Home > Support > Documentation

OSXMLEncodeBuffer Class Reference

The OSXMLEncodeBuffer class is derived from the OSXMLMessageBuffer base class. More...

#include <rtXmlCppMsgBuf.h>

Inheritance diagram for OSXMLEncodeBuffer:

OSXMLMessageBuffer

Public Member Functions

 OSXMLEncodeBuffer ()
 Default constructor.
 OSXMLEncodeBuffer (OSOCTET *pMsgBuf, size_t msgBufLen)
 This constructor allows a static message buffer to be specified to receive the encoded message.
virtual size_t getMsgLen ()
 This method returns the length of a previously encoded XML message.
virtual int init ()
 This method reinitializes the encode buffer to allow a new message to be encoded.
virtual OSBOOL isA (int bufferType)
 This is a virtual method that must be overridden by derived classes to allow identification of the class.
virtual long write (const char *filename)
 This method writes the encoded message to the given file.
virtual long write (FILE *fp)
 This version of the write method writes to a file that is specified by a FILE pointer.

Protected Member Functions

 OSXMLEncodeBuffer (OSRTContext *pContext)

Detailed Description

The OSXMLEncodeBuffer class is derived from the OSXMLMessageBuffer base class.

It contains variables and methods specific to encoding XML messages. It is used to manage the buffer into which a message is to be encoded.

Definition at line 137 of file rtXmlCppMsgBuf.h.

Constructor & Destructor Documentation

OSXMLEncodeBuffer::OSXMLEncodeBuffer (  OSOCTET *  pMsgBuf,
size_t  msgBufLen
) 
 

This constructor allows a static message buffer to be specified to receive the encoded message.

Parameters:
pMsgBuf A pointer to a fixed size message buffer to receive the encoded message.
msgBufLen Size of the fixed-size message buffer.

Member Function Documentation

virtual size_t OSXMLEncodeBuffer::getMsgLen (   )  [inline, virtual]
 

This method returns the length of a previously encoded XML message.

Returns:
Length of the XML message encapsulated within this buffer object.

Definition at line 165 of file rtXmlCppMsgBuf.h.

virtual int OSXMLEncodeBuffer::init (   )  [virtual]
 

This method reinitializes the encode buffer to allow a new message to be encoded.

This makes it possible to reuse one message buffer object in a loop to encode multiple messages. After this method is called, any previously encoded message in the buffer will be overwritten on the next encode call.

virtual OSBOOL OSXMLEncodeBuffer::isA (  int  bufferType  )  [inline, virtual]
 

This is a virtual method that must be overridden by derived classes to allow identification of the class.

The base class variant is abstract. This method matches an enumerated identifier defined in the base class. One identifier is declared for each of the derived classes.

Parameters:
bufferType Enumerated identifier specifying a derived class. This type is defined as a public access type in the OSRTMessageBufferIF base interface. Possible values include BEREncode, BERDecode, PEREncode, PERDecode, XMLEncode, and XMLDecode.
Returns:
Boolean result of the match operation. True if the bufferType argument is XMLEncode. argument.

Definition at line 193 of file rtXmlCppMsgBuf.h.

virtual long OSXMLEncodeBuffer::write (  FILE *  fp  )  [virtual]
 

This version of the write method writes to a file that is specified by a FILE pointer.

Parameters:
fp Pointer to FILE structure to which the encoded message will be written.
Returns:
Number of octets actually written. This value may be less than the actual message length if an error occurs.

virtual long OSXMLEncodeBuffer::write (  const char *  filename  )  [virtual]
 

This method writes the encoded message to the given file.

Parameters:
filename The name of file to which the encoded message will be written.
Returns:
Number of octets actually written. This value may be less than the actual message length if an error occurs.
The documentation for this class was generated from the following file: