Struct ntex::http::client::Connector

pub struct Connector { /* 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 ntex::http::client::Connector;
use ntex::time::Millis;

let connector = Connector::default()
     .timeout(Millis(5_000))
     .finish();

Implementations

impl Connector

pub fn new() -> Connector

impl Connector

pub fn timeout<T: Into<Millis>>(self, timeout: T) -> Self

Connection timeout.

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

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

Use openssl connector for secured connections.

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

Use rustls connector for secured connections.

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 keep_alive(self, dur: Seconds) -> 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 lifetime(self, dur: Seconds) -> 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<T: Into<Millis>>(self, timeout: T) -> Self

Set server connection disconnect timeout.

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 3 seconds.

pub fn connector<Io, T>(self, connector: T) -> Self where
    T: Service<TcpConnect<Uri>, Response = Io, Error = ConnectError> + 'static,
    IoBoxed: From<Io>, 

Use custom connector to open un-secured connections.

pub fn secure_connector<Io, T>(self, connector: T) -> Self where
    T: Service<TcpConnect<Uri>, Response = Io, Error = ConnectError> + 'static,
    IoBoxed: From<Io>, 

Use custom connector to open secure connections.

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

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

Trait Implementations

impl Default for Connector

fn default() -> Self

Returns the “default value” for a type.