Enum SessionPixAction 

pub enum SessionPixAction {
    RequestSsa {
        ssa_ids: Vec<SsaId<HoprPseudonym>>,
        params: PixParams,
    },
    RequestCommitmentRetransmission {
        ssa_id: SsaId<HoprPseudonym>,
        params: PixParams,
    },
    ReleaseService,
    WithholdService,
    ProgressNotification,
    Close(SessionPixCloseReason),
    RetireSsa(SsaId<HoprPseudonym>),
    SetFillRate(FillRate),
}

Actions emitted by the SessionPixSupervisor for the caller to execute.

Variants

RequestSsa

Request one or more new SSAs with the given dimensions.

Always non-empty, and always contiguous ascending indices. The whole batch travels in a single SsaRequest — one message, one params field — because every SSA in a Session shares the negotiated dimensions. Carrying the set rather than one id is what keeps the batch atomic: the carrier either puts all of them on the wire or none, and a partial failure releases every registration it made.

Fields

ssa_ids: Vec<SsaId<HoprPseudonym>>

params: PixParams

RequestCommitmentRetransmission

Ask the Entry to re-send the parts of one SSA’s commitment that never arrived.

Emitted when a partially delivered commitment has been quiet for SupervisorConfig::commitment_recommit_interval, and repeated on that interval until the commitment verifies or the absolute delivery deadline closes the Session. The scope is not carried here: what is missing is the reconstructor’s to say, and it can change between this action being emitted and being carried out, so the carrier reads it at the point of sending.

Unlike RequestSsa this asks for nothing new and its failure is not terminal — the delivery deadline remains the backstop, so a dropped ask costs one interval.

Fields

ssa_id: SsaId<HoprPseudonym>

params: PixParams

ReleaseService

Put the service gate in funded mode for the front cycle, or rebaseline a funded successor.

WithholdService

Return the service gate to an unfunded successor’s predeposit allowance after a paid handoff.

ProgressNotification

Notifies the gate that the funded front made recovery progress, resetting its served-without-progress ceiling.

Close(SessionPixCloseReason)

Close the session with the given reason.

RetireSsa(SsaId<HoprPseudonym>)

Retire a previously-used SSA from the reconstructor (idempotent). Emitted when an SSA’s tombstone period expires so mid-session state does not accumulate.

SetFillRate(FillRate)

Set the rate at which the Exit originates its own fill keep-alives.

Emitted only when the planned rate actually changes — see fill::FillPlanner, which is private to this crate — so the action stream carries decisions rather than a per-second heartbeat of its own.

Deliberately not coalescible, unlike ProgressNotification. A dropped notification is replaced by the next one within an acknowledgement batch; a dropped rate change is not replaced at all, because the planner’s hysteresis means it will not re-emit a value it believes is already applied. Dropping a drop to zero is the worst case: the Session would keep spending SURBs on a cycle that no longer exists. At not more than one per second against a 64-deep channel, treating a failure to deliver it as a wedged channel is the correct reading.

Trait Implementations

impl Clone for SessionPixAction

fn clone(&self) -> SessionPixAction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SessionPixAction

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

Formats the value using the given formatter.