1 | // |
---|
2 | // LoggingRegistry.h |
---|
3 | // |
---|
4 | // $Id: //poco/1.3/Foundation/include/Poco/LoggingRegistry.h#1 $ |
---|
5 | // |
---|
6 | // Library: Foundation |
---|
7 | // Package: Logging |
---|
8 | // Module: LoggingRegistry |
---|
9 | // |
---|
10 | // Definition of the LoggingRegistry class. |
---|
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_LoggingRegistry_INCLUDED |
---|
40 | #define Foundation_LoggingRegistry_INCLUDED |
---|
41 | |
---|
42 | |
---|
43 | #include "Poco/Foundation.h" |
---|
44 | #include "Poco/AutoPtr.h" |
---|
45 | #include "Poco/Channel.h" |
---|
46 | #include "Poco/Formatter.h" |
---|
47 | #include "Poco/Mutex.h" |
---|
48 | #include <map> |
---|
49 | |
---|
50 | |
---|
51 | namespace Poco { |
---|
52 | |
---|
53 | |
---|
54 | class Foundation_API LoggingRegistry |
---|
55 | /// A registry for channels and formatters. |
---|
56 | /// |
---|
57 | /// The LoggingRegistry class is used for configuring |
---|
58 | /// the logging framework. |
---|
59 | { |
---|
60 | public: |
---|
61 | LoggingRegistry(); |
---|
62 | /// Creates the LoggingRegistry. |
---|
63 | |
---|
64 | ~LoggingRegistry(); |
---|
65 | /// Destroys the LoggingRegistry. |
---|
66 | |
---|
67 | Channel* channelForName(const std::string& name) const; |
---|
68 | /// Returns the Channel object which has been registered |
---|
69 | /// under the given name. |
---|
70 | /// |
---|
71 | /// Throws a NotFoundException if the name is unknown. |
---|
72 | |
---|
73 | Formatter* formatterForName(const std::string& name) const; |
---|
74 | /// Returns the Formatter object which has been registered |
---|
75 | /// under the given name. |
---|
76 | /// |
---|
77 | /// Throws a NotFoundException if the name is unknown. |
---|
78 | |
---|
79 | void registerChannel(const std::string& name, Channel* pChannel); |
---|
80 | /// Registers a channel under a given name. |
---|
81 | /// It is okay to re-register a different channel under an |
---|
82 | /// already existing name. |
---|
83 | |
---|
84 | void registerFormatter(const std::string& name, Formatter* pFormatter); |
---|
85 | /// Registers a formatter under a given name. |
---|
86 | /// It is okay to re-register a different formatter under an |
---|
87 | /// already existing name. |
---|
88 | |
---|
89 | void unregisterChannel(const std::string& name); |
---|
90 | /// Unregisters the given channel. |
---|
91 | /// |
---|
92 | /// Throws a NotFoundException if the name is unknown. |
---|
93 | |
---|
94 | void unregisterFormatter(const std::string& name); |
---|
95 | /// Unregisters the given formatter. |
---|
96 | /// |
---|
97 | /// Throws a NotFoundException if the name is unknown. |
---|
98 | |
---|
99 | void clear(); |
---|
100 | /// Unregisters all registered channels and formatters. |
---|
101 | |
---|
102 | static LoggingRegistry& defaultRegistry(); |
---|
103 | /// Returns a reference to the default |
---|
104 | /// LoggingRegistry. |
---|
105 | |
---|
106 | private: |
---|
107 | typedef AutoPtr<Channel> ChannelPtr; |
---|
108 | typedef AutoPtr<Formatter> FormatterPtr; |
---|
109 | typedef std::map<std::string, ChannelPtr> ChannelMap; |
---|
110 | typedef std::map<std::string, FormatterPtr> FormatterMap; |
---|
111 | |
---|
112 | ChannelMap _channelMap; |
---|
113 | FormatterMap _formatterMap; |
---|
114 | mutable FastMutex _mutex; |
---|
115 | }; |
---|
116 | |
---|
117 | |
---|
118 | } // namespace Poco |
---|
119 | |
---|
120 | |
---|
121 | #endif // Foundation_LoggingRegistry_INCLUDED |
---|