Skip to main content

NetworkManager

Struct NetworkManager 

Source
pub struct NetworkManager { /* private fields */ }
Expand description

The user-facing API for the networking stack.

NetworkManager ties together all five layers (identity, transport, routing, discovery, application) and provides a simple interface for sending messages, discovering peers, and subscribing to network events.

§Example

let manager = NetworkManagerBuilder::new(my_identity)
    .add_transport(IpcTransport::new(None))
    .with_discovery(ManualDiscovery::new())
    .build();

manager.send(peer_id, "hello").await?;

let mut events = manager.subscribe();
while let Ok(event) = events.recv().await {
    // handle events
}

Implementations§

Source§

impl NetworkManager

Source

pub fn identity(&self) -> &AgentIdentity

Get this agent’s identity.

Source

pub fn subscribe(&self) -> Receiver<NetworkEvent>

Subscribe to network events.

Source

pub async fn peer_table(&self) -> RwLockReadGuard<'_, PeerTable>

Get a read lock on the peer table.

Source

pub async fn peer_table_mut(&self) -> RwLockWriteGuard<'_, PeerTable>

Get a write lock on the peer table.

Source

pub async fn peers(&self) -> Vec<AgentIdentity>

List all known peers.

Source

pub async fn send( &self, target: Uuid, payload: impl Into<Payload>, ) -> Result<()>

Send a message to a specific peer.

Source

pub async fn broadcast(&self, payload: impl Into<Payload>) -> Result<()>

Broadcast a message to all known peers.

Source

pub async fn publish( &self, topic: impl Into<String>, payload: impl Into<Payload>, ) -> Result<()>

Publish a message to a topic.

Source

pub async fn send_envelope(&self, envelope: MessageEnvelope) -> Result<()>

Send a pre-built envelope.

Source

pub fn add_transport(&mut self, transport: Box<dyn Transport>)

Add a transport to the manager.

Source

pub fn set_custom_router(&mut self, router: Box<dyn Router>)

Set a custom router (overrides the default direct router for point-to-point messages).

Source

pub fn add_discovery(&mut self, discovery: Box<dyn Discovery>)

Add a discovery service.

Source

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

Register this agent with all discovery services.

Source

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

Deregister this agent from all discovery services.

Source

pub async fn discover_peers(&self) -> Result<Vec<AgentIdentity>>

Run discovery across all services and update the peer table.

Source

pub fn emit(&self, event: NetworkEvent)

Emit a network event.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,