C# Class GSF.Diagnostics.MessageRate

Defines a message rate for the message suppression algorithm
Datei anzeigen Open project: GridProtectionAlliance/gsf Class Usage Examples

Public Properties

Property Type Description
Default MessageRate

Public Methods

Method Description
EveryFewDays ( double seperation ) : MessageRate

As a minimum timespan between each message.

EveryFewHours ( double seperation ) : MessageRate

As a minimum timespan between each message.

EveryFewMinutes ( double seperation ) : MessageRate

As a minimum timespan between each message.

EveryFewSeconds ( double seperation ) : MessageRate

As a minimum timespan between each message.

PerDay ( double messagesPerDay ) : MessageRate

As messages per day.

PerHour ( double messagesPerHour ) : MessageRate

As messages per hour.

PerMinute ( double messagesPerMinute ) : MessageRate

As messages per minute.

PerSecond ( double messagesPerSecond ) : MessageRate

As messages per second.

Private Methods

Method Description
MessageRate ( double rate )

Method Details

EveryFewDays() public static method

As a minimum timespan between each message.
public static EveryFewDays ( double seperation ) : MessageRate
seperation double the number of Days between messages
return MessageRate

EveryFewHours() public static method

As a minimum timespan between each message.
public static EveryFewHours ( double seperation ) : MessageRate
seperation double the number of Hours between messages
return MessageRate

EveryFewMinutes() public static method

As a minimum timespan between each message.
public static EveryFewMinutes ( double seperation ) : MessageRate
seperation double the number of Minutes between messages
return MessageRate

EveryFewSeconds() public static method

As a minimum timespan between each message.
public static EveryFewSeconds ( double seperation ) : MessageRate
seperation double the number of seconds between messages
return MessageRate

PerDay() public static method

As messages per day.
public static PerDay ( double messagesPerDay ) : MessageRate
messagesPerDay double the number of messages to allow per day
return MessageRate

PerHour() public static method

As messages per hour.
public static PerHour ( double messagesPerHour ) : MessageRate
messagesPerHour double the number of messages to allow per hour
return MessageRate

PerMinute() public static method

As messages per minute.
public static PerMinute ( double messagesPerMinute ) : MessageRate
messagesPerMinute double the number of messages to allow per minute
return MessageRate

PerSecond() public static method

As messages per second.
public static PerSecond ( double messagesPerSecond ) : MessageRate
messagesPerSecond double the number of messages to allow per second
return MessageRate

Property Details

Default public_oe static_oe property

Gets the default message rate. Which is 1 message per second.
public static MessageRate,GSF.Diagnostics Default
return MessageRate