diff options
Diffstat (limited to 'src/swarm')
| -rw-r--r-- | src/swarm/relay.rs | 11 |
1 files changed, 6 insertions, 5 deletions
diff --git a/src/swarm/relay.rs b/src/swarm/relay.rs index f79c601..29da2eb 100644 --- a/src/swarm/relay.rs +++ b/src/swarm/relay.rs @@ -1,14 +1,15 @@ -//! Passing changes on in a partial mesh (`swarm::topology`). +//! Passing changes on (`swarm::topology`): along writers' trees (`swarm::tree`), and by +//! announcement and pull where they don't reach. //! //! A node pushes its own changes to its neighbours, but nothing it receives goes any -//! further by itself. So after applying changes from one neighbour, a node *announces* +//! further by itself but along a writer's tree. So after applying changes from one +//! neighbour, a node *announces* //! its new heads to its other neighbours with a STATUS (heads, about 100 bytes, not the //! changes; no keepalive, and answered only by a neighbour whose heads differ). A //! neighbour that sees heads it lacks *pulls*: it enters the //! announced heads as the peer's heads in its sync state, Automerge asks for what's -//! missing (`need`), and the announcer answers with exactly those changes. Each node -//! receives a change about once; the rest is announcements. Regular keepalives work the -//! same way, so any gap is noticed within a keepalive interval. +//! missing (`need`), and the announcer answers with exactly those changes. Regular +//! keepalives work the same way, so any gap is noticed within a keepalive interval. //! //! Announcements are coalesced: the first applied change schedules one announcement //! round `ANNOUNCE_DELAY` later, and every change applied until then rides along. A |