Hostname translation callback (asynchronous)

Callback will be called after DNS resolution completes or a failure occurs.

Callback should not take more than 10ms to execute, otherwise it might prevent underlying thread processing. A portable user of the callback should not make calls to network operations due to stack size limitations. The callback should not perform expensive operations such as socket recv/send calls or blocking operations.

Parameters

result	Negative error code on failure or value that represents the number of DNS records
address	On success, destination for the host SocketAddress

Definition at line 127 of file NetworkStack.h.

Add a domain name server to list of servers to query.

Parameters

address	Destination for the host address
interface_name	Network interface name

Returns

NSAPI_ERROR_OK on success, negative error code on failure

Implements DNS.

Reimplemented in LWIP.

Register a network interface with the IP stack.

Connects EMAC layer with the IP stack and initializes all the required infrastructure. This function should be called only once for each available interface. EMAC memory manager is available to EMAC after this function call.

Parameters

	emac	EMAC HAL implementation for this network interface
	default_if	true if the interface should be treated as the default one
[out]	interface_out	pointer to stack interface object controlling the EMAC

Returns

NSAPI_ERROR_OK on success, or error code

Implemented in LWIP, EmacTestNetworkStack, and Nanostack.

Return the default on-board network stack.

Returns the default on-board network stack, as configured by JSON option nsapi.default-stack.

Get a domain name server from a list of servers to query.

Returns a DNS server address for a index. If returns error no more DNS servers to read.

Parameters

index	Index of the DNS server, starts from zero
address	Destination for the host address
interface_name	Network interface name

Returns

NSAPI_ERROR_OK on success, negative error code on failure

Reimplemented in LWIP, and Nanostack.

Get the local IP address.

Parameters

address

SocketAddress representation of the local IP address

Return values

NSAPI_ERROR_OK	on success
NSAPI_ERROR_UNSUPPORTED	if this feature is not supported
NSAPI_ERROR_PARAMETER	if the provided pointer is invalid
NSAPI_ERROR_NO_ADDRESS	if the address cannot be obtained from stack

Reimplemented in LWIP, Nanostack, QUECTEL_BG96_CellularStack, AT_CellularStack, and UBLOX_AT_CellularStack.

Get the local IP address on interface name.

Parameters

address	SocketAddress representation of the link local IPv6 address
interface_name	Network interface_name

Return values

NSAPI_ERROR_OK	on success
NSAPI_ERROR_UNSUPPORTED	if this feature is not supported
NSAPI_ERROR_PARAMETER	if the provided pointer is invalid
NSAPI_ERROR_NO_ADDRESS	if the address cannot be obtained from stack

Reimplemented in LWIP.

Get the IPv6 link local address.

Parameters

address

SocketAddress representation of the link local IPv6 address

Return values

NSAPI_ERROR_OK	on success
NSAPI_ERROR_UNSUPPORTED	if this feature is not supported
NSAPI_ERROR_PARAMETER	if the provided pointer is invalid

Translate a hostname to the multiple IP addresses with specific version using network interface name.

The hostname may be either a domain name or an IP address. If the hostname is an IP address, no network transactions will be performed.

If no stack-specific DNS resolution is provided, the hostname will be resolve using a UDP socket on the stack.

Parameters

hostname	Hostname to resolve.
hints	Pointer to a SocketAddress with query parameters.
res	Pointer to a SocketAddress array to store the result..
interface_name	Network interface name

Returns

number of results on success, negative error code on failure.

Implements DNS.

Translates a hostname to the multiple IP addresses (asynchronous)

The hostname may be either a domain name or an IP address. If the hostname is an IP address, no network transactions will be performed.

If no stack-specific DNS resolution is provided, the hostname will be resolve using a UDP socket on the stack.

The call is non-blocking. Result of the DNS operation is returned by the callback. If this function returns failure, callback will not be called. In case that IP addresses are found from DNS cache, callback will be called before function returns.

Parameters

hostname	Hostname to resolve
hints	Pointer to a SocketAddress with query parameters.
callback	Callback that is called for result
interface_name	Network interface_name

Returns

0 on immediate success, negative error code on immediate failure or a positive unique id that represents the hostname translation operation and can be passed to cancel

Implements DNS.

Translates a hostname to an IP address with specific version.

The hostname may be either a domain name or an IP address. If the hostname is an IP address, no network transactions will be performed.

If no stack-specific DNS resolution is provided, the hostname will be resolve using a UDP socket on the stack.

Parameters

host	Hostname to resolve
address	Pointer to a SocketAddress to store the result.
version	IP version of address to resolve, NSAPI_UNSPEC indicates version is chosen by the stack (defaults to NSAPI_UNSPEC)
interface_name	Network interface_name

Return values

NSAPI_ERROR_OK	on success
NSAPI_ERROR_PARAMETER	if invalid (null) name is provided
NSAPI_ERROR_DNS_FAILURE	if DNS resolution fails
int	other negative errors, see nsapi_dns_query

Implements DNS.

Reimplemented in Nanostack, UBLOX_AT_CellularStack, and RM1000_AT_CellularStack.

Translates a hostname to multiple IP addresses (asynchronous)

The hostname may be either a domain name or an IP address. If the hostname is an IP address, no network transactions will be performed.

If no stack-specific DNS resolution is provided, the hostname will be resolve using a UDP socket on the stack.

Call is non-blocking. Result of the DNS operation is returned by the callback. If this function returns failure, callback will not be called. In case result is success (IP address was found from DNS cache), callback will be called before function returns.

Parameters

host	Hostname to resolve
callback	Callback that is called for result
version	IP version of address to resolve, NSAPI_UNSPEC indicates version is chosen by the stack (defaults to NSAPI_UNSPEC)
interface_name	Network interface_name

Returns

0 on immediate success, negative error code on immediate failure or a positive unique id that represents the hostname translation operation and can be passed to cancel

Implements DNS.

Reimplemented in Nanostack.

Cancels asynchronous hostname translation.

When translation is cancelled, callback will not be called.

Parameters

id	Unique id of the hostname translation operation

Returns

NSAPI_ERROR_OK on success, negative error code on failure

Implements DNS.

Get stack-specific socket options.

The getstackopt allow an application to retrieve stack-specific hints from the underlying stack. For unsupported options, NSAPI_ERROR_UNSUPPORTED is returned and optval is unmodified.

Parameters

handle	Socket handle.
level	Stack-specific protocol level.
optname	Stack-specific option identifier.
optval	Destination for option value.
optlen	Length of the option value.

Returns

NSAPI_ERROR_OK on success, negative error code on failure.

Reimplemented in LWIP, EmacTestNetworkStack, and Nanostack.

Dynamic downcast to a OnboardNetworkStack.

Reimplemented from NetworkStack.

Definition at line 200 of file OnboardNetworkStack.h.

Set stack-specific socket options.

The setsockopt allow an application to pass stack-specific hints to the underlying stack. For unsupported options, NSAPI_ERROR_UNSUPPORTED is returned and the socket is unmodified.

Parameters

handle	Socket handle.
level	Stack-specific protocol level.
optname	Stack-specific option identifier.
optval	Option value.
optlen	Length of the option value.

Returns

NSAPI_ERROR_OK on success, negative error code on failure.

Reimplemented in LWIP, EmacTestNetworkStack, and Nanostack.

Accepts a connection on a TCP socket.

The server socket must be bound and set to listen for connections. On a new connection, creates a network socket and stores it in the specified handle. The handle must be passed to following calls on the socket.

A stack may have a finite number of sockets, in this case NSAPI_ERROR_NO_SOCKET is returned if no socket is available.

This call is non-blocking. If accept would block, NSAPI_ERROR_WOULD_BLOCK is returned immediately.

Parameters

server	Socket handle to server to accept from
handle	Destination for a handle to the newly created socket
address	Destination for the remote address or NULL

Returns

NSAPI_ERROR_OK on success, negative error code on failure

Implemented in LWIP, EmacTestNetworkStack, Nanostack, AT_CellularStack, TELIT_ME310_CellularStack, QUECTEL_M26_CellularStack, UBLOX_AT_CellularStack, QUECTEL_BG96_CellularStack, RM1000_AT_CellularStack, UBLOX_N2XX_CellularStack, and QUECTEL_BC95_CellularStack.

Register a callback on state change of the socket.

The specified callback will be called on state changes such as when the socket can recv/send/accept successfully and on when an error occurs. The callback may also be called spuriously without reason.

The callback may be called in an interrupt context and should not perform expensive operations such as recv/send calls.

Parameters

handle	Socket handle
callback	Function to call on state change
data	Argument to pass to callback

Implemented in LWIP, EmacTestNetworkStack, Nanostack, and AT_CellularStack.

Bind a specific address to a socket.

Binding a socket specifies the address and port on which to receive data. If the IP address is zeroed, only the port is bound.

Parameters

handle	Socket handle
address	Local address to bind

Returns

NSAPI_ERROR_OK on success, negative error code on failure.

Implemented in LWIP, EmacTestNetworkStack, Nanostack, AT_CellularStack, and QUECTEL_M26_CellularStack.

Close the socket.

Closes any open connection and deallocates any memory associated with the socket.

Parameters

handle

Socket handle

Returns

NSAPI_ERROR_OK on success, negative error code on failure

Implemented in LWIP, EmacTestNetworkStack, Nanostack, and AT_CellularStack.

Connects TCP socket to a remote host.

Initiates a connection to a remote server specified by the indicated address.

Parameters

handle	Socket handle
address	The SocketAddress of the remote host

Returns

NSAPI_ERROR_OK on success, negative error code on failure

Implemented in LWIP, EmacTestNetworkStack, Nanostack, AT_CellularStack, UBLOX_AT_CellularStack, RM1000_AT_CellularStack, TELIT_ME310_CellularStack, QUECTEL_M26_CellularStack, GEMALTO_CINTERION_CellularStack, QUECTEL_BG96_CellularStack, and QUECTEL_BC95_CellularStack.

Listen for connections on a TCP socket.

Marks the socket as a passive socket that can be used to accept incoming connections.

Parameters

handle	Socket handle
backlog	Number of pending connections that can be queued simultaneously

Returns

NSAPI_ERROR_OK on success, negative error code on failure

Implemented in LWIP, EmacTestNetworkStack, Nanostack, AT_CellularStack, TELIT_ME310_CellularStack, QUECTEL_M26_CellularStack, UBLOX_AT_CellularStack, QUECTEL_BG96_CellularStack, RM1000_AT_CellularStack, UBLOX_N2XX_CellularStack, and QUECTEL_BC95_CellularStack.

Opens a socket.

Creates a network socket and stores it in the specified handle. The handle must be passed to following calls on the socket.

A stack may have a finite number of sockets, in this case NSAPI_ERROR_NO_SOCKET is returned if no socket is available.

Parameters

handle	Destination for the handle to a newly created socket
proto	Protocol of socket to open, NSAPI_TCP or NSAPI_UDP

Returns

NSAPI_ERROR_OK on success, negative error code on failure

Implemented in LWIP, EmacTestNetworkStack, Nanostack, and AT_CellularStack.

Receive data over a TCP socket.

The socket must be connected to a remote host. Returns the number of bytes received into the buffer.

This call is non-blocking. If recv would block, NSAPI_ERROR_WOULD_BLOCK is returned immediately.

Parameters

handle	Socket handle
data	Destination buffer for data received from the host
size	Size of the buffer in bytes

Returns

Number of received bytes on success, negative error code on failure

Implemented in LWIP, EmacTestNetworkStack, Nanostack, and AT_CellularStack.

Receive a packet over a UDP socket.

Receives data and stores the source address in address if address is not NULL. Returns the number of bytes received into the buffer.

This call is non-blocking. If recvfrom would block, NSAPI_ERROR_WOULD_BLOCK is returned immediately.

Parameters

handle	Socket handle
address	Destination for the source address or NULL
buffer	Destination buffer for data received from the host
size	Size of the buffer in bytes

Returns

Number of received bytes on success, negative error code on failure

Implemented in LWIP, EmacTestNetworkStack, Nanostack, and AT_CellularStack.

Receive a packet with ancillary data over a UDP socket.

Receives data and stores the source address in address if address is not NULL. Returns the number of bytes received into the buffer.

Additional information related to the message can be retrieved with the control data.

This call is non-blocking. If recvfrom would block, NSAPI_ERROR_WOULD_BLOCK is returned immediately.

Parameters

handle	Socket handle
address	Destination for the source address or NULL
buffer	Destination buffer for data received from the host
size	Size of the buffer in bytes
control	Storage for ancillary data
control_size	Size of ancillary data

Returns

Number of received bytes on success, negative error code on failure

Reimplemented in LWIP.

Definition at line 446 of file NetworkStack.h.

Send data over a TCP socket.

The socket must be connected to a remote host. Returns the number of bytes sent from the buffer.

This call is non-blocking. If send would block, NSAPI_ERROR_WOULD_BLOCK is returned immediately.

Parameters

handle	Socket handle
data	Buffer of data to send to the host
size	Size of the buffer in bytes

Returns

Number of sent bytes on success, negative error code on failure

Implemented in LWIP, EmacTestNetworkStack, Nanostack, and AT_CellularStack.

Send a packet over a UDP socket.

Sends data to the specified address. Returns the number of bytes sent from the buffer.

This call is non-blocking. If sendto would block, NSAPI_ERROR_WOULD_BLOCK is returned immediately.

Parameters

handle	Socket handle
address	The SocketAddress of the remote host
data	Buffer of data to send to the host
size	Size of the buffer in bytes

Returns

Number of sent bytes on success, negative error code on failure

Implemented in LWIP, EmacTestNetworkStack, Nanostack, and AT_CellularStack.

Send a packet with ancillary data over a UDP socket.

Sends data to the specified address. Returns the number of bytes sent from the buffer.

This call is non-blocking. If sendto would block, NSAPI_ERROR_WOULD_BLOCK is returned immediately.

Parameters

handle	Socket handle
address	The SocketAddress of the remote host
data	Buffer of data to send to the host
size	Size of the buffer in bytes
control	Storage for ancillary data
control_size	Size of ancillary data

Returns

Number of sent bytes on success, negative error code on failure

Reimplemented in LWIP.

Definition at line 415 of file NetworkStack.h.