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//! Implements the floodsub protocol, see also the:
22//! [spec](https://github.com/libp2p/specs/tree/master/pubsub).
23
24use libp2p_core::PeerId;
25
26pub mod protocol;
27
28mod layer;
29mod topic;
30
31mod rpc_proto {
32    include!(concat!(env!("OUT_DIR"), "/floodsub.pb.rs"));
33}
34
35pub use self::layer::{Floodsub, FloodsubEvent};
36pub use self::protocol::{FloodsubMessage, FloodsubRpc};
37pub use self::topic::Topic;
38
39/// Configuration options for the Floodsub protocol.
40pub struct FloodsubConfig {
41    /// Peer id of the local node. Used for the source of the messages that we publish.
42    pub local_peer_id: PeerId,
43
44    /// `true` if messages published by local node should be propagated as messages received from
45    /// the network, `false` by default.
46    pub subscribe_local_messages: bool,
47}
48
49impl FloodsubConfig {
50    pub fn new(local_peer_id: PeerId) -> Self {
51        Self {
52            local_peer_id,
53            subscribe_local_messages: false
54        }
55    }
56}
libp2p_floodsub/lib.rs

libp2p_floodsub/
lib.rs
