NettyServerBuilder (grpc-netty 1.6.0 API)

java.lang.Object
- io.grpc.ServerBuilder<T>
- - io.grpc.internal.AbstractServerImplBuilder<NettyServerBuilder>
  - - io.grpc.netty.NettyServerBuilder

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

A builder to help simplify the construction of a Netty-based GRPC server.

Field Summary

Fields
Modifier and Type Field and Description

static int DEFAULT_FLOW_CONTROL_WINDOW

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`NettyServerBuilder`	`bossEventLoopGroup(EventLoopGroup group)` Provides the boss EventGroupLoop to the server.
`protected io.grpc.netty.NettyServer`	`buildTransportServer(List<io.grpc.ServerStreamTracer.Factory> streamTracerFactories)`
`NettyServerBuilder`	`channelType(Class<? extends ServerChannel> channelType)` Specify the channel type to use, by default we use `NioServerSocketChannel`.
`NettyServerBuilder`	`flowControlWindow(int flowControlWindow)` Sets the HTTP/2 flow control window.
`static NettyServerBuilder`	`forAddress(SocketAddress address)` Creates a server builder configured with the given `SocketAddress`.
`static NettyServerBuilder`	`forPort(int port)` Creates a server builder that will bind to the given port.
`NettyServerBuilder`	`keepAliveTime(long keepAliveTime, TimeUnit timeUnit)` Sets a custom keepalive time, the delay time for sending next keepalive ping.
`NettyServerBuilder`	`keepAliveTimeout(long keepAliveTimeout, TimeUnit timeUnit)` Sets a custom keepalive timeout, the timeout for keepalive ping requests.
`NettyServerBuilder`	`maxConcurrentCallsPerConnection(int maxCalls)` The maximum number of concurrent calls permitted for each incoming connection.
`NettyServerBuilder`	`maxConnectionAge(long maxConnectionAge, TimeUnit timeUnit)` Sets a custom max connection age, connection lasting longer than which will be gracefully terminated.
`NettyServerBuilder`	`maxConnectionAgeGrace(long maxConnectionAgeGrace, TimeUnit timeUnit)` Sets a custom grace time for the graceful connection termination.
`NettyServerBuilder`	`maxConnectionIdle(long maxConnectionIdle, TimeUnit timeUnit)` Sets a custom max connection idle time, connection being idle for longer than which will be gracefully terminated.
`NettyServerBuilder`	`maxHeaderListSize(int maxHeaderListSize)` Sets the maximum size of header list allowed to be received.
`NettyServerBuilder`	`maxMessageSize(int maxMessageSize)` Sets the maximum message size allowed to be received on the server.
`NettyServerBuilder`	`permitKeepAliveTime(long keepAliveTime, TimeUnit timeUnit)` Specify the most aggressive keep-alive time clients are permitted to configure.
`NettyServerBuilder`	`permitKeepAliveWithoutCalls(boolean permit)` Sets whether to allow clients to send keep-alive HTTP/2 PINGs even if there are no outstanding RPCs on the connection.
`NettyServerBuilder`	`protocolNegotiator(ProtocolNegotiator protocolNegotiator)` Sets the `ProtocolNegotiator` to be used.
`NettyServerBuilder`	`sslContext(SslContext sslContext)` Sets the TLS context to use for encryption.
`NettyServerBuilder`	`useTransportSecurity(File certChain, File privateKey)`
`NettyServerBuilder`	`workerEventLoopGroup(EventLoopGroup group)` Provides the worker EventGroupLoop to the server.

Methods inherited from class io.grpc.internal.AbstractServerImplBuilder
addService, addService, addStreamTracerFactory, addTransportFilter, build, compressorRegistry, decompressorRegistry, directExecutor, executor, fallbackHandlerRegistry, intercept, statsContextFactory

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
  - forPort
```
@CheckReturnValue
public static NettyServerBuilder forPort(int port)
```
    Creates a server builder that will bind to the given port.
    
    Parameters:
    
    port - the port on which the server is to be bound.
    
    Returns:
    
    the server builder.
  - forAddress
```
@CheckReturnValue
public static NettyServerBuilder forAddress(SocketAddress address)
```
    Creates a server builder configured with the given SocketAddress.
    
    Parameters:
    
    address - the socket address on which the server is to be bound.
    
    Returns:
    
    the server builder
  - channelType
```
public NettyServerBuilder channelType(Class<? extends ServerChannel> channelType)
```
    Specify the channel type to use, by default we use NioServerSocketChannel.
  - bossEventLoopGroup
```
public NettyServerBuilder bossEventLoopGroup(EventLoopGroup group)
```
    Provides the boss EventGroupLoop to the server.
    It's an optional parameter. If the user has not provided one when the server is built, the builder will use the default one which is static.
    The server won't take ownership of the given EventLoopGroup. It's caller's responsibility to shut it down when it's desired.
    Grpc uses non-daemon Threads by default and thus a Server will continue to run even after the main thread has terminated. However, users have to be cautious when providing their own EventLoopGroups. For example, Netty's EventLoopGroups use daemon threads by default and thus an application with only daemon threads running besides the main thread will exit as soon as the main thread completes. A simple solution to this problem is to call Server.awaitTermination() to keep the main thread alive until the server has terminated.
  - workerEventLoopGroup
```
public NettyServerBuilder workerEventLoopGroup(EventLoopGroup group)
```
    Provides the worker EventGroupLoop to the server.
    It's an optional parameter. If the user has not provided one when the server is built, the builder will create one.
    The server won't take ownership of the given EventLoopGroup. It's caller's responsibility to shut it down when it's desired.
    Grpc uses non-daemon Threads by default and thus a Server will continue to run even after the main thread has terminated. However, users have to be cautious when providing their own EventLoopGroups. For example, Netty's EventLoopGroups use daemon threads by default and thus an application with only daemon threads running besides the main thread will exit as soon as the main thread completes. A simple solution to this problem is to call Server.awaitTermination() to keep the main thread alive until the server has terminated.
  - sslContext
```
public NettyServerBuilder sslContext(SslContext sslContext)
```
    Sets the TLS context to use for encryption. Providing a context enables encryption. It must have been configured with GrpcSslContexts, but options could have been overridden.
  - protocolNegotiator
```
@Internal
public final NettyServerBuilder protocolNegotiator(@Nullable
                                                             ProtocolNegotiator protocolNegotiator)
```
    Sets the ProtocolNegotiator to be used. If non-null, overrides the value specified in sslContext(SslContext).
    Default: null.
  - maxConcurrentCallsPerConnection
```
public NettyServerBuilder maxConcurrentCallsPerConnection(int maxCalls)
```
    The maximum number of concurrent calls permitted for each incoming connection. Defaults to no limit.
  - flowControlWindow
```
public NettyServerBuilder flowControlWindow(int flowControlWindow)
```
    Sets the HTTP/2 flow control window. If not called, the default value is DEFAULT_FLOW_CONTROL_WINDOW).
  - maxMessageSize
```
public NettyServerBuilder maxMessageSize(int maxMessageSize)
```
    Sets the maximum message size allowed to be received on the server. If not called, defaults to 4 MiB. The default provides protection to services who haven't considered the possibility of receiving large messages while trying to be large enough to not be hit in normal usage.
  - maxHeaderListSize
```
public NettyServerBuilder maxHeaderListSize(int maxHeaderListSize)
```
    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.
  - keepAliveTime
```
public NettyServerBuilder keepAliveTime(long keepAliveTime,
                                        TimeUnit timeUnit)
```
    Sets a custom keepalive time, the delay time for sending next keepalive ping. An unreasonably small value might be increased, and Long.MAX_VALUE nano seconds or an unreasonably large value will disable keepalive.
    
    Since:
    
    1.3.0
  - keepAliveTimeout
```
public NettyServerBuilder keepAliveTimeout(long keepAliveTimeout,
                                           TimeUnit timeUnit)
```
    Sets a custom keepalive timeout, the timeout for keepalive ping requests. An unreasonably small value might be increased.
    
    Since:
    
    1.3.0
  - maxConnectionIdle
```
public NettyServerBuilder maxConnectionIdle(long maxConnectionIdle,
                                            TimeUnit timeUnit)
```
    Sets a custom max connection idle time, connection being idle for longer than which will be gracefully terminated. Idleness duration is defined since the most recent time the number of outstanding RPCs became zero or the connection establishment. An unreasonably small value might be increased. Long.MAX_VALUE nano seconds or an unreasonably large value will disable max connection idle.
    
    Since:
    
    1.4.0
  - maxConnectionAge
```
public NettyServerBuilder maxConnectionAge(long maxConnectionAge,
                                           TimeUnit timeUnit)
```
    Sets a custom max connection age, connection lasting longer than which will be gracefully terminated. An unreasonably small value might be increased. A random jitter of +/-10% will be added to it. Long.MAX_VALUE nano seconds or an unreasonably large value will disable max connection age.
    
    Since:
    
    1.3.0
  - maxConnectionAgeGrace
```
public NettyServerBuilder maxConnectionAgeGrace(long maxConnectionAgeGrace,
                                                TimeUnit timeUnit)
```
    Sets a custom grace time for the graceful connection termination. Once the max connection age is reached, RPCs have the grace time to complete. RPCs that do not complete in time will be cancelled, allowing the connection to terminate. Long.MAX_VALUE nano seconds or an unreasonably large value are considered infinite.
    
    Since:
    
    1.3.0
    
    See Also:
    
    maxConnectionAge(long, TimeUnit)
  - permitKeepAliveTime
```
public NettyServerBuilder permitKeepAliveTime(long keepAliveTime,
                                              TimeUnit timeUnit)
```
    Specify the most aggressive keep-alive time clients are permitted to configure. The server will try to detect clients exceeding this rate and when detected will forcefully close the connection. The default is 5 minutes.
    Even though a default is defined that allows some keep-alives, clients must not use keep-alive without approval from the service owner. Otherwise, they may experience failures in the future if the service becomes more restrictive. When unthrottled, keep-alives can cause a significant amount of traffic and CPU usage, so clients and servers should be conservative in what they use and accept.
    
    Since:
    
    1.3.0
    
    See Also:
    
    permitKeepAliveWithoutCalls(boolean)
  - permitKeepAliveWithoutCalls
```
public NettyServerBuilder permitKeepAliveWithoutCalls(boolean permit)
```
    Sets whether to allow clients to send keep-alive HTTP/2 PINGs even if there are no outstanding RPCs on the connection. Defaults to false.
    
    Since:
    
    1.3.0
    
    See Also:
    
    permitKeepAliveTime(long, TimeUnit)
  - buildTransportServer
```
@CheckReturnValue
protected io.grpc.netty.NettyServer buildTransportServer(List<io.grpc.ServerStreamTracer.Factory> streamTracerFactories)
```
    Specified by:
    
    buildTransportServer in class io.grpc.internal.AbstractServerImplBuilder<NettyServerBuilder>
  - useTransportSecurity
```
public NettyServerBuilder useTransportSecurity(File certChain,
                                               File privateKey)
```
    Specified by:
    
    useTransportSecurity in class io.grpc.ServerBuilder<NettyServerBuilder>

Class NettyServerBuilder

Field Summary

Method Summary

Methods inherited from class io.grpc.internal.AbstractServerImplBuilder

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_FLOW_CONTROL_WINDOW

Method Detail

forPort

forAddress

channelType

bossEventLoopGroup

workerEventLoopGroup

sslContext

protocolNegotiator

maxConcurrentCallsPerConnection

flowControlWindow

maxMessageSize

maxHeaderListSize

keepAliveTime

keepAliveTimeout

maxConnectionIdle

maxConnectionAge

maxConnectionAgeGrace

permitKeepAliveTime

permitKeepAliveWithoutCalls

buildTransportServer

useTransportSecurity