Skip to content

STOMPゲートウェイ ​

EMQX STOMPゲートウェイは、STOMPとMQTTプロトコル間のギャップを埋めるメッセージングプロトコルトランスレーターであり、これらのプロトコルを使用するクライアント同士の通信を可能にします。

このSTOMPゲートウェイは、クライアントとサーバーに対して軽量でシンプルなメッセージングソリューションを提供し、多様なメッセージング環境でのメッセージ交換を実現します。TCPおよびSSLタイプのリスナーをサポートしており、柔軟かつ多用途なメッセージングシステム構築ツールです。

TIP

STOMPゲートウェイはStomp v1.2をベースとしており、STOMP v1.0およびv1.1仕様と互換性があります。

STOMPゲートウェイの有効化 ​

EMQX 5では、STOMPゲートウェイはダッシュボード、REST API、および設定ファイル base.hocon を通じて設定および有効化できます。本節では、ダッシュボードによる設定例を用いて操作手順を説明します。

EMQXダッシュボードの左側ナビゲーションメニューで Management -> Gateways をクリックします。Gateways ページにはサポートされているすべてのゲートウェイが一覧表示されます。STOMP を見つけ、Actions 列の Setup をクリックすると、Initialize STOMP ページに遷移します。

TIP

EMQXをクラスターで運用している場合、ダッシュボードやREST APIで行った設定はクラスター全体に影響します。特定のノードのみ設定を変更したい場合は、base.hoconで設定してください。

設定を簡略化するため、EMQXはGatewaysページのすべての必須フィールドにデフォルト値を提供しています。大幅なカスタマイズが不要な場合、STOMPゲートウェイは3クリックで有効化できます。

  1. Basic Configuration タブで Next をクリックし、すべてのデフォルト設定を受け入れます。
  2. 次に Listeners タブに遷移し、EMQXはポート 61613 のUDPリスナーを事前設定しています。再度 Next をクリックして設定を確認します。
  3. 最後に Enable ボタンをクリックしてSTOMPゲートウェイを有効化します。

ゲートウェイの有効化が完了すると、Gateways ページに戻り、STOMPゲートウェイのステータスが Enabled と表示されていることを確認できます。

STOMPゲートウェイが有効化された状態

EMQX 5.0では、ダッシュボードを通じてStompゲートウェイの設定および有効化が可能です。

上記の設定はREST APIでも行えます。

例:

bash
curl -X 'PUT' 'http://127.0.0.1:18083/api/v5/gateways/stomp' \
  -u <your-application-key>:<your-security-key> \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "stomp",
  "enable": true,
  "mountpoint": "stomp/",
  "listeners": [
    {
      "type": "tcp",
      "name": "default",
      "bind": "61613",
      "max_conn_rate": 1000,
      "max_connections": 1024000
    }
  ]
}'

STOMPクライアントとの連携 ​

クライアントライブラリ ​

STOMPゲートウェイを構築した後、stomp.pyなどのSTOMPクライアントツールを使用して接続をテストし、正常に動作することを確認できます。

パブリッシュ/サブスクライブ ​

STOMPプロトコルはPUB/SUBメッセージングモデルと完全に互換性があり、STOMPゲートウェイは以下を使用します。

  • STOMPプロトコルの SEND メッセージをメッセージのパブリッシュに使用します。SEND メッセージの destination フィールドがトピックを指定し、メッセージ内容は SEND メッセージのボディに含まれます。QoS(サービス品質)は固定で0です。
  • STOMPプロトコルの SUBSCRIBE メッセージをサブスクライブ要求に使用します。SUBSCRIBE メッセージの destination フィールドがトピックを指定します。QoSは固定で0であり、MQTTプロトコルで定義されるワイルドカードをサポートします。
  • STOMPプロトコルの UNSUBSCRIBE メッセージをサブスクライブ解除要求に使用します。SUBSCRIBE メッセージの destination フィールドがトピックを指定します。

STOMPゲートウェイのカスタマイズ ​

デフォルト設定に加え、EMQXはさまざまな設定オプションを提供し、特定のビジネス要件により適合させることができます。本節では、Gateways ページで利用可能な各種フィールドについて詳述します。

基本設定 ​

Basic Configuration タブでは、許容される最大ヘッダー数、ヘッダー長の最大値、統計収集の有効化、ゲートウェイのMountPoint文字列設定が可能です。以下に各フィールドの詳細を示します。

  1. Max Header: 許容されるSTOMPヘッダーの最大数を設定します。デフォルトは 10 です。

  2. Max Each Header Length: STOMPヘッダー名と値の合計長の最大値をバイト単位で設定します。デフォルトは 1024 バイトです。

  3. Max Body Length: STOMPフレームのボディの最大サイズをバイト単位で設定します。デフォルトは 65536 バイトです。

  4. Idle Timeout: 非アクティブ状態が続いた場合に接続を切断するまでの最大待機時間(秒)を設定します。

  5. Enable Statistics: ゲートウェイによる統計収集と報告を許可するかどうかを設定します。デフォルトは true、選択肢は true または false です。

  6. MountPoint: パブリッシュやサブスクライブ時にすべてのトピックの先頭に付加される文字列を設定します。これにより異なるプロトコル間でのメッセージルーティングの分離を実現できます。例: stomp/。

    注意: このトピックプレフィックスはゲートウェイによって管理され、クライアントはパブリッシュやサブスクライブ時に明示的にこのプレフィックスを追加する必要はありません。

STOMPトランザクションの制限 6.0.5+ ​

gateway.stomp.transaction を使用して、各STOMP接続が保持するトランザクション状態を制限できます。トランザクション設定が省略された場合、EMQXは以下のデフォルト値を適用します。

オプションデフォルト説明
max_transactions1001接続あたり同時に開けるトランザクションの最大数。
max_actions_per_transaction10001トランザクション内でバッファリング可能な SEND、ACK、NACK フレームの最大数。
max_retained_bytes16777216 バイト1接続あたりすべての開いているトランザクションが保持する合計バイト数の最大値。
timeout60s開いているトランザクションが期限切れとなりEMQXが破棄するまでの時間。0より大きい値である必要があります。

設定されたトランザクション数、バッファリングフレーム数、または保持バイト数の制限を超えた場合、EMQXはSTOMPの ERROR フレームを送信し、接続を切断します。

リスナーの追加 ​

ポート 61613 で名前が default のtcpリスナーがすでに設定されており、プール内の最大アクセプター数は16、最大同時接続数は1,024,000です。より詳細な設定を行う場合は Settings をクリックし、リスナーを削除する場合は Delete をクリック、新しいリスナーを追加する場合は + Add Listener をクリックします。

TIP

STOMPゲートウェイはTCPおよびSSLタイプのリスナーのみサポートしています。

Add Listener をクリックすると Add Listener ページが開き、以下の設定が可能です。

基本設定

  • Name: リスナーの一意識別子を設定します。
  • Type: プロトコルタイプを選択します。STOMPの場合は tcp または ssl のいずれかです。
  • Bind: リスナーが接続を受け付けるポート番号を設定します。
  • MountPoint(任意): パブリッシュやサブスクライブ時にすべてのトピックの先頭に付加される文字列を設定し、異なるプロトコル間でのメッセージルーティング分離を実現します。

リスナー設定

  • Acceptor: アクセプタープールのサイズを設定します。デフォルトは 16 です。
  • Max Connections: リスナーが処理可能な最大同時接続数を設定します。デフォルトは 1024000 です。
  • Max Connection Rate: 1秒あたりにリスナーが受け入れ可能な新規接続の最大レートを設定します。デフォルトは 1000 です。
  • Proxy Protocol: EMQXがロードバランサーの背後にある場合、プロトコルV1/V2を有効にします。
  • Proxy Protocol Timeout: プロキシプロトコルパッケージを待機する最大時間(秒)を設定し、非アクティブ時に接続を切断します。デフォルトは 3秒 です。

TCP設定

  • ActiveN: ソケットの {active, N} オプションを設定します。これはソケットが積極的に処理可能な受信パケット数を意味します。詳細はErlangドキュメント - setopts/2を参照してください。
  • Buffer: 受信および送信パケットを格納するバッファのサイズをKB単位で設定します。
  • TCP_NODELAY: 接続に対して TCP_NODELAY フラグを有効にするかどうかを設定します。これはクライアントが前回のデータのアックを待たずに追加データを送信できるかどうかを意味します。デフォルトは false、選択肢は true または false です。
  • SO_REUSEADDR: ポート番号のローカル再利用を許可するかどうかを設定します。
  • Send Timeout: プロキシプロトコルパッケージを待機する最大時間(秒)を設定し、非アクティブ時に接続を切断します。デフォルトは 15秒 です。
  • Send Timeout: 送信タイムアウト時に接続を切断するかどうかを設定します。

SSL設定(SSLリスナーのみ)

TLS検証を有効にするかどうかをトグルスイッチで設定できます。ただし、その前に関連する TLS Cert、TLS Key、および CA Cert の情報を、ファイルの内容を入力するか、Select File ボタンでアップロードして設定する必要があります。詳細はSSL/TLS接続の有効化を参照してください。

その後、以下の設定を続けられます。

  • SSL Versions: サポートするSSLバージョンを設定します。デフォルトは tlsv1.3、tlsv1.2、tlsv1.1、および tlsv1 です。
  • Fail If No Peer Cert: クライアントが空の証明書を送信した場合にEMQXが接続を拒否するかどうかを設定します。デフォルトは false、選択肢は true または false です。
  • Intermediate Certificate Depth: ピア証明書に続く有効な認証パスに含まれる自己発行でない中間証明書の最大数を設定します。デフォルトは 10 です。
  • Key Password: プライベートキーがパスワード保護されている場合に使用するユーザーパスワードを設定します。

認証の設定 ​

STOMPプロトコルの接続メッセージにはユーザー名とパスワードの概念がすでに定義されているため、STOMPは以下のような多様な認証方式をサポートしています。

STOMPゲートウェイはSTOMPプロトコルの CONNECT または STOMP メッセージ内の情報を使用してクライアントの認証フィールドを生成します。

  • クライアントID: ランダム生成された文字列
  • ユーザー名: CONNECT または STOMP メッセージヘッダーの login フィールドの値
  • パスワード: CONNECT または STOMP メッセージヘッダーの passcode フィールドの値

REST APIを使用してStompゲートウェイ用の組み込みデータベース認証を作成することも可能です。

例:

bash
curl -X 'POST' \
  'http://127.0.0.1:18083/api/v5/gateway/stomp/authentication' \
  -u <your-application-key>:<your-security-key> \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "backend": "built_in_database",
  "mechanism": "password_based",
  "password_hash_algorithm": {
    "name": "sha256",
    "salt_position": "suffix"
  },
  "user_id_type": "username"
}'

TIP

MQTTプロトコルとは異なり、ゲートウェイは認証器の作成のみをサポートし、認証器のリスト(または認証チェーン)はサポートしません。

認証器が有効化されていない場合、すべてのSTOMPクライアントはログインが許可されます。