Mistake on this page?
Report an issue in GitHub or email us
Public Types | Public Member Functions | Protected Member Functions
NetworkStack Class Referenceabstract

NetworkStack class. More...

#include <NetworkStack.h>

Inheritance diagram for NetworkStack:
DNS AT_CellularStack OnboardNetworkStack GEMALTO_CINTERION_CellularStack QUECTEL_BC95_CellularStack QUECTEL_BG96_CellularStack QUECTEL_M26_CellularStack RM1000_AT_CellularStack TELIT_ME310_CellularStack UBLOX_AT_CellularStack UBLOX_N2XX_CellularStack EmacTestNetworkStack LWIP Nanostack

Public Types

typedef mbed::Callback< void(nsapi_value_or_error_t result, SocketAddress *address)> hostbyname_cb_t
 Hostname translation callback (asynchronous) More...
 

Public Member Functions

virtual nsapi_error_t get_ip_address (SocketAddress *address)
 Get the local IP address. More...
 
virtual nsapi_error_t get_ipv6_link_local_address (SocketAddress *address)
 Get the IPv6 link local address. More...
 
virtual nsapi_error_t get_ip_address_if (SocketAddress *address, const char *interface_name)
 Get the local IP address on interface name. More...
 
virtual nsapi_error_t gethostbyname (const char *host, SocketAddress *address, nsapi_version_t version=NSAPI_UNSPEC, const char *interface_name=NULL)
 Translates a hostname to an IP address with specific version. More...
 
virtual nsapi_value_or_error_t getaddrinfo (const char *hostname, SocketAddress *hints, SocketAddress **res, const char *interface_name=NULL)
 Translate a hostname to the multiple IP addresses with specific version using network interface name. More...
 
virtual nsapi_value_or_error_t gethostbyname_async (const char *host, hostbyname_cb_t callback, nsapi_version_t version=NSAPI_UNSPEC, const char *interface_name=NULL)
 Translates a hostname to multiple IP addresses (asynchronous) More...
 
virtual nsapi_value_or_error_t getaddrinfo_async (const char *hostname, SocketAddress *hints, hostbyname_cb_t callback, const char *interface_name=NULL)
 Translates a hostname to the multiple IP addresses (asynchronous) More...
 
virtual nsapi_error_t gethostbyname_async_cancel (int id)
 Cancels asynchronous hostname translation. More...
 
virtual nsapi_error_t add_dns_server (const SocketAddress &address, const char *interface_name=NULL)
 Add a domain name server to list of servers to query. More...
 
virtual nsapi_error_t get_dns_server (int index, SocketAddress *address, const char *interface_name=NULL)
 Get a domain name server from a list of servers to query. More...
 
virtual OnboardNetworkStackonboardNetworkStack ()
 Dynamic downcast to a OnboardNetworkStack. More...
 

Protected Member Functions

virtual nsapi_error_t socket_open (nsapi_socket_t *handle, nsapi_protocol_t proto)=0
 Opens a socket. More...
 
virtual nsapi_error_t socket_close (nsapi_socket_t handle)=0
 Close the socket. More...
 
virtual nsapi_error_t socket_bind (nsapi_socket_t handle, const SocketAddress &address)=0
 Bind a specific address to a socket. More...
 
virtual nsapi_error_t socket_listen (nsapi_socket_t handle, int backlog)=0
 Listen for connections on a TCP socket. More...
 
virtual nsapi_error_t socket_connect (nsapi_socket_t handle, const SocketAddress &address)=0
 Connects TCP socket to a remote host. More...
 
virtual nsapi_error_t socket_accept (nsapi_socket_t server, nsapi_socket_t *handle, SocketAddress *address=0)=0
 Accepts a connection on a TCP socket. More...
 
virtual nsapi_size_or_error_t socket_send (nsapi_socket_t handle, const void *data, nsapi_size_t size)=0
 Send data over a TCP socket. More...
 
virtual nsapi_size_or_error_t socket_recv (nsapi_socket_t handle, void *data, nsapi_size_t size)=0
 Receive data over a TCP socket. More...
 
virtual nsapi_size_or_error_t socket_sendto (nsapi_socket_t handle, const SocketAddress &address, const void *data, nsapi_size_t size)=0
 Send a packet over a UDP socket. More...
 
virtual nsapi_size_or_error_t socket_recvfrom (nsapi_socket_t handle, SocketAddress *address, void *buffer, nsapi_size_t size)=0
 Receive a packet over a UDP socket. More...
 
virtual nsapi_size_or_error_t socket_sendto_control (nsapi_socket_t handle, const SocketAddress &address, const void *data, nsapi_size_t size, nsapi_msghdr_t *control, nsapi_size_t control_size)
 Send a packet with ancillary data over a UDP socket. More...
 
virtual nsapi_size_or_error_t socket_recvfrom_control (nsapi_socket_t handle, SocketAddress *address, void *data, nsapi_size_t size, nsapi_msghdr_t *control, nsapi_size_t control_size)
 Receive a packet with ancillary data over a UDP socket. More...
 
virtual void socket_attach (nsapi_socket_t handle, void(*callback)(void *), void *data)=0
 Register a callback on state change of the socket. More...
 
virtual nsapi_error_t setsockopt (nsapi_socket_t handle, int level, int optname, const void *optval, unsigned optlen)
 Set stack-specific socket options. More...
 
virtual nsapi_error_t getsockopt (nsapi_socket_t handle, int level, int optname, void *optval, unsigned *optlen)
 Get stack-specific socket options. More...
 

Detailed Description

NetworkStack class.

Common interface that is shared between hardware that can connect to a network over IP. By implementing the NetworkStack, a network stack can be used as a target for instantiating network sockets.

Definition at line 42 of file NetworkStack.h.

Member Typedef Documentation

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
resultNegative error code on failure or value that represents the number of DNS records
addressOn success, destination for the host SocketAddress

Definition at line 127 of file NetworkStack.h.

Member Function Documentation

virtual nsapi_error_t add_dns_server ( const SocketAddress address,
const char *  interface_name = NULL 
)
virtual

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

Parameters
addressDestination for the host address
interface_nameNetwork interface name
Returns
NSAPI_ERROR_OK on success, negative error code on failure

Implements DNS.

Reimplemented in LWIP.

virtual nsapi_error_t get_dns_server ( int  index,
SocketAddress address,
const char *  interface_name = NULL 
)
virtual

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
indexIndex of the DNS server, starts from zero
addressDestination for the host address
interface_nameNetwork interface name
Returns
NSAPI_ERROR_OK on success, negative error code on failure

Reimplemented in LWIP, and Nanostack.

virtual nsapi_error_t get_ip_address ( SocketAddress address)
virtual

Get the local IP address.

Parameters
addressSocketAddress representation of the local IP address
Return values
NSAPI_ERROR_OKon success
NSAPI_ERROR_UNSUPPORTEDif this feature is not supported
NSAPI_ERROR_PARAMETERif the provided pointer is invalid
NSAPI_ERROR_NO_ADDRESSif the address cannot be obtained from stack

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

virtual nsapi_error_t get_ip_address_if ( SocketAddress address,
const char *  interface_name 
)
virtual

Get the local IP address on interface name.

Parameters
addressSocketAddress representation of the link local IPv6 address
interface_nameNetwork interface_name
Return values
NSAPI_ERROR_OKon success
NSAPI_ERROR_UNSUPPORTEDif this feature is not supported
NSAPI_ERROR_PARAMETERif the provided pointer is invalid
NSAPI_ERROR_NO_ADDRESSif the address cannot be obtained from stack

Reimplemented in LWIP.

virtual nsapi_error_t get_ipv6_link_local_address ( SocketAddress address)
virtual

Get the IPv6 link local address.

Parameters
addressSocketAddress representation of the link local IPv6 address
Return values
NSAPI_ERROR_OKon success
NSAPI_ERROR_UNSUPPORTEDif this feature is not supported
NSAPI_ERROR_PARAMETERif the provided pointer is invalid
virtual nsapi_value_or_error_t getaddrinfo ( const char *  hostname,
SocketAddress hints,
SocketAddress **  res,
const char *  interface_name = NULL 
)
virtual

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
hostnameHostname to resolve.
hintsPointer to a SocketAddress with query parameters.
resPointer to a SocketAddress array to store the result..
interface_nameNetwork interface name
Returns
number of results on success, negative error code on failure.

Implements DNS.

virtual nsapi_value_or_error_t getaddrinfo_async ( const char *  hostname,
SocketAddress hints,
hostbyname_cb_t  callback,
const char *  interface_name = NULL 
)
virtual

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
hostnameHostname to resolve
hintsPointer to a SocketAddress with query parameters.
callbackCallback that is called for result
interface_nameNetwork 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.

virtual nsapi_error_t gethostbyname ( const char *  host,
SocketAddress address,
nsapi_version_t  version = NSAPI_UNSPEC,
const char *  interface_name = NULL 
)
virtual

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
hostHostname to resolve
addressPointer to a SocketAddress to store the result.
versionIP version of address to resolve, NSAPI_UNSPEC indicates version is chosen by the stack (defaults to NSAPI_UNSPEC)
interface_nameNetwork interface_name
Return values
NSAPI_ERROR_OKon success
NSAPI_ERROR_PARAMETERif invalid (null) name is provided
NSAPI_ERROR_DNS_FAILUREif DNS resolution fails
intother negative errors, see nsapi_dns_query

Implements DNS.

Reimplemented in Nanostack, UBLOX_AT_CellularStack, and RM1000_AT_CellularStack.

virtual nsapi_value_or_error_t gethostbyname_async ( const char *  host,
hostbyname_cb_t  callback,
nsapi_version_t  version = NSAPI_UNSPEC,
const char *  interface_name = NULL 
)
virtual

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
hostHostname to resolve
callbackCallback that is called for result
versionIP version of address to resolve, NSAPI_UNSPEC indicates version is chosen by the stack (defaults to NSAPI_UNSPEC)
interface_nameNetwork 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.

virtual nsapi_error_t gethostbyname_async_cancel ( int  id)
virtual

Cancels asynchronous hostname translation.

When translation is cancelled, callback will not be called.

Parameters
idUnique id of the hostname translation operation
Returns
NSAPI_ERROR_OK on success, negative error code on failure

Implements DNS.

virtual nsapi_error_t getsockopt ( nsapi_socket_t  handle,
int  level,
int  optname,
void *  optval,
unsigned *  optlen 
)
protectedvirtual

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
handleSocket handle.
levelStack-specific protocol level.
optnameStack-specific option identifier.
optvalDestination for option value.
optlenLength of the option value.
Returns
NSAPI_ERROR_OK on success, negative error code on failure.

Reimplemented in LWIP, EmacTestNetworkStack, and Nanostack.

virtual OnboardNetworkStack* onboardNetworkStack ( )
virtual

Dynamic downcast to a OnboardNetworkStack.

Reimplemented in OnboardNetworkStack.

Definition at line 239 of file NetworkStack.h.

virtual nsapi_error_t setsockopt ( nsapi_socket_t  handle,
int  level,
int  optname,
const void *  optval,
unsigned  optlen 
)
protectedvirtual

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
handleSocket handle.
levelStack-specific protocol level.
optnameStack-specific option identifier.
optvalOption value.
optlenLength of the option value.
Returns
NSAPI_ERROR_OK on success, negative error code on failure.

Reimplemented in LWIP, EmacTestNetworkStack, and Nanostack.

virtual nsapi_error_t socket_accept ( nsapi_socket_t  server,
nsapi_socket_t handle,
SocketAddress address = 0 
)
protectedpure virtual

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
serverSocket handle to server to accept from
handleDestination for a handle to the newly created socket
addressDestination 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.

virtual void socket_attach ( nsapi_socket_t  handle,
void(*)(void *)  callback,
void *  data 
)
protectedpure virtual

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
handleSocket handle
callbackFunction to call on state change
dataArgument to pass to callback

Implemented in LWIP, EmacTestNetworkStack, Nanostack, and AT_CellularStack.

virtual nsapi_error_t socket_bind ( nsapi_socket_t  handle,
const SocketAddress address 
)
protectedpure virtual

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
handleSocket handle
addressLocal 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.

virtual nsapi_error_t socket_close ( nsapi_socket_t  handle)
protectedpure virtual

Close the socket.

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

Parameters
handleSocket handle
Returns
NSAPI_ERROR_OK on success, negative error code on failure

Implemented in LWIP, EmacTestNetworkStack, Nanostack, and AT_CellularStack.

virtual nsapi_error_t socket_connect ( nsapi_socket_t  handle,
const SocketAddress address 
)
protectedpure virtual

Connects TCP socket to a remote host.

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

Parameters
handleSocket handle
addressThe 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.

virtual nsapi_error_t socket_listen ( nsapi_socket_t  handle,
int  backlog 
)
protectedpure virtual

Listen for connections on a TCP socket.

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

Parameters
handleSocket handle
backlogNumber 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.

virtual nsapi_error_t socket_open ( nsapi_socket_t handle,
nsapi_protocol_t  proto 
)
protectedpure virtual

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
handleDestination for the handle to a newly created socket
protoProtocol 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.

virtual nsapi_size_or_error_t socket_recv ( nsapi_socket_t  handle,
void *  data,
nsapi_size_t  size 
)
protectedpure virtual

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
handleSocket handle
dataDestination buffer for data received from the host
sizeSize 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.

virtual nsapi_size_or_error_t socket_recvfrom ( nsapi_socket_t  handle,
SocketAddress address,
void *  buffer,
nsapi_size_t  size 
)
protectedpure virtual

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
handleSocket handle
addressDestination for the source address or NULL
bufferDestination buffer for data received from the host
sizeSize 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.

virtual nsapi_size_or_error_t socket_recvfrom_control ( nsapi_socket_t  handle,
SocketAddress address,
void *  data,
nsapi_size_t  size,
nsapi_msghdr_t control,
nsapi_size_t  control_size 
)
protectedvirtual

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
handleSocket handle
addressDestination for the source address or NULL
bufferDestination buffer for data received from the host
sizeSize of the buffer in bytes
controlStorage for ancillary data
control_sizeSize 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.

virtual nsapi_size_or_error_t socket_send ( nsapi_socket_t  handle,
const void *  data,
nsapi_size_t  size 
)
protectedpure virtual

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
handleSocket handle
dataBuffer of data to send to the host
sizeSize 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.

virtual nsapi_size_or_error_t socket_sendto ( nsapi_socket_t  handle,
const SocketAddress address,
const void *  data,
nsapi_size_t  size 
)
protectedpure virtual

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
handleSocket handle
addressThe SocketAddress of the remote host
dataBuffer of data to send to the host
sizeSize 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.

virtual nsapi_size_or_error_t socket_sendto_control ( nsapi_socket_t  handle,
const SocketAddress address,
const void *  data,
nsapi_size_t  size,
nsapi_msghdr_t control,
nsapi_size_t  control_size 
)
protectedvirtual

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
handleSocket handle
addressThe SocketAddress of the remote host
dataBuffer of data to send to the host
sizeSize of the buffer in bytes
controlStorage for ancillary data
control_sizeSize 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.

Important Information for this Arm website

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.