@CheckReturnValue

Package io.grpc.netty

The main transport implementation based on Netty, for both the client and the server.

Interface Summary

Interface	Description
AbstractNettyHandler.PingLimiter	Controls whether PINGs like those for BDP are permitted to be sent at the current time.
InternalNettyChannelBuilder.ProtocolNegotiatorFactory	A class that provides a Netty handler to control protocol negotiation.
InternalNettySocketSupport.InternalHelper
InternalProtocolNegotiator.ClientFactory
InternalProtocolNegotiator.ProtocolNegotiator
InternalProtocolNegotiator.ServerFactory
NettySocketSupport.Helper
ProtocolNegotiator	An class that provides a Netty handler to control protocol negotiation.
ProtocolNegotiator.ClientFactory
ProtocolNegotiator.ServerFactory
StreamIdHolder	Container for stream ids.
WriteQueue.QueuedCommand	Simple wrapper type around a command and its optional completion listener.

Class Summary

Class	Description
AbstractHttp2Headers
AbstractNettyHandler	Base class for all Netty gRPC handlers.
AbstractNettyHandler.AllowPingLimiter
CancelClientStreamCommand	Command sent from a Netty client stream to the handler to cancel the stream.
CancelServerStreamCommand	Command sent from a Netty server stream to the handler to cancel the stream.
ClientTransportLifecycleManager	Maintainer of transport lifecycle status.
CreateStreamCommand	A command to create a new stream.
FixedKeyManagerFactory	A KeyManagerFactory that returns a fixed list of key managers.
FixedKeyManagerFactory.FixedKeyManagerFactorySpi
FixedTrustManagerFactory	A TrustManagerFactory that returns a fixed list of trust managers.
FixedTrustManagerFactory.FixedTrustManagerFactorySpi
ForcefulCloseCommand	A command to trigger close and close all streams.
GracefulCloseCommand	A command to trigger close.
GracefulServerCloseCommand	A command to trigger close and allow streams naturally close.
GrpcHttp2ConnectionHandler	gRPC wrapper for Http2ConnectionHandler.
GrpcHttp2HeadersUtils	A headers utils providing custom gRPC implementations of DefaultHttp2HeadersDecoder.
GrpcHttp2HeadersUtils.GrpcHttp2ClientHeadersDecoder
GrpcHttp2HeadersUtils.GrpcHttp2InboundHeaders	A Http2Headers implementation optimized for inbound/received headers.
GrpcHttp2HeadersUtils.GrpcHttp2RequestHeaders	A GrpcHttp2HeadersUtils.GrpcHttp2InboundHeaders implementation, optimized for HTTP/2 request headers.
GrpcHttp2HeadersUtils.GrpcHttp2ResponseHeaders	This class only implements the methods used by NettyClientHandler and tests.
GrpcHttp2HeadersUtils.GrpcHttp2ServerHeadersDecoder
GrpcHttp2OutboundHeaders	A custom implementation of Http2Headers that only includes methods used by gRPC.
GrpcSslContexts	Utility for configuring SslContext for gRPC.
GrpcSslContexts.ConscryptHolder
Http2ControlFrameLimitEncoder	DecoratingHttp2ConnectionEncoder which guards against a remote peer that will trigger a massive amount of control frames but will not consume our responses to these.
InsecureFromHttp1ChannelCredentials	An insecure credential that upgrades from HTTP/1 to HTTP/2.
InternalGracefulServerCloseCommand	Internal accessor for GracefulServerCloseCommand.
InternalNettyChannelBuilder	Internal NettyChannelBuilder accessor.
InternalNettyChannelCredentials	Internal NettyChannelCredentials accessor.
InternalNettyServerBuilder	Internal NettyServerBuilder accessor.
InternalNettyServerCredentials	Internal NettyServerCredentials accessor.
InternalNettySocketSupport	An internal accessor.
InternalNettySocketSupport.InternalNativeSocketOptions
InternalProtocolNegotiationEvent	Internal accessor for ProtocolNegotiationEvent.
InternalProtocolNegotiator	Internal accessor for InternalProtocolNegotiator.ProtocolNegotiator.
InternalProtocolNegotiator.ProtocolNegotiatorAdapter
InternalProtocolNegotiators	Internal accessor for ProtocolNegotiators.
InternalProtocolNegotiators.ProtocolNegotiationHandler
InternalWriteBufferingAndExceptionHandlerUtils	Utility class for WriteBufferingAndExceptionHandler.
JettyTlsUtil	Utility class for determining support for Jetty TLS ALPN/NPN.
JettyTlsUtil.Java9AlpnUnavailabilityCauseHolder
NettyAdaptiveCumulator	"Adaptive" cumulator: cumulate ByteBufs by dynamically switching between merge and compose strategies.
NettyChannelBuilder	A builder to help simplify construction of channels using the Netty transport.
NettyChannelBuilder.LocalSocketPicker	This class is meant to be overriden with a custom implementation of NettyChannelBuilder.LocalSocketPicker.createSocketAddress(java.net.SocketAddress, io.grpc.Attributes).
NettyChannelBuilder.NettyTransportFactory	Creates Netty transports.
NettyChannelCredentials	A credential with full control over the security handshake.
NettyChannelProvider	Provider for NettyChannelBuilder instances.
NettyClientHandler	Client-side Netty handler for GRPC processing.
NettyClientHandler.PingCountingFrameWriter
NettyClientStream	Client stream for a Netty transport.
NettyClientStream.TransportState	This should only be called from the transport thread.
NettyClientTransport	A Netty-based ConnectionClientTransport implementation.
NettyReadableBuffer	A Buffer implementation that is backed by a Netty ByteBuf.
NettyServer	Netty-based server implementation.
NettyServer.ListenSocket	A class that can answer channelz queries about the server listen sockets.
NettyServerBuilder	A builder to help simplify the construction of a Netty-based GRPC server.
NettyServerCredentials	A credential with full control over the security handshake.
NettyServerHandler	Server-side Netty handler for GRPC processing.
NettyServerHandler.ServerChannelLogger
NettyServerHandler.WriteMonitoringFrameWriter
NettyServerProvider	Provider for NettyServerBuilder instances.
NettyServerStream	Server stream for a Netty HTTP2 transport.
NettyServerStream.TransportState	This should only be called from the transport thread.
NettyServerTransport	The Netty-based server transport.
NettySocketSupport	An class for getting low level socket info.
NettySocketSupport.NativeSocketOptions	A TcpInfo and additional other info that will be turned into channelz socket options.
NettySocketSupport.NettySocketHelperImpl
NettySslContextChannelCredentials	A credential that performs TLS with Netty's SslContext as configuration.
NettySslContextServerCredentials	A credential that performs TLS with Netty's SslContext as configuration.
NettyWritableBuffer	The WritableBuffer used by the Netty transport.
NettyWritableBufferAllocator	The default allocator for NettyWritableBuffers used by the Netty transport.
ProtocolNegotiationEvent	Represents a completion of a protocol negotiation stage.
ProtocolNegotiators	Common ProtocolNegotiators used by gRPC.
ProtocolNegotiators.ClientTlsHandler
ProtocolNegotiators.ClientTlsProtocolNegotiator
ProtocolNegotiators.FixedProtocolNegotiatorServerFactory
ProtocolNegotiators.FromChannelCredentialsResult
ProtocolNegotiators.FromServerCredentialsResult
ProtocolNegotiators.GrpcNegotiationHandler	Adapts a ProtocolNegotiationEvent to the GrpcHttp2ConnectionHandler.
ProtocolNegotiators.HostPort	A tuple of (host, port).
ProtocolNegotiators.Http2UpgradeAndGrpcHandler	Acts as a combination of Http2Upgrade and ProtocolNegotiators.GrpcNegotiationHandler.
ProtocolNegotiators.PlaintextProtocolNegotiator	A negotiator that only does plain text.
ProtocolNegotiators.PlaintextProtocolNegotiatorClientFactory
ProtocolNegotiators.PlaintextProtocolNegotiatorServerFactory
ProtocolNegotiators.PlaintextUpgradeProtocolNegotiator
ProtocolNegotiators.PlaintextUpgradeProtocolNegotiatorClientFactory
ProtocolNegotiators.ProtocolNegotiationHandler	ProtocolNegotiationHandler is a convenience handler that makes it easy to follow the rules for protocol negotiation.
ProtocolNegotiators.ProxyProtocolNegotiationHandler	A Proxy handler follows ProtocolNegotiators.ProtocolNegotiationHandler pattern.
ProtocolNegotiators.ServerTlsHandler
ProtocolNegotiators.TlsProtocolNegotiatorClientFactory
ProtocolNegotiators.TlsProtocolNegotiatorServerFactory
ProtocolNegotiators.WaitUntilActiveHandler	Waits for the channel to be active, and then installs the next Handler.
SendGrpcFrameCommand	Command sent from the transport to the Netty channel to send a GRPC frame to the remote endpoint.
SendPingCommand	Command sent from the transport to the Netty channel to send a PING frame.
SendResponseHeadersCommand	Command sent from the transport to the Netty channel to send response headers to the client.
UdsNameResolver
UdsNameResolverProvider
UdsNettyChannelProvider	Provider for NettyChannelBuilder instances for UDS channels.
UnhelpfulSecurityProvider	A stand-in provider when you must provide a provider but you don't actually have one.
Utils	Common utility methods.
Utils.ByteBufAllocatorPreferDirectHolder
Utils.ByteBufAllocatorPreferHeapHolder
Utils.DefaultEventLoopGroupResource
Utils.FlowControlReader
WriteBufferingAndExceptionHandler	Buffers all writes until either WriteBufferingAndExceptionHandler.writeBufferedAndRemove(ChannelHandlerContext) or WriteBufferingAndExceptionHandler.failWrites(Throwable) is called.
WriteBufferingAndExceptionHandler.ChannelWrite
WriteQueue	A queue of pending writes to a Channel that is flushed as a single unit.
WriteQueue.AbstractQueuedCommand
WriteQueue.RunnableCommand

Enum Summary

Enum	Description
CancelServerStreamCommand.PeerNotify
NegotiationType	Identifies the negotiation used for starting up HTTP/2.
Utils.EventLoopGroupType