Skip to content

Commit 64c4e54

Browse files
docs: warn that HeartbeatRequest is not handled by the dqlite server
The C dqlite server omits HEARTBEAT from its gateway dispatcher, and the Go client's heartbeat code is commented out. Sending HeartbeatRequest results in a FailureResponse. Updated the docstring to warn about this and document the expected response type (ServersResponse) if heartbeat is ever enabled. Closes #141 Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 644cb5c commit 64c4e54

1 file changed

Lines changed: 8 additions & 0 deletions

File tree

src/dqlitewire/messages/requests.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,14 @@ class HeartbeatRequest(Message):
7676
"""Send heartbeat to server.
7777
7878
Body: uint64 timestamp
79+
80+
Note: The C dqlite server does not currently handle this request type
81+
(HEARTBEAT is omitted from the gateway dispatcher). The Go client's
82+
heartbeat code is also commented out. Sending this request will result
83+
in a FailureResponse from the server.
84+
85+
If heartbeat is ever enabled, the expected response is a
86+
ServersResponse (type 3) containing the cluster node list.
7987
"""
8088

8189
MSG_TYPE: ClassVar[int] = RequestType.HEARTBEAT

0 commit comments

Comments
 (0)