Struct DHTServer 

pub struct DHTServer { /* private fields */ }

Cloneable BEP-5 server handle and primary crate entry point.

Implementations

impl DHTServer

pub async fn new(options: DHTOptions) -> Result<Self>

Validates options, binds configured UDP sockets and constructs bounded pipelines.

Background Metadata scheduling begins during construction. Active crawling and UDP receive loops begin when Self::start is awaited.

pub fn on_metadata_fetch<F, Fut>(&self, callback: F)

where F: Fn(String) -> Fut + Send + Sync + 'static, Fut: Future<Output = bool> + Send + 'static,

Registers the asynchronous admission gate invoked before the first real Peer attempt.

Returning false rejects the job without downloading Metadata and without emitting a MetadataFetchCompletion. If no gate is registered, jobs are admitted.

pub fn on_torrent<F>(&self, callback: F)

where F: Fn(TorrentInfo) + Send + Sync + 'static,

Registers a torrent callback whose return is implicitly treated as accepted delivery.

Registering a new torrent callback replaces the previous one.

pub fn on_torrent_with_ack<F>(&self, callback: F)

where F: Fn(TorrentInfo) -> bool + Send + Sync + 'static,

Registers a torrent callback that acknowledges application delivery.

Returning true produces crate::MetadataFetchCompletionStatus::Accepted. Returning false produces crate::MetadataFetchCompletionStatus::DeliveryRejected: the Metadata download was valid, but the application did not accept it. A callback panic is caught and treated as rejected delivery. Registering this callback replaces any previous torrent callback.

pub fn on_metadata_fetch_complete<F>(&self, callback: F)

where F: Fn(MetadataFetchCompletion) + Send + Sync + 'static,

Registers a callback invoked exactly once when an admitted Metadata job terminates.

Gate rejection does not emit a completion. attempts counts real Peer network attempts; failure-cache skips are excluded. Registering a new callback replaces the previous one.

pub fn filter<F>(&self, filter: F)

where F: Fn(&str) -> bool + Send + Sync + 'static,

Registers an early synchronous InfoHash filter for valid announce_peer queries.

Returning false prevents the Hash from entering the bounded ingress queue. Registering a new filter replaces the previous one.

pub fn set_filter<F>(&self, filter: F)

where F: Fn(&str) -> bool + Send + Sync + 'static,

Alias for Self::filter.

pub fn on_error<F>(&self, callback: F)

where F: Fn(DHTError) + Send + Sync + 'static,

Registers a runtime error callback, replacing any previous callback.

Initialization and start errors are still returned through Result.

pub fn get_node_pool_size(&self) -> usize

Returns the current strict FIFO crawl-pool size.

pub fn runtime_stats(&self) -> DhtRuntimeStats

Returns a cheap cloneable handle to transport-neutral atomic runtime statistics.

pub async fn start(&self) -> Result<()>

Starts crawl and UDP background tasks, then waits until Self::shutdown is called.

A shut-down server cannot be restarted. Construct a new DHTServer for another run.

pub fn shutdown(&self)

Cancels UDP, crawl and Metadata tasks. This method is safe to call more than once.

Trait Implementations

impl Clone for DHTServer

fn clone(&self) -> DHTServer

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.