Struct SessionSynchronousProxy

pub struct SessionSynchronousProxy { /* private fields */ }

Implementations

impl SessionSynchronousProxy

pub fn new(channel: Channel) -> Self

pub fn into_channel(self) -> Channel

pub fn wait_for_event( &self, deadline: MonotonicInstant, ) -> Result<SessionEvent, Error>

Waits until an event arrives and returns it. It is safe for other threads to make concurrent requests while waiting for an event.

pub fn attach( &self, port: &PortId, rx_frames: &[FrameType], ___deadline: MonotonicInstant, ) -> Result<SessionAttachResult, Error>

Attaches the session to port.

Once attached, the session starts to receive the subscribed frames over the data FIFOs and it may send frames destined to the specified port.

• request port port to subscribe to.
• request rx_frames Frame types of interest on the port.

• error ZX_ERR_NOT_FOUND if port is not valid.
• error ZX_ERR_INVALID_ARGS if rx_frames is not a subset of the port’s supported frames.
• error ZX_ERR_ALREADY_BOUND if port is already attached.

pub fn detach( &self, port: &PortId, ___deadline: MonotonicInstant, ) -> Result<SessionDetachResult, Error>

Detaches the session from port.

Once detached, the session stops receiving frames from port. Frames sent to a detached port may be returned with an error. It is not necessary to call Detach on ports that are removed from the device, doing so causes ZX_ERR_NOT_FOUND to be returned.

• request port port to subscribe to.

• error ZX_ERR_NOT_FOUND if the session is not currently attached to the port.

pub fn close(&self) -> Result<(), Error>

Cleanly closes a session.

This will cause the session to send a ZX_ERR_CANCELLED epitaph and proceed to close the Session channel. Clients may only assume that they own all the buffers that are currently owned by the session (sent over either the rx or tx FIFOs) once the epitaph is received. Closing the rx or tx FIFO is equivalent to calling Close.

pub fn watch_delegated_rx_lease( &self, ___deadline: MonotonicInstant, ) -> Result<DelegatedRxLease, Error>

Watchers for delegated receive wakeup leases.

Calls block until a lease is delegated by the device. If a call to WatchDelegatedRxLease is made while a previous call is blocking, the session is closed with ZX_ERR_BAD_STATE. Will never yield any values for sessions created without [SessionFlags.RECEIVE_RX_POWER_LEASES].

Given a single lease is assumed sufficient to keep the system awake, the server only keeps a single lease in its buffer. If a new delegated lease becomes available and the client hasn’t popped the previous one with a call to WatchDelegatedRxLease, the server drops the previously pending lease.

See DelegatedRxLease for how to handle delegated leases.

Trait Implementations

impl Debug for SessionSynchronousProxy

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

Formats the value using the given formatter.

impl From<Channel> for SessionSynchronousProxy

fn from(value: Channel) -> Self

Converts to this type from the input type.

impl From<SessionSynchronousProxy> for Handle

fn from(value: SessionSynchronousProxy) -> Self

Converts to this type from the input type.

impl SynchronousProxy for SessionSynchronousProxy

type Proxy = SessionProxy

The async proxy for the same protocol.

type Protocol = SessionMarker

The protocol which this Proxy controls.

fn from_channel(inner: Channel) -> Self

Create a proxy over the given channel.

fn into_channel(self) -> Channel

Convert the proxy back into a channel.

fn as_channel(&self) -> &Channel

Get a reference to the proxy’s underlying channel.

fn is_closed(&self) -> Result<bool, Status>

Returns true if the proxy has received the PEER_CLOSED signal.