Objective Systems, Inc.  
Home
About ASN.1
Products
Free Software
Documents
Services
Resources
Resellers
Customers
Careers
About Us
Contact Us
 

Google


Objective Systems, Inc.

OSXMLEncodeStream Class Reference

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

#include <rtXmlCppMsgBuf.h>

Inheritance diagram for OSXMLEncodeStream:

OSXMLMessageBuffer OSMessageBuffer OSMessageBufferIF List of all members.

Public Member Functions

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

Protected Attributes

OSOutputStreammpStream
OSBOOL mbOwnStream

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 OSOutputStream 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 OSOutputStream 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 OSBOOL OSXMLEncodeStream::isA Type  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 OSMessageBufferIF 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 271 of file rtXmlCppMsgBuf.h.


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

This file was last modified on 8 Jan 2007.
XBinder, Version 1.1.9