Yort.DeadManSwitch 1.0.3-beta

Prefix Reserved
.NET Standard 1.2 This package targets .NET Standard 1.2. The package is compatible with this framework or higher. .NET Framework 4.0 This package targets .NET Framework 4.0. The package is compatible with this framework or higher.
This is a prerelease version of Yort.DeadManSwitch.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package Yort.DeadManSwitch --version 1.0.3-beta                

                    
                

            
NuGet\Install-Package Yort.DeadManSwitch -Version 1.0.3-beta
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Yort.DeadManSwitch" Version="1.0.3-beta" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add Yort.DeadManSwitch --version 1.0.3-beta                

                    
                

            
#r "nuget: Yort.DeadManSwitch, 1.0.3-beta"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install Yort.DeadManSwitch as a Cake Addin
#addin nuget:?package=Yort.DeadManSwitch&version=1.0.3-beta&prerelease

// Install Yort.DeadManSwitch as a Cake Tool
#tool nuget:?package=Yort.DeadManSwitch&version=1.0.3-beta&prerelease

Yort.DeadManSwitch

What is it?

A reusable implementation of a dead man switch. A dead man switch 'activates' (causes something to happen) when some event hasn't occurred for a specified period of time. It is effectively a resetable timer.

When would I use it?

Any time you want to take some action because something else hasn't happened for a while, this includes but is not limited to;

  • Logging or sending an alert when you haven't received a (network or other) message for X minutes/hours.
  • Performing a search x millseconds after the last key pressed in an auto-search/complete text field.
  • Starting archive/optimisation processes when there's been no user activity for a while.

GitHub license

Build status

Supported Platforms

Currently;

  • .Net Standard 1.2
  • .Net Standard 2.0
  • .Net 4.0+

Available on Nuget

    PM> Install-Package Yort.DeadManSwitch

NuGet Badge

How do I use it?

Create a switch passing the action to call when the switch activates, the delay before activation, and other settings to the constructor. Call the Reset method of the switch each time a regular event occurs. When Reset hasn't been called within the delay period specified, the switch will activate.

See the demo console app in the repo for sample usage

    using Yort.DeadManSwitch;

    //This switch activates after 5 seconds on inactivity, and automatically
    //resets itself after activation.
    var dms = new DeadManSwitch(5000, () => Console.WriteLine("Switch activated!")), (reason) => Console.WriteLine("Reset because " + reason.ToString()), true);

    //Somewhere else in the code, in a code path that should execute regularly within 5 seconds
    dms.Reset();

    //To stop the switch, dispose it.
    dms.Dispose();
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp1.0 was computed.  netcoreapp1.1 was computed.  netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard1.2 is compatible.  netstandard1.3 was computed.  netstandard1.4 was computed.  netstandard1.5 was computed.  netstandard1.6 was computed.  netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net40 is compatible.  net403 was computed.  net45 was computed.  net451 was computed.  net452 was computed.  net46 was computed.  net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen30 was computed.  tizen40 was computed.  tizen60 was computed. 
Universal Windows Platform uap was computed.  uap10.0 was computed. 
Windows Phone wpa81 was computed. 
Windows Store netcore451 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.3 163 11/7/2024
1.0.3-beta 68 11/7/2024
1.0.2 1,636 2/12/2018
1.0.1 1,032 12/7/2017
1.0.0 850 9/1/2017

* Fixed a race condition on dispose which could cause an uncatchable ObjectDisposedException
* Added a Disarm method to disable/pause the trigger