Struct TcpListener 

pub struct TcpListener { /* private fields */ }

A TCP socket listener that optionally allows for round-robin load-balancing in-process.

Implementations

impl TcpListener

pub fn bind(socket_addr: SocketAddr, reuse_port: bool) -> Result<Self>

Bind to a port. On Linux, or when we don’t have SO_REUSEPORT set, we just bind the port directly. On other platforms, we emulate SO_REUSEPORT by cloning the socket and having each clone race to accept every connection.

Why not SO_REUSEPORT?

The SO_REUSEPORT socket option allows multiple sockets on the same host to bind to the same port. This is particularly useful for load balancing or implementing high availability in server applications.

On Linux, SO_REUSEPORT allows multiple sockets to bind to the same port, and the kernel will load balance incoming connections among those sockets. Each socket can accept connections independently. This is useful for scenarios where you want to distribute incoming connections among multiple processes or threads.

On macOS (which is based on BSD), the behaviour of SO_REUSEPORT is slightly different. When SO_REUSEPORT is set, multiple sockets can still bind to the same port, but the kernel does not perform load balancing as it does on Linux. Instead, it follows a “last bind wins” strategy. This means that the most recently bound socket will receive incoming connections exclusively, while the previously bound sockets will not receive any connections. This behaviour is less useful for load balancing compared to Linux, but it can still be valuable in certain scenarios.

pub fn bind_direct(socket_addr: SocketAddr, reuse_port: bool) -> Result<Self>

Bind directly to the port, passing reuse_port directly to the socket. On platforms other than Linux, reuse_port does not do any load balancing.

pub fn bind_load_balanced(socket_addr: SocketAddr) -> Result<Self>

Bind to the port in a load-balanced manner.

pub async fn accept(&self) -> Result<(TcpStream, SocketAddr)>

pub fn local_addr(&self) -> Result<SocketAddr>

Trait Implementations

impl Drop for TcpListener

fn drop(&mut self)

Executes the destructor for this type.

impl From<TcpListener> for NetworkStreamListener

fn from(value: TcpListener) -> Self

Converts to this type from the input type.

impl NetworkStreamListenerTrait for TcpListener

const RESOURCE_NAME: &'static str = "tcpListener"

type Stream = TcpStream

type Addr = SocketAddr

type ResourceData = ()

Additional data, if needed

async fn accept(&self) -> Result<(Self::Stream, Self::Addr)>

fn listen_address(&self) -> Result<Self::Addr>