pub enum DeviceRequest {
    ProvisionNetwork {
        params: ProvisioningParams,
        responder: DeviceProvisionNetworkResponder,
    },
    LeaveNetwork {
        responder: DeviceLeaveNetworkResponder,
    },
    SetActive {
        active: bool,
        responder: DeviceSetActiveResponder,
    },
    GetSupportedNetworkTypes {
        responder: DeviceGetSupportedNetworkTypesResponder,
    },
    WatchDeviceState {
        responder: DeviceWatchDeviceStateResponder,
    },
}
Expand description

LoWPAN Device Protocol.

This protocol provides clients with a way to control and monitor the device.

Note that aspects of the device that deal with PII must be monitored and controlled via the [DeviceExtra] protocol.

Variants§

§

ProvisionNetwork

Provision the interface for the network described by identity and credential. This is similar to JoinNetwork, except that (assuming the identity and credential are valid) it will (assuming all preconditions are met) always succeed, even if there are no peers nearby.

The following fields of ProvisioningParams MUST be specified:

  • identity.raw_name
  • identity.xpanid
  • identity.panid
  • identity.channel_index
  • credential

If any of the required fields are unspecified, the channel will be closed with the epitaph ZX_ERR_INVALID_ARGUMENT.

Additionally, if the identity.net_type field is present and does not match a network type supported by this device, the channel will also be closed with the epitaph ZX_ERR_NOT_SUPPORTED.

This method returns once the device has been reconfigured successfully. The resulting change in state can be monitored via WatchDeviceState(). Any error that prevents the operation from completing successfully will result in the protocol being closed.

§

LeaveNetwork

Bring down the network interface and forget all non-volatile details about the current network.

Upon completion, all non-volatile and transient state about the current network is cleared and the interface will be offline.

Specifically, calling this method will cause the following observable effects:

  • DeviceState.connectivity_state will transition to State::OFFLINE, assuming it wasn’t in that state already.
  • DeviceExtra::WatchIdentity will emit an empty Identity, assuming it wasn’t already empty.

If the interface was not previously provisioned, calling this method does nothing.

§

SetActive

Fields

§active: bool

Activate (“bring-up”) or deactivate (“shut-down”) the network interface.

Note that simply setting this to true does not mean that the network interface will necessarily become online and usable, see the connectivity_state field of the DeviceState table for more information.

This method returns once the operation has completed successfully. The resulting change in state can be monitored via WatchDeviceState(). Any error that prevents the operation from completing successfully will result in the protocol being closed.

§

GetSupportedNetworkTypes

Returns the types of networks supported by this interface.

LoWPAN devices typically only support a single network type, but some devices may support more than one. Up to MAX_NETWORK_TYPES network types may be returned.

§

WatchDeviceState

Observes changes to the DeviceState.

First call always returns a snapshot of the current state. Subsequent calls will block until the state has changed and returns the delta against the device’s internal state.

Changes are not queued. The returned value always represents the latest and most accurate state values, even if several changes had happened in-between calls.

Implementations§

Trait Implementations§

source§

impl Debug for DeviceRequest

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> Encode<Ambiguous1> for T

§

unsafe fn encode( self, _encoder: &mut Encoder<'_>, _offset: usize, _depth: Depth ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more
§

impl<T> Encode<Ambiguous2> for T

§

unsafe fn encode( self, _encoder: &mut Encoder<'_>, _offset: usize, _depth: Depth ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more