DataBlockReason Struct Reference

#include <DataBlock.h>

Collaboration diagram for DataBlockReason:

Public Member Functions
	DataBlockReason (int code=kDataBlockReason_NormalPoll, int session=-1, ReplicaObject *object=0)

Public Attributes
int	mReasonCode
int	mSessionReference
DynamicMessageHelper *	mMessageHelper
ReplicaObject *	mObserver
SysTimeType	mFloatValue
SysTimeType	mFloatTime
SysTimeType	mFloatLocalTime

Detailed Description

A parameter block that is used to pass state information to a DataBlock

Constructor & Destructor Documentation

DataBlockReason ( int  code = kDataBlockReason_NormalPoll, int  session = -1, ReplicaObject *  object = 0  )

inline

This structure ctor sets a reason code by default if none is passed in

Parameters

code	The reason code to use,kDataBlockReason_NormalPoll by default
session	The session ID to set in the data block, -1 by default

References DataBlockReason::mFloatValue, DataBlockReason::mObserver, DataBlockReason::mReasonCode, and DataBlockReason::mSessionReference.

Member Data Documentation

SysTimeType mFloatValue

A general purpose value that is dependant on the reason code

Referenced by DataBlockReason::DataBlockReason().

DynamicMessageHelper* mMessageHelper

The message helper for this data block

ReplicaObject* mObserver

A reference to the observer object for this session reference

Referenced by DataBlockReason::DataBlockReason().

int mReasonCode

The reason code

Referenced by DataBlockReason::DataBlockReason().

int mSessionReference

The reference session ID

Referenced by DataBlockReason::DataBlockReason().