appenderattachable.h
Go to the documentation of this file.
// -*- C++ -*-
// Module: Log4CPLUS
// File: appenderattachable.h
// Created: 6/2001
// Author: Tad E. Smith
//
//
// Copyright 2001-2017 Tad E. Smith
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#ifndef LOG4CPLUS_SPI_APPENDER_ATTACHABLE_HEADER_
#define LOG4CPLUS_SPI_APPENDER_ATTACHABLE_HEADER_
#include <log4cplus/config.hxx>
#if defined (LOG4CPLUS_HAVE_PRAGMA_ONCE)
#pragma once
#endif
#include <log4cplus/appender.h>
#include <log4cplus/tstring.h>
#include <log4cplus/helpers/pointer.h>
#include <vector>
namespace log4cplus {
// Forward Declarations
typedef std::vector<log4cplus::SharedAppenderPtr> SharedAppenderPtrList;
namespace spi {
class LOG4CPLUS_EXPORT AppenderAttachable {
public:
// Methods
virtual void addAppender(SharedAppenderPtr newAppender) = 0;
virtual SharedAppenderPtrList getAllAppenders() = 0;
virtual SharedAppenderPtr getAppender(const log4cplus::tstring& name) = 0;
virtual void removeAllAppenders() = 0;
virtual void removeAppender(SharedAppenderPtr appender) = 0;
virtual void removeAppender(const log4cplus::tstring& name) = 0;
// Dtor
virtual ~AppenderAttachable() = 0;
};
} // end namespace spi
} // end namespace log4cplus
#endif // LOG4CPLUS_SPI_APPENDER_ATTACHABLE_HEADER_
appender.h
log4cplus::spi::AppenderAttachable
This Interface is for attaching Appenders to objects.
Definition appenderattachable.h:47
log4cplus::spi::AppenderAttachable::~AppenderAttachable
virtual ~AppenderAttachable()=0
log4cplus::spi::AppenderAttachable::removeAllAppenders
virtual void removeAllAppenders()=0
Remove all previously added appenders.
log4cplus::spi::AppenderAttachable::getAppender
virtual SharedAppenderPtr getAppender(const log4cplus::tstring &name)=0
Get an appender by name.
log4cplus::spi::AppenderAttachable::addAppender
virtual void addAppender(SharedAppenderPtr newAppender)=0
Add an appender.
log4cplus::spi::AppenderAttachable::getAllAppenders
virtual SharedAppenderPtrList getAllAppenders()=0
Get all previously added appenders as an Enumeration.
log4cplus::spi::AppenderAttachable::removeAppender
virtual void removeAppender(const log4cplus::tstring &name)=0
Remove the appender with the name passed as parameter from the list of appenders.
log4cplus::spi::AppenderAttachable::removeAppender
virtual void removeAppender(SharedAppenderPtr appender)=0
Remove the appender passed as parameter from the list of appenders.
config.hxx
log4cplus::spi
Definition layout.h:62
log4cplus
Definition appender.h:46
log4cplus::SharedAppenderPtr
helpers::SharedObjectPtr< Appender > SharedAppenderPtr
This is a pointer to an Appender.
Definition appender.h:336
log4cplus::tstring
std::basic_string< tchar > tstring
Definition tstring.h:39
log4cplus::SharedAppenderPtrList
std::vector< log4cplus::SharedAppenderPtr > SharedAppenderPtrList
Definition appenderattachable.h:40
pointer.h
tstring.h
LOG4CPLUS_EXPORT
#define LOG4CPLUS_EXPORT
Definition win32.h:141