ACE/protocols/ace/HTBP/HTBP_Addr.h

   1 // -*- C++ -*-
   2
   3 //=============================================================================
   4 /**
   5  *  @file    HTBP_Addr.h
   6  *
   7  *  @author Phil Mesnier
   8  */
   9 //=============================================================================
  10
  11 #ifndef ACE_HTBP_ADDR_H
  12 #define ACE_HTBP_ADDR_H
  13 #include /**/ "ace/pre.h"
  14
  15 #include "HTBP_Export.h"
  16
  17 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  18 # pragma once
  19 #endif /* ACE_LACKS_PRAGMA_ONCE */
  20
  21 #include "ace/INET_Addr.h"
  22 #include "ace/Synch.h"
  23 #include "ace/SString.h"
  24
  25 ACE_BEGIN_VERSIONED_NAMESPACE_DECL
  26
  27 namespace ACE
  28 {
  29   namespace HTBP
  30   {
  31     /**
  32      * @class Addr
  33      *
  34      * @brief Defines the member functions of the pure virtual class
  35      * Addr
  36      *
  37      * This class derives from ACE_INET_Addr. It is the base class for
  38      * the Inside, Proxy and Outside classes
  39      */
  40     class HTBP_Export Addr : public ACE_INET_Addr
  41     {
  42     public:
  43       /// Constructor
  44       Addr () = default;
  45
  46       Addr (const Addr &other);
  47
  48       /// Create an Addr suitable for use on the inside of a firewall this
  49       /// take a string used to populate the htid_ member. With this address,
  50       /// the IP addr form is ignored.
  51       Addr (const char *htid);
  52
  53       /// Initialize an Addr for the outside of a firewall. In this form,
  54       /// the htid_ is an empty string and the arguments are passed to the
  55       /// base address type.
  56       Addr (u_short port_number,
  57             const char host_name[],
  58             int address_family = AF_UNSPEC);
  59
  60       /// Destructor
  61       virtual ~Addr () = default;
  62
  63       int set (u_short port,
  64                const char host [],
  65                const char *htid);
  66
  67       /// Methods to help convert the OutSide_Addr to a String
  68       /// and vice versa
  69       int addr_to_string (ACE_TCHAR buffer[],
  70                           size_t size,
  71                           int ipaddr_format = 1) const;
  72       int string_to_addr (const char address[],
  73                           int address_facmily = AF_UNSPEC);
  74
  75       int set_htid(const char *htid);
  76       const char *get_htid () const;
  77
  78     private:
  79       /// HTID - web-obtained unique-identifier
  80       ACE_CString htid_;
  81     };
  82   }
  83 }
  84
  85 ACE_END_VERSIONED_NAMESPACE_DECL
  86
  87 #include /**/ "ace/post.h"
  88 #endif /* ACE_HTBP_ADDR_H */