XBinder XML Runtime  XBinder Version 3.0.x
OSXMLEncodeStream.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2003-2022 Objective Systems, Inc.
3  *
4  * This software is furnished under a license and may be used and copied
5  * only in accordance with the terms of such license and with the
6  * inclusion of the above copyright notice. This software or any other
7  * copies thereof may not be provided or otherwise made available to any
8  * other person. No title to and ownership of the software is hereby
9  * transferred.
10  *
11  * The information in this software is subject to change without notice
12  * and should not be construed as a commitment by Objective Systems, Inc.
13  *
14  * PROPRIETARY NOTICE
15  *
16  * This software is an unpublished work subject to a confidentiality agreement
17  * and is protected by copyright and trade secret law. Unauthorized copying,
18  * redistribution or other use of this work is prohibited.
19  *
20  * The above notice of copyright on this source code product does not indicate
21  * any actual or intended publication of such source code.
22  *
23  *****************************************************************************/
28 #ifndef _OSXMLENCODESTREAM_H_
29 #define _OSXMLENCODESTREAM_H_
30 
31 #include "rtxsrc/OSRTOutputStream.h"
33 
40 class EXTXMLCLASS OSXMLEncodeStream : public OSXMLEncodeBase {
41  protected:
43  OSRTOutputStream* mpStream;
44 
47  OSBOOL mbOwnStream;
48 
49  public:
57  EXTXMLMETHOD OSXMLEncodeStream (OSRTOutputStream& outputStream);
58 
68  OSXMLEncodeStream (OSRTOutputStream* pOutputStream,
69  OSBOOL ownStream = TRUE);
70 
72 
78  virtual EXTXMLMETHOD int init ();
79 
95  virtual OSBOOL isA (Type bufferType) {
96  return bufferType == XMLEncode || bufferType == Stream;
97  }
98 
106  virtual const OSOCTET* getMsgPtr () { return 0; }
107 
113  inline OSRTOutputStream* getStream () const { return mpStream; }
114 
115 } ;
116 
117 #endif
118 
The OSXMLEncodeStream class is derived from the OSXMLEncodeBase class.
OSRTOutputStream * getStream() const
This method returns the output stream associated with the object.
OSBOOL mbOwnStream
TRUE if the OSXMLEncodeStream object will close and free the stream in the destructor.
virtual OSBOOL isA(Type bufferType)
This is a virtual method that must be overridden by derived classes to allow identification of the cl...
XML encode/decode buffer and stream base class.
OSXMLEncodeBase is a base class for the XML encode buffer and stream classes, OSXMLEncodeBuffer and O...
OSRTOutputStream * mpStream
A pointer to an OSRTOutputStream object.
virtual const OSOCTET * getMsgPtr()
This is a virtual method that must be overridden by derived classes to allow access to the stored mes...