Struct Connection 

pub struct Connection<Bindings: ConnectionBindings> { /* private fields */ }

A bidirectional, message-oriented AsyncRead/AsyncWrite stream wrapper.

Connections are Futures that you spawn. To send messages, you push them into the outbound message stream. To receive messages, you implement a MessageReactor.

Inbound messages are not wrapped in a Stream, in order to avoid an extra layer of async buffering. If you need to buffer messages or forward them to a Stream, you can do so in the reactor. If you can process them very quickly, you can handle them inline in the reactor callback on_messages, which will let you reply as soon as possible.

Implementations

impl<Bindings: ConnectionBindings> Connection<Bindings>

where <Bindings::Deserializer as Deserializer>::Message: Send,

pub fn new( stream: Bindings::Stream, address: SocketAddr, deserializer: Bindings::Deserializer, serializer: Bindings::Serializer, max_buffer_length: usize, buffer_allocation_increment: usize, max_queued_send_messages: usize, outbound_messages: Receiver<<Bindings::Serializer as Serializer>::Message>, reactor: Bindings::Reactor, ) -> Connection<Bindings>

Create a new protosocket Connection with the given stream and reactor.

Probably you are interested in the protosocket-server or protosocket-prost crates.

Trait Implementations

impl<Bindings: ConnectionBindings> Display for Connection<Bindings>

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

Formats the value using the given formatter.

impl<Lifecycle: ConnectionBindings> Drop for Connection<Lifecycle>

fn drop(&mut self)

Executes the destructor for this type.

impl<Bindings: ConnectionBindings> Future for Connection<Bindings>

fn poll(self: Pin<&mut Self>, context: &mut Context<'_>) -> Poll<Self::Output>

Take a look at ConnectionBindings for the type definitions used by the Connection

This method performs the following steps:

1. Check for read readiness and read into the receive_buffer (up to max_buffer_length).
2. Deserialize the read bytes into Messages and store them in the inbound_messages queue.
3. Dispatch messages as they are deserialized using the user-provided MessageReactor.
4. Serialize messages from outbound_messages queue, up to max_queued_send_messages.
5. Send serialized messages.

type Output = ()

The type of value produced on completion.

impl<Bindings: ConnectionBindings> Unpin for Connection<Bindings>