NettyChannelBuilder (grpc-all 1.55.1 API)

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")
 @CheckReturnValue
public final class NettyChannelBuilder
extends io.grpc.internal.AbstractManagedChannelImplBuilder<NettyChannelBuilder>

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

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`NettyChannelBuilder.LocalSocketPicker` This class is meant to be overriden with a custom implementation of `NettyChannelBuilder.LocalSocketPicker.createSocketAddress(java.net.SocketAddress, io.grpc.Attributes)`.

Field Summary

Fields
Modifier and Type Field and Description

static int DEFAULT_FLOW_CONTROL_WINDOW
- Fields inherited from class io.grpc.internal.AbstractManagedChannelImplBuilder
  maxInboundMessageSize

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_FLOW_CONTROL_WINDOW`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`NettyChannelBuilder`	`channelFactory(io.netty.channel.ChannelFactory<? extends io.netty.channel.Channel> channelFactory)` Specifies the `ChannelFactory` to create `Channel` instances.
`NettyChannelBuilder`	`channelType(Class<? extends io.netty.channel.Channel> channelType)` Specifies the channel type to use, by default we use `EpollSocketChannel` if available, otherwise using `NioSocketChannel`.
`protected ManagedChannelBuilder<?>`	`delegate()`
`NettyChannelBuilder`	`eventLoopGroup(io.netty.channel.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(SocketAddress serverAddress, ChannelCredentials creds)` 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`	`forAddress(String host, int port, ChannelCredentials creds)` 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`.
`static NettyChannelBuilder`	`forTarget(String target, ChannelCredentials creds)` Creates a new builder with the given target string that will be resolved by `NameResolver`.
`NettyChannelBuilder`	`initialFlowControlWindow(int initialFlowControlWindow)` Sets the initial flow control window in bytes.
`NettyChannelBuilder`	`keepAliveTime(long keepAliveTime, TimeUnit timeUnit)`
`NettyChannelBuilder`	`keepAliveTimeout(long keepAliveTimeout, TimeUnit timeUnit)`
`NettyChannelBuilder`	`keepAliveWithoutCalls(boolean enable)`
`NettyChannelBuilder`	`localSocketPicker(NettyChannelBuilder.LocalSocketPicker localSocketPicker)` If non-`null`, attempts to create connections bound to a local port.
`NettyChannelBuilder`	`maxHeaderListSize(int maxHeaderListSize)` Deprecated. Use `maxInboundMetadataSize(int)` instead
`NettyChannelBuilder`	`maxInboundMessageSize(int max)` Sets the maximum message size allowed for a single gRPC frame.
`NettyChannelBuilder`	`maxInboundMetadataSize(int bytes)` Sets the maximum size of metadata allowed to be received.
`NettyChannelBuilder`	`negotiationType(NegotiationType type)` Sets the negotiation type for the HTTP/2 connection.
`NettyChannelBuilder`	`sslContext(io.netty.handler.ssl.SslContext sslContext)` SSL/TLS context to use instead of the system default.
`NettyChannelBuilder`	`usePlaintext()` Equivalent to using `negotiationType(NegotiationType)` with `PLAINTEXT`.
`NettyChannelBuilder`	`useTransportSecurity()` Equivalent to using `negotiationType(NegotiationType)` with `TLS`.
`<T> NettyChannelBuilder`	`withOption(io.netty.channel.ChannelOption<T> option, T value)` Specifies a channel option.

Methods inherited from class io.grpc.internal.AbstractManagedChannelImplBuilder
build, compressorRegistry, decompressorRegistry, defaultLoadBalancingPolicy, defaultServiceConfig, directExecutor, disableRetry, disableServiceConfigLookUp, enableFullStreamDecompression, enableRetry, executor, idleTimeout, intercept, intercept, maxHedgedAttempts, maxRetryAttempts, maxTraceEvents, nameResolverFactory, offloadExecutor, overrideAuthority, perRpcBufferLimit, proxyDetector, retryBufferSize, setBinaryLog, thisT, toString, userAgent

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, 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. If an unresolved InetSocketAddress is passed in, then it will remain unresolved.
  - forAddress
```
public static NettyChannelBuilder forAddress(SocketAddress serverAddress,
                                             ChannelCredentials creds)
```
    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, ChannelCredentials) should generally be preferred over this method, since that API permits delaying DNS lookups and noticing changes to DNS. If an unresolved InetSocketAddress is passed in, then it will remain unresolved.
  - forAddress
```
public static NettyChannelBuilder forAddress(String host,
                                             int port)
```
    Creates a new builder with the given host and port.
  - forAddress
```
public static NettyChannelBuilder forAddress(String host,
                                             int port,
                                             ChannelCredentials creds)
```
    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.
  - forTarget
```
public static NettyChannelBuilder forTarget(String target,
                                            ChannelCredentials creds)
```
    Creates a new builder with the given target string that will be resolved by NameResolver.
  - delegate
```
@Internal
protected ManagedChannelBuilder<?> delegate()
```
    Specified by:
    
    delegate in class io.grpc.internal.AbstractManagedChannelImplBuilder<NettyChannelBuilder>
  - channelType
```
@CanIgnoreReturnValue
public NettyChannelBuilder channelType(Class<? extends io.netty.channel.Channel> channelType)
```
    Specifies the channel type to use, by default we use EpollSocketChannel if available, otherwise using NioSocketChannel.
    You either use this or channelFactory(io.netty.channel.ChannelFactory) if your Channel implementation has no no-args constructor.
    It's an optional parameter. If the user has not provided an Channel type or ChannelFactory when the channel is built, the builder will use the default one which is static.
    You must also provide corresponding eventLoopGroup(EventLoopGroup). For example, NioSocketChannel must use NioEventLoopGroup, otherwise your application won't start.
  - channelFactory
```
@CanIgnoreReturnValue
public NettyChannelBuilder channelFactory(io.netty.channel.ChannelFactory<? extends io.netty.channel.Channel> channelFactory)
```
    Specifies the ChannelFactory to create Channel instances. This method is usually only used if the specific Channel requires complex logic which requires additional information to create the Channel. Otherwise, recommend to use channelType(Class).
    It's an optional parameter. If the user has not provided an Channel type or ChannelFactory when the channel is built, the builder will use the default one which is static.
    You must also provide corresponding eventLoopGroup(EventLoopGroup). For example, NioSocketChannel based ChannelFactory must use NioEventLoopGroup, otherwise your application won't start.
  - withOption
```
@CanIgnoreReturnValue
public <T> NettyChannelBuilder withOption(io.netty.channel.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
```
@CanIgnoreReturnValue
public NettyChannelBuilder negotiationType(NegotiationType type)
```
    Sets the negotiation type for the HTTP/2 connection.
    Default: TLS
  - eventLoopGroup
```
@CanIgnoreReturnValue
public NettyChannelBuilder eventLoopGroup(@Nullable
                                                                io.netty.channel.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.
    You must also provide corresponding channelType(Class) or channelFactory(ChannelFactory) corresponding to the given EventLoopGroup. For example, NioEventLoopGroup requires NioSocketChannel
    The channel won't take ownership of the given EventLoopGroup. It's caller's responsibility to shut it down when it's desired.
  - sslContext
```
@CanIgnoreReturnValue
public NettyChannelBuilder sslContext(io.netty.handler.ssl.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.
  - initialFlowControlWindow
```
@CanIgnoreReturnValue
public NettyChannelBuilder initialFlowControlWindow(int initialFlowControlWindow)
```
    Sets the initial flow control window in bytes. Setting initial flow control window enables auto flow control tuning using bandwidth-delay product algorithm. To disable auto flow control tuning, use flowControlWindow(int). By default, auto flow control is enabled with initial flow control window size of DEFAULT_FLOW_CONTROL_WINDOW.
  - flowControlWindow
```
@CanIgnoreReturnValue
public NettyChannelBuilder flowControlWindow(int flowControlWindow)
```
    Sets the flow control window in bytes. Setting flowControlWindow disables auto flow control tuning; use initialFlowControlWindow(int) to enable auto flow control tuning. If not called, the default value is DEFAULT_FLOW_CONTROL_WINDOW) with auto flow control tuning.
  - maxHeaderListSize
```
@CanIgnoreReturnValue
 @Deprecated
 @InlineMe(replacement="this.maxInboundMetadataSize(maxHeaderListSize)")
public NettyChannelBuilder maxHeaderListSize(int maxHeaderListSize)
```
    Deprecated. Use maxInboundMetadataSize(int) instead
    
    Sets the maximum size of header list allowed to be received. This is cumulative size of the headers with some overhead, as defined for HTTP/2's SETTINGS_MAX_HEADER_LIST_SIZE. The default is 8 KiB.
  - maxInboundMetadataSize
```
@CanIgnoreReturnValue
public NettyChannelBuilder maxInboundMetadataSize(int bytes)
```
    Sets the maximum size of metadata allowed to be received. This is cumulative size of the entries with some overhead, as defined for HTTP/2's SETTINGS_MAX_HEADER_LIST_SIZE. The default is 8 KiB.
    
    Overrides:
    
    maxInboundMetadataSize in class io.grpc.internal.AbstractManagedChannelImplBuilder<NettyChannelBuilder>
    
    Parameters:
    
    bytes - the maximum size of received metadata
    
    Returns:
    
    this
    
    Throws:
    
    IllegalArgumentException - if bytes is non-positive
    
    Since:
    
    1.17.0
  - usePlaintext
```
@CanIgnoreReturnValue
public NettyChannelBuilder usePlaintext()
```
    Equivalent to using negotiationType(NegotiationType) with PLAINTEXT.
    
    Overrides:
    
    usePlaintext in class io.grpc.internal.AbstractManagedChannelImplBuilder<NettyChannelBuilder>
  - useTransportSecurity
```
@CanIgnoreReturnValue
public NettyChannelBuilder useTransportSecurity()
```
    Equivalent to using negotiationType(NegotiationType) with TLS.
    
    Overrides:
    
    useTransportSecurity in class io.grpc.internal.AbstractManagedChannelImplBuilder<NettyChannelBuilder>
  - keepAliveTime
```
@CanIgnoreReturnValue
public NettyChannelBuilder keepAliveTime(long keepAliveTime,
                                                               TimeUnit timeUnit)
```
    Overrides:
    
    keepAliveTime in class io.grpc.internal.AbstractManagedChannelImplBuilder<NettyChannelBuilder>
    
    Since:
    
    1.3.0
  - keepAliveTimeout
```
@CanIgnoreReturnValue
public NettyChannelBuilder keepAliveTimeout(long keepAliveTimeout,
                                                                  TimeUnit timeUnit)
```
    Overrides:
    
    keepAliveTimeout in class io.grpc.internal.AbstractManagedChannelImplBuilder<NettyChannelBuilder>
    
    Since:
    
    1.3.0
  - keepAliveWithoutCalls
```
@CanIgnoreReturnValue
public NettyChannelBuilder keepAliveWithoutCalls(boolean enable)
```
    Overrides:
    
    keepAliveWithoutCalls in class io.grpc.internal.AbstractManagedChannelImplBuilder<NettyChannelBuilder>
    
    Since:
    
    1.3.0
  - localSocketPicker
```
@CanIgnoreReturnValue
public NettyChannelBuilder localSocketPicker(@Nullable
                                                                   NettyChannelBuilder.LocalSocketPicker localSocketPicker)
```
    If non-null, attempts to create connections bound to a local port.
  - maxInboundMessageSize
```
@CanIgnoreReturnValue
public NettyChannelBuilder maxInboundMessageSize(int max)
```
    Sets the maximum message size allowed for a single gRPC frame. If an inbound messages larger than this limit is received it will not be processed and the RPC will fail with RESOURCE_EXHAUSTED.
    
    Overrides:
    
    maxInboundMessageSize in class io.grpc.internal.AbstractManagedChannelImplBuilder<NettyChannelBuilder>

Class NettyChannelBuilder

Nested Class Summary

Field Summary

Fields inherited from class io.grpc.internal.AbstractManagedChannelImplBuilder

Method Summary

Methods inherited from class io.grpc.internal.AbstractManagedChannelImplBuilder

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_FLOW_CONTROL_WINDOW

Method Detail

forAddress

forAddress

forAddress

forAddress

forTarget

forTarget

delegate

channelType

channelFactory

withOption

negotiationType

eventLoopGroup

sslContext

initialFlowControlWindow

flowControlWindow

maxHeaderListSize

maxInboundMetadataSize

usePlaintext

useTransportSecurity

keepAliveTime

keepAliveTimeout

keepAliveWithoutCalls

localSocketPicker

maxInboundMessageSize