obx::CustomMsgConnectionDelegate Class Reference

Used internally to decouple the lifetime of the user connection object from the one "managed" (created/deleted) by AbstractCustomMsgServer/CustomMsgServerDelegate. This way, the user connection can be clear at any time. More...

#include <objectbox-sync.hpp>

Inheritance diagram for obx::CustomMsgConnectionDelegate:

Public Member Functions
	CustomMsgConnectionDelegate (uint64_t serverId, const std::shared_ptr< AbstractCustomMsgConnection > &connection, bool deleteThisOnShutdown)
	~CustomMsgConnectionDelegate () override=default
void	close () override
	The connection closing itself (to be implemented by concrete subclass).
void	shutdown () override
	The connection shall shutdown; e.g. it may delete itself. Note that there is no "automatic" deletion triggered from the custom msg system: often, connections are intertwined with the server and thus deletion must be managed at the implementing side.
bool	sendAsync (BytesLazy &&message) override
	Offers bytes to be sent asynchronously to the client (to be implemented by concrete subclass).
void	clearOutgoingMessages () override
	Clear all outgoing messages (to be implemented by concrete subclass).
Public Member Functions inherited from obx::AbstractCustomMsgConnection
	AbstractCustomMsgConnection (uint64_t serverId, uint64_t id=0)
virtual	~AbstractCustomMsgConnection ()=default
uint64_t	serverId () const
uint64_t	id () const
void	setId (uint64_t id)

Detailed Description

Used internally to decouple the lifetime of the user connection object from the one "managed" (created/deleted) by AbstractCustomMsgServer/CustomMsgServerDelegate. This way, the user connection can be clear at any time.

Constructor & Destructor Documentation

CustomMsgConnectionDelegate()

obx::CustomMsgConnectionDelegate::CustomMsgConnectionDelegate ( uint64_t  serverId, const std::shared_ptr< AbstractCustomMsgConnection > &  connection, bool  deleteThisOnShutdown  )

inlineexplicit

~CustomMsgConnectionDelegate()

obx::CustomMsgConnectionDelegate::~CustomMsgConnectionDelegate ( )

overridedefault

Member Function Documentation

clearOutgoingMessages()

void obx::CustomMsgConnectionDelegate::clearOutgoingMessages ( )

inlineoverridevirtual

Clear all outgoing messages (to be implemented by concrete subclass).

Implements obx::AbstractCustomMsgConnection.

close()

void obx::CustomMsgConnectionDelegate::close ( )

inlineoverridevirtual

The connection closing itself (to be implemented by concrete subclass).

Implements obx::AbstractCustomMsgConnection.

sendAsync()

bool obx::CustomMsgConnectionDelegate::sendAsync ( BytesLazy &&  message )

inlineoverridevirtual

Offers bytes to be sent asynchronously to the client (to be implemented by concrete subclass).

Parameters

message

the message bytes.

Returns

true if the operation was successful.

false in case the operation encountered an issue.

Implements obx::AbstractCustomMsgConnection.

shutdown()

void obx::CustomMsgConnectionDelegate::shutdown ( )

inlineoverridevirtual

The connection shall shutdown; e.g. it may delete itself. Note that there is no "automatic" deletion triggered from the custom msg system: often, connections are intertwined with the server and thus deletion must be managed at the implementing side.

Implements obx::AbstractCustomMsgConnection.