[80] | 1 | // |
---|
| 2 | // Channel.h |
---|
| 3 | // |
---|
| 4 | // $Id: //poco/1.3/Foundation/include/Poco/Channel.h#2 $ |
---|
| 5 | // |
---|
| 6 | // Library: Foundation |
---|
| 7 | // Package: Logging |
---|
| 8 | // Module: Channel |
---|
| 9 | // |
---|
| 10 | // Definition of the Channel 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_Channel_INCLUDED |
---|
| 40 | #define Foundation_Channel_INCLUDED |
---|
| 41 | |
---|
| 42 | |
---|
| 43 | #include "Poco/Foundation.h" |
---|
| 44 | #include "Poco/Configurable.h" |
---|
| 45 | #include "Poco/Mutex.h" |
---|
| 46 | #include "Poco/RefCountedObject.h" |
---|
| 47 | |
---|
| 48 | |
---|
| 49 | namespace Poco { |
---|
| 50 | |
---|
| 51 | |
---|
| 52 | class Message; |
---|
| 53 | |
---|
| 54 | |
---|
| 55 | class Foundation_API Channel: public Configurable, public RefCountedObject |
---|
| 56 | /// The base class for all Channel classes. |
---|
| 57 | /// |
---|
| 58 | /// Supports reference counting based garbage |
---|
| 59 | /// collection and provides trivial implementations |
---|
| 60 | /// of getProperty() and setProperty(). |
---|
| 61 | { |
---|
| 62 | public: |
---|
| 63 | Channel(); |
---|
| 64 | /// Creates the channel and initializes |
---|
| 65 | /// the reference count to one. |
---|
| 66 | |
---|
| 67 | virtual void open(); |
---|
| 68 | /// Does whatever is necessary to open the channel. |
---|
| 69 | /// The default implementation does nothing. |
---|
| 70 | |
---|
| 71 | virtual void close(); |
---|
| 72 | /// Does whatever is necessary to close the channel. |
---|
| 73 | /// The default implementation does nothing. |
---|
| 74 | |
---|
| 75 | virtual void log(const Message& msg) = 0; |
---|
| 76 | /// Logs the given message to the channel. Must be |
---|
| 77 | /// overridden by subclasses. |
---|
| 78 | /// |
---|
| 79 | /// If the channel has not been opened yet, the log() |
---|
| 80 | /// method will open it. |
---|
| 81 | |
---|
| 82 | void setProperty(const std::string& name, const std::string& value); |
---|
| 83 | /// Throws a PropertyNotSupportedException. |
---|
| 84 | |
---|
| 85 | std::string getProperty(const std::string& name) const; |
---|
| 86 | /// Throws a PropertyNotSupportedException. |
---|
| 87 | |
---|
| 88 | protected: |
---|
| 89 | virtual ~Channel(); |
---|
| 90 | |
---|
| 91 | private: |
---|
| 92 | Channel(const Channel&); |
---|
| 93 | Channel& operator = (const Channel&); |
---|
| 94 | }; |
---|
| 95 | |
---|
| 96 | |
---|
| 97 | } // namespace Poco |
---|
| 98 | |
---|
| 99 | |
---|
| 100 | #endif // Foundation_Channel_INCLUDED |
---|