Wizt::RemoteVish::Communicator Struct Reference

Network Communicator Callback: action performed The receive() callback function is responsible for parsing the data stream and invoke appropriate actions. More...

#include <ocean/remotevish/RemoteVish.hpp>

Inheritance diagram for Wizt::RemoteVish::Communicator:

Public Member Functions
bool	receive (socket_t id) override
	Callback function invoked when data are ready to be read from the socket.
void	shutdown () override
	Callback function when this object is going to be closed.
Public Member Functions inherited from Wizt::VSocketAction::Receiver
bool	expect (const RefPtr< Expectation > &E, socket_t sd)
	Set an expectation object to this receiver.
	Receiver ()
	Constructor.
virtual	~Receiver ()=0
	Virtual Destructor.
Public Member Functions inherited from MemCore::ReferenceBase< Receiver >
auto	getObjectCountID () const noexcept
	Get a unique ID for this object in the given domain.
bool	isIdentical (const WeakPtr< Receiver, Receiver > &PossibleSelf) const noexcept
	Check if this object is identical to the one used by the given pointer.
void	mkAutoDestructive ()
	Marks this object as being automatically destructed, e.g.
refcount_t	refcount () const noexcept
	The strong reference count.
	ReferenceBase (Receiver *that) noexcept
	Constructor, initializes reference counter to zero.
const auto &	self () const
	Return weak pointer to the object self.
refcount_t	wrefcount () const noexcept
	The weak reference count.

Public Attributes
VSlotChangeInfo	myChangedSlots
	The slots that have been changed locally and not yet been sent to the remote instances.
Public Attributes inherited from Wizt::VSocketAction::Receiver
RefPtr< Expectation >	MyExpectation
	If there is an expectation object associated with this receiver, then it will be filled first until any more data are delivered to the receive() functions.
std::string	status
	A freely definable string describing the status of this connection.

Additional Inherited Members
Public Types inherited from MemCore::ReferenceBase< Receiver >
using	reference_domain_t = Receiver
	The type of the base class.
using	SelfPtr_t = WeakPtr< Receiver, Receiver >
	Type for a pointer to this object itself.
Protected Member Functions inherited from MemCore::ReferenceBase< Receiver >
virtual void	extremeUnction ()
	A virtual function that will be called just before the object is destroyed.
ReferenceBase &	operator= (const ReferenceBase &R)
	Protected assignment operator (should not be called).
void	suicide ()
	Delete this.
virtual	~ReferenceBase ()
	Virtual destructor.

Detailed Description

Network Communicator Callback: action performed The receive() callback function is responsible for parsing the data stream and invoke appropriate actions.

Member Function Documentation

receive()

bool Wizt::RemoteVish::Communicator::receive ( socket_t  )

inlineoverridevirtual

Callback function invoked when data are ready to be read from the socket.

Returns

false if the connection shall be closed after this data transfer, otherwise return true to indicate it shall be kept alive.

Implements Wizt::VSocketAction::Receiver.

References MemCore::ReferenceBase< Receiver >::self().