commit	58230b32642d6ddb8df788222b722e18302c27ab	[log] [tgz]
author	Daniel Blankensteiner <dba@danskecommodities.com>	Wed Sep 25 12:22:37 2019 +0200
committer	Daniel Blankensteiner <dba@danskecommodities.com>	Wed Sep 25 12:22:37 2019 +0200
tree	590ad729f7bb22976787ac75791bfe1d45a74ebe
parent	cb1309d005219453048ce202cffeabe62470f8f2 [diff]

tree: 590ad729f7bb22976787ac75791bfe1d45a74ebe

README.md

DotPulsar

Native .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";

using var client = PulsarClient.Builder().Build(); //Connecting to 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();
var message = await consumer.Receive();
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

[X] Service discovery
[X] Automatic reconnect
[X] TLS connections
[X] JSON Web Token Authentication
[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] 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 seek
[X] Consumer unsubscribe
[X] Consume compacted topics
[X] Reader API

Roadmap

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

1.0.0

Before the first stable release, we should have a look at:

Use IAsyncDisposable
Use IAsyncEnumerable
Consider using ValueTask instead of Task
Consider using nullable reference types
Look into the possibility of supporting .NET Standard 2.0

Future

Batching

If requested by the community

Get consumer stats
Get topics of namespace
Message encryption
Schema
Partitioned topics
Multi-topic subscriptions
TLS Authentication
Athenz Authentication
Kerberos Authentication
LZ4 message compression
ZLIB message compression
ZSTD message compression
SNAPPY message compression

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.