wangyuzhu/pulsar-dotpulsar

.NET/C# client library for Apache Pulsar

DotPulsar

.NET/C# client library for Apache Pulsar.

DotPulsar is written entirely in C# and implements Apache Pulsar's binary protocol. Other options was using the C++ client library (which is what the Python client and Go client do) or build on top of the WebSocket API. We decided to implement the binary protocol to gain full control and maximize portability and performance.

DotPulsar's API is strongly inspired by Apache Pulsar's official Java client, but a 100% match is not a goal.

Getting Started

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

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

var producer = client.NewProducer()
                     .Topic(myTopic)
                     .Create();

_ = await producer.Send(Encoding.UTF8.GetBytes("Hello World"));

var consumer = client.NewConsumer()
                     .SubscriptionName("MySubscription")
                     .Topic(myTopic)
                     .Create();

await foreach (var message in consumer.Messages())
{
    Console.WriteLine("Received: " + Encoding.UTF8.GetString(message.Data.ToArray()));
    await consumer.Acknowledge(message);
}

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

Supported features

• Service discovery
• Automatic reconnect
• TLS connections
• TLS Authentication
• JSON Web Token Authentication
• Producer send with custom metadata
• Producer send with event time, sequence id and delayed message delivery
• Producer send with key and ordering key
• Consumer subscription with initial position and priority level
• Consumer subscription types exclusive, shared, failover and key shared
• Consumer receive and single + cumulative acknowledge
• Consumer seek
• Consumer unsubscribe
• Consume compacted topics
• Reader API
• Read/Consume/Acknowledge batched messages
• Pulsar Proxy

Roadmap

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

1.0.0

We are feature complete for this release. We just need testing.

• Use IAsyncDisposable
• Use IAsyncEnumerable
• Use ValueTask instead of Task
• Make solution nullable
• Support .NET Standard 2.0 and 2.1

If requested by the community

Let us know which features you need by creating an issue or by giving existing issues a "Thumbs up".

• Message encryption
• Batching when producing
• Schema
• Partitioned topics
• Multi-topic subscriptions
• Athenz Authentication
• Kerberos Authentication
• LZ4 message compression
• ZLIB message compression
• ZSTD message compression
• SNAPPY message compression

Join Our Community

Apache Pulsar has a Slack instance and there you'll find us in the #dev-dotpulsar channel. Just waiting for you to pop by :-)

Built With

• protobuf-net - Provides simple access to fast and efficient "Protocol Buffers" serialization from .NET applications
• System.IO.Pipelines - Single producer single consumer byte buffer management

Versioning

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

Authors

• Daniel Blankensteiner - Initial work - Danske Commodities

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.