diff options
| author | Fabio Alessandrelli <fabio.alessandrelli@gmail.com> | 2021-06-28 14:31:15 +0200 |
|---|---|---|
| committer | Fabio Alessandrelli <fabio.alessandrelli@gmail.com> | 2021-06-28 15:53:25 +0200 |
| commit | 458437edef19bc4ddcb0a5a9b41d337a33471398 (patch) | |
| tree | 93c956b1d65fef5dd63bfe928aa6104c1a17890c /modules/websocket/doc_classes | |
| parent | ce7f5992083bdebf2d828a0117d5197eff624710 (diff) | |
[Net] Add WebSocketServer handshake_timeout property.
Allows customization of the maximum time a client is allowed to stay in
the the "pending" state (i.e. awaiting HTTP handshake).
This used to be 1 second by before, the new default is 3 seconds.
Diffstat (limited to 'modules/websocket/doc_classes')
| -rw-r--r-- | modules/websocket/doc_classes/WebSocketServer.xml | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/modules/websocket/doc_classes/WebSocketServer.xml b/modules/websocket/doc_classes/WebSocketServer.xml index 78f2832770..7bc0d64718 100644 --- a/modules/websocket/doc_classes/WebSocketServer.xml +++ b/modules/websocket/doc_classes/WebSocketServer.xml @@ -89,6 +89,9 @@ <member name="ca_chain" type="X509Certificate" setter="set_ca_chain" getter="get_ca_chain"> When using SSL (see [member private_key] and [member ssl_certificate]), you can set this to a valid [X509Certificate] to be provided as additional CA chain information during the SSL handshake. </member> + <member name="handshake_timeout" type="float" setter="set_handshake_timeout" getter="get_handshake_timeout" default="3.0"> + The time in seconds before a pending client (i.e. a client that has not yet finished the HTTP handshake) is considered stale and forcefully disconnected. + </member> <member name="private_key" type="CryptoKey" setter="set_private_key" getter="get_private_key"> When set to a valid [CryptoKey] (along with [member ssl_certificate]) will cause the server to require SSL instead of regular TCP (i.e. the [code]wss://[/code] protocol). </member> |