karyon_p2p::backend

Struct Backend

Source
pub struct Backend {
    config: Arc<Config>,
    key_pair: KeyPair,
    peer_id: PeerID,
    monitor: Arc<Monitor>,
    discovery: Arc<Discovery>,
    peer_pool: Arc<PeerPool>,
}
Expand description

Backend serves as the central entry point for initiating and managing the P2P network.

Fields§

§config: Arc<Config>

The Configuration for the P2P network.

§key_pair: KeyPair

Identity Key pair

§peer_id: PeerID

Peer ID

§monitor: Arc<Monitor>

Responsible for network and system monitoring.

§discovery: Arc<Discovery>

Discovery instance.

§peer_pool: Arc<PeerPool>

PeerPool instance.

Implementations§

Source§

impl Backend

Source

pub fn new(key_pair: &KeyPair, config: Config, ex: Executor) -> Arc<Backend>

Creates a new Backend.

Source

pub async fn run(self: &Arc<Self>) -> Result<()>

Run the Backend, starting the PeerPool and Discovery instances.

Source

pub async fn attach_protocol<P: Protocol>( &self, c: impl Fn(Arc<Peer>) -> Arc<dyn Protocol> + Send + Sync + 'static, ) -> Result<()>

Attach a custom protocol to the network

Source

pub async fn peers(&self) -> usize

Returns the number of currently connected peers.

Source

pub fn config(&self) -> Arc<Config>

Returns the Config.

Source

pub fn peer_id(&self) -> &PeerID

Returns the PeerID.

Source

pub fn key_pair(&self) -> &KeyPair

Returns the KeyPair.

Source

pub async fn inbound_peers(&self) -> HashMap<PeerID, Endpoint>

Returns a map of inbound connected peers with their endpoints.

Source

pub async fn outbound_peers(&self) -> HashMap<PeerID, Endpoint>

Returns a map of outbound connected peers with their endpoints.

Source

pub fn monitor(&self) -> Arc<Monitor>

Returns the monitor to receive system events.

Source

pub async fn shutdown(&self)

Shuts down the Backend.

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
§

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.

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