NATS.Client.KeyValueStore 2.4.0-preview.3

Looking for NATS .NET v1? Click here

Please update your references to the new name. You can also read the announcement for more information.

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 .NET Standard 2.0, 2.1, and .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