pub struct OneShotHandler<TInbound, TOutbound, TEvent>where
    TOutbound: OutboundUpgradeSend,{ /* private fields */ }
Expand description

A ConnectionHandler that opens a new substream for each request.

Implementations§

source§

impl<TInbound, TOutbound, TEvent> OneShotHandler<TInbound, TOutbound, TEvent>where TOutbound: OutboundUpgradeSend,

source

pub fn new( listen_protocol: SubstreamProtocol<TInbound, ()>, config: OneShotHandlerConfig ) -> OneShotHandler<TInbound, TOutbound, TEvent>

Creates a OneShotHandler.

source

pub fn pending_requests(&self) -> u32

Returns the number of pending requests.

source

pub fn listen_protocol_ref(&self) -> &SubstreamProtocol<TInbound, ()>

Returns a reference to the listen protocol configuration.

Note: If you modify the protocol, modifications will only applies to future inbound substreams, not the ones already being negotiated.

source

pub fn listen_protocol_mut(&mut self) -> &mut SubstreamProtocol<TInbound, ()>

Returns a mutable reference to the listen protocol configuration.

Note: If you modify the protocol, modifications will only applies to future inbound substreams, not the ones already being negotiated.

source

pub fn send_request(&mut self, upgrade: TOutbound)

Opens an outbound substream with upgrade.

Trait Implementations§

source§

impl<TInbound, TOutbound, TEvent> ConnectionHandler for OneShotHandler<TInbound, TOutbound, TEvent>where TInbound: InboundUpgradeSend + Send + 'static, TOutbound: Debug + OutboundUpgradeSend, <TInbound as InboundUpgradeSend>::Output: Into<TEvent>, <TOutbound as OutboundUpgradeSend>::Output: Into<TEvent>, <TOutbound as OutboundUpgradeSend>::Error: Error + Send + 'static, SubstreamProtocol<TInbound, ()>: Clone, TEvent: Debug + Send + 'static,

§

type InEvent = TOutbound

Custom event that can be received from the outside.
§

type OutEvent = TEvent

Custom event that can be produced by the handler and that will be returned to the outside.
§

type Error = ConnectionHandlerUpgrErr<<<OneShotHandler<TInbound, TOutbound, TEvent> as ConnectionHandler>::OutboundProtocol as OutboundUpgradeSend>::Error>

The type of errors returned by ConnectionHandler::poll.
§

type InboundProtocol = TInbound

The inbound upgrade for the protocol(s) used by the handler.
§

type OutboundProtocol = TOutbound

The outbound upgrade for the protocol(s) used by the handler.
§

type OutboundOpenInfo = ()

The type of additional information passed to an OutboundSubstreamRequest.
§

type InboundOpenInfo = ()

The type of additional information returned from listen_protocol.
source§

fn listen_protocol( &self ) -> SubstreamProtocol<<OneShotHandler<TInbound, TOutbound, TEvent> as ConnectionHandler>::InboundProtocol, <OneShotHandler<TInbound, TOutbound, TEvent> as ConnectionHandler>::InboundOpenInfo>

The InboundUpgrade to apply on inbound substreams to negotiate the desired protocols. Read more
source§

fn on_behaviour_event( &mut self, event: <OneShotHandler<TInbound, TOutbound, TEvent> as ConnectionHandler>::InEvent )

Informs the handler about an event from the NetworkBehaviour.
source§

fn connection_keep_alive(&self) -> KeepAlive

Returns until when the connection should be kept alive. Read more
source§

fn poll( &mut self, _: &mut Context<'_> ) -> Poll<ConnectionHandlerEvent<<OneShotHandler<TInbound, TOutbound, TEvent> as ConnectionHandler>::OutboundProtocol, <OneShotHandler<TInbound, TOutbound, TEvent> as ConnectionHandler>::OutboundOpenInfo, <OneShotHandler<TInbound, TOutbound, TEvent> as ConnectionHandler>::OutEvent, <OneShotHandler<TInbound, TOutbound, TEvent> as ConnectionHandler>::Error>>

Should behave like Stream::poll().
source§

fn on_connection_event( &mut self, event: ConnectionEvent<'_, <OneShotHandler<TInbound, TOutbound, TEvent> as ConnectionHandler>::InboundProtocol, <OneShotHandler<TInbound, TOutbound, TEvent> as ConnectionHandler>::OutboundProtocol, <OneShotHandler<TInbound, TOutbound, TEvent> as ConnectionHandler>::InboundOpenInfo, <OneShotHandler<TInbound, TOutbound, TEvent> as ConnectionHandler>::OutboundOpenInfo> )

source§

fn inject_fully_negotiated_inbound( &mut self, protocol: <Self::InboundProtocol as InboundUpgradeSend>::Output, info: Self::InboundOpenInfo )

👎Deprecated since 0.41.0: Handle ConnectionEvent::FullyNegotiatedInbound on ConnectionHandler::on_connection_event instead. The default implemention of this inject_* method delegates to it.
Injects the output of a successful upgrade on a new inbound substream. Read more
source§

fn inject_fully_negotiated_outbound( &mut self, protocol: <Self::OutboundProtocol as OutboundUpgradeSend>::Output, info: Self::OutboundOpenInfo )

👎Deprecated since 0.41.0: Handle ConnectionEvent::FullyNegotiatedOutbound on ConnectionHandler::on_connection_event instead. The default implemention of this inject_* method delegates to it.
Injects the output of a successful upgrade on a new outbound substream. Read more
source§

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

👎Deprecated since 0.41.0: Implement ConnectionHandler::on_behaviour_event instead. The default implementation of inject_event delegates to it.
Injects an event coming from the outside in the handler.
source§

fn inject_address_change(&mut self, new_address: &Multiaddr)

👎Deprecated since 0.41.0: Handle ConnectionEvent::AddressChange on ConnectionHandler::on_connection_event instead. The default implemention of this inject_* method delegates to it.
Notifies the handler of a change in the address of the remote.
source§

fn inject_dial_upgrade_error( &mut self, info: Self::OutboundOpenInfo, error: ConnectionHandlerUpgrErr<<Self::OutboundProtocol as OutboundUpgradeSend>::Error> )

👎Deprecated since 0.41.0: Handle ConnectionEvent::DialUpgradeError on ConnectionHandler::on_connection_event instead. The default implemention of this inject_* method delegates to it.
Indicates to the handler that upgrading an outbound substream to the given protocol has failed.
source§

fn inject_listen_upgrade_error( &mut self, info: Self::InboundOpenInfo, error: ConnectionHandlerUpgrErr<<Self::InboundProtocol as InboundUpgradeSend>::Error> )

👎Deprecated since 0.41.0: Handle ConnectionEvent::ListenUpgradeError on ConnectionHandler::on_connection_event instead. The default implemention of this inject_* method delegates to it.
Indicates to the handler that upgrading an inbound substream to the given protocol has failed.
source§

fn map_in_event<TNewIn, TMap>(self, map: TMap) -> MapInEvent<Self, TNewIn, TMap>where Self: Sized, TMap: Fn(&TNewIn) -> Option<&Self::InEvent>,

Adds a closure that turns the input event into something else.
source§

fn map_out_event<TMap, TNewOut>(self, map: TMap) -> MapOutEvent<Self, TMap>where Self: Sized, TMap: FnMut(Self::OutEvent) -> TNewOut,

Adds a closure that turns the output event into something else.
source§

fn select<TProto2>( self, other: TProto2 ) -> ConnectionHandlerSelect<Self, TProto2>where Self: Sized,

Creates a new ConnectionHandler that selects either this handler or other by delegating methods calls appropriately. Read more
source§

impl<TInbound, TOutbound, TEvent> Default for OneShotHandler<TInbound, TOutbound, TEvent>where TOutbound: OutboundUpgradeSend, TInbound: InboundUpgradeSend + Default,

source§

fn default() -> OneShotHandler<TInbound, TOutbound, TEvent>

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<TInbound, TOutbound, TEvent> !RefUnwindSafe for OneShotHandler<TInbound, TOutbound, TEvent>

§

impl<TInbound, TOutbound, TEvent> Send for OneShotHandler<TInbound, TOutbound, TEvent>where TEvent: Send, TInbound: Send,

§

impl<TInbound, TOutbound, TEvent> Sync for OneShotHandler<TInbound, TOutbound, TEvent>where TEvent: Sync, TInbound: Sync, TOutbound: Sync, <TOutbound as OutboundUpgradeSend>::Error: Sync,

§

impl<TInbound, TOutbound, TEvent> Unpin for OneShotHandler<TInbound, TOutbound, TEvent>where TEvent: Unpin, TInbound: Unpin, TOutbound: Unpin, <TOutbound as OutboundUpgradeSend>::Error: Unpin,

§

impl<TInbound, TOutbound, TEvent> !UnwindSafe for OneShotHandler<TInbound, TOutbound, TEvent>

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere 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 Twhere 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> IntoConnectionHandler for Twhere T: ConnectionHandler,

§

type Handler = T

The protocols handler.
source§

fn into_handler(self, _: &PeerId, _: &ConnectedPoint) -> T

Builds the protocols handler. Read more
source§

fn inbound_protocol( &self ) -> <<T as IntoConnectionHandler>::Handler as ConnectionHandler>::InboundProtocol

Return the handler’s inbound protocol.
source§

fn select<TProto2>( self, other: TProto2 ) -> IntoConnectionHandlerSelect<Self, TProto2>where Self: Sized,

Builds an implementation of IntoConnectionHandler that handles both this protocol and the other one together.
source§

impl<T> Same<T> for T

§

type Output = T

Should always be Self
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

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 Twhere U: TryFrom<T>,

§

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