ACE/ASNMP/asnmp/oid.h

   1
   2
   3 #ifndef OID_CLS_
   4 #define OID_CLS_
   5 //=============================================================================
   6 /**
   7  *  @file    oid.h
   8  *
   9  * This class is fully contained and does not rely on or any other
  10  * SNMP libraries. This class is portable across any platform
  11  * which supports C++. Ported to ACE by Mike MacFaden mrm@cisco.com
  12  * and modified for MT. Some API cleanup: collapse constructors,
  13  * add suboid() method remove unnecessary overload, and update a few
  14  * names and types to improve clarity.
  15  *
  16  *  @author Peter E Mellquist
  17  */
  18 //=============================================================================
  19
  20 /*===================================================================
  21   Copyright (c) 1996
  22   Hewlett-Packard Company
  23
  24   ATTENTION: USE OF THIS SOFTWARE IS SUBJECT TO THE FOLLOWING TERMS.
  25   Permission to use, copy, modify, distribute and/or sell this software
  26   and/or its documentation is hereby granted without fee. User agrees
  27   to display the above copyright notice and this license notice in all
  28   copies of the software and any documentation of the software. User
  29   agrees to assume all liability for the use of the software; Hewlett-Packard
  30   makes no representations about the suitability of this software for any
  31   purpose. It is provided "AS-IS without warranty of any kind,either express
  32   or implied. User hereby grants a royalty-free license to any and all
  33   derivatives based upon this software code base.
  34 =====================================================================*/
  35
  36 //----------[ extern C libraries Needed ]---------------------------------
  37 #include "ace/config-all.h"
  38
  39 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  40 # pragma once
  41 #endif /* ACE_LACKS_PRAGMA_ONCE */
  42
  43 #include "asnmp/smival.h"                // derived class for all values
  44
  45 /**
  46  * @class Oid
  47  *
  48  * @brief Implement RFC 1155 Object Identifier (OID) datatype
  49  */
  50 class ASNMP_Export Oid : public  SnmpSyntax
  51 {
  52 public:
  53   /// constructor using a dotted string
  54   Oid( const char * dotted_oid_string = "", size_t size = unsigned(-1) );
  55
  56   /// constructor using another oid object
  57   Oid ( const Oid &oid);
  58
  59   /// constructor from raw form
  60   Oid(const unsigned long *raw_oid, size_t oid_len);
  61
  62   /// destructor
  63   ~Oid();
  64
  65   /// syntax type
  66   SmiUINT32 get_syntax();
  67
  68   /// assignment to another oid object overloaded
  69   Oid& operator=( const Oid &oid);
  70
  71   /// equal operator overloaded
  72   friend ASNMP_Export bool operator==( const Oid &lhs,const Oid &rhs);
  73
  74   /// not equal operator overloaded
  75   friend ASNMP_Export bool operator!=( const Oid &lhs,const Oid &rhs);
  76
  77   /// less than < overloaded
  78   friend ASNMP_Export bool operator<( const Oid &lhs,const Oid &rhs);
  79
  80   /// less than <= overloaded
  81   friend ASNMP_Export bool operator<=( const Oid &lhs,const Oid &rhs);
  82
  83   /// greater than > overloaded
  84   friend ASNMP_Export bool operator>( const Oid &lhs,const Oid &rhs);
  85
  86   /// greater than >= overloaded
  87   friend ASNMP_Export bool operator>=( const Oid &lhs,const Oid &rhs);
  88
  89   /// append operator, appends a string
  90   Oid& operator+=( const char *a);
  91
  92   /// appends an int
  93   Oid& operator+=( const unsigned long i);
  94
  95   /// appends an Oid
  96   Oid& operator+=( const Oid &o);
  97
  98   /// allows element access
  99   unsigned long & operator[]( size_t position);
 100
 101   /// return the WinSnmp oid part
 102   SmiLPOID oidval();
 103
 104   /// reset the data from raw 1 byte format
 105   void set_data( const char *dotted_oid_string);
 106
 107   /// reset the data from raw 4byte integer format
 108   void set_data( const unsigned long *raw_oid, const size_t oid_len);
 109
 110   /// return the len of the oid
 111   size_t length() const;
 112
 113   /// trim off the n rightmost values of an oid
 114   void trim( const size_t how_many = 1);
 115
 116   /// the equivalent of a substr(new_str, 0, 1)
 117   int suboid(Oid& oid, size_t start = 0, size_t how_many = size_t (-1));
 118
 119   /**
 120    * compare the n leftmost bytes (left-to-right)
 121    * returns 0, equal
 122    * returns -1, <
 123    * returns 1 , >
 124    */
 125   int left_comparison( const unsigned long n, const Oid &o) const;
 126
 127
 128   /**
 129    * compare the n rightmost bytes (right-to-left)
 130    * returns 0, equal
 131    * returns -1, <
 132    * returns 1 , >
 133    */
 134   int right_comparison( const unsigned long n, const Oid &o) const;
 135
 136   /// is the Oid object valid
 137   int valid() const;
 138
 139   /// return dotted string value from the right
 140   /// where the user specifies how many positions to print
 141   const char *to_string();
 142
 143   /// create a new instance of this Value
 144   SnmpSyntax *clone() const;
 145
 146   /// copy an instance of this Value
 147   SnmpSyntax& operator=( SnmpSyntax &val);
 148
 149 protected:
 150   /// used for returning oid string
 151   char *iv_str;
 152
 153   /// convert a string to an smi oid
 154   int StrToOid( const char *string, SmiLPOID dstOid, size_t& how_many_bytes);
 155
 156   /// clone an smi oid
 157   int OidCopy(  SmiLPOID srcOid, SmiLPOID dstOid, size_t& how_many_bytes);
 158
 159   /// convert an smi oid to its string representation
 160   int OidToStr(SmiLPOID srcOid, SmiUINT32 size, char *string,  size_t& how_many_bytes);
 161
 162   private:
 163     /// release memory, re-init data members
 164     void set_invalid();
 165
 166     /// initialize object data members
 167     void set_null();
 168     void init_value( const SmiLPOID srcOid, size_t len);
 169     void init_value(const unsigned long *raw_oid, size_t oid_len);
 170 };
 171
 172 #endif //OID_CLS_