FileChannel: added "none" to the PURGE_AGE and PURGE_COUNT

This commit is contained in:
Marian Krivos
2012-04-29 10:58:27 +00:00
parent 53fe184bfa
commit c816693153
3 changed files with 409 additions and 372 deletions

View File

@@ -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 "compress"
/// method. Compressing can be controlled with the "compression"
/// property. The following values for the "compress" property
/// are supported:
///
@@ -154,6 +154,7 @@ 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.
@@ -161,10 +162,10 @@ 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.
/// 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).
///
/// For a more lightweight file channel class, see SimpleFileChannel.
{