Skip to main content

HoprPacketPipelineBuilder

hopr_transport::pipeline

Struct HoprPacketPipelineBuilder 

Source 
pub struct HoprPacketPipelineBuilder<WIn, WOut, Chain, S, TFact, AppOut, AppIn, TEvt = Drain<TicketEvent>> {
    packet_key: Option<OffchainKeypair>,
    chain_key: Option<ChainKeypair>,
    wire_msg: (WOut, WIn),
    api: (AppOut, AppIn),
    surb_store: S,
    chain_api: Chain,
    ticket_factory: TFact,
    counters: PeerProtocolCounterRegistry,
    channels_dst: Option<Hash>,
    cfg: HoprPacketPipelineConfig,
    ticket_events: Option<TEvt>,
}
Expand description

Builder for the HOPR packet pipeline.

Creates the encoder/decoder, the unacknowledged-ticket processor, optionally hooks up the packet capture (when the capture feature is enabled) and finally delegates to the lower-level PacketPipelineBuilder to spawn the per-stage tasks. The shape of the spawned pipeline is selected by which terminal build_for_* method is called:

The builder is constructed via HoprPacketPipelineBuilder::new which takes no arguments. The required components must then be supplied via the corresponding builder methods: identity, transport, api, surb_store, chain_api, ticket_factory and channels_dst.

The per-peer counter registry defaults to an empty one; override it via HoprPacketPipelineBuilder::with_counters.

The configuration (HoprPacketPipelineConfig) is optional and defaults to HoprPacketPipelineConfig::default(); override it via HoprPacketPipelineBuilder::with_config.

Fields§

§packet_key: Option<OffchainKeypair>§chain_key: Option<ChainKeypair>§wire_msg: (WOut, WIn)§api: (AppOut, AppIn)§surb_store: S§chain_api: Chain§ticket_factory: TFact§counters: PeerProtocolCounterRegistry§channels_dst: Option<Hash>§cfg: HoprPacketPipelineConfig§ticket_events: Option<TEvt>

Implementations§

Source§

impl HoprPacketPipelineBuilder<Unset, Unset, Unset, Unset, Unset, Unset, Unset, Drain<TicketEvent>>

Source

pub fn new() -> Self

Creates a new empty builder. All required components must then be supplied via the corresponding builder methods before calling any of the terminal build_for_* methods.

Source§

impl<WIn, WOut, Chain, S, TFact, AppOut, AppIn, TEvt> HoprPacketPipelineBuilder<WIn, WOut, Chain, S, TFact, AppOut, AppIn, TEvt>

Source

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

Overrides the default HoprPacketPipelineConfig.

Source

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

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

Source

pub fn identity<'a, I>(self, identity: I) -> Self
where I: Into<(&'a ChainKeypair, &'a OffchainKeypair)>,

Sets the node identity (chain and offchain keypairs).

Source

pub fn channels_dst(self, channels_dst: Hash) -> Self

Sets the channel-set domain separator used by the codec and ticket processor.

Source

pub fn transport<WIn2, WOut2>( self, wire_msg: (WOut2, WIn2), ) -> HoprPacketPipelineBuilder<WIn2, WOut2, Chain, S, TFact, AppOut, AppIn, TEvt>

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

Source

pub fn api<AppOut2, AppIn2>( self, api: (AppOut2, AppIn2), ) -> HoprPacketPipelineBuilder<WIn, WOut, Chain, S, TFact, AppOut2, AppIn2, TEvt>

Sets the application API (incoming sink, outgoing stream).

Source

pub fn surb_store<S2>( self, surb_store: S2, ) -> HoprPacketPipelineBuilder<WIn, WOut, Chain, S2, TFact, AppOut, AppIn, TEvt>

Sets the SURB store used by the encoder/decoder.

Source

pub fn chain_api<Chain2>( self, chain_api: Chain2, ) -> HoprPacketPipelineBuilder<WIn, WOut, Chain2, S, TFact, AppOut, AppIn, TEvt>

Sets the chain API used by the encoder/decoder and the unacknowledged ticket processor.

Source

pub fn ticket_factory<TFact2>( self, ticket_factory: TFact2, ) -> HoprPacketPipelineBuilder<WIn, WOut, Chain, S, TFact2, AppOut, AppIn, TEvt>

Sets the ticket factory used by the encoder/decoder.

Source

pub fn with_ticket_events<TEvt2>( self, ticket_events: TEvt2, ) -> HoprPacketPipelineBuilder<WIn, WOut, Chain, S, TFact, AppOut, AppIn, TEvt2>

Attaches the ticket events sink. Required for Relay nodes (see HoprPacketPipelineBuilder::build_for_relay); ignored by Entry and Exit nodes.

Source§

impl<WIn, WOut, Chain, S, TFact, AppOut, AppIn, TEvt> HoprPacketPipelineBuilder<WIn, WOut, Chain, S, TFact, AppOut, AppIn, TEvt>
where WOut: Sink<(PeerId, Bytes)> + Clone + Unpin + Send + 'static, WOut::Error: Error, WIn: Stream<Item = (PeerId, Bytes)> + Send + 'static, Chain: ChainKeyOperations + ChainReadChannelOperations + ChainReadTicketOperations + ChainValues + Clone + Send + Sync + 'static, S: SurbStore + Clone + Send + Sync + 'static, TFact: TicketFactory + Clone + Send + Sync + 'static, AppOut: Sink<(HoprPseudonym, ApplicationDataIn)> + Send + 'static, AppOut::Error: Error, AppIn: Stream<Item = (ResolvedTransportRouting<HoprSurb>, ApplicationDataOut)> + Send + 'static,

Source

fn prepare( self, ) -> (OffchainKeypair, (WOut, WIn), (AppOut, AppIn), PeerProtocolCounterRegistry, HoprUnacknowledgedTicketProcessor<Chain>, Option<TEvt>, HoprPacketPipelineConfig, AbortableList<HoprTransportProcess>, BuiltCodec<Chain, S, TFact>)

Builds the codec pair (and capture wiring when enabled) and the unacknowledged ticket processor, returning them together with an AbortableList already containing the capture task if any was started.

Source§

impl<WIn, WOut, Chain, S, TFact, AppOut, AppIn, TEvt> HoprPacketPipelineBuilder<WIn, WOut, Chain, S, TFact, AppOut, AppIn, TEvt>
where WOut: Sink<(PeerId, Bytes)> + Clone + Unpin + Send + 'static, WOut::Error: Error, WIn: Stream<Item = (PeerId, Bytes)> + Send + 'static, Chain: ChainKeyOperations + ChainReadChannelOperations + ChainReadTicketOperations + ChainValues + Clone + Send + Sync + 'static, S: SurbStore + Clone + Send + Sync + 'static, TEvt: Sink<TicketEvent> + Clone + Unpin + Send + 'static, TEvt::Error: Error, TFact: TicketFactory + Clone + Send + Sync + 'static, AppOut: Sink<(HoprPseudonym, ApplicationDataIn)> + Send + 'static, AppOut::Error: Error, AppIn: Stream<Item = (ResolvedTransportRouting<HoprSurb>, ApplicationDataOut)> + Send + 'static,

Source

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

Builds the pipeline configured for a Relay node.

§Panics

Panics if HoprPacketPipelineBuilder::with_ticket_events was not called.

Source§

impl<WIn, WOut, Chain, S, TFact, AppOut, AppIn, TEvt> HoprPacketPipelineBuilder<WIn, WOut, Chain, S, TFact, AppOut, AppIn, TEvt>
where WOut: Sink<(PeerId, Bytes)> + Clone + Unpin + Send + 'static, WOut::Error: Error, WIn: Stream<Item = (PeerId, Bytes)> + Send + 'static, Chain: ChainKeyOperations + ChainReadChannelOperations + ChainReadTicketOperations + ChainValues + Clone + Send + Sync + 'static, S: SurbStore + Clone + Send + Sync + 'static, TFact: TicketFactory + Clone + Send + Sync + 'static, AppOut: Sink<(HoprPseudonym, ApplicationDataIn)> + Send + 'static, AppOut::Error: Error, AppIn: Stream<Item = (ResolvedTransportRouting<HoprSurb>, ApplicationDataOut)> + Send + 'static,

Source

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

Builds the pipeline configured for an Entry node.

The incoming acknowledgement pipeline is not started; ticket events (if any) are ignored.

Source

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

Builds the pipeline configured for an Exit node.

The incoming acknowledgement pipeline is started but its acknowledgements are drained (never forwarded to a ticket processor); ticket events (if any) are ignored.

Trait Implementations§

Source§

impl Default for HoprPacketPipelineBuilder<Unset, Unset, Unset, Unset, Unset, Unset, Unset, Drain<TicketEvent>>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<WIn, WOut, Chain, S, TFact, AppOut, AppIn, TEvt> Freeze for HoprPacketPipelineBuilder<WIn, WOut, Chain, S, TFact, AppOut, AppIn, TEvt>
where S: Freeze, Chain: Freeze, TFact: Freeze, WOut: Freeze, WIn: Freeze, AppOut: Freeze, AppIn: Freeze, TEvt: Freeze,

§

impl<WIn, WOut, Chain, S, TFact, AppOut, AppIn, TEvt = Drain<TicketEvent>> !RefUnwindSafe for HoprPacketPipelineBuilder<WIn, WOut, Chain, S, TFact, AppOut, AppIn, TEvt>

§

impl<WIn, WOut, Chain, S, TFact, AppOut, AppIn, TEvt> Send for HoprPacketPipelineBuilder<WIn, WOut, Chain, S, TFact, AppOut, AppIn, TEvt>
where S: Send, Chain: Send, TFact: Send, WOut: Send, WIn: Send, AppOut: Send, AppIn: Send, TEvt: Send,

§

impl<WIn, WOut, Chain, S, TFact, AppOut, AppIn, TEvt> Sync for HoprPacketPipelineBuilder<WIn, WOut, Chain, S, TFact, AppOut, AppIn, TEvt>
where S: Sync, Chain: Sync, TFact: Sync, WOut: Sync, WIn: Sync, AppOut: Sync, AppIn: Sync, TEvt: Sync,

§

impl<WIn, WOut, Chain, S, TFact, AppOut, AppIn, TEvt> Unpin for HoprPacketPipelineBuilder<WIn, WOut, Chain, S, TFact, AppOut, AppIn, TEvt>
where S: Unpin, Chain: Unpin, TFact: Unpin, WOut: Unpin, WIn: Unpin, AppOut: Unpin, AppIn: Unpin, TEvt: Unpin,

§

impl<WIn, WOut, Chain, S, TFact, AppOut, AppIn, TEvt = Drain<TicketEvent>> !UnwindSafe for HoprPacketPipelineBuilder<WIn, WOut, Chain, S, TFact, AppOut, AppIn, TEvt>

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,

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
§

impl<T> Conv for T

§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
§

impl<T> FmtForward for T

§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> FutureExt for T

§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
§

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

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

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

§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
§

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
§

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

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<T> Tap for T

§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
§

impl<T> TryConv for T

§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
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