Data Structures | |
class | Interface |
Public Types | |
typedef mbed::Callback< void(nsapi_error_t result, SocketAddress *address)> | hostbyname_cb_t |
Hostname translation callback (asynchronous) More... | |
Public Member Functions | |
virtual nsapi_error_t | add_ethernet_interface (EMAC &emac, bool default_if, OnboardNetworkStack::Interface **interface_out) |
Register a network interface with the IP stack. More... | |
virtual nsapi_error_t | gethostbyname (const char *host, SocketAddress *address, nsapi_version_t version=NSAPI_UNSPEC) |
Translates a hostname to an IP address with specific version. More... | |
virtual nsapi_error_t | add_dns_server (const SocketAddress &address) |
Add a domain name server to list of servers to query. More... | |
virtual const char * | get_ip_address () |
Get the local IP address. More... | |
virtual const char * | get_ip_address_if (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 | 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) 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 OnboardNetworkStack * | onboardNetworkStack () |
Dynamic downcast to a OnboardNetworkStack. More... | |
Static Public Member Functions | |
static OnboardNetworkStack & | get_default_instance () |
Return the default on-board network stack. More... | |
Protected Member Functions | |
virtual nsapi_error_t | socket_open (nsapi_socket_t *handle, nsapi_protocol_t proto) |
Opens a socket. More... | |
virtual nsapi_error_t | socket_close (nsapi_socket_t handle) |
Close the socket. More... | |
virtual nsapi_error_t | socket_bind (nsapi_socket_t handle, const SocketAddress &address) |
Bind a specific address to a socket. More... | |
virtual nsapi_error_t | socket_listen (nsapi_socket_t handle, int backlog) |
Listen for connections on a TCP socket. More... | |
virtual nsapi_error_t | socket_connect (nsapi_socket_t handle, const SocketAddress &address) |
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) |
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) |
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) |
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) |
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) |
Receive a packet over a UDP socket. More... | |
virtual void | socket_attach (nsapi_socket_t handle, void(*callback)(void *), void *data) |
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... | |
Definition at line 27 of file emac_TestNetworkStack.h.
|
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.
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.
|
virtualinherited |
Add a domain name server to list of servers to query.
address | Destination for the host address |
interface_name | Network interface name |
Implements DNS.
|
virtual |
Add a domain name server to list of servers to query.
address | Destination for the host address |
|
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 | 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 |
Implements OnboardNetworkStack.
|
staticinherited |
Return the default on-board network stack.
Returns the default on-board network stack, as configured by JSON option nsapi.default-stack.
|
virtualinherited |
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.
index | Index of the DNS server, starts from zero |
address | Destination for the host address |
interface_name | Network interface name |
|
virtualinherited |
Get the local IP address.
Reimplemented in Nanostack, and AT_CellularStack.
|
virtualinherited |
Get the local IP address on interface name.
interface_name | Network interface_name |
|
virtualinherited |
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.
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 |
Implements DNS.
|
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.
host | Hostname to resolve |
address | Destination for the host SocketAddress |
version | IP version of address to resolve, NSAPI_UNSPEC indicates version is chosen by the stack (defaults to NSAPI_UNSPEC) |
|
virtualinherited |
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.
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 |
Implements DNS.
|
virtualinherited |
Cancels asynchronous hostname translation.
When translation is cancelled, callback will not be called.
id | Unique id of the hostname translation operation |
Implements DNS.
|
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.
handle | Socket handle. |
level | Stack-specific protocol level. |
optname | Stack-specific option identifier. |
optval | Destination for option value. |
optlen | Length of the option value. |
Reimplemented from NetworkStack.
|
virtualinherited |
Dynamic downcast to a OnboardNetworkStack.
Definition at line 179 of file NetworkStack.h.
|
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.
handle | Socket handle. |
level | Stack-specific protocol level. |
optname | Stack-specific option identifier. |
optval | Option value. |
optlen | Length of the option value. |
Reimplemented from NetworkStack.
|
protectedvirtual |
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.
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 |
Implements NetworkStack.
|
protectedvirtual |
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.
handle | Socket handle |
callback | Function to call on state change |
data | Argument to pass to callback |
Implements NetworkStack.
|
protectedvirtual |
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.
handle | Socket handle |
address | Local address to bind |
Implements NetworkStack.
|
protectedvirtual |
Close the socket.
Closes any open connection and deallocates any memory associated with the socket.
handle | Socket handle |
Implements NetworkStack.
|
protectedvirtual |
Connects TCP socket to a remote host.
Initiates a connection to a remote server specified by the indicated address.
handle | Socket handle |
address | The SocketAddress of the remote host |
Implements NetworkStack.
|
protectedvirtual |
Listen for connections on a TCP socket.
Marks the socket as a passive socket that can be used to accept incoming connections.
handle | Socket handle |
backlog | Number of pending connections that can be queued simultaneously |
Implements NetworkStack.
|
protectedvirtual |
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.
handle | Destination for the handle to a newly created socket |
proto | Protocol of socket to open, NSAPI_TCP or NSAPI_UDP |
Implements NetworkStack.
|
protectedvirtual |
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.
handle | Socket handle |
data | Destination buffer for data received from the host |
size | Size of the buffer in bytes |
Implements NetworkStack.
|
protectedvirtual |
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.
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 |
Implements NetworkStack.
|
protectedvirtual |
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.
handle | Socket handle |
data | Buffer of data to send to the host |
size | Size of the buffer in bytes |
Implements NetworkStack.
|
protectedvirtual |
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.
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 |
Implements NetworkStack.