DataDistributionManagerTypes.h File Reference

DataDistributionManager library. More...

#include "DataDistributionManagerEnums.h"

Go to the source code of this file.

Macros
#define	DDM_NO_TIMESTAMP   -1
	Definition to avoid timestamp on write.
#define	CHANNEL_HANDLE   IDataDistributionChannel*
	Channel handle definition.
#define	CHANNEL_HANDLE_PARAMETER   CHANNEL_HANDLE channelHandle
	Channel handle parameter definition.
#define	OPERATION_SUCCEEDED(or)
	Check if operation succeeded.
#define	OPERATION_FAILED(or)
	Check if operation failed.
#define	DDM_NO_ERROR_CONDITION   0
#define	DDM_DATA_AVAILABLE   0x20000000
#define	DDM_END_OF_STREAM   DDM_DATA_AVAILABLE + 1
#define	DDM_NO_DATA_RETURNED   DDM_DATA_AVAILABLE + 2
#define	DDM_ELAPSED_MESSAGE_RECEIVE_TIMEOUT_BEGIN   DDM_DATA_AVAILABLE + 3
#define	DDM_ELAPSED_MESSAGE_RECEIVE_TIMEOUT_END   DDM_DATA_AVAILABLE + 4
#define	DDM_ELAPSED_MESSAGE_ACKNOWLEDGMENT_TIMEOUT   DDM_DATA_AVAILABLE + 5
#define	DDM_UNMAPPED_ERROR_CONDITION   0xF0000000
#define	DDM_FATAL_ERROR   DDM_UNMAPPED_ERROR_CONDITION + 1
#define	DDM_TIMEOUT   DDM_UNMAPPED_ERROR_CONDITION + 2
#define	DDM_INVALID_DATA   DDM_UNMAPPED_ERROR_CONDITION + 3
#define	DDM_SUBSYSTEM_NOT_STARTED   DDM_UNMAPPED_ERROR_CONDITION + 4
#define	DDM_WRITE_FAILED   DDM_UNMAPPED_ERROR_CONDITION + 5
#define	DDM_COMMIT_FAILED   DDM_UNMAPPED_ERROR_CONDITION + 6
#define	DDM_POINTER_NOT_SET   DDM_UNMAPPED_ERROR_CONDITION + 7
#define	DDM_NOT_IMPLEMENTED   DDM_UNMAPPED_ERROR_CONDITION + 8
#define	DDM_PARAMETER_ERROR   DDM_UNMAPPED_ERROR_CONDITION + 9
#define	DDM_SEEK_FAILED   DDM_UNMAPPED_ERROR_CONDITION + 10

Typedefs
typedef void *	GENERIC_HANDLE
	Generic handle definition, used for thread, lock, mutex.
typedef long	OPERATION_RESULT
	OPERATION_RESULT type.

Detailed Description

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.

Macro Definition Documentation

CHANNEL_HANDLE

#define CHANNEL_HANDLE   IDataDistributionChannel*

Channel handle definition.

CHANNEL_HANDLE_PARAMETER

#define CHANNEL_HANDLE_PARAMETER   CHANNEL_HANDLE channelHandle

Channel handle parameter definition.

DDM_COMMIT_FAILED

#define DDM_COMMIT_FAILED   DDM_UNMAPPED_ERROR_CONDITION + 6

Commit failed

DDM_DATA_AVAILABLE

#define DDM_DATA_AVAILABLE   0x20000000

Data are available

DDM_ELAPSED_MESSAGE_ACKNOWLEDGMENT_TIMEOUT

#define DDM_ELAPSED_MESSAGE_ACKNOWLEDGMENT_TIMEOUT   DDM_DATA_AVAILABLE + 5

Timeout on acknowledgment

DDM_ELAPSED_MESSAGE_RECEIVE_TIMEOUT_BEGIN

#define DDM_ELAPSED_MESSAGE_RECEIVE_TIMEOUT_BEGIN   DDM_DATA_AVAILABLE + 3

Timeout elapsed waiting for messages from the channel

DDM_ELAPSED_MESSAGE_RECEIVE_TIMEOUT_END

#define DDM_ELAPSED_MESSAGE_RECEIVE_TIMEOUT_END   DDM_DATA_AVAILABLE + 4

End timeout condition waiting for messages from the channel

DDM_END_OF_STREAM

#define DDM_END_OF_STREAM   DDM_DATA_AVAILABLE + 1

Reached end of stream

DDM_FATAL_ERROR

#define DDM_FATAL_ERROR   DDM_UNMAPPED_ERROR_CONDITION + 1

Fatal

DDM_INVALID_DATA

#define DDM_INVALID_DATA   DDM_UNMAPPED_ERROR_CONDITION + 3

Invalid data

DDM_NO_DATA_RETURNED

#define DDM_NO_DATA_RETURNED   DDM_DATA_AVAILABLE + 2

No data returned

DDM_NO_ERROR_CONDITION

#define DDM_NO_ERROR_CONDITION   0

No error

DDM_NO_TIMESTAMP

#define DDM_NO_TIMESTAMP   -1

Definition to avoid timestamp on write.

DDM_NOT_IMPLEMENTED

#define DDM_NOT_IMPLEMENTED   DDM_UNMAPPED_ERROR_CONDITION + 8

Function not implemented

DDM_PARAMETER_ERROR

#define DDM_PARAMETER_ERROR   DDM_UNMAPPED_ERROR_CONDITION + 9

Errors in parameters

DDM_POINTER_NOT_SET

#define DDM_POINTER_NOT_SET   DDM_UNMAPPED_ERROR_CONDITION + 7

Pointer not set within subsystem

DDM_SEEK_FAILED

#define DDM_SEEK_FAILED   DDM_UNMAPPED_ERROR_CONDITION + 10

Errors during seek operation

DDM_SUBSYSTEM_NOT_STARTED

#define DDM_SUBSYSTEM_NOT_STARTED   DDM_UNMAPPED_ERROR_CONDITION + 4

Subsystem not started

DDM_TIMEOUT

#define DDM_TIMEOUT   DDM_UNMAPPED_ERROR_CONDITION + 2

Timeout occurred

DDM_UNMAPPED_ERROR_CONDITION

#define DDM_UNMAPPED_ERROR_CONDITION   0xF0000000

Unmapped error

DDM_WRITE_FAILED

#define DDM_WRITE_FAILED   DDM_UNMAPPED_ERROR_CONDITION + 5

Failed on write

OPERATION_FAILED

#define OPERATION_FAILED

(

or

)

Value:

(((OPERATION_RESULT)(or)) < 0)

Check if operation failed.

OPERATION_SUCCEEDED

#define OPERATION_SUCCEEDED

(

or

)

Value:

(((OPERATION_RESULT)(or)) >= 0)

Check if operation succeeded.

Typedef Documentation

GENERIC_HANDLE

typedef void* GENERIC_HANDLE

Generic handle definition, used for thread, lock, mutex.

OPERATION_RESULT

typedef long OPERATION_RESULT

OPERATION_RESULT type.

Errors or conditions from underlying layer