TAO/tao/CSD_ThreadPool/CSD_TP_Custom_Request_Operation.h

   1 // -*- C++ -*-
   2
   3 //=============================================================================
   4 /**
   5  *  @file    CSD_TP_Custom_Request_Operation.h
   6  *
   7  *  @author  Tim Bradley <bradley_t@ociweb.com>
   8  */
   9 //=============================================================================
  10
  11 #ifndef TAO_CSD_TP_CUSTOM_REQUEST_OPERATION_H
  12 #define TAO_CSD_TP_CUSTOM_REQUEST_OPERATION_H
  13
  14 #include /**/ "ace/pre.h"
  15
  16 #include "tao/CSD_ThreadPool/CSD_TP_Export.h"
  17
  18 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  19 # pragma once
  20 #endif /* ACE_LACKS_PRAGMA_ONCE */
  21
  22 #include "tao/Intrusive_Ref_Count_Base_T.h"
  23 #include "tao/Intrusive_Ref_Count_Handle_T.h"
  24 #include "tao/PortableServer/Servant_Base.h"
  25 #include "ace/Synch.h"
  26
  27 TAO_BEGIN_VERSIONED_NAMESPACE_DECL
  28
  29 namespace TAO
  30 {
  31   namespace CSD
  32   {
  33     class TP_Custom_Request_Operation;
  34     typedef TAO_Intrusive_Ref_Count_Handle<TP_Custom_Request_Operation>
  35                                           TP_Custom_Request_Operation_Handle;
  36
  37
  38     /**
  39      * @class TP_Custom_Request_Operation
  40      *
  41      * @brief Base class for all custom request operations.
  42      *
  43      * @note  The caller that creates a new TP_Custom_Request_Operation
  44      *        object needs call _add_ref () on the servant before
  45      *        constructing it and the TP_Custom_Request_Operation object
  46      *        is responsible to decrement the reference count.
  47      *
  48      * TBD - Add description
  49      */
  50     class TAO_CSD_TP_Export TP_Custom_Request_Operation
  51                       : public TAO_Intrusive_Ref_Count_Base<TAO_SYNCH_MUTEX>
  52     {
  53     public:
  54       /// Virtual Destructor.
  55       virtual ~TP_Custom_Request_Operation();
  56
  57       /// Invoked by a worker thread to perform the operation.
  58       void execute();
  59
  60       /// Invoked when the request has been cancelled.
  61       void cancel();
  62
  63       /// Used by the TP_Strategy to obtain the target servant in order
  64       /// to construct the custom request object.  Returns the servant as
  65       /// an "in" argument (the caller does not get a new 'copy').  This
  66       /// is useful for chaining.
  67       PortableServer::Servant servant();
  68
  69     protected:
  70       /// Constructor.
  71       TP_Custom_Request_Operation(PortableServer::Servant servant);
  72
  73       virtual void execute_i() = 0;
  74       virtual void cancel_i() = 0;
  75
  76     private:
  77       PortableServer::ServantBase_var servant_;
  78     };
  79   }
  80 }
  81
  82 TAO_END_VERSIONED_NAMESPACE_DECL
  83
  84 #if defined (__ACE_INLINE__)
  85 # include "tao/CSD_ThreadPool/CSD_TP_Custom_Request_Operation.inl"
  86 #endif /* __ACE_INLINE__ */
  87
  88 #include /**/ "ace/post.h"
  89
  90 #endif /* TAO_CSD_TP_CUSTOM_REQUEST_OPERATION_H */