A multiplexed p2p network framework based on yamux that supports mounting custom protocols.
The crate is aimed at implementing a framework that light weight, simple, reliable, high performance, and friendly to users.
Multiaddr aims to make network addresses future-proof, composable, and efficient.
It can express almost all network protocols, such as:
In this library, the most important concept is protocol, so we need to clarify what is the protocol defined by tentacle.
If you use the simplest way to understand, then it can be compared to the http protocol on the TCP protocol, that is, each protocol can have its own behavior standards, analysis methods, etc.
As a framework, a builder is provided to describe the standard protocol, and three traits are provided to define the behavior of the protocol. Unfortunately, users also need an event trait to perceive other events that occur in the service, such as session establishment, protocol exceptions, etc.
The biggest question users may have is why there are three different traits defining protocol behavior.
These three traits can be divided into two groups, representing two different design ideas:
user can only do what it defines, tentacle has stronger constraints on it
ServiceProtocol defines a globally unique single-protocol processing capability, and
all the protocol data and behaviors opened by the session will be summarized here for processing.
Its lifetime is from the start of the service to the end.
SessionProtocol its lifetime is only in the phase when the corresponding session is opened,
the session is disconnected, and the handle drop, session open, handle open. That's all.
Obviously, there is an abstraction of data interception
user can combine stream with any existing future ecology, tentacle restricts it weaker
ProtocolSpawn Users can get a perfect asynchronous environment to make complex control flow,
and even use this trait to implement data summary processing in callback mode again
Compared with callback mode, it reduces a layer of abstraction
- Define protocol behavior with Callback or Stream trait
ServiceHandleto process other event output on tentacle service
- Build all need
- Register all
ServiceBuilder, then build
- Setup an async runtime such as tokio
Servicejust like other stream, maybe keep a
Controlon some place which want to communicate with background
Some gadgets that help create a service
Context for Session and Service
An abstraction of p2p service
Some useful functions
Index of session
Protocol Stream read part