Ocean::Network::Client Class Reference

This class is the base class for all clients. More...

#include <Client.h>

Inheritance diagram for Ocean::Network::Client:

Protected Member Functions
	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.

Protected Attributes
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.

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.
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.
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.

Detailed Description

This class is the base class for all clients.

Constructor & Destructor Documentation

Client()

Ocean::Network::Client::Client ( )

protected

Creates a new client.

~Client()

Ocean::Network::Client::~Client ( )

overrideprotected

Destructs a client.

Field Documentation

socketBuffer_

Buffer Ocean::Network::Client::socketBuffer_

protected

The socket buffer of this client.

---

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

• Client.h