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

UDP socket implementation. More...

#include <UDPSocket.h>

Inheritance diagram for UDPSocket:
InternetSocket Socket

Public Member Functions

 UDPSocket ()
 Create an uninitialized socket. More...
 
template<typename S >
 UDPSocket (S *stack)
 Create and open a socket on the network stack of the given network interface. More...
 
virtual ~UDPSocket ()
 Destroy a socket. More...
 
virtual nsapi_size_or_error_t sendto (const char *host, uint16_t port, const void *data, nsapi_size_t size)
 Send data to the specified host and port. More...
 
virtual nsapi_size_or_error_t sendto (const SocketAddress &address, const void *data, nsapi_size_t size)
 Send data to the specified address. More...
 
virtual nsapi_size_or_error_t recvfrom (SocketAddress *address, void *data, nsapi_size_t size)
 Receive a datagram and store the source address in address if it's not NULL. More...
 
virtual nsapi_error_t connect (const SocketAddress &address)
 Set the remote address for next send() call and filtering of incoming packets. More...
 
virtual nsapi_size_or_error_t send (const void *data, nsapi_size_t size)
 Send a datagram to connected remote address. More...
 
virtual nsapi_size_or_error_t recv (void *data, nsapi_size_t size)
 Receive data from a socket. More...
 
virtual Socketaccept (nsapi_error_t *error=NULL)
 Not implemented for UDP. More...
 
virtual nsapi_error_t listen (int backlog=1)
 Not implemented for UDP. More...
 
nsapi_error_t open (NetworkStack *stack)
 Open a network socket on the network stack of the given network interface. More...
 
virtual nsapi_error_t close ()
 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...
 
nsapi_error_t bind (uint16_t port)
 Bind the socket to a port on which to receive data. More...
 
nsapi_error_t bind (const char *address, uint16_t port)
 Bind the socket to a specific address and port on which to receive data. More...
 
virtual nsapi_error_t bind (const SocketAddress &address)
 Bind a specific address to a socket. More...
 
virtual void set_blocking (bool blocking)
 Set blocking or non-blocking mode of the socket. More...
 
virtual void set_timeout (int timeout)
 Set timeout on blocking socket operations. More...
 
virtual nsapi_error_t setsockopt (int level, int optname, const void *optval, unsigned optlen)
 Set socket options. More...
 
virtual nsapi_error_t getsockopt (int level, int optname, void *optval, unsigned *optlen)
 Get socket options. More...
 
virtual void sigio (mbed::Callback< void()> func)
 Register a callback on state change of the socket. More...
 
virtual nsapi_error_t getpeername (SocketAddress *address)
 Get the remote-end peer associated with this socket. More...
 
void attach (mbed::Callback< void()> func)
 Register a callback on state change of the socket. More...
 
template<typename T , typename M >
void attach (T *obj, M method)
 Register a callback on state change of the socket. More...
 

Detailed Description

UDP socket implementation.

Definition at line 31 of file UDPSocket.h.

Constructor & Destructor Documentation

UDPSocket ( )

Create an uninitialized socket.

Note
Must call open to initialize the socket on a network stack.
UDPSocket ( S *  stack)

Create and open a socket on the network stack of the given network interface.

Template Parameters
SType of the Network stack.
Parameters
stackNetwork stack as target for socket.
Deprecated:
since mbed-os-5.11

Definition at line 51 of file UDPSocket.h.

virtual ~UDPSocket ( )
virtual

Destroy a socket.

Note
Closes socket if the socket is still open.

Member Function Documentation

virtual Socket* accept ( nsapi_error_t error = NULL)
virtual

Not implemented for UDP.

Parameters
errorNot used.
Returns
NSAPI_ERROR_UNSUPPORTED

Implements Socket.

void attach ( mbed::Callback< void()>  func)
inherited

Register a callback on state change of the socket.

See also
Socket::sigio
Deprecated:
The behavior of Socket::attach differs from other attach functions in Mbed OS and has been known to cause confusion. Replaced by Socket::sigio.
void attach ( T *  obj,
method 
)
inherited

Register a callback on state change of the socket.

See also
Socket::sigio
Deprecated:
The attach function does not support cv-qualifiers. Replaced by attach(callback(obj, method)).

Definition at line 148 of file InternetSocket.h.

nsapi_error_t bind ( uint16_t  port)
inherited

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

Parameters
portLocal port to bind.
Returns
0 on success, negative error code on failure (
See also
nsapi_types.h).
nsapi_error_t bind ( const char *  address,
uint16_t  port 
)
inherited

Bind the socket to a specific address and port on which to receive data.

If the IP address is zeroed, only the port is bound.

Parameters
addressNull-terminated local address to bind.
portLocal port to bind.
Returns
0 on success, negative error code on failure (
See also
nsapi_types.h).
virtual nsapi_error_t bind ( const SocketAddress address)
virtualinherited

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 error code on failure.

Implements Socket.

virtual nsapi_error_t close ( )
virtualinherited

defined(DOXYGEN_ONLY)

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

Returns
0 on success, negative error code on failure (
See also
nsapi_types.h).

Implements Socket.

virtual nsapi_error_t connect ( const SocketAddress address)
virtual

Set the remote address for next send() call and filtering of incoming packets.

To reset the address, zero initialized SocketAddress must be in the address parameter.

Parameters
addressThe SocketAddress of the remote host.
Returns
0 on success, negative error code on failure.

Implements Socket.

virtual nsapi_error_t getpeername ( SocketAddress address)
virtualinherited

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

Implements Socket.

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

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

Implements Socket.

int join_multicast_group ( const SocketAddress address)
inherited

Subscribe to an IP multicast group.

Parameters
addressMulticast group IP address.
Returns
0 on success, negative error code on failure (
See also
nsapi_types.h).
int leave_multicast_group ( const SocketAddress address)
inherited

Leave an IP multicast group.

Parameters
addressMulticast group IP address.
Returns
0 on success, negative error code on failure (
See also
nsapi_types.h).
virtual nsapi_error_t listen ( int  backlog = 1)
virtual

Not implemented for UDP.

Parameters
backlogNot used.
Returns
NSAPI_ERROR_UNSUPPORTED

Implements Socket.

nsapi_error_t open ( NetworkStack stack)
inherited

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.
Returns
0 on success, negative error code on failure (
See also
nsapi_types.h).
virtual nsapi_size_or_error_t recv ( void *  data,
nsapi_size_t  size 
)
virtual

Receive data from a socket.

This is equivalent to calling recvfrom(NULL, data, size).

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

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

Note
recv() is allowed write to data buffer even if error occurs.
Parameters
dataPointer to 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 Socket.

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

Receive a datagram and store the source address in address if it's not NULL.

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

Note
If the datagram is larger than the buffer, the excess data is silently discarded.
If socket is connected, only packets coming from connected peer address are accepted.
recvfrom() is allowed write to address and data buffers even if error occurs.
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 error code on failure.

Implements Socket.

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

Send a datagram to connected remote address.

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

Note
The socket must be connected to a remote host before send() call.
Parameters
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 Socket.

virtual nsapi_size_or_error_t sendto ( const char *  host,
uint16_t  port,
const void *  data,
nsapi_size_t  size 
)
virtual

Send data to the specified host and port.

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

Parameters
hostDomain name of the remote host or a dotted notation IP address.
portPort 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_size_or_error_t sendto ( const SocketAddress address,
const void *  data,
nsapi_size_t  size 
)
virtual

Send data to the specified address.

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

Parameters
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 Socket.

virtual void set_blocking ( bool  blocking)
virtualinherited

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.

virtual void set_timeout ( int  timeout)
virtualinherited

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.

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

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

Implements Socket.

virtual void sigio ( mbed::Callback< void()>  func)
virtualinherited

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.