NATS.Client.Core 2.3.0-preview.1

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.3.0-preview.1                
NuGet\Install-Package NATS.Client.Core -Version 2.3.0-preview.1                
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.3.0-preview.1" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add NATS.Client.Core --version 2.3.0-preview.1                
#r "nuget: NATS.Client.Core, 2.3.0-preview.1"                
#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.3.0-preview.1&prerelease

// Install NATS.Client.Core as a Cake Tool
#tool nuget:?package=NATS.Client.Core&version=2.3.0-preview.1&prerelease                

License Apache 2.0 NuGet

NATS .NET

NATS .NET is a client library designed to connect to the NATS messaging server, fully supporting all NATS features. It integrates seamlessly with modern .NET asynchronous interfaces such as async enumerables and channels, and leverages advanced .NET memory, buffer and IO features.

Check out NATS .NET client library documentation for guides and examples.

What is NATS?

NATS is a high-performance, secure, distributed messaging system. It's a connective technology tailored for modern distributed systems, facilitating efficient addressing, discovery, and message exchange. It supports dynamic service and stream processing across various locations and devices, enhancing mobility, security, and independence from traditional constraints such as DNS.

Head over to NATS documentation for more information.

Quick Start

Basic messaging:

// NATS core M:N messaging example
await using var nats = new NatsConnection();

// Subscribe on one terminal
await foreach (var msg in nats.SubscribeAsync<string>(subject: "foo"))
{
    Console.WriteLine($"Received: {msg.Data}");
}

// Start publishing to the same subject on a second terminal
await nats.PublishAsync(subject: "foo", data: "Hello, World!");

Persistance with JetStream:

await using var nats = new NatsConnection();
var js = new NatsJSContext(nats);

// Create a stream to store the messages
await js.CreateStreamAsync(new StreamConfig(name: "orders", subjects: new[] { "orders.*" }));

// Publish a message to the stream. The message will be stored in the stream
// because the published subject matches one of the the stream's subjects.
var ack = await js.PublishAsync(subject: "orders.new", data: "order 1");
ack.EnsureSuccess();

// Create a consumer on a stream to receive the messages
var consumer = await js.CreateOrUpdateConsumerAsync("orders", new ConsumerConfig("order_processor"));

await foreach (var jsMsg in consumer.ConsumeAsync<string>())
{
    Console.WriteLine($"Processed: {jsMsg.Data}");
    await jsMsg.AckAsync();
}

See more details, including how to download and start NATS server and JetStream in our documentation.

Additionally check out NATS by example - An evolving collection of runnable, cross-client reference examples for NATS.

NATS .NET Goals

  • Only support Async I/O (async/await)
  • Target current .NET LTS releases (currently .NET 6.0 & .NET 8.0)

Packages

  • NATS.Net: Meta package that includes all other packages (except serialization)
  • NATS.Client.Core: Core NATS
  • NATS.Client.JetStream: JetStream
  • NATS.Client.KeyValueStore: Key/Value Store
  • NATS.Client.ObjectStore: Object Store
  • NATS.Client.Services: Services
  • NATS.Extensions.Microsoft.DependencyInjection: extension to configure DI container
  • NATS.Client.Serializers.Json: JSON serializer for ad-hoc types

Contributing

  • Run dotnet format at root directory of project in order to clear warnings that can be auto-formatted
  • Run dotnet build at root directory and make sure there are no errors or warnings

Find us on slack.nats.io dotnet channel

Please also check out the Contributor Guide and Code of Conduct.

Attribution

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

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

NuGet packages (6)

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.3.3-preview.2 7 7/24/2024
2.3.3-preview.1 101 7/18/2024
2.3.2 5,205 7/10/2024
2.3.1 1,421 7/9/2024
2.3.1-preview.2 51 7/8/2024
2.3.1-preview.1 49 7/6/2024
2.3.0 5,556 7/3/2024
2.3.0-preview.1 254 6/24/2024
2.2.3 13,027 6/11/2024
2.2.2 9,012 5/23/2024
2.2.1 50,403 4/17/2024
2.2.0 11,267 4/4/2024
2.1.4 18,114 3/19/2024
2.1.3 5,121 3/12/2024
2.1.2 22,332 2/27/2024
2.1.1 5,868 2/20/2024
2.1.0 10,115 2/10/2024
2.1.0-preview.7 62 2/8/2024
2.1.0-preview.6 83 2/2/2024
2.1.0-preview.5 1,324 1/25/2024
2.1.0-preview.4 55 1/23/2024
2.1.0-preview.3 13,528 1/18/2024
2.1.0-preview.2 1,329 1/12/2024
2.1.0-preview.1 70 1/11/2024
2.0.3 57,966 1/5/2024
2.0.3-preview.1 341 12/22/2023
2.0.2 21,687 12/15/2023
2.0.2-preview.2 77 12/12/2023
2.0.2-preview.1 1,172 12/6/2023
2.0.1 16,955 11/29/2023
2.0.0 1,258 11/23/2023
2.0.0-rc.2 967 11/21/2023
2.0.0-rc.1 330 11/17/2023
2.0.0-beta.3 73 11/16/2023
2.0.0-beta.2 5,580 11/13/2023
2.0.0-beta.1 652 11/7/2023
2.0.0-beta.0 393 11/7/2023
2.0.0-alpha.7 576 10/27/2023
2.0.0-alpha.6 135 10/25/2023
2.0.0-alpha.5 221 10/20/2023
2.0.0-alpha.4 6,498 10/12/2023
2.0.0-alpha.3 311 9/13/2023
2.0.0-alpha.2 97 9/7/2023
2.0.0-alpha.1 96 8/31/2023
2.0.0-alpha.0 856 7/10/2023