Struct MemorySurbStore 

pub struct MemorySurbStore {
    pseudonym_openers: Cache<HoprPseudonym, Cache<HoprSurbId, ReplyOpener>>,
    surbs_per_pseudonym: Cache<HoprPseudonym, SurbRingBuffer<HoprSurb>>,
    invalidated_relayers: Arc<RwLock<HashSet<HoprKeyIdent>>>,
    reporters: Arc<EvictionReporters>,
    cfg: Arc<SurbStoreConfig>,
}

Basic SurbStore implementation based on an in-memory cache.

This SURB store offers no persistence, and all SURBs and Reply Openers are lost once dropped.

The instance can be cheaply cloned.

Fields

pseudonym_openers: Cache<HoprPseudonym, Cache<HoprSurbId, ReplyOpener>>

surbs_per_pseudonym: Cache<HoprPseudonym, SurbRingBuffer<HoprSurb>>

invalidated_relayers: Arc<RwLock<HashSet<HoprKeyIdent>>>

Relayers this node can no longer pay. Holds at most a handful of entries (our own closing channels), so a plain set behind an RwLock beats a concurrent map on this read-heavy path.

reporters: Arc<EvictionReporters>

cfg: Arc<SurbStoreConfig>

Implementations

impl MemorySurbStore

pub fn new(cfg: SurbStoreConfig) -> Self

Creates a new instance with the given configuration.

pub fn is_relayer_invalidated(&self, relayer: &HoprKeyIdent) -> bool

Whether relayer is currently unusable as a return path’s first hop.

fn is_surb_usable(&self, surb: &HoprSurb) -> bool

Whether a stored SURB can still be used to reply: its first relayer must still be payable.

A direct return path is exempt — its “first relayer” is the final recipient, which needs no channel (RFC-0003 §3.2, RFC-0006 §6.1). Without that exemption, closing an unrelated channel to a session’s originator would discard perfectly good SURBs.

Trait Implementations

impl Clone for MemorySurbStore

fn clone(&self) -> MemorySurbStore

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for MemorySurbStore

fn default() -> Self

Returns the “default value” for a type.

impl SurbStore for MemorySurbStore

fn find_surb(&self, matcher: SurbMatcher) -> Option<FoundSurb>

Tries to find SURB using the given matcher.

fn insert_surbs( &self, pseudonym: HoprPseudonym, surbs: Vec<(HoprSurbId, HoprSurb)>, ) -> SurbInsertOutcome

Stores the surbs and associates them with the given pseudonym.

fn insert_reply_opener(&self, sender_id: HoprSenderId, opener: ReplyOpener)

Stores the given opener for the given sender_id.

fn invalidate_relayer(&self, relayer: &HoprKeyIdent)

Marks the edge from this node to relayer as unusable, so stored SURBs whose return path starts there are no longer handed out.

fn revalidate_relayer(&self, relayer: &HoprKeyIdent)

Reverts SurbStore::invalidate_relayer once the channel towards relayer re-opens.

fn find_reply_opener(&self, sender_id: &HoprSenderId) -> Option<ReplyOpener>

Tries to find a ReplyOpener given the sender_id.