Mbed OS Reference
Loading...
Searching...
No Matches
Nanostack Class Reference
Inheritance diagram for Nanostack:
OnboardNetworkStack NonCopyable< Nanostack > NetworkStack DNS

Data Structures

class  EthernetInterface
 
class  Interface
 
class  MeshInterface
 
class  PPPInterface
 

Public Types

typedef mbed::Callback< nsapi_error_t(int delay_ms, mbed::Callback< void()> user_cb)> call_in_callback_cb_t
 Type for a call-in callback. More...
 

Public Member Functions

nsapi_error_t add_ethernet_interface (EMAC &emac, bool default_if, OnboardNetworkStack::Interface **interface_out, NetworkInterface *user_network_interface=NULL) override
 Register a network interface with the IP stack. More...
 
OnboardNetworkStackonboardNetworkStack () final
 Dynamic downcast to a OnboardNetworkStack. 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_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 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...
 

Static Public Member Functions

static OnboardNetworkStackget_default_instance ()
 Return the default on-board network stack. More...
 

Protected Member Functions

nsapi_error_t get_ip_address (SocketAddress *address) override
 Get the local IP address. More...
 
virtual nsapi_error_t gethostbyname (const char *host, SocketAddress *address, nsapi_version_t version, const char *interface_name) override
 Translate a hostname to an IP address 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, const char *interface_name) override
 Translate a hostname to an IP address (asynchronous) using network interface name. More...
 
virtual nsapi_error_t get_dns_server (int index, SocketAddress *address, const char *interface_name) override
 Get a domain name server from a list of servers to query. More...
 
nsapi_error_t socket_open (void **handle, nsapi_protocol_t proto) override
 Opens a socket. More...
 
nsapi_error_t socket_close (void *handle) override
 Close the socket. More...
 
nsapi_error_t socket_bind (void *handle, const SocketAddress &address) override
 Bind a specific address to a socket. More...
 
nsapi_error_t socket_listen (void *handle, int backlog) override
 Listen for connections on a TCP socket. More...
 
nsapi_error_t socket_connect (void *handle, const SocketAddress &address) override
 Connects TCP socket to a remote host. More...
 
nsapi_error_t socket_accept (void *handle, void **server, SocketAddress *address) override
 Accepts a connection on a TCP socket. More...
 
nsapi_size_or_error_t socket_send (void *handle, const void *data, nsapi_size_t size) override
 Send data over a TCP socket. More...
 
nsapi_size_or_error_t socket_recv (void *handle, void *data, nsapi_size_t size) override
 Receive data over a TCP socket. More...
 
nsapi_size_or_error_t socket_sendto (void *handle, const SocketAddress &address, const void *data, nsapi_size_t size) override
 Send a packet over a UDP socket. More...
 
nsapi_size_or_error_t socket_recvfrom (void *handle, SocketAddress *address, void *buffer, nsapi_size_t size) override
 Receive a packet over a UDP socket. More...
 
void socket_attach (void *handle, void(*callback)(void *), void *data) override
 Register a callback on state change of the socket. More...
 
nsapi_error_t setsockopt (void *handle, int level, int optname, const void *optval, unsigned optlen) override
 Set stack-specific socket options. More...
 
nsapi_error_t getsockopt (void *handle, int level, int optname, void *optval, unsigned *optlen) override
 Get stack-specific socket options. 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...
 

Detailed Description

Definition at line 29 of file Nanostack.h.

Member Typedef Documentation

◆ call_in_callback_cb_t

typedef mbed::Callback<nsapi_error_t (int delay_ms, mbed::Callback<void()> user_cb)> call_in_callback_cb_t
inherited

Type for a call-in callback.

This is a pointer to a function that will call the provided callback from the network stack after a given delay, or immediately if delay_ms is 0.

Definition at line 235 of file NetworkStack.h.

Member Function Documentation

◆ add_ethernet_interface()

nsapi_error_t add_ethernet_interface ( EMAC emac,
bool  default_if,
OnboardNetworkStack::Interface **  interface_out,
NetworkInterface user_network_interface = NULL 
)
overridevirtual

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
emacEMAC HAL implementation for this network interface
default_iftrue if the interface should be treated as the default one
[out]interface_outNetwork stack's representation of the network interface will be saved to this pointer.
[in]user_network_interfacePointer to NetworkInterface that represents the ethernet interface being added.
Returns
NSAPI_ERROR_OK on success, or error code

Implements OnboardNetworkStack.

◆ get_ip_address()

nsapi_error_t get_ip_address ( SocketAddress address)
overrideprotectedvirtual

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 from NetworkStack.

◆ gethostbyname()

virtual nsapi_error_t gethostbyname ( const char *  host,
SocketAddress address,
nsapi_version_t  version,
const char *  interface_name 
)
overrideprotectedvirtual

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

Method first checks Nanostack DNS query result cache. If match is found, then the result is returned immediately. Otherwise method calls DNS resolver to find a match.

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
Returns
NSAPI_ERROR_OK on success, negative error code on failure.

Reimplemented from NetworkStack.

◆ gethostbyname_async()

virtual nsapi_value_or_error_t gethostbyname_async ( const char *  host,
hostbyname_cb_t  callback,
nsapi_version_t  version,
const char *  interface_name 
)
overrideprotectedvirtual

Translate a hostname to an IP address (asynchronous) using network interface name.

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

Method first checks Nanostack DNS query result cache. If match is found, then the result is returned immediately.

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.

Reimplemented from NetworkStack.

◆ get_dns_server()

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

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

Returns a DNS server address for a index. DNS servers are queried from Nanostack DNS cache. 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
0 on success, negative error code on failure

Reimplemented from NetworkStack.

◆ socket_open()

nsapi_error_t socket_open ( void **  handle,
nsapi_protocol_t  proto 
)
overrideprotectedvirtual

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, NSAPI_UDP or NSAPI_ICMP
Returns
0 on success, negative error code on failure

Implements NetworkStack.

◆ socket_close()

nsapi_error_t socket_close ( void *  handle)
overrideprotectedvirtual

Close the socket.

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

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

Implements NetworkStack.

◆ socket_bind()

nsapi_error_t socket_bind ( void *  handle,
const SocketAddress address 
)
overrideprotectedvirtual

Bind a specific address to a socket.

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

Parameters
handleSocket handle
addressLocal address to bind
Returns
0 on success, negative error code on failure.

Implements NetworkStack.

◆ socket_listen()

nsapi_error_t socket_listen ( void *  handle,
int  backlog 
)
overrideprotectedvirtual

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
0 on success, negative error code on failure

Implements NetworkStack.

◆ socket_connect()

nsapi_error_t socket_connect ( void *  handle,
const SocketAddress address 
)
overrideprotectedvirtual

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
0 on success, negative error code on failure

Implements NetworkStack.

◆ socket_accept()

nsapi_error_t socket_accept ( void *  handle,
void **  server,
SocketAddress address 
)
overrideprotectedvirtual

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
0 on success, negative error code on failure

Implements NetworkStack.

◆ socket_send()

nsapi_size_or_error_t socket_send ( void *  handle,
const void *  data,
nsapi_size_t  size 
)
overrideprotectedvirtual

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

Implements NetworkStack.

◆ socket_recv()

nsapi_size_or_error_t socket_recv ( void *  handle,
void *  data,
nsapi_size_t  size 
)
overrideprotectedvirtual

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

Implements NetworkStack.

◆ socket_sendto()

nsapi_size_or_error_t socket_sendto ( void *  handle,
const SocketAddress address,
const void *  data,
nsapi_size_t  size 
)
overrideprotectedvirtual

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

Implements NetworkStack.

◆ socket_recvfrom()

nsapi_size_or_error_t socket_recvfrom ( void *  handle,
SocketAddress address,
void *  buffer,
nsapi_size_t  size 
)
overrideprotectedvirtual

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

Implements NetworkStack.

◆ socket_attach()

void socket_attach ( void *  handle,
void(*)(void *)  callback,
void *  data 
)
overrideprotectedvirtual

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

Implements NetworkStack.

◆ setsockopt()

nsapi_error_t setsockopt ( void *  handle,
int  level,
int  optname,
const void *  optval,
unsigned  optlen 
)
overrideprotectedvirtual

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 from NetworkStack.

◆ getsockopt()

nsapi_error_t getsockopt ( void *  handle,
int  level,
int  optname,
void *  optval,
unsigned *  optlen 
)
overrideprotectedvirtual

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 from NetworkStack.

◆ get_default_instance()

static OnboardNetworkStack & get_default_instance ( )
staticinherited

Return the default on-board network stack.

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

◆ onboardNetworkStack()

OnboardNetworkStack * onboardNetworkStack ( )
finalvirtualinherited

Dynamic downcast to a OnboardNetworkStack.

Reimplemented from NetworkStack.

Definition at line 209 of file OnboardNetworkStack.h.

◆ get_ipv6_link_local_address()

virtual nsapi_error_t get_ipv6_link_local_address ( SocketAddress address)
virtualinherited

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

◆ get_ip_address_if()

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

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

◆ getaddrinfo()

virtual nsapi_value_or_error_t getaddrinfo ( const char *  hostname,
SocketAddress hints,
SocketAddress **  res,
const char *  interface_name = NULL 
)
virtualinherited

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.

◆ getaddrinfo_async()

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

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.

◆ gethostbyname_async_cancel()

virtual nsapi_error_t gethostbyname_async_cancel ( int  id)
virtualinherited

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.

◆ add_dns_server()

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

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

Parameters
addressDestination for the host address
interface_nameNetwork interface name. Currently unused, the server is added for all interfaces.
Returns
NSAPI_ERROR_OK on success, negative error code on failure

Implements DNS.

◆ socket_sendto_control()

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

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

Definition at line 408 of file NetworkStack.h.

◆ socket_recvfrom_control()

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

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.

Ancillary data is stored into control. The caller needs to allocate a buffer that is large enough to contain the data they want to receive, then pass the pointer in through the control member. The data will be filled into control, beginning with a header specifying what data was received. See MsgHeaderIterator for how to parse this 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
dataDestination 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

Definition at line 441 of file NetworkStack.h.