Struct EnergyScanSynchronousProxy

pub struct EnergyScanSynchronousProxy { /* private fields */ }

Implementations

impl EnergyScanSynchronousProxy

pub fn new(channel: Channel) -> Self

pub fn into_channel(self) -> Channel

pub fn wait_for_event( &self, deadline: MonotonicInstant, ) -> Result<EnergyScanEvent, 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 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 Debug for EnergyScanSynchronousProxy

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

Formats the value using the given formatter.

impl SynchronousProxy for EnergyScanSynchronousProxy

type Proxy = EnergyScanProxy

The async proxy for the same protocol.

type Protocol = EnergyScanMarker

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.