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

Google


Objective Systems, Inc.

OSXMLDecodeBuffer Class Reference

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

#include <rtXmlCppMsgBuf.h>

Inheritance diagram for OSXMLDecodeBuffer:

OSXMLMessageBuffer OSMessageBuffer OSMessageBufferIF List of all members.

Public Member Functions

 OSXMLDecodeBuffer (const char *xmlFile)
 This version of the OSXMLDecodeBuffer constructor takes a name of a file that contains XML data to be decoded and constructs a buffer.

 OSXMLDecodeBuffer (const OSOCTET *msgbuf, size_t bufsiz)
 This version of the OSXMLDecodeBuffer constructor takes parameters describing a message in memory to be decoded and constructs a buffer.

 OSXMLDecodeBuffer (OSInputStream &inputStream)
 This version of the OSXMLDecodeBuffer constructor takes a reference to the OSInputStream object.

int decodeXML (OSXMLReader *pReader)
 This method decodes an XML message associated with this buffer.

const char * getXmlFileName ()
 This method returns the name of the XML file that is associated with the current buffer.

virtual OSBOOL isA (Type bufferType)

Protected Types

enum  { INPUT_FILE, INPUT_STREAM, INPUT_STREAM_ATTACHED, INPUT_MEMORY }

Protected Attributes

union {
   const char *   fileName
   OSInputStream *   pInputStream
   struct {
      const OSOCTET *   pMemBuf
      size_t   bufSize
   }   memBuf
mInput
enum OSXMLDecodeBuffer:: { ... }  mInputId

Detailed Description

The OSXMLDecodeBuffer class is derived from the OSXMLMessageBuffer base class.

It contains variables and methods specific to decoding XML messages. It is used to manage the input buffer containing a message to be decoded.

Note that the XML decode buffer object does not take a message buffer argument because buffer management is handled by the XML parser.

Definition at line 230 of file rtXmlCppMsgBuf.h.


Constructor & Destructor Documentation

OSXMLDecodeBuffer::OSXMLDecodeBuffer const char *  xmlFile  ) 
 

This version of the OSXMLDecodeBuffer constructor takes a name of a file that contains XML data to be decoded and constructs a buffer.

Parameters:
xmlFile A pointer to name of file to be decoded.

OSXMLDecodeBuffer::OSXMLDecodeBuffer const OSOCTET *  msgbuf,
size_t  bufsiz
 

This version of the OSXMLDecodeBuffer constructor takes parameters describing a message in memory to be decoded and constructs a buffer.

Parameters:
msgbuf A pointer to a buffer containing an XML message.
bufsiz Size of the message buffer.

OSXMLDecodeBuffer::OSXMLDecodeBuffer OSInputStream inputStream  ) 
 

This version of the OSXMLDecodeBuffer constructor takes a reference to the OSInputStream object.

The stream is assumed to have been previuously initialized to point at an encoded XML message.

Parameters:
inputStream reference to the OSInputStream object


Member Function Documentation

int OSXMLDecodeBuffer::decodeXML OSXMLReader *  pReader  ) 
 

This method decodes an XML message associated with this buffer.

Returns:
stat Status of the operation. Possible values are ASN_OK if successful or one of the negative error status codes defined in Appendix A of the C/C++ runtime Common Functions Reference Manual.
Parameters:
pReader Pointer to OSXMLReader object.

const char* OSXMLDecodeBuffer::getXmlFileName  )  [inline]
 

This method returns the name of the XML file that is associated with the current buffer.

Returns:
Name of the XML file that is associated with this object.

Definition at line 295 of file rtXmlCppMsgBuf.h.


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

This file was last modified on 1 Jun 2004.
XBinder, Version 1.0.0