socket

Константы

EVENT_CONNECT : string = connect

EVENT_CONNECTING : string = connecting

EVENT_CONNECT_ERROR : string = connect_error

EVENT_CONNECT_TIMEOUT : string = connect_timeout

EVENT_DISCONNECT : string = disconnect

EVENT_ERROR : string = error

EVENT_MESSAGE : string = message

EVENT_PING : string = ping

EVENT_PONG : string = pong

EVENT_RECONNECT : string = reconnect

EVENT_RECONNECTING : string = reconnecting

EVENT_RECONNECT_ATTEMPT : string = reconnect_attempt

EVENT_RECONNECT_ERROR : string = reconnect_error

EVENT_RECONNECT_FAILED : string = reconnect_failed

Функции

newSocket(url, options = {}) — создаёт новый SocketValue

options (map с ключами):

  • forceNew (boolean)
  • multiplex (boolean)
  • reconnection (boolean)
  • rememberUpgrade (boolean)
  • secure (boolean)
  • timestampRequests (boolean)
  • upgrade (boolean)
  • policyPort (integer)
  • port (integer)
  • reconnectionAttempts (integer)
  • reconnectionDelay (timestamp - long)
  • reconnectionDelayMax (timestamp - long)
  • timeout (timestamp - long) - -1 для отключения
  • randomizationFactor (double)
  • host (string)
  • hostname (string)
  • path (string)
  • query (string)
  • timestampParam (string)
  • transports (array of strings)

Типы

SocketValue

Функции

close() — закрывает соединение сокета

connect() — подключает сокет

connected() — возвращает состояние подключения (1 - подключен, 0 - нет)

disconnect() — закрывает соединение сокета

emit(event, data) — посылает событие

hasListeners(event) — возвращает true, если для указанного события есть обработчики

id() — возвращает id сокета

off(event = ..) — удаляет обработчик указанного события или удаляет все обработчики, если не было передано ни одного аргумента

on(event, listener) — добавляет обработчик указанного события

once(event, listener) — добавляет одноразовый обработчик указанного события

open() — подключает сокет

send(data) — отправляет сообщения