diff options
Diffstat (limited to 'ASNMP/asnmp/wpdu.h')
| -rw-r--r-- | ASNMP/asnmp/wpdu.h | 59 |
1 files changed, 29 insertions, 30 deletions
diff --git a/ASNMP/asnmp/wpdu.h b/ASNMP/asnmp/wpdu.h index 1485560baeb..7feec356bc8 100644 --- a/ASNMP/asnmp/wpdu.h +++ b/ASNMP/asnmp/wpdu.h @@ -1,24 +1,21 @@ /* -*-C++-*- */ -// $Id$ #ifndef WPDU_H_ #define WPDU_H_ -// ============================================================================ -// -// = LIBRARY -// asnmp -// -// = FILENAME -// wpdu.h -// -// = DESCRIPTION -// Adapter class. Converts a Pdu and GenTarget into a format -// that can be stuffed out a I/O port -// -// = AUTHOR -// Michael R. MacFaden re-worked api, use ACE API -// Peter E Mellquist wrote original class snmpmsg -// -// ============================================================================ +//============================================================================= +/** + * @file wpdu.h + * + * $Id$ + * + * Adapter class. Converts a Pdu and GenTarget into a format + * that can be stuffed out a I/O port + * + * + * @author Michael R. MacFaden re-worked api + * @author use ACE APIPeter E Mellquist wrote original class snmpmsg + */ +//============================================================================= + #include "ace/config-all.h" @@ -34,32 +31,34 @@ // PDU / Target -> iovec buffer // iovec buffer -> PDU / Target struct snmp_pdu; +/** + * @class wpdu + * + * @brief Implement an Adapter pattern between CMU SNMP and HP SNMP++ + */ class ASNMP_Export wpdu - // = TITLE - // Implement an Adapter pattern between CMU SNMP and HP SNMP++ - // { public: + /// construct CMU data from HP SNMP++ objects + /// construct HP SNMP++ objects from raw buffer via CMU SNMP datatypes wpdu(const Pdu& pdu, const UdpTarget& target); - // construct CMU data from HP SNMP++ objects wpdu(const iovec& buffer); - // construct HP SNMP++ objects from raw buffer via CMU SNMP datatypes wpdu(); // same as using iovec? ~wpdu(); + /// constructor completed ok? rc = 1 else 0 int valid() const; - // constructor completed ok? rc = 1 else 0 + /// return raw data stream via CMU code const iovec& get_buffer() const; - // return raw data stream via CMU code + /// return HP SNMP++ pdu int get_pdu(Pdu& pdu, snmp_version& version); - // return HP SNMP++ pdu + /// return community strptr const unsigned char *get_community() const; - // return community strptr private: int convert_vb_to_smival( Vb &tempvb, SmiVALUE *smival ); @@ -69,14 +68,14 @@ private: static void copy_iovec(iovec& dest, const iovec& src); int set_trap_info(snmp_pdu *raw_pdu, const Pdu& pdu) const; + /// raw format iovec iovec_; - // raw format + /// object construction state int valid_flag_; - // object construction state + /// snmp version snmp_version version_; - // snmp version unsigned char community_name[MAX_COMM_STR_LEN]; unsigned long comm_len; // = MAX_COMM_STR_LEN; |