Skip to main content

VCLConfig

Struct VCLConfig 

Source
pub struct VCLConfig {
    pub transport: TransportMode,
    pub reliability: ReliabilityMode,
    pub max_retries: u32,
    pub retry_interval_ms: u64,
    pub fragment_size: usize,
    pub flow_window_size: usize,
}
Expand description

Full configuration for a VCL connection.

Controls transport, reliability, fragmentation, and flow control behaviour. Use one of the preset constructors or build a custom config.

§Presets

PresetTransportReliabilityUse case
vpn()TCPReliableVPN tunnels, secure comms
gaming()UDPPartialReal-time games
streaming()UDPUnreliableVideo/audio streaming
auto()AutoAdaptiveUnknown / mixed traffic

Fields§

§transport: TransportMode

Transport protocol to use.

§reliability: ReliabilityMode

Reliability guarantee for packet delivery.

§max_retries: u32

Maximum number of retransmission attempts for lost packets. Only used when reliability is Reliable or Partial. Default: 5

§retry_interval_ms: u64

Time in milliseconds between retransmission attempts. Default: 100

§fragment_size: usize

Maximum payload size per fragment in bytes. Packets larger than this are split into multiple fragments. Default: 1200 (safe for most networks including VPN overhead)

§flow_window_size: usize

Number of packets that can be in-flight simultaneously (flow control window). Default: 64

Implementations§

Source§

impl VCLConfig

Source

pub fn vpn() -> Self

VPN mode — reliability over speed.

Uses TCP with guaranteed delivery. Every packet is retransmitted on loss. Suitable for VPN tunnels, secure communications, financial transactions.

use vcl_protocol::config::{VCLConfig, TransportMode, ReliabilityMode};

let config = VCLConfig::vpn();
assert_eq!(config.transport, TransportMode::Tcp);
assert_eq!(config.reliability, ReliabilityMode::Reliable);
Source

pub fn gaming() -> Self

Gaming mode — speed over reliability.

Uses UDP with partial reliability. Only critical packets are retransmitted. Suitable for real-time games, position updates, input events.

use vcl_protocol::config::{VCLConfig, TransportMode, ReliabilityMode};

let config = VCLConfig::gaming();
assert_eq!(config.transport, TransportMode::Udp);
assert_eq!(config.reliability, ReliabilityMode::Partial);
Source

pub fn streaming() -> Self

Streaming mode — lowest latency, no retransmission.

Uses UDP with no reliability guarantees. Lost packets are dropped silently. Suitable for video/audio streaming where a missed frame is better than lag.

use vcl_protocol::config::{VCLConfig, TransportMode, ReliabilityMode};

let config = VCLConfig::streaming();
assert_eq!(config.transport, TransportMode::Udp);
assert_eq!(config.reliability, ReliabilityMode::Unreliable);
Source

pub fn auto() -> Self

Auto mode — recommended default.

VCL selects transport and reliability dynamically based on network conditions. Starts with UDP, upgrades to TCP on detected packet loss.

use vcl_protocol::config::{VCLConfig, TransportMode, ReliabilityMode};

let config = VCLConfig::auto();
assert_eq!(config.transport, TransportMode::Auto);
assert_eq!(config.reliability, ReliabilityMode::Adaptive);
Source

pub fn is_tcp(&self) -> bool

Returns true if this config uses TCP transport or will select TCP in Auto mode.

Source

pub fn has_retransmission(&self) -> bool

Returns true if retransmission is enabled for this config.

Source

pub fn needs_fragmentation(&self, size: usize) -> bool

Returns true if fragmentation is needed for a payload of size bytes.

Trait Implementations§

Source§

impl Clone for VCLConfig

Source§

fn clone(&self) -> VCLConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for VCLConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for VCLConfig

Source§

fn default() -> Self

Default config is VCLConfig::auto().

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more