class XxxLargeADT : public XxxADTClass

Generic large ADT

Inheritance:

Public Classes

class

XxxLargeADTEnv : public XxxADTEnv Environment variable class enum XxxLargeADTDisplayTypeEnum Determines the display type typedef enum XxxLargeADTDisplayTypeEnum XxxLargeADTDisplayType A typedef for easy reference static const char* const DISPLAY_TYPE The command referencing the next variable XxxLargeADTDisplayType DisplayType The desired display type XxxShoreVolumeId StorageVolume The volume on which the large ADTs store information XxxShoreObjectId StorageFile A file on the default volume which is persistent XxxShoreObjectId TemporaryFile A file on the default volume which is cleared after all Xacts end

Public Methods

virtual XxxErrCode	CreateEnv ( XxxADTEnv* &Env ) Creates an ADT environment
virtual XxxErrCode	DeleteEnv ( XxxADTEnv* Env ) Reclaims an ADT environment
virtual XxxErrCode	GetResultSize (const XxxADTValue *ObjectRef, const XxxADTMetaInfo *MetaInfo, const char *Message, const int MessageSize, int &ResultSize) This function will only be called on ADTs which support callbacks
virtual XxxBool	IsSmall (const XxxADTMetaInfo*) Are the values "small" i
virtual XxxErrCode	ServiceCallback (const XxxADTValue *ObjectRef, const XxxADTMetaInfo *MetaInfo, const char *Message, const int MessageSize, ostream &OStr) This function will only be called on ADTs which support callbacks
virtual XxxBool	SupportsCallback () Must return XXX_TRUE for ADTs which wish to implement callbacks

virtual XxxBool IsSmall(const XxxADTMetaInfo*)

Are the values "small" i.e., stored totally within the record?

virtual XxxBool SupportsCallback()

Must return XXX_TRUE for ADTs which wish to implement callbacks

virtual XxxErrCode GetResultSize(const XxxADTValue *ObjectRef, const XxxADTMetaInfo *MetaInfo, const char *Message, const int MessageSize, int &ResultSize)

This function will only be called on ADTs which support callbacks. Given a handle on the result, this function must determine the size (in bytes) of the response it will send in a call to the ServiceCallback() function.

Parameters:

ObjectRef - The object for which a callback is being made
MetaInfo - The meta info for that object
Message - A binary message that was sent with the callback (or NULL if none was sent)
MessageSize - The size of the Message array
ResultSize - (out) The size of the object to be sent

virtual XxxErrCode ServiceCallback(const XxxADTValue *ObjectRef, const XxxADTMetaInfo *MetaInfo, const char *Message, const int MessageSize, ostream &OStr)

This function will only be called on ADTs which support callbacks. This is the sister-function to the Callback function in the Java Client Library. It communicates with the JCL and transfers the "full value" of a data object over the stream provided.

Parameters:

RequestBuffer - The request message sent from the JCL
BufferSize - The buffer's size
OStr - The output stream to the JCL data type

virtual XxxErrCode CreateEnv( XxxADTEnv* &Env )

Creates an ADT environment

virtual XxxErrCode DeleteEnv( XxxADTEnv* Env )

Reclaims an ADT environment

class XxxLargeADTEnv: public XxxADTEnv

Environment variable class

enum XxxLargeADTDisplayTypeEnum

Determines the display type

typedef enum XxxLargeADTDisplayTypeEnum XxxLargeADTDisplayType

A typedef for easy reference

static const char* const DISPLAY_TYPE

The command referencing the next variable

XxxLargeADTDisplayType DisplayType

The desired display type

XxxShoreVolumeId StorageVolume

The volume on which the large ADTs store information

XxxShoreObjectId StorageFile

A file on the default volume which is persistent

XxxShoreObjectId TemporaryFile

A file on the default volume which is cleared after all Xacts end

Direct child classes:

XxxLargeVarADT
XxxLargeFixedADT

alphabetic index hierarchy of classes

this page has been generated automatically by doc++

(c)opyright by Malte Zöckler, Roland Wunderling
contact: doc++@zib.de