PTLib  Version 2.10.10
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
PSNMP_PDU Class Reference

#include <snmp.h>

Inheritance diagram for PSNMP_PDU:
PASN_Sequence PASN_Object PObject PSNMP_GetNextRequest_PDU PSNMP_GetRequest_PDU PSNMP_GetResponse_PDU PSNMP_SetRequest_PDU

Public Member Functions

 PSNMP_PDU (unsigned tag=UniversalSequence, TagClass tagClass=UniversalTagClass)
 
PINDEX GetDataLength () const
 
PBoolean Decode (PASN_Stream &strm)
 
void Encode (PASN_Stream &strm) const
 
void PrintOn (ostream &strm) const
 Output the contents of the object to the stream. More...
 
Comparison Compare (const PObject &obj) const
 Compare the two objects and return their relative rank. More...
 
PObjectClone () const
 Create a copy of the class on the heap. More...
 
- Public Member Functions inherited from PASN_Sequence
 PASN_Sequence (unsigned tag=UniversalSequence, TagClass tagClass=UniversalTagClass, unsigned nOpts=0, PBoolean extend=false, unsigned nExtend=0)
 
 PASN_Sequence (const PASN_Sequence &other)
 
PASN_Sequenceoperator= (const PASN_Sequence &other)
 
PINDEX GetSize () const
 
PBoolean SetSize (PINDEX newSize)
 
PASN_Objectoperator[] (PINDEX i) const
 
PBoolean HasOptionalField (PINDEX opt) const
 
void IncludeOptionalField (PINDEX opt)
 
void RemoveOptionalField (PINDEX opt)
 
virtual PString GetTypeAsString () const
 Return a string giving the type of the object. More...
 
virtual PBoolean IsPrimitive () const
 
PBoolean PreambleDecode (PASN_Stream &strm)
 
void PreambleEncode (PASN_Stream &strm) const
 
PBoolean KnownExtensionDecode (PASN_Stream &strm, PINDEX fld, PASN_Object &field)
 
void KnownExtensionEncode (PASN_Stream &strm, PINDEX fld, const PASN_Object &field) const
 
PBoolean UnknownExtensionsDecode (PASN_Stream &strm)
 
void UnknownExtensionsEncode (PASN_Stream &strm) const
 
PBoolean PreambleDecodeBER (PBER_Stream &strm)
 
void PreambleEncodeBER (PBER_Stream &strm) const
 
PBoolean KnownExtensionDecodeBER (PBER_Stream &strm, PINDEX fld, PASN_Object &field)
 
void KnownExtensionEncodeBER (PBER_Stream &strm, PINDEX fld, const PASN_Object &field) const
 
PBoolean UnknownExtensionsDecodeBER (PBER_Stream &strm)
 
void UnknownExtensionsEncodeBER (PBER_Stream &strm) const
 
PBoolean PreambleDecodePER (PPER_Stream &strm)
 
void PreambleEncodePER (PPER_Stream &strm) const
 
PBoolean KnownExtensionDecodePER (PPER_Stream &strm, PINDEX fld, PASN_Object &field)
 
void KnownExtensionEncodePER (PPER_Stream &strm, PINDEX fld, const PASN_Object &field) const
 
PBoolean UnknownExtensionsDecodePER (PPER_Stream &strm)
 
void UnknownExtensionsEncodePER (PPER_Stream &strm) const
 
virtual PBoolean PreambleDecodeXER (PXER_Stream &strm)
 
virtual void PreambleEncodeXER (PXER_Stream &strm) const
 
virtual PBoolean KnownExtensionDecodeXER (PXER_Stream &strm, PINDEX fld, PASN_Object &field)
 
virtual void KnownExtensionEncodeXER (PXER_Stream &strm, PINDEX fld, const PASN_Object &field) const
 
virtual PBoolean UnknownExtensionsDecodeXER (PXER_Stream &strm)
 
virtual void UnknownExtensionsEncodeXER (PXER_Stream &strm) const
 
- Public Member Functions inherited from PASN_Object
PINDEX GetObjectLength () const
 
PBoolean IsExtendable () const
 
void SetExtendable (PBoolean ext=true)
 
TagClass GetTagClass () const
 
unsigned GetTag () const
 
virtual void SetTag (unsigned newTag, TagClass tagClass=DefaultTagClass)
 
void SetConstraints (ConstraintType type, int value)
 
void SetConstraints (ConstraintType, int lower, MaximumValueTag)
 
void SetConstraints (ConstraintType, MinimumValueTag lower, unsigned upper)
 
void SetConstraints (ConstraintType, MinimumValueTag lower, MaximumValueTag upper)
 
void SetConstraints (ConstraintType type, int lower, unsigned upper)
 
virtual void SetConstraintBounds (ConstraintType type, int lower, unsigned upper)
 
virtual void SetCharacterSet (ConstraintType ctype, const char *charSet)
 
virtual void SetCharacterSet (ConstraintType ctype, unsigned firstChar, unsigned lastChar)
 
- Public Member Functions inherited from PObject
virtual ~PObject ()
 
virtual PINDEX HashFunction () const
 This function yields a hash value required by the PDictionary class. More...
 
virtual const char * GetClass (unsigned ancestor=0) const
 Get the current dynamic type of the object instance. More...
 
PBoolean IsClass (const char *cls) const
 
virtual PBoolean InternalIsDescendant (const char *clsName) const
 Determine if the dynamic type of the current instance is a descendent of the specified class. More...
 
virtual Comparison CompareObjectMemoryDirect (const PObject &obj) const
 Determine the byte wise comparison of two objects. More...
 
bool operator== (const PObject &obj) const
 Compare the two objects. More...
 
bool operator!= (const PObject &obj) const
 Compare the two objects. More...
 
bool operator< (const PObject &obj) const
 Compare the two objects. More...
 
bool operator> (const PObject &obj) const
 Compare the two objects. More...
 
bool operator<= (const PObject &obj) const
 Compare the two objects. More...
 
bool operator>= (const PObject &obj) const
 Compare the two objects. More...
 
virtual void ReadFrom (istream &strm)
 Input the contents of the object from the stream. More...
 

Public Attributes

PASN_Integer m_request_id
 
PASN_Integer m_error_status
 
PASN_Integer m_error_index
 
PSNMP_VarBindList m_variable_bindings
 

Additional Inherited Members

- Public Types inherited from PASN_Object
enum  TagClass {
  UniversalTagClass, ApplicationTagClass, ContextSpecificTagClass, PrivateTagClass,
  DefaultTagClass
}
 
enum  UniversalTags {
  InvalidUniversalTag, UniversalBoolean, UniversalInteger, UniversalBitString,
  UniversalOctetString, UniversalNull, UniversalObjectId, UniversalObjectDescriptor,
  UniversalExternalType, UniversalReal, UniversalEnumeration, UniversalEmbeddedPDV,
  UniversalSequence = 16, UniversalSet, UniversalNumericString, UniversalPrintableString,
  UniversalTeletexString, UniversalVideotexString, UniversalIA5String, UniversalUTCTime,
  UniversalGeneralisedTime, UniversalGeneralizedTime = UniversalGeneralisedTime, UniversalGraphicString, UniversalVisibleString,
  UniversalGeneralString, UniversalUniversalString, UniversalBMPString = 30
}
 
enum  ConstraintType { Unconstrained, PartiallyConstrained, FixedConstraint, ExtendableConstraint }
 
enum  MinimumValueTag { MinimumValue = INT_MIN }
 
enum  MaximumValueTag { MaximumValue = INT_MAX }
 
- Static Public Member Functions inherited from PASN_Object
static PINDEX GetMaximumArraySize ()
 
static void SetMaximumArraySize (PINDEX sz)
 
static PINDEX GetMaximumStringSize ()
 
static void SetMaximumStringSize (PINDEX sz)
 
- Protected Member Functions inherited from PASN_Sequence
PBoolean NoExtensionsToDecode (PPER_Stream &strm)
 
PBoolean NoExtensionsToEncode (PPER_Stream &strm)
 
- Protected Attributes inherited from PASN_Sequence
PASN_ObjectArray fields
 
PASN_BitString optionMap
 
int knownExtensions
 
int totalExtensions
 
PASN_BitString extensionMap
 
PINDEX endBasicEncoding
 
- Friends inherited from PObject

Constructor & Destructor Documentation

PSNMP_PDU::PSNMP_PDU ( unsigned  tag = UniversalSequence,
TagClass  tagClass = UniversalTagClass 
)

Member Function Documentation

PObject* PSNMP_PDU::Clone ( ) const
virtual

Create a copy of the class on the heap.

The exact semantics of the descendent class determine what is required to make a duplicate of the instance. Not all classes can even do a clone operation.

The main user of the clone function is the PDictionary class as it requires copies of the dictionary keys.

The default behaviour is for this function to assert.

Returns
pointer to new copy of the class instance.

Reimplemented from PASN_Sequence.

Reimplemented in PSNMP_SetRequest_PDU, PSNMP_GetResponse_PDU, PSNMP_GetNextRequest_PDU, and PSNMP_GetRequest_PDU.

Comparison PSNMP_PDU::Compare ( const PObject obj) const
virtual

Compare the two objects and return their relative rank.

This function is usually overridden by descendent classes to yield the ranking according to the semantics of the object.

The default function is to use the CompareObjectMemoryDirect() function to do a byte wise memory comparison of the two objects.

Returns
LessThan, EqualTo or GreaterThan according to the relative rank of the objects.

Reimplemented from PASN_Sequence.

PBoolean PSNMP_PDU::Decode ( PASN_Stream strm)
virtual

Reimplemented from PASN_Sequence.

void PSNMP_PDU::Encode ( PASN_Stream strm) const
virtual

Reimplemented from PASN_Sequence.

PINDEX PSNMP_PDU::GetDataLength ( ) const
virtual

Reimplemented from PASN_Sequence.

void PSNMP_PDU::PrintOn ( ostream &  strm) const
virtual

Output the contents of the object to the stream.

The exact output is dependent on the exact semantics of the descendent class. This is primarily used by the standard operator<< function.

The default behaviour is to print the class name.

Reimplemented from PASN_Sequence.

Member Data Documentation

PASN_Integer PSNMP_PDU::m_error_index
PASN_Integer PSNMP_PDU::m_error_status
PASN_Integer PSNMP_PDU::m_request_id
PSNMP_VarBindList PSNMP_PDU::m_variable_bindings

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