TAO/tao/Collocated_Invocation.h

   1 // -*- C++ -*-
   2
   3 //=============================================================================
   4 /**
   5  *  @file    Collocated_Invocation.h
   6  *
   7  *  @author Balachandran Natarajan <bala@dre.vanderbilt.edu>
   8  */
   9 //=============================================================================
  10
  11 #ifndef TAO_COLLOCATED_INVOCATION_H
  12 #define TAO_COLLOCATED_INVOCATION_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/Collocation_Strategy.h"
  23 #include "tao/Invocation_Base.h"
  24 #include "tao/Exception.h"
  25
  26 TAO_BEGIN_VERSIONED_NAMESPACE_DECL
  27
  28 class TAO_Operation_Details;
  29 class TAO_Stub;
  30
  31 namespace TAO
  32 {
  33   class Profile_Transport_Resolver;
  34   class Argument;
  35   class Collocation_Proxy_Broker;
  36
  37   /**
  38    * @class Collocated_Invocation
  39    *
  40    * @brief Class for Collocated invocations
  41    *
  42    * @note Reliable oneways are not handled properly including use of
  43    * interceptors. This class should technically serve as the base
  44    * for all invocation types. But now, this is the only class that
  45    * handles collocated invocations and that too in a brain dead way.
  46    */
  47   class TAO_Export Collocated_Invocation : public Invocation_Base
  48   {
  49   public:
  50     /// Constructor used by TAO::Invocation_Adapter
  51     /**
  52      * @param t The target on which invocation first started.
  53      *
  54      * @param et The effective target in which this invocation is now
  55      * flowing
  56      *
  57      * @param stub Stub for effective target @a et
  58      *
  59      * @param detail operation details of the invocation including
  60      * the service context list
  61      *
  62      * @param response_expected flag to indicate whether the
  63      * operation encapsulated by @a detail returns a response or not.
  64      */
  65     Collocated_Invocation (CORBA::Object_ptr t,
  66                            CORBA::Object_ptr et,
  67                            TAO_Stub *stub,
  68                            TAO_Operation_Details &detail,
  69                            bool response_expected = true);
  70
  71     /// Invocation on the collocated object mediated through this
  72     /// class.
  73     /**
  74      * Practically this method is a place holder to do the
  75      * following
  76      *  - Call the start and end interception points on the client
  77      *    side.
  78      *
  79      *  - Handle location forwards that could be thrown by the
  80      *    servant.
  81      *
  82      */
  83     Invocation_Status invoke (Collocation_Strategy strat);
  84
  85   private:
  86     Collocated_Invocation () = delete;
  87   };
  88 }
  89
  90 TAO_END_VERSIONED_NAMESPACE_DECL
  91
  92 #include /**/ "ace/post.h"
  93 #endif /*TAO_COLLOCATED_INVOCATION_H*/