パラメータ名 |
説明 |
デフォルト値 |
connection <name> |
リモートブローカのクライアントIDとして使用される名前を指定。 クライアントIDは"name.hostname"の形式になる。 HostnameはこのPCのホスト名になる。 |
なし |
address <host>[:<port>] |
接続先のホストのアドレスとブリッジに使用するポートを指定。 接続は複数設定することが可能。 |
portのデフォルトは1883。 |
bridge_attempt_unsubscribe [ true | false ] |
trueの場合、リモートブローカーにサブスクライブ解除要求を送信する。 |
true |
bridge_protocol_version <version> |
このブリッジで使用するMQTTプロトコルのバージョンを設定する。 mqttv31またはmqttv311のいずれかになる。 |
mqttv31 |
cleansession [ true | false ] |
trueの場合、リモートブローカ上のサブスクライブとメッセージは、接続が切断されるとクリーンアップされる。 デフォルト値はfalse。 |
false |
keepalive_interval <seconds> |
キープアライブの間隔を指定する。 |
60 |
idle_timeout <seconds> |
"start type"が"lazy"を使用しているブリッジがアイドル状態になってから停止するまでの時間を指定する。 |
60 |
local_clientid <id> |
ローカルブローカー上で使用するクライアントIDを指定する。 |
local |
local_password <password> |
ローカルブローカーに接続する際のパスワードを指定する。 |
なし |
local_username <username> |
ローカルブローカーに接続する際のユーザ名を指定する。 |
なし |
notifications [ true | false ] |
ブリッジ接続状態を通知する設定。 Trueの場合、ローカルおよびリモートのブローカーに指定されたトピックでブリッジ接続の接続状態を通知する。 メッセージが1の場合、接続がアクティブで、0の場合は接続できていなことを示す。 |
true |
notification_topic <topic> |
ブリッジの接続状態を通知するトピックを指定する。 |
"sys$/broker/ connection /<clientid>/state" |
remote_clientid <id> |
リモートブローカのクライアントIDを指定。 |
クライアントidは"name.hostname"の形式になる。 hostnameはこのpcのホスト名になる。 |
remote_password <value> |
ブリッジ接続する際のパスワードを指定。 |
なし |
remote_username <name> |
ブリッジ接続する際のユーザ名を指定。 |
なし |
restart_timeout <value> |
"start type"が"automatic" を使用しているブリッジが再接続を試みるまで待機する時間を設定する。 |
30 |
round_robin [ true | false ] |
"address"で複数のアドレスが指定されていた場合のブリッジ接続失敗時の動作を指定。 Falseなら最初のアドレスがメインブリッジ接続として、扱われる。 メインブリッジの接続に失敗すると、他のセカンダリアドレスへのブリッジ接続を順次試行する。 セカンダリブリッジに接続されいる間、ブリッジは正常に終了するまで、定期的にメインブリッジに再接続を試みる。 Trueの場合、すべてのアドレスが同等に扱われる。 接続に失敗すると、次のアドレスへの接続を試行し、成功した場合は失敗するまでは対象のアドレスへの接続を維持する。 |
false |
start_type [ automatic | lazy | once ] |
ブリッジの開始タイプを指定する。 ・ automatic ブローカの起動時にブリッジ接続が自動的に開始され、 接続が失敗した場合は短い遅延（30秒）後に再接続を行う。 ・ lazy キューに入れられたメッセージの数が"threshold "オプションで、 設定された数を超えると自動的に接続を開始する。 ・ once ブローカーの起動時に自動的に接続する、接続が失敗した場合には再接続しない。 |
automatic |
threshold <count> |
"start type"が"lazy"を使用しているブリッジを接続を開始する際の、キューのメッセージの数の閾値を設定する。 |
10 |
topic <pattern> [[[ out | in | both ] qos-level] local-prefix remote-prefix] |
2つのブローカー間で共有されるトピックのパターンを定義する。 ● pattern 共有するトピックのパターン文字列を指定する。 ● [ out | in | both ] メッセージを共有する際の方向を示す。 ・ out : ローカルブローカーからリモートブローカーにメッセージをエクスポートする ・ in : リモートブローカーからローカルブローカーにメッセージをインポートする ・ both : ローカルブローカーとリモートブローカーでメッセージを双方向で共有する ● qos-level 対象のトピックのQoSのレベル ● local-prefix ローカルブローカーで扱うローカー間の共有トピックの"pattern"の前につく先頭文字列。 ※ "pattern"が"A", "local-prefix" "/a/b/c/" の場合、共有するトピックは、"/a/b/c/A"となる。 ● remote-prefix リモートブローカーで扱うローカー間の共有トピックの"pattern"の前につく先頭文字列。 ※ "pattern"が"A", "remote-prefix" "/a/b/c/" の場合、共有するトピックは、"/a/b/c/A"となる。 |
なし |
try_private [ true | false ] |
trueの場合、ブリッジは、通常のクライアントではなくブリッジであることをリモートブローカに示すように試みる。 |
true |