Struct libp2p_networking::network::behaviours::dht::DHTBehaviour
source · pub struct DHTBehaviour<K: SignatureKey + 'static> {
pub in_progress_get_closest_peers: HashMap<QueryId, Sender<()>>,
in_progress_record_queries: HashMap<QueryId, KadGetQuery>,
outstanding_dht_query_keys: HashSet<Vec<u8>>,
in_progress_put_record_queries: HashMap<QueryId, KadPutQuery>,
pub bootstrap_state: Bootstrap,
pub peer_id: PeerId,
pub replication_factor: NonZeroUsize,
retry_tx: Option<UnboundedSender<ClientRequest>>,
bootstrap_tx: Option<Sender<InputEvent>>,
phantom: PhantomData<K>,
}
Expand description
Behaviour wrapping libp2p’s kademlia included:
- publishing API
- Request API
- bootstrapping into the network
- peer discovery
Fields§
§in_progress_get_closest_peers: HashMap<QueryId, Sender<()>>
in progress queries for nearby peers
in_progress_record_queries: HashMap<QueryId, KadGetQuery>
List of in-progress get requests
outstanding_dht_query_keys: HashSet<Vec<u8>>
The lookup keys for all outstanding DHT queries
in_progress_put_record_queries: HashMap<QueryId, KadPutQuery>
List of in-progress put requests
bootstrap_state: Bootstrap
State of bootstrapping
peer_id: PeerId
the peer id (useful only for debugging right now)
replication_factor: NonZeroUsize
replication factor
retry_tx: Option<UnboundedSender<ClientRequest>>
Sender to retry requests.
bootstrap_tx: Option<Sender<InputEvent>>
Sender to the bootstrap task
phantom: PhantomData<K>
Phantom type for the key
Implementations§
source§impl<K: SignatureKey + 'static> DHTBehaviour<K>
impl<K: SignatureKey + 'static> DHTBehaviour<K>
sourcepub fn set_retry(&mut self, tx: UnboundedSender<ClientRequest>)
pub fn set_retry(&mut self, tx: UnboundedSender<ClientRequest>)
Give the handler a way to retry requests.
sourcepub fn set_bootstrap_sender(&mut self, tx: Sender<InputEvent>)
pub fn set_bootstrap_sender(&mut self, tx: Sender<InputEvent>)
Sets a sender to bootstrap task
sourcepub fn new(pid: PeerId, replication_factor: NonZeroUsize) -> Self
pub fn new(pid: PeerId, replication_factor: NonZeroUsize) -> Self
Create a new DHT behaviour
sourcepub fn print_routing_table(
&mut self,
kadem: &mut KademliaBehaviour<FileBackedStore<ValidatedStore<MemoryStore, K>>>,
)
pub fn print_routing_table( &mut self, kadem: &mut KademliaBehaviour<FileBackedStore<ValidatedStore<MemoryStore, K>>>, )
print out the routing table to stderr
sourcepub fn replication_factor(&self) -> NonZeroUsize
pub fn replication_factor(&self) -> NonZeroUsize
Get the replication factor for queries
sourcepub fn put_record(&mut self, id: QueryId, query: KadPutQuery)
pub fn put_record(&mut self, id: QueryId, query: KadPutQuery)
Publish a key/value to the kv store.
Once replicated upon all nodes, the caller is notified over
chan
sourcepub fn get_record(
&mut self,
key: Vec<u8>,
chan: Sender<Vec<u8>>,
factor: NonZeroUsize,
backoff: ExponentialBackoff,
retry_count: u8,
kad: &mut KademliaBehaviour<FileBackedStore<ValidatedStore<MemoryStore, K>>>,
)
pub fn get_record( &mut self, key: Vec<u8>, chan: Sender<Vec<u8>>, factor: NonZeroUsize, backoff: ExponentialBackoff, retry_count: u8, kad: &mut KademliaBehaviour<FileBackedStore<ValidatedStore<MemoryStore, K>>>, )
Retrieve a value for a key from the DHT.
sourcefn retry_get(&self, query: KadGetQuery)
fn retry_get(&self, query: KadGetQuery)
Spawn a task which will retry the query after a backoff.
sourcefn retry_put(&self, query: KadPutQuery)
fn retry_put(&self, query: KadPutQuery)
Spawn a task which will retry the query after a backoff.
sourcefn handle_get_query(
&mut self,
store: &mut FileBackedStore<ValidatedStore<MemoryStore, K>>,
record_results: GetRecordResult,
id: QueryId,
last: bool,
)
fn handle_get_query( &mut self, store: &mut FileBackedStore<ValidatedStore<MemoryStore, K>>, record_results: GetRecordResult, id: QueryId, last: bool, )
update state based on recv-ed get query
sourcefn handle_put_query(&mut self, record_results: PutRecordResult, id: QueryId)
fn handle_put_query(&mut self, record_results: PutRecordResult, id: QueryId)
Update state based on put query
sourcefn finish_bootstrap(&mut self)
fn finish_bootstrap(&mut self)
Send that the bootstrap succeeded
sourcepub fn dht_handle_event(
&mut self,
event: KademliaEvent,
store: &mut FileBackedStore<ValidatedStore<MemoryStore, K>>,
) -> Option<NetworkEvent>
pub fn dht_handle_event( &mut self, event: KademliaEvent, store: &mut FileBackedStore<ValidatedStore<MemoryStore, K>>, ) -> Option<NetworkEvent>
handle a DHT event
Trait Implementations§
Auto Trait Implementations§
impl<K> Freeze for DHTBehaviour<K>
impl<K> !RefUnwindSafe for DHTBehaviour<K>
impl<K> Send for DHTBehaviour<K>
impl<K> Sync for DHTBehaviour<K>
impl<K> Unpin for DHTBehaviour<K>where
K: Unpin,
impl<K> !UnwindSafe for DHTBehaviour<K>
Blanket Implementations§
§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<T> Conv for T
impl<T> Conv for T
§impl<T> FmtForward for T
impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self
to use its Binary
implementation when Debug
-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self
to use its Display
implementation when
Debug
-formatted.§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self
to use its LowerExp
implementation when
Debug
-formatted.§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self
to use its LowerHex
implementation when
Debug
-formatted.§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self
to use its Octal
implementation when Debug
-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self
to use its Pointer
implementation when
Debug
-formatted.§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self
to use its UpperExp
implementation when
Debug
-formatted.§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self
to use its UpperHex
implementation when
Debug
-formatted.§fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self
, then passes self.as_ref()
into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self
, then passes self.as_mut()
into the pipe
function.§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self
, then passes self.deref()
into the pipe function.§impl<T> Pointable for T
impl<T> Pointable for T
§impl<T> Tap for T
impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B>
of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B>
of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R>
view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R>
view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target
of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target
of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap()
only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut()
only in debug builds, and is erased in release
builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow()
only in debug builds, and is erased in release
builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref()
only in debug builds, and is erased in release
builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut()
only in debug builds, and is erased in release
builds.§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref()
only in debug builds, and is erased in release
builds.