Struct jormungandr::network::p2p::comm::CommHandle

pub struct CommHandle<T> {
    state: SubscriptionState<T>,
    direction: SubscriptionDirection,
}

Handle used by the per-peer communication tasks to produce an outbound subscription stream towards the peer.

Fields

state: SubscriptionState<T>

direction: SubscriptionDirection

Implementations

impl<T> CommHandle<T>

pub fn client_pending(item: T) -> Self

Creates a handle with the Client direction and an item waiting to be sent, in expectation for a subscription to be established.

pub fn direction(&self) -> SubscriptionDirection

pub fn is_client(&self) -> bool

pub fn clear_pending(&mut self)

pub fn update(&mut self, newer: CommHandle<T>)

Updates this handle with the subscription state from another handle. This happens when another connection is established to the same peer. This method is used instead of replacing the handle to send a potential pending item over the new subscription.

pub fn subscribe(&mut self) -> OutboundSubscription<T>

Returns a stream to use as an outbound half of the subscription stream.

If this method is called again on the same handle, the previous subscription is closed and its stream is terminated.

pub fn is_subscribed(&self) -> bool

pub fn try_send(&mut self, item: T) -> Result<(), PropagateError<T>>

Trait Implementations

impl<T> Default for CommHandle<T>

fn default() -> Self

Returns the “default value” for a type.