The official .NET client library for Apache Pulsar

Clone this repo:
  1. 8555159 Updated NuGet packages by Daniel Blankensteiner · 7 days ago master
  2. dc1c25d Retain original stack trace when exception happens in Producer (#108) by jvmdc · 7 days ago
  3. 1620196 Updated NuGet packages by Daniel Blankensteiner · 5 weeks ago
  4. 55745be Make ready for release 2.4.0 by Daniel Blankensteiner · 8 weeks ago 2.4.0
  5. 0c34db7 Implemented support for ZstdSharp.Port by Daniel Blankensteiner · 8 weeks ago

# DotPulsar

CI - Unit

The official .NET client library for Apache Pulsar.

DotPulsar is written entirely in C# and implements Apache Pulsar's binary protocol.

What's new?

Have a look at the changelog.

Getting Started

Let's take a look at a “Hello world” example, where we first produce a message and then consume it.

First, we need a Pulsar setup. Have a look here to see how to setup a local standalone Pulsar instance. Install the NuGet package DotPulsar and copy/paste the code below (you will be needing using declarations for ‘DotPulsar’ and ‘DotPulsar.Extensions’).

const string myTopic = "persistent://public/default/mytopic";

await using var client = PulsarClient.Builder()
                                     .Build(); // Connecting to pulsar://localhost:6650

await using var producer = client.NewProducer(Schema.String)
                                 .Topic(myTopic)
                                 .Create();

_ = await producer.Send("Hello World"); // Send a message and ignore the returned MessageId

await using var consumer = client.NewConsumer(Schema.String)
                                 .SubscriptionName("MySubscription")
                                 .Topic(myTopic)
                                 .Create();

await foreach (var message in consumer.Messages())
{
    Console.WriteLine($"Received: {message.Value()}");
    await consumer.Acknowledge(message);
}

For a more in-depth tour of the API, please visit the Wiki.

Supported features

  • [X] Service discovery
  • [X] Automatic reconnect
  • [X] TLS connections
  • [X] Pulsar Proxy
  • [X] Producer send with custom metadata
  • [X] Producer send with event time, sequence id, and delayed message delivery
  • [X] Producer send with key and ordering key
  • [X] Producer for partitioned topics
  • [X] Consumer subscription with initial position and priority level
  • [X] Consumer subscription types exclusive, shared, failover, and key shared
  • [X] Consumer receive and single + cumulative acknowledge
  • [X] Consumer and Reader seek on message-id and publish time
  • [X] Consumer unsubscribe
  • [X] Consume compacted topics
  • [X] Reader API
  • [X] Read/Consume/Acknowledge batched messages
  • [X] Telemetry
  • [X] Authentication
    • TLS Authentication
    • JSON Web Token Authentication
    • Custom Authentication
  • [X] Message compression
    • LZ4
    • ZLIB
    • ZSTD
    • SNAPPY
  • [X] Schemas
    • Boolean
    • Bytes (using byte[] and ReadOnlySequence<byte>)
    • String (UTF-8, UTF-16, and US-ASCII)
    • INT8, INT16, INT32, and INT64
    • Float and Double
    • Time (using TimeSpan)
    • Timestamp and Date (using DateTime)

Roadmap

Help prioritizing the roadmap is most welcome, so please reach out and tell us what you want and need.

Join Our Community

Apache Pulsar has a Slack instance and there you'll find us in the #dev-dotpulsar channel.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the Apache License Version 2.0 - see the LICENSE file for details.