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

status	NSAPI_ERROR_OK on success, negative error code on failure
address	On success, destination for the host SocketAddress

Definition at line 90 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.

Implements modem specific AT command set for creating socket.

Parameters

socket

Cellular socket handle

Find the socket handle based on the index of the socket construct in the socket container.

Please note that this index may or may not be the socket id. The actual meaning of this index depends upon the modem being used.

Parameters

index

Index of the socket construct in the container

Returns

Socket handle, NULL on error

Find the index of the given CellularSocket handle.

This index may or may not be the socket id. The actual meaning of this index depends upon the modem being used.

Getter for at handler.

Common method for all AT-classes.

Returns

reference to ATHandler

Gets the device error that happened when using AT commands/responses.

This is at error returned by the device. Returned CME/CMS errors can be found from 3gpp documents 27007 and 27005.

Returns

at error (CME/CMS) while communicating with the device

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

Get the local IP address.

Returns

Null-terminated representation of the local IP address or null if not yet connected

Reimplemented from NetworkStack.

Get the local IP address on interface name.

Parameters

interface_name

Network interface_name

Returns

Null-terminated representation of the local IP address or null if not yet connected

Gets maximum number of sockets modem supports.

Get value for the given key.

Parameters

key	key for value to be fetched

Returns

property value for the given key. Value type is defined in enum CellularProperty

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

Returns

NSAPI_ERROR_OK on success, negative error code on failure

Implements DNS.

Translates a hostname to an IP address (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.

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 EmacTestNetworkStack, and Nanostack.

Checks if modem supports the given protocol.

Parameters

protocol

Protocol type

Dynamic downcast to a OnboardNetworkStack.

Definition at line 179 of file NetworkStack.h.

Cellular module need to define an array of cellular properties which defines module supported property values.

Parameters

property_array

array of module properties

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 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

Implements NetworkStack.

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

Implements NetworkStack.

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.

Implements NetworkStack.

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

Implements NetworkStack.

Implements modem specific AT command set for socket closing.

Parameters

sock_id

Socket id

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

Implements NetworkStack.

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

Implements NetworkStack.

Note: Socket_open does not actually open socket on all drivers, but that's deferred until calling sendto.

The reason is that IP stack implementations are very much modem specific and it's quite common that when a socket is created (via AT commands) it must also be given remote IP address, and that is usually known only when calling sendto.

Implements NetworkStack.

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

Implements NetworkStack.

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

Implements NetworkStack.

Implements modem specific AT command set for receiving data.

Parameters

socket	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

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

Implements NetworkStack.

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

Implements NetworkStack.

Implements modem specific AT command set for sending data.

Parameters

socket	Cellular 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

Modem specific socket stack initialization.

Returns

0 on success