class Server

Gets general information about the device and its supported features.

This method is safe to call even when the SoftMAC has not yet started.

Note: The implementation of this method must not depend on a response

from an ethernet driver, otherwise there is a risk of deadlock.

The wlansoftmac driver calls this method synchronously while

serving the fuchsia.hardware.ethernet/EthernetImpl.Query method.

Gets information about the station discovery (e.g., scanning and

probing) features supported by the device. This method is safe to call

even when the SoftMAC has not yet started.

Gets information about the MAC features supported by the device. This

method is safe to call even when the SoftMAC has not yet started.

Note: The implementation of this method must not depend on a response

from an ethernet driver, otherwise there is a risk of deadlock.

The wlansoftmac driver calls this method synchronously while

serving the fuchsia.hardware.ethernet/EthernetImpl.Query method.

Gets information about the security features supported by the device.

This method is safe to call even when the SoftMAC has not yet started.

Gets information about the spectrum usage (e.g., DFS) features supported

by the device. This method is safe to call even when the SoftMAC has not

yet started.

Set the primary radio channel, e.g. in response to a channel switch event.

If successful, this will trigger the channel switch immediately. This may

impact the transmission of any frames that are in-flight, and might also

interfere with an ongoing scan request.

Common errors include:

\

/// ZX_ERR_NOT_SUPPORTED: The device cannot switch to the requested channel.

Join a specific BSS in which we will participate.

This applies regardless of if we are hosting the BSS or joining it

(indicated by the `remote` flag in `JoinBssRequest`).

If successful, the device will switch to the correct channel and perform

any internal filtering/timing operations required to join the BSS.

For client STAs, this is the first step before authenticating.

Common errors include:

\

/// ZX_ERR_NOT_SUPPORTED: The device does not support the given bss config.

Enables hardware Beaconing.

This method cannot be called while beaconing is enabled and so

`DisableBeaconing` must be called prior to this method if beaconing is

enabled.

All request fields are required.

Common errors include:

- `ZX_ERR_NOT_SUPPORTED`: The device does not support hardware beacons.

- `ZX_ERR_INVALID_ARGS`: The device cannot transmit the requested

beacon.

- `ZX_ERR_BAD_STATE`: The device is already beaconing.

Disables hardware beaconing.

Install a key for encryption when transmitting or receiving protected

frames.

Common errors include:

ZX_ERR_INVALID_ARGS: The given config does not specify a valid key.

ZX_ERR_NOT_SUPPORTED: The device does not support the given cipher.

Notifies the device of a successful association and configures

additional parameters necessary to participate in that association.

# Errors

Common errors include:

- `ZX_ERR_BAD_STATE`: The device was not previously informed of this BSS

via `WlanSoftmac.JoinBss`.

Notifies MAC and PHY that the peer has been de-associated.

Starts a passive scan. The server will deliver scan results

as Beacon frames using WlanSoftmacIfc.Recv(). When complete,

the server will call WlanSoftmacIfc.ScanComplete() with the

same `scan_id` returned by StartPassiveScan().

The server indicates support for `StartPassiveScan()` using

`fuchsia.wlan.common/ScanOffloadExtension.supported`.

Common errors include:

ZX_ERR_INVALID_ARGS: The device is not capable of performing the

requested scan, e.g. because an incompatible channel was requested.

ZX_ERR_UNAVAILABLE: The device cannot currently perform scans.

ZX_ERR_SHOULD_WAIT: Another scan is already in-progress.

Starts an active scan. The server will deliver scan results

as Beacon or Probe Response frames using WlanSoftmacIfc.Recv().

When complete, the server will call WlanSoftmacIfc.ScanComplete()

with the same `scan_id` returned by StartActiveScan().

A device driver indicates support for `StartActiveScan()` using

`fuchsia.wlan.common/ProbeRequestOffloadExtension.supported`.

Common errors include:

ZX_ERR_INVALID_ARGS: The device is not capable of performing the

requested scan, e.g. because an incompatible channel was requested.

ZX_ERR_UNAVAILABLE: The device cannot currently perform scans.

ZX_ERR_SHOULD_WAIT: Another scan is already in-progress.

Cancels the ongoing scan corresponding to `scan_id`,

where `scan_id` is an identifier returned by

`StartPassiveScan()` or `StartActiveScan()`. If cancellation succeeds,

the server will soon call WlanSoftmacIfc.ScanComplete() with the same

`scan_id`.

A device driver indicates support for `CancelScan()` using

`fuchsia.wlan.common/ScanOffloadExtension.scan_cancel_supported`.

Common errors include:

- `ZX_ERR_NOT_FOUND`: `scan_id` does not match an ongoing scan.

- `ZX_ERR_NOT_SUPPORTED`: Server does not support scan cancellation.

Indicate the device of modified WiFi Multimedia (WMM) parameters for a

particular access category (AC).

|bind_handler| returns a handler that binds incoming connections to this

server implementation.

The returned handler borrows the server instance.

The server must outlive the provided |dispatcher|. Only after

the dispatcher is shutdown will it be safe to destroy the servers.

The server should not be moved.