io.grpc.netty

Class NettyChannelBuilder

java.lang.Object

io.grpc.ManagedChannelBuilder<T>

io.grpc.internal.AbstractManagedChannelImplBuilder<NettyChannelBuilder>

io.grpc.netty.NettyChannelBuilder

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

A builder to help simplify construction of channels using the Netty transport.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_FLOW_CONTROL_WINDOW

Method Summary

Modifier and Type	Method and Description
protected io.grpc.internal.ClientTransportFactory	buildTransportFactory()
NettyChannelBuilder	channelType(Class<? extends Channel> channelType) Specifies the channel type to use, by default we use NioSocketChannel.
protected String	checkAuthority(String authority)
NettyChannelBuilder	enableKeepAlive(boolean enable) Enable keepalive with default delay and timeout.
NettyChannelBuilder	enableKeepAlive(boolean enable, long keepAliveDelay, TimeUnit delayUnit, long keepAliveTimeout, TimeUnit timeoutUnit) Enable keepalive with custom delay and timeout.
NettyChannelBuilder	eventLoopGroup(EventLoopGroup eventLoopGroup) Provides an EventGroupLoop to be used by the netty transport.
NettyChannelBuilder	flowControlWindow(int flowControlWindow) Sets the flow control window in bytes.
static NettyChannelBuilder	forAddress(SocketAddress serverAddress) Creates a new builder with the given server address.
static NettyChannelBuilder	forAddress(String host, int port) Creates a new builder with the given host and port.
static NettyChannelBuilder	forTarget(String target) Creates a new builder with the given target string that will be resolved by NameResolver.
protected io.grpc.Attributes	getNameResolverParams()
NettyChannelBuilder	maxHeaderListSize(int maxHeaderListSize) Sets the maximum size of header list allowed to be received on the channel.
NettyChannelBuilder	maxMessageSize(int maxMessageSize) Deprecated. Use AbstractManagedChannelImplBuilder.maxInboundMessageSize instead
NettyChannelBuilder	negotiationType(NegotiationType type) Sets the negotiation type for the HTTP/2 connection.
NettyChannelBuilder	sslContext(SslContext sslContext) SSL/TLS context to use instead of the system default.
NettyChannelBuilder	usePlaintext(boolean skipNegotiation) Equivalent to using negotiationType(NegotiationType) with PLAINTEXT or PLAINTEXT_UPGRADE.
<T> NettyChannelBuilder	withOption(ChannelOption<T> option, T value) Specifies a channel option.

Methods inherited from class io.grpc.internal.AbstractManagedChannelImplBuilder

build, compressorRegistry, decompressorRegistry, directExecutor, executor, idleTimeout, intercept, intercept, loadBalancerFactory, loadBalancerFactory, maxInboundMessageSize, maxInboundMessageSize, nameResolverFactory, overrideAuthority, statsContextFactory, userAgent

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_FLOW_CONTROL_WINDOW

public static final int DEFAULT_FLOW_CONTROL_WINDOW

See Also:

Constant Field Values

Method Detail

forAddress

public static NettyChannelBuilder forAddress(SocketAddress serverAddress)

Creates a new builder with the given server address. This factory method is primarily intended for using Netty Channel types other than SocketChannel. forAddress(String, int) should generally be preferred over this method, since that API permits delaying DNS lookups and noticing changes to DNS.

forAddress

public static NettyChannelBuilder forAddress(String host,
                                             int port)

Creates a new builder with the given host and port.

forTarget

public static NettyChannelBuilder forTarget(String target)

Creates a new builder with the given target string that will be resolved by NameResolver.

channelType

public NettyChannelBuilder channelType(Class<? extends Channel> channelType)

Specifies the channel type to use, by default we use NioSocketChannel.

withOption

public <T> NettyChannelBuilder withOption(ChannelOption<T> option,
                                          T value)

Specifies a channel option. As the underlying channel as well as network implementation may ignore this value applications should consider it a hint.

negotiationType

public NettyChannelBuilder negotiationType(NegotiationType type)

Sets the negotiation type for the HTTP/2 connection.

Default: TLS

eventLoopGroup

public NettyChannelBuilder eventLoopGroup(@Nullable
                                          EventLoopGroup eventLoopGroup)

Provides an EventGroupLoop to be used by the netty transport.

It's an optional parameter. If the user has not provided an EventGroupLoop when the channel is built, the builder will use the default one which is static.

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

sslContext

public NettyChannelBuilder sslContext(SslContext sslContext)

SSL/TLS context to use instead of the system default. It must have been configured with GrpcSslContexts, but options could have been overridden.

flowControlWindow

public NettyChannelBuilder flowControlWindow(int flowControlWindow)

Sets the flow control window in bytes. If not called, the default value is DEFAULT_FLOW_CONTROL_WINDOW).

maxMessageSize

@Deprecated
public NettyChannelBuilder maxMessageSize(int maxMessageSize)

Deprecated. Use AbstractManagedChannelImplBuilder.maxInboundMessageSize instead

Sets the max message size.

maxHeaderListSize

public NettyChannelBuilder maxHeaderListSize(int maxHeaderListSize)

Sets the maximum size of header list allowed to be received on the channel. If not called, defaults to GrpcUtil.DEFAULT_MAX_HEADER_LIST_SIZE.

usePlaintext

public NettyChannelBuilder usePlaintext(boolean skipNegotiation)

Equivalent to using negotiationType(NegotiationType) with PLAINTEXT or PLAINTEXT_UPGRADE.

Specified by:

usePlaintext in class io.grpc.ManagedChannelBuilder<NettyChannelBuilder>

enableKeepAlive

public final NettyChannelBuilder enableKeepAlive(boolean enable)

Enable keepalive with default delay and timeout.

enableKeepAlive

public final NettyChannelBuilder enableKeepAlive(boolean enable,
                                                 long keepAliveDelay,
                                                 TimeUnit delayUnit,
                                                 long keepAliveTimeout,
                                                 TimeUnit timeoutUnit)

Enable keepalive with custom delay and timeout.

buildTransportFactory

protected io.grpc.internal.ClientTransportFactory buildTransportFactory()

Specified by:

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

getNameResolverParams

protected io.grpc.Attributes getNameResolverParams()

Overrides:

getNameResolverParams in class io.grpc.internal.AbstractManagedChannelImplBuilder<NettyChannelBuilder>

checkAuthority

protected String checkAuthority(String authority)

Overrides:

checkAuthority in class io.grpc.internal.AbstractManagedChannelImplBuilder<NettyChannelBuilder>