Struct DeviceProxy

pub struct DeviceProxy { /* private fields */ }

Implementations

impl DeviceProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.lowpan.spinel/Device.

pub fn take_event_stream(&self) -> DeviceEventStream

Get a Stream of events from the remote end of the protocol.

Panics

Panics if the event stream was already taken.

pub fn open( &self, ) -> QueryResponseFut<DeviceOpenResult, DefaultFuchsiaResourceDialect>

Opens the Spinel connection and performs initialization.

This method will block until the Device is ready to use or an error has been encountered. If an error is indicated, the device is still considered closed.

Calling this method will typically induce reset if supported by the underlying hardware. It may be called while the device is already open in order to trigger a reset.

Possible error codes:

• Error::IO_ERROR: An IO error occurred.
• Error::UNSPECIFIED: An unspecified error occurred. See logs for more details.

pub fn close( &self, ) -> QueryResponseFut<DeviceCloseResult, DefaultFuchsiaResourceDialect>

Close the Spinel connection.

This method will block until the Device has successfully been put into a closed (preferably low-power) state. An error may be indicated if a problem was encountered that may indicate the device did not close cleanly.

Calling this method will always cause this interface to be closed, even if an error is reported. Thus, the error may be simply ignored or logged.

Calling this method when the device is already closed will do nothing.

Possible error codes:

• Error::IO_ERROR: An IO error occurred.
• Error::UNSPECIFIED: An unspecified error occurred. See logs for more details.

pub fn get_max_frame_size( &self, ) -> QueryResponseFut<u32, DefaultFuchsiaResourceDialect>

Fetch the max frame size.

This method may be called at any time. The returned value is an implementation-specific constant.

@return The size of the largest frame that this implementation supports being passed into SendFrame().

pub fn send_frame(&self, data: &[u8]) -> Result<(), Error>

Sends a Spinel-formatted frame to the device.

Calling this method while the device is closed will cause the frame to be dropped and ->OnError() to emit Error::CLOSED.

See ->OnReadyForSendFrames() for flow-control considerations.

pub fn ready_to_receive_frames( &self, number_of_frames: u32, ) -> Result<(), Error>

Increases the number of additional frames that the caller is currently ready to receive, as a method of inbound flow-control.

The caller can use this method to regulate the speed at which inbound frames are handled. This method should be called periodically to ensure low-latency frame delivery.

Calling this method with a non-zero value indicates to the receiver that the caller is ready to receive the specified additional number of frames.

This method SHOULD NOT be called with a value of zero. If the receiver gets this call with a value of zero, it MUST be ignored.

Frames will not be received until this method is first called with a non-zero value. Once received, the receiver will limit the number of subsequent frames emitted via ->OnReceiveFrame() to the given number of frames.

Calling this method while the device is closed will do nothing.

A reasonable usage pattern would be to first call this method with a value of 4, calling it again with a value of 2 after every second received inbound frame.

Outbound flow control is similarly accomplished via ->OnReadyForSendFrames().

Trait Implementations

impl Clone for DeviceProxy

fn clone(&self) -> DeviceProxy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DeviceProxy

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

Formats the value using the given formatter.

impl DeviceProxyInterface for DeviceProxy

type OpenResponseFut = QueryResponseFut<Result<(), Error>>

type CloseResponseFut = QueryResponseFut<Result<(), Error>>

type GetMaxFrameSizeResponseFut = QueryResponseFut<u32>

fn open(&self) -> Self::OpenResponseFut

fn close(&self) -> Self::CloseResponseFut

fn get_max_frame_size(&self) -> Self::GetMaxFrameSizeResponseFut

fn send_frame(&self, data: &[u8]) -> Result<(), Error>

fn ready_to_receive_frames(&self, number_of_frames: u32) -> Result<(), Error>

impl Proxy for DeviceProxy

type Protocol = DeviceMarker

The protocol which this Proxy controls.

fn from_channel(inner: AsyncChannel) -> Self

Create a proxy over the given channel.

fn into_channel(self) -> Result<AsyncChannel, Self>

Attempt to convert the proxy back into a channel.

fn as_channel(&self) -> &AsyncChannel

Get a reference to the proxy’s underlying channel.

fn into_client_end(self) -> Result<ClientEnd<Self::Protocol>, Self>

Attempt to convert the proxy back into a client end.

fn is_closed(&self) -> bool

Returns true if the proxy has received the PEER_CLOSED signal.

fn on_closed(&self) -> OnSignals<'_, Unowned<'_, Handle>>

Returns a future that completes when the proxy receives the PEER_CLOSED signal.