Class Poco::AsyncChannel

Library: Foundation
Package: Logging
Header: Poco/AsyncChannel.h

Description

A channel uses a separate thread for logging.

Using this channel can help to improve the performance of applications that produce huge amounts of log messages or that write log messages to multiple channels simultaneously.

All log messages are put into a queue and this queue is then processed by a separate thread.

Inheritance

Direct Base Classes: Channel, Runnable

All Base Classes: Channel, Configurable, RefCountedObject, Runnable

Member Summary

Member Functions: close, getChannel, log, open, run, setChannel, setPriority, setProperty

Inherited Functions: close, duplicate, getProperty, log, open, referenceCount, release, run, setProperty

Constructors

AsyncChannel

AsyncChannel(
Channel * pChannel = 0,
Thread::Priority prio = Thread::PRIO_NORMAL
);

Creates the AsyncChannel and connects it to the given channel.

Destructor

~AsyncChannel

~AsyncChannel();

Member Functions

close

void close();

Closes the channel and stops the background logging thread.

See also: Poco::Channel::close()

getChannel

Channel * getChannel() const;

Returns the target channel.

log

void log(
const Message & msg
);

Queues the message for processing by the background thread.

See also: Poco::Channel::log()

open

void open();

Opens the channel and creates the background logging thread.

See also: Poco::Channel::open()

setChannel

void setChannel(
Channel * pChannel
);

Connects the AsyncChannel to the given target channel. All messages will be forwarded to this channel.

setProperty

void setProperty(
const std::string & name,
const std::string & value
);

Sets or changes a configuration property.

The "channel" property allows setting the target channel via the LoggingRegistry. The "channel" property is set-only.

The "priority" property allows setting the thread priority. The following values are supported:

lowest
low
normal (default)
high
highest

The "priority" property is set-only.

See also: Poco::Channel::setProperty()

run

void run();

See also: Poco::Runnable::run()

setPriority