Skip to main content

SocketConfig

Struct SocketConfig 

Source
pub struct SocketConfig {
    pub bind_addr: Option<SocketAddr>,
    pub bind_to_device: Option<String>,
    pub mark: Option<u32>,
    pub ttl: Option<u32>,
}
Expand description

Local UDP socket options used by ClientConfig.

These settings affect how the client binds and sends from the socket. They do not change the IRTT protocol parameters negotiated with the server.

§Example

Bind to a chosen local endpoint and set the outgoing IPv4 TTL:

use std::net::{Ipv4Addr, SocketAddr};

use irtt_client::{AddressFamily, ClientConfig, SocketConfig};

let config = ClientConfig {
    address_family: AddressFamily::Ipv4,
    socket: SocketConfig {
        bind_addr: Some(SocketAddr::from((Ipv4Addr::UNSPECIFIED, 0))),
        ttl: Some(32),
        ..SocketConfig::default()
    },
    ..ClientConfig::default()
};

assert_eq!(config.socket.ttl, Some(32));
assert_eq!(config.address_family, AddressFamily::Ipv4);

Fields§

§bind_addr: Option<SocketAddr>

Local address to bind before connecting the UDP socket.

None binds to an unspecified address with an ephemeral port matching the selected remote address family.

§bind_to_device: Option<String>

Network interface to bind this socket to (SO_BINDTODEVICE).

§mark: Option<u32>

Firewall mark applied to outgoing packets (SO_MARK).

§ttl: Option<u32>

Optional IPv4 TTL or IPv6 hop limit applied to sent packets.

None leaves the platform default unchanged. Values must fit in the platform socket option range; MAX_TTL is the public configuration bound used by this crate.

Trait Implementations§

Source§

impl Clone for SocketConfig

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SocketConfig

Source§

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

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

impl Default for SocketConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Eq for SocketConfig

Source§

impl PartialEq for SocketConfig

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for SocketConfig

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, 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 = !

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

fn try_from(value: U) -> Result<T, !>

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.