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

WebSocket

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

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

Методы​

isClosed​

Добавлено до v1.9 webSocket.isClosed

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

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

WebSocket.isClosed();

Возвращает

url​

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

Содержит URL WebSocket.

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

WebSocket.url();

Возвращает

waitForFrameReceived​

Добавлено в: v1.10 webSocket.waitForFrameReceived

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

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

WebSocket.waitForFrameReceived(callback);
WebSocket.waitForFrameReceived(callback, options);

Аргументы

  • options WebSocket.WaitForFrameReceivedOptions (опционально)

    • setPredicate Predicate<WebSocketFrame> (опционально) Добавлено в: v1.9#

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

    • setTimeout double (опционально) Добавлено в: v1.9#

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

  • callback Runnable Добавлено в: v1.9#

    Обратный вызов, который выполняет действие, вызывающее событие.

Возвращает

waitForFrameSent​

Добавлено в: v1.10 webSocket.waitForFrameSent

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

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

WebSocket.waitForFrameSent(callback);
WebSocket.waitForFrameSent(callback, options);

Аргументы

  • options WebSocket.WaitForFrameSentOptions (опционально)

    • setPredicate Predicate<WebSocketFrame> (опционально) Добавлено в: v1.9#

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

    • setTimeout double (опционально) Добавлено в: v1.9#

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

  • callback Runnable Добавлено в: v1.9#

    Обратный вызов, который выполняет действие, вызывающее событие.

Возвращает

События​

onClose(handler)​

Добавлено до v1.9 webSocket.onClose(handler)

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

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

WebSocket.onClose(handler)

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

onFrameReceived(handler)​

Добавлено в: v1.9 webSocket.onFrameReceived(handler)

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

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

WebSocket.onFrameReceived(handler)

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

onFrameSent(handler)​

Добавлено в: v1.9 webSocket.onFrameSent(handler)

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

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

WebSocket.onFrameSent(handler)

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

onSocketError(handler)​

Добавлено в: v1.9 webSocket.onSocketError(handler)

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

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

WebSocket.onSocketError(handler)

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