Config (httpClient-WebsocketConfig)

This component contains configures the web socket.
Figure 12.   Config properties
Image

To access these properties, expand WebsocketClient and double-click Config.

Property Value Description
Outgoing Message Queue Size number (Range 0–max, Defaults 10) Configures a maximum queue size for outgoing messages. This is required to cope with rapid changes of value from the message source.
Incoming Message Queue Size number (Range 0–max, Defaults 10) Configures a maximum queue size for incoming messages. This is required to cope with rapid arrival of messages over the socket.
Connection Attempt Timeout number of milliseconds
Determines how long a station attempts to connect to a server before the attempt fails. This time should not be too short to cause false connection failures, and not so long as to cause excessive delays when a server is down.
Send Message Timeout number of milliseconds Configures the maximum amount of time to await for a message to be sent successfully.
Write on Start true or false
Determines a writable proxy point’s behavior when the station starts.

true initiates a write when the station first reaches a steady state.

false prevents a write when the station first reaches a steady state.

 
NOTE: Consider setting to false except for critical proxy points, otherwise large networks may experience write-queue-overflow exceptions.
 
Write on Enabled true or false
Determines a writable proxy point’s behavior when the point’s status transitions from disabled to normal (enabled).

true initiates a write when the transition occurs.

false prevents a write when the transition occurs.

Frame Buffer Size Bytes number Specifies the maximum size of each individual message frame.
Write Raw Bytes true or false Configures how the WebSocket client sends bytes.

true sends message bytes as raw byte values.

false sends message bytes as a WebSocket text messages.