Data Structures
class	SocketAddress
	SocketAddress class. More...
struct	nsapi_addr
	IP address structure for passing IP addresses by value. More...
struct	nsapi_wifi_ap
	nsapi_wifi_ap structure More...
struct	nsapi_stack
	nsapi_stack structure More...
struct	nsapi_ip_mreq
	nsapi_ip_mreq structure More...
struct	nsapi_stack_api
	nsapi_stack_api structure More...
Typedefs
typedef signed int	nsapi_error_t
	Type used to represent error codes.
typedef unsigned int	nsapi_size_t
	Type used to represent the size of data passed through sockets.
typedef signed int	nsapi_size_or_error_t
	Type used to represent either a size or error passed through sockets.
typedef signed int	nsapi_value_or_error_t
	Type used to represent either a value or error.
typedef enum nsapi_security	nsapi_security_t
	Enum of encryption types.
typedef struct nsapi_addr	nsapi_addr_t
	IP address structure for passing IP addresses by value.
typedef void *	nsapi_socket_t
	Opaque handle for network sockets.
typedef struct nsapi_wifi_ap	nsapi_wifi_ap_t
	nsapi_wifi_ap structure
typedef struct nsapi_stack	nsapi_stack_t
	nsapi_stack structure
typedef struct nsapi_ip_mreq	nsapi_ip_mreq_t
	nsapi_ip_mreq structure
typedef struct nsapi_stack_api	nsapi_stack_api_t
	nsapi_stack_api structure
Enumerations
enum	nsapi_error { NSAPI_ERROR_OK = 0, NSAPI_ERROR_WOULD_BLOCK = -3001, NSAPI_ERROR_UNSUPPORTED = -3002, NSAPI_ERROR_PARAMETER = -3003, NSAPI_ERROR_NO_CONNECTION = -3004, NSAPI_ERROR_NO_SOCKET = -3005, NSAPI_ERROR_NO_ADDRESS = -3006, NSAPI_ERROR_NO_MEMORY = -3007, NSAPI_ERROR_NO_SSID = -3008, NSAPI_ERROR_DNS_FAILURE = -3009, NSAPI_ERROR_DHCP_FAILURE = -3010, NSAPI_ERROR_AUTH_FAILURE = -3011, NSAPI_ERROR_DEVICE_ERROR = -3012, NSAPI_ERROR_IN_PROGRESS = -3013, NSAPI_ERROR_ALREADY = -3014, NSAPI_ERROR_IS_CONNECTED = -3015, NSAPI_ERROR_CONNECTION_LOST = -3016, NSAPI_ERROR_CONNECTION_TIMEOUT = -3017, NSAPI_ERROR_ADDRESS_IN_USE = -3018, NSAPI_ERROR_TIMEOUT = -3019, NSAPI_ERROR_BUSY = -3020 }
	Enum of standardized error codes. More...
enum	nsapi_connection_status { NSAPI_STATUS_LOCAL_UP = 0, NSAPI_STATUS_GLOBAL_UP = 1, NSAPI_STATUS_DISCONNECTED = 2, NSAPI_STATUS_CONNECTING = 3 }
	Enum of connection status types. More...
enum	nsapi_event { NSAPI_EVENT_CONNECTION_STATUS_CHANGE = 0, NSAPI_EVENT_CELLULAR_STATUS_BASE = 0x1000, NSAPI_EVENT_CELLULAR_STATUS_END = 0x1FFF }
	Enum of event types. More...
enum	nsapi_security { NSAPI_SECURITY_NONE = 0x0, NSAPI_SECURITY_WEP = 0x1, NSAPI_SECURITY_WPA = 0x2, NSAPI_SECURITY_WPA2 = 0x3, NSAPI_SECURITY_WPA_WPA2 = 0x4, NSAPI_SECURITY_PAP = 0x5, NSAPI_SECURITY_CHAP = 0x6, NSAPI_SECURITY_EAP_TLS = 0x7, NSAPI_SECURITY_PEAP = 0x8, NSAPI_SECURITY_UNKNOWN = 0xFF }
	Enum of encryption types. More...
enum	nsapi_version { NSAPI_UNSPEC, NSAPI_IPv4, NSAPI_IPv6 }
	Enum of IP address versions. More...
enum	nsapi_protocol { NSAPI_TCP, NSAPI_UDP }
	Enum of socket protocols. More...
enum	nsapi_stack_level { NSAPI_STACK = 5000 }
	Enum of standardized stack option levels for use with NetworkStack::setstackopt and getstackopt. More...
enum	nsapi_stack_option { NSAPI_IPV4_MRU, NSAPI_IPV6_MRU }
	Enum of standardized stack option names for level NSAPI_STACK of NetworkStack::setstackopt and getstackopt. More...
enum	nsapi_socket_level { NSAPI_SOCKET = 7000 }
	Enum of standardized socket option levels for use with Socket::setsockopt and getsockopt. More...
enum	nsapi_socket_option { NSAPI_REUSEADDR, NSAPI_KEEPALIVE, NSAPI_KEEPIDLE, NSAPI_KEEPINTVL, NSAPI_LINGER, NSAPI_SNDBUF, NSAPI_RCVBUF, NSAPI_ADD_MEMBERSHIP, NSAPI_DROP_MEMBERSHIP, NSAPI_BIND_TO_DEVICE }
	Enum of standardized socket option names for level NSAPI_SOCKET of Socket::setsockopt and getsockopt. More...
enum	nsapi_ip_stack
	Supported IP protocol versions of IP stack. More...

Typedef Documentation

typedef struct nsapi_addr nsapi_addr_t

IP address structure for passing IP addresses by value.

typedef signed int nsapi_error_t

Type used to represent error codes.

This is a separate type from enum nsapi_error to avoid breaking compatibility in type-sensitive overloads

Definition at line 95 of file nsapi_types.h.

typedef struct nsapi_ip_mreq nsapi_ip_mreq_t

nsapi_ip_mreq structure

typedef enum nsapi_security nsapi_security_t

Enum of encryption types.

The security type specifies a particular security to use when connected to a WiFi network

typedef signed int nsapi_size_or_error_t

Type used to represent either a size or error passed through sockets.

A valid nsapi_size_or_error_t is either a non-negative size or a negative error code from the nsapi_error_t

Definition at line 106 of file nsapi_types.h.

typedef unsigned int nsapi_size_t

Type used to represent the size of data passed through sockets.

Definition at line 99 of file nsapi_types.h.

typedef void* nsapi_socket_t

Opaque handle for network sockets.

Definition at line 204 of file nsapi_types.h.

typedef struct nsapi_stack_api nsapi_stack_api_t

nsapi_stack_api structure

Common api structure for network stack operations. A network stack can provide a nsapi_stack_api structure filled out with the appropriate implementation.

Unsupported operations can be left as null pointers.

typedef struct nsapi_stack nsapi_stack_t

nsapi_stack structure

Stack structure representing a specific instance of a stack.

typedef signed int nsapi_value_or_error_t

Type used to represent either a value or error.

A valid nsapi_value_or_error_t is either a non-negative value or a negative error code from the nsapi_error_t

Definition at line 113 of file nsapi_types.h.

typedef struct nsapi_wifi_ap nsapi_wifi_ap_t

nsapi_wifi_ap structure

Structure representing a WiFi Access Point

Enumeration Type Documentation

enum nsapi_connection_status

Enum of connection status types.

Valid error codes have negative values.

Enumerator:

NSAPI_STATUS_LOCAL_UP	local IP address set
NSAPI_STATUS_GLOBAL_UP	global IP address set
NSAPI_STATUS_DISCONNECTED	no connection to network
NSAPI_STATUS_CONNECTING	connecting to network

Definition at line 68 of file nsapi_types.h.

enum nsapi_error

Enum of standardized error codes.

Valid error codes have negative values and may be returned by any network operation.

Enumerator:

NSAPI_ERROR_OK	no error
NSAPI_ERROR_WOULD_BLOCK	no data is not available but call is non-blocking
NSAPI_ERROR_UNSUPPORTED	unsupported functionality
NSAPI_ERROR_PARAMETER	invalid configuration
NSAPI_ERROR_NO_CONNECTION	not connected to a network
NSAPI_ERROR_NO_SOCKET	socket not available for use
NSAPI_ERROR_NO_ADDRESS	IP address is not known
NSAPI_ERROR_NO_MEMORY	memory resource not available
NSAPI_ERROR_NO_SSID	ssid not found
NSAPI_ERROR_DNS_FAILURE	DNS failed to complete successfully
NSAPI_ERROR_DHCP_FAILURE	DHCP failed to complete successfully
NSAPI_ERROR_AUTH_FAILURE	connection to access point failed
NSAPI_ERROR_DEVICE_ERROR	failure interfacing with the network processor
NSAPI_ERROR_IN_PROGRESS	operation (eg connect) in progress
NSAPI_ERROR_ALREADY	operation (eg connect) already in progress
NSAPI_ERROR_IS_CONNECTED	socket is already connected
NSAPI_ERROR_CONNECTION_LOST	connection lost
NSAPI_ERROR_CONNECTION_TIMEOUT	connection timed out
NSAPI_ERROR_ADDRESS_IN_USE	Address already in use
NSAPI_ERROR_TIMEOUT	operation timed out
NSAPI_ERROR_BUSY	device is busy and cannot accept new operation

Definition at line 37 of file nsapi_types.h.

enum nsapi_event

Enum of event types.

Event callbacks are accompanied with an event-dependent parameter passed as an intptr_t.

Enumerator:

NSAPI_EVENT_CONNECTION_STATUS_CHANGE	network connection status has changed, the parameter = new status (nsapi_connection_status_t)
NSAPI_EVENT_CELLULAR_STATUS_BASE	Cellular modem status has changed, See the enum values from enum cellular_connection_status_t in /features/cellular/framework/common/CellularCommon.h
NSAPI_EVENT_CELLULAR_STATUS_END	cellular modem status has changed, See the enum values from enum cellular_connection_status_t in /features/cellular/framework/common/CellularCommon.h

Definition at line 83 of file nsapi_types.h.

enum nsapi_ip_stack

Supported IP protocol versions of IP stack.

Definition at line 275 of file nsapi_types.h.

enum nsapi_protocol

Enum of socket protocols.

The socket protocol specifies a particular protocol to be used with a newly created socket.

Enumerator:

NSAPI_TCP	Socket is of TCP type
NSAPI_UDP	Socket is of UDP type

Definition at line 214 of file nsapi_types.h.

enum nsapi_security

Enum of encryption types.

The security type specifies a particular security to use when connected to a WiFi network

Enumerator:

NSAPI_SECURITY_NONE	open access point
NSAPI_SECURITY_WEP	phrase conforms to WEP
NSAPI_SECURITY_WPA	phrase conforms to WPA
NSAPI_SECURITY_WPA2	phrase conforms to WPA2
NSAPI_SECURITY_WPA_WPA2	phrase conforms to WPA/WPA2
NSAPI_SECURITY_PAP	phrase conforms to PPP authentication context
NSAPI_SECURITY_CHAP	phrase conforms to PPP authentication context
NSAPI_SECURITY_EAP_TLS	phrase conforms to EAP-TLS
NSAPI_SECURITY_PEAP	phrase conforms to PEAP
NSAPI_SECURITY_UNKNOWN	unknown/unsupported security in scan results

Definition at line 120 of file nsapi_types.h.

enum nsapi_socket_level

Enum of standardized socket option levels for use with Socket::setsockopt and getsockopt.

Enumerator:

NSAPI_SOCKET

Socket option level - see nsapi_socket_option_t for options

Definition at line 246 of file nsapi_types.h.

enum nsapi_socket_option

Enum of standardized socket option names for level NSAPI_SOCKET of Socket::setsockopt and getsockopt.

These options may not be supported on all stacks, in which case NSAPI_ERROR_UNSUPPORTED may be returned.

Enumerator:

NSAPI_REUSEADDR	Allow bind to reuse local addresses
NSAPI_KEEPALIVE	Enables sending of keepalive messages
NSAPI_KEEPIDLE	Sets timeout value to initiate keepalive
NSAPI_KEEPINTVL	Sets timeout value for keepalive
NSAPI_LINGER	Keeps close from returning until queues empty
NSAPI_SNDBUF	Sets send buffer size
NSAPI_RCVBUF	Sets recv buffer size
NSAPI_ADD_MEMBERSHIP	Add membership to multicast address
NSAPI_DROP_MEMBERSHIP	Drop membership to multicast address
NSAPI_BIND_TO_DEVICE	Bind socket network interface name

Definition at line 258 of file nsapi_types.h.

enum nsapi_stack_level

Enum of standardized stack option levels for use with NetworkStack::setstackopt and getstackopt.

Enumerator:

NSAPI_STACK

Stack option level - see nsapi_stack_option_t for options

Definition at line 224 of file nsapi_types.h.

enum nsapi_stack_option

Enum of standardized stack option names for level NSAPI_STACK of NetworkStack::setstackopt and getstackopt.

These options may not be supported on all stacks, in which case NSAPI_ERROR_UNSUPPORTED may be returned.

Enumerator:

NSAPI_IPV4_MRU	Sets/gets size of largest IPv4 fragmented datagram to reassemble
NSAPI_IPV6_MRU	Sets/gets size of largest IPv6 fragmented datagram to reassemble

Definition at line 236 of file nsapi_types.h.

enum nsapi_version

Enum of IP address versions.

The IP version specifies the type of an IP address.

Enumerator:

NSAPI_UNSPEC	Address is unspecified
NSAPI_IPv4	Address is IPv4
NSAPI_IPv6	Address is IPv6

Definition at line 179 of file nsapi_types.h.

Type:	Library
Created:	24 Sep 2020
Imports:	1
Forks:	0
Commits:	23
Dependents:	0
Dependencies:	0
Followers:	1

Netsocket

Data Structures

Typedefs

Enumerations

Typedef Documentation

Enumeration Type Documentation

Repository toolbox

Repository details

Important Information for this Arm website

Netsocket

Data Structures

Typedefs

Enumerations

Typedef Documentation

Enumeration Type Documentation

Repository toolbox

Repository details

Important Information for this Arm website

Access Warning