libp2p_floodsub/
lib.rs

1// Copyright 2018 Parity Technologies (UK) Ltd.
2//
3// Permission is hereby granted, free of charge, to any person obtaining a
4// copy of this software and associated documentation files (the "Software"),
5// to deal in the Software without restriction, including without limitation
6// the rights to use, copy, modify, merge, publish, distribute, sublicense,
7// and/or sell copies of the Software, and to permit persons to whom the
8// Software is furnished to do so, subject to the following conditions:
9//
10// The above copyright notice and this permission notice shall be included in
11// all copies or substantial portions of the Software.
12//
13// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
14// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
18// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
19// DEALINGS IN THE SOFTWARE.
20
21//! Implementation of the [floodsub](https://github.com/libp2p/specs/blob/master/pubsub/README.md) protocol.
22
23#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
24
25use libp2p_identity::PeerId;
26
27pub mod protocol;
28
29mod layer;
30mod topic;
31
32mod proto {
33    #![allow(unreachable_pub)]
34    include!("generated/mod.rs");
35    pub(crate) use self::floodsub::pb::{mod_RPC::SubOpts, Message, RPC};
36}
37
38pub use self::{
39    layer::{Floodsub, FloodsubEvent},
40    protocol::{FloodsubMessage, FloodsubRpc},
41    topic::Topic,
42};
43
44/// Configuration options for the Floodsub protocol.
45#[derive(Debug, Clone)]
46pub struct FloodsubConfig {
47    /// Peer id of the local node. Used for the source of the messages that we publish.
48    pub local_peer_id: PeerId,
49
50    /// `true` if messages published by local node should be propagated as messages received from
51    /// the network, `false` by default.
52    pub subscribe_local_messages: bool,
53}
54
55impl FloodsubConfig {
56    pub fn new(local_peer_id: PeerId) -> Self {
57        Self {
58            local_peer_id,
59            subscribe_local_messages: false,
60        }
61    }
62}
libp2p_floodsub/lib.rs

libp2p_floodsub/
lib.rs
