generic-library/poco
1
0
Fork 0
mirror of https://github.com/pocoproject/poco.git synced 2025-10-27 02:53:10 +01:00
Code Issues Projects Releases Wiki Activity

- Poco::FileChannel now supports a new rotateOnOpen property (true/false) which can be used

Browse Source 
to force rotation of the log file when it's opened.
This commit is contained in:
Guenter Obiltschnig
2012-11-10 11:55:54 +01:00
parent 4f66c0e1d8
commit b402881343
2 changed files with 98 additions and 90 deletions
Download Patch File Download Diff File Expand all files Collapse all files

70
Foundation/include/Poco/FileChannel.h
View File

@@ -1,7 +1,7 @@
//
// FileChannel.h
//
// $Id: //poco/1.4/Foundation/include/Poco/FileChannel.h#2 $
// $Id: //poco/1.4/Foundation/include/Poco/FileChannel.h#5 $
//
// Library: Foundation
// Package: Logging
@@ -140,7 +140,7 @@ class Foundation_API FileChannel: public Channel
/// * local: Rotation strategy is based on local time.
///
/// Archived log files can be compressed using the gzip compression
/// method. Compressing can be controlled with the "compression"
/// method. Compressing can be controlled with the "compress"
/// property. The following values for the "compress" property
/// are supported:
///
@@ -154,7 +154,6 @@ class Foundation_API FileChannel: public Channel
///
/// The purgeAge property can have the following values:
///
/// * "none" or "" no purging
/// * <n> [seconds]: the maximum age is <n> seconds.
/// * <n> minutes: the maximum age is <n> minutes.
/// * <n> hours: the maximum age is <n> hours.
@@ -162,19 +161,27 @@ class Foundation_API FileChannel: public Channel
/// * <n> weeks: the maximum age is <n> weeks.
/// * <n> months: the maximum age is <n> months, where a month has 30 days.
///
/// The purgeCount property has an integer value that specifies the maximum number
/// of archived log files. If the number is exceeded, archived log files are
/// deleted, starting with the oldest. When "none" or empty string are
/// supplied, they reset purgeCount to none (no purging).
/// The purgeCount property has an integer value that
/// specifies the maximum number of archived log files.
/// If the number is exceeded, archived log files are
/// deleted, starting with the oldest.
///
/// 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),
// or whether it's allowed to stay in the system's file buffer for some time.
// or whether it's allowed to stay in the system's file buffer for some time.
/// Valid values are:
///
/// * true: Every essages is immediately flushed to the log file (default).
/// * false: Messages are not immediately flushed to the log file.
/// * true: Every essages is immediately flushed to the log file (default).
/// * false: Messages are not immediately flushed to the log file.
///
/// The rotateOnOpen property specifies whether an existing log file should be
/// rotated (and archived) when the channel is opened. Valid values are:
///
/// * true: The log file is rotated (and archived) when the channel is opened.
/// * false: Log messages will be appended to an existing log file,
/// if it exists (unless other conditions for a rotation are met).
/// This is the default.
///
/// For a more lightweight file channel class, see SimpleFileChannel.
{
@@ -198,25 +205,27 @@ public:
/// Sets the property with the given name.
///
/// The following properties are supported:
/// * path: The log file's path.
/// * rotation: The log file's rotation mode. See the
/// FileChannel class for details.
/// * archive: The log file's archive mode. See the
/// FileChannel class for details.
/// * times: The log file's time mode. See the
/// FileChannel class for details.
/// * compress: Enable or disable compression of
/// archived files. See the FileChannel class
/// for details.
/// * purgeAge: Maximum age of an archived log file before
/// it is purged. See the FileChannel class for
/// details.
/// * purgeCount: Maximum number of archived log files before
/// files are purged. See the FileChannel class
/// for details.
/// * flush: Specifies whether messages are immediately
/// flushed to the log file. See the FileChannel class
/// for details.
/// * path: The log file's path.
/// * rotation: The log file's rotation mode. See the
/// FileChannel class for details.
/// * archive: The log file's archive mode. See the
/// FileChannel class for details.
/// * times: The log file's time mode. See the
/// FileChannel class for details.
/// * compress: Enable or disable compression of
/// archived files. See the FileChannel class
/// for details.
/// * purgeAge: Maximum age of an archived log file before
/// it is purged. See the FileChannel class for
/// details.
/// * purgeCount: Maximum number of archived log files before
/// files are purged. See the FileChannel class
/// for details.
/// * flush: Specifies whether messages are immediately
/// flushed to the log file. See the FileChannel class
/// for details.
/// * rotateOnOpen: Specifies whether an existing log file should be
/// rotated and archived when the channel is opened.
std::string getProperty(const std::string& name) const;
/// Returns the value of the property with the given name.
@@ -240,6 +249,7 @@ public:
static const std::string PROP_PURGEAGE;
static const std::string PROP_PURGECOUNT;
static const std::string PROP_FLUSH;
static const std::string PROP_ROTATEONOPEN;
protected:
~FileChannel();
@@ -249,6 +259,7 @@ protected:
void setPurgeAge(const std::string& age);
void setPurgeCount(const std::string& count);
void setFlush(const std::string& flush);
void setRotateOnOpen(const std::string& rotateOnOpen);
void purge();
private:
@@ -260,6 +271,7 @@ private:
std::string _purgeAge;
std::string _purgeCount;
bool _flush;
bool _rotateOnOpen;
LogFile* _pFile;
RotateStrategy* _pRotateStrategy;
ArchiveStrategy* _pArchiveStrategy;