org.zkoss.zkmax.au.websocket.WebSocketEndPoint.pingIntervalSecond

From Documentation
Revision as of 02:07, 16 November 2021 by Jumperchen (talk | contribs) (add note about http session keep alive when enables the ping interval mechanism)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)


DocumentationZK Configuration Referencezk.xmlThe Library Propertiesorg.zkoss.zkmax.au.websocket.WebSocketEndPoint.pingIntervalSecond
org.zkoss.zkmax.au.websocket.WebSocketEndPoint.pingIntervalSecond


Property: org.zkoss.zkmax.au.websocket.WebSocketEndPoint.pingIntervalSecond

Applicable:
Dndsmalltalk-check-icon.png globally in zk.xml via <library-property>
Dndsmalltalk-cross-icon.png not as <custom-attribute>
Default: 0 (Turned off)
[Since 9.5.0]
Default: 25 (Turned on)
It means the http session will keep alive during the ping and pong mechanism until the user closes the browser tab or navigates to another browser page.
[Since 9.6.1]
  • Available for ZK:
  • http://www.zkoss.org/product/zkhttp://www.zkoss.org/whyzk/zkeeVersion ee.png

It specifies the interval in second of the ping mechanism described in RFC 6455 when WebSocket connection is enabled.

Only works when WebSocket connection is enabled.



Last Update : 2021/11/16

Copyright © Potix Corporation. This article is licensed under GNU Free Documentation License.