Struct HyperListener

pub struct HyperListener<In: RpcMessage, Out: RpcMessage> { /* private fields */ }

A listener using a hyper server

Each request made by the any client connection this channel will yield a (recv, send) pair which allows receiving the request and sending the response. Both these are channels themselves to support streaming requests and responses.

Creating this spawns a tokio task which runs the server, once dropped this task is shut down: no new connections will be accepted and existing channels will stop.

Implementations

impl<In: RpcMessage, Out: RpcMessage> HyperListener<In, Out>

pub fn serve(addr: &SocketAddr) -> Result<Self>

Creates a server listening on the SocketAddr, with the default configuration.

pub fn serve_with_config( addr: &SocketAddr, config: ChannelConfig, ) -> Result<Self>

Creates a server listening on the SocketAddr with a custom configuration.

Trait Implementations

impl<In: RpcMessage, Out: RpcMessage> Clone for HyperListener<In, Out>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<In: RpcMessage, Out: RpcMessage> ConnectionErrors for HyperListener<In, Out>

type SendError = SendError

Error when sending a message via a channel

type RecvError = RecvError

Error when receiving a message via a channel

type OpenError = AcceptError

Error when opening a channel

type AcceptError = AcceptError

Error when accepting a channel

impl<In: Debug + RpcMessage, Out: Debug + RpcMessage> Debug for HyperListener<In, Out>

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

Formats the value using the given formatter.

impl<In: RpcMessage, Out: RpcMessage> Listener for HyperListener<In, Out>

fn local_addr(&self) -> &[LocalAddr]

The local addresses this endpoint is bound to.

async fn accept( &self, ) -> Result<(Self::SendSink, Self::RecvStream), AcceptError>

Accept a new typed bidirectional channel on any of the connections we have currently opened.

fn boxed(self) -> BoxedListener<Self::In, Self::Out>

where Self: BoxableListener<Self::In, Self::Out> + Sized + 'static,

Box the listener

impl<In: RpcMessage, Out: RpcMessage> StreamTypes for HyperListener<In, Out>

type In = In

The type of messages that can be received on the channel

type Out = Out

The type of messages that can be sent on the channel

type RecvStream = RecvStream<In>

Receive side of a bidirectional typed channel

type SendSink = SendSink<Out>

Send side of a bidirectional typed channel