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

#include <ConnectionOrientedClient.h>

Inheritance diagram for Ocean::Network::ConnectionOrientedClient:

Public Types
using	ReceiveCallback = Callback< void, const void *, const size_t >
	Definition of a data receive callback function.

using	DisconnectCallback = Callback< void >
	Definition of a disconnection callback function.

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
virtual bool	connect (const Address4 &address, const Port &port, const unsigned int timeout=1000u)
	Connects to a connection-oriented server.

virtual bool	connect (const unsigned int timeout=1000u)
	Reconnects the client by the usage of the most recent address and port.

virtual bool	disconnect ()
	Disconnects the client.

virtual bool	isConnected () const
	Returns whether this client is connected.

virtual SocketResult	send (const void *data, const size_t size)
	Sends data via the established connection.

SocketResult	send (const std::string &message)
	Sets a message via the established connection.

Address4	receiverAddress () const
	Returns the (remote) receiver address.

Port	receiverPort () const
	Returns the (remote) receiver port.

void	setReceiveCallback (const ReceiveCallback &callback)
	Sets the receive callback function.

void	setDisconnectCallback (const DisconnectCallback &callback)
	Sets the disconnect callback function.

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
	ConnectionOrientedClient ()
	Creates a new connection oriented client.

	~ConnectionOrientedClient () override
	Destructs a connection oriented client.

bool	onScheduler () override
	The scheduler event function.

virtual size_t	onSend (const void *data, const size_t size)
	Internal event function to send data.

virtual void	onReceived (const void *data, const size_t size)
	Internal event function for received data.

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.

Socket &	operator= (const Socket &object)=delete
	Disabled copy operator.

Protected Attributes
Address4	receiverAddress_
	Receiver address.

Port	receiverPort_
	Receiver port.

ReceiveCallback	receiveCallback_
	Receive callback function.

DisconnectCallback	disconnectCallback_
	Disconnect callback function.

bool	isConnected_ = false
	Determines whether a connection is established.

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.

Additional Inherited Members
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 connection oriented clients.

Member Typedef Documentation

◆ DisconnectCallback

using Ocean::Network::ConnectionOrientedClient::DisconnectCallback = Callback<void>

Definition of a disconnection callback function.

◆ ReceiveCallback

using Ocean::Network::ConnectionOrientedClient::ReceiveCallback = Callback<void, const void*, const size_t>

Definition of a data receive callback function.

The first parameter provides the received data, which must be copied The second parameter provides the size of the received data, in bytes

Constructor & Destructor Documentation

◆ ConnectionOrientedClient()

Ocean::Network::ConnectionOrientedClient::ConnectionOrientedClient ( )

protected

Creates a new connection oriented client.

◆ ~ConnectionOrientedClient()

Ocean::Network::ConnectionOrientedClient::~ConnectionOrientedClient ( )

overrideprotected

Destructs a connection oriented client.

Member Function Documentation

◆ connect() [1/2]

virtual bool Ocean::Network::ConnectionOrientedClient::connect	(	const Address4 &	address,
		const Port &	port,
		const unsigned int	timeout = `1000u`
	)

virtual

Connects to a connection-oriented server.

Parameters

address	Remote address of the server to connect
port	Remote port of the server to connect
timeout	The timeout in milliseconds, with range [0, infinity)

Returns: True, if succeeded

Reimplemented in Ocean::Network::TCPClient.

◆ connect() [2/2]

virtual bool Ocean::Network::ConnectionOrientedClient::connect ( const unsigned int timeout = 1000u )

virtual

Reconnects the client by the usage of the most recent address and port.

Parameters

timeout The timeout in milliseconds, with range [0, infinity)

Returns: True, if succeeded

Reimplemented in Ocean::Network::TCPClient.

◆ disconnect()

virtual bool Ocean::Network::ConnectionOrientedClient::disconnect ( )

virtual

Disconnects the client.

Returns: True, if the client was connected

Reimplemented in Ocean::Network::TCPClient.

◆ isConnected()

virtual bool Ocean::Network::ConnectionOrientedClient::isConnected ( ) const

virtual

Returns whether this client is connected.

Returns: True, if so

◆ onReceived()

virtual void Ocean::Network::ConnectionOrientedClient::onReceived	(	const void *	data,
		const size_t	size
	)

protectedvirtual

Internal event function for received data.

Parameters

data	The data that has been received, must be valid
size	The size of the data in bytes, with range [1, infinity)

Reimplemented in Ocean::Network::PackagedTCPClient.

◆ onScheduler()

bool Ocean::Network::ConnectionOrientedClient::onScheduler ( )

overrideprotectedvirtual

The scheduler event function.

Socket::onScheduler().

Reimplemented from Ocean::Network::Socket.

◆ onSend()

virtual size_t Ocean::Network::ConnectionOrientedClient::onSend	(	const void *	data,
		const size_t	size
	)

protectedvirtual

Internal event function to send data.

Parameters

data	The data to send, must be valid
size	The size of the data in bytes, with range [1, infinity)

Returns: The number of bytes which have been sent, with range [0, size]

Reimplemented in Ocean::Network::PackagedTCPClient.

◆ receiverAddress()

Address4 Ocean::Network::ConnectionOrientedClient::receiverAddress ( ) const

inline

Returns the (remote) receiver address.

Returns: Receiver address

◆ receiverPort()

Port Ocean::Network::ConnectionOrientedClient::receiverPort ( ) const

inline

Returns the (remote) receiver port.

Returns: Receiver port

◆ send() [1/2]

ConnectionOrientedClient::SocketResult Ocean::Network::ConnectionOrientedClient::send ( const std::string & message )

inline

Sets a message via the established connection.

Parameters

message The message to send, must be valid

Returns: SR_SUCCEEDED, if succeeded

◆ send() [2/2]

virtual SocketResult Ocean::Network::ConnectionOrientedClient::send	(	const void *	data,
		const size_t	size
	)

virtual

Sends data via the established connection.

If the resource is busy SR_FAILED will be returned and the caller needs to send the data later

Parameters

data	The data to send, can be nullptr if 'size == 0'
size	The size of the data to send, in bytes, with range [0, infinity)

Returns: SR_SUCCEEDED, if succeeded

◆ setDisconnectCallback()

void Ocean::Network::ConnectionOrientedClient::setDisconnectCallback ( const DisconnectCallback & callback )

inline

Sets the disconnect callback function.

Parameters

callback The callback function to set

◆ setReceiveCallback()

void Ocean::Network::ConnectionOrientedClient::setReceiveCallback ( const ReceiveCallback & callback )

inline

Sets the receive callback function.

Parameters

callback The callback function to set

Field Documentation

◆ disconnectCallback_

DisconnectCallback Ocean::Network::ConnectionOrientedClient::disconnectCallback_

protected

Disconnect callback function.

◆ isConnected_

bool Ocean::Network::ConnectionOrientedClient::isConnected_ = false

protected

Determines whether a connection is established.

◆ receiveCallback_

ReceiveCallback Ocean::Network::ConnectionOrientedClient::receiveCallback_

protected

Receive callback function.

◆ receiverAddress_

Address4 Ocean::Network::ConnectionOrientedClient::receiverAddress_

protected

Receiver address.

◆ receiverPort_

Port Ocean::Network::ConnectionOrientedClient::receiverPort_

protected

Receiver port.

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

ConnectionOrientedClient.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ DisconnectCallback

◆ ReceiveCallback

Constructor & Destructor Documentation

◆ ConnectionOrientedClient()

◆ ~ConnectionOrientedClient()

Member Function Documentation

◆ connect() [1/2]

◆ connect() [2/2]

◆ disconnect()

◆ isConnected()

◆ onReceived()

◆ onScheduler()

◆ onSend()

◆ receiverAddress()

◆ receiverPort()

◆ send() [1/2]

◆ send() [2/2]

◆ setDisconnectCallback()

◆ setReceiveCallback()

Field Documentation

◆ disconnectCallback_

◆ isConnected_

◆ receiveCallback_

◆ receiverAddress_

◆ receiverPort_