io.grpc.transport.netty

Class NettyChannelBuilder

java.lang.Object

io.grpc.AbstractChannelBuilder<NettyChannelBuilder>

io.grpc.transport.netty.NettyChannelBuilder

public final class NettyChannelBuilder
extends AbstractChannelBuilder<NettyChannelBuilder>

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

Nested Class Summary

Nested classes/interfaces inherited from class io.grpc.AbstractChannelBuilder

AbstractChannelBuilder.ChannelEssentials

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_CONNECTION_WINDOW_SIZE
static int	DEFAULT_STREAM_WINDOW_SIZE

Method Summary

Modifier and Type	Method and Description
protected AbstractChannelBuilder.ChannelEssentials	buildEssentials()
NettyChannelBuilder	channelType(Class<? extends Channel> channelType) Specify the channel type to use, by default we use NioSocketChannel.
NettyChannelBuilder	connectionWindowSize(int connectionWindowSize) Sets the HTTP/2 connection flow control window.
NettyChannelBuilder	eventLoopGroup(EventLoopGroup group) Provides an EventGroupLoop to be used by the netty transport.
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	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	streamWindowSize(int streamWindowSize) Sets the HTTP/2 per-stream flow control window.

Methods inherited from class io.grpc.AbstractChannelBuilder

build, executor

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CONNECTION_WINDOW_SIZE

public static final int DEFAULT_CONNECTION_WINDOW_SIZE

See Also:

Constant Field Values

DEFAULT_STREAM_WINDOW_SIZE

public static final int DEFAULT_STREAM_WINDOW_SIZE

See Also:

Constant Field Values

Method Detail

forAddress

public static NettyChannelBuilder forAddress(SocketAddress serverAddress)

Creates a new builder with the given server address.

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(EventLoopGroup group)

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.

connectionWindowSize

public NettyChannelBuilder connectionWindowSize(int connectionWindowSize)

Sets the HTTP/2 connection flow control window. If not called, the default value is DEFAULT_CONNECTION_WINDOW_SIZE).

streamWindowSize

public NettyChannelBuilder streamWindowSize(int streamWindowSize)

Sets the HTTP/2 per-stream flow control window. If not called, the default value is DEFAULT_STREAM_WINDOW_SIZE).

buildEssentials

protected AbstractChannelBuilder.ChannelEssentials buildEssentials()

Specified by:

buildEssentials in class AbstractChannelBuilder<NettyChannelBuilder>