docs: change advertisements to registration

This commit is contained in:
Ludovic Chenut 2024-10-01 12:17:08 +02:00
parent a6c5343998
commit db2699b3f1
No known key found for this signature in database
GPG Key ID: D9A59B1907F1D50C

View File

@ -506,11 +506,11 @@ proc advertisePeer(rdv: RendezVous, peer: PeerId, msg: seq[byte]) {.async.} =
discard await advertiseWrap().withTimeout(5.seconds) discard await advertiseWrap().withTimeout(5.seconds)
proc advertise*( proc advertise*(
rdv: RendezVous, ns: string, ttl: Duration, peers: seq[PeerId] rdv: RendezVous, ns: string, ttl: Duration = rdv.minDuration, peers: seq[PeerId]
) {.async.} = ) {.async.} =
## The advertise async procedure sends advertisements for a namespace ## The advertise async procedure sends a registration for a namespace
## to a sequence of peers. It encodes and sends a signed peer record ## to a sequence of peers. It encodes and sends a signed peer record
## along with a time-to-live value. Advertisements are sent ## along with a time-to-live value. The registrations are sent
## concurrently to all specified peers. ## concurrently to all specified peers.
## ##
if ns.len notin 1 .. 255: if ns.len notin 1 .. 255: