TAO/tao/RTCORBA/RT_Stub.h

   1 // -*- C++ -*-
   2
   3 //=============================================================================
   4 /**
   5  *  @file    RT_Stub.h
   6  *
   7  *  This file contains the declaration for the RTCORBA Stub.
   8  *
   9  *  @author  Angelo Corsaro <corsaro@cs.wustl.edu>
  10  *  @author  Frank Hunleth <fhunleth@cs.wustl.edu>
  11  */
  12 //=============================================================================
  13
  14 #ifndef TAO_RT_STUB_H_
  15 #define TAO_RT_STUB_H_
  16
  17 #include /**/ "ace/pre.h"
  18
  19 #include "tao/orbconf.h"
  20
  21 #if defined (TAO_HAS_CORBA_MESSAGING) && TAO_HAS_CORBA_MESSAGING != 0
  22
  23 #include "tao/RTCORBA/rtcorba_export.h"
  24
  25 #include "tao/Stub.h"
  26
  27 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  28 # pragma once
  29 #endif /* ACE_LACKS_PRAGMA_ONCE */
  30
  31 TAO_BEGIN_VERSIONED_NAMESPACE_DECL
  32
  33 // Forward references.
  34 class TAO_PriorityModelPolicy;
  35 class TAO_PriorityBandedConnectionPolicy;
  36 class TAO_ClientProtocolPolicy;
  37 class TAO_PrivateConnectionPolicy;
  38
  39 /**
  40  * @class TAO_RT_Stub
  41  *
  42  * This class represent a stub with extended functionality, which are needed
  43  * for RTCORBA.
  44  */
  45 class TAO_RTCORBA_Export TAO_RT_Stub : public TAO_Stub
  46 {
  47 public:
  48   TAO_RT_Stub (const char *repository_id,
  49                const TAO_MProfile &profiles,
  50                TAO_ORB_Core *orb_core);
  51
  52   virtual ~TAO_RT_Stub ();
  53
  54
  55 #if (TAO_HAS_CORBA_MESSAGING == 1)
  56
  57   /**
  58    * Returns the effective policy if @a type is a known client-exposed
  59    * policy type.  Returns the effective override for all other policy
  60    * types.
  61    */
  62   CORBA::Policy_ptr get_policy (CORBA::PolicyType type);
  63
  64   CORBA::Policy_ptr get_cached_policy (TAO_Cached_Policy_Type type);
  65
  66   TAO_Stub* set_policy_overrides (const CORBA::PolicyList & policies,
  67                                   CORBA::SetOverrideType set_add);
  68
  69 #endif /* TAO_HAS_CORBA_MESSAGING */
  70
  71 private:
  72   /// Helper method used to parse the policies.
  73   void parse_policies ();
  74
  75   void exposed_priority_model (CORBA::Policy_ptr policy);
  76
  77   void exposed_priority_banded_connection (CORBA::Policy_ptr policy);
  78
  79   void exposed_client_protocol (CORBA::Policy_ptr policy);
  80
  81   /// Returns the CORBA::Policy (which will be narrowed to be
  82   /// used as RTCORBA::PriorityModelPolicy) exported
  83   /// in object's IOR.
  84   CORBA::Policy_ptr exposed_priority_model ();
  85
  86   /// Returns the CORBA::Policy (which will be narrowed and used
  87   /// as RTCORBA::PriorityBandedConnectionPolicy) exported
  88   /// in object's IOR.
  89   CORBA::Policy_ptr exposed_priority_banded_connection ();
  90
  91   /// Returns the CORBA::Policy (which will be narrowed and used
  92   /// as RTCORBA::ClientProtocolPolicy) exported
  93   /// in object's IOR.
  94   CORBA::Policy_ptr exposed_client_protocol ();
  95
  96   // = Methods for obtaining effective policies.
  97   //
  98   //   Effective policy is the one that would be used if a request
  99   //   were made.  The policy is determined by obtaining the effective
 100   //   override for a given policy type, and then reconciling it with
 101   //   the policy value exported in the Object's IOR.
 102
 103   CORBA::Policy_ptr effective_priority_banded_connection ();
 104   CORBA::Policy_ptr effective_client_protocol ();
 105
 106   // The following attribute are used to cache
 107   // the different kind of policies and avoid to
 108   // parse the MProfile's policy list each time we
 109   // are asked about a given policy.
 110
 111   CORBA::Policy_var priority_model_policy_;
 112
 113   CORBA::Policy_var priority_banded_connection_policy_;
 114
 115   CORBA::Policy_var client_protocol_policy_;
 116
 117   bool are_policies_parsed_;
 118
 119 private:
 120   // = Disallow copying and assignment.
 121   TAO_RT_Stub (const TAO_RT_Stub &);
 122   TAO_RT_Stub &operator = (const TAO_RT_Stub &);
 123 };
 124
 125 TAO_END_VERSIONED_NAMESPACE_DECL
 126
 127 #endif /* TAO_HAS_CORBA_MESSAGING && TAO_HAS_CORBA_MESSAGING != 0 */
 128
 129 #include /**/ "ace/post.h"
 130
 131 #endif /* TAO_RT_STUB_FACTORY_H_ */