OSRTMessageBufferIF Class Reference

class OSRTMessageBufferIF : public OSRTCtxtHolderIF

Abstract message buffer or stream interface class. This is the base class for both the in-memory message buffer classes and the run-time stream classes.

Inherits from

Constructor & Destructor Documentation

~OSRTMessageBufferIF()

~OSRTMessageBufferIF ( ) [protected, inline, virtual]

The virtual destructor does nothing. It is overridden by derived versions of this class.

Member Functions Documentation

getAppInfo()

void * getAppInfo ( ) [pure virtual]

Returns a pointer to application-specific information block

getByteIndex()

size_t getByteIndex ( ) [pure virtual]

The getByteIndex method is used to fetch the current byte offset within the current working buffer. For encoding, this is the next location that will be written to. For decoding, this is the next byte the parser will read.

getMsgCopy()

OSOCTET * getMsgCopy ( ) [pure virtual]

The getMsgCopy method will return a copy of the encoded ASN.1 message managed by the object. The memory for the copy is allocated by new [] operator, user is responsible to free it by delete [] operator.

getMsgPtr()

const OSOCTET * getMsgPtr ( ) [pure virtual]

The getMsgPtr method will return a const pointer to the encoded ASN.1 message managed by the object.

init()

int init ( ) [pure virtual]

Initializes message buffer.

initBuffer(OSOCTET *, size_t)

int initBuffer ( OSOCTET * pMsgBuf,
size_t msgBufLen
) [pure virtual]

This version of the overloaded initBuffer method initializes the message buffer to point at the given null-terminated character string.

Parameters

OSOCTET * pMsgBuf Pointer to message buffer.
size_t msgBufLen Length of message buffer in bytes. string.

isA(int)

OSBOOL isA ( int bufferType ) [pure virtual]

This method checks the type of the message buffer.

Parameters

int bufferType Enumerated identifier specifying a derived class. Possible values are: BEREncode, BERDecode, PEREncode, PERDecode, XEREncode, XERDecode, XMLEncode, XMLDecode, Stream.

setAppInfo(void *)

void setAppInfo ( void * pAppInfo ) [pure virtual]

Sets the application-specific information block.

Parameters

void * pAppInfo

setDiag(OSBOOL)

void setDiag ( OSBOOL value = TRUE ) [pure virtual]

The setDiag method will turn diagnostic tracing on or off.

Parameters

OSBOOL value = TRUE - Boolean value (default = TRUE = on)

setNamespace(const OSUTF8CHAR *, const OSUTF8CHAR *, OSRTDList *)

void setNamespace ( const OSUTF8CHAR * ,
const OSUTF8CHAR * ,
OSRTDList *  = 0
) [inline, virtual]

Sets the namespace information.

Parameters

const OSUTF8CHAR *
const OSUTF8CHAR *
OSRTDList *  = 0

Member Enumerations Documentation

Enum Type

Enumerators

BEREncode
BERDecode
PEREncode
PERDecode
XEREncode
XERDecode
XMLEncode
XMLDecode
Stream