Skip to main content

ListenOptions

Struct ListenOptions 

Source
pub struct ListenOptions { /* private fields */ }
Expand description

Options set on a listening socket before bind and listen.

use net_io::{ListenOptions, TcpListener};
let options = ListenOptions::new().backlog(4096).reuse_port(cfg!(target_os = "linux"));
let listener = TcpListener::bind_with("127.0.0.1:0", options)?;
println!("effective backlog {:?}", listener.info().backlog);

Implementations§

Source§

impl ListenOptions

Source

pub fn new() -> ListenOptions

Backlog 1,024; reuse address on Unix, exclusive address use on Windows; IPv6-only; TCP_NODELAY on accepted sockets.

Source

pub fn backlog(self, n: u32) -> ListenOptions

The listen backlog (capped by the OS; the effective value is in ListenerInfo).

Source

pub fn reuse_address(self, on: bool) -> ListenOptions

Unix: SO_REUSEADDR, so a restart binds while connections of the old process linger. Windows: ignored, the port is always SO_EXCLUSIVEADDRUSE. An exclusive listener there can already bind again at once after a restart, and Windows SO_REUSEADDR means something else: another local socket could bind the same port over the listener and take its connections.

Source

pub fn reuse_port(self, on: bool) -> ListenOptions

SO_REUSEPORT (Unsupported on Windows).

Source

pub fn ipv6_only(self, on: bool) -> ListenOptions

IPV6_V6ONLY for IPv6 addresses (on by default; decision D-026).

Source

pub fn send_buffer(self, bytes: u32) -> ListenOptions

SO_SNDBUF on the listener (before listen).

Source

pub fn receive_buffer(self, bytes: u32) -> ListenOptions

SO_RCVBUF on the listener (before listen, so window scaling is negotiated).

Source

pub fn defer_accept(self, wait: Option<Duration>) -> ListenOptions

accept returns once the client has sent bytes, or after wait (TCP_DEFER_ACCEPT, whole seconds; Unsupported off Linux). A client that connects and stays silent costs no accept for that long. Cost: the gate sees the connection later, and a server that speaks first must not use this.

Source

pub fn fast_open(self, queue: Option<u32>) -> ListenOptions

Server TCP Fast Open with this many pending requests. Saves a round trip for a client that returns. Security: the first flight of data can be replayed by the network, so turn this on only for requests that are safe to run twice; the gate and the PROXY check run as usual. Linux also needs net.ipv4.tcp_fastopen.

Source

pub fn incoming_cpu(self, cpu: Option<u32>) -> ListenOptions

Accepts on this listener the connections the given CPU received (SO_INCOMING_CPU, Linux; Unsupported elsewhere). For one reuse-port listener per CPU.

Source

pub fn per_worker(self, on: bool) -> ListenOptions

One socket per reactor worker, in a SO_REUSEPORT group (Linux; Unsupported elsewhere, InvalidConfig on the blocking driver). Each worker accepts on its own socket in its own event loop, runs the caps and the gate there, and starts the connection in the same turn: no accept thread, no hand-off between threads, and no connection crosses to another worker. With ServerBuilder::placement each socket also takes the connections its worker’s CPU received. Costs: a socket per worker; the kernel’s hash decides the balance; the gate’s admit runs on the worker, so a slow gate delays that worker’s other connections; and such a listener cannot be handed off: closing one socket of a group resets what is queued on it.

Source

pub fn tcp_options(self, options: TcpOptions) -> ListenOptions

Options applied to every accepted socket.

Trait Implementations§

Source§

impl Clone for ListenOptions

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 Copy for ListenOptions

Source§

impl Debug for ListenOptions

Source§

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

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

impl Default for ListenOptions

Source§

fn default() -> ListenOptions

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

impl Eq for ListenOptions

Source§

impl PartialEq for ListenOptions

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 ListenOptions

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> 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.