TAO/orbsvcs/FT_ReplicationManager/FT_FaultConsumer.h

   1 /* -*- C++ -*- */
   2 //=============================================================================
   3 /**
   4  *  @file    FT_FaultConsumer.h
   5  *
   6  *  This file is part of TAO's implementation of Fault Tolerant CORBA.
   7  *
   8  *  @author Steve Totten <totten_s@ociweb.com>
   9  */
  10 //=============================================================================
  11
  12
  13 #ifndef FT_FAULT_CONSUMER_H_
  14 #define FT_FAULT_CONSUMER_H_
  15
  16 #include /**/ "ace/pre.h"
  17 #include <ace/ACE.h>
  18
  19 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  20 #pragma once
  21 #endif /* ACE_LACKS_PRAGMA_ONCE */
  22
  23 #include "orbsvcs/CosNotifyCommS.h"
  24 #include "orbsvcs/FT_NotifierC.h"
  25 #include "FT_ReplicationManagerLib_export.h"
  26
  27 TAO_BEGIN_VERSIONED_NAMESPACE_DECL
  28
  29 namespace TAO
  30 {
  31   ///////////////////////
  32   // Forward declarations
  33   class FT_FaultAnalyzer;
  34
  35   /**
  36   * Implement the CosNotifyComm::StructuredPushConsumer interface.
  37   *
  38   */
  39   class TAO_ReplicationManagerLib_Export FT_FaultConsumer
  40     : public virtual POA_CosNotifyComm::StructuredPushConsumer
  41   {
  42     //////////////////////
  43     // non-CORBA interface
  44
  45   public:
  46     /**
  47     * Default constructor.
  48     */
  49     FT_FaultConsumer ();
  50
  51     /**
  52     * Destructor.
  53     */
  54     virtual ~FT_FaultConsumer ();
  55
  56     /**
  57     * Connect to the FT::FaultNotifier.
  58     * Note: We make the following assumptions about what the
  59     * application will do:
  60     * - Create an instance of this consumer class.
  61     * - Obtain the object reference of the FaultNotifier to which this
  62     *   consumer should connect.
  63     * - Call this init() method, passing it the POA with which we
  64     *   have been activated, the FaultNotifier, and ReplicationManager
  65     *   object references.
  66     */
  67     int init (
  68       PortableServer::POA_ptr poa,
  69       FT::FaultNotifier_ptr fault_notifier,
  70       TAO::FT_FaultAnalyzer * fault_analyzer);
  71
  72     /**
  73     * Clean house for process shut down.
  74     * - Disconnect from FT::FaultNotifier.
  75     * - Deactivate from the POA.
  76     */
  77     int fini ();
  78
  79     /**
  80     * Accessor for a duplicate of this consumer's object reference.
  81     */
  82     CosNotifyComm::StructuredPushConsumer_ptr consumer_ref ();
  83
  84     //@@ For testing purposes only, will be removed later.
  85     /**
  86     * Accessor for the number of notifications we have received.
  87     */
  88     size_t notifications () const;
  89
  90   public:
  91     /**
  92     * @name POA_CosNotifyComm::StructuredPushConsumer Methods
  93     *
  94     * Methods required by the POA_CosNotifyComm::StructuredPushConsumer
  95     * interface.
  96     */
  97     //@{
  98     ////////////////
  99     // CORBA methods
 100     virtual void push_structured_event (
 101       const CosNotification::StructuredEvent &notification);
 102
 103    virtual void offer_change (
 104         const CosNotification::EventTypeSeq & added,
 105         const CosNotification::EventTypeSeq & removed);
 106
 107    virtual void disconnect_structured_push_consumer ();
 108
 109     //@}
 110
 111     ////////////////////
 112     // Forbidden methods
 113   private:
 114     /// Copy constructor.
 115     FT_FaultConsumer (const FT_FaultConsumer & rhs);
 116     /// Assignment operator.
 117     FT_FaultConsumer & operator = (const FT_FaultConsumer & rhs);
 118
 119     ///////////////
 120     // Data Members
 121   private:
 122     /// The POA with which we are activated.
 123     PortableServer::POA_var poa_;
 124
 125     /// The ObjectId from our activation in the POA.
 126     PortableServer::ObjectId_var object_id_;
 127
 128     /// The FaultNotifier's object reference.
 129     FT::FaultNotifier_var fault_notifier_;
 130
 131     /// Application-specific Fault Analyzer.
 132     TAO::FT_FaultAnalyzer * fault_analyzer_;
 133
 134     /// ConsumerId assigned by the notifier.
 135     FT::FaultNotifier::ConsumerId consumer_id_;
 136
 137     /// Our consumer object reference.
 138     CosNotifyComm::StructuredPushConsumer_var consumer_ref_;
 139
 140     ///TODO: Remove this later, it is just for testing.
 141     // Keep track of how many notifications we have received.
 142     size_t notifications_;
 143   };
 144 } // namespace TAO
 145
 146 TAO_END_VERSIONED_NAMESPACE_DECL
 147
 148 #include /**/ "ace/post.h"
 149
 150 #endif  /* FT_FAULT_CONSUMER_H_ */
 151