Apache Log4cxx  Version 1.3.1
nteventlogappender.h
Go to the documentation of this file.
1 /*
2  * Licensed to the Apache Software Foundation (ASF) under one or more
3  * contributor license agreements. See the NOTICE file distributed with
4  * this work for additional information regarding copyright ownership.
5  * The ASF licenses this file to You under the Apache License, Version 2.0
6  * (the "License"); you may not use this file except in compliance with
7  * the License. You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17 
18 #ifndef _LOG4CXX_NT_EVENT_LOG_APPENDER_HEADER_
19 #define _LOG4CXX_NT_EVENT_LOG_APPENDER_HEADER_
20 
22 
23 namespace LOG4CXX_NS
24 {
25 namespace nt
26 {
30 class LOG4CXX_EXPORT NTEventLogAppender : public AppenderSkeleton
31 {
32  public:
38 
40  NTEventLogAppender(const LogString& server, const LogString& log,
41  const LogString& source, const LayoutPtr& layout);
42 
43  virtual ~NTEventLogAppender();
44 
50  void activateOptions(helpers::Pool& p) override;
51  void close() override;
52 
68  void setOption(const LogString& option, const LogString& value) override;
69 
75  bool requiresLayout() const override
76  {
77  return true;
78  }
79 
80  void setSource(const LogString& source);
81 
82  const LogString& getSource() const;
83 
84  void setLog(const LogString& log);
85 
86  const LogString& getLog() const;
87 
88  void setServer(const LogString& server);
89 
90  const LogString& getServer() const;
91 
92 
93  protected:
94  //
95  // these typedef are proxies for the real Win32 definitions
96  // and need to be cast to the global definitions before
97  // use with a Win32 API call
98  typedef void SID;
99  typedef void* HANDLE;
100 
101  void append(const spi::LoggingEventPtr& event, helpers::Pool& p) override;
102  static unsigned short getEventType(const spi::LoggingEventPtr& event);
103  static unsigned short getEventCategory(const spi::LoggingEventPtr& event);
104  /*
105  * Add this source with appropriate configuration keys to the registry.
106  */
108 
109  struct NTEventLogAppenderPrivate;
110  static LogString getErrorString(const LogString& function);
111 
112  private:
114  NTEventLogAppender& operator=(const NTEventLogAppender&);
115 }; // class NTEventLogAppender
116 
118 
119 } // namespace nt
120 } // namespace log4cxx
121 
122 #endif //_LOG4CXX_NT_EVENT_LOG_APPENDER_HEADER_
Implementation base class for all appenders.
Definition: appenderskeleton.h:41
Definition: pool.h:33
Appends log events to NT EventLog.
Definition: nteventlogappender.h:31
const LogString & getSource() const
void setLog(const LogString &log)
void * HANDLE
Definition: nteventlogappender.h:99
static unsigned short getEventType(const spi::LoggingEventPtr &event)
const LogString & getServer() const
void setServer(const LogString &server)
const LogString & getLog() const
static LogString getErrorString(const LogString &function)
void append(const spi::LoggingEventPtr &event, helpers::Pool &p) override
Subclasses of AppenderSkeleton should implement this method to perform actual logging.
void setSource(const LogString &source)
void SID
Definition: nteventlogappender.h:98
static unsigned short getEventCategory(const spi::LoggingEventPtr &event)
LOG4CXX_PTR_DEF(NTEventLogAppender)
std::shared_ptr< LoggingEvent > LoggingEventPtr
Definition: appender.h:31
std::basic_string< logchar > LogString
Definition: logstring.h:60
std::shared_ptr< Layout > LayoutPtr
Definition: appender.h:41
#define LOG4CXX_CAST_ENTRY(Interface)
Definition: object.h:158
#define END_LOG4CXX_CAST_MAP()
Definition: object.h:152
#define DECLARE_LOG4CXX_OBJECT(object)
Definition: object.h:43
#define LOG4CXX_CAST_ENTRY_CHAIN(Interface)
Definition: object.h:164
#define BEGIN_LOG4CXX_CAST_MAP()
Definition: object.h:146