Struct Session 

pub struct Session;

The type corresponding to the Session protocol. Represents a session with a Network device.

A session has a data plane and a control plane. The Session protocol represents the control plane of the session and the FIFOs and VMOs exchanged during the [Device.OpenSession] call are the data plane. Lifetime of the session is controlled by a Session protocol handle.

Sessions must attach to ports of interest to start receiving and sending data. Sessions are always created with no ports attached.

If a port is destroyed from the underlying device, it is automatically detached from the session.

Inbound traffic is dispatched to all open sessions. Devices typically operate with a single primary session, see [SessionFlags.PRIMARY]. Each additional open session to the same device causes data copy overhead on the device’s data path.

The session is closed with an error epitaph if an invalid buffer descriptor is sent over either the tx or rx FIFOs. Invalid descriptors include: - Descriptor index larger than [SessionInfo.descriptor_count]. - Descriptor chains larger than MAX_DESCRIPTOR_CHAIN. - rx buffers smaller than [Info.min_rx_buffer_length]. - tx buffers smaller than [Info.min_tx_buffer_length]. - tx buffers not respecting [Info.min_tx_buffer_head] or [Info.min_tx_buffer_tail].

Trait Implementations

impl Debug for Session

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

Formats the value using the given formatter.

impl<___H, ___T> DispatchClientMessage<___H, ___T> for Session

where ___H: SessionClientHandler<___T> + Send, ___T: Transport,

async fn on_event( handler: &mut ___H, message: Message<___T>, ) -> Result<(), ProtocolError<___T::Error>>

Handles a received client event with the given handler.

impl<___H, ___T> DispatchLocalClientMessage<___H, ___T> for Session

where ___H: SessionLocalClientHandler<___T>, ___T: Transport,

async fn on_event( handler: &mut ___H, message: Message<___T>, ) -> Result<(), ProtocolError<___T::Error>>

Handles a received client event with the given handler.

impl<___H, ___T> DispatchLocalServerMessage<___H, ___T> for Session

where ___H: SessionLocalServerHandler<___T>, ___T: Transport, for<'de> SessionAttachRequest<'de>: Decode<<<___T as Transport>::RecvBuffer as AsDecoder<'de>>::Decoder, Constraint = ()>, for<'de> SessionDetachRequest: Decode<<<___T as Transport>::RecvBuffer as AsDecoder<'de>>::Decoder, Constraint = ()>, for<'de> SessionRegisterForTxRequest<'de>: Decode<<<___T as Transport>::RecvBuffer as AsDecoder<'de>>::Decoder, Constraint = ()>, for<'de> SessionUnregisterForTxRequest<'de>: Decode<<<___T as Transport>::RecvBuffer as AsDecoder<'de>>::Decoder, Constraint = ()>,

async fn on_one_way( handler: &mut ___H, message: Message<___T>, ) -> Result<(), ProtocolError<<___T as Transport>::Error>>

Handles a received server one-way message with the given handler.

async fn on_two_way( handler: &mut ___H, message: Message<___T>, responder: Responder<___T>, ) -> Result<(), ProtocolError<<___T as Transport>::Error>>

Handles a received server two-way message with the given handler.

impl<___H, ___T> DispatchServerMessage<___H, ___T> for Session

where ___H: SessionServerHandler<___T> + Send, ___T: Transport, for<'de> SessionAttachRequest<'de>: Decode<<<___T as Transport>::RecvBuffer as AsDecoder<'de>>::Decoder, Constraint = ()>, for<'de> SessionDetachRequest: Decode<<<___T as Transport>::RecvBuffer as AsDecoder<'de>>::Decoder, Constraint = ()>, for<'de> SessionRegisterForTxRequest<'de>: Decode<<<___T as Transport>::RecvBuffer as AsDecoder<'de>>::Decoder, Constraint = ()>, for<'de> SessionUnregisterForTxRequest<'de>: Decode<<<___T as Transport>::RecvBuffer as AsDecoder<'de>>::Decoder, Constraint = ()>,

async fn on_one_way( handler: &mut ___H, message: Message<___T>, ) -> Result<(), ProtocolError<<___T as Transport>::Error>>

Handles a received server one-way message with the given handler.

async fn on_two_way( handler: &mut ___H, message: Message<___T>, responder: Responder<___T>, ) -> Result<(), ProtocolError<<___T as Transport>::Error>>

Handles a received server two-way message with the given handler.

impl<___T> HasConnectionHandles<___T> for Session

where ___T: Transport,

type Client = SessionClient<___T>

The client for the protocol. It must be a #[repr(transparent)] wrapper around Client<T>.

type Server = SessionServer<___T>

The server for the protocol. It must be a #[repr(transparent)] wrapper around Server<T>.

impl HasTransport for Session

Available on Fuchsia only.

type Transport = Channel

The default transport type for this protocol.

impl PartialEq for Session

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Session