io.grpc.netty

Class NettyChannelBuilder

java.lang.Object

io.grpc.ManagedChannelBuilder<T>

io.grpc.internal.AbstractManagedChannelImplBuilder<NettyChannelBuilder>

io.grpc.netty.NettyChannelBuilder

@ExperimentalApi(value="There is no plan to make this API stable, given transport API instability")
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) Specify the channel type to use, by default we use NioSocketChannel.
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.
NettyChannelBuilder	maxMessageSize(int maxMessageSize) Sets the maximum message size allowed to be received on the channel.
NettyChannelBuilder	negotiationType(NegotiationType type) Sets the negotiation type for the HTTP/2 connection.
NettyChannelBuilder	overrideAuthority(String authority)
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.

Methods inherited from class io.grpc.internal.AbstractManagedChannelImplBuilder

build, executor, intercept, intercept, 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.

channelType

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

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

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

public NettyChannelBuilder maxMessageSize(int maxMessageSize)

Sets the maximum message size allowed to be received on the channel. If not called, defaults to GrpcUtil.DEFAULT_MAX_MESSAGE_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>

overrideAuthority

public NettyChannelBuilder overrideAuthority(String authority)

Specified by:

overrideAuthority in class io.grpc.ManagedChannelBuilder<NettyChannelBuilder>

buildTransportFactory

protected io.grpc.internal.ClientTransportFactory buildTransportFactory()

Specified by:

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