Struct awc::Connector

pub struct Connector<T> { /* private fields */ }

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;

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

Implementations

impl Connector<()>

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

Create a new connector with default TLS settings

Panics

• When the rustls-0_23-webpki-roots or rustls-0_23-native-roots features are enabled and no default crypto provider has been loaded, this method will panic.
• When the rustls-0_23-native-roots or rustls-0_22-native-roots features are enabled and the runtime system has no native root certificates, this method will panic.

impl<S> Connector<S>

pub fn connector<S1, Io1>(self, connector: S1) -> Connector<S1>

where Io1: ActixStream + Debug + 'static, S1: Service<ConnectInfo<Uri>, Response = TcpConnection<Uri, Io1>, Error = TcpConnectError> + Clone,

Sets custom connector.

impl<S, IO> Connector<S>

where IO: ActixStream + Debug + 'static, S: Service<ConnectInfo<Uri>, Response = Connection<Uri, IO>, Error = ConnectError> + Clone + 'static,

pub fn timeout(self, timeout: Duration) -> Self

Sets TCP connection timeout.

This is the max time allowed to connect to remote host, including DNS name resolution.

By default, the timeout is 5 seconds.

pub fn handshake_timeout(self, timeout: Duration) -> Self

Sets TLS handshake timeout.

This is the max time allowed to perform the TLS handshake with remote host after TCP connection is established.

By default, the timeout is 5 seconds.

pub fn openssl(self, connector: SslConnector) -> Self

Available on crate feature openssl only.

Sets custom OpenSSL SslConnector instance.

pub fn rustls(self, connector: Arc<ClientConfig>) -> Self

Available on crate feature rustls-0_20 only.

Sets custom Rustls v0.20 ClientConfig instance.

pub fn rustls_021(self, connector: Arc<ClientConfig>) -> Self

Available on crate feature rustls-0_21 only.

Sets custom Rustls v0.21 ClientConfig instance.

pub fn rustls_0_22(self, connector: Arc<ClientConfig>) -> Self

Available on crate features rustls-0_22-webpki-roots or rustls-0_22-native-roots only.

Sets custom Rustls v0.22 ClientConfig instance.

pub fn rustls_0_23(self, connector: Arc<ClientConfig>) -> Self

Available on crate feature rustls-0_23 only.

Sets custom Rustls v0.23 ClientConfig instance.

In order to enable ALPN, set the .alpn_protocols field on the ClientConfig to the following:

vec![b"h2".to_vec(), b"http/1.1".to_vec()]

pub fn max_http_version(self, val: Version) -> Self

Sets maximum supported HTTP major version.

Supported versions are HTTP/1.1 and HTTP/2.

pub fn initial_window_size(self, size: u32) -> Self

Sets the initial window size (in bytes) for HTTP/2 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) -> Self

Sets the initial window size (in bytes) for HTTP/2 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) -> Self

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) -> Self

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) -> Self

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) -> Self

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 local_address(self, addr: IpAddr) -> Self

Set local IP Address the connector would use for establishing connection.

pub fn finish( self ) -> ConnectorServicePriv<TcpConnectorService<TcpConnectorInnerService<S>>, Rc<dyn Service<Connect, Response = (Box<dyn ConnectionIo>, Protocol), Error = ConnectError, Future = LocalBoxFuture<'static, Result<(Box<dyn ConnectionIo>, Protocol), ConnectError>>>>, IO, Box<dyn ConnectionIo>>

Finish configuration process and create connector service.

The Connector builder always concludes by calling finish() last in its combinator chain.