TAO/tao/CSD_ThreadPool/CSD_TP_Collocated_Asynch_Request.h

   1 // -*- C++ -*-
   2
   3 //=============================================================================
   4 /**
   5  *  @file    CSD_TP_Collocated_Asynch_Request.h
   6  *
   7  *  @author  Tim Bradley <bradley_t@ociweb.com>
   8  */
   9 //=============================================================================
  10
  11 #ifndef TAO_CSD_TP_COLLOCATED_ASYNCH_REQUEST_H
  12 #define TAO_CSD_TP_COLLOCATED_ASYNCH_REQUEST_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/CSD_ThreadPool/CSD_TP_Corba_Request.h"
  23
  24 TAO_BEGIN_VERSIONED_NAMESPACE_DECL
  25
  26 namespace TAO
  27 {
  28   namespace CSD
  29   {
  30     class TP_Collocated_Asynch_Request;
  31     typedef TAO_Intrusive_Ref_Count_Handle<TP_Collocated_Asynch_Request>
  32                                         TP_Collocated_Asynch_Request_Handle;
  33
  34     /**
  35      * @class TP_Collocated_Asynch_Request
  36      *
  37      * @brief Represents a "queue-able", collocated, asynchronous,
  38      *        CORBA request.
  39      *
  40      * This kind request is one-way collocated request with the default
  41      * SYNC_SCOPE policy (SYNC_WITH_TRANSPORT) applied. It is cloned
  42      * before enqueuing and the "enqueuing" thread never blocks.
  43      */
  44     class TAO_CSD_TP_Export TP_Collocated_Asynch_Request
  45                                                  : public TP_Corba_Request
  46     {
  47     public:
  48       /// Constructor.
  49       TP_Collocated_Asynch_Request
  50                            (TAO_ServerRequest&              server_request,
  51                             const PortableServer::ObjectId& object_id,
  52                             PortableServer::POA_ptr         poa,
  53                             const char*                     operation,
  54                             PortableServer::Servant         servant,
  55                             TP_Servant_State*               servant_state);
  56
  57       /// Virtual Destructor.
  58       virtual ~TP_Collocated_Asynch_Request();
  59
  60
  61     protected:
  62       /// Prepare this TP_Collocated_Asynch_Request object to be placed
  63       /// into the request queue.  This will cause the underlying
  64       /// TAO_ServerRequest object to be cloned.
  65       virtual void prepare_for_queue_i();
  66
  67       /// Dispatch the request to the servant.
  68       virtual void dispatch_i();
  69
  70       /// Cancel the request.
  71       virtual void cancel_i();
  72     };
  73   }
  74 }
  75
  76 TAO_END_VERSIONED_NAMESPACE_DECL
  77
  78 #if defined (__ACE_INLINE__)
  79 # include "tao/CSD_ThreadPool/CSD_TP_Collocated_Asynch_Request.inl"
  80 #endif /* __ACE_INLINE__ */
  81
  82 #include /**/ "ace/post.h"
  83
  84 #endif /* TAO_CSD_TP_COLLOCATED_ASYNCH_REQUEST_H */