WebSockets

Enabled: Indicates that the WebSocket Cluster uses authentication and authorization. The WebSocket client applications must authenticate to the WebSocket server with username and password credentials.

Disabled: Authentication and authorization security is not required for this WebSocket Cluster’s clients.

Running: The WebSocket server is running and its local realm definition is up to date: that is, it is the latest deployment.

Offline: The WebSocket server is not running, and the FTL server does not have any data about it.

Needs Restart: The server is running, but it cannot accept a proposed deployment. To accept the deployment, you must restart the service.

Timed Out: The FTL server has lost the WebSocket server's heartbeat signal. Either the WebSocket server has stopped, or a network segmentation obstructs the heartbeat signal.

Exception: The WebSocket server is running, but its realm definition is out-of-date. The deployment caused an error in the WebSocket server, so the service continues to use its old realm definition.

Restarting the WebSocket server might not be sufficient to resolve the issue. For example, the deployment specifies a new TCP transport, but the port is already bound.

Out-of-Sync: The WebSocket server's realm definition is a different revision than the FTL server's.

Limits the number of clients that each server in the WebSocket cluster can support simultaneously.

Zero indicates no limit.

Required for EMS Channels. The WebSocket server connects to the EMS server at this URL.

For fault tolerance, supply a comma-separated list of URLs: first the primary EMS server, then the backup server

Optional. Associates a persistence store with an FTL Channel.

To prevent crosstalk, use unique stores: that is, ensure that no two channels use the same store.

Optional. When WebSocket clients create dynamic durable subscriptions on the channel without specifying a durable type, they use this template.

It is a good practice to avoid confusion by configuring a standard durable template as the default.

You can associate at most one default dynamic durable template with each channel. The dropdown offers the templates defined in the persistence store associated with the channel.

Optional. When present, the channel converts messages from WebSocket clients into this exchange format as it forwards them to FTL clients. Select a format name from the dropdown menu of formats defined for the FTL server.

When absent, the channel converts messages from WebSocket clients into self-describing dynamic-format messages as it forwards them to FTL clients.

Optional. When WebSocket clients create shared durable subscriptions on the channel, they use this template.

You can associate at most one shared durable template with each channel. The dropdown offers the templates defined in the persistence store associated with the channel.

Optional. When WebSocket clients create last-value durable subscriptions on the channel, they use this template.

You can associate at most one last-value durable template with each channel. The dropdown offers the templates defined in the persistence store associated with the channel.

Optional. When WebSocket clients create map durable subscriptions on the channel, they use this template.

You can associate at most one map template with each channel. The dropdown offers the templates defined in the persistence store associated with the channel.

Optional. If you configure a persistence store for a channel, then you can configure a mapping from durable names (in subscribe calls) to static durable names (defined in the store).

For the semantics of durable subscriptions, see Persistence in TIBCO FTL® - Enterprise EditionDevelopment.

Limit on the number of WebSocket client message queues.

This can be used to conserve memory in the WebSocket server. For background and complete details, see Maximum Queue Size in TIBCO eFTL™ - Enterprise Edition Administration.

When the backlog of unacknowledged messages outbound to a WebSocket client on the channel exceeds this limit, the service stops transferring messages to the client. When the service receives acknowledgments, it resumes sending messages to the client.

The TIBCO WebSocket server sends heartbeats at this interval to clients on the channel. Clients respond to heartbeats, indicating that they are still connected.

Zero prevents the service from sending heartbeats. If you set this parameter to zero, you must also set 'client timeout' to zero.

The TIBCO WebSocket server disconnects a client after this interval since the last communication from the client, including heartbeat responses and message publishing calls.

Zero instructs the service not to disconnect clients.

Optional. Channels isolate message streams; however, the EMS server merges message streams that share a topic name. A topic prefix can prevent crosstalk among channels through the EMS server if you supply a distinct prefix string for each EMS channel.

If present, the channel prepends this prefix string to EMS topic names at each publish and subscribe operation. Topic prefix strings are transparent to WebSocket client applications. EMS administrators must explicitly allow these prefix strings in topic names.

If absent, separate channels could carry crosstalk.