UDP socket. More...

#include <UDPSocket.h>

Inherited by EchoSocket, and UDPSocketFriend.

Public Member Functions
	UDPSocket ()
	Create an uninitialized socket.
template<typename S >
	UDPSocket (S *stack)
	Create a socket on a network interface.
virtual	~UDPSocket ()
	Destroy a socket.
virtual nsapi_size_or_error_t	sendto (const char host, uint16_t port, const void data, nsapi_size_t size)
	Send a packet over a UDP socket.
virtual nsapi_size_or_error_t	sendto (const SocketAddress &address, const void *data, nsapi_size_t size)
	Send a packet over a UDP socket.
virtual nsapi_size_or_error_t	recvfrom (SocketAddress address, void data, nsapi_size_t size)
	Receive a datagram over a UDP socket.
virtual nsapi_error_t	connect (const SocketAddress &address)
	Set remote peer address.
virtual nsapi_size_or_error_t	send (const void *data, nsapi_size_t size)
	Send a datagram to pre-specified remote.
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 UDP.
virtual nsapi_error_t	listen (int backlog=1)
	Not implemented for UDP.
nsapi_error_t	open (NetworkStack *stack)
	Opens a socket.
virtual nsapi_error_t	close ()
	Close the socket.
int	join_multicast_group (const SocketAddress &address)
	Subscribes 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 a specific address to a socket.
nsapi_error_t	bind (const char *address, uint16_t port)
	Bind a specific address to a socket.
virtual nsapi_error_t	bind (const SocketAddress &address)
	Bind a specific address to a socket.
virtual void	set_blocking (bool blocking)
	Set blocking or non-blocking mode of the socket.
virtual void	set_timeout (int timeout)
	Set timeout on blocking socket operations.
virtual void	sigio (mbed::Callback< void()> func)
	Register a callback on state change of the socket.
template<typename T , typename M >
MBED_DEPRECATED_SINCE("mbed-os-5.4","The behaviour 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.

Detailed Description

UDP socket.

Definition at line 31 of file UDPSocket.h.

Constructor & Destructor Documentation

UDPSocket ( )

Create an uninitialized socket.

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

Definition at line 21 of file UDPSocket.cpp.

UDPSocket ( S * stack )

Create a socket on a network interface.

Creates and opens a socket on the network stack of the given network interface.

Parameters:

stack Network stack as target for socket

Definition at line 47 of file UDPSocket.h.

~UDPSocket ( ) [virtual]

Destroy a socket.

Closes socket if the socket is still open

Definition at line 25 of file UDPSocket.cpp.

Member Function Documentation

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

Not implemented for UDP.

Parameters:

error unused

Returns:: NSAPI_ERROR_UNSUPPORTED

Implements Socket.

Definition at line 167 of file UDPSocket.cpp.

nsapi_error_t bind	(	const char *	address,
		uint16_t	port
	)		`[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	Null-terminated local address to bind
port	Local port to bind

Returns:: 0 on success, negative error code on failure.

Definition at line 116 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:: 0 on success, negative error code on failure.

Implements Socket.

Definition at line 123 of file InternetSocket.cpp.

nsapi_error_t bind ( uint16_t port ) [inherited]

Bind a specific address to a socket.

Binding a socket specifies the address and port on which to receive data.

Parameters:

port	Local port to bind

Returns:: 0 on success, negative error code on failure.

Definition at line 109 of file InternetSocket.cpp.

nsapi_error_t close ( void ) [virtual, inherited]

Close the socket.

Closes any open connection and deallocates any memory associated with the socket. Called from destructor if socket is not closed.

Returns:: 0 on success, negative error code on failure

Implements Socket.

Definition at line 54 of file InternetSocket.cpp.

nsapi_error_t connect ( const SocketAddress & address ) [virtual]

Set remote peer address.

Set the remote address for next send() call and filtering for incomming packets. To reset the address, zero initialised SocketAddress must be in the address parameter.

Parameters:

address The SocketAddress of the remote host

Returns:: 0 on success, negative error code on failure

Implements Socket.

Definition at line 35 of file UDPSocket.cpp.

int join_multicast_group ( const SocketAddress & address ) [inherited]

Subscribes to an IP multicast group.

Parameters:

address Multicast group IP address

Returns:: Negative error code on failure

Reimplemented in TCPSocket.

Definition at line 98 of file InternetSocket.cpp.

int leave_multicast_group ( const SocketAddress & address ) [inherited]

Leave an IP multicast group.

Parameters:

address Multicast group IP address

Returns:: Negative error code on failure

Definition at line 103 of file InternetSocket.cpp.

nsapi_error_t listen ( int backlog = 1 ) [virtual]

Not implemented for UDP.

Parameters:

backlog unused

Returns:: NSAPI_ERROR_UNSUPPORTED

Implements Socket.

Definition at line 175 of file UDPSocket.cpp.

MBED_DEPRECATED_SINCE ("mbed-os-5.4", "The behaviour 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

nsapi_error_t open ( NetworkStack * stack ) [inherited]

Opens a socket.

Creates a network socket on the network stack of the given network interface. Not needed if stack is passed to the socket's constructor.

Parameters:

stack Network stack as target for socket

Returns:: 0 on success, negative error code on failure

Definition at line 29 of file InternetSocket.cpp.

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

Receive data from a socket.

This is equivalent of 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 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:

data	Destination buffer for data received from the host
size	Size of the buffer in bytes

Returns:: Number of received bytes on success, negative error code on failure.

Implements Socket.

Definition at line 162 of file UDPSocket.cpp.

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

Receive a datagram over a UDP socket.

Receives a datagram and stores the source address in address if address is not NULL. Returns the number of bytes written into the buffer. 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.

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 datagram, NSAPI_ERROR_WOULD_BLOCK is returned.

Parameters:

address	Destination for the source address or NULL
data	Destination buffer for datagram received from the host
size	Size of the buffer in bytes

Returns:: Number of received bytes on success, negative error code on failure

Implements Socket.

Definition at line 106 of file UDPSocket.cpp.

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

Send a datagram to pre-specified remote.

The socket must be connected to a remote host before send() call. Returns the number of bytes sent from the buffer.

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:

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

Returns:: Number of sent bytes on success, negative error code on failure.

Implements Socket.

Definition at line 98 of file UDPSocket.cpp.

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

Send a packet over a UDP socket.

Sends data to the specified address. Returns the number of bytes sent from the buffer.

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:

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

Returns:: Number of sent bytes on success, negative error code on failure

Implements Socket.

Definition at line 55 of file UDPSocket.cpp.

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

Send a packet over a UDP socket.

Sends data to the specified address specified by either a domain name or an IP address and port. Returns the number of bytes sent from the buffer.

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:

host	Hostname of the remote host
port	Port of the remote host
data	Buffer of data to send to the host
size	Size of the buffer in bytes

Returns:: Number of sent bytes on success, negative error code on failure

Definition at line 41 of file UDPSocket.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 can not continue.

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

Parameters:

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

Implements Socket.

Definition at line 138 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 give 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 144 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 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.

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 when the registered function is called is not guaranteed and susceptible to change.

Parameters:

func	Function to call on state change

Implements Socket.

Type:	Program
Mbed OS support:	Mbed OS
Created:	11 Oct 2018
Imports:	23
Forks:	0
Commits:	4
Dependents:	0
Dependencies:	1
Followers:	1

Important changes to repositories hosted on mbed.com

UDPSocket Class Reference
[Netsocket]

Public Member Functions

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

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Repository toolbox

Repository details

Important Information for this Arm website

Access Warning

UDPSocket Class Reference
[Netsocket]