OSMessageBufferIF Class ReferenceAbstract message buffer or stream interface class.
More...
#include <rtxCppMsgBufIF.h>
Inheritance diagram for OSMessageBufferIF:
List of all members.
|
Public Types |
| enum | Type |
Public Member Functions |
|
virtual OSOCTET * | getMsgCopy () |
|
virtual const OSOCTET * | getMsgPtr () |
|
virtual void | init () |
|
virtual int | initBuffer (OSOCTET *, size_t) |
|
virtual void | setNamespace (const OSUTF8CHAR *, const OSUTF8CHAR *) |
| size_t | getByteIndex () |
| | The getByteIndex method is used to fetch the current byte offset within the current working buffer.
|
| virtual char * | getErrorInfo ()=0 |
| | Returns error text in a dynamic memory buffer.
|
| virtual char * | getErrorInfo (char *pBuf, size_t &bufSize)=0 |
| | Returns error text in a memory buffer.
|
|
void | printErrorInfo () |
| | The printErrorInfo method prints information on errors contained within the context.
|
|
void | resetErrorInfo () |
| | The resetErrorInfo method resets information on errors contained within the context.
|
| virtual void | setDiag (OSBOOL value=TRUE) |
| | The setDiag method will turn diagnostic tracing on or off.
|
Protected Member Functions |
| virtual | ~OSMessageBufferIF () |
| | 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 38 of file rtxCppMsgBufIF.h.
Constructor & Destructor Documentation
| virtual OSMessageBufferIF::~OSMessageBufferIF |
( |
|
) |
[inline, protected, virtual] |
|
|
|
The virtual destructor does nothing.
It is overridden by derived versions of this class.
Definition at line 49 of file rtxCppMsgBufIF.h. |
Member Function Documentation
| size_t OSMessageBufferIF::getByteIndex |
( |
|
) |
[inline] |
|
|
|
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.
Definition at line 71 of file rtxCppMsgBufIF.h.
Referenced by OSXMLEncodeBuffer::getMsgLen(). |
| virtual char* OSMessageBufferIF::getErrorInfo |
( |
char * |
pBuf, |
|
|
size_t & |
bufSize |
|
) |
[pure 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 occured.
Implemented in OSMessageBuffer. |
| virtual char* OSMessageBufferIF::getErrorInfo |
( |
|
) |
[pure virtual] |
|
|
|
Returns error text in a dynamic memory buffer.
Buffer will be allocated by '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.
Implemented in OSMessageBuffer. |
| virtual void OSMessageBufferIF::setDiag |
( |
OSBOOL |
value = TRUE |
) |
[inline, virtual] |
|
|
|
The setDiag method will turn diagnostic tracing on or off.
- Parameters:
-
| value | - Boolean value (default = TRUE = on) |
Definition at line 123 of file rtxCppMsgBufIF.h. |
The documentation for this class was generated from the following file:
|
