Struct EnergyScanProxy

pub struct EnergyScanProxy { /* private fields */ }

Implementations

impl EnergyScanProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.lowpan.device/EnergyScan.

pub fn take_event_stream(&self) -> EnergyScanEventStream

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

Panics

Panics if the event stream was already taken.

pub fn start_energy_scan( &self, params: &EnergyScanParameters, stream: ServerEnd<EnergyScanResultStreamMarker>, ) -> Result<(), Error>

Starts an energy scan operation.

This can be used for surveying the spectrum 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.

Performing energy scans could be used to profile the spectrum energy for a location and thus be used to determine or refine coarse location information.

Trait Implementations

impl Clone for EnergyScanProxy

fn clone(&self) -> EnergyScanProxy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EnergyScanProxy

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

Formats the value using the given formatter.

impl EnergyScanProxyInterface for EnergyScanProxy

fn start_energy_scan( &self, params: &EnergyScanParameters, stream: ServerEnd<EnergyScanResultStreamMarker>, ) -> Result<(), Error>

impl Proxy for EnergyScanProxy

type Protocol = EnergyScanMarker

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.