Home > Support > Documentation

rtEXIDecoder.h File Reference

Interface for EXI low-level decoders. More...

#include "rtexisrc/osrtexi.h"
#include "rtexisrc/rtEXIEvent.h"
#include "rtexisrc/rtEXIEventCodeGroup.h"
#include "rtxmlsrc/osrtxml.h"
#include "rtxsrc/rtxArrayList.h"

Go to the source code of this file.


Functions

EXTERNEXI int rtEXIDecAttribute (OSCTXT *pctxt, OSXMLFullQName *pqname, const OSUTF8CHAR **ppvalue)
 Decodes the attribute at the current position in the decode stream.
EXTERNEXI int rtEXIDecBoolValue (OSCTXT *pctxt, OSBOOL *pvalue)
 This function decodes a boolean value.
EXTERNEXI int rtEXIDec_CH_String_EE (OSCTXT *pctxt, const OSXMLFullQName *pqname, const OSUTF8CHAR **ppvalue)
 This function decodes a CH event (assumed to be a one part code = 0 in a 1 bit field) followed by string content followed by an EE event (assumed to be a one part code = 0 in a 1 bit field).
EXTERNEXI int rtEXIDecDate (OSCTXT *pctxt, OSNumDateTime *pvalue)
 This function decodes a date value into a structured variable.
EXTERNEXI int rtEXIDecDateString (OSCTXT *pctxt, const OSUTF8CHAR **ppvalue)
 This function decodes a date value into a string.
EXTERNEXI int rtEXIDecDocumentType (OSCTXT *pctxt, const OSUTF8CHAR **ppName, const OSUTF8CHAR **ppPublic, const OSUTF8CHAR **ppSystem, const OSUTF8CHAR **ppText)
 This function decodes an XML document type declaration (DTD).
EXTERNEXI int rtEXIDecEventCodePart1 (OSCTXT *pctxt, OSINT32 *ppart, OSUINT32 nbits)
 This function decodes part 1 of an event code.
EXTERNEXI OSBOOL rtEXIDecHasNext (OSCTXT *pctxt)
 This functions checks for additonal events in the decode stream.
EXTERNEXI int rtEXIDecIntValue (OSCTXT *pctxt, OSINT32 *pvalue)
 This function decodes a signed integer value.
EXTERNEXI int rtEXIDecLocalName (OSCTXT *pctxt, const OSUTF8CHAR **ppname)
 Returns the local name associated with the current event.
EXTERNEXI int rtEXIDecNamespaceURI (OSCTXT *pctxt, const OSUTF8CHAR **ppNSURI)
 Returns the namespace associated with the current event.
EXTERNEXI int rtEXIDecNBitUIntValue (OSCTXT *pctxt, OSUINT32 *pvalue, OSUINT32 nbits)
 This function decodes an unsigned integer value from a bit field of the given width.
EXTERNEXI int rtEXIDecNextEventType (OSCTXT *pctxt, OSEXIEventType *pEventType)
 Returns the next OSEXIEventType read by this decoder.
EXTERNEXI int rtEXIDecPrefix (OSCTXT *pctxt, const OSUTF8CHAR *uri, const OSUTF8CHAR **ppPrefix)
 Returns the namespace associated with the current event.
EXTERNEXI int rtEXIDecProcessingInstruction (OSCTXT *pctxt, const OSUTF8CHAR **ppTarget, const OSUTF8CHAR **ppData)
 This function decodes an XML processing instruction (PI).
EXTERNEXI int rtEXIDecQName (OSCTXT *pctxt, OSXMLFullQName *pqname)
 Returns the qname associated with the current event.
EXTERNEXI int rtEXIDecReset (OSCTXT *pctxt)
 Resets the decoder for decoding a new message instance.
EXTERNEXI int rtEXIDecString (OSCTXT *pctxt, const OSXMLFullQName *pqname, const OSUTF8CHAR **ppvalue)
 Returns the value associated with the current event.
EXTERNEXI int rtEXIDecStringCHEvent (OSCTXT *pctxt, const OSXMLFullQName *pqname, const OSUTF8CHAR **ppvalue)
 This function decodes a CH event (assumed to be a one-bit field with code 0) followed by string content.
EXTERNEXI int rtEXIDecStringToCharArray (OSCTXT *pctxt, const OSUTF8CHAR *target, size_t start, size_t length)
 Similar to rtEXIDecString but the characters are copied into a fixed-size character array.
EXTERNEXI int rtEXIDecStringLength (OSCTXT *pctxt)
 Returns the length of the string returned by rtEXIDecString.
EXTERNEXI int rtEXIDecUIntValue (OSCTXT *pctxt, OSUINT32 *pvalue)
 This function decodes an unsigned integer value.
EXTERNEXI int rtEXIDecUTF8Str (OSCTXT *pctxt, OSUTF8CHAR **ppvalue)
 This function decodes a UTF-8 string value.
EXTERNEXI int rtEXIDecUTF8Chars (OSCTXT *pctxt, OSUTF8CHAR **ppvalue, OSUINT32 nchars)
 This function reads the given number of characters from the decode stream and creates a UTF-8 string.

Detailed Description

Interface for EXI low-level decoders.

The interface is similar to StAX, but uses enumerations for the different event types and reports attributes and namespaces as individual events.

Definition in file rtEXIDecoder.h.