address.h
上传用户:uncom666
上传日期:2020-03-30
资源大小:1426k
文件大小:31k
源码类别:

SNMP编程

开发平台:

Visual C++

  1. /*_############################################################################
  2.   _## 
  3.   _##  address.h  
  4.   _##
  5.   _##  SNMP++v3.2.24
  6.   _##  -----------------------------------------------
  7.   _##  Copyright (c) 2001-2009 Jochen Katz, Frank Fock
  8.   _##
  9.   _##  This software is based on SNMP++2.6 from Hewlett Packard:
  10.   _##  
  11.   _##    Copyright (c) 1996
  12.   _##    Hewlett-Packard Company
  13.   _##  
  14.   _##  ATTENTION: USE OF THIS SOFTWARE IS SUBJECT TO THE FOLLOWING TERMS.
  15.   _##  Permission to use, copy, modify, distribute and/or sell this software 
  16.   _##  and/or its documentation is hereby granted without fee. User agrees 
  17.   _##  to display the above copyright notice and this license notice in all 
  18.   _##  copies of the software and any documentation of the software. User 
  19.   _##  agrees to assume all liability for the use of the software; 
  20.   _##  Hewlett-Packard and Jochen Katz make no representations about the 
  21.   _##  suitability of this software for any purpose. It is provided 
  22.   _##  "AS-IS" without warranty of any kind, either express or implied. User 
  23.   _##  hereby grants a royalty-free license to any and all derivatives based
  24.   _##  upon this software code base. 
  25.   _##  
  26.   _##  Stuttgart, Germany, Fri May 29 22:35:14 CEST 2009 
  27.   _##  
  28.   _##########################################################################*/
  29. /*
  30.   Copyright (c) 1999
  31.   Hewlett-Packard Company
  32.   ATTENTION: USE OF THIS SOFTWARE IS SUBJECT TO THE FOLLOWING TERMS.
  33.   Permission to use, copy, modify, distribute and/or sell this software
  34.   and/or its documentation is hereby granted without fee. User agrees
  35.   to display the above copyright notice and this license notice in all
  36.   copies of the software and any documentation of the software. User
  37.   agrees to assume all liability for the use of the software; Hewlett-Packard
  38.   makes no representations about the suitability of this software for any
  39.   purpose. It is provided "AS-IS without warranty of any kind,either express
  40.   or implied. User hereby grants a royalty-free license to any and all
  41.   derivatives based upon this software code base.
  42.   SNMP++ A D D R E S S . H
  43.   ADDRESS CLASS DEFINITION
  44.   DESIGN + AUTHOR:   Peter E Mellquist
  45.   DESCRIPTION:
  46.   Address class definition. Encapsulates various network
  47.   addresses into easy to use, safe and portable classes.
  48. =====================================================================*/
  49. // $Id: address.h 307 2007-09-14 20:01:45Z katz $
  50. #ifndef _ADDRESS
  51. #define _ADDRESS
  52. //----[ includes ]-----------------------------------------------------
  53. #include <string.h>
  54. #if defined (CPU) && CPU == PPC603
  55. #undef HASH1
  56. #undef HASH2
  57. #else
  58. #include <memory.h>
  59. #endif
  60. #include "snmp_pp/config_snmp_pp.h" // for _IPX_ADDRESS and _MAC_ADDRESS
  61. #include "snmp_pp/smival.h"
  62. #include "snmp_pp/collect.h"
  63. #include "snmp_pp/reentrant.h"
  64. // include sockets header files
  65. // for Windows16 and Windows32 include Winsock
  66. // otherwise assume UNIX
  67. #if defined (CPU) && CPU == PPC603
  68. #include <inetLib.h>
  69. #include <hostLib.h>
  70. #endif
  71. #ifdef __unix
  72. #if !defined(_AIX) && !defined(__QNX_NEUTRINO)
  73. #include <unistd.h>
  74. #endif
  75. #include <sys/socket.h>
  76. #include <netinet/in.h>
  77. #include <netdb.h>
  78. #include <arpa/inet.h>
  79. #if defined _AIX
  80. #include <strings.h> // This is needed for FD_SET, bzero
  81. #endif
  82. #if !defined __CYGWIN32__ && !defined __hpux && !defined linux && !defined _AIX
  83. extern int h_errno;  // defined in WinSock header, but not for UX?!
  84. #endif
  85. #endif // __unix
  86. #ifdef SNMP_PP_NAMESPACE
  87. namespace Snmp_pp {
  88. #endif
  89. //----[ macros ]-------------------------------------------------------
  90. #define ADDRBUF 50     // worst case of address lens
  91. #define OUTBUFF 80     // worst case of output lens
  92. #define IPLEN      4
  93. #define UDPIPLEN   6
  94. #define IP6LEN_NO_SCOPE   16
  95. #define IP6LEN_WITH_SCOPE 20
  96. #define UDPIP6LEN_NO_SCOPE   18
  97. #define UDPIP6LEN_WITH_SCOPE 22
  98. #define IS_IP6LEN(n) ((n==16) || (n==20))
  99. #define IS_UDPIP6LEN(n) ((n==18) || (n==22))
  100. #define IPXLEN     10
  101. #define IPXSOCKLEN 12
  102. #define MACLEN     6
  103. #define MAX_FRIENDLY_NAME 80
  104. #define HASH0 19
  105. #define HASH1 13
  106. #define HASH2 7
  107. //---[ forward declarations ]-----------------------------------------
  108. class GenAddress;
  109. //----[ Address class ]-----------------------------------------------
  110. /**
  111.  * Base class of all Address classes.
  112.  */
  113. class DLLOPT Address : public SnmpSyntax
  114. {
  115.   friend class GenAddress;
  116.  public:
  117.   //----[ enumerated types for address types ]---------------------------
  118.   /**
  119.    * Type returned by Address::get_type().
  120.    */
  121.   enum addr_type
  122.   {
  123.     type_ip,      ///< IpAddress (IPv4 or IPv6)
  124.     type_ipx,     ///< IpxAddress
  125.     type_udp,     ///< UdpAddress (IPv4 or IPv6)
  126.     type_ipxsock, ///< IpxSockAddress
  127.     type_mac,     ///< MacAddress
  128.     type_invalid  ///< Used by GenAddress::get_type() if address is not valid
  129.   };
  130.   /**
  131.    * Type returned by IpAddress::get_ip_version() and
  132.    * UdpAddress::get_ip_version().
  133.    */
  134.   enum version_type
  135.   {
  136.     version_ipv4, ///< IPv4
  137.     version_ipv6  ///< IPv6
  138.   };
  139.   /**
  140.    * Default constructor, clears the buffer and sets valid flag to false.
  141.    */
  142.   Address();
  143.   /**
  144.    * Allow destruction of derived classes.
  145.    */
  146.   virtual ~Address() {};
  147.   /// overloaded equivlence operator, are two addresses equal?
  148.   DLLOPT friend int operator==(const Address &lhs,const Address &rhs);
  149.   /// overloaded not equivlence operator, are two addresses not equal?
  150.   DLLOPT friend int operator!=(const Address &lhs, const Address &rhs)
  151.     { return !(lhs == rhs); };
  152.   /// overloaded > operator, is a1 > a2
  153.   DLLOPT friend int operator>(const Address &lhs,const Address &rhs);
  154.   /// overloaded >= operator, is a1 >= a2
  155.   DLLOPT friend int operator>=(const Address &lhs,const Address &rhs)
  156.     { if ((lhs > rhs) || (lhs == rhs)) return true;  return false; };
  157.   /// overloaded < operator, is a1 < a2
  158.   DLLOPT friend int operator<(const Address &lhs,const Address &rhs);
  159.   /// overloaded <= operator, is a1 <= a2
  160.   DLLOPT friend int operator<=(const Address &lhs, const Address &rhs)
  161.     { if ((lhs < rhs) || (lhs == rhs)) return true; return false; };
  162.   /// equivlence operator overloaded, are an address and a string equal?
  163.   DLLOPT friend int operator==(const Address &lhs,const char *rhs);
  164.   /// overloaded not equivlence operator, are an address and string not equal?
  165.   DLLOPT friend int operator!=(const Address &lhs,const char *rhs)
  166.     { return !(lhs == rhs); };
  167.   /// overloaded < , is an address greater than a string?
  168.   DLLOPT friend int operator>(const Address &lhs,const char *rhs);
  169.   /// overloaded >=, is an address greater than or equal to a string?
  170.   DLLOPT friend int operator>=(const Address &lhs,const char *rhs);
  171.   /// overloaded < , is an address less than a string?
  172.   DLLOPT friend int operator<(const Address &lhs,const char *rhs);
  173.   /// overloaded <=, is an address less than or equal to a string?
  174.   DLLOPT friend int operator<=(const Address &lhs,const char *rhs);
  175.   /**
  176.    * Overloaded operator for streaming output.
  177.    *
  178.    * @return String containing the numerical address
  179.    */
  180.   virtual operator const char *() const = 0;
  181.   /**
  182.    * Return if the object contains a valid address.
  183.    *
  184.    * @return true if the object is valid
  185.    */
  186.   virtual bool valid() const { return valid_flag; };
  187.   /**
  188.    * Return the space needed for serialization.
  189.    */
  190.   virtual int get_asn1_length() const = 0;
  191.   /**
  192.    * Access as an array (read and write).
  193.    * @note Only pass in values between 0 and get_length().
  194.    *
  195.    * @param position - pos to return
  196.    * @return reference to the byte at the given position
  197.    */
  198.   unsigned char& operator[](const int position)
  199.     { addr_changed = true; valid_flag = true;
  200.       return (position < ADDRBUF) ? address_buffer[position]
  201.                                   : address_buffer[0]; };
  202.   /**
  203.    * Access as an array (read only).
  204.    * @note Only pass in values between 0 and get_length().
  205.    *
  206.    * @param position - pos to return
  207.    * @return the byte at the given position
  208.    */
  209.   unsigned char operator[](const int position) const
  210.     { return (position < ADDRBUF) ? address_buffer[ position] : 0; }
  211.   /**
  212.    * Get the length of the binary address (accessible through operator[]).
  213.    */
  214.   virtual int get_length() const = 0;
  215.   /**
  216.    * Get the type of the address.
  217.    * @see Address::addr_type
  218.    */
  219.   virtual addr_type get_type() const = 0;
  220.   /**
  221.    * Overloaded assignment operator.
  222.    */
  223.   virtual SnmpSyntax& operator=(const SnmpSyntax &val) = 0;
  224.   // return a hash key
  225.   virtual unsigned int hashFunction() const { return 0;};
  226.  protected:
  227.   SNMP_PP_MUTABLE bool addr_changed;
  228.   bool valid_flag;
  229.   unsigned char address_buffer[ADDRBUF]; // internal representation
  230.   // parse the address string
  231.   // redefined for each specific address subclass
  232.   virtual bool parse_address(const char * inaddr) = 0;
  233.   // format the output
  234.   // redefined for each specific address subclass
  235.   virtual void format_output() const = 0;
  236.   /**
  237.    * Trim of whitespaces at the start and the end of the string.
  238.    *
  239.    * @param ptr - string to trim
  240.    */
  241.   void trim_white_space(char * ptr);
  242.   /**
  243.    * Is this a GenAddress object.
  244.    */
  245.   virtual bool is_gen_address() const { return false; };
  246.   /**
  247.    * Reset the object.
  248.    */
  249.   void clear();
  250. #if !defined HAVE_GETHOSTBYNAME_R || !defined HAVE_GETHOSTBYADDR_R || !defined HAVE_REENTRANT_GETHOSTBYNAME || !defined HAVE_REENTRANT_GETHOSTBYADDR
  251. #ifdef _THREADS
  252.   static SnmpSynchronized syscall_mutex;
  253. #endif
  254. #endif
  255. };
  256. //-----------------------------------------------------------------------
  257. //---------[ IP Address Class ]------------------------------------------
  258. //-----------------------------------------------------------------------
  259. class DLLOPT IpAddress : public Address
  260. {
  261.  public:
  262.   /**
  263.    * Construct an empty invalid IP address.
  264.    */
  265.   IpAddress();
  266.   /**
  267.    * Construct an IP address from a string.
  268.    *
  269.    * The following formats can be used:
  270.    * - hostname with or without domain ("www.agentpp.com", "printsrv")
  271.    * - Numerical IPv4 address ("192.168.17.1")
  272.    * - Numerical IPv6 address ("abcd:1234::a:b:1", "::abcd:1")
  273.    * - Numerical IPv6 address with scope ("abcd:1234::a:b:1%3", "::abcd:1%1")
  274.    *
  275.    * @param inaddr - Hostname or IP address
  276.    */
  277.   IpAddress(const char *inaddr);
  278.   /**
  279.    * Construct an IP address from another IP address.
  280.    *
  281.    * @param ipaddr - address to copy
  282.    */
  283.   IpAddress(const IpAddress &ipaddr);
  284.   /**
  285.    * Construct an IP address from a GenAddress.
  286.    *
  287.    * @param genaddr - address to copy
  288.    */
  289.   IpAddress(const GenAddress &genaddr);
  290.   /**
  291.    * Destructor (ensure that SnmpSyntax::~SnmpSyntax() is overridden).
  292.    */
  293.   ~IpAddress() {};
  294.   /**
  295.    * Map other SnmpSyntax objects to IpAddress.
  296.    */
  297.   SnmpSyntax& operator=(const SnmpSyntax &val);
  298.   /**
  299.    * Overloaded assignment operator for other IP addresses.
  300.    */
  301.   IpAddress& operator=(const IpAddress &ipaddress);
  302.   /**
  303.    * Overloaded assignment operator for strings.
  304.    */
  305.   IpAddress& operator=(const char *inaddr);
  306.   /**
  307.    * Clone this object.
  308.    *
  309.    * @return Pointer to the newly created object (allocated through new).
  310.    */
  311.   SnmpSyntax *clone() const { return (SnmpSyntax *) new IpAddress(*this); };
  312.   /**
  313.    * Return the friendly name. Does a reverse DNS lookup for the IP address.
  314.    *
  315.    * @param status - The errno value for the lookup
  316.    *
  317.    * @return the friendly name or a zero length string (no null pointer)
  318.    */
  319.   char *friendly_name(int &status);
  320.   /**
  321.    * Get a printable ASCII value of the address.
  322.    *
  323.    * @return String containing the numerical address
  324.    */
  325.   virtual const char *get_printable() const
  326.     { if (addr_changed) format_output(); return output_buffer; };
  327.   /**
  328.    * Overloaded operator for streaming output.
  329.    *
  330.    * @return String containing the numerical address
  331.    */
  332.   virtual operator const char *() const
  333.     { if (addr_changed) format_output(); return output_buffer; };
  334.   /**
  335.    * Logically AND the address with the param.
  336.    *
  337.    * @param ipaddr - address to use as mask
  338.    */
  339.   void mask(const IpAddress &ipaddr);
  340.   /**
  341.    * Get the count of matching bits from the left.
  342.    *
  343.    * @param match_ip - address to match with
  344.    */
  345.   int get_match_bits(const IpAddress match_ip) const;
  346.   /**
  347.    * Get the length of the binary address (accessible through operator[]).
  348.    */
  349.   virtual int get_length() const
  350.     { return (ip_version == version_ipv4) ? IPLEN : 
  351.      (have_ipv6_scope ? IP6LEN_WITH_SCOPE : IP6LEN_NO_SCOPE); };
  352.   /**
  353.    * Return the type of the address.
  354.    * @see Address::addr_type
  355.    * @return Always Address:type_ip
  356.    */
  357.   virtual addr_type get_type() const { return type_ip; };
  358.   /**
  359.    * Return the syntax.
  360.    *
  361.    * @return This method always returns sNMP_SYNTAX_IPADDR.
  362.    */
  363.   virtual SmiUINT32 get_syntax() const { return sNMP_SYNTAX_IPADDR; };
  364.   /**
  365.    * Return the space needed for serialization.
  366.    */
  367.   virtual int get_asn1_length() const
  368.     { return get_length() + 2; };
  369.   /**
  370.    * Return the IP version of the address.
  371.    *
  372.    * @return one of Address::version_type
  373.    */
  374.   virtual version_type get_ip_version() const { return ip_version; };
  375.   /**
  376.    * Map a IPv4 address to a IPv6 address.
  377.    *
  378.    * @return - TRUE if no error occured.
  379.    */
  380.   virtual int map_to_ipv6();
  381.   /**
  382.    * Get the IPv6 scope
  383.    */
  384.   virtual unsigned int get_scope() const;
  385.   /**
  386.    * Set the IPv6 scope
  387.    */
  388.   virtual bool set_scope(const unsigned int scope);
  389.   /**
  390.    * Reset the object.
  391.    */
  392.   void clear();
  393.   bool has_ipv6_scope() const
  394.       { return (ip_version == version_ipv6) && have_ipv6_scope; };
  395.  protected:
  396.   SNMP_PP_MUTABLE char output_buffer[OUTBUFF];           // output buffer
  397.   // friendly name storage
  398.   char iv_friendly_name[MAX_FRIENDLY_NAME];
  399.   int  iv_friendly_name_status;
  400.   // redefined parse address
  401.   // specific to IP addresses
  402.   virtual bool parse_address(const char *inaddr);
  403.   // redefined format output
  404.   // specific to IP addresses
  405.   virtual void format_output() const;
  406.   // parse a dotted string
  407.   int parse_dotted_ipstring(const char *inaddr);
  408.   // parse a coloned string
  409.   int parse_coloned_ipstring(const char *inaddr);
  410.   // using the currently defined address, do a DNS
  411.   // and try to fill up the name
  412.   int addr_to_friendly();
  413.   // support both ipv4 and ipv6 addresses
  414.   version_type ip_version;
  415.   bool have_ipv6_scope;
  416. };
  417. //------------------------------------------------------------------------
  418. //---------[ UDP Address Class ]------------------------------------------
  419. //------------------------------------------------------------------------
  420. class DLLOPT UdpAddress : public IpAddress
  421. {
  422.  public:
  423.   /**
  424.    * Construct an empty invalid UDP address.
  425.    */
  426.   UdpAddress();
  427.   /**
  428.    * Construct an UDP address from a string.
  429.    *
  430.    * The following formats can be used additional to those recognized by
  431.    * IpAdress:
  432.    * - Port added to IPv4 address with '/' or ':'
  433.    *   ("192.168.17.1:161", "192.168.17.1/161", "printsrv/161")
  434.    * - Port added to IPv6 address with '/' or using '[...]:'
  435.    *   ("::1/162", "[::1]/162", "[::1]:162")
  436.    *
  437.    * @param inaddr - Hostname or IP address
  438.    */
  439.   UdpAddress(const char *inaddr);
  440.   /**
  441.    * Construct an UDP address from another UDP address.
  442.    *
  443.    * @param udpaddr - address to copy
  444.    */
  445.   UdpAddress(const UdpAddress &udpaddr);
  446.   /**
  447.    * Construct an UDP address from a GenAddress.
  448.    *
  449.    * @param genaddr - address to copy
  450.    */
  451.   UdpAddress(const GenAddress &genaddr);
  452.   /**
  453.    * Construct an UDP address from a IP address.
  454.    * The port will be set to 0.
  455.    *
  456.    * @param ipaddr - address to copy
  457.    */
  458.   UdpAddress(const IpAddress &ipaddr);
  459.   /**
  460.    * Destructor (ensure that SnmpSyntax::~SnmpSyntax() is overridden).
  461.    */
  462.   ~UdpAddress() {};
  463.   /**
  464.    * Map other SnmpSyntax objects to UdpAddress.
  465.    */
  466.   SnmpSyntax& operator=(const SnmpSyntax &val);
  467.   /**
  468.    * Overloaded assignment operator for UdpAddress.
  469.    */
  470.   UdpAddress& operator=(const UdpAddress &udpaddr);
  471.   /**
  472.    * Overloaded assignment operator for IpAddress.
  473.    */
  474.   UdpAddress& operator=(const IpAddress &ipaddr);
  475.   /**
  476.    * Overloaded assignment operator for strings.
  477.    */
  478.   UdpAddress& operator=(const char *inaddr);
  479.   /**
  480.    * Return the syntax.
  481.    *
  482.    * @return This method always returns sNMP_SYNTAX_OCTETS.
  483.    */
  484.   SmiUINT32 get_syntax() const { return sNMP_SYNTAX_OCTETS; };
  485.   /**
  486.    * Return the space needed for serialization.
  487.    */
  488.   virtual int get_asn1_length() const
  489.     { return get_length() + 2; };
  490.   /**
  491.    * Clone this object.
  492.    *
  493.    * @return Pointer to the newly created object (allocated through new).
  494.    */
  495.   SnmpSyntax *clone() const { return (SnmpSyntax *) new UdpAddress(*this); };
  496.   /**
  497.    * Get a printable ASCII value of the address.
  498.    *
  499.    * @return String containing the numerical address
  500.    */
  501.   virtual const char *get_printable() const
  502.     { if (addr_changed) format_output(); return output_buffer; };
  503.   /**
  504.    * Overloaded operator for streaming output.
  505.    *
  506.    * @return String containing the numerical address
  507.    */
  508.   virtual operator const char *() const
  509.     { if (addr_changed) format_output(); return output_buffer; };
  510.   /**
  511.    * Set the port number.
  512.    *
  513.    * @note If the object is not valid(), the port may not be set.
  514.    */
  515.   void set_port(const unsigned short p);
  516.   /**
  517.    * Get the port number.
  518.    *
  519.    * @return The port number, or 0 is the object is not valid.
  520.    */
  521.   unsigned short get_port() const;
  522.   /**
  523.    * Get the length of the binary address (accessible through operator[]).
  524.    */
  525.   virtual int get_length() const
  526.     { return (ip_version == version_ipv4) ? UDPIPLEN : 
  527.              (have_ipv6_scope ? UDPIP6LEN_WITH_SCOPE : UDPIP6LEN_NO_SCOPE);};
  528.   /**
  529.    * Return the type of the address.
  530.    * @see Address::addr_type
  531.    * @return Always Address:type_udp
  532.    */
  533.   virtual addr_type get_type() const { return type_udp; };
  534.   /**
  535.    * Map a IPv4 UDP address to a IPv6 UDP address.
  536.    *
  537.    * @return - TRUE if no error occured.
  538.    */
  539.   virtual int map_to_ipv6();
  540.   /**
  541.    * Reset the object.
  542.    */
  543.   void clear()
  544.     { Address::clear(); memset(output_buffer, 0, sizeof(output_buffer)); };
  545.   /**
  546.    * Set the IPv6 scope
  547.    */
  548.   virtual bool set_scope(const unsigned int scope);
  549.  protected:
  550.   SNMP_PP_MUTABLE char output_buffer[OUTBUFF];           // output buffer
  551.   char sep;                              // separator
  552.   // redefined parse address
  553.   // specific to IP addresses
  554.   virtual bool parse_address(const char *inaddr);
  555.   // redefined format output
  556.   // specific to IP addresses
  557.   virtual void format_output() const;
  558. };
  559. #ifdef _MAC_ADDRESS
  560. //-------------------------------------------------------------------------
  561. //---------[ 802.3 MAC Address Class ]-------------------------------------
  562. //-------------------------------------------------------------------------
  563. class DLLOPT MacAddress : public Address {
  564. public:
  565.   // constructor, no arguments
  566.   MacAddress();
  567.   // constructor with a string argument
  568.   MacAddress(const char  *inaddr);
  569.   // constructor with another MAC object
  570.   MacAddress(const MacAddress  &macaddr);
  571.   // construct a MacAddress with a GenAddress
  572.   MacAddress(const GenAddress &genaddr);
  573.   // destructor
  574.   ~MacAddress() {};
  575.   /**
  576.    * Return the syntax.
  577.    *
  578.    * @return This method always returns sNMP_SYNTAX_OCTETS.
  579.    */
  580.   SmiUINT32 get_syntax() const { return sNMP_SYNTAX_OCTETS; };
  581.   /**
  582.    * Return the space needed for serialization.
  583.    */
  584.   virtual int get_asn1_length() const { return MACLEN + 2; };
  585.   /**
  586.    * Map other SnmpSyntax objects to MacAddress.
  587.    */
  588.   SnmpSyntax& operator=(const SnmpSyntax &val);
  589.   // assignment to another IpAddress object overloaded
  590.   MacAddress& operator=(const MacAddress &macaddress);
  591.   /**
  592.    * Clone this object.
  593.    *
  594.    * @return Pointer to the newly created object (allocated through new).
  595.    */
  596.   SnmpSyntax *clone() const { return (SnmpSyntax *) new MacAddress(*this); };
  597.   /**
  598.    * Get a printable ASCII value of the address.
  599.    *
  600.    * @return String containing the numerical address
  601.    */
  602.   virtual const char *get_printable() const
  603.     { if (addr_changed) format_output(); return output_buffer; };
  604.   /**
  605.    * Overloaded operator for streaming output.
  606.    *
  607.    * @return String containing the numerical address
  608.    */
  609.   virtual operator const char *() const
  610.     { if (addr_changed) format_output(); return output_buffer; };
  611.   /**
  612.    * Get the length of the binary address (accessible through operator[]).
  613.    */
  614.   virtual int get_length() const { return MACLEN; };
  615.   /**
  616.    * Return the type of the address.
  617.    * @see Address::addr_type
  618.    * @return Always Address:type_mac
  619.    */
  620.   virtual addr_type get_type() const { return type_mac; };
  621.   // return a hash key
  622.   unsigned int hashFunction() const;
  623.   /**
  624.    * Reset the object.
  625.    */
  626.   void clear()
  627.     { Address::clear(); memset(output_buffer, 0, sizeof(output_buffer)); };
  628.  protected:
  629.   SNMP_PP_MUTABLE char output_buffer[OUTBUFF];           // output buffer
  630.   // redefined parse address for macs
  631.   virtual bool parse_address(const char *inaddr);
  632.   // redefined format output for MACs
  633.   virtual void format_output() const;
  634. };
  635. #endif // _MAC_ADDRESS
  636. #ifdef _IPX_ADDRESS
  637. //------------------------------------------------------------------------
  638. //---------[ IPX Address Class ]------------------------------------------
  639. //------------------------------------------------------------------------
  640. class DLLOPT IpxAddress : public Address {
  641. public:
  642.   // constructor no args
  643.   IpxAddress();
  644.   // constructor with a string arg
  645.   IpxAddress(const char  *inaddr);
  646.   // constructor with another ipx object
  647.   IpxAddress(const IpxAddress  &ipxaddr);
  648.   // construct with a GenAddress
  649.   IpxAddress(const GenAddress &genaddr);
  650.   // destructor
  651.   ~IpxAddress() {};
  652.   /**
  653.    * Return the syntax.
  654.    *
  655.    * @return This method always returns sNMP_SYNTAX_OCTETS.
  656.    */
  657.   virtual SmiUINT32 get_syntax() const { return sNMP_SYNTAX_OCTETS; };
  658.   /**
  659.    * Return the space needed for serialization.
  660.    */
  661.   virtual int get_asn1_length() const  { return IPXLEN + 2; };
  662.   /**
  663.    * Map other SnmpSyntax objects to IpxAddress.
  664.    */
  665.   SnmpSyntax& operator=(const SnmpSyntax &val);
  666.   // assignment to another IpAddress object overloaded
  667.   IpxAddress& operator=(const IpxAddress &ipxaddress);
  668. #ifdef _MAC_ADDRESS
  669.   // get the host id portion of an ipx address
  670.   int get_hostid(MacAddress& mac) const;
  671. #endif
  672.   /**
  673.    * Clone this object.
  674.    *
  675.    * @return Pointer to the newly created object (allocated through new).
  676.    */
  677.   SnmpSyntax *clone() const { return (SnmpSyntax *) new IpxAddress(*this); };
  678.   /**
  679.    * Get a printable ASCII value of the address.
  680.    *
  681.    * @return String containing the numerical address
  682.    */
  683.   virtual const char *get_printable() const
  684.     { if (addr_changed) format_output(); return output_buffer; };
  685.   /**
  686.    * Overloaded operator for streaming output.
  687.    *
  688.    * @return String containing the numerical address
  689.    */
  690.   virtual operator const char *() const
  691.     { if (addr_changed) format_output(); return output_buffer; };
  692.   /**
  693.    * Get the length of the binary address (accessible through operator[]).
  694.    */
  695.   virtual int get_length() const { return IPXLEN; };
  696.   /**
  697.    * Return the type of the address.
  698.    * @see Address::addr_type
  699.    * @return Always Address:type_ipx
  700.    */
  701.   virtual addr_type get_type() const { return type_ipx; };
  702.   /**
  703.    * Reset the object.
  704.    */
  705.   void clear()
  706.     { Address::clear(); memset(output_buffer, 0, sizeof(output_buffer)); };
  707.  protected:
  708.   // ipx format separator
  709.   char separator;
  710.   SNMP_PP_MUTABLE char output_buffer[OUTBUFF];           // output buffer
  711.   // redefined parse address for ipx strings
  712.   virtual bool parse_address(const char  *inaddr);
  713.   // redefined format output for ipx strings
  714.   // uses same separator as when constructed
  715.   virtual void format_output() const;
  716. };
  717. //------------------------------------------------------------------------
  718. //---------[ IpxSock Address Class ]--------------------------------------
  719. //------------------------------------------------------------------------
  720. class DLLOPT IpxSockAddress : public IpxAddress {
  721. public:
  722.   // constructor, no args
  723.   IpxSockAddress();
  724.   // constructor with a dotted string
  725.   IpxSockAddress(const char *inaddr);
  726.   // construct an Udp address with another Udp address
  727.   IpxSockAddress(const IpxSockAddress &ipxaddr);
  728.   //constructor with a GenAddress
  729.   IpxSockAddress(const GenAddress &genaddr);
  730.   //constructor with a IpxAddress
  731.   // default socket # is 0
  732.   IpxSockAddress(const IpxAddress &ipxaddr);
  733.   // destructor
  734.   ~IpxSockAddress() {};
  735.   // syntax type
  736.   //virtual SmiUINT32 get_syntax() const { return sNMP_SYNTAX_OCTETS; };
  737.   /**
  738.    * Return the space needed for serialization.
  739.    */
  740.   virtual int get_asn1_length() const { return IPXSOCKLEN + 2; };
  741.   /**
  742.    * Map other SnmpSyntax objects to IpxSockAddress.
  743.    */
  744.   SnmpSyntax& operator=(const SnmpSyntax &val);
  745.   // assignment to another IpAddress object overloaded
  746.   IpxSockAddress& operator=(const IpxSockAddress &ipxaddr);
  747.   /**
  748.    * Clone this object.
  749.    *
  750.    * @return Pointer to the newly created object (allocated through new).
  751.    */
  752.   SnmpSyntax *clone() const { return (SnmpSyntax *)new IpxSockAddress(*this); };
  753.   // set the socket number
  754.   void set_socket(const unsigned short s);
  755.   // get the socket number
  756.   unsigned short get_socket() const;
  757.   /**
  758.    * Get a printable ASCII value of the address.
  759.    *
  760.    * @return String containing the numerical address
  761.    */
  762.   virtual const char *get_printable() const
  763.     { if (addr_changed) format_output(); return output_buffer; };
  764.   /**
  765.    * Overloaded operator for streaming output.
  766.    *
  767.    * @return String containing the numerical address
  768.    */
  769.   virtual operator const char *() const
  770.     { if (addr_changed) format_output(); return output_buffer; };
  771.   /**
  772.    * Get the length of the binary address (accessible through operator[]).
  773.    */
  774.   virtual int get_length() const { return IPXSOCKLEN; };
  775.   /**
  776.    * Return the type of the address.
  777.    * @see Address::addr_type
  778.    * @return Always Address:type_ipxsock
  779.    */
  780.   virtual addr_type get_type() const { return type_ipxsock; };
  781.   /**
  782.    * Reset the object.
  783.    */
  784.   void clear()
  785.     { Address::clear(); memset(output_buffer, 0, sizeof(output_buffer)); };
  786.  protected:
  787.   SNMP_PP_MUTABLE char output_buffer[OUTBUFF];           // output buffer
  788.   // redefined parse address for ipx strings
  789.   virtual bool parse_address(const char  *inaddr);
  790.   // redefined format output
  791.   // specific to IP addresses
  792.   virtual void format_output() const;
  793. };
  794. #endif // _IPX_ADDRESS
  795. //-------------------------------------------------------------------------
  796. //--------[ Generic Address ]----------------------------------------------
  797. //-------------------------------------------------------------------------
  798. class DLLOPT GenAddress : public Address
  799. {
  800.  public:
  801.   /**
  802.    * Construct an empty invalid generic address object.
  803.    */
  804.   GenAddress();
  805.   /**
  806.    * Construct a generic address from a string.
  807.    *
  808.    * To optimize the speed of the parsing method, use_type can be used
  809.    * to indicate that the address string is of the specified type.
  810.    *
  811.    * @param addr     - address string
  812.    * @param use_type - if this value is set, the input string is only
  813.    *                   parsed for the given type 
  814.    */
  815.   GenAddress(const char *addr,
  816.      const Address::addr_type use_type = Address::type_invalid);
  817.   /**
  818.    * Construct a generic address from an Address object.
  819.    *
  820.    * @param addr - Any address object
  821.    */
  822.   GenAddress(const Address &addr);
  823.   /**
  824.    * Construct a generic address from another generic address object.
  825.    *
  826.    * @param addr - Generic address object to copy
  827.    */
  828.   GenAddress(const GenAddress &addr);
  829.   /**
  830.    * Destructor, free memory.
  831.    */
  832.   ~GenAddress() { if (address) delete address; };
  833.   /**
  834.    * Return the syntax.
  835.    *
  836.    * @return This method returns sNMP_SYNTAX_IPADDR, sNMP_SYNTAX_OCTETS
  837.    *         or sNMP_SYNTAX_NULL if the generic address does not have
  838.    *         an address object.
  839.    */
  840.   SmiUINT32 get_syntax() const
  841.     { return address ? address->get_syntax() : sNMP_SYNTAX_NULL; };
  842.   /**
  843.    * Return the space needed for serialization.
  844.    */
  845.   virtual int get_asn1_length() const
  846.     { return address ? address->get_asn1_length() : 2; };
  847.   /**
  848.    * Clone this object.
  849.    *
  850.    * @return Pointer to the newly created object (allocated through new).
  851.    */
  852.   SnmpSyntax *clone() const { return (SnmpSyntax *)new GenAddress(*this); };
  853.   /**
  854.    * Overloaded assignment operator for a GenAddress.
  855.    */
  856.   GenAddress& operator=(const GenAddress &addr);
  857.   /**
  858.    * Overloaded assignment operator for a Address.
  859.    */
  860.   GenAddress& operator=(const Address &addr);
  861.   /**
  862.    * Map other SnmpSyntax objects to GenAddress.
  863.    */
  864.   SnmpSyntax& operator=(const SnmpSyntax &val);
  865.   /**
  866.    * Get a printable ASCII value of the address.
  867.    *
  868.    * @return String containing the numerical address
  869.    */
  870.   virtual const char *get_printable() const
  871.     { return (address) ? address->get_printable() : output_buffer; };
  872.   /**
  873.    * Overloaded operator for streaming output.
  874.    *
  875.    * @return String containing the numerical address
  876.    */
  877.   virtual operator const char *() const
  878.     { return address ? (const char *)*address : output_buffer; };
  879.   /**
  880.    * Get the length of the binary address (accessible through operator[]).
  881.    */
  882.   virtual int get_length() const
  883.     { return (address) ? address->get_length() : 0; };
  884.   /**
  885.    * Reset the object.
  886.    */
  887.   void clear() { if (address) address->clear(); };
  888.   /**
  889.    * Return the type of the address.
  890.    * @see Address::addr_type
  891.    * @return Type of the contained address object or Address::type_invalid
  892.    *         if it is not valid().
  893.    */
  894.   virtual addr_type get_type() const
  895.     { return (valid()) ? address->get_type() : type_invalid; };
  896.   /**
  897.    * Access the protected address.
  898.    * The caller must make sure that this GenAddress object ist valid()
  899.    * and is of the right type (get_type()).
  900.    */
  901.   const IpAddress  &cast_ipaddress()  const { return (IpAddress& )*address; };
  902.   /**
  903.    * Access the protected address.
  904.    * The caller must make sure that this GenAddress object ist valid()
  905.    * and is of the right type (get_type()).
  906.    */
  907.   const UdpAddress &cast_udpaddress() const { return (UdpAddress&)*address; };
  908. #ifdef _MAC_ADDRESS
  909.   /**
  910.    * Access the protected address.
  911.    * The caller must make sure that this GenAddress object ist valid()
  912.    * and is of the right type (get_type()).
  913.    */
  914.   const MacAddress &cast_macaddress() const { return (MacAddress&)*address; };
  915. #endif
  916. #ifdef _IPX_ADDRESS
  917.   /**
  918.    * Access the protected address.
  919.    * The caller must make sure that this GenAddress object ist valid()
  920.    * and is of the right type (get_type()).
  921.    */
  922.   const IpxAddress &cast_ipxaddress() const { return (IpxAddress&)*address; };
  923.   /**
  924.    * Access the protected address.
  925.    * The caller must make sure that this GenAddress object ist valid()
  926.    * and is of the right type (get_type()).
  927.    */
  928.   const IpxSockAddress &cast_ipxsockaddress() const
  929.     { return (IpxSockAddress&)*address; };
  930. #endif
  931. protected:
  932.   // pointer to a concrete address
  933.   Address *address;
  934.   char output_buffer[1];           // output buffer
  935.   // redefined parse address for generic address
  936.   virtual bool parse_address(const char *addr)
  937.     { return parse_address(addr, Address::type_invalid); };
  938.   virtual bool parse_address(const char *addr,
  939.      const Address::addr_type use_type);
  940.   // format output for a generic address
  941.   virtual void format_output() const {};
  942.   /**
  943.    * Is this a GenAddress object.
  944.    */
  945.   virtual bool is_gen_address() const { return true; };
  946. };
  947. // create AddressCollection type
  948. typedef SnmpCollection <GenAddress> AddressCollection;
  949. typedef SnmpCollection <UdpAddress> UdpAddressCollection;
  950. #ifdef SNMP_PP_NAMESPACE
  951. } // end of namespace Snmp_pp
  952. #endif 
  953. #endif  //_ADDRESS