Morse Micro IoT SDK  2.11.2
Data Fields
mmwlan_relay_args Struct Reference
Morse Micro Wireless LAN (mmwlan) API » WLAN Control API for S1G Relay functionality

Detailed Description

Arguments data structure for mmwlan_relay_enable().

Warning
ALPHA NOTICE: This is an alpha API that is under development; breaking changes may be introduced in future releases.

This structure should be initialized using MMWLAN_RELAY_ARGS_INIT for sensible default values, particularly for forward compatibility with new releases that may add new fields to the struct. For example:

enum mmwlan_status status;
struct mmwlan_relay_args relay_args = MMWLAN_RELAY_ARGS_INIT;
// HERE: initialize arguments
status = mmwlan_relay_enable(&relay_args);
MMWLAN_RELAY_ARGS_INIT
#define MMWLAN_RELAY_ARGS_INIT
Initializer for mmwlan_relay_args.
Definition: mmwlan.h:2001
mmwlan_relay_enable
enum mmwlan_status mmwlan_relay_enable(const struct mmwlan_relay_args *args)
Enable S1G Relay mode.
mmwlan_status
mmwlan_status
Enumeration of status return codes.
Definition: mmwlan.h:50
mmwlan_relay_args
Arguments data structure for mmwlan_relay_enable().
Definition: mmwlan.h:1984

Definition at line 1983 of file mmwlan.h.

#include <mmwlan.h>

Data Fields

unsigned forwarding_table_size
 Maximum number of entries in the forward table. More...
 
bool is_root_node
 Indicates whether this is the root node. More...
 

Field Documentation

◆ forwarding_table_size

unsigned mmwlan_relay_args::forwarding_table_size

Maximum number of entries in the forward table.

This must be large enough to hold one entry for every node under this one (direct and indirect). If zero, then the default value, MMWLAN_RELAY_DEFAULT_FORWARDING_TABLE_SIZE, will be used.

Definition at line 1990 of file mmwlan.h.

◆ is_root_node

bool mmwlan_relay_args::is_root_node

Indicates whether this is the root node.

Definition at line 1993 of file mmwlan.h.

The documentation for this struct was generated from the following file: