AgentX++  2.0.5
Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
AgentXPdu Class Reference

#include <agentx_pdu.h>

Inheritance diagram for AgentXPdu:

Public Member Functions

 AgentXPdu ()
 Constructors.
 
 AgentXPdu (bool, u_char)
 Construct a pdu with a given byte order and type.
 
 AgentXPdu (const AgentXPdu &)
 Copy constructor.
 
virtual Pdux * clone () const
 Clone the receiver.
 
virtual void set_version (u_char v)
 get/set Pdu's version
 
virtual u_char get_version () const
 
virtual u_char get_flags () const
 Get/Set flags.
 
virtual void set_flags (const u_char f)
 
virtual u_int get_session_id () const
 get/set session id
 
virtual void set_session_id (const u_int i)
 
virtual u_int get_transaction_id () const
 get/set transaction id
 
virtual void set_transaction_id (const u_int i)
 
virtual u_int get_packet_id () const
 get/set packet id
 
virtual void set_packet_id (const u_int i)
 
virtual NS_SNMP OctetStr get_context () const
 get/set context
 
virtual void set_context (const NS_SNMP OctetStr &s)
 
virtual bool non_default_context ()
 
virtual u_char get_timeout () const
 get/set timeout
 
virtual void set_timeout (const u_char c)
 
virtual u_char get_priority () const
 get/set priority
 
virtual void set_priority (const u_char c)
 
virtual u_char get_reason () const
 get/set reason
 
virtual void set_reason (const u_char c)
 
virtual AgentXRegion get_region () const
 get/set region (set returns SNMP_CLASS_SUCCESS on success)
 
virtual int set_region (const Oidx &o, const int sid, const u_long u)
 
virtual void set_region (const AgentXRegion &r)
 
virtual int get_range_count () const
 get/add oid range
 
AgentXSearchRangerange (const int i)
 
virtual AgentXSearchRange get_range (const int i) const
 
virtual void add_range (const AgentXSearchRange &r)
 
virtual int trim_ranges (const int n)
 
virtual void set_range (AgentXSearchRange *r, const int i)
 
virtual ListCursor
< AgentXSearchRange
get_ranges ()
 
u_int get_non_repeaters () const
 get/set non repeaters
 
void set_non_repeaters (const u_int i)
 
void inc_non_repeaters ()
 
virtual u_int get_max_repetitions () const
 get/set max repetitions
 
virtual void set_max_repetitions (u_int i)
 
virtual time_t get_timestamp () const
 get/set error status
 
virtual void set_timestamp (time_t t)
 
virtual time_t get_time () const
 get/set sysUpTime
 
virtual void set_time (u_int i)
 
virtual bool network_byte_order () const
 
u_char get_agentx_type () const
 
void set_agentx_type (u_char t)
 
Oidx get_id ()
 
NS_SNMP OctetStr get_descr ()
 
virtual AgentXPeerget_peer ()
 get/set AgentXPeer
 
virtual void set_peer (AgentXPeer *p)
 
virtual AgentXPduoperator= (const AgentXPdu &)
 operator =
 
virtual AgentXPduoperator+= (const Vbx &)
 Adds a variable binding even if its OID is a zero length OID, because these are valid OIDs in AgentX.
 
virtual bool operator< (const AgentXPdu &) const
 operators
 
virtual bool operator== (const AgentXPdu &) const
 
virtual bool operator> (const AgentXPdu &) const
 
virtual int encode (AgentXOctets &) const
 encode/decode the Pdu
 
virtual int decode (AgentXOctets &)
 
virtual void build_vbs_from_ranges ()
 For each search range in the receiver, create a variable binding with the lower bound of the search range as oid and null as value.
 

Protected Member Functions

virtual void copy_from (const AgentXPdu &)
 
virtual void encode_header (AgentXOctets &, int) const
 
virtual void encode_ranges (AgentXOctets &) const
 
virtual void decode_ranges (AgentXOctets &, u_int &)
 
virtual void encode_region (AgentXOctets &, const AgentXRegion &) const
 
virtual AgentXRegion decode_region (AgentXOctets &, u_int &, u_char) const
 
virtual void encode_vbs (AgentXOctets &, Vbx *, const int) const
 
virtual bool decode_vbs (AgentXOctets &, u_int &)
 
virtual void encode_oids (AgentXOctets &, Vbx *, const int) const
 
virtual void decode_oids (AgentXOctets &, u_int &)
 

Static Protected Member Functions

static AgentXOctets null_octets (const int)
 

Protected Attributes

u_char version
 
u_int session_id
 
u_int packet_id
 
u_char ax_type
 
u_char flags
 
NS_SNMP OctetStr context
 
u_char timeout
 
u_char priority
 
u_char reason
 
AgentXRegion region
 
List< AgentXSearchRangeranges
 
time_t timestamp
 
u_int sysUpTime
 
bool byteOrder
 
AgentXPeerpeer
 

Constructor & Destructor Documentation

AgentXPdu::AgentXPdu ( )

Constructors.

AgentXPdu::AgentXPdu ( bool  ,
u_char   
)

Construct a pdu with a given byte order and type.

Parameters
networkByteOrderif TRUE the pdu uses network byte order, if FALSE host byte order
typethe type of the PDU
AgentXPdu::AgentXPdu ( const AgentXPdu )

Copy constructor.

Member Function Documentation

virtual void AgentXPdu::add_range ( const AgentXSearchRange r)
inlinevirtual
virtual void AgentXPdu::build_vbs_from_ranges ( )
virtual

For each search range in the receiver, create a variable binding with the lower bound of the search range as oid and null as value.

virtual Pdux* AgentXPdu::clone ( ) const
inlinevirtual

Clone the receiver.

virtual void AgentXPdu::copy_from ( const AgentXPdu )
protectedvirtual
virtual int AgentXPdu::decode ( AgentXOctets )
virtual
virtual void AgentXPdu::decode_oids ( AgentXOctets ,
u_int &   
)
protectedvirtual
virtual void AgentXPdu::decode_ranges ( AgentXOctets ,
u_int &   
)
protectedvirtual
virtual AgentXRegion AgentXPdu::decode_region ( AgentXOctets ,
u_int &  ,
u_char   
) const
protectedvirtual
virtual bool AgentXPdu::decode_vbs ( AgentXOctets ,
u_int &   
)
protectedvirtual
virtual int AgentXPdu::encode ( AgentXOctets ) const
virtual

encode/decode the Pdu

virtual void AgentXPdu::encode_header ( AgentXOctets ,
int   
) const
protectedvirtual
virtual void AgentXPdu::encode_oids ( AgentXOctets ,
Vbx *  ,
const int   
) const
protectedvirtual
virtual void AgentXPdu::encode_ranges ( AgentXOctets ) const
protectedvirtual
virtual void AgentXPdu::encode_region ( AgentXOctets ,
const AgentXRegion  
) const
protectedvirtual
virtual void AgentXPdu::encode_vbs ( AgentXOctets ,
Vbx *  ,
const int   
) const
protectedvirtual
u_char AgentXPdu::get_agentx_type ( ) const
inline
virtual NS_SNMP OctetStr AgentXPdu::get_context ( ) const
inlinevirtual

get/set context

NS_SNMP OctetStr AgentXPdu::get_descr ( )
virtual u_char AgentXPdu::get_flags ( ) const
inlinevirtual

Get/Set flags.

Oidx AgentXPdu::get_id ( )
virtual u_int AgentXPdu::get_max_repetitions ( ) const
inlinevirtual

get/set max repetitions

u_int AgentXPdu::get_non_repeaters ( ) const
inline

get/set non repeaters

virtual u_int AgentXPdu::get_packet_id ( ) const
inlinevirtual

get/set packet id

virtual AgentXPeer* AgentXPdu::get_peer ( )
inlinevirtual

get/set AgentXPeer

virtual u_char AgentXPdu::get_priority ( ) const
inlinevirtual

get/set priority

virtual AgentXSearchRange AgentXPdu::get_range ( const int  i) const
inlinevirtual
virtual int AgentXPdu::get_range_count ( ) const
inlinevirtual

get/add oid range

virtual ListCursor<AgentXSearchRange> AgentXPdu::get_ranges ( )
inlinevirtual
virtual u_char AgentXPdu::get_reason ( ) const
inlinevirtual

get/set reason

virtual AgentXRegion AgentXPdu::get_region ( ) const
inlinevirtual

get/set region (set returns SNMP_CLASS_SUCCESS on success)

virtual u_int AgentXPdu::get_session_id ( ) const
inlinevirtual

get/set session id

virtual time_t AgentXPdu::get_time ( ) const
inlinevirtual

get/set sysUpTime

virtual u_char AgentXPdu::get_timeout ( ) const
inlinevirtual

get/set timeout

virtual time_t AgentXPdu::get_timestamp ( ) const
inlinevirtual

get/set error status

get/set error index get/set timestamp

virtual u_int AgentXPdu::get_transaction_id ( ) const
inlinevirtual

get/set transaction id

virtual u_char AgentXPdu::get_version ( ) const
inlinevirtual
void AgentXPdu::inc_non_repeaters ( )
inline
virtual bool AgentXPdu::network_byte_order ( ) const
inlinevirtual
virtual bool AgentXPdu::non_default_context ( )
inlinevirtual
static AgentXOctets AgentXPdu::null_octets ( const int  )
staticprotected
virtual AgentXPdu& AgentXPdu::operator+= ( const Vbx &  )
virtual

Adds a variable binding even if its OID is a zero length OID, because these are valid OIDs in AgentX.

Since
1.4.11
virtual bool AgentXPdu::operator< ( const AgentXPdu ) const
virtual

operators

virtual AgentXPdu& AgentXPdu::operator= ( const AgentXPdu )
virtual

operator =

virtual bool AgentXPdu::operator== ( const AgentXPdu ) const
virtual
virtual bool AgentXPdu::operator> ( const AgentXPdu ) const
virtual
AgentXSearchRange* AgentXPdu::range ( const int  i)
inline
void AgentXPdu::set_agentx_type ( u_char  t)
virtual void AgentXPdu::set_context ( const NS_SNMP OctetStr &  s)
inlinevirtual
virtual void AgentXPdu::set_flags ( const u_char  f)
inlinevirtual
virtual void AgentXPdu::set_max_repetitions ( u_int  i)
inlinevirtual
void AgentXPdu::set_non_repeaters ( const u_int  i)
inline
virtual void AgentXPdu::set_packet_id ( const u_int  i)
inlinevirtual
virtual void AgentXPdu::set_peer ( AgentXPeer p)
inlinevirtual
virtual void AgentXPdu::set_priority ( const u_char  c)
inlinevirtual
virtual void AgentXPdu::set_range ( AgentXSearchRange r,
const int  i 
)
inlinevirtual
virtual void AgentXPdu::set_reason ( const u_char  c)
inlinevirtual
virtual int AgentXPdu::set_region ( const Oidx &  o,
const int  sid,
const u_long  u 
)
inlinevirtual
virtual void AgentXPdu::set_region ( const AgentXRegion r)
inlinevirtual
virtual void AgentXPdu::set_session_id ( const u_int  i)
inlinevirtual
virtual void AgentXPdu::set_time ( u_int  i)
inlinevirtual
virtual void AgentXPdu::set_timeout ( const u_char  c)
inlinevirtual
virtual void AgentXPdu::set_timestamp ( time_t  t)
inlinevirtual
virtual void AgentXPdu::set_transaction_id ( const u_int  i)
inlinevirtual
virtual void AgentXPdu::set_version ( u_char  v)
inlinevirtual

get/set Pdu's version

virtual int AgentXPdu::trim_ranges ( const int  n)
inlinevirtual

Member Data Documentation

u_char AgentXPdu::ax_type
protected
bool AgentXPdu::byteOrder
protected
NS_SNMP OctetStr AgentXPdu::context
protected
u_char AgentXPdu::flags
protected
u_int AgentXPdu::packet_id
protected
AgentXPeer* AgentXPdu::peer
protected
u_char AgentXPdu::priority
protected
List<AgentXSearchRange> AgentXPdu::ranges
protected
u_char AgentXPdu::reason
protected
AgentXRegion AgentXPdu::region
protected
u_int AgentXPdu::session_id
protected
u_int AgentXPdu::sysUpTime
protected
u_char AgentXPdu::timeout
protected
time_t AgentXPdu::timestamp
protected
u_char AgentXPdu::version
protected

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