Struct PacketPipelineBuilder 

pub struct PacketPipelineBuilder<WIn, WOut, C, D, T, TEvt, AppOut, AppIn> {
    packet_key: OffchainKeypair,
    wire_msg: (WOut, WIn),
    codec: (C, D),
    cfg: PacketPipelineConfig,
    api: (AppOut, AppIn),
    counters: PeerProtocolCounterRegistry,
    ticket_proc: Option<T>,
    ticket_events: Option<TEvt>,
}

Builder for constructing the HOPR packet pipeline for a specific node type.

The builder is constructed from a packet key via PacketPipelineBuilder::new; the transport, codec and application API must then be provided via the PacketPipelineBuilder::transport, PacketPipelineBuilder::codec and PacketPipelineBuilder::api builder methods.

Terminal methods for each node type are then exposed:

• PacketPipelineBuilder::build_for_relay — full pipeline, requires ticket processing via PacketPipelineBuilder::with_ticket_processing.
• PacketPipelineBuilder::build_for_entry — Entry nodes; the incoming acknowledgement pipeline is not started at all.
• PacketPipelineBuilder::build_for_exit — Exit nodes; the incoming acknowledgement pipeline is started but only drains the stream (no ticket processing).

The pipeline does not handle mixing itself; it needs to be injected as a separate process overlay on top of the wire_msg Stream or Sink.

Fields

packet_key: OffchainKeypair

wire_msg: (WOut, WIn)

codec: (C, D)

cfg: PacketPipelineConfig

api: (AppOut, AppIn)

counters: PeerProtocolCounterRegistry

ticket_proc: Option<T>

ticket_events: Option<TEvt>

Implementations

impl PacketPipelineBuilder<Unset, Unset, Unset, Unset, NoopTicketProcessor, Drain<TicketEvent>, Unset, Unset>

pub fn new(packet_key: OffchainKeypair) -> Self

Creates a new builder with the common parameters shared by all node types.

The transport, codec and application API must be supplied via PacketPipelineBuilder::transport, PacketPipelineBuilder::codec and PacketPipelineBuilder::api before any of the terminal build_for_* methods can be called.

The pipeline configuration defaults to PacketPipelineConfig::default; use PacketPipelineBuilder::with_config to override it. The per-peer counter registry defaults to an empty one; use PacketPipelineBuilder::with_counters to override it.

Use PacketPipelineBuilder::with_ticket_processing to attach ticket processing before calling PacketPipelineBuilder::build_for_relay.

impl<WIn, WOut, C, D, T, TEvt, AppOut, AppIn> PacketPipelineBuilder<WIn, WOut, C, D, T, TEvt, AppOut, AppIn>

pub fn with_config(self, cfg: PacketPipelineConfig) -> Self

Overrides the default PacketPipelineConfig.

pub fn with_counters(self, counters: PeerProtocolCounterRegistry) -> Self

Overrides the default (empty) per-peer protocol counter registry.

pub fn transport<WIn2, WOut2>( self, wire_msg: (WOut2, WIn2), ) -> PacketPipelineBuilder<WIn2, WOut2, C, D, T, TEvt, AppOut, AppIn>

Sets the underlying wire-message transport (outgoing sink, incoming stream).

pub fn codec<C2, D2>( self, codec: (C2, D2), ) -> PacketPipelineBuilder<WIn, WOut, C2, D2, T, TEvt, AppOut, AppIn>

Sets the packet codec (encoder, decoder).

pub fn api<AppOut2, AppIn2>( self, api: (AppOut2, AppIn2), ) -> PacketPipelineBuilder<WIn, WOut, C, D, T, TEvt, AppOut2, AppIn2>

Sets the application API (outgoing sink for received data, incoming stream for data to send).

pub fn with_ticket_processing<T2, TEvt2>( self, ticket_proc: T2, ticket_events: TEvt2, ) -> PacketPipelineBuilder<WIn, WOut, C, D, T2, TEvt2, AppOut, AppIn>

where T2: UnacknowledgedTicketProcessor + Sync + Send + 'static, TEvt2: Sink<TicketEvent> + Clone + Unpin + Send + 'static, TEvt2::Error: Error,

Attaches a ticket processor and a ticket-events sink to the builder.

Required before calling PacketPipelineBuilder::build_for_relay. Has no effect on Entry/Exit builds, which never process tickets.

impl<WIn, WOut, C, D, T, TEvt, AppOut, AppIn> PacketPipelineBuilder<WIn, WOut, C, D, T, TEvt, AppOut, AppIn>

where WOut: Sink<(PeerId, Bytes)> + Clone + Unpin + Send + 'static, WOut::Error: Error, WIn: Stream<Item = (PeerId, Bytes)> + Send + 'static, C: PacketEncoder + Sync + Send + 'static, D: PacketDecoder + Sync + Send + 'static, T: UnacknowledgedTicketProcessor + Sync + Send + 'static, TEvt: Sink<TicketEvent> + Clone + Unpin + Send + 'static, TEvt::Error: Error, AppOut: Sink<(HoprPseudonym, ApplicationDataIn)> + Send + 'static, AppOut::Error: Error, AppIn: Stream<Item = (ResolvedTransportRouting<HoprSurb>, ApplicationDataOut)> + Send + 'static,

pub fn build_for_relay(self) -> AbortableList<PacketPipelineProcesses>

Builds and starts the full packet pipeline for a HOPR Relay node.

Relay nodes run the full pipeline: outgoing/incoming messages, outgoing acknowledgements, and incoming acknowledgements (with ticket processing).

Panics

Panics if PacketPipelineBuilder::with_ticket_processing was not called before this method.

impl<WIn, WOut, C, D, T, TEvt, AppOut, AppIn> PacketPipelineBuilder<WIn, WOut, C, D, T, TEvt, AppOut, AppIn>

where WOut: Sink<(PeerId, Bytes)> + Clone + Unpin + Send + 'static, WOut::Error: Error, WIn: Stream<Item = (PeerId, Bytes)> + Send + 'static, C: PacketEncoder + Sync + Send + 'static, D: PacketDecoder + Sync + Send + 'static, AppOut: Sink<(HoprPseudonym, ApplicationDataIn)> + Send + 'static, AppOut::Error: Error, AppIn: Stream<Item = (ResolvedTransportRouting<HoprSurb>, ApplicationDataOut)> + Send + 'static,

pub fn build_for_entry(self) -> AbortableList<PacketPipelineProcesses>

Builds and starts the packet pipeline for a HOPR Entry node.

Entry nodes never relay packets and therefore do not process tickets. As a consequence, the incoming acknowledgement pipeline is not started. Any ticket processor or ticket events sink previously set via PacketPipelineBuilder::with_ticket_processing is ignored.

pub fn build_for_exit(self) -> AbortableList<PacketPipelineProcesses>

Builds and starts the packet pipeline for a HOPR Exit node.

Exit nodes do not process tickets either. However, in contrast to PacketPipelineBuilder::build_for_entry, the incoming acknowledgement pipeline is kept running (it only drains the stream) to support future development. Any ticket processor or ticket events sink previously set via PacketPipelineBuilder::with_ticket_processing is ignored.