PTLib  Version 2.10.4
PASNObject Class Reference

This class defines the common behviour of all ASN objects. More...

#include <pasn.h>

Inheritance diagram for PASNObject:
PObject PASNInteger PASNNull PASNObjectID PASNSequence PASNString PASNUnsignedInteger PASNIPAddress PASNCounter PASNGauge PASNTimeTicks

List of all members.

Public Types

enum  ASNType {
  Integer, String, ObjectID, Sequence,
  Choice, IPAddress, Counter, Gauge,
  TimeTicks, Opaque, NsapAddress, Counter64,
  UInteger32, Null, Unknown, ASNTypeMax
}
 Value returned by the GetType() function to indicate the type of an ASN object. More...

Public Member Functions

virtual ASNType GetType () const
 Return a value of type enum ASNType which indicates the type of the object.
int GetChoice () const
 Return the descriminator for Choice sequences.
virtual PString GetTypeAsString () const
 Return a string giving the type of the object.
virtual PASNInt GetInteger () const
 Return the value of the ASN object as a PASNInt.
virtual PASNUnsigned GetUnsigned () const
 Return the value of the object as a PASNUnsigned.
virtual PString GetString () const
 Return the value of the object as a PString.
virtual const PASNSequenceGetSequence () const
 Return the value of the object as a PString.
virtual PIPSocket::Address GetIPAddress () const
 Return the value of the object as an IPAddress.
virtual void PrintOn (ostream &strm) const
 Virtual functions used by the PObject::operator<< function to print the value of the object.
virtual void Encode (PBYTEArray &buffer)
 Virtual function used to encode the object into ASN format.
virtual WORD GetEncodedLength ()
 Virtual function used to get the length of object when encoded into ASN format.
virtual PObjectClone () const
 Virtual function used to duplicate objects.

Static Public Member Functions

static void EncodeASNLength (PBYTEArray &buffer, WORD length)
 Encode an ASN length value.
static WORD GetASNLengthLength (WORD length)
 Return the length of an encoded ASN length value.
static PBoolean DecodeASNLength (const PBYTEArray &buffer, PINDEX &ptr, WORD &len)
 Decode an ASN length in the buffer at the given ptr.
static void EncodeASNSequenceStart (PBYTEArray &buffer, BYTE type, WORD length)
 Encode a sequence header into the buffer at the specified offset.
static WORD GetASNSequenceStartLength (WORD length)
 Return the encoded length of a sequence if it has the specified length.
static void EncodeASNHeader (PBYTEArray &buffer, PASNObject::ASNType type, WORD length)
 Encode an ASN object header into the buffer.
static WORD GetASNHeaderLength (WORD length)
 Return the length of an ASN object header if the object is the specified length.
static void EncodeASNInteger (PBYTEArray &buffer, PASNInt data, PASNObject::ASNType type)
static void EncodeASNUnsigned (PBYTEArray &buffer, PASNUnsigned data, PASNObject::ASNType type)
static WORD GetASNIntegerLength (PASNInt data)
static WORD GetASNUnsignedLength (PASNUnsigned data)
static PBoolean DecodeASNInteger (const PBYTEArray &buffer, PINDEX &ptr, PASNInt &value, ASNType type=Integer)
static PBoolean DecodeASNUnsigned (const PBYTEArray &buffer, PINDEX &ptr, PASNUnsigned &value, ASNType type=TimeTicks)

Protected Member Functions

 PASNObject ()
 Create an empty ASN object.

Static Protected Attributes

static BYTE ASNTypeToType [ASNTypeMax]
 Table to map enum ASNType values to ASN identifiers.

Detailed Description

This class defines the common behviour of all ASN objects.

It also contains several functions which are used for encoding common ASN primitives.

This class will never be instantiated directly. See the PASNInteger, PASNSequence, PASNString and PASNObjectID classes for examples of ASN objects that can be created.

Only descendants of this class can be put into the ASNSequence class.


Member Enumeration Documentation

Value returned by the GetType() function to indicate the type of an ASN object.

Enumerator:
Integer 

ASN Integer object.

String 

ASN Octet String object.

ObjectID 

ASN Object ID object.

Sequence 

ASN Sequence object.

Choice 

ASN Sequence with discriminator.

IPAddress 

ASN IPAddress object.

Counter 

ASN Counter object.

Gauge 

ASN Gauge object.

TimeTicks 

ASN TimeTicks object.

Opaque 

ASN Opaque object.

NsapAddress 

ASN NsapAddress.

Counter64 

ASN Counter64.

UInteger32 

ASN Unsigned integer 32.

Null 

ASN Null.

Unknown 

unknown ASN object type

ASNTypeMax 

maximum of number of ASN object types


Constructor & Destructor Documentation

PASNObject::PASNObject ( ) [protected]

Create an empty ASN object.

Used only by descendant constructors


Member Function Documentation

virtual PObject* PASNObject::Clone ( ) const [virtual]

Virtual function used to duplicate objects.

Reimplemented from PObject.

Reimplemented in PASNNull, PASNObjectID, PASNGauge, PASNCounter, PASNTimeTicks, PASNIPAddress, PASNString, and PASNInteger.

static PBoolean PASNObject::DecodeASNInteger ( const PBYTEArray buffer,
PINDEX &  ptr,
PASNInt value,
ASNType  type = Integer 
) [static]
Parameters:
bufferbuffer to decode from
ptrptr to data in buffer
valuereturned value
typeactual integer type
static PBoolean PASNObject::DecodeASNLength ( const PBYTEArray buffer,
PINDEX &  ptr,
WORD &  len 
) [static]

Decode an ASN length in the buffer at the given ptr.

The ptr is moved to the byte after the end of the encoded length.

Parameters:
bufferbuffer to decode data from
ptrptr to decode from
lenreturned length
static PBoolean PASNObject::DecodeASNUnsigned ( const PBYTEArray buffer,
PINDEX &  ptr,
PASNUnsigned value,
ASNType  type = TimeTicks 
) [static]
Parameters:
bufferbuffer to decode from
ptrptr to data in buffer
valuereturned value
typeactual integer type
virtual void PASNObject::Encode ( PBYTEArray buffer) [virtual]

Virtual function used to encode the object into ASN format.

Parameters:
bufferbuffer to encode into

Reimplemented in PASNSequence, PASNNull, PASNObjectID, PASNGauge, PASNCounter, PASNTimeTicks, PASNIPAddress, PASNString, and PASNInteger.

static void PASNObject::EncodeASNHeader ( PBYTEArray buffer,
PASNObject::ASNType  type,
WORD  length 
) [static]

Encode an ASN object header into the buffer.

Parameters:
bufferbuffer to encode into
typeASN type of the object
lengthlength of the object
static void PASNObject::EncodeASNInteger ( PBYTEArray buffer,
PASNInt  data,
PASNObject::ASNType  type 
) [static]
Parameters:
bufferbuffer to encode into
datavalue to encode
typeactual integer type
static void PASNObject::EncodeASNLength ( PBYTEArray buffer,
WORD  length 
) [static]

Encode an ASN length value.

Parameters:
bufferbuffer to encode into
lengthASN length to encode
static void PASNObject::EncodeASNSequenceStart ( PBYTEArray buffer,
BYTE  type,
WORD  length 
) [static]

Encode a sequence header into the buffer at the specified offset.

Parameters:
bufferbuffer to encode data into
typesequence type
lengthlength of sequence data
static void PASNObject::EncodeASNUnsigned ( PBYTEArray buffer,
PASNUnsigned  data,
PASNObject::ASNType  type 
) [static]
Parameters:
bufferbuffer to encode into
datavalue to encode
typeactual integer type
static WORD PASNObject::GetASNHeaderLength ( WORD  length) [static]

Return the length of an ASN object header if the object is the specified length.

Parameters:
lengthlength of object
static WORD PASNObject::GetASNIntegerLength ( PASNInt  data) [static]
Parameters:
datavalue to get length of
static WORD PASNObject::GetASNLengthLength ( WORD  length) [static]

Return the length of an encoded ASN length value.

Parameters:
lengthlength to find length of
static WORD PASNObject::GetASNSequenceStartLength ( WORD  length) [static]

Return the encoded length of a sequence if it has the specified length.

Parameters:
lengthlength of sequence data
static WORD PASNObject::GetASNUnsignedLength ( PASNUnsigned  data) [static]
Parameters:
datavalue to get length of
int PASNObject::GetChoice ( ) const

Return the descriminator for Choice sequences.

Reimplemented in PASNSequence.

virtual WORD PASNObject::GetEncodedLength ( ) [virtual]

Virtual function used to get the length of object when encoded into ASN format.

Reimplemented in PASNSequence, PASNNull, PASNObjectID, PASNUnsignedInteger, PASNString, and PASNInteger.

virtual PASNInt PASNObject::GetInteger ( ) const [virtual]

Return the value of the ASN object as a PASNInt.

This function will assert if the object is not a descendant of PASNInteger.

Reimplemented in PASNInteger.

virtual PIPSocket::Address PASNObject::GetIPAddress ( ) const [virtual]

Return the value of the object as an IPAddress.

This function will assert if the object is not a descendant of PASNIPAddress.

Reimplemented in PASNIPAddress.

virtual const PASNSequence& PASNObject::GetSequence ( ) const [virtual]

Return the value of the object as a PString.

This function will assert if the object is not a descendant of PASNSequence.

Reimplemented in PASNSequence.

virtual PString PASNObject::GetString ( ) const [virtual]

Return the value of the object as a PString.

This function can be use for all ASN object types

Reimplemented in PASNNull, PASNObjectID, PASNUnsignedInteger, PASNIPAddress, PASNString, and PASNInteger.

virtual ASNType PASNObject::GetType ( ) const [virtual]

Return a value of type enum ASNType which indicates the type of the object.

Reimplemented in PASNSequence, PASNNull, PASNObjectID, PASNGauge, PASNCounter, PASNTimeTicks, PASNIPAddress, PASNString, and PASNInteger.

virtual PString PASNObject::GetTypeAsString ( ) const [virtual]

Return a string giving the type of the object.

Reimplemented in PASNSequence, PASNNull, PASNObjectID, PASNGauge, PASNCounter, PASNTimeTicks, PASNIPAddress, PASNString, and PASNInteger.

virtual PASNUnsigned PASNObject::GetUnsigned ( ) const [virtual]

Return the value of the object as a PASNUnsigned.

This function will assert if the object is not a descendant of PASNTimeTicks or

PASNCounter.

Reimplemented in PASNUnsignedInteger.

virtual void PASNObject::PrintOn ( ostream &  strm) const [virtual]

Virtual functions used by the PObject::operator<< function to print the value of the object.

Parameters:
strmstream to print on

Reimplemented from PObject.

Reimplemented in PASNSequence, PASNNull, PASNObjectID, PASNUnsignedInteger, PASNString, and PASNInteger.


Member Data Documentation

BYTE PASNObject::ASNTypeToType[ASNTypeMax] [static, protected]

Table to map enum ASNType values to ASN identifiers.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines