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
OnboardNetworkStack Class Reference
mbed OS API for onboard IP stack abstraction More...
#include <OnboardNetworkStack.h>
Inherits NetworkStack.
Inherited by LWIP, and Nanostack.
Data Structures | |
class | Interface |
Representation of a stack's view of an interface. More... | |
Public Types | |
typedef mbed::Callback< void(nsapi_error_t result, SocketAddress *address) | hostbyname_cb_t ) |
Hostname translation callback (asynchronous) | |
Public Member Functions | |
virtual nsapi_error_t | add_ethernet_interface (EMAC &emac, bool default_if, Interface **interface_out)=0 |
Register a network interface with the IP stack. | |
virtual nsapi_error_t | get_ip_address (SocketAddress *address) |
Get the local IP address. | |
virtual nsapi_error_t | get_ipv6_link_local_address (SocketAddress *address) |
Get the IPv6 link local address. | |
virtual nsapi_error_t | get_ip_address_if (SocketAddress *address, const char *interface_name) |
Get the local IP address on interface name. | |
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. | |
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 an IP address (asynchronous) | |
virtual nsapi_error_t | gethostbyname_async_cancel (int id) |
Cancels asynchronous hostname translation. | |
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. | |
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. | |
virtual OnboardNetworkStack * | onboardNetworkStack () |
Dynamic downcast to a OnboardNetworkStack. | |
Static Public Member Functions | |
static OnboardNetworkStack & | get_default_instance () |
Return the default on-board network stack. | |
Protected Member Functions | |
virtual nsapi_error_t | socket_open (nsapi_socket_t *handle, nsapi_protocol_t proto)=0 |
Opens a socket. | |
virtual nsapi_error_t | socket_close (nsapi_socket_t handle)=0 |
Close the socket. | |
virtual nsapi_error_t | socket_bind (nsapi_socket_t handle, const SocketAddress &address)=0 |
Bind a specific address to a socket. | |
virtual nsapi_error_t | socket_listen (nsapi_socket_t handle, int backlog)=0 |
Listen for connections on a TCP socket. | |
virtual nsapi_error_t | socket_connect (nsapi_socket_t handle, const SocketAddress &address)=0 |
Connects TCP socket to a remote host. | |
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. | |
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. | |
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. | |
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. | |
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. | |
virtual void | socket_attach (nsapi_socket_t handle, void(*callback)(void *), void *data)=0 |
Register a callback on state change of the socket. | |
virtual nsapi_error_t | setsockopt (nsapi_socket_t handle, int level, int optname, const void *optval, unsigned optlen) |
Set stack-specific socket options. | |
virtual nsapi_error_t | getsockopt (nsapi_socket_t handle, int level, int optname, void *optval, unsigned *optlen) |
Get stack-specific socket options. | |
Friends | |
class | InternetSocket |
class | InternetDatagramSocket |
class | TCPSocket |
class | TCPServer |
Detailed Description
mbed OS API for onboard IP stack abstraction
This interface should be used by targets to initialize IP stack, create, bring up and bring down network interfaces.
An onboard network stack has the potential ability to register interfaces such as through EMAC, and has its own interface identifiers.
Definition at line 35 of file OnboardNetworkStack.h.
Member Typedef Documentation
typedef mbed::Callback<void (nsapi_error_t result, SocketAddress *address) hostbyname_cb_t) [inherited] |
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
Reimplemented from DNS.
Definition at line 114 of file NetworkStack.h.
Member Function Documentation
nsapi_error_t add_dns_server | ( | const SocketAddress & | address, |
const char * | interface_name = NULL |
||
) | [virtual, inherited] |
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.
Definition at line 116 of file NetworkStack.cpp.
virtual nsapi_error_t add_ethernet_interface | ( | EMAC & | emac, |
bool | default_if, | ||
Interface ** | interface_out | ||
) | [pure virtual] |
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
OnboardNetworkStack & get_default_instance | ( | ) | [static] |
Return the default on-board network stack.
Returns the default on-board network stack, as configured by JSON option nsapi.default-stack.
Definition at line 714 of file LWIPStack.cpp.
nsapi_error_t get_dns_server | ( | int | index, |
SocketAddress * | address, | ||
const char * | interface_name = NULL |
||
) | [virtual, inherited] |
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
Definition at line 121 of file NetworkStack.cpp.
nsapi_error_t get_ip_address | ( | SocketAddress * | address ) | [virtual, inherited] |
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 ESP8266Interface, and AT_CellularStack.
Definition at line 27 of file NetworkStack.cpp.
nsapi_error_t get_ip_address_if | ( | SocketAddress * | address, |
const char * | interface_name | ||
) | [virtual, inherited] |
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
Definition at line 42 of file NetworkStack.cpp.
nsapi_error_t get_ipv6_link_local_address | ( | SocketAddress * | address ) | [virtual, inherited] |
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
Definition at line 37 of file NetworkStack.cpp.
nsapi_error_t gethostbyname | ( | const char * | host, |
SocketAddress * | address, | ||
nsapi_version_t | version = NSAPI_UNSPEC , |
||
const char * | interface_name = NULL |
||
) | [virtual, inherited] |
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.
Definition at line 52 of file NetworkStack.cpp.
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, inherited] |
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.
Definition at line 79 of file NetworkStack.cpp.
nsapi_error_t gethostbyname_async_cancel | ( | int | id ) | [virtual, inherited] |
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.
Definition at line 111 of file NetworkStack.cpp.
virtual nsapi_error_t getsockopt | ( | nsapi_socket_t | handle, |
int | level, | ||
int | optname, | ||
void * | optval, | ||
unsigned * | optlen | ||
) | [protected, virtual, inherited] |
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 ESP8266Interface.
virtual OnboardNetworkStack* onboardNetworkStack | ( | ) | [virtual, inherited] |
Dynamic downcast to a OnboardNetworkStack.
Definition at line 203 of file NetworkStack.h.
virtual nsapi_error_t setsockopt | ( | nsapi_socket_t | handle, |
int | level, | ||
int | optname, | ||
const void * | optval, | ||
unsigned | optlen | ||
) | [protected, virtual, inherited] |
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 ESP8266Interface.
virtual nsapi_error_t socket_accept | ( | nsapi_socket_t | server, |
nsapi_socket_t * | handle, | ||
SocketAddress * | address = 0 |
||
) | [protected, pure virtual, inherited] |
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 AT_CellularStack.
virtual void socket_attach | ( | nsapi_socket_t | handle, |
void(*)(void *) | callback, | ||
void * | data | ||
) | [protected, pure virtual, inherited] |
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 AT_CellularStack.
virtual nsapi_error_t socket_bind | ( | nsapi_socket_t | handle, |
const SocketAddress & | address | ||
) | [protected, pure virtual, inherited] |
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 AT_CellularStack.
virtual nsapi_error_t socket_close | ( | nsapi_socket_t | handle ) | [protected, pure virtual, inherited] |
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 AT_CellularStack.
virtual nsapi_error_t socket_connect | ( | nsapi_socket_t | handle, |
const SocketAddress & | address | ||
) | [protected, pure virtual, inherited] |
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 AT_CellularStack.
virtual nsapi_error_t socket_listen | ( | nsapi_socket_t | handle, |
int | backlog | ||
) | [protected, pure virtual, inherited] |
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 AT_CellularStack.
virtual nsapi_error_t socket_open | ( | nsapi_socket_t * | handle, |
nsapi_protocol_t | proto | ||
) | [protected, pure virtual, inherited] |
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 AT_CellularStack.
virtual nsapi_size_or_error_t socket_recv | ( | nsapi_socket_t | handle, |
void * | data, | ||
nsapi_size_t | size | ||
) | [protected, pure virtual, inherited] |
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 AT_CellularStack.
virtual nsapi_size_or_error_t socket_recvfrom | ( | nsapi_socket_t | handle, |
SocketAddress * | address, | ||
void * | buffer, | ||
nsapi_size_t | size | ||
) | [protected, pure virtual, inherited] |
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 AT_CellularStack.
virtual nsapi_size_or_error_t socket_send | ( | nsapi_socket_t | handle, |
const void * | data, | ||
nsapi_size_t | size | ||
) | [protected, pure virtual, inherited] |
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 AT_CellularStack.
virtual nsapi_size_or_error_t socket_sendto | ( | nsapi_socket_t | handle, |
const SocketAddress & | address, | ||
const void * | data, | ||
nsapi_size_t | size | ||
) | [protected, pure virtual, inherited] |
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 AT_CellularStack.
Generated on Tue Jul 12 2022 13:55:34 by
