A User Datagram (UDP) socket. More...

#include <DatagramSocket.h++>

Inheritance diagram for DatagramSocket:

Collaboration diagram for DatagramSocket:

Public Member Functions
	DatagramSocket (uint16_t port=0)
	Construct a new DatagramSocket. More...

	~DatagramSocket ()
	Destructor. More...

void	connect (const String &addr, uint16_t port)
	Connect the datagram socket to a remote endpoint. More...

void	connect (const SocketAddress &addr)
	Connect the datagram socket to a remote endpoint. More...

size_t	send (const byte_t *buffer, size_t buflen)
	Send a datagram to the remote endpoint. More...

size_t	send (ByteBuffer &buffer)
	Send a datagram to the remote endpoint. More...

size_t	send (const byte_t *buffer, size_t buflen, const SocketAddress &dest)
	Send a datagram to a given address. More...

size_t	send (ByteBuffer &buffer, const SocketAddress &dest)
	Send a datagram to a given address. More...

size_t	receive (byte_t *buffer, size_t buflen)
	Receive a datagram from the remote endpoint, and write it to a buffer. More...

size_t	receive (ByteBuffer &buffer)
	Receive a datagram from the remote endpoint, and write it to a buffer. More...

size_t	receive (byte_t *buffer, size_t buflen, SocketAddress &source)
	Receive a datagram and write it to a buffer. More...

size_t	receive (ByteBuffer &buffer, SocketAddress &source)
	Receive a datagram and write it to a buffer. More...

void	setBroadcast (bool flag)
	Enable or disable broadcast. More...

bool	getBroadcast () const
	Determine if broadcast is enabled. More...

virtual void	init ()
	Initialize the socket. More...

virtual void	shutdown ()
	Shut down the socket. More...

void	setTimeout (timespan_ms_t timeout)
	Set the timeout for the socket. More...

void	setReceiveBufSize (size_t size)
	Set the size of the socket's internal receive buffer. More...

size_t	getReceiveBufSize () const
	Get the size of the socket's internal receive buffer. More...

void	setSendBufSize (size_t size)
	Set the size of the socket's internal send buffer. More...

size_t	getSendBufSize () const
	Get the size of the socket's internal send buffer. More...

void	setLingerTime (timespan_s_t timeout)
	Set the linger time for the socket. More...

timespan_s_t	getLingerTime () const
	Get the linger time for the socket. More...

void	setReuseAddress (bool enable)
	Enable or disable the SO_REUSEADDR option on the socket. More...

bool	getReuseAddress () const
	Determine if the SO_REUSEADDR option is enabled or disabled. More...

void	setKeepAlive (bool enable)
	Enable or disable the SO_KEEPALIVE option on the socket. More...

bool	getKeepAlive ()
	Determine if the SO_KEEPALIVE option is enabled or disabled. More...

void	setTCPDelay (bool enable)
	Enable or disable the Nagle algorithm for send coalescing. More...

bool	getTCPDelay ()
	Determine if the Nagle algorithm is enabled or disabled. More...

bool	isInitialized () const
	Determine if the socket has been initialized. More...

bool	isConnected () const
	Determine if the socket is connected. More...

NetProtocol	getType () const
	Get the socket type. More...

const SocketAddress &	getLocalAddress () const
	Get the address of the local end of the socket. More...

const SocketAddress &	getRemoteAddress () const
	Get the address of the remote (peer) end of the socket. More...

Static Public Attributes
static const size_t	MAX_DATAGRAM_SIZE = 16384
	The maximum size of a datagram packet. More...

Protected Types
enum	IOWaitMode { WaitWrite, WaitRead }

Protected Member Functions
SocketHandle	getSocketHandle () const
	Get the underlying socket handle for this socket. More...

void	waitForIO (IOWaitMode mode)
	Wait for the socket to become ready for reading or writing. More...

Protected Attributes
NetProtocol	_type
	The socket type. More...

SocketHandle	_socket
	A handle to the socket itself. More...

SocketAddress	_raddr
	The remote address. More...

SocketAddress	_laddr
	The local address. More...

int	_sotimeout
	The timeout value. More...

Detailed Description

A User Datagram (UDP) socket.

UDP sockets are connectionless and do not provide reliable delivery. Connecting a UDP socket does not establish an actual network connection, but rather specifies the default address to which datagrams are sent and the only address from which datagrams will be received.

Author: Mark Lindner

Member Enumeration Documentation

◆ IOWaitMode

enum IOWaitMode

protectedinherited

Enumerator
WaitWrite
WaitRead

Constructor & Destructor Documentation

◆ DatagramSocket()

DatagramSocket ( uint16_t port = 0 )

Construct a new DatagramSocket.

Parameters

port	The local port to bind to, or 0 to bind to an arbitrary port.

◆ ~DatagramSocket()

~DatagramSocket ( )

Destructor.

Member Function Documentation

◆ connect() [1/2]

void connect	(	const String &	addr,
		uint16_t	port
	)

virtual

Connect the datagram socket to a remote endpoint.

Connecting a datagram socket to an address does not actually establish a network connection, but rather restricts the socket so that it may only exchange datagrams with that address.

Parameters

addr	The address, which may either be a dot-separated IP address or a DNS name.
port	The port number.

Exceptions

IOException If an error occurs.

Reimplemented from Socket.

◆ connect() [2/2]

void connect ( const SocketAddress & addr )

virtual

Connect the datagram socket to a remote endpoint.

Connecting a datagram socket to an address does not actually establish a network connection, but rather restricts the socket so that it may only exchange datagrams with that address.

Parameters

addr	The address.

Exceptions

IOException If an error occurs.

Reimplemented from Socket.

◆ getBroadcast()

bool getBroadcast ( ) const

Determine if broadcast is enabled.

Returns: true if broadcast is enabled, false otherwise.

Exceptions

SocketException If an error occurs.

◆ getKeepAlive()

bool getKeepAlive ( )

inherited

Determine if the SO_KEEPALIVE option is enabled or disabled.

Returns: true if the option is enabled, false otherwise.

Exceptions

SocketException If a socket error occurs.

◆ getLingerTime()

timespan_s_t getLingerTime ( ) const

inherited

Get the linger time for the socket.

Returns: The linger time, in seconds, or -1 if the feature is disabled.

Exceptions

SocketException If the linger time could not be retrieved.

◆ getLocalAddress()

const SocketAddress& getLocalAddress ( ) const

inlineinherited

Get the address of the local end of the socket.

◆ getReceiveBufSize()

size_t getReceiveBufSize ( ) const

inherited

Get the size of the socket's internal receive buffer.

Returns: The size, in bytes.

Exceptions

SocketException If the size could not be changed.

◆ getRemoteAddress()

const SocketAddress& getRemoteAddress ( ) const

inlineinherited

Get the address of the remote (peer) end of the socket.

◆ getReuseAddress()

bool getReuseAddress ( ) const

inherited

Determine if the SO_REUSEADDR option is enabled or disabled.

Returns: true if the option is enabled, false otherwise.

Exceptions

SocketException If a socket error occurs.

◆ getSendBufSize()

size_t getSendBufSize ( ) const

inherited

Get the size of the socket's internal send buffer.

Returns: The size, in bytes.

Exceptions

SocketException If the size could not be changed.

◆ getSocketHandle()

SocketHandle getSocketHandle ( ) const

inlineprotectedinherited

Get the underlying socket handle for this socket.

◆ getTCPDelay()

bool getTCPDelay ( )

inherited

Determine if the Nagle algorithm is enabled or disabled.

Returns: true if the Nagle algorithm is enabled (TCP_NODELAY off), false otherwise.

Exceptions

SocketException If a socket error occurs.

◆ getType()

NetProtocol getType ( ) const

inlineinherited

Get the socket type.

◆ init()

void init ( )

virtualinherited

Initialize the socket.

This method creates the underlying socket object.

Exceptions

SocketException If the socket could not be created.

Reimplemented in ServerSocket.

◆ isConnected()

bool isConnected ( ) const

inlineinherited

Determine if the socket is connected.

◆ isInitialized()

bool isInitialized ( ) const

inlineinherited

Determine if the socket has been initialized.

◆ receive() [1/4]

size_t receive	(	byte_t *	buffer,
		size_t	buflen
	)

Receive a datagram from the remote endpoint, and write it to a buffer.

The socket must be connected before this method can be used.

Parameters

buffer	The raw buffer to write the data to.
buflen	The length of the buffer.

Returns: The number of bytes received.

Exceptions

IOException If an error occurs.

◆ receive() [2/4]

size_t receive ( ByteBuffer & buffer )

Receive a datagram from the remote endpoint, and write it to a buffer.

The socket must be connected before this method can be used.

Parameters

buffer The buffer to write the data to.

Returns: The number of bytes received.

Exceptions

IOException If an error occurs.

◆ receive() [3/4]

size_t receive	(	byte_t *	buffer,
		size_t	buflen,
		SocketAddress &	source
	)

Receive a datagram and write it to a buffer.

Parameters

buffer	The raw buffer to write the data to.
buflen	The length of the buffer.
source	The object in which to place the source address of the received datagram.

Returns: The number of bytes received.

Exceptions

IOException If an error occurs.

◆ receive() [4/4]

size_t receive	(	ByteBuffer &	buffer,
		SocketAddress &	source
	)

Receive a datagram and write it to a buffer.

Parameters

buffer	The buffer to write the data to.
source	The object in which to place the source address of the received datagram.

Returns: The number of bytes received.

Exceptions

IOException If an error occurs.

◆ send() [1/4]

size_t send	(	const byte_t *	buffer,
		size_t	buflen
	)

Send a datagram to the remote endpoint.

The socket must be connected before this method can be used.

Parameters

buffer	The raw buffer containing the data to send.
buflen	The length of the buffer.

Returns: The number of bytes sent.

Exceptions

IOException If an error occurs.

◆ send() [2/4]

size_t send ( ByteBuffer & buffer )

Send a datagram to the remote endpoint.

The socket must be connected before this method can be used.

Parameters

buffer The buffer containing the data to send.

Returns: The number of bytes sent.

Exceptions

IOException If an error occurs.

◆ send() [3/4]

size_t send	(	const byte_t *	buffer,
		size_t	buflen,
		const SocketAddress &	dest
	)

Send a datagram to a given address.

Parameters

buffer	The raw buffer containing the data to send.
buflen	The length of the buffer.
dest	The destination address.

Returns: The number of bytes sent.

Exceptions

IOException If an error occurs.

◆ send() [4/4]

size_t send	(	ByteBuffer &	buffer,
		const SocketAddress &	dest
	)

Send a datagram to a given address.

Parameters

buffer	The buffer containing the data to send.
dest	The destination address.

Returns: The number of bytes sent.

Exceptions

IOException If an error occurs.

◆ setBroadcast()

void setBroadcast ( bool flag )

Enable or disable broadcast.

When enabled, the socket will receive packets sent to a broadcast address and is allowed to send packets to a broadcast address.

Parameters

flag	A flag indicating whether the feature should be enabled or disabled.

Exceptions

SocketException If an error occurs.

◆ setKeepAlive()

void setKeepAlive ( bool enable )

inherited

Enable or disable the SO_KEEPALIVE option on the socket.

Parameters

enable true to enable the option false to disable it.

Exceptions

SocketException If a socket error occurs.

◆ setLingerTime()

void setLingerTime ( timespan_s_t timeout )

inherited

Set the linger time for the socket.

Parameters

timeout The new linger time, in seconds; a negative value disables the linger feature.

Exceptions

SocketException If the linger time could not be changed.

◆ setReceiveBufSize()

void setReceiveBufSize ( size_t size )

inherited

Set the size of the socket's internal receive buffer.

Parameters

size	The new size, in bytes.

Exceptions

SocketException If the size could not be changed.

◆ setReuseAddress()

void setReuseAddress ( bool enable )

inherited

Enable or disable the SO_REUSEADDR option on the socket.

This method may only be called before the socket has been initialized. This option is off by default in newly created sockets.

Parameters

enable true to enable the option false to disable it.

Exceptions

SocketException If a socket error occurs, or if the call was made after the socket was initialized.

◆ setSendBufSize()

void setSendBufSize ( size_t size )

inherited

Set the size of the socket's internal send buffer.

Parameters

size	The new size, in bytes.

Exceptions

SocketException If the size could not be changed.

◆ setTCPDelay()

void setTCPDelay ( bool enable )

inherited

Enable or disable the Nagle algorithm for send coalescing.

Parameters

enable true to enable the Nagle algorithm (TCP_NODELAY off), false to disable it (TCP_NODELAY on).

Exceptions

SocketException If a socket error occurs.

◆ setTimeout()

void setTimeout ( timespan_ms_t timeout )

inherited

Set the timeout for the socket.

The timeout affects both I/O and connections.

Parameters

timeout The timeout, in milliseconds.

Exceptions

SocketException If an error occurs.

◆ shutdown()

void shutdown ( )

virtualinherited

Shut down the socket.

Closes the connection and destroys the underlying socket object.

Reimplemented in StreamSocket, and ServerSocket.

◆ waitForIO()

void waitForIO ( IOWaitMode mode )

protectedinherited

Wait for the socket to become ready for reading or writing.

Parameters

mode	The wait mode; one of WaitWrite or WaitRead.

Exceptions

IOException On timeout or other error.

Member Data Documentation

◆ _laddr

SocketAddress _laddr

protectedinherited

The local address.

◆ _raddr

SocketAddress _raddr

protectedinherited

The remote address.

◆ _socket

SocketHandle _socket

protectedinherited

A handle to the socket itself.

◆ _sotimeout

int _sotimeout

protectedinherited

The timeout value.

◆ _type

NetProtocol _type

protectedinherited

The socket type.

◆ MAX_DATAGRAM_SIZE

const size_t MAX_DATAGRAM_SIZE = 16384

static

The maximum size of a datagram packet.

The documentation for this class was generated from the following files:

Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ IOWaitMode

Constructor & Destructor Documentation

◆ DatagramSocket()

◆ ~DatagramSocket()

Member Function Documentation

◆ connect() [1/2]

◆ connect() [2/2]

◆ getBroadcast()

◆ getKeepAlive()

◆ getLingerTime()

◆ getLocalAddress()

◆ getReceiveBufSize()

◆ getRemoteAddress()

◆ getReuseAddress()

◆ getSendBufSize()

◆ getSocketHandle()

◆ getTCPDelay()

◆ getType()

◆ init()

◆ isConnected()

◆ isInitialized()

◆ receive() [1/4]

◆ receive() [2/4]

◆ receive() [3/4]

◆ receive() [4/4]

◆ send() [1/4]

◆ send() [2/4]

◆ send() [3/4]

◆ send() [4/4]

◆ setBroadcast()

◆ setKeepAlive()

◆ setLingerTime()

◆ setReceiveBufSize()

◆ setReuseAddress()

◆ setSendBufSize()

◆ setTCPDelay()

◆ setTimeout()

◆ shutdown()

◆ waitForIO()

Member Data Documentation

◆ _laddr

◆ _raddr

◆ _socket

◆ _sotimeout

◆ _type

◆ MAX_DATAGRAM_SIZE