docs: public rendezvous procedure #1203
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
AlejandroCabeza
approved these changes
Sep 27, 2024
libp2p/protocols/rendezvous.nim
Outdated
| await rdv.advertise(ns, ttl, rdv.peers) | ||
|
|
||
| proc requestLocally*(rdv: RendezVous, ns: string): seq[PeerRecord] = | ||
| ## This procedure returns all the peers already registered on the | ||
| ## given namespace. This function is synchronous |
There was a problem hiding this comment.
This function is synchronous
Not sure this is necessary.
libp2p/protocols/rendezvous.nim
Outdated
| @@ -555,6 +560,10 @@ proc requestLocally*(rdv: RendezVous, ns: string): seq[PeerRecord] = | |||
| proc request*( | |||
| rdv: RendezVous, ns: string, l: int = DiscoverLimit.int, peers: seq[PeerId] | |||
| ): Future[seq[PeerRecord]] {.async.} = | |||
| ## This async procedure request discovers and returns peers for | |||
There was a problem hiding this comment.
request discovers
Is it a typo?
libp2p/protocols/rendezvous.nim
Outdated
| @@ -555,6 +560,10 @@ proc requestLocally*(rdv: RendezVous, ns: string): seq[PeerRecord] = | |||
| proc request*( | |||
| rdv: RendezVous, ns: string, l: int = DiscoverLimit.int, peers: seq[PeerId] | |||
There was a problem hiding this comment.
it's better to use a more descriptive name for the parameter than l.
| @@ -646,6 +655,10 @@ proc unsubscribeLocally*(rdv: RendezVous, ns: string) = | |||
| return | |||
|
|
|||
| proc unsubscribe*(rdv: RendezVous, ns: string, peerIds: seq[PeerId]) {.async.} = | |||
| ## The async unsubscribe procedure removes peers from a namespace by | |||
| ## sending an "Unregister" message to each connected peer. The operation | |||
| ## is bounded by a timeout for unsubscribing from all peers. | |||
There was a problem hiding this comment.
Where is this timeout?
There was a problem hiding this comment.
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.
Three changes on this PR:
advertisefrom method to proc.Related to these comments: #1183 (comment), #1183 (comment) and #1183 (comment)