Struct actix_web::client::Connector

pub struct Connector<T, U> { /* fields omitted */ }

Manages http client network connectivity The Connector type uses a builder-like combinator pattern for service construction that finishes by calling the .finish() method.

use std::time::Duration;
use actix_http::client::Connector;

let connector = Connector::new()
     .timeout(Duration::from_secs(5))
     .finish();

Implementations

impl Connector<(), ()>

pub fn new(
) -> Connector<impl Clone + Service<Request = Connect<Uri>, Response = Connection<Uri, TcpStream>, Error = ConnectError>, TcpStream>

impl<T, U> Connector<T, U>

pub fn connector<T1, U1>(self, connector: T1) -> Connector<T1, U1> where
    T1: Service<Request = Connect<Uri>, Response = Connection<Uri, U1>, Error = ConnectError> + Clone,
    U1: AsyncRead + AsyncWrite + Unpin + Debug, 

Use custom connector.

impl<T, U> Connector<T, U> where
    T: Service<Request = Connect<Uri>, Response = Connection<Uri, U>, Error = ConnectError> + Clone + 'static,
    U: AsyncWrite + Unpin + Debug + 'static + AsyncRead, 

pub fn timeout(self, timeout: Duration) -> Connector<T, U>

Connection timeout, i.e. max time to connect to remote host including dns name resolution. Set to 1 second by default.

pub fn ssl(self, connector: SslConnector) -> Connector<T, U>

Use custom SslConnector instance.

pub fn rustls(self, connector: Arc<ClientConfig>) -> Connector<T, U>

pub fn max_http_version(self, val: Version) -> Connector<T, U>

Maximum supported http major version Supported versions http/1.1, http/2

pub fn initial_window_size(self, size: u32) -> Connector<T, U>

Indicates the initial window size (in octets) for HTTP2 stream-level flow control for received data.

The default value is 65,535 and is good for APIs, but not for big objects.

pub fn initial_connection_window_size(self, size: u32) -> Connector<T, U>

Indicates the initial window size (in octets) for HTTP2 connection-level flow control for received data.

The default value is 65,535 and is good for APIs, but not for big objects.

pub fn limit(self, limit: usize) -> Connector<T, U>

Set total number of simultaneous connections per type of scheme.

If limit is 0, the connector has no limit. The default limit size is 100.

pub fn conn_keep_alive(self, dur: Duration) -> Connector<T, U>

Set keep-alive period for opened connection.

Keep-alive period is the period between connection usage. If the delay between repeated usages of the same connection exceeds this period, the connection is closed. Default keep-alive period is 15 seconds.

pub fn conn_lifetime(self, dur: Duration) -> Connector<T, U>

Set max lifetime period for connection.

Connection lifetime is max lifetime of any opened connection until it is closed regardless of keep-alive period. Default lifetime period is 75 seconds.

pub fn disconnect_timeout(self, dur: Duration) -> Connector<T, U>

Set server connection disconnect timeout in milliseconds.

Defines a timeout for disconnect connection. If a disconnect procedure does not complete within this time, the socket get dropped. This timeout affects only secure connections.

To disable timeout set value to 0.

By default disconnect timeout is set to 3000 milliseconds.

pub fn finish(
    self
) -> impl Clone + Service<Request = Connect, Response = impl Connection, Error = ConnectError>

Finish configuration process and create connector service. The Connector builder always concludes by calling finish() last in its combinator chain.