TAO/tao/PortableServer/ServantRetentionStrategy.h

   1 // -*- C++ -*-
   2
   3 //=============================================================================
   4 /**
   5  *  @file ServantRetentionStrategy.h
   6  *
   7  *  @author  Johnny Willemsen  <jwillemsen@remedy.nl>
   8  */
   9 //=============================================================================
  10
  11 #ifndef TAO_SERVANTRETENTIONSTRATEGY_H
  12 #define TAO_SERVANTRETENTIONSTRATEGY_H
  13 #include /**/ "ace/pre.h"
  14
  15 #include "tao/PortableServer/Servant_Location.h"
  16
  17 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  18 # pragma once
  19 #endif /* ACE_LACKS_PRAGMA_ONCE */
  20
  21 #include "tao/PortableServer/Servant_Upcall.h"
  22 #include "tao/PortableServer/ServantRetentionPolicyC.h"
  23 #include "tao/PortableServer/PortableServer.h"
  24
  25 TAO_BEGIN_VERSIONED_NAMESPACE_DECL
  26
  27 class TAO_Root_POA;
  28 class TAO_Active_Object_Map;
  29 struct TAO_Active_Object_Map_Entry;
  30
  31 namespace TAO
  32 {
  33   namespace Portable_Server
  34   {
  35     class ServantRetentionStrategy
  36     {
  37     public:
  38       ServantRetentionStrategy ();
  39       virtual ~ServantRetentionStrategy () = default;
  40
  41       virtual void strategy_init (TAO_Root_POA *poa) = 0;
  42
  43       virtual void strategy_cleanup() = 0;
  44
  45       virtual CORBA::ULong waiting_servant_deactivation () const = 0;
  46
  47       virtual int is_servant_in_map (PortableServer::Servant servant,
  48                                      bool &wait_occurred_restart_call) = 0;
  49
  50       virtual TAO_Servant_Location servant_present (
  51         const PortableServer::ObjectId &system_id,
  52         PortableServer::Servant &servant) = 0;
  53
  54       virtual PortableServer::Servant find_servant (
  55         const PortableServer::ObjectId &system_id,
  56         TAO::Portable_Server::Servant_Upcall &servant_upcall,
  57         TAO::Portable_Server::POA_Current_Impl &poa_current_impl) = 0;
  58
  59       virtual int find_servant_priority (
  60         const PortableServer::ObjectId &system_id,
  61         CORBA::Short &priority) = 0;
  62
  63       virtual PortableServer::ObjectId *activate_object (
  64         PortableServer::Servant servant,
  65         CORBA::Short priority,
  66         bool &wait_occurred_restart_call) = 0;
  67
  68       virtual void activate_object_with_id (
  69         const PortableServer::ObjectId &id,
  70         PortableServer::Servant servant,
  71         CORBA::Short priority,
  72         bool &wait_occurred_restart_call) = 0;
  73
  74       virtual void deactivate_object (const PortableServer::ObjectId &id) = 0;
  75
  76       virtual PortableServer::Servant find_servant (
  77         const PortableServer::ObjectId &system_id) = 0;
  78
  79       virtual PortableServer::ObjectId *system_id_to_object_id (
  80         const PortableServer::ObjectId &system_id) = 0;
  81
  82       virtual PortableServer::Servant user_id_to_servant (
  83         const PortableServer::ObjectId &id) = 0;
  84
  85       virtual CORBA::Object_ptr id_to_reference (
  86         const PortableServer::ObjectId &id,
  87         bool indirect) = 0;
  88
  89       virtual void deactivate_all_objects () = 0;
  90
  91       virtual PortableServer::ObjectId *servant_to_user_id (
  92         PortableServer::Servant servant) = 0;
  93
  94       virtual CORBA::Object_ptr servant_to_reference (
  95         PortableServer::Servant servant) = 0;
  96
  97       virtual CORBA::Object_ptr create_reference (
  98         const char *intf,
  99         CORBA::Short priority) = 0;
 100
 101 #if !defined (CORBA_E_MICRO)
 102       virtual CORBA::Object_ptr create_reference_with_id (
 103         const PortableServer::ObjectId &oid,
 104         const char *intf,
 105         CORBA::Short priority) = 0;
 106 #endif
 107
 108       virtual int rebind_using_user_id_and_system_id (
 109         PortableServer::Servant servant,
 110         const PortableServer::ObjectId &user_id,
 111         const PortableServer::ObjectId &system_id,
 112         TAO::Portable_Server::Servant_Upcall &servant_upcall) = 0;
 113
 114       virtual int unbind_using_user_id (
 115         const PortableServer::ObjectId &user_id) = 0;
 116
 117       virtual CORBA::Boolean servant_has_remaining_activations (
 118         PortableServer::Servant servant) = 0;
 119
 120       virtual ::PortableServer::ServantRetentionPolicyValue type() const = 0;
 121
 122       virtual TAO_Active_Object_Map * get_active_object_map() const = 0;
 123     };
 124   }
 125 }
 126
 127 TAO_END_VERSIONED_NAMESPACE_DECL
 128
 129 #include /**/ "ace/post.h"
 130 #endif /* TAO_SERVANTRETENTIONSTRATEGY_H */