aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/libs/poco/Foundation/include/Poco/Channel.h
blob: d3633ae897957ba277dab36f5fded9990b425612 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
// 
// Channel.h 
// 
// Library: Foundation 
// Package: Logging 
// Module:  Channel 
// 
// Definition of the Channel class. 
// 
// Copyright (c) 2004-2006, Applied Informatics Software Engineering GmbH. 
// and Contributors. 
// 
// SPDX-License-Identifier:	BSL-1.0 
// 
 
 
#ifndef Foundation_Channel_INCLUDED 
#define Foundation_Channel_INCLUDED 
 
 
#include "Poco/Foundation.h" 
#include "Poco/Configurable.h" 
#include "Poco/Mutex.h" 
#include "Poco/RefCountedObject.h" 
 
 
namespace Poco { 
 
 
class Message; 
 
 
class Foundation_API Channel: public Configurable, public RefCountedObject 
	/// The base class for all Channel classes. 
	/// 
	/// Supports reference counting based garbage 
	/// collection and provides trivial implementations 
	/// of getProperty() and setProperty(). 
{ 
public: 
	Channel(); 
		/// Creates the channel and initializes 
		/// the reference count to one. 
 
	virtual void open(); 
		/// Does whatever is necessary to open the channel.  
		/// The default implementation does nothing. 
		 
	virtual void close(); 
		/// Does whatever is necessary to close the channel. 
		/// The default implementation does nothing. 
		 
	virtual void log(const Message& msg) = 0; 
		/// Logs the given message to the channel. Must be 
		/// overridden by subclasses. 
		/// 
		/// If the channel has not been opened yet, the log() 
		/// method will open it. 
		 
	void setProperty(const std::string& name, const std::string& value); 
		/// Throws a PropertyNotSupportedException. 
 
	std::string getProperty(const std::string& name) const; 
		/// Throws a PropertyNotSupportedException. 
		 
protected: 
	virtual ~Channel(); 
	 
private: 
	Channel(const Channel&); 
	Channel& operator = (const Channel&); 
}; 
 
 
} // namespace Poco 
 
 
#endif // Foundation_Channel_INCLUDED