Package io.grpc.internal

@Internal package io.grpc.internal

Interfaces and implementations that are internal to gRPC.

All the content under this package and its subpackages are considered annotated with Internal.

Related Packages

Package	Description
io.grpc	The gRPC core public API.
io.grpc.inprocess	The in-process transport which is for when a server is in the same process as the client.
io.grpc.netty	The main transport implementation based on Netty, for both the client and the server.
io.grpc.protobuf	API for gRPC over Protocol Buffers, including tools for serializing and de-serializing protobuf messages.
io.grpc.stub	API for the Stub layer.
io.grpc.util	Utilities with advanced features in the core layer that user can optionally use.

Class	Description
AbstractClientStream	The abstract base class for ClientStream implementations.
AbstractClientStream.Sink	A sink for outbound operations, separated from the stream simply to avoid name collisions/confusion.
AbstractClientStream.TransportState	This should only be called from the transport thread.
AbstractReadableBuffer	Abstract base class for ReadableBuffer implementations.
AbstractServerStream	Abstract base class for ServerStream implementations.
AbstractServerStream.Sink	A sink for outbound operations, separated from the stream simply to avoid name collisions/confusion.
AbstractServerStream.TransportState	This should only be called from the transport thread (except for private interactions with AbstractServerStream).
AbstractStream	The stream and stream state as used by the application.
AbstractStream.TransportState	Stream state as used by the transport.
ApplicationThreadDeframer	Sits between AbstractStream.TransportState and MessageDeframer to deframe in the client thread.
AtomicBackoff	A long atomically updated due to errors caused by the value being too small.
AutoConfiguredLoadBalancerFactory
BackoffPolicy	Determines how long to wait before doing some action (typically a retry, or a reconnect).
BackoffPolicy.Provider
ClientStream	Extension of Stream to support client-side termination semantics.
ClientStreamListener	An observer of client-side stream events.
ClientStreamListener.RpcProgress	The progress of the RPC when client stream listener is closed.
ClientTransport	The client-side transport typically encapsulating a single connection to a remote server.
ClientTransport.PingCallback	A callback that is invoked when the acknowledgement to a ClientTransport.ping(io.grpc.internal.ClientTransport.PingCallback, java.util.concurrent.Executor) is received.
ClientTransportFactory	Pre-configured factory for creating ConnectionClientTransport instances.
ClientTransportFactory.ClientTransportOptions	Options passed to ClientTransportFactory.newClientTransport(java.net.SocketAddress, io.grpc.internal.ClientTransportFactory.ClientTransportOptions, io.grpc.ChannelLogger).
ClientTransportFactory.SwapChannelCredentialsResult
CompositeReadableBuffer	A ReadableBuffer that is composed of 0 or more ReadableBuffers.
ConnectionClientTransport	A ManagedClientTransport that is based on a connection.
ConscryptLoader	Utility to load dynamically Conscrypt when it is available.
Deframer	Interface for deframing gRPC messages.
DelayedClientCall<ReqT,RespT>	A call that queues requests before a real call is ready to be delegated to.
DnsNameResolver	A DNS-based NameResolver.
DnsNameResolver.AddressResolver	AddressResolver resolves a hostname into a list of addresses.
DnsNameResolver.InternalResolutionResult	Used as a DNS-based name resolver's internal representation of resolution result.
DnsNameResolver.ResourceResolver	DnsNameResolver.ResourceResolver is a Dns ResourceRecord resolver.
DnsNameResolver.SrvRecord	Describes a parsed SRV record.
DnsNameResolverProvider	A provider for DnsNameResolver.
ExponentialBackoffPolicy	Retry Policy for Transport reconnection.
ExponentialBackoffPolicy.Provider
FailingClientStream	An implementation of ClientStream that fails (by calling ClientStreamListener.closed(io.grpc.Status, io.grpc.internal.ClientStreamListener.RpcProgress, io.grpc.Metadata)) when started, and silently does nothing for the other operations.
FixedObjectPool<T>	An object pool that always returns the same instance and does nothing when returning the object.
ForwardingClientStreamTracer
ForwardingReadableBuffer	Base class for a wrapper around another ReadableBuffer.
Framer	Interface for framing gRPC messages.
GrpcAttributes	Special attributes that are only useful to gRPC.
GrpcUtil	Common utilities for GRPC.
GrpcUtil.AuthorityEscaper	Percent encode the authority based on https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.
GrpcUtil.GrpcBuildVersion
GrpcUtil.Http2Error	All error codes identified by the HTTP/2 spec.
Http2ClientStreamTransportState	Base implementation for client streams using HTTP2 as the transport.
Http2Ping	Represents an outstanding PING operation on an HTTP/2 channel.
InsightBuilder	Builds a concise and readable string that gives insight of the concerned part of the system.
InternalServer	An object that accepts new incoming connections on one or more listening socket addresses.
InUseStateAggregator<T>	Aggregates the in-use state of a set of objects.
JsonParser	Parses JSON with as few preconceived notions as possible.
JsonUtil	Helper utility to work with JSON values in Java types.
KeepAliveEnforcer	Monitors the client's PING usage to make sure the rate is permitted.
KeepAliveManager	Manages keepalive pings.
KeepAliveManager.ClientKeepAlivePinger	Default client side KeepAliveManager.KeepAlivePinger.
KeepAliveManager.KeepAlivePinger
LogExceptionRunnable	A simple wrapper for a Runnable that logs any exception thrown by it, before re-throwing it.
LongCounter	An interface for a long base counter.
ManagedChannelImplBuilder	Default managed channel builder, for usage in Transport implementations.
ManagedChannelImplBuilder.ChannelBuilderDefaultPortProvider	An interface for Transport implementors to provide a default port to NameResolver for use in cases where the target string doesn't include a port.
ManagedChannelImplBuilder.ClientTransportFactoryBuilder	An interface for Transport implementors to provide the ClientTransportFactory appropriate for the channel.
ManagedChannelImplBuilder.FixedPortProvider	Default implementation of ManagedChannelImplBuilder.ChannelBuilderDefaultPortProvider that returns a fixed port.
ManagedChannelImplBuilder.UnsupportedClientTransportFactoryBuilder	Convenience ClientTransportFactoryBuilder, throws UnsupportedOperationException().
ManagedClientTransport	A ClientTransport that has life-cycle management.
ManagedClientTransport.Listener	Receives notifications for the transport life-cycle events.
MaxConnectionIdleManager	Monitors connection idle time; shutdowns the connection if the max connection idle is reached.
MaxConnectionIdleManager.Ticker
MessageDeframer	Deframer for GRPC frames.
MessageDeframer.Listener	A listener of deframing events.
MessageFramer	Encodes gRPC messages to be delivered via the transport layer which implements MessageFramer.Sink.
MessageFramer.Sink	Sink implemented by the transport layer to receive frames and forward them to their destination.
NameResolverFactoryToProviderFacade
NoopClientStream	An implementation of ClientStream that silently does nothing for the operations.
ObjectPool<T>	An object pool.
PickFirstLoadBalancerProvider	Provider for the "pick_first" balancing policy.
PickSubchannelArgsImpl	Implementation of LoadBalancer.PickSubchannelArgs.
ReadableBuffer	Interface for an abstract byte buffer.
ReadableBuffers	Utility methods for creating ReadableBuffer instances.
ReflectionLongAdderCounter	A LongCounter that is implemented with a JDK8 invalid reference LongAdder .
RetryScheduler	This interface is used to schedule future retry attempts for a failed operation.
ScParser	The library built-in implementation of service config parser.
SerializingExecutor	Executor ensuring that all Runnable tasks submitted are executed in order using the provided Executor, and serially such that no two will ever be running at the same time.
ServerImpl	Default implementation of Server, for creation by transports.
ServerImplBuilder	Default builder for Server instances, for usage in Transport implementations.
ServerImplBuilder.ClientTransportServersBuilder	An interface to provide to provide transport specific information for the server.
ServerListener	A listener to a server for transport creation events.
ServerStream	Extension of Stream to support server-side termination semantics.
ServerStreamListener	An observer of server-side stream events.
ServerTransport	An inbound connection.
ServerTransportListener	A observer of a server-side transport for stream creation events.
ServiceConfigUtil	Helper utility to work with service configs.
ServiceConfigUtil.LbConfig	A LoadBalancingConfig that includes the policy name (the key) and its raw config value (parsed JSON).
ServiceConfigUtil.PolicySelection
SharedResourceHolder	A holder for shared resource singletons.
SharedResourceHolder.Resource<T>	Defines a resource, and the way to create and destroy instances of it.
SharedResourcePool<T>	An ObjectPool backed by a SharedResourceHolder.Resource.
SpiffeUtil	Provides utilities to manage SPIFFE bundles, extract SPIFFE IDs from X.509 certificate chains, and parse SPIFFE IDs.
SpiffeUtil.SpiffeBundle	Represents a SPIFFE trust bundle; that is, a map from trust domain to set of trusted certificates.
SpiffeUtil.SpiffeId	Represents a SPIFFE ID as defined in the SPIFFE standard.
StatsTraceContext	The stats and tracing information for a stream.
Stream	A single stream of communication between two end-points within a transport.
StreamListener	An observer of Stream events.
StreamListener.MessageProducer	A producer for deframed gRPC messages.
ThreadOptimizedDeframer	A Deframer that optimizations by taking over part of the thread safety.
TimeProvider	Time source representing the current system time in nanos.
TransportFrameUtil	Utility functions for transport layer framing.
TransportTracer	A class for gathering statistics about a transport.
TransportTracer.Factory
TransportTracer.FlowControlReader	An interface for reading the local and remote flow control windows of the transport.
TransportTracer.FlowControlWindows	A container that holds the local and remote flow control window sizes.
WritableBuffer	An interface for a byte buffer that can only be written to.
WritableBufferAllocator	An allocator of buffers provided by the transport implementation to MessageFramer so it can send chunks of data to the transport in a form that the transport can directly serialize.