MQTT/Subscribeで途中でプログラムが停止する

Question

MQTT通信が途中で止まる

概要

　同じLAN内に設置したmqttサーバ(Broker)にアクセスして複数のトピックスを購読(Subscribe)し、受信したメッセージを(先ずは)画面に表示し、通信が安定してできているかチェックしている状態です。プログラムを実行すると、最初のうちは問題なくデータを表示できているのですが、しばらく経過すると同じエラーで停止します。開発環境を示した後に、Pythonコード、出力されるエラーメッセージ、参考にしたサイトを掲示します。

client.loop_forever()がトラブルの根源なのかと思ったのですが、エラーメッセージの最後を見ると、on_disconnection関数のrcという変数が指定の場所にない、と言われおり、何を修正すれば良いのか判りません。どのように修正すればよいのか教えて下さい。

環境

• Windows10 64bit
• WinPython (Python v=3.8.3)
• module : paho-mqtt のバージョン= 1.5.1

Pythonプログラム(ファイル名は、sub.py)

import paho.mqtt.client as mqtt
import sys

def on_connect(client, userdata, flag, rc):
    if rc == 0:
        print("Connected with Broker")
    else:
        print("Not Connected with rc=",str(rc))
        sys.exit()

    client.subscribe("AAA/BBB/CCC")
    client.subscribe("AAA/BBB/DDD")

def on_message(client, userdata, msg):
    if msg.topic == "AAA/BBB/CCC":
        print("CCC=", str(msg.payload))
    if msg.topic == "AAA/BBB/DDD":
        print("DDD=", str(msg.payload))

def on disconnect(client, userdata, flag, rc):
    if rc == 1:
        print("Connection Refused : incorrect protocol version")
        sys.exit()
    elif rc == 2:
        print("Connection Refused : invalid client identifier")
        sys.exit()
    elif rc == 3:
        print("Connection Refused : Server unavailable")
        sys.exit()
    elif rc == 4:
        print("Connection Refused : bad username or password")
        sys.exit()
    elif rc == 5:
        print("Connection Refused : not authorised")
        sys.exit()
    else:
        print("Currently Unused")
        sys.exit()

client = mqtt.Client()
client.on_connect = on_connect
client.on_message = on_message
client.on_disconnect = on_disconnect
client.connect(host="BROKER_IP_ADDR", port=1883, keepalive=60)
client.loop_forever()

出力されるエラーメッセージ

Traceback (most recent call last):
File sub.py, line xxx, in <module> client.loop_forever()
File ".../python-3.8.6.amd64\lib\site-packages\paho\mqtt\client.py", line 1779, in loop_forever rc = self.loop(timeout, max_packets)
File ".../python-3.8.6.amd64\lib\site-packages\paho\mqtt\client.py", line 1201, in loop return self.loop_misc()
File ".../python-3.8.6.amd64\lib\site-packages\paho\mqtt\client.py", line 1644, in loop_misc self._do_on_disconnect(rc)
File ".../python-3.8.6.amd64\lib\site-packages\paho\mqtt\client.py", line 3360, in _do_on_disconnect self.on_disconnect(self, self._userdata, rc)

TypeError : on_disconnect() missing 1 required positional argument: "rc"

参考にしたサイト

pythonでMQTT送受信

Answer 1

on_disconnect の引数は client, userdata, rc の3つです。flag はありません。

Callbacks より

on_disconnect(client, userdata, rc)

Called when the client disconnects from the broker.

client
    the client instance for this callback
userdata
    the private user data as set in Client() or user_data_set()
rc
    the disconnection result

Comments

[yuki23]

ここでエラーが起きるのは、何か問題があってブローカーとの通信が切断されたということです。
その原因はご質問の情報ではわかりません。ただ、通信切断時のエラー処理の実装が誤っているので、切断の原因を表示する前に強制終了しているということです。

[BuhKeil]

yuki23さま、回答ありがとうございます。
公式のドキュメントで、
https://www.eclipse.org/paho/index.php?page=clients/python/docs/index.php#connect-reconnect-disconnect
ばかりを見ていて、引数がなく、どうしてかとずっと悩んでいました。

探したら指摘して頂いたように、同ドキュメントの後ろの方にありましたね。
on_disconnect(client, userdata, rc)の記述がありました。
positional argumentという意味もやっと分かりました。

ご指摘ありがとうございました。