ACE/ace/Log_Msg_NT_Event_Log.h

   1 // -*- C++ -*-
   2
   3 //=============================================================================
   4 /**
   5  *  @file    Log_Msg_NT_Event_Log.h
   6  *
   7  *  @author Christopher Kohlhoff <chris@kohlhoff.com>
   8  */
   9 //=============================================================================
  10
  11 #ifndef ACE_LOG_MSG_NT_EVENT_LOG_H
  12 #define ACE_LOG_MSG_NT_EVENT_LOG_H
  13 #include /**/ "ace/pre.h"
  14
  15 #include /**/ "ace/config-all.h"
  16
  17 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  18 # pragma once
  19 #endif /* ACE_LACKS_PRAGMA_ONCE */
  20
  21 #if defined ACE_HAS_LOG_MSG_NT_EVENT_LOG
  22
  23 #include "ace/Log_Msg_Backend.h"
  24
  25 ACE_BEGIN_VERSIONED_NAMESPACE_DECL
  26
  27 /**
  28  * @class ACE_Log_Msg_NT_Event_Log
  29  *
  30  * @brief Implements an ACE_Log_Msg_Backend that logs to the WinNT system
  31  * event log.
  32  */
  33 class ACE_Export ACE_Log_Msg_NT_Event_Log : public ACE_Log_Msg_Backend
  34 {
  35 public:
  36   /// Constructor
  37   ACE_Log_Msg_NT_Event_Log () = default;
  38
  39   /// Destructor
  40   ~ACE_Log_Msg_NT_Event_Log () override;
  41
  42   /// Open a new event log.
  43   /**
  44    * Initialize the event logging facility.
  45    * @param logger_key The name of the calling program. This name is
  46    *                   used in the Source field of the event log. If
  47    *                   it is 0 (no name), the application name as
  48    *                   returned from ACE_Log_Msg::program_name() is used.
  49    */
  50   int open (const ACE_TCHAR *logger_key) override;
  51
  52   /// Reset the backend.
  53   int reset () override;
  54
  55   /// Close the backend completely.
  56   int close () override;
  57
  58   /// This is called when we want to log a message.
  59   ssize_t log (ACE_Log_Record &log_record) override;
  60
  61 private:
  62   HANDLE evlog_handle_ {0};
  63 };
  64
  65 ACE_END_VERSIONED_NAMESPACE_DECL
  66
  67 #endif /* ACE_HAS_LOG_MSG_NT_EVENT_LOG */
  68
  69 #include /**/ "ace/post.h"
  70 #endif /* ACE_LOG_MSG_NT_EVENT_LOG_H */