NettyChannelBuilder (grpc-all 1.18.0 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")
 @CanIgnoreReturnValue
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
  transportTracerFactory

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
`protected io.grpc.internal.ClientTransportFactory`	`buildTransportFactory()`
`NettyChannelBuilder`	`channelType(Class<? extends io.netty.channel.Channel> channelType)` Specifies the channel type to use, by default we use `NioSocketChannel`.
`protected String`	`checkAuthority(String authority)`
`NettyChannelBuilder`	`enableKeepAlive(boolean enable)` Deprecated. Please use `keepAliveTime(long, java.util.concurrent.TimeUnit)` and `keepAliveTimeout(long, java.util.concurrent.TimeUnit)` instead
`NettyChannelBuilder`	`enableKeepAlive(boolean enable, long keepAliveTime, TimeUnit delayUnit, long keepAliveTimeout, TimeUnit timeoutUnit)` Deprecated. Please use `keepAliveTime(long, java.util.concurrent.TimeUnit)` and `keepAliveTimeout(long, java.util.concurrent.TimeUnit)` instead
`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(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 Attributes`	`getNameResolverParams()`
`NettyChannelBuilder`	`keepAliveTime(long keepAliveTime, TimeUnit timeUnit)` Sets the time without read activity before sending a keepalive ping.
`NettyChannelBuilder`	`keepAliveTimeout(long keepAliveTimeout, TimeUnit timeUnit)` Sets the time waiting for read activity after sending a keepalive ping.
`NettyChannelBuilder`	`keepAliveWithoutCalls(boolean enable)` Sets whether keepalive will be performed when there are no outstanding RPC on a connection.
`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`	`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.
`protected void`	`setStatsEnabled(boolean value)`
`protected void`	`setStatsRecordRealTimeMetrics(boolean value)`
`protected void`	`setStatsRecordStartedRpcs(boolean value)`
`protected void`	`setTracingEnabled(boolean value)`
`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`	`usePlaintext(boolean skipNegotiation)` Deprecated. use `usePlaintext()` instead.
`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, directExecutor, disableRetry, enableFullStreamDecompression, enableRetry, executor, idleTimeout, intercept, intercept, loadBalancerFactory, maxHedgedAttempts, maxInboundMessageSize, maxInboundMessageSize, maxRetryAttempts, maxTraceEvents, nameResolverFactory, overrideAuthority, overrideCensusStatsModule, perRpcBufferLimit, retryBufferSize, setBinaryLog, setStatsRecordFinishedRpcs, 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
```
@CheckReturnValue
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
```
@CheckReturnValue
public static NettyChannelBuilder forAddress(String host,
                                                               int port)
```
    Creates a new builder with the given host and port.
  - forTarget
```
@CheckReturnValue
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 io.netty.channel.Channel> channelType)
```
    Specifies the channel type to use, by default we use NioSocketChannel.
  - withOption
```
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
```
public NettyChannelBuilder negotiationType(NegotiationType type)
```
    Sets the negotiation type for the HTTP/2 connection.
    Default: TLS
  - eventLoopGroup
```
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.
    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(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.
  - flowControlWindow
```
public NettyChannelBuilder flowControlWindow(int flowControlWindow)
```
    Sets the flow control window in bytes. If not called, the default value is DEFAULT_FLOW_CONTROL_WINDOW).
  - maxHeaderListSize
```
@Deprecated
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
```
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 ManagedChannelBuilder<NettyChannelBuilder>
    
    Parameters:
    
    bytes - the maximum size of received metadata
    
    Returns:
    
    this
    
    Throws:
    
    IllegalArgumentException - if bytes is non-positive
    
    Since:
    
    1.17.0
  - usePlaintext
```
@Deprecated
public NettyChannelBuilder usePlaintext(boolean skipNegotiation)
```
    Deprecated. use usePlaintext() instead.
    
    Equivalent to using negotiationType(NegotiationType) with PLAINTEXT or PLAINTEXT_UPGRADE.
    
    Overrides:
    
    usePlaintext in class ManagedChannelBuilder<NettyChannelBuilder>
    
    Parameters:
    
    skipNegotiation - @{code true} if there is a priori knowledge that the endpoint supports plaintext, false if plaintext use must be negotiated.
    
    Returns:
    
    this
  - usePlaintext
```
public NettyChannelBuilder usePlaintext()
```
    Equivalent to using negotiationType(NegotiationType) with PLAINTEXT.
    
    Overrides:
    
    usePlaintext in class ManagedChannelBuilder<NettyChannelBuilder>
    
    Returns:
    
    this
  - useTransportSecurity
```
public NettyChannelBuilder useTransportSecurity()
```
    Equivalent to using negotiationType(NegotiationType) with TLS.
    
    Overrides:
    
    useTransportSecurity in class ManagedChannelBuilder<NettyChannelBuilder>
    
    Returns:
    
    this
  - enableKeepAlive
```
@Deprecated
public final NettyChannelBuilder enableKeepAlive(boolean enable)
```
    Deprecated. Please use keepAliveTime(long, java.util.concurrent.TimeUnit) and keepAliveTimeout(long, java.util.concurrent.TimeUnit) instead
    
    Enable keepalive with default delay and timeout.
  - enableKeepAlive
```
@Deprecated
public final NettyChannelBuilder enableKeepAlive(boolean enable,
                                                             long keepAliveTime,
                                                             TimeUnit delayUnit,
                                                             long keepAliveTimeout,
                                                             TimeUnit timeoutUnit)
```
    Deprecated. Please use keepAliveTime(long, java.util.concurrent.TimeUnit) and keepAliveTimeout(long, java.util.concurrent.TimeUnit) instead
    
    Enable keepalive with custom delay and timeout.
  - keepAliveTime
```
public NettyChannelBuilder keepAliveTime(long keepAliveTime,
                                         TimeUnit timeUnit)
```
    Sets the time without read activity before sending a keepalive ping. An unreasonably small value might be increased, and Long.MAX_VALUE nano seconds or an unreasonably large value will disable keepalive. Defaults to infinite.
    Clients must receive permission from the service owner before enabling this option. Keepalives can increase the load on services and are commonly "invisible" making it hard to notice when they are causing excessive load. Clients are strongly encouraged to use only as small of a value as necessary.
    
    Overrides:
    
    keepAliveTime in class ManagedChannelBuilder<NettyChannelBuilder>
    
    Since:
    
    1.3.0
  - keepAliveTimeout
```
public NettyChannelBuilder keepAliveTimeout(long keepAliveTimeout,
                                            TimeUnit timeUnit)
```
    Sets the time waiting for read activity after sending a keepalive ping. If the time expires without any read activity on the connection, the connection is considered dead. An unreasonably small value might be increased. Defaults to 20 seconds.
    This value should be at least multiple times the RTT to allow for lost packets.
    
    Overrides:
    
    keepAliveTimeout in class ManagedChannelBuilder<NettyChannelBuilder>
    
    Since:
    
    1.3.0
  - keepAliveWithoutCalls
```
public NettyChannelBuilder keepAliveWithoutCalls(boolean enable)
```
    Sets whether keepalive will be performed when there are no outstanding RPC on a connection. Defaults to false.
    Clients must receive permission from the service owner before enabling this option. Keepalives on unused connections can easilly accidentally consume a considerable amount of bandwidth and CPU. idleTimeout() should generally be used instead of this option.
    
    Overrides:
    
    keepAliveWithoutCalls in class ManagedChannelBuilder<NettyChannelBuilder>
    
    Since:
    
    1.3.0
    
    See Also:
    
    ManagedChannelBuilder.keepAliveTime(long, TimeUnit)
  - localSocketPicker
```
public NettyChannelBuilder localSocketPicker(@Nullable
                                             NettyChannelBuilder.LocalSocketPicker localSocketPicker)
```
    If non-null, attempts to create connections bound to a local port.
  - buildTransportFactory
```
@CheckReturnValue
 @Internal
protected io.grpc.internal.ClientTransportFactory buildTransportFactory()
```
    Specified by:
    
    buildTransportFactory in class io.grpc.internal.AbstractManagedChannelImplBuilder<NettyChannelBuilder>
  - getNameResolverParams
```
@CheckReturnValue
protected Attributes getNameResolverParams()
```
    Overrides:
    
    getNameResolverParams in class io.grpc.internal.AbstractManagedChannelImplBuilder<NettyChannelBuilder>
  - checkAuthority
```
@CheckReturnValue
 @Internal
protected String checkAuthority(String authority)
```
    Overrides:
    
    checkAuthority in class io.grpc.internal.AbstractManagedChannelImplBuilder<NettyChannelBuilder>
  - setTracingEnabled
```
protected void setTracingEnabled(boolean value)
```
    Overrides:
    
    setTracingEnabled in class io.grpc.internal.AbstractManagedChannelImplBuilder<NettyChannelBuilder>
  - setStatsEnabled
```
protected void setStatsEnabled(boolean value)
```
    Overrides:
    
    setStatsEnabled in class io.grpc.internal.AbstractManagedChannelImplBuilder<NettyChannelBuilder>
  - setStatsRecordStartedRpcs
```
protected void setStatsRecordStartedRpcs(boolean value)
```
    Overrides:
    
    setStatsRecordStartedRpcs in class io.grpc.internal.AbstractManagedChannelImplBuilder<NettyChannelBuilder>
  - setStatsRecordRealTimeMetrics
```
protected void setStatsRecordRealTimeMetrics(boolean value)
```
    Overrides:
    
    setStatsRecordRealTimeMetrics 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

forTarget

channelType

withOption

negotiationType

eventLoopGroup

sslContext

flowControlWindow

maxHeaderListSize

maxInboundMetadataSize

usePlaintext

usePlaintext

useTransportSecurity

enableKeepAlive

enableKeepAlive

keepAliveTime

keepAliveTimeout

keepAliveWithoutCalls

localSocketPicker

buildTransportFactory

getNameResolverParams

checkAuthority

setTracingEnabled

setStatsEnabled

setStatsRecordStartedRpcs

setStatsRecordRealTimeMetrics