TAO/tests/TransportCurrent/lib/Client_Request_Interceptor.h

   1 // -*- C++ -*-
   2
   3 //=============================================================================
   4 /**
   5  * @file Client_Request_Interceptor.h
   6  *
   7  * Implementation header for the client request interceptor for the
   8  * Transport::Current test.
   9  *
  10  * @author Ossama Othman <ossama@uci.edu>
  11  */
  12 //=============================================================================
  13
  14 #ifndef CLIENT_REQUEST_INTERCEPTOR_H
  15 #define CLIENT_REQUEST_INTERCEPTOR_H
  16
  17 #include /**/ "ace/config.h"
  18 #include /**/ "Current_Test_Export.h"
  19
  20 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  21 # pragma once
  22 #endif /* ACE_LACKS_PRAGMA_ONCE */
  23
  24 #include "tao/PI/PI.h"
  25 #include "tao/PortableInterceptorC.h"
  26 #include "tao/LocalObject.h"
  27 #include "tao/ORB.h"
  28 #include "tao/CORBA_String.h"
  29
  30 namespace Test
  31 {
  32   /// A metod doing the actual testing, so we could change it for the
  33   /// different traits implementations
  34   typedef int (*TEST) (CORBA::ORB_ptr);
  35
  36
  37   /**
  38    * @class Client_Request_Interceptor
  39    *
  40    * @brief Client request interceptor that exercises
  41    * Transport::Current support.
  42    *
  43    * This client request interceptor forwards a request to a secondary
  44    * object by throwing the PortableInterceptor::ForwardRequest
  45    * exception from within the send_request() interception point.  It
  46    * only forwards the initial request.  See the README file for
  47    * details.
  48    */
  49   class Current_Test_Export Client_Request_Interceptor
  50     : public virtual PortableInterceptor::ClientRequestInterceptor,
  51       public virtual ::CORBA::LocalObject
  52   {
  53  public:
  54     /// Constructor.
  55     Client_Request_Interceptor (const char *orb_id,
  56                                 TEST test);
  57     /**
  58      * @name Methods Required by the Client Request Interceptor
  59      * Interface
  60      *
  61      * These are methods that must be implemented since they are pure
  62      * virtual in the abstract base class.  They are the canonical
  63      * methods required for all client request interceptors.
  64      */
  65     //@{
  66     /// Return the name of this ClientRequestinterceptor.
  67     virtual char * name ();
  68
  69     virtual void destroy ();
  70
  71     virtual void send_request (PortableInterceptor::ClientRequestInfo_ptr ri);
  72
  73     virtual void send_poll (PortableInterceptor::ClientRequestInfo_ptr ri);
  74
  75     virtual void receive_reply (PortableInterceptor::ClientRequestInfo_ptr ri);
  76
  77     virtual void receive_exception (PortableInterceptor::ClientRequestInfo_ptr ri);
  78
  79     virtual void receive_other (PortableInterceptor::ClientRequestInfo_ptr ri);
  80     //@}
  81
  82     // Number of interceptions
  83     CORBA::Long interceptions ();
  84
  85   private:
  86     // Implementation method, every inteception point will have to
  87     // call it, supplying a name.
  88     void test_transport_current (const ACE_TCHAR* amethod);
  89
  90   private:
  91     ///The ID of the ORB this interceptor is registered with.
  92     CORBA::String_var orb_id_;
  93
  94     /// Pseudo-reference to the ORB this interceptor is registered
  95     /// with.
  96     CORBA::ORB_var orb_;
  97
  98     /// The number of requests intercepted by this interceptor.
  99     CORBA::ULong request_count_;
 100
 101     /// Stringified reference to the object the initial request will be
 102     /// forwarded to by this interceptor.
 103     CORBA::String_var forward_str_;
 104
 105     /// Synchronize internal state...
 106     TAO_SYNCH_MUTEX lock_;
 107
 108     /// Unique request ID
 109     unsigned long requestID_;
 110
 111     /// Test function
 112     TEST test_;
 113   };
 114 } // namespace Test
 115
 116 #endif  /* CLIENT_REQUEST_INTERCEPTOR_H */