Struct PkarrPublisher

pub struct PkarrPublisher { /* private fields */ }

Publisher of node discovery information to a pkarr relay.

This publisher uses HTTP to publish node discovery information to a pkarr relay server, see the module docs for details.

This implements the Discovery trait to be used as a node discovery service. Note that it only publishes node discovery information, for the corresponding resolver use the PkarrResolver together with ConcurrentDiscovery.

This publisher will only publish the RelayUrl if the AddrInfo contains a RelayUrl. If the AddrInfo does not contain a RelayUrl the direct addresses are published instead.

Implementations

impl PkarrPublisher

pub fn new(secret_key: SecretKey, pkarr_relay: Url) -> Self

Creates a new publisher for the SecretKey.

This publisher will be able to publish pkarr records for SecretKey. It will use DEFAULT_PKARR_TTL as the time-to-live value for the published packets. Will republish discovery information every DEFAULT_REPUBLISH_INTERVAL, even if the information is unchanged.

pub fn with_options( secret_key: SecretKey, pkarr_relay: Url, ttl: u32, republish_interval: Duration, ) -> Self

Creates a new PkarrPublisher with a custom TTL and republish intervals.

This allows creating the publisher with custom time-to-live values of the pkarr::SignedPackets and well as a custom republish interval.

pub fn n0_dns(secret_key: SecretKey) -> Self

Creates a pkarr publisher which uses the number 0 pkarr relay server.

This uses the pkarr relay server operated by number 0, at N0_DNS_PKARR_RELAY_PROD.

When running with the environment variable IROH_FORCE_STAGING_RELAYS set to any non empty value N0_DNS_PKARR_RELAY_STAGING server is used instead.

pub fn update_addr_info(&self, info: &AddrInfo)

Publishes AddrInfo about this node to a pkarr relay.

This is a nonblocking function, the actual update is performed in the background.

Trait Implementations

impl Clone for PkarrPublisher

fn clone(&self) -> PkarrPublisher

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PkarrPublisher

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

Formats the value using the given formatter.

impl Discovery for PkarrPublisher

fn publish(&self, info: &AddrInfo)

Publishes the given AddrInfo to the discovery mechanism.

fn resolve( &self, _endpoint: Endpoint, _node_id: NodeId, ) -> Option<BoxStream<Result<DiscoveryItem>>>

Resolves the AddrInfo for the given NodeId.

fn subscribe(&self) -> Option<BoxStream<DiscoveryItem>>

Subscribe to all addresses that get passively discovered.

impl Drop for PkarrPublisher

fn drop(&mut self)

Executes the destructor for this type.