jay/go-honeybee
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

document EventDisconnected.Err and ErrReadLimit classification

Browse Source
This commit is contained in:
Jay
2026-08-10 18:08:21 -04:00
parent 7851d22c22
commit d50ec56800
1 changed files with 8 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+8 -5
View File
@@ -76,8 +76,9 @@ go func() {
go func() { go func() {
for ev := range pool.Events() { for ev := range pool.Events() {
// ev.At is the event timestamp // ev.At is the event timestamp
// ev.Err is non-nil for EventDialFailed // ev.Err is non-nil for EventDialFailed and for EventDisconnected
// caused by a read failure
switch ev.Kind { switch ev.Kind {
case honeybee.EventConnected: case honeybee.EventConnected:
case honeybee.EventDisconnected: case honeybee.EventDisconnected:
@@ -94,7 +95,7 @@ pool.Send("wss://peer.example.com", []byte("hello"))
URLs are normalized by the pool. `wss://peer.example.com`, `wss://peer.example.com/`, and `WSS://Peer.Example.Com:443` all identify the same peer. `honeybee.NormalizeURL` is also available directly if you need to use the same URLs as keys elsewhere. URLs are normalized by the pool. `wss://peer.example.com`, `wss://peer.example.com/`, and `WSS://Peer.Example.Com:443` all identify the same peer. `honeybee.NormalizeURL` is also available directly if you need to use the same URLs as keys elsewhere.
Every time a connection is established, `honeybee.EventConnected` is emitted. Every time a connection drops for any reason, `honeybee.EventDisconnected` is emitted. A peer that reconnects three times produces three Connected/Disconnected pairs. Every time a connection is established, `honeybee.EventConnected` is emitted. Every time a connection drops for any reason, `honeybee.EventDisconnected` is emitted. A peer that reconnects three times produces three Connected/Disconnected pairs. When the drop was caused by a read failure, `ev.Err` carries the classified error — match `honeybee.ErrReadLimit` to detect read-limit violations. A local `Stop()` emits `EventDisconnected` with nil `Err`.
Keepalive is configured via `honeybee.WithKeepaliveTimeout`. The session records a heartbeat on every inbound message, every successful send, and every received pong. If no heartbeats arrive before the keepalive timer fires, the connection is proactively disconnected and reconnected. When set to zero, keepalive is disabled. Keepalive is configured via `honeybee.WithKeepaliveTimeout`. The session records a heartbeat on every inbound message, every successful send, and every received pong. If no heartbeats arrive before the keepalive timer fires, the connection is proactively disconnected and reconnected. When set to zero, keepalive is disabled.
@@ -142,7 +143,8 @@ When the reader exits, exactly one classified error reaches `Errors()` before th
- `ErrPeerClosedClean` for normal closure - `ErrPeerClosedClean` for normal closure
- `ErrPeerClosedUnexpected` for abnormal close codes - `ErrPeerClosedUnexpected` for abnormal close codes
- `ErrReadError` for anything else - `ErrReadError` for any other read failure
- `ErrReadLimit` (chained under `ErrReadError`) when the read limit is exceeded
Pass an `slog.Handler` as the fourth argument to enable structured logging. Pass `nil` to disable it. Pass an `slog.Handler` as the fourth argument to enable structured logging. Pass `nil` to disable it.
@@ -251,7 +253,8 @@ When the reader exits, exactly one classified error reaches `Errors()` before th
- `ErrPeerClosedClean` for normal closure - `ErrPeerClosedClean` for normal closure
- `ErrPeerClosedUnexpected` for abnormal close codes - `ErrPeerClosedUnexpected` for abnormal close codes
- `ErrReadError` for anything else - `ErrReadError` for any other read failure
- `ErrReadLimit` (chained under `ErrReadError`) when the read limit is exceeded
## Ping-Pong Heartbeats ## Ping-Pong Heartbeats