Ocean::Network::UDPClient Class Reference

This class implements a UDP client. More...

#include <UDPClient.h>

Inheritance diagram for Ocean::Network::UDPClient:

Public Member Functions
	UDPClient ()
	Creates a new UDP client object.
	~UDPClient () override
	Destructs a UDP client object.
Public Member Functions inherited from Ocean::Network::ConnectionlessClient
SocketResult	send (const Address4 &address, const Port &port, const void *data, const size_t size)
	Sends data to a specified recipient.
SocketResult	send (const Address4 &address, const Port &port, const std::string &message)
	Sends a message to a specified recipient.
Public Member Functions inherited from Ocean::Network::Socket
virtual	~Socket ()
	Destructs a socket object.
SocketId	id () const
	Returns the socket id.
Address4	address () const
	Returns the own address of this socket.
Port	port () const
	Returns the own port of this socket.
virtual bool	setAddress (const Address4 &address)
	Sets the own address of this socket.
virtual bool	setPort (const Port &port)
	Sets the own port of this socket.
	operator bool () const
	Returns whether this socket is valid.

Protected Member Functions
bool	buildSocket (const Address4 &localAddress=Address4(), const Port localPort=Port())
	Build the UDP socket.
Protected Member Functions inherited from Ocean::Network::ConnectionlessClient
	ConnectionlessClient ()
	Creates a new connectionless client object.
Protected Member Functions inherited from Ocean::Network::Client
	Client ()
	Creates a new client.
	~Client () override
	Destructs a client.
Protected Member Functions inherited from Ocean::Network::Socket
	Socket ()
	Creates a new socket object.
	Socket (const Socket &object)=delete
	Disabled copy constructor.
bool	setBlockingMode (const bool blocking)
	Sets the blocking mode of this socket.
size_t	maximalMessageSize (const size_t defaultSize=65536)
	Returns the maximal message size in bytes.
bool	releaseSocket ()
	Releases the socket.
virtual bool	onScheduler ()
	The scheduler event function.
Socket &	operator= (const Socket &object)=delete
	Disabled copy operator.

Additional Inherited Members
Public Types inherited from Ocean::Network::Socket
enum	SocketResult { SR_SUCCEEDED = 0 , SR_FAILED , SR_BUSY , SR_NOT_CONNECTED }
	Definition of individual result values. More...
using	SocketId = SOCKET
	Definition of a socket id.
using	SocketId = int
	Definition of a socket id.
using	Buffer = std::vector< uint8_t >
	Definition of a vector holding 8 bit values.
Static Public Member Functions inherited from Ocean::Network::Socket
static constexpr SocketId	invalidSocketId ()
	Returns an invalid socket id.
static bool	setBlockingMode (const SocketId socketId, const bool blocking)
	Sets the blocking mode of a socket.
Protected Attributes inherited from Ocean::Network::Client
Buffer	socketBuffer_
	The socket buffer of this client.
Protected Attributes inherited from Ocean::Network::Socket
SocketId	socketId_ = invalidSocketId()
	Socket id.
Lock	lock_
	Socket lock.
NetworkResource	networkResource_
	The network resource object.

Detailed Description

This class implements a UDP client.

Constructor & Destructor Documentation

UDPClient()

Ocean::Network::UDPClient::UDPClient

(

)

Creates a new UDP client object.

~UDPClient()

Ocean::Network::UDPClient::~UDPClient ( )

override

Destructs a UDP client object.

Member Function Documentation

buildSocket()

bool Ocean::Network::UDPClient::buildSocket ( const Address4 &  localAddress = Address4(), const Port  localPort = Port()  )

protected

Build the UDP socket.

Parameters

localAddress	The local address to which the socket will be bound, a default address to bound the socket to any local address
localPort	The local port to which the socket will be bound, a default port to bound the socket to any free port

Returns

True, if succeeded

---

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

• UDPClient.h