org.apache.pekko.http.scaladsl

Class ClientTransport$

java.lang.Object

org.apache.pekko.http.scaladsl.ClientTransport$

public class ClientTransport$
extends java.lang.Object

(Still unstable) entry point to create or access predefined client transports.

Field Summary

Fields

Modifier and Type	Field and Description
static ClientTransport$	MODULE$ Static reference to the singleton instance of this Scala object.

Constructor Summary

Constructors

Constructor and Description
ClientTransport$()

Method Summary

Modifier and Type	Method and Description
ClientTransport	httpsProxy(org.apache.pekko.actor.ActorSystem system) Returns a ClientTransport that runs all connection through the given HTTP(S) proxy using the HTTP CONNECT method.
ClientTransport	httpsProxy(HttpCredentials proxyCredentials, org.apache.pekko.actor.ActorSystem system) Returns a ClientTransport that runs all connection through the given HTTP(S) proxy using the HTTP CONNECT method.
ClientTransport	httpsProxy(java.net.InetSocketAddress proxyAddress) Returns a ClientTransport that runs all connection through the given HTTP(S) proxy using the HTTP CONNECT method.
ClientTransport	httpsProxy(java.net.InetSocketAddress proxyAddress, HttpCredentials proxyCredentials) Returns a ClientTransport that runs all connection through the given HTTP(S) proxy using the HTTP CONNECT method.
ClientTransport	TCP()
ClientTransport	withCustomResolver(scala.Function2<java.lang.String,java.lang.Object,scala.concurrent.Future<java.net.InetSocketAddress>> lookup) Returns a ClientTransport that allows to customize host name resolution.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MODULE$

public static final ClientTransport$ MODULE$

Static reference to the singleton instance of this Scala object.

Constructor Detail

ClientTransport$

public ClientTransport$()

Method Detail

TCP

public ClientTransport TCP()

httpsProxy

public ClientTransport httpsProxy(java.net.InetSocketAddress proxyAddress)

Returns a ClientTransport that runs all connection through the given HTTP(S) proxy using the HTTP CONNECT method.

An HTTP(S) proxy is a proxy that will create one TCP connection to the HTTP(S) proxy for each target connection. The proxy transparently forwards the TCP connection to the target host.

For more information about HTTP CONNECT tunnelling see https://tools.ietf.org/html/rfc7231#section-4.3.6.

Parameters:

proxyAddress - (undocumented)

Returns:

(undocumented)

httpsProxy

public ClientTransport httpsProxy(org.apache.pekko.actor.ActorSystem system)

Returns a ClientTransport that runs all connection through the given HTTP(S) proxy using the HTTP CONNECT method.

Pulls the host/port pair from the application.conf: pekko.client.proxy.https.{host, port}

Parameters:

system - (undocumented)

Returns:

(undocumented)

httpsProxy

public ClientTransport httpsProxy(java.net.InetSocketAddress proxyAddress,
                                  HttpCredentials proxyCredentials)

Returns a ClientTransport that runs all connection through the given HTTP(S) proxy using the HTTP CONNECT method. This method also takes HttpCredentials in order to pass along to the proxy.

An HTTP(S) proxy is a proxy that will create one TCP connection to the HTTP(S) proxy for each target connection. The proxy transparently forwards the TCP connection to the target host.

For more information about HTTP CONNECT tunnelling see https://tools.ietf.org/html/rfc7231#section-4.3.6.

Parameters:

proxyAddress - (undocumented)

proxyCredentials - (undocumented)

Returns:

(undocumented)

httpsProxy

public ClientTransport httpsProxy(HttpCredentials proxyCredentials,
                                  org.apache.pekko.actor.ActorSystem system)

Returns a ClientTransport that runs all connection through the given HTTP(S) proxy using the HTTP CONNECT method. This method also takes HttpCredentials in order to pass along to the proxy.

Pulls the host/port pair from the application.conf: pekko.client.proxy.https.{host, port}

Parameters:

proxyCredentials - (undocumented)

system - (undocumented)

Returns:

(undocumented)

withCustomResolver

public ClientTransport withCustomResolver(scala.Function2<java.lang.String,java.lang.Object,scala.concurrent.Future<java.net.InetSocketAddress>> lookup)

Returns a ClientTransport that allows to customize host name resolution.

Parameters:

lookup - A function that will be called with hostname and port and that should (potentially asynchronously resolve the given host/port to an InetSocketAddress

Returns:

(undocumented)