Skip to content

Commit 2739979

Browse files
committed
Update library documentation to cover the Keepalive functionality see #5
1 parent d99d287 commit 2739979

5 files changed

Lines changed: 27 additions & 5 deletions

File tree

README.md

Lines changed: 27 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,22 @@ stored in the requesting actor.
122122

123123
## WebSocket Server Manager
124124

125+
### Keepalive Settings
126+
![Keepalive Settings](media/Keepalive%20Settings.png)
127+
128+
The Keepalive settings allow for the configuration of the Keepalive functionality whereby client/server checks if the peer is still responding ("Alive") by sending WebSockets Ping messages to the peer on a certain time interval. The peer will answer with a WebSockets Pong message. If the answer is not received within a certain amount timeout the client/server will drop the connection.
129+
130+
**Enable** If true enables the Keepalive functionality
131+
**Ping Interval (ms)** is the interval of time in milliseconds that elapses between the receipt of the previous pong response and the sending of the next ping message
132+
**Ping Timeout (ms)** is the interval of time in milliseconds that a client/server waits after sending a ping message until declaring the peer not Alive and dropping the connection
133+
134+
### WebSocket Server Manager Configuration
135+
Before launch the "Server Manager Actor" can be configured with the Keepalive settings described above by means of the following property node
136+
137+
![](media/Server%20Menager%20Configuration.png)
138+
139+
The Keepalive settings will be active for all the WebSocket Servers launched by the "WebSocket Server Manager Actor"
140+
125141
### WebSocket Server Listener Settings
126142

127143
<img src="./media/image2.png" style="width:1.77108in;height:1.25017in"
@@ -186,15 +202,18 @@ In case the WebSocket Server Actor is manually launched the following
186202
properties are available to configure it (the port must be entered)
187203
before its launch
188204

189-
<img src="./media/image5.png" style="width:1.81275in;height:0.55216in"
190-
alt="A close-up of a sign Description automatically generated" />
205+
![](media/image5.png)
206+
191207

192-
**Listener Settings** specifies the settings for the Server (see
208+
**Listener Settings** specifies the Listener settings for the Server (see
193209
definition above).
194210

195211
**Handshake timeout** specifies the timeout of the handshake when the
196212
client establishes a WebSocket connection to the server.
197213

214+
**Keepalive** specifies the Keepalive settings for the Server (see
215+
definition above).
216+
198217
### Add Service
199218

200219
<img src="./media/image6.png" style="width:4.77541in;height:3.01693in"
@@ -244,8 +263,8 @@ we want to send the data
244263
The following properties of the WebSocket Client actor must be set
245264
before launching it:
246265

247-
<img src="./media/image9.png" style="width:1.79167in;height:0.91667in"
248-
alt="A screenshot of a computer Description automatically generated" />
266+
![](media/image9.png)
267+
249268

250269
**WS URI** specifies the URI of the client with the following format:
251270

@@ -261,6 +280,9 @@ Msg.lvclass”.*
261280
**Subscriber Enqueuer** specifies the enqueuer of the actor (must be
262281
created) that subscribes to the WebSocket Client Actor.
263282

283+
**Keepalive** specifies the Keepalive settings for the Client (see
284+
definition above).
285+
264286
## Send to Peers
265287

266288
<img src="./media/image10.png" style="width:4.20036in;height:2.6419in"

media/Keepalive Settings.png

14.5 KB
Loading
7.09 KB
Loading

media/image5.png

8.62 KB
Loading

media/image9.png

11.2 KB
Loading

0 commit comments

Comments
 (0)