WebMediator.Client
1.0.6
dotnet add package WebMediator.Client --version 1.0.6
NuGet\Install-Package WebMediator.Client -Version 1.0.6
<PackageReference Include="WebMediator.Client" Version="1.0.6" />
<PackageVersion Include="WebMediator.Client" Version="1.0.6" />
<PackageReference Include="WebMediator.Client" />
paket add WebMediator.Client --version 1.0.6
#r "nuget: WebMediator.Client, 1.0.6"
#:package WebMediator.Client@1.0.6
#addin nuget:?package=WebMediator.Client&version=1.0.6
#tool nuget:?package=WebMediator.Client&version=1.0.6
WebMediator.Client
A .NET client for sending requests to a WebMediator endpoint. It supports typed request/response calls, void requests, file and stream transfers, and server-sent event streams.
Send a request
Use WebMediatorClient with the URL of your mapped mediator endpoint. Request and response types are your application’s shared contracts; this example uses Ping and Pong from the sample project.
using WebMediator.Client;
using var client = new WebMediatorClient("https://localhost:7263/mediator");
var response = await client.Send(new Ping { Message = "TEST" });
Console.WriteLine(response?.Message);
// Build a GET URL for a request without stream data.
var requestUrl = client.GetUrl(new Ping { Message = "TEST" });
Example output:
TEST PONG
The client implements IDisposable; dispose it when it is no longer needed. Pass a cancellation token to Send to cancel a request:
using var cancellation = new CancellationTokenSource(TimeSpan.FromSeconds(10));
var response = await client.Send(new Ping { Message = "TEST" }, cancellation.Token);
Void requests
For a request that does not return a response body, call Send and await the operation:
await client.Send(new VoidRequest { Message = "Process this request" });
File and stream transfers
Requests and responses can carry streams. Dispose returned streams after use so the underlying HTTP response can be released:
using var stream = await client.Send<Stream>(new FileDownload { Name = "example.txt" });
using var reader = new StreamReader(stream!);
Console.WriteLine(await reader.ReadToEndAsync());
For upload requests, put the file stream in a request property of type Stream and dispose the stream you opened. See the complete client example for upload, download, and response metadata examples.
Server-sent events
Use EventStream to consume typed SSE items. The request contract below is from the sample project:
using Example;
using var cancellation = new CancellationTokenSource();
await foreach (var item in client.EventStream<string>(
new ExampleAsyncEvents { Type = "updates" },
cancellation.Token))
{
Console.WriteLine($"{item.EventType}: {item.Data}");
}
Configure the client
Pass WebMediatorClientSettings to customize JSON serialization, add default HTTP headers, provide an HTTP handler, or configure event-stream reconnection:
var settings = new WebMediatorClientSettings
{
HttpHeaders = new Dictionary<string, IEnumerable<string>>
{
["X-Client-Name"] = ["sample-app"]
}
};
using var client = new WebMediatorClient(
"https://localhost:7263/mediator",
settings);
More examples
See the Example.Client project for working examples of request/response calls, uploads, downloads, and streams. For JavaScript and Python clients, see their guides in the repository.
| Product | Versions 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 is compatible. 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. net9.0 is compatible. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. 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. net11.0 is compatible. |
| .NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
| .NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
| .NET Framework | 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 | tizen40 was computed. tizen60 was computed. |
| Xamarin.iOS | xamarinios was computed. |
| Xamarin.Mac | xamarinmac was computed. |
| Xamarin.TVOS | xamarintvos was computed. |
| Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.0
- Mediator.Abstractions (>= 3.0.2)
- MediatR.Contracts (>= 2.0.1)
- System.Net.ServerSentEvents (>= 10.0.5)
- System.Text.Json (>= 10.0.0)
- TypeSerialization (>= 1.3.1)
-
net10.0
- Mediator.Abstractions (>= 3.0.2)
- MediatR.Contracts (>= 2.0.1)
- TypeSerialization (>= 1.3.1)
-
net11.0
- Mediator.Abstractions (>= 3.0.2)
- MediatR.Contracts (>= 2.0.1)
- TypeSerialization (>= 1.3.1)
-
net8.0
- Mediator.Abstractions (>= 3.0.2)
- MediatR.Contracts (>= 2.0.1)
- System.Net.ServerSentEvents (>= 10.0.5)
- TypeSerialization (>= 1.3.1)
-
net9.0
- Mediator.Abstractions (>= 3.0.2)
- MediatR.Contracts (>= 2.0.1)
- System.Net.ServerSentEvents (>= 10.0.5)
- TypeSerialization (>= 1.3.1)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.