2021-01-30 07:51:39 +01:00
|
|
|
//
|
|
|
|
// LoggingRegistry.h
|
|
|
|
//
|
|
|
|
// Library: Foundation
|
|
|
|
// Package: Logging
|
|
|
|
// Module: LoggingRegistry
|
|
|
|
//
|
|
|
|
// Definition of the LoggingRegistry class.
|
|
|
|
//
|
|
|
|
// Copyright (c) 2004-2006, Applied Informatics Software Engineering GmbH.
|
|
|
|
// and Contributors.
|
|
|
|
//
|
|
|
|
// SPDX-License-Identifier: BSL-1.0
|
|
|
|
//
|
|
|
|
|
|
|
|
|
|
|
|
#ifndef Foundation_LoggingRegistry_INCLUDED
|
|
|
|
#define Foundation_LoggingRegistry_INCLUDED
|
|
|
|
|
|
|
|
|
|
|
|
#include "Poco/Foundation.h"
|
|
|
|
#include "Poco/AutoPtr.h"
|
|
|
|
#include "Poco/Channel.h"
|
|
|
|
#include "Poco/Formatter.h"
|
|
|
|
#include "Poco/Mutex.h"
|
|
|
|
#include <map>
|
|
|
|
|
|
|
|
|
|
|
|
namespace Poco {
|
|
|
|
|
|
|
|
|
|
|
|
class Foundation_API LoggingRegistry
|
|
|
|
/// A registry for channels and formatters.
|
|
|
|
///
|
|
|
|
/// The LoggingRegistry class is used for configuring
|
|
|
|
/// the logging framework.
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
LoggingRegistry();
|
|
|
|
/// Creates the LoggingRegistry.
|
|
|
|
|
|
|
|
~LoggingRegistry();
|
|
|
|
/// Destroys the LoggingRegistry.
|
|
|
|
|
|
|
|
Channel::Ptr channelForName(const std::string& name) const;
|
|
|
|
/// Returns the Channel object which has been registered
|
|
|
|
/// under the given name.
|
|
|
|
///
|
|
|
|
/// Throws a NotFoundException if the name is unknown.
|
|
|
|
|
|
|
|
Formatter::Ptr formatterForName(const std::string& name) const;
|
|
|
|
/// Returns the Formatter object which has been registered
|
|
|
|
/// under the given name.
|
|
|
|
///
|
|
|
|
/// Throws a NotFoundException if the name is unknown.
|
|
|
|
|
|
|
|
void registerChannel(const std::string& name, Channel::Ptr pChannel);
|
|
|
|
/// Registers a channel under a given name.
|
|
|
|
/// It is okay to re-register a different channel under an
|
|
|
|
/// already existing name.
|
2023-03-23 19:19:11 +01:00
|
|
|
|
2021-01-30 07:51:39 +01:00
|
|
|
void registerFormatter(const std::string& name, Formatter::Ptr pFormatter);
|
|
|
|
/// Registers a formatter under a given name.
|
|
|
|
/// It is okay to re-register a different formatter under an
|
|
|
|
/// already existing name.
|
|
|
|
|
|
|
|
void unregisterChannel(const std::string& name);
|
|
|
|
/// Unregisters the given channel.
|
|
|
|
///
|
|
|
|
/// Throws a NotFoundException if the name is unknown.
|
|
|
|
|
|
|
|
void unregisterFormatter(const std::string& name);
|
|
|
|
/// Unregisters the given formatter.
|
|
|
|
///
|
|
|
|
/// Throws a NotFoundException if the name is unknown.
|
|
|
|
|
|
|
|
void clear();
|
|
|
|
/// Unregisters all registered channels and formatters.
|
|
|
|
|
|
|
|
static LoggingRegistry& defaultRegistry();
|
|
|
|
/// Returns a reference to the default
|
|
|
|
/// LoggingRegistry.
|
|
|
|
|
|
|
|
private:
|
|
|
|
typedef Channel::Ptr ChannelPtr;
|
|
|
|
typedef AutoPtr<Formatter> FormatterPtr;
|
|
|
|
typedef std::map<std::string, ChannelPtr> ChannelMap;
|
|
|
|
typedef std::map<std::string, FormatterPtr> FormatterMap;
|
2023-03-23 19:19:11 +01:00
|
|
|
|
2021-01-30 07:51:39 +01:00
|
|
|
ChannelMap _channelMap;
|
|
|
|
FormatterMap _formatterMap;
|
|
|
|
mutable FastMutex _mutex;
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
} // namespace Poco
|
|
|
|
|
|
|
|
|
|
|
|
#endif // Foundation_LoggingRegistry_INCLUDED
|