Mistake on this page?
Report an issue in GitHub or email us
Public Member Functions
InternetSocket Class Referenceabstract

Socket implementation that uses IP network stack. More...

#include <InternetSocket.h>

Inheritance diagram for InternetSocket:
Socket InternetDatagramSocket TCPSocket ICMPSocket UDPSocket

Public Member Functions

 ~InternetSocket () override
 Destroy the socket. More...
 
nsapi_error_t open (NetworkStack *stack)
 Open a network socket on the network stack of the given network interface. More...
 
nsapi_error_t close () override
 defined(DOXYGEN_ONLY) More...
 
int join_multicast_group (const SocketAddress &address)
 Subscribe to an IP multicast group. More...
 
int leave_multicast_group (const SocketAddress &address)
 Leave an IP multicast group. More...
 
int get_rtt_estimate_to_address (const SocketAddress &address, uint32_t *rtt_estimate)
 Get estimated round trip time to destination address. More...
 
int get_stagger_estimate_to_address (const SocketAddress &address, uint16_t data_amount, uint16_t *stagger_min, uint16_t *stagger_max, uint16_t *stagger_rand)
 Get estimated stagger value. More...
 
nsapi_error_t bind (uint16_t port)
 Bind the socket to a port on which to receive data. More...
 
nsapi_error_t bind (const SocketAddress &address) override
 Bind a specific address to a socket. More...
 
void set_blocking (bool blocking) override
 Set blocking or non-blocking mode of the socket. More...
 
void set_timeout (int timeout) override
 Set timeout on blocking socket operations. More...
 
nsapi_error_t setsockopt (int level, int optname, const void *optval, unsigned optlen) override
 Set socket options. More...
 
nsapi_error_t getsockopt (int level, int optname, void *optval, unsigned *optlen) override
 Get socket options. More...
 
void sigio (mbed::Callback< void()> func) override
 Register a callback on state change of the socket. More...
 
nsapi_error_t getpeername (SocketAddress *address) override
 Get the remote-end peer associated with this socket. More...
 
virtual nsapi_error_t connect (const SocketAddress &address)=0
 Connects socket to a remote address. More...
 
virtual nsapi_size_or_error_t send (const void *data, nsapi_size_t size)=0
 Send data on a socket. More...
 
virtual nsapi_size_or_error_t recv (void *data, nsapi_size_t size)=0
 Receive data from a socket. More...
 
virtual nsapi_size_or_error_t sendto (const SocketAddress &address, const void *data, nsapi_size_t size)=0
 Send a message on a socket. More...
 
virtual nsapi_size_or_error_t recvfrom (SocketAddress *address, void *data, nsapi_size_t size)=0
 Receive a data from a socket. More...
 
virtual Socketaccept (nsapi_error_t *error=NULL)=0
 Accepts a connection on a socket. More...
 
virtual nsapi_error_t listen (int backlog=1)=0
 Listen for incoming connections. More...
 

Detailed Description

Socket implementation that uses IP network stack.

Not to be directly used by applications. Cannot be directly instantiated.

Definition at line 35 of file InternetSocket.h.

Constructor & Destructor Documentation

~InternetSocket ( )
override

Destroy the socket.

Note
Closes socket if it's still open.

Member Function Documentation

virtual Socket* accept ( nsapi_error_t error = NULL)
pure virtualinherited

Accepts a connection on a socket.

The server socket must be bound and set to listen for connections. On a new connection, returns connected network socket to call close() that deallocates the resources. Referencing a returned pointer after a close() call is not allowed and leads to undefined behavior.

By default, accept blocks until incoming connection occurs. If socket is set to non-blocking or times out, error is set to NSAPI_ERROR_WOULD_BLOCK.

Parameters
errorPointer to storage of the error value or NULL.
Returns
Pointer to a socket.

Implemented in TLSSocketWrapper, TCPSocket, InternetDatagramSocket, and CellularNonIPSocket.

nsapi_error_t bind ( uint16_t  port)

Bind the socket to a port on which to receive data.

Parameters
portLocal port to bind.
Return values
NSAPI_ERROR_OKon success.
NSAPI_ERROR_NO_SOCKETif socket is not open.
intnegative error codes for stack-related failures. See NetworkStack::socket_bind.
nsapi_error_t bind ( const SocketAddress address)
overridevirtual

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
addressLocal address to bind.
Returns
NSAPI_ERROR_OK on success, negative subclass-dependent error code on failure.

Implements Socket.

nsapi_error_t close ( )
overridevirtual

defined(DOXYGEN_ONLY)

Close any open connection, and deallocate any memory associated with the socket. Called from destructor if socket is not closed.

Return values
NSAPI_ERROR_OKon success.
NSAPI_ERROR_NO_SOCKETif socket is not open.
intnegative error codes for stack-related failures. See NetworkStack::socket_close.

Implements Socket.

virtual nsapi_error_t connect ( const SocketAddress address)
pure virtualinherited

Connects socket to a remote address.

Attempts to make connection on connection-mode protocol or set or reset the peer address on connectionless protocol.

Connectionless protocols also use the connected address to filter incoming packets for recv() and recvfrom() calls.

To reset the peer address, there must be zero initialized(default constructor) SocketAddress objects in the address parameter.

Note
If connect() fails it is recommended to close the Socket and create a new one before attempting to reconnect.
Parameters
addressThe SocketAddress of the remote peer.
Returns
NSAPI_ERROR_OK on success. Negative subclass-dependent error code on failure.

Implemented in TLSSocketWrapper, CellularNonIPSocket, InternetDatagramSocket, and TCPSocket.

int get_rtt_estimate_to_address ( const SocketAddress address,
uint32_t *  rtt_estimate 
)

Get estimated round trip time to destination address.

Use estimated round trip time to adjust application retry timers to work in networks that have low data rate and high latency.

Parameters
addressDestination address to use in rtt estimate.
rtt_estimateReturned round trip time value in milliseconds.
Returns
NSAPI_ERROR_OK on success.
NSAPI_ERROR_PARAMETER if the provided pointer is invalid.
negative error code on other failures (
See also
InternetSocket::getsockopt).
int get_stagger_estimate_to_address ( const SocketAddress address,
uint16_t  data_amount,
uint16_t *  stagger_min,
uint16_t *  stagger_max,
uint16_t *  stagger_rand 
)

Get estimated stagger value.

Stagger value is a time that application should wait before using heavy network operations after connecting to network. Purpose of staggering is to avoid network congestion that may happen in low bandwith networks if multiple applications simultaneously start heavy network usage after joining to the network.

Parameters
addressDestination added used to estimate stagger value.
data_amountAmount of bytes to transfer in kilobytes.
stagger_minMinimum stagger value in seconds.
stagger_maxMaximum stagger value in seconds.
stagger_randRandomized stagger value between stagger_min and stagger_max in seconds.
Returns
NSAPI_ERROR_OK on success.
negative error code on other failures (
See also
InternetSocket::getsockopt).
nsapi_error_t getpeername ( SocketAddress address)
overridevirtual

Get the remote-end peer associated with this socket.

Copy the remote peer address to a SocketAddress structure pointed by address parameter. Socket must be connected to have a peer address associated.

Parameters
addressPointer to SocketAddress structure.
Return values
NSAPI_ERROR_OKon success.
NSAPI_ERROR_NO_SOCKETif socket is not connected.
NSAPI_ERROR_NO_CONNECTIONif the remote peer was not set.

Implements Socket.

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

Get socket options.

getsockopt() allows an application to retrieve stack-specific options from the underlying stack using stack-specific level and option names, or to request generic options using levels from nsapi_socket_level_t.

For unsupported options, NSAPI_ERROR_UNSUPPORTED is returned and the socket is unmodified.

Parameters
levelStack-specific protocol level or nsapi_socket_level_t.
optnameLevel-specific option name.
optvalDestination for option value.
optlenLength of the option value.
Return values
NSAPI_ERROR_OKon success.
NSAPI_ERROR_NO_SOCKETif socket is not open.
intNegative error code on failure, see NetworkStack::getsockopt.

Implements Socket.

int join_multicast_group ( const SocketAddress address)

Subscribe to an IP multicast group.

Parameters
addressMulticast group IP address.
Returns
NSAPI_ERROR_OK on success, negative error code on failure (
See also
InternetSocket::setsockopt).
int leave_multicast_group ( const SocketAddress address)

Leave an IP multicast group.

Parameters
addressMulticast group IP address.
Returns
NSAPI_ERROR_OK on success, negative error code on failure (
See also
InternetSocket::setsockopt).
virtual nsapi_error_t listen ( int  backlog = 1)
pure virtualinherited

Listen for incoming connections.

Marks the socket as a passive socket that can be used to accept incoming connections.

Parameters
backlogNumber of pending connections that can be queued simultaneously, defaults to 1.
Returns
NSAPI_ERROR_OK on success, negative error code on failure.

Implemented in TLSSocketWrapper, TCPSocket, InternetDatagramSocket, and CellularNonIPSocket.

nsapi_error_t open ( NetworkStack stack)

Open a network socket on the network stack of the given network interface.

Note
Not needed if stack is passed to the socket's constructor.
Parameters
stackNetwork stack as target for socket.
Return values
NSAPI_ERROR_OKon success.
NSAPI_ERROR_PARAMETERin case the provided stack was invalid or a stack was already created and socket opened successfully.
intnegative error codes for stack-related failures. See NetworkStack::socket_open.
virtual nsapi_size_or_error_t recv ( void *  data,
nsapi_size_t  size 
)
pure virtualinherited

Receive data from a socket.

Receive data from connected socket, or in the case of connectionless socket, equivalent to calling recvfrom(NULL, data, size).

If socket is connected, only packets coming from connected peer address are accepted.

Note
recv() is allowed write to data buffer even if an error occurs.

By default, recv blocks until some data is received. If socket is set to non-blocking or times out, NSAPI_ERROR_WOULD_BLOCK can be returned to indicate no data.

Parameters
dataDestination buffer for data received from the host.
sizeSize of the buffer in bytes.
Returns
Number of received bytes on success, negative, subclass-dependent error code on failure. If no data is available to be received and the peer has performed an orderly shutdown, recv() returns 0.

Implemented in TLSSocketWrapper, InternetDatagramSocket, CellularNonIPSocket, and TCPSocket.

virtual nsapi_size_or_error_t recvfrom ( SocketAddress address,
void *  data,
nsapi_size_t  size 
)
pure virtualinherited

Receive a data from a socket.

Receives a data and stores the source address in address if address is not NULL. Returns the number of bytes written into the buffer.

If socket is connected, only packets coming from connected peer address are accepted.

Note
recvfrom() is allowed write to address and data buffers even if error occurs.

By default, recvfrom blocks until a datagram is received. If socket is set to non-blocking or times out with no data, NSAPI_ERROR_WOULD_BLOCK is returned.

Parameters
addressDestination for the source address or NULL
dataDestination buffer for datagram received from the host
sizeSize of the buffer in bytes
Returns
Number of received bytes on success, negative subclass-dependent error code on failure

Implemented in TLSSocketWrapper, TCPSocket, CellularNonIPSocket, and InternetDatagramSocket.

virtual nsapi_size_or_error_t send ( const void *  data,
nsapi_size_t  size 
)
pure virtualinherited

Send data on a socket.

The socket must be connected to a remote host before send() call. Returns the number of bytes sent from the buffer. In case of connectionless socket, sends data to pre-specified remote.

By default, send blocks until all data is sent. If socket is set to non-blocking or times out, a partial amount can be written. NSAPI_ERROR_WOULD_BLOCK is returned if no data was written.

Parameters
dataBuffer of data to send to the host.
sizeSize of the buffer in bytes.
Returns
NSAPI_ERROR_OK on success. Negative subclass-dependent error code on failure.

Implemented in TLSSocketWrapper, InternetDatagramSocket, CellularNonIPSocket, and TCPSocket.

virtual nsapi_size_or_error_t sendto ( const SocketAddress address,
const void *  data,
nsapi_size_t  size 
)
pure virtualinherited

Send a message on a socket.

The sendto() function sends a message through a connection-mode or connectionless-mode socket. If the socket is a connectionless-mode socket, the message is sent to the address specified. If the socket is a connected-mode socket, address is ignored.

By default, sendto blocks until data is sent. If socket is set to non-blocking or times out, NSAPI_ERROR_WOULD_BLOCK is returned immediately.

Parameters
addressRemote address
dataBuffer of data to send to the host
sizeSize of the buffer in bytes
Returns
Number of sent bytes on success, negative subclass-dependent error code on failure

Implemented in TLSSocketWrapper, CellularNonIPSocket, TCPSocket, and InternetDatagramSocket.

void set_blocking ( bool  blocking)
overridevirtual

Set blocking or non-blocking mode of the socket.

Initially all sockets are in blocking mode. In non-blocking mode blocking operations such as send/recv/accept return NSAPI_ERROR_WOULD_BLOCK if they cannot continue.

set_blocking(false) is equivalent to set_timeout(0) set_blocking(true) is equivalent to set_timeout(-1)

Parameters
blockingtrue for blocking mode, false for non-blocking mode.

Implements Socket.

void set_timeout ( int  timeout)
overridevirtual

Set timeout on blocking socket operations.

Initially all sockets have unbounded timeouts. NSAPI_ERROR_WOULD_BLOCK is returned if a blocking operation takes longer than the specified timeout. A timeout of 0 removes the timeout from the socket. A negative value gives the socket an unbounded timeout.

set_timeout(0) is equivalent to set_blocking(false) set_timeout(-1) is equivalent to set_blocking(true)

Parameters
timeoutTimeout in milliseconds

Implements Socket.

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

Set socket options.

setsockopt() allows an application to pass stack-specific options to the underlying stack using stack-specific level and option names, or to request generic options using levels from nsapi_socket_level_t.

For unsupported options, NSAPI_ERROR_UNSUPPORTED is returned and the socket is unmodified.

Parameters
levelStack-specific protocol level or nsapi_socket_level_t.
optnameLevel-specific option name.
optvalOption value.
optlenLength of the option value.
Return values
NSAPI_ERROR_OKon success.
NSAPI_ERROR_NO_SOCKETif socket is not open.
intNegative error code on failure, see NetworkStack::setsockopt.

Implements Socket.

void sigio ( mbed::Callback< void()>  func)
overridevirtual

Register a callback on state change of the socket.

The specified callback is called on state changes, such as when the socket can receive/send/accept successfully and 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 receive/send calls.

Note! This is not intended as a replacement for a poll or attach-like asynchronous API, but rather as a building block for constructing such functionality. The exact timing of the registered function is not guaranteed and susceptible to change.

Parameters
funcFunction to call on state change.

Implements Socket.

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.