Struct IrohNode 

pub struct IrohNode { /* private fields */ }

Implementations

impl IrohNode

pub async fn new( identity: IdentityManager, data_dir: PathBuf, relay_mode: RelayMode, member_keys: Arc<RwLock<HashSet<PublicKey>>>, discovery: DiscoveryConfig, ) -> Result<Self>

Creates a node and starts accepting the blobs, docs, and gossip protocols.

Errors

Returns an error if the directory structure cannot be created, if binding the endpoint fails, or if starting the background services fails.

pub async fn new_with_relay( identity: IdentityManager, data_dir: PathBuf, relay_mode: RelayMode, member_keys: Arc<RwLock<HashSet<PublicKey>>>, discovery: DiscoveryConfig, relay: Option<RelayManager>, ) -> Result<Self>

Creates a node with the Syncthing (BEP) relay transport installed.

When relay is Some, the manager’s custom transport is registered on the endpoint and the manager is kept alive for the node’s lifetime; the node’s share tickets then carry the node’s relay address so peers can reach it through a Syncthing relay when direct paths fail.

Errors

Returns an error if the directory structure cannot be created, if binding the endpoint fails, or if starting the background services fails.

pub async fn new_with_address_lookup( identity: IdentityManager, data_dir: PathBuf, relay_mode: RelayMode, address_lookup: MemoryLookup, discovery: DiscoveryConfig, member_keys: Arc<RwLock<HashSet<PublicKey>>>, ) -> Result<Self>

Errors

Returns an error if the directory structure cannot be created, if binding the endpoint fails, or if starting the background services fails.

pub async fn new_with_address_lookup_and_relay( identity: IdentityManager, data_dir: PathBuf, relay_mode: RelayMode, address_lookup: MemoryLookup, discovery: DiscoveryConfig, member_keys: Arc<RwLock<HashSet<PublicKey>>>, relay: Option<RelayManager>, ) -> Result<Self>

Errors

Returns an error if the directory structure cannot be created, if binding the endpoint fails, or if starting the background services fails.

pub fn relay_addr(&self) -> Option<CustomAddr>

The relay custom address this node advertises, when Syncthing (BEP) relaying is enabled.

pub const fn endpoint(&self) -> &Endpoint

pub const fn blobs(&self) -> &BlobsProtocol

pub const fn docs(&self) -> &Docs

pub fn gossip(&self) -> &Gossip

pub const fn blob_store(&self) -> &BlobStore

pub const fn docs_engine(&self) -> &DocsEngine

pub const fn topic_tracker(&self) -> &TopicTracker

pub fn is_running(&self) -> bool

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

Errors

Returns an error if the router fails to shutdown properly.

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

Errors

Returns an error if stopping the node fails.

Trait Implementations

impl Drop for IrohNode

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.