1 | // |
---|
2 | // EventLogChannel.h |
---|
3 | // |
---|
4 | // $Id: //poco/1.3/Foundation/include/Poco/EventLogChannel.h#2 $ |
---|
5 | // |
---|
6 | // Library: Foundation |
---|
7 | // Package: Logging |
---|
8 | // Module: EventLogChannel |
---|
9 | // |
---|
10 | // Definition of the EventLogChannel class specific to WIN32. |
---|
11 | // |
---|
12 | // Copyright (c) 2004-2006, Applied Informatics Software Engineering GmbH. |
---|
13 | // and Contributors. |
---|
14 | // |
---|
15 | // Permission is hereby granted, free of charge, to any person or organization |
---|
16 | // obtaining a copy of the software and accompanying documentation covered by |
---|
17 | // this license (the "Software") to use, reproduce, display, distribute, |
---|
18 | // execute, and transmit the Software, and to prepare derivative works of the |
---|
19 | // Software, and to permit third-parties to whom the Software is furnished to |
---|
20 | // do so, all subject to the following: |
---|
21 | // |
---|
22 | // The copyright notices in the Software and this entire statement, including |
---|
23 | // the above license grant, this restriction and the following disclaimer, |
---|
24 | // must be included in all copies of the Software, in whole or in part, and |
---|
25 | // all derivative works of the Software, unless such copies or derivative |
---|
26 | // works are solely in the form of machine-executable object code generated by |
---|
27 | // a source language processor. |
---|
28 | // |
---|
29 | // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
---|
30 | // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
---|
31 | // FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT |
---|
32 | // SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE |
---|
33 | // FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, |
---|
34 | // ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER |
---|
35 | // DEALINGS IN THE SOFTWARE. |
---|
36 | // |
---|
37 | |
---|
38 | |
---|
39 | #ifndef Foundation_EventLogChannel_INCLUDED |
---|
40 | #define Foundation_EventLogChannel_INCLUDED |
---|
41 | |
---|
42 | |
---|
43 | #include "Poco/Foundation.h" |
---|
44 | #include "Poco/Channel.h" |
---|
45 | #include "Poco/UnWindows.h" |
---|
46 | |
---|
47 | |
---|
48 | namespace Poco { |
---|
49 | |
---|
50 | |
---|
51 | class Foundation_API EventLogChannel: public Channel |
---|
52 | /// This Windows-only channel works with the Windows NT Event Log |
---|
53 | /// service. |
---|
54 | /// |
---|
55 | /// To work properly, the EventLogChannel class requires that either |
---|
56 | /// the PocoFoundation.dll or the PocoMsg.dll Dynamic Link Library |
---|
57 | /// containing the message definition resources can be found in $PATH. |
---|
58 | { |
---|
59 | public: |
---|
60 | EventLogChannel(); |
---|
61 | /// Creates the EventLogChannel. |
---|
62 | /// The name of the current application (or more correctly, |
---|
63 | /// the name of its executable) is taken as event source name. |
---|
64 | |
---|
65 | EventLogChannel(const std::string& name); |
---|
66 | /// Creates the EventLogChannel with the given event source name. |
---|
67 | |
---|
68 | EventLogChannel(const std::string& name, const std::string& host); |
---|
69 | /// Creates an EventLogChannel with the given event source |
---|
70 | /// name that routes messages to the given host. |
---|
71 | |
---|
72 | void open(); |
---|
73 | /// Opens the EventLogChannel. If necessary, the |
---|
74 | /// required registry entries to register a |
---|
75 | /// message resource DLL are made. |
---|
76 | |
---|
77 | void close(); |
---|
78 | /// Closes the EventLogChannel. |
---|
79 | |
---|
80 | void log(const Message& msg); |
---|
81 | /// Logs the given message to the Windows Event Log. |
---|
82 | /// |
---|
83 | /// The message type and priority are mapped to |
---|
84 | /// appropriate values for Event Log type and category. |
---|
85 | |
---|
86 | void setProperty(const std::string& name, const std::string& value); |
---|
87 | /// Sets or changes a configuration property. |
---|
88 | /// |
---|
89 | /// The following properties are supported: |
---|
90 | /// |
---|
91 | /// * name: The name of the event source. |
---|
92 | /// * loghost: The name of the host where the Event Log service is running. |
---|
93 | /// The default is "localhost". |
---|
94 | /// * host: same as host. |
---|
95 | /// * logfile: The name of the log file. The default is "Application". |
---|
96 | |
---|
97 | std::string getProperty(const std::string& name) const; |
---|
98 | /// Returns the value of the given property. |
---|
99 | |
---|
100 | static const std::string PROP_NAME; |
---|
101 | static const std::string PROP_HOST; |
---|
102 | static const std::string PROP_LOGHOST; |
---|
103 | static const std::string PROP_LOGFILE; |
---|
104 | |
---|
105 | protected: |
---|
106 | ~EventLogChannel(); |
---|
107 | static int getType(const Message& msg); |
---|
108 | static int getCategory(const Message& msg); |
---|
109 | void setUpRegistry() const; |
---|
110 | #if defined(POCO_WIN32_UTF8) |
---|
111 | static std::wstring findLibrary(const wchar_t* name); |
---|
112 | #else |
---|
113 | static std::string findLibrary(const char* name); |
---|
114 | #endif |
---|
115 | |
---|
116 | private: |
---|
117 | std::string _name; |
---|
118 | std::string _host; |
---|
119 | std::string _logFile; |
---|
120 | HANDLE _h; |
---|
121 | }; |
---|
122 | |
---|
123 | |
---|
124 | } // namespace Poco |
---|
125 | |
---|
126 | |
---|
127 | #endif // Foundation_EventLogChannel_INCLUDED |
---|