Skip to main content

MessagingPlugin

Struct MessagingPlugin 

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

Daemon plugin shell.

The daemon constructs the MessagingService first (since its RPC layer needs a direct handle to call send, mark_*, history, etc.) and then wraps it with this plugin so payload dispatch and lifecycle hooks can flow through the same instance.

Implementations§

Source§

impl MessagingPlugin

Source

pub fn new(service: Arc<MessagingService>) -> Arc<Self>

Wrap an existing MessagingService as a DaemonPlugin.

Trait Implementations§

Source§

impl DaemonPlugin for MessagingPlugin

Source§

fn name(&self) -> &'static str

Stable identifier — used for log spans and (by convention) as a prefix for the plugin’s payload kinds.
Source§

fn payload_kinds(&self) -> &'static [&'static str]

Stable list of PluginPayload.kind values this plugin claims. The daemon dispatches inbound payloads by matching kind against each registered plugin in order; the first match wins.
Source§

fn handle_payload<'life0, 'life1, 'async_trait>( &'life0 self, src: NodeId, kind: &'life1 str, body: Bytes, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Handle an inbound ControlFrame::PluginPayload whose kind appeared in Self::payload_kinds.
Source§

fn start<'async_trait>( self: Arc<Self>, _ctx: PluginContext, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait,

Spawn whatever long-running tasks the plugin needs. Returns once startup is complete; long-running work should be on detached tokio::spawn handles tied to ctx.cancel.
Source§

fn on_peer_forgotten<'life0, 'async_trait>( &'life0 self, peer: NodeId, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Notification: the daemon dropped this peer’s identity from the keystore (e.g. via peers.forget). Plugins typically wipe any per-peer state of their own here. Failure is logged but does not block other plugins from being notified.
Source§

fn shutdown<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Best-effort shutdown — called once at daemon teardown.

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