TAO/tao/CSD_ThreadPool/CSD_TP_Remote_Request.h

   1 // -*- C++ -*-
   2
   3 //=============================================================================
   4 /**
   5  *  @file    CSD_TP_Remote_Request.h
   6  *
   7  *  @author  Tim Bradley <bradley_t@ociweb.com>
   8  */
   9 //=============================================================================
  10
  11 #ifndef TAO_CSD_TP_REMOTE_REQUEST_H
  12 #define TAO_CSD_TP_REMOTE_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_Remote_Request;
  31     typedef TAO_Intrusive_Ref_Count_Handle<TP_Remote_Request>
  32                                              TP_Remote_Request_Handle;
  33
  34     /**
  35      * @class TP_Remote_Request
  36      *
  37      * @brief Represents a "queue-able", remote, CORBA request.
  38      *        Both syncronous and asynchronous remote CORBA requests
  39      *        are represented by the class.
  40      *
  41      * TBD - Go over the following comments and clean up.
  42      *
  43      * Since this class derives from the TP_Request class, it can be
  44      * added to a TP_Queue (ie, it is a "queueable" request).  It
  45      * represents a servant request that has been made by a remote
  46      * CORBA client (as opposed to a collocated CORBA client).  The
  47      * term "CORBA client" is being used here to distinguish CORBA
  48      * servant requests (those made thru a CORBA object reference), and
  49      * "Custom" servant requests that can be "dispatched" to the strategy
  50      * directly by the client application code (ie, not thru a CORBA
  51      * object reference).  Thus, there are "CORBA clients" and
  52      * "Direct clients".
  53      *
  54      * In summary, this class represents a servant request made when a
  55      * remote client invokes a method on a CORBA object reference.
  56      *
  57      */
  58     class TAO_CSD_TP_Export TP_Remote_Request : public TP_Corba_Request
  59     {
  60     public:
  61       /// Constructor.
  62       TP_Remote_Request(TAO_ServerRequest&              server_request,
  63                         const PortableServer::ObjectId& object_id,
  64                         PortableServer::POA_ptr         poa,
  65                         const char*                     operation,
  66                         PortableServer::Servant         servant,
  67                         TP_Servant_State*               servant_state);
  68
  69       /// Virtual Destructor.
  70       virtual ~TP_Remote_Request();
  71
  72
  73     protected:
  74       /// Prepare this TP_Remote_Request object to be placed into the
  75       /// request queue.  This will cause the underlying TAO_ServerRequest
  76       /// object to be cloned.
  77       virtual void prepare_for_queue_i();
  78
  79       /// Dispatch the request to the servant.
  80       virtual void dispatch_i();
  81
  82       /// Cancel the request.
  83       virtual void cancel_i();
  84     };
  85   }
  86 }
  87
  88 TAO_END_VERSIONED_NAMESPACE_DECL
  89
  90 #if defined (__ACE_INLINE__)
  91 # include "tao/CSD_ThreadPool/CSD_TP_Remote_Request.inl"
  92 #endif /* __ACE_INLINE__ */
  93
  94 #include /**/ "ace/post.h"
  95
  96 #endif /* TAO_CSD_TP_REMOTE_REQUEST_H */