DotNetSseClient 1.2.0
dotnet add package DotNetSseClient --version 1.2.0
NuGet\Install-Package DotNetSseClient -Version 1.2.0
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="DotNetSseClient" Version="1.2.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="DotNetSseClient" Version="1.2.0" />
<PackageReference Include="DotNetSseClient" />
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add DotNetSseClient --version 1.2.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: DotNetSseClient, 1.2.0"
#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.
#:package DotNetSseClient@1.2.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=DotNetSseClient&version=1.2.0
#tool nuget:?package=DotNetSseClient&version=1.2.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
dotnet-sse-client
A lightweight Server-Sent Events (SSE) client built on HttpClient, with keyed DI registration for .NET applications.
Requirements
- .NET 10 (
net10.0)
Installation
dotnet add package DotNetSseClient
Quick start
using DotNetSseClient;
using Microsoft.Extensions.DependencyInjection;
var services = new ServiceCollection();
services.AddSseClient<MyEvent>(
key: "events",
baseAddress: "https://api.example.com/")
.WithBearerToken((serviceProvider, cancellationToken) =>
{
var tokenProvider = serviceProvider.GetRequiredService<[YourTokenProvider]>();
return ValueTask.FromResult(tokenProvider.GetToken(cancellationToken));
})
.OnUnauthorized((serviceProvider, _, cancellationToken) =>
{
var tokenProvider = serviceProvider.GetRequiredService<[YourTokenProvider]>();
tokenProvider.Refresh(cancellationToken);
return ValueTask.FromResult(true); // retry once with refreshed token
});
await using var provider = services.BuildServiceProvider();
var stream = provider.GetRequiredKeyedService<SseClient<MyEvent>>("events");
await stream.StartAsync(
"sse/updates",
onMessage: message => Console.WriteLine(message),
onError: ex => Console.Error.WriteLine(ex),
onDisconnected: () => Console.WriteLine("Disconnected."));
Why keyed DI Registration?
In case you need to consume two different SSE streams in the same application using the same type, you can register two SseClient<T> instances with different keys and configurations.
Behavior notes
- Endpoints passed to
StartAsynccan be relative or absolute. WithBearerTokenandWithApiKeyare applied on every connect/reconnect attempt.onUnauthorizedis invoked on HTTP 401 and can opt into one immediate retry.- The client validates
text/event-streamresponses. - Automatic reconnect is supported, including
Last-Event-IDcontinuation. - JSON parse errors are raised through the
Errorevent and stream processing continues.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net10.0
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Use SseParser instead of manually parsing