OSXMLDecodeBuffer Class ReferenceThe OSXMLDecodeBuffer class is derived from the OSXMLMessageBuffer base class.
More...
#include <rtXmlCppMsgBuf.h>
Inheritance diagram for OSXMLDecodeBuffer:
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.
|
| int | parseElementName (OSUTF8CHAR **ppName) |
| | This method parses the initial tag from an XML message.
|
| int | parseElemQName (OSXMLQName *pQName) |
| | This method parses the initial tag from an XML message.
|
| 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 | |
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 288 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:
-
|
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:
-
- Returns:
- Completion status.
|
| 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 384 of file rtXmlCppMsgBuf.h. |
| int OSXMLDecodeBuffer::parseElementName |
( |
OSUTF8CHAR ** |
ppName |
) |
|
|
|
|
This method parses the initial tag from an XML message.
If the tag is a QName, only the local part of the name is returned.
- Parameters:
-
| ppName | Pointer to a pointer to receive decoded UTF-8 string. Dynamic memory is allocated for the variable using the rtxMemAlloc function. |
- Returns:
- Completion status of operation:
- 0 = success,
- negative return value is error.
|
| int OSXMLDecodeBuffer::parseElemQName |
( |
OSXMLQName * |
pQName |
) |
|
|
|
|
This method parses the initial tag from an XML message.
- Parameters:
-
| pQName | Pointer to a QName structure to receive parsed name prefix and local name. Dynamic memory is allocated for both name parts using the rtxMemAlloc function. |
- Returns:
- Completion status of operation:
- 0 = success,
- negative return value is error.
|
The documentation for this class was generated from the following file:
|
