io.grpc

Class AbstractChannelBuilder<BuilderT extends AbstractChannelBuilder<BuilderT>>

java.lang.Object

io.grpc.AbstractChannelBuilder<BuilderT>

Type Parameters:

BuilderT - The concrete type of this builder.

Direct Known Subclasses:

InProcessChannelBuilder, NettyChannelBuilder, OkHttpChannelBuilder

public abstract class AbstractChannelBuilder<BuilderT extends AbstractChannelBuilder<BuilderT>>
extends Object

The base class for channel builders.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractChannelBuilder.ChannelEssentials The essentials required for creating a channel.

Constructor Summary

Constructors

Constructor and Description
AbstractChannelBuilder()

Method Summary

Modifier and Type	Method and Description
ChannelImpl	build() Builds a channel using the given parameters.
protected abstract AbstractChannelBuilder.ChannelEssentials	buildEssentials() Children of AbstractChannelBuilder should override this method to provide transport specific information for the channel.
BuilderT	executor(ExecutorService executor) Provides a custom executor.
BuilderT	intercept(ClientInterceptor... interceptors) Adds interceptors that will be called before the channel performs its real work.
BuilderT	intercept(List<ClientInterceptor> interceptors) Adds interceptors that will be called before the channel performs its real work.
BuilderT	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

AbstractChannelBuilder

public AbstractChannelBuilder()

Method Detail

executor

public final BuilderT executor(ExecutorService 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 final BuilderT 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 ChannelImpl.

intercept

public final BuilderT 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 ChannelImpl.

userAgent

public final BuilderT 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.

build

public ChannelImpl build()

Builds a channel using the given parameters.

buildEssentials

@Internal
protected abstract AbstractChannelBuilder.ChannelEssentials buildEssentials()

Children of AbstractChannelBuilder should override this method to provide transport specific information for the channel. This method is mean for Transport implementors and should not be used by normal users.