Skip to content

Latest commit

 

History

History
138 lines (99 loc) · 5.79 KB

README.md

File metadata and controls

138 lines (99 loc) · 5.79 KB
Raw

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.

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 Unity 2018.1+.

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

Install the NATS.Net package from NuGet:

dotnet add package NATS.Net

Basic messaging:

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

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

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

Persistence with JetStream:

// NATS JetStream basic publish-consume example
await using var nc = new NatsClient();
var js = nc.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 .NET LTS releases (currently .NET 6.0 & .NET 8.0)

Packages

  • NATS.Net: Meta package that includes all other packages except extensions
  • 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.Client.Simplified: simplify common use cases especially for beginners
  • NATS.Client.Serializers.Json: JSON serializer for ad-hoc types
  • NATS.Extensions.Microsoft.DependencyInjection: extension to configure DI container

Contributing

You are welcome to contribute to this project. Here are some steps to get you started:

Reporting Bugs and Feature Requests

You can report bugs and request features by opening an issue on GitHub.

Join the Community

You can join the community asking questions, sharing ideas, and helping others:

Contributing Code

  • Read the Contributor Guide
  • Fork the repository and create a branch
  • Open NATS.Net.sln solution in Visual Studio, Rider or VS Code (or any other editor of your choice)
  • Make changes and write tests
  • Run tests against a locally installed NATS server in your PATH
  • Note that some tests are still not reliable locally, so CI will run all tests
  • For a quick check, run NATS.Client.Platform.Windows.Tests which is a subset of tests that should pass on Windows
  • You can also locally run NATS.Client.CoreUnit.Tests and NATS.Client.Core2.Tests which are more stable
  • Run dotnet format at root directory of project to clear warnings that can be auto-formatted
  • Run dotnet build at root directory and make sure there are no errors or warnings
  • Submit a pull request

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

Attribution

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