Struct ntex_h2::client::ClientBuilder

pub struct ClientBuilder(/* private fields */);

Manages http client network connectivity.

The ClientBuilder type uses a builder-like combinator pattern for service construction that finishes by calling the .finish() method.

Implementations

impl ClientBuilder

pub fn with_default<A, U>(addr: U) -> Self

where A: Address + Clone, Connect<A>: From<U>,

impl ClientBuilder

pub fn scheme(self, scheme: Scheme) -> Self

Set client’s connection scheme

pub fn memory_pool(self, id: PoolId) -> Self

Set memory pool.

Use specified memory pool for memory allocations. By default P5 memory pool is used.

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 max_streams(self, limit: u32) -> Self

Set total number of simultaneous streams per connection.

If limit is 0, the connector uses “MAX_CONCURRENT_STREAMS” config from connection settings. The default limit size is 100.

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 not set.

pub fn minconn(self, num: usize) -> Self

Sets the minimum concurrent connections.

By default min connections is set to a 1.

pub fn maxconn(self, num: usize) -> Self

Sets the maximum concurrent connections.

By default max connections is set to a 16.

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.

To disable timeout set value to 0.

By default disconnect timeout is set to 3 seconds.

pub fn configure<O, R>(self, f: O) -> Self

where O: FnOnce(&Config) -> R,

Configure http2 connection settings

pub fn config(&self) -> &Config

Http/2 connection settings

pub fn connector<A, U, T, F>(self, addr: U, connector: F) -> Self

where A: Address + Clone, F: IntoService<T, Connect<A>>, T: Service<Connect<A>, Error = ConnectError> + 'static, IoBoxed: From<T::Response>, Connect<A>: From<U>,

Use custom connector

pub fn finish(self) -> Client

Finish configuration process and create connections pool.

Trait Implementations

impl Debug for ClientBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.