TAO/tao/Protocols_Hooks.h

   1 // -*- C++ -*-
   2
   3 // ===================================================================
   4 /**
   5  *  @file   Protocols_Hooks.h
   6  *
   7  *  @author Priyanka Gontla <pgontla@ece.uci.edu>
   8  */
   9 // ===================================================================
  10
  11 #ifndef TAO_PROTOCOLS_HOOKS_H
  12 #define TAO_PROTOCOLS_HOOKS_H
  13
  14 #include /**/ "ace/pre.h"
  15
  16 #include "ace/Service_Object.h"
  17
  18 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  19 # pragma once
  20 #endif /* ACE_LACKS_PRAGMA_ONCE */
  21
  22 #include /**/ "tao/TAO_Export.h"
  23 #include "tao/Basic_Types.h"
  24 #include "tao/IOPC.h"
  25 #include "ace/SString.h"
  26
  27 TAO_BEGIN_VERSIONED_NAMESPACE_DECL
  28
  29 namespace CORBA
  30 {
  31   class Policy;
  32 }
  33
  34 class TAO_ORB_Core;
  35 class TAO_Service_Context;
  36 class TAO_Connection_Handler;
  37 class TAO_Stub;
  38
  39 class TAO_Export TAO_IIOP_Protocol_Properties
  40 {
  41 public:
  42
  43   TAO_IIOP_Protocol_Properties ();
  44
  45   CORBA::Long send_buffer_size_;
  46   CORBA::Long recv_buffer_size_;
  47   int keep_alive_;
  48   int dont_route_;
  49   int no_delay_;
  50   CORBA::Boolean enable_network_priority_;
  51   CORBA::Long hop_limit_;
  52 };
  53
  54 class TAO_Export TAO_UIOP_Protocol_Properties
  55 {
  56 public:
  57
  58   TAO_UIOP_Protocol_Properties ();
  59
  60   CORBA::Long send_buffer_size_;
  61   CORBA::Long recv_buffer_size_;
  62 };
  63
  64 class TAO_Export TAO_SHMIOP_Protocol_Properties
  65 {
  66 public:
  67
  68   TAO_SHMIOP_Protocol_Properties ();
  69
  70   CORBA::Long send_buffer_size_;
  71   CORBA::Long recv_buffer_size_;
  72   int keep_alive_;
  73   int dont_route_;
  74   int no_delay_;
  75   CORBA::Long preallocate_buffer_size_;
  76   ACE_CString mmap_filename_;
  77   ACE_CString mmap_lockname_;
  78 };
  79
  80 class TAO_Export TAO_DIOP_Protocol_Properties
  81 {
  82 public:
  83
  84   TAO_DIOP_Protocol_Properties ();
  85
  86   CORBA::Long send_buffer_size_;
  87   CORBA::Long recv_buffer_size_;
  88   CORBA::Boolean enable_network_priority_;
  89   CORBA::Long hop_limit_;
  90   CORBA::Boolean enable_multicast_loop_;
  91 };
  92
  93 class TAO_Export TAO_SCIOP_Protocol_Properties
  94 {
  95 public:
  96
  97   TAO_SCIOP_Protocol_Properties ();
  98
  99   CORBA::Long send_buffer_size_;
 100   CORBA::Long recv_buffer_size_;
 101   int keep_alive_;
 102   int dont_route_;
 103   int no_delay_;
 104   CORBA::Boolean enable_network_priority_;
 105   CORBA::Long hop_limit_;
 106 };
 107
 108 class TAO_Export TAO_Protocols_Hooks : public ACE_Service_Object
 109 {
 110 public:
 111   /// Destructor
 112   virtual ~TAO_Protocols_Hooks ();
 113
 114   /// Initialize the protocols hooks instance.
 115   virtual void init_hooks (TAO_ORB_Core *orb_core) = 0;
 116
 117   virtual CORBA::Boolean set_client_network_priority (
 118     IOP::ProfileId protocol_tag,
 119     TAO_Stub *stub) = 0;
 120
 121   virtual CORBA::Boolean set_server_network_priority (
 122     IOP::ProfileId protocol_tag,
 123     CORBA::Policy *policy) = 0;
 124
 125   virtual void server_protocol_properties_at_orb_level (
 126     TAO_IIOP_Protocol_Properties &protocol_properties) = 0;
 127
 128   virtual void client_protocol_properties_at_orb_level (
 129     TAO_IIOP_Protocol_Properties &protocol_properties) = 0;
 130
 131   virtual void server_protocol_properties_at_orb_level (
 132     TAO_UIOP_Protocol_Properties &protocol_properties) = 0;
 133
 134   virtual void client_protocol_properties_at_orb_level (
 135     TAO_UIOP_Protocol_Properties &protocol_properties) = 0;
 136
 137   virtual void server_protocol_properties_at_orb_level (
 138     TAO_SHMIOP_Protocol_Properties &protocol_properties) = 0;
 139
 140   virtual void client_protocol_properties_at_orb_level (
 141     TAO_SHMIOP_Protocol_Properties &protocol_properties) = 0;
 142
 143   virtual void server_protocol_properties_at_orb_level (
 144     TAO_DIOP_Protocol_Properties &protocol_properties) = 0;
 145
 146   virtual void client_protocol_properties_at_orb_level (
 147     TAO_DIOP_Protocol_Properties &protocol_properties) = 0;
 148
 149   virtual void server_protocol_properties_at_orb_level (
 150     TAO_SCIOP_Protocol_Properties &protocol_properties) = 0;
 151
 152   virtual void client_protocol_properties_at_orb_level (
 153     TAO_SCIOP_Protocol_Properties &protocol_properties) = 0;
 154
 155   virtual CORBA::Long get_dscp_codepoint () = 0;
 156
 157   virtual void get_selector_hook (CORBA::Policy *model_policy,
 158                                   CORBA::Boolean &is_client_propagated,
 159                                   CORBA::Short &server_priority) = 0;
 160
 161   virtual void get_selector_bands_policy_hook (CORBA::Policy *bands_policy,
 162                                                CORBA::Short priority,
 163                                                CORBA::Short &min_priority,
 164                                                CORBA::Short &max_priority,
 165                                                bool &in_range) = 0;
 166
 167   /**
 168    * @name Accessor and modifier to the current thread priority, used to
 169    * implement the RTCORBA::Current interface, but it is faster for
 170    * some critical components.  If the RTCORBA library isn't used,
 171    * these operations are no-ops.
 172    */
 173   //@{
 174   virtual int get_thread_CORBA_priority (CORBA::Short &) = 0;
 175
 176   virtual int get_thread_native_priority (CORBA::Short &) = 0;
 177
 178   virtual int get_thread_CORBA_and_native_priority (
 179     CORBA::Short &,
 180     CORBA::Short &) = 0;
 181
 182   virtual int get_thread_implicit_CORBA_priority (CORBA::Short&) = 0;
 183
 184   virtual int set_thread_CORBA_priority (CORBA::Short) = 0;
 185
 186   virtual int restore_thread_CORBA_and_native_priority (CORBA::Short,
 187                                                         CORBA::Short) = 0;
 188   //@}
 189 };
 190
 191 TAO_END_VERSIONED_NAMESPACE_DECL
 192
 193 #include /**/ "ace/post.h"
 194
 195 #endif /* TAO_PROTOCOLS_HOOKS_H */