iroh_gossip::proto::topic

Struct State

Source 
pub struct State<PI, R> { /* private fields */ }
Expand description

The topic state maintains the swarm membership and broadcast tree for a particular topic.

Implementations§

Source§

impl<PI: PeerIdentity> State<PI, StdRng>

Source

pub fn new(me: PI, me_data: Option<PeerData>, config: Config) -> Self

Initialize the local state with the default random number generator.

Source§

impl<PI, R> State<PI, R>

Source

pub fn endpoint(&self) -> &PI

The address of your local endpoint.

Source§

impl<PI: PeerIdentity, R: Rng> State<PI, R>

Source

pub fn with_rng( me: PI, me_data: Option<PeerData>, config: Config, rng: R, ) -> Self

Initialize the local state with a custom random number generator.

Source

pub fn handle( &mut self, event: InEvent<PI>, now: Instant, ) -> impl Iterator<Item = OutEvent<PI>> + '_

Handle an incoming event.

Returns an iterator of outgoing events that must be processed by the application.

Source

pub fn stats(&self) -> &Stats

Get stats on how many messages were sent and received

TODO: Remove/replace with metrics?

Source

pub fn gossip_stats(&self) -> &Stats

Get statistics for the gossip broadcast state

TODO: Remove/replace with metrics?

Source

pub fn has_active_peers(&self) -> bool

Check if this topic has any active (connected) peers.

Trait Implementations§

Source§

impl<PI: Debug, R: Debug> Debug for State<PI, R>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<PI, R> !Freeze for State<PI, R>

§

impl<PI, R> RefUnwindSafe for State<PI, R>
where PI: RefUnwindSafe, R: RefUnwindSafe,

§

impl<PI, R> Send for State<PI, R>
where PI: Send, R: Send,

§

impl<PI, R> Sync for State<PI, R>
where PI: Sync, R: Sync,

§

impl<PI, R> Unpin for State<PI, R>
where PI: Unpin, R: Unpin,

§

impl<PI, R> UnwindSafe for State<PI, R>
where PI: UnwindSafe, R: UnwindSafe,

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
§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

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.

§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

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

Initializes a with the given initializer. Read more
§

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

Dereferences the given pointer. Read more
§

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

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

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

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
§

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

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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

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

§

impl<T> MaybeSendSync for T