TAO/tao/IIOP_Endpoint.h

   1 // -*- C++ -*-
   2
   3 //=============================================================================
   4 /**
   5  *  @file     IIOP_Endpoint.h
   6  *
   7  *  IIOP implementation of PP Framework Endpoint interface.
   8  *
   9  *  @author  Marina Spivak <marina@cs.wustl.edu>
  10  */
  11 //=============================================================================
  12
  13 #ifndef TAO_IIOP_ENDPOINT_H
  14 #define TAO_IIOP_ENDPOINT_H
  15
  16 #include /**/ "ace/pre.h"
  17
  18 #include "tao/orbconf.h"
  19
  20 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  21 # pragma once
  22 #endif /* ACE_LACKS_PRAGMA_ONCE */
  23
  24 #if defined (TAO_HAS_IIOP) && (TAO_HAS_IIOP != 0)
  25
  26 #include "tao/CORBA_String.h"
  27 #include "tao/IIOP_EndpointsC.h"
  28 #include "tao/Endpoint.h"
  29
  30 #include "ace/INET_Addr.h"
  31 #include "ace/Vector_T.h"
  32
  33 TAO_BEGIN_VERSIONED_NAMESPACE_DECL
  34
  35 class TAO_IIOP_Connection_Handler;
  36 class TAO_IIOP_Profile;
  37
  38 /**
  39  * @class TAO_IIOP_Endpoint
  40  *
  41  * @brief TAO_IIOP_Endpoint
  42  *
  43  * IIOP-specific implementation of PP Framework Endpoint interface.
  44  */
  45 class TAO_Export TAO_IIOP_Endpoint : public TAO_Endpoint
  46 {
  47 public:
  48   // @todo Lose these friends!
  49   friend class TAO_IIOP_Profile;
  50   friend class TAO_SSLIOP_Profile;
  51
  52   /// Default constructor.
  53   TAO_IIOP_Endpoint ();
  54
  55   /// Constructor.  This is the most efficient constructor since it
  56   /// does not require any address resolution processing.
  57   TAO_IIOP_Endpoint (const char *host,
  58                      CORBA::UShort port,
  59                      const ACE_INET_Addr &addr,
  60                      CORBA::Short priority = TAO_INVALID_PRIORITY);
  61
  62   /// Constructor.
  63   TAO_IIOP_Endpoint (const ACE_INET_Addr &addr,
  64                      int use_dotted_decimal_addresses);
  65
  66   /// Constructor.  This constructor is used when decoding endpoints.
  67   TAO_IIOP_Endpoint (const char *host,
  68                      CORBA::UShort port,
  69                      CORBA::Short priority);
  70
  71   /// Destructor.
  72   ~TAO_IIOP_Endpoint () = default;
  73
  74   // = Implementation of abstract TAO_Endpoint methods.  See
  75   // Endpoint.h for their documentation.
  76
  77   virtual TAO_Endpoint *next ();
  78
  79   /**
  80    * Return the next endpoint in the list, but use protocol-specific
  81    * filtering to constrain the value. The orb core is needed to supply
  82    * any sort of filter arguments, and the root endpoint is needed in case
  83    * the algorithm needs to rewind. If the supplied root is 0, then this
  84    * is assumed to be the candidate next endpoint.
  85    *
  86    * To use this, the caller starts off the change with root == 0. This
  87    * is a bit of a violation in logic, a more correct implementation would
  88    * accept this == 0 and a non-null root.
  89    * To do iteration using next_filtered, do:
  90    *   for (TAO_Endpoint *ep = root_endpoint->next_filtered (orb_core, 0);
  91    *        ep != 0;
  92    *        ep = ep->next_filtered(orb_core, root_endpoint)) { }
  93    */
  94   virtual TAO_Endpoint *next_filtered (TAO_ORB_Core *, TAO_Endpoint *root);
  95
  96   virtual int addr_to_string (char *buffer, size_t length);
  97
  98   /// Makes a copy of @c this
  99   virtual TAO_Endpoint *duplicate ();
 100
 101   /// Return true if this endpoint is equivalent to @a other_endpoint.  Two
 102   /// endpoints are equivalent if their port and host are the same.
 103   virtual CORBA::Boolean is_equivalent (const TAO_Endpoint *other_endpoint);
 104
 105   /// Return a hash value for this object.
 106   virtual CORBA::ULong hash ();
 107
 108   // = IIOP_Endpoint-specific methods.
 109
 110   /// Return a reference to the <object_addr>.
 111   const ACE_INET_Addr &object_addr () const;
 112
 113   /// Return a pointer to the host string.  This object maintains
 114   /// ownership of this string.
 115   const char *host () const;
 116
 117   /// Copy the string @a h into <host_> and return the resulting pointer.
 118   /// This object maintains ownership of this string.
 119   const char *host (const char *h);
 120
 121   /// Return the port number.
 122   CORBA::UShort port () const;
 123
 124   /// Set the port number.
 125   CORBA::UShort port (CORBA::UShort p);
 126
 127   /// Do we have a preferred local network for the target?
 128   bool is_preferred_network () const;
 129
 130   /// Return the preferred network if any.
 131   const char *preferred_network () const;
 132
 133 #if defined (ACE_HAS_IPV6)
 134   /// Does the host string represent an IPv6 decimal address.
 135   bool is_ipv6_decimal () const;
 136 #endif /* ACE_HAS_IPV6 */
 137
 138   /// Need to have an assignment operator since the IIOP_Profile class may
 139   /// have to reorder its list of endpoints based on filtering by the EndpointPolicy.
 140   TAO_IIOP_Endpoint & operator= (const TAO_IIOP_Endpoint& other);
 141
 142   /// Given a comma separated list of preferred interface directives, which
 143   /// are of the form <wild_remote>=<wild_local>, this function will retrieve
 144   /// the list of preferred local ip addresses by matching wild_local against
 145   /// the list of all local ip interfaces, for any directive where wild_remote
 146   /// matches the host from our endpoint.
 147   static void find_preferred_interfaces (const ACE_CString& host,
 148                                          const ACE_CString& csvPreferred,
 149                                          ACE_Vector<ACE_CString>& preferred);
 150
 151 private:
 152   TAO_IIOP_Endpoint *next_filtered_i (TAO_IIOP_Endpoint *root,
 153                                       bool ipv6_only,
 154                                       bool prefer_ipv6,
 155                                       bool want_ipv6);
 156
 157   /// Helper method for setting INET_Addr.
 158   int set (const ACE_INET_Addr &addr,
 159            int use_dotted_decimal_addresses);
 160
 161   /// Helper method for object_addr () call.
 162   void object_addr_i () const;
 163
 164   /// Generate preferred interfaces from the options passed in by the
 165   /// user.
 166   CORBA::ULong preferred_interfaces (const char *csvPreferred,
 167                                      bool enforce,
 168                                      TAO_IIOP_Profile &profile);
 169
 170   /// Chain a new duplicate of ourself with the specified
 171   /// local preferred interface.
 172   TAO_IIOP_Endpoint *add_local_endpoint (TAO_IIOP_Endpoint *ep,
 173                                          const char *local,
 174                                          TAO_IIOP_Profile &profile);
 175
 176   /// Canonical copy constructor
 177   /**
 178    * In private section to prevent clients from invoking this
 179    * accidentally. Clients should only use duplicate () to make a deep
 180    * copy
 181    */
 182   TAO_IIOP_Endpoint (const TAO_IIOP_Endpoint &);
 183
 184 private:
 185   /// String representing the host name.
 186   CORBA::String_var host_;
 187
 188   /// TCP port number.
 189   CORBA::UShort port_;
 190
 191 #if defined (ACE_HAS_IPV6)
 192   /// Does the host string represent an IPv6 decimal address.
 193   bool is_ipv6_decimal_;
 194 #endif /* ACE_HAS_IPV6 */
 195
 196   /// Is this endpoint created encodable as part of the IOR?
 197   bool is_encodable_;
 198
 199   /// Flag to indicate if the address has been resolved and set.
 200   mutable bool object_addr_set_;
 201
 202   /// Cached instance of ACE_INET_Addr for use in making
 203   /// invocations, etc.
 204   mutable ACE_INET_Addr object_addr_;
 205
 206   /// Preferred path for this endpoint.
 207   TAO::IIOP_Endpoint_Info preferred_path_;
 208
 209   /// IIOP Endpoints can be strung into a list.  Return the next
 210   /// endpoint in the list, if any.
 211   TAO_IIOP_Endpoint *next_;
 212 };
 213
 214 TAO_END_VERSIONED_NAMESPACE_DECL
 215
 216 #if defined (__ACE_INLINE__)
 217 # include "tao/IIOP_Endpoint.inl"
 218 #endif /* __ACE_INLINE__ */
 219
 220 #endif /* TAO_HAS_IIOP && TAO_HAS_IIOP != 0 */
 221
 222 #include /**/ "ace/post.h"
 223 #endif  /* TAO_IIOP_PROFILE_H */