Google Git
Sign in
apache / pulsar-dotpulsar / d77d77b1fb53155698c98348c31b811c9de04e14
commitd77d77b1fb53155698c98348c31b811c9de04e14[log] [tgz]
authorDaniel Blankensteiner <db@vmail.dk>Tue Mar 15 23:39:17 2022 +0100
committerDaniel Blankensteiner <db@vmail.dk>Tue Mar 15 23:39:17 2022 +0100
treeba0991bdce938435982251ff44af26f87b35250c
parentc3e547b7f93615323017ec978e4ebad2c940f7f5 [diff]
Adding metrics. Needs testing
11 files changed
tree: ba0991bdce938435982251ff44af26f87b35250c
  1. .github/
  2. .idea/
  3. samples/
  4. src/
  5. tests/
  6. .asf.yaml
  7. .editorconfig
  8. .gitattributes
  9. .gitignore
  10. CHANGELOG.md
  11. docker-compose.yml
  12. DotPulsar.sln
  13. DotPulsar.sln.DotSettings
  14. LICENSE
  15. README.md
README.md

# 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] TLS Authentication
  • [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] 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] Pulsar Proxy
  • [X] LZ4 message compression
  • [X] ZLIB message compression
  • [X] ZSTD message compression
  • [X] SNAPPY message compression
  • [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.