Struct spirit_tokio::net::Listen

#[non_exhaustive]pub struct Listen {
    pub port: u16,
    pub host: IpAddr,
    pub reuse_addr: Option<bool>,
    pub reuse_port: Option<bool>,
    pub only_v6: Option<bool>,
    pub backlog: u32,
    pub ttl: Option<u32>,
}

A description of listening interface and port.

This can be used as part of configuration to describe a socket.

Note that the Default implementation is there to provide something on creation of Spirit, but isn't very useful. It'll listen on a OS-assigned port on all the interfaces.

This is used as the base of the TcpListen and UdpListen configuration fragments.

Configuration options

• port (mandatory)
• host (optional, if not present, :: is used)
• reuse-addr (optional, boolean, if not present the OS default is used)
• reuse-port (optional, boolean, if not present the OS default is used, does something only on unix).
• only-v6 (optional, boolean, if not present the OS default is used, does nothing for IPv4 sockets).
• backlog (optional, number of waiting connections to be accepted in the OS queue, defaults to 128)
• ttl (TTL of the listening/UDP socket).

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

port: u16

The port to bind to.

host: IpAddr

The interface to bind to.

Defaults to :: (IPv6 any).

reuse_addr: Option<bool>

The SO_REUSEADDR socket option.

Usually, the OS reserves the host-port pair for a short time after it has been released, so leftovers of old connections don't confuse the new application. The SO_REUSEADDR option asks the OS not to do this reservation.

If not set, it is left on the OS default (which is likely off = doing the reservation).

reuse_port: Option<bool>

The SO_REUSEPORT socket option.

Setting this to true allows multiple applications to simultaneously bind to the same port.

If not set, it is left on the OS default (which is likely off).

This option is not available on Windows and has no effect there.

only_v6: Option<bool>

The IP_V6ONLY option.

This has no effect on IPv4 sockets.

On IPv6 sockets, this restricts the socket to sending and receiving only IPv6 packets. This allows another socket to bind the same port on IPv4. If it is set to false, the socket can communicate with both IPv6 and IPv4 endpoints under some circumstances.

Due to platform differences, the generally accepted best practice is to bind IPv4 and IPv6 as two separate sockets, the IPv6 one with setting IP_V6ONLY explicitly to true.

If not set, it is left on the OS default (which differs from OS to OS).

backlog: u32

The accepting backlog.

Has no effect for UDP sockets.

This specifies how many connections can wait in the kernel before being accepted. If more than this limit are queued, the kernel starts refusing them with connection reset packets.

The default is 128.

ttl: Option<u32>

The TTL field of IP packets sent from this socket.

If not set, it defaults to the OS value.

Implementations

impl Listen

pub fn create_tcp(&self) -> Result<StdTcpListener, AnyError>

Creates a TCP socket described by the loaded configuration.

This is the synchronous socket from standard library. See TcpListener::from_std.

pub fn create_udp(&self) -> Result<StdUdpSocket, AnyError>

Creates a UDP socket described by the loaded configuration.

This is the synchronous socket from standard library. See UdpSocket::from_std.

Trait Implementations

impl Clone for Listen

fn clone(&self) -> Listen

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Listen

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

Formats the value using the given formatter.

impl Default for Listen

fn default() -> Self

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for Listen

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Eq for Listen

impl Hash for Listen

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for Listen

fn cmp(&self, other: &Listen) -> Ordering

This method returns an Ordering between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<Listen> for Listen

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<Listen> for Listen

fn partial_cmp(&self, other: &Listen) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Listen) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Listen) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Listen) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Listen) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Listen

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructDoc for Listen

fn document() -> Documentation

Returns the documentation for the type.

impl StructuralEq for Listen

impl StructuralPartialEq for Listen