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 | Static Protected Member Functions
AT_CellularStack Class Referenceabstract

Class AT_CellularStack. More...

#include <AT_CellularStack.h>

Inheritance diagram for AT_CellularStack:
NetworkStack AT_CellularBase DNS

Data Structures

class  CellularSocket
 

Public Types

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

Public Member Functions

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 OnboardNetworkStackonboardNetworkStack ()
 Dynamic downcast to a OnboardNetworkStack. More...
 
ATHandlerget_at_handler ()
 Getter for at handler. More...
 
device_err_t get_device_error () const
 Gets the device error that happened when using AT commands/responses. More...
 

Static Public Member Functions

static void set_cellular_properties (const intptr_t *property_array)
 Cellular module need to define an array of cellular properties which defines module supported property values. More...
 

Protected Member Functions

virtual nsapi_error_t socket_stack_init ()
 Modem specific socket stack initialization. More...
 
virtual nsapi_error_t socket_open (nsapi_socket_t *handle, nsapi_protocol_t proto)
 Note: Socket_open does not actually open socket on all drivers, but that's deferred until calling sendto. 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 int get_max_socket_count ()=0
 Gets maximum number of sockets modem supports. More...
 
virtual bool is_protocol_supported (nsapi_protocol_t protocol)=0
 Checks if modem supports the given protocol. More...
 
virtual nsapi_error_t socket_close_impl (int sock_id)=0
 Implements modem specific AT command set for socket closing. More...
 
virtual nsapi_error_t create_socket_impl (CellularSocket *socket)=0
 Implements modem specific AT command set for creating socket. More...
 
virtual nsapi_size_or_error_t socket_sendto_impl (CellularSocket *socket, const SocketAddress &address, const void *data, nsapi_size_t size)=0
 Implements modem specific AT command set for sending data. More...
 
virtual nsapi_size_or_error_t socket_recvfrom_impl (CellularSocket *socket, SocketAddress *address, void *buffer, nsapi_size_t size)=0
 Implements modem specific AT command set for receiving data. More...
 
CellularSocketfind_socket (int sock_id)
 Find the socket handle based on socket identifier. 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...
 

Static Protected Member Functions

static intptr_t get_property (CellularProperty key)
 Get value for the given key. More...
 

Detailed Description

Class AT_CellularStack.

Implements NetworkStack and introduces interface for modem specific stack implementations.

Definition at line 37 of file AT_CellularStack.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 90 of file NetworkStack.h.

Member Function Documentation

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

Implements DNS.

virtual nsapi_error_t create_socket_impl ( CellularSocket socket)
protectedpure virtual

Implements modem specific AT command set for creating socket.

Parameters
socketCellular socket handle
CellularSocket* find_socket ( int  sock_id)
protected

Find the socket handle based on socket identifier.

Parameters
sock_idSocket identifier
Returns
Socket handle, NULL on error
ATHandler& get_at_handler ( )
inherited

Getter for at handler.

Common method for all AT-classes.

Returns
reference to ATHandler
device_err_t get_device_error ( ) const
inherited

Gets the device error that happened when using AT commands/responses.

This is at error returned by the device. Returned CME/CMS errors can be found from 3gpp documents 27007 and 27005.

Returns
at error (CME/CMS) while communicating with the device
virtual nsapi_error_t get_dns_server ( int  index,
SocketAddress address,
const char *  interface_name = NULL 
)
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
interface_nameNetwork interface name
Returns
NSAPI_ERROR_OK on success, negative error code on failure
virtual const char* get_ip_address ( )
virtual

Get the local IP address.

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

Reimplemented from NetworkStack.

virtual const char* get_ip_address_if ( const char *  interface_name)
virtualinherited

Get the local IP address on interface name.

Parameters
interface_nameNetwork interface_name
Returns
Null-terminated representation of the local IP address or null if not yet connected
virtual int get_max_socket_count ( )
protectedpure virtual

Gets maximum number of sockets modem supports.

static intptr_t get_property ( CellularProperty  key)
staticprotectedinherited

Get value for the given key.

Parameters
keykey for value to be fetched
Returns
property value for the given key. Value type is defined in enum CellularProperty
virtual nsapi_error_t gethostbyname ( const char *  host,
SocketAddress address,
nsapi_version_t  version = NSAPI_UNSPEC,
const char *  interface_name = NULL 
)
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)
interface_nameNetwork interface_name
Returns
NSAPI_ERROR_OK on success, negative error code on failure

Implements DNS.

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 
)
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)
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_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 ( nsapi_socket_t  handle,
int  level,
int  optname,
void *  optval,
unsigned *  optlen 
)
protectedvirtualinherited

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 EmacTestNetworkStack, and Nanostack.

virtual bool is_protocol_supported ( nsapi_protocol_t  protocol)
protectedpure virtual

Checks if modem supports the given protocol.

Parameters
protocolProtocol type
virtual OnboardNetworkStack* onboardNetworkStack ( )
virtualinherited

Dynamic downcast to a OnboardNetworkStack.

Definition at line 179 of file NetworkStack.h.

static void set_cellular_properties ( const intptr_t *  property_array)
staticinherited

Cellular module need to define an array of cellular properties which defines module supported property values.

Parameters
property_arrayarray of module properties
virtual nsapi_error_t setsockopt ( nsapi_socket_t  handle,
int  level,
int  optname,
const void *  optval,
unsigned  optlen 
)
protectedvirtualinherited

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 EmacTestNetworkStack, and Nanostack.

virtual nsapi_error_t socket_accept ( nsapi_socket_t  server,
nsapi_socket_t handle,
SocketAddress address = 0 
)
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
NSAPI_ERROR_OK on success, negative error code on failure

Implements NetworkStack.

virtual void socket_attach ( nsapi_socket_t  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 ( nsapi_socket_t  handle,
const SocketAddress address 
)
protectedvirtual

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.

Implements NetworkStack.

virtual nsapi_error_t socket_close ( nsapi_socket_t  handle)
protectedvirtual

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

Implements NetworkStack.

virtual nsapi_error_t socket_close_impl ( int  sock_id)
protectedpure virtual

Implements modem specific AT command set for socket closing.

Parameters
sock_idSocket id
virtual nsapi_error_t socket_connect ( nsapi_socket_t  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
NSAPI_ERROR_OK on success, negative error code on failure

Implements NetworkStack.

virtual nsapi_error_t socket_listen ( nsapi_socket_t  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
NSAPI_ERROR_OK on success, negative error code on failure

Implements NetworkStack.

virtual nsapi_error_t socket_open ( nsapi_socket_t handle,
nsapi_protocol_t  proto 
)
protectedvirtual

Note: Socket_open does not actually open socket on all drivers, but that's deferred until calling sendto.

The reason is that IP stack implementations are very much modem specific and it's quite common that when a socket is created (via AT commands) it must also be given remote IP address, and that is usually known only when calling sendto.

Implements NetworkStack.

virtual nsapi_size_or_error_t socket_recv ( nsapi_socket_t  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 ( nsapi_socket_t  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_recvfrom_impl ( CellularSocket socket,
SocketAddress address,
void *  buffer,
nsapi_size_t  size 
)
protectedpure virtual

Implements modem specific AT command set for receiving data.

Parameters
socketSocket 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
virtual nsapi_size_or_error_t socket_send ( nsapi_socket_t  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 ( nsapi_socket_t  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.

virtual nsapi_size_or_error_t socket_sendto_impl ( CellularSocket socket,
const SocketAddress address,
const void *  data,
nsapi_size_t  size 
)
protectedpure virtual

Implements modem specific AT command set for sending data.

Parameters
socketCellular socket 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
virtual nsapi_error_t socket_stack_init ( )
protectedvirtual

Modem specific socket stack initialization.

Returns
0 on success
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.