Struct iroh_docs::engine::Engine

pub struct Engine<D> {
    pub endpoint: Endpoint,
    pub sync: SyncHandle,
    pub default_author: Arc<DefaultAuthor>,
    /* private fields */
}

Available on crate feature engine only.

The sync engine coordinates actors that manage open documents, set-reconciliation syncs with peers and a gossip swarm for each syncing document.

Fields

endpoint: Endpoint

[Endpoint] used by the engine.

sync: SyncHandle

Handle to the actor thread.

default_author: Arc<DefaultAuthor>

The persistent default author for this engine.

Implementations

impl<D: Store> Engine<D>

pub async fn spawn( endpoint: Endpoint, gossip: Gossip, replica_store: Store, bao_store: D, downloader: Downloader, default_author_storage: DefaultAuthorStorage, local_pool_handle: LocalPoolHandle ) -> Result<Self>

Start the sync engine.

This will spawn two tokio tasks for the live sync coordination and gossip actors, and a thread for the crate::actor::SyncHandle.

pub fn protect_cb(&self) -> ProtectCb

Return a callback that can be added to blobs to protect the content of all docs from garbage collection.

pub fn blob_store(&self) -> &D

Get the blob store.

pub async fn start_sync( &self, namespace: NamespaceId, peers: Vec<NodeAddr> ) -> Result<()>

Start to sync a document.

If peers is non-empty, it will both do an initial set-reconciliation sync with each peer, and join an iroh-gossip swarm with these peers to receive and broadcast document updates.

pub async fn leave( &self, namespace: NamespaceId, kill_subscribers: bool ) -> Result<()>

Stop the live sync for a document and leave the gossip swarm.

If kill_subscribers is true, all existing event subscribers will be dropped. This means they will receive None and no further events in case of rejoining the document.

pub async fn subscribe( &self, namespace: NamespaceId ) -> Result<impl Stream<Item = Result<LiveEvent>> + Unpin + 'static>

Subscribe to replica and sync progress events.

pub async fn handle_connection(&self, conn: Connecting) -> Result<()>

Handle an incoming iroh-docs connection.

pub async fn shutdown(&self) -> Result<()>

Shutdown the engine.

pub fn local_pool_handle(&self) -> &LocalPoolHandle

Returns the stored LocalPoolHandle.

impl<D: Store> Engine<D>

pub fn client(&self) -> &MemClient

Available on crate feature rpc only.

Get an in memory client to interact with the docs engine.

pub async fn handle_rpc_request<C: ChannelTypes<RpcService>>( self, msg: Request, chan: RpcChannel<RpcService, C> ) -> Result<(), RpcServerError<C>>

Available on crate feature rpc only.

Handle a docs request from the RPC server.

Trait Implementations

impl<D: Clone> Clone for Engine<D>

fn clone(&self) -> Engine<D>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<D> Debug for Engine<D>

where D: Debug,

fn fmt(&self, __derive_more_f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<D: Store> ProtocolHandler for Engine<D>

fn accept(&self, conn: Connecting) -> BoxedFuture<Result<()>>

Handle an incoming connection.

fn shutdown(&self) -> BoxedFuture<()>

Called when the node shuts down.