AgentXPdu Class Reference

#include <agentx_pdu.h>

List of all members.

Public Member Functions

 AgentXPdu ()
 Constructors.
 AgentXPdu (boolean, 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 boolean 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 boolean 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 boolean operator< (const AgentXPdu &) const
 operators
virtual boolean operator== (const AgentXPdu &) const
virtual boolean 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 boolean 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
boolean byteOrder
AgentXPeerpeer


Constructor & Destructor Documentation

AgentXPdu::AgentXPdu (  ) 

Constructors.

AgentXPdu::AgentXPdu ( boolean  ,
u_char   
)

Construct a pdu with a given byte order and type.

Parameters:
networkByteOrder if TRUE the pdu uses network byte order, if FALSE host byte order
type the type of the PDU

AgentXPdu::AgentXPdu ( const AgentXPdu  ) 

Copy constructor.


Member Function Documentation

virtual Pdux* AgentXPdu::clone (  )  const [inline, virtual]

Clone the receiver.

virtual void AgentXPdu::set_version ( u_char  v  )  [inline, virtual]

get/set Pdu's version

virtual u_char AgentXPdu::get_version (  )  const [inline, virtual]

virtual u_char AgentXPdu::get_flags (  )  const [inline, virtual]

Get/Set flags.

virtual void AgentXPdu::set_flags ( const u_char  f  )  [inline, virtual]

virtual u_int AgentXPdu::get_session_id (  )  const [inline, virtual]

get/set session id

virtual void AgentXPdu::set_session_id ( const u_int  i  )  [inline, virtual]

virtual u_int AgentXPdu::get_transaction_id (  )  const [inline, virtual]

get/set transaction id

virtual void AgentXPdu::set_transaction_id ( const u_int  i  )  [inline, virtual]

virtual u_int AgentXPdu::get_packet_id (  )  const [inline, virtual]

get/set packet id

virtual void AgentXPdu::set_packet_id ( const u_int  i  )  [inline, virtual]

virtual NS_SNMP OctetStr AgentXPdu::get_context (  )  const [inline, virtual]

get/set context

virtual void AgentXPdu::set_context ( const NS_SNMP OctetStr &  s  )  [inline, virtual]

virtual boolean AgentXPdu::non_default_context (  )  [inline, virtual]

virtual u_char AgentXPdu::get_timeout (  )  const [inline, virtual]

get/set timeout

virtual void AgentXPdu::set_timeout ( const u_char  c  )  [inline, virtual]

virtual u_char AgentXPdu::get_priority (  )  const [inline, virtual]

get/set priority

virtual void AgentXPdu::set_priority ( const u_char  c  )  [inline, virtual]

virtual u_char AgentXPdu::get_reason (  )  const [inline, virtual]

get/set reason

virtual void AgentXPdu::set_reason ( const u_char  c  )  [inline, virtual]

virtual AgentXRegion AgentXPdu::get_region (  )  const [inline, virtual]

get/set region (set returns SNMP_CLASS_SUCCESS on success)

virtual int AgentXPdu::set_region ( const Oidx &  o,
const int  sid,
const u_long  u 
) [inline, virtual]

virtual void AgentXPdu::set_region ( const AgentXRegion r  )  [inline, virtual]

virtual int AgentXPdu::get_range_count (  )  const [inline, virtual]

get/add oid range

AgentXSearchRange* AgentXPdu::range ( const int  i  )  [inline]

virtual AgentXSearchRange AgentXPdu::get_range ( const int  i  )  const [inline, virtual]

virtual void AgentXPdu::add_range ( const AgentXSearchRange r  )  [inline, virtual]

virtual int AgentXPdu::trim_ranges ( const int  n  )  [inline, virtual]

virtual void AgentXPdu::set_range ( AgentXSearchRange r,
const int  i 
) [inline, virtual]

virtual ListCursor<AgentXSearchRange> AgentXPdu::get_ranges (  )  [inline, virtual]

u_int AgentXPdu::get_non_repeaters (  )  const [inline]

get/set non repeaters

void AgentXPdu::set_non_repeaters ( const u_int  i  )  [inline]

void AgentXPdu::inc_non_repeaters (  )  [inline]

virtual u_int AgentXPdu::get_max_repetitions (  )  const [inline, virtual]

get/set max repetitions

virtual void AgentXPdu::set_max_repetitions ( u_int  i  )  [inline, virtual]

virtual time_t AgentXPdu::get_timestamp (  )  const [inline, virtual]

get/set error status

get/set error index get/set timestamp

virtual void AgentXPdu::set_timestamp ( time_t  t  )  [inline, virtual]

virtual time_t AgentXPdu::get_time (  )  const [inline, virtual]

get/set sysUpTime

virtual void AgentXPdu::set_time ( u_int  i  )  [inline, virtual]

virtual boolean AgentXPdu::network_byte_order (  )  const [inline, virtual]

u_char AgentXPdu::get_agentx_type (  )  const [inline]

void AgentXPdu::set_agentx_type ( u_char  t  ) 

Oidx AgentXPdu::get_id (  ) 

NS_SNMP OctetStr AgentXPdu::get_descr (  ) 

virtual AgentXPeer* AgentXPdu::get_peer (  )  [inline, virtual]

get/set AgentXPeer

virtual void AgentXPdu::set_peer ( AgentXPeer p  )  [inline, virtual]

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

operator =

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 boolean AgentXPdu::operator< ( const AgentXPdu  )  const [virtual]

operators

virtual boolean AgentXPdu::operator== ( const AgentXPdu  )  const [virtual]

virtual boolean AgentXPdu::operator> ( const AgentXPdu  )  const [virtual]

virtual int AgentXPdu::encode ( AgentXOctets  )  const [virtual]

encode/decode the Pdu

virtual int AgentXPdu::decode ( AgentXOctets  )  [virtual]

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 void AgentXPdu::copy_from ( const AgentXPdu  )  [protected, virtual]

virtual void AgentXPdu::encode_header ( AgentXOctets ,
int   
) const [protected, virtual]

virtual void AgentXPdu::encode_ranges ( AgentXOctets  )  const [protected, virtual]

virtual void AgentXPdu::decode_ranges ( AgentXOctets ,
u_int &   
) [protected, virtual]

virtual void AgentXPdu::encode_region ( AgentXOctets ,
const AgentXRegion  
) const [protected, virtual]

virtual AgentXRegion AgentXPdu::decode_region ( AgentXOctets ,
u_int &  ,
u_char   
) const [protected, virtual]

virtual void AgentXPdu::encode_vbs ( AgentXOctets ,
Vbx *  ,
const   int 
) const [protected, virtual]

virtual boolean AgentXPdu::decode_vbs ( AgentXOctets ,
u_int &   
) [protected, virtual]

virtual void AgentXPdu::encode_oids ( AgentXOctets ,
Vbx *  ,
const   int 
) const [protected, virtual]

virtual void AgentXPdu::decode_oids ( AgentXOctets ,
u_int &   
) [protected, virtual]

static AgentXOctets AgentXPdu::null_octets ( const   int  )  [static, protected]


Member Data Documentation

u_char AgentXPdu::version [protected]

u_int AgentXPdu::session_id [protected]

u_int AgentXPdu::packet_id [protected]

u_char AgentXPdu::ax_type [protected]

u_char AgentXPdu::flags [protected]

NS_SNMP OctetStr AgentXPdu::context [protected]

u_char AgentXPdu::timeout [protected]

u_char AgentXPdu::priority [protected]

u_char AgentXPdu::reason [protected]

time_t AgentXPdu::timestamp [protected]

u_int AgentXPdu::sysUpTime [protected]

boolean AgentXPdu::byteOrder [protected]


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

Generated on Tue May 26 23:32:15 2009 for AgentX++ by  doxygen 1.5.6