class Poco::SimpleFileChannel

Overview

A Channel that writes to a file. More…

#include <SimpleFileChannel.h>

class SimpleFileChannel: public Poco::Channel
{
public:
    // fields

    static const std::string PROP_PATH;
    static const std::string PROP_SECONDARYPATH;
    static const std::string PROP_ROTATION;
    static const std::string PROP_FLUSH;

    // construction

    SimpleFileChannel();
    SimpleFileChannel(const std::string& path);

    // methods

    virtual
    void
    open();

    virtual
    void
    close();

    virtual
    void
    log(const Message& msg);

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

    virtual
    std::string
    getProperty(const std::string& name) const;

    Timestamp
    creationDate() const;

    UInt64
    size() const;

    const std::string&
    path() const;

    const std::string&
    secondaryPath() const;

protected:
    // methods

    void
    setRotation(const std::string& rotation);

    void
    setFlush(const std::string& flush);

    void
    rotate();
};

Inherited Members

public:
    // methods

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

    virtual
    std::string
    getProperty(const std::string& name) const = 0;

    void
    duplicate() const;

    void
    release() const;

    int
    referenceCount() const;

    virtual
    void
    open();

    virtual
    void
    close();

    virtual
    void
    log(const Message& msg) = 0;

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

    virtual
    std::string
    getProperty(const std::string& name) const;

Detailed Documentation

A Channel that writes to a file.

This class only supports simple log file rotation.

For more features, see the FileChannel class.

Only the message’s text is written, followed by a newline.

Chain this channel to a FormattingChannel with an appropriate Formatter to control what is in the text.

Log file rotation based on log file size is supported.

If rotation is enabled, the SimpleFileChannel will alternate between two log files. If the size of the primary log file exceeds a specified limit, the secondary log file will be used, and vice versa.

Log rotation is configured with the “rotation” property, which supports the following values:

* never:         no log rotation
* <n>:           the file is rotated when its size exceeds
                 <n> bytes.
* <n> K:         the file is rotated when its size exceeds
                 <n> Kilobytes.
* <n> M:         the file is rotated when its size exceeds
                 <n> Megabytes.

The path of the (primary) log file can be specified with the “path” property. Optionally, the path of the secondary log file can be specified with the “secondaryPath” property.

If no secondary path is specified, the secondary path will default to <primaryPath>.1.

The flush property specifies whether each log message is flushed immediately to the log file (which may hurt application performance, but ensures that everything is in the log in case of a system crash), Valid values are:

* true:   Every essages is immediately flushed to the log file (default).
* false:  Messages are not immediately flushed to the log file.

Construction

SimpleFileChannel()

Creates the FileChannel.

SimpleFileChannel(const std::string& path)

Creates the FileChannel for a file with the given path.

Methods

virtual
void
open()

Opens the FileChannel and creates the log file if necessary.

virtual
void
close()

Closes the FileChannel.

virtual
void
log(const Message& msg)

Logs the given message to the file.

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

Sets the property with the given name.

The following properties are supported:

* path:          The primary log file's path.
* secondaryPath: The secondary log file's path.
* rotation:      The log file's rotation mode. See the
                 SimpleFileChannel class for details.
* flush:         Specifies whether messages are immediately
                 flushed to the log file. See the SimpleFileChannel
                 class for details.

virtual
std::string
getProperty(const std::string& name) const

Returns the value of the property with the given name.

See setProperty() for a description of the supported properties.

Timestamp
creationDate() const

Returns the log file’s creation date.

UInt64
size() const

Returns the log file’s current size in bytes.

const std::string&
path() const

Returns the log file’s primary path.

const std::string&
secondaryPath() const

Returns the log file’s secondary path.