Class FloodFilter

Implements a destination group that stops message flood

Inheritance
System.Object
DisposableObject
ApplicationComponent
Destination
CompositeDestination
FloodFilter
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: NFX.Log.Destinations
Assembly: NFX.dll
Syntax
public class FloodFilter : CompositeDestination, IApplicationComponent, IDisposable, IConfigurable, IExternallyParameterized

Constructors

FloodFilter()

Creates a filter that prevents message flood

Declaration
public FloodFilter()

FloodFilter(Destination[])

Creates a filter that prevents message flood

Declaration
public FloodFilter(params Destination[] inner)
Parameters
Type Name Description
Destination[] inner

FloodFilter(String, Destination[])

Creates a filter that prevents message flood

Declaration
public FloodFilter(string name, params Destination[] inner)
Parameters
Type Name Description
System.String name
Destination[] inner

Fields

DEFAULT_INTERVAL_SEC

Declaration
public const int DEFAULT_INTERVAL_SEC = 10
Field Value
Type Description
System.Int32

DEFAULT_MAX_COUNT

Declaration
public const int DEFAULT_MAX_COUNT = 25
Field Value
Type Description
System.Int32

DEFAULT_MAX_TEXT_LENGTH

Declaration
public const int DEFAULT_MAX_TEXT_LENGTH = 0
Field Value
Type Description
System.Int32

MAX_MAX_COUNT

Declaration
public const int MAX_MAX_COUNT = 1000
Field Value
Type Description
System.Int32

Properties

IntervalSec

Declaration
[Config]
public int IntervalSec { get; set; }
Property Value
Type Description
System.Int32

MaxCount

Sets how many messages may be batched per interval. If more messages arrive then their data is not going to be logged

Declaration
[Config]
public int MaxCount { get; set; }
Property Value
Type Description
System.Int32

MaxTextLength

Imposes a limit in character length of combined message test

Declaration
[Config]
public int MaxTextLength { get; set; }
Property Value
Type Description
System.Int32

MessageFrom

Determines the message from for message emitted when flood is detected

Declaration
[Config]
public string MessageFrom { get; set; }
Property Value
Type Description
System.String

MessageSource

Determines the message topic for message emitted when flood is detected

Declaration
[Config]
public int MessageSource { get; set; }
Property Value
Type Description
System.Int32

MessageTopic

Determines the message topic for message emitted when flood is detected

Declaration
[Config]
public string MessageTopic { get; set; }
Property Value
Type Description
System.String

MessageType

Determines the message type for message emitted when flood is detected

Declaration
[Config]
public MessageType MessageType { get; set; }
Property Value
Type Description
MessageType

Methods

Close()

Declaration
public override void Close()
Overrides

Destructor()

Declaration
protected override void Destructor()
Overrides

DoPulse()

Declaration
protected override void DoPulse()
Overrides

DoSend(Message)

Declaration
protected override void DoSend(Message entry)
Parameters
Type Name Description
Message entry
Overrides

Open()

Declaration
public override void Open()
Overrides

Implements

System.IDisposable

Extension Methods