TAO/orbsvcs/FT_ReplicationManager/FT_FaultAnalyzer.h

   1 /* -*- C++ -*- */
   2 //=============================================================================
   3 /**
   4  *  @file    FT_FaultAnalyzer.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_ANALYZER_H_
  14 #define FT_FAULT_ANALYZER_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 "FT_ReplicationManagerLib_export.h"
  24 #include "orbsvcs/CosNotifyCommC.h"
  25
  26 TAO_BEGIN_VERSIONED_NAMESPACE_DECL
  27
  28 namespace TAO
  29 {
  30   /**
  31   * Abstract base class for application-defined fault analyzers.
  32   *
  33   */
  34   class TAO_ReplicationManagerLib_Export FT_FaultAnalyzer
  35   {
  36
  37   public:
  38     /**
  39     * Default constructor.
  40     */
  41     FT_FaultAnalyzer ();
  42
  43     /**
  44     * Destructor.
  45     */
  46     virtual ~FT_FaultAnalyzer ();
  47
  48   public:
  49
  50     /**
  51     * Validate event type to make sure it is one we can handle.
  52     * @param event The structured fault event, as from the Fault Notifier.
  53     * @return 0 if it is a valid event type, -1 otherwise.
  54     */
  55     virtual int validate_event_type (
  56       const CosNotification::StructuredEvent & event) = 0;
  57
  58     /**
  59     * Analyze a fault event.
  60     * @param event The structured fault event, as from the Fault Notifier.
  61     * @return 0 on success, -1 on failure.
  62     */
  63     virtual int analyze_fault_event (
  64       const CosNotification::StructuredEvent & event) = 0;
  65
  66     ////////////////////
  67     // Forbidden methods
  68   private:
  69     /// Copy constructor.
  70     FT_FaultAnalyzer (const FT_FaultAnalyzer & rhs);
  71     /// Assignment operator.
  72     FT_FaultAnalyzer & operator = (const FT_FaultAnalyzer & rhs);
  73
  74     ///////////////
  75     // Data Members
  76   private:
  77
  78   };
  79
  80 } // namespace TAO
  81
  82 TAO_END_VERSIONED_NAMESPACE_DECL
  83
  84 #include /**/ "ace/post.h"
  85
  86 #endif  /* FT_FAULT_ANALYZER_H_ */
  87