net: README.
I'm using a Google Drawing to make this diagram. Turned out pretty well.
Juan Batiz-Benet committed
Dec 9, 2014 at 02:11 UTC
dc9f1c4532836e623cdbe3f20b9c3c4a142fcf65
1 file changed
+17
net/README.md
new
+17
@@ -0,0 +1,17 @@
1
+# Network
2
+
3
+The IPFS Network package handles all of the peer-to-peer networking. It connects to other hosts, it encrypts communications, it muxes messages between the network's client services and target hosts. It has multiple subcomponents:
4
+
5
+- `Conn` - a connection to a single Peer
6
+ - `MultiConn` - a set of connections to a single Peer
7
+ - `SecureConn` - an encrypted (tls-like) connection
8
+- `Swarm` - holds connections to Peers, multiplexes from/to each `MultiConn`
9
+- `Muxer` - multiplexes between `Services` and `Swarm`. Handles `Requet/Reply`.
10
+ - `Service` - connects between an outside client service and Network.
11
+ - `Handler` - the client service part that handles requests
12
+
13
+It looks a bit like this:
14
+
15
+<center>
16
+
17
+</center>