Skip to content

Commit

Permalink
chore(kad): update kad caching docs for clarity about write mechanism
Browse files Browse the repository at this point in the history
Pull-Request: #4564.
  • Loading branch information
joshuef authored Sep 27, 2023
1 parent 91fb6a1 commit f6b5a13
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions protocols/kad/src/behaviour.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2780,11 +2780,11 @@ pub enum GetRecordOk {
/// _to the record key_ (not the local node) that were queried but
/// did not return the record, sorted by distance to the record key
/// from closest to farthest. How many of these are tracked is configured
/// by [`KademliaConfig::set_caching`]. If the lookup used a quorum of
/// 1, these peers will be sent the record as a means of caching.
/// If the lookup used a quorum > 1, you may wish to use these
/// candidates with [`Kademlia::put_record_to`] after selecting
/// one of the returned records.
/// by [`KademliaConfig::set_caching`].
///
/// Writing back the cache at these peers is a manual operation.
/// ie. you may wish to use these candidates with [`Kademlia::put_record_to`]
/// after selecting one of the returned records.
cache_candidates: BTreeMap<kbucket::Distance, PeerId>,
},
}
Expand Down

0 comments on commit f6b5a13

Please sign in to comment.