Skip to main content

Module config

Module config 

Source
Expand description

Configuration of the crate::HoprTransport.

StructsΒ§

HoprCodecConfig
Configuration of [HoprEncoder] and [HoprDecoder].
HoprPacketPipelineConfig
Configuration of the HOPR packet pipeline.
HoprProtocolConfig
Complete configuration of the HOPR protocol stack.
HoprUnacknowledgedTicketProcessorConfig
Configuration for the [HoprUnacknowledgedTicketProcessor].
HostConfig
Configuration of the listening host.
MixerConfig
Mixer configuration.
PixGlobalConfig
Global configuration for the Protocol for Incentivization of eXits (PIX).
PixReconstructorConfig
Operator-facing mirror of SsaReconstructorConfig, the Exit-side share reconstructor.
ProbeConfig
Configuration for the probing mechanism
SessionGlobalConfig
Global configuration of Sessions and the Session manager.
StreamProtocolConfig
Configuration of the per-peer egress stream layer.
SurbStoreConfig
Configuration for the SURB cache.
TransitLatencyConfig
Simulated per-packet transit latency inserted between the mixer and the wire.
TransportConfig
Configuration of the physical transport mechanism.

EnumsΒ§

HostType
Enumeration of possible host types.
SurbPopOrder
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 PixGlobalConfig will 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 in SessionManagerConfig (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 by SessionManager::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 IncomingSessionPixConfig whose 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 SsaReconstructorConfig itself would reject.
validate_session_idle_timeout πŸ”’
validate_stream_open_timeout πŸ”’
validate_surb_balance_notify_period πŸ”’