WebSocket Parameters
Last updated: 04-Dec-2024
This table describes the required parameters used for WebSocket configurations.
Note
The listed parameters have underscore (_) at the end of the name.
| Config.usr1/Parameter DLD Name | Description | Valid/Max Values | Default Value | Name as in PropertiesData.xml |
|---|---|---|---|---|
| WEBSOCKETADDRESS | This parameter is used to set the server address. The address should be either a valid IP address or host name. The local host listen IP address (or host name). | Alphanumeric, 200 | dev-poscloud.vficloud.net | address |
| WEBSOCKETKEEPALIVEENABLED | This parameter is used to enable or disable sending of keep-alive messages on WebSocket. |
|
1 | so_keepalive |
| WEBSOCKETKEEPALIVECNT | This parameter sets the maximum number of keepalive probes, TCP should send before dropping the connection. | Numeric, 4 | 5 | so_keepalive_keepcnt |
| WEBSOCKETKEEPALIVEIDLE | This parameter sets the time (in seconds) the connection needs to remain idle before TCP starts sending keepalive probes. | Numeric, 4 | 45 | so_keepalive_keepidle |
| WEBSOCKETKEEPALIVEINTVL | This parameter sets the duration (in seconds) between two successive keepalive re-transmissions, if acknowledgement to the previous keepalive transmission is not received. | Numeric, 4 | 1 | so_keepalive_keepintvl |
| WEBSOCKETPINGINTERVAL_1 | This parameter is used to set the time interval for sending a WebSocket ping message to remote peer in every x seconds. If this parameter is set to 0, then no ping message will be sent. In SCA, the default time interval is set to 45 seconds. | Numeric, 4. Value ranges (in seconds): 0 to 3600 | 45 seconds | wspinginterval |
| WEBSOCKETPORT | This parameter is used to set the destination host service port number. | Value range: 1 … 65535 | 443 | port |
| WEBSOCKETSSL_CA_CERT_FILE | This is the path and name of file containing trusted root certificates. It can contain either one or multiple certificates. In case more than one root certificate is stored, then all those certificates have to be concatenated into one file in PEM format. NOTE: This is used only when TYPE is WSS, this certificate file should be loaded to the terminal in the path mentioned here, with all permissions. | Alphanumeric, 200 | /home/usr1/flash/cst2_test-gsc_vfims_com.cer | ssl_ca_cert_file |
| WEBSOCKETSSL_OWN_CERT | This is the name of file (and optional path too) containing the own public key certificate required for mutual authentication. | Alphanumeric, 200 | /mnt/flash/system/rkeys/usr1/key0.crt | ssl_own_cert |
| WEBSOCKETSSL_OWN_PKEY | This is the name of file (and optional path too) containing the private key required for mutual SSL authentication. | Alphanumeric, 200 | vault:/mnt/flash/system/rkeys/usr1/key0.der | ssl_own_pkey |
| WBS_START_NETWORK | This parameter is used for bringing up the same network interface for WebSocket connection, if it goes down for any reason. |
|
1 | start_network |
| WEBSOCKETTIMEOUT | This parameter is used to set the time, for which a connection establishment may take before it is canceled. When this timeout elapses the current connection attempt is canceled and the next connection is tried, if present. | Alphanumeric, 10 and Unit is msec. | 60000 | timeout |
| WEBSOCKETTYPE | This parameter is used to set the type of the connection, like plain TCP, plain UDP, TLS/SSL over TCP or WebSocket (TLS secured and non-secure). |
|
WSS | type |
| WEBSOCKETWSHOST | This parameter is used to set the Hostname on server. This is used only if TYPE=WS or TYPE=WSS. NOTE: If this parameter is not specified explicitly, then this will automatically set to the value ADDRESS. | Alphanumeric, 200 | dev-poscloud.vficloud.net | wshost |
| WEBSOCKETWSORIGIN | This parameter is used to set the Socket origin name. This is used only if TYPE=WS or TYPE=WSS. NOTE: If this parameter is not specified explicitly, then this will automatically set to the value ADDRESS. | Alphanumeric, 200 | dev-poscloud.vficloud.net | wsorigin |
| WEBSOCKETWSPATH | This parameter is used to set the WebSocket path on server. This is used only if TYPE=WS or TYPE=WSS. | Alphanumeric, 200 | /poscloud | wspath |
| WEBSOCKETWSPROTOCOL | This parameter is used to set the WebSocket HTTP/S. The value of this parameter is passed to the client and/or server. | Alphanumeric, 200 | SCI | wsprotocol |
Rate this article:
