LocalNode

Struct LocalNode 

Source
pub struct LocalNode<M: MacBackend> { /* private fields */ }
Expand description

Per-identity application handle.

LocalNode owns its channel membership set via shared interior state. Different LocalNode instances (for different identities) may join different channel sets.

Implementations§

Source§

impl<M: MacBackend> LocalNode<M>

Source

pub fn identity_id(&self) -> LocalIdentityId

The identity slot this node operates on.

Source

pub fn peer(&self, key: PublicKey) -> Result<PeerConnection<Self>, NodeError<M>>

Create a peer connection (registers peer in MAC if new).

Source

pub fn on_receive<F>(&self, handler: F) -> Subscription
where F: FnMut(&ReceivedPacketRef<'_>) -> bool + 'static,

Source

pub fn on_node_discovered<F>(&self, handler: F) -> Subscription
where F: FnMut(PublicKey, Option<&str>) + 'static,

Source

pub fn on_beacon<F>(&self, handler: F) -> Subscription
where F: FnMut(NodeHint, Option<PublicKey>) + 'static,

Source

pub fn on_mac_command<F>(&self, handler: F) -> Subscription
where F: FnMut(PublicKey, &OwnedMacCommand) + 'static,

Source

pub fn on_ack_received<F>(&self, handler: F) -> Subscription
where F: FnMut(PublicKey, SendToken) + 'static,

Source

pub fn on_ack_timeout<F>(&self, handler: F) -> Subscription
where F: FnMut(PublicKey, SendToken) + 'static,

Source

pub fn on_pfs_established<F>(&self, handler: F) -> Subscription
where F: FnMut(PublicKey) + 'static,

Source

pub fn on_pfs_ended<F>(&self, handler: F) -> Subscription
where F: FnMut(PublicKey) + 'static,

Source

pub async fn request_pfs( &self, peer: &PublicKey, duration_minutes: u16, options: &SendOptions, ) -> Result<SendProgressTicket, NodeError<M>>

Source

pub async fn end_pfs( &self, peer: &PublicKey, options: &SendOptions, ) -> Result<(), NodeError<M>>

Source

pub fn pfs_status(&self, peer: &PublicKey) -> Result<PfsStatus, NodeError<M>>

Source

pub fn join(&self, channel: &Channel) -> Result<BoundChannel<M>, NodeError<M>>

Join a channel. Registers the channel key in the MAC if this is the first node to join it. Returns the bound channel handle.

Source

pub fn leave(&self, channel: &Channel) -> Result<(), NodeError<M>>

Leave a channel. Marks the membership entry inactive and bumps that entry’s generation counter.

Source

pub fn bound_channel(&self, channel: &Channel) -> Option<BoundChannel<M>>

Get a handle to an already-joined channel.

Source

pub fn bound_channels(&self) -> Vec<BoundChannel<M>>

List all joined channels.

Trait Implementations§

Source§

impl<M: Clone + MacBackend> Clone for LocalNode<M>

Source§

fn clone(&self) -> LocalNode<M>

Returns a duplicate of the value. Read more
1.0.0§

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

Performs copy-assignment from source. Read more
Source§

impl<M: MacBackend> Transport for LocalNode<M>

Source§

type Error = NodeError<M>

Source§

async fn send( &self, to: &PublicKey, payload: &[u8], options: &SendOptions, ) -> Result<SendProgressTicket, Self::Error>

Send a payload to a specific destination. Read more
Source§

async fn send_all( &self, payload: &[u8], options: &SendOptions, ) -> Result<SendProgressTicket, Self::Error>

Send a payload to all reachable nodes in this transport’s scope. Read more

Auto Trait Implementations§

§

impl<M> Freeze for LocalNode<M>
where M: Freeze,

§

impl<M> !RefUnwindSafe for LocalNode<M>

§

impl<M> !Send for LocalNode<M>

§

impl<M> !Sync for LocalNode<M>

§

impl<M> Unpin for LocalNode<M>
where M: Unpin,

§

impl<M> !UnwindSafe for LocalNode<M>

Blanket Implementations§

§

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

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

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

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

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

§

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

Mutably borrows from an owned value. Read more
§

impl<T> CloneToUninit for T
where T: Clone,

§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<T> From<T> for T

§

fn from(t: T) -> T

Returns the argument unchanged.

§

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

§

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> Same for T

Source§

type Output = T

Should always be Self
§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
§

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

§

type Error = Infallible

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

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

Performs the conversion.
§

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

§

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

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

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

Performs the conversion.