/usr/share/doc/ruby-rubytorrent/design.txt is in ruby-rubytorrent 0.3-5.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 | RubyTorrent Design
------------------
This is pretty sketchy at the moment but it might help if you want to
do some hacking.
+---------+ +----------------+
disk <::::::::>| Package | /-| PeerConnection |<=== network ===> peer
+---------+ | +----------------+
| |
+---------+ +------------+ / +----------------+
| Tracker |--| Controller |----| PeerConnection |<=== network ===> peer
+---------+ +------------+ \ +----------------+
/ | .
+--------+ / | .
| Server |- | .
+--------+ \
\ +---------+
| | Package |<:::::::> disk
| +---------+
| |
+---------+ \+------------+ +----------------+
| Tracker |--| Controller |----| PeerConnection |<=== network ===> peer
+---------+ +------------+ \ +----------------+
|
| +----------------+
|--| PeerConnection |<=== network ===> peer
| +----------------+
.
.
.
Each .torrent download is associated with a Package. A Package is
composed of several Pieces, each corresponding to a BitTorrent
piece. A Package provides simple aggregate operations over all the
Pieces. Each Piece handles writing to and reading from disk (across
potentially multiple file pointers), as well as dividing its data into
one or more Blocks. Each Block is an in-memory section of a Piece and
corresponds to the BitTorrent piece, transferrable across the network.
One Server coordinates all BitTorrent downloads. It maintains several
Controllers, one per .torrent download. The server handles all
handshaking. It accepts incoming connections, shunting them to the
appropriate Controller, and creates outgoing ones at the Controllers'
behest. Each connection to a peer is maintained by a PeerConnection,
which keeps track of the peer's state and the connection state.
PeerConnections get empty Blocks from their Controller and send
requests for them across the wire, and, upon receiving requests from
the peer, get full Blocks from the Package and transmit them back.
The Controller also keeps a Tracker object, which it uses to
communicate with the tracker.
PeerConnections are completely reactive, and are tightly integrated
with their Controller. They rely on the Controller's heartbeat thread
to trigger any time-dependent events, and also for propagating any
messages to other peers.
|