pea2pea 0.54.0

A lightweight, performant microkernel for TCP peer-to-peer (P2P) networking. Handles connection pooling and framing, leaving the logic to you.
Documentation 
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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98

# Protocols

This directory contains the protocols available to nodes implementing the `Pea2Pea` trait.

## Connection Lifecycle Graph

[PNG format](https://github.com/ljedrz/pea2pea/blob/master/assets/connection_lifetime.png)

```
               +----------------+
               | New Connection |
               +-------+--------+
                       |
                   CONNECTING
                       |
                       v
            /---------------------\
            |  Handshake Enabled? |
            \----------+----------/
                       |
          +------------+-------------+
          | Yes                      | No
          v                          |
+-----------------------------+      |
| Handshake::perform_handshake|      |
+-------------+---------------+      |
              |                      |
      +-------+-------+              |
      | Failure       | Success      |
      |               |              |
      |               v              v
      |             /------------------\
      |             | Reading Enabled? |
      |             \--------+---------/
      |                      |
      |             +--------+---------+
      |             | Yes              | No
      |             v                  |
      | +------------------------------------------------+
      | | Spawn task for decoding Reading::Messages      |
      | | Spawn task for processing Reading::Messages    |
      | | (Reads will start when CONNECTED)              |
      | +------------------------+-----------------------+
      |                          |
      |                          v
      |                 /------------------\
      |                 | Writing Enabled? |
      |                 \--------+---------/
      |                          |
      |                 +--------+--------+
      |                 | Yes             | No
      |                 v                 |
      |       +-------------------------+ |
      |       | Spawn task for encoding | |
      |       | Writing::Messages       | |
      |       +------------+------------+ |
      |                    |              |
      |                    v              v
      |          +--------------------------+
      |          |  The Connection is Ready |
      |          +-----------+--------------+
      |                      |
      |                  CONNECTED
      |                      |
      |                      v
      |             /--------------------\
      |             | OnConnect Enabled? |
      |             \----------+---------/
      |                        |
      |             +----------+----------+
      |             | Yes                 | No
      |             v                     |
      |    +-----------------------+      |
      |    | OnConnect::on_connect |      |
      |    +-----------+-----------+      |
      |                |                  |
      |                v                  v
      |             [ ... ] (Active Connection)
      |                      |
      |                  disconnect
      |                      |
      |                      v
      |          /-----------------------\
      |          | OnDisconnect Enabled? |
      |          \-----------+-----------/
      |                      |
      |            +---------+----------+
      |            | Yes                | No
      |            v                    |
      | +-----------------------------+ |
      | | OnDisconnect::on_disconnect | |
      | +------------+----------------+ |
      |              |                  |
      v              v                  v
+-------------------------------------------+
|           Connection Terminated           |
+-------------------------------------------+
```