Struct Config 

pub struct Config { /* private fields */ }

Top-level configuration combining all settings.

Implementations

impl Config

pub fn builder() -> ConfigBuilder

Create a new ConfigBuilder with default values.

Examples found in repository

examples/without_mergers.rs (line 41)

async fn main() -> Result<()> {
    // Generate a new random secret key
    let secret_key = SecretKey::generate();
    let signing_key = SigningKey::from_bytes(&secret_key.to_bytes());

    // Set up endpoint with discovery enabled
    let endpoint = Endpoint::builder(iroh::endpoint::presets::N0)
        .secret_key(secret_key.clone())
        .bind()
        .await?;

    // Initialize gossip with auto-discovery
    let gossip = Gossip::builder().spawn(endpoint.clone());

    // Set up protocol router
    let _router = iroh::protocol::Router::builder(endpoint.clone())
        .accept(iroh_gossip::ALPN, gossip.clone())
        .spawn();

    let topic_id = TopicId::new("my-iroh-gossip-topic".to_string());
    let initial_secret = b"my-initial-secret".to_vec();

    let record_publisher = RecordPublisher::new(
        topic_id.clone(),
        signing_key.clone(),
        None,
        initial_secret,
        // [!] Disable merge workers (BubbleMerge and MessageOverlapMerge)
        Config::builder()
            .merge_config(
                MergeConfig::builder()
                    .bubble_merge(BubbleMergeConfig::Disabled)
                    .message_overlap_merge(MessageOverlapMergeConfig::Disabled)
                    .build(),
            )
            .build(),
    );

    let topic = gossip
        .subscribe_and_join_with_auto_discovery(record_publisher)
        .await?;

    println!("[joined topic]");

    // Do something with the gossip topic
    // (bonus: GossipSender and GossipReceiver are safely clonable)
    let (_gossip_sender, _gossip_receiver) = topic.split().await?;

    Ok(())
}

examples/full_config.rs (line 18)

fn config_builder() -> Config {
    Config::builder()
        .dht_config(
            DhtConfig::builder()
                .retries(3)
                .base_retry_interval(Duration::from_secs(5))
                .max_retry_jitter(Duration::from_secs(10))
                .get_timeout(Duration::from_secs(10))
                .put_timeout(Duration::from_secs(10))
                .build(),
        )
        .bootstrap_config(
            BootstrapConfig::builder()
                .max_bootstrap_records(5)
                .publish_record_on_startup(true)
                .check_older_records_first_on_startup(false)
                .discovery_poll_interval(Duration::from_millis(2000))
                .no_peers_retry_interval(Duration::from_millis(1500))
                .per_peer_join_settle_time(Duration::from_millis(100))
                .join_confirmation_wait_time(Duration::from_millis(500))
                .build(),
        )
        .max_join_peer_count(4)
        .publisher_config(
            PublisherConfig::builder()
                .initial_delay(Duration::from_secs(10))
                .base_interval(Duration::from_secs(10))
                .max_jitter(Duration::from_secs(50))
                .build(),
        )
        .merge_config(
            MergeConfig::builder()
                .bubble_merge(
                    BubbleMergeConfig::builder()
                        .min_neighbors(4)
                        .initial_interval(Duration::from_secs(30))
                        .base_interval(Duration::from_secs(60))
                        .max_jitter(Duration::from_secs(120))
                        .fail_topic_creation_on_merge_startup_failure(true)
                        .max_join_peers(2)
                        .build(),
                )
                .message_overlap_merge(
                    MessageOverlapMergeConfig::builder()
                        .initial_interval(Duration::from_secs(30))
                        .base_interval(Duration::from_secs(60))
                        .max_jitter(Duration::from_secs(120))
                        .fail_topic_creation_on_merge_startup_failure(true)
                        .max_join_peers(2)
                        .build(),
                )
                .build(),
        )
        .timeouts(
            TimeoutConfig::builder()
                .join_peer_timeout(Duration::from_secs(5))
                .broadcast_neighbors_timeout(Duration::from_secs(5))
                .broadcast_timeout(Duration::from_secs(5))
                .build(),
        )
        .build()
}

examples/chat.rs (line 52)

async fn main() -> Result<()> {
    // tracing init - only show distributed_topic_tracker logs
    use tracing_subscriber::filter::EnvFilter;

    tracing_subscriber::fmt()
        .with_thread_ids(true)
        .with_ansi(true)
        .with_env_filter(
            EnvFilter::try_from_default_env()
                .unwrap_or_else(|_| EnvFilter::new("distributed_topic_tracker=debug")),
        )
        .init();

    // Generate a new random secret key
    let secret_key = SecretKey::generate();
    let signing_key = SigningKey::from_bytes(&secret_key.to_bytes());

    // Set up endpoint with discovery enabled
    let endpoint = Endpoint::builder(iroh::endpoint::presets::N0)
        .secret_key(secret_key.clone())
        .bind()
        .await?;

    // Initialize gossip with auto-discovery
    let gossip = Gossip::builder().spawn(endpoint.clone());

    // Set up protocol router
    let _router = iroh::protocol::Router::builder(endpoint.clone())
        .accept(iroh_gossip::ALPN, gossip.clone())
        .spawn();

    let topic_id = TopicId::new("my-iroh-gossip-topic".to_string());
    let initial_secret = b"my-initial-secret".to_vec();

    let record_publisher = RecordPublisher::new(
        topic_id.clone(),
        signing_key.clone(),
        None,
        initial_secret,
        Config::builder()
            .bootstrap_config(
                BootstrapConfig::builder()
                    .check_older_records_first_on_startup(false)
                    .build(),
            )
            .build(),
    );

    // Split into sink (sending) and stream (receiving)
    let (gossip_sender, mut gossip_receiver) = gossip
        .subscribe_and_join_with_auto_discovery(record_publisher)
        .await?
        .split()
        .await?;

    println!("Joined topic");

    // Spawn listener for incoming messages
    tokio::spawn(async move {
        while let Ok(event) = gossip_receiver.next().await {
            if let Event::Received(msg) = event {
                println!(
                    "\nMessage from {}: {}",
                    &msg.delivered_from.to_string()[0..8],
                    String::from_utf8(msg.content.to_vec()).unwrap()
                );
            } else if let Event::NeighborUp(peer) = event {
                println!("\nJoined by {}", &peer.to_string()[0..8]);
            }
        }
        println!("\nGossip receiver stream ended");
    });

    // Main input loop for sending messages
    let mut buffer = String::new();
    let stdin = std::io::stdin();
    loop {
        print!("\n> ");
        stdin.read_line(&mut buffer).unwrap();
        gossip_sender
            .broadcast(
                buffer
                    .trim_end_matches(&['\r', '\n'][..])
                    .as_bytes()
                    .to_vec(),
            )
            .await
            .unwrap();
        println!(" - (sent)");
        buffer.clear();
    }
}

pub fn publisher_config(&self) -> &PublisherConfig

Publisher strategy config.

Default: PublisherConfig::default().

pub fn dht_config(&self) -> &DhtConfig

DHT operation settings.

Default: DhtConfig::default().

pub fn bootstrap_config(&self) -> &BootstrapConfig

Bootstrap strategy settings.

Default: BootstrapConfig::default().

pub fn max_join_peer_count(&self) -> usize

Max peers to join simultaneously.

Minimum is 1.

Default: 4.

pub fn timeouts(&self) -> &TimeoutConfig

Timeout settings.

Default: TimeoutConfig::default().

pub fn merge_config(&self) -> &MergeConfig

Merge strategy settings.

Default: bubble and overlap merges enabled.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.