Pulsar.Client
3.6.0
dotnet add package Pulsar.Client --version 3.6.0
NuGet\Install-Package Pulsar.Client -Version 3.6.0
<PackageReference Include="Pulsar.Client" Version="3.6.0" />
paket add Pulsar.Client --version 3.6.0
#r "nuget: Pulsar.Client, 3.6.0"
// Install Pulsar.Client as a Cake Addin #addin nuget:?package=Pulsar.Client&version=3.6.0 // Install Pulsar.Client as a Cake Tool #tool nuget:?package=Pulsar.Client&version=3.6.0
pulsar-client-dotnet
Contributions and stars ★ are most welcome!
Pulsar.Client nuget | Pulsar.Client.Otel nuget
Supported pulsar cluster versions: 2.4+
Find examples of usage in /examples folder. We are trying to keep api similar to the Java client, so please take a look at it's documentation to understand possible options available. You can also join telegram chat https://t.me/pro_pulsar for further discussions.
Features list (based on Client Feature Matrix):
- Basic Producer/Consumer API
- Partitioned topics
- Batching
- Chunking
- Compression
- TLS
- Authentication (token, tls, oauth2)
- Reader API
- Proxy Support
- Effectively-Once
- Schema (All types, Multi-version)
- Consumer seek
- Multi-topics consumer
- Topics regex consumer
- Compacted topics
- User defined properties
- Reader hasMessageAvailable
- Hostname verification
- Multi Hosts Service Url
- Key_shared subscription
- Key based batcher
- Negative Acknowledge
- Delayed/scheduled messages
- Dead Letter Policy
- Interceptors
- Transactions
- Statistics
- End-to-end Encryption
- SubscriptionInitialPosition
- Cumulative Ack
- Batch-Index Ack
- SNI Routing
- Table view
Quick contributing guide
Common steps before building
- Fork and clone locally
- Install dotnet tools:
dotnet tool restore
- Restore packages:
dotnet restore
MacOS steps before building:
- Install Snappy:
brew install snappy
- Install Libzstd:
brew install zstd
Ubuntu steps before building:
- Install Snappy:
sudo apt-get install -y libsnappy-dev
- Install Libzstd:
sudo apt-get install -y libzstd-dev
Building and Testing
- Build the solution:
dotnet build
(dotnet core sdk required) This will install required tools and then you can use any IDE to build solution - Make your modifications
- Run unit tests:
cd tests/UnitTests
&&dotnet test
- (Optional) If changes are made in Client logic, run Integration tests. Before running do the following
- Install pulsar cluster:
- MacOS guide:
brew tap streamlio/homebrew-formulae
brew install streamlio/homebrew-formulae/pulsar
brew install streamlio/homebrew-formulae/bookkeeper
brew services start pulsar
brew services start bookkeeper
- Run commands in
/tests/IntegrationTests/commands.txt
- Change
pulsarAddress
in Common.fs to point your pulsar cluster - Ensure
public/default
namespace with default settings - Ensure
public/retention
namespace with time or storage size retention configured
- Install pulsar cluster:
- Send a Pull Request
Maintaners
- @Lanayx (only maintaining). If you want me to implement new features, this can be arranged on a paid basis, please PM in Telegram
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
-
net8.0
- Apache.Avro (>= 1.11.3)
- AvroSchemaGenerator (>= 2.9.2)
- FSharp.Core (>= 8.0.301)
- FSharp.UMX (>= 1.1.0)
- K4os.Compression.LZ4 (>= 1.3.6)
- Microsoft.Extensions.Caching.Memory (>= 8.0.0)
- Microsoft.Extensions.Logging (>= 8.0.0)
- Microsoft.Extensions.Logging.Abstractions (>= 8.0.0)
- Microsoft.IO.RecyclableMemoryStream (>= 3.0.0)
- NSec.Cryptography (>= 22.4.0)
- PemUtils (>= 3.0.0.82)
- Pipelines.Sockets.Unofficial (>= 2.2.8)
- protobuf-net (>= 3.2.30)
- protobuf-net.Reflection (>= 3.2.12)
- Snappier (>= 1.1.6)
- System.IO.Pipelines (>= 8.0.0)
- zlib.net-mutliplatform (>= 1.0.6)
- ZstdNet (>= 1.4.5)
NuGet packages (10)
Showing the top 5 NuGet packages that depend on Pulsar.Client:
Package | Downloads |
---|---|
Pulsar.Client.Otel
OpenTelemetry plugin for Pulsar.Client |
|
Zq.Utils.Core
.NET Standard2.0、.NET Standard2.1、.NET5、.NET6版本工具类 |
|
DotNetCore.CAP.Pulsar
Distributed transaction solution in micro-service base on eventually consistency, also an eventbus with Outbox pattern. |
|
SnD.Sdk
SDK for Sneaks&Data OSS Projects |
|
RJ.Commons.Pulsar
Default Pulsar API for Aries project. |
GitHub repositories (2)
Showing the top 2 popular GitHub repositories that depend on Pulsar.Client:
Repository | Stars |
---|---|
dotnetcore/CAP
Distributed transaction solution in micro-service base on eventually consistency, also an eventbus with Outbox pattern
|
|
LeonKou/NetPro
🌈An enhanced version with clean architecture of asp.netcore,efficiently manage startup,Support for netcore3.1/6.0
|
Version | Downloads | Last updated |
---|---|---|
3.6.0 | 34,204 | 8/8/2024 |
3.5.4 | 8,036 | 8/1/2024 |
3.5.3 | 1,070 | 7/31/2024 |
3.5.2 | 6,471 | 7/15/2024 |
3.5.1 | 8,254 | 6/19/2024 |
3.5.0 | 5,459 | 5/15/2024 |
3.4.0 | 3,446 | 4/19/2024 |
3.3.1 | 2,820 | 3/28/2024 |
3.3.0 | 36,662 | 2/12/2024 |
3.2.0 | 1,787 | 2/1/2024 |
3.1.0 | 18,338 | 11/19/2023 |
3.0.0 | 753 | 11/17/2023 |
3.0.0-beta.2 | 148 | 10/22/2023 |
3.0.0-beta.1 | 111 | 10/15/2023 |
2.16.0 | 6,933 | 4/29/2024 |
2.15.2 | 1,603 | 3/7/2024 |
2.15.1 | 596 | 2/12/2024 |
2.15.0 | 37,542 | 11/18/2023 |
2.14.0 | 1,081 | 11/14/2023 |
2.13.2 | 31,322 | 10/11/2023 |
2.13.1 | 3,410 | 9/29/2023 |
2.13.0 | 10,600 | 9/25/2023 |
2.12.7 | 19,989 | 8/9/2023 |
2.12.6 | 42,770 | 7/23/2023 |
2.12.4 | 4,728 | 7/17/2023 |
2.12.3 | 17,091 | 7/6/2023 |
2.12.2 | 106,076 | 3/31/2023 |
2.12.1 | 16,437 | 3/22/2023 |
2.12.0 | 10,546 | 1/29/2023 |
2.11.0 | 37,293 | 10/13/2022 |
2.10.4 | 7,952 | 10/7/2022 |
2.10.3 | 2,861 | 9/16/2022 |
2.10.2 | 53,140 | 6/22/2022 |
2.10.1 | 62,847 | 3/9/2022 |
2.10.0 | 40,786 | 2/23/2022 |
2.9.4 | 19,144 | 12/5/2021 |
2.9.3 | 3,479 | 11/26/2021 |
2.9.2 | 1,179 | 11/11/2021 |
2.9.1 | 29,775 | 10/14/2021 |
2.9.0 | 2,051 | 9/29/2021 |
2.8.1 | 5,340 | 9/9/2021 |
2.8.0 | 2,152 | 9/2/2021 |
2.7.2 | 8,138 | 8/26/2021 |
2.7.1 | 7,349 | 8/6/2021 |
2.7.0 | 7,221 | 7/20/2021 |
2.6.3 | 2,042 | 7/15/2021 |
2.6.2 | 1,920 | 7/9/2021 |
2.6.1 | 1,312 | 7/6/2021 |
2.6.0 | 6,654 | 7/5/2021 |
2.5.3 | 1,131 | 7/2/2021 |
2.5.2 | 1,272 | 6/30/2021 |
2.5.1 | 1,573 | 6/29/2021 |
2.5.0 | 1,216 | 6/27/2021 |
2.4.1 | 1,420 | 6/25/2021 |
2.4.0 | 2,569 | 6/14/2021 |
2.3.3 | 1,527 | 6/8/2021 |
2.3.1 | 2,736 | 5/11/2021 |
2.3.0 | 1,284 | 5/11/2021 |
2.2.0 | 2,163 | 4/22/2021 |
2.1.1 | 1,245 | 4/14/2021 |
2.1.0 | 4,576 | 3/16/2021 |
2.0.4 | 2,248 | 3/5/2021 |
2.0.3 | 1,250 | 3/5/2021 |
2.0.2 | 2,533 | 2/23/2021 |
2.0.1 | 9,248 | 2/17/2021 |
2.0.0 | 1,244 | 2/12/2021 |
1.8.5 | 9,347 | 2/10/2021 |
1.8.4 | 24,599 | 1/25/2021 |
1.8.3 | 2,302 | 1/6/2021 |
1.8.2 | 3,308 | 12/17/2020 |
1.8.1 | 4,372 | 12/15/2020 |
1.8.0 | 3,943 | 12/10/2020 |
1.7.8 | 72,302 | 5/17/2021 |
1.7.7 | 1,170 | 5/17/2021 |
1.7.6 | 1,241 | 5/17/2021 |
1.7.5 | 3,065 | 10/30/2020 |
1.7.4 | 6,736 | 10/19/2020 |
1.7.3 | 27,483 | 10/13/2020 |
1.7.2 | 1,728 | 10/2/2020 |
1.7.1 | 4,739 | 9/17/2020 |
1.7.0 | 1,551 | 9/14/2020 |
1.6.3 | 1,359 | 9/12/2020 |
1.6.2 | 1,450 | 9/3/2020 |
1.6.1 | 1,313 | 9/2/2020 |
1.6.0 | 1,461 | 8/30/2020 |
1.5.0 | 10,760 | 8/3/2020 |
1.4.3 | 2,443 | 7/9/2020 |
1.4.2 | 1,522 | 7/2/2020 |
1.4.1 | 1,234 | 6/29/2020 |
1.4.0 | 1,686 | 6/17/2020 |
1.3.0 | 1,433 | 6/14/2020 |
1.2.0 | 2,801 | 5/27/2020 |
1.1.1 | 1,339 | 5/22/2020 |
1.1.0 | 1,927 | 5/15/2020 |
1.0.1 | 1,294 | 5/14/2020 |
1.0.0 | 1,306 | 5/14/2020 |
0.18.4 | 1,857 | 4/21/2020 |
0.18.3 | 1,496 | 4/18/2020 |
0.18.2 | 3,222 | 4/8/2020 |
0.18.1 | 1,327 | 4/7/2020 |
0.18.0 | 1,528 | 4/1/2020 |
0.17.0 | 1,522 | 3/21/2020 |
0.16.0 | 1,365 | 3/19/2020 |
0.15.0 | 1,953 | 2/28/2020 |
0.14.1 | 1,349 | 2/25/2020 |
0.14.0 | 1,283 | 2/21/2020 |
0.13.1 | 1,324 | 2/19/2020 |
0.13.0 | 1,683 | 2/14/2020 |
0.12.0 | 2,031 | 12/31/2019 |
0.11.2 | 1,521 | 12/23/2019 |
0.11.1 | 1,439 | 12/20/2019 |
0.11.0 | 1,386 | 12/16/2019 |
0.10.0 | 1,456 | 11/17/2019 |
0.9.1 | 1,518 | 11/14/2019 |
0.9.0 | 1,438 | 11/12/2019 |
0.8.2 | 1,462 | 11/9/2019 |
0.8.1 | 1,447 | 11/4/2019 |
0.8.0 | 1,385 | 11/2/2019 |
0.7.0 | 1,406 | 10/25/2019 |
0.6.0 | 1,475 | 10/16/2019 |
0.5.0 | 1,402 | 10/15/2019 |
0.4.0 | 1,428 | 10/8/2019 |
0.3.0 | 1,403 | 10/7/2019 |
0.2.0 | 1,522 | 9/30/2019 |
0.1.5 | 1,267 | 9/13/2019 |
0.1.4 | 1,230 | 9/9/2019 |
0.1.3 | 1,208 | 9/9/2019 |
0.1.2 | 1,168 | 9/9/2019 |
0.1.1 | 1,284 | 9/6/2019 |
0.1.0 | 1,268 | 9/6/2019 |
Support InitialSubscritionName for DLQ