C# と .NET MQTT 3.1.1 と 5.0

MQTT 3.1.1 と 5.0 に対応した C# MQTT クライアント

この .NET MQTT クライアントで、.NET Framework 2.0 から .NET 10 までの C# アプリを、TCP または WebSocket で任意の MQTT ブローカーに接続できます。

MQTT 3.1.1 と MQTT 5.0
QoS 0、1、2
TCP または WebSocket 上の TLS
Last Will、リテイン、キープアライブ

C# で接続、サブスクライブ、パブリッシュ → · 価格を見る →

C# MQTT クライアント
using esegece.sgcWebSockets;

var client = new TsgcWebSocketClient();
client.Host = "broker.example.com";
client.Port = 8883;
client.TLS = true;
client.Specifications.RFC6455 = false; // MQTT over TCP

var mqtt = new TsgcWSPClient_MQTT();
mqtt.Client = client;
mqtt.MQTTVersion = TwsMQTTVersion.mqtt5;

mqtt.OnMQTTConnect += (conn, session, code, reason, props) =>
    mqtt.Subscribe("sensors/#");
mqtt.OnMQTTPublish += (conn, topic, text, props) =>
    Console.WriteLine(topic + ": " + text);

client.Active = true;

sgcWebSockets クライアントの上で動作する MQTT クライアント

1 つのトランスポートコンポーネント、1 つのプロトコルコンポーネント、MQTT のすべてのパケットに対応するイベント。

sgcWebSockets .NET の C# MQTT クライアントは、esegece.sgcWebSockets 名前空間の TsgcWSPClient_MQTT です。ソケットは自分では開きません。TsgcWebSocketClient を Client プロパティに割り当てると、そのクライアントが MQTT パケットを、プレーンな TCP ストリーム(ポート 1883 と 8883)として、または MQTT over WebSocket のエンドポイントを公開するブローカー向けに WebSocket フレームの中で運びます。ホスト、ポート、TLS、プロキシ、自動再接続はトランスポート側に残り、MQTT のセッション、トピック、QoS はプロトコルコンポーネントが担当します。

ブローカーからの応答はすべて C# のイベントになります:OnMQTTConnect、OnMQTTPublish、OnMQTTSubscribe、OnMQTTPubAck、OnMQTTPubRec、OnMQTTPubComp、OnMQTTPing、OnMQTTDisconnect、さらに MQTT 5.0 の拡張認証用の OnMQTTAuth があります。同じパッケージが、Windows、Linux、macOS 上の .NET Framework 2.0 から 4.8.1、.NET Core 1.0 から 3.1、.NET 5 から .NET 10、.NET Standard 1.6 と 2.0 を対象にしています。

MQTT 3.1.1 と 5.0

MQTTVersion でプロトコルを選択します:TwsMQTTVersion.mqtt311 または TwsMQTTVersion.mqtt5。

TCP または WebSocket

トランスポートで Specifications.RFC6455 = false にすると、生の MQTT を TCP で送信します。オンのままにすると、MQTT を WebSocket のパス経由でトンネリングします。

3 つの QoS レベル

すべてのパブリッシュとサブスクライブで TmqttQoS.mtqsAtMostOnce、mtqsAtLeastOnce、mtqsExactlyOnce を指定できます。

セッション制御

Authentication にユーザー名とパスワード、HeartBeat にキープアライブ ping、LastWillTestament に Last Will を設定します。

C# で接続、サブスクライブ、パブリッシュ

esegece.sgcWebSockets の NuGet パッケージ(または esegece.sgcWebSockets.Community)をインストールし、4 つのステップに従います。

using esegece.sgcWebSockets;

// transport: TCP with TLS on the standard secure MQTT port
var client = new TsgcWebSocketClient();
client.Host = "broker.example.com";
client.Port = 8883;
client.TLS = true;
client.TLSOptions.Version = TwsTLSVersions.tls1_2;
client.Specifications.RFC6455 = false;   // raw MQTT, no WebSocket handshake

// protocol: MQTT 3.1.1 with credentials and keep-alive
var mqtt = new TsgcWSPClient_MQTT();
mqtt.Client = client;
mqtt.MQTTVersion = TwsMQTTVersion.mqtt311;
mqtt.Authentication.Enabled = true;
mqtt.Authentication.UserName = "device-01";
mqtt.Authentication.Password = "secret";
mqtt.HeartBeat.Enabled = true;
mqtt.HeartBeat.Interval = 30;

mqtt.OnMQTTConnect += (conn, session, reasonCode, reasonName, props) =>
    Console.WriteLine("#mqtt connected: " + reasonName);
mqtt.OnMQTTDisconnect += (conn, reasonCode, reasonName, props) =>
    Console.WriteLine("#mqtt disconnected: " + reasonName);

client.Active = true;
// subscribe once the broker has accepted the session
mqtt.OnMQTTConnect += (conn, session, reasonCode, reasonName, props) =>
{
    mqtt.Subscribe("sensors/+/temperature");
    mqtt.Subscribe("alerts/#", TmqttQoS.mtqsExactlyOnce, null);
};

mqtt.OnMQTTSubscribe += (conn, packetId, codes, props) =>
    Console.WriteLine("#subscribed, packet " + packetId);

// every message on a subscribed topic arrives here
mqtt.OnMQTTPublish += (conn, topic, text, props) =>
    Console.WriteLine(topic + " = " + text);

// stop receiving a topic
mqtt.UnSubscribe("alerts/#");
// QoS 0: fire and forget
mqtt.Publish("sensors/room1/temperature", "21.5");

// QoS 1 with the retain flag, so late subscribers get the last value
mqtt.Publish("devices/device-01/status", "online", TmqttQoS.mtqsAtLeastOnce, true);

// QoS 2: wait up to 10 seconds for the broker to confirm
bool ok = mqtt.PublishAndWait("orders/new", "{\"id\": 42}", TmqttQoS.mtqsExactlyOnce, 10000);

// binary payloads
mqtt.Publish("images/cam1", File.ReadAllBytes("frame.jpg"));

// acknowledgements
mqtt.OnMQTTPubAck  += (conn, packetId, reasonCode, reasonName, props) =>
    Console.WriteLine("#puback " + packetId);
mqtt.OnMQTTPubComp += (conn, packetId, reasonCode, reasonName, props) =>
    Console.WriteLine("#pubcomp " + packetId);
using esegece.sgcWebSockets;

// the same MQTT client, tunnelled through a secure WebSocket (wss://)
var client = new TsgcWebSocketClient();
client.Host = "broker.example.com";
client.Port = 443;
client.TLS = true;
client.Options.Parameters = "/mqtt";   // the broker's WebSocket path
client.WatchDog.Enabled = true;          // reconnect after network drops

var mqtt = new TsgcWSPClient_MQTT();
mqtt.Client = client;
mqtt.OnMQTTPublish += (conn, topic, text, props) => Console.WriteLine(topic + ": " + text);

client.Active = true;

.NET ダウンロードに含まれる WinForms デモ MQTT Client と MQTT Console は、同じ呼び出しをフォームに結び付け、ブローカー一覧、TLS とプロキシの設定、QoS とリテインのオプションを備えています。

C# からの MQTT QoS 0、1、2

Publish、PublishAndWait、Subscribe に TmqttQoS の値を渡します。QoS 1 と 2 では、確認応答が時間内に届かない場合、クライアントがメッセージを再送します。配信を追跡するには OnMQTTPubAck または OnMQTTPubComp を処理するか、PublishAndWait を呼び出します。これは、タイムアウト(既定では 10 秒)以内にブローカーから応答がない場合に false を返します。

QoSC# の値配信確認イベント
0TmqttQoS.mtqsAtMostOnce最大 1 回、ベストエフォート、応答なしなし
1TmqttQoS.mtqsAtLeastOnce少なくとも 1 回、ブローカーが確認応答OnMQTTPubAck
2TmqttQoS.mtqsExactlyOnceちょうど 1 回、4 ステップのハンドシェイクOnMQTTPubRec, OnMQTTPubComp

TLS、認証情報、Last Will、キープアライブ

ポート 8883 での TLS

トランスポートで TLS = true を設定し、TLSOptions.Version で TLS 1.3 までのプロトコルを選択します。クライアント証明書を要求するブローカー向けには、TLSOptions に CertFile、KeyFile、Password、RootCertFile も指定でき、VerifyCertificate がサーバー証明書を検証します。

ユーザー名とパスワード

Authentication.Enabled、Authentication.UserName、Authentication.Password は CONNECT パケットに入ります。

Last Will

LastWillTestament は Topic、Text、QoS、Retain を設定するため、デバイスが正常な切断なしに接続を失ったとき、ブローカーが「offline」メッセージをパブリッシュします。

キープアライブ

HeartBeat.Enabled と HeartBeat.Interval は PINGREQ パケットを送信します。OnMQTTPing は各応答を通知し、Ping() は必要に応じて 1 つ送信します。

クライアント ID とクリーンセッション

OnMQTTBeforeConnect は CleanSession と ClientIdentifier を参照渡しするため、永続セッションとデバイスごとの固定クライアント ID を選べます。

プロキシと再接続

トランスポートの Proxy 設定と WatchDog による自動再接続は、MQTT にもそのまま適用されます。

mqtt.LastWillTestament.Enabled = true;
mqtt.LastWillTestament.Topic = "devices/device-01/status";
mqtt.LastWillTestament.Text = "offline";
mqtt.LastWillTestament.QoS = TmqttQoS.mtqsAtLeastOnce;
mqtt.LastWillTestament.Retain = true;

mqtt.OnMQTTBeforeConnect += (TsgcWSConnection conn, ref bool cleanSession, ref string clientId) =>
{
    cleanSession = false;
    clientId = "device-01";
};

C# での MQTT 5.0 機能

MQTTVersion = TwsMQTTVersion.mqtt5 を設定すると、クライアントは MQTT 5.0 で通信します。すべての確認応答イベントが、パケットのプロパティとともにブローカーの ReasonCode と ReasonName を運ぶため、失敗は接続の切断ではなく、理由付きで届きます。

接続プロパティ

ConnectProperties は、SessionExpiryInterval、ReceiveMaximum、MaximumPacketSize、TopicAliasMaximum、UserProperties、応答情報と問題情報のリクエストフラグを設定します。

パブリッシュプロパティ

リクエストとレスポンスのパターン向けに、メッセージごとの ContentType、ResponseTopic、CorrelationData、MessageExpiryInterval、TopicAlias、PayloadFormat とユーザープロパティを設定できます。

拡張認証

Auth() は、AuthenticationMethod と AuthenticationData を持つ AUTH パケットを再認証を含めて送信し、OnMQTTAuth はブローカーのチャレンジを受け取ります。

Will と切断のプロパティ

Last Will の遅延間隔とメッセージの有効期限、さらに Disconnect での理由コード、理由文字列、セッションの有効期限。

mqtt.MQTTVersion = TwsMQTTVersion.mqtt5;
mqtt.ConnectProperties.Enabled = true;
mqtt.ConnectProperties.SessionExpiryInterval = 3600;   // keep the session one hour
mqtt.ConnectProperties.ReceiveMaximum = 100;

mqtt.OnMQTTConnect += (conn, session, reasonCode, reasonName, props) =>
    Console.WriteLine("CONNACK " + reasonCode + " " + reasonName);

標準的な任意の MQTT ブローカー、および AWS IoT と Azure IoT

クライアントは MQTT 3.1.1 と 5.0 の仕様に従うため、自前運用のブローカーでもマネージドのブローカーでも接続できます。プレーン TCP ではポート 1883、TLS では 8883、HTTPS のポートしか開いていない場合はブローカーの WebSocket パスを使います。クラウドの IoT プラットフォーム向けに、sgcWebSockets .NET は AWS IoT Core 用の AWS IoT クライアントと Azure IoT Hub 用の Azure IoT クライアントも提供しており、どちらも MQTT ベースで、.NET 機能マトリックスに掲載されています。

同じライブラリには、AMQP 0.9.1 と 1.0、STOMP、Kafka、C# WebSocket クライアントとサーバーも含まれるため、1 つの依存関係でアプリケーション内のすべてのメッセージングプロトコルをカバーできます。

無料で始められ、すべてのプロトコルが 1 つの価格

MQTT クライアントはすべての .NET エディションに含まれます。Community は、小規模チーム(売上 100 万ユーロ未満、開発者 5 名まで)が商用でも非商用でも無料で利用でき、全機能が使え、起動時に通知が表示されます。Professional では通知がなくなり、開発者あたり €149 から、1 年間のアップデート付きです。Enterprise では、アセンブリを再ビルドするためのソースコードが加わります。Team と Site のライセンスは価格ページ(.NET タブ)にあります。

C# MQTT に関するよくある質問

ブローカーの Host と Port を指定して TsgcWebSocketClient を作成し、プレーン TCP のブローカーには Specifications.RFC6455 = false を設定します。TsgcWSPClient_MQTT を作成して、そのクライアントを Client プロパティに割り当てます。client.Active = true を設定すると接続が開き、ブローカーがセッションを受け入れると OnMQTTConnect が発生します。

はい。MQTT 5.0 には MQTTVersion を TwsMQTTVersion.mqtt5 に、MQTT 3.1.1 には TwsMQTTVersion.mqtt311 に設定します。MQTT 5.0 では、すべての確認応答に理由コードが付き、接続とパブリッシュのプロパティ、ユーザープロパティ、拡張認証が加わります。

Publish(topic, text, TmqttQoS.mtqsAtLeastOnce) または TmqttQoS.mtqsExactlyOnce を、必要に応じてリテインフラグとともに呼び出します。コードがブローカーによるメッセージの処理を確認する必要がある場合は、PublishAndWait を使います。タイムアウト内に応答がない場合は false を返します。

はい。TsgcWebSocketClient に Port = 8883 と TLS = true を設定し、TLSOptions.Version でバージョン(TLS 1.3 まで)を選択します。ブローカーがクライアント証明書を求める場合は、TLSOptions.CertFile と KeyFile を追加します。

はい、これがトランスポートの既定です。Specifications.RFC6455 をオンのままにし、Options.Parameters にブローカーの WebSocket パス(例:/mqtt)を設定し、wss:// 用にポート 443 で TLS = true を使います。これにより、HTTPS のみを許可するファイアウォールを MQTT が通過できます。

Windows、Linux、macOS 上の .NET Framework 2.0 から 4.8.1、.NET Core 1.0 から 3.1、.NET 5 から .NET 10、.NET Standard 1.6 と 2.0。nuget.org から esegece.sgcWebSockets または無料の esegece.sgcWebSockets.Community パッケージをインストールします。

はい。Community エディションには MQTT クライアントが含まれ、小規模チーム(売上 100 万ユーロ未満、開発者 5 名まで)が商用でも非商用でも無料で利用でき、起動時に通知が表示されます。より大きな組織は、開発者あたり €149 からの Professional、または Enterprise をご購入ください。

sgcWebSockets .NET についてさらに詳しく

C# WebSocket ライブラリ

MQTT のトラフィックを運ぶ WebSocket クライアントとサーバー。TLS、圧縮、自動再接続に対応しています。

.NET 機能マトリックス

MQTT、AMQP、STOMP、AWS IoT、Azure IoT を含む、.NET エディションのすべてのコンポーネントとプロトコル。

ダウンロード

Community エディション、NuGet パッケージ、MQTT Client と MQTT Console を含むコンパイル済みの .NET デモ。

Delphi と C++Builder にも対応

同じ MQTT クライアントを、同じ TsgcWSPClient_MQTT クラスとイベントで、Delphi と C++Builder 向けにも提供しています。

最もお得な選択: All-AccesseSeGeCe の全製品にプレミアムサポートが付いて、年間 €1,059 からご利用いただけます。
All-Access の価格を見る

今日、C# から最初の MQTT メッセージをパブリッシュ

体験版をダウンロードするか、NuGet から esegece.sgcWebSockets.Community をインストールしてください。Professional は開発者あたり €149 から。