io.grpc.inprocess

Class InProcessChannelBuilder

java.lang.Object

io.grpc.ManagedChannelBuilder<T>

io.grpc.internal.AbstractManagedChannelImplBuilder<InProcessChannelBuilder>

io.grpc.inprocess.InProcessChannelBuilder

@ExperimentalApi(value="https://github.com/grpc/grpc-java/issues/1783")
public final class InProcessChannelBuilder
extends AbstractManagedChannelImplBuilder<InProcessChannelBuilder>

Builder for a channel that issues in-process requests. Clients identify the in-process server by its name.

The channel is intended to be fully-featured, high performance, and useful in testing.

For usage examples, see InProcessServerBuilder.

Field Summary

Fields inherited from class io.grpc.internal.AbstractManagedChannelImplBuilder

transportTracerFactory

Method Summary

Modifier and Type	Method and Description
protected ClientTransportFactory	buildTransportFactory() Subclasses should override this method to provide the ClientTransportFactory appropriate for this channel.
static InProcessChannelBuilder	forAddress(String name, int port) Always fails.
static InProcessChannelBuilder	forName(String name) Create a channel builder that will connect to the server with the given name.
static InProcessChannelBuilder	forTarget(String target) Always fails.
InProcessChannelBuilder	keepAliveTime(long keepAliveTime, TimeUnit timeUnit) Does nothing.
InProcessChannelBuilder	keepAliveTimeout(long keepAliveTimeout, TimeUnit timeUnit) Does nothing.
InProcessChannelBuilder	keepAliveWithoutCalls(boolean enable) Does nothing.
InProcessChannelBuilder	maxInboundMessageSize(int max) Sets the maximum message size allowed for a single gRPC frame.
InProcessChannelBuilder	maxInboundMetadataSize(int bytes) Sets the maximum size of metadata allowed to be received.
InProcessChannelBuilder	scheduledExecutorService(ScheduledExecutorService scheduledExecutorService) Provides a custom scheduled executor service.
InProcessChannelBuilder	usePlaintext() Does nothing.
InProcessChannelBuilder	usePlaintext(boolean skipNegotiation) Deprecated. use usePlaintext() instead.
InProcessChannelBuilder	useTransportSecurity() Does nothing.

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, maxRetryAttempts, maxTraceEvents, nameResolverFactory, overrideAuthority, overrideCensusStatsModule, perRpcBufferLimit, proxyDetector, retryBufferSize, setBinaryLog, setStatsEnabled, setStatsRecordFinishedRpcs, setStatsRecordRealTimeMetrics, setStatsRecordStartedRpcs, setTracingEnabled, userAgent

Methods inherited from class java.lang.Object

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

Method Detail

forName

public static InProcessChannelBuilder forName(String name)

Create a channel builder that will connect to the server with the given name.

Parameters:

name - the identity of the server to connect to

Returns:

a new builder

forTarget

public static InProcessChannelBuilder forTarget(String target)

Always fails. Call forName(java.lang.String) instead.

forAddress

public static InProcessChannelBuilder forAddress(String name,
                                                 int port)

Always fails. Call forName(java.lang.String) instead.

maxInboundMessageSize

public final InProcessChannelBuilder maxInboundMessageSize(int max)

Description copied from class: AbstractManagedChannelImplBuilder

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 AbstractManagedChannelImplBuilder<InProcessChannelBuilder>

useTransportSecurity

public InProcessChannelBuilder useTransportSecurity()

Does nothing.

Overrides:

useTransportSecurity in class io.grpc.ManagedChannelBuilder<InProcessChannelBuilder>

usePlaintext

@Deprecated
public InProcessChannelBuilder usePlaintext(boolean skipNegotiation)

Deprecated. use usePlaintext() instead.

Does nothing.

Overrides:

usePlaintext in class io.grpc.ManagedChannelBuilder<InProcessChannelBuilder>

usePlaintext

public InProcessChannelBuilder usePlaintext()

Does nothing.

Overrides:

usePlaintext in class io.grpc.ManagedChannelBuilder<InProcessChannelBuilder>

keepAliveTime

public InProcessChannelBuilder keepAliveTime(long keepAliveTime,
                                             TimeUnit timeUnit)

Does nothing.

Overrides:

keepAliveTime in class io.grpc.ManagedChannelBuilder<InProcessChannelBuilder>

keepAliveTimeout

public InProcessChannelBuilder keepAliveTimeout(long keepAliveTimeout,
                                                TimeUnit timeUnit)

Does nothing.

Overrides:

keepAliveTimeout in class io.grpc.ManagedChannelBuilder<InProcessChannelBuilder>

keepAliveWithoutCalls

public InProcessChannelBuilder keepAliveWithoutCalls(boolean enable)

Does nothing.

Overrides:

keepAliveWithoutCalls in class io.grpc.ManagedChannelBuilder<InProcessChannelBuilder>

scheduledExecutorService

public InProcessChannelBuilder scheduledExecutorService(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.11.0

maxInboundMetadataSize

public InProcessChannelBuilder maxInboundMetadataSize(int bytes)

Sets the maximum size of metadata allowed to be received. Integer.MAX_VALUE disables the enforcement. Defaults to no limit (Integer.MAX_VALUE).

There is potential for performance penalty when this setting is enabled, as the Metadata must actually be serialized. Since the current implementation of Metadata pre-serializes, it's currently negligible. But Metadata is free to change its implementation.

Overrides:

maxInboundMetadataSize in class io.grpc.ManagedChannelBuilder<InProcessChannelBuilder>

Parameters:

bytes - the maximum size of received metadata

Returns:

this

Throws:

IllegalArgumentException - if bytes is non-positive

Since:

1.17.0

buildTransportFactory

@Internal
protected ClientTransportFactory buildTransportFactory()

Description copied from class: AbstractManagedChannelImplBuilder

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.

Specified by:

buildTransportFactory in class AbstractManagedChannelImplBuilder<InProcessChannelBuilder>