Home > Support > Documentation

OSRTMessageBuffer Class Reference
[Message Buffer Classes]

Abstract message buffer base class. More...

#include <OSRTMsgBuf.h>

Inheritance diagram for OSRTMessageBuffer:

OSRTCtxtHolder OSRTMessageBufferIF OSRTCtxtHolderIF OSRTCtxtHolderIF List of all members.

Public Member Functions

virtual ~OSRTMessageBuffer ()
 The virtual destructor does nothing.
virtual void * getAppInfo ()
 Returns a pointer to application-specific information block.
virtual size_t getByteIndex ()
 The getByteIndex method is used to fetch the current byte offset within the current working buffer.
virtual OSRTCtxtPtr getContext ()
 The getContext method returns the underlying context smart-pointer object.
virtual OSCTXT * getCtxtPtr ()
 The getCtxtPtr method returns the underlying C runtime context.
virtual char * getErrorInfo ()
 Returns error text in a dynamic memory buffer.
virtual char * getErrorInfo (char *pBuf, size_t &bufSize)
 Returns error text in a memory buffer.
virtual OSOCTET * getMsgCopy ()
 The getMsgCopy method will return a copy of the encoded message managed by the object.
virtual const OSOCTET * getMsgPtr ()
 The getMsgPtr method will return a const pointer to the encoded message managed by the object.
int getStatus () const
 This method returns the completion status of previous operation.
virtual int init ()
 Initializes message buffer.
virtual EXTRTMETHOD int initBuffer (OSOCTET *pMsgBuf, size_t msgBufLen)
 This version of the overloaded initBuffer method initializes the message buffer to point at the given null-terminated character string.
virtual void printErrorInfo ()
 The printErrorInfo method prints information on errors contained within the context.
virtual void resetErrorInfo ()
 The resetErrorInfo method resets information on errors contained within the context.
virtual void setAppInfo (void *)
 Sets the application-specific information block.
virtual EXTRTMETHOD void setDiag (OSBOOL value=TRUE)
 The setDiag method will turn diagnostic tracing on or off.

Protected Member Functions

EXTRTMETHOD OSRTMessageBuffer (Type bufferType, OSRTContext *pContext=0)
 The protected constructor creates a new context and sets the buffer class type.

Protected Attributes

Type mBufferType
 The mBufferType member variable holds information on the derived message buffer class type (for example, XMLEncode).

Detailed Description

Abstract message buffer base class.

This class is used to manage an encode or decode message buffer. For encoding, this is the buffer into which the message is being built. For decoding, it describes a message that was read into memory to be decoded. Further classes are derived from this to handle encoding and decoding of messages for different encoding rules types.

Definition at line 46 of file OSRTMsgBuf.h.

Constructor & Destructor Documentation

EXTRTMETHOD OSRTMessageBuffer::OSRTMessageBuffer (  Type  bufferType,
OSRTContext *  pContext = 0
)  [protected]
 

The protected constructor creates a new context and sets the buffer class type.

Parameters:
bufferType Type of message buffer that is being created (for example, XMLEncode).
pContext Pointer to a context to use. If NULL, new context will be allocated.

virtual OSRTMessageBuffer::~OSRTMessageBuffer (   )  [inline, virtual]
 

The virtual destructor does nothing.

It is overridden by derived versions of this class.

Definition at line 73 of file OSRTMsgBuf.h.

Member Function Documentation

virtual size_t OSRTMessageBuffer::getByteIndex (   )  [inline, 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.

Implements OSRTMessageBufferIF.

Definition at line 86 of file OSRTMsgBuf.h.

References OSRTCtxtHolder::getCtxtPtr().

virtual OSCTXT* OSRTMessageBuffer::getCtxtPtr (   )  [inline, virtual]
 

The getCtxtPtr method returns the underlying C runtime context.

This context can be used in calls to C runtime functions.

Reimplemented from OSRTCtxtHolder.

Definition at line 102 of file OSRTMsgBuf.h.

References OSRTCtxtHolder::getCtxtPtr().

virtual char* OSRTMessageBuffer::getErrorInfo (  char *  pBuf,
size_t &  bufSize
)  [inline, virtual]
 

Returns error text in a memory buffer.

If buffer pointer is specified in parameters (not NULL) then error text will be copied in the passed buffer. Otherwise, this method allocates memory using the 'operator new []' function. The calling routine is responsible to free the memory by using 'operator delete []'.

Parameters:
pBuf A pointer to a destination buffer to obtain the error text. If NULL, dynamic buffer will be allocated.
bufSize A reference to buffer size. If pBuf is NULL it will receive the size of allocated dynamic buffer.
Returns:
A pointer to a buffer with error text. If pBuf is not NULL, the return pointer will be equal to it. Otherwise, returns newly allocated buffer with error text. NULL, if error occurred.

Reimplemented from OSRTCtxtHolder.

Definition at line 133 of file OSRTMsgBuf.h.

References OSRTCtxtHolder::getErrorInfo().

virtual char* OSRTMessageBuffer::getErrorInfo (   )  [inline, virtual]
 

Returns error text in a dynamic memory buffer.

The buffer is allocated using 'operator new []'. The calling routine is responsible to free the memory by using 'operator delete []'.

Returns:
A pointer to a newly allocated buffer with error text.

Reimplemented from OSRTCtxtHolder.

Definition at line 113 of file OSRTMsgBuf.h.

References OSRTCtxtHolder::getErrorInfo().

int OSRTMessageBuffer::getStatus (   )  const [inline, virtual]
 

This method returns the completion status of previous operation.

It can be used to check completion status of constructors or methods, which do not return completion status.

Returns:
Runtime status code:
  • 0 = success,
  • negative return value is error.

Reimplemented from OSRTCtxtHolder.

Definition at line 162 of file OSRTMsgBuf.h.

References OSRTCtxtHolder::getStatus().

virtual int OSRTMessageBuffer::init (   )  [inline, virtual]
 

Initializes message buffer.

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

Implements OSRTMessageBufferIF.

Definition at line 173 of file OSRTMsgBuf.h.

virtual EXTRTMETHOD int OSRTMessageBuffer::initBuffer (  OSOCTET *  pMsgBuf,
size_t  msgBufLen
)  [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.
Returns:
Completion status of operation:
  • 0 (0) = success,
  • negative return value is error.

Implements OSRTMessageBufferIF.

virtual EXTRTMETHOD void OSRTMessageBuffer::setDiag (  OSBOOL  value = TRUE  )  [virtual]
 

The setDiag method will turn diagnostic tracing on or off.

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

Implements OSRTMessageBufferIF.

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