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

Google
Objective Systems, Inc.
Main Page | Modules | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members

ASN1XERDecodeBuffer Class Reference
[XER Message Buffer Classes]

#include <asn1XerCppTypes.h>

Inheritance diagram for ASN1XERDecodeBuffer:

ASN1XERMessageBuffer ASN1XERInputStream ASN1XERFileInputStream ASN1XERSocketInputStream List of all members.

Detailed Description

The ANS1XERDecodeBuffer class is derived from the ASN1XERMessageBuffer base class. It contains variables and methods specific to decoding ASN.1 XER messages. It is used to manage the input buffer containing an ASN.1 message to be decoded.

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


Public Member Functions

 ASN1XERDecodeBuffer (const char *xmlFile)
 ASN1XERDecodeBuffer (const ASN1OCTET *msgbuf, size_t numocts, ASN1BOOL openType=FALSE)
 ASN1XERDecodeBuffer (OSCInputStream &inputStream, ASN1BOOL openType=FALSE)
int decodeXML (OSXMLReader *pReader)
const char * getXmlFileName ()
int initBuffer (ASN1MemBuf &membuf)
int initBuffer (char *str)
int initBuffer (ASN116BITCHAR *str)
virtual ASN1BOOL isA (Type bufferType)
virtual void throwSAXException (int stat, const char *file=0, int line=0)
void setOpenType ()

Protected Types

enum  { INPUT_FILE, INPUT_STREAM, INPUT_STREAM_ATTACHED, INPUT_MEMORY }

Protected Attributes

union {
   const char *   fileName
   OSCInputStream *   pInputStream
   struct {
      const ASN1OCTET *   pMemBuf
      int   bufSize
   }   memBuf
} mInput
enum ASN1XERDecodeBuffer:: { ... }  mInputId

Constructor & Destructor Documentation

ASN1XERDecodeBuffer::ASN1XERDecodeBuffer (  const char *  xmlFile  ) 
 

The ASN1XERDecodeBuffer class has three overloaded constructors. This version of the ASN1XERDecodeBuffer constructor takes a name of a file that contains the XML data to be decoded, and constructs a buffer. Use getStatus() method to determine has error occured during the initialization or not.

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

ASN1XERDecodeBuffer::ASN1XERDecodeBuffer (  const ASN1OCTET *  msgbuf,
size_t  numocts,
ASN1BOOL  openType = FALSE
) 
 

This version of the ASN1XERDecodeBuffer constructor takes parameters describing the message to be decoded, and constructs a buffer describing an encoded ASN.1 message. Use getStatus() method to determine has error occured during the initialization or not.

Parameters:
msgbuf A pointer to a buffer containing an encoded ASN.1 message.
numocts Size of the message buffer.
openType Open Type decoding indicator. Set this argument as TRUE to decode an open type.

ASN1XERDecodeBuffer::ASN1XERDecodeBuffer (  OSCInputStream &  inputStream,
ASN1BOOL  openType = FALSE
) 
 

This version of the ASN1XERDecodeBuffer constructor takes a reference to the OSCInputStream object. Use getStatus() method to determine has error occured during the initialization or not.

Parameters:
inputStream reference to the OSCInputStream object
openType Open Type decoding indicator. Set this argument as TRUE to decode an open type.

Member Function Documentation

int ASN1XERDecodeBuffer::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* ASN1XERDecodeBuffer::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 the current buffer.

int ASN1XERDecodeBuffer::initBuffer (  ASN1MemBuf &  membuf  )  [inline]
 

This method reinitializes the decode buffer pointer to allow new data to be decoded. This makes it possible to reuse one message buffer object in a loop to decode multiple data messages.

Returns:
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++ Run-time Common Functions Reference Manual.
Parameters:
membuf reference to ASN1MemBuf object.

The documentation for this class was generated from the following file:
Copyright © 1997-2004 Objective Systems,Inc.
All Rights Reserved.
This document may be distributed in any form, electronic
or otherwise, provided that it is distributed in its entirety
and that the copyright and this notice are included.
This file was last modified on 1 Oct 2004.
ASN1C XER Runtime, ASN1C v5.7x