Skip to content

Commit 2193169

Browse files
committed
Add ClientHeartbeatPacket
Also rename HeartbeatPacket to ServerHeartbeatPacket per discussion in issue artemis-nerds#194. Also add information about periods of both heartbeats being 3 seconds. Signed-off-by: Dave Thaler <dthaler@ntdev.microsoft.com>
1 parent 9cf3169 commit 2193169

File tree

1 file changed

+22
-3
lines changed

1 file changed

+22
-3
lines changed

index.html

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2034,6 +2034,25 @@ <h4>Payload</h4>
20342034
</dd>
20352035
</dl>
20362036
</section>
2037+
<section id="clientheartbeatpacket">
2038+
<h3>ClientHeartbeatPacket</h3>
2039+
<div class="pkt-props">Type: <code>0x4c821d3c</code>:<code>0x24</code> [from <span>client</span>]</div>
2040+
<p>
2041+
This packet is transmitted regularly by the client (about every 3 seconds) to demonstrate that it's still
2042+
alive. If the server does not receive a heartbeat packet in a while, it will
2043+
forget the client and let a new client connect and control any
2044+
stations the old client previously had control of.
2045+
</p>
2046+
<h4>Payload</h4>
2047+
<dl>
2048+
<dt>Subtype (int)</dt>
2049+
<dd>
2050+
<p>
2051+
Always <code>0x24</code>.
2052+
</p>
2053+
</dd>
2054+
</dl>
2055+
</section>
20372056
<section id="buttonclickpacket">
20382057
<h3>ButtonClickPacket</h3>
20392058
<div class="pkt-props">Type: <code>0x4c821d3c</code>:<code>0x15</code> [from <span>client</span>]</div>
@@ -3491,11 +3510,11 @@ <h4>Payload</h4>
34913510
</section>
34923511
<section id="pkt-h">
34933512
<h3>H</h3>
3494-
<section id="heartbeatpacket">
3495-
<h3>HeartbeatPacket</h3>
3513+
<section id="serverheartbeatpacket">
3514+
<h3>ServerHeartbeatPacket</h3>
34963515
<div class="pkt-props">Type: <code>0xf5821226</code> [from <span>server</span>]</div>
34973516
<p>
3498-
This packet is transmitted regularly by the server to demonstrate that it's still
3517+
This packet is transmitted regularly by the server (about every 3 seconds) to demonstrate that it's still
34993518
alive. If the stock client does not receive a heartbeat packet in a while, it will
35003519
display a message at the top-right of the console selection screen saying "Server
35013520
not running" but will otherwise still continue to act as though everything is fine.

0 commit comments

Comments
 (0)