Network Interface Types. More...

Data Structures

struct gos_ip_address_t
struct gos_ip_setting_t
struct gos_mac_t
MAC address type. More...
struct gos_ssid_t
MAC address type. More...
struct gos_softap_client_t
Contains information about a SoftAP client. More...

Typedefs

typedef void(* gos_softap_event_handler_t ) (const gos_softap_client_t *info)
SoftAP client event handler prototype.

Enumerations

enum gos_ip_version_t {
GOS_IPV4 = 4,
GOS_IPV6 = 6,
GOS_INVALID_IP = INT_MAX
}
enum gos_interface_t {
GOS_INTERFACE_WLAN = 0,
GOS_INTERFACE_SOFTAP = 1,
GOS_INTERFACE_ETHERNET = 2,
GOS_INTERFACE_COUNT ,
GOS_INTERFACE_DEFAULT = 127,
GOS_INTERFACE_NONE = 0xFE,
GOS_INTERFACE_ANY = 0xFF
}
Network interface type. More...
enum gos_interface_mask_t {
GOS_INTERFACE_MASK_NONE = 0,
GOS_INTERFACE_MASK_WLAN = (1 << GOS_INTERFACE_WLAN),
GOS_INTERFACE_MASK_SOFTAP = (1 << GOS_INTERFACE_SOFTAP),
GOS_INTERFACE_MASK_ETHERNET = (1 << GOS_INTERFACE_ETHERNET),
GOS_INTERFACE_MASK_DEFAULT = (1 << GOS_INTERFACE_COUNT)
}
enum gos_deauth_reason_t {
GOS_DEAUTH_REASON_RESERVED = 0,
GOS_DEAUTH_REASON_UNSPECIFIED = 1,
GOS_DEAUTH_REASON_INACTIVITY = 4
}
Reason for deauthenticating SoftAP client used by gos_network_softap_deauth_client() More...
enum gos_wlan_result_t {
GOS_WLAN_STATUS_UNKNOWN = 0,
GOS_WLAN_STATUS_SUCCESS = 1,
GOS_WLAN_STATUS_JOINING = 2,
GOS_WLAN_STATUS_SSID_NOT_SET = 3,
GOS_WLAN_STATUS_PASSWORD_NOT_SET = 4,
GOS_WLAN_STATUS_SECURITY_NOT_SUPPORTED = 5,
GOS_WLAN_STATUS_NOT_FOUND = 6,
GOS_WLAN_STATUS_FAILED = 7,
GOS_WLAN_STATUS_ABORTED = 8
}
Result of most recent WLAN join attempt. More...
enum gos_network_status_t {
GOS_NETWORK_STATUS_DOWN = 0,
GOS_NETWORK_STATUS_UP = 1,
GOS_NETWORK_STATUS_IP = 2
}
Current network status of interface. More...

Detailed Description

Network Interface Types.

Enumeration Type Documentation

gos_deauth_reason_t

Reason for deauthenticating SoftAP client used by gos_network_softap_deauth_client()

Enumerator
GOS_DEAUTH_REASON_RESERVED

Reserved.

GOS_DEAUTH_REASON_UNSPECIFIED

Unspecified reason.

GOS_DEAUTH_REASON_INACTIVITY

Disassociated due to inactivity.

gos_interface_mask_t

Interface mask

Enumerator
GOS_INTERFACE_MASK_NONE

GOS_INTERFACE_MASK_NONE.

GOS_INTERFACE_MASK_WLAN

GOS_INTERFACE_MASK_WLAN.

GOS_INTERFACE_MASK_SOFTAP

GOS_INTERFACE_MASK_SOFTAP.

GOS_INTERFACE_MASK_ETHERNET

GOS_INTERFACE_MASK_ETHERNET.

GOS_INTERFACE_MASK_DEFAULT

GOS_INTERFACE_MASK_DEFAULT.

gos_interface_t

Network interface type.

Enumerator
GOS_INTERFACE_WLAN

WLAN interface.

GOS_INTERFACE_SOFTAP

SoftAP interface.

GOS_INTERFACE_ETHERNET

Ethernet interface.

GOS_INTERFACE_COUNT

Network interface count.

GOS_INTERFACE_DEFAULT

Default interface.

GOS_INTERFACE_NONE

No interface.

GOS_INTERFACE_ANY

Any interface.

gos_ip_version_t

TCPIP version

Enumerator
GOS_IPV4

IPv4.

GOS_IPV6

IPv6.

GOS_INVALID_IP

GOS_INVALID_IP.

gos_network_status_t

Current network status of interface.

Enumerator
GOS_NETWORK_STATUS_DOWN

Interface is down.

GOS_NETWORK_STATUS_UP

Interface is up but does NOT have an IP.

GOS_NETWORK_STATUS_IP

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

gos_wlan_result_t

Result of most recent WLAN join attempt.

Enumerator
GOS_WLAN_STATUS_UNKNOWN

Haven't tried to join.

GOS_WLAN_STATUS_SUCCESS

Success - Joined network.

GOS_WLAN_STATUS_JOINING

Joining network.

GOS_WLAN_STATUS_SSID_NOT_SET

SSID not set.

GOS_WLAN_STATUS_PASSWORD_NOT_SET

No password set and AP requires security.

GOS_WLAN_STATUS_SECURITY_NOT_SUPPORTED

Specified security not supported by AP.

GOS_WLAN_STATUS_NOT_FOUND

Network not found.

GOS_WLAN_STATUS_FAILED

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

GOS_WLAN_STATUS_ABORTED

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