Loading...
Searching...
No Matches
IDataDistributionCallback Class Referenceabstract

The C++ callback interface to be externally implemented. More...

#include <DataDistributionManager.h>

Inheritance diagram for IDataDistributionCallback:
DataDistributionCallback SmartDataDistributionBase SmartDataDistribution< T >

Public Member Functions

virtual const char * OnConfiguration (const char *channelName, const char *key, const char *value)=0
 Invoked during configuration validation.
 
virtual void OnLogging (DDM_LOG_LEVEL level, const char *source, const char *function, const char *logStr)=0
 Callback invoked when a log is emitted from subsystem.
 
virtual void OnCompletelyDisconnected (const char *channelName, const char *reason)=0
 Callback invoked on a complete disconnection.
 

Detailed Description

The C++ callback interface to be externally implemented.

Implement this interface in an external class and pass the pointer to IDataDistribution::Initialize. The external class will be called conseguently.

See also
IDataDistribution::Initialize
IDataDistributionSubsystem::Initialize
IDataDistributionSubsystem::GetCallbacks

Member Function Documentation

◆ OnCompletelyDisconnected()

virtual void IDataDistributionCallback::OnCompletelyDisconnected ( const char *  channelName,
const char *  reason 
)
pure virtual

Callback invoked on a complete disconnection.

Callback invoked when subsystem detects a complete disconnection from central server or other peers. channelName reports the disconnected channel reason is the reason of disconnection.

Implemented in SmartDataDistributionBase.

◆ OnConfiguration()

virtual const char * IDataDistributionCallback::OnConfiguration ( const char *  channelName,
const char *  key,
const char *  value 
)
pure virtual

Invoked during configuration validation.

The callback is usable to override configuration parameters in some special conditions. channelName reports the channel involved (null for global parameters), key is the parameter key to be checked and value is the actual value.

Returns
value if no change is needed, otherwise any new string value according to the expected parameter type

Implemented in SmartDataDistributionBase.

◆ OnLogging()

virtual void IDataDistributionCallback::OnLogging ( DDM_LOG_LEVEL  level,
const char *  source,
const char *  function,
const char *  logStr 
)
pure virtual

Callback invoked when a log is emitted from subsystem.

The callback is usable to receive log information. level is the DDM_LOG_LEVEL of the log reported source is the module source name of the log function is the function, within the module, reporting the log logStr is the reported log string

See also
IDataDistributionLog::Log

Implemented in SmartDataDistributionBase.


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