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

Google


Objective Systems, Inc.

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 (ASN1BOOL value)=0
virtual void intValue (ASN1INT value)=0
virtual void uIntValue (ASN1UINT value)=0
virtual void bitStrValue (ASN1UINT numbits, ASN1ConstOctetPtr data)=0
virtual void octStrValue (ASN1UINT numocts, ASN1ConstOctetPtr data)=0
virtual void charStrValue (ASN1ConstCharPtr value)=0
virtual void charStrValue (ASN1UINT nchars, ASN116BITCHAR *data)=0
virtual void charStrValue (ASN1UINT nchars, ASN132BITCHAR *data)=0
virtual void nullValue ()=0
virtual void oidValue (ASN1UINT numSubIds, ASN1UINT *pSubIds)=0
virtual void realValue (double value)=0
virtual void enumValue (ASN1UINT value)=0
virtual void openTypeValue (ASN1UINT numocts, ASN1ConstOctetPtr data)=0

Static Public Member Functions

static void addEventHandler (ASN1CTXT *pCtxt, Asn1NamedEventHandler *pHandler)
static void removeEventHandler (ASN1CTXT *pCtxt, Asn1NamedEventHandler *pHandler)
static void invokeStartElement (ASN1CTXT *pCtxt, const char *name, int index)
static void invokeEndElement (ASN1CTXT *pCtxt, const char *name, int index)
static void invokeBoolValue (ASN1CTXT *pCtxt, ASN1BOOL value)
static void invokeIntValue (ASN1CTXT *pCtxt, ASN1INT value)
static void invokeUIntValue (ASN1CTXT *pCtxt, ASN1UINT value)
static void invokeBitStrValue (ASN1CTXT *pCtxt, ASN1UINT numbits, ASN1ConstOctetPtr data)
static void invokeOctStrValue (ASN1CTXT *pCtxt, ASN1UINT numocts, ASN1ConstOctetPtr data)
static void invokeCharStrValue (ASN1CTXT *pCtxt, ASN1ConstCharPtr value)
static void invokeCharStrValue (ASN1CTXT *pCtxt, ASN1UINT nchars, ASN116BITCHAR *data)
static void invokeCharStrValue (ASN1CTXT *pCtxt, ASN1UINT nchars, ASN132BITCHAR *data)
static void invokeNullValue (ASN1CTXT *pCtxt)
static void invokeOidValue (ASN1CTXT *pCtxt, ASN1UINT numSubIds, ASN1UINT *pSubIds)
static void invokeRealValue (ASN1CTXT *pCtxt, double value)
static void invokeEnumValue (ASN1CTXT *pCtxt, ASN1UINT value)
static void invokeOpenTypeValue (ASN1CTXT *pCtxt, ASN1UINT numocts, ASN1ConstOctetPtr data)


Member Function Documentation

virtual void Asn1NamedEventHandler::bitStrValue ASN1UINT  numbits,
ASN1ConstOctetPtr  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::boolValue ASN1BOOL  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::charStrValue ASN1UINT  nchars,
ASN132BITCHAR *  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::charStrValue ASN1UINT  nchars,
ASN116BITCHAR *  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 ASN1ConstCharPtr  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::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::enumValue ASN1UINT  value  )  [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
Returns:
- none

virtual void Asn1NamedEventHandler::intValue ASN1INT  value  )  [pure virtual]
 

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

Parameters:
value Parsed value.
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::octStrValue ASN1UINT  numocts,
ASN1ConstOctetPtr  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::oidValue ASN1UINT  numSubIds,
ASN1UINT *  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::openTypeValue ASN1UINT  numocts,
ASN1ConstOctetPtr  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

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::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::uIntValue ASN1UINT  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


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

Copyright © 1997-2005 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 8 Sep 2005.
ASN1C C/C++ Common Runtime, ASN1C v5.8x