Skip to main content

Module types

Module types 

Source

Structs§

AdmissionToken
Names one admission of a pseudonym into the SURB store’s admitted class.
AgreedSsaQuota
Representation of a data quota per SSA agreed upon during the Session establishment.
HoprPixDepositPayload
The deposit data for a single SSA, as it travels inside an SsaRequest.
HoprSession
Represents the Session protocol socket over HOPR.
HoprSessionCapabilities
Wrapper for Capabilities that makes conversion to/from u8 possible.
HoprSessionConfig
Configures the Session protocol socket over HOPR.

Enums§

ClosureReason
Indicates the closure reason of a HoprSession.
HoprSessionInPixEvent
Events received by the crate::manager::SessionManager in reaction to received shares from the packet pipeline.
HoprSessionOutPixEvent
Events raised by the crate::manager::SessionManager in response to received PIX messages.
SessionTarget
SessionId, ServiceId, and SessionTarget are provided by hopr-types and re-exported here via hopr-utils, so they match the published hopr-api session types.

Constants§

DEFAULT_PIX_PARAMS 🔒
The three defaults and the local curve suite, as the single set both nodes must agree on.
DEFAULT_PIX_POLYS_PER_SSA
Default number of polynomials (“SSA parts”) a single SSA is split into.
DEFAULT_PIX_QUOTA_RANGE_SPAN 🔒
Divisor applied to DEFAULT_PIX_SSA_QUOTA to obtain the lower bound of the default quota_range.
DEFAULT_PIX_SHARES_PER_POLY
Default number of shares required to reconstruct a single SSA part.
DEFAULT_PIX_SSA_QUOTA
Nominal per-SSA data quota implied by the default PIX dimensions.
DEFAULT_PIX_SURPLUS_SHARES
Default number of shares emitted per SSA part beyond DEFAULT_PIX_SHARES_PER_POLY.
LOCAL_PIX_SUITE
The elliptic curve suite this build instantiates PIX over, as announced to peers.
PIX_QUOTA_BYTES_PER_SHARE
Bytes of quota one PIX share is priced at: the Session data the packet it rides on can carry.
SESSION_APPLICATION_TAG
Constant application tag used for all sessions. Previously tags were dynamically allocated per session.
SESSION_SOCKET_CAPACITY 🔒

Traits§

AsyncReadWrite 🔒
Helper trait to allow Box aliasing
SurbAdmissionControl
Hands a SessionId in and out of the SURB store’s admission classes.

Functions§

caps_to_ack_mode 🔒
deposit_data_for_batch 🔒
Turns the deposit data a pool produced for a batch into the per-SSA map an SsaRequest carries.
pix_params_to_quota 🔒
What a single SSA deposit buys: every Exit → Entry Session byte the cycle can carry.

Type Aliases§

HoprPixDepositData
The deposit data a deposit pool produced for one batch of SSAs.
HoprStartProtocol
Start protocol instantiation for HOPR.
IncomingSession
Wrapper for an incoming HoprSession carrying the SessionId and SessionTarget extracted from the Start protocol during session establishment.
ServiceId
SessionId, ServiceId, and SessionTarget are provided by hopr-types and re-exported here via hopr-utils, so they match the published hopr-api session types.
SessionAdmissionReply
Where a SessionAdmissionRequest’s answer is delivered.
SessionAdmissionSink
How the SessionManager reaches whoever decides admission.
SessionId
SessionId, ServiceId, and SessionTarget are provided by hopr-types and re-exported here via hopr-utils, so they match the published hopr-api session types.
SsaQuota
Quota per single SSA in bytes.