Skip to content

Commit

Permalink
Update architecture diagram. (#60)
Browse files Browse the repository at this point in the history
  • Loading branch information
@hdevalence @dconnolly
hdevalence authored and dconnolly committed Oct 9, 2019
1 parent 8a3b4f4 commit 4efceb4
Showing 1 changed file with 75 additions and 75 deletions.
150 changes: 75 additions & 75 deletions design/peers.txt
View file
Original file line number Diff line number Diff line change
@@ -1,75 +1,75 @@
┌───────────────────────────────────────────────┐
│Peer: one or more futures │
│ │
│ ┌────────────┐ incoming messages │
│ │ TcpStream │ are sent to the │
│ └────────────┘ PeerClient, to │
│ ▲ check if they are │
│ ║ responses, or else │
│ ║ to the PeerServer, │
│ ▼ to check if they │
│ ┌────────────┐ are requests │
│ │ Framed │ │
│ │ Messages │─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─│─ ─ ─
│ └────────────┘ last-seen timestamp channel │ │
│ ▲ │
│ ║ mpsc channel or Service? │ │
│ ╠════════════════════════╗ │
│ ║ ║ │ │
│ ▼ ▼ │
│ ┌──────────────────┐ ┌──────────────────┐ │ │
│ │ PeerClient │ │ PeerServer │ │
│ │sends reqs to peer│ │sends reqs to core│ │ │
│ │sends rsps to core│ │sends rsps to peer│ │
│ └──────────────────┘ └──────────────────┘ │ │
│ ▲ │ │
└───────────┼────────────────────────┼──────────┘ │
│ │
│ │ │
┌───────────┼────────────────────────┼──────────┐
│ │ PeerSet: two Services │ │ │
│ │ plus bookkeeping ▼ │
│ ┌──────────────────┐ ┌──────────────────┐ │ │
│ │ Client │ │ Server │ │ ┌─────────────────────────────┐
│ │ │ │ │ │ │ │ PeerConnector Service │
│ │ load-balances │ │ routes inbound │ │ │ req: SocketAddr │
│ │outbound reqs over│ │PeerServer reqs to│ │ │ │rsp: (PeerClient, PeerServer)│
│ │ available │ │internal Services │ │────────▶│ │
│ │ PeerClients │ │ │ │ │ │ performs handshakes, │
│ │ │ │ drives peerset │ │ │ constructs peer futures │
│ │ drives peerset │ │ contraction via │ │ │ └─────────────────────────────┘
│ │ expansion via │ │ backpressure │ │ │
│ │ backpressure │ │ │ │ │ │
│ └──────────────────┘ └──────────────────┘ │ │
│ ▲ │ │ │ │
└───────────┼────────────────────────┼──────────┘ │
│ │ │ ▼
│ │ ┌─────────────────────────────┐
│ │ │ │ PeerAddress Service │
│ │ │ req: () │
│ │ │ │ rsp: SocketAddr │
└────────────────────────┼────────────────────│ │
│ │ │returns the next addr to try │
│ │ to connect to or asks │
│ │ │existing peers for more addrs│
│ └─────────────────────────────┘
│ │ │
│ │
│ │ │
│ ▼
│ │ ┌─────────────────────────────┐
│ │ AddressBook │
│ └ ─▶│ │
│ │ per-addr last-seen info │
│ └─────────────────────────────┘
│ ▲
│ │
│ │
│ │
│ ┌─────────────────────────────┐
│ │ AddressGossip Service │
│ │ req: () │
└───────────────────▶│ rsp: Vec<MetaAddr> │
│ │
│ truncates timestamps │
└─────────────────────────────┘
──────▶ Channel
Legend:
━━━━━━▶ Service call

┌─────────────┐ ┌─────────────┐ ┌─────────────┐ ┌─────────────┐
│ PeerServer │ │ PeerServer │ │ PeerServer │ │ PeerServer │
│ ┌───────┐ │ │ ┌───────┐ │ │ ┌───────┐ │ │ ┌───────┐ │
│ │┌─────┐│ │ │ │┌─────┐│ │ │ │┌─────┐│ │ │ │┌─────┐│ │
│ ││ Tcp ││ │ │ ││ Tcp ││ │ │ ││ Tcp ││ │ │ ││ Tcp ││ │
│ │└─────┘│───┼┐ │ │└─────┘│───┼┐ │ │└─────┘│───┼┐ │ │└─────┘│───┼┐
│ │Framed │ ││ │ │Framed │ ││ │ │Framed │ ││ │ │Framed │ ││
│ │Stream │ ││ │ │Stream │ ││ │ │Stream │ ││ │ │Stream │ ││
│ └───────┘ ││ │ └───────┘ ││ │ └───────┘ ││ │ └───────┘ ││
┏▶│ ┃ ││ ┏▶│ ┃ ││ ┏▶│ ┃ ││ ┏▶│ ┃ ││
┃ │ ┃ ││ ┃ │ ┃ ││ ┃ │ ┃ ││ ┃ │ ┃ ││
┃ │ ▼ ││ ┃ │ ▼ ││ ┃ │ ▼ ││ ┃ │ ▼ ││
┃ │ ┌───────┐ ││ ┃ │ ┌───────┐ ││ ┃ │ ┌───────┐ ││ ┃ │ ┌───────┐ ││
┃ │ │ Tower │ ││ ┃ │ │ Tower │ ││ ┃ │ │ Tower │ ││ ┃ │ │ Tower │ ││
┃ │ │Buffer │ ││ ┃ │ │Buffer │ ││ ┃ │ │Buffer │ ││ ┃ │ │Buffer │ ││
┃ │ └───────┘ ││ ┃ │ └───────┘ ││ ┃ │ └───────┘ ││ ┃ │ └───────┘ ││
┃ │ ┃ ││ ┃ │ ┃ ││ ┃ │ ┃ ││ ┃ │ ┃ ││
┃ └─────╋───────┘│ ┃ └─────╋───────┘│ ┃ └─────╋───────┘│ ┃ └─────╋───────┘│
┃ ┃ └─╋───────╋────────┴─╋───────╋────────┴─╋───────╋────────┴─┐
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┃ │
┃ ┗━━━━━━━━━━╋━━━━━━━┻━━━━━━━━━━╋━━━━━━━┻━━━━━━━━━━╋━━━━━━━┻━━━━━━━━━━╋━┓
┃ ┃ ┃ ┃ │ ┃
┗━━━━━━━━┓ ┗━━━━━━━━┓ ┗━━━━━━━━┓ ┗━━━━━━━━┓ │ ┃
┌───────╋──────────────────╋──────────────────╋──────────────────╋───────┐ │ ┃
│ ┃ ┃ ┃ ┃ │ │ ┃
│┌─────────────┐ ┌─────────────┐ ┌─────────────┐ ┌─────────────┐│ │ ┃
││ PeerClient │ │ PeerClient │ │ PeerClient │ │ PeerClient ││ │ ┃
│└─────────────┘ └─────────────┘ └─────────────┘ └─────────────┘│ │ ┃
│ │ │ ┃
│ PeerSet │ │ ┃
│ req: Request, rsp: Response │ │ ┃
│ routes all outgoing requests, adds peers to handle load │ │ ┃
└─────────────────────────────────────────────────────────┬──────────────┘ │ ┃
▲ │ │ ┃
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ │ │ ┃
┃ ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╋━━━━━━━━━━━━━━━━╋━┛
┃ ▼ │ │
┃ ┌────────────────────────────────┐ ┌────────────────────────────┐ │
┃ │ Router │ │ PeerDiscover │ │
┃ │ req: Request, rsp: Response │ │Discover<Service=PeerClient>│ │
┃ │ routes all incoming requests, │ │ │ │
┃ │ removes peers to shed load │ │ connects to a remote peer, │ │
┃ │ │ │ constructs client/server │ │
┃ │ │ └────────────────────────────┘ │
┃ │ │ ┃ ▲ │
┃ └────────────────────────────────┘ ┃ └─────┐ │
┃ ┃ ┃ │ │
┃ ┃ ┃ ┌───────────────┐ │
┃ ┃ ┃ │ PeerListener │ │
┃ ┃ ┃ │ req: ? │ │
┃ ┃ ┃ │rsp: PeerClient│ │
┃ ┃ ┃ └───────────────┘ │
┃ ┃ ┃ ┌───────────────┐ │
┃ ┃ ┃ │ PeerConnector │ │
┃ ┃ ┗━━━━▶│req: SocketAddr│ │
┃ ┃ │rsp: PeerClient│ │
┃ ┃ └───────────────┘ │
┃ ┃ ┃ │
┃ ┃ ▼ │
┃ ┃ ┌───────────────┐ │
┃ ┃ ┌───────────────┐ │ NextAddress │ │
┗━━━━━━━━━━━━━━━━━━━━━╋━━━━━│ AddrCrawler │─────────▶│ req: () │ │
┃ └───────────────┘ │rsp: SocketAddr│ │
┃ └───────────────┘ │
┃ ▲ │
┃ │ │
┃ ┌───────────────┐ ┌───────────────┐ │
┃ │ AddrService │ │ AddressBook │ │
┗━━━━▶│ req: GetPeers │◀─────────│ our per-peer │◀─┘
│ rsp: Peers │ │last-seen info │
└───────────────┘ └───────────────┘

0 comments on commit 4efceb4

Please sign in to comment.