Struct SurbTelemetryCodec 

pub struct SurbTelemetryCodec<C> {
    inner: C,
    me: OffchainPublicKey,
    slots: PathSlotResolver,
    registry: SurbRoundTripRegistry,
    pending: PendingLegs,
}

Wraps a codec so the SURBs it mints and consumes are counted per pair of legs.

Encoding and decoding are otherwise passed straight through; a failure to attribute a round-trip never fails a packet.

Fields

inner: C

me: OffchainPublicKey

slots: PathSlotResolver

registry: SurbRoundTripRegistry

pending: PendingLegs

Legs each outstanding SURB was minted over.

Bounded by capacity and TTL rather than by replies arriving, so a peer that never replies cannot grow it without limit. Shared with the other codec half – see PendingLegs.

Implementations

impl<C> SurbTelemetryCodec<C>

pub fn new( inner: C, me: OffchainPublicKey, slots: PathSlotResolver, registry: SurbRoundTripRegistry, pending: PendingLegs, ) -> Self

Wraps inner, resolving path slots with slots and accumulating into registry.

fn on_minted( &self, routing: &ResolvedTransportRouting<HoprSurb>, minted: &[HoprSurbId], )

Associates freshly minted SURBs with the legs they were minted over.

Opener order is significant, so the ids zip positionally with the return paths that produced them.

fn on_replied(&self, surb_id: &HoprSurbId)

Credits the legs a reply came back on.

Trait Implementations

impl<C: Clone> Clone for SurbTelemetryCodec<C>

fn clone(&self) -> SurbTelemetryCodec<C>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<C: Debug> Debug for SurbTelemetryCodec<C>

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

Formats the value using the given formatter.

impl<C> PacketDecoder for SurbTelemetryCodec<C>

where C: PacketDecoder,

type Error = <C as PacketDecoder>::Error

fn decode( &self, sender: PeerId, data: Bytes, ) -> Result<IncomingPacket, IncomingPacketError<<Self as PacketDecoder>::Error>>

Decodes the data received from the given sender returns the corresponding IncomingPacket if the decoding into a HOPR packet was successful.

impl<C> PacketEncoder for SurbTelemetryCodec<C>

where C: PacketEncoder,

type Error = <C as PacketEncoder>::Error

fn encode_packet<T: AsRef<[u8]> + Send + 'static, S: Into<PacketSignals> + Send + 'static>( &self, data: T, routing: ResolvedTransportRouting<HoprSurb>, signals: S, ) -> Result<OutgoingPacket, <Self as PacketEncoder>::Error>

Encodes the given data and signals for sending.

fn encode_acknowledgements( &self, acks: &[VerifiedAcknowledgement], destination: &OffchainPublicKey, ) -> Result<OutgoingPacket, <Self as PacketEncoder>::Error>

Encodes the given vector of VerifiedAcknowledgements as an outgoing packet to be sent to the given destination.