UDP socket. More...

#include <UDPSocket.h>

Inherits Socket.

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.
int	sendto (const char host, uint16_t port, const void data, unsigned size)
	Send a packet over a UDP socket.
int	sendto (const SocketAddress &address, const void *data, unsigned size)
	Send a packet over a UDP socket.
int	recvfrom (SocketAddress address, void data, unsigned size)
	Receive a packet over a UDP socket.
int	open (NetworkStack *stack)
	Opens a socket.
int	close ()
	Close the socket.
int	bind (uint16_t port)
	Bind a specific address to a socket.
int	bind (const char *address, uint16_t port)
	Bind a specific address to a socket.
int	bind (const SocketAddress &address)
	Bind a specific address to a socket.
void	set_blocking (bool blocking)
	Set blocking or non-blocking mode of the socket.
void	set_timeout (int timeout)
	Set timeout on blocking socket operations.
void	attach (mbed::Callback< void()> func)
	Register a callback on state change of the socket.
template<typename T , typename M >
	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 27 of file UDPSocket.cpp.

Member Function Documentation

void attach ( mbed::Callback< void()> func ) [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.

Parameters:

func	Function to call on state change

int bind ( uint16_t port ) [inherited]

Bind a specific address to a socket.

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

Parameters:

port	Local port to bind

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

Definition at line 72 of file Socket.cpp.

int 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 recieve 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 79 of file Socket.cpp.

int bind ( const SocketAddress & address ) [inherited]

Bind a specific address to a socket.

Binding a socket specifies the address and port on which to recieve 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.

Definition at line 86 of file Socket.cpp.

int close ( void ) [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

Definition at line 52 of file Socket.cpp.

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.

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:

obj	Pointer to object to call method on
method	Method to call on state change

int 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 27 of file Socket.cpp.

int recvfrom	(	SocketAddress *	address,
		void *	data,
		unsigned	size
	)

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.

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

Parameters:

address	Destination for the source address or NULL
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

Definition at line 95 of file UDPSocket.cpp.

int sendto	(	const SocketAddress &	address,
		const void *	data,
		unsigned	size
	)

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

Definition at line 51 of file UDPSocket.cpp.

int sendto	(	const char *	host,
		uint16_t	port,
		const void *	data,
		unsigned	size
	)

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 37 of file UDPSocket.cpp.

void set_blocking ( bool blocking ) [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.

Definition at line 101 of file Socket.cpp.

void set_timeout ( int timeout ) [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

Definition at line 107 of file Socket.cpp.

Type:	Library
Created:	17 Nov 2016
Imports:	992
Forks:	0
Commits:	1
Dependents:	0
Dependencies:	0
Followers:	13

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]