hivemq-mqtt-client-dotnet - GitLite

KO | EN

gitlite — search

#javascript #python #golang #go #rust #deep-learning #macos #nodejs #java #awesome #kubernetes #vue #ios #mcp

hivemq-mqtt-client-dotnet

(★ 97)

Spectacular C# MQTT and Sparkplug Clients for .NET

File Explorer

Download Latest Version (.zip)

- - bug_report.md
  - config.yml
  - feature_request.md
  - question.md
- - build.yml
  - codeql-analysis.yml
  - release-drafter.yml
- CODE_OF_CONDUCT.md
- CONTRIBUTING.md
- dependabot.yml
- PULL_REQUEST_TEMPLATE.md
- release-drafter.yml
- SECURITY.md
- launch.json
- settings.json
- tasks.json
- - ClientBenchmark.cs
  - ClientBenchmarkApp.csproj
  - Program.cs
  - README.md
- - help.md
- - .nojekyll
- .gitignore
- babel.config.js
- docfx.json
- docusaurus.config.js
- package-lock.json
- package.json
- README.md
- sidebars.js
- yarn.lock
- - ConnectReceiveAndPublish.csproj
  - Program.cs
  - README.md
- - DisposeRepro.csproj
  - Program.cs
- - HiveMQtt-CLI.sln
  - README.md
- - NLog.config
  - README.md
- - Program.cs
  - README.md
  - SendMessageOnLoop.csproj
- - Program.cs
  - README.md
  - SparkplugEdgeNode.csproj
- - Program.cs
  - README.md
  - SparkplugHostApplication.csproj
- - Program.cs
  - README.md
  - SubscriberWithEvents.csproj
- Banner.png
- csharp-logo.png
- Hero.png
- hivemq-mqtt-client.png
- Icon.png
- - GlobalSuppressions.cs
  - HiveMQtt.csproj
  - HiveMQtt.sln
  - NLog.config
- - HiveMQtt.Sparkplug.csproj
  - README.md
- Directory.Build.props
- - HiveMQtt.Sparkplug.Test.csproj
- - BrokerCollection.cs
  - HiveMQtt.Test.csproj
  - xunit.runner.json
- .editorconfig
- Directory.Build.props
.editorconfig
.gitattributes
.gitignore
build.cake
Directory.Build.props
Directory.Build.targets
dotnet-tools.json
HEADER
HiveMQtt.sln
LICENSE
README.md
StyleCop.Analyzers.ruleset
stylecop.json

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

![HiveMQtt logo](https://i.imgur.com/YmafvGk.png)
![HiveMQ C# MQTT Client banner](https://i.imgur.com/Tnl78V6.png)

# The Spectacular C# MQTT and Sparkplug Clients for .NET

[![NuGet Version](https://img.shields.io/nuget/v/HiveMQtt?style=for-the-badge)](https://www.nuget.org/packages/HiveMQtt)
[![GitHub release (latest by date)](https://img.shields.io/github/v/release/hivemq/hivemq-mqtt-client-dotnet?style=for-the-badge)](https://github.com/hivemq/hivemq-mqtt-client-dotnet/releases)
[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/hivemq/hivemq-mqtt-client-dotnet/build.yml?style=for-the-badge)](https://github.com/hivemq/hivemq-mqtt-client-dotnet/actions)
[![NuGet](https://img.shields.io/nuget/dt/HiveMQtt?style=for-the-badge)](https://www.nuget.org/packages/HiveMQtt)
[![GitHub](https://img.shields.io/github/license/hivemq/hivemq-mqtt-client-dotnet?style=for-the-badge)](https://github.com/hivemq/hivemq-mqtt-client-dotnet/blob/main/LICENSE)

![Static Badge](https://img.shields.io/badge/.NET-6.0-%23512BD4?style=for-the-badge)
![Static Badge](https://img.shields.io/badge/.NET-7.0-%23512BD4?style=for-the-badge)
![Static Badge](https://img.shields.io/badge/.NET-8.0-%23512BD4?style=for-the-badge)
![Static Badge](https://img.shields.io/badge/.NET-9.0-%23512BD4?style=for-the-badge)
![Static Badge](https://img.shields.io/badge/.NET-10.0-%23512BD4?style=for-the-badge)

> Looking for the **Sparkplug Client**? Use [HiveMQtt.Sparkplug](https://www.nuget.org/packages/HiveMQtt.Sparkplug/) and start with the [Sparkplug README](./Source/HiveMQtt.Sparkplug/README.md) for quick start guides and examples.

### 💽 Installation & Compatibility
* **Easy-to-Install**: Available as a [NuGet package](https://www.nuget.org/packages/HiveMQtt).
* **Globally Compatible**: Built to be a fully compliant MQTT 5.0 client compatible with all modern MQTT brokers.
* **Multi-Targeted**: Supports .NET 6.0, 7.0, 8.0, 9.0 & 10.0
* **Sparkplug Client extension**: The [HiveMQtt.Sparkplug](https://www.nuget.org/packages/HiveMQtt.Sparkplug) package adds Host Application and Edge Node support for industrial IoT (IIoT) using the [Eclipse Sparkplug B 3.0](https://sparkplug.eclipse.org/specification/version/3.0) specification—install with `dotnet add package HiveMQtt.Sparkplug` and see the [Sparkplug README](./Source/HiveMQtt.Sparkplug/README.md) for full details.

### 🚀 Features
* **MQTT 5.0 Support**: Fully compliant with the latest [MQTT 5.0 specification](https://docs.oasis-open.org/mqtt/mqtt/v5.0/mqtt-v5.0.html), ensuring compatibility with modern MQTT brokers.
* **Multiple Transport Options**: Support for both TCP and WebSocket connections (ws:// and wss://), ideal for network environments that restrict TCP traffic or require HTTP-compatible transport.
* **Manual Acknowledgement**: Control when the broker considers QoS 1 and QoS 2 messages delivered. Process or persist messages first, then call `AckAsync`—ideal for at-least-once and exactly-once workflows. See the [manual ack guide](https://hivemq.github.io/hivemq-mqtt-client-dotnet/docs/how-to/manual-ack).
* **TCP & WebSocket Proxy Support**: Connect through HTTP proxies—TCP via [HTTP CONNECT tunneling](https://hivemq.github.io/hivemq-mqtt-client-dotnet/docs/how-to/configure-proxy) (`WithProxy`), WebSocket via `WithWebSocketProxy`. Perfect for corporate networks and firewalls.
* **Back Pressure Management**: Automatically manages back pressure to prevent overwhelming the broker (or client), ensuring reliable and efficient communication.
* **Asynchronous Design**: Designed for high-performance and low-latency communication, allowing your application to process multiple messages concurrently.
* **Extensive Event System**: Hook into all parts of the client down to the packet level with [built in events](https://hivemq.github.io/hivemq-mqtt-client-dotnet/docs/events).
* **Global and Per-Subscription Message Handling**: Use multiple targeted handlers for more targeted and specialized message processing.
* **Full Last Will & Testament Support**: Reliable message delivery and notification of client disconnections.
* **Secure Client Identification**: Full support for [X.509 client certificates](https://hivemq.github.io/hivemq-mqtt-client-dotnet/docs/how-to/client-certificates) and TLS connections.
* **Observable**: Configure up to [TRACE level logging](https://hivemq.github.io/hivemq-mqtt-client-dotnet/docs/how-to/debug) for package internals.
* **Fast**: Optimized & benchmarked.  See the benchmark results [here](https://github.com/hivemq/hivemq-mqtt-client-dotnet/blob/main/Benchmarks/ClientBenchmarkApp/README.md).

### 🔒 Security
* **Secure Password Storage**: Passwords are stored using `SecureString` to prevent exposure in memory dumps and process memory. Use `WithPassword(SecureString)` for enhanced security.
* **Secure Certificate Password Handling**: Certificate passwords are handled securely using `SecureString`. Use `WithClientCertificate(path, SecureString)` for enhanced security.
* **Memory-Safe Password Handling**: Temporary password strings are automatically cleared from memory after use, ensuring no sensitive data persists in memory.
* **Backward Compatibility**: Existing code using string passwords continues to work while being automatically converted to secure storage internally.
* **TLS/SSL Support**: Full support for encrypted connections (both TCP and WebSocket) with configurable certificate validation and custom certificate handling.
* **Secure WebSocket (wss://)**: Complete support for secure WebSocket connections with client certificate authentication and configurable certificate validation.
* **X.509 Certificate Authentication**: Complete support for client certificate authentication with secure private key handling for both TCP and WebSocket connections.

### 🏝️ Ease of Use
* **Easy to Use**: Smart defaults, excellent interfaces and intelligent automation make implementation a breeze.
* **Easy Integration**: Simple and intuitive API makes it easy to integrate with your .NET applications.

### 🛟 Maintenance and Support
* **Actively Maintained**: Built by the MQTT professionals that built HiveMQ (and do this for a living).
* **Supported**: Contact us anytime in [this repository](https://github.com/hivemq/hivemq-mqtt-client-dotnet/issues), in the [community forum](https://community.hivemq.com) or [through support](https://www.hivemq.com/support/).
* **Extensively Documented**: What good is it without [excellent documentation](https://hivemq.github.io/hivemq-mqtt-client-dotnet/)?

### 🐧 Open Source
* **Open Source**: No blackbox code. Only trusted, tested and reviewed open source code.

**📍 Get Started Today**

Download the HiveMQ C# MQTT Client for .NET and start building your next-generation IoT, industrial automation, or real-time data streaming application with HiveMQ on your side.

_Do you have a success story with this client?  [Let us know](https://www.hivemq.com/contact/?btn=contact-nav).  We'd love to feature your story in a blog post or video and you'll get some sweet HiveMQ swag (and publicity) along the way._

## What is this?

MQTT is an [open standard protocol](https://mqtt.org) for publishing and consuming messages from IoT devices all the way up to mainframes.  It's binary, massively performant and easy to use.

This client library is used to publish and consume messages over MQTT.  So you can get the temperature from a remote sensor, send a control message to a factory robot, tunnel WhatsApp messages to an X account or anything else you can imagine.

This is the client library that speaks with an MQTT broker that delivers messages to their final destination.

Need a broker? Sign up for a free broker at [HiveMQ Cloud](https://www.hivemq.com/mqtt-cloud-broker/) and be up and running in a couple minutes.  Connect up to 100 devices - no credit card required.

## MQTT Resources

* [MQTT Essentials](https://www.hivemq.com/mqtt-essentials/) (Great for beginners wanting an introduction)
* [MQTT Toolbox](https://www.hivemq.com/mqtt-toolbox/)
* [MQTT Client Library Encyclopedia](https://www.hivemq.com/mqtt-client-library-encyclopedia/)
* HiveMQ [Public Broker](http://www.mqtt-dashboard.com)
* HiveMQ [Support](https://www.hivemq.com/support/)

## Need an MQTT Broker?

This client communicates with an MQTT broker to publish and consume messages.  It's built to be compatible with all major MQTT brokers but if you need a broker now run the HiveMQ Community Edition:

```bash
docker run --name hivemq-ce -d -p 1883:1883 hivemq/hivemq-ce
```

This will run the HiveMQ Community Edition broker on localhost port 1883.

If you need advanced features, check out our [premium editions](https://www.hivemq.com/hivemq/editions/) or alternatively [HiveMQ Cloud](https://www.hivemq.com/mqtt-cloud-broker/) which is free to connect up to 100 devices (no credit card required).

## Install

### HiveMQtt (core client)

This package is [available on NuGet.org](https://www.nuget.org/packages/HiveMQtt/) and can be installed with:

```sh
dotnet add package HiveMQtt
```

See the [HiveMQtt NuGet page](https://www.nuget.org/packages/HiveMQtt/) for more installation options.

### HiveMQtt.Sparkplug (Sparkplug B extension)

The **HiveMQtt.Sparkplug** package is now available on NuGet. It extends the HiveMQtt client with [Sparkplug B 3.0](https://sparkplug.eclipse.org/specification/version/3.0) support for industrial IoT: Host Applications (subscribe to Edge Nodes and Devices, publish NCMD/DCMD) and Edge Nodes (publish NBIRTH/NDATA/NDEATH, DBIRTH/DDATA/DDEATH; receive NCMD/DCMD). Install with:

```sh
dotnet add package HiveMQtt.Sparkplug
```

See the [HiveMQtt.Sparkplug NuGet page](https://www.nuget.org/packages/HiveMQtt.Sparkplug/) and the [extension README](Source/HiveMQtt.Sparkplug/README.md) for details and quick start.

## Example

The following illustrates the client pattern to connect, subscribe and publish messages.

```csharp
using HiveMQtt.Client;
using HiveMQtt.MQTT5.Types;

// Setup Client options and instantiate
var options = new HiveMQClientOptionsBuilder().
                    WithBroker("candy.x39.eu.hivemq.cloud").
                    WithPort(8883).
                    WithUseTls(true).
                    Build();
var client = new HiveMQClient(options);

// Setup application message handlers BEFORE subscribing to a topic
client.OnMessageReceived += (sender, args) =>
{
    Console.WriteLine($"Message Received: {args.PublishMessage.PayloadAsString}");
};

// Connect to the MQTT broker
var connectResult = await client.ConnectAsync().ConfigureAwait(false);

// Configure the subscriptions we want and subscribe
var builder = new SubscribeOptionsBuilder();
builder.WithSubscription("topic1", QualityOfService.AtLeastOnceDelivery)
       .WithSubscription("topic2", QualityOfService.ExactlyOnceDelivery);
var subscribeOptions = builder.Build();
var subscribeResult = await client.SubscribeAsync(subscribeOptions);

// Publish a message
var publishResult = await client.PublishAsync("topic1/example", "Hello Payload");
```

### WebSocket Connection Example

The client also supports WebSocket connections (ws:// and wss://). WebSocket is useful when:
- Network policies only allow HTTP/HTTPS traffic (firewalls, proxies that block TCP)
- You need to leverage existing WebSocket infrastructure
- You're building server-side .NET applications that require HTTP-compatible transport

```csharp
using HiveMQtt.Client;
using HiveMQtt.MQTT5.Types;

// Connect via WebSocket (ws://)
var options = new HiveMQClientOptionsBuilder()
    .WithWebSocketServer("ws://localhost:8000/mqtt")
    .WithClientId("WebSocketClient")
    .Build();

// Or connect via secure WebSocket (wss://) with TLS
var secureOptions = new HiveMQClientOptionsBuilder()
    .WithWebSocketServer("wss://broker.hivemq.com:8884/mqtt")
    .WithClientId("SecureWebSocketClient")
    .Build();

var client = new HiveMQClient(secureOptions);
var connectResult = await client.ConnectAsync().ConfigureAwait(false);

// Use the same API for publish/subscribe - works identically to TCP connections
client.OnMessageReceived += (sender, args) =>
{
    Console.WriteLine($"WebSocket Message: {args.PublishMessage.PayloadAsString}");
};

await client.SubscribeAsync("my/topic");
await client.PublishAsync("my/topic", "Hello from WebSocket!");
```

### Manual Acknowledgement (QoS 1 & 2)

When you need to process or persist messages before the broker is told they were received, enable manual ack. The client won't send PubAck/PubRec until you call `AckAsync`:

```csharp
using HiveMQtt.Client;
using HiveMQtt.MQTT5.Types;

var options = new HiveMQClientOptionsBuilder()
    .WithBroker("broker.example.com")
    .WithPort(1883)
    .WithManualAck()
    .Build();

var client = new HiveMQClient(options);
client.OnMessageReceived += async (sender, args) =>
{
    await ProcessOrPersistAsync(args.PublishMessage);
    await client.AckAsync(args);   // Safe for any QoS (no-op for QoS 0)
};

await client.ConnectAsync();
await client.SubscribeAsync("orders/#", QualityOfService.AtLeastOnceDelivery);
```

See the [manual acknowledgement guide](https://hivemq.github.io/hivemq-mqtt-client-dotnet/docs/how-to/manual-ack) for Receive Maximum, thread safety, and RawClient usage.

### TCP and WebSocket Proxy Support

Connect through HTTP proxies—essential in corporate or restricted networks:

**TCP (HTTP CONNECT tunnel):**

```csharp
using System.Net;
using HiveMQtt.Client;

var options = new HiveMQClientOptionsBuilder()
    .WithBroker("broker.example.com")
    .WithPort(1883)
    .WithProxy(new WebProxy("http://proxy.example.com:8080"))
    .Build();

var client = new HiveMQClient(options);
await client.ConnectAsync();
```

**WebSocket:** Use `WithWebSocketProxy(new WebProxy("http://proxy.example.com:8080"))` with `WithWebSocketServer(...)`. Both support proxy credentials. Full details: [Configure a Proxy Server](https://hivemq.github.io/hivemq-mqtt-client-dotnet/docs/how-to/configure-proxy).

---

For a Quickstart, more examples and walkthroughs, see [the documentation](https://hivemq.github.io/hivemq-mqtt-client-dotnet/docs/quickstart).

## Other MQTT Clients

* [Java](https://github.com/hivemq/hivemq-mqtt-client)
* [Javascript](https://github.com/hivemq/hivemq-mqtt-web-client)

For a list of all known MQTT clients, see [MQTT.org](https://mqtt.org/software/).

## 🛡 License

[![License](https://img.shields.io/github/license/hivemq/hivemq-mqtt-client-dotnet)](https://github.com/hivemq/hivemq-mqtt-client-dotnet/blob/main/LICENSE)

This project is licensed under the terms of the `Apache Software License 2.0` license. See [LICENSE](https://github.com/hivemq/hivemq-mqtt-client-dotnet/blob/main/LICENSE) for more details.

## 📃 Citation

```bibtex
@misc{hivemq-mqtt-client-dotnet,
  author = {HiveMQ GmbH},
  title = {The HiveMQ C# MQTT client for .NET},
  year = {2026},
  publisher = {GitHub},
  journal = {GitHub repository},
  howpublished = {\url{https://github.com/hivemq/hivemq-mqtt-client-dotnet}}
}
```