Home > Support > Documentation

OSRTMessageBufferIF Class Reference
[Message Buffer Classes]

Abstract message buffer or stream interface class. More...

#include <OSRTMsgBufIF.h>

Inheritance diagram for OSRTMessageBufferIF:

OSRTCtxtHolderIF OSRTMessageBuffer List of all members.

Public Types

enum  Type

Public Member Functions

virtual void * getAppInfo ()=0
 Returns a pointer to application-specific information block.
virtual size_t getByteIndex ()=0
 The getByteIndex method is used to fetch the current byte offset within the current working buffer.
virtual OSOCTET * getMsgCopy ()=0
 The getMsgCopy method will return a copy of the encoded ASN.1 message managed by the object.
virtual const OSOCTET * getMsgPtr ()=0
 The getMsgPtr method will return a const pointer to the encoded ASN.1 message managed by the object.
virtual int init ()=0
 Initializes message buffer.
virtual int initBuffer (OSOCTET *pMsgBuf, size_t msgBufLen)=0
 This version of the overloaded initBuffer method initializes the message buffer to point at the given null-terminated character string.
virtual OSBOOL isA (int bufferType)=0
 This method checks the type of the message buffer.
virtual void setAppInfo (void *pAppInfo)=0
 Sets the application-specific information block.
virtual void setNamespace (const OSUTF8CHAR *, const OSUTF8CHAR *, OSRTDList *=0)
 Sets the namespace information.
virtual void setDiag (OSBOOL value=TRUE)=0
 The setDiag method will turn diagnostic tracing on or off.

Protected Member Functions

virtual ~OSRTMessageBufferIF ()
 The virtual destructor does nothing.

Detailed Description

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.

Definition at line 47 of file OSRTMsgBufIF.h.

Constructor & Destructor Documentation

virtual OSRTMessageBufferIF::~OSRTMessageBufferIF (   )  [inline, protected, virtual]
 

The virtual destructor does nothing.

It is overridden by derived versions of this class.

Definition at line 58 of file OSRTMsgBufIF.h.

Member Function Documentation

virtual size_t OSRTMessageBufferIF::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.

Implemented in OSRTMessageBuffer.

virtual OSOCTET* OSRTMessageBufferIF::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.

Returns:
The pointer to copied encoded ASN.1 message. NULL, if error occurred.

Implemented in OSRTMessageBuffer.

virtual const OSOCTET* OSRTMessageBufferIF::getMsgPtr (   )  [pure virtual]
 

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

Returns:
The pointer to the encoded ASN.1 message.

Implemented in OSRTMessageBuffer.

virtual int OSRTMessageBufferIF::init (   )  [pure virtual]
 

Initializes message buffer.

Returns:
Completion status of operation:
  • 0 (0) = success,
  • negative return value is error.

Implemented in OSRTMessageBuffer.

virtual int OSRTMessageBufferIF::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:
pMsgBuf Pointer to message buffer.
msgBufLen Length of message buffer in bytes. string.
Returns:
Completion status of operation:
  • 0 (0) = success,
  • negative return value is error.

Implemented in OSRTMessageBuffer.

virtual OSBOOL OSRTMessageBufferIF::isA (  int  bufferType  )  [pure virtual]
 

This method checks the type of the message buffer.

Parameters:
bufferType Enumerated identifier specifying a derived class. Possible values are: BEREncode, BERDecode, PEREncode, PERDecode, XEREncode, XERDecode, XMLEncode, XMLDecode, Stream.
Returns:
Boolean result of the match operation. True if this is the class corresponding to the identifier argument.

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

The setDiag method will turn diagnostic tracing on or off.

Parameters:
value - Boolean value (default = TRUE = on)

Implemented in OSRTMessageBuffer.

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