Module adapter

Module that specify the pattern to follow to create adapters. This module is not part of the public API itself, it must be used from the internals to build new adapters.

Structs

ConnectionInfo

Plain struct used as a returned value of Remote::connect_with()

ListeningInfo

Plain struct used as a returned value of Local::listen_with()

Enums

AcceptedType

Used as a parameter callback in Local::accept()

PendingStatus

ReadStatus

Returned as a result of Remote::receive()

SendStatus

The following represents the posible status that crate::network::NetworkController::send() call can return. The library do not encourage to perform the check of this status for each send() call, only in that cases where you need extra information about how the sending method was.

Traits

Adapter

High level trait to represent an adapter for a transport protocol. The adapter is only used to identify the resources of your adapter.

Local

The resource used to represent a local listener. It usually is a wrapper over a socket/listener.

Remote

The resource used to represent a remote. It usually is a wrapper over a socket/stream.

Resource

A Resource is defined as an object that can return a mutable reference to a Source. Source is the trait that mio uses to register in the poll in order to wake up asynchronously from events. Your Remote and Local entities must implement Resource.