Class: WebSocketClientParameters

WebSocketClientParameters(builder)

Configuration parameters for KDC-JS WebSocket clients. Extends ClientParameters with WebSocket-specific settings, including the server URL, synchronous Reply timeout, and registered event handlers. Instances are created using WebSocketClientParametersBuilder. The configuration object is frozen after construction to prevent reassignment of its properties. Note that Object.freeze() is shallow; referenced objects and arrays are not themselves frozen.

Constructor

new WebSocketClientParameters(builder)

Creates WebSocket client parameters from a builder.
Parameters:
Name Type Description
builder WebSocketClientParametersBuilder Builder containing the WebSocket client configuration.

Extends

Classes

WebSocketClientParameters

Members

eventHandlers :Array.<WebSocketClientEventHandlerAdapter>

Registered event handlers notified of WebSocket connection, Agent, and Reply events.
Type:

serverUrl :string

URL of the WebSocket server. Typically uses the ws:// or wss:// scheme.
Type:
  • string

syncReplyTimeout :number

Maximum time to wait for a synchronous Reply, in milliseconds.
Type:
  • number