chore: update Transport option documentation #3144
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: D4ryl00 <[email protected]>
sukunrt
requested changes
Feb 10, 2025
Comment on lines
134
to
+140
| // * Transport Upgrader (*tptu.Upgrader) | ||
| // * Host | ||
| // * Stream muxer (muxer.Transport) | ||
| // * Security transport (security.Transport) | ||
| // * Connection Gater (connmgr.ConnectionGater) | ||
| // * Private network protector (pnet.Protector) | ||
| // * Peer ID | ||
| // * Private Key | ||
| // * Public Key | ||
| // * Address filter (filter.Filter) | ||
| // * Peerstore | ||
| // * Resource Manager (network.ResourceManager) | ||
| // * TCP reuse Connection Manager (tcpreuse.ConnMgr) | ||
| // * WebRTC listener (libp2pwebrtc.ListenUDPFn) |
There was a problem hiding this comment.
It's better to mention that users should refer to the parameters of the transport used for all the options available because different transports have different parameters.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR aims to update the list of parameters available for Transport constructors, following this code: https://github.com/libp2p/go-libp2p/blob/master/config/config.go#L290-L324