Pulsar.Client 3.15.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-formulaebrew install streamlio/homebrew-formulae/pulsarbrew install streamlio/homebrew-formulae/bookkeeperbrew services start pulsarbrew services start bookkeeper
- Run commands in
/tests/IntegrationTests/commands.txt - Change
pulsarAddressin Common.fs to point your pulsar cluster - Ensure
advertisedAddressin broker.conf to point your pulsar cluster - Ensure
public/defaultnamespace with default settings - Ensure
public/retentionnamespace with time or storage size retention configured
- Install pulsar cluster:
- Send a Pull Request
Maintaners and support
- You can suppport me (@Lanayx) using Github sponsors so I continue maintaining this project well.
- If you want me to implement new (missing) features, this can be arranged on a paid basis using Github sponsors as well, please PM in Telegram
No packages depend on Pulsar.Client.
Auto cluster failover support
.NET 8.0
- Apache.Avro (>= 1.11.3)
- AvroSchemaGenerator (>= 2.9.2)
- FSharp.Core (>= 10.0.102)
- FSharp.UMX (>= 1.1.0)
- K4os.Compression.LZ4 (>= 1.3.6)
- Microsoft.Extensions.Caching.Memory (>= 8.0.1)
- Microsoft.Extensions.Logging (>= 8.0.0)
- Microsoft.Extensions.Logging.Abstractions (>= 8.0.2)
- Microsoft.IO.RecyclableMemoryStream (>= 3.0.0)
- NSec.Cryptography (>= 22.4.0)
- PemUtils (>= 3.0.0.82)
- Pipelines.Sockets.Unofficial (>= 2.2.8)
- Snappier (>= 1.1.6)
- System.IO.Pipelines (>= 8.0.0)
- ZstdNet (>= 1.4.5)
- protobuf-net (>= 3.2.30)
- protobuf-net.Reflection (>= 3.2.12)
- zlib.net-mutliplatform (>= 1.0.6)
| Version | Downloads | Last updated |
|---|---|---|
| 3.15.0 | 1 | 04/17/2026 |
| 3.14.1 | 0 | 03/30/2026 |
| 3.14.0 | 0 | 03/30/2026 |
| 3.13.5 | 0 | 03/18/2026 |
| 3.13.4 | 0 | 02/10/2026 |
| 3.13.3 | 0 | 01/29/2026 |
| 3.13.2 | 0 | 01/15/2026 |
| 3.13.1 | 0 | 12/27/2025 |
| 3.13.0 | 0 | 11/08/2025 |
| 3.12.1 | 0 | 10/30/2025 |
| 3.12.0 | 0 | 09/22/2025 |
| 3.11.0 | 0 | 09/18/2025 |
| 3.10.0 | 0 | 07/31/2025 |
| 3.9.6 | 0 | 07/29/2025 |
| 3.9.5 | 2 | 04/16/2026 |
| 3.9.4 | 0 | 05/28/2025 |
| 3.9.3 | 0 | 05/22/2025 |
| 3.9.2 | 0 | 04/14/2025 |
| 3.9.1 | 0 | 04/03/2025 |
| 3.9.0 | 0 | 03/26/2025 |
| 3.8.1 | 0 | 03/07/2025 |
| 3.8.0 | 0 | 03/05/2025 |
| 3.7.0 | 0 | 02/08/2025 |
| 3.6.2 | 0 | 12/09/2024 |
| 3.6.1 | 0 | 11/21/2024 |
| 3.6.0 | 0 | 08/08/2024 |
| 3.5.4 | 0 | 08/01/2024 |
| 3.5.3 | 0 | 07/31/2024 |
| 3.5.2 | 0 | 07/15/2024 |
| 3.5.1 | 0 | 06/19/2024 |
| 3.5.0 | 0 | 05/15/2024 |
| 3.4.0 | 0 | 04/19/2024 |
| 3.3.1 | 0 | 03/28/2024 |
| 3.3.0 | 0 | 02/12/2024 |
| 3.2.0 | 0 | 02/01/2024 |
| 3.1.0 | 0 | 11/19/2023 |
| 3.0.0 | 0 | 11/17/2023 |
| 3.0.0-beta.2 | 0 | 10/22/2023 |
| 3.0.0-beta.1 | 0 | 10/15/2023 |
| 2.22.0 | 0 | 04/02/2026 |
| 2.21.1 | 0 | 01/30/2026 |
| 2.21.0 | 0 | 09/23/2025 |
| 2.20.0 | 0 | 07/31/2025 |
| 2.19.0 | 0 | 05/19/2025 |
| 2.18.3 | 0 | 04/16/2025 |
| 2.18.2 | 0 | 04/03/2025 |
| 2.18.1 | 0 | 04/02/2025 |
| 2.18.0 | 0 | 03/27/2025 |
| 2.17.0 | 0 | 12/26/2024 |
| 2.16.0 | 0 | 04/29/2024 |
| 2.15.2 | 0 | 03/07/2024 |
| 2.15.1 | 0 | 02/12/2024 |
| 2.15.0 | 0 | 11/18/2023 |
| 2.14.0 | 0 | 11/14/2023 |
| 2.13.2 | 0 | 10/11/2023 |
| 2.13.1 | 0 | 09/29/2023 |
| 2.13.0 | 0 | 09/25/2023 |
| 2.12.7 | 0 | 08/09/2023 |
| 2.12.6 | 0 | 07/23/2023 |
| 2.12.4 | 0 | 07/17/2023 |
| 2.12.3 | 0 | 07/06/2023 |
| 2.12.2 | 0 | 03/31/2023 |
| 2.12.1 | 0 | 03/22/2023 |
| 2.12.0 | 0 | 01/29/2023 |
| 2.11.0 | 0 | 10/13/2022 |
| 2.10.4 | 0 | 10/07/2022 |
| 2.10.3 | 0 | 09/16/2022 |
| 2.10.2 | 0 | 06/22/2022 |
| 2.10.1 | 0 | 03/09/2022 |
| 2.10.0 | 0 | 02/23/2022 |
| 2.9.4 | 0 | 12/05/2021 |
| 2.9.3 | 0 | 11/26/2021 |
| 2.9.2 | 0 | 11/11/2021 |
| 2.9.1 | 0 | 10/14/2021 |
| 2.9.0 | 0 | 09/29/2021 |
| 2.8.1 | 0 | 09/09/2021 |
| 2.8.0 | 0 | 09/02/2021 |
| 2.7.2 | 0 | 08/26/2021 |
| 2.7.1 | 0 | 08/06/2021 |
| 2.7.0 | 0 | 07/20/2021 |
| 2.6.3 | 0 | 07/15/2021 |
| 2.6.2 | 0 | 07/09/2021 |
| 2.6.1 | 0 | 07/06/2021 |
| 2.6.0 | 0 | 07/05/2021 |
| 2.5.3 | 0 | 07/02/2021 |
| 2.5.2 | 0 | 06/30/2021 |
| 2.5.1 | 0 | 06/29/2021 |
| 2.5.0 | 0 | 06/27/2021 |
| 2.4.1 | 0 | 06/25/2021 |
| 2.4.0 | 0 | 06/14/2021 |
| 2.3.3 | 0 | 06/08/2021 |
| 2.3.1 | 0 | 05/11/2021 |
| 2.3.0 | 0 | 05/11/2021 |
| 2.2.0 | 0 | 04/22/2021 |
| 2.1.1 | 0 | 04/14/2021 |
| 2.1.0 | 0 | 03/16/2021 |
| 2.0.4 | 0 | 03/05/2021 |
| 2.0.3 | 0 | 03/05/2021 |
| 2.0.2 | 0 | 02/23/2021 |
| 2.0.1 | 0 | 02/17/2021 |
| 2.0.0 | 0 | 02/12/2021 |
| 1.8.5 | 0 | 02/10/2021 |
| 1.8.4 | 0 | 01/25/2021 |
| 1.8.3 | 0 | 01/06/2021 |
| 1.8.2 | 0 | 12/17/2020 |
| 1.8.1 | 0 | 12/15/2020 |
| 1.8.0 | 0 | 12/10/2020 |
| 1.7.8 | 0 | 05/17/2021 |
| 1.7.7 | 0 | 05/17/2021 |
| 1.7.6 | 0 | 05/17/2021 |
| 1.7.5 | 0 | 10/30/2020 |
| 1.7.4 | 0 | 10/19/2020 |
| 1.7.3 | 0 | 10/13/2020 |
| 1.7.2 | 0 | 10/02/2020 |
| 1.7.1 | 0 | 09/17/2020 |
| 1.7.0 | 0 | 09/14/2020 |
| 1.6.3 | 0 | 09/12/2020 |
| 1.6.2 | 0 | 09/03/2020 |
| 1.6.1 | 0 | 09/02/2020 |
| 1.6.0 | 0 | 08/30/2020 |
| 1.5.0 | 0 | 08/03/2020 |
| 1.4.3 | 0 | 07/09/2020 |
| 1.4.2 | 0 | 07/02/2020 |
| 1.4.1 | 0 | 06/29/2020 |
| 1.4.0 | 0 | 06/17/2020 |
| 1.3.0 | 0 | 06/14/2020 |
| 1.2.0 | 0 | 05/27/2020 |
| 1.1.1 | 0 | 05/22/2020 |
| 1.1.0 | 0 | 05/15/2020 |
| 1.0.1 | 0 | 05/14/2020 |
| 1.0.0 | 0 | 05/14/2020 |
| 0.18.4 | 0 | 04/21/2020 |
| 0.18.3 | 0 | 04/18/2020 |
| 0.18.2 | 0 | 04/08/2020 |
| 0.18.1 | 0 | 04/07/2020 |
| 0.18.0 | 0 | 04/01/2020 |
| 0.17.0 | 0 | 03/21/2020 |
| 0.16.0 | 0 | 03/19/2020 |
| 0.15.0 | 0 | 02/28/2020 |
| 0.14.1 | 0 | 02/25/2020 |
| 0.14.0 | 0 | 02/21/2020 |
| 0.13.1 | 0 | 02/19/2020 |
| 0.13.0 | 0 | 02/14/2020 |
| 0.12.0 | 0 | 12/31/2019 |
| 0.11.2 | 0 | 12/23/2019 |
| 0.11.1 | 0 | 12/20/2019 |
| 0.11.0 | 0 | 12/16/2019 |
| 0.10.0 | 0 | 11/17/2019 |
| 0.9.1 | 0 | 11/14/2019 |
| 0.9.0 | 0 | 11/12/2019 |
| 0.8.2 | 0 | 11/09/2019 |
| 0.8.1 | 0 | 11/04/2019 |
| 0.8.0 | 0 | 11/02/2019 |
| 0.7.0 | 0 | 10/25/2019 |
| 0.6.0 | 0 | 10/16/2019 |
| 0.5.0 | 0 | 10/15/2019 |
| 0.4.0 | 0 | 10/08/2019 |
| 0.3.0 | 0 | 10/07/2019 |
| 0.2.0 | 0 | 09/30/2019 |
| 0.1.5 | 0 | 09/13/2019 |
| 0.1.4 | 0 | 09/09/2019 |
| 0.1.3 | 0 | 09/09/2019 |
| 0.1.2 | 0 | 09/09/2019 |
| 0.1.1 | 0 | 09/06/2019 |
| 0.1.0 | 0 | 09/06/2019 |