T_NChronicle_File_Configuration_RetentionPolicyConfiguration

RetentionPolicyConfiguration Class

Container for RetentionPolicy configuration.

Inheritance Hierarchy

System.Object
  NChronicle.File.Configuration.RetentionPolicyConfiguration
Namespace: NChronicle.File.Configuration
Assembly: NChronicle.File (in NChronicle.File.dll) Version: 1.0.1.0 (1.0.1.0)

Syntax

C#

public class RetentionPolicyConfiguration

VB

Public Class RetentionPolicyConfiguration

F#

type RetentionPolicyConfiguration =  class end

The RetentionPolicyConfiguration type exposes the following members.

Constructors

 

	Name	Description
	RetentionPolicyConfiguration	Initializes a new instance of the RetentionPolicyConfiguration class

  Back to Top

Methods

 

	Name	Description
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetSchema	Required for XML serialization, this method offers no functionality.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ReadXml	Populate configuration from XML via the specified XmlReader.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	WithAgeLimit	Set the age limit for the output file before it will be archived. The default age limit is 1 day.
	WithFileSizeLimitInBytes	Set the file size limit for the output file before it will be archived. The file size limit must be above 50KB. The default file size limit is 100MB;.
	WithFileSizeLimitInKilobytes	Set the file size limit for the output file before it will be archived. The file size limit must be above 50KB. The default file size limit is 100MB;.
	WithFileSizeLimitInMegabytes	Set the file size limit for the output file before it will be archived. The file size limit must be above 50KB. The default file size limit is 100MB;.
	WithNoAgeLimit	Remove the age limit for the output file so as not to archive it - regardless of it's age - unless it extends over the set file size limit.
	WithNoFileSizeLimit	Remove the file size limit for the output file so as not to archive it - regardless of it's file size - unless it extends over the set age limit.
	WithNoRetentionLimit	Remove the retention limit so as not to delete any archived log regardless of the quantity.
	WithRetentionLimit	Set a retention limit, defining how many of the newest archived logs are kept, the elder archived logs are deleted. the default retention limit is 20.
	WriteXml	Write configuration to XML via the specified XmlWriter.

  Back to Top

See Also

Reference

NChronicle.File.Configuration Namespace