refs/heads/master - pulsar-dotpulsar

commit	1a07120aa9d14016f1449fc1218b29ea025988b0	[log] [tgz]
author	entvex <1580435+entvex@users.noreply.github.com>	Fri Sep 27 09:40:19 2024 +0200
committer	GitHub <noreply@github.com>	Fri Sep 27 09:40:19 2024 +0200
tree	6d1d41f67a3adeb90c8a6dc6cffd25722d1ff5d6
parent	0c811eb2578f43d66173b35c99180a5212973299 [diff]

tree: 6d1d41f67a3adeb90c8a6dc6cffd25722d1ff5d6

README.md

# DotPulsar

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. Note that the topic and subscription will be created if they don’t exist.

First, we need a Pulsar setup. See Pulsar docs for how to set up a local standalone Pulsar instance.

Install the NuGet package DotPulsar and run the follow code example:

using DotPulsar;
using DotPulsar.Extensions;

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

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

// produce a message
await using var producer = client.NewProducer(Schema.String).Topic(myTopic).Create();
await producer.Send("Hello World");

// consume messages
await using var consumer = client.NewConsumer(Schema.String)
    .SubscriptionName("MySubscription")
    .Topic(myTopic)
    .InitialPosition(SubscriptionInitialPosition.Earliest)
    .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 - 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/Reader - seek on message-id and publish time
[X] Consumer - unsubscribe
[X] Consumer - compacted topics
[X] Consumer - partitioned topics
[X] Reader API
[X] Read/Consume/Acknowledge batched messages
[X] Telemetry
- Tracing
- Metrics
[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)

For a horizontal comparison with more language-specific clients, see Client Feature Matrix.

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

Daniel Blankensteiner - Initial work - Danske Commodities

Contributions are welcomed and greatly appreciated. See also the list of contributors who participated in this project. Read the CONTRIBUTING guide for how to participate.

If your contribution adds Pulsar features for C# clients, you need to update both the Pulsar docs and the Client Feature Matrix. See Contribution Guide for more details.

License

This project is licensed under Apache License, Version 2.0.