io.grpc.transport.okhttp

Class OkHttpChannelBuilder

java.lang.Object

io.grpc.AbstractChannelBuilder<OkHttpChannelBuilder>

io.grpc.transport.okhttp.OkHttpChannelBuilder

public final class OkHttpChannelBuilder
extends io.grpc.AbstractChannelBuilder<OkHttpChannelBuilder>

Convenience class for building channels with the OkHttp transport.

Nested Class Summary

Nested classes/interfaces inherited from class io.grpc.AbstractChannelBuilder

io.grpc.AbstractChannelBuilder.ChannelEssentials

Method Summary

Modifier and Type	Method and Description
protected io.grpc.AbstractChannelBuilder.ChannelEssentials	buildEssentials()
static OkHttpChannelBuilder	forAddress(String host, int port) Creates a new builder for the given server host and port.
OkHttpChannelBuilder	overrideHostForAuthority(String host) Overrides the host used with TLS and HTTP virtual hosting.
OkHttpChannelBuilder	setConnectionSpec(ConnectionSpec connectionSpec) For secure connection, provides a ConnectionSpec to specify Cipher suite and TLS versions.
OkHttpChannelBuilder	sslSocketFactory(SSLSocketFactory factory) Provides a SSLSocketFactory to establish a secure connection.
OkHttpChannelBuilder	transportExecutor(ExecutorService executor) Override the default executor necessary for internal transport use.

Methods inherited from class io.grpc.AbstractChannelBuilder

build, executor

Methods inherited from class java.lang.Object

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

Method Detail

forAddress

public static OkHttpChannelBuilder forAddress(String host,
                                              int port)

Creates a new builder for the given server host and port.

transportExecutor

public OkHttpChannelBuilder transportExecutor(ExecutorService executor)

Override the default executor necessary for internal transport use.

The channel does not take ownership of the given executor. It is the caller' responsibility to shutdown the executor when appropriate.

overrideHostForAuthority

public OkHttpChannelBuilder overrideHostForAuthority(String host)

Overrides the host used with TLS and HTTP virtual hosting. It does not change what host is actually connected to.

Should only used by tests.

sslSocketFactory

public OkHttpChannelBuilder sslSocketFactory(SSLSocketFactory factory)

Provides a SSLSocketFactory to establish a secure connection.

setConnectionSpec

public OkHttpChannelBuilder setConnectionSpec(ConnectionSpec connectionSpec)

For secure connection, provides a ConnectionSpec to specify Cipher suite and TLS versions.

By default OkHttpClientTransport.DEFAULT_CONNECTION_SPEC will be used.

buildEssentials

protected io.grpc.AbstractChannelBuilder.ChannelEssentials buildEssentials()

Specified by:

buildEssentials in class io.grpc.AbstractChannelBuilder<OkHttpChannelBuilder>