Struct SessionClientConfig 

pub struct SessionClientConfig {
    pub forward_path_options: RoutingOptions,
    pub return_path_options: RoutingOptions,
    pub capabilities: FlagSet<Capability>,
    pub pseudonym: Option<SimplePseudonym>,
    pub surb_management: Option<SurbBalancerConfig>,
    pub always_max_out_surbs: bool,
    pub flow_control: Option<FlowControlConfig>,
    pub max_frames_behind_gap: Option<usize>,
}

Configuration for the session.

Relevant primarily for the client, since the server is only a reactive component in regard to the session concept.

Fields

forward_path_options: RoutingOptions

The forward path options for the session.

return_path_options: RoutingOptions

The return path options for the session.

capabilities: FlagSet<Capability>

Capabilities offered by the session.

pseudonym: Option<SimplePseudonym>

Optional pseudonym used for the session. Mostly useful for testing only.

surb_management: Option<SurbBalancerConfig>

Enable automatic SURB management for the Session.

always_max_out_surbs: bool

If set, the maximum number of possible SURBs will always be sent with Session data packets (if they fit).

This does not affect KeepAlive messages used with SURB balancing, as they will always carry the maximum number of SURBs possible. Setting this to true will put additional CPU pressure on the local node as it will generate the maximum number of SURBs for each data packet.

It also opts out of the SURB balancer’s control over organic production entirely. With the default false, a data packet carries at most one SURB and none at all while the counterparty is estimated to be at its target buffer size — which is what stops SURBs being delivered into a full buffer that discards them. Setting this to true keeps producing regardless of that estimate.

Set this to true only when the underlying traffic is highly asymmetric.

Default is false.

flow_control: Option<FlowControlConfig>

Opt-in client-side send-window flow control for this session.

None (the default) leaves the session unpaced — today’s behaviour. Some(..) enables the adaptive AIMD window on the entry (sending) side; use FlowControlConfig::default for the verified clean profile or FlowControlConfig::robust for the tail-tolerance bundle. This is the client’s explicit dial (only meaningful on a reliable / RetransmissionAck session).

max_frames_behind_gap: Option<usize>

Abandon the frame due next once the sequence has advanced this far past it, instead of holding everything already received for the whole frame timeout.

Head-of-line bound for this session’s incoming direction. None inherits the node’s setting, Some(0) disables it here, Some(n) sets it.

Worth setting per session because the right value tracks reordering depth – throughput x latency spread / frame size – which is a property of the traffic, not of the node: a bulk data session and a control session on the same node differ by orders of magnitude.

Has no effect on a session carrying a retransmission capability, where a missing frame can still be recovered and waiting for it is productive.

Trait Implementations

impl Clone for SessionClientConfig

fn clone(&self) -> SessionClientConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SessionClientConfig

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

Formats the value using the given formatter.

impl Default for SessionClientConfig

fn default() -> SessionClientConfig

Return SessionClientConfig { forward_path_options: RoutingOptions::Hops(hopr_api::types::primitive::bounded::BoundedSize::MIN), return_path_options: RoutingOptions::Hops(hopr_api::types::primitive::bounded::BoundedSize::MIN), capabilities: Capability :: Segmentation.into(), pseudonym: None, surb_management: Some(SurbBalancerConfig::default()), always_max_out_surbs: false, flow_control: None, max_frames_behind_gap: Default::default() }

impl PartialEq for SessionClientConfig

fn eq(&self, other: &SessionClientConfig) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for SessionClientConfig