Struct fidl_fuchsia_wlan_softmac::WlanSoftmacStartActiveScanRequest

pub struct WlanSoftmacStartActiveScanRequest {
    pub channels: Option<Vec<u8>>,
    pub ssids: Option<Vec<CSsid>>,
    pub mac_header: Option<Vec<u8>>,
    pub ies: Option<Vec<u8>>,
    pub min_channel_time: Option<i64>,
    pub max_channel_time: Option<i64>,
    pub min_home_time: Option<i64>,
    pub min_probes_per_channel: Option<u8>,
    pub max_probes_per_channel: Option<u8>,
    /* private fields */
}

Argument struct to be passed as the single argument to WlanSoftmac.StartActiveScan

Fields

channels: Option<Vec<u8>>

List of channels to scan on. An empty list of channels will cause a scan request to immediately return ZX_ERR_INVALID_ARGS.

Invalid channel numbers will be silently ignored. The validity of a channel number depends on the current regulatory region, and a SoftMAC driver cannot always determine the region setting. This is especially the case when firmware changes the region setting dynamically.

ssids: Option<Vec<CSsid>>

List of SSIDs to scan for. For a list with a single SSID, the SSID will be placed in the SSID element in the Probe Request frame. For a list with more than one SSID, all SSIDs will be placed in an SSID List element in the Probe Request frame with the first SSID in the list in the required SSID element. An empty list is the same as specifying a list containing only the wildcard SSID.

mac_header: Option<Vec<u8>>

Buffer containing a MAC header (as defined in IEEE Std 802.11-2016, 9.3.3.2) to include in each Probe Request frame.

ies: Option<Vec<u8>>

Buffer containing IE bytes to include in each Probe Request frame.

The IEs specified must not result in a Probe Request MMPDU that exceed the limits defined by IEEE Std 802.11-2016, 9.2.4.7. MMPDU limit constants can be found in fuchsia.wlan.ieee80211. These limits are very large and will likely not be exceeded by specifying the most common IEs found in Probe Request frames.

min_channel_time: Option<i64>

Minimum duration to spend on each channel during the scan.

max_channel_time: Option<i64>

Maximum duration to spend on each channel during the scan.

min_home_time: Option<i64>

Minimum duration to spend on the home channel(s) between the dwell time on each channel where a home channel corresponds to channels the device should otherwise be present on while not scanning.

min_probes_per_channel: Option<u8>

Minimum number of Probe Request frames to transmit per channel visit during a scan. The definition of a channel visit may differ between device drivers, but it is roughly the interval of time spent on a specific channel during a scan.

Sending more than one Probe Request frame on a channel may increase the probability that it is received in a noisy environment.

max_probes_per_channel: Option<u8>

Maximum number of Probe Request frames to transmit per channel visit during a scan. The definition of a channel visit may differ between device drivers, but it is roughly the interval of time spent on a specific channel during a scan. Specifying 0 is invalid since at least one Probe Request frame must be transmitted for an active scan.

Limiting the number of Probe Request frames sent on a channel reduces the time spent transmitting frames, and thus increase the time spent receiving frames, while scanning.

Trait Implementations

impl Clone for WlanSoftmacStartActiveScanRequest

fn clone(&self) -> WlanSoftmacStartActiveScanRequest

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for WlanSoftmacStartActiveScanRequest

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

Formats the value using the given formatter.

impl Decode<WlanSoftmacStartActiveScanRequest> for WlanSoftmacStartActiveScanRequest

fn new_empty() -> Self

Creates a valid instance of Self. The specific value does not matter, since it will be overwritten by decode.

unsafe fn decode( &mut self, decoder: &mut Decoder<'_>, offset: usize, depth: Depth ) -> Result<()>

Decodes an object of type T from the decoder’s buffers into self.

impl Default for WlanSoftmacStartActiveScanRequest

fn default() -> WlanSoftmacStartActiveScanRequest

Returns the “default value” for a type.

impl Encode<WlanSoftmacStartActiveScanRequest> for &WlanSoftmacStartActiveScanRequest

unsafe fn encode( self, encoder: &mut Encoder<'_>, offset: usize, depth: Depth ) -> Result<()>

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

impl PartialEq for WlanSoftmacStartActiveScanRequest

fn eq(&self, other: &WlanSoftmacStartActiveScanRequest) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TypeMarker for WlanSoftmacStartActiveScanRequest

type Owned = WlanSoftmacStartActiveScanRequest

The owned Rust type which this FIDL type decodes into.

fn inline_align(_context: Context) -> usize

Returns the minimum required alignment of the inline portion of the encoded object. It must be a (nonzero) power of two.

fn inline_size(_context: Context) -> usize

Returns the size of the inline portion of the encoded object, including padding for alignment. Must be a multiple of inline_align.

fn encode_is_copy() -> bool

Returns true if the memory layout of Self::Owned matches the FIDL wire format and encoding requires no validation. When true, we can optimize encoding arrays and vectors of Self::Owned to a single memcpy.

fn decode_is_copy() -> bool

Returns true if the memory layout of Self::Owned matches the FIDL wire format and decoding requires no validation. When true, we can optimize decoding arrays and vectors of Self::Owned to a single memcpy.

impl ValueTypeMarker for WlanSoftmacStartActiveScanRequest

type Borrowed<'a> = &'a WlanSoftmacStartActiveScanRequest

The Rust type to use for encoding. This is a particular Encode<Self> type cheaply obtainable from &Self::Owned. There are three cases:

fn borrow<'a>(value: &'a <Self as TypeMarker>::Owned) -> Self::Borrowed<'a>

Cheaply converts from &Self::Owned to Self::Borrowed.

impl Persistable for WlanSoftmacStartActiveScanRequest

impl StructuralPartialEq for WlanSoftmacStartActiveScanRequest