NATS.Client.Core 2.0.0-alpha.0

Prefix Reserved
This is a prerelease version of NATS.Client.Core.
There is a newer version of this package available.
See the version list below for details.
dotnet add package NATS.Client.Core --version 2.0.0-alpha.0                
NuGet\Install-Package NATS.Client.Core -Version 2.0.0-alpha.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="NATS.Client.Core" Version="2.0.0-alpha.0" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add NATS.Client.Core --version 2.0.0-alpha.0                
#r "nuget: NATS.Client.Core, 2.0.0-alpha.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.
// Install NATS.Client.Core as a Cake Addin
#addin nuget:?package=NATS.Client.Core&version=2.0.0-alpha.0&prerelease

// Install NATS.Client.Core as a Cake Tool
#tool nuget:?package=NATS.Client.Core&version=2.0.0-alpha.0&prerelease                

NATS.NET V2

Preview

The NATS.NET V2 client is in preview and not recommended for production use. Codebase is still under heavy development and currently we only have implementations for core NATS features.

Please test and provide feedback by visiting our Slack channel.

NATS.NET V2 Goals

  • Only support Async I/O
  • Target latest .NET LTS Release (currently net6.0)

Packages

  • NATS.Client.Core: core NATS
  • NATS.Client.Hosting: extension to configure DI container
  • NATS.Client.JetStream: JetStream not yet implemented

Basic Usage

Download the latest nats-server for your platform and run it without any arguments. nats-server will listen on its default TCP port 4222.

Given that we have a plain class Bar, we can publish and subscribe to our nats-server sending and receiving Bar objects:

public record Bar
{
    public int Id { get; set; }
    public string Name { get; set; }
}

Subscribe to all bar related subjects:

await using var nats = new NatsConnection(options);

await using sub = await nats.SubscribeAsync<Bar>("bar.>");
await foreach (var msg in sub.Msgs.ReadAllAsync())
{
    Console.WriteLine($"Received {msg.Subject}: {msg.Data}\n");
}

Publish Bar objects to related bar subjects:

await using var nats = new NatsConnection();

for (int i = 0; i < 10; i++)
{
    Console.WriteLine($" Publishing {i}...");
    await nats.PublishAsync<Bar>($"bar.baz.{i}", new Bar { Id = i, Name = "Baz" });
}

You should also hook your logger to NatsConnection to make sure all is working as expected or to get help diagnosing any issues you might have:

var options = NatsOptions.Default with { LoggerFactory = new MinimumConsoleLoggerFactory(LogLevel.Error) };
await using var nats = new NatsConnection(options);

Contributing

  • Run dotnet format at root directory of project in order to clear warnings that can be auto-formatted

Attribution

This library is based on the excellent work in Cysharp/AlterNats

Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  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 was computed.  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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (7)

Showing the top 5 NuGet packages that depend on NATS.Client.Core:

Package Downloads
NATS.Client.JetStream

JetStream support for NATS.Client.

NATS.Client.Services

Service API support for NATS.Client.

NATS.Client.Hosting

ASP.NET Core and Generic Host support for NATS.Client.

NATS.Net

NATS client for modern .NET

NATS.Client.Serializers.Json

NATS client generic JSON serializer. Not suitable for native AOT deployments.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2.4.0 1,721 9/17/2024
2.4.0-preview.3 59 9/11/2024
2.4.0-preview.2 104 8/23/2024
2.4.0-preview.1 594 8/5/2024
2.3.3 35,607 8/2/2024
2.3.3-preview.4 171 7/26/2024
2.3.3-preview.3 97 7/25/2024
2.3.3-preview.2 47 7/24/2024
2.3.3-preview.1 148 7/18/2024
2.3.2 25,537 7/10/2024
2.3.1 5,166 7/9/2024
2.3.1-preview.2 58 7/8/2024
2.3.1-preview.1 55 7/6/2024
2.3.0 14,243 7/3/2024
2.3.0-preview.1 495 6/24/2024
2.2.3 33,297 6/11/2024
2.2.2 15,843 5/23/2024
2.2.1 81,011 4/17/2024
2.2.0 16,865 4/4/2024
2.1.4 20,921 3/19/2024
2.1.3 5,593 3/12/2024
2.1.2 26,270 2/27/2024
2.1.1 6,394 2/20/2024
2.1.0 14,160 2/10/2024
2.1.0-preview.7 67 2/8/2024
2.1.0-preview.6 89 2/2/2024
2.1.0-preview.5 1,329 1/25/2024
2.1.0-preview.4 60 1/23/2024
2.1.0-preview.3 13,534 1/18/2024
2.1.0-preview.2 1,333 1/12/2024
2.1.0-preview.1 73 1/11/2024
2.0.3 71,318 1/5/2024
2.0.3-preview.1 405 12/22/2023
2.0.2 22,136 12/15/2023
2.0.2-preview.2 88 12/12/2023
2.0.2-preview.1 1,179 12/6/2023
2.0.1 17,145 11/29/2023
2.0.0 1,438 11/23/2023
2.0.0-rc.2 971 11/21/2023
2.0.0-rc.1 346 11/17/2023
2.0.0-beta.3 77 11/16/2023
2.0.0-beta.2 5,595 11/13/2023
2.0.0-beta.1 660 11/7/2023
2.0.0-beta.0 399 11/7/2023
2.0.0-alpha.7 587 10/27/2023
2.0.0-alpha.6 141 10/25/2023
2.0.0-alpha.5 228 10/20/2023
2.0.0-alpha.4 8,029 10/12/2023
2.0.0-alpha.3 322 9/13/2023
2.0.0-alpha.2 104 9/7/2023
2.0.0-alpha.1 102 8/31/2023
2.0.0-alpha.0 867 7/10/2023