Struct Topic 

pub struct Topic<R: SecretRotation + Default + Clone + Send + 'static> { /* private fields */ }

Implementations

impl<R: SecretRotation + Default + Clone + Send + 'static> Topic<R>

pub async fn new( topic_id: TopicId, endpoint: &Endpoint, node_signing_key: &SigningKey, gossip: Gossip, initial_secret: &Vec<u8>, secret_rotation_function: Option<R>, async_bootstrap: bool, ) -> Result<Self>

pub fn split(&self) -> (GossipSender, GossipReceiver)

Examples found in repository

examples/e2e_test.rs (line 38)

async fn main() -> Result<()> {
    // Generate a new random secret key
    let secret_key = SecretKey::generate(rand::rngs::OsRng);

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

    // Initialize gossip with auto-discovery
    let gossip = Gossip::builder()
        .spawn_with_auto_discovery::<DefaultSecretRotation>(endpoint.clone(), None)
        .await?;

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

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

    // Split into sink (sending) and stream (receiving)
    let (tx,mut rx) = gossip
        .subscribe_and_join_with_auto_discovery(topic_id, initial_secret)
        .await?.split();

    tokio::spawn(async move {
        let mut rx = rx.subscribe().await.unwrap();
        while let Ok(event) = rx.recv().await {
            println!("{event:?}");
        }
    });


    tokio::time::sleep(std::time::Duration::from_secs(3)).await;
    tx.broadcast(format!("hi from {}",endpoint.node_id()).into()).await?;


    // print "[joined topic]" to stdout in success case
    println!("[joined topic]");

    tokio::time::sleep(std::time::Duration::from_secs(10)).await;

    println!("[finished]");

    // successfully joined
    // exit with code 0
    Ok(())
}

examples/secret_rotation.rs (line 61)

async fn main() -> Result<()> {
    // Generate a new random secret key
    let secret_key = SecretKey::generate(rand::rngs::OsRng);

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

    // Initialize gossip with auto-discovery
    let gossip = Gossip::builder()
        .spawn_with_auto_discovery::<MySecretRotation>(endpoint.clone(), None)
        .await?;

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

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

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

    println!("Joined topic");

    // Spawn listener for incoming messages
    tokio::spawn(async move {
        let mut reader = stream.subscribe().await.unwrap();
        while let Ok(event) = reader.recv().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]);
            }
        }
    });

    // 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();
        sink.broadcast(buffer.clone().replace("\n", "").into())
            .await
            .unwrap();
        println!(" - (sent)");
        buffer.clear();
    }
}

examples/chat.rs (line 39)

async fn main() -> Result<()> {
    // Generate a new random secret key
    let secret_key = SecretKey::generate(rand::rngs::OsRng);

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

    // Initialize gossip with auto-discovery
    let gossip = Gossip::builder()
        .spawn_with_auto_discovery::<DefaultSecretRotation>(endpoint.clone(), None)
        .await?;

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

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

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

    println!("Joined topic");

    // Spawn listener for incoming messages
    tokio::spawn(async move {
        let mut reader = stream.subscribe().await.unwrap();
        while let Ok(event) = reader.recv().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]);
            }
        }
    });

    // 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();
        sink.broadcast(buffer.clone().replace("\n", "").into())
            .await
            .unwrap();
        println!(" - (sent)");
        buffer.clear();
    }
}

examples/chat_no_wait.rs (line 39)

async fn main() -> Result<()> {
    // Generate a new random secret key
    let secret_key = SecretKey::generate(rand::rngs::OsRng);

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

    // Initialize gossip with auto-discovery
    let gossip = Gossip::builder()
        .spawn_with_auto_discovery::<DefaultSecretRotation>(endpoint.clone(), None)
        .await?;

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

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

    // Split into sink (sending) and stream (receiving)
    let (sink, mut stream) = gossip
        .subscribe_and_join_with_auto_discovery_no_wait(topic_id, initial_secret)
        .await?
        .split();

    println!("Joined topic");

    // Spawn listener for incoming messages
    tokio::spawn(async move {
        let mut reader = stream.subscribe().await.unwrap();
        while let Ok(event) = reader.recv().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]);
            }
        }
    });

    // 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();
        sink.broadcast(buffer.clone().replace("\n", "").into())
            .await
            .unwrap();
        println!(" - (sent)");
        buffer.clear();
    }
}

pub fn topic_id(&self) -> &TopicId

pub fn node_id(&self) -> &NodeId

pub fn gossip_sender(&self) -> GossipSender

pub fn gossip_receiver(&self) -> GossipReceiver

pub fn secret_rotation_function(&self) -> R

pub fn initial_secret_hash(&self) -> [u8; 32]

pub fn set_initial_secret_hash(&mut self, initial_secret_hash: [u8; 32])

impl<R: SecretRotation + Default + Clone + Send + 'static> Topic<R>

pub async fn bootstrap_no_wait( topic_id: TopicId, endpoint: &Endpoint, node_signing_key: &SigningKey, gossip: Gossip, initial_secret_hash: [u8; 32], secret_rotation_function: Option<R>, ) -> Result<(GossipSender, GossipReceiver)>

pub async fn bootstrap( topic_id: TopicId, endpoint: &Endpoint, node_signing_key: &SigningKey, gossip: Gossip, initial_secret_hash: [u8; 32], secret_rotation_function: Option<R>, ) -> Result<(GossipSender, GossipReceiver)>

Trait Implementations

impl<R: Debug + SecretRotation + Default + Clone + Send + 'static> Debug for Topic<R>

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

Formats the value using the given formatter.