Skip to content
This repository has been archived by the owner on Nov 20, 2023. It is now read-only.

Commit

Permalink
Forgot mention of PeriodicTimer.
Browse files Browse the repository at this point in the history
  • Loading branch information
RobThree committed Jun 22, 2022
1 parent 6ab8734 commit fc5f4cc
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion ITimer.Documentation/Content/Welcome.aml
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ public void ConfigureServices(IServiceCollection services)
</section>

<section>
<title>ThreadingTimer and SystemTimer</title>
<title>ThreadingTimer, SystemTimer and PeriodicTimer</title>
<content>
<para>
As mentioned before, these timers encapsulate (or "wrap") the <codeEntityReference linkText="System.Threading.Timer">T:System.Threading.Timer</codeEntityReference> and <codeEntityReference linkText="System.Timers.Timer">T:System.Timers.Timer</codeEntityReference> timers and provide a unified interface because they both implement the <codeEntityReference>T:ITimer.ISignaler</codeEntityReference> interface. The difference between the first two is perhaps best explained by <externalLink>
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ For usage in unittests, see the [`TestTimer`](#testtimer) below.

The [`ISignaler`](ITimer/ISignaler.cs) interface defines the `Start()` and `Stop()` methods to start and stop the timer raise the `Elapsed` event. The `Interval` property gets the timer's interval and the `AutoReset` property returns whether or not the timer should fire the event once and then stop, or keep going in a fire event / wait cycle.

## ThreadingTimer and SystemTimer
## ThreadingTimer, SystemTimer and PeriodicTimer

As mentioned before, these timers encapsulate (or "wrap") the [`System.Threading.Timer`](https://docs.microsoft.com/en-us/dotnet/api/system.threading.timer) and [`System.Timers.Timer`](https://docs.microsoft.com/en-us/dotnet/api/system.timers.timer) timers and provide a unified interface because they both implement the [`ISignaler`](ITimer/ISignaler.cs) interface. The difference between the first two is perhaps best explained by [Jon Skeet](https://jonskeet.uk/csharp/threads/timers.html) (archived version [here](https://archive.is/eXhQS) or [here](https://web.archive.org/web/20190303143427/http://jonskeet.uk/csharp/threads/timers.html)). The [`System.Windows.Forms.Timer`](https://docs.microsoft.com/en-us/dotnet/api/system.windows.forms.timer) is not provided by this library but should be simple to implement.

Expand Down

0 comments on commit fc5f4cc

Please sign in to comment.