Home > Support > Documentation

Asn1NamedEventHandler Class Reference
[Asn1NamedEventHandler]

#include <asn1CppEvtHndlr.h>

List of all members.

Detailed Description

Named event handler base class. This is the base class from which user-defined event handler classes are derived. These classes can be used to handle events during the parsing of an ASN.1 message. The event callback methods that can be implemented are startElement, endElement, and contents methods.


Public Member Functions

virtual void startElement (const char *name, int index)=0
virtual void endElement (const char *name, int index)=0
virtual void boolValue (OSBOOL value)=0
virtual void intValue (OSINT32 value)=0
virtual void uIntValue (OSUINT32 value)=0
virtual void int64Value (OSINT64 value)
virtual void uInt64Value (OSUINT64 value)
virtual void bitStrValue (OSUINT32 numbits, const OSOCTET *data)=0
virtual void octStrValue (OSUINT32 numocts, const OSOCTET *data)=0
virtual void charStrValue (const char *value)=0
virtual void charStrValue (OSUINT32 nchars, OSUNICHAR *data)=0
virtual void charStrValue (OSUINT32 nchars, OS32BITCHAR *data)=0
virtual void nullValue ()=0
virtual void oidValue (OSUINT32 numSubIds, OSUINT32 *pSubIds)=0
virtual void realValue (double value)=0
virtual void enumValue (OSUINT32 value, const OSUTF8CHAR *text)=0
virtual void openTypeValue (OSUINT32 numocts, const OSOCTET *data)=0

Static Public Member Functions

static void addEventHandler (OSCTXT *pCtxt, Asn1NamedEventHandler *pHandler)
static void removeEventHandler (OSCTXT *pCtxt, Asn1NamedEventHandler *pHandler)
static void invokeStartElement (OSCTXT *pCtxt, const char *name, int index)
static void invokeEndElement (OSCTXT *pCtxt, const char *name, int index)
static void invokeBoolValue (OSCTXT *pCtxt, OSBOOL value)
static void invokeIntValue (OSCTXT *pCtxt, OSINT32 value)
static void invokeUIntValue (OSCTXT *pCtxt, OSUINT32 value)
static void invokeInt64Value (OSCTXT *pCtxt, OSINT64 value)
static void invokeUInt64Value (OSCTXT *pCtxt, OSUINT64 value)
static void invokeBitStrValue (OSCTXT *pCtxt, OSUINT32 numbits, const OSOCTET *data)
static void invokeOctStrValue (OSCTXT *pCtxt, OSUINT32 numocts, const OSOCTET *data)
static void invokeCharStrValue (OSCTXT *pCtxt, const char *value)
static void invokeCharStrValue (OSCTXT *pCtxt, OSUINT32 nchars, OSUNICHAR *data)
static void invokeCharStrValue (OSCTXT *pCtxt, OSUINT32 nchars, OS32BITCHAR *data)
static void invokeNullValue (OSCTXT *pCtxt)
static void invokeOidValue (OSCTXT *pCtxt, OSUINT32 numSubIds, OSUINT32 *pSubIds)
static void invokeRealValue (OSCTXT *pCtxt, double value)
static void invokeEnumValue (OSCTXT *pCtxt, OSUINT32 value, const OSUTF8CHAR *text)
static void invokeOpenTypeValue (OSCTXT *pCtxt, OSUINT32 numocts, const OSOCTET *data)

Member Function Documentation

virtual void Asn1NamedEventHandler::startElement ( const char *  name,
int  index 
) [pure virtual]

This method is invoked from within a decode function when an element of a SEQUENCE, SET, SEQUENCE OF, SET OF, or CHOICE construct is parsed.

Parameters:
name For SEQUENCE, SET, or CHOICE, this is the name of the element as defined in the ASN.1 defination. For SEQUENCE OF or SET OF, this is set to the name "element".
index For SEQUENCE, SET, or CHOICE, this is not used and is set to the value -1. For SEQUENCE OF or SET OF, this contains the zero-based index of the element in the conceptual array associated with the construct.
Returns:
- none

virtual void Asn1NamedEventHandler::endElement ( const char *  name,
int  index 
) [pure virtual]

This method is invoked from within a decode function when parsing is complete on an element of a SEQUENCE, SET, SEQUENCE OF, SET OF, or CHOICE construct.

Parameters:
name For SEQUENCE, SET, or CHOICE, this is the name of the element as defined in the ASN.1 defination. For SEQUENCE OF or SET OF, this is set to the name "element".
index For SEQUENCE, SET, or CHOICE, this is not used and is set to the value -1. For SEQUENCE OF or SET OF, this contains the zero-based index of the element in the conceptual array associated with the construct.
Returns:
- none

virtual void Asn1NamedEventHandler::boolValue ( OSBOOL  value  )  [pure virtual]

This method is invoked from within a decode function when a value of the BOOLEAN ASN.1 type is parsed.

Parameters:
value Parsed value.
Returns:
- none

virtual void Asn1NamedEventHandler::intValue ( OSINT32  value  )  [pure virtual]

This method is invoked from within a decode function when a value of the INTEGER ASN.1 type is parsed.

Parameters:
value Parsed value.
Returns:
- none

virtual void Asn1NamedEventHandler::uIntValue ( OSUINT32  value  )  [pure virtual]

This method is invoked from within a decode function when a value of the INTEGER ASN.1 type is parsed.

In this case, constraints on the integer value forced the use of unsigned integer C type to represent the value.

Parameters:
value Parsed value.
Returns:
- none

virtual void Asn1NamedEventHandler::int64Value ( OSINT64  value  )  [inline, virtual]

This method is invoked from within a decode function when a value of the 64-bit INTEGER ASN.1 type is parsed.

Parameters:
value Parsed value.
Returns:
- none

virtual void Asn1NamedEventHandler::uInt64Value ( OSUINT64  value  )  [inline, virtual]

This method is invoked from within a decode function when a value of the 64-bit INTEGER ASN.1 type is parsed.

Parameters:
value Parsed value.
Returns:
- none

virtual void Asn1NamedEventHandler::bitStrValue ( OSUINT32  numbits,
const OSOCTET *  data 
) [pure virtual]

This method is invoked from within a decode function when a value of the BIT STRING ASN.1 type is parsed.

Parameters:
numbits - Number of bits in the parsed value.
data - Pointer to a byte array that contains the bit string data.
Returns:
- none

virtual void Asn1NamedEventHandler::octStrValue ( OSUINT32  numocts,
const OSOCTET *  data 
) [pure virtual]

This method is invoked from within a decode function when a value of one of the OCTET STRING ASN.1 type is parsed.

Parameters:
numocts Number of octets in the parsed value.
data Pointer to byte array containing the octet string data.
Returns:
- none

virtual void Asn1NamedEventHandler::charStrValue ( const char *  value  )  [pure virtual]

This method is invoked from within a decode function when a value of one of the 8-bit ASN.1 character string types is parsed.

Parameters:
value Null terminated character string value.
Returns:
- none

virtual void Asn1NamedEventHandler::charStrValue ( OSUINT32  nchars,
OSUNICHAR *  data 
) [pure virtual]

This method is invoked from within a decode function when a value of one of the 16-bit ASN.1 character string types is parsed.

This is used for the ASN.1 BmpString type.

Parameters:
nchars Number of characters in the parsed value.
data Pointer to an array containing 16-bit values. These are represented using unsigned short integer values.
Returns:
- none

virtual void Asn1NamedEventHandler::charStrValue ( OSUINT32  nchars,
OS32BITCHAR *  data 
) [pure virtual]

This method is invoked from within a decode function when a value of one of the 32-bit ASN.1 characer string types is parsed.

This is used for the ASN.1 UniversalString type.

Parameters:
nchars Number of characters in the parsed value.
data Pointer to an array containing 32-bit values. Each 32-bit integer value is a universal character.
Returns:
- none

virtual void Asn1NamedEventHandler::nullValue (  )  [pure virtual]

This method is invoked from within a decode function when a value of the NULL ASN.1 type is parsed.

Parameters:
- none
Returns:
- none

virtual void Asn1NamedEventHandler::oidValue ( OSUINT32  numSubIds,
OSUINT32 *  pSubIds 
) [pure virtual]

This method is invoked from within a decode function whn a value the OBJECT IDENTIFIER ASN.1 type is parsed.

Parameters:
numSubIds Number of subidentifiers in the object identifier.
pSubIds Pointer to array containing the subidentifier values.
Returns:
-none

virtual void Asn1NamedEventHandler::realValue ( double  value  )  [pure virtual]

This method is invoked from within a decode function when a value the REAL ASN.1 type is parsed.

Parameters:
value Parsed value.
Returns:
- none

virtual void Asn1NamedEventHandler::enumValue ( OSUINT32  value,
const OSUTF8CHAR *  text 
) [pure virtual]

This method is invoked from within a decode function when a value of the ENUMERATED ASN.1 type is parsed.

Parameters:
value - Parsed enumerated value
text - Textual value of enumerated identifier
Returns:
- none

virtual void Asn1NamedEventHandler::openTypeValue ( OSUINT32  numocts,
const OSOCTET *  data 
) [pure virtual]

This value is invoked from within a decode function when an ASN.1 open type is parsed.

Parameters:
numocts Number of octets in the parsed value.
data Pointer to byet array contain in tencoded ASN.1 value.
Returns:
- none

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