Struct DatasetSynchronousProxy

pub struct DatasetSynchronousProxy { /* private fields */ }

Implementations

impl DatasetSynchronousProxy

pub fn new(channel: Channel) -> Self

pub fn into_channel(self) -> Channel

pub fn wait_for_event( &self, deadline: MonotonicInstant, ) -> Result<DatasetEvent, 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 get_active_tlvs( &self, ___deadline: MonotonicInstant, ) -> Result<Option<Vec<u8>>, Error>

Fetches and returns the active Thread operational dataset in raw TLV form. Functionally equivalent to otDatasetGetActiveTlvs().

This method returns the active dataset, or nothing in the case that there is no active operational dataset.

Any error that prevents the operation from completing successfully will result in the protocol being closed.

pub fn set_active_tlvs( &self, dataset: &[u8], ___deadline: MonotonicInstant, ) -> Result<(), Error>

Sets the active Thread Operational Dataset in raw TLV form. Functionally equivalent to otDatasetSetActiveTlvs().

This method returns once the operation has completed successfully.

Any error that prevents the operation from completing successfully will result in the protocol being closed.

pub fn attach_all_nodes_to( &self, dataset: &[u8], ___deadline: MonotonicInstant, ) -> Result<i64, Error>

Requests that all nodes on the current network attach to the thread network described by given dataset. Returns the number of milliseconds until the change takes effect.

Functionally equivalent to ot-br-posix’s AttachAllNodesTo.

If this device is not currently provisioned, then calling this method is equivalent to calling [SetActiveTlvs()].

The transition of all nodes to the new network may take as long as five minutes. The exact amount of time until the network is transitioned is returned by this method.

This method returns once the transition has been scheduled successfully. Any error that prevents the scheduling of this operation from completing successfully (such as being provided with an incomplete dataset) will result in the protocol being closed.

Trait Implementations

impl Debug for DatasetSynchronousProxy

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

Formats the value using the given formatter.

impl SynchronousProxy for DatasetSynchronousProxy

type Proxy = DatasetProxy

The async proxy for the same protocol.

type Protocol = DatasetMarker

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.