RollingFileLogAppender Class

Log appender that writes log messages to a rolling file.

Syntax

public class RollingFileLogAppender : LogAppender

Remarks

This class represents a log file this is rolled based on size. It is configured with the number of rolling files to use and the maximum size they can reach before the files are rolled.

The rolling files that are not being written to will be numbered from one to the value of FileCount minus one where the file with the lowest number contains the more recent log messages.

FileName	FileCount	Rolling files
`"C:/temp/logs/mylog.txt"`	1	`"C:/temp/logs/mylog.txt"`
`"C:/temp/logs/mylog.txt"`	2	`"C:/temp/logs/mylog.txt"` `"C:/temp/logs/mylog.1.txt"`
`"C:/temp/logs/mylog.txt"`	4	`"C:/temp/logs/mylog.txt"` `"C:/temp/logs/mylog.1.txt"` `"C:/temp/logs/mylog.2.txt"` `"C:/temp/logs/mylog.3.txt"`

Example

// Create a RollingFileLogAppender that alternates between two log files
public static LogAppender CreateRollingFileLogAppender(string fileName)
{
    // The following appender alternates between two 1MB files
    return new RollingFileLogAppender(fileName, 2, 1024 * 1024);
}

Inheritance Hierarchy

System.Object (not available in C#)
  EngineObject
    LogAppender
      RollingFileLogAppender

Platforms

Windows, Linux, Android

RollingFileLogAppender Members

The RollingFileLogAppender type has the following members.

Constructors

Name	Description
RollingFileLogAppender	Initializes a new instance of the RollingFileLogAppender class.

Properties

Name	Description
FileCount	Gets the number of rolling log files.
FileName	Gets the full path of the file that is used as the base path and name for the rolling log files.
IsDisposed	Gets a value that tells whether the current RollingFileLogAppender has been disposed. Inherited from EngineObject
MaximumFileSize	Gets maximum size of the log files in bytes.
NativeHandle	Gets the native Carmenta Engine kernel object the current RollingFileLogAppender represents. Inherited from EngineObject

Methods

Name	Description
Clone	Creates a copy of an object. Inherited from EngineObject
Dispose	Releases the reference to the native Carmenta Engine kernel instance the EngineObject represents. Inherited from EngineObject
Equals	Determines whether this instance is equal to another. Inherited from EngineObject

RollingFileLogAppender Class

Log appender that writes log messages to a rolling file.

Syntax

C++

class RollingFileLogAppender : public LogAppender

C++ Smart Pointer Declaration

typedef Ptr<RollingFileLogAppender> RollingFileLogAppenderPtr;

Remarks

This class represents a log file this is rolled based on size. It is configured with the number of rolling files to use and the maximum size they can reach before the files are rolled.

The rolling files that are not being written to will be numbered from one to the value of fileCount minus one where the file with the lowest number contains the more recent log messages.

fileName	fileCount	Rolling files
`"C:/temp/logs/mylog.txt"`	1	`"C:/temp/logs/mylog.txt"`
`"C:/temp/logs/mylog.txt"`	2	`"C:/temp/logs/mylog.txt"` `"C:/temp/logs/mylog.1.txt"`
`"C:/temp/logs/mylog.txt"`	4	`"C:/temp/logs/mylog.txt"` `"C:/temp/logs/mylog.1.txt"` `"C:/temp/logs/mylog.2.txt"` `"C:/temp/logs/mylog.3.txt"`

Example

C++

// Create a RollingFileLogAppender that alternates between two log files
static LogAppenderPtr createRollingFileLogAppender(const char* fileName)
{
    // The following appender alternates between two 1MB files
    return new RollingFileLogAppender(fileName, 2, 1024 * 1024);
}

Inheritance Hierarchy

EngineObject
LogAppender
RollingFileLogAppender

Platforms

Windows, Linux, Android

RollingFileLogAppender Members

The RollingFileLogAppender type has the following members.

Constructors

Name	Description
RollingFileLogAppender	Initializes a new instance of the RollingFileLogAppender class.

Properties

Name	Description
fileCount	Gets the number of rolling log files.
fileName	Gets the full path of the file that is used as the base path and name for the rolling log files.
maximumFileSize	Gets maximum size of the log files in bytes.

Methods

Name	Description
clone	Creates a copy of an object. Inherited from EngineObject
equals	Determines whether this instance is equal to another. Inherited from EngineObject

RollingFileLogAppender Class

Log appender that writes log messages to a rolling file.

Syntax

Java

public class RollingFileLogAppender extends LogAppender

Remarks

This class represents a log file this is rolled based on size. It is configured with the number of rolling files to use and the maximum size they can reach before the files are rolled.

The rolling files that are not being written to will be numbered from one to the value of fileCount minus one where the file with the lowest number contains the more recent log messages.

fileName	fileCount	Rolling files
`"C:/temp/logs/mylog.txt"`	1	`"C:/temp/logs/mylog.txt"`
`"C:/temp/logs/mylog.txt"`	2	`"C:/temp/logs/mylog.txt"` `"C:/temp/logs/mylog.1.txt"`
`"C:/temp/logs/mylog.txt"`	4	`"C:/temp/logs/mylog.txt"` `"C:/temp/logs/mylog.1.txt"` `"C:/temp/logs/mylog.2.txt"` `"C:/temp/logs/mylog.3.txt"`

Example

Java

// Create a RollingFileLogAppender that alternates between two log files
public static LogAppender createRollingFileLogAppender(String fileName)
{
    // The following appender alternates between two 1MB files
    return new RollingFileLogAppender(fileName, 2, 1024 * 1024);
}

Inheritance Hierarchy

System::Object (not available in Java)
  EngineObject
    LogAppender
      RollingFileLogAppender

Platforms

Windows, Linux, Android

RollingFileLogAppender Members

The RollingFileLogAppender type has the following members.

Constructors

Name	Description
RollingFileLogAppender	Initializes a new instance of the RollingFileLogAppender class.

Properties

Name	Description
fileCount	Gets the number of rolling log files.
fileName	Gets the full path of the file that is used as the base path and name for the rolling log files.
isDisposed	Gets a value that tells whether the current RollingFileLogAppender has been disposed. Inherited from EngineObject
maximumFileSize	Gets maximum size of the log files in bytes.

Methods

Name	Description
clone	Creates a copy of an object. Inherited from EngineObject
dispose	Releases the reference to the native Carmenta Engine kernel instance the EngineObject represents. Inherited from EngineObject
equals	Determines whether this instance is equal to another. Inherited from EngineObject

RollingFileLogAppender Class

Log appender that writes log messages to a rolling file.

Syntax

Python

class RollingFileLogAppender ( LogAppender )

Remarks

This class represents a log file this is rolled based on size. It is configured with the number of rolling files to use and the maximum size they can reach before the files are rolled.

The rolling files that are not being written to will be numbered from one to the value of fileCount minus one where the file with the lowest number contains the more recent log messages.

fileName	fileCount	Rolling files
`"C:/temp/logs/mylog.txt"`	1	`"C:/temp/logs/mylog.txt"`
`"C:/temp/logs/mylog.txt"`	2	`"C:/temp/logs/mylog.txt"` `"C:/temp/logs/mylog.1.txt"`
`"C:/temp/logs/mylog.txt"`	4	`"C:/temp/logs/mylog.txt"` `"C:/temp/logs/mylog.1.txt"` `"C:/temp/logs/mylog.2.txt"` `"C:/temp/logs/mylog.3.txt"`

Example

Python

# Create a rolling file log appender that writes to two rolling
# files with a 1MB maximum file size
logFile = RollingFileLogAppender(
		"C:\temp\logs\mylog.txt",
		2,
		1024 * 1024)

Inheritance Hierarchy

EngineObject
LogAppender
RollingFileLogAppender

Platforms

Windows, Linux, Android

RollingFileLogAppender Members

The RollingFileLogAppender type has the following members.

Constructors

Name	Description
RollingFileLogAppender	Initializes a new instance of the RollingFileLogAppender class.

Properties

Name	Description
fileCount	Gets the number of rolling log files.
fileName	Gets the full path of the file that is used as the base path and name for the rolling log files.
maximumFileSize	Gets maximum size of the log files in bytes.

Methods

Name	Description
clone	Creates a copy of an object. Inherited from EngineObject
equals	Determines whether this instance is equal to another. Inherited from EngineObject

RollingFileLogAppender Class

In this article

Syntax

Remarks

Example

Inheritance Hierarchy

Platforms

See Also

Reference

RollingFileLogAppender Members

RollingFileLogAppender Class

In this article

Syntax

Remarks

Example

Inheritance Hierarchy

Platforms

See Also

Reference

RollingFileLogAppender Members

RollingFileLogAppender Class

In this article

Syntax

Remarks

Example

Inheritance Hierarchy

Platforms

See Also

Reference

RollingFileLogAppender Members

RollingFileLogAppender Class

In this article

Syntax

Remarks

Example

Inheritance Hierarchy

Platforms

See Also

Reference

RollingFileLogAppender Members