Skip to main content Module manager Copy item path Source AbortOnDrop ๐ Aborts the wrapped task when dropped, which neither a join handle nor an [AbortHandle] does on
its own drop. Built through From from any [Abortable]. ClaimedPublication ๐ A member taken out of OwedPublications by whoever is publishing it. CycleBudgetReservation ๐ One Sessionโs reservation against the nodeโs live reconstructor-cycle budget. DegradedSwitch ๐ What the Exitโs loss driver last told the notification stream, so that it acts only when the answer changes. EffectivePixAdmission ๐ The PIX terms a single incoming Session is admitted on. EntryAnnouncement ๐ What spawn_exit_keep_alive takes from the Entryโs Session request. IncomingSessionPixConfig Configuration of the PIX protocol for incoming Sessions on Exit nodes. OwedPublications ๐ The members of the batch last staged that are still owed their publication, and the ones that
have had it. ParkedSurbRefund ๐ The SURB refund of a packet parked at the PIX egress gate, given back unless the gate admits the
packet. PendingOutgoingGuard ๐ Removes an outgoing Sessionโs pseudonym from the managerโs pending index when dropped. PendingOutgoingToken ๐ Per-claim token distinguishing one initiationโs marker from another attemptโs under the same
pseudonym. PixFillControl ๐ The Exitโs control over the single Exit โ Entry keep-alive stream a Session runs. PixFillState ๐ PixToolbox PIX protocol toolbox to enable SessionManager to use PIX protocol. SessionManager Manages lifecycles of Sessions. SessionManagerConfig Configuration for the SessionManager . SessionSlot ๐ SessionSlotGuard ๐ RAII guard that rolls back a freshly inserted SessionSlot unless the
session setup is explicitly committed . SessionSsaState ๐ The PIX dimensions this Session negotiated, on the Exit side. SurbReserveBasis ๐ What one Sessionโs fill reserve is derived from (see effective_surb_reserve ). SurbsStored ๐ What an incoming packet did to the SURB store, as the packet pipeline reported it. DispatchResult Indicates the result of processing a message. DropReason Why an inbound packet was dropped without being delivered. ResendDecision ๐ What the action driver does with a SessionPixAction::ResendSsaRequest . SessionHandles ๐ Handles to streams and tasks spawned by the Session. SsaRefusal ๐ Why handle_ssa_request dropped a request without committing to it, short of refusing the Session. DEFAULT_MAX_SSAS_PER_SSA_REQUEST Default for SessionManagerConfig::max_ssas_per_ssa_request โ how many SSA commitments an Entry
accepts in a single [SsaServerCommitmentMessage]. DEFAULT_SSAS_PER_SSA_REQUEST Default for SupervisorConfig::ssas_per_request โ
how many SSAs an Exit may ask for in a single [SsaServerCommitmentMessage]. It is the maximum
in dynamic mode and the exact batch in fixed mode. DEPOSIT_DATA_REQUEST_TIMEOUT How long an Exit waits for the deposit pool to answer a
DepositDataRequest before sending the batch
without what has not arrived. EXTERNAL_SEND_TIMEOUT ๐ Timeout when sending Start protocol messages to the sink FULL_QUEUE_WARN_INTERVAL ๐ How many drops of a full queue may pass between two warn! lines. IDLE_NOTIFY_PERIODS_PER_IDLE_TIMEOUT ๐ How many idle reports fit into the Entryโs slot idle timeout at the longest backoff. IDLE_REPORTS_AT_BASE ๐ Idle reports sent at the base period before backing off: the first idle minute at 15 s. INITIATION_OPTIONS_SHIFT ๐ Bit position of the 64-bit options word within StartInitiation::additional_data. MAX_ASSUMED_SESSION_PACKET_RATE Fastest return-path rate a Session is assumed to sustain, in packets per second. MAX_CONCURRENT_START_SESSIONS ๐ StartSession handlers allowed in hand at once.MAX_OVERLAPPING_BATCHES SSA batches whose reconstructor state can be live on the Exit at the same moment. MAX_SSA_BATCH_SIZE Hard ceiling on both SSA batch-size knobs, whatever the configuration says. MIN_CHALLENGE ๐ The first challenge value used in Start protocol to initiate a session. MIN_COMMITMENTS_PER_SSA_COMMIT_MSG ๐ Conservative lower bound on how many coefficient commitments fit into one SsaCommit message. MIN_FRAME_TIMEOUT ๐ Minimum timeout until an unfinished frame is discarded. MIN_SURB_BUFFER_DURATION Minimum time the SURB buffer must endure if no SURBs are being produced. MIN_SURB_BUFFER_NOTIFICATION_PERIOD Minimum time between SURB buffer notifications to the Entry. NO_ANNOUNCEMENT ๐ Stands for โthe Entry has announced no targetโ in PixFillControl โs record of the last one. SESSION_READINESS_TIMEOUT ๐ Maximum time to wait for counterparty to receive the target number of SURBs. SSA_REPEAT_RESEND_GRACE ๐ How long after a batchโs commitments last went out the Entry takes a repeat of its request to
mean that they were lost on the way, rather than that the repeat crossed them. SSA_SUCCESSOR_SERVICE_POLL ๐ How often SSA_SUCCESSOR_SERVICE_WAIT re-reads the returned-packet count. SSA_SUCCESSOR_SERVICE_WAIT ๐ How long the Entry holds a near-miss SsaRequest while the Exitโs returned data catches up to
the successor boundary. START_PROTOCOL_CHANNEL_RESERVE ๐ Slack added on top of the PIX commitment burst to cover non-PIX Start protocol traffic
(session initiations, establishments, errors, keep-alives). START_SESSION_ADMISSION_CONCURRENCY Concurrent session-server admission waits, held below the lane size so a slow server refuses
with Busy instead of parking every handler. START_SESSION_LANE_DEPTH_FACTOR ๐ How many queued StartSessions may wait per handler. SUCCESSOR_GATE_ARRIVAL_SIGMAS ๐ Standard deviations below an honest Exitโs expected returned packets at which the successor gate
sets its bar โ see successor_required_packets . SURB_DARK_NOTIFY_PERIOD ๐ How often the Exit reports its SURB level while its frames stall: while the forward path is dark. SURB_DEGRADED_HOLD ๐ How long a frame loss keeps the Exitโs notification at its degraded period. SURB_DEGRADED_POLL ๐ How often the Exitโs loss driver re-reads the Sessionโs forward path. SURB_DEGRADED_STALL ๐ How long the Exitโs frames have to stall before the forward path counts as degraded without a loss yet. SURB_RESERVE_POLL ๐ How often a data packet held back for the keep-alive reserve looks at the SURB estimate again. account_incoming_surbs ๐ Books an incoming packetโs SURBs into the Exitโs flow estimator. acquire_egress_permit ๐ Passes one outgoing data packet through a Sessionโs PIX egress gate, if it has one. announced_idle_timeout ๐ The idle timeout the Entry announced in additional_data, or None if it announced none. answer_while_draining ๐ How a close is answered for a Session whose SURB buffer is already draining. backed_off_notify_period ๐ The report period after idle_reports idle reports: base for the first IDLE_REPORTS_AT_BASE , then
doubling up to cap. At 15 s and 60 s the gaps run 15, 15, 15, 30, 60, 60, โฆ book_start_message_surbs ๐ Books what a Start-protocol packet did to an incoming Sessionโs SURB store: the SURBs it carried and
the ones the store lost to it. A no-op for an outgoing Session, whose counterparty stores no SURBs of
ours. cap_organic_surbs ๐ Caps how many SURBs an outgoing Session data packet may carry, per the SURB balancer. close_session ๐ Closes an established Session. commit_slot_guard ๐ Commits guard, admitting session_id into the SURB store for capacity SURBs. count_exit_control_send ๐ Counts a sendโs outcome in hopr_exit_control_packets_total, passing the result through. count_return_packet_surb ๐ Counts the SURB a return packet will take as consumed in estimator, and attaches the refund that
gives it back. current_keep_alive_surb_reserve ๐ The keep-alive reserve of a Session whose Entry currently asks for the target balancer holds. cycle_budget_for What a PIX Session at these dimensions costs the nodeโs live-cycle budget. decode_pix_offer ๐ Decodes the incentivization the Entry offered, before anyone is asked what to do about it. defer_admission_retire ๐ Retires pseudonym on behalf of token, after a grace derived from the pipelineโs
SURB-resolution window (see surb_retire_grace ), when a runtime is running. effective_surb_reserve ๐ The SURB reserve one Sessionโs fill actually respects. exit_data_egress ๐ The Exitโs data egress for a rate-controlled Session: holds each packet back while the SURB stock
is down to the keep-alive reserve of the target balancer holds (once the Entry refills it, see
hold_for_surb_reserve ), books the SURB it consumes, and passes it through the PIX egress gate. exit_forward_path_is_degraded ๐ Whether the Exit should report its SURB level faster than its normal period. forget_request_of ๐ Forgets last_request when retired is one of its members. has_announced_surb_target ๐ Whether the Exit holds a SURB target the Entry announced for this Session. hold_for_surb_reserve ๐ Holds an outgoing data packet back while the Exitโs SURB stock is down to its keep-alive reserve
(see current_keep_alive_surb_reserve ). initiation_cache_ttl ๐ TTL of the pending-initiation caches: the longest initiation_wait plus the time the
StartSession send may take before that wait starts. initiation_options ๐ Inverse of into_initiation_additional_data for the options word, ignoring the least significant half. initiation_timeout_max_one_way ๐ initiation_wait ๐ How long new_session waits for the answer to a StartSession over the given hop counts. into_initiation_additional_data ๐ Packs the 64-bit options word into the most significant half of StartInitiation::additional_data, and
the Entryโs idle timeout into its lowest 32 bits. is_full_queue_warn_due ๐ Whether the drop that saw drops_so_far prior full-queue drops is the one that logs. keep_alive_surb_reserve ๐ SURBs the Exit keeps back from its data, so that its keep-alives can still be sent. max_cycle_budget_for_quota The largest reservation any offer inside a quota_range ending at quota_bytes can produce. note_exit_data_activity ๐ Tells the Exitโs keep-alive stream, if it runs one, that application data moved. publication_cut_short ๐ Puts a claimed member back after its publication failed, and reports the cut. publish_commitment ๐ Puts one cycleโs commitment burst on the wire and, only once all of it is out, announces its deposit
address. release_session_slot ๐ Tears down a Session slot: stops its tasks and returns what it holds. report_start_result ๐ Shared result handling for both Start lanes. republish_commitments ๐ Sends the whole burst of each of members again, rebuilt from the material the generator
retains, and announces nothing. resend_payload ๐ Decides whether ssa_ids can be re-sent, and with what. resume_publication ๐ Finishes publishing the batch an interrupted publication left behind, member by member in ascending
order, stopping at the first transport failure. send_via_msg_sender ๐ session_config ๐ session_config_with ๐ As session_config , with the initiating sessionโs own head-of-line bound. session_idle_notify_cap ๐ The longest idle report period for one Exit Session. start_control_channel_capacity ๐ Capacity of the control Start protocol lane (every variant but StartSession). start_session_channel_capacity ๐ Capacity of the StartSession lane. successor_required_packets ๐ Returned packets the successor gate demands of an Exit whose boundary is target packets, at the
share loss tolerated_loss the negotiated split survives. surb_retire_grace ๐ How long a teardown waits before retiring its Sessionโs pseudonym from the SURB storeโs admitted
class. validate_incoming_session_pix_config Validates the incoming-PIX invariants that span quota, supervision and memory settings. AdmissionCell ๐ The admission-token cell a SessionSlot shares with the SessionSlotGuard that allocated it. BoxSink ๐ CommitmentBurst ๐ The messages of one cycleโs client commitment, as [SsaClientCommitmentMessage::new_multiple] splits it. EgressItem ๐ One outgoing data packet on its way to the wire. EgressPermit ๐ The result of asking the PIX egress gate for permission to send one packet. LastSsaRequest ๐ The batch most recently put on the wire by the PIX action driver, with the message that carried it. SessionInitiationCache ๐ SessionNotifiers ๐ StartMessage ๐ StartProtocolMsgSink ๐