UDP socket implementation. More...

#include <UDPSocket.h>

Public Member Functions
	UDPSocket ()
	Create an uninitialized socket.
template<typename S >
	MBED_DEPRECATED_SINCE ("mbed-os-5.11","The UDPSocket(S stack) constructor is deprecated""It discards the open() call return value.""Use another constructor and call open() explicitly, instead.") UDPSocket(S stack)
	Create and open a socket on the network stack of the given network interface.
	MBED_DEPRECATED_SINCE ("mbed-os-5.15","String-based APIs are deprecated") virtual nsapi_size_or_error_t sendto(const char *host
	Send data to the specified host and port.
template<typename T , typename M >
MBED_DEPRECATED_SINCE("mbed-os-5.4","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(mbed	MBED_DEPRECATED_SINCE ("mbed-os-5.1","The attach function does not support cv-qualifiers. Replaced by ""attach(callback(obj, method)).") void attach(T *obj
	Register a callback on state change of the socket.
virtual nsapi_size_or_error_t	sendto (const SocketAddress &address, const void *data, nsapi_size_t size)
	Send data to the specified address.
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.
virtual nsapi_error_t	connect (const SocketAddress &address)
	Set the remote address for next send() call and filtering of incoming packets.
virtual nsapi_size_or_error_t	send (const void *data, nsapi_size_t size)
	Send a raw data to connected remote address.
virtual nsapi_size_or_error_t	recv (void *data, nsapi_size_t size)
	Receive data from a socket.
virtual Socket *	accept (nsapi_error_t *error=NULL)
	Not implemented for InternetDatagramSocket.
virtual nsapi_error_t	listen (int backlog=1)
	Not implemented for InternetDatagramSocket.
nsapi_error_t	open (NetworkStack *stack)
	Open a network socket on the network stack of the given network interface.
virtual nsapi_error_t	close ()
	Close any open connection, and deallocate any memory associated with the socket.
int	join_multicast_group (const SocketAddress &address)
	Subscribe to an IP multicast group.
int	leave_multicast_group (const SocketAddress &address)
	Leave an IP multicast group.
nsapi_error_t	bind (uint16_t port)
	Bind the socket to a port on which to receive data.
virtual nsapi_error_t	bind (const SocketAddress &address)
virtual void	set_blocking (bool blocking)
virtual void	set_timeout (int timeout)
virtual nsapi_error_t	setsockopt (int level, int optname, const void *optval, unsigned optlen)
virtual nsapi_error_t	getsockopt (int level, int optname, void optval, unsigned optlen)
virtual void	sigio (mbed::Callback< void()> func)
virtual nsapi_error_t	getpeername (SocketAddress *address)
Friends
class	DTLSSocket

Detailed Description

UDP socket implementation.

Definition at line 33 of file UDPSocket.h.

Constructor & Destructor Documentation

UDPSocket ( )

Create an uninitialized socket.

Note:: Must call open to initialize the socket on a network stack.

Definition at line 21 of file UDPSocket.cpp.

Member Function Documentation

Socket * accept ( nsapi_error_t * error = NULL ) [virtual, inherited]

Not implemented for InternetDatagramSocket.

Parameters:

error Not used.

Returns:: NSAPI_ERROR_UNSUPPORTED

Implements Socket.

Definition at line 171 of file InternetDatagramSocket.cpp.

nsapi_error_t bind ( uint16_t port ) [inherited]

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

Parameters:

port	Local port to bind.

Return values:

NSAPI_ERROR_OK	on success.
NSAPI_ERROR_NO_SOCKET	if socket is not open.
int	negative error codes for stack-related failures. See NetworkStack::socket_bind.

Definition at line 123 of file InternetSocket.cpp.

nsapi_error_t bind ( const SocketAddress & address ) [virtual, inherited]

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:

address Local address to bind.

Returns:: NSAPI_ERROR_OK on success, negative subclass-dependent error code on failure.

Implements Socket.

Definition at line 137 of file InternetSocket.cpp.

nsapi_error_t close ( void ) [virtual, inherited]

Close any open connection, and deallocate any memory associated with the socket.

Called from destructor if socket is not closed.

Return values:

NSAPI_ERROR_OK	on success.
NSAPI_ERROR_NO_SOCKET	if socket is not open.
int	negative error codes for stack-related failures. See NetworkStack::socket_close.

Implements Socket.

Definition at line 64 of file InternetSocket.cpp.

nsapi_error_t connect ( const SocketAddress & address ) [virtual, inherited]

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:

address The SocketAddress of the remote host.

Returns:: NSAPI_ERROR_OK on success.

Implements Socket.

Definition at line 21 of file InternetDatagramSocket.cpp.

nsapi_error_t getpeername ( SocketAddress * address ) [virtual, inherited]

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:

address Pointer to SocketAddress structure.

Return values:

NSAPI_ERROR_OK	on success.
NSAPI_ERROR_NO_SOCKET	if socket is not connected.
NSAPI_ERROR_NO_CONNECTION	if the remote peer was not set.

Implements Socket.

Definition at line 225 of file InternetSocket.cpp.

nsapi_error_t getsockopt	(	int	level,
		int	optname,
		void *	optval,
		unsigned *	optlen
	)		`[virtual, inherited]`

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:

level	Stack-specific protocol level or nsapi_socket_level_t.
optname	Level-specific option name.
optval	Destination for option value.
optlen	Length of the option value.

Return values:

NSAPI_ERROR_OK	on success.
NSAPI_ERROR_NO_SOCKET	if socket is not open.
int	Negative error code on failure, see NetworkStack::getsockopt.

Implements Socket.

Definition at line 189 of file InternetSocket.cpp.

int join_multicast_group ( const SocketAddress & address ) [inherited]

Subscribe to an IP multicast group.

Parameters:

address Multicast group IP address.

Returns:: NSAPI_ERROR_OK on success, negative error code on failure (

See also:: InternetSocket::setsockopt).

Reimplemented in TCPSocket.

Definition at line 112 of file InternetSocket.cpp.

int leave_multicast_group ( const SocketAddress & address ) [inherited]

Leave an IP multicast group.

Parameters:

address Multicast group IP address.

Returns:: NSAPI_ERROR_OK on success, negative error code on failure (

See also:: InternetSocket::setsockopt).

Definition at line 117 of file InternetSocket.cpp.

nsapi_error_t listen ( int backlog = 1 ) [virtual, inherited]

Not implemented for InternetDatagramSocket.

Parameters:

backlog Not used.

Returns:: NSAPI_ERROR_UNSUPPORTED

Implements Socket.

Definition at line 179 of file InternetDatagramSocket.cpp.

MBED_DEPRECATED_SINCE ("mbed-os-5.4", "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(mbed MBED_DEPRECATED_SINCE	(	"mbed-os-5.1"	,
		"The attach function does not support cv-qualifiers. Replaced by ""attach(callback(obj, method))."
	)		`[inherited]`

Register a callback on state change of the socket.

See also:: Socket::sigio

Register a callback on state change of the socket.

See also:: Socket::sigio

MBED_DEPRECATED_SINCE	(	"mbed-os-5.11"	,
		"The UDPSocket(S *stack) constructor is deprecated""It discards the open() call return value.""Use another constructor and call open()	explicitly,
		instead."
	)

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

Template Parameters:

S	Type of the Network stack.

Parameters:

stack Network stack as target for socket.

Definition at line 49 of file UDPSocket.h.

MBED_DEPRECATED_SINCE	(	"mbed-os-5.15"	,
		"String-based APIs are deprecated"
	)		const `[inherited]`

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:

host	Domain name of the remote host or a dotted notation IP address.
port	Port of the remote host.
data	Buffer of data to send to the host.
size	Size of the buffer in bytes.

Return values:

int	Number of sent bytes on success.
NSAPI_ERROR_NO_SOCKET	in case socket was not created correctly.
NSAPI_ERROR_DNS_FAILURE	if the DNS address of host could not be resolved
NSAPI_ERROR_WOULD_BLOCK	in case non-blocking mode is enabled and send cannot be performed immediately.
int	Other negative error codes for stack-related failures. See NetworkStack::socket_send.

Reimplemented from InternetSocket.

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:

stack Network stack as target for socket.

Return values:

NSAPI_ERROR_OK	on success.
NSAPI_ERROR_PARAMETER	in case the provided stack was invalid or a stack was already created and socket opened successfully.
int	negative error codes for stack-related failures. See NetworkStack::socket_open.

Reimplemented in TLSSocket.

Definition at line 38 of file InternetSocket.cpp.

nsapi_size_or_error_t recv	(	void *	data,
		nsapi_size_t	size
	)		`[virtual, inherited]`

Receive data from a socket.

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

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:

data	Pointer to buffer for data received from the host.
size	Size of the buffer in bytes.

Return values:

int	Number of received bytes on success.
NSAPI_ERROR_NO_SOCKET	in case socket was not created correctly.
NSAPI_ERROR_WOULD_BLOCK	in case non-blocking mode is enabled and send cannot be performed immediately.
int	Other negative error codes for stack-related failures. See NetworkStack::socket_recv.

Implements Socket.

Definition at line 166 of file InternetDatagramSocket.cpp.

nsapi_size_or_error_t recvfrom	(	SocketAddress *	address,
		void *	data,
		nsapi_size_t	size
	)		`[virtual, inherited]`

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:

address	Destination for the source address or NULL.
data	Destination buffer for RAW data to be received from the host.
size	Size of the buffer in bytes.

Return values:

int	Number of received bytes on success.
NSAPI_ERROR_NO_SOCKET	in case socket was not created correctly.
NSAPI_ERROR_WOULD_BLOCK	in case non-blocking mode is enabled and send cannot be performed immediately.
int	Other negative error codes for stack-related failures. See NetworkStack::socket_recv.

Implements Socket.

Definition at line 105 of file InternetDatagramSocket.cpp.

nsapi_size_or_error_t send	(	const void *	data,
		nsapi_size_t	size
	)		`[virtual, inherited]`

Send a raw data 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:

data	Buffer of data to send to the host.
size	Size of the buffer in bytes.

Return values:

int	Number of sent bytes on success.
NSAPI_ERROR_NO_SOCKET	in case socket was not created correctly.
NSAPI_ERROR_WOULD_BLOCK	in case non-blocking mode is enabled and send cannot be performed immediately. retval NSAPI_ERROR_NO_ADDRESS if the address was not set with connect().
int	Other negative error codes for stack-related failures. See NetworkStack::socket_send.

Implements Socket.

Definition at line 97 of file InternetDatagramSocket.cpp.

nsapi_size_or_error_t sendto	(	const SocketAddress &	address,
		const void *	data,
		nsapi_size_t	size
	)		`[virtual, inherited]`

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:

address	The SocketAddress of the remote host.
data	Buffer of data to send to the host.
size	Size of the buffer in bytes.

Return values:

NSAPI_ERROR_NO_SOCKET	in case socket was not created correctly.
NSAPI_ERROR_WOULD_BLOCK	in case non-blocking mode is enabled and send cannot be performed immediately.
int	Other negative error codes for stack-related failures. See NetworkStack::socket_send.

Implements Socket.

Definition at line 50 of file InternetDatagramSocket.cpp.

void set_blocking ( bool blocking ) [virtual, inherited]

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:

blocking true for blocking mode, false for non-blocking mode.

Implements Socket.

Definition at line 152 of file InternetSocket.cpp.

void set_timeout ( int timeout ) [virtual, inherited]

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:

timeout Timeout in milliseconds

Implements Socket.

Definition at line 158 of file InternetSocket.cpp.

nsapi_error_t setsockopt	(	int	level,
		int	optname,
		const void *	optval,
		unsigned	optlen
	)		`[virtual, inherited]`

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:

level	Stack-specific protocol level or nsapi_socket_level_t.
optname	Level-specific option name.
optval	Option value.
optlen	Length of the option value.

Return values:

NSAPI_ERROR_OK	on success.
NSAPI_ERROR_NO_SOCKET	if socket is not open.
int	Negative error code on failure, see NetworkStack::setsockopt.

Implements Socket.

Definition at line 171 of file InternetSocket.cpp.

virtual void sigio ( mbed::Callback< void()> func ) [virtual, inherited]

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:

func	Function to call on state change.

Implements Socket.

Type:	Library
Created:	17 Dec 2019
Imports:	79
Forks:	0
Commits:	2
Dependents:	2
Dependencies:	0
Followers:	1

Important changes to repositories hosted on mbed.com

UDPSocket Class Reference
[Netsocket]

Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Repository toolbox

Repository details

Important Information for this Arm website

Important changes to repositories hosted on mbed.com

UDPSocket Class Reference [Netsocket]

Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Repository toolbox

Repository details

Important Information for this Arm website

Access Warning

UDPSocket Class Reference
[Netsocket]