Struct rings_node::prelude::message::MessageHandler

impl MessageHandler

pub fn new(
 swarm: Arc<Swarm>,
 callback: Option<Box<dyn MessageCallback + Sync + Send + 'static, Global>>,
 validator: Option<Box<dyn MessageValidator + Sync + Send + 'static, Global>>
) -> MessageHandler

Create a new MessageHandler Instance.

pub fn decrypt_msg(
&self,
msg: &MaybeEncrypted<CustomMessage>
) -> Result<CustomMessage, Error>

Decrypt message.

pub fn handle_payload<'life0, 'life_self, 'async_recursion>(
 &'life_self self,
 payload: &'life0 MessagePayload<Message>
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_recursion, Global>>where
 'life0: 'async_recursion,
 'life_self: 'async_recursion,

Handle builtin message.

pub async fn listen_once(
&self
) -> impl Future<Output = Option<MessagePayload<Message>>>

This method is required because web-sys components is not Send which means a listening loop cannot running concurrency.

Trait Implementations§

impl Clone for MessageHandler

fn clone(&self) -> MessageHandler

Returns a copy of the value. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

impl HandleMsg<AlreadyConnected> for MessageHandler

fn handle<'life0, 'life1, 'life2, 'async_trait>(
 &'life0 self,
 ctx: &'life1 MessagePayload<Message>,
 _msg: &'life2 AlreadyConnected
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait, Global>>where
 'life0: 'async_trait,
 'life1: 'async_trait,
 'life2: 'async_trait,
 MessageHandler: 'async_trait,

Message handler.

impl HandleMsg<ConnectNodeReport> for MessageHandler

fn handle<'life0, 'life1, 'life2, 'async_trait>(
 &'life0 self,
 ctx: &'life1 MessagePayload<Message>,
 msg: &'life2 ConnectNodeReport
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait, Global>>where
 'life0: 'async_trait,
 'life1: 'async_trait,
 'life2: 'async_trait,
 MessageHandler: 'async_trait,

Message handler.

impl HandleMsg<ConnectNodeSend> for MessageHandler

fn handle<'life0, 'life1, 'life2, 'async_trait>(
 &'life0 self,
 ctx: &'life1 MessagePayload<Message>,
 msg: &'life2 ConnectNodeSend
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait, Global>>where
 'life0: 'async_trait,
 'life1: 'async_trait,
 'life2: 'async_trait,
 MessageHandler: 'async_trait,

Message handler.

impl HandleMsg<FindSuccessorReport> for MessageHandler

fn handle<'life0, 'life1, 'life2, 'async_trait>(
 &'life0 self,
 ctx: &'life1 MessagePayload<Message>,
 msg: &'life2 FindSuccessorReport
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait, Global>>where
 'life0: 'async_trait,
 'life1: 'async_trait,
 'life2: 'async_trait,
 MessageHandler: 'async_trait,

Message handler.

impl HandleMsg<FindSuccessorSend> for MessageHandler

fn handle<'life0, 'life1, 'life2, 'async_trait>(
 &'life0 self,
 ctx: &'life1 MessagePayload<Message>,
 msg: &'life2 FindSuccessorSend
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait, Global>>where
 'life0: 'async_trait,
 'life1: 'async_trait,
 'life2: 'async_trait,
 MessageHandler: 'async_trait,

Message handler.

impl HandleMsg<FoundVNode> for MessageHandler

fn handle<'life0, 'life1, 'life2, 'async_trait>(
 &'life0 self,
 ctx: &'life1 MessagePayload<Message>,
 msg: &'life2 FoundVNode
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait, Global>>where
 'life0: 'async_trait,
 'life1: 'async_trait,
 'life2: 'async_trait,
 MessageHandler: 'async_trait,

Message handler.

impl HandleMsg<JoinDHT> for MessageHandler

fn handle<'life0, 'life1, 'life2, 'async_trait>(
 &'life0 self,
 ctx: &'life1 MessagePayload<Message>,
 msg: &'life2 JoinDHT
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait, Global>>where
 'life0: 'async_trait,
 'life1: 'async_trait,
 'life2: 'async_trait,
 MessageHandler: 'async_trait,

Message handler.

impl HandleMsg<LeaveDHT> for MessageHandler

fn handle<'life0, 'life1, 'life2, 'async_trait>(
 &'life0 self,
 _ctx: &'life1 MessagePayload<Message>,
 msg: &'life2 LeaveDHT
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait, Global>>where
 'life0: 'async_trait,
 'life1: 'async_trait,
 'life2: 'async_trait,
 MessageHandler: 'async_trait,

Message handler.

impl HandleMsg<MaybeEncrypted<CustomMessage>> for MessageHandler

fn handle<'life0, 'life1, 'life2, 'async_trait>(
 &'life0 self,
 ctx: &'life1 MessagePayload<Message>,
 __arg2: &'life2 MaybeEncrypted<CustomMessage>
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait, Global>>where
 'life0: 'async_trait,
 'life1: 'async_trait,
 'life2: 'async_trait,
 MessageHandler: 'async_trait,

Message handler.

impl HandleMsg<NotifyPredecessorReport> for MessageHandler

fn handle<'life0, 'life1, 'life2, 'async_trait>(
 &'life0 self,
 _ctx: &'life1 MessagePayload<Message>,
 msg: &'life2 NotifyPredecessorReport
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait, Global>>where
 'life0: 'async_trait,
 'life1: 'async_trait,
 'life2: 'async_trait,
 MessageHandler: 'async_trait,

Message handler.

impl HandleMsg<NotifyPredecessorSend> for MessageHandler

fn handle<'life0, 'life1, 'life2, 'async_trait>(
 &'life0 self,
 ctx: &'life1 MessagePayload<Message>,
 msg: &'life2 NotifyPredecessorSend
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait, Global>>where
 'life0: 'async_trait,
 'life1: 'async_trait,
 'life2: 'async_trait,
 MessageHandler: 'async_trait,

Message handler.

impl HandleMsg<SearchVNode> for MessageHandler

fn handle<'life0, 'life1, 'life2, 'async_trait>(
 &'life0 self,
 ctx: &'life1 MessagePayload<Message>,
 msg: &'life2 SearchVNode
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait, Global>>where
 'life0: 'async_trait,
 'life1: 'async_trait,
 'life2: 'async_trait,
 MessageHandler: 'async_trait,

Search VNode via successor If a VNode is storead local, it will response immediately.

impl HandleMsg<SyncVNodeWithSuccessor> for MessageHandler

fn handle<'life0, 'life1, 'life2, 'async_trait>(
 &'life0 self,
 _ctx: &'life1 MessagePayload<Message>,
 msg: &'life2 SyncVNodeWithSuccessor
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait, Global>>where
 'life0: 'async_trait,
 'life1: 'async_trait,
 'life2: 'async_trait,
 MessageHandler: 'async_trait,

Message handler.

impl HandleMsg<VNodeOperation> for MessageHandler

fn handle<'life0, 'life1, 'life2, 'async_trait>(
 &'life0 self,
 ctx: &'life1 MessagePayload<Message>,
 msg: &'life2 VNodeOperation
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait, Global>>where
 'life0: 'async_trait,
 'life1: 'async_trait,
 'life2: 'async_trait,
 MessageHandler: 'async_trait,

Message handler.

impl MessageListener for MessageHandler

fn listen<'async_trait>(
self: Arc<MessageHandler>
) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait, Global>>where
MessageHandler: 'async_trait,

impl PayloadSender<Message> for MessageHandler

fn session_manager(&self) -> &SessionManager

fn do_send_payload<'life0, 'async_trait>(
 &'life0 self,
 did: Did,
 payload: MessagePayload<Message>
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait, Global>>where
 'life0: 'async_trait,
 MessageHandler: 'async_trait,

fn send_payload<'life0, 'async_trait>(
 &'life0 self,
 payload: MessagePayload<T>
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait, Global>>where
 'life0: 'async_trait,
 Self: Sync + 'async_trait,

fn send_message<'life0, 'async_trait>(
 &'life0 self,
 msg: T,
 next_hop: Did,
 destination: Did
) -> Pin<Box<dyn Future<Output = Result<Uuid, Error>> + Send + 'async_trait, Global>>where
 'life0: 'async_trait,
 Self: Sync + 'async_trait,

fn send_direct_message<'life0, 'async_trait>(
 &'life0 self,
 msg: T,
 destination: Did
) -> Pin<Box<dyn Future<Output = Result<Uuid, Error>> + Send + 'async_trait, Global>>where
 'life0: 'async_trait,
 Self: Sync + 'async_trait,

fn send_report_message<'life0, 'async_trait>(
 &'life0 self,
 msg: T,
 tx_id: Uuid,
 relay: MessageRelay
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait, Global>>where
 'life0: 'async_trait,
 Self: Sync + 'async_trait,

fn forward_payload<'life0, 'life1, 'async_trait>(
 &'life0 self,
 payload: &'life1 MessagePayload<T>,
 relay: MessageRelay
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait, Global>>where
 'life0: 'async_trait,
 'life1: 'async_trait,
 Self: Sync + 'async_trait,

Auto Trait Implementations§

impl !UnwindSafe for MessageHandler

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

impl<'a, T> AsTaggedExplicit<'a> for Twhere
T: 'a,

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self>

impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,

fn implicit(
 self,
 class: Class,
 constructed: bool,
 tag: u32
) -> TaggedParser<'a, Implicit, Self, E>

impl<'a, T> AsTaggedImplicit<'a> for Twhere
T: 'a,

fn implicit(
 self,
 class: Class,
 constructed: bool,
 tag: u32
) -> TaggedParser<'a, Implicit, Self>

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

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

const: unstable · source§

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> FutureExt for T

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more

impl<T> Instrument for T

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

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

fn in_current_span(self) -> Instrumented<Self>

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

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

const: unstable · 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.

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::<T>()

The alignment of pointer.

type Init = T

The type for initializers.

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

Initializes a with the given initializer. Read more

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

Dereferences the given pointer. Read more

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

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

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

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T> ToOwned for Twhere
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 for Twhere
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source§

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

Performs the conversion.

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source§

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

Performs the conversion.

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

fn vzip(self) -> V

impl<T> WithSubscriber for T

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