GossipReceiver

Struct GossipReceiver 

Source
pub struct GossipReceiver { /* private fields */ }

Implementations§

Source§

impl GossipReceiver

Source

pub fn new(gossip_receiver: GossipReceiver, gossip: Gossip) -> Self

Source

pub async fn neighbors(&self) -> HashSet<NodeId>

Source

pub async fn is_joined(&self) -> bool

Source

pub async fn next(&self) -> Option<Result<Event, ApiError>>

Examples found in repository?
examples/e2e_test.rs (line 47)
11async fn main() -> Result<()> {
12    // Generate a new random secret key
13    let secret_key = SecretKey::generate(rand::rngs::OsRng);
14
15    // Set up endpoint with discovery enabled
16    let endpoint = Endpoint::builder()
17        .secret_key(secret_key.clone())
18        .discovery_n0()
19        .bind()
20        .await?;
21
22    // Initialize gossip with auto-discovery
23    let gossip = Gossip::builder()
24        .spawn(endpoint.clone());
25
26    // Set up protocol router
27    let _router = iroh::protocol::Router::builder(endpoint.clone())
28        .accept(iroh_gossip::ALPN, gossip.clone())
29        .spawn();
30
31    let topic_id = TopicId::new("my-iroh-gossip-topic".to_string());
32    let initial_secret = b"my-initial-secret".to_vec();
33
34    let record_publisher = RecordPublisher::new(
35        topic_id.clone(),
36        endpoint.node_id().public(),
37        secret_key.secret().clone(),
38        None,
39        initial_secret,
40    );
41    let (gossip_sender, gossip_receiver) = gossip
42        .subscribe_and_join_with_auto_discovery(record_publisher)
43        .await?
44        .split().await?;
45
46    tokio::spawn(async move {
47        while let Some(Ok(event)) = gossip_receiver.next().await {
48            println!("event: {event:?}");
49        }
50    });
51
52
53    tokio::time::sleep(std::time::Duration::from_secs(3)).await;
54    gossip_sender.broadcast(format!("hi from {}",endpoint.node_id()).into()).await?;
55
56    println!("[joined topic]");
57
58    tokio::time::sleep(std::time::Duration::from_secs(10)).await;
59
60    println!("[finished]");
61
62    // successfully joined
63    // exit with code 0
64    Ok(())
65}
More examples
Hide additional examples
examples/chat_no_wait.rs (line 50)
11async fn main() -> Result<()> {
12    // Generate a new random secret key
13    let secret_key = SecretKey::generate(rand::rngs::OsRng);
14
15    // Set up endpoint with discovery enabled
16    let endpoint = Endpoint::builder()
17        .secret_key(secret_key.clone())
18        .discovery_n0()
19        .bind()
20        .await?;
21
22    // Initialize gossip with auto-discovery
23    let gossip = Gossip::builder()
24        .spawn(endpoint.clone());
25
26    // Set up protocol router
27    let _router = iroh::protocol::Router::builder(endpoint.clone())
28        .accept(iroh_gossip::ALPN, gossip.clone())
29        .spawn();
30
31    let topic_id = TopicId::new("my-iroh-gossip-topic".to_string());
32    let initial_secret = b"my-initial-secret".to_vec();
33
34    let record_publisher = RecordPublisher::new(
35        topic_id.clone(),
36        endpoint.node_id().public(),
37        secret_key.secret().clone(),
38        None,
39        initial_secret,
40    );
41    let (gossip_sender, gossip_receiver) = gossip
42        .subscribe_and_join_with_auto_discovery_no_wait(record_publisher)
43        .await?
44        .split().await?;
45
46    println!("Joined topic");
47
48    // Spawn listener for incoming messages
49    tokio::spawn(async move {
50        while let Some(Ok(event)) = gossip_receiver.next().await {
51            if let Event::Received(msg) = event {
52                println!(
53                    "\nMessage from {}: {}",
54                    &msg.delivered_from.to_string()[0..8],
55                    String::from_utf8(msg.content.to_vec()).unwrap()
56                );
57            } else if let Event::NeighborUp(peer) = event {
58                println!("\nJoined by {}", &peer.to_string()[0..8]);
59            }
60        }
61    });
62
63    // Main input loop for sending messages
64    let mut buffer = String::new();
65    let stdin = std::io::stdin();
66    loop {
67        print!("\n> ");
68        stdin.read_line(&mut buffer).unwrap();
69        gossip_sender.broadcast(buffer.clone().replace("\n", "").into())
70            .await
71            .unwrap();
72        println!(" - (sent)");
73        buffer.clear();
74    }
75}
examples/chat.rs (line 53)
11async fn main() -> Result<()> {
12    // Generate a new random secret key
13    let secret_key = SecretKey::generate(rand::rngs::OsRng);
14
15    // Set up endpoint with discovery enabled
16    let endpoint = Endpoint::builder()
17        .secret_key(secret_key.clone())
18        .discovery_n0()
19        .bind()
20        .await?;
21
22    // Initialize gossip with auto-discovery
23    let gossip = Gossip::builder()
24        .spawn(endpoint.clone());
25
26    // Set up protocol router
27    let _router = iroh::protocol::Router::builder(endpoint.clone())
28        .accept(iroh_gossip::ALPN, gossip.clone())
29        .spawn();
30
31    let topic_id = TopicId::new("my-iroh-gossip-topic".to_string());
32    let initial_secret = b"my-initial-secret".to_vec();
33
34
35    let record_publisher = RecordPublisher::new(
36        topic_id.clone(),
37        endpoint.node_id().public(),
38        secret_key.secret().clone(),
39        None,
40        initial_secret,
41    );
42        
43    // Split into sink (sending) and stream (receiving)
44    let (gossip_sender, gossip_receiver) = gossip
45        .subscribe_and_join_with_auto_discovery(record_publisher)
46        .await?
47        .split().await?;
48
49    println!("Joined topic");
50
51    // Spawn listener for incoming messages
52    tokio::spawn(async move {
53        while let Some(Ok(event)) = gossip_receiver.next().await {
54            if let Event::Received(msg) = event {
55                println!(
56                    "\nMessage from {}: {}",
57                    &msg.delivered_from.to_string()[0..8],
58                    String::from_utf8(msg.content.to_vec()).unwrap()
59                );
60            } else if let Event::NeighborUp(peer) = event {
61                println!("\nJoined by {}", &peer.to_string()[0..8]);
62            }
63        }
64    });
65
66    // Main input loop for sending messages
67    let mut buffer = String::new();
68    let stdin = std::io::stdin();
69    loop {
70        print!("\n> ");
71        stdin.read_line(&mut buffer).unwrap();
72        gossip_sender.broadcast(buffer.clone().replace("\n", "").into())
73            .await
74            .unwrap();
75        println!(" - (sent)");
76        buffer.clear();
77    }
78}
examples/secret_rotation.rs (line 71)
30async fn main() -> Result<()> {
31    // Generate a new random secret key
32    let secret_key = SecretKey::generate(rand::rngs::OsRng);
33
34    // Set up endpoint with discovery enabled
35    let endpoint = Endpoint::builder()
36        .secret_key(secret_key.clone())
37        .discovery_n0()
38        .bind()
39        .await?;
40
41    // Initialize gossip with auto-discovery
42    let gossip = Gossip::builder()
43        .spawn(endpoint.clone());
44
45    // Set up protocol router
46    let _router = iroh::protocol::Router::builder(endpoint.clone())
47        .accept(iroh_gossip::ALPN, gossip.clone())
48        .spawn();
49
50    let topic_id = TopicId::new("my-iroh-gossip-topic".to_string());
51    let initial_secret = b"my-initial-secret".to_vec();
52
53    // Split into sink (sending) and stream (receiving)
54
55    let record_publisher = RecordPublisher::new(
56        topic_id.clone(),
57        endpoint.node_id().public(),
58        secret_key.secret().clone(),
59        Some(RotationHandle::new(MySecretRotation)),
60        initial_secret,
61    );
62    let (gossip_sender, gossip_receiver) = gossip
63        .subscribe_and_join_with_auto_discovery(record_publisher)
64        .await?
65        .split().await?;
66
67    println!("Joined topic");
68
69    // Spawn listener for incoming messages
70    tokio::spawn(async move {
71        while let Some(Ok(event)) = gossip_receiver.next().await {
72            if let Event::Received(msg) = event {
73                println!(
74                    "\nMessage from {}: {}",
75                    &msg.delivered_from.to_string()[0..8],
76                    String::from_utf8(msg.content.to_vec()).unwrap()
77                );
78            } else if let Event::NeighborUp(peer) = event {
79                println!("\nJoined by {}", &peer.to_string()[0..8]);
80            }
81        }
82    });
83
84    // Main input loop for sending messages
85    let mut buffer = String::new();
86    let stdin = std::io::stdin();
87    loop {
88        print!("\n> ");
89        stdin.read_line(&mut buffer).unwrap();
90        gossip_sender.broadcast(buffer.clone().replace("\n", "").into())
91            .await
92            .unwrap();
93        println!(" - (sent)");
94        buffer.clear();
95    }
96}
Source

pub async fn last_message_hashes(&self) -> Vec<[u8; 32]>

Trait Implementations§

Source§

impl Clone for GossipReceiver

Source§

fn clone(&self) -> GossipReceiver

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for GossipReceiver

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> CompatExt for T

Source§

fn compat(self) -> Compat<T>

Applies the Compat adapter by value. Read more
Source§

fn compat_ref(&self) -> Compat<&T>

Applies the Compat adapter by shared reference. Read more
Source§

fn compat_mut(&mut self) -> Compat<&mut T>

Applies the Compat adapter by mutable reference. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,