io.grpc.cronet

Class CronetChannelBuilder

java.lang.Object

io.grpc.ManagedChannelBuilder<T>

io.grpc.internal.AbstractManagedChannelImplBuilder<CronetChannelBuilder>

io.grpc.cronet.CronetChannelBuilder

@ExperimentalApi(value="There is no plan to make this API stable, given transport API instability")
public final class CronetChannelBuilder
extends io.grpc.internal.AbstractManagedChannelImplBuilder<CronetChannelBuilder>

Convenience class for building channels with the cronet transport.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CronetChannelBuilder.StreamBuilderFactory BidirectionalStream.Builder factory used for getting the gRPC BidirectionalStream.

Field Summary

Fields inherited from class io.grpc.internal.AbstractManagedChannelImplBuilder

transportTracerFactory

Method Summary

Modifier and Type	Method and Description
CronetChannelBuilder	alwaysUsePut(boolean enable) Sets the Cronet channel to always use PUT instead of POST.
protected io.grpc.internal.ClientTransportFactory	buildTransportFactory()
static CronetChannelBuilder	forAddress(java.lang.String name, int port) Always fails.
static CronetChannelBuilder	forAddress(java.lang.String host, int port, org.chromium.net.CronetEngine cronetEngine) Creates a new builder for the given server host, port and CronetEngine.
static CronetChannelBuilder	forTarget(java.lang.String target) Always fails.
CronetChannelBuilder	maxMessageSize(int maxMessageSize) Sets the maximum message size allowed to be received on the channel.
CronetChannelBuilder	scheduledExecutorService(java.util.concurrent.ScheduledExecutorService scheduledExecutorService) Provides a custom scheduled executor service.
CronetChannelBuilder	usePlaintext(boolean skipNegotiation) Not supported for building cronet channel.

Methods inherited from class io.grpc.internal.AbstractManagedChannelImplBuilder

build, checkAuthority, compressorRegistry, decompressorRegistry, defaultLoadBalancingPolicy, defaultServiceConfig, directExecutor, disableRetry, disableServiceConfigLookUp, enableFullStreamDecompression, enableRetry, executor, getDefaultPort, idleTimeout, intercept, intercept, maxHedgedAttempts, maxInboundMessageSize, maxInboundMessageSize, maxRetryAttempts, maxTraceEvents, nameResolverFactory, offloadExecutor, overrideAuthority, overrideCensusStatsModule, perRpcBufferLimit, proxyDetector, retryBufferSize, setBinaryLog, setStatsEnabled, setStatsRecordFinishedRpcs, setStatsRecordRealTimeMetrics, setStatsRecordStartedRpcs, setTracingEnabled, userAgent

Methods inherited from class io.grpc.ManagedChannelBuilder

blockingExecutor, keepAliveTime, keepAliveTimeout, keepAliveWithoutCalls, maxInboundMetadataSize, usePlaintext, useTransportSecurity

Methods inherited from class java.lang.Object

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

Method Detail

forAddress

public static CronetChannelBuilder forAddress(java.lang.String host,
                                              int port,
                                              org.chromium.net.CronetEngine cronetEngine)

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

forTarget

public static CronetChannelBuilder forTarget(java.lang.String target)

Always fails. Call forAddress(String, int, CronetEngine) instead.

forAddress

public static CronetChannelBuilder forAddress(java.lang.String name,
                                              int port)

Always fails. Call forAddress(String, int, CronetEngine) instead.

maxMessageSize

public final CronetChannelBuilder maxMessageSize(int maxMessageSize)

Sets the maximum message size allowed to be received on the channel. If not called, defaults to GrpcUtil.DEFAULT_MAX_MESSAGE_SIZE.

alwaysUsePut

public final CronetChannelBuilder alwaysUsePut(boolean enable)

Sets the Cronet channel to always use PUT instead of POST. Defaults to false.

usePlaintext

public final CronetChannelBuilder usePlaintext(boolean skipNegotiation)

Not supported for building cronet channel.

Overrides:

usePlaintext in class io.grpc.ManagedChannelBuilder<CronetChannelBuilder>

scheduledExecutorService

public final CronetChannelBuilder scheduledExecutorService(java.util.concurrent.ScheduledExecutorService scheduledExecutorService)

Provides a custom scheduled executor service.

It's an optional parameter. If the user has not provided a scheduled executor service when the channel is built, the builder will use a static cached thread pool.

Returns:

this

Since:

1.12.0

buildTransportFactory

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

Specified by:

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