io.grpc.okhttp

Class OkHttpChannelBuilder

java.lang.Object

io.grpc.ManagedChannelBuilder<T>

io.grpc.internal.AbstractManagedChannelImplBuilder<OkHttpChannelBuilder>

io.grpc.okhttp.OkHttpChannelBuilder

@ExperimentalApi(value="https://github.com/grpc/grpc-java/issues/1785")
public class OkHttpChannelBuilder
extends io.grpc.internal.AbstractManagedChannelImplBuilder<OkHttpChannelBuilder>

Convenience class for building channels with the OkHttp transport.

Field Summary

Fields

Modifier and Type	Field and Description
static ConnectionSpec	DEFAULT_CONNECTION_SPEC

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OkHttpChannelBuilder(String host, int port)

Method Summary

Modifier and Type	Method and Description
protected io.grpc.internal.ClientTransportFactory	buildTransportFactory()
OkHttpChannelBuilder	connectionSpec(ConnectionSpec connectionSpec) For secure connection, provides a ConnectionSpec to specify Cipher suite and TLS versions.
OkHttpChannelBuilder	enableKeepAlive(boolean enable) Enable keepalive with default delay and timeout.
OkHttpChannelBuilder	enableKeepAlive(boolean enable, long keepAliveDelay, TimeUnit delayUnit, long keepAliveTimeout, TimeUnit timeoutUnit) Enable keepalive with custom delay and timeout.
static OkHttpChannelBuilder	forAddress(String host, int port) Creates a new builder for the given server host and port.
static OkHttpChannelBuilder	forTarget(String target) Creates a new builder for the given target that will be resolved by NameResolver.
protected Attributes	getNameResolverParams()
OkHttpChannelBuilder	maxMessageSize(int maxMessageSize) Sets the maximum message size allowed to be received on the channel.
OkHttpChannelBuilder	negotiationType(NegotiationType type) Sets the negotiation type for the HTTP/2 connection.
OkHttpChannelBuilder	sslSocketFactory(SSLSocketFactory factory) Provides a SSLSocketFactory to replace the default SSLSocketFactory used for TLS.
OkHttpChannelBuilder	transportExecutor(Executor transportExecutor) Override the default executor necessary for internal transport use.
OkHttpChannelBuilder	usePlaintext(boolean skipNegotiation) Equivalent to using negotiationType(NegotiationType) with PLAINTEXT.

Methods inherited from class io.grpc.internal.AbstractManagedChannelImplBuilder

build, checkAuthority, compressorRegistry, decompressorRegistry, directExecutor, executor, idleTimeout, intercept, intercept, loadBalancerFactory, nameResolverFactory, overrideAuthority, userAgent

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CONNECTION_SPEC

public static final ConnectionSpec DEFAULT_CONNECTION_SPEC

Constructor Detail

OkHttpChannelBuilder

protected OkHttpChannelBuilder(String host,
                               int port)

Method Detail

forAddress

public static OkHttpChannelBuilder forAddress(String host,
                                              int port)

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

forTarget

public static OkHttpChannelBuilder forTarget(String target)

Creates a new builder for the given target that will be resolved by NameResolver.

transportExecutor

public final OkHttpChannelBuilder transportExecutor(@Nullable
                                                    Executor transportExecutor)

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.

negotiationType

public final OkHttpChannelBuilder negotiationType(NegotiationType type)

Sets the negotiation type for the HTTP/2 connection.

Default: TLS

enableKeepAlive

public final OkHttpChannelBuilder enableKeepAlive(boolean enable)

Enable keepalive with default delay and timeout.

enableKeepAlive

public final OkHttpChannelBuilder enableKeepAlive(boolean enable,
                                                  long keepAliveDelay,
                                                  TimeUnit delayUnit,
                                                  long keepAliveTimeout,
                                                  TimeUnit timeoutUnit)

Enable keepalive with custom delay and timeout.

sslSocketFactory

public final OkHttpChannelBuilder sslSocketFactory(SSLSocketFactory factory)

Provides a SSLSocketFactory to replace the default SSLSocketFactory used for TLS.

By default, when TLS is enabled, SSLSocketFactory.getDefault() will be used.

NegotiationType.TLS will be applied by calling this method.

connectionSpec

public final OkHttpChannelBuilder connectionSpec(ConnectionSpec connectionSpec)

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

By default DEFAULT_CONNECTION_SPEC will be used.

This method is only used when building a secure connection. For plaintext connection, use usePlaintext(boolean) instead.

Throws:

IllegalArgumentException - If connectionSpec is not with TLS

maxMessageSize

public final OkHttpChannelBuilder maxMessageSize(int maxMessageSize)

Sets the maximum message size allowed to be received on the channel. If not called, defaults to 4 MiB. The default provides protection to clients who haven't considered the possibility of receiving large messages while trying to be large enough to not be hit in normal usage.

usePlaintext

public final OkHttpChannelBuilder usePlaintext(boolean skipNegotiation)

Equivalent to using negotiationType(NegotiationType) with PLAINTEXT.

Specified by:

usePlaintext in class ManagedChannelBuilder<OkHttpChannelBuilder>

buildTransportFactory

protected final io.grpc.internal.ClientTransportFactory buildTransportFactory()

Specified by:

buildTransportFactory in class io.grpc.internal.AbstractManagedChannelImplBuilder<OkHttpChannelBuilder>

getNameResolverParams

protected Attributes getNameResolverParams()

Overrides:

getNameResolverParams in class io.grpc.internal.AbstractManagedChannelImplBuilder<OkHttpChannelBuilder>