P2P
Overview
This is a minimal implementation for a multiplexed p2p network based on yamux
that supports mounting custom protocols.
Architecture
- Data stream transmission
+----+ +----------------+ +-----------+ +-------------+ +----------+ +------+
|user| <--> | custom streams | <--> |Yamux frame| <--> |Secure stream| <--> |TCP stream| <--> |remote|
+----+ +----------------+ +-----------+ +-------------+ +----------+ +------+
- Code implementation
All data is passed through the futures channel, yamux
splits the actual tcp stream into multiple substreams,
and the service layer wraps the yamux substream into a protocol stream.
At the same time, support for other protocol(such as websocket) is also planned, but will delay a lot.
Note: It is not compatible with
libp2p
.
Status
The api of this project is changing dramatically, but the core ideas will hardly change much, PR is welcome.
This library still lacks a lot of stability tests and stress tests, I will try to do these things.
Usage
Example
- Clone
$ git clone https://github.com/nervosnetwork/p2p.git
- On one terminal:
Listen on 127.0.0.1:1337
$ RUST_LOG=simple=info,p2p=debug cargo run --example simple -- server
- On another terminal:
$ RUST_LOG=simple=info,p2p=debug cargo run --example simple
- Now you can see some data interaction information on the terminal.
Why?
Because when I use rust-libp2p
, I have encountered some difficult problems,
and it is difficult to locate whether it is my problem or the library itself,
it is better to implement one myself.