Files
wlan-cloud-lib-poco/Foundation/include/Poco/FormattingChannel.h
Aleksandar Fabijanic 4efaa99fff Add WeakRefPtr to Foundation #2246 (#2247)
* Logger & Channel classes now using AutoPtr<Channel> instead of Channel* (API improvement)

* fix CachingChannel

* more fixes

* Configuration: remove raw pointers from interfaces #2077

* Add WeakPtr to Foundation #2246

* Add WeakPtr to Foundation #2246 (buildsystems files)

* Add WeakPtr to Foundation #2246 (x64 VS project files)

* backtrace and Event fixes

* add ordered map

* add ordered set

* add sanitize makefiles

* update RefPtr doc

* fix AtomicCounter includes

* add ordered containers tests

* fix xml test compile error

* remove operator bool rom smart pointers

* Poco::strToInt<> fails for values right above the type's boundary / limit #2250

* add g++ -ftrapv config

* remove Version.h includes (now included from Config.h)

* comment out offending SQLite test (TODO)

* add AtomicFlag and SpinlockMutex

* remove RefCountedObject include from RefPtr and WeakRefPtr mutex template param

* add WeakRef SpinLockMutex threading test

* WeakRefPtr, backtrace, NDC, refcount DC fixes

* SQL fixes

* update RCO documentation

* XML/DOM: Remove raw pointers from public interfaces #2075

* few fixes

* PocoDoc - make logger non-static reference member

* remove path char array initialization

* Fix failing unit test, adding d in debug mode for TestApp and TestLibrary

* fix application config pointer

* fix some crypto warnings

* fix Process tests and consolidate TestApp name building

* define PathImpl::selfImpl for WinCE

* restore WinCE test app name extension

* attempt to passify 32 bit clang

* fix failing Active* tests

* Add POCO_OS_ANDROID support for Path::self()

* Add build dependencies between Foundation-testrunner and TestApp, TestLibrary in cmake build

* Remove to set LD_LIBRARY_PATH on foundation test

* revert to develop XML

* fix VS150 env not found (hardcode it)

* undef min/max
2018-05-02 16:04:39 -06:00

101 lines
2.5 KiB
C++

//
// FormattingChannel.h
//
// Library: Foundation
// Package: Logging
// Module: Formatter
//
// Definition of the FormattingChannel class.
//
// Copyright (c) 2004-2006, Applied Informatics Software Engineering GmbH.
// and Contributors.
//
// SPDX-License-Identifier: BSL-1.0
//
#ifndef Foundation_FormattingChannel_INCLUDED
#define Foundation_FormattingChannel_INCLUDED
#include "Poco/Foundation.h"
#include "Poco/Channel.h"
#include "Poco/Formatter.h"
#include "Poco/AutoPtr.h"
namespace Poco {
class Formatter;
class Foundation_API FormattingChannel: public Channel
/// The FormattingChannel is a filter channel that routes
/// a Message through a Formatter before passing it on
/// to the destination channel.
{
public:
typedef AutoPtr<FormattingChannel> Ptr;
FormattingChannel();
/// Creates a FormattingChannel.
FormattingChannel(Formatter::Ptr pFormatter);
/// Creates a FormattingChannel and attaches a Formatter.
FormattingChannel(Formatter::Ptr pFormatter, Channel::Ptr pChannel);
/// Creates a FormattingChannel and attaches a Formatter
/// and a Channel.
void setFormatter(Formatter::Ptr pFormatter);
/// Sets the Formatter used to format the messages
/// before they are passed on. If null, the message
/// is passed on unmodified.
Formatter::Ptr getFormatter() const;
/// Returns the Formatter used to format messages,
/// which may be null.
void setChannel(Channel::Ptr pChannel);
/// Sets the destination channel to which the formatted
/// messages are passed on.
Channel::Ptr getChannel() const;
/// Returns the channel to which the formatted
/// messages are passed on.
void log(const Message& msg);
/// Formats the given Message using the Formatter and
/// passes the formatted message on to the destination
/// Channel.
void setProperty(const std::string& name, const std::string& value);
/// Sets or changes a configuration property.
///
/// Only the "channel" and "formatter" properties are supported, which allow
/// setting the target channel and formatter, respectively, via the LoggingRegistry.
/// The "channel" and "formatter" properties are set-only.
///
/// Unsupported properties are passed to the attached Channel.
void open();
/// Opens the attached channel.
void close();
/// Closes the attached channel.
protected:
~FormattingChannel();
private:
Formatter::Ptr _pFormatter;
Channel::Ptr _pChannel;
};
} // namespace Poco
#endif // Foundation_FormattingChannel_INCLUDED