Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Dependents: TYBLE16_simple_data_logger TYBLE16_MP3_Air
Netsocket
Data Structures | |
class | CellularNonIPSocket |
Socket implementation for cellular Non-IP data delivery(NIDD). More... | |
class | DNS |
Base class for DNS provider. More... | |
class | DTLSSocket |
DTLSSocket implement DTLS stream over UDP Socket. More... | |
class | DTLSSocketWrapper |
DTLSSocketWrapper implement DTLS stream over the existing Socket transport. More... | |
class | ICMPSocket |
ICMP socket implementation. More... | |
class | InternetDatagramSocket |
InternetDatagramSocket socket implementation. More... | |
class | InternetSocket |
Socket implementation that uses IP network stack. More... | |
class | NetworkStack |
NetworkStack 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... | |
class | Socket |
Socket interface. More... | |
class | SocketAddress |
SocketAddress class. More... | |
class | TCPServer |
TCP socket server. More... | |
class | TCPSocket |
TCP socket connection. More... | |
class | TLSSocket |
TLSSocket is a wrapper around TCPSocket for interacting with TLS servers. More... | |
class | TLSSocketWrapper |
TLSSocket is a wrapper around Socket for interacting with TLS servers. More... | |
class | UDPSocket |
UDP socket implementation. 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_WPA2_ENT = 0x9, 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, NSAPI_ICMP } |
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_tlssocket_level { NSAPI_TLSSOCKET_LEVEL = 7099 } |
enum | nsapi_tlssocket_option { NSAPI_TLSSOCKET_SET_HOSTNAME, NSAPI_TLSSOCKET_SET_CACERT, NSAPI_TLSSOCKET_SET_CLCERT, NSAPI_TLSSOCKET_SET_CLKEY, NSAPI_TLSSOCKET_ENABLE } |
enum | nsapi_ip_stack |
Supported IP protocol versions of IP stack. More... | |
Functions | |
NetworkStack * | nsapi_create_stack (nsapi_stack_t *stack) |
Convert a raw nsapi_stack_t object into a C++ NetworkStack object. | |
nsapi_error_t | nsapi_dns_query (nsapi_stack_t *stack, const char *host, nsapi_addr_t *addr, nsapi_version_t version) |
Query a domain name server for an IP address of a given hostname. | |
nsapi_size_or_error_t | nsapi_dns_query_multiple (nsapi_stack_t *stack, const char *host, nsapi_addr_t *addr, nsapi_size_t addr_count, nsapi_version_t version) |
Query a domain name server for multiple IP address of a given hostname. | |
nsapi_error_t | nsapi_dns_add_server (nsapi_addr_t addr, const char *interface_name) |
Add a domain name server to list of servers to query. | |
nsapi_error_t | nsapi_dns_query (NetworkStack *stack, const char *host, SocketAddress *addr, nsapi_version_t version=NSAPI_IPv4) |
Query a domain name server for an IP address of a given hostname. | |
nsapi_error_t | nsapi_dns_query (NetworkStack *stack, const char *host, SocketAddress *addr, const char *interface_name, nsapi_version_t version=NSAPI_IPv4) |
Query a domain name server for an IP address of a given hostname using Network interface name. | |
nsapi_error_t | nsapi_dns_query_async (NetworkStack *stack, const char *host, NetworkStack::hostbyname_cb_t callback, call_in_callback_cb_t call_in_cb, nsapi_version_t version=NSAPI_IPv4) |
Query a domain name server for an IP address of a given hostname. | |
nsapi_error_t | nsapi_dns_query_async (NetworkStack *stack, const char *host, NetworkStack::hostbyname_cb_t callback, call_in_callback_cb_t call_in_cb, const char *interface_name, nsapi_version_t version=NSAPI_IPv4) |
Query a domain name server for an IP address of a given hostname using Network interface name. | |
template<typename S > | |
nsapi_error_t | nsapi_dns_query (S *stack, const char *host, SocketAddress *addr, nsapi_version_t version=NSAPI_IPv4) |
Query a domain name server for an IP address of a given hostname. | |
nsapi_size_or_error_t | nsapi_dns_query_multiple (NetworkStack *stack, const char *host, SocketAddress *addr, nsapi_size_t addr_count, const char *interface_name, nsapi_version_t version=NSAPI_IPv4) |
Query a domain name server for multiple IP address of a given hostname. | |
nsapi_size_or_error_t | nsapi_dns_query_multiple_async (NetworkStack *stack, const char *host, NetworkStack::hostbyname_cb_t callback, nsapi_size_t addr_count, call_in_callback_cb_t call_in_cb, const char *interface_name, nsapi_version_t version=NSAPI_IPv4) |
Query a domain name server for an IP address of a given hostname (asynchronous) | |
nsapi_size_or_error_t | nsapi_dns_query_multiple (nsapi_stack_t *stack, const char *host, nsapi_addr_t *addr, nsapi_size_t addr_count, const char *interface_name, nsapi_version_t version=NSAPI_IPv4) |
Query a domain name server for multiple IP address of a given hostname. | |
template<typename S > | |
nsapi_size_or_error_t | nsapi_dns_query_multiple (S *stack, const char *host, SocketAddress *addr, nsapi_size_t addr_count, nsapi_version_t version=NSAPI_IPv4) |
Query a domain name server for multiple IP address of a given hostname. | |
nsapi_error_t | nsapi_dns_query_async_cancel (nsapi_size_or_error_t id) |
Cancels asynchronous hostname translation. | |
void | nsapi_dns_call_in_set (call_in_callback_cb_t callback) |
Set a call in callback. | |
void | nsapi_dns_reset () |
nsapi_dns_reset Resets all internal states and frees reserved memory, see NOTE! Can be used to clean up system resources when there is no need for network connections. | |
static nsapi_error_t | nsapi_dns_add_server (const SocketAddress &address, const char *interface_name) |
Add a domain name server to list of servers to query. | |
static nsapi_error_t | nsapi_dns_add_server (const char *address, const char *interface_name) |
Add a domain name server to list of servers to query. |
Detailed Description
Mbed OS Socket API.
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 205 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 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:
Definition at line 83 of file nsapi_types.h.
enum nsapi_ip_stack |
Supported IP protocol versions of IP stack.
Definition at line 289 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
NSAPI_ICMP Socket is of ICMP type
Definition at line 215 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:
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 248 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:
Definition at line 260 of file nsapi_types.h.
enum nsapi_stack_level |
Enum of standardized stack option levels for use with NetworkStack::setstackopt and getstackopt.
Definition at line 226 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 238 of file nsapi_types.h.
- Enumerator:
NSAPI_TLSSOCKET_LEVEL TLSSocket option level - see nsapi_tlssocket_option_t for options
Definition at line 273 of file nsapi_types.h.
- Enumerator:
NSAPI_TLSSOCKET_SET_HOSTNAME Set host name
NSAPI_TLSSOCKET_SET_CACERT Set server CA certificate
NSAPI_TLSSOCKET_SET_CLCERT Set client certificate
NSAPI_TLSSOCKET_SET_CLKEY Set client key
NSAPI_TLSSOCKET_ENABLE Enable TLSSocket
Definition at line 277 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 180 of file nsapi_types.h.
Function Documentation
NetworkStack* nsapi_create_stack | ( | nsapi_stack_t * | stack ) |
Convert a raw nsapi_stack_t object into a C++ NetworkStack object.
- Parameters:
-
stack Reference to an object that can be converted to a stack - A raw nsapi_stack_t object
- A reference to a network stack
- A reference to a network interface
- Returns:
- Reference to the underlying network stack
Definition at line 386 of file NetworkStack.cpp.
static nsapi_error_t nsapi_dns_add_server | ( | const SocketAddress & | address, |
const char * | interface_name | ||
) | [static] |
Add a domain name server to list of servers to query.
- Parameters:
-
addr Destination for the host address
- Returns:
- 0 on success, negative error code on failure
Definition at line 254 of file nsapi_dns.h.
static nsapi_error_t nsapi_dns_add_server | ( | const char * | address, |
const char * | interface_name | ||
) | [static] |
Add a domain name server to list of servers to query.
- Parameters:
-
addr Destination for the host address
- Returns:
- 0 on success, negative error code on failure
Definition at line 264 of file nsapi_dns.h.
nsapi_error_t nsapi_dns_add_server | ( | nsapi_addr_t | addr, |
const char * | interface_name | ||
) |
Add a domain name server to list of servers to query.
- Parameters:
-
addr Destination for the host address
- Returns:
- 0 on success, negative error code on failure
Definition at line 134 of file nsapi_dns.cpp.
void nsapi_dns_call_in_set | ( | call_in_callback_cb_t | callback ) |
Set a call in callback.
Can be used to provide an application specific call in callback to DNS resolver. When callback is set it is used instead of stack specific call in callbacks.
- Parameters:
-
callback Callback
Definition at line 639 of file nsapi_dns.cpp.
nsapi_error_t nsapi_dns_query | ( | NetworkStack * | stack, |
const char * | host, | ||
SocketAddress * | addr, | ||
const char * | interface_name, | ||
nsapi_version_t | version = NSAPI_IPv4 |
||
) |
Query a domain name server for an IP address of a given hostname using Network interface name.
- Parameters:
-
stack Network stack as target for DNS query host Hostname to resolve addr Destination for the host address interface_name Network interface name version IP version to resolve (defaults to NSAPI_IPv4)
- Returns:
- See nsapi_dns_query_multiple
Definition at line 616 of file nsapi_dns.cpp.
nsapi_error_t nsapi_dns_query | ( | nsapi_stack_t * | stack, |
const char * | host, | ||
nsapi_addr_t * | addr, | ||
nsapi_version_t | version | ||
) |
Query a domain name server for an IP address of a given hostname.
Query a domain name server for an IP address of a given hostname (asynchronous)
- Parameters:
-
stack Network stack as target for DNS query host Hostname to resolve addr Destination for the host address version IP version to resolve
- Returns:
- 0 on success, negative error code on failure NSAPI_ERROR_DNS_FAILURE indicates the host could not be found
- Parameters:
-
stack Network stack as target for DNS query host Hostname to resolve addr Destination for the host address version IP version to resolve (defaults to NSAPI_IPv4)
- Returns:
- 0 on success, negative error code on failure NSAPI_ERROR_DNS_FAILURE indicates the host could not be found
Query a domain name server for an IP address of a given hostname.
- Parameters:
-
stack Network stack as target for DNS query host Hostname to resolve addr Destination for the host address version IP version to resolve (defaults to NSAPI_IPv4)
- Returns:
- 0 on success, negative error code on failure NSAPI_ERROR_DNS_FAILURE indicates the host could not be found
Definition at line 599 of file nsapi_dns.cpp.
nsapi_error_t nsapi_dns_query | ( | S * | stack, |
const char * | host, | ||
SocketAddress * | addr, | ||
nsapi_version_t | version = NSAPI_IPv4 |
||
) |
Query a domain name server for an IP address of a given hostname.
- Parameters:
-
stack Network stack as target for DNS query host Hostname to resolve addr Destination for the host address version IP version to resolve (defaults to NSAPI_IPv4)
- Returns:
- 0 on success, negative error code on failure NSAPI_ERROR_DNS_FAILURE indicates the host could not be found
Definition at line 145 of file nsapi_dns.h.
nsapi_error_t nsapi_dns_query | ( | NetworkStack * | stack, |
const char * | host, | ||
SocketAddress * | addr, | ||
nsapi_version_t | version = NSAPI_IPv4 |
||
) |
Query a domain name server for an IP address of a given hostname.
- Parameters:
-
stack Network stack as target for DNS query host Hostname to resolve addr Destination for the host address version IP version to resolve (defaults to NSAPI_IPv4)
- Returns:
- 0 on success, negative error code on failure NSAPI_ERROR_DNS_FAILURE indicates the host could not be found
Definition at line 607 of file nsapi_dns.cpp.
nsapi_error_t nsapi_dns_query_async | ( | NetworkStack * | stack, |
const char * | host, | ||
NetworkStack::hostbyname_cb_t | callback, | ||
call_in_callback_cb_t | call_in_cb, | ||
nsapi_version_t | version = NSAPI_IPv4 |
||
) |
Query a domain name server for an IP address of a given hostname.
- Parameters:
-
stack Network stack as target for DNS query host Hostname to resolve callback Callback that is called for result version IP version to resolve (defaults to NSAPI_IPv4)
- Returns:
- 0 on success, negative error code on failure or an unique id that represents the hostname translation operation and can be passed to cancel, NSAPI_ERROR_DNS_FAILURE indicates the host could not be found
Definition at line 625 of file nsapi_dns.cpp.
nsapi_error_t nsapi_dns_query_async | ( | NetworkStack * | stack, |
const char * | host, | ||
NetworkStack::hostbyname_cb_t | callback, | ||
call_in_callback_cb_t | call_in_cb, | ||
const char * | interface_name, | ||
nsapi_version_t | version = NSAPI_IPv4 |
||
) |
Query a domain name server for an IP address of a given hostname using Network interface name.
- Parameters:
-
stack Network stack as target for DNS query host Hostname to resolve callback Callback that is called for result interface_name Network interface name version IP version to resolve (defaults to NSAPI_IPv4)
- Returns:
- 0 on success, negative error code on failure or an unique id that represents the hostname translation operation and can be passed to cancel, NSAPI_ERROR_DNS_FAILURE indicates the host could not be found
Definition at line 632 of file nsapi_dns.cpp.
nsapi_error_t nsapi_dns_query_async_cancel | ( | nsapi_size_or_error_t | id ) |
Cancels asynchronous hostname translation.
When translation is cancelled, callback will not be called.
- Parameters:
-
id Unique id of the hostname translation operation
- Returns:
- 0 on success, negative error code on failure
Definition at line 853 of file nsapi_dns.cpp.
nsapi_size_or_error_t nsapi_dns_query_multiple | ( | nsapi_stack_t * | stack, |
const char * | host, | ||
nsapi_addr_t * | addr, | ||
nsapi_size_t | addr_count, | ||
const char * | interface_name, | ||
nsapi_version_t | version = NSAPI_IPv4 |
||
) |
Query a domain name server for multiple IP address of a given hostname.
- Parameters:
-
stack Network stack as target for DNS query host Hostname to resolve addr Array for the host addresses addr_count Number of addresses allocated in the array version IP version to resolve (defaults to NSAPI_IPv4)
- Returns:
- Number of addresses found on success, negative error code on failure NSAPI_ERROR_DNS_FAILURE indicates the host could not be found
Definition at line 576 of file nsapi_dns.cpp.
nsapi_size_or_error_t nsapi_dns_query_multiple | ( | nsapi_stack_t * | stack, |
const char * | host, | ||
nsapi_addr_t * | addr, | ||
nsapi_size_t | addr_count, | ||
nsapi_version_t | version | ||
) |
Query a domain name server for multiple IP address of a given hostname.
- Parameters:
-
stack Network stack as target for DNS query host Hostname to resolve addr Array for the host addresses addr_count Number of addresses allocated in the array version IP version to resolve
- Returns:
- Number of addresses found on success, negative error code on failure NSAPI_ERROR_DNS_FAILURE indicates the host could not be found
nsapi_size_or_error_t nsapi_dns_query_multiple | ( | NetworkStack * | stack, |
const char * | host, | ||
SocketAddress * | addr, | ||
nsapi_size_t | addr_count, | ||
const char * | interface_name, | ||
nsapi_version_t | version = NSAPI_IPv4 |
||
) |
Query a domain name server for multiple IP address of a given hostname.
- Parameters:
-
stack Network stack as target for DNS query host Hostname to resolve addr Array for the host addresses addr_count Number of addresses allocated in the array version IP version to resolve (defaults to NSAPI_IPv4)
- Returns:
- Positive number of addresses found on success
- Return values:
-
NSAPI_ERROR_PARAMETER if provided parameters are invalid NSAPI_ERROR_NO_MEMORY if allocation fails due to lack of memory NSAPI_ERROR_DNS_FAILURE if DNS resolution fails NSAPI_ERROR_WOULD_BLOCK in case non-blocking mode is enabled and DNS cannot be resolved immediately.
Definition at line 583 of file nsapi_dns.cpp.
nsapi_size_or_error_t nsapi_dns_query_multiple | ( | S * | stack, |
const char * | host, | ||
SocketAddress * | addr, | ||
nsapi_size_t | addr_count, | ||
nsapi_version_t | version = NSAPI_IPv4 |
||
) |
Query a domain name server for multiple IP address of a given hostname.
- Parameters:
-
stack Network stack as target for DNS query host Hostname to resolve addr Array for the host addresses addr_count Number of addresses allocated in the array version IP version to resolve (defaults to NSAPI_IPv4)
- Returns:
- Number of addresses found on success, negative error code on failure NSAPI_ERROR_DNS_FAILURE indicates the host could not be found
Definition at line 208 of file nsapi_dns.h.
nsapi_size_or_error_t nsapi_dns_query_multiple_async | ( | NetworkStack * | stack, |
const char * | host, | ||
NetworkStack::hostbyname_cb_t | callback, | ||
nsapi_size_t | addr_count, | ||
call_in_callback_cb_t | call_in_cb, | ||
const char * | interface_name, | ||
nsapi_version_t | version = NSAPI_IPv4 |
||
) |
Query a domain name server for an IP address of a given hostname (asynchronous)
- Parameters:
-
stack Network stack as target for DNS query host Hostname to resolve callback Callback that is called for result addr_count Number of addresses allocated in the array version IP version to resolve (defaults to NSAPI_IPv4)
- Returns:
- 0 on success, negative error code on failure or an unique id that represents the hostname translation operation and can be passed to cancel, NSAPI_ERROR_DNS_FAILURE indicates the host could not be found
Definition at line 661 of file nsapi_dns.cpp.
void nsapi_dns_reset | ( | ) |
nsapi_dns_reset Resets all internal states and frees reserved memory, see NOTE! Can be used to clean up system resources when there is no need for network connections.
NOTE: Does NOT clear asynchronous ongoing operations! Currently only cleans up DNS cache (if used)
Definition at line 644 of file nsapi_dns.cpp.
Generated on Tue Jul 12 2022 13:55:27 by
