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.
[!NOTE]
Don't confuse NuGet packages!
NATS .NET package on NuGet is called NATS.Net.
There is another package called NATS.Client which is the older version of the client library
and will be deprecated eventually.
[!TIP]
NATS .NET now supports .NET Standard 2.0 and 2.1 along with .NET 6.0 and 8.0,
which means you can also use it with .NET Framework 4.6.2+ and 2018.1+.
Unity
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.
Run a local nats-server to use or connect to the demo server if you're not behind a firewall:
await using var client = new NatsClient("demo.nats.io");
Basic messaging:
// NATS core M:N messaging example
await using var client = new NatsClient();
// Subscribe on one terminal
await foreach (var msg in client.SubscribeAsync<string>(subject: "foo"))
{
Console.WriteLine($"Received: {msg.Data}");
}
// Start publishing to the same subject on a second terminal
await client.PublishAsync(subject: "foo", data: "Hello, World!");
// NATS JetStream basic publish-consume example
await using var client = new NatsClient();
var js = client.CreateJetStreamContext();
// 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 the two most recent .NET LTS releases (currently .NET 6.0 & .NET 8.0)
Packages
NATS.Net: Meta package that includes all other packages except extensions
