Struct libp2p::swarm::protocols_handler::DummyProtocolsHandler [−][src]
pub struct DummyProtocolsHandler {
pub keep_alive: KeepAlive,
}
Expand description
Implementation of ProtocolsHandler
that doesn’t handle anything.
Fields
keep_alive: KeepAlive
Trait Implementations
Returns the “default value” for a type. Read more
type InEvent = Void
type InEvent = Void
Custom event that can be received from the outside.
type OutEvent = Void
type OutEvent = Void
Custom event that can be produced by the handler and that will be returned to the outside.
type Error = Void
type Error = Void
The type of errors returned by ProtocolsHandler::poll
.
type InboundProtocol = DeniedUpgrade
type InboundProtocol = DeniedUpgrade
The inbound upgrade for the protocol(s) used by the handler.
type OutboundProtocol = DeniedUpgrade
type OutboundProtocol = DeniedUpgrade
The outbound upgrade for the protocol(s) used by the handler.
type OutboundOpenInfo = Void
type OutboundOpenInfo = Void
The type of additional information passed to an OutboundSubstreamRequest
.
type InboundOpenInfo = ()
type InboundOpenInfo = ()
The type of additional information returned from listen_protocol
.
pub fn listen_protocol(
&self
) -> SubstreamProtocol<<DummyProtocolsHandler as ProtocolsHandler>::InboundProtocol, <DummyProtocolsHandler as ProtocolsHandler>::InboundOpenInfo>
pub fn listen_protocol(
&self
) -> SubstreamProtocol<<DummyProtocolsHandler as ProtocolsHandler>::InboundProtocol, <DummyProtocolsHandler as ProtocolsHandler>::InboundOpenInfo>
The InboundUpgrade
to apply on inbound
substreams to negotiate the desired protocols. Read more
pub fn inject_fully_negotiated_inbound(
&mut self,
<<DummyProtocolsHandler as ProtocolsHandler>::InboundProtocol as InboundUpgrade<Negotiated<SubstreamRef<Arc<StreamMuxerBox>>>>>::Output,
<DummyProtocolsHandler as ProtocolsHandler>::InboundOpenInfo
)
pub fn inject_fully_negotiated_inbound(
&mut self,
<<DummyProtocolsHandler as ProtocolsHandler>::InboundProtocol as InboundUpgrade<Negotiated<SubstreamRef<Arc<StreamMuxerBox>>>>>::Output,
<DummyProtocolsHandler as ProtocolsHandler>::InboundOpenInfo
)
Injects the output of a successful upgrade on a new inbound substream.
pub fn inject_fully_negotiated_outbound(
&mut self,
<<DummyProtocolsHandler as ProtocolsHandler>::OutboundProtocol as OutboundUpgrade<Negotiated<SubstreamRef<Arc<StreamMuxerBox>>>>>::Output,
<DummyProtocolsHandler as ProtocolsHandler>::OutboundOpenInfo
)
pub fn inject_fully_negotiated_outbound(
&mut self,
<<DummyProtocolsHandler as ProtocolsHandler>::OutboundProtocol as OutboundUpgrade<Negotiated<SubstreamRef<Arc<StreamMuxerBox>>>>>::Output,
<DummyProtocolsHandler as ProtocolsHandler>::OutboundOpenInfo
)
Injects the output of a successful upgrade on a new outbound substream. Read more
Injects an event coming from the outside in the handler.
Notifies the handler of a change in the address of the remote.
pub fn inject_dial_upgrade_error(
&mut self,
<DummyProtocolsHandler as ProtocolsHandler>::OutboundOpenInfo,
ProtocolsHandlerUpgrErr<<<DummyProtocolsHandler as ProtocolsHandler>::OutboundProtocol as OutboundUpgrade<Negotiated<SubstreamRef<Arc<StreamMuxerBox>>>>>::Error>
)
pub fn inject_dial_upgrade_error(
&mut self,
<DummyProtocolsHandler as ProtocolsHandler>::OutboundOpenInfo,
ProtocolsHandlerUpgrErr<<<DummyProtocolsHandler as ProtocolsHandler>::OutboundProtocol as OutboundUpgrade<Negotiated<SubstreamRef<Arc<StreamMuxerBox>>>>>::Error>
)
Indicates to the handler that upgrading an outbound substream to the given protocol has failed.
pub fn inject_listen_upgrade_error(
&mut self,
<DummyProtocolsHandler as ProtocolsHandler>::InboundOpenInfo,
ProtocolsHandlerUpgrErr<<<DummyProtocolsHandler as ProtocolsHandler>::InboundProtocol as InboundUpgrade<Negotiated<SubstreamRef<Arc<StreamMuxerBox>>>>>::Error>
)
pub fn inject_listen_upgrade_error(
&mut self,
<DummyProtocolsHandler as ProtocolsHandler>::InboundOpenInfo,
ProtocolsHandlerUpgrErr<<<DummyProtocolsHandler as ProtocolsHandler>::InboundProtocol as InboundUpgrade<Negotiated<SubstreamRef<Arc<StreamMuxerBox>>>>>::Error>
)
Indicates to the handler that upgrading an inbound substream to the given protocol has failed.
Returns until when the connection should be kept alive. Read more
pub fn poll(
&mut self,
&mut Context<'_>
) -> Poll<ProtocolsHandlerEvent<<DummyProtocolsHandler as ProtocolsHandler>::OutboundProtocol, <DummyProtocolsHandler as ProtocolsHandler>::OutboundOpenInfo, <DummyProtocolsHandler as ProtocolsHandler>::OutEvent, <DummyProtocolsHandler as ProtocolsHandler>::Error>>
pub fn poll(
&mut self,
&mut Context<'_>
) -> Poll<ProtocolsHandlerEvent<<DummyProtocolsHandler as ProtocolsHandler>::OutboundProtocol, <DummyProtocolsHandler as ProtocolsHandler>::OutboundOpenInfo, <DummyProtocolsHandler as ProtocolsHandler>::OutEvent, <DummyProtocolsHandler as ProtocolsHandler>::Error>>
Should behave like Stream::poll()
.
fn map_in_event<TNewIn, TMap>(self, map: TMap) -> MapInEvent<Self, TNewIn, TMap> where
TMap: Fn(&TNewIn) -> Option<&Self::InEvent>,
fn map_in_event<TNewIn, TMap>(self, map: TMap) -> MapInEvent<Self, TNewIn, TMap> where
TMap: Fn(&TNewIn) -> Option<&Self::InEvent>,
Adds a closure that turns the input event into something else.
fn map_out_event<TMap, TNewOut>(self, map: TMap) -> MapOutEvent<Self, TMap> where
TMap: FnMut(Self::OutEvent) -> TNewOut,
fn map_out_event<TMap, TNewOut>(self, map: TMap) -> MapOutEvent<Self, TMap> where
TMap: FnMut(Self::OutEvent) -> TNewOut,
Adds a closure that turns the output event into something else.
Creates a new ProtocolsHandler
that selects either this handler or
other
by delegating methods calls appropriately. Read more
Creates a builder that allows creating a NodeHandler
that handles this protocol
exclusively. Read more
Auto Trait Implementations
impl RefUnwindSafe for DummyProtocolsHandler
impl Send for DummyProtocolsHandler
impl Sync for DummyProtocolsHandler
impl Unpin for DummyProtocolsHandler
impl UnwindSafe for DummyProtocolsHandler
Blanket Implementations
Mutably borrows from an owned value. Read more
type Handler = T
type Handler = T
The protocols handler.
Builds the protocols handler. Read more
pub fn inbound_protocol(
&self
) -> <<T as IntoProtocolsHandler>::Handler as ProtocolsHandler>::InboundProtocol
pub fn inbound_protocol(
&self
) -> <<T as IntoProtocolsHandler>::Handler as ProtocolsHandler>::InboundProtocol
Return the handler’s inbound protocol.
Builds an implementation of IntoProtocolsHandler
that handles both this protocol and the
other one together. Read more
Creates a builder that will allow creating a NodeHandler
that handles this protocol
exclusively. Read more