Struct pkarr::PkarrClient

pub struct PkarrClient { /* private fields */ }

Pkarr client for publishing and resolving SignedPackets over mainline.

Implementations

impl PkarrClient

pub fn new(settings: Settings) -> Result<PkarrClient>

pub fn builder() -> PkarrClientBuilder

Returns a builder to edit settings before creating PkarrClient.

pub fn local_addr(&self) -> Option<SocketAddr>

Returns the local address of the udp socket this node is listening on.

Returns None if the node is shutdown

pub fn cache(&self) -> &dyn PkarrCache

Returns a reference to the internal cache.

pub fn publish(&self, signed_packet: &SignedPacket) -> Result<()>

Publishes a SignedPacket to the Dht.

Errors

• Returns a Error::DhtIsShutdown if PkarrClient::shutdown was called, or the loop in the actor thread is stopped for any reason (like thread panic).
• Returns a Error::PublishInflight if the client is currently publishing the same public_key.
• Returns a Error::NotMostRecent if the provided signed packet is older than most recent.
• Returns a Error::MainlineError if the Dht received an unexpected error otherwise.

pub fn resolve(&self, public_key: &PublicKey) -> Result<Option<SignedPacket>>

Returns a SignedPacket from cache if it is not expired, otherwise, it will query the Dht, and return the first valid response, which may or may not be expired itself.

If the Dht was called, in the background, it continues receiving responses and updating the cache with any more recent valid packets it receives.

Errors

• Returns a Error::DhtIsShutdown if PkarrClient::shutdown was called, or the loop in the actor thread is stopped for any reason (like thread panic).

pub fn shutdown(&mut self) -> Result<()>

Shutdown the actor thread loop.

impl PkarrClient

pub fn as_async(self) -> PkarrClientAsync

Returns PkarrClientAsync

Trait Implementations

impl Clone for PkarrClient

fn clone(&self) -> PkarrClient

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PkarrClient

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.