python websocket 参数

websocket中就有建立连接connect、发送消息send等函数可供使用，但是websocket.WebSocketApp将这些都封装好了，只用在实例化的时候传入自定义函数即可，更方便。因此这里选择使用websocket.WebSocketApp来模拟客户行为。

WebSocketApp也是websocket中的一个类。要使用WebSocketApp中的回调函数需要传入一系列的可调用对象。在实例化该类时传入构造函数中的on_open、on_message、on_error就需要传入一系列的可调用对象，例如自定义的函数。

以下是websocket.WebSocketApp类中的构造函数的摘录，简单介绍一下各个传入值的说明。

def init(self, url, header=[],

on_open=None, on_message=None, on_error=None,

on_close=None, on_ping=None, on_pong=None,

on_cont_message=None,

keep_running=True,get_mask_key=None, cookie=None,

subprotocols=None,

on_data=None)

　　

（1）url: websocket的地址。

（2）header: 客户发送websocket握手请求的请求头，{‘head1:value1’,‘head2:value2’}。

（3）on_open：在建立Websocket握手时调用的可调用对象，这个方法只有一个参数，就是该类本身。

（4）on_message：这个对象在接收到服务器返回的消息时调用。有两个参数，一个是该类本身，一个是我们从服务器获取的字符串（utf-8格式）。

（5）on_error：这个对象在遇到错误时调用，有两个参数，第一个是该类本身，第二个是异常对象。

（6）on_close：在遇到连接关闭的情况时调用，参数只有一个，就是该类本身。

（7）on_cont_message：这个对象在接收到连续帧数据时被调用，有三个参数，分别是：类本身，从服务器接受的字符串（utf-8），连续标志。

（8）on_data：当从服务器接收到消息时被调用，有四个参数，分别是：该类本身，接收到的字符串（utf-8），数据类型，连续标志。

（9）keep_running：一个二进制的标志位，如果为True，这个app的主循环将持续运行，默认值为True。

（10）get_mask_key：用于产生一个掩码。

（11）subprotocols：一组可用的子协议，默认为空。

 

除此之外，还有on_ping，on_pong等，详细内容可以查看源代码。

另外说明一下该类中的一个方法叫run_forever()。Run_forever是一个无限循环，只要这个websocket连接未断开，这个循环就会一直进行下去。如果在实现websocket连接时使用了心跳包，可以在这个函数中传入心跳包的间隔，格式如下：

ws.run_forever(ping_interval=SOCKET_PING_INTERVAL,timeout=SOCKET_TIMEOUT)