Kanzi Connect  3.9.9
Kanzi Connect C++ API
kanzi::connect::MessageDispatcher Class Referenceabstract

A class that abstracts the destination and delivery method for a network message. More...

#include <message_dispatcher.hpp>

Inheritance diagram for kanzi::connect::MessageDispatcher:
kanzi::connect::ClientRemoteServiceHost kanzi::connect::p2p::P2PClient::NetworkListenerRegistration

Public Member Functions

virtual void dispatch (const MessagePackage &message)=0
 Dispatches this message to its destination. More...
 
virtual bool getParameter (size_t id, size_t &param)
 Allows to retrieve a dispatcher specific parameter, mostly for internal use. More...
 
 MessageDispatcher ()
 Constructor. More...
 
virtual ~MessageDispatcher ()
 Destructor. More...
 

Detailed Description

A class that abstracts the destination and delivery method for a network message.

Constructor & Destructor Documentation

◆ MessageDispatcher()

kanzi::connect::MessageDispatcher::MessageDispatcher ( )
inline

Constructor.

◆ ~MessageDispatcher()

virtual kanzi::connect::MessageDispatcher::~MessageDispatcher ( )
inlinevirtual

Destructor.

Member Function Documentation

◆ dispatch()

virtual void kanzi::connect::MessageDispatcher::dispatch ( const MessagePackage message)
pure virtual

Dispatches this message to its destination.

Parameters
messageMessage to dispatch.

Implemented in kanzi::connect::ClientRemoteServiceHost, and kanzi::connect::p2p::P2PClient::NetworkListenerRegistration.

◆ getParameter()

virtual bool kanzi::connect::MessageDispatcher::getParameter ( size_t  id,
size_t &  param 
)
inlinevirtual

Allows to retrieve a dispatcher specific parameter, mostly for internal use.

Parameters
idId of the parameter.
paramreceives the output value for the parameter.
Returns
If parameter is successfully retrieved, true, otherwise false.

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