WebSocket

WebSocket类提供了对于WebSocket通讯的操作支持,该类的实例无需手工创建,在路由处理器中会自动获得相应的实例。WebSocket类实例提供了与Request类实例相似的内容,可以用于访问WebSocket通讯的请求内容。

但是WebSocket与普通HTTP请求和响应不同的是,WebSocket是双向实时通讯的,所以WebSocket类提供了一系列的异步方法来支持通讯功能。

  • websocket.accept(),建立WebSocket连接。
  • websocket.send_text(data),发送纯文本数据。
  • websocket.send_bytes(data),发送字节数组数据。
  • websocket.send_json(data),发送JSON格式数据。
  • websocket.receive_text(),接受纯文本数据。所有接受数据的方法可能会抛出starlette.websockets.Disconnect()异常。
  • websocket.receive_bytes(),接受字节数组数据。
  • websocket.receive_json(),接受JSON格式数据。
  • websocket.close(),关闭WebSocket连接。