autosync-package

autosync

A WebSocket-based implementation of the 'automerge-repo' synchronization
protocol used by 'sync.automerge.org'. Acts as a sync server, enabling 'R' to
serve as a synchronization hub for 'Automerge' clients in 'JavaScript',
'Rust', and other languages, and as a client for fetching, editing, and
synchronizing documents hosted on remote servers.

A WebSocket-based implementation of the 'automerge-repo'
synchronization protocol used by 'sync.automerge.org'. Acts as a sync
server, enabling 'R' to serve as a synchronization hub for 'Automerge'
clients in 'JavaScript', 'Rust', and other languages, and as a client
for fetching, editing, and synchronizing documents hosted on remote
servers.

Charlie Gao

'Automerge' Sync Server and Client

Posit Software, PBC 

autosync-package function

<dl>
<dt><code>sync_server()</code></dt>
<dd>Create a new sync server with <code>$start()</code> and
<code>$close()</code> methods</dd></dl>

Main Functions

<dl>
<dt><code>create_document()</code></dt>
<dd>Create a new document</dd></dl><dt><code>get_document()</code></dt>
<dd>Retrieve a document by ID</dd><dt><code>list_documents()</code></dt>
<dd>List all document IDs</dd><dt><code>generate_document_id()</code></dt>
<dd>Generate a new document ID</dd>

Document Management

The server implements the automerge-repo sync protocol over WebSockets.
Messages are CBOR-encoded and include:<dl>
<dt>join/peer</dt>
<dd>Handshake messages for connection establishment</dd><dt>request/sync</dt>
<dd>Document synchronization messages</dd><dt>ephemeral</dt>
<dd>Transient messages forwarded without persistence</dd><dt>error</dt>
<dd>Error notifications</dd>
</dl>

Protocol

<pre><code>
# Create and start a server
server &lt;- sync_server()
server$start()
server$url</code></pre># Stop when done
server$close()

Example

Maintainer: Charlie Gao <a href="/link/charlie.gao%40posit.co?package=autosync&version=0.2.0" data-mini-rdoc="autosync::charlie.gao@posit.co">charlie.gao@posit.co</a> (<a href="https://orcid.org/0000-0002-0750-061X">ORCID</a>)
Authors:<ul>
<li>Charlie Gao <a href="/link/charlie.gao%40posit.co?package=autosync&version=0.2.0" data-mini-rdoc="autosync::charlie.gao@posit.co">charlie.gao@posit.co</a> (<a href="https://orcid.org/0000-0002-0750-061X">ORCID</a>)</li>
</ul>Other contributors:<ul>
<li>Posit Software, PBC (<a href="https://ror.org/03wc8by49">ROR</a>) [copyright holder, funder]</li>
</ul>

Author

autosync: 'Automerge' Sync Server and Client — autosync-package

<dl>
<dt><code>sync_server()</code></dt>
<dd>Create a new sync server with <code>$start()</code> and
<code>$close()</code> methods</dd>


</dl>

<dl>
<dt><code>create_document()</code></dt>
<dd>Create a new document</dd>

<dt><code>get_document()</code></dt>
<dd>Retrieve a document by ID</dd>

<dt><code>list_documents()</code></dt>
<dd>List all document IDs</dd>

<dt><code>generate_document_id()</code></dt>
<dd>Generate a new document ID</dd>


</dl>

The server implements the automerge-repo sync protocol over WebSockets.
Messages are CBOR-encoded and include:<dl>
<dt>join/peer</dt>
<dd>Handshake messages for connection establishment</dd>

<dt>request/sync</dt>
<dd>Document synchronization messages</dd>

<dt>ephemeral</dt>
<dd>Transient messages forwarded without persistence</dd>

<dt>error</dt>
<dd>Error notifications</dd>


</dl>

<pre><code>
# Create and start a server
server &lt;- sync_server()
server$start()
server$url

# Stop when done
server$close()
</code></pre>

Maintainer: Charlie Gao <a href='mailto:charlie.gao@posit.co'>charlie.gao@posit.co</a> (<a href='https://orcid.org/0000-0002-0750-061X'>ORCID</a>)
Authors:<ul>
<li>Charlie Gao <a href='mailto:charlie.gao@posit.co'>charlie.gao@posit.co</a> (<a href='https://orcid.org/0000-0002-0750-061X'>ORCID</a>)</li>
</ul>

Other contributors:<ul>
<li>Posit Software, PBC (<a href='https://ror.org/03wc8by49'>ROR</a>) [copyright holder, funder]</li>
</ul>

autosync-package: autosync: 'Automerge' Sync Server and Client

Description

Arguments

Main Functions

Document Management

Protocol

Example

Author

See Also