Network Interface Types. More...

Data Structures

struct  zos_mac_t
 MAC address type. More...
 
struct  zos_ssid_t
 MAC address type. More...
 
struct  zos_softap_client_t
 Contains information about a SoftAP client. More...
 

Typedefs

typedef void(* zos_network_event_handler_t) (uint32_t is_up)
 Network event handler prototype.
 
typedef void(* zos_softap_event_handler_t) (const zos_softap_client_t *info)
 SoftAP client event handler prototype.
 

Enumerations

enum  zos_interface_t {
  ZOS_WLAN = 0,
  ZOS_SOFTAP = 1,
  ZOS_ETHERNET = 2,
  ZOS_CELLULAR = 3,
  ZOS_DEFAULT_INTERFACE = 127,
  ZOS_ANY_INTERFACE = 0xFF
}
 Network interface type. More...
 
enum  zos_deauth_reason_t {
  ZOS_DEAUTH_REASON_RESERVED = 0,
  ZOS_DEAUTH_REASON_UNSPECIFIED = 1,
  ZOS_DEAUTH_REASON_INACTIVITY = 4
}
 Reason for deauthenticating SoftAP client used by zn_network_softap_deauth_client() More...
 
enum  zos_wlan_result_t {
  ZOS_WLAN_RESULT_UNKNOWN = 0,
  ZOS_WLAN_RESULT_SUCCESS = 1,
  ZOS_WLAN_RESULT_JOINING = 2,
  ZOS_WLAN_RESULT_SSID_NOT_SET = 3,
  ZOS_WLAN_RESULT_PASSWORD_NOT_SET = 4,
  ZOS_WLAN_RESULT_SECURITY_NOT_SUPPORTED = 5,
  ZOS_WLAN_RESULT_NOT_FOUND = 6,
  ZOS_WLAN_RESULT_FAILED = 7,
  ZOS_WLAN_RESULT_ABORTED = 8
}
 Result of most recent WLAN join attempt. More...
 
enum  zos_network_status_t {
  ZOS_NETWORK_STATUS_DOWN = 0,
  ZOS_NETWORK_STATUS_UP = 1,
  ZOS_NETWORK_STATUS_IP = 2
}
 Current network status of interface. More...
 

Detailed Description

Network Interface Types.

Enumeration Type Documentation

Reason for deauthenticating SoftAP client used by zn_network_softap_deauth_client()

Enumerator
ZOS_DEAUTH_REASON_RESERVED 

Reserved.

ZOS_DEAUTH_REASON_UNSPECIFIED 

Unspecified reason.

ZOS_DEAUTH_REASON_INACTIVITY 

Disassociated due to inactivity.

Network interface type.

Enumerator
ZOS_WLAN 

WLAN interface.

ZOS_SOFTAP 

SoftAP interface.

ZOS_ETHERNET 

Ethernet interface.

ZOS_CELLULAR 

Cellular interface.

ZOS_DEFAULT_INTERFACE 

Default interface.

ZOS_ANY_INTERFACE 

Any interface.

Current network status of interface.

Enumerator
ZOS_NETWORK_STATUS_DOWN 

Interface is down.

ZOS_NETWORK_STATUS_UP 

Interface is up but does NOT have an IP.

ZOS_NETWORK_STATUS_IP 

Interface is up and has an IP address (i.e. is ready for network connections)

Result of most recent WLAN join attempt.

Enumerator
ZOS_WLAN_RESULT_UNKNOWN 

Haven't tried to join.

ZOS_WLAN_RESULT_SUCCESS 

Success - Joined network.

ZOS_WLAN_RESULT_JOINING 

Joining network.

ZOS_WLAN_RESULT_SSID_NOT_SET 

SSID not set.

ZOS_WLAN_RESULT_PASSWORD_NOT_SET 

No password set and AP requires security.

ZOS_WLAN_RESULT_SECURITY_NOT_SUPPORTED 

Specified security not supported by AP.

ZOS_WLAN_RESULT_NOT_FOUND 

Network not found.

ZOS_WLAN_RESULT_FAILED 

Failed to join network. All attempts to join have failed.

ZOS_WLAN_RESULT_ABORTED 

Join aborted. zn_network_down() called while trying to join.