Struct libp2p_core::protocols_handler::NodeHandlerWrapper

pub struct NodeHandlerWrapper<TProtoHandler>where
    TProtoHandler: ProtocolsHandler,{ /* private fields */ }

Wraps around an implementation of ProtocolsHandler, and implements NodeHandler.

Trait Implementations

impl<TProtoHandler> NodeHandler for NodeHandlerWrapper<TProtoHandler>where
    TProtoHandler: ProtocolsHandler,
    <TProtoHandler::OutboundProtocol as OutboundUpgrade<<TProtoHandler as ProtocolsHandler>::Substream>>::Error: Debug,

type InEvent = <TProtoHandler as ProtocolsHandler>::InEvent

Custom event that can be received from the outside.

type OutEvent = <TProtoHandler as ProtocolsHandler>::OutEvent

Custom event that can be produced by the handler and that will be returned by the swarm.

type Error = <TProtoHandler as ProtocolsHandler>::Error

Error that can happen during the processing of the node.

type Substream = <TProtoHandler as ProtocolsHandler>::Substream

The type of the substream containing the data.

type OutboundOpenInfo = (u64, <TProtoHandler as ProtocolsHandler>::OutboundOpenInfo)

Information about a substream. Can be sent to the handler through a NodeHandlerEndpoint, and will be passed back in inject_substream or inject_outbound_closed.

fn inject_substream(
    &mut self,
    substream: Self::Substream,
    endpoint: NodeHandlerEndpoint<Self::OutboundOpenInfo>
)

Sends a new substream to the handler.

fn inject_inbound_closed(&mut self)

Indicates to the handler that the inbound part of the muxer has been closed, and that therefore no more inbound substream will be produced.

fn inject_outbound_closed(&mut self, user_data: Self::OutboundOpenInfo)

Indicates to the handler that an outbound substream failed to open because the outbound part of the muxer has been closed.

fn inject_event(&mut self, event: Self::InEvent)

Injects an event coming from the outside into the handler.

fn shutdown(&mut self)

Indicates to the node that it should shut down. After that, it is expected that poll() returns Ready(NodeHandlerEvent::Shutdown) as soon as possible.

fn poll(
    &mut self
) -> Poll<NodeHandlerEvent<Self::OutboundOpenInfo, Self::OutEvent>, Self::Error>

Should behave like Stream::poll(). Should close if no more event can be produced and the node should be closed.