TAO/tao/Transport_Descriptor_Interface.h

   1 // -*- C++ -*-
   2
   3 // ===================================================================
   4 /**
   5  *  @file   Transport_Descriptor_Interface.h
   6  *
   7  *  @author Bala Natarajan <bala@cs.wustl.edu>
   8  */
   9 // ===================================================================
  10
  11 #ifndef TAO_CONNECTION_DESCRIPTOR_INTERFACE_H
  12 #define TAO_CONNECTION_DESCRIPTOR_INTERFACE_H
  13
  14 #include /**/ "ace/pre.h"
  15
  16 #include /**/ "tao/TAO_Export.h"
  17
  18 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  19 # pragma once
  20 #endif /* ACE_LACKS_PRAGMA_ONCE */
  21
  22 #include "tao/Basic_Types.h"
  23
  24 TAO_BEGIN_VERSIONED_NAMESPACE_DECL
  25
  26 class TAO_Endpoint;
  27
  28 /**
  29  * @class TAO_Transport_Descriptor_Interface
  30  *
  31  * @brief An abstract base class for Transport Property
  32  *
  33  * This class provides an abstract interface and holds minimal info
  34  * on which the Transport Caching scheme is based on. Concrete
  35  * connection properties can be got by inheriting from this class and
  36  * implementing the virtual functions.
  37  * Note 1: Additional properties for connection like Qos,
  38  * Priority that the RT folks would need, can be added by
  39  * inheriting from this class and providing the following
  40  * methods.
  41  * 1. duplicate ()
  42  * 2. is_equivalent ()
  43  * 3. hash ()
  44  */
  45 class TAO_Export TAO_Transport_Descriptor_Interface
  46 {
  47 public:
  48   /// Destructor
  49   virtual ~TAO_Transport_Descriptor_Interface ();
  50
  51   /// This call allocates and copies the contents of this class and
  52   /// returns the pointer
  53   virtual  TAO_Transport_Descriptor_Interface *duplicate () = 0;
  54
  55   /// Try to determine if this object is same as the @a other_prop.
  56   virtual CORBA::Boolean is_equivalent (
  57       const TAO_Transport_Descriptor_Interface *other_prop) = 0;
  58
  59   /// Generate hash value for our class
  60   virtual u_long hash () const = 0;
  61
  62   /// Return the underlying endpoint object
  63   TAO_Endpoint *endpoint ();
  64
  65   /// Reset the endpoint pointer to point to another, if that one is
  66   /// part of the chain based by the current endpoint. Although this
  67   /// method is public it should only be used by the protocol specific
  68   /// connector, right before caching, and only when a parallel
  69   /// connect was attempted with more than one possible endpoints.
  70   CORBA::Boolean reset_endpoint (TAO_Endpoint *ep);
  71
  72   /// Set the BiDir flag
  73   void set_bidir_flag (CORBA::Boolean flag);
  74
  75 protected:
  76   /// Default Constructor
  77   TAO_Transport_Descriptor_Interface ();
  78
  79   /// Constructor
  80   TAO_Transport_Descriptor_Interface (TAO_Endpoint *endpoint,
  81                                       CORBA::Boolean take_ownership = false);
  82
  83   /// The base property of the connection ie. the peer's endpoint
  84   TAO_Endpoint *endpoint_;
  85
  86   /// Should the endpoint be used in either direction?
  87   CORBA::Boolean bidir_flag_;
  88
  89   /// Is the endpoint allocated on the heap? If so, we will have to
  90   /// delete it when we destruct ourselves.
  91   CORBA::Boolean release_;
  92 };
  93
  94 TAO_END_VERSIONED_NAMESPACE_DECL
  95
  96 #if defined (__ACE_INLINE__)
  97 # include "tao/Transport_Descriptor_Interface.inl"
  98 #endif /* __ACE_INLINE__ */
  99
 100 #include /**/ "ace/post.h"
 101
 102 #endif /*TAO_CONNECTION_DESCRIPTOR_INTERFACE_H*/