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_HELPERS_APPENDER_ATTACHABLE_IMPL_H
19 #define _LOG4CXX_HELPERS_APPENDER_ATTACHABLE_IMPL_H
20 
21 #if defined(_MSC_VER)
22 	#pragma warning ( push )
23 	#pragma warning ( disable: 4231 4251 4275 4786 )
24 #endif
25 
26 
27 #include <log4cxx/spi/appenderattachable.h>
28 #include <log4cxx/helpers/objectimpl.h>
29 #include <log4cxx/helpers/mutex.h>
30 #include <log4cxx/helpers/pool.h>
31 
32 namespace log4cxx
33 {
34 namespace spi
35 {
36 class LoggingEvent;
37 typedef helpers::ObjectPtrT<LoggingEvent> LoggingEventPtr;
38 }
39 
40 namespace helpers
41 {
42 
43 class LOG4CXX_EXPORT AppenderAttachableImpl :
44 	public virtual spi::AppenderAttachable,
45 	public virtual helpers::ObjectImpl
46 {
47 	protected:
48 		/** Array of appenders. */
49 		AppenderList  appenderList;
50 
51 	public:
52 		/**
53 		 *   Create new instance.
54 		 *   @param pool pool, must be longer-lived than instance.
55 		 */
56 		AppenderAttachableImpl(Pool& pool);
57 
58 		DECLARE_ABSTRACT_LOG4CXX_OBJECT(AppenderAttachableImpl)
59 		BEGIN_LOG4CXX_CAST_MAP()
60 		LOG4CXX_CAST_ENTRY(AppenderAttachableImpl)
61 		LOG4CXX_CAST_ENTRY(spi::AppenderAttachable)
62 		END_LOG4CXX_CAST_MAP()
63 
64 		void addRef() const;
65 		void releaseRef() const;
66 
67 		// Methods
68 		/**
69 		 * Add an appender.
70 		 */
71 		virtual void addAppender(const AppenderPtr& newAppender);
72 
73 		/**
74 		 Call the <code>doAppend</code> method on all attached appenders.
75 		*/
76 		int appendLoopOnAppenders(const spi::LoggingEventPtr& event,
77 			log4cxx::helpers::Pool& p);
78 
79 		/**
80 		 * Get all previously added appenders as an Enumeration.
81 		 */
82 		virtual AppenderList getAllAppenders() const;
83 
84 		/**
85 		 * Get an appender by name.
86 		 */
87 		virtual AppenderPtr getAppender(const LogString& name) const;
88 
89 		/**
90 		 Returns <code>true</code> if the specified appender is in the
91 		 list of attached appenders, <code>false</code> otherwise.
92 		*/
93 		virtual bool isAttached(const AppenderPtr& appender) const;
94 
95 		/**
96 		 * Remove all previously added appenders.
97 		 */
98 		virtual void removeAllAppenders();
99 
100 		/**
101 		 * Remove the appender passed as parameter from the list of appenders.
102 		 */
103 		virtual void removeAppender(const AppenderPtr& appender);
104 
105 		/**
106 		 * Remove the appender with the name passed as parameter from the
107 		 * list of appenders.
108 		 */
109 		virtual void removeAppender(const LogString& name);
110 
getMutex()111 		inline const log4cxx::helpers::Mutex& getMutex() const
112 		{
113 			return mutex;
114 		}
115 
116 	private:
117 		log4cxx::helpers::Mutex mutex;
118 		AppenderAttachableImpl(const AppenderAttachableImpl&);
119 		AppenderAttachableImpl& operator=(const AppenderAttachableImpl&);
120 };
121 
122 LOG4CXX_PTR_DEF(AppenderAttachableImpl);
123 
124 }
125 }
126 
127 #if defined(_MSC_VER)
128 	#pragma warning ( pop )
129 #endif
130 
131 #endif //_LOG4CXX_HELPERS_APPENDER_ATTACHABLE_IMPL_H
132