Struct ClientControllerSynchronousProxy

pub struct ClientControllerSynchronousProxy { /* private fields */ }

Implementations

impl ClientControllerSynchronousProxy

pub fn new(channel: Channel) -> Self

pub fn into_channel(self) -> Channel

pub fn wait_for_event( &self, deadline: MonotonicInstant, ) -> Result<ClientControllerEvent, 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_client_connections( &self, ___deadline: MonotonicInstant, ) -> Result<RequestStatus, Error>

Enables WLAN client functionality. Once enabled, automatic connections will be attempted for saved networks, and callers can initiate operations via the ScanForNetworks() and Connect() APIs. Depending on the underlying capabilities of the device, this call may impact other device operation (for example, acting as an access point). The returned status represents acknowledgement of the request. The ClientListener protocol should be monitored to learn when client functionality has been enabled.

pub fn stop_client_connections( &self, ___deadline: MonotonicInstant, ) -> Result<RequestStatus, Error>

Tears down any existing connections to wlan networks and disables initiation of new connections. The returned status represents acknowledgements of the request. The ClientListener protocol should be monitored to learn when client functionality has been disabled.

pub fn scan_for_networks( &self, iterator: ServerEnd<ScanResultIteratorMarker>, ) -> Result<(), Error>

Triggers a network scan. Note, even in normal operation, some scan requests may be rejected due to timing with connection establishment or other critical connection maintenance. If the scan is cancelled or errors, the caller is notified via a status update in the ScanResultIterator. In the current implementation, client connections must be started for a scan to be performed.

pub fn save_network( &self, config: &NetworkConfig, ___deadline: MonotonicInstant, ) -> Result<ClientControllerSaveNetworkResult, Error>

Saves a network and any credential information needed to connect. Multiple entries for the same NetworkIdentifier can exist if the credentials are different. If a caller attempts to save a NetworkConfig with the same NetworkIdentifier and same Credentials as a previously saved network the method will effectively be a no-op. Saved networks will be used to autoconnect, and are also available to use with the Connect() API.

pub fn remove_network( &self, config: &NetworkConfig, ___deadline: MonotonicInstant, ) -> Result<ClientControllerRemoveNetworkResult, Error>

Removes a saved network configuration, if one exists. This method will automatically trigger a disconnection if the NetworkConfig was used to establish the connection.

pub fn get_saved_networks( &self, iterator: ServerEnd<NetworkConfigIteratorMarker>, ) -> Result<(), Error>

Retrieve the currently saved networks using the provided iterator.

pub fn connect( &self, id: &NetworkIdentifier, ___deadline: MonotonicInstant, ) -> Result<RequestStatus, Error>

Request to attempt a connection to the specified network. The target of the connect call must already be a saved network. This call is not a blocking call for the duration of the connection attempt. If the call cannot be immediately attempted, a failure status will be returned. If the connection request will be attempted, an acknowledgment status will be returned. Updates to the connection status are disseminated via the ClientStateUpdates protocol. If the connect attempt fails, the service will fall back to default behavior with scanning and connecting via network selection.

Trait Implementations

impl Debug for ClientControllerSynchronousProxy

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

Formats the value using the given formatter.

impl SynchronousProxy for ClientControllerSynchronousProxy

type Proxy = ClientControllerProxy

The async proxy for the same protocol.

type Protocol = ClientControllerMarker

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.