Struct SubCore 

pub struct SubCore<PeerId> { /* private fields */ }

Core state for SUB socket behavior.

Implementations

impl<PeerId> SubCore<PeerId>

where PeerId: Copy + Eq,

pub fn new() -> Self

Creates an empty SUB core.

pub fn with_filter_inbound(self, filter_inbound: bool) -> Self

Controls whether inbound messages are filtered against local subscriptions.

pub fn add_peer(&mut self, peer: PeerId) -> Vec<PatternAction<PeerId>>

Adds a peer and replays local subscriptions to it.

pub fn remove_peer(&mut self, peer: PeerId)

Removes a peer from the active SUB peer set.

pub fn subscribe( &mut self, topic: &Bytes, ) -> Result<Vec<PatternAction<PeerId>>, ProtocolError>

Registers a local subscription and fans it out to connected peers.

Errors

This method currently does not return an error.

pub fn cancel( &mut self, topic: &Bytes, ) -> Result<Vec<PatternAction<PeerId>>, ProtocolError>

Removes a local subscription and fans the cancel out to connected peers.

Errors

Returns ProtocolError::UnknownSubscription when topic is not currently subscribed.

pub fn on_peer_event( &mut self, peer: PeerId, event: PeerEvent, ) -> Result<Vec<PatternAction<PeerId>>, ProtocolError>

Handles inbound peer events for a SUB socket.

Errors

Returns ProtocolError::EmptyMessage when an inbound message has no frames.

Trait Implementations

impl<PeerId: Clone> Clone for SubCore<PeerId>

fn clone(&self) -> SubCore<PeerId>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<PeerId: Debug> Debug for SubCore<PeerId>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<PeerId> Default for SubCore<PeerId>

fn default() -> Self

Returns the “default value” for a type.