Spec-Zone.ru › Hammerspoon

hs.websocket

Простой websocket-клиент.

Обзор API

  • Функции — API-вызовы, предоставляемые непосредственно расширением
    • new
  • Методы — API-вызовы, которые можно выполнить только на объекте, возвращенном конструктором
    • close
    • send
    • status

Документация API

Функции

new
Подпись hs.websocket.new(url, callback) -> object
Тип Функция
Описание

Создаёт новое websocket-соединение.

Параметры
  • url — URL вебсокет-соединения
  • callback — функция, которая срабатывает при действиях вебсокет-соединения.
Возвращаемое значение
  • Объект hs.websocket
Примечания
  • Функция обратного вызова должна принимать два параметра.
  • Первый параметр — строка с возможными значениями:
    • open — вебсокет-соединение открыто
    • closed — вебсокет-соединение закрыто
    • fail — вебсокет-соединение завершилось ошибкой
    • received — вебсокет получил сообщение
    • pong — получен запрос pong
  • Второй параметр — строка с полученным сообщением или сообщением об ошибке.
  • При заданном пути '/mysock' и порте 8000, URL вебсокет-соединения будет следующим:
    • ws://localhost:8000/mysock
    • wss://localhost:8000/mysock (если включен SSL)
Источник extensions/websocket/libwebsocket.m строка 120

Методы

close
Подпись hs.websocket:close() -> object
Тип Метод
Описание

Закрывает вебсокет-соединение.

Параметры
  • Нет
Возвращаемое значение
  • Объект hs.websocket
Источник extensions/websocket/libwebsocket.m строка 230
send
Подпись hs.websocket:send(message[, isData]) -> object
Тип Метод
Описание

Отправляет сообщение вебсокет-клиенту.

Параметры
  • message — строка, содержащая отправляемое сообщение.
  • isData — необязательный булевый параметр, отправляет сообщение как двоичные данные (по умолчанию true).
Возвращаемое значение
  • Объект hs.websocket
Примечания
  • Принудительное представление текста, установив isData в false, может изменить данные, если оно

содержит неверные последовательности UTF8 (поведение строк по умолчанию — убедиться, что всё "печать" путём преобразования неверных последовательностей в последовательность Юникод с недопустимым символом).

Источник extensions/websocket/libwebsocket.m строка 164
status
Подпись hs.websocket:status() -> string
Тип Метод
Описание

Получает статус вебсокета.

Параметры
  • Нет
Возвращаемое значение
  • Строка, содержащая одно из следующих значений:
  • connecting
  • open
  • closing
  • closed
  • unknown
Источник extensions/websocket/libwebsocket.m строка 194

© 2014–2017 Hammerspoon contributors
Licensed under the MIT License.
https://www.hammerspoon.org/docs/hs.websocket.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API