NetworkHandle

Struct NetworkHandle 

Source
pub struct NetworkHandle {
    pub(super) command_sender: UnboundedSender<NetworkCommand>,
}
Expand description

A handle for interacting with the NetworkLayer.

This struct provides a thread-safe way to send commands to the NetworkLayer and receive responses.

Fields§

§command_sender: UnboundedSender<NetworkCommand>

Implementations§

Source§

impl NetworkHandle

Source

pub async fn send_message( &self, peer_id: PeerId, message: Message, ) -> Result<()>

Sends a chat message to a peer.

§Arguments
  • peer_id - The PeerId of the recipient.
  • message - The message to send.
§Errors

This function will return an error if the message cannot be sent.

Source

pub async fn send_chat_request( &self, peer_id: PeerId, request: ChatRequest, ) -> Result<()>

Sends a chat request to a peer.

This can be used for things like sending delivery confirmations or read receipts.

§Arguments
  • peer_id - The PeerId of the recipient.
  • request - The chat request to send.
§Errors

This function will return an error if the request cannot be sent.

Source

pub async fn get_connected_peers(&self) -> Result<Vec<PeerId>>

Gets the list of connected peers.

§Errors

This function will return an error if the list of peers cannot be retrieved.

Source

pub async fn mailbox_put( &self, peer_id: PeerId, recipient: [u8; 32], message: EncryptedMessage, ) -> Result<bool>

Puts a message into a mailbox.

§Arguments
  • peer_id - The PeerId of the mailbox node.
  • recipient - The hash of the recipient’s public key.
  • message - The encrypted message to store.
§Errors

This function will return an error if the message cannot be stored.

Source

pub async fn mailbox_fetch( &self, peer_id: PeerId, recipient: [u8; 32], limit: usize, ) -> Result<Vec<EncryptedMessage>>

Fetches messages from a mailbox.

§Arguments
  • peer_id - The PeerId of the mailbox node.
  • recipient - The hash of the recipient’s public key.
  • limit - The maximum number of messages to fetch.
§Errors

This function will return an error if the messages cannot be fetched.

Source

pub async fn mailbox_ack( &self, peer_id: PeerId, recipient: [u8; 32], msg_ids: Vec<Uuid>, ) -> Result<usize>

Acknowledges the receipt of messages from a mailbox.

This will delete the acknowledged messages from the mailbox.

§Arguments
  • peer_id - The PeerId of the mailbox node.
  • recipient - The hash of the recipient’s public key.
  • msg_ids - The IDs of the messages to acknowledge.
§Errors

This function will return an error if the messages cannot be acknowledged.

Source

pub async fn start_dht_provider_query(&self, key: RecordKey) -> Result<QueryId>

Starts a Kademlia DHT query to find providers for a key.

§Arguments
  • key - The key to find providers for.
§Errors

This function will return an error if the query cannot be started.

Trait Implementations§

Source§

impl Clone for NetworkHandle

Source§

fn clone(&self) -> NetworkHandle

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more

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> CloneToUninit for T
where T: Clone,

Source§

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
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

Uses borrowed data to replace owned data, usually by cloning. Read more
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,

Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,