Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bloomtom/HttpProgress
A set of extension methods for HttpClient which adds progress reporting.
https://github.com/bloomtom/HttpProgress
httpclient progress stream
Last synced: 3 months ago
JSON representation
A set of extension methods for HttpClient which adds progress reporting.
- Host: GitHub
- URL: https://github.com/bloomtom/HttpProgress
- Owner: bloomtom
- License: mit
- Created: 2018-11-25T00:57:42.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2020-01-29T03:10:32.000Z (almost 5 years ago)
- Last Synced: 2024-07-01T03:22:03.536Z (4 months ago)
- Topics: httpclient, progress, stream
- Language: C#
- Size: 37.1 KB
- Stars: 17
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# HttpProgress
>A set of extension methods for `HttpClient` which adds progress reporting.
HttpClient doesn't natively support progress reporting? Yes, it's true. You're expected to make your own `HttpContent` which overrides `SerializeToStreamAsync` for `PutAsync` and `PostAsync`, and you're expected to extend `GetAsync` with progress reporting in the stream copy logic. Well guess what? I've done that for you.
## Nuget Packages
Package Name | Target Framework | Version
---|---|---
[HttpProgress](https://www.nuget.org/packages/bloomtom.HttpProgress) | .NET Standard 2.0 | 
## Usage
Add HttpProgress to your usings.
```csharp
using HttpProgress;
```
Use the `HttpClient` extensions.
```csharp
// Make your progress event.
var progress = new Progress(x => // Please see "Notes on IProgress"
{
// This is your progress event!
// It will fire on every buffer fill so don't do anything expensive.
// Writing to the console IS expensive, so don't do the following in practice...
Console.WriteLine(x.PercentComplete.ToString("P"));
});
// Post
using (var fileStream = System.IO.File.OpenRead("MyFile.txt"))
{
var result = await client.PostAsync("https://mysite.com/something", fileStream, progress);
}
// Get
using (var downloadStream = new MemoryStream())
{
var response = await client.GetAsync("https://mysite.com/something", downloadStream, progress);
}
```
Woah, that was easy. But what if you want more than just percent complete? Well the progress event actually gives you all of the following in `ICopyProgress`:
```csharp
public interface ICopyProgress
{
///
/// The instantaneous data transfer rate.
///
int BytesPerSecond { get; }
///
/// The total number of bytes transferred so far.
///
long BytesTransferred { get; }
///
/// The total number of bytes expected to be copied.
///
long ExpectedBytes { get; }
///
/// The percentage complete as a value 0-1.
///
double PercentComplete { get; }
///
/// The total time elapsed so far.
///
TimeSpan TransferTime { get; }
}
```
## Notes on `IProgress`
#### Concrete Implementation
The type [`Progress`](https://docs.microsoft.com/en-us/dotnet/api/system.progress-1) is provided by the framework for use cases where the progress changed event should be processed through your application's synchronization context. This is useful for desktop UI applications where modifying controls from the progress event needs to be done on the event loop thread. For console applications, which have no intelligent synchronization context, the event will end up on the thread pool and _will likely be executed out of order_. If this is undesirable, consider using [`NaiveProgress`](https://github.com/bloomtom/NaiveProgress) instead.
#### Performance Considerations
The action you give for progress reporting will fire on every buffer cycle. This can happen _many_ times! With a 16kB buffer transfering a 10MB file will cause 640 events to be fired.
If you need to do time consuming operations, consider rate limiting them. A simple way to do this is to only fire your expensive operation when `TransferTime` or `PercentComplete` crosses specific thresholds. A more complex but "prettier" solution is to buffer `ICopyProgress` and have a threaded reader to refresh your UI on a timer.