|
seqeron 0.18.0
|
Classes | |
| class | FrameLayer |
The frame layer's constants: the queue's identity, the cluster clock, and the size limits of spec §12. The C# mirror of the spec, as FrameLayer.java and SequencedFrame.hpp are; a change is a wire change (V-3) and lands in all three. Never read from a transport: S-3 forbids checking a node's own MTU, which would fork clusterSeqNo. More... | |
| class | PortLayout |
The cluster port-layout formula: the C# mirror of PortLayout.java, PortLayout.hpp and ports.sh; change all four together. Cluster member ports only (doc/ops.md, "Ports"). More... | |
| class | ReplayProtocol |
| The replay protocol's addresses, shared by the Replayer and its co-located clients. More... | |
| class | SeqeronCounters |
Registry of seqeron's custom Aeron counter type ids (Aeron reserves 0-999). One block per process family, so a range scan (clusterctl counters) finds them all. The ids and key layout match SeqeronCounters.java and SeqeronCounters.hpp. More... | |
| class | SequencedFrameDecoder |
One frame off the queue with the envelope stripped; SequencedFrameDecoder.java and FrameView in SequencedFrame.hpp are its twins, and the three stay in step. IsSystem says which family: an application frame dispatches on (PayloadId, TemplateId), never TemplateId alone, and a system frame on SystemEventType. More... | |
| class | SnapshotFormat |
What a snapshot is (doc/snapshot.md §2): a sequence of records, the façade's header first, checked by the CRC-32C of their bytes in order that its SnapshotEnd carries. SnapshotFormat.java and Snapshot.hpp are its twins; keep the three in step. More... | |
| class | SystemFrame |
The ingress side of the frame layer: wraps an already-encoded payload in its family's envelope and returns the length; the offer is the caller's. A system payload carries no MessageHeader: it is encoded bare, and decoded with its codec's compiled constants (§7, V-3). More... | |
Enumerations | |
| enum | Publish { Published , Refused , Declined } |
| What a publish did. Refused is local and permanent: the payload is too long, or the frame breaks §9.2 conditions 6 to 9, so retrying it cannot succeed. Declined (transport back-pressure, a lost session, or the tracker holding or full) is the one a caller may retry. More... | |
Functions | |
| record | SnapshotHeader (long LeadershipTermId, int LeaderMemberId, IReadOnlyList< SnapshotHeader.Group > Groups, SnapshotHeader.GatewayState Gateway) |
| The header a façade writes ahead of the application's body: what it derives from frames before the round's cut, which a restore never replays (doc/snapshot.md §6). Little-endian, packed: | |
What a publish did. Refused is local and permanent: the payload is too long, or the frame breaks §9.2 conditions 6 to 9, so retrying it cannot succeed. Declined (transport back-pressure, a lost session, or the tracker holding or full) is the one a caller may retry.
| Enumerator | |
|---|---|
| Published | The frame was offered, and tracked if a tracker was given. |
| Refused | Nothing was offered and retrying cannot help. |
| Declined | Nothing was offered; the same frame may be offered again. |
|
sealed |
The header a façade writes ahead of the application's body: what it derives from frames before the round's cut, which a restore never replays (doc/snapshot.md §6). Little-endian, packed:
0 headerVersion uint16 HeaderVersion 2 headerLength uint32 bytes up to the body 6 leadershipTermId int64 from the last LeadershipChanged before the cut 14 leaderMemberId int32 that frame's newLeaderMemberId 18 groupCount uint8 19 groups, in ascending groupId: groupId uint8, groupName char[32] — a gateway's header continues at G = 19 + 33 × groupCount — G gatewaySourceId int32 G + 4 activeGatewayId int32 the current GatewayActive's, or NoGateway G + 8 highestConnectionId int32 the highest in the source's history G + 12 rowCount uint16 G + 14 rows, in list order: gatewayId int32, preferenceRank uint8, gatewayName char[32] Every instance of a source writes the same header (A-6), so it carries the rows of every instance of a gateway and an instance finds its own by name, as it does in the list. SnapshotHeader.java and Snapshot.hpp are its twins; keep the three in step.
| LeadershipTermId | the term of the last LeadershipChanged before the cut |
| LeaderMemberId | that term's leader |
| Groups | the active groups before the cut, in ascending groupId |
| Gateway | a gateway's continuation, or null for an application's header |
The one headerVersion this build writes and reads.
No GatewayActive yet.
One active group.
| GroupId | 1 to FrameLayer.MaxGroups |
| GroupName | its name, at most 32 US-ASCII characters |
A gateway's continuation.
| GatewaySourceId | the logical gateway |
| ActiveGatewayId | the instance the current GatewayActive names, or NoGateway |
| HighestConnectionId | the highest connectionId in the source's history |
| Rows | the list rows of every instance of the gateway, in list order |
Equal when every field is, the rows compared in order.
| other | the state to compare with |
One instance's list row.
| GatewayId | the instance |
| PreferenceRank | its rank |
| GatewayName | its name, at most 32 US-ASCII characters |
Equal when every field is, the groups compared in order.
| other | the header to compare with |
Bytes Encode writes; the value of headerLength.
Writes the header.
| buffer | where to write |
| offset | of the header's first byte |
The headerVersion at offset , or -1 if length cannot hold one.
| buffer | holding the snapshot |
| offset | of its first byte |
| length | the snapshot's bytes from offset |
Reads a header written by Encode.
| buffer | holding the snapshot |
| offset | of its first byte |
| length | the snapshot's bytes from offset |