Skip to content

Commit

Permalink
identify: Document identify behavior for asymetrical protocols (libp2…
Browse files Browse the repository at this point in the history
…p#327)

* identify: Document identify behavior for asymetrical protocols

> Note on asymmetrical protocols: Assume an asymmetrical
request-response style protocol `foo` where some clients only support
initiating requests while some servers (only) support responding to
requests. To prevent clients from initiating requests to other clients,
which given them being clients they fail to respond, clients should not
list `foo` in their `protocols` list.

Question emerged in libp2p#324.

* identify/README: Reword to inbound substreams
  • Loading branch information
mxinden committed May 25, 2021
1 parent 9274d30 commit f922a3e
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions identify/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,3 +120,11 @@ observable source address.
### protocols

This is a list of protocols supported by the peer.

A node should only advertise a protocol if it's willing to receive inbound
streams on that protocol. This is relevant for asymmetrical protocols. For
example assume an asymmetrical request-response style protocol `foo` where some
clients only support initiating requests while some servers (only) support
responding to requests. To prevent clients from initiating requests to other
clients, which given them being clients they fail to respond, clients should not
advertise `foo` in their `protocols` list.

0 comments on commit f922a3e

Please sign in to comment.