UnderlyingEventData Struct Reference

Class to reports information from transport subsystem. More...

#include <DataDistributionManager.h>

Public Member Functions
	UnderlyingEventData (const char *channelName)
	Initialize a new UnderlyingEventData.
	UnderlyingEventData (const char *channelName, const char *key, size_t keyLen, const void *buffer, size_t bufferLength, int64_t timestamp=-1, int64_t offset=-1)
	Initialize a new UnderlyingEventData to reports data.
	UnderlyingEventData (const char *channelName, OPERATION_RESULT condition, int nativeCode, const char *subSystemReason)
	Initialize a new UnderlyingEventData to reports errors or conditions.

Public Attributes
const char *	ChannelName
BOOL	IsDataAvailable
int64_t	Offset
int64_t	Timestamp
const char *	Key
size_t	KeyLen
const void *	Buffer
size_t	BufferLength
OPERATION_RESULT	Condition
int	NativeCode
const char *	SubSystemReason

Detailed Description

Class to reports information from transport subsystem.

This class allocates an UnderlyingEventData with information from subsystem

Constructor & Destructor Documentation

UnderlyingEventData() [1/3]

UnderlyingEventData::UnderlyingEventData ( const char *  channelName )

inline

Initialize a new UnderlyingEventData.

channelName The channel name reporting UnderlyingEventData

Remarks

it used internally

Initialize a new UnderlyingEventData

UnderlyingEventData() [2/3]

UnderlyingEventData::UnderlyingEventData ( const char *  channelName, const char *  key, size_t  keyLen, const void *  buffer, size_t  bufferLength, int64_t  timestamp = -1, int64_t  offset = -1  )

inline

Initialize a new UnderlyingEventData to reports data.

Initialize a new UnderlyingEventData

channelName The channel name reporting UnderlyingEventData key the key associated to the message received keyLen of the key associated to the message received buffer the buffer associated to the message received bufferLength of the buffer associated to the message received timestamp The timestamp associated to the data: Milliseconds since epoch (UTC). offset The offset associated to the data

Remarks

it used internally

UnderlyingEventData() [3/3]

UnderlyingEventData::UnderlyingEventData ( const char *  channelName, OPERATION_RESULT  condition, int  nativeCode, const char *  subSystemReason  )

inline

Initialize a new UnderlyingEventData to reports errors or conditions.

Initialize a new UnderlyingEventData

channelName The channel name reporting UnderlyingEventData condition the OPERATION_RESULT reported nativeCode Native code from subsystem associated to condition subSystemReason string reason from subsystem associated to nativeCode

Remarks

it used internally

Member Data Documentation

Buffer

const void* UnderlyingEventData::Buffer

The buffer of the message associated to UnderlyingEventData.

Remarks

Valid only if IsDataAvailable is TRUE

BufferLength

size_t UnderlyingEventData::BufferLength

The length of the Buffer associated to UnderlyingEventData.

Remarks

Valid only if IsDataAvailable is TRUE

ChannelName

const char* UnderlyingEventData::ChannelName

Channel name associated to UnderlyingEventData

Condition

OPERATION_RESULT UnderlyingEventData::Condition

OPERATION_RESULT associated to UnderlyingEventData.

Remarks

Valid only if IsDataAvailable is FALSE

IsDataAvailable

BOOL UnderlyingEventData::IsDataAvailable

TRUE if data are available, otherwise FALSE

Key

const char* UnderlyingEventData::Key

The key of the message associated to UnderlyingEventData.

Remarks

Valid only if IsDataAvailable is TRUE

KeyLen

size_t UnderlyingEventData::KeyLen

The length of Key associated to UnderlyingEventData.

Remarks

Valid only if IsDataAvailable is TRUE

NativeCode

int UnderlyingEventData::NativeCode

Native code from subsystem associated to Condition of UnderlyingEventData.

Remarks

Valid only if IsDataAvailable is TRUE

Offset

int64_t UnderlyingEventData::Offset

The offset associated to the data

SubSystemReason

const char* UnderlyingEventData::SubSystemReason

String reason from subsystem associated to NativeCode of UnderlyingEventData.

Remarks

Valid only if IsDataAvailable is TRUE

Timestamp

int64_t UnderlyingEventData::Timestamp

The timestamp associated to the data: Milliseconds since epoch (UTC).

---

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

• D:/a/DataDistributionManager/DataDistributionManager/src/DataDistributionManager/DataDistributionManager.h