Home > Support > Documentation

OSXMLEncodeStream Class Reference

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

#include <rtXmlCppMsgBuf.h>

Inheritance diagram for OSXMLEncodeStream:

OSXMLMessageBuffer

Public Member Functions

 OSXMLEncodeStream (OSRTOutputStream &outputStream)
 This version of the OSXMLEncodeStream constructor takes a reference to the OSOutputStream object.
 OSXMLEncodeStream (OSRTOutputStream *pOutputStream, OSBOOL ownStream=TRUE)
 This version of the OSXMLEncodeStream constructor takes a pointer to the OSOutputStream object.
virtual OSBOOL isA (int bufferType)
 This is a virtual method that must be overridden by derived classes to allow identification of the class.
virtual const OSOCTET * getMsgPtr ()
 This is a virtual method that must be overridden by derived classes to allow access to the stored message.

Protected Attributes

OSRTOutputStream * mpStream
 A pointer to an OSRTOutputStream object.
OSBOOL mbOwnStream
 TRUE if the OSXMLEncodeStream object will close and free the stream in the destructor.

Detailed Description

The OSXMLEncodeStream class is derived from the OSXMLMessageBuffer base class.

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

Definition at line 229 of file rtXmlCppMsgBuf.h.

Constructor & Destructor Documentation

OSXMLEncodeStream::OSXMLEncodeStream (  OSRTOutputStream &  outputStream  ) 
 

This version of the OSXMLEncodeStream constructor takes a reference to the OSOutputStream object.

The stream is assumed to have been previuously initialized.

Parameters:
outputStream reference to the OSOutputStream object

OSXMLEncodeStream::OSXMLEncodeStream (  OSRTOutputStream *  pOutputStream,
OSBOOL  ownStream = TRUE
) 
 

This version of the OSXMLEncodeStream constructor takes a pointer to the OSOutputStream object.

The stream is assumed to have been previuously initialized. if ownStream is set to TRUE, then stream will be closed and freed in the destructor.

Parameters:
pOutputStream reference to the OSOutputStream object
ownStream set ownership for the passed stream object.

Member Function Documentation

virtual const OSOCTET* OSXMLEncodeStream::getMsgPtr (   )  [inline, virtual]
 

This is a virtual method that must be overridden by derived classes to allow access to the stored message.

The base class implementation returns a null value.

Returns:
A pointer to the stored message.

Definition at line 285 of file rtXmlCppMsgBuf.h.

virtual OSBOOL OSXMLEncodeStream::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 275 of file rtXmlCppMsgBuf.h.

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