Mistake on this page?
Report an issue in GitHub or email us
Data Structures | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions
Nanostack Class Reference
Inheritance diagram for Nanostack:
OnboardNetworkStack NonCopyable< Nanostack > NetworkStack DNS

Data Structures

class  EthernetInterface
 
class  Interface
 
class  MeshInterface
 

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_value_or_error_t gethostbyname_async (const char *host, hostbyname_cb_t callback, nsapi_version_t version=NSAPI_UNSPEC)
 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)
 Add a domain name server to list of servers to query. More...
 
virtual nsapi_error_t get_dns_server (int index, SocketAddress *address)
 Get a domain name server from a list of servers to query. More...
 
virtual OnboardNetworkStackonboardNetworkStack ()
 Dynamic downcast to a OnboardNetworkStack. More...
 

Static Public Member Functions

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

Protected Member Functions

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

Detailed Description

Definition at line 29 of file Nanostack.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
statusNSAPI_ERROR_OK on success, negative error code on failure
addressOn success, destination for the host SocketAddress

Definition at line 81 of file NetworkStack.h.

Member Function Documentation

virtual nsapi_error_t add_dns_server ( const SocketAddress address)
virtualinherited

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

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

Implements DNS.

Reimplemented in EmacTestNetworkStack.

virtual nsapi_error_t add_ethernet_interface ( EMAC emac,
bool  default_if,
OnboardNetworkStack::Interface **  interface_out 
)
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
emacEMAC HAL implementation for this network interface
default_iftrue if the interface should be treated as the default one
[out]interface_outpointer to stack interface object controlling the EMAC
Returns
NSAPI_ERROR_OK on success, or error code

Implements OnboardNetworkStack.

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.

virtual nsapi_error_t get_dns_server ( int  index,
SocketAddress address 
)
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.

Parameters
indexIndex of the DNS server, starts from zero
addressDestination for the host address
Returns
NSAPI_ERROR_OK on success, negative error code on failure
virtual const char* get_ip_address ( )
protectedvirtual

Get the local IP address.

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

Reimplemented from NetworkStack.

virtual nsapi_error_t gethostbyname ( const char *  host,
SocketAddress address,
nsapi_version_t  version = NSAPI_UNSPEC 
)
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.

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

Implements DNS.

Reimplemented in EmacTestNetworkStack.

virtual nsapi_value_or_error_t gethostbyname_async ( const char *  host,
hostbyname_cb_t  callback,
nsapi_version_t  version = 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.

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)
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_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.

virtual nsapi_error_t getsockopt ( void *  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 from NetworkStack.

virtual OnboardNetworkStack* onboardNetworkStack ( )
virtualinherited

Dynamic downcast to a OnboardNetworkStack.

Definition at line 167 of file NetworkStack.h.

virtual nsapi_error_t setsockopt ( void *  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 from NetworkStack.

virtual nsapi_error_t socket_accept ( void *  handle,
void **  server,
SocketAddress address 
)
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.

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.

virtual void socket_attach ( void *  handle,
void(*)(void *)  callback,
void *  data 
)
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.

Parameters
handleSocket handle
callbackFunction to call on state change
dataArgument to pass to callback

Implements NetworkStack.

virtual nsapi_error_t socket_bind ( void *  handle,
const SocketAddress address 
)
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.

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

Implements NetworkStack.

virtual nsapi_error_t socket_close ( void *  handle)
protectedvirtual

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.

virtual nsapi_error_t socket_connect ( void *  handle,
const SocketAddress address 
)
protectedvirtual

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.

virtual nsapi_error_t socket_listen ( void *  handle,
int  backlog 
)
protectedvirtual

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.

virtual nsapi_error_t socket_open ( void **  handle,
nsapi_protocol_t  proto 
)
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.

Parameters
handleDestination for the handle to a newly created socket
protoProtocol of socket to open, NSAPI_TCP or NSAPI_UDP
Returns
0 on success, negative error code on failure

Implements NetworkStack.

virtual nsapi_size_or_error_t socket_recv ( void *  handle,
void *  data,
nsapi_size_t  size 
)
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.

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.

virtual nsapi_size_or_error_t socket_recvfrom ( void *  handle,
SocketAddress address,
void *  buffer,
nsapi_size_t  size 
)
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.

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.

virtual nsapi_size_or_error_t socket_send ( void *  handle,
const void *  data,
nsapi_size_t  size 
)
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.

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.

virtual nsapi_size_or_error_t socket_sendto ( void *  handle,
const SocketAddress address,
const void *  data,
nsapi_size_t  size 
)
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.

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.

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.