websocket-clientの実装方法について

Question

websocket通信のクライアント側の実装に
websocket-clientを使いたいのですが、よく出てくるサンプルコードに不明な点があるため質問させて頂きました。

下記サンプルコードですが
•スレッドを作成する意味はなんでしょうか？
•受けとったメッセージは画面表示していますが、通信以降の処理に使うにはどう変数をとりまわしたらいいでしょうか？

import websocket
try:
    import thread
except ImportError:
    import _thread as thread
import time

def on_message(ws, message):
    print(message)

def on_error(ws, error):
    print(error)

def on_close(ws):
    print("### closed ###")

def on_open(ws):
    def run(*args):
        for i in range(3):
            time.sleep(1)
            ws.send("Hello %d" % i)
        time.sleep(1)
        ws.close()
        print("thread terminating...")
    thread.start_new_thread(run, ())


if __name__ == "__main__":
    websocket.enableTrace(True)
    ws = websocket.WebSocketApp("ws://echo.websocket.org/",
                              on_message = on_message,
                              on_error = on_error,
                              on_close = on_close)
    ws.on_open = on_open
    ws.run_forever()

Answer 1

websocket-clientを使いたいのですが、よく出てくるサンプルコードに不明な点があるため質問させて頂きました。

もとになっているのは公式サンプルwebsocket-client/examples/echoapp_client.pyのようです。
ソースを読んだ限りだと、このサンプルでは送受信処理をrun_forever内で生成したスレッドのループで回しています。
よって外部から送信するためには別スレッドで送信(ws.send)を呼び出してやる必要があります。
ちなみにwebsocket-client/examples/echo_client.pyのほうではスレッドを使わない方法が示されています。

受けとったメッセージは画面表示していますが、通信以降の処理に使うにはどう変数をとりまわしたらいいでしょうか？

グローバルスコープに変数を用意しておき、on_messageでその変数に代入して取り廻すのがてっとり早いかと思います。あるいはWebSocketAppクラスを継承してメンバ変数に入れるのでもよいです。

Comments

[nt914]

処理の流れはわかるのですが、わざわざスレッドを立てて、そのスレッドで送信等の処理を行う理由は何でしょうか？
公式で上記コードはLong-lived connectionと、スレッドを立てない方法はShort-lived one-off send-receiveと紹介されているため、複数送受信するためにはスレッドを立てる必要があると思いきや、close()をしない限りスレッドを立てない方法でも複数送受信できるので違いがわかりませんでした。

[can110]

以下は実際に動かして試してはいないので想像で書きますが…

たしかに単純に送信→受信の順番で複数メッセージが流れるだけならShort-livedの単純ループでもできそうですね。
しかしLong-lived(スレッド)版だと、こちらがinput()なりで送信データを準備するために待ち受けている最中にも相手からのメッセージが送られてきた場合、on_messageでデータ受信ができると思われます。
すなわち複数回送受信だけではない使い道もあると考えます。
そういったサンプルコードもあるとよいのですが。