io.grpc.internal

Class AbstractManagedChannelImplBuilder<T extends AbstractManagedChannelImplBuilder<T>>

java.lang.Object

io.grpc.ManagedChannelBuilder<T>

io.grpc.internal.AbstractManagedChannelImplBuilder<T>

Type Parameters:

T - The concrete type of this builder.

Direct Known Subclasses:

InProcessChannelBuilder

public abstract class AbstractManagedChannelImplBuilder<T extends AbstractManagedChannelImplBuilder<T>>
extends io.grpc.ManagedChannelBuilder<T>

The base class for channel builders.

Field Summary

Fields

Modifier and Type	Field and Description
protected TransportTracer.Factory	transportTracerFactory

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractManagedChannelImplBuilder(SocketAddress directServerAddress, String authority)
protected	AbstractManagedChannelImplBuilder(String target)

Method Summary

Modifier and Type	Method and Description
io.grpc.ManagedChannel	build()
protected abstract ClientTransportFactory	buildTransportFactory() Subclasses should override this method to provide the ClientTransportFactory appropriate for this channel.
protected String	checkAuthority(String authority) Verifies the authority is valid.
T	compressorRegistry(io.grpc.CompressorRegistry registry)
T	decompressorRegistry(io.grpc.DecompressorRegistry registry)
T	defaultLoadBalancingPolicy(String policy)
T	defaultServiceConfig(Map<String,?> serviceConfig)
T	directExecutor()
T	disableRetry()
T	disableServiceConfigLookUp()
T	enableFullStreamDecompression()
T	enableRetry()
T	executor(Executor executor)
static io.grpc.ManagedChannelBuilder<?>	forAddress(String name, int port)
static io.grpc.ManagedChannelBuilder<?>	forTarget(String target)
protected int	getDefaultPort() Subclasses can override this method to provide a default port to NameResolver for use in cases where the target string doesn't include a port.
T	idleTimeout(long value, TimeUnit unit)
T	intercept(io.grpc.ClientInterceptor... interceptors)
T	intercept(List<io.grpc.ClientInterceptor> interceptors)
T	maxHedgedAttempts(int maxHedgedAttempts)
protected int	maxInboundMessageSize()
T	maxInboundMessageSize(int max) Sets the maximum message size allowed for a single gRPC frame.
T	maxRetryAttempts(int maxRetryAttempts)
T	maxTraceEvents(int maxTraceEvents)
T	nameResolverFactory(io.grpc.NameResolver.Factory resolverFactory)
T	overrideAuthority(String authority)
protected T	overrideCensusStatsModule(CensusStatsModule censusStats) Override the default stats implementation.
T	perRpcBufferLimit(long bytes)
T	proxyDetector(io.grpc.ProxyDetector proxyDetector)
T	retryBufferSize(long bytes)
T	setBinaryLog(io.grpc.BinaryLog binlog)
protected void	setStatsEnabled(boolean value) Disable or enable stats features.
protected void	setStatsRecordFinishedRpcs(boolean value) Disable or enable stats recording for RPC completions.
protected void	setStatsRecordRealTimeMetrics(boolean value) Disable or enable real-time metrics recording.
protected void	setStatsRecordStartedRpcs(boolean value) Disable or enable stats recording for RPC upstarts.
protected void	setTracingEnabled(boolean value) Disable or enable tracing features.
T	userAgent(String userAgent)

Methods inherited from class io.grpc.ManagedChannelBuilder

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

Methods inherited from class java.lang.Object

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

Field Detail

transportTracerFactory

protected TransportTracer.Factory transportTracerFactory

Constructor Detail

AbstractManagedChannelImplBuilder

protected AbstractManagedChannelImplBuilder(String target)

AbstractManagedChannelImplBuilder

protected AbstractManagedChannelImplBuilder(SocketAddress directServerAddress,
                                            String authority)

Method Detail

forAddress

public static io.grpc.ManagedChannelBuilder<?> forAddress(String name,
                                                          int port)

forTarget

public static io.grpc.ManagedChannelBuilder<?> forTarget(String target)

maxInboundMessageSize

public T maxInboundMessageSize(int max)

Sets the maximum message size allowed for a single gRPC frame. If an inbound messages larger than this limit is received it will not be processed and the RPC will fail with RESOURCE_EXHAUSTED.

Overrides:

maxInboundMessageSize in class io.grpc.ManagedChannelBuilder<T extends AbstractManagedChannelImplBuilder<T>>

maxInboundMessageSize

protected final int maxInboundMessageSize()

directExecutor

public final T directExecutor()

Specified by:

directExecutor in class io.grpc.ManagedChannelBuilder<T extends AbstractManagedChannelImplBuilder<T>>

executor

public final T executor(Executor executor)

Specified by:

executor in class io.grpc.ManagedChannelBuilder<T extends AbstractManagedChannelImplBuilder<T>>

intercept

public final T intercept(List<io.grpc.ClientInterceptor> interceptors)

Specified by:

intercept in class io.grpc.ManagedChannelBuilder<T extends AbstractManagedChannelImplBuilder<T>>

intercept

public final T intercept(io.grpc.ClientInterceptor... interceptors)

Specified by:

intercept in class io.grpc.ManagedChannelBuilder<T extends AbstractManagedChannelImplBuilder<T>>

nameResolverFactory

public final T nameResolverFactory(io.grpc.NameResolver.Factory resolverFactory)

Specified by:

nameResolverFactory in class io.grpc.ManagedChannelBuilder<T extends AbstractManagedChannelImplBuilder<T>>

defaultLoadBalancingPolicy

public final T defaultLoadBalancingPolicy(String policy)

Overrides:

defaultLoadBalancingPolicy in class io.grpc.ManagedChannelBuilder<T extends AbstractManagedChannelImplBuilder<T>>

enableFullStreamDecompression

public final T enableFullStreamDecompression()

Overrides:

enableFullStreamDecompression in class io.grpc.ManagedChannelBuilder<T extends AbstractManagedChannelImplBuilder<T>>

decompressorRegistry

public final T decompressorRegistry(io.grpc.DecompressorRegistry registry)

Specified by:

decompressorRegistry in class io.grpc.ManagedChannelBuilder<T extends AbstractManagedChannelImplBuilder<T>>

compressorRegistry

public final T compressorRegistry(io.grpc.CompressorRegistry registry)

Specified by:

compressorRegistry in class io.grpc.ManagedChannelBuilder<T extends AbstractManagedChannelImplBuilder<T>>

userAgent

public final T userAgent(@Nullable
                         String userAgent)

Specified by:

userAgent in class io.grpc.ManagedChannelBuilder<T extends AbstractManagedChannelImplBuilder<T>>

overrideAuthority

public final T overrideAuthority(String authority)

Specified by:

overrideAuthority in class io.grpc.ManagedChannelBuilder<T extends AbstractManagedChannelImplBuilder<T>>

idleTimeout

public final T idleTimeout(long value,
                           TimeUnit unit)

Specified by:

idleTimeout in class io.grpc.ManagedChannelBuilder<T extends AbstractManagedChannelImplBuilder<T>>

maxRetryAttempts

public final T maxRetryAttempts(int maxRetryAttempts)

Overrides:

maxRetryAttempts in class io.grpc.ManagedChannelBuilder<T extends AbstractManagedChannelImplBuilder<T>>

maxHedgedAttempts

public final T maxHedgedAttempts(int maxHedgedAttempts)

Overrides:

maxHedgedAttempts in class io.grpc.ManagedChannelBuilder<T extends AbstractManagedChannelImplBuilder<T>>

retryBufferSize

public final T retryBufferSize(long bytes)

Overrides:

retryBufferSize in class io.grpc.ManagedChannelBuilder<T extends AbstractManagedChannelImplBuilder<T>>

perRpcBufferLimit

public final T perRpcBufferLimit(long bytes)

Overrides:

perRpcBufferLimit in class io.grpc.ManagedChannelBuilder<T extends AbstractManagedChannelImplBuilder<T>>

disableRetry

public final T disableRetry()

Overrides:

disableRetry in class io.grpc.ManagedChannelBuilder<T extends AbstractManagedChannelImplBuilder<T>>

enableRetry

public final T enableRetry()

Overrides:

enableRetry in class io.grpc.ManagedChannelBuilder<T extends AbstractManagedChannelImplBuilder<T>>

setBinaryLog

public final T setBinaryLog(io.grpc.BinaryLog binlog)

Overrides:

setBinaryLog in class io.grpc.ManagedChannelBuilder<T extends AbstractManagedChannelImplBuilder<T>>

maxTraceEvents

public T maxTraceEvents(int maxTraceEvents)

Overrides:

maxTraceEvents in class io.grpc.ManagedChannelBuilder<T extends AbstractManagedChannelImplBuilder<T>>

overrideCensusStatsModule

protected final T overrideCensusStatsModule(CensusStatsModule censusStats)

Override the default stats implementation.

proxyDetector

public T proxyDetector(@Nullable
                       io.grpc.ProxyDetector proxyDetector)

Overrides:

proxyDetector in class io.grpc.ManagedChannelBuilder<T extends AbstractManagedChannelImplBuilder<T>>

defaultServiceConfig

public T defaultServiceConfig(@Nullable
                              Map<String,?> serviceConfig)

Overrides:

defaultServiceConfig in class io.grpc.ManagedChannelBuilder<T extends AbstractManagedChannelImplBuilder<T>>

disableServiceConfigLookUp

public T disableServiceConfigLookUp()

Overrides:

disableServiceConfigLookUp in class io.grpc.ManagedChannelBuilder<T extends AbstractManagedChannelImplBuilder<T>>

setStatsEnabled

protected void setStatsEnabled(boolean value)

Disable or enable stats features. Enabled by default.

For the current release, calling setStatsEnabled(true) may have a side effect that disables retry.

setStatsRecordStartedRpcs

protected void setStatsRecordStartedRpcs(boolean value)

Disable or enable stats recording for RPC upstarts. Effective only if setStatsEnabled(boolean) is set to true. Enabled by default.

setStatsRecordFinishedRpcs

protected void setStatsRecordFinishedRpcs(boolean value)

Disable or enable stats recording for RPC completions. Effective only if setStatsEnabled(boolean) is set to true. Enabled by default.

setStatsRecordRealTimeMetrics

protected void setStatsRecordRealTimeMetrics(boolean value)

Disable or enable real-time metrics recording. Effective only if setStatsEnabled(boolean) is set to true. Disabled by default.

setTracingEnabled

protected void setTracingEnabled(boolean value)

Disable or enable tracing features. Enabled by default.

For the current release, calling setTracingEnabled(true) may have a side effect that disables retry.

checkAuthority

protected String checkAuthority(String authority)

Verifies the authority is valid. This method exists as an escape hatch for putting in an authority that is valid, but would fail the default validation provided by this implementation.

build

public io.grpc.ManagedChannel build()

Specified by:

build in class io.grpc.ManagedChannelBuilder<T extends AbstractManagedChannelImplBuilder<T>>

buildTransportFactory

protected abstract ClientTransportFactory buildTransportFactory()

Subclasses should override this method to provide the ClientTransportFactory appropriate for this channel. This method is meant for Transport implementors and should not be used by normal users.

getDefaultPort

protected int getDefaultPort()

Subclasses can override this method to provide a default port to NameResolver for use in cases where the target string doesn't include a port. The default implementation returns GrpcUtil.DEFAULT_PORT_SSL.