Struct actix_web::client::ClientConnector

pub struct ClientConnector { /* fields omitted */ }

ClientConnector type is responsible for transport layer of a client connection.

Methods

impl ClientConnector

pub fn with_connector(connector: SslConnector) -> ClientConnector

Create ClientConnector actor with custom SslConnector instance.

By default ClientConnector uses very a simple SSL configuration. With with_connector method it is possible to use a custom SslConnector object.

extern crate openssl;
use actix_web::{actix, client::ClientConnector, client::Connect};

use openssl::ssl::{SslConnector, SslMethod};

fn main() {
    actix::run(|| {
        // Start `ClientConnector` with custom `SslConnector`
        let ssl_conn = SslConnector::builder(SslMethod::tls()).unwrap().build();
        let conn = ClientConnector::with_connector(ssl_conn).start();

        conn.send(
            Connect::new("https://www.rust-lang.org").unwrap()) // <- connect to host
                .map_err(|_| ())
                .and_then(|res| {
                    if let Ok(mut stream) = res {
                        stream.write_all(b"GET / HTTP/1.0\r\n\r\n").unwrap();
                    }
                    Ok(())
                })
    });
}

pub fn limit(self, limit: usize) -> Self

Set total number of simultaneous connections.

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

pub fn limit_per_host(self, limit: usize) -> Self

Set total number of simultaneous connections to the same endpoint.

Endpoints are the same if they have equal (host, port, ssl) triplets. If limit is 0, the connector has no limit. The default limit size is 0.

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 stats(self, subs: Recipient<ClientConnectorStats>) -> Self

Subscribe for connector stats. Only one subscriber is supported.

pub fn resolver<A: Into<Recipient<ResolveConnect>>>(self, addr: A) -> Self

Use custom resolver actor

By default actix's Resolver is used.

Trait Implementations

impl Default for ClientConnector

fn default() -> ClientConnector

Returns the "default value" for a type.

impl Actor for ClientConnector

type Context = Context<ClientConnector>

Actor execution context type

fn started(&mut self, ctx: &mut Self::Context)

Method is called when actor get polled first time.

fn stopping(&mut self, ctx: &mut Self::Context) -> Running

Method is called after an actor is in Actor::Stopping state. There could be several reasons for stopping. Context::stop get called by the actor itself. All addresses to current actor get dropped and no more evented objects left in the context.

fn stopped(&mut self, ctx: &mut Self::Context)

Method is called after an actor is stopped, it can be used to perform any needed cleanup work or spawning more actors. This is final state, after this call actor get dropped.

fn start(self) -> Addr<Self> where
    Self: Actor<Context = Context<Self>>, 

Start new asynchronous actor, returns address of newly created actor.

fn start_default() -> Addr<Self> where
    Self: Actor<Context = Context<Self>> + Default, 

Start new asynchronous actor, returns address of newly created actor.

fn create<F>(f: F) -> Addr<Self> where
    F: FnOnce(&mut Context<Self>) -> Self + 'static,
    Self: Actor<Context = Context<Self>>, 

Use create method, if you need Context object during actor initialization.

impl Supervised for ClientConnector

fn restarting(&mut self, ctx: &mut Self::Context)

Method called when supervisor restarting failed actor

impl Handler<Pause> for ClientConnector

type Result = ()

The type of value that this handle will return

fn handle(&mut self, msg: Pause, _: &mut Self::Context)

Method is called for every message received by this Actor

impl Handler<Resume> for ClientConnector

type Result = ()

The type of value that this handle will return

fn handle(&mut self, _: Resume, _: &mut Self::Context)

Method is called for every message received by this Actor

impl Handler<Connect> for ClientConnector

type Result = ActorResponse<ClientConnector, Connection, ClientConnectorError>

The type of value that this handle will return

fn handle(&mut self, msg: Connect, ctx: &mut Self::Context) -> Self::Result

Method is called for every message received by this Actor

impl SystemService for ClientConnector

fn start_service(sys: &Addr<Arbiter>) -> Addr<Self>

Construct and start system service

fn service_started(&mut self, ctx: &mut Context<Self>)

Method is called during service initialization.

fn from_registry() -> Addr<Self>

Get actor's address from system registry