Struct ConnectionOptions

Source

pub struct ConnectionOptions { /* private fields */ }

Expand description

Timeouts, buffer sizes and the reconnection policy for one client.

Every field has a default that works against a normally configured server; change only what you have a reason to change. See the module documentation for why these are checked when the ClientConfig is built rather than one at a time.

§Examples

use std::time::Duration;
use lightstreamer_rs::ConnectionOptions;

let options = ConnectionOptions::default()
    .with_open_timeout(Duration::from_secs(5))
    .with_send_sync(false);
assert_eq!(options.open_timeout(), Duration::from_secs(5));

Implementations§

Source §

impl ConnectionOptions

Source

pub const fn with_open_timeout(self, timeout: Duration) -> Self

How long a session-opening request may go unanswered before the attempt is abandoned and retried.

This is a limit of this crate: the protocol defines none, and without one a server that accepts a connection and then says nothing would wedge the client forever. Default: 10 s.

Source

pub const fn with_keepalive_slack(self, slack: Duration) -> Self

Extra grace beyond the server’s own keepalive interval before a silent stream is treated as dead and recovered.

The server promises to send something — a keepalive probe if nothing else — at least this often, and tells the client the interval when the session binds [docs/spec/02-session-lifecycle.md §8.1]. This value is added on top of that negotiated interval to absorb one late probe. Default: 3 s.

The negotiated interval always wins over ConnectionOptions::with_keepalive_hint; this slack is the only part of the liveness budget the caller controls outright.

Source

pub const fn with_keepalive_hint(self, interval: Option<Duration>) -> Self

Asks the server for a particular keepalive interval.

A hint, not a setting: the server clamps it to its own configured minimum and maximum and reports the interval it actually adopted, which is what this client then enforces [docs/spec/02-session-lifecycle.md §8.1]. Leave it unset to let the server choose, which is the default.

Source

pub const fn with_inactivity_commitment( self, interval: Option<Duration>, ) -> Self

Commits to sending the server something at least this often.

If the server hears nothing from the client for longer than this it may conclude the client is stuck and act on it [docs/spec/03-requests.md §2.1]. Setting it makes this crate send a heartbeat whenever nothing else has been sent, at half the committed interval — half being this crate’s choice, so that one lost heartbeat does not break the commitment.

Unset by default: without a commitment there is nothing to keep, and the server applies no such check.

Source

pub const fn with_send_sync(self, enabled: bool) -> Self

Whether to let the server send its periodic clock-synchronisation notifications.

They carry the seconds elapsed on the server since the session began, which lets a client detect that its own machine has been suspended [docs/spec/03-requests.md §2.1]. This crate surfaces them on the session event stream and does not act on them. Default: enabled.

Source

pub const fn with_content_length(self, bytes: Option<NonZeroU64>) -> Self

Asks the server to end each stream connection after this many bytes, forcing a clean rebind.

Chiefly a defence against intermediaries that buffer an endless response; the server raises a value it considers too low [docs/spec/03-requests.md §2.1]. Leave it unset to let the server choose, which is the default. A rebind triggered this way preserves the session and every subscription.

Source