Struct sc_network_gossip::GossipEngine

source · [−]

pub struct GossipEngine<B: BlockT> { /* private fields */ }

Expand description

Wraps around an implementation of the Network crate and provides gossiping capabilities on top of it.

Implementations

source

impl<B: BlockT> GossipEngine

source

pub fn new<N: Network + Send + Clone + 'static>(
 network: N,
 protocol: impl Into<Cow<'static, str>>,
 validator: Arc<dyn Validator>,
 metrics_registry: Option<&Registry>
) -> Self where
 B: 'static,

Create a new instance.

source

pub fn report(&self, who: PeerId, reputation: ReputationChange)

source

pub fn register_gossip_message(&mut self, topic: B::Hash, message: Vec<u8>)

Registers a message without propagating it to any peers. The message becomes available to new peers or when the service is asked to gossip the message’s topic. No validation is performed on the message, if the message is already expired it should be dropped on the next garbage collection.

source

pub fn broadcast_topic(&mut self, topic: B::Hash, force: bool)

Broadcast all messages with given topic.

source

pub fn messages_for(&mut self, topic: B::Hash) -> Receiver<TopicNotification>

Get data of valid, incoming messages for a topic (but might have expired meanwhile).

source

pub fn send_topic(&mut self, who: &PeerId, topic: B::Hash, force: bool)

Send all messages with given topic to a peer.

source

pub fn gossip_message(&mut self, topic: B::Hash, message: Vec<u8>, force: bool)

Multicast a message to all peers.

source

pub fn send_message(&mut self, who: Vec<PeerId>, data: Vec<u8>)

Send addressed message to the given peers. The message is not kept or multicast later on.

source

pub fn announce(&self, block: B::Hash, associated_data: Option<Vec<u8>>)

Notify everyone we’re connected to that we have the given block.

Note: this method isn’t strictly related to gossiping and should eventually be moved somewhere else.

Trait Implementations

source

impl<B: BlockT> Future for GossipEngine

type Output = ()

The type of value produced on completion.

source

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

Attempt to resolve the future to a final value, registering the current task for wakeup if the value is not yet available. Read more

source

impl<B: BlockT> Unpin for GossipEngine

Auto Trait Implementations

impl !RefUnwindSafe for GossipEngine

impl Send for GossipEngine

impl !Sync for GossipEngine

impl !UnwindSafe for GossipEngine

Blanket Implementations

source

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

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> CheckedConversion for T

source

fn checked_from<T>(t: T) -> Option<Self> where
Self: TryFrom<T>,

Convert from a value of T into an equivalent instance of Option<Self>. Read more

source

fn checked_into<T>(self) -> Option<T> where
Self: TryInto<T>,

Consume self to return Some equivalent value of Option<T>. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> FutureExt for T where
T: Future + ?Sized,

source

fn map<U, F>(self, f: F) -> Map<Self, F> where
F: FnOnce(Self::Output) -> U,

Map this future’s output to a different type, returning a new future of the resulting type. Read more

source

fn map_into(self) -> MapInto<Self, U> where
Self::Output: Into,

Map this future’s output to a different type, returning a new future of the resulting type. Read more

source

fn then<Fut, F>(self, f: F) -> Then<Self, Fut, F> where
F: FnOnce(Self::Output) -> Fut,
Fut: Future,

Chain on a computation for when a future finished, passing the result of the future to the provided closure f. Read more

source

fn left_future(self) -> Either<Self, B> where
B: Future<Output = Self::Output>,

Wrap this future in an Either future, making it the left-hand variant of that Either. Read more

source

fn right_future<A>(self) -> Either<A, Self> where
A: Future<Output = Self::Output>,

Wrap this future in an Either future, making it the right-hand variant of that Either. Read more

source

fn into_stream(self) -> IntoStream<Self>

Convert this future into a single element stream. Read more

source

fn flatten(self) -> Flatten<Self> where
Self::Output: Future,

Flatten the execution of this future when the output of this future is itself another future. Read more

source

fn flatten_stream(self) -> FlattenStream<Self> where
Self::Output: Stream,

Flatten the execution of this future when the successful result of this future is a stream. Read more

source

fn fuse(self) -> Fuse<Self>

Fuse a future such that poll will never again be called once it has completed. This method can be used to turn any Future into a FusedFuture. Read more

source

fn inspect<F>(self, f: F) -> Inspect<Self, F> where
F: FnOnce(&Self::Output),

Do something with the output of a future before passing it on. Read more

source

fn catch_unwind(self) -> CatchUnwind<Self> where
Self: UnwindSafe,

Catches unwinding panics while polling the future. Read more

source

fn shared(self) -> Shared<Self> where
Self::Output: Clone,

Create a cloneable handle to this future where all handles will resolve to the same result. Read more

source

fn remote_handle(self) -> (Remote<Self>, RemoteHandle<Self::Output>)

Turn this future into a future that yields () on completion and sends its output to another future on a separate task. Read more

source

fn boxed<'a>(
self
) -> Pin<Box<dyn Future<Output = Self::Output> + Send + 'a, Global>> where
Self: 'a + Send,

Wrap the future in a Box, pinning it. Read more

source

fn boxed_local<'a>(
self
) -> Pin<Box<dyn Future<Output = Self::Output> + 'a, Global>> where
Self: 'a,

Wrap the future in a Box, pinning it. Read more

source

fn unit_error(self) -> UnitError<Self>

Turns a Future<Output = T> into a TryFuture<Ok = T, Error = ()>. Read more

source

fn never_error(self) -> NeverError<Self>

Turns a Future<Output = T> into a TryFuture<Ok = T, Error = Never>. Read more

source

fn poll_unpin(&mut self, cx: &mut Context<'_>) -> Poll<Self::Output> where
Self: Unpin,

A convenience for calling Future::poll on Unpin future types.

source

fn now_or_never(self) -> Option<Self::Output>

Evaluates and consumes the future, returning the resulting output if the future is ready after the first call to Future::poll. Read more

source

impl<F> FutureExt for F where
F: Future + ?Sized,

source

fn poll(&mut self, cx: &mut Context<'_>) -> Poll<Self::Output> where
Self: Unpin,

A convenience for calling Future::poll() on !Unpin types.

source

fn or<F>(self, other: F) -> Or<Self, F> where
F: Future<Output = Self::Output>,

Returns the result of self or other future, preferring self if both are ready. Read more

source

fn race<F>(self, other: F) -> Race<Self, F> where
F: Future<Output = Self::Output>,

Returns the result of self or other future, with no preference if both are ready. Read more

source

fn catch_unwind(self) -> CatchUnwind<Self> where
Self: UnwindSafe,

Catches panics while polling the future. Read more

source

fn boxed<'a>(
self
) -> Pin<Box<dyn Future<Output = Self::Output> + Send + 'a, Global>> where
Self: 'a + Send,

Boxes the future and changes its type to dyn Future + Send + 'a. Read more

source

fn boxed_local<'a>(
self
) -> Pin<Box<dyn Future<Output = Self::Output> + 'a, Global>> where
Self: 'a,

Boxes the future and changes its type to dyn Future + 'a. Read more

source

impl<T> FutureExt for T where
T: Future + ?Sized,

source

fn delay(self, dur: Duration) -> DelayFuture<Self>

Returns a Future that delays execution for a specified time. Read more

source

fn flatten(self) -> FlattenFuture<Self, <Self::Output as IntoFuture>::Future> where
Self::Output: IntoFuture,

Flatten out the execution of this future when the result itself can be converted into another future. Read more

source

fn race<F>(self, other: F) -> Race<Self, F> where
Self: Future,
F: Future<Output = Self::Output>,

Waits for one of two similarly-typed futures to complete. Read more

source

fn try_race<F, T, E>(self, other: F) -> TryRace<Self, F> where
Self: Future<Output = Result<T, E>>,
F: Future<Output = Self::Output>,

Waits for one of two similarly-typed fallible futures to complete. Read more

source

fn join<F>(self, other: F) -> Join<Self, F> where
Self: Future,
F: Future,

Waits for two similarly-typed futures to complete. Read more

source

fn try_join<F, A, B, E>(self, other: F) -> TryJoin<Self, F> where
Self: Future<Output = Result<A, E>>,
F: Future<Output = Result<B, E>>,

Waits for two similarly-typed fallible futures to complete. Read more

source

fn timeout(self, dur: Duration) -> TimeoutFuture<Self>

Waits for both the future and a timeout, if the timeout completes before the future, it returns an TimeoutError. Read more

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> 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 for T where
U: From<T>,

const: unstable · source

pub 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<F> IntoFuture for F where
F: Future,

type Output = <F as Future>::Output

🔬 This is a nightly-only experimental API. (into_future)

The output that the future will produce on completion.

type Future = F

🔬 This is a nightly-only experimental API. (into_future)

Which kind of future are we turning this into?

source

pub fn into_future(self) -> <F as IntoFuture>::Future

🔬 This is a nightly-only experimental API. (into_future)

Creates a future from a value.

source

impl<T> IntoFuture for T where
T: Future,

type Output = <T as Future>::Output

The type of value produced on completion.

type Future = T

Which kind of future are we turning this into?

source

pub fn into_future(self) -> <T as IntoFuture>::Future

Create a future from a value

source

impl<T, Outer> IsWrappedBy<Outer> for T where
Outer: AsRef<T> + AsMut<T> + From<T>,
T: From<Outer>,

source

pub fn from_ref(outer: &Outer) -> &T

Get a reference to the inner from the outer.

source

pub fn from_mut(outer: &mut Outer) -> &mut T

Get a mutable reference to the inner from the outer.

source

impl<T> Pointable for T

source

pub const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

source

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

Initializes a with the given initializer. Read more

source

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

Dereferences the given pointer. Read more

source

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

Mutably dereferences the given pointer. Read more

source

pub unsafe fn drop(ptr: usize)

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

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<T> SaturatedConversion for T

source

fn saturated_from<T>(t: T) -> Self where
Self: UniqueSaturatedFrom<T>,

Convert from a value of T into an equivalent instance of Self. Read more

source

fn saturated_into<T>(self) -> T where
Self: UniqueSaturatedInto<T>,

Consume self to return an equivalent value of T. Read more

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

source

impl<S, T> UncheckedInto<T> for S where
T: UncheckedFrom<S>,

source

pub fn unchecked_into(self) -> T

The counterpart to unchecked_from.

source

impl<T, S> UniqueSaturatedInto<T> for S where
T: Bounded,
S: TryInto<T>,

source

pub fn unique_saturated_into(self) -> T

Consume self to return an equivalent value of 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

Struct sc_network_gossip::GossipEngine

Implementations

impl<B: BlockT> GossipEngine<B>

pub fn new<N: Network<B> + Send + Clone + 'static>( network: N, protocol: impl Into<Cow<'static, str>>, validator: Arc<dyn Validator<B>>, metrics_registry: Option<&Registry>) -> Self where B: 'static,

pub fn report(&self, who: PeerId, reputation: ReputationChange)

pub fn register_gossip_message(&mut self, topic: B::Hash, message: Vec<u8>)

pub fn broadcast_topic(&mut self, topic: B::Hash, force: bool)

pub fn messages_for(&mut self, topic: B::Hash) -> Receiver<TopicNotification>

pub fn send_topic(&mut self, who: &PeerId, topic: B::Hash, force: bool)

pub fn gossip_message(&mut self, topic: B::Hash, message: Vec<u8>, force: bool)

pub fn send_message(&mut self, who: Vec<PeerId>, data: Vec<u8>)

pub fn announce(&self, block: B::Hash, associated_data: Option<Vec<u8>>)

Trait Implementations

impl<B: BlockT> Future for GossipEngine<B>

type Output = ()

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

impl<B: BlockT> Unpin for GossipEngine<B>

Auto Trait Implementations

impl<B> !RefUnwindSafe for GossipEngine<B>

impl<B> Send for GossipEngine<B>

impl<B> !Sync for GossipEngine<B>

impl<B> !UnwindSafe for GossipEngine<B>

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

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

impl<T> CheckedConversion for T

fn checked_from<T>(t: T) -> Option<Self> where Self: TryFrom<T>,

fn checked_into<T>(self) -> Option<T> where Self: TryInto<T>,

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T> FutureExt for T where T: Future + ?Sized,

fn map<U, F>(self, f: F) -> Map<Self, F> where F: FnOnce(Self::Output) -> U,

fn map_into<U>(self) -> MapInto<Self, U> where Self::Output: Into<U>,

fn then<Fut, F>(self, f: F) -> Then<Self, Fut, F> where F: FnOnce(Self::Output) -> Fut, Fut: Future,

fn left_future<B>(self) -> Either<Self, B> where B: Future<Output = Self::Output>,

fn right_future<A>(self) -> Either<A, Self> where A: Future<Output = Self::Output>,

fn into_stream(self) -> IntoStream<Self>

fn flatten(self) -> Flatten<Self> where Self::Output: Future,

fn flatten_stream(self) -> FlattenStream<Self> where Self::Output: Stream,

fn fuse(self) -> Fuse<Self>

fn inspect<F>(self, f: F) -> Inspect<Self, F> where F: FnOnce(&Self::Output),

fn catch_unwind(self) -> CatchUnwind<Self> where Self: UnwindSafe,

fn shared(self) -> Shared<Self> where Self::Output: Clone,

fn remote_handle(self) -> (Remote<Self>, RemoteHandle<Self::Output>)

fn boxed<'a>( self) -> Pin<Box<dyn Future<Output = Self::Output> + Send + 'a, Global>> where Self: 'a + Send,

fn boxed_local<'a>( self) -> Pin<Box<dyn Future<Output = Self::Output> + 'a, Global>> where Self: 'a,

fn unit_error(self) -> UnitError<Self>

fn never_error(self) -> NeverError<Self>

fn poll_unpin(&mut self, cx: &mut Context<'_>) -> Poll<Self::Output> where Self: Unpin,

fn now_or_never(self) -> Option<Self::Output>

impl<F> FutureExt for F where F: Future + ?Sized,

fn poll(&mut self, cx: &mut Context<'_>) -> Poll<Self::Output> where Self: Unpin,

fn or<F>(self, other: F) -> Or<Self, F> where F: Future<Output = Self::Output>,

fn race<F>(self, other: F) -> Race<Self, F> where F: Future<Output = Self::Output>,

fn catch_unwind(self) -> CatchUnwind<Self> where Self: UnwindSafe,

fn boxed<'a>( self) -> Pin<Box<dyn Future<Output = Self::Output> + Send + 'a, Global>> where Self: 'a + Send,

fn boxed_local<'a>( self) -> Pin<Box<dyn Future<Output = Self::Output> + 'a, Global>> where Self: 'a,

impl<T> FutureExt for T where T: Future + ?Sized,

fn delay(self, dur: Duration) -> DelayFuture<Self>

fn flatten(self) -> FlattenFuture<Self, <Self::Output as IntoFuture>::Future> where Self::Output: IntoFuture,

fn race<F>(self, other: F) -> Race<Self, F> where Self: Future, F: Future<Output = Self::Output>,

fn try_race<F, T, E>(self, other: F) -> TryRace<Self, F> where Self: Future<Output = Result<T, E>>, F: Future<Output = Self::Output>,

fn join<F>(self, other: F) -> Join<Self, F> where Self: Future, F: Future,

fn try_join<F, A, B, E>(self, other: F) -> TryJoin<Self, F> where Self: Future<Output = Result<A, E>>, F: Future<Output = Result<B, E>>,

fn timeout(self, dur: Duration) -> TimeoutFuture<Self>

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

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

pub fn into(self) -> U

impl<F> IntoFuture for F where F: Future,

type Output = <F as Future>::Output

type Future = F

pub fn new<N: Network<B> + Send + Clone + 'static>(
network: N,
protocol: impl Into<Cow<'static, str>>,
validator: Arc<dyn Validator<B>>,
metrics_registry: Option<&Registry>
) -> Self where
B: 'static,

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

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

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

fn checked_from<T>(t: T) -> Option<Self> where
Self: TryFrom<T>,

fn checked_into<T>(self) -> Option<T> where
Self: TryInto<T>,

impl<T> FutureExt for T where
T: Future + ?Sized,

fn map<U, F>(self, f: F) -> Map<Self, F> where
F: FnOnce(Self::Output) -> U,

fn map_into<U>(self) -> MapInto<Self, U> where
Self::Output: Into<U>,

fn then<Fut, F>(self, f: F) -> Then<Self, Fut, F> where
F: FnOnce(Self::Output) -> Fut,
Fut: Future,

fn left_future<B>(self) -> Either<Self, B> where
B: Future<Output = Self::Output>,

fn right_future<A>(self) -> Either<A, Self> where
A: Future<Output = Self::Output>,

fn flatten(self) -> Flatten<Self> where
Self::Output: Future,

fn flatten_stream(self) -> FlattenStream<Self> where
Self::Output: Stream,

fn inspect<F>(self, f: F) -> Inspect<Self, F> where
F: FnOnce(&Self::Output),

fn catch_unwind(self) -> CatchUnwind<Self> where
Self: UnwindSafe,

fn shared(self) -> Shared<Self> where
Self::Output: Clone,

fn boxed<'a>(
self
) -> Pin<Box<dyn Future<Output = Self::Output> + Send + 'a, Global>> where
Self: 'a + Send,

fn boxed_local<'a>(
self
) -> Pin<Box<dyn Future<Output = Self::Output> + 'a, Global>> where
Self: 'a,

fn poll_unpin(&mut self, cx: &mut Context<'_>) -> Poll<Self::Output> where
Self: Unpin,

impl<F> FutureExt for F where
F: Future + ?Sized,

fn poll(&mut self, cx: &mut Context<'_>) -> Poll<Self::Output> where
Self: Unpin,

fn or<F>(self, other: F) -> Or<Self, F> where
F: Future<Output = Self::Output>,

fn race<F>(self, other: F) -> Race<Self, F> where
F: Future<Output = Self::Output>,

fn catch_unwind(self) -> CatchUnwind<Self> where
Self: UnwindSafe,

fn boxed<'a>(
self
) -> Pin<Box<dyn Future<Output = Self::Output> + Send + 'a, Global>> where
Self: 'a + Send,

fn boxed_local<'a>(
self
) -> Pin<Box<dyn Future<Output = Self::Output> + 'a, Global>> where
Self: 'a,

impl<T> FutureExt for T where
T: Future + ?Sized,

fn flatten(self) -> FlattenFuture<Self, <Self::Output as IntoFuture>::Future> where
Self::Output: IntoFuture,

fn race<F>(self, other: F) -> Race<Self, F> where
Self: Future,
F: Future<Output = Self::Output>,

fn try_race<F, T, E>(self, other: F) -> TryRace<Self, F> where
Self: Future<Output = Result<T, E>>,
F: Future<Output = Self::Output>,

fn join<F>(self, other: F) -> Join<Self, F> where
Self: Future,
F: Future,

fn try_join<F, A, B, E>(self, other: F) -> TryJoin<Self, F> where
Self: Future<Output = Result<A, E>>,
F: Future<Output = Result<B, E>>,

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

impl<F> IntoFuture for F where
F: Future,

impl<T> IntoFuture for T where
T: Future,

impl<T, Outer> IsWrappedBy<Outer> for T where
Outer: AsRef<T> + AsMut<T> + From<T>,
T: From<Outer>,

fn saturated_from<T>(t: T) -> Self where
Self: UniqueSaturatedFrom<T>,

fn saturated_into<T>(self) -> T where
Self: UniqueSaturatedInto<T>,

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

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

impl<S, T> UncheckedInto<T> for S where
T: UncheckedFrom<S>,

impl<T, S> UniqueSaturatedInto<T> for S where
T: Bounded,
S: TryInto<T>,

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

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