Skip to content
This repository was archived by the owner on Aug 15, 2025. It is now read-only.

Commit 39aa208

Browse files
committed
Enhance doc for 'from' & 'to' fields:
- Specify as string (JSON compatible) - Detail purpose within mathematical intervals
1 parent 2601224 commit 39aa208

File tree

1 file changed

+10
-4
lines changed
  • docs/Protocol Specifications

1 file changed

+10
-4
lines changed

docs/Protocol Specifications/core.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -499,6 +499,11 @@ object with the fields `from`, `to`, and `except`. The `from` and `to` fields ar
499499
a range of numbers. The `except` field is an array of strings representing numbers that are not
500500
included in the range.
501501

502+
!!! info
503+
504+
Numbers are formatted as strings due to JSON conventions. Every number in the `from`, `to` and
505+
`except` fields is a valid, unsigned integer of up to 64 bits.
506+
502507
The range described by the `from` and `to` fields is a mathematical, closed interval, where
503508
`from` is equal to $a$ and `to` is equal to $b$ :
504509

@@ -516,10 +521,11 @@ $$
516521
}
517522
```
518523

519-
| Field | Type | Description |
520-
| ------ | ------ | ----------- |
521-
| `from` | string | |
522-
524+
| Field | Type | Description |
525+
| -------- | ------------- | -------------------------------------------------------------------------------------------------------------------------- |
526+
| `from` | string | The lowest sequence number received this heartbeat interval |
527+
| `to` | string | The highest sequence number received this heartbeat interval |
528+
| `except` | array[string] | Sequence numbers `x`, where \{$x \in \mathbb{N} \mid from\leq x\leq to\}$, that were not received this heartbeat interval. |
523529

524530
!!! example "Example heartbeat event payload"
525531

0 commit comments

Comments
 (0)