nonebot2/website/versioned_docs/version-2.3.0/api/drivers/websockets.md
noneflow[bot] a9a86aba61 🔖 Release 2.3.0
2024-05-01 09:01:32 +00:00

1.9 KiB

sidebar_position description
4 nonebot.drivers.websockets 模块

nonebot.drivers.websockets

websockets 驱动适配

nb driver install websockets
# 或者
pip install nonebot2[websockets]

:::tip 提示 本驱动仅支持客户端 WebSocket 连接 :::

def catch_closed(func)

  • 参数

    • func ((P) -> Coroutine[Any, Any, T])
  • 返回

    • (P) -> Coroutine[Any, Any, T]

class Mixin(<auto>)

  • 说明: Websockets Mixin

  • 参数

    auto

method websocket(setup)

class WebSocket(*, request, websocket)

  • 说明: Websockets WebSocket Wrapper

  • 参数

    • request (Request)

    • websocket (WebSocketClientProtocol)

async method accept()

  • 参数

    empty

  • 返回

    • untyped

async method close(code=1000, reason="")

  • 参数

    • code (int)

    • reason (str)

  • 返回

    • untyped

async method receive()

  • 参数

    empty

  • 返回

    • str | bytes

async method receive_text()

  • 参数

    empty

  • 返回

    • str

async method receive_bytes()

  • 参数

    empty

  • 返回

    • bytes

async method send_text(data)

  • 参数

    • data (str)
  • 返回

    • None

async method send_bytes(data)

  • 参数

    • data (bytes)
  • 返回

    • None

class Driver(env, config)