log4cplus  1.1.0
appenderattachable.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 // Module:  Log4CPLUS
00003 // File:    appenderattachable.h
00004 // Created: 6/2001
00005 // Author:  Tad E. Smith
00006 //
00007 //
00008 // Copyright 2001-2010 Tad E. Smith
00009 //
00010 // Licensed under the Apache License, Version 2.0 (the "License");
00011 // you may not use this file except in compliance with the License.
00012 // You may obtain a copy of the License at
00013 //
00014 //     http://www.apache.org/licenses/LICENSE-2.0
00015 //
00016 // Unless required by applicable law or agreed to in writing, software
00017 // distributed under the License is distributed on an "AS IS" BASIS,
00018 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00019 // See the License for the specific language governing permissions and
00020 // limitations under the License.
00021 
00024 #ifndef LOG4CPLUS_SPI_APPENDER_ATTACHABLE_HEADER_
00025 #define LOG4CPLUS_SPI_APPENDER_ATTACHABLE_HEADER_
00026 
00027 #include <log4cplus/config.hxx>
00028 
00029 #if defined (LOG4CPLUS_HAVE_PRAGMA_ONCE)
00030 #pragma once
00031 #endif
00032 
00033 #include <log4cplus/appender.h>
00034 #include <log4cplus/tstring.h>
00035 #include <log4cplus/helpers/pointer.h>
00036 #include <vector>
00037 
00038 namespace log4cplus {
00039     // Forward Declarations
00040     typedef helpers::SharedObjectPtr<Appender> SharedAppenderPtr;
00041     typedef std::vector<log4cplus::SharedAppenderPtr> SharedAppenderPtrList;
00042 
00043     namespace spi {
00044 
00048         class LOG4CPLUS_EXPORT AppenderAttachable {
00049         public:
00050           // Methods
00054             virtual void addAppender(SharedAppenderPtr newAppender) = 0;
00055 
00059             virtual SharedAppenderPtrList getAllAppenders() = 0;
00060 
00064             virtual SharedAppenderPtr getAppender(const log4cplus::tstring& name) = 0;
00065 
00069             virtual void removeAllAppenders() = 0;
00070 
00074             virtual void removeAppender(SharedAppenderPtr appender) = 0;
00075 
00080             virtual void removeAppender(const log4cplus::tstring& name) = 0;
00081 
00082           // Dtor
00083             virtual ~AppenderAttachable() = 0;
00084         };
00085 
00086     } // end namespace spi
00087 } // end namespace log4cplus
00088 
00089 #endif // LOG4CPLUS_SPI_APPENDER_ATTACHABLE_HEADER_
00090