io.grpc

Class ManagedChannelBuilder<T extends ManagedChannelBuilder<T>>

java.lang.Object

io.grpc.ManagedChannelBuilder<T>

Type Parameters:

T - The concrete type of this builder.

Direct Known Subclasses:

io.grpc.internal.AbstractManagedChannelImplBuilder

public abstract class ManagedChannelBuilder<T extends ManagedChannelBuilder<T>>
extends Object

A builder for ManagedChannel instances.

Constructor Summary

Constructors

Constructor and Description
ManagedChannelBuilder()

Method Summary

Modifier and Type	Method and Description
abstract ManagedChannel	build() Builds a channel using the given parameters.
abstract T	executor(Executor executor) Provides a custom executor.
static ManagedChannelBuilder<?>	forAddress(String name, int port)
abstract T	intercept(ClientInterceptor... interceptors) Adds interceptors that will be called before the channel performs its real work.
abstract T	intercept(List<ClientInterceptor> interceptors) Adds interceptors that will be called before the channel performs its real work.
abstract T	overrideAuthority(String authority) Overrides the authority used with TLS and HTTP virtual hosting.
abstract T	usePlaintext(boolean skipNegotiation)
abstract T	userAgent(String userAgent) Provides a custom User-Agent for the application.

Methods inherited from class java.lang.Object

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

Constructor Detail

ManagedChannelBuilder

public ManagedChannelBuilder()

Method Detail

forAddress

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

executor

public abstract T executor(Executor executor)

Provides a custom executor.

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

The channel won't take ownership of the given executor. It's caller's responsibility to shut down the executor when it's desired.

intercept

public abstract T intercept(List<ClientInterceptor> interceptors)

Adds interceptors that will be called before the channel performs its real work. This is functionally equivalent to using ClientInterceptors.intercept(Channel, List), but while still having access to the original ManagedChannel.

intercept

public abstract T intercept(ClientInterceptor... interceptors)

Adds interceptors that will be called before the channel performs its real work. This is functionally equivalent to using ClientInterceptors.intercept(Channel, ClientInterceptor...), but while still having access to the original ManagedChannel.

userAgent

public abstract T userAgent(String userAgent)

Provides a custom User-Agent for the application.

It's an optional parameter. If provided, the given agent will be prepended by the grpc User-Agent.

overrideAuthority

@ExperimentalApi(value="primarily for testing")
public abstract T overrideAuthority(String authority)

Overrides the authority used with TLS and HTTP virtual hosting. It does not change what host is actually connected to. Is commonly in the form host:port.

Should only used by tests.

usePlaintext

@ExperimentalApi(value="primarily for testing")
public abstract T usePlaintext(boolean skipNegotiation)

build

public abstract ManagedChannel build()

Builds a channel using the given parameters.