Package io.grpc.netty

Class NettyServer

java.lang.Object

io.grpc.netty.NettyServer

All Implemented Interfaces:

InternalServer, InternalWithLogId

class NettyServer
extends Object
implements InternalServer, InternalWithLogId

Netty-based server implementation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final class	NettyServer.ListenSocket	A class that can answer channelz queries about the server listen sockets.
(package private) class	NettyServer.SharedResourceReferenceCounter

Field Summary

Fields

Modifier and Type	Field	Description
private final List<? extends SocketAddress>	addresses
private final boolean	autoFlowControl
private final io.netty.channel.EventLoop	bossExecutor
private io.netty.channel.EventLoopGroup	bossGroup
private final ObjectPool<? extends io.netty.channel.EventLoopGroup>	bossGroupPool
private final io.netty.channel.ChannelFactory<? extends io.netty.channel.ServerChannel>	channelFactory
private final io.netty.channel.group.ChannelGroup	channelGroup
private final Map<io.netty.channel.ChannelOption<?>,?>	channelOptions
private final InternalChannelz	channelz
private final Map<io.netty.channel.ChannelOption<?>,?>	childChannelOptions
private final Attributes	eagAttributes
private final int	flowControlWindow
private final boolean	forceHeapBuffer
private final long	keepAliveTimeInNanos
private final long	keepAliveTimeoutInNanos
private ServerListener	listener
private List<InternalInstrumented<InternalChannelz.SocketStats>>	listenSocketStatsList
private static final Logger	log
private final InternalLogId	logId
private final long	maxConnectionAgeGraceInNanos
private final long	maxConnectionAgeInNanos
private final long	maxConnectionIdleInNanos
private final int	maxHeaderListSize
private final int	maxMessageSize
private final int	maxRstCount
private final long	maxRstPeriodNanos
private final int	maxStreamsPerConnection
private final long	permitKeepAliveTimeInNanos
private final boolean	permitKeepAliveWithoutCalls
private final ProtocolNegotiator	protocolNegotiator
private final io.netty.util.ReferenceCounted	sharedResourceReferenceCounter
private final List<? extends ServerStreamTracer.Factory>	streamTracerFactories
private boolean	terminated
private final TransportTracer.Factory	transportTracerFactory
private io.netty.channel.EventLoopGroup	workerGroup
private final ObjectPool<? extends io.netty.channel.EventLoopGroup>	workerGroupPool

Constructor Summary

Constructors

Constructor

Description

NettyServer(List<? extends SocketAddress> addresses, io.netty.channel.ChannelFactory<? extends io.netty.channel.ServerChannel> channelFactory, Map<io.netty.channel.ChannelOption<?>,?> channelOptions, Map<io.netty.channel.ChannelOption<?>,?> childChannelOptions, ObjectPool<? extends io.netty.channel.EventLoopGroup> bossGroupPool, ObjectPool<? extends io.netty.channel.EventLoopGroup> workerGroupPool, boolean forceHeapBuffer, ProtocolNegotiator protocolNegotiator, List<? extends ServerStreamTracer.Factory> streamTracerFactories, TransportTracer.Factory transportTracerFactory, int maxStreamsPerConnection, boolean autoFlowControl, int flowControlWindow, int maxMessageSize, int maxHeaderListSize, long keepAliveTimeInNanos, long keepAliveTimeoutInNanos, long maxConnectionIdleInNanos, long maxConnectionAgeInNanos, long maxConnectionAgeGraceInNanos, boolean permitKeepAliveWithoutCalls, long permitKeepAliveTimeInNanos, int maxRstCount, long maxRstPeriodNanos, Attributes eagAttributes, InternalChannelz channelz)

Method Summary

Modifier and Type	Method	Description
SocketAddress	getListenSocketAddress()	Returns the first listening socket address.
List<SocketAddress>	getListenSocketAddresses()	Returns a list of listening socket addresses.
InternalInstrumented<InternalChannelz.SocketStats>	getListenSocketStats()	Returns the first listen socket stats of this server.
List<InternalInstrumented<InternalChannelz.SocketStats>>	getListenSocketStatsList()	Returns a list of listen socket stats of this server.
InternalLogId	getLogId()	Returns an ID that is primarily used in debug logs.
void	shutdown()	Initiates an orderly shutdown of the server.
void	start(ServerListener serverListener)	Starts transport.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

log

private static final Logger log

logId

private final InternalLogId logId

addresses

private final List<? extends SocketAddress> addresses

channelFactory

private final io.netty.channel.ChannelFactory<? extends io.netty.channel.ServerChannel> channelFactory

channelOptions

private final Map<io.netty.channel.ChannelOption<?>,?> channelOptions

childChannelOptions

private final Map<io.netty.channel.ChannelOption<?>,?> childChannelOptions

protocolNegotiator

private final ProtocolNegotiator protocolNegotiator

maxStreamsPerConnection

private final int maxStreamsPerConnection

bossGroupPool

private final ObjectPool<? extends io.netty.channel.EventLoopGroup> bossGroupPool

workerGroupPool

private final ObjectPool<? extends io.netty.channel.EventLoopGroup> workerGroupPool

forceHeapBuffer

private final boolean forceHeapBuffer

bossGroup

private io.netty.channel.EventLoopGroup bossGroup

workerGroup

private io.netty.channel.EventLoopGroup workerGroup

listener

private ServerListener listener

channelGroup

private final io.netty.channel.group.ChannelGroup channelGroup

autoFlowControl

private final boolean autoFlowControl

flowControlWindow

private final int flowControlWindow

maxMessageSize

private final int maxMessageSize

maxHeaderListSize

private final int maxHeaderListSize

keepAliveTimeInNanos

private final long keepAliveTimeInNanos

keepAliveTimeoutInNanos

private final long keepAliveTimeoutInNanos

maxConnectionIdleInNanos

private final long maxConnectionIdleInNanos

maxConnectionAgeInNanos

private final long maxConnectionAgeInNanos

maxConnectionAgeGraceInNanos

private final long maxConnectionAgeGraceInNanos

permitKeepAliveWithoutCalls

private final boolean permitKeepAliveWithoutCalls

permitKeepAliveTimeInNanos

private final long permitKeepAliveTimeInNanos

maxRstCount

private final int maxRstCount

maxRstPeriodNanos

private final long maxRstPeriodNanos

eagAttributes

private final Attributes eagAttributes

sharedResourceReferenceCounter

private final io.netty.util.ReferenceCounted sharedResourceReferenceCounter

streamTracerFactories

private final List<? extends ServerStreamTracer.Factory> streamTracerFactories

transportTracerFactory

private final TransportTracer.Factory transportTracerFactory

channelz

private final InternalChannelz channelz

listenSocketStatsList

private volatile List<InternalInstrumented<InternalChannelz.SocketStats>> listenSocketStatsList

terminated

private volatile boolean terminated

bossExecutor

private final io.netty.channel.EventLoop bossExecutor

Constructor Details

NettyServer

NettyServer(List<? extends SocketAddress> addresses,
 io.netty.channel.ChannelFactory<? extends io.netty.channel.ServerChannel> channelFactory,
 Map<io.netty.channel.ChannelOption<?>,?> channelOptions,
 Map<io.netty.channel.ChannelOption<?>,?> childChannelOptions,
 ObjectPool<? extends io.netty.channel.EventLoopGroup> bossGroupPool,
 ObjectPool<? extends io.netty.channel.EventLoopGroup> workerGroupPool,
 boolean forceHeapBuffer,
 ProtocolNegotiator protocolNegotiator,
 List<? extends ServerStreamTracer.Factory> streamTracerFactories,
 TransportTracer.Factory transportTracerFactory,
 int maxStreamsPerConnection,
 boolean autoFlowControl,
 int flowControlWindow,
 int maxMessageSize,
 int maxHeaderListSize,
 long keepAliveTimeInNanos,
 long keepAliveTimeoutInNanos,
 long maxConnectionIdleInNanos,
 long maxConnectionAgeInNanos,
 long maxConnectionAgeGraceInNanos,
 boolean permitKeepAliveWithoutCalls,
 long permitKeepAliveTimeInNanos,
 int maxRstCount,
 long maxRstPeriodNanos,
 Attributes eagAttributes,
 InternalChannelz channelz)

Method Details

getListenSocketAddress

public SocketAddress getListenSocketAddress()

Description copied from interface: InternalServer

Returns the first listening socket address. May change after InternalServer.start(ServerListener) is called.

Specified by:

getListenSocketAddress in interface InternalServer

getListenSocketAddresses

public List<SocketAddress> getListenSocketAddresses()

Description copied from interface: InternalServer

Returns a list of listening socket addresses. May change after InternalServer.start(ServerListener) is called.

Specified by:

getListenSocketAddresses in interface InternalServer

getListenSocketStats

public InternalInstrumented<InternalChannelz.SocketStats> getListenSocketStats()

Description copied from interface: InternalServer

Returns the first listen socket stats of this server. May return null.

Specified by:

getListenSocketStats in interface InternalServer

getListenSocketStatsList

public List<InternalInstrumented<InternalChannelz.SocketStats>> getListenSocketStatsList()

Description copied from interface: InternalServer

Returns a list of listen socket stats of this server. May return null.

Specified by:

getListenSocketStatsList in interface InternalServer

start

public void start(ServerListener serverListener)
           throws IOException

Description copied from interface: InternalServer

Starts transport. Implementations must not call listener until after start() returns. The method only returns after it has done the equivalent of bind()ing, so it will be able to service any connections created after returning.

Specified by:

start in interface InternalServer

Parameters:

serverListener - non-null listener of server events

Throws:

IOException - if unable to bind

shutdown

public void shutdown()

Description copied from interface: InternalServer

Initiates an orderly shutdown of the server. Existing transports continue, but new transports will not be created (once ServerListener.serverShutdown() callback is called). This method may only be called once. Blocks until the listening socket(s) have been closed. If interrupted, this method will not wait for the close to complete, but it will happen asynchronously.

Specified by:

shutdown in interface InternalServer

getLogId

public InternalLogId getLogId()

Description copied from interface: InternalWithLogId

Returns an ID that is primarily used in debug logs. It usually contains the class name and a numeric ID that is unique among the instances.

The subclasses of this interface usually want to include the log ID in their Object.toString() results.

Specified by:

getLogId in interface InternalWithLogId

toString

public String toString()

Overrides:

toString in class Object