Struct sl4f_lib::wlan_policy::facade::WlanPolicyFacade

pub struct WlanPolicyFacade { /* private fields */ }

Implementations

impl WlanPolicyFacade

pub fn new() -> Result<WlanPolicyFacade, Error>

pub async fn create_client_controller(&self) -> Result<(), Error>

Create a client controller and listen for client state updates. If the facade already has a client controller, recreate it and start listening for client state updates again. See WlanPolicyFacade::get_update() for details about listening for updates.

A client controller is necessary to access the fuchsia.wlan.policy.ClientController API. Only one caller can have the control channel open at a time.

pub fn drop_client_controller(&self)

Drop the facade’s client controller so that something else can get a controller.

pub fn set_new_listener(&self) -> Result<(), Error>

This function will set a new listener even if there is one because new listeners will get the most recent update immediately without waiting. This might be used to set the facade’s listener update stream if it wasn’t set by creating the client controller or to set a clean state for a new test.

pub async fn scan_for_networks(&self) -> Result<Vec<String>, Error>

Request a scan and return the list of network names found, or an error if one occurs.

pub async fn connect( &self, target_ssid: Vec<u8>, type_: SecurityType ) -> Result<String, Error>

Connect to a network through the policy layer. The network must have been saved first. Returns an error if the connect command was not received, otherwise returns the response to the connect request as a string. A connection should be triggered if the response is “Acknowledged”.

Arguments:

• `target_ssid’: The SSID (network name) that we want to connect to.
• type: Security type should be a string of the security type, either “none”, “wep”, “wpa”, “wpa2” or “wpa3”, matching the policy API’s defined security types, case doesn’t matter.

pub async fn remove_network( &self, target_ssid: Vec<u8>, type_: SecurityType, credential: Credential ) -> Result<(), Error>

Forget the specified saved network. Doesn’t do anything if network not saved.

Arguments:

• target_ssid: The SSID (network name) that we want to forget.
• type: the security type of the network. It should be a string, either “none”, “wep”, “wpa”, “wpa2” or “wpa3”, matching the policy API’s defined security types. Target password can be password, PSK, or none, represented by empty string.
• credential: the password or other credential of the network we want to forget.

pub async fn remove_all_networks(&self) -> Result<(), Error>

Remove all of the client’s saved networks.

pub async fn start_client_connections(&self) -> Result<(), Error>

Send the request to the policy layer to start making client connections.

pub async fn get_update(&self) -> Result<ClientStateSummary, Error>

Wait for and return a client update. If this is the first update gotten from the facade since the client controller or a new update listener has been created, it will get an immediate status. After that, it will wait for a change and return a status when there has been a change since the last call to get_update. This call will hang if there are no updates. This function is not thread safe, so there should not be multiple get_update calls at the same time unless a new listener is set between them. There is no lock around the update_listener field of the facade in order to prevent a hanging get_update from blocking all future get_updates.

pub async fn stop_client_connections(&self) -> Result<(), Error>

Send the request to the policy layer to stop making client connections.

pub async fn save_network( &self, target_ssid: Vec<u8>, type_: SecurityType, credential: Credential ) -> Result<(), Error>

Save the specified network.

Arguments:

• target_ssid: The SSID (network name) that we want to save.
• type: the security type of the network. It should be a string, either “none”, “wep”, “wpa”, “wpa2” or “wpa3”, matching the policy API’s defined security types. Target password can be password, PSK, or none, represented by empty string
• credential: the password or other credential of the network we want to remember.

pub async fn get_saved_networks_json(&self) -> Result<Vec<NetworkConfig>, Error>

Trait Implementations

impl Debug for WlanPolicyFacade

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

Formats the value using the given formatter.

impl Facade for WlanPolicyFacade

fn handle_request<'life0, 'async_trait>( &'life0 self, method: String, args: Value ) -> Pin<Box<dyn Future<Output = Result<Value, Error>> + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Asynchronously handle the incoming request for the given method and arguments, returning a future object representing the pending operation.

fn cleanup(&self)

In response to a request to /cleanup, cleanup any cross-request state.

fn print(&self)

In response to a request to /print, log relevant facade state.