Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/reactiveui/punchclock
Make sure your asynchronous operations show up to work on time
https://github.com/reactiveui/punchclock
async cross-platform dotnet dotnet-core http-client xamarin
Last synced: about 1 month ago
JSON representation
Make sure your asynchronous operations show up to work on time
- Host: GitHub
- URL: https://github.com/reactiveui/punchclock
- Owner: reactiveui
- License: mit
- Created: 2013-10-08T06:29:40.000Z (about 11 years ago)
- Default Branch: main
- Last Pushed: 2024-04-14T06:37:00.000Z (7 months ago)
- Last Synced: 2024-04-14T13:08:30.771Z (7 months ago)
- Topics: async, cross-platform, dotnet, dotnet-core, http-client, xamarin
- Language: C#
- Homepage:
- Size: 4.49 MB
- Stars: 260
- Watchers: 18
- Forks: 21
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://www.nuget.org/packages/punchclock) 
[](https://codecov.io/gh/reactiveui/punchclock) [](https://reactiveui.net/contribute)
## Punchclock: A library for managing concurrent operations
Punchclock is the low-level scheduling and prioritization library used by
[Fusillade](https://github.com/reactiveui/Fusillade) to orchestrate pending
concurrent operations.
### What even does that mean?
Ok, so you've got a shiny mobile phone app and you've got async/await.
Awesome! It's so easy to issue network requests, why not do it all the time?
After your users one-:star2: you for your app being slow, you discover that
you're issuing *way* too many requests at the same time.
Then, you try to manage issuing less requests by hand, and it becomes a
spaghetti mess as different parts of your app reach into each other to try to
figure out who's doing what. Let's figure out a better way.
### So many words, gimme the examples
```cs
var wc = new WebClient();
var opQueue = new OperationQueue(2 /*at a time*/);
// Download a bunch of images
var foo = opQueue.Enqueue(1,
() => wc.DownloadFile("https://example.com/foo.jpg", "foo.jpg"));
var bar = opQueue.Enqueue(1,
() => wc.DownloadFile("https://example.com/bar.jpg", "bar.jpg"));
var baz = opQueue.Enqueue(1,
() => wc.DownloadFile("https://example.com/baz.jpg", "baz.jpg"));
var bamf = opQueue.Enqueue(1,
() => wc.DownloadFile("https://example.com/bamf.jpg", "bamf.jpg"));
// We'll be downloading the images two at a time, even though we started
// them all at once
await Task.WaitAll(foo, bar, baz, bamf);
```
Now, in a completely different part of your app, if you need something right
away, you can specify it via the priority:
```cs
// This file is super important, we don't care if it cuts in line in front
// of some images or other stuff
var wc = new WebClient();
await opQueue.Enqueue(10 /* It's Important */,
() => wc.DownloadFileTaskAsync("http://example.com/cool.txt", "./cool.txt"));
```
## What else can this library do
* Cancellation via CancellationTokens or via Observables
* Ensure certain operations don't run concurrently via a key
* Queue pause / resume
## Contribute
Punchclock is developed under an OSI-approved open source license, making it freely usable and distributable, even for commercial use. Because of our Open Collective model for funding and transparency, we are able to funnel support and funds through to our contributors and community. We ❤ the people who are involved in this project, and we’d love to have you on board, especially if you are just getting started or have never contributed to open-source before.
So here's to you, lovely person who wants to join us — this is how you can support us:
* [Responding to questions on StackOverflow](https://stackoverflow.com/questions/tagged/punchclock)
* [Passing on knowledge and teaching the next generation of developers](https://ericsink.com/entries/dont_use_rxui.html)
* Submitting documentation updates where you see fit or lacking.
* Making contributions to the code base.