Struct zebra_network::peer::handshake::Handshake

pub struct Handshake<S, C = NoChainTip>
where
    S: Service<Request, Response = Response, Error = BoxError> + Clone + Send + 'static,
    S::Future: Send,
    C: ChainTip + Clone + Send + 'static,
{
    config: Config,
    user_agent: String,
    our_services: PeerServices,
    relay: bool,
    inbound_service: S,
    address_book_updater: Sender<MetaAddrChange>,
    inv_collector: Sender<InventoryResponse<(AtLeastOne<InventoryHash>, PeerSocketAddr), (AtLeastOne<InventoryHash>, PeerSocketAddr)>>,
    minimum_peer_version: MinimumPeerVersion<C>,
    nonces: Arc<Mutex<IndexSet<Nonce>>>,
    parent_span: Span,
}

A [Service] that handshakes with a remote peer and constructs a client/server pair.

CORRECTNESS

To avoid hangs, each handshake (or its connector) should be:

• launched in a separate task, and
• wrapped in a timeout.

Fields

config: Config

user_agent: String

our_services: PeerServices

relay: bool

inbound_service: S

address_book_updater: Sender<MetaAddrChange>

inv_collector: Sender<InventoryResponse<(AtLeastOne<InventoryHash>, PeerSocketAddr), (AtLeastOne<InventoryHash>, PeerSocketAddr)>>

minimum_peer_version: MinimumPeerVersion<C>

nonces: Arc<Mutex<IndexSet<Nonce>>>

parent_span: Span

Implementations

impl<S> Handshake<S, NoChainTip>

where S: Service<Request, Response = Response, Error = BoxError> + Clone + Send + 'static, S::Future: Send,

pub fn builder() -> Builder<S, NoChainTip>

Create a builder that configures a Handshake service.

Trait Implementations

impl<S, C> Clone for Handshake<S, C>

where S: Service<Request, Response = Response, Error = BoxError> + Clone + Send + 'static, S::Future: Send, C: ChainTip + Clone + Send + 'static,

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S, C> Debug for Handshake<S, C>

where S: Service<Request, Response = Response, Error = BoxError> + Clone + Send + 'static, S::Future: Send, C: ChainTip + Clone + Send + 'static,

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

Formats the value using the given formatter.

impl<S, PeerTransport, C> Service<HandshakeRequest<PeerTransport>> for Handshake<S, C>

where S: Service<Request, Response = Response, Error = BoxError> + Clone + Send + 'static, S::Future: Send, C: ChainTip + Clone + Send + 'static, PeerTransport: AsyncRead + AsyncWrite + Unpin + Send + 'static,

type Response = Client

Responses given by the service.

type Error = Box<dyn Error + Sync + Send>

Errors produced by the service.

type Future = Pin<Box<dyn Future<Output = Result<<Handshake<S, C> as Service<HandshakeRequest<PeerTransport>>>::Response, <Handshake<S, C> as Service<HandshakeRequest<PeerTransport>>>::Error>> + Send>>

The future response value.

fn poll_ready(&mut self, _cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>>

Returns Poll::Ready(Ok(())) when the service is able to process requests.

fn call(&mut self, req: HandshakeRequest<PeerTransport>) -> Self::Future

Process the request and return the response asynchronously.