log4cplus  2.1.0
appenderattachable.h
Go to the documentation of this file.
1 // -*- C++ -*-
2 // Module: Log4CPLUS
3 // File: appenderattachable.h
4 // Created: 6/2001
5 // Author: Tad E. Smith
6 //
7 //
8 // Copyright 2001-2017 Tad E. Smith
9 //
10 // Licensed under the Apache License, Version 2.0 (the "License");
11 // you may not use this file except in compliance with the License.
12 // You may obtain a copy of the License at
13 //
14 // http://www.apache.org/licenses/LICENSE-2.0
15 //
16 // Unless required by applicable law or agreed to in writing, software
17 // distributed under the License is distributed on an "AS IS" BASIS,
18 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19 // See the License for the specific language governing permissions and
20 // limitations under the License.
21 
24 #ifndef LOG4CPLUS_SPI_APPENDER_ATTACHABLE_HEADER_
25 #define LOG4CPLUS_SPI_APPENDER_ATTACHABLE_HEADER_
26 
27 #include <log4cplus/config.hxx>
28 
29 #if defined (LOG4CPLUS_HAVE_PRAGMA_ONCE)
30 #pragma once
31 #endif
32 
33 #include <log4cplus/appender.h>
34 #include <log4cplus/tstring.h>
36 #include <vector>
37 
38 namespace log4cplus {
39  // Forward Declarations
40  typedef std::vector<log4cplus::SharedAppenderPtr> SharedAppenderPtrList;
41 
42  namespace spi {
43 
48  public:
49  // Methods
53  virtual void addAppender(SharedAppenderPtr newAppender) = 0;
54 
59 
64 
68  virtual void removeAllAppenders() = 0;
69 
73  virtual void removeAppender(SharedAppenderPtr appender) = 0;
74 
79  virtual void removeAppender(const log4cplus::tstring& name) = 0;
80 
81  // Dtor
82  virtual ~AppenderAttachable() = 0;
83  };
84 
85  } // end namespace spi
86 } // end namespace log4cplus
87 
88 #endif // LOG4CPLUS_SPI_APPENDER_ATTACHABLE_HEADER_
This Interface is for attaching Appenders to objects.
virtual void removeAllAppenders()=0
Remove all previously added appenders.
virtual SharedAppenderPtr getAppender(const log4cplus::tstring &name)=0
Get an appender by name.
virtual void addAppender(SharedAppenderPtr newAppender)=0
Add an appender.
virtual SharedAppenderPtrList getAllAppenders()=0
Get all previously added appenders as an Enumeration.
virtual void removeAppender(const log4cplus::tstring &name)=0
Remove the appender with the name passed as parameter from the list of appenders.
virtual void removeAppender(SharedAppenderPtr appender)=0
Remove the appender passed as parameter from the list of appenders.
std::basic_string< tchar > tstring
Definition: tstring.h:39
std::vector< log4cplus::SharedAppenderPtr > SharedAppenderPtrList
#define LOG4CPLUS_EXPORT
Definition: win32.h:141