Skip to content

feat: multistream-select #297

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

Merged
merged 7 commits into from
Feb 24, 2023
Merged

feat: multistream-select #297

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
9c5b4d5
populate multistream-select
salmad3 Jan 16, 2023
7b60596
edits
salmad3 Jan 17, 2023
ad6b880
incorporate PR feedback and simplify
salmad3 Jan 25, 2023
e6b6fdb
Apply suggestions from code review
p-shahi Feb 13, 2023
67d6f20
Rephrase title and include stream negotiation
mxinden Feb 24, 2023
6fd1015
Fix multistream select not being a multiplexing protocol
mxinden Feb 24, 2023
0fb3637
Rephrase central paragraph, mentioning stream protocol negotiation
mxinden Feb 24, 2023
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
20 changes: 18 additions & 2 deletions content/concepts/introduction/protocols/multistream.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,23 @@
---
title: "Multistream Select"
description: ""
description: "Multistream Select is used to negotiate the protocol to be spoken on a connection or stream."
weight: 26
---

Coming soon!
## Overview

[Multistream Select](https://github.com/multiformats/multistream-select) is a
protocol negotiation protocol. It allows two peers to negotiate the next spoken
protocol on a connection or stream.

Peers use Multistream Select at various places to select the protocols to use on
a libp2p connection or stream. Most prominently Multistream Select is used to
select the [security](../../secure-comm/overview.md) followed by [stream
multiplexing](../../multiplex/overview.md) protocol spoken on a connection. In
addition it is used to select the application protocol (e.g. Kademlia) on each
new stream on a given connection. The [protocol
negotiation](../core-abstractions/connections#protocol-negotiation) and [upgrade
process](../core-abstractions/connections#upgrading-connections) are explained
further in the [connections document](../core-abstractions/connections.md).

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should add a sentence saying that it's also used to select application protocols spoken on streams.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 done with the last 3 commits.

{{< alert icon="💡" context="note" text="See the multistream-select <a class=\"text-muted\" href=\"https://github.com/multiformats/multistream-select\">technical specification</a> for more details." />}}