C# Class PowerArgs.ActionDebouncer

A class that can be used to ensure an action only fires after a burst of triggers ends.

Datei anzeigen Open project: adamabdelhamed/PowerArgs

Public Methods

Method	Description
ActionDebouncer ( System.TimeSpan burstTimeWindow, System.Action callback ) : System	Creates the debouncer given a bust time window and an action callback.
Trigger ( ) : void	Triggers a burst. If this is the first trigger in a burst of events then a countdown of duration BurstTimeWindow begins. If this trigger occurs while the countdown is in the process of counting to zero then the countdown is reset. If the countdown ever hits zero then the callback fires and the burst is complete.

Method Details

ActionDebouncer() public method

Creates the debouncer given a bust time window and an action callback.

public ActionDebouncer ( System.TimeSpan burstTimeWindow, System.Action callback ) : System
burstTimeWindow	System.TimeSpan	The time span that determines the time window. When a trigger fires, the debouncer will wait this amount of time before executing the callback. If a trigger fires before the time elapses, the timer is reset.
callback	System.Action	The action to execute when a trigger fires and the burst time window elapses.
return	System

Trigger() public method

Triggers a burst. If this is the first trigger in a burst of events then a countdown of duration BurstTimeWindow begins. If this trigger occurs while the countdown is in the process of counting to zero then the countdown is reset. If the countdown ever hits zero then the callback fires and the burst is complete.

public Trigger ( ) : void
return	void