Struct splinter::peer::PeerManagerConnector

source · [−]

pub struct PeerManagerConnector { /* private fields */ }

Expand description

The PeerManagerConnector will be used to make requests to the PeerManager.

The connector includes functions to add a new peer reference, update a peer and list the existing peers.

Implementations

source

impl PeerManagerConnector

source

pub fn add_peer_ref(
 &self,
 peer_id: PeerAuthorizationToken,
 endpoints: Vec<String>,
 required_local_auth: PeerAuthorizationToken
) -> Result<PeerRef, PeerRefAddError>

Requests that a peer is added to the PeerManager. If a peer already exists, the peer’s reference count will be incremented

Returns a PeerRef that, when dropped, will automatically send a removal request to the PeerManager.

Arguments

peer_id - The unique PeerAuthorizationToken for the peer.
endpoints - The list of endpoints associated with the peer. The list should be in order of preference, with the first endpoint being the first attempted.
required_local_auth - The local authorization that must be used to identify the local node during authorization.

source

pub fn add_unidentified_peer(
 &self,
 endpoint: String,
 local_authorization: PeerAuthorizationToken
) -> Result<EndpointPeerRef, PeerUnknownAddError>

Requests that a peer is added to the PeerManager. This function should be used when the peer ID is unknown.

Returns Ok(EndpointPeerRef) if the unidentified peer was added

Arguments

endpoint - The endpoint associated with the peer.
local_authorization - The required PeerAuthorizationToken that will be used to identify
the local node.

source

pub fn list_peers(&self) -> Result<Vec<PeerAuthorizationToken>, PeerListError>

Requests the list of currently connected peers.

Returns the list of peer IDs.

source

pub fn list_unreferenced_peers(
&self
) -> Result<Vec<PeerTokenPair>, PeerListError>

Requests the list of unreferenced peers.

Unreferenced peers are those peers that have successfully connected from a remote node, but have not yet been referenced by a circuit. These peers are available to be promoted to fully refrerenced peers.

source

pub fn connection_ids(
&self
) -> Result<BiHashMap<PeerTokenPair, String>, PeerConnectionIdError>

Requests the map of currently connected peers to connection IDs

Returns a map of peer IDs to connection IDs

👎 Deprecated since 0.5.1:

please use subscribe_sender instead

Subscribes to PeerManager notifications.

Returns a PeerNotificationIter that can be used to receive notifications about connected and disconnected peers

source

pub fn subscribe_sender<T>(
 &self,
 subscriber: Sender<T>
) -> Result<SubscriberId, PeerManagerError> where
 T: From<PeerManagerNotification> + Send + 'static,

Subscribe to notifications for peer events.

PeerManagerNotification instances will be transformed via type T’s implementation of From<PeerManagerNotification> and passed to the given sender.

Returns

The subscriber ID that can be used for unsubscribing the given sender.

Errors

Return a PeerManagerError if the subscriber cannot be registered via the PeerManagerConnector instance.

source

pub fn unsubscribe(
&self,
subscriber_id: SubscriberId
) -> Result<(), PeerManagerError>

Unsubscribe from PeerManagerNotification.

Errors

Returns a PeerManagerError if the PeerManager has stopped running.

Trait Implementations

source

impl Clone for PeerManagerConnector

source

fn clone(&self) -> PeerManagerConnector

Returns a copy of the value. Read more

1.0.0 · source

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

source

impl Debug for PeerManagerConnector

source

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

Formats the value using the given formatter. Read more

source

impl PeerLookup for PeerManagerConnector

source

fn connection_id(
&self,
peer_id: &PeerTokenPair
) -> Result<Option<String>, PeerLookupError>

Retrieves the connection ID for a given peer ID, if found. Read more

source

fn peer_id(
&self,
connection_id: &str
) -> Result<Option<PeerTokenPair>, PeerLookupError>

Retrieves the peer ID for a given connection ID, if found. Read more

Auto Trait Implementations

impl !RefUnwindSafe for PeerManagerConnector

impl Send for PeerManagerConnector

impl !Sync for PeerManagerConnector

impl Unpin for PeerManagerConnector

impl !UnwindSafe for PeerManagerConnector

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

source

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

const: unstable · source

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

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

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

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

fn into_sql<T>(self) -> Self::Expression where
Self: AsExpression<T>,

Convert self to an expression for Diesel’s query builder. Read more

source

fn as_sql<'a, T>(&'a self) -> <&'a Self as AsExpression<T>>::Expression where
&'a Self: AsExpression<T>,

Convert &self to an expression for Diesel’s query builder. Read more

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

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

Uses borrowed data to replace owned data, usually by cloning. 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

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

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

Performs the conversion.

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

fn vzip(self) -> V

source

impl<T> WithSubscriber for 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 splinter::peer::PeerManagerConnector

Implementations

impl PeerManagerConnector

pub fn add_peer_ref( &self, peer_id: PeerAuthorizationToken, endpoints: Vec<String>, required_local_auth: PeerAuthorizationToken) -> Result<PeerRef, PeerRefAddError>

pub fn add_unidentified_peer( &self, endpoint: String, local_authorization: PeerAuthorizationToken) -> Result<EndpointPeerRef, PeerUnknownAddError>

pub fn list_peers(&self) -> Result<Vec<PeerAuthorizationToken>, PeerListError>

pub fn list_unreferenced_peers( &self) -> Result<Vec<PeerTokenPair>, PeerListError>

pub fn connection_ids( &self) -> Result<BiHashMap<PeerTokenPair, String>, PeerConnectionIdError>

pub fn subscribe(&self) -> Result<PeerNotificationIter, PeerManagerError>

pub fn subscribe_sender<T>( &self, subscriber: Sender<T>) -> Result<SubscriberId, PeerManagerError> where T: From<PeerManagerNotification> + Send + 'static,

pub fn unsubscribe( &self, subscriber_id: SubscriberId) -> Result<(), PeerManagerError>

Trait Implementations

impl Clone for PeerManagerConnector

fn clone(&self) -> PeerManagerConnector

fn clone_from(&mut self, source: &Self)

impl Debug for PeerManagerConnector

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

impl PeerLookup for PeerManagerConnector

fn connection_id( &self, peer_id: &PeerTokenPair) -> Result<Option<String>, PeerLookupError>

fn peer_id( &self, connection_id: &str) -> Result<Option<PeerTokenPair>, PeerLookupError>

Auto Trait Implementations

impl !RefUnwindSafe for PeerManagerConnector

impl Send for PeerManagerConnector

impl !Sync for PeerManagerConnector

impl Unpin for PeerManagerConnector

impl !UnwindSafe for PeerManagerConnector

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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>,

fn into(self) -> U

impl<P, N> IntoBytes<P> for N where P: Message + FromNative<N>,

fn into_bytes(self) -> Result<Vec<u8, Global>, ProtoConversionError>

impl<N, P> IntoNative<N> for P where N: FromProto<P>,

fn into_native(self) -> Result<N, ProtoConversionError>

impl<N, P> IntoProto<P> for N where P: FromNative<N>,

fn into_proto(self) -> Result<P, ProtoConversionError>

impl<T> IntoSql for T

fn into_sql<T>(self) -> Self::Expression where Self: AsExpression<T>,

fn as_sql<'a, T>(&'a self) -> <&'a Self as AsExpression<T>>::Expression where &'a Self: AsExpression<T>,

impl<T> Same<T> for T

type Output = T

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

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

type Error = Infallible

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

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

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

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>,

fn with_current_subscriber(self) -> WithDispatch<Self>

pub fn add_peer_ref(
&self,
peer_id: PeerAuthorizationToken,
endpoints: Vec<String>,
required_local_auth: PeerAuthorizationToken
) -> Result<PeerRef, PeerRefAddError>

pub fn add_unidentified_peer(
&self,
endpoint: String,
local_authorization: PeerAuthorizationToken
) -> Result<EndpointPeerRef, PeerUnknownAddError>

pub fn list_unreferenced_peers(
&self
) -> Result<Vec<PeerTokenPair>, PeerListError>

pub fn connection_ids(
&self
) -> Result<BiHashMap<PeerTokenPair, String>, PeerConnectionIdError>

pub fn subscribe_sender<T>(
&self,
subscriber: Sender<T>
) -> Result<SubscriberId, PeerManagerError> where
T: From<PeerManagerNotification> + Send + 'static,

pub fn unsubscribe(
&self,
subscriber_id: SubscriberId
) -> Result<(), PeerManagerError>

fn connection_id(
&self,
peer_id: &PeerTokenPair
) -> Result<Option<String>, PeerLookupError>

fn peer_id(
&self,
connection_id: &str
) -> Result<Option<PeerTokenPair>, PeerLookupError>

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,

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

impl<P, N> IntoBytes<P> for N where
P: Message + FromNative<N>,

impl<N, P> IntoNative<N> for P where
N: FromProto<P>,

impl<N, P> IntoProto<P> for N where
P: FromNative<N>,

fn into_sql<T>(self) -> Self::Expression where
Self: AsExpression<T>,

fn as_sql<'a, T>(&'a self) -> <&'a Self as AsExpression<T>>::Expression where
&'a Self: AsExpression<T>,

impl<T> ToOwned for T where
T: Clone,

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

impl<T, U> TryInto<U> for T where
U: TryFrom<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>,