Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

connection/README: Recommend yamux over mplex #402

Merged
merged 1 commit into from
Mar 18, 2022
Merged

connection/README: Recommend yamux over mplex #402

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions connections/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,8 +112,8 @@ functions.
Each protocol supported by a peer is identified using a unique string called a
**protocol id**. While any string can be used, the conventional format is a
path-like structure containing a short name and a version number, separated by
`/` characters. For example: `/mplex/1.0.0` identifies version 1.0.0 of the
[`mplex` stream multiplexing protocol][mplex]. multistream-select itself has a
`/` characters. For example: `/yamux/1.0.0` identifies version 1.0.0 of the
marten-seemann marked this conversation as resolved.
Show resolved Hide resolved
[`yamux` stream multiplexing protocol][yamux]. multistream-select itself has a
protocol id of `/multistream/1.0.0`.

Including a version number in the protocol id simplifies the case where you want
Expand Down Expand Up @@ -277,8 +277,8 @@ should support a baseline "stack" of security and multiplexing protocols.
The recommended baseline **security** protocol is [Noise][noise-spec], which is
supported in all current libp2p implementations.

The recommended baseline **stream multiplexer** is [mplex][mplex], which
provides a very simple programmatic API and is supported in all current libp2p
The recommended baseline **stream multiplexer** is [yamux][yamux], which
provides a very simple programmatic API and is supported in most libp2p
implementations.

### State Management
Expand Down Expand Up @@ -394,7 +394,7 @@ updated to incorporate the changes.

[mss]: https://github.com/multiformats/multistream-select
[uvarint]: https://github.com/multiformats/unsigned-varint
[mplex]: ../mplex/README.md
[yamux]: https://github.com/hashicorp/yamux/blob/master/spec.md
[noise-spec]: ../noise/README.md
[connmgr-v2-spec]: https://github.com/libp2p/specs/pull/161
[connmgr-go-interface]: https://github.com/libp2p/go-libp2p-core/blob/master/connmgr/connmgr.go
Expand Down