Expand description
Configuration of the crate::HoprTransport.
StructsΒ§
- Hopr
Codec Config - Configuration of [
HoprEncoder] and [HoprDecoder]. - Hopr
Packet Pipeline Config - Configuration of the HOPR packet pipeline.
- Hopr
Protocol Config - Complete configuration of the HOPR protocol stack.
- Hopr
Unacknowledged Ticket Processor Config - Configuration for the [
HoprUnacknowledgedTicketProcessor]. - Host
Config - Configuration of the listening host.
- Mixer
Config - Mixer configuration.
- PixGlobal
Config - Global configuration for the Protocol for Incentivization of eXits (PIX).
- PixReconstructor
Config - Operator-facing mirror of
SsaReconstructorConfig, the Exit-side share reconstructor. - Probe
Config - Configuration for the probing mechanism
- Session
Global Config - Global configuration of Sessions and the Session manager.
- Stream
Protocol Config - Configuration of the per-peer egress stream layer.
- Surb
Store Config - Configuration for the SURB cache.
- Transit
Latency Config - Simulated per-packet transit latency inserted between the mixer and the wire.
- Transport
Config - Configuration of the physical transport mechanism.
EnumsΒ§
- Host
Type - Enumeration of possible host types.
- Surb
PopOrder - Which end of the per-pseudonym buffer a pop consumes from. Replying side only.
ConstantsΒ§
- DEFAULT_
COUNTER_ πFLUSH_ INTERVAL - DEFAULT_
EGRESS_ πBACKPRESSURE_ TIMEOUT - DEFAULT_
FRAME_ πWRITER_ BACKPRESSURE_ BYTES - DEFAULT_
MAXIMUM_ πMANAGED_ SESSIONS - DEFAULT_
PER_ πPEER_ CHANNEL_ CAPACITY - DEFAULT_
SESSION_ πBALANCER_ BUFFER_ DURATION - DEFAULT_
SESSION_ πBALANCER_ SAMPLING - DEFAULT_
SESSION_ πESTABLISH_ MAX_ RETRIES - DEFAULT_
SESSION_ πESTABLISH_ RETRY_ DELAY - DEFAULT_
SESSION_ πIDLE_ TIMEOUT - DEFAULT_
STREAM_ πOPEN_ TIMEOUT - DEFAULT_
SURB_ πFLUSH_ INTERVAL - How often SURB round-trip counts reach the network graph.
- MAX_
PIX_ πDIMENSION_ PRODUCT_ FACTOR - Headroom over the profiled dimension product that
PixGlobalConfigwill accept. - MIN_
EGRESS_ BACKPRESSURE_ TIMEOUT - Minimum accepted value for
StreamProtocolConfig::egress_backpressure_timeout. - MIN_
STREAM_ OPEN_ TIMEOUT - Minimum accepted value for
StreamProtocolConfig::stream_open_timeout. - SESSION_
IDLE_ πMIN_ TIMEOUT
FunctionsΒ§
- default_
counter_ πflush_ interval - default_
egress_ πbackpressure_ timeout - default_
frame_ πwriter_ backpressure_ bytes - default_
max_ πmanaged_ sessions - default_
multiaddr_ πtransport - default_
per_ πpeer_ channel_ capacity - default_
session_ πbalancer_ buffer_ duration - default_
session_ πbalancer_ sampling - default_
session_ πestablish_ max_ retries - default_
session_ πestablish_ retry_ delay - default_
session_ πidle_ timeout - default_
session_ πmax_ frames_ behind_ gap - default_
session_ πsurb_ balance_ notify_ period - Transport-layer default for the SURB balance notification period; this is the effective default
for
SessionGlobalConfig::surb_balance_notify_period(15s). It deliberately overrides the lower-level fallback inSessionManagerConfig(whose own field default is 60s) with a tighter 15s cadence, so the Entryβs dead-reckoned estimate of the Exitβs SURB buffer is corrected often enough to keep the SURB balancer from under-producing (and starving the Exit) under drift, without the per-session keep-alive overhead of the previous 2s cadence. The 1s floor is enforced downstream bySessionManager::new(MIN_SURB_BUFFER_NOTIFICATION_PERIOD). - default_
stream_ πopen_ timeout - default_
surb_ πflush_ interval - is_
dns_ πaddress_ regex - is_
reachable_ domain - Check whether the string is an actual reachable domain.
- looks_
like_ domain - Check whether the string looks like a valid domain.
- validate_
balancer_ πbuffer_ duration - validate_
balancer_ πsampling - validate_
dns_ πaddress - validate_
egress_ πbackpressure_ timeout - validate_
incoming_ πsession_ pix_ config - Rejects an
IncomingSessionPixConfigwhose acceptance range can never match anything, or whose SSA batch size is outside what the protocol supports. - validate_
ipv4_ πaddress - validate_
pix_ πdimension_ product - Rejects dimensions whose product is far outside anything that has been measured.
- validate_
pix_ πreconstructor_ config - Rejects a reconstructor configuration that
SsaReconstructorConfigitself would reject. - validate_
session_ πidle_ timeout - validate_
stream_ πopen_ timeout - validate_
surb_ πbalance_ notify_ period