cfwebsocket

Подключает необходимые файлы JavaScript в шаблон CFM и создает глобальную ссылку JavaScript на объект WebSocket на стороне клиента.

<cfwebsocket name="" onMessage="">

cfwebsocket(name="", onMessage="");

Для этого тега требуется Adobe ColdFusion 10 или более поздняя версия. Не поддерживается в Lucee и т. д.

CF10+

Справочник по атрибутам

name string
Обязательный

onMessage string
Обязательный

Функция JavaScript, вызываемая при получении WebSocket сообщения от сервера.

onOpen string

Функция JavaScript, вызываемая при установлении соединения WebSocket.

onClose string

Функция JavaScript, вызываемая при закрытии соединения WebSocket.

onError string

Функция JavaScript, вызываемая при возникновении ошибки во время выполнения действия через соединение WebSocket.

usecfAuth boolean
По умолчанию: `false`

Если установлено значение true (по умолчанию), пользователям не требуется проходить аутентификацию для подключения по WebSocket (при условии, что они уже вошли в приложение). Это значение используется по умолчанию. Если установлено значение false, пользователи должны указать учетные данные для подключения по WebSocket.

subscribeTo string

Список каналов для подписки, разделенных запятыми. Можно указать любые или все каналы, заданные в настройках приложения this.wschannels.

secure boolean

Если установлено значение true, обмен данными через веб-сокет будет выполняться по SSL. CF 11+

Совместимость

ColdFusion:

Версия 10+ SSL доступен только в CF11 и более поздних версиях

Ссылки дополнительная информация о cfwebsocket

— Слайды и код презентации «Realtime with Websockets» на ColdFusion Summit 2014 и 2015. Включает AdvancedSocket, призванный помочь решать проблемы с подключением на стороне клиента при использовании решения ColdFusion WebSocket. Также содержит готовый набор тестов в папке console, обновленный и оформленный в новом стиле на основе исходного примера Adobe.
HTML5 WebSockets и ColdFusion — Awdhesh Kumar — оригинальная публикация Awdhesh Kumar 2012 года об использовании WebSockets в ColdFusion 10.
Использование WebSocket с ColdFusion 11 — Awdhesh Kumar — продолжение публикации Awdhesh Kumar 2014 года, посвященное улучшениям WebSockets в ColdFusion 11.
Использование WebSocket для трансляции сообщений — Adobe — примеры из документации ColdFusion

Примеры
Пример кода с использованием тега cfwebsocket

Синтаксис скрипта (CF11+)

cfwebsocket(name="ws", onMessage="handleMessage");

Синтаксис тега

В этом примере создается объект JavaScript WebSocket с именем ws. Когда отправляется сообщение, клиент выполняет функцию JavaScript handleMessage. В этом примере также используется атрибут subscribeTo, чтобы автоматически подписаться на канал chat.

<cfwebsocket name="ws" onMessage="handleMessage" subscribeTo="chat" />
<script>
  function handleMessage(message)  {
    // Output message object to console
    console.log(message);
  }
</script>

Подканалы

Подканалы создаются динамически и обозначаются с помощью точечной нотации. При трансляции сообщения в канал все его подканалы также получают это сообщение. Передача выполняется только сверху вниз, но не в обратном направлении. В этом примере мы создаем объект JavaScript с именем ws и подписываемся на подканал room-general основного канала chat.

<cfwebsocket name="ws" onMessage="handleMessage" subscribeTo="chat.room-general" />

© 2012–present Foundeo, Inc. and the CFDocs contributors.
Licensed under the MIT License.
ColdFusion is a trademark of Adobe Systems Incorporated.
https://cfdocs.org/cfwebsocket