Struct DeviceExtraProxy

pub struct DeviceExtraProxy { /* private fields */ }

Implementations

impl DeviceExtraProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.lowpan.experimental/DeviceExtra.

pub fn take_event_stream(&self) -> DeviceExtraEventStream

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

Panics

Panics if the event stream was already taken.

pub fn form_network( &self, params: &ProvisioningParams, progress: ServerEnd<ProvisioningMonitorMarker>, ) -> Result<(), Error>

Forms a new network with the given provisioning parameters.

Any unspecified fields that are required by the underlying device or network type will assigned with default values. If the credential is unspecified, a random one will be generated automatically.

This method will cause the device to leave any previously provisioned network.

Calling this method while the device is not active will implicitly make the device active.

Upon success, the device will be active and provisioned for the newly created network.

The progress of the operation can be monitored via the ProvisioningMonitor protocol instance. The operation may be cancelled by closing the ProvisioningMonitor.

Calling this method will cause any current form, join, or commission operation to be canceled.

pub fn join_network( &self, params: &JoinParams, progress: ServerEnd<ProvisioningMonitorMarker>, ) -> Result<(), Error>

Attempts to join a pre-existing nearby network with the given provisioning parameters or joiner parameters.

In-band commissioning is supported.

Upon success, the device will be active and provisioned for the newly created network.

The progress of the operation can be monitored via the ProvisioningMonitor protocol instance. The operation may be cancelled by closing the ProvisioningMonitor.

Calling this method will cause any current form, join, or commission operation to be canceled.

pub fn start_network_scan( &self, params: &NetworkScanParameters, stream: ServerEnd<BeaconInfoStreamMarker>, ) -> Result<(), Error>

Starts an active network scan operation.

This scan is used to identify other nearby networks in order to identify channels that should be avoided.

The scan operation may be cancelled by closing the stream protocol.

If a scan is started while another scan is in progress, the previous scan is allowed to complete before the new scan executes and starts returning results.

All scans should be expected to completely occupy the LoWPAN device while it is in progress, preventing other operations from completing until the scan has completed. Additionally, all network packets should be expected to be dropped while a scan is in progress.

A [BeaconInfoStream] instance could be used to expose coarse location information.

Trait Implementations

impl Clone for DeviceExtraProxy

fn clone(&self) -> DeviceExtraProxy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DeviceExtraProxy

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

Formats the value using the given formatter.

impl DeviceExtraProxyInterface for DeviceExtraProxy

fn form_network( &self, params: &ProvisioningParams, progress: ServerEnd<ProvisioningMonitorMarker>, ) -> Result<(), Error>

fn join_network( &self, params: &JoinParams, progress: ServerEnd<ProvisioningMonitorMarker>, ) -> Result<(), Error>

fn start_network_scan( &self, params: &NetworkScanParameters, stream: ServerEnd<BeaconInfoStreamMarker>, ) -> Result<(), Error>

impl Proxy for DeviceExtraProxy

type Protocol = DeviceExtraMarker

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.