Перейти к основному содержимому

WebSocket

Класс WebSocket представляет соединения WebSocket на странице. Он предоставляет возможность инспектировать и изменять данные, которые передаются и принимаются.

Если вы хотите перехватывать или изменять фреймы WebSocket, рассмотрите возможность использования WebSocketRoute.

Методы​

expect_event​

Добавлено до версии v1.9 webSocket.expect_event

Ожидает, пока событие не будет вызвано, и передает его значение в функцию-предикат. Возвращает, когда предикат возвращает истинное значение. Выдаст ошибку, если webSocket будет закрыт до вызова события. Возвращает значение данных события.

Использование

web_socket.expect_event(event)
web_socket.expect_event(event, **kwargs)

Аргументы

  • event str#

    Имя события, такое же, как передается в webSocket.on(event).

  • predicate Callable (опционально)#

    Получает данные события и разрешается в истинное значение, когда ожидание должно завершиться.

  • timeout float (опционально)#

    Максимальное время ожидания в миллисекундах. По умолчанию 30000 (30 секунд). Передайте 0, чтобы отключить тайм-аут. Значение по умолчанию можно изменить, используя browser_context.set_default_timeout().

Возвращает

wait_for_event​

Добавлено до версии v1.9 webSocket.wait_for_event
примечание

В большинстве случаев следует использовать web_socket.expect_event().

Ожидает, пока указанное событие не будет вызвано. Если предикат предоставлен, он передает значение события в функцию predicate и ждет, пока predicate(event) не вернет истинное значение. Выдаст ошибку, если сокет будет закрыт до вызова события.

Использование

web_socket.wait_for_event(event)
web_socket.wait_for_event(event, **kwargs)

Аргументы

  • event str#

    Имя события, такое же, как обычно передается в *.on(event).

  • predicate Callable (опционально)#

    Получает данные события и разрешается в истинное значение, когда ожидание должно завершиться.

  • timeout float (опционально)#

    Максимальное время ожидания в миллисекундах. По умолчанию 30000 (30 секунд). Передайте 0, чтобы отключить тайм-аут. Значение по умолчанию можно изменить, используя browser_context.set_default_timeout().

Возвращает

Свойства​

is_closed​

Добавлено до версии v1.9 webSocket.is_closed

Указывает, что веб-сокет был закрыт.

Использование

web_socket.is_closed()

Возвращает

url​

Добавлено до версии v1.9 webSocket.url

Содержит URL WebSocket.

Использование

web_socket.url

Возвращает

События​

on("close")​

Добавлено до версии v1.9 webSocket.on("close")

Вызывается, когда веб-сокет закрывается.

Использование

web_socket.on("close", handler)

Данные события

on("framereceived")​

Добавлено в: v1.9 webSocket.on("framereceived")

Вызывается, когда веб-сокет получает фрейм.

Использование

web_socket.on("framereceived", handler)

Данные события

on("framesent")​

Добавлено в: v1.9 webSocket.on("framesent")

Вызывается, когда веб-сокет отправляет фрейм.

Использование

web_socket.on("framesent", handler)

Данные события

on("socketerror")​

Добавлено в: v1.9 webSocket.on("socketerror")

Вызывается, когда веб-сокет имеет ошибку.

Использование

web_socket.on("socketerror", handler)

Данные события