-
+
+
- Generated by
1.12.0
+
| + | +
DataDistributionManager library. +More...
+ +Go to the source code of this file.
++Typedefs | |
| typedef enum DDM_GENERAL_PARAMETER | DDM_GENERAL_PARAMETER |
| typedef enum DDM_CHANNEL_DIRECTION | DDM_CHANNEL_DIRECTION |
| typedef enum DDM_LOG_LEVEL | DDM_LOG_LEVEL |
| typedef enum DDM_INSTANCE_STATE | DDM_INSTANCE_STATE |
| typedef enum DDM_CLUSTEREVENT | DDM_CLUSTEREVENT |
| typedef enum DDM_SEEKCONTEXT | DDM_SEEKCONTEXT |
| typedef enum DDM_SEEKKIND | DDM_SEEKKIND |
+Enumerations | |
| enum class | DDM_GENERAL_PARAMETER { + MAX_MESSAGE_SIZE = 0x1 +, SERVER_LOST_TIMEOUT +, CREATE_CHANNEL_TIMEOUT +, CHANNEL_SEEK_TIMEOUT +, + FIRST_CONNECTION_TIMEOUT +, KEEP_ALIVE_TIMEOUT +, CONSUMER_TIMEOUT +, PRODUCER_TIMEOUT + + } |
| DDM_GENERAL_PARAMETER type. More... | |
| enum class | DDM_CHANNEL_DIRECTION { TRANSMITTER = 0x1 +, RECEIVER = 0x2 +, ALL = TRANSMITTER | RECEIVER + } |
| DDM_CHANNEL_DIRECTION type. More... | |
| enum class | DDM_LOG_LEVEL { + FATAL_LEVEL = 0x1 +, ERROR_LEVEL = 0x2 +, WARNING_LEVEL = 0x4 +, INFO_LEVEL = 0x8 +, + DEBUG_LEVEL = 0x10 + + } |
| DDM_LOG_LEVEL type. More... | |
| enum class | DDM_INSTANCE_STATE { + UNKNOWN +, PRIMARY +, FOLLOWER +, ALONE +, + STOPPING +, GOING_ALONE +, OBSERVER +, COMMAND + + } |
| DDM_INSTANCE_STATE type. More... | |
| enum class | DDM_CLUSTEREVENT { NOEVENT = 0x1 +, ADDSERVER = 0x2 +, LOSTSERVER = 0x4 +, REMOVESERVER = 0x8 + } |
| DDM_CLUSTEREVENT type. More... | |
| enum class | DDM_SEEKCONTEXT { OFFSET = 0x1 +, TIMESTAMP = 0x2 + } |
| DDM_SEEKCONTEXT type. More... | |
| enum class | DDM_SEEKKIND { ABSOLUTE = 0x1 +, RELATIVE = 0x2 + } |
| DDM_SEEKKIND type. More... | |
DataDistributionManager library.
+DataDistributionManagerEnums.h contains the public enums for DataDistributionManager. The API is documented in this file as comments prefixing the class, function, type, enum, define, etc. The C++ interface is STD C++ '03 compliant and adheres to the Google C++ Style Guide.
+| typedef enum DDM_CHANNEL_DIRECTION DDM_CHANNEL_DIRECTION | +
| typedef enum DDM_CLUSTEREVENT DDM_CLUSTEREVENT | +
| typedef enum DDM_GENERAL_PARAMETER DDM_GENERAL_PARAMETER | +
| typedef enum DDM_INSTANCE_STATE DDM_INSTANCE_STATE | +
| typedef enum DDM_LOG_LEVEL DDM_LOG_LEVEL | +
| typedef enum DDM_SEEKCONTEXT DDM_SEEKCONTEXT | +
| typedef enum DDM_SEEKKIND DDM_SEEKKIND | +
+
|
+ +strong | +
+
|
+ +strong | +
DDM_CLUSTEREVENT type.
+Cluster events
+| Enumerator | |
|---|---|
| NOEVENT | No event + |
| ADDSERVER | A server was added in the cluster + |
| LOSTSERVER | A server was lost in the cluster + |
| REMOVESERVER | A server was removed from the cluster + |
+
|
+ +strong | +
DDM_GENERAL_PARAMETER type.
+General configuration parameters
+
+
|
+ +strong | +
DDM_INSTANCE_STATE type.
+State of the instance
+| Enumerator | |
|---|---|
| UNKNOWN | Unknown + |
| PRIMARY | Primary + |
| FOLLOWER | Follower + |
| ALONE | Alone + |
| STOPPING | Stopping + |
| GOING_ALONE | Going alone + |
| OBSERVER | Observer + |
| COMMAND | Command sender + |
+
|
+ +strong | +
DDM_LOG_LEVEL type.
+Log levels
+| Enumerator | |
|---|---|
| FATAL_LEVEL | Fatal + |
| ERROR_LEVEL | Error + |
| WARNING_LEVEL | Warning + |
| INFO_LEVEL | Info + |
| DEBUG_LEVEL | Debug + |
+
|
+ +strong | +
+
|
+ +strong | +
1.12.0 | + | +
1.12.0 | + | +
DataDistributionManager library. +More...
+#include "DataDistributionManagerEnums.h"Go to the source code of this file.
++Typedefs | |
| typedef void * | GENERIC_HANDLE |
| Generic handle definition, used for thread, lock, mutex. | |
| typedef long | OPERATION_RESULT |
| OPERATION_RESULT type. | |
DataDistributionManager library.
+DataDistributionManagerTypes.h contains the public types for DataDistributionManager. The API is documented in this file as comments prefixing the class, function, type, enum, define, etc. The C++ interface is STD C++ '03 compliant and adheres to the Google C++ Style Guide.
+| #define CHANNEL_HANDLE IDataDistributionChannel* | +
Channel handle definition.
+ +| #define CHANNEL_HANDLE_PARAMETER CHANNEL_HANDLE channelHandle | +
Channel handle parameter definition.
+ +| #define DDM_COMMIT_FAILED DDM_UNMAPPED_ERROR_CONDITION + 6 | +
Commit failed
+ +| #define DDM_DATA_AVAILABLE 0x20000000 | +
Data are available
+ +| #define DDM_ELAPSED_MESSAGE_ACKNOWLEDGMENT_TIMEOUT DDM_DATA_AVAILABLE + 5 | +
Timeout on acknowledgment
+ +| #define DDM_ELAPSED_MESSAGE_RECEIVE_TIMEOUT_BEGIN DDM_DATA_AVAILABLE + 3 | +
Timeout elapsed waiting for messages from the channel
+ +| #define DDM_ELAPSED_MESSAGE_RECEIVE_TIMEOUT_END DDM_DATA_AVAILABLE + 4 | +
End timeout condition waiting for messages from the channel
+ +| #define DDM_END_OF_STREAM DDM_DATA_AVAILABLE + 1 | +
Reached end of stream
+ +| #define DDM_FATAL_ERROR DDM_UNMAPPED_ERROR_CONDITION + 1 | +
Fatal
+ +| #define DDM_INVALID_DATA DDM_UNMAPPED_ERROR_CONDITION + 3 | +
Invalid data
+ +| #define DDM_NO_DATA_RETURNED DDM_DATA_AVAILABLE + 2 | +
No data returned
+ +| #define DDM_NO_ERROR_CONDITION 0 | +
No error
+ +| #define DDM_NO_TIMESTAMP -1 | +
Definition to avoid timestamp on write.
+ +| #define DDM_NOT_IMPLEMENTED DDM_UNMAPPED_ERROR_CONDITION + 8 | +
Function not implemented
+ +| #define DDM_PARAMETER_ERROR DDM_UNMAPPED_ERROR_CONDITION + 9 | +
Errors in parameters
+ +| #define DDM_POINTER_NOT_SET DDM_UNMAPPED_ERROR_CONDITION + 7 | +
Pointer not set within subsystem
+ +| #define DDM_SEEK_FAILED DDM_UNMAPPED_ERROR_CONDITION + 10 | +
Errors during seek operation
+ +| #define DDM_SUBSYSTEM_NOT_STARTED DDM_UNMAPPED_ERROR_CONDITION + 4 | +
Subsystem not started
+ +| #define DDM_TIMEOUT DDM_UNMAPPED_ERROR_CONDITION + 2 | +
Timeout occurred
+ +| #define DDM_UNMAPPED_ERROR_CONDITION 0xF0000000 | +
Unmapped error
+ +| #define DDM_WRITE_FAILED DDM_UNMAPPED_ERROR_CONDITION + 5 | +
Failed on write
+ +| #define OPERATION_FAILED | +( | +or | ) | ++ |
Check if operation failed.
+ +| #define OPERATION_SUCCEEDED | +( | +or | ) | ++ |
Check if operation succeeded.
+ +| typedef void* GENERIC_HANDLE | +
Generic handle definition, used for thread, lock, mutex.
+ +| typedef long OPERATION_RESULT | +
OPERATION_RESULT type.
+Errors or conditions from underlying layer
+ + 1.12.0 | + | +
1.12.0 | + | +
DataDistributionManager library. +More...
+#include "DataDistributionManagerTypes.h"Go to the source code of this file.
++Classes | |
| struct | ClusterHealthElement |
| Contains information needed from the cluster management. More... | |
| class | ITimeMeasureWrapper |
| Interface to manage time information. More... | |
| class | TimeMeasureWrapper |
| Class to allocate an ITimeMeasureWrapper. More... | |
| class | IDataDistributionLog |
| Interface to reports logging. More... | |
| class | IDataDistributionCallback |
| The C++ callback interface to be externally implemented. More... | |
| class | DataDistributionCallback |
| Class to convert C style callback into C++ callback. More... | |
| struct | UnderlyingEventData |
| Class to reports information from transport subsystem. More... | |
| class | IDataDistributionChannel |
| The basic interface for all channel. More... | |
| class | IDataDistributionChannelCallback |
| The C++ callback interface to be externally implemented. More... | |
| class | DataDistributionChannelCallback |
| Class to convert C style dataDistributionUnderlyingEvent callback into IDataDistributionChannelCallback C++ callback. More... | |
| class | IDataDistributionMastershipCallback |
| The C++ callback interface to be externally implemented. More... | |
| class | DataDistributionMastershipCallback |
| Class to convert C style callbacks into IDataDistributionMastershipCallback C++ callback. More... | |
| class | IDataDistributionChannelBase |
| Base interface to be implemented from channel manager. More... | |
| class | IDataDistributionTransport |
| Interface to be implemented from transport subsystem. More... | |
| class | IDataDistributionSubsystem |
| Interface to be implemented from subsystem. More... | |
| class | IDataDistributionMastershipCommon |
| Interface to be implemented from mastership subsystem. More... | |
| class | IDataDistribution |
| Interface to be implemented from common manager. More... | |
| class | DataDistribution |
| Main entry point to activate an instance of IDataDistribution. More... | |
+Typedefs | |
| typedef const char *(FUNCALL * | dataDistributionConfigurationCb) (const void *opaque, const char *channelName, const char *key, const char *value) |
| C-style callback invoked for each key-value in the configuration. | |
| typedef void(FUNCALL * | dataDistributionLoggingCb) (const void *opaque, const DDM_LOG_LEVEL level, const char *source, const char *function, const char *logStr) |
| C-style callback invoked when a log is emitted from subsystem. | |
| typedef void(FUNCALL * | dataDistributionCompletelyDisconnectedCb) (const void *opaque, const char *channelName, const char *reason) |
| C-style callback invoked on a complete disconnection . | |
| typedef struct DDM_EXPORT UnderlyingEventData | UnderlyingEventData |
| Class to reports information from transport subsystem. | |
| typedef struct DDM_EXPORT UnderlyingEventData * | pUnderlyingEventData |
| typedef void(FUNCALL * | dataDistributionUnderlyingEvent) (const void *opaque, const CHANNEL_HANDLE_PARAMETER, const UnderlyingEventData *uEvent) |
| C-style callback invoked to report UnderlyingEventData. | |
| typedef void(FUNCALL * | dataDistributionOnClusterStateChange) (void *opaque, DDM_CLUSTEREVENT change, int64_t serverid) |
| C-style callback invoked to report cluster state change. | |
| typedef void(FUNCALL * | dataDistributionOnStateChange) (void *opaque, DDM_INSTANCE_STATE newState, DDM_INSTANCE_STATE oldState) |
| C-style callback invoked to report a state change. | |
| typedef void(FUNCALL * | dataDistributionOnStateReady) (void *opaque, void *pState, int64_t len) |
| C-style callback invoked when a state transfer is completed. | |
| typedef void(FUNCALL * | dataDistributionOnRequestedState) (void *opaque, void **pState, size_t *len) |
| C-style callback invoked when a state transfer is requested. | |
| typedef void(FUNCALL * | dataDistributionOnMultiplePrimary) (void *opaque, int64_t myId, int64_t otherId) |
| C-style callback invoked when multiple primary server are detected. | |
| typedef void(FUNCALL * | dataDistributionFirstStateChange) (void *opaque, DDM_INSTANCE_STATE newState) |
| C-style callback invoked to report a first state change. | |
| typedef void(FUNCALL * | dataDistributionChangingState) (void *opaque, DDM_INSTANCE_STATE actualState, DDM_INSTANCE_STATE futureState) |
| C-style callback invoked to report a starting instance state change. | |
| typedef void(FUNCALL * | dataDistributionChangedState) (void *opaque, DDM_INSTANCE_STATE actualState) |
| C-style callback invoked to report a finished instance state change. | |
| typedef std::map< int64_t, ClusterHealthElement * > | ClusterHealth |
| Association map between server id and ClusterHealthElement. | |
| typedef std::map< int64_t, ClusterHealthElement * >::const_iterator | ClusterHealthIterator |
| Iterator of ClusterHealth. | |
DataDistributionManager library.
+DataDistributionManager.h contains the public C++ API for DataDistributionManager. The API is documented in this file as comments prefixing the class, function, type, enum, define, etc. The C++ interface is STD C++ '03 compliant and adheres to the Google C++ Style Guide.
+| typedef std::map<int64_t, ClusterHealthElement *> ClusterHealth | +
Association map between server id and ClusterHealthElement.
+ +| typedef std::map<int64_t,ClusterHealthElement*>::const_iterator ClusterHealthIterator | +
Iterator of ClusterHealth.
+ +| typedef void(FUNCALL * dataDistributionChangedState) (void *opaque, DDM_INSTANCE_STATE actualState) | +
C-style callback invoked to report a finished instance state change.
+C-style callback invoked when subsystem needs to report a state change.
+actualState reports the actual DDM_INSTANCE_STATE state
The callback's opaque argument is the opaque set with DataDistributionMastershipCallback::create().
| typedef void(FUNCALL * dataDistributionChangingState) (void *opaque, DDM_INSTANCE_STATE actualState, DDM_INSTANCE_STATE futureState) | +
C-style callback invoked to report a starting instance state change.
+C-style callback invoked when subsystem needs to report a state change.
+futureState reports the future DDM_INSTANCE_STATE state actualState reports the actual DDM_INSTANCE_STATE state
The callback's opaque argument is the opaque set with DataDistributionMastershipCallback::create().
| typedef void(FUNCALL * dataDistributionCompletelyDisconnectedCb) (const void *opaque, const char *channelName, const char *reason) | +
C-style callback invoked on a complete disconnection .
+C-style 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.
The callback's opaque argument is the opaque set with DataDistributionCallback::create().
| typedef const char *(FUNCALL * dataDistributionConfigurationCb) (const void *opaque, const char *channelName, const char *key, const char *value) | +
C-style callback invoked for each key-value in the configuration.
+C-style callback 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.
value if no change is needed, otherwise any new string value according to the expected parameter typeThe callback's opaque argument is the opaque set with DataDistributionCallback::create().
| typedef void(FUNCALL * dataDistributionFirstStateChange) (void *opaque, DDM_INSTANCE_STATE newState) | +
C-style callback invoked to report a first state change.
+C-style callback invoked when subsystem needs to to report a first state change
+newState DDM_INSTANCE_STATE state
The callback's opaque argument is the opaque set with DataDistributionMastershipCallback::create().
| typedef void(FUNCALL * dataDistributionLoggingCb) (const void *opaque, const DDM_LOG_LEVEL level, const char *source, const char *function, const char *logStr) | +
C-style callback invoked when a log is emitted from subsystem.
+C-style callback 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 stringThe callback's opaque argument is the opaque set with DataDistributionCallback::create().
| typedef void(FUNCALL * dataDistributionOnClusterStateChange) (void *opaque, DDM_CLUSTEREVENT change, int64_t serverid) | +
C-style callback invoked to report cluster state change.
+C-style callback invoked when subsystem needs to report a cluster state change.
+change reports the DDM_CLUSTEREVENT event serverid the server id reporting the change
The callback's opaque argument is the opaque set with DataDistributionMastershipCallback::create().
| typedef void(FUNCALL * dataDistributionOnMultiplePrimary) (void *opaque, int64_t myId, int64_t otherId) | +
C-style callback invoked when multiple primary server are detected.
+C-style callback invoked when subsystem needs to report there are multiple primary server are detected
+myId my primary identifier otherId other primary identifier
The callback's opaque argument is the opaque set with DataDistributionMastershipCallback::create().
| typedef void(FUNCALL * dataDistributionOnRequestedState) (void *opaque, void **pState, size_t *len) | +
C-style callback invoked when a state transfer is requested.
+C-style callback invoked when subsystem needs to request a state transfer. Fill pState and len with state information
pState pointer to the buffer of the state len the length of the buffer
The callback's opaque argument is the opaque set with DataDistributionMastershipCallback::create().
| typedef void(FUNCALL * dataDistributionOnStateChange) (void *opaque, DDM_INSTANCE_STATE newState, DDM_INSTANCE_STATE oldState) | +
C-style callback invoked to report a state change.
+C-style callback invoked when subsystem needs to report a state change.
+newState reports the new DDM_INSTANCE_STATE state oldState reports the new DDM_INSTANCE_STATE state
The callback's opaque argument is the opaque set with DataDistributionMastershipCallback::create().
| typedef void(FUNCALL * dataDistributionOnStateReady) (void *opaque, void *pState, int64_t len) | +
C-style callback invoked when a state transfer is completed.
+C-style callback invoked when subsystem needs to report a completed state transfer
+pState pointer to the buffer of the state len the length of the buffer
The callback's opaque argument is the opaque set with DataDistributionMastershipCallback::create().
| typedef void(FUNCALL * dataDistributionUnderlyingEvent) (const void *opaque, const CHANNEL_HANDLE_PARAMETER, const UnderlyingEventData *uEvent) | +
C-style callback invoked to report UnderlyingEventData.
+C-style callback invoked when subsystem needs to report an UnderlyingEventData. channelHandle reports the channel handle source of UnderlyingEventData uEvent the UnderlyingEventData event
The callback's opaque argument is the opaque set with DataDistributionChannelCallback::create().
| typedef struct DDM_EXPORT UnderlyingEventData * pUnderlyingEventData | +
| typedef struct DDM_EXPORT UnderlyingEventData UnderlyingEventData | +
Class to reports information from transport subsystem.
+This class allocates an UnderlyingEventData with information from subsystem
+ + 1.12.0 | + | +
1.12.0 | + | +
DataDistributionManager library. +More...
+ +Go to the source code of this file.
++Classes | |
| class | SmartTimeMeasureWrapper |
| Smart class to manage ITimeMeasureWrapper. More... | |
| class | SmartDataDistributionChannel |
| Smart class to manage IDataDistributionChannelCallback. More... | |
| class | SmartDataDistributionBase |
| Smart class to manage IDataDistributionCallback and IDataDistributionMastershipCallback. More... | |
| class | SmartDataDistribution< T > |
| Smart class to manage DataDistribution. More... | |
DataDistributionManager library.
+SmartDataDistributionManager.h contains the public C++ API for Smart management of DataDistributionManager. The API is documented in this file as comments prefixing the class, function, type, enum, define, etc. The C++ interface is STD C++ '03 compliant and adheres to the Google C++ Style Guide.
+ 1.12.0 | + | +
1.12.0 | + | +
| CClusterHealthElement | Contains information needed from the cluster management |
| CDataDistribution | Main entry point to activate an instance of IDataDistribution |
| CDataDistributionCallback | Class to convert C style callback into C++ callback |
| CDataDistributionChannelCallback | Class to convert C style dataDistributionUnderlyingEvent callback into IDataDistributionChannelCallback C++ callback |
| CDataDistributionMastershipCallback | Class to convert C style callbacks into IDataDistributionMastershipCallback C++ callback |
| CIDataDistribution | Interface to be implemented from common manager |
| CIDataDistributionCallback | The C++ callback interface to be externally implemented |
| CIDataDistributionChannel | The basic interface for all channel |
| CIDataDistributionChannelBase | Base interface to be implemented from channel manager |
| CIDataDistributionChannelCallback | The C++ callback interface to be externally implemented |
| CIDataDistributionLog | Interface to reports logging |
| CIDataDistributionMastershipCallback | The C++ callback interface to be externally implemented |
| CIDataDistributionMastershipCommon | Interface to be implemented from mastership subsystem |
| CIDataDistributionSubsystem | Interface to be implemented from subsystem |
| CIDataDistributionTransport | Interface to be implemented from transport subsystem |
| CITimeMeasureWrapper | Interface to manage time information |
| CSmartDataDistribution | Smart class to manage DataDistribution |
| CSmartDataDistributionBase | Smart class to manage IDataDistributionCallback and IDataDistributionMastershipCallback |
| CSmartDataDistributionChannel | Smart class to manage IDataDistributionChannelCallback |
| CSmartTimeMeasureWrapper | Smart class to manage ITimeMeasureWrapper |
| CTimeMeasureWrapper | Class to allocate an ITimeMeasureWrapper |
| CUnderlyingEventData | Class to reports information from transport subsystem |
1.12.0 | + | +
This is the complete list of members for DataDistribution, including all inherited members.
+| create() | DataDistribution | static |
| GetMastershipLib()=0 | IDataDistribution | pure virtual |
| GetMastershipManager()=0 | IDataDistribution | pure virtual |
| GetProtocol()=0 | IDataDistribution | pure virtual |
| GetProtocolLib()=0 | IDataDistribution | pure virtual |
| GetSubsystemManager()=0 | IDataDistribution | pure virtual |
| Initialize(IDataDistributionCallback *iddcb, const char *conf_file=NULL, const char *hostAddress=NULL, const char *channelTrailer=NULL)=0 | IDataDistribution | pure virtual |
| Initialize(IDataDistributionCallback *iddcb, const char *arrayParams[], int len, const char *hostAddress=NULL, const char *channelTrailer=NULL)=0 | IDataDistribution | pure virtual |
| RequestMastershipManager(IDataDistributionMastershipCallback *cbs, const char *szMyAddress=NULL, const char *arrayParams[]=NULL, int len=0)=0 | IDataDistribution | pure virtual |
| Start(unsigned long timeout)=0 | IDataDistribution | pure virtual |
| Stop(unsigned long timeout)=0 | IDataDistribution | pure virtual |
1.12.0 | + | +
Main entry point to activate an instance of IDataDistribution. + More...
+ +#include <DataDistributionManager.h>
+
++Static Public Member Functions | |
| static IDataDistribution * | create () |
| Creates a new IDataDistribution instance. | |
+Additional Inherited Members | |
 Public Member Functions inherited from IDataDistribution | |
| virtual OPERATION_RESULT | Initialize (IDataDistributionCallback *iddcb, const char *conf_file=NULL, const char *hostAddress=NULL, const char *channelTrailer=NULL)=0 |
| Initialize IDataDistribution instance. | |
| virtual OPERATION_RESULT | Initialize (IDataDistributionCallback *iddcb, const char *arrayParams[], int len, const char *hostAddress=NULL, const char *channelTrailer=NULL)=0 |
| Initialize IDataDistribution instance. | |
| virtual OPERATION_RESULT | RequestMastershipManager (IDataDistributionMastershipCallback *cbs, const char *szMyAddress=NULL, const char *arrayParams[]=NULL, int len=0)=0 |
| Allocate and initialize the mastership manager. | |
| virtual BOOL | Start (unsigned long timeout)=0 |
| Start the common manager. | |
| virtual BOOL | Stop (unsigned long timeout)=0 |
| Stop the common manager. | |
| virtual IDataDistributionSubsystem * | GetSubsystemManager ()=0 |
| Returns the allocated communication subsystem. | |
| virtual IDataDistributionMastershipCommon * | GetMastershipManager ()=0 |
| Returns the allocated mastership subsystem. | |
| virtual std::string | GetProtocol ()=0 |
| Returns the protocol in use from IDataDistribution instance. | |
| virtual std::string | GetProtocolLib ()=0 |
| Returns the protocol library in use from IDataDistribution instance. | |
| virtual std::string | GetMastershipLib ()=0 |
| Returns the mastership library in use from IDataDistribution instance. | |
Main entry point to activate an instance of IDataDistribution.
+Main entry point to activate an instance of IDataDistribution
+
+
|
+ +static | +
Creates a new IDataDistribution instance.
+ 1.12.0 | + | +
This is the complete list of members for DataDistributionCallback, including all inherited members.
+| create(void *opaque, dataDistributionConfigurationCb confCb, dataDistributionLoggingCb logCb, dataDistributionCompletelyDisconnectedCb cbCb) | DataDistributionCallback | static |
| OnCompletelyDisconnected(const char *channelName, const char *reason)=0 | IDataDistributionCallback | pure virtual |
| OnConfiguration(const char *channelName, const char *key, const char *value)=0 | IDataDistributionCallback | pure virtual |
| OnLogging(DDM_LOG_LEVEL level, const char *source, const char *function, const char *logStr)=0 | IDataDistributionCallback | pure virtual |
1.12.0 | + | +
Class to convert C style callback into C++ callback. + More...
+ +#include <DataDistributionManager.h>
+
++Static Public Member Functions | |
| static IDataDistributionCallback * | create (void *opaque, dataDistributionConfigurationCb confCb, dataDistributionLoggingCb logCb, dataDistributionCompletelyDisconnectedCb cbCb) |
| Creates a new IDataDistributionCallback instance. | |
+Additional Inherited Members | |
| Public Member Functions inherited from IDataDistributionCallback | |
| 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. | |
Class to convert C style callback into C++ callback.
+This class allocates an IDataDistributionCallback with point to C-style callback
+
+
|
+ +static | +
Creates a new IDataDistributionCallback instance.
+opaque user pointer sent back on C-style callback invocation confCb C-style dataDistributionConfigurationCb callback logCb C-style dataDistributionLoggingCb callback cbCb C-style dataDistributionCompletelyDisconnectedCb callback
1.12.0 | + | +
This is the complete list of members for DataDistributionChannelCallback, including all inherited members.
+| create(void *opaque, dataDistributionUnderlyingEvent uEventCb) | DataDistributionChannelCallback | static |
1.12.0 | + | +
Class to convert C style dataDistributionUnderlyingEvent callback into IDataDistributionChannelCallback C++ callback. + More...
+ +#include <DataDistributionManager.h>
+Static Public Member Functions | |
| static IDataDistributionChannelCallback * | create (void *opaque, dataDistributionUnderlyingEvent uEventCb) |
| Creates a new IDataDistributionChannelCallback instance. | |
Class to convert C style dataDistributionUnderlyingEvent callback into IDataDistributionChannelCallback C++ callback.
+This class allocates an IDataDistributionChannelCallback which points to C-style callback
+
+
|
+ +static | +
Creates a new IDataDistributionChannelCallback instance.
+opaque user pointer sent back on C-style callback invocation uEventCb C-style dataDistributionUnderlyingEvent callback
1.12.0 | + | +
This is the complete list of members for DataDistributionMastershipCallback, including all inherited members.
+| create(void *opaque, dataDistributionOnClusterStateChange c1, dataDistributionOnStateChange c2, dataDistributionOnStateReady c3, dataDistributionOnRequestedState c4, dataDistributionOnMultiplePrimary c5, dataDistributionFirstStateChange c6, dataDistributionChangingState c7, dataDistributionChangedState c8) | DataDistributionMastershipCallback | static |
1.12.0 | + | +
Class to convert C style callbacks into IDataDistributionMastershipCallback C++ callback. + More...
+ +#include <DataDistributionManager.h>
+Static Public Member Functions | |
| static IDataDistributionMastershipCallback * | create (void *opaque, dataDistributionOnClusterStateChange c1, dataDistributionOnStateChange c2, dataDistributionOnStateReady c3, dataDistributionOnRequestedState c4, dataDistributionOnMultiplePrimary c5, dataDistributionFirstStateChange c6, dataDistributionChangingState c7, dataDistributionChangedState c8) |
| Creates a new IDataDistributionMastershipCallback instance. | |
Class to convert C style callbacks into IDataDistributionMastershipCallback C++ callback.
+This class allocates an IDataDistributionMastershipCallback which points to C-style callbacks
+
+
|
+ +static | +
Creates a new IDataDistributionMastershipCallback instance.
+opaque user pointer sent back on C-style callback invocation c1 C-style dataDistributionOnClusterStateChange callback c2 C-style dataDistributionOnStateChange callback c3 C-style dataDistributionOnStateReady callback c4 C-style dataDistributionOnRequestedState callback c5 C-style dataDistributionOnMultiplePrimary callback c6 C-style dataDistributionFirstStateChange callback c7 C-style dataDistributionChangingState callback c8 C-style dataDistributionChangedState callback
1.12.0 | + | +
This is the complete list of members for IDataDistribution, including all inherited members.
+| GetMastershipLib()=0 | IDataDistribution | pure virtual |
| GetMastershipManager()=0 | IDataDistribution | pure virtual |
| GetProtocol()=0 | IDataDistribution | pure virtual |
| GetProtocolLib()=0 | IDataDistribution | pure virtual |
| GetSubsystemManager()=0 | IDataDistribution | pure virtual |
| Initialize(IDataDistributionCallback *iddcb, const char *conf_file=NULL, const char *hostAddress=NULL, const char *channelTrailer=NULL)=0 | IDataDistribution | pure virtual |
| Initialize(IDataDistributionCallback *iddcb, const char *arrayParams[], int len, const char *hostAddress=NULL, const char *channelTrailer=NULL)=0 | IDataDistribution | pure virtual |
| RequestMastershipManager(IDataDistributionMastershipCallback *cbs, const char *szMyAddress=NULL, const char *arrayParams[]=NULL, int len=0)=0 | IDataDistribution | pure virtual |
| Start(unsigned long timeout)=0 | IDataDistribution | pure virtual |
| Stop(unsigned long timeout)=0 | IDataDistribution | pure virtual |
1.12.0 | + | +
Interface to be implemented from common manager. + More...
+ +#include <DataDistributionManager.h>
+
++Public Member Functions | |
| virtual OPERATION_RESULT | Initialize (IDataDistributionCallback *iddcb, const char *conf_file=NULL, const char *hostAddress=NULL, const char *channelTrailer=NULL)=0 |
| Initialize IDataDistribution instance. | |
| virtual OPERATION_RESULT | Initialize (IDataDistributionCallback *iddcb, const char *arrayParams[], int len, const char *hostAddress=NULL, const char *channelTrailer=NULL)=0 |
| Initialize IDataDistribution instance. | |
| virtual OPERATION_RESULT | RequestMastershipManager (IDataDistributionMastershipCallback *cbs, const char *szMyAddress=NULL, const char *arrayParams[]=NULL, int len=0)=0 |
| Allocate and initialize the mastership manager. | |
| virtual BOOL | Start (unsigned long timeout)=0 |
| Start the common manager. | |
| virtual BOOL | Stop (unsigned long timeout)=0 |
| Stop the common manager. | |
| virtual IDataDistributionSubsystem * | GetSubsystemManager ()=0 |
| Returns the allocated communication subsystem. | |
| virtual IDataDistributionMastershipCommon * | GetMastershipManager ()=0 |
| Returns the allocated mastership subsystem. | |
| virtual std::string | GetProtocol ()=0 |
| Returns the protocol in use from IDataDistribution instance. | |
| virtual std::string | GetProtocolLib ()=0 |
| Returns the protocol library in use from IDataDistribution instance. | |
| virtual std::string | GetMastershipLib ()=0 |
| Returns the mastership library in use from IDataDistribution instance. | |
Interface to be implemented from common manager.
+Interface to be implemented from common manager
+
+
|
+ +pure virtual | +
Returns the mastership library in use from IDataDistribution instance.
+
+
|
+ +pure virtual | +
Returns the allocated mastership subsystem.
+
+
|
+ +pure virtual | +
Returns the protocol in use from IDataDistribution instance.
+
+
|
+ +pure virtual | +
Returns the protocol library in use from IDataDistribution instance.
+
+
|
+ +pure virtual | +
Returns the allocated communication subsystem.
+
+
|
+ +pure virtual | +
Initialize IDataDistribution instance.
+iddcb IDataDistributionCallback received from external user application arrayParams an array of string in the form key=value len length of arrayParams hostAddress optional host address or host name channelTrailer the optional trailer to be appended to channel name when each channel is created
+
|
+ +pure virtual | +
Initialize IDataDistribution instance.
+iddcb IDataDistributionCallback from external user application conf_file the external ASCII configuration file with lines written as key=value hostAddress optional host address or host name channelTrailer the optional trailer to be appended to channel name when each channel is created
+
|
+ +pure virtual | +
Allocate and initialize the mastership manager.
+cbs IDataDistributionMastershipCallback received from external user application hostAddress optional host address or host name arrayParams an array of string in the form key=value len length of arrayParams
+
|
+ +pure virtual | +
Start the common manager.
+timeout the operation timeout in milliseconds
+
|
+ +pure virtual | +
Stop the common manager.
+timeout the operation timeout in milliseconds
1.12.0 | + | +
This is the complete list of members for IDataDistributionCallback, including all inherited members.
+| OnCompletelyDisconnected(const char *channelName, const char *reason)=0 | IDataDistributionCallback | pure virtual |
| OnConfiguration(const char *channelName, const char *key, const char *value)=0 | IDataDistributionCallback | pure virtual |
| OnLogging(DDM_LOG_LEVEL level, const char *source, const char *function, const char *logStr)=0 | IDataDistributionCallback | pure virtual |
1.12.0 | + | +
The C++ callback interface to be externally implemented. + More...
+ +#include <DataDistributionManager.h>
+
++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. | |
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.
+ +
+
|
+ +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.
+ +
+
|
+ +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.
value if no change is needed, otherwise any new string value according to the expected parameter type Implemented in SmartDataDistributionBase.
+ +
+
|
+ +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
Implemented in SmartDataDistributionBase.
+ + 1.12.0 | + | +
This is the complete list of members for IDataDistributionChannel, including all inherited members.
+| GetChannelName()=0 | IDataDistributionChannel | pure virtual |
| GetOpaqueHandle()=0 | IDataDistributionChannel | pure virtual |
1.12.0 | + | +
The basic interface for all channel. + More...
+ +#include <DataDistributionManager.h>
+Public Member Functions | |
| virtual const char * | GetChannelName ()=0 |
| Returns the channel name. | |
| virtual GENERIC_HANDLE | GetOpaqueHandle ()=0 |
| Returns an opaque version of the channel handle. | |
The basic interface for all channel.
+CHANNEL_HANDLE can be casted to IDataDistributionChannel
+ +
+
|
+ +pure virtual | +
Returns the channel name.
+Returns the channel name
+
+
|
+ +pure virtual | +
Returns an opaque version of the channel handle.
+Returns an opaque version of the channel handle
+ 1.12.0 | + | +
This is the complete list of members for IDataDistributionChannelBase, including all inherited members.
+| ChangeChannelDirection(CHANNEL_HANDLE_PARAMETER, DDM_CHANNEL_DIRECTION direction)=0 | IDataDistributionChannelBase | pure virtual |
| CreateChannel(const char *channelName, IDataDistributionChannelCallback *dataCb, DDM_CHANNEL_DIRECTION direction=DDM_CHANNEL_DIRECTION::ALL, const char *arrayParams[]=NULL, int len=0)=0 | IDataDistributionChannelBase | pure virtual |
| DeleteChannel(CHANNEL_HANDLE_PARAMETER)=0 | IDataDistributionChannelBase | pure virtual |
| GetParameter(CHANNEL_HANDLE_PARAMETER, const char *paramName)=0 | IDataDistributionChannelBase | pure virtual |
| GetParameter(CHANNEL_HANDLE_PARAMETER, DDM_GENERAL_PARAMETER paramId)=0 | IDataDistributionChannelBase | pure virtual |
| Lock(CHANNEL_HANDLE_PARAMETER, unsigned long timeout)=0 | IDataDistributionChannelBase | pure virtual |
| ReadFromChannel(CHANNEL_HANDLE_PARAMETER, int64_t offset, size_t *bufferLen, void **buffer)=0 | IDataDistributionChannelBase | pure virtual |
| SeekChannel(CHANNEL_HANDLE_PARAMETER, int64_t position, DDM_SEEKCONTEXT context=DDM_SEEKCONTEXT::OFFSET, DDM_SEEKKIND kind=DDM_SEEKKIND::ABSOLUTE)=0 | IDataDistributionChannelBase | pure virtual |
| SetParameter(CHANNEL_HANDLE_PARAMETER, const char *paramName, const char *paramValue)=0 | IDataDistributionChannelBase | pure virtual |
| SetParameter(CHANNEL_HANDLE_PARAMETER, DDM_GENERAL_PARAMETER paramId, const char *paramValue)=0 | IDataDistributionChannelBase | pure virtual |
| StartChannel(CHANNEL_HANDLE_PARAMETER, unsigned long timeout)=0 | IDataDistributionChannelBase | pure virtual |
| StopChannel(CHANNEL_HANDLE_PARAMETER, unsigned long timeout)=0 | IDataDistributionChannelBase | pure virtual |
| Unlock(CHANNEL_HANDLE_PARAMETER)=0 | IDataDistributionChannelBase | pure virtual |
| WriteOnChannel(CHANNEL_HANDLE_PARAMETER, const char *key, size_t keyLen, void *buffer, size_t bufferLen, const BOOL waitAll=FALSE, const int64_t timestamp=DDM_NO_TIMESTAMP)=0 | IDataDistributionChannelBase | pure virtual |
1.12.0 | + | +
Base interface to be implemented from channel manager. + More...
+ +#include <DataDistributionManager.h>
+
++Public Member Functions | |
| virtual CHANNEL_HANDLE | CreateChannel (const char *channelName, IDataDistributionChannelCallback *dataCb, DDM_CHANNEL_DIRECTION direction=DDM_CHANNEL_DIRECTION::ALL, const char *arrayParams[]=NULL, int len=0)=0 |
| Creates a new channel. | |
| virtual OPERATION_RESULT | StartChannel (CHANNEL_HANDLE_PARAMETER, unsigned long timeout)=0 |
| Starts the channel. | |
| virtual OPERATION_RESULT | StopChannel (CHANNEL_HANDLE_PARAMETER, unsigned long timeout)=0 |
| Stops the channel. | |
| virtual void | SetParameter (CHANNEL_HANDLE_PARAMETER, const char *paramName, const char *paramValue)=0 |
| Sets a parameter at run-time. | |
| virtual void | SetParameter (CHANNEL_HANDLE_PARAMETER, DDM_GENERAL_PARAMETER paramId, const char *paramValue)=0 |
| Sets a parameter at run-time. | |
| virtual const char * | GetParameter (CHANNEL_HANDLE_PARAMETER, const char *paramName)=0 |
| Reads a parameter at run-time. | |
| virtual const char * | GetParameter (CHANNEL_HANDLE_PARAMETER, DDM_GENERAL_PARAMETER paramId)=0 |
| Reads a parameter at run-time. | |
| virtual OPERATION_RESULT | Lock (CHANNEL_HANDLE_PARAMETER, unsigned long timeout)=0 |
| Locks the channel. | |
| virtual OPERATION_RESULT | Unlock (CHANNEL_HANDLE_PARAMETER)=0 |
| Unlock the channel. | |
| virtual OPERATION_RESULT | SeekChannel (CHANNEL_HANDLE_PARAMETER, int64_t position, DDM_SEEKCONTEXT context=DDM_SEEKCONTEXT::OFFSET, DDM_SEEKKIND kind=DDM_SEEKKIND::ABSOLUTE)=0 |
| Seeks the channel. | |
| virtual OPERATION_RESULT | DeleteChannel (CHANNEL_HANDLE_PARAMETER)=0 |
| Deletes the channel. | |
| virtual OPERATION_RESULT | WriteOnChannel (CHANNEL_HANDLE_PARAMETER, const char *key, size_t keyLen, void *buffer, size_t bufferLen, const BOOL waitAll=FALSE, const int64_t timestamp=DDM_NO_TIMESTAMP)=0 |
| Writes data on the channel. | |
| virtual OPERATION_RESULT | ReadFromChannel (CHANNEL_HANDLE_PARAMETER, int64_t offset, size_t *bufferLen, void **buffer)=0 |
| Reads data from the channel. | |
| virtual OPERATION_RESULT | ChangeChannelDirection (CHANNEL_HANDLE_PARAMETER, DDM_CHANNEL_DIRECTION direction)=0 |
| Change the DDM_CHANNEL_DIRECTION of the channel. | |
Base interface to be implemented from channel manager.
+Base interface to be implemented from channel manager
+
+
|
+ +pure virtual | +
Change the DDM_CHANNEL_DIRECTION of the channel.
+channelHandle the CHANNEL_HANDLE of the channel return from IDataDistributionChannelBase::CreateChannel direction DDM_CHANNEL_DIRECTION direction
+
|
+ +pure virtual | +
Creates a new channel.
+channelName the name of the channel dataCb IDataDistributionChannelCallback pointer to receive data, condition or errors direction DDM_CHANNEL_DIRECTION direction, default is DDM_CHANNEL_DIRECTION::ALL arrayParams an array of string in the form key=value to override parameters passed into IDataDistribution::Initialize len length of arrayParams
+
|
+ +pure virtual | +
Deletes the channel.
+channelHandle the CHANNEL_HANDLE of the channel return from IDataDistributionChannelBase::CreateChannel
+
|
+ +pure virtual | +
Reads a parameter at run-time.
+channelHandle the CHANNEL_HANDLE of the channel return from IDataDistributionChannelBase::CreateChannel paramName the parameter name
+
|
+ +pure virtual | +
Reads a parameter at run-time.
+channelHandle the CHANNEL_HANDLE of the channel return from IDataDistributionChannelBase::CreateChannel paramId the DDM_GENERAL_PARAMETER parameter id
+
|
+ +pure virtual | +
Locks the channel.
+channelHandle the CHANNEL_HANDLE of the channel return from IDataDistributionChannelBase::CreateChannel timeout the operation timeout in milliseconds
+
|
+ +pure virtual | +
Reads data from the channel.
+channelHandle the CHANNEL_HANDLE of the channel return from IDataDistributionChannelBase::CreateChannel offset offset to read info from dataLen pointer will receive length of data read buffer the buffer to receive data from the channel, it cannot be NULL
+
|
+ +pure virtual | +
Seeks the channel.
+channelHandle the CHANNEL_HANDLE of the channel return from IDataDistributionChannelBase::CreateChannel position the new channel position context the DDM_SEEKCONTEXT to use kind the DDM_SEEKKIND to use
+
|
+ +pure virtual | +
Sets a parameter at run-time.
+channelHandle the CHANNEL_HANDLE of the channel return from IDataDistributionChannelBase::CreateChannel paramName the parameter name paramValue the parameter value
+
|
+ +pure virtual | +
Sets a parameter at run-time.
+channelHandle the CHANNEL_HANDLE of the channel return from IDataDistributionChannelBase::CreateChannel paramId the DDM_GENERAL_PARAMETER parameter id paramValue the parameter value
+
|
+ +pure virtual | +
Starts the channel.
+channelHandle the CHANNEL_HANDLE of the channel return from IDataDistributionChannelBase::CreateChannel timeout the operation timeout in milliseconds
+
|
+ +pure virtual | +
Stops the channel.
+channelHandle the CHANNEL_HANDLE of the channel return from IDataDistributionChannelBase::CreateChannel timeout the operation timeout in milliseconds
+
|
+ +pure virtual | +
Unlock the channel.
+channelHandle the CHANNEL_HANDLE of the channel return from IDataDistributionChannelBase::CreateChannel
+
|
+ +pure virtual | +
Writes data on the channel.
+channelHandle the CHANNEL_HANDLE of the channel return from IDataDistributionChannelBase::CreateChannel key the key of the message to write, it can be NULL keyLen the length of the key buffer the buffer to write on the channel, it cannot be NULL bufferLen the length of the buffer to write waitAll set to TRUE to wait a complete message dispatch, default is FALSE.
timestamp a timestamp associable to the message, default is DDM_NO_TIMESTAMP and means no timestamp written 1.12.0 | + | +
This is the complete list of members for IDataDistributionChannelCallback, including all inherited members.
+| OnUnderlyingEvent(const CHANNEL_HANDLE_PARAMETER, const UnderlyingEventData *uEvent)=0 | IDataDistributionChannelCallback | pure virtual |
1.12.0 | + | +
The C++ callback interface to be externally implemented. + More...
+ +#include <DataDistributionManager.h>
+
++Public Member Functions | |
| virtual void | OnUnderlyingEvent (const CHANNEL_HANDLE_PARAMETER, const UnderlyingEventData *uEvent)=0 |
| Callback invoked to report UnderlyingEventData. | |
The C++ callback interface to be externally implemented.
+Implement this interface in an external class and pass the pointer to IDataDistributionChannelBase::CreateChannel. The external class will be called conseguently.
+ +
+
|
+ +pure virtual | +
Callback invoked to report UnderlyingEventData.
+Callback invoked when subsystem needs to report an UnderlyingEventData.
+channelHandle reports the channel handle source of UnderlyingEventData uEvent the UnderlyingEventData event
Implemented in SmartDataDistributionChannel.
+ + 1.12.0 | + | +
This is the complete list of members for IDataDistributionLog, including all inherited members.
+| Log(const DDM_LOG_LEVEL level, const char *sourceName, const char *function, const char *format,...)=0 | IDataDistributionLog | pure virtual |
| Log(const DDM_LOG_LEVEL level, const char *sourceName, const char *function, const char *format, va_list args)=0 | IDataDistributionLog | pure virtual |
1.12.0 | + | +
Interface to reports logging. + More...
+ +#include <DataDistributionManager.h>
+
++Public Member Functions | |
| virtual void | Log (const DDM_LOG_LEVEL level, const char *sourceName, const char *function, const char *format,...)=0 |
| Reports log information. | |
| virtual void | Log (const DDM_LOG_LEVEL level, const char *sourceName, const char *function, const char *format, va_list args)=0 |
| Reports log information. | |
Interface to reports logging.
+Logging reporting base interface
+
+
|
+ +pure virtual | +
Reports log information.
+This interface is implemented in modules to report log information level is the DDM_LOG_LEVEL of the log reported sourceName is the module source name of the log function is the function, within the module, reporting the log format is the format string to be filled with parameters args are the arguments for the format
+
|
+ +pure virtual | +
Reports log information.
+This interface is implemented in modules to report log information level is the DDM_LOG_LEVEL of the log reported sourceName is the module source name of the log function is the function, within the module, reporting the log format is the format string to be filled with parameters
1.12.0 | + | +
This is the complete list of members for IDataDistributionMastershipCallback, including all inherited members.
+| ChangedState(DDM_INSTANCE_STATE actualState)=0 | IDataDistributionMastershipCallback | pure virtual |
| ChangingState(DDM_INSTANCE_STATE actualState, DDM_INSTANCE_STATE futureState)=0 | IDataDistributionMastershipCallback | pure virtual |
| FirstStateChange(DDM_INSTANCE_STATE newState)=0 | IDataDistributionMastershipCallback | pure virtual |
| OnClusterStateChange(DDM_CLUSTEREVENT change, int64_t serverid)=0 | IDataDistributionMastershipCallback | pure virtual |
| OnMultiplePrimary(int64_t myId, int64_t otherId)=0 | IDataDistributionMastershipCallback | pure virtual |
| OnRequestedState(void **pState, size_t *len)=0 | IDataDistributionMastershipCallback | pure virtual |
| OnStateChange(DDM_INSTANCE_STATE newState, DDM_INSTANCE_STATE oldState)=0 | IDataDistributionMastershipCallback | pure virtual |
| OnStateReady(void *pState, int64_t len)=0 | IDataDistributionMastershipCallback | pure virtual |
1.12.0 | + | +
The C++ callback interface to be externally implemented. + More...
+ +#include <DataDistributionManager.h>
+
++Public Member Functions | |
| virtual void | OnClusterStateChange (DDM_CLUSTEREVENT change, int64_t serverid)=0 |
| Callback invoked to report cluster state change. | |
| virtual void | OnStateChange (DDM_INSTANCE_STATE newState, DDM_INSTANCE_STATE oldState)=0 |
| Callback invoked to report a state change. | |
| virtual void | OnStateReady (void *pState, int64_t len)=0 |
| Callback invoked when a state transfer is completed. | |
| virtual void | OnRequestedState (void **pState, size_t *len)=0 |
| Callback invoked when a state transfer is requested. | |
| virtual void | OnMultiplePrimary (int64_t myId, int64_t otherId)=0 |
| Callback invoked when multiple primary server are detected. | |
| virtual void | FirstStateChange (DDM_INSTANCE_STATE newState)=0 |
| Callback invoked to report a first state change. | |
| virtual void | ChangingState (DDM_INSTANCE_STATE actualState, DDM_INSTANCE_STATE futureState)=0 |
| Callback invoked to report a starting instance state change. | |
| virtual void | ChangedState (DDM_INSTANCE_STATE actualState)=0 |
| Callback invoked to report a finished instance state change. | |
The C++ callback interface to be externally implemented.
+Implement this interface in an external class and pass the pointer to IDataDistribution::RequestMastershipManager. The external class will be called conseguently.
+ +
+
|
+ +pure virtual | +
Callback invoked to report a finished instance state change.
+Callback invoked when subsystem needs to report a state change.
+actualState reports the actual DDM_INSTANCE_STATE state
Implemented in SmartDataDistributionBase.
+ +
+
|
+ +pure virtual | +
Callback invoked to report a starting instance state change.
+Callback invoked when subsystem needs to report a state change.
+futureState reports the future DDM_INSTANCE_STATE state actualState reports the actual DDM_INSTANCE_STATE state
Implemented in SmartDataDistributionBase.
+ +
+
|
+ +pure virtual | +
Callback invoked to report a first state change.
+Callback invoked when subsystem needs to to report a first state change
+newState DDM_INSTANCE_STATE state
Implemented in SmartDataDistributionBase.
+ +
+
|
+ +pure virtual | +
Callback invoked to report cluster state change.
+Callback invoked when subsystem needs to report a cluster state change.
+change reports the DDM_CLUSTEREVENT event serverid the server id reporting the change
Implemented in SmartDataDistributionBase.
+ +
+
|
+ +pure virtual | +
Callback invoked when multiple primary server are detected.
+Callback invoked when subsystem needs to report there are multiple primary server are detected
+myId my primary identifier otherId other primary identifier
Implemented in SmartDataDistributionBase.
+ +
+
|
+ +pure virtual | +
Callback invoked when a state transfer is requested.
+Callback invoked when subsystem needs to request a state transfer. Fill pState and len with state information
pState pointer to the buffer of the state len the length of the buffer
Implemented in SmartDataDistributionBase.
+ +
+
|
+ +pure virtual | +
Callback invoked to report a state change.
+Callback invoked when subsystem needs to report a state change.
+newState reports the new DDM_INSTANCE_STATE state oldState reports the new DDM_INSTANCE_STATE state
Implemented in SmartDataDistributionBase.
+ +
+
|
+ +pure virtual | +
Callback invoked when a state transfer is completed.
+Callback invoked when subsystem needs to report a completed state transfer
+pState pointer to the buffer of the state len the length of the buffer
Implemented in SmartDataDistributionBase.
+ + 1.12.0 | + | +
This is the complete list of members for IDataDistributionMastershipCommon, including all inherited members.
+ 1.12.0 | + | +
Interface to be implemented from mastership subsystem. + More...
+ +#include <DataDistributionManager.h>
+Public Member Functions | |
| virtual OPERATION_RESULT | Initialize (IDataDistributionSubsystem *transportManager, IDataDistributionMastershipCallback *cbs, const char *hostAddress=NULL, const char *arrayParams[]=NULL, int len=0)=0 |
| Initialize the subsystem. | |
| virtual void | SetParameter (const char *paramName, const char *paramValue)=0 |
| Sets a parameter at run-time. | |
| virtual const char * | GetParameter (const char *paramName)=0 |
| Reads a parameter at run-time. | |
| virtual OPERATION_RESULT | Start (unsigned long timeout)=0 |
| Start the mastership subsystem. | |
| virtual OPERATION_RESULT | Stop (unsigned long timeout)=0 |
| Stop the mastership subsystem. | |
| virtual BOOL | GetIamNextPrimary ()=0 |
| Verify if this server will be elected as next primary. | |
| virtual BOOL | RequestIAmNextPrimary ()=0 |
| Request to be the next primary server. | |
| virtual int64_t * | GetClusterIndexes (size_t *length)=0 |
| Returns an array of all known indexes of the servers within the cluster. | |
| virtual DDM_INSTANCE_STATE | GetStateOf (int64_t serverId)=0 |
| Returns the DDM_INSTANCE_STATE of a specific server. | |
| virtual ClusterHealth | GetClusterHealth ()=0 |
| Returns the health of the cluster. | |
| virtual DDM_INSTANCE_STATE | GetMyState ()=0 |
| Returns DDM_INSTANCE_STATE of this instance. | |
| virtual void | ChangeMyState (DDM_INSTANCE_STATE state)=0 |
| Change DDM_INSTANCE_STATE of this instance. | |
| virtual void | ChangeState (int64_t instanceId, DDM_INSTANCE_STATE state)=0 |
Change DDM_INSTANCE_STATE of instanceId. | |
| virtual int64_t | GetLocalServerId ()=0 |
| Returns the server id of the local instance. | |
| virtual int64_t | GetPrimaryServerId ()=0 |
| Returns the server id of the primary instance. | |
| virtual int64_t | GetMessageDelay ()=0 |
| Returns the message delay within the cluster. | |
| virtual int64_t | GetUpTime ()=0 |
| Returns the current uptime. | |
Interface to be implemented from mastership subsystem.
+Interface to be implemented from mastership subsystem
+
+
|
+ +pure virtual | +
Change DDM_INSTANCE_STATE of this instance.
+state DDM_INSTANCE_STATE expected
+
|
+ +pure virtual | +
Change DDM_INSTANCE_STATE of instanceId.
instanceId server id to change state state DDM_INSTANCE_STATE expected
+
|
+ +pure virtual | +
Returns the health of the cluster.
+
+
|
+ +pure virtual | +
Returns an array of all known indexes of the servers within the cluster.
+length the parameter receiving the length of returned buffer
+
|
+ +pure virtual | +
Verify if this server will be elected as next primary.
+
+
|
+ +pure virtual | +
Returns the server id of the local instance.
+
+
|
+ +pure virtual | +
Returns the message delay within the cluster.
+
+
|
+ +pure virtual | +
Returns DDM_INSTANCE_STATE of this instance.
+
+
|
+ +pure virtual | +
Reads a parameter at run-time.
+paramName the parameter name
+
|
+ +pure virtual | +
Returns the server id of the primary instance.
+
+
|
+ +pure virtual | +
Returns the DDM_INSTANCE_STATE of a specific server.
+serverId server index to get DDM_INSTANCE_STATE
+
|
+ +pure virtual | +
Returns the current uptime.
+
+
|
+ +pure virtual | +
Initialize the subsystem.
+transportManager IDataDistributionSubsystem to use cbs IDataDistributionMastershipCallback to communicate information hostAddress optional host address or host name arrayParams an array of string in the form key=value len length of arrayParams
+
|
+ +pure virtual | +
Request to be the next primary server.
+
+
|
+ +pure virtual | +
Sets a parameter at run-time.
+paramName the parameter name paramValue the parameter value
+
|
+ +pure virtual | +
Start the mastership subsystem.
+timeout the operation timeout in milliseconds
+
|
+ +pure virtual | +
Stop the mastership subsystem.
+timeout the operation timeout in milliseconds
1.12.0 | + | +
This is the complete list of members for IDataDistributionSubsystem, including all inherited members.
+| ChangeChannelDirection(CHANNEL_HANDLE_PARAMETER, DDM_CHANNEL_DIRECTION direction)=0 | IDataDistributionChannelBase | pure virtual |
| CreateChannel(const char *channelName, IDataDistributionChannelCallback *dataCb, DDM_CHANNEL_DIRECTION direction=DDM_CHANNEL_DIRECTION::ALL, const char *arrayParams[]=NULL, int len=0)=0 | IDataDistributionChannelBase | pure virtual |
| DeleteChannel(CHANNEL_HANDLE_PARAMETER)=0 | IDataDistributionChannelBase | pure virtual |
| GetCallbacks()=0 | IDataDistributionSubsystem | pure virtual |
| GetMaxMessageSize()=0 | IDataDistributionTransport | pure virtual |
| GetParameter(CHANNEL_HANDLE_PARAMETER, const char *paramName)=0 | IDataDistributionChannelBase | pure virtual |
| GetParameter(CHANNEL_HANDLE_PARAMETER, DDM_GENERAL_PARAMETER paramId)=0 | IDataDistributionChannelBase | pure virtual |
| GetServerLostTimeout()=0 | IDataDistributionTransport | pure virtual |
| Initialize(IDataDistributionCallback *cb, const char *conf_file, const char *hostAddress=NULL, const char *channelTrailer=NULL)=0 | IDataDistributionSubsystem | pure virtual |
| Initialize(IDataDistributionCallback *cb, const char *arrayParams[], int len, const char *hostAddress=NULL, const char *channelTrailer=NULL)=0 | IDataDistributionSubsystem | pure virtual |
| Lock(CHANNEL_HANDLE_PARAMETER, unsigned long timeout)=0 | IDataDistributionChannelBase | pure virtual |
| Log(const DDM_LOG_LEVEL level, const char *sourceName, const char *function, const char *format,...)=0 | IDataDistributionLog | pure virtual |
| Log(const DDM_LOG_LEVEL level, const char *sourceName, const char *function, const char *format, va_list args)=0 | IDataDistributionLog | pure virtual |
| ReadFromChannel(CHANNEL_HANDLE_PARAMETER, int64_t offset, size_t *bufferLen, void **buffer)=0 | IDataDistributionChannelBase | pure virtual |
| SeekChannel(CHANNEL_HANDLE_PARAMETER, int64_t position, DDM_SEEKCONTEXT context=DDM_SEEKCONTEXT::OFFSET, DDM_SEEKKIND kind=DDM_SEEKKIND::ABSOLUTE)=0 | IDataDistributionChannelBase | pure virtual |
| SetParameter(CHANNEL_HANDLE_PARAMETER, const char *paramName, const char *paramValue)=0 | IDataDistributionChannelBase | pure virtual |
| SetParameter(CHANNEL_HANDLE_PARAMETER, DDM_GENERAL_PARAMETER paramId, const char *paramValue)=0 | IDataDistributionChannelBase | pure virtual |
| Start(unsigned long timeout)=0 | IDataDistributionTransport | pure virtual |
| StartChannel(CHANNEL_HANDLE_PARAMETER, unsigned long timeout)=0 | IDataDistributionChannelBase | pure virtual |
| Stop(unsigned long timeout)=0 | IDataDistributionTransport | pure virtual |
| StopChannel(CHANNEL_HANDLE_PARAMETER, unsigned long timeout)=0 | IDataDistributionChannelBase | pure virtual |
| Unlock(CHANNEL_HANDLE_PARAMETER)=0 | IDataDistributionChannelBase | pure virtual |
| WriteOnChannel(CHANNEL_HANDLE_PARAMETER, const char *key, size_t keyLen, void *buffer, size_t bufferLen, const BOOL waitAll=FALSE, const int64_t timestamp=DDM_NO_TIMESTAMP)=0 | IDataDistributionChannelBase | pure virtual |
1.12.0 | + | +
Interface to be implemented from subsystem. + More...
+ +#include <DataDistributionManager.h>
+
++Public Member Functions | |
| virtual OPERATION_RESULT | Initialize (IDataDistributionCallback *cb, const char *conf_file, const char *hostAddress=NULL, const char *channelTrailer=NULL)=0 |
| Initialize the subsystem. | |
| virtual OPERATION_RESULT | Initialize (IDataDistributionCallback *cb, const char *arrayParams[], int len, const char *hostAddress=NULL, const char *channelTrailer=NULL)=0 |
| Initialize the subsystem. | |
| virtual IDataDistributionCallback * | GetCallbacks ()=0 |
| Returns IDataDistributionCallback passed during IDataDistributionSubsystem::Initialize. | |
| Public Member Functions inherited from IDataDistributionTransport | |
| virtual int | GetServerLostTimeout ()=0 |
| Returns the server lost timeout. | |
| virtual size_t | GetMaxMessageSize ()=0 |
| Returns the max message size managed from the subsystem. | |
| virtual OPERATION_RESULT | Start (unsigned long timeout)=0 |
| Start the transport subsystem. | |
| virtual OPERATION_RESULT | Stop (unsigned long timeout)=0 |
| Start the transport subsystem. | |
| Public Member Functions inherited from IDataDistributionChannelBase | |
| virtual CHANNEL_HANDLE | CreateChannel (const char *channelName, IDataDistributionChannelCallback *dataCb, DDM_CHANNEL_DIRECTION direction=DDM_CHANNEL_DIRECTION::ALL, const char *arrayParams[]=NULL, int len=0)=0 |
| Creates a new channel. | |
| virtual OPERATION_RESULT | StartChannel (CHANNEL_HANDLE_PARAMETER, unsigned long timeout)=0 |
| Starts the channel. | |
| virtual OPERATION_RESULT | StopChannel (CHANNEL_HANDLE_PARAMETER, unsigned long timeout)=0 |
| Stops the channel. | |
| virtual void | SetParameter (CHANNEL_HANDLE_PARAMETER, const char *paramName, const char *paramValue)=0 |
| Sets a parameter at run-time. | |
| virtual void | SetParameter (CHANNEL_HANDLE_PARAMETER, DDM_GENERAL_PARAMETER paramId, const char *paramValue)=0 |
| Sets a parameter at run-time. | |
| virtual const char * | GetParameter (CHANNEL_HANDLE_PARAMETER, const char *paramName)=0 |
| Reads a parameter at run-time. | |
| virtual const char * | GetParameter (CHANNEL_HANDLE_PARAMETER, DDM_GENERAL_PARAMETER paramId)=0 |
| Reads a parameter at run-time. | |
| virtual OPERATION_RESULT | Lock (CHANNEL_HANDLE_PARAMETER, unsigned long timeout)=0 |
| Locks the channel. | |
| virtual OPERATION_RESULT | Unlock (CHANNEL_HANDLE_PARAMETER)=0 |
| Unlock the channel. | |
| virtual OPERATION_RESULT | SeekChannel (CHANNEL_HANDLE_PARAMETER, int64_t position, DDM_SEEKCONTEXT context=DDM_SEEKCONTEXT::OFFSET, DDM_SEEKKIND kind=DDM_SEEKKIND::ABSOLUTE)=0 |
| Seeks the channel. | |
| virtual OPERATION_RESULT | DeleteChannel (CHANNEL_HANDLE_PARAMETER)=0 |
| Deletes the channel. | |
| virtual OPERATION_RESULT | WriteOnChannel (CHANNEL_HANDLE_PARAMETER, const char *key, size_t keyLen, void *buffer, size_t bufferLen, const BOOL waitAll=FALSE, const int64_t timestamp=DDM_NO_TIMESTAMP)=0 |
| Writes data on the channel. | |
| virtual OPERATION_RESULT | ReadFromChannel (CHANNEL_HANDLE_PARAMETER, int64_t offset, size_t *bufferLen, void **buffer)=0 |
| Reads data from the channel. | |
| virtual OPERATION_RESULT | ChangeChannelDirection (CHANNEL_HANDLE_PARAMETER, DDM_CHANNEL_DIRECTION direction)=0 |
| Change the DDM_CHANNEL_DIRECTION of the channel. | |
| Public Member Functions inherited from IDataDistributionLog | |
| virtual void | Log (const DDM_LOG_LEVEL level, const char *sourceName, const char *function, const char *format,...)=0 |
| Reports log information. | |
| virtual void | Log (const DDM_LOG_LEVEL level, const char *sourceName, const char *function, const char *format, va_list args)=0 |
| Reports log information. | |
Interface to be implemented from subsystem.
+Interface to be implemented from subsystem. Extends IDataDistributionTransport and IDataDistributionLog
+
+
|
+ +pure virtual | +
Returns IDataDistributionCallback passed during IDataDistributionSubsystem::Initialize.
+
+
|
+ +pure virtual | +
Initialize the subsystem.
+cb IDataDistributionCallback received from IDataDistribution::Initialize arrayParams an array of string in the form key=value len length of arrayParams hostAddress optional host address or host name channelTrailer the optional trailer to be appended to channel name when each channel is created
+
|
+ +pure virtual | +
Initialize the subsystem.
+cb IDataDistributionCallback received from IDataDistribution::Initialize conf_file the external ASCII configuration file with lines written as key=value hostAddress optional host address or host name channelTrailer the optional trailer to be appended to channel name when each channel is created
1.12.0 | + | +
This is the complete list of members for IDataDistributionTransport, including all inherited members.
+| ChangeChannelDirection(CHANNEL_HANDLE_PARAMETER, DDM_CHANNEL_DIRECTION direction)=0 | IDataDistributionChannelBase | pure virtual |
| CreateChannel(const char *channelName, IDataDistributionChannelCallback *dataCb, DDM_CHANNEL_DIRECTION direction=DDM_CHANNEL_DIRECTION::ALL, const char *arrayParams[]=NULL, int len=0)=0 | IDataDistributionChannelBase | pure virtual |
| DeleteChannel(CHANNEL_HANDLE_PARAMETER)=0 | IDataDistributionChannelBase | pure virtual |
| GetMaxMessageSize()=0 | IDataDistributionTransport | pure virtual |
| GetParameter(CHANNEL_HANDLE_PARAMETER, const char *paramName)=0 | IDataDistributionChannelBase | pure virtual |
| GetParameter(CHANNEL_HANDLE_PARAMETER, DDM_GENERAL_PARAMETER paramId)=0 | IDataDistributionChannelBase | pure virtual |
| GetServerLostTimeout()=0 | IDataDistributionTransport | pure virtual |
| Lock(CHANNEL_HANDLE_PARAMETER, unsigned long timeout)=0 | IDataDistributionChannelBase | pure virtual |
| ReadFromChannel(CHANNEL_HANDLE_PARAMETER, int64_t offset, size_t *bufferLen, void **buffer)=0 | IDataDistributionChannelBase | pure virtual |
| SeekChannel(CHANNEL_HANDLE_PARAMETER, int64_t position, DDM_SEEKCONTEXT context=DDM_SEEKCONTEXT::OFFSET, DDM_SEEKKIND kind=DDM_SEEKKIND::ABSOLUTE)=0 | IDataDistributionChannelBase | pure virtual |
| SetParameter(CHANNEL_HANDLE_PARAMETER, const char *paramName, const char *paramValue)=0 | IDataDistributionChannelBase | pure virtual |
| SetParameter(CHANNEL_HANDLE_PARAMETER, DDM_GENERAL_PARAMETER paramId, const char *paramValue)=0 | IDataDistributionChannelBase | pure virtual |
| Start(unsigned long timeout)=0 | IDataDistributionTransport | pure virtual |
| StartChannel(CHANNEL_HANDLE_PARAMETER, unsigned long timeout)=0 | IDataDistributionChannelBase | pure virtual |
| Stop(unsigned long timeout)=0 | IDataDistributionTransport | pure virtual |
| StopChannel(CHANNEL_HANDLE_PARAMETER, unsigned long timeout)=0 | IDataDistributionChannelBase | pure virtual |
| Unlock(CHANNEL_HANDLE_PARAMETER)=0 | IDataDistributionChannelBase | pure virtual |
| WriteOnChannel(CHANNEL_HANDLE_PARAMETER, const char *key, size_t keyLen, void *buffer, size_t bufferLen, const BOOL waitAll=FALSE, const int64_t timestamp=DDM_NO_TIMESTAMP)=0 | IDataDistributionChannelBase | pure virtual |
1.12.0 | + | +
Interface to be implemented from transport subsystem. + More...
+ +#include <DataDistributionManager.h>
+
++Public Member Functions | |
| virtual int | GetServerLostTimeout ()=0 |
| Returns the server lost timeout. | |
| virtual size_t | GetMaxMessageSize ()=0 |
| Returns the max message size managed from the subsystem. | |
| virtual OPERATION_RESULT | Start (unsigned long timeout)=0 |
| Start the transport subsystem. | |
| virtual OPERATION_RESULT | Stop (unsigned long timeout)=0 |
| Start the transport subsystem. | |
| Public Member Functions inherited from IDataDistributionChannelBase | |
| virtual CHANNEL_HANDLE | CreateChannel (const char *channelName, IDataDistributionChannelCallback *dataCb, DDM_CHANNEL_DIRECTION direction=DDM_CHANNEL_DIRECTION::ALL, const char *arrayParams[]=NULL, int len=0)=0 |
| Creates a new channel. | |
| virtual OPERATION_RESULT | StartChannel (CHANNEL_HANDLE_PARAMETER, unsigned long timeout)=0 |
| Starts the channel. | |
| virtual OPERATION_RESULT | StopChannel (CHANNEL_HANDLE_PARAMETER, unsigned long timeout)=0 |
| Stops the channel. | |
| virtual void | SetParameter (CHANNEL_HANDLE_PARAMETER, const char *paramName, const char *paramValue)=0 |
| Sets a parameter at run-time. | |
| virtual void | SetParameter (CHANNEL_HANDLE_PARAMETER, DDM_GENERAL_PARAMETER paramId, const char *paramValue)=0 |
| Sets a parameter at run-time. | |
| virtual const char * | GetParameter (CHANNEL_HANDLE_PARAMETER, const char *paramName)=0 |
| Reads a parameter at run-time. | |
| virtual const char * | GetParameter (CHANNEL_HANDLE_PARAMETER, DDM_GENERAL_PARAMETER paramId)=0 |
| Reads a parameter at run-time. | |
| virtual OPERATION_RESULT | Lock (CHANNEL_HANDLE_PARAMETER, unsigned long timeout)=0 |
| Locks the channel. | |
| virtual OPERATION_RESULT | Unlock (CHANNEL_HANDLE_PARAMETER)=0 |
| Unlock the channel. | |
| virtual OPERATION_RESULT | SeekChannel (CHANNEL_HANDLE_PARAMETER, int64_t position, DDM_SEEKCONTEXT context=DDM_SEEKCONTEXT::OFFSET, DDM_SEEKKIND kind=DDM_SEEKKIND::ABSOLUTE)=0 |
| Seeks the channel. | |
| virtual OPERATION_RESULT | DeleteChannel (CHANNEL_HANDLE_PARAMETER)=0 |
| Deletes the channel. | |
| virtual OPERATION_RESULT | WriteOnChannel (CHANNEL_HANDLE_PARAMETER, const char *key, size_t keyLen, void *buffer, size_t bufferLen, const BOOL waitAll=FALSE, const int64_t timestamp=DDM_NO_TIMESTAMP)=0 |
| Writes data on the channel. | |
| virtual OPERATION_RESULT | ReadFromChannel (CHANNEL_HANDLE_PARAMETER, int64_t offset, size_t *bufferLen, void **buffer)=0 |
| Reads data from the channel. | |
| virtual OPERATION_RESULT | ChangeChannelDirection (CHANNEL_HANDLE_PARAMETER, DDM_CHANNEL_DIRECTION direction)=0 |
| Change the DDM_CHANNEL_DIRECTION of the channel. | |
Interface to be implemented from transport subsystem.
+Interface to be implemented from transport subsystem. Extends IDataDistributionChannelBase
+
+
|
+ +pure virtual | +
Returns the max message size managed from the subsystem.
+
+
|
+ +pure virtual | +
Returns the server lost timeout.
+
+
|
+ +pure virtual | +
Start the transport subsystem.
+timeout the operation timeout in milliseconds
+
|
+ +pure virtual | +
Start the transport subsystem.
+timeout the operation timeout in milliseconds
1.12.0 | + | +
This is the complete list of members for ITimeMeasureWrapper, including all inherited members.
+| AddNanoseconds(unsigned int time)=0 | ITimeMeasureWrapper | pure virtual |
| ElapsedMicroseconds()=0 | ITimeMeasureWrapper | pure virtual |
| ElapsedMilliseconds()=0 | ITimeMeasureWrapper | pure virtual |
| ElapsedNanoseconds()=0 | ITimeMeasureWrapper | pure virtual |
| ResetTime()=0 | ITimeMeasureWrapper | pure virtual |
1.12.0 | + | +
Interface to manage time information. + More...
+ +#include <DataDistributionManager.h>
+
++Public Member Functions | |
| virtual void | ResetTime ()=0 |
| Reset the timer. | |
| virtual int64_t | ElapsedMilliseconds ()=0 |
| Reports the elapsed time in milliseconds. | |
| virtual int64_t | ElapsedMicroseconds ()=0 |
| Reports the elapsed time in microseconds. | |
| virtual int64_t | ElapsedNanoseconds ()=0 |
| Reports the elapsed time in nanoseconds. | |
| virtual void | AddNanoseconds (unsigned int time)=0 |
| Adds nanoseconds time to actual value. | |
Interface to manage time information.
+A manager for timing
+
+
|
+ +pure virtual | +
Adds nanoseconds time to actual value.
+Use to function to add time nanoseconds to current value
time the nanoseconds to be added
Implemented in SmartTimeMeasureWrapper.
+ +
+
|
+ +pure virtual | +
Reports the elapsed time in microseconds.
+Use to function to get the elapsed time in microseconds
+Implemented in SmartTimeMeasureWrapper.
+ +
+
|
+ +pure virtual | +
Reports the elapsed time in milliseconds.
+Use to function to get the elapsed time in milliseconds
+Implemented in SmartTimeMeasureWrapper.
+ +
+
|
+ +pure virtual | +
Reports the elapsed time in nanoseconds.
+Use to function to get the elapsed time in nanoseconds
+Implemented in SmartTimeMeasureWrapper.
+ +
+
|
+ +pure virtual | +
Reset the timer.
+Reset the timer information to zero
+ +Implemented in SmartTimeMeasureWrapper.
+ + 1.12.0 | + | +
This is the complete list of members for SmartDataDistribution< T >, including all inherited members.
+| ChangedState(DDM_INSTANCE_STATE actualState) | SmartDataDistributionBase | protectedvirtual |
| ChangingState(DDM_INSTANCE_STATE actualState, DDM_INSTANCE_STATE futureState) | SmartDataDistributionBase | protectedvirtual |
| CreateSmartChannel(const char *channelName, DDM_CHANNEL_DIRECTION direction=DDM_CHANNEL_DIRECTION::ALL, const char *arrayParams[]=NULL, int len=0) | SmartDataDistribution< T > | inline |
| FirstStateChange(DDM_INSTANCE_STATE newState) | SmartDataDistributionBase | protectedvirtual |
| GetMastershipLib() | SmartDataDistributionBase | |
| GetProtocol() | SmartDataDistributionBase | |
| GetProtocolLib() | SmartDataDistributionBase | |
| Initialize(const char *conf_file, const char *hostAddress=0, const char *channelTrailer=0) | SmartDataDistributionBase | |
| Initialize(const char *arrayParams[], int len, const char *hostAddress=0, const char *channelTrailer=0) | SmartDataDistributionBase | |
| m_pIDataDistribution | SmartDataDistributionBase | protected |
| m_pIDataDistributionMastershipCommon | SmartDataDistributionBase | protected |
| m_pInitializeHRESULT | SmartDataDistributionBase | protected |
| OnClusterStateChange(DDM_CLUSTEREVENT change, int64_t serverid) | SmartDataDistributionBase | protectedvirtual |
| OnCompletelyDisconnected(const char *channelName, const char *reason) | SmartDataDistributionBase | protectedvirtual |
| OnConfiguration(const char *channelName, const char *key, const char *value) | SmartDataDistributionBase | protectedvirtual |
| OnLogging(DDM_LOG_LEVEL level, const char *source, const char *function, const char *logStr) | SmartDataDistributionBase | protectedvirtual |
| OnMultiplePrimary(int64_t myId, int64_t otherId) | SmartDataDistributionBase | protectedvirtual |
| OnRequestedState(void **pState, size_t *len) | SmartDataDistributionBase | protectedvirtual |
| OnStateChange(DDM_INSTANCE_STATE newState, DDM_INSTANCE_STATE oldState) | SmartDataDistributionBase | protectedvirtual |
| OnStateReady(void *pState, int64_t len) | SmartDataDistributionBase | protectedvirtual |
| RequestMastershipManager(const char *hostAddress=NULL, const char *arrayParams[]=NULL, int len=0) | SmartDataDistributionBase | |
| SmartDataDistribution() | SmartDataDistribution< T > | inline |
| SmartDataDistributionBase() | SmartDataDistributionBase | |
| Start(unsigned long timeout) | SmartDataDistributionBase | |
| Stop(unsigned long timeout) | SmartDataDistributionBase | |
| ~SmartDataDistribution() | SmartDataDistribution< T > | inline |
| ~SmartDataDistributionBase() | SmartDataDistributionBase |
1.12.0 | + | +
Smart class to manage DataDistribution. + More...
+ +#include <SmartDataDistributionManager.h>
+
++Public Member Functions | |
| SmartDataDistribution () | |
| Initialize a new SmartDataDistribution. | |
| ~SmartDataDistribution () | |
| Destructor of SmartDataDistribution. | |
| T * | CreateSmartChannel (const char *channelName, DDM_CHANNEL_DIRECTION direction=DDM_CHANNEL_DIRECTION::ALL, const char *arrayParams[]=NULL, int len=0) |
| Creates a new smart channel. | |
| Public Member Functions inherited from SmartDataDistributionBase | |
| SmartDataDistributionBase () | |
| Initialize a new SmartDataDistributionBase. | |
| ~SmartDataDistributionBase () | |
| Destructor of SmartDataDistributionBase. | |
| OPERATION_RESULT | Initialize (const char *conf_file, const char *hostAddress=0, const char *channelTrailer=0) |
| Initialize SmartDataDistributionBase system. | |
| OPERATION_RESULT | Initialize (const char *arrayParams[], int len, const char *hostAddress=0, const char *channelTrailer=0) |
| Initialize IDataDistribution instance. | |
| OPERATION_RESULT | RequestMastershipManager (const char *hostAddress=NULL, const char *arrayParams[]=NULL, int len=0) |
| Allocate and initialize the mastership manager. | |
| BOOL | Start (unsigned long timeout) |
| Start the common manager. | |
| BOOL | Stop (unsigned long timeout) |
| Stop the common manager. | |
| std::string | GetProtocol () |
| Returns the protocol in use from IDataDistribution instance. | |
| std::string | GetProtocolLib () |
| Returns the protocol library in use from IDataDistribution instance. | |
| std::string | GetMastershipLib () |
| Returns the mastership library in use from IDataDistribution instance. | |
+Additional Inherited Members | |
| Protected Member Functions inherited from SmartDataDistributionBase | |
| virtual const char * | OnConfiguration (const char *channelName, const char *key, const char *value) |
| Function invoked during configuration validation. | |
| virtual void | OnLogging (DDM_LOG_LEVEL level, const char *source, const char *function, const char *logStr) |
| Function invoked when a log is emitted from subsystem. | |
| virtual void | OnCompletelyDisconnected (const char *channelName, const char *reason) |
| Callback invoked on a complete disconnection. | |
| virtual void | OnClusterStateChange (DDM_CLUSTEREVENT change, int64_t serverid) |
| Callback invoked to report cluster state change. | |
| virtual void | OnStateChange (DDM_INSTANCE_STATE newState, DDM_INSTANCE_STATE oldState) |
| Callback invoked to report a state change. | |
| virtual void | OnStateReady (void *pState, int64_t len) |
| Callback invoked when a state transfer is completed. | |
| virtual void | OnRequestedState (void **pState, size_t *len) |
| Callback invoked when a state transfer is requested. | |
| virtual void | OnMultiplePrimary (int64_t myId, int64_t otherId) |
| Callback invoked when multiple primary server are detected. | |
| virtual void | FirstStateChange (DDM_INSTANCE_STATE newState) |
| Callback invoked to report a first state change. | |
| virtual void | ChangingState (DDM_INSTANCE_STATE actualState, DDM_INSTANCE_STATE futureState) |
| Callback invoked to report a starting instance state change. | |
| virtual void | ChangedState (DDM_INSTANCE_STATE actualState) |
| Callback invoked to report a finished instance state change. | |
| Protected Member Functions inherited from IDataDistributionCallback | |
| Protected Member Functions inherited from IDataDistributionMastershipCallback | |
| Protected Attributes inherited from SmartDataDistributionBase | |
| IDataDistribution * | m_pIDataDistribution |
| IDataDistributionMastershipCommon * | m_pIDataDistributionMastershipCommon |
| OPERATION_RESULT | m_pInitializeHRESULT |
Smart class to manage DataDistribution.
+| T | The class inherited from SmartDataDistributionChannel |
+
|
+ +inline | +
Initialize a new SmartDataDistribution.
+ +
+
|
+ +inline | +
Destructor of SmartDataDistribution.
+ +
+
|
+ +inline | +
Creates a new smart channel.
+channelName the name of the channel direction DDM_CHANNEL_DIRECTION direction, default is DDM_CHANNEL_DIRECTION::ALL arrayParams an array of string in the form key=value to override parameters passed into IDataDistribution::Initialize len length of arrayParams
1.12.0 | + | +
This is the complete list of members for SmartDataDistributionBase, including all inherited members.
+| ChangedState(DDM_INSTANCE_STATE actualState) | SmartDataDistributionBase | protectedvirtual |
| ChangingState(DDM_INSTANCE_STATE actualState, DDM_INSTANCE_STATE futureState) | SmartDataDistributionBase | protectedvirtual |
| FirstStateChange(DDM_INSTANCE_STATE newState) | SmartDataDistributionBase | protectedvirtual |
| GetMastershipLib() | SmartDataDistributionBase | |
| GetProtocol() | SmartDataDistributionBase | |
| GetProtocolLib() | SmartDataDistributionBase | |
| Initialize(const char *conf_file, const char *hostAddress=0, const char *channelTrailer=0) | SmartDataDistributionBase | |
| Initialize(const char *arrayParams[], int len, const char *hostAddress=0, const char *channelTrailer=0) | SmartDataDistributionBase | |
| m_pIDataDistribution | SmartDataDistributionBase | protected |
| m_pIDataDistributionMastershipCommon | SmartDataDistributionBase | protected |
| m_pInitializeHRESULT | SmartDataDistributionBase | protected |
| OnClusterStateChange(DDM_CLUSTEREVENT change, int64_t serverid) | SmartDataDistributionBase | protectedvirtual |
| OnCompletelyDisconnected(const char *channelName, const char *reason) | SmartDataDistributionBase | protectedvirtual |
| OnConfiguration(const char *channelName, const char *key, const char *value) | SmartDataDistributionBase | protectedvirtual |
| OnLogging(DDM_LOG_LEVEL level, const char *source, const char *function, const char *logStr) | SmartDataDistributionBase | protectedvirtual |
| OnMultiplePrimary(int64_t myId, int64_t otherId) | SmartDataDistributionBase | protectedvirtual |
| OnRequestedState(void **pState, size_t *len) | SmartDataDistributionBase | protectedvirtual |
| OnStateChange(DDM_INSTANCE_STATE newState, DDM_INSTANCE_STATE oldState) | SmartDataDistributionBase | protectedvirtual |
| OnStateReady(void *pState, int64_t len) | SmartDataDistributionBase | protectedvirtual |
| RequestMastershipManager(const char *hostAddress=NULL, const char *arrayParams[]=NULL, int len=0) | SmartDataDistributionBase | |
| SmartDataDistributionBase() | SmartDataDistributionBase | |
| Start(unsigned long timeout) | SmartDataDistributionBase | |
| Stop(unsigned long timeout) | SmartDataDistributionBase | |
| ~SmartDataDistributionBase() | SmartDataDistributionBase |
1.12.0 | + | +
Smart class to manage IDataDistributionCallback and IDataDistributionMastershipCallback. + More...
+ +#include <SmartDataDistributionManager.h>
+
++Public Member Functions | |
| SmartDataDistributionBase () | |
| Initialize a new SmartDataDistributionBase. | |
| ~SmartDataDistributionBase () | |
| Destructor of SmartDataDistributionBase. | |
| OPERATION_RESULT | Initialize (const char *conf_file, const char *hostAddress=0, const char *channelTrailer=0) |
| Initialize SmartDataDistributionBase system. | |
| OPERATION_RESULT | Initialize (const char *arrayParams[], int len, const char *hostAddress=0, const char *channelTrailer=0) |
| Initialize IDataDistribution instance. | |
| OPERATION_RESULT | RequestMastershipManager (const char *hostAddress=NULL, const char *arrayParams[]=NULL, int len=0) |
| Allocate and initialize the mastership manager. | |
| BOOL | Start (unsigned long timeout) |
| Start the common manager. | |
| BOOL | Stop (unsigned long timeout) |
| Stop the common manager. | |
| std::string | GetProtocol () |
| Returns the protocol in use from IDataDistribution instance. | |
| std::string | GetProtocolLib () |
| Returns the protocol library in use from IDataDistribution instance. | |
| std::string | GetMastershipLib () |
| Returns the mastership library in use from IDataDistribution instance. | |
+Protected Member Functions | |
| virtual const char * | OnConfiguration (const char *channelName, const char *key, const char *value) |
| Function invoked during configuration validation. | |
| virtual void | OnLogging (DDM_LOG_LEVEL level, const char *source, const char *function, const char *logStr) |
| Function invoked when a log is emitted from subsystem. | |
| virtual void | OnCompletelyDisconnected (const char *channelName, const char *reason) |
| Callback invoked on a complete disconnection. | |
| virtual void | OnClusterStateChange (DDM_CLUSTEREVENT change, int64_t serverid) |
| Callback invoked to report cluster state change. | |
| virtual void | OnStateChange (DDM_INSTANCE_STATE newState, DDM_INSTANCE_STATE oldState) |
| Callback invoked to report a state change. | |
| virtual void | OnStateReady (void *pState, int64_t len) |
| Callback invoked when a state transfer is completed. | |
| virtual void | OnRequestedState (void **pState, size_t *len) |
| Callback invoked when a state transfer is requested. | |
| virtual void | OnMultiplePrimary (int64_t myId, int64_t otherId) |
| Callback invoked when multiple primary server are detected. | |
| virtual void | FirstStateChange (DDM_INSTANCE_STATE newState) |
| Callback invoked to report a first state change. | |
| virtual void | ChangingState (DDM_INSTANCE_STATE actualState, DDM_INSTANCE_STATE futureState) |
| Callback invoked to report a starting instance state change. | |
| virtual void | ChangedState (DDM_INSTANCE_STATE actualState) |
| Callback invoked to report a finished instance state change. | |
| Protected Member Functions inherited from IDataDistributionCallback | |
| Protected Member Functions inherited from IDataDistributionMastershipCallback | |
+Protected Attributes | |
| IDataDistribution * | m_pIDataDistribution |
| IDataDistributionMastershipCommon * | m_pIDataDistributionMastershipCommon |
| OPERATION_RESULT | m_pInitializeHRESULT |
Smart class to manage IDataDistributionCallback and IDataDistributionMastershipCallback.
+The main class to manage Data Distribution
+| SmartDataDistributionBase::SmartDataDistributionBase | +( | +) | ++ |
Initialize a new SmartDataDistributionBase.
+ +| SmartDataDistributionBase::~SmartDataDistributionBase | +( | +) | ++ |
Destructor of SmartDataDistributionBase.
+ +
+
|
+ +protectedvirtual | +
Callback invoked to report a finished instance state change.
+Callback invoked when subsystem needs to report a state change.
+actualState reports the actual DDM_INSTANCE_STATE state
Implements IDataDistributionMastershipCallback.
+ +
+
|
+ +protectedvirtual | +
Callback invoked to report a starting instance state change.
+Callback invoked when subsystem needs to report a state change.
+futureState reports the future DDM_INSTANCE_STATE state actualState reports the actual DDM_INSTANCE_STATE state
Implements IDataDistributionMastershipCallback.
+ +
+
|
+ +protectedvirtual | +
Callback invoked to report a first state change.
+Callback invoked when subsystem needs to to report a first state change
+newState DDM_INSTANCE_STATE state
Implements IDataDistributionMastershipCallback.
+ +| std::string SmartDataDistributionBase::GetMastershipLib | +( | +) | ++ |
Returns the mastership library in use from IDataDistribution instance.
+| std::string SmartDataDistributionBase::GetProtocol | +( | +) | ++ |
Returns the protocol in use from IDataDistribution instance.
+| std::string SmartDataDistributionBase::GetProtocolLib | +( | +) | ++ |
Returns the protocol library in use from IDataDistribution instance.
+| OPERATION_RESULT SmartDataDistributionBase::Initialize | +( | +const char * | arrayParams[], | +
| + | + | int | len, | +
| + | + | const char * | hostAddress = 0, | +
| + | + | const char * | channelTrailer = 0 ) | +
Initialize IDataDistribution instance.
+arrayParams an array of string in the form key=value len length of arrayParams hostAddress optional host address or host name channelTrailer the optional trailer to be appended to channel name when each channel is created
| OPERATION_RESULT SmartDataDistributionBase::Initialize | +( | +const char * | conf_file, | +
| + | + | const char * | hostAddress = 0, | +
| + | + | const char * | channelTrailer = 0 ) | +
Initialize SmartDataDistributionBase system.
+conf_file the external ASCII configuration file with lines written as key=value hostAddress optional host address or host name channelTrailer the optional trailer to be appended to channel name when each channel is created
+
|
+ +protectedvirtual | +
Callback invoked to report cluster state change.
+Callback invoked when subsystem needs to report a cluster state change.
+change reports the DDM_CLUSTEREVENT event serverid the server id reporting the change
Implements IDataDistributionMastershipCallback.
+ +
+
|
+ +protectedvirtual | +
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.
Implements IDataDistributionCallback.
+ +
+
|
+ +protectedvirtual | +
Function 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.
value if no change is needed, otherwise any new string value according to the expected parameter type Implements IDataDistributionCallback.
+ +
+
|
+ +protectedvirtual | +
Function 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
Implements IDataDistributionCallback.
+ +
+
|
+ +protectedvirtual | +
Callback invoked when multiple primary server are detected.
+Callback invoked when subsystem needs to report there are multiple primary server are detected
+myId my primary identifier otherId other primary identifier
Implements IDataDistributionMastershipCallback.
+ +
+
|
+ +protectedvirtual | +
Callback invoked when a state transfer is requested.
+Callback invoked when subsystem needs to request a state transfer. Fill pState and len with state information
pState pointer to the buffer of the state len the length of the buffer
Implements IDataDistributionMastershipCallback.
+ +
+
|
+ +protectedvirtual | +
Callback invoked to report a state change.
+Callback invoked when subsystem needs to report a state change.
+newState reports the new DDM_INSTANCE_STATE state oldState reports the new DDM_INSTANCE_STATE state
Implements IDataDistributionMastershipCallback.
+ +
+
|
+ +protectedvirtual | +
Callback invoked when a state transfer is completed.
+Callback invoked when subsystem needs to report a completed state transfer
+pState pointer to the buffer of the state len the length of the buffer
Implements IDataDistributionMastershipCallback.
+ +| OPERATION_RESULT SmartDataDistributionBase::RequestMastershipManager | +( | +const char * | hostAddress = NULL, | +
| + | + | const char * | arrayParams[] = NULL, | +
| + | + | int | len = 0 ) | +
Allocate and initialize the mastership manager.
+hostAddress optional host address or host name arrayParams an array of string in the form key=value len length of arrayParams
| BOOL SmartDataDistributionBase::Start | +( | +unsigned long | timeout | ) | ++ |
Start the common manager.
+timeout the operation timeout in milliseconds
| BOOL SmartDataDistributionBase::Stop | +( | +unsigned long | timeout | ) | ++ |
Stop the common manager.
+timeout the operation timeout in milliseconds
+
|
+ +protected | +
+
|
+ +protected | +
+
|
+ +protected | +
1.12.0 | + | +
This is the complete list of members for SmartDataDistributionChannel, including all inherited members.
+| ChangeChannelDirection(DDM_CHANNEL_DIRECTION direction) | SmartDataDistributionChannel | |
| GetChannelName() | SmartDataDistributionChannel | |
| GetDirection() | SmartDataDistributionChannel | |
| GetOffset() | SmartDataDistributionChannel | |
| GetTimestamp() | SmartDataDistributionChannel | |
| Lock(unsigned long timeout) | SmartDataDistributionChannel | |
| OnConditionOrError(const OPERATION_RESULT errorCode, const int nativeCode, const char *subSystemReason) | SmartDataDistributionChannel | virtual |
| OnConditionOrError(const OPERATION_RESULT errorCode, const int nativeCode, const std::string subSystemReason) | SmartDataDistributionChannel | virtual |
| OnDataAvailable(const char *key, size_t keyLen, const void *buffer, const size_t len) | SmartDataDistributionChannel | virtual |
| OnDataAvailable(const std::string key, const void *buffer, const size_t len) | SmartDataDistributionChannel | virtual |
| OnUnderlyingEvent(const CHANNEL_HANDLE_PARAMETER, const UnderlyingEventData *uEvent) | SmartDataDistributionChannel | protectedvirtual |
| ReadFromChannel(int64_t offset, size_t *dataLen, void **buffer) | SmartDataDistributionChannel | |
| SeekChannel(int64_t position) | SmartDataDistributionChannel | |
| SetInformation(const char *channelName, IDataDistributionChannelBase *pIDataDistributionChannelBase, CHANNEL_HANDLE_PARAMETER, DDM_CHANNEL_DIRECTION direction) | SmartDataDistributionChannel | |
| SmartDataDistributionChannel() | SmartDataDistributionChannel | |
| StartChannel(unsigned long timeout) | SmartDataDistributionChannel | |
| StopChannel(unsigned long timeout) | SmartDataDistributionChannel | |
| Unlock() | SmartDataDistributionChannel | |
| WriteOnChannel(const char *key, size_t keyLen, void *buffer, size_t bufferLen, const BOOL waitAll=FALSE, const int64_t timestamp=DDM_NO_TIMESTAMP) | SmartDataDistributionChannel | |
| ~SmartDataDistributionChannel() | SmartDataDistributionChannel | protected |
1.12.0 | + | +
Smart class to manage IDataDistributionChannelCallback. + More...
+ +#include <SmartDataDistributionManager.h>
+
++Public Member Functions | |
| SmartDataDistributionChannel () | |
| Initialize a new SmartDataDistributionChannel. | |
| DDM_CHANNEL_DIRECTION | GetDirection () |
| Returns the DDM_CHANNEL_DIRECTION channel direction. | |
| void | SetInformation (const char *channelName, IDataDistributionChannelBase *pIDataDistributionChannelBase, CHANNEL_HANDLE_PARAMETER, DDM_CHANNEL_DIRECTION direction) |
| Sets information on SmartDataDistributionChannel. | |
| OPERATION_RESULT | StartChannel (unsigned long timeout) |
| Starts the channel. | |
| OPERATION_RESULT | StopChannel (unsigned long timeout) |
| Stops the channel. | |
| OPERATION_RESULT | Lock (unsigned long timeout) |
| Locks the channel. | |
| OPERATION_RESULT | Unlock () |
| Unlock the channel. | |
| OPERATION_RESULT | SeekChannel (int64_t position) |
| Seeks the channel. | |
| OPERATION_RESULT | WriteOnChannel (const char *key, size_t keyLen, void *buffer, size_t bufferLen, const BOOL waitAll=FALSE, const int64_t timestamp=DDM_NO_TIMESTAMP) |
| Writes data on the channel. | |
| OPERATION_RESULT | ReadFromChannel (int64_t offset, size_t *dataLen, void **buffer) |
| Reads data from the channel. | |
| OPERATION_RESULT | ChangeChannelDirection (DDM_CHANNEL_DIRECTION direction) |
| Change the DDM_CHANNEL_DIRECTION of the channel. | |
| const char * | GetChannelName () |
| Returns the channel name. | |
| int64_t | GetTimestamp () |
| Returns the timestamp. | |
| int64_t | GetOffset () |
| Returns the actual channel offset. | |
| virtual void | OnDataAvailable (const char *key, size_t keyLen, const void *buffer, const size_t len) |
| Function to override to receive data available. | |
| virtual void | OnDataAvailable (const std::string key, const void *buffer, const size_t len) |
| Function to override to receive data available. | |
| virtual void | OnConditionOrError (const OPERATION_RESULT errorCode, const int nativeCode, const char *subSystemReason) |
| Function to override to receive condition or error. | |
| virtual void | OnConditionOrError (const OPERATION_RESULT errorCode, const int nativeCode, const std::string subSystemReason) |
| Function to override to receive condition or error. | |
+Protected Member Functions | |
| ~SmartDataDistributionChannel () | |
| Destructor of SmartDataDistributionChannel. | |
| virtual void | OnUnderlyingEvent (const CHANNEL_HANDLE_PARAMETER, const UnderlyingEventData *uEvent) |
| Function to override to receive UnderlyingEventData. | |
| Protected Member Functions inherited from IDataDistributionChannelCallback | |
Smart class to manage IDataDistributionChannelCallback.
+A smart manager for channels
+| SmartDataDistributionChannel::SmartDataDistributionChannel | +( | +) | ++ |
Initialize a new SmartDataDistributionChannel.
+ +
+
|
+ +protected | +
Destructor of SmartDataDistributionChannel.
+ +| OPERATION_RESULT SmartDataDistributionChannel::ChangeChannelDirection | +( | +DDM_CHANNEL_DIRECTION | direction | ) | ++ |
Change the DDM_CHANNEL_DIRECTION of the channel.
+direction DDM_CHANNEL_DIRECTION direction
| const char * SmartDataDistributionChannel::GetChannelName | +( | +) | ++ |
Returns the channel name.
+| DDM_CHANNEL_DIRECTION SmartDataDistributionChannel::GetDirection | +( | +) | ++ |
Returns the DDM_CHANNEL_DIRECTION channel direction.
+ +| int64_t SmartDataDistributionChannel::GetOffset | +( | +) | ++ |
Returns the actual channel offset.
+| int64_t SmartDataDistributionChannel::GetTimestamp | +( | +) | ++ |
Returns the timestamp.
+| OPERATION_RESULT SmartDataDistributionChannel::Lock | +( | +unsigned long | timeout | ) | ++ |
Locks the channel.
+timeout the operation timeout in milliseconds
+
|
+ +virtual | +
Function to override to receive condition or error.
+errorCode the DDM_UNDERLYING_ERROR_CONDITION error or condition nativeCode the native code from transport subsystem subSystemReason reason from transport subsystem
+
|
+ +virtual | +
Function to override to receive condition or error.
+errorCode the DDM_UNDERLYING_ERROR_CONDITION error or condition nativeCode the native code from transport subsystem subSystemReason reason from transport subsystem
+
|
+ +virtual | +
Function to override to receive data available.
+key the key of the message, NULL if the key was omitted in transmission keyLen the length of key buffer the data buffer received len the length of the buffer timestamp The timestamp associated to the data: Milliseconds since epoch (UTC). offset The offset associated to the data
+
|
+ +virtual | +
Function to override to receive data available.
+key the key of the message, NULL if the key was omitted in transmission buffer the data buffer received len the length of the buffer timestamp The timestamp associated to the data: Milliseconds since epoch (UTC). offset The offset associated to the data
+
|
+ +protectedvirtual | +
Function to override to receive UnderlyingEventData.
+channelHandle the CHANNEL_HANDLE of the channel uEvent the UnderlyingEventData received from transport subsystem
Implements IDataDistributionChannelCallback.
+ +| OPERATION_RESULT SmartDataDistributionChannel::ReadFromChannel | +( | +int64_t | offset, | +
| + | + | size_t * | dataLen, | +
| + | + | void ** | buffer ) | +
Reads data from the channel.
+offset offset to read info from dataLen pointer will receive length of data read buffer the buffer to receive data from the channel, it cannot be NULL
| OPERATION_RESULT SmartDataDistributionChannel::SeekChannel | +( | +int64_t | position | ) | ++ |
Seeks the channel.
+position the new channel position
| void SmartDataDistributionChannel::SetInformation | +( | +const char * | channelName, | +
| + | + | IDataDistributionChannelBase * | pIDataDistributionChannelBase, | +
| + | + | CHANNEL_HANDLE_PARAMETER | , | +
| + | + | DDM_CHANNEL_DIRECTION | direction ) | +
Sets information on SmartDataDistributionChannel.
+channelName the channel name pIDataDistributionChannelBase pointer to IDataDistributionChannelBase instance channelHandle the CHANNEL_HANDLE to the channel direction DDM_CHANNEL_DIRECTION direction
| OPERATION_RESULT SmartDataDistributionChannel::StartChannel | +( | +unsigned long | timeout | ) | ++ |
Starts the channel.
+timeout the operation timeout in milliseconds
| OPERATION_RESULT SmartDataDistributionChannel::StopChannel | +( | +unsigned long | timeout | ) | ++ |
Stops the channel.
+timeout the operation timeout in milliseconds
| OPERATION_RESULT SmartDataDistributionChannel::Unlock | +( | +) | ++ |
Unlock the channel.
+| OPERATION_RESULT SmartDataDistributionChannel::WriteOnChannel | +( | +const char * | key, | +
| + | + | size_t | keyLen, | +
| + | + | void * | buffer, | +
| + | + | size_t | bufferLen, | +
| + | + | const BOOL | waitAll = FALSE, | +
| + | + | const int64_t | timestamp = DDM_NO_TIMESTAMP ) | +
Writes data on the channel.
+key the key of the message to write, it can be NULL keyLen the length of the key buffer the buffer to write on the channel, it cannot be NULL bufferLen the length of the buffer to write waitAll set to TRUE to wait a complete message dispatch, default is FALSE.
timestamp a timestamp associable to the message, default is DDM_NO_TIMESTAMP and means no timestamp written 1.12.0 | + | +
This is the complete list of members for SmartTimeMeasureWrapper, including all inherited members.
+| AddNanoseconds(unsigned int time) | SmartTimeMeasureWrapper | virtual |
| ElapsedMicroseconds() | SmartTimeMeasureWrapper | virtual |
| ElapsedMilliseconds() | SmartTimeMeasureWrapper | virtual |
| ElapsedNanoseconds() | SmartTimeMeasureWrapper | virtual |
| ResetTime() | SmartTimeMeasureWrapper | virtual |
| SmartTimeMeasureWrapper() | SmartTimeMeasureWrapper | |
| ~SmartTimeMeasureWrapper() | SmartTimeMeasureWrapper |
1.12.0 | + | +
Smart class to manage ITimeMeasureWrapper. + More...
+ +#include <SmartDataDistributionManager.h>
+
++Public Member Functions | |
| SmartTimeMeasureWrapper () | |
| Initialize a new SmartTimeMeasureWrapper. | |
| ~SmartTimeMeasureWrapper () | |
| Destructor of SmartTimeMeasureWrapper. | |
| void | ResetTime () |
| Reset the timer. | |
| int64_t | ElapsedMilliseconds () |
| Reports the elapsed time in milliseconds. | |
| int64_t | ElapsedMicroseconds () |
| Reports the elapsed time in microseconds. | |
| int64_t | ElapsedNanoseconds () |
| Reports the elapsed time in nanoseconds. | |
| void | AddNanoseconds (unsigned int time) |
| Adds nanoseconds time to actual value. | |
| Public Member Functions inherited from ITimeMeasureWrapper | |
Smart class to manage ITimeMeasureWrapper.
+A smart manager for timing
+| SmartTimeMeasureWrapper::SmartTimeMeasureWrapper | +( | +) | ++ |
Initialize a new SmartTimeMeasureWrapper.
+ +| SmartTimeMeasureWrapper::~SmartTimeMeasureWrapper | +( | +) | ++ |
Destructor of SmartTimeMeasureWrapper.
+ +
+
|
+ +virtual | +
Adds nanoseconds time to actual value.
+Use to function to add time nanoseconds to current value
time the nanoseconds to be added
Implements ITimeMeasureWrapper.
+ +
+
|
+ +virtual | +
Reports the elapsed time in microseconds.
+Use to function to get the elapsed time in microseconds
+Implements ITimeMeasureWrapper.
+ +
+
|
+ +virtual | +
Reports the elapsed time in milliseconds.
+Use to function to get the elapsed time in milliseconds
+Implements ITimeMeasureWrapper.
+ +
+
|
+ +virtual | +
Reports the elapsed time in nanoseconds.
+Use to function to get the elapsed time in nanoseconds
+Implements ITimeMeasureWrapper.
+ +
+
|
+ +virtual | +
1.12.0 | + | +
This is the complete list of members for TimeMeasureWrapper, including all inherited members.
+| create() | TimeMeasureWrapper | static |
1.12.0 | + | +
Class to allocate an ITimeMeasureWrapper. + More...
+ +#include <DataDistributionManager.h>
+Static Public Member Functions | |
| static ITimeMeasureWrapper * | create () |
| Creates a new ITimeMeasureWrapper instance. | |
Class to allocate an ITimeMeasureWrapper.
+Class to allocate an ITimeMeasureWrapper
+
+
|
+ +static | +
Creates a new ITimeMeasureWrapper instance.
+ 1.12.0 | + | +
1.12.0 | + | +
+Directories | |
| DataDistributionManager | |
1.12.0 | + | +
+Files | |
| DataDistributionManager.h | |
| DataDistributionManager library. | |
| DataDistributionManagerEnums.h | |
| DataDistributionManager library. | |
| DataDistributionManagerTypes.h | |
| DataDistributionManager library. | |
| SmartDataDistributionManager.h | |
| DataDistributionManager library. | |
1.12.0