Struct ConnectionBuilder

pub struct ConnectionBuilder { /* private fields */ }

Implementations

impl ConnectionBuilder

pub fn keepalive(self, time: Option<Duration>) -> Self

Set that all sockets have SO_KEEPALIVE set with the supplied duration to remain idle before sending TCP keepalive probes.

If None, keepalive is disabled.

Default is None.

pub fn keepalive_interval(self, interval: Option<Duration>) -> Self

Set the duration between two successive TCP keepalive retransmissions, if acknowledgement to the previous keepalive transmission is not received.

pub fn keepalive_retries(self, retries: Option<u32>) -> Self

Set the number of retransmissions to be carried out before declaring that remote end is not available.

pub fn nodelay(self, nodelay: bool) -> Self

Set that all sockets have SO_NODELAY set to the supplied value nodelay.

Default is false.

pub fn send_buffer_size(self, size: Option<usize>) -> Self

Sets the value of the SO_SNDBUF option on the socket.

pub fn recv_buffer_size(self, size: Option<usize>) -> Self

Sets the value of the SO_RCVBUF option on the socket.

pub fn local_address(self, addr: Option<IpAddr>) -> Self

Set that all sockets are bound to the configured address before connection.

If None, the sockets will not be bound.

Default is None.

pub fn local_addresses(self, addr_ipv4: Ipv4Addr, addr_ipv6: Ipv6Addr) -> Self

Set that all sockets are bound to the configured IPv4 or IPv6 address (depending on host’s preferences) before connection.

pub fn connect_timeout(self, dur: Option<Duration>) -> Self

Set the connect timeout.

If a domain resolves to multiple IP addresses, the timeout will be evenly divided across them.

Default is None.

pub fn happy_eyeballs_timeout(self, dur: Option<Duration>) -> Self

Set timeout for RFC 6555 (Happy Eyeballs) algorithm.

If hostname resolves to both IPv4 and IPv6 addresses and connection cannot be established using preferred address family before timeout elapses, then connector will in parallel attempt connection using other address family.

If None, parallel connection attempts are disabled.

Default is 300 milliseconds.

pub fn reuse_address(self, reuse_address: bool) -> Self

Set that all socket have SO_REUSEADDR set to the supplied value reuse_address.

Default is false.

pub fn interface<S: Into<String>>(self, interface: S) -> Self

Sets the value for the SO_BINDTODEVICE option on this socket.

If a socket is bound to an interface, only packets received from that particular interface are processed by the socket. Note that this only works for some socket types, particularly AF_INET sockets.

On Linux it can be used to specify a VRF, but the binary needs to either have CAP_NET_RAW or to be run as root.

This function is only available on Android、Fuchsia and Linux.

pub async fn establish(self) -> Result<Io, Error>

Build and establish connection

pub async fn tls_setup(self) -> Result<TlsBuilder, Error>

Build connection and proceed with tls setup.

pub fn socks5_proxy_setup(self, proxy_addr: Uri) -> Socks5ProxyBuilder

Build connection and proceed with socks5 proxy setup.