Skip navigation links
A B C D E F G H I K L M N O P R S T U V W 

A

ABORTED - Static variable in class io.grpc.Status
The operation was aborted, typically due to a concurrency issue like sequencer check failures, transaction aborts, etc.
AbstractAsyncStub<S extends AbstractAsyncStub<S>> - Class in io.grpc.stub
Stub implementations for async stubs.
AbstractAsyncStub(Channel, CallOptions) - Constructor for class io.grpc.stub.AbstractAsyncStub
 
AbstractBlockingStub<S extends AbstractBlockingStub<S>> - Class in io.grpc.stub
Stub implementations for blocking stubs.
AbstractBlockingStub(Channel, CallOptions) - Constructor for class io.grpc.stub.AbstractBlockingStub
 
AbstractFutureStub<S extends AbstractFutureStub<S>> - Class in io.grpc.stub
Stub implementations for future stubs.
AbstractFutureStub(Channel, CallOptions) - Constructor for class io.grpc.stub.AbstractFutureStub
 
AbstractStub<S extends AbstractStub<S>> - Class in io.grpc.stub
Common base type for stub implementations.
AbstractStub(Channel) - Constructor for class io.grpc.stub.AbstractStub
Constructor for use by subclasses, with the default CallOptions.
AbstractStub(Channel, CallOptions) - Constructor for class io.grpc.stub.AbstractStub
Constructor for use by subclasses.
AbstractStub.StubFactory<T extends AbstractStub<T>> - Interface in io.grpc.stub
A factory class for stub.
addListenAddress(SocketAddress) - Method in class io.grpc.netty.NettyServerBuilder
Adds an additional address for this server to listen on.
addListener(Context.CancellationListener, Executor) - Method in class io.grpc.Context
Add a listener that will be notified when the context becomes cancelled.
addListener(Context.CancellationListener, Executor) - Method in class io.grpc.Context.CancellableContext
 
addMethod(MethodDescriptor<ReqT, RespT>, ServerCallHandler<ReqT, RespT>) - Method in class io.grpc.ServerServiceDefinition.Builder
Add a method to be supported by the service.
addMethod(ServerMethodDefinition<ReqT, RespT>) - Method in class io.grpc.ServerServiceDefinition.Builder
Add a method to be supported by the service.
addMethod(MethodDescriptor<?, ?>) - Method in class io.grpc.ServiceDescriptor.Builder
Adds a method to this service.
addOption(LoadBalancer.CreateSubchannelArgs.Key<T>, T) - Method in class io.grpc.LoadBalancer.CreateSubchannelArgs.Builder
Add a custom option.
addService(ServerServiceDefinition) - Method in class io.grpc.ServerBuilder
Adds a service implementation to the handler registry.
addService(BindableService) - Method in class io.grpc.ServerBuilder
Adds a service implementation to the handler registry.
addService(ServerServiceDefinition) - Method in class io.grpc.util.MutableHandlerRegistry
Registers a service.
addService(BindableService) - Method in class io.grpc.util.MutableHandlerRegistry
Registers a service.
addStreamTracerFactory(ServerStreamTracer.Factory) - Method in class io.grpc.ServerBuilder
Adds a ServerStreamTracer.Factory to measure server-side traffic.
addTransportFilter(ServerTransportFilter) - Method in class io.grpc.ServerBuilder
after(long, TimeUnit) - Static method in class io.grpc.Deadline
Create a deadline that will expire at the specified offset based on the system ticker.
after(long, TimeUnit, Deadline.Ticker) - Static method in class io.grpc.Deadline
Create a deadline that will expire at the specified offset based on the given Deadline.Ticker.
after() - Method in class io.grpc.testing.GrpcServerRule
After the test has completed, clean up the channel and server.
ALREADY_EXISTS - Static variable in class io.grpc.Status
Some entity that we attempted to create (e.g., file or directory) already exists.
apply(Metadata) - Method in class io.grpc.CallCredentials.MetadataApplier
Called when headers are successfully generated.
apply(Statement, Description) - Method in class io.grpc.testing.GrpcCleanupRule
 
applyRequestMetadata(CallCredentials.RequestInfo, Executor, CallCredentials.MetadataApplier) - Method in class io.grpc.CallCredentials
Pass the credential data to the given CallCredentials.MetadataApplier, which will propagate it to the request metadata.
applyRequestMetadata(CallCredentials.RequestInfo, Executor, CallCredentials2.MetadataApplier) - Method in class io.grpc.CallCredentials2
Deprecated.
Pass the credential data to the given CallCredentials2.MetadataApplier, which will propagate it to the request metadata.
applyRequestMetadata(CallCredentials.RequestInfo, Executor, CallCredentials.MetadataApplier) - Method in class io.grpc.CallCredentials2
Deprecated.
 
asChannel() - Method in class io.grpc.LoadBalancer.Subchannel
(Internal use only) returns a Channel that is backed by this Subchannel.
asChannel() - Method in class io.grpc.util.ForwardingSubchannel
 
ASCII_STRING_MARSHALLER - Static variable in class io.grpc.Metadata
Simple metadata marshaller that encodes strings as is.
asException() - Method in class io.grpc.Status
Convert this Status to an Exception.
asException(Metadata) - Method in class io.grpc.Status
Same as Status.asException() but includes the provided trailers in the returned exception.
asFactory() - Static method in class io.grpc.NameResolverProvider
Deprecated.
Use NameResolverRegistry.getDefaultRegistry().asFactory()
asFactory() - Method in class io.grpc.NameResolverRegistry
 
asRuntimeException() - Method in class io.grpc.Status
Convert this Status to a RuntimeException.
asRuntimeException(Metadata) - Method in class io.grpc.Status
Same as Status.asRuntimeException() but includes the provided trailers in the returned exception.
asyncBidiStreamingCall(ClientCall<ReqT, RespT>, StreamObserver<RespT>) - Static method in class io.grpc.stub.ClientCalls
Executes a bidirectional-streaming call.
asyncBidiStreamingCall(ServerCalls.BidiStreamingMethod<ReqT, RespT>) - Static method in class io.grpc.stub.ServerCalls
Creates a ServerCallHandler for a bidi streaming method of the service.
asyncClientStreamingCall(ClientCall<ReqT, RespT>, StreamObserver<RespT>) - Static method in class io.grpc.stub.ClientCalls
Executes a client-streaming call returning a StreamObserver for the request messages.
asyncClientStreamingCall(ServerCalls.ClientStreamingMethod<ReqT, RespT>) - Static method in class io.grpc.stub.ServerCalls
Creates a ServerCallHandler for a client streaming method of the service.
asyncServerStreamingCall(ClientCall<ReqT, RespT>, ReqT, StreamObserver<RespT>) - Static method in class io.grpc.stub.ClientCalls
Executes a server-streaming call with a response StreamObserver.
asyncServerStreamingCall(ServerCalls.ServerStreamingMethod<ReqT, RespT>) - Static method in class io.grpc.stub.ServerCalls
Creates a ServerCallHandler for a server streaming method of the service.
asyncUnaryCall(ClientCall<ReqT, RespT>, ReqT, StreamObserver<RespT>) - Static method in class io.grpc.stub.ClientCalls
Executes a unary call with a response StreamObserver.
asyncUnaryCall(ServerCalls.UnaryMethod<ReqT, RespT>) - Static method in class io.grpc.stub.ServerCalls
Creates a ServerCallHandler for a unary call method of the service.
asyncUnimplementedStreamingCall(MethodDescriptor<?, ?>, StreamObserver<?>) - Static method in class io.grpc.stub.ServerCalls
Sets unimplemented status for streaming call.
asyncUnimplementedUnaryCall(MethodDescriptor<?, ?>, StreamObserver<?>) - Static method in class io.grpc.stub.ServerCalls
Sets unimplemented status for method on given response stream for unary call.
attach() - Method in class io.grpc.Context
Attach this context, thus enter a new scope within which this context is Context.current().
attach() - Method in class io.grpc.Context.CancellableContext
 
attach(Context) - Method in class io.grpc.Context.Storage
Deprecated.
This is an old API that is no longer used.
attachHeaders(T, Metadata) - Static method in class io.grpc.stub.MetadataUtils
Attaches a set of request headers to a stub.
ATTR_AUTHORITY_OVERRIDE - Static variable in class io.grpc.EquivalentAddressGroup
The authority to be used when constructing Subchannels for this EquivalentAddressGroup.
ATTR_HEALTH_CHECKING_CONFIG - Static variable in class io.grpc.LoadBalancer
 
ATTR_LB_ADDR_AUTHORITY - Static variable in class io.grpc.grpclb.GrpclbConstants
The naming authority of a gRPC LB server address.
ATTR_LB_PROVIDED_BACKEND - Static variable in class io.grpc.grpclb.GrpclbConstants
Whether this EquivalentAddressGroup was provided by a GRPCLB server.
ATTR_LOAD_BALANCING_CONFIG - Static variable in class io.grpc.LoadBalancer
Deprecated.
Attributes - Class in io.grpc
An immutable type-safe container of attributes.
Attributes.Builder - Class in io.grpc
The helper class to build an Attributes instance.
Attributes.Key<T> - Class in io.grpc
Key for an key-value pair.
augmentDescription(String) - Method in class io.grpc.Status
Create a derived instance of Status augmenting the current description with additional detail.
authority() - Method in class io.grpc.Channel
The authority of the destination this channel connects to.
available() - Method in interface io.grpc.KnownLength
Returns the total number of bytes that can be read (or skipped over) from this object until all bytes have been read out.
awaitCompletion() - Method in class io.grpc.testing.StreamRecorder
Deprecated.
Waits for the stream to terminate.
awaitCompletion(int, TimeUnit) - Method in class io.grpc.testing.StreamRecorder
Deprecated.
Waits a fixed timeout for the stream to terminate.
awaitTermination(long, TimeUnit) - Method in class io.grpc.ManagedChannel
Waits for the channel to become terminated, giving up if the timeout is reached.
awaitTermination(long, TimeUnit) - Method in class io.grpc.Server
Waits for the server to become terminated, giving up if the timeout is reached.
awaitTermination() - Method in class io.grpc.Server
Waits for the server to become terminated.

B

before() - Method in class io.grpc.testing.GrpcServerRule
Before the test has started, create the server and channel.
beforeStart(ClientCallStreamObserver<ReqT>) - Method in interface io.grpc.stub.ClientResponseObserver
Called by the runtime priot to the start of a call to provide a reference to the ClientCallStreamObserver for the outbound stream.
BINARY_BYTE_MARSHALLER - Static variable in class io.grpc.Metadata
Simple metadata marshaller that encodes bytes as is.
BINARY_HEADER_SUFFIX - Static variable in class io.grpc.Metadata
All binary headers should have this suffix in their names.
BinaryLog - Class in io.grpc
A binary log that can be installed on a channel or server.
BinaryLog() - Constructor for class io.grpc.BinaryLog
 
BinaryLogProvider - Class in io.grpc.services
 
BinaryLogProvider() - Constructor for class io.grpc.services.BinaryLogProvider
 
BinaryLogs - Class in io.grpc.services
 
BinaryLogSink - Interface in io.grpc.services
A class that accepts binary log messages.
BindableService - Interface in io.grpc
Provides a way to bind instance of service implementation to server.
bindService() - Method in interface io.grpc.BindableService
Creates ServerServiceDefinition object for current instance of service implementation.
blockingExecutor(Executor) - Method in class io.grpc.ForwardingChannelBuilder
Deprecated.
blockingExecutor(Executor) - Method in class io.grpc.ManagedChannelBuilder
Deprecated.
blockingServerStreamingCall(ClientCall<ReqT, RespT>, ReqT) - Static method in class io.grpc.stub.ClientCalls
Executes a server-streaming call returning a blocking Iterator over the response stream.
blockingServerStreamingCall(Channel, MethodDescriptor<ReqT, RespT>, CallOptions, ReqT) - Static method in class io.grpc.stub.ClientCalls
Executes a server-streaming call returning a blocking Iterator over the response stream.
blockingUnaryCall(ClientCall<ReqT, RespT>, ReqT) - Static method in class io.grpc.stub.ClientCalls
Executes a unary call and blocks on the response.
blockingUnaryCall(Channel, MethodDescriptor<ReqT, RespT>, CallOptions, ReqT) - Static method in class io.grpc.stub.ClientCalls
Executes a unary call and blocks on the response.
bossEventLoopGroup(EventLoopGroup) - Method in class io.grpc.netty.NettyServerBuilder
Provides the boss EventGroupLoop to the server.
build() - Method in class io.grpc.Attributes.Builder
Build the attributes.
build() - Method in class io.grpc.ClientStreamTracer.StreamInfo.Builder
Builds a new StreamInfo.
build() - Method in class io.grpc.ForwardingChannelBuilder
Returns the ManagedChannel built by the delegate by default.
build() - Method in class io.grpc.HttpConnectProxiedSocketAddress.Builder
Creates an HttpConnectProxiedSocketAddress.
build() - Method in class io.grpc.LoadBalancer.CreateSubchannelArgs.Builder
Creates a new args object.
build() - Method in class io.grpc.LoadBalancer.ResolvedAddresses.Builder
build() - Method in class io.grpc.ManagedChannelBuilder
Builds a channel using the given parameters.
build() - Method in class io.grpc.MethodDescriptor.Builder
Builds the method descriptor.
build() - Method in class io.grpc.NameResolver.Args.Builder
build() - Method in class io.grpc.NameResolver.ResolutionResult.Builder
Constructs a new NameResolver.ResolutionResult from this builder.
build() - Method in class io.grpc.ServerBuilder
Builds a server using the given parameters.
build() - Method in class io.grpc.ServerServiceDefinition.Builder
Construct new ServerServiceDefinition.
build() - Method in class io.grpc.ServiceDescriptor.Builder
Constructs a new ServiceDescriptor.
build(Channel, CallOptions) - Method in class io.grpc.stub.AbstractStub
Returns a new stub with the given channel for the provided method configurations.
builder(String) - Static method in class io.grpc.ServerServiceDefinition
Convenience that constructs a ServiceDescriptor simultaneously.
builder(ServiceDescriptor) - Static method in class io.grpc.ServerServiceDefinition
 
builderForAddress(String, int) - Method in class io.grpc.ManagedChannelProvider
Creates a new builder with the given host and port.
builderForAddress(String, int) - Method in class io.grpc.netty.NettyChannelProvider
 
builderForAddress(String, int) - Method in class io.grpc.okhttp.OkHttpChannelProvider
 
builderForPort(int) - Method in class io.grpc.netty.NettyServerProvider
 
builderForPort(int) - Method in class io.grpc.ServerProvider
Creates a new builder with the given port.
builderForTarget(String) - Method in class io.grpc.ManagedChannelProvider
Creates a new builder with the given target URI.
builderForTarget(String) - Method in class io.grpc.netty.NettyChannelProvider
 
builderForTarget(String) - Method in class io.grpc.okhttp.OkHttpChannelProvider
 
buildTransportFactory() - Method in class io.grpc.inprocess.InProcessChannelBuilder
 
buildTransportFactory() - Method in class io.grpc.netty.NettyChannelBuilder
 
buildTransportFactory() - Method in class io.grpc.okhttp.OkHttpChannelBuilder
 
buildTransportServers(List<? extends ServerStreamTracer.Factory>) - Method in class io.grpc.inprocess.InProcessServerBuilder
 
buildTransportServers(List<? extends ServerStreamTracer.Factory>) - Method in class io.grpc.netty.NettyServerBuilder
 
BYTEARRAY_MARSHALLER - Static variable in class io.grpc.services.BinaryLogProvider
 

C

call(Callable<V>) - Method in class io.grpc.Context
Immediately call a Callable with this context as the Context.current() context.
CallCredentials - Class in io.grpc
Carries credential data that will be propagated to the server via request metadata for each RPC.
CallCredentials() - Constructor for class io.grpc.CallCredentials
 
CallCredentials.MetadataApplier - Class in io.grpc
The outlet of the produced headers.
CallCredentials.RequestInfo - Class in io.grpc
The request-related information passed to CallCredentials.applyRequestMetadata().
CallCredentials2 - Class in io.grpc
Deprecated.
the new interface has been promoted into CallCredentials. Implementations should switch back to "extends CallCredentials".
CallCredentials2() - Constructor for class io.grpc.CallCredentials2
Deprecated.
 
CallCredentials2.MetadataApplier - Class in io.grpc
Deprecated.
 
CallMetricRecorder - Class in io.grpc.services
Utility to record call metrics for load-balancing.
CallOptions - Class in io.grpc
The collection of runtime options for a new RPC call.
CallOptions.Key<T> - Class in io.grpc
Key for a key-value pair.
CallStreamObserver<V> - Class in io.grpc.stub
A refinement of StreamObserver provided by the GRPC runtime to the application (the client or the server) that allows for more complex interactions with call behavior.
CallStreamObserver() - Constructor for class io.grpc.stub.CallStreamObserver
 
cancel(String, Throwable) - Method in class io.grpc.ClientCall
Prevent any further processing for this ClientCall.
cancel(Throwable) - Method in class io.grpc.Context.CancellableContext
Cancel this context and optionally provide a cause (can be null) for the cancellation.
cancel(String, Throwable) - Method in class io.grpc.stub.ClientCallStreamObserver
Prevent any further processing for this ClientCallStreamObserver.
cancel() - Method in class io.grpc.SynchronizationContext.ScheduledHandle
Cancel the task if it's still pending.
cancellationCause() - Method in class io.grpc.Context.CancellableContext
 
cancellationCause() - Method in class io.grpc.Context
If a context Context.isCancelled() then return the cause of the cancellation or null if context was cancelled without a cause.
cancelled(Context) - Method in interface io.grpc.Context.CancellationListener
 
CANCELLED - Static variable in class io.grpc.Status
The operation was cancelled (typically by the caller).
canHandleEmptyAddressListFromNameResolution() - Method in class io.grpc.LoadBalancer
Whether this LoadBalancer can handle empty address group list to be passed to LoadBalancer.handleResolvedAddresses(ResolvedAddresses).
canHandleEmptyAddressListFromNameResolution() - Method in class io.grpc.util.ForwardingLoadBalancer
 
captureMetadata(T, AtomicReference<Metadata>, AtomicReference<Metadata>) - Static method in class io.grpc.stub.MetadataUtils
Captures the last received metadata for a stub.
Channel - Class in io.grpc
A virtual connection to a conceptual endpoint, to perform RPCs.
Channel() - Constructor for class io.grpc.Channel
 
channelFactory(ChannelFactory<? extends Channel>) - Method in class io.grpc.netty.NettyChannelBuilder
Specifies the ChannelFactory to create Channel instances.
channelFactory(ChannelFactory<? extends ServerChannel>) - Method in class io.grpc.netty.NettyServerBuilder
Specifies the ChannelFactory to create ServerChannel instances.
ChannelLogger - Class in io.grpc
A Channel-specific logger provided by GRPC library to LoadBalancer implementations.
ChannelLogger() - Constructor for class io.grpc.ChannelLogger
 
ChannelLogger.ChannelLogLevel - Enum in io.grpc
Log levels.
channelType(Class<? extends Channel>) - Method in class io.grpc.netty.NettyChannelBuilder
Specifies the channel type to use, by default we use EpollSocketChannel if available, otherwise using NioSocketChannel.
channelType(Class<? extends ServerChannel>) - Method in class io.grpc.netty.NettyServerBuilder
Specifies the channel type to use, by default we use EpollServerSocketChannel if available, otherwise using NioServerSocketChannel.
channelUnused - Variable in class io.grpc.netty.GrpcHttp2ConnectionHandler
 
ChannelzService - Class in io.grpc.services
The channelz service provides stats about a running gRPC process.
checkAuthority(String) - Method in class io.grpc.netty.NettyChannelBuilder
 
CheckedForwardingClientCall(ClientCall<ReqT, RespT>) - Constructor for class io.grpc.ClientInterceptors.CheckedForwardingClientCall
 
checkedStart(ClientCall.Listener<RespT>, Metadata) - Method in class io.grpc.ClientInterceptors.CheckedForwardingClientCall
Subclasses implement the start logic here that would normally belong to start().
clearStatus(String) - Method in class io.grpc.services.HealthStatusManager
Clears the health status record of a service.
ClientAuthInterceptor - Class in io.grpc.auth
Deprecated.
ClientAuthInterceptor(Credentials, Executor) - Constructor for class io.grpc.auth.ClientAuthInterceptor
Deprecated.
 
ClientCall<ReqT,RespT> - Class in io.grpc
An instance of a call to a remote method.
ClientCall() - Constructor for class io.grpc.ClientCall
 
ClientCall.Listener<T> - Class in io.grpc
Callbacks for receiving metadata, response messages and completion status from the server.
ClientCalls - Class in io.grpc.stub
Utility functions for processing different call idioms.
ClientCallStreamObserver<V> - Class in io.grpc.stub
A refinement of CallStreamObserver that allows for lower-level interaction with client calls.
ClientCallStreamObserver() - Constructor for class io.grpc.stub.ClientCallStreamObserver
 
ClientInterceptor - Interface in io.grpc
Interface for intercepting outgoing calls before they are dispatched by a Channel.
ClientInterceptors - Class in io.grpc
Utility methods for working with ClientInterceptors.
ClientInterceptors.CheckedForwardingClientCall<ReqT,RespT> - Class in io.grpc
A ForwardingClientCall that delivers exceptions from its start logic to the call listener.
ClientResponseObserver<ReqT,RespT> - Interface in io.grpc.stub
Specialization of StreamObserver implemented by clients in order to interact with the advanced features of a call such as flow-control.
clientSendsOneMessage() - Method in enum io.grpc.MethodDescriptor.MethodType
Returns true for UNARY and SERVER_STREAMING, which do not permit the client to stream.
ClientStreamTracer - Class in io.grpc
StreamTracer for the client-side.
ClientStreamTracer() - Constructor for class io.grpc.ClientStreamTracer
 
ClientStreamTracer.Factory - Class in io.grpc
Factory class for ClientStreamTracer.
ClientStreamTracer.StreamInfo - Class in io.grpc
Information about a stream.
ClientStreamTracer.StreamInfo.Builder - Class in io.grpc
close() - Method in class io.grpc.Context.CancellableContext
Cleans up this object by calling cancel(null).
close(Status, Metadata) - Method in class io.grpc.ServerCall
Close the call with the provided status.
close() - Method in class io.grpc.services.BinaryLogProvider
 
Codec - Interface in io.grpc
Encloses classes related to the compression and decompression of messages.
Codec.Gzip - Class in io.grpc
A gzip compressor and decompressor.
Codec.Identity - Class in io.grpc
The "identity", or "none" codec.
compareTo(Deadline) - Method in class io.grpc.Deadline
compress(OutputStream) - Method in class io.grpc.Codec.Gzip
 
compress(OutputStream) - Method in class io.grpc.Codec.Identity
 
compress(OutputStream) - Method in interface io.grpc.Compressor
Wraps an existing output stream with a compressing output stream.
Compressor - Interface in io.grpc
Represents a message compressor.
CompressorRegistry - Class in io.grpc
Encloses classes related to the compression and decompression of messages.
compressorRegistry(CompressorRegistry) - Method in class io.grpc.ForwardingChannelBuilder
 
compressorRegistry(CompressorRegistry) - Method in class io.grpc.ManagedChannelBuilder
Set the compression registry for use in the channel.
compressorRegistry(CompressorRegistry) - Method in class io.grpc.ServerBuilder
Set the compression registry for use in the channel.
configure(SslContextBuilder) - Static method in class io.grpc.netty.GrpcSslContexts
Set ciphers and APN appropriate for gRPC.
configure(SslContextBuilder, SslProvider) - Static method in class io.grpc.netty.GrpcSslContexts
Set ciphers and APN appropriate for gRPC.
configure(SslContextBuilder, Provider) - Static method in class io.grpc.netty.GrpcSslContexts
Set ciphers and APN appropriate for gRPC.
connectionSpec(ConnectionSpec) - Method in class io.grpc.okhttp.OkHttpChannelBuilder
For secure connection, provides a ConnectionSpec to specify Cipher suite and TLS versions.
ConnectivityState - Enum in io.grpc
The connectivity states.
ConnectivityStateInfo - Class in io.grpc
A tuple of a ConnectivityState and its associated Status.
containsKey(Metadata.Key<?>) - Method in class io.grpc.Metadata
Returns true if a value is defined for the given key.
Context - Class in io.grpc
A context propagation mechanism which can carry scoped-values across API boundaries and between threads.
Context.CancellableContext - Class in io.grpc
A context which inherits cancellation from its parent but which can also be independently cancelled and which will propagate cancellation to its descendants.
Context.CancellationListener - Interface in io.grpc
A listener notified on context cancellation.
Context.Key<T> - Class in io.grpc
Key for indexing values stored in a context.
Context.Storage - Class in io.grpc
Defines the mechanisms for attaching and detaching the "current" context.
Contexts - Class in io.grpc
Utility methods for working with Contexts in GRPC.
copyWithFlowControl(Iterator<V>, CallStreamObserver<V>) - Static method in class io.grpc.stub.StreamObservers
Copy the values of an Iterator to the target CallStreamObserver while properly accounting for outbound flow-control.
copyWithFlowControl(Iterable<V>, CallStreamObserver<V>) - Static method in class io.grpc.stub.StreamObservers
Copy the values of an Iterable to the target CallStreamObserver while properly accounting for outbound flow-control.
create(String) - Static method in class io.grpc.Attributes.Key
Factory method for creating instances of Attributes.Key.
create(String) - Static method in class io.grpc.CallOptions.Key
Factory method for creating instances of CallOptions.Key.
create(String) - Static method in class io.grpc.LoadBalancer.CreateSubchannelArgs.Key
Factory method for creating instances of LoadBalancer.CreateSubchannelArgs.Key.
create(MethodDescriptor.MethodType, String, MethodDescriptor.Marshaller<RequestT>, MethodDescriptor.Marshaller<ResponseT>) - Static method in class io.grpc.MethodDescriptor
create(MethodDescriptor<ReqT, RespT>, ServerCallHandler<ReqT, RespT>) - Static method in class io.grpc.ServerMethodDefinition
Create a new instance.
create() - Static method in class io.grpc.testing.StreamRecorder
Deprecated.
Creates a new recorder.
createBinaryLog() - Static method in class io.grpc.services.BinaryLogs
Creates a binary log that writes to a temp file.
createBinaryLog(BinaryLogSink) - Static method in class io.grpc.services.BinaryLogs
Deprecated.
createBinaryLog(BinaryLogSink, String) - Static method in class io.grpc.services.BinaryLogs
Creates a binary log with a custom BinaryLogSink for receiving the logged data, and a config string as defined by A16-binary-logging.
createOobChannel(EquivalentAddressGroup, String) - Method in class io.grpc.LoadBalancer.Helper
Out-of-band channel for LoadBalancer’s own RPC needs, e.g., talking to an external load-balancer service.
createOobChannel(EquivalentAddressGroup, String) - Method in class io.grpc.util.ForwardingLoadBalancerHelper
 
createResolvingOobChannel(String) - Method in class io.grpc.LoadBalancer.Helper
Creates an out-of-band channel for LoadBalancer's own RPC needs, e.g., talking to an external load-balancer service, that is specified by a target string.
createResolvingOobChannel(String) - Method in class io.grpc.util.ForwardingLoadBalancerHelper
 
createResolvingOobChannelBuilder(String) - Method in class io.grpc.LoadBalancer.Helper
Creates an out-of-band channel builder for LoadBalancer's own RPC needs, e.g., talking to an external load-balancer service, that is specified by a target string.
createResolvingOobChannelBuilder(String) - Method in class io.grpc.util.ForwardingLoadBalancerHelper
 
createSocketAddress(SocketAddress, Attributes) - Method in class io.grpc.netty.NettyChannelBuilder.LocalSocketPicker
Called by gRPC to pick local socket to bind to.
createSubchannel(EquivalentAddressGroup, Attributes) - Method in class io.grpc.LoadBalancer.Helper
createSubchannel(List<EquivalentAddressGroup>, Attributes) - Method in class io.grpc.LoadBalancer.Helper
createSubchannel(LoadBalancer.CreateSubchannelArgs) - Method in class io.grpc.LoadBalancer.Helper
Creates a Subchannel, which is a logical connection to the given group of addresses which are considered equivalent.
createSubchannel(List<EquivalentAddressGroup>, Attributes) - Method in class io.grpc.util.ForwardingLoadBalancerHelper
Deprecated.
createSubchannel(LoadBalancer.CreateSubchannelArgs) - Method in class io.grpc.util.ForwardingLoadBalancerHelper
 
createWithDefault(String, T) - Static method in class io.grpc.CallOptions.Key
Factory method for creating instances of CallOptions.Key.
createWithDefault(String, T) - Static method in class io.grpc.LoadBalancer.CreateSubchannelArgs.Key
Factory method for creating instances of LoadBalancer.CreateSubchannelArgs.Key.
current() - Static method in class io.grpc.Context
Return the context associated with the current scope, will never return null.
current() - Method in class io.grpc.Context.Storage
Implements Context.current().
currentContextExecutor(Executor) - Static method in class io.grpc.Context
Create an executor that propagates the Context.current() context when Executor.execute(java.lang.Runnable) is called as the Context.current() context of the Runnable scheduled.

D

DATA_LOSS - Static variable in class io.grpc.Status
Unrecoverable data loss or corruption.
Deadline - Class in io.grpc
An absolute point in time, generally for tracking when a task should be completed.
Deadline.Ticker - Class in io.grpc
Time source representing nanoseconds since fixed but arbitrary point in time.
DEADLINE_EXCEEDED - Static variable in class io.grpc.Status
Deadline expired before operation could complete.
deadlineTicker(Deadline.Ticker) - Method in class io.grpc.inprocess.InProcessServerBuilder
Provides a custom deadline ticker that this server will use to create incoming Deadlines.
decompress(InputStream) - Method in class io.grpc.Codec.Gzip
 
decompress(InputStream) - Method in class io.grpc.Codec.Identity
 
decompress(InputStream) - Method in interface io.grpc.Decompressor
Wraps an existing input stream with a decompressing input stream.
Decompressor - Interface in io.grpc
Represents a message decompressor.
DecompressorRegistry - Class in io.grpc
Encloses classes related to the compression and decompression of messages.
decompressorRegistry(DecompressorRegistry) - Method in class io.grpc.ForwardingChannelBuilder
 
decompressorRegistry(DecompressorRegistry) - Method in class io.grpc.ManagedChannelBuilder
Set the decompression registry for use in the channel.
decompressorRegistry(DecompressorRegistry) - Method in class io.grpc.ServerBuilder
Set the decompression registry for use in the channel.
DEFAULT - Static variable in class io.grpc.CallOptions
A blank CallOptions that all fields are not set.
DEFAULT_FLOW_CONTROL_WINDOW - Static variable in class io.grpc.netty.NettyChannelBuilder
 
DEFAULT_FLOW_CONTROL_WINDOW - Static variable in class io.grpc.netty.NettyServerBuilder
 
DEFAULT_FLOW_CONTROL_WINDOW - Static variable in class io.grpc.okhttp.OkHttpChannelBuilder
 
defaultLoadBalancingPolicy(String) - Method in class io.grpc.ForwardingChannelBuilder
 
defaultLoadBalancingPolicy(String) - Method in class io.grpc.ManagedChannelBuilder
Sets the default load-balancing policy that will be used if the service config doesn't specify one.
defaultServiceConfig(Map<String, ?>) - Method in class io.grpc.ForwardingChannelBuilder
 
defaultServiceConfig(Map<String, ?>) - Method in class io.grpc.ManagedChannelBuilder
Provides a service config to the channel.
delegate() - Method in class io.grpc.ClientInterceptors.CheckedForwardingClientCall
 
delegate() - Method in class io.grpc.ForwardingChannelBuilder
Returns the delegated ManagedChannelBuilder.
delegate() - Method in class io.grpc.ForwardingClientCall
Returns the delegated ClientCall.
delegate() - Method in class io.grpc.ForwardingClientCall.SimpleForwardingClientCall
 
delegate() - Method in class io.grpc.ForwardingClientCallListener
Returns the delegated ClientCall.Listener.
delegate() - Method in class io.grpc.ForwardingClientCallListener.SimpleForwardingClientCallListener
 
delegate() - Method in class io.grpc.ForwardingServerCall
Returns the delegated ServerCall.
delegate() - Method in class io.grpc.ForwardingServerCall.SimpleForwardingServerCall
 
delegate() - Method in class io.grpc.ForwardingServerCallListener
Returns the delegated ServerCall.Listener.
delegate() - Method in class io.grpc.ForwardingServerCallListener.SimpleForwardingServerCallListener
 
delegate() - Method in class io.grpc.util.ForwardingClientStreamTracer
Returns the underlying ClientStreamTracer.
delegate() - Method in class io.grpc.util.ForwardingLoadBalancer
Returns the underlying balancer.
delegate() - Method in class io.grpc.util.ForwardingLoadBalancerHelper
Returns the underlying helper.
delegate() - Method in class io.grpc.util.ForwardingSubchannel
Returns the underlying Subchannel.
delegate() - Method in class io.grpc.util.GracefulSwitchLoadBalancer
 
deregister(LoadBalancerProvider) - Method in class io.grpc.LoadBalancerRegistry
Deregisters a provider.
deregister(NameResolverProvider) - Method in class io.grpc.NameResolverRegistry
Deregisters a provider.
detach(Context) - Method in class io.grpc.Context.CancellableContext
 
detach(Context) - Method in class io.grpc.Context
Reverse an attach(), restoring the previous context and exiting the current scope.
detach(Context, Context) - Method in class io.grpc.Context.Storage
detachAndCancel(Context, Throwable) - Method in class io.grpc.Context.CancellableContext
Cancel this context and detach it as the current context.
directExecutor() - Method in class io.grpc.ForwardingChannelBuilder
 
directExecutor() - Method in class io.grpc.ManagedChannelBuilder
Execute application code directly in the transport thread.
directExecutor() - Method in class io.grpc.ServerBuilder
Execute application code directly in the transport thread.
directExecutor() - Method in class io.grpc.testing.GrpcServerRule
Returns this configured to use a direct executor for the ManagedChannel and Server.
disableAutoInboundFlowControl() - Method in class io.grpc.stub.CallStreamObserver
Disables automatic flow control where a token is returned to the peer after a call to the 'inbound' StreamObserver.onNext(Object) has completed.
disableAutoRequest() - Method in class io.grpc.stub.ServerCallStreamObserver
Swaps to manual flow control where no message will be delivered to StreamObserver.onNext(Object) unless it is request()ed.
disableAutoRequestWithInitial(int) - Method in class io.grpc.stub.ClientCallStreamObserver
Swaps to manual flow control where no message will be delivered to StreamObserver.onNext(Object) unless it is request()ed.
disableRetry() - Method in class io.grpc.ForwardingChannelBuilder
 
disableRetry() - Method in class io.grpc.ManagedChannelBuilder
Disables the retry and hedging mechanism provided by the gRPC library.
disableServiceConfigLookUp() - Method in class io.grpc.ForwardingChannelBuilder
 
disableServiceConfigLookUp() - Method in class io.grpc.ManagedChannelBuilder
Disables service config look-up from the naming system, which is enabled by default.
discard(Attributes.Key<T>) - Method in class io.grpc.Attributes.Builder
Removes the key and associated value from the attribtues.
discardAll(Metadata.Key<T>) - Method in class io.grpc.Metadata
Remove all values for the given key without returning them.
doAttach(Context) - Method in class io.grpc.Context.Storage
Implements Context.attach().
drain() - Method in class io.grpc.SynchronizationContext
Run all tasks in the queue in the current thread, if no other thread is running this method.
Drainable - Interface in io.grpc
Extension to an InputStream or alike by adding a method that transfers all content to an OutputStream.
drainTo(OutputStream) - Method in interface io.grpc.Drainable
Transfers the entire contents of this stream to the specified target.

E

EMPTY - Static variable in class io.grpc.Attributes
 
emptyInstance() - Static method in class io.grpc.DecompressorRegistry
 
enableFullStreamDecompression() - Method in class io.grpc.ForwardingChannelBuilder
 
enableFullStreamDecompression() - Method in class io.grpc.ManagedChannelBuilder
Enables full-stream decompression of inbound streams.
enableRetry() - Method in class io.grpc.ForwardingChannelBuilder
 
enableRetry() - Method in class io.grpc.ManagedChannelBuilder
Enables the retry and hedging mechanism provided by the gRPC library.
enterIdle() - Method in class io.grpc.ManagedChannel
Invoking this method moves the channel into the IDLE state and triggers tear-down of the channel's name resolver and load balancer, while still allowing on-going RPCs on the channel to continue.
enterTerminalState() - Method in class io.grpc.services.HealthStatusManager
enterTerminalState causes the health status manager to mark all services as not serving, and prevents future updates to services.
equals(Object) - Method in class io.grpc.Attributes
Returns true if the given object is also a Attributes with an equal attribute values.
equals(Object) - Method in class io.grpc.ConnectivityStateInfo
 
equals(Object) - Method in class io.grpc.Deadline
 
equals(Object) - Method in class io.grpc.EquivalentAddressGroup
Returns true if the given object is also an EquivalentAddressGroup with an equal address list and equal attribute values.
equals(Object) - Method in class io.grpc.HttpConnectProxiedSocketAddress
 
equals(Object) - Method in class io.grpc.inprocess.InProcessSocketAddress
 
equals(Object) - Method in class io.grpc.LoadBalancer.PickResult
Returns true if the LoadBalancer.Subchannel, Status, and ClientStreamTracer.Factory all match.
equals(Object) - Method in class io.grpc.LoadBalancer.ResolvedAddresses
 
equals(Object) - Method in class io.grpc.LoadBalancerProvider
Uses identity equality.
equals(Object) - Method in class io.grpc.Metadata.Key
Returns true if the two objects are both Keys, and their names match (case insensitive).
equals(Object) - Method in class io.grpc.NameResolver.ConfigOrError
 
equals(Object) - Method in class io.grpc.NameResolver.ResolutionResult
Useful for testing.
equals(Object) - Method in class io.grpc.netty.ProtocolNegotiationEvent
 
equals(Object) - Method in class io.grpc.Status
Equality on Statuses is not well defined.
EquivalentAddressGroup - Class in io.grpc
A group of SocketAddresses that are considered equivalent when channel makes connections.
EquivalentAddressGroup(List<SocketAddress>) - Constructor for class io.grpc.EquivalentAddressGroup
List constructor without Attributes.
EquivalentAddressGroup(List<SocketAddress>, Attributes) - Constructor for class io.grpc.EquivalentAddressGroup
List constructor with Attributes.
EquivalentAddressGroup(SocketAddress) - Constructor for class io.grpc.EquivalentAddressGroup
Singleton constructor without Attributes.
EquivalentAddressGroup(SocketAddress, Attributes) - Constructor for class io.grpc.EquivalentAddressGroup
Singleton constructor with Attributes.
EquivalentAddressGroup.Attr - Annotation Type in io.grpc
Annotation for EquivalentAddressGroup's attributes.
eventLoopGroup(EventLoopGroup) - Method in class io.grpc.netty.NettyChannelBuilder
Provides an EventGroupLoop to be used by the netty transport.
execute(Runnable) - Method in class io.grpc.SynchronizationContext
Adds a task and run it in this synchronization context as soon as possible.
executeLater(Runnable) - Method in class io.grpc.SynchronizationContext
Adds a task that will be run when SynchronizationContext.drain() is called.
executor(Executor) - Method in class io.grpc.ForwardingChannelBuilder
 
executor(Executor) - Method in class io.grpc.ManagedChannelBuilder
Provides a custom executor.
executor(Executor) - Method in class io.grpc.ServerBuilder
Provides a custom executor.
ExperimentalApi - Annotation Type in io.grpc
Indicates a public API that can change at any time, and has no guarantee of API stability and backward-compatibility.
extractFullServiceName(String) - Static method in class io.grpc.MethodDescriptor
Extract the fully qualified service name out of a fully qualified method name.

F

Factory() - Constructor for class io.grpc.ClientStreamTracer.Factory
 
Factory() - Constructor for class io.grpc.LoadBalancer.Factory
 
Factory() - Constructor for class io.grpc.NameResolver.Factory
 
Factory() - Constructor for class io.grpc.ServerStreamTracer.Factory
 
fail(Status) - Method in class io.grpc.CallCredentials.MetadataApplier
Called when there has been an error when preparing the headers.
FAILED_PRECONDITION - Static variable in class io.grpc.Status
Operation was rejected because the system is not in a state required for the operation's execution.
fallbackHandlerRegistry(HandlerRegistry) - Method in class io.grpc.ServerBuilder
Sets a fallback handler registry that will be looked up in if a method is not found in the primary registry.
fillInStackTrace() - Method in exception io.grpc.StatusException
 
fillInStackTrace() - Method in exception io.grpc.StatusRuntimeException
 
filterContext(Context) - Method in class io.grpc.ServerStreamTracer
Called before the interceptors and the call handlers and make changes to the Context object if needed.
firstValue() - Method in class io.grpc.testing.StreamRecorder
Deprecated.
Returns a ListenableFuture for the first value received from the stream.
fixedContextExecutor(Executor) - Method in class io.grpc.Context
Wrap an Executor so that it always executes with this context as the Context.current() context.
flowControlWindow(int) - Method in class io.grpc.netty.NettyChannelBuilder
Sets the flow control window in bytes.
flowControlWindow(int) - Method in class io.grpc.netty.NettyServerBuilder
Sets the flow control window in bytes.
flowControlWindow(int) - Method in class io.grpc.okhttp.OkHttpChannelBuilder
Sets the flow control window in bytes.
forAddress(String, int) - Static method in class io.grpc.ForwardingChannelBuilder
This method serves to force sub classes to "hide" this static factory.
forAddress(String, int) - Static method in class io.grpc.inprocess.InProcessChannelBuilder
Always fails.
forAddress(String, int) - Static method in class io.grpc.ManagedChannelBuilder
Creates a channel with the target's address and port number.
forAddress(SocketAddress) - Static method in class io.grpc.netty.NettyChannelBuilder
Creates a new builder with the given server address.
forAddress(String, int) - Static method in class io.grpc.netty.NettyChannelBuilder
Creates a new builder with the given host and port.
forAddress(SocketAddress) - Static method in class io.grpc.netty.NettyServerBuilder
Creates a server builder configured with the given SocketAddress.
forAddress(String, int) - Static method in class io.grpc.okhttp.OkHttpChannelBuilder
Creates a new builder for the given server host and port.
forClient() - Static method in class io.grpc.netty.GrpcSslContexts
Creates an SslContextBuilder with ciphers and APN appropriate for gRPC.
fork() - Method in class io.grpc.Context
Create a new context which propagates the values of this context but does not cascade its cancellation.
forName(String) - Static method in class io.grpc.inprocess.InProcessChannelBuilder
Create a channel builder that will connect to the server with the given name.
forName(String) - Static method in class io.grpc.inprocess.InProcessServerBuilder
Create a server builder that will bind with the given name.
forNonError(ConnectivityState) - Static method in class io.grpc.ConnectivityStateInfo
Returns an instance for a state that is not TRANSIENT_FAILURE.
forPort(int) - Static method in class io.grpc.inprocess.InProcessServerBuilder
Always fails.
forPort(int) - Static method in class io.grpc.netty.NettyServerBuilder
Creates a server builder that will bind to the given port.
forPort(int) - Static method in class io.grpc.ServerBuilder
Static factory for creating a new ServerBuilder.
forServer(File, File) - Static method in class io.grpc.netty.GrpcSslContexts
Creates an SslContextBuilder with ciphers and APN appropriate for gRPC.
forServer(File, File, String) - Static method in class io.grpc.netty.GrpcSslContexts
Creates an SslContextBuilder with ciphers and APN appropriate for gRPC.
forServer(InputStream, InputStream) - Static method in class io.grpc.netty.GrpcSslContexts
Creates an SslContextBuilder with ciphers and APN appropriate for gRPC.
forServer(InputStream, InputStream, String) - Static method in class io.grpc.netty.GrpcSslContexts
Creates an SslContextBuilder with ciphers and APN appropriate for gRPC.
forTarget(String) - Static method in class io.grpc.ForwardingChannelBuilder
This method serves to force sub classes to "hide" this static factory.
forTarget(String) - Static method in class io.grpc.inprocess.InProcessChannelBuilder
Always fails.
forTarget(String) - Static method in class io.grpc.ManagedChannelBuilder
Creates a channel with a target string, which can be either a valid NameResolver-compliant URI, or an authority string.
forTarget(String) - Static method in class io.grpc.netty.NettyChannelBuilder
Creates a new builder with the given target string that will be resolved by NameResolver.
forTarget(String) - Static method in class io.grpc.okhttp.OkHttpChannelBuilder
Creates a new builder for the given target that will be resolved by NameResolver.
forTransientFailure(Status) - Static method in class io.grpc.ConnectivityStateInfo
Returns an instance for TRANSIENT_FAILURE, associated with an error status.
ForwardingChannelBuilder<T extends ForwardingChannelBuilder<T>> - Class in io.grpc
A ManagedChannelBuilder that delegates all its builder method to another builder by default.
ForwardingChannelBuilder() - Constructor for class io.grpc.ForwardingChannelBuilder
The default constructor.
ForwardingClientCall<ReqT,RespT> - Class in io.grpc
A ClientCall which forwards all of it's methods to another ClientCall.
ForwardingClientCall() - Constructor for class io.grpc.ForwardingClientCall
 
ForwardingClientCall.SimpleForwardingClientCall<ReqT,RespT> - Class in io.grpc
A simplified version of ForwardingClientCall where subclasses can pass in a ClientCall as the delegate.
ForwardingClientCallListener<RespT> - Class in io.grpc
A ClientCall.Listener which forwards all of its methods to another ClientCall.Listener.
ForwardingClientCallListener() - Constructor for class io.grpc.ForwardingClientCallListener
 
ForwardingClientCallListener.SimpleForwardingClientCallListener<RespT> - Class in io.grpc
A simplified version of ForwardingClientCallListener where subclasses can pass in a ClientCall.Listener as the delegate.
ForwardingClientStreamTracer - Class in io.grpc.util
 
ForwardingClientStreamTracer() - Constructor for class io.grpc.util.ForwardingClientStreamTracer
 
ForwardingLoadBalancer - Class in io.grpc.util
 
ForwardingLoadBalancer() - Constructor for class io.grpc.util.ForwardingLoadBalancer
 
ForwardingLoadBalancerHelper - Class in io.grpc.util
 
ForwardingLoadBalancerHelper() - Constructor for class io.grpc.util.ForwardingLoadBalancerHelper
 
ForwardingServerCall<ReqT,RespT> - Class in io.grpc
A ServerCall which forwards all of it's methods to another ServerCall.
ForwardingServerCall() - Constructor for class io.grpc.ForwardingServerCall
 
ForwardingServerCall.SimpleForwardingServerCall<ReqT,RespT> - Class in io.grpc
A simplified version of ForwardingServerCall where subclasses can pass in a ServerCall as the delegate.
ForwardingServerCallListener<ReqT> - Class in io.grpc
A ServerCall.Listener which forwards all of its methods to another ServerCall.Listener of matching parameterized types.
ForwardingServerCallListener() - Constructor for class io.grpc.ForwardingServerCallListener
 
ForwardingServerCallListener.SimpleForwardingServerCallListener<ReqT> - Class in io.grpc
A simplified version of ForwardingServerCallListener where subclasses can pass in a ServerCall.Listener as the delegate.
ForwardingSubchannel - Class in io.grpc.util
 
ForwardingSubchannel() - Constructor for class io.grpc.util.ForwardingSubchannel
 
from(Credentials) - Static method in class io.grpc.auth.MoreCallCredentials
Converts a Google Auth Library Credentials to CallCredentials.
fromCode(Status.Code) - Static method in class io.grpc.Status
Return a Status given a canonical error Status.Code object.
fromCodeValue(int) - Static method in class io.grpc.Status
Return a Status given a canonical error Status.Code value.
fromConfig(Object) - Static method in class io.grpc.NameResolver.ConfigOrError
Returns a NameResolver.ConfigOrError for the successfully parsed config.
fromError(Status) - Static method in class io.grpc.NameResolver.ConfigOrError
Returns a NameResolver.ConfigOrError for the failure to parse the config.
fromStatusAndTrailers(Status, Metadata) - Static method in class io.grpc.protobuf.StatusProto
Extracts the google.rpc.Status from trailers, and makes sure they match the gRPC status.
fromThrowable(Throwable) - Static method in class io.grpc.protobuf.StatusProto
Extract a Status instance from the causal chain of a Throwable.
fromThrowable(Throwable) - Static method in class io.grpc.Status
Extract an error Status from the causal chain of a Throwable.
futureUnaryCall(ClientCall<ReqT, RespT>, ReqT) - Static method in class io.grpc.stub.ClientCalls
Executes a unary call and returns a ListenableFuture to the response.

G

generateFullMethodName(String, String) - Static method in class io.grpc.MethodDescriptor
Generate the fully qualified method name.
generateName() - Static method in class io.grpc.inprocess.InProcessServerBuilder
Generates a new server name that is unique each time.
get(Attributes.Key<T>) - Method in class io.grpc.Attributes
Gets the value for the key, or null if it's not present.
get() - Method in class io.grpc.Context.Key
Get the value from the Context.current() context for this key.
get(Context) - Method in class io.grpc.Context.Key
Get the value from the specified context for this key.
get(Metadata.Key<T>) - Method in class io.grpc.Metadata
Returns the last metadata entry added with the name 'name' parsed as T.
getAddresses() - Method in class io.grpc.EquivalentAddressGroup
Returns an immutable list of the addresses.
getAddresses() - Method in class io.grpc.LoadBalancer.CreateSubchannelArgs
Returns the addresses, which is an unmodifiable list.
getAddresses() - Method in class io.grpc.LoadBalancer.ResolvedAddresses
Gets the server addresses.
getAddresses() - Method in class io.grpc.LoadBalancer.Subchannel
Returns the addresses that this Subchannel is bound to.
getAddresses() - Method in class io.grpc.NameResolver.ResolutionResult
Gets the addresses resolved by name resolution.
getAdvertisedMessageEncodings() - Method in class io.grpc.DecompressorRegistry
Provides a list of all message encodings that have decompressors available and should be advertised.
getAll(Metadata.Key<T>) - Method in class io.grpc.Metadata
Returns all the metadata entries named 'name', in the order they were received, parsed as T, or null if there are none.
getAllAddresses() - Method in class io.grpc.LoadBalancer.Subchannel
Returns the addresses that this Subchannel is bound to.
getAllAddresses() - Method in class io.grpc.util.ForwardingSubchannel
 
getAttributes() - Method in class io.grpc.ClientCall
Returns additional properties of the call.
getAttributes() - Method in class io.grpc.EquivalentAddressGroup
Returns the attributes.
getAttributes() - Method in class io.grpc.LoadBalancer.CreateSubchannelArgs
Returns the attributes.
getAttributes() - Method in class io.grpc.LoadBalancer.ResolvedAddresses
Gets the attributes associated with these addresses.
getAttributes() - Method in class io.grpc.LoadBalancer.Subchannel
The same attributes passed to Helper.createSubchannel().
getAttributes() - Method in class io.grpc.NameResolver.ResolutionResult
Gets the attributes associated with the addresses resolved by name resolution.
getAttributes() - Method in class io.grpc.ServerCall
Returns properties of a single call.
getAttributes() - Method in class io.grpc.ServerStreamTracer.ServerCallInfo
 
getAttributes() - Method in class io.grpc.util.ForwardingSubchannel
 
getAuthority() - Method in class io.grpc.CallCredentials.RequestInfo
Returns the authority string used to authenticate the server for this call.
getAuthority() - Method in class io.grpc.CallOptions
Override the HTTP/2 authority the channel claims to be connecting to.
getAuthority() - Method in class io.grpc.LoadBalancer.Helper
Returns the authority string of the channel, which is derived from the DNS-style target name.
getAuthority() - Method in class io.grpc.netty.GrpcHttp2ConnectionHandler
Returns the authority of the server.
getAuthority() - Method in class io.grpc.ServerCall
Gets the authority this call is addressed to.
getAuthority() - Method in class io.grpc.ServerStreamTracer.ServerCallInfo
 
getAuthority() - Method in class io.grpc.util.ForwardingLoadBalancerHelper
 
getCallOptions() - Method in class io.grpc.ClientStreamTracer.StreamInfo
Returns the effective CallOptions of the call.
getCallOptions() - Method in class io.grpc.LoadBalancer.PickSubchannelArgs
Call options.
getCallOptions() - Method in class io.grpc.stub.AbstractStub
The CallOptions of the stub.
getCause() - Method in class io.grpc.Status
The underlying cause of an error.
getChannel(GetChannelRequest, StreamObserver<GetChannelResponse>) - Method in class io.grpc.services.ChannelzService
Returns a top level channel aka ManagedChannel.
getChannel() - Method in class io.grpc.stub.AbstractStub
The underlying channel of the stub.
getChannel() - Method in class io.grpc.testing.GrpcServerRule
Returns a ManagedChannel connected to this service.
getChannelLogger() - Method in class io.grpc.LoadBalancer.Helper
Returns the ChannelLogger for the Channel served by this LoadBalancer.
getChannelLogger() - Method in class io.grpc.LoadBalancer.Subchannel
Returns a ChannelLogger for this Subchannel.
getChannelLogger() - Method in class io.grpc.NameResolver.Args
Returns the ChannelLogger for the Channel served by this NameResolver.
getChannelLogger() - Method in class io.grpc.util.ForwardingLoadBalancerHelper
 
getChannelLogger() - Method in class io.grpc.util.ForwardingSubchannel
 
getClientInterceptor(String, CallOptions) - Method in class io.grpc.services.BinaryLogProvider
Returns a ClientInterceptor for binary logging.
getCode() - Method in class io.grpc.Status
The canonical status code.
getCompressor() - Method in class io.grpc.CallOptions
Returns the compressor's name.
getConfig() - Method in class io.grpc.NameResolver.ConfigOrError
Returns config if exists, otherwise null.
getCredentials() - Method in class io.grpc.CallOptions
Returns the call credentials.
getCurrent() - Static method in class io.grpc.services.CallMetricRecorder
Returns the call metric recorder attached to the current Context.
getDeadline() - Method in class io.grpc.CallOptions
Returns the deadline or null if the deadline is not set.
getDeadline() - Method in class io.grpc.Context.CancellableContext
 
getDeadline() - Method in class io.grpc.Context
A context may have an associated Deadline at which it will be automatically cancelled.
getDefault() - Method in class io.grpc.CallOptions.Key
Returns the user supplied default value for this key.
getDefault() - Method in class io.grpc.LoadBalancer.CreateSubchannelArgs.Key
Returns the user supplied default value for this key.
getDefaultInstance() - Static method in class io.grpc.CompressorRegistry
Returns the default instance used by gRPC when the registry is not specified.
getDefaultInstance() - Static method in class io.grpc.DecompressorRegistry
 
getDefaultPort() - Method in class io.grpc.NameResolver.Args
The port number used in case the target or the underlying naming system doesn't provide a port number.
getDefaultPort() - Method in class io.grpc.NameResolver.Helper
Deprecated.
The port number used in case the target or the underlying naming system doesn't provide a port number.
getDefaultPort() - Method in class io.grpc.netty.NettyChannelBuilder
 
getDefaultPort() - Method in class io.grpc.okhttp.OkHttpChannelBuilder
 
getDefaultRegistry() - Static method in class io.grpc.LoadBalancerRegistry
Returns the default registry that loads providers via the Java service loader mechanism.
getDefaultRegistry() - Static method in class io.grpc.NameResolverRegistry
Returns the default registry that loads providers via the Java service loader mechanism.
getDefaultScheme() - Method in class io.grpc.NameResolver.Factory
Returns the default scheme, which will be used to construct a URI when ManagedChannelBuilder.forTarget(String) is given an authority string instead of a compliant URI.
getDescription() - Method in class io.grpc.Status
A description of this status for human consumption.
getEagAttributes() - Method in class io.grpc.netty.GrpcHttp2ConnectionHandler
Get the attributes of the EquivalentAddressGroup used to create this transport.
getError() - Method in class io.grpc.NameResolver.ConfigOrError
Returns error status if exists, otherwise null.
getError() - Method in class io.grpc.testing.StreamRecorder
Deprecated.
Returns the stream terminating error.
getExecutor() - Method in class io.grpc.CallOptions
 
getFileDescriptor() - Method in interface io.grpc.protobuf.ProtoFileDescriptorSupplier
Returns file descriptor to the underlying proto file.
getFullMethodName() - Method in class io.grpc.MethodDescriptor
The fully qualified name of the method.
getHeaders() - Method in class io.grpc.LoadBalancer.PickSubchannelArgs
Headers of the call.
getHealthService() - Method in class io.grpc.services.HealthStatusManager
Gets the health check service created in the constructor.
getImmutableServices() - Method in class io.grpc.Server
Returns immutable services registered with the server, or an empty list if not supported by the implementation.
getInternalSubchannel() - Method in class io.grpc.LoadBalancer.Subchannel
(Internal use only) returns an object that represents the underlying subchannel that is used by the Channel for sending RPCs when this LoadBalancer.Subchannel is picked.
getInternalSubchannel() - Method in class io.grpc.util.ForwardingSubchannel
 
getKnownMessageEncodings() - Method in class io.grpc.DecompressorRegistry
Provides a list of all message encodings that have decompressors available.
getListenSockets() - Method in class io.grpc.Server
Returns a list of listening sockets for this server.
getLoadBalancingPolicyConfig() - Method in class io.grpc.LoadBalancer.ResolvedAddresses
Gets the domain specific load balancing policy.
getMaxInboundMessageSize() - Method in class io.grpc.CallOptions
Gets the maximum allowed message size acceptable from the remote peer.
getMaxOutboundMessageSize() - Method in class io.grpc.CallOptions
Gets the maximum allowed message size acceptable to send the remote peer.
getMessageClass() - Method in interface io.grpc.MethodDescriptor.ReflectableMarshaller
Returns the Class that this marshaller serializes and deserializes.
getMessageEncoding() - Method in class io.grpc.Codec.Gzip
 
getMessageEncoding() - Method in class io.grpc.Codec.Identity
 
getMessageEncoding() - Method in interface io.grpc.Compressor
Returns the message encoding that this compressor uses.
getMessageEncoding() - Method in interface io.grpc.Decompressor
Returns the message encoding that this compressor uses.
getMessagePrototype() - Method in interface io.grpc.MethodDescriptor.PrototypeMarshaller
An instance of the expected message type, typically used as a schema and helper for producing other message instances.
getMethod(String) - Method in class io.grpc.ServerServiceDefinition
Look up a method by its fully qualified name.
getMethodDescriptor() - Method in class io.grpc.CallCredentials.RequestInfo
The method descriptor of this RPC.
getMethodDescriptor() - Method in class io.grpc.ForwardingServerCall.SimpleForwardingServerCall
 
getMethodDescriptor() - Method in class io.grpc.LoadBalancer.PickSubchannelArgs
Call method.
getMethodDescriptor() - Method in interface io.grpc.protobuf.ProtoMethodDescriptorSupplier
Returns method descriptor to the proto service method.
getMethodDescriptor() - Method in class io.grpc.ServerCall
The MethodDescriptor for the call.
getMethodDescriptor() - Method in class io.grpc.ServerMethodDefinition
The MethodDescriptor for this method.
getMethodDescriptor() - Method in class io.grpc.ServerStreamTracer.ServerCallInfo
 
getMethods() - Method in class io.grpc.ServerServiceDefinition
Gets all the methods of service.
getMethods() - Method in class io.grpc.ServiceDescriptor
A collection of MethodDescriptor instances describing the methods exposed by the service.
getMutableServices() - Method in class io.grpc.Server
Returns mutable services registered with the server, or an empty list if not supported by the implementation.
getName() - Method in class io.grpc.inprocess.InProcessSocketAddress
Gets the name of the inprocess channel or server.
getName() - Method in class io.grpc.ServiceDescriptor
Simple name of the service.
getNameResolverArgs() - Method in class io.grpc.LoadBalancer.Helper
Returns the NameResolver.Args that the Channel uses to create NameResolvers.
getNameResolverArgs() - Method in class io.grpc.util.ForwardingLoadBalancerHelper
 
getNameResolverFactory() - Method in class io.grpc.LoadBalancer.Helper
Deprecated.
this method will be deleted in a future release. If you think it shouldn't be deleted, please file an issue on github.
getNameResolverFactory() - Method in class io.grpc.util.ForwardingLoadBalancerHelper
Deprecated.
getNameResolverRegistry() - Method in class io.grpc.LoadBalancer.Helper
Returns the NameResolverRegistry that the Channel uses to look for NameResolvers.
getNameResolverRegistry() - Method in class io.grpc.util.ForwardingLoadBalancerHelper
 
getOffloadExecutor() - Method in class io.grpc.NameResolver.Args
Returns the Executor on which this resolver should execute long-running or I/O bound work.
getOption(CallOptions.Key<T>) - Method in class io.grpc.CallOptions
Get the value for a custom option or its inherent default.
getOption(LoadBalancer.CreateSubchannelArgs.Key<T>) - Method in class io.grpc.LoadBalancer.CreateSubchannelArgs
Get the value for a custom option or its inherent default.
getPassword() - Method in class io.grpc.HttpConnectProxiedSocketAddress
Returns the password used to connect to the proxy.
getPolicyName() - Method in class io.grpc.grpclb.GrpclbLoadBalancerProvider
 
getPolicyName() - Method in class io.grpc.LoadBalancerProvider
Returns the load-balancing policy name associated with this provider, which makes it selectable via LoadBalancerRegistry.getProvider(java.lang.String).
getPort() - Method in class io.grpc.Server
Returns the port number the server is listening on.
getPriority() - Method in class io.grpc.grpclb.GrpclbLoadBalancerProvider
 
getPriority() - Method in class io.grpc.LoadBalancerProvider
A priority, from 0 to 10 that this provider should be used, taking the current environment into consideration.
getProvider(String) - Method in class io.grpc.LoadBalancerRegistry
Returns the effective provider for the given load-balancing policy, or null if no suitable provider can be found.
getProxyAddress() - Method in class io.grpc.HttpConnectProxiedSocketAddress
Returns the address to the proxy, which is already resolved.
getProxyDetector() - Method in class io.grpc.NameResolver.Args
If the NameResolver wants to support proxy, it should inquire this ProxyDetector.
getProxyDetector() - Method in class io.grpc.NameResolver.Helper
Deprecated.
If the NameResolver wants to support proxy, it should inquire this ProxyDetector.
getRequestMarshaller() - Method in class io.grpc.MethodDescriptor
Returns the marshaller for the request type.
getResponseMarshaller() - Method in class io.grpc.MethodDescriptor
Returns the marshaller for the response type.
getScheduledExecutorService() - Method in class io.grpc.LoadBalancer.Helper
Returns a ScheduledExecutorService for scheduling delayed tasks.
getScheduledExecutorService() - Method in class io.grpc.NameResolver.Args
Returns a ScheduledExecutorService for scheduling delayed tasks.
getScheduledExecutorService() - Method in class io.grpc.util.ForwardingLoadBalancerHelper
 
getSchemaDescriptor() - Method in class io.grpc.MethodDescriptor
Returns the schema descriptor for this method.
getSchemaDescriptor() - Method in class io.grpc.ServiceDescriptor
Returns the schema descriptor for this service.
getSecurityLevel() - Method in class io.grpc.CallCredentials.RequestInfo
The security level on the transport.
getServer() - Method in class io.grpc.testing.GrpcServerRule
Returns the underlying gRPC Server for this service.
getServerCallHandler() - Method in class io.grpc.ServerMethodDefinition
Handler for incoming calls.
getServerInterceptor(String) - Method in class io.grpc.services.BinaryLogProvider
Returns a ServerInterceptor for binary logging.
getServerName() - Method in class io.grpc.testing.GrpcServerRule
Returns the randomly generated server name for this service.
getServers(GetServersRequest, StreamObserver<GetServersResponse>) - Method in class io.grpc.services.ChannelzService
Returns servers.
getServerSockets(GetServerSocketsRequest, StreamObserver<GetServerSocketsResponse>) - Method in class io.grpc.services.ChannelzService
 
getServiceAuthority() - Method in class io.grpc.NameResolver
Returns the authority used to authenticate connections to servers.
getServiceConfig() - Method in class io.grpc.NameResolver.ResolutionResult
Gets the Service Config parsed by NameResolver.Helper.parseServiceConfig(Map).
getServiceConfigParser() - Method in class io.grpc.NameResolver.Args
getServiceDescriptor() - Method in interface io.grpc.protobuf.ProtoServiceDescriptorSupplier
Returns service descriptor to the proto service.
getServiceDescriptor() - Method in class io.grpc.ServerServiceDefinition
The descriptor for the service.
getServiceName() - Method in class io.grpc.MethodDescriptor
A convenience method for extractFullServiceName(getFullMethodName()).
getServiceRegistry() - Method in class io.grpc.testing.GrpcServerRule
Returns the service registry for this service.
getServices() - Method in class io.grpc.HandlerRegistry
Returns the ServerServiceDefinitions provided by the registry, or an empty list if not supported by the implementation.
getServices() - Method in class io.grpc.Server
Returns all services registered with the server, or an empty list if not supported by the implementation.
getServices() - Method in class io.grpc.util.MutableHandlerRegistry
Note: This does not necessarily return a consistent view of the map.
getSocket(GetSocketRequest, StreamObserver<GetSocketResponse>) - Method in class io.grpc.services.ChannelzService
Returns a socket.
getState() - Method in class io.grpc.ConnectivityStateInfo
Returns the state.
getState(boolean) - Method in class io.grpc.ManagedChannel
Gets the current connectivity state.
getStatus() - Method in class io.grpc.ConnectivityStateInfo
Returns the status associated with the state.
getStatus() - Method in class io.grpc.LoadBalancer.PickResult
The status associated with this result.
getStatus() - Method in exception io.grpc.StatusException
Returns the status code as a Status object.
getStatus() - Method in exception io.grpc.StatusRuntimeException
Returns the status code as a Status object.
getStreamTracerFactories() - Method in class io.grpc.CallOptions
Returns an immutable list of ClientStreamTracerFactorys.
getStreamTracerFactory() - Method in class io.grpc.LoadBalancer.PickResult
The stream tracer factory this result was created with.
getSubchannel() - Method in class io.grpc.LoadBalancer.PickResult
The Subchannel if this result was created by withSubchannel(), or null otherwise.
getSubchannel(GetSubchannelRequest, StreamObserver<GetSubchannelResponse>) - Method in class io.grpc.services.ChannelzService
Returns a subchannel.
getSynchronizationContext() - Method in class io.grpc.LoadBalancer.Helper
Returns a SynchronizationContext that runs tasks in the same Synchronization Context as that the callback methods on the LoadBalancer interface are run in.
getSynchronizationContext() - Method in class io.grpc.NameResolver.Args
getSynchronizationContext() - Method in class io.grpc.NameResolver.Helper
Deprecated.
getSynchronizationContext() - Method in class io.grpc.util.ForwardingLoadBalancerHelper
 
getSystemTicker() - Static method in class io.grpc.Deadline
Returns the ticker that's based on system clock.
getTargetAddress() - Method in class io.grpc.HttpConnectProxiedSocketAddress
Returns the address to the target server.
getTopChannels(GetTopChannelsRequest, StreamObserver<GetTopChannelsResponse>) - Method in class io.grpc.services.ChannelzService
Returns top level channel aka ManagedChannel.
getTrailers() - Method in exception io.grpc.StatusException
Returns the received trailers.
getTrailers() - Method in exception io.grpc.StatusRuntimeException
Returns the received trailers.
getTransportAttrs() - Method in class io.grpc.CallCredentials.RequestInfo
Returns the transport attributes.
getTransportAttrs() - Method in class io.grpc.ClientStreamTracer.StreamInfo
Returns the attributes of the transport that this stream was created on.
getType() - Method in class io.grpc.MethodDescriptor
The call type of the method.
getUsername() - Method in class io.grpc.HttpConnectProxiedSocketAddress
Returns the username used to connect to the proxy.
getValues() - Method in class io.grpc.testing.StreamRecorder
Deprecated.
Returns the current set of received values.
GracefulSwitchLoadBalancer - Class in io.grpc.util
A load balancer that gracefully swaps to a new lb policy.
GracefulSwitchLoadBalancer(LoadBalancer.Helper) - Constructor for class io.grpc.util.GracefulSwitchLoadBalancer
 
Grpc - Class in io.grpc
Stuff that are part of the public API but are not bound to particular classes, e.g., static methods, constants, attribute and context keys.
Grpc.TransportAttr - Annotation Type in io.grpc
Annotation for transport attributes.
GrpcCleanupRule - Class in io.grpc.testing
A JUnit TestRule that can register gRPC resources and manages its automatic release at the end of the test.
GrpcCleanupRule() - Constructor for class io.grpc.testing.GrpcCleanupRule
 
GrpcHttp2ConnectionHandler - Class in io.grpc.netty
gRPC wrapper for Http2ConnectionHandler.
GrpcHttp2ConnectionHandler(ChannelPromise, Http2ConnectionDecoder, Http2ConnectionEncoder, Http2Settings) - Constructor for class io.grpc.netty.GrpcHttp2ConnectionHandler
 
GrpclbConstants - Class in io.grpc.grpclb
Constants for the GRPCLB load-balancer.
GrpclbLoadBalancerProvider - Class in io.grpc.grpclb
The provider for the "grpclb" balancing policy.
GrpclbLoadBalancerProvider() - Constructor for class io.grpc.grpclb.GrpclbLoadBalancerProvider
 
GrpcServerRule - Class in io.grpc.testing
GrpcServerRule is a JUnit TestRule that starts an in-process gRPC service with a MutableHandlerRegistry for adding services.
GrpcServerRule() - Constructor for class io.grpc.testing.GrpcServerRule
 
GrpcSslContexts - Class in io.grpc.netty
Utility for configuring SslContext for gRPC.
Gzip() - Constructor for class io.grpc.Codec.Gzip
 

H

halfClose() - Method in class io.grpc.ClientCall
Close the call for request message sending.
handleNameResolutionError(Status) - Method in class io.grpc.LoadBalancer
Handles an error from the name resolution system.
handleNameResolutionError(Status) - Method in class io.grpc.util.ForwardingLoadBalancer
 
handleProtocolNegotiationCompleted(Attributes) - Method in class io.grpc.netty.GrpcHttp2ConnectionHandler
Deprecated.
Use the two argument method instead.
handleProtocolNegotiationCompleted(Attributes, InternalChannelz.Security) - Method in class io.grpc.netty.GrpcHttp2ConnectionHandler
Triggered on protocol negotiation completion.
handleResolvedAddresses(LoadBalancer.ResolvedAddresses) - Method in class io.grpc.LoadBalancer
Handles newly resolved server groups and metadata attributes from name resolution system.
handleResolvedAddresses(LoadBalancer.ResolvedAddresses) - Method in class io.grpc.util.ForwardingLoadBalancer
 
handleResolvedAddressGroups(List<EquivalentAddressGroup>, Attributes) - Method in class io.grpc.LoadBalancer
Deprecated.
override instead
handleResolvedAddressGroups(List<EquivalentAddressGroup>, Attributes) - Method in class io.grpc.util.ForwardingLoadBalancer
Deprecated.
HandlerRegistry - Class in io.grpc
Registry of services and their methods used by servers to dispatching incoming calls.
HandlerRegistry() - Constructor for class io.grpc.HandlerRegistry
 
handleSubchannelState(LoadBalancer.Subchannel, ConnectivityStateInfo) - Method in class io.grpc.LoadBalancer
Deprecated.
This method will be removed. Stop overriding it. Instead, pass LoadBalancer.SubchannelStateListener to LoadBalancer.Subchannel.start(io.grpc.LoadBalancer.SubchannelStateListener) to receive Subchannel state updates
handleSubchannelState(LoadBalancer.Subchannel, ConnectivityStateInfo) - Method in class io.grpc.util.ForwardingLoadBalancer
Deprecated.
handleSubchannelState(LoadBalancer.Subchannel, ConnectivityStateInfo) - Method in class io.grpc.util.GracefulSwitchLoadBalancer
Deprecated.
handshakeTimeout(long, TimeUnit) - Method in class io.grpc.ServerBuilder
Sets the permitted time for new connections to complete negotiation handshakes before being killed.
hashCode() - Method in class io.grpc.Attributes
Returns a hash code for the attributes.
hashCode() - Method in class io.grpc.ConnectivityStateInfo
 
hashCode() - Method in class io.grpc.Deadline
 
hashCode() - Method in class io.grpc.EquivalentAddressGroup
 
hashCode() - Method in class io.grpc.HttpConnectProxiedSocketAddress
 
hashCode() - Method in class io.grpc.inprocess.InProcessSocketAddress
 
hashCode() - Method in class io.grpc.LoadBalancer.PickResult
 
hashCode() - Method in class io.grpc.LoadBalancer.ResolvedAddresses
 
hashCode() - Method in class io.grpc.LoadBalancerProvider
 
hashCode() - Method in class io.grpc.Metadata.Key
 
hashCode() - Method in class io.grpc.NameResolver.ConfigOrError
 
hashCode() - Method in class io.grpc.NameResolver.ResolutionResult
Useful for testing.
hashCode() - Method in class io.grpc.netty.ProtocolNegotiationEvent
This method is not efficient and is intended for testing.
hashCode() - Method in class io.grpc.Status
Hash codes on Statuses are not well defined.
HealthCheckingLoadBalancerUtil - Class in io.grpc.services
Utility for enabling client-side health checking for LoadBalancers.
HealthStatusManager - Class in io.grpc.services
A HealthStatusManager object manages a health check service.
HealthStatusManager() - Constructor for class io.grpc.services.HealthStatusManager
Creates a new health service instance.
Helper() - Constructor for class io.grpc.LoadBalancer.Helper
 
Helper() - Constructor for class io.grpc.NameResolver.Helper
Deprecated.
 
hostnameVerifier(HostnameVerifier) - Method in class io.grpc.okhttp.OkHttpChannelBuilder
Set the hostname verifier to use when using TLS negotiation.
HttpConnectProxiedSocketAddress - Class in io.grpc
An ProxiedSocketAddress for making a connection to an endpoint via an HTTP CONNECT proxy.
HttpConnectProxiedSocketAddress.Builder - Class in io.grpc

I

idleTimeout(long, TimeUnit) - Method in class io.grpc.ForwardingChannelBuilder
 
idleTimeout(long, TimeUnit) - Method in class io.grpc.ManagedChannelBuilder
Set the duration without ongoing RPCs before going to idle mode.
inboundHeaders() - Method in class io.grpc.ClientStreamTracer
Headers has been received from the server.
inboundHeaders() - Method in class io.grpc.util.ForwardingClientStreamTracer
 
inboundMessage(int) - Method in class io.grpc.StreamTracer
An inbound message has been received by the stream.
inboundMessage(int) - Method in class io.grpc.util.ForwardingClientStreamTracer
 
inboundMessageRead(int, long, long) - Method in class io.grpc.StreamTracer
An inbound message has been fully read from the transport.
inboundMessageRead(int, long, long) - Method in class io.grpc.util.ForwardingClientStreamTracer
 
inboundTrailers(Metadata) - Method in class io.grpc.ClientStreamTracer
Trailing metadata has been received from the server.
inboundTrailers(Metadata) - Method in class io.grpc.util.ForwardingClientStreamTracer
 
inboundUncompressedSize(long) - Method in class io.grpc.StreamTracer
The uncompressed size of some inbound data is revealed.
inboundUncompressedSize(long) - Method in class io.grpc.util.ForwardingClientStreamTracer
 
inboundWireSize(long) - Method in class io.grpc.StreamTracer
The wire size of some inbound data is revealed.
inboundWireSize(long) - Method in class io.grpc.util.ForwardingClientStreamTracer
 
initialFlowControlWindow(int) - Method in class io.grpc.netty.NettyChannelBuilder
Sets the initial flow control window in bytes.
initialFlowControlWindow(int) - Method in class io.grpc.netty.NettyServerBuilder
Sets the initial flow control window in bytes.
InProcessChannelBuilder - Class in io.grpc.inprocess
Builder for a channel that issues in-process requests.
InProcessServerBuilder - Class in io.grpc.inprocess
Builder for a server that services in-process requests.
InProcessSocketAddress - Class in io.grpc.inprocess
Custom SocketAddress class for InProcessTransport.
InProcessSocketAddress(String) - Constructor for class io.grpc.inprocess.InProcessSocketAddress
 
instance() - Static method in class io.grpc.util.TransmitStatusRuntimeExceptionInterceptor
 
intercept(Channel, ClientInterceptor...) - Static method in class io.grpc.ClientInterceptors
Create a new Channel that will call interceptors before starting a call on the given channel.
intercept(Channel, List<? extends ClientInterceptor>) - Static method in class io.grpc.ClientInterceptors
Create a new Channel that will call interceptors before starting a call on the given channel.
intercept(List<ClientInterceptor>) - Method in class io.grpc.ForwardingChannelBuilder
 
intercept(ClientInterceptor...) - Method in class io.grpc.ForwardingChannelBuilder
 
intercept(List<ClientInterceptor>) - Method in class io.grpc.ManagedChannelBuilder
Adds interceptors that will be called before the channel performs its real work.
intercept(ClientInterceptor...) - Method in class io.grpc.ManagedChannelBuilder
Adds interceptors that will be called before the channel performs its real work.
intercept(ServerInterceptor) - Method in class io.grpc.ServerBuilder
Adds a ServerInterceptor that is run for all services on the server.
intercept(ServerServiceDefinition, ServerInterceptor...) - Static method in class io.grpc.ServerInterceptors
Create a new ServerServiceDefinition whose ServerCallHandlers will call interceptors before calling the pre-existing ServerCallHandler.
intercept(BindableService, ServerInterceptor...) - Static method in class io.grpc.ServerInterceptors
 
intercept(ServerServiceDefinition, List<? extends ServerInterceptor>) - Static method in class io.grpc.ServerInterceptors
Create a new ServerServiceDefinition whose ServerCallHandlers will call interceptors before calling the pre-existing ServerCallHandler.
intercept(BindableService, List<? extends ServerInterceptor>) - Static method in class io.grpc.ServerInterceptors
 
interceptCall(MethodDescriptor<ReqT, RespT>, CallOptions, Channel) - Method in class io.grpc.auth.ClientAuthInterceptor
Deprecated.
 
interceptCall(MethodDescriptor<ReqT, RespT>, CallOptions, Channel) - Method in interface io.grpc.ClientInterceptor
Intercept ClientCall creation by the next Channel.
interceptCall(Context, ServerCall<ReqT, RespT>, Metadata, ServerCallHandler<ReqT, RespT>) - Static method in class io.grpc.Contexts
Make the provided Context Context.current() for the creation of a listener to a received call and for all events received by that listener.
interceptCall(ServerCall<ReqT, RespT>, Metadata, ServerCallHandler<ReqT, RespT>) - Method in interface io.grpc.ServerInterceptor
Intercept ServerCall dispatch by the next ServerCallHandler.
interceptCall(ServerCall<ReqT, RespT>, Metadata, ServerCallHandler<ReqT, RespT>) - Method in class io.grpc.util.TransmitStatusRuntimeExceptionInterceptor
 
interceptForward(Channel, ClientInterceptor...) - Static method in class io.grpc.ClientInterceptors
Create a new Channel that will call interceptors before starting a call on the given channel.
interceptForward(Channel, List<? extends ClientInterceptor>) - Static method in class io.grpc.ClientInterceptors
Create a new Channel that will call interceptors before starting a call on the given channel.
interceptForward(ServerServiceDefinition, ServerInterceptor...) - Static method in class io.grpc.ServerInterceptors
Create a new ServerServiceDefinition whose ServerCallHandlers will call interceptors before calling the pre-existing ServerCallHandler.
interceptForward(BindableService, ServerInterceptor...) - Static method in class io.grpc.ServerInterceptors
 
interceptForward(ServerServiceDefinition, List<? extends ServerInterceptor>) - Static method in class io.grpc.ServerInterceptors
Create a new ServerServiceDefinition whose ServerCallHandlers will call interceptors before calling the pre-existing ServerCallHandler.
interceptForward(BindableService, List<? extends ServerInterceptor>) - Static method in class io.grpc.ServerInterceptors
 
Internal - Annotation Type in io.grpc
Annotates a program element (class, method, package, etc) which is internal to gRPC, not part of the public API, and should not be used by users of gRPC.
INTERNAL - Static variable in class io.grpc.Status
Internal errors.
INVALID_ARGUMENT - Static variable in class io.grpc.Status
Client specified an invalid argument.
invoke(StreamObserver<RespT>) - Method in interface io.grpc.stub.ServerCalls.BidiStreamingMethod
 
invoke(StreamObserver<RespT>) - Method in interface io.grpc.stub.ServerCalls.ClientStreamingMethod
 
invoke(ReqT, StreamObserver<RespT>) - Method in interface io.grpc.stub.ServerCalls.ServerStreamingMethod
 
invoke(ReqT, StreamObserver<RespT>) - Method in interface io.grpc.stub.ServerCalls.UnaryMethod
 
io.grpc - package io.grpc
The gRPC core public API.
io.grpc.auth - package io.grpc.auth
Implementations of CallCredentials and authentication related API.
io.grpc.grpclb - package io.grpc.grpclb
 
io.grpc.inprocess - package io.grpc.inprocess
The in-process transport which is for when a server is in the same process as the client.
io.grpc.netty - package io.grpc.netty
The main transport implementation based on Netty, for both the client and the server.
io.grpc.okhttp - package io.grpc.okhttp
A lightweight transport based on OkHttp, mainly for use on Android (client-only).
io.grpc.protobuf - package io.grpc.protobuf
API for gRPC over Protocol Buffers, including tools for serializing and de-serializing protobuf messages.
io.grpc.protobuf.lite - package io.grpc.protobuf.lite
API for gRPC over Protocol Buffers with proto message classes generated by the Lite Runtime library.
io.grpc.protobuf.services - package io.grpc.protobuf.services
 
io.grpc.services - package io.grpc.services
Service definitions and utilities for the pre-defined gRPC services.
io.grpc.stub - package io.grpc.stub
API for the Stub layer.
io.grpc.stub.annotations - package io.grpc.stub.annotations
 
io.grpc.testing - package io.grpc.testing
API that is useful for testing gRPC.
io.grpc.util - package io.grpc.util
Utilities with advanced features in the core layer that user can optionally use.
isAvailable() - Method in class io.grpc.grpclb.GrpclbLoadBalancerProvider
 
isAvailable() - Method in class io.grpc.LoadBalancerProvider
Whether this provider is available for use, taking the current environment into consideration.
isAvailable() - Method in class io.grpc.ManagedChannelProvider
Whether this provider is available for use, taking the current environment into consideration.
isAvailable() - Method in class io.grpc.NameResolverProvider
Whether this provider is available for use, taking the current environment into consideration.
isAvailable() - Method in class io.grpc.netty.NettyChannelProvider
 
isAvailable() - Method in class io.grpc.netty.NettyServerProvider
 
isAvailable() - Method in class io.grpc.okhttp.OkHttpChannelProvider
 
isAvailable() - Method in class io.grpc.ServerProvider
Whether this provider is available for use, taking the current environment into consideration.
isBefore(Deadline) - Method in class io.grpc.Deadline
Is this deadline before another.
isCancelled() - Method in class io.grpc.Context.CancellableContext
 
isCancelled() - Method in class io.grpc.Context
Is this context cancelled.
isCancelled() - Method in class io.grpc.ServerCall
Returns true when the call is cancelled and the server is encouraged to abort processing to save resources, since the client will not be processing any further methods.
isCancelled() - Method in class io.grpc.stub.ServerCallStreamObserver
Returns true when the call is cancelled and the server is encouraged to abort processing to save resources, since the client will not be processing any further methods.
isCurrent() - Method in class io.grpc.Context.CancellableContext
Deprecated.
This method violates some GRPC class encapsulation and should not be used. If you must know whether a Context is the current context, check whether it is the same object returned by Context.current().
isDrop() - Method in class io.grpc.LoadBalancer.PickResult
Returns true if this result was created by withDrop().
isExpired() - Method in class io.grpc.Deadline
Has this deadline expired
isIdempotent() - Method in class io.grpc.MethodDescriptor
Returns whether this method is idempotent.
isOk() - Method in class io.grpc.Status
Is this status OK, i.e., not an error.
isPending() - Method in class io.grpc.SynchronizationContext.ScheduledHandle
Returns true if the task will eventually run, meaning that it has neither started running nor been cancelled.
isReady() - Method in class io.grpc.ClientCall
If true, indicates that the call is capable of sending additional messages without requiring excessive buffering internally.
isReady() - Method in class io.grpc.ServerCall
If true, indicates that the call is capable of sending additional messages without requiring excessive buffering internally.
isReady() - Method in class io.grpc.stub.CallStreamObserver
If true, indicates that the observer is capable of sending additional messages without requiring excessive buffering internally.
isSafe() - Method in class io.grpc.MethodDescriptor
Returns whether this method is safe.
isSampledToLocalTracing() - Method in class io.grpc.MethodDescriptor
Returns whether RPCs for this method may be sampled into the local tracing store.
isShutdown() - Method in class io.grpc.ManagedChannel
Returns whether the channel is shutdown.
isShutdown() - Method in class io.grpc.Server
Returns whether the server is shutdown.
isTerminated() - Method in class io.grpc.ManagedChannel
Returns whether the channel is terminated.
isTerminated() - Method in class io.grpc.Server
Returns whether the server is terminated.
isWaitForReady() - Method in class io.grpc.CallOptions
Returns whether 'wait for ready' option is enabled for the call.

K

keepAliveTime(long, TimeUnit) - Method in class io.grpc.ForwardingChannelBuilder
 
keepAliveTime(long, TimeUnit) - Method in class io.grpc.inprocess.InProcessChannelBuilder
Does nothing.
keepAliveTime(long, TimeUnit) - Method in class io.grpc.ManagedChannelBuilder
Sets the time without read activity before sending a keepalive ping.
keepAliveTime(long, TimeUnit) - Method in class io.grpc.netty.NettyChannelBuilder
Sets the time without read activity before sending a keepalive ping.
keepAliveTime(long, TimeUnit) - Method in class io.grpc.netty.NettyServerBuilder
Sets a custom keepalive time, the delay time for sending next keepalive ping.
keepAliveTime(long, TimeUnit) - Method in class io.grpc.okhttp.OkHttpChannelBuilder
Sets the time without read activity before sending a keepalive ping.
keepAliveTimeout(long, TimeUnit) - Method in class io.grpc.ForwardingChannelBuilder
 
keepAliveTimeout(long, TimeUnit) - Method in class io.grpc.inprocess.InProcessChannelBuilder
Does nothing.
keepAliveTimeout(long, TimeUnit) - Method in class io.grpc.ManagedChannelBuilder
Sets the time waiting for read activity after sending a keepalive ping.
keepAliveTimeout(long, TimeUnit) - Method in class io.grpc.netty.NettyChannelBuilder
Sets the time waiting for read activity after sending a keepalive ping.
keepAliveTimeout(long, TimeUnit) - Method in class io.grpc.netty.NettyServerBuilder
Sets a custom keepalive timeout, the timeout for keepalive ping requests.
keepAliveTimeout(long, TimeUnit) - Method in class io.grpc.okhttp.OkHttpChannelBuilder
Sets the time waiting for read activity after sending a keepalive ping.
keepAliveWithoutCalls(boolean) - Method in class io.grpc.ForwardingChannelBuilder
 
keepAliveWithoutCalls(boolean) - Method in class io.grpc.inprocess.InProcessChannelBuilder
Does nothing.
keepAliveWithoutCalls(boolean) - Method in class io.grpc.ManagedChannelBuilder
Sets whether keepalive will be performed when there are no outstanding RPC on a connection.
keepAliveWithoutCalls(boolean) - Method in class io.grpc.netty.NettyChannelBuilder
Sets whether keepalive will be performed when there are no outstanding RPC on a connection.
keepAliveWithoutCalls(boolean) - Method in class io.grpc.okhttp.OkHttpChannelBuilder
Sets whether keepalive will be performed when there are no outstanding RPC on a connection.
key(String) - Static method in class io.grpc.Context
Create a Context.Key with the given debug name.
keyForProto(T) - Static method in class io.grpc.protobuf.ProtoUtils
Produce a metadata key for a generated protobuf type.
keys() - Method in class io.grpc.Attributes
Deprecated.
This method is being considered for removal, if you feel this method is needed please reach out on this Github issue: grpc-java/issues/1764.
keys() - Method in class io.grpc.Metadata
Returns set of all keys in store.
keyWithDefault(String, T) - Static method in class io.grpc.Context
Create a Context.Key with the given debug name and default value.
KnownLength - Interface in io.grpc
An InputStream or alike whose total number of bytes that can be read is known upfront.

L

Listener() - Constructor for class io.grpc.ClientCall.Listener
 
Listener() - Constructor for class io.grpc.ServerCall.Listener
 
Listener2() - Constructor for class io.grpc.NameResolver.Listener2
 
LoadBalancer - Class in io.grpc
A pluggable component that receives resolved addresses from NameResolver and provides the channel a usable subchannel when asked.
LoadBalancer() - Constructor for class io.grpc.LoadBalancer
 
LoadBalancer.CreateSubchannelArgs - Class in io.grpc
Arguments for creating a LoadBalancer.Subchannel.
LoadBalancer.CreateSubchannelArgs.Builder - Class in io.grpc
 
LoadBalancer.CreateSubchannelArgs.Key<T> - Class in io.grpc
Key for a key-value pair.
LoadBalancer.Factory - Class in io.grpc
Factory to create LoadBalancer instance.
LoadBalancer.Helper - Class in io.grpc
Provides essentials for LoadBalancer implementations.
LoadBalancer.PickResult - Class in io.grpc
A balancing decision made by SubchannelPicker for an RPC.
LoadBalancer.PickSubchannelArgs - Class in io.grpc
LoadBalancer.ResolvedAddresses - Class in io.grpc
Represents a combination of the resolved server address, associated attributes and a load balancing policy config.
LoadBalancer.ResolvedAddresses.Builder - Class in io.grpc
LoadBalancer.Subchannel - Class in io.grpc
A logical connection to a server, or a group of equivalent servers represented by an EquivalentAddressGroup.
LoadBalancer.SubchannelPicker - Class in io.grpc
The main balancing logic.
LoadBalancer.SubchannelStateListener - Interface in io.grpc
Receives state changes for one LoadBalancer.Subchannel.
LoadBalancerProvider - Class in io.grpc
Provider of LoadBalancers.
LoadBalancerProvider() - Constructor for class io.grpc.LoadBalancerProvider
 
LoadBalancerRegistry - Class in io.grpc
Registry of LoadBalancerProviders.
LoadBalancerRegistry() - Constructor for class io.grpc.LoadBalancerRegistry
 
loadCert(String) - Static method in class io.grpc.testing.TlsTesting
Retrieves the specified test certificate or key resource in src/main/resources/certs/ as an InputStream.
loadX509Cert(String) - Static method in class io.grpc.testing.TestUtils
Deprecated.
Not for public use
localSocketPicker(NettyChannelBuilder.LocalSocketPicker) - Method in class io.grpc.netty.NettyChannelBuilder
If non-null, attempts to create connections bound to a local port.
LocalSocketPicker() - Constructor for class io.grpc.netty.NettyChannelBuilder.LocalSocketPicker
 
log(ChannelLogger.ChannelLogLevel, String) - Method in class io.grpc.ChannelLogger
Logs a message.
log(ChannelLogger.ChannelLogLevel, String, Object...) - Method in class io.grpc.ChannelLogger
Logs a message, using a message format and a list of arguments used to generate the log message with MessageFormat.
lookupCompressor(String) - Method in class io.grpc.CompressorRegistry
 
lookupDecompressor(String) - Method in class io.grpc.DecompressorRegistry
Returns a decompressor for the given message encoding, or null if none has been registered.
lookupMethod(String, String) - Method in class io.grpc.HandlerRegistry
Lookup a ServerMethodDefinition by its fully-qualified name.
lookupMethod(String) - Method in class io.grpc.HandlerRegistry
Lookup a ServerMethodDefinition by its fully-qualified name.
lookupMethod(String, String) - Method in class io.grpc.util.MutableHandlerRegistry
Note: This does not actually honor the authority provided.

M

ManagedChannel - Class in io.grpc
A Channel that provides lifecycle management.
ManagedChannel() - Constructor for class io.grpc.ManagedChannel
 
ManagedChannelBuilder<T extends ManagedChannelBuilder<T>> - Class in io.grpc
A builder for ManagedChannel instances.
ManagedChannelBuilder() - Constructor for class io.grpc.ManagedChannelBuilder
 
ManagedChannelProvider - Class in io.grpc
Provider of managed channels for transport agnostic consumption.
ManagedChannelProvider() - Constructor for class io.grpc.ManagedChannelProvider
 
ManagedChannelProvider.ProviderNotFoundException - Exception in io.grpc
Thrown when no suitable ManagedChannelProvider objects can be found.
marshaller(T) - Static method in class io.grpc.protobuf.lite.ProtoLiteUtils
Creates a MethodDescriptor.Marshaller for protos of the same type as defaultInstance.
marshaller(T) - Static method in class io.grpc.protobuf.ProtoUtils
Create a MethodDescriptor.Marshaller for protos of the same type as defaultInstance.
maxConcurrentCallsPerConnection(int) - Method in class io.grpc.netty.NettyServerBuilder
The maximum number of concurrent calls permitted for each incoming connection.
maxConnectionAge(long, TimeUnit) - Method in class io.grpc.netty.NettyServerBuilder
Sets a custom max connection age, connection lasting longer than which will be gracefully terminated.
maxConnectionAgeGrace(long, TimeUnit) - Method in class io.grpc.netty.NettyServerBuilder
Sets a custom grace time for the graceful connection termination.
maxConnectionIdle(long, TimeUnit) - Method in class io.grpc.netty.NettyServerBuilder
Sets a custom max connection idle time, connection being idle for longer than which will be gracefully terminated.
maxHeaderListSize(int) - Method in class io.grpc.netty.NettyChannelBuilder
maxHeaderListSize(int) - Method in class io.grpc.netty.NettyServerBuilder
maxHedgedAttempts(int) - Method in class io.grpc.ForwardingChannelBuilder
 
maxHedgedAttempts(int) - Method in class io.grpc.ManagedChannelBuilder
Sets max number of hedged attempts.
maxInboundMessageSize(int) - Method in class io.grpc.ForwardingChannelBuilder
 
maxInboundMessageSize(int) - Method in class io.grpc.inprocess.InProcessChannelBuilder
 
maxInboundMessageSize(int) - Method in class io.grpc.ManagedChannelBuilder
Sets the maximum message size allowed to be received on the channel.
maxInboundMessageSize(int) - Method in class io.grpc.netty.NettyServerBuilder
Sets the maximum message size allowed to be received on the server.
maxInboundMessageSize(int) - Method in class io.grpc.ServerBuilder
Sets the maximum message size allowed to be received on the server.
maxInboundMetadataSize(int) - Method in class io.grpc.ForwardingChannelBuilder
 
maxInboundMetadataSize(int) - Method in class io.grpc.inprocess.InProcessChannelBuilder
Sets the maximum size of metadata allowed to be received.
maxInboundMetadataSize(int) - Method in class io.grpc.inprocess.InProcessServerBuilder
Sets the maximum size of metadata allowed to be received.
maxInboundMetadataSize(int) - Method in class io.grpc.ManagedChannelBuilder
Sets the maximum size of metadata allowed to be received.
maxInboundMetadataSize(int) - Method in class io.grpc.netty.NettyChannelBuilder
Sets the maximum size of metadata allowed to be received.
maxInboundMetadataSize(int) - Method in class io.grpc.netty.NettyServerBuilder
Sets the maximum size of metadata allowed to be received.
maxInboundMetadataSize(int) - Method in class io.grpc.okhttp.OkHttpChannelBuilder
Sets the maximum size of metadata allowed to be received.
maxInboundMetadataSize(int) - Method in class io.grpc.ServerBuilder
Sets the maximum size of metadata allowed to be received.
maxMessageSize(int) - Method in class io.grpc.netty.NettyServerBuilder
Deprecated.
Call NettyServerBuilder.maxInboundMessageSize(int) instead. This method will be removed in a future release.
maxRetryAttempts(int) - Method in class io.grpc.ForwardingChannelBuilder
 
maxRetryAttempts(int) - Method in class io.grpc.ManagedChannelBuilder
Sets max number of retry attempts.
maxTraceEvents(int) - Method in class io.grpc.ForwardingChannelBuilder
 
maxTraceEvents(int) - Method in class io.grpc.ManagedChannelBuilder
Sets the maximum number of channel trace events to keep in the tracer for each channel or subchannel.
merge(Metadata) - Method in class io.grpc.Metadata
Perform a simple merge of two sets of metadata.
merge(Metadata, Set<Metadata.Key<?>>) - Method in class io.grpc.Metadata
Merge values from the given set of keys into this set of metadata.
Metadata - Class in io.grpc
Provides access to read and write metadata values to be exchanged during a call.
Metadata() - Constructor for class io.grpc.Metadata
Constructor called by the application layer when it wants to send metadata.
Metadata.AsciiMarshaller<T> - Interface in io.grpc
Marshaller for metadata values that are serialized into ASCII strings.
Metadata.BinaryMarshaller<T> - Interface in io.grpc
Marshaller for metadata values that are serialized into raw binary.
Metadata.BinaryStreamMarshaller<T> - Interface in io.grpc
Marshaller for metadata values that are serialized to an InputStream.
Metadata.Key<T> - Class in io.grpc
Key for metadata entries.
MetadataApplier() - Constructor for class io.grpc.CallCredentials.MetadataApplier
 
MetadataApplier() - Constructor for class io.grpc.CallCredentials2.MetadataApplier
Deprecated.
 
metadataMarshaller(T) - Static method in class io.grpc.protobuf.lite.ProtoLiteUtils
Produce a metadata marshaller for a protobuf type.
metadataMarshaller(T) - Static method in class io.grpc.protobuf.ProtoUtils
Produce a metadata marshaller for a protobuf type.
MetadataUtils - Class in io.grpc.stub
Utility functions for binding and receiving headers.
MethodDescriptor<ReqT,RespT> - Class in io.grpc
Description of a remote method used by Channel to initiate a call.
MethodDescriptor.Builder<ReqT,RespT> - Class in io.grpc
A builder for a MethodDescriptor.
MethodDescriptor.Marshaller<T> - Interface in io.grpc
A typed abstraction over message serialization and deserialization, a.k.a.
MethodDescriptor.MethodType - Enum in io.grpc
The call type of a method.
MethodDescriptor.PrototypeMarshaller<T> - Interface in io.grpc
A marshaller that uses a fixed instance of the type it produces.
MethodDescriptor.ReflectableMarshaller<T> - Interface in io.grpc
A marshaller that supports retrieving it's type parameter T at runtime.
minimum(Deadline) - Method in class io.grpc.Deadline
Return the minimum deadline of this or an other deadline.
MoreCallCredentials - Class in io.grpc.auth
A utility class that converts other types of credentials to CallCredentials.
MutableHandlerRegistry - Class in io.grpc.util
Default implementation of MutableHandlerRegistry.
MutableHandlerRegistry() - Constructor for class io.grpc.util.MutableHandlerRegistry
 

N

name() - Method in class io.grpc.Metadata.Key
 
NameResolver - Class in io.grpc
A pluggable component that resolves a target URI and return addresses to the caller.
NameResolver() - Constructor for class io.grpc.NameResolver
 
NameResolver.Args - Class in io.grpc
Information that a NameResolver.Factory uses to create a NameResolver.
NameResolver.Args.Builder - Class in io.grpc
Builder for NameResolver.Args.
NameResolver.ConfigOrError - Class in io.grpc
Gets the attributes associated with the addresses resolved by name resolution.
NameResolver.Factory - Class in io.grpc
Factory that creates NameResolver instances.
NameResolver.Helper - Class in io.grpc
Deprecated.
use NameResolver.Args instead.
NameResolver.Listener - Interface in io.grpc
Receives address updates.
NameResolver.Listener2 - Class in io.grpc
Receives address updates.
NameResolver.ResolutionResult - Class in io.grpc
Represents the results from a Name Resolver.
NameResolver.ResolutionResult.Builder - Class in io.grpc
NameResolver.ResolutionResultAttr - Annotation Type in io.grpc
Annotation for name resolution result attributes.
NameResolver.ServiceConfigParser - Class in io.grpc
Parses and validates service configuration.
nameResolverFactory(NameResolver.Factory) - Method in class io.grpc.ForwardingChannelBuilder
Deprecated.
nameResolverFactory(NameResolver.Factory) - Method in class io.grpc.ManagedChannelBuilder
Deprecated.
Most usages should use a globally-registered NameResolverProvider instead, with either the SPI mechanism or NameResolverRegistry.register(io.grpc.NameResolverProvider). Replacements for all use-cases are not necessarily available yet. See #7133.
NameResolverProvider - Class in io.grpc
Provider of name resolvers for name agnostic consumption.
NameResolverProvider() - Constructor for class io.grpc.NameResolverProvider
 
NameResolverRegistry - Class in io.grpc
Registry of NameResolverProviders.
NameResolverRegistry() - Constructor for class io.grpc.NameResolverRegistry
 
nanoTime() - Method in class io.grpc.Deadline.Ticker
Returns the number of nanoseconds since this source's epoch.
NegotiationType - Enum in io.grpc.netty
Identifies the negotiation used for starting up HTTP/2.
negotiationType(NegotiationType) - Method in class io.grpc.netty.NettyChannelBuilder
Sets the negotiation type for the HTTP/2 connection.
NegotiationType - Enum in io.grpc.okhttp
negotiationType(NegotiationType) - Method in class io.grpc.okhttp.OkHttpChannelBuilder
NettyChannelBuilder - Class in io.grpc.netty
A builder to help simplify construction of channels using the Netty transport.
NettyChannelBuilder.LocalSocketPicker - Class in io.grpc.netty
This class is meant to be overriden with a custom implementation of NettyChannelBuilder.LocalSocketPicker.createSocketAddress(java.net.SocketAddress, io.grpc.Attributes).
NettyChannelProvider - Class in io.grpc.netty
Provider for NettyChannelBuilder instances.
NettyChannelProvider() - Constructor for class io.grpc.netty.NettyChannelProvider
 
NettyServerBuilder - Class in io.grpc.netty
A builder to help simplify the construction of a Netty-based GRPC server.
NettyServerProvider - Class in io.grpc.netty
Provider for NettyChannelBuilder instances.
NettyServerProvider() - Constructor for class io.grpc.netty.NettyServerProvider
 
newAttachHeadersInterceptor(Metadata) - Static method in class io.grpc.stub.MetadataUtils
Returns a client interceptor that attaches a set of headers to requests.
newBuilder(Attributes) - Static method in class io.grpc.Attributes
Deprecated.
Use Attributes.toBuilder() on the Attributes instance instead. This method will be removed in the future.
newBuilder() - Static method in class io.grpc.Attributes
Create a new builder.
newBuilder() - Static method in class io.grpc.ClientStreamTracer.StreamInfo
Creates an empty Builder.
newBuilder() - Static method in class io.grpc.HttpConnectProxiedSocketAddress
Create a new builder.
newBuilder() - Static method in class io.grpc.LoadBalancer.CreateSubchannelArgs
Creates a new builder.
newBuilder() - Static method in class io.grpc.LoadBalancer.ResolvedAddresses
Factory for constructing a new Builder.
newBuilder() - Static method in class io.grpc.MethodDescriptor
Creates a new builder for a MethodDescriptor.
newBuilder(MethodDescriptor.Marshaller<ReqT>, MethodDescriptor.Marshaller<RespT>) - Static method in class io.grpc.MethodDescriptor
Creates a new builder for a MethodDescriptor.
newBuilder() - Static method in class io.grpc.NameResolver.Args
Creates a new builder.
newBuilder() - Static method in class io.grpc.NameResolver.ResolutionResult
Constructs a new builder of a name resolution result.
newBuilder(String) - Static method in class io.grpc.ServiceDescriptor
Creates a new builder for a ServiceDescriptor.
newCall(MethodDescriptor<RequestT, ResponseT>, CallOptions) - Method in class io.grpc.Channel
Create a ClientCall to the remote operation specified by the given MethodDescriptor.
newCaptureMetadataInterceptor(AtomicReference<Metadata>, AtomicReference<Metadata>) - Static method in class io.grpc.stub.MetadataUtils
Captures the last received metadata on a channel.
newClientStreamTracer(CallOptions, Metadata) - Method in class io.grpc.ClientStreamTracer.Factory
newClientStreamTracer(ClientStreamTracer.StreamInfo, Metadata) - Method in class io.grpc.ClientStreamTracer.Factory
Creates a ClientStreamTracer for a new client stream.
newEmptyInstance() - Static method in class io.grpc.CompressorRegistry
Returns a new instance with no registered compressors.
newHealthCheckingLoadBalancer(LoadBalancer.Factory, LoadBalancer.Helper) - Static method in class io.grpc.services.HealthCheckingLoadBalancerUtil
Creates a health-checking-capable LoadBalancer.
newInstance() - Static method in class io.grpc.protobuf.services.ProtoReflectionService
Creates a instance of ProtoReflectionService.
newInstance(int) - Static method in class io.grpc.services.ChannelzService
Creates an instance.
newLoadBalancer(LoadBalancer.Helper) - Method in class io.grpc.grpclb.GrpclbLoadBalancerProvider
 
newLoadBalancer(LoadBalancer.Helper) - Method in class io.grpc.LoadBalancer.Factory
Creates a LoadBalancer that will be used inside a channel.
newNameResolver(URI, Attributes) - Method in class io.grpc.NameResolver.Factory
Deprecated.
Implement NameResolver.Factory.newNameResolver(URI, NameResolver.Helper) instead. This is going to be deleted in a future release.
newNameResolver(URI, NameResolver.Helper) - Method in class io.grpc.NameResolver.Factory
newNameResolver(URI, NameResolver.Args) - Method in class io.grpc.NameResolver.Factory
Creates a NameResolver for the given target URI, or null if the given URI cannot be resolved by this factory.
newServerStreamTracer(String, Metadata) - Method in class io.grpc.ServerStreamTracer.Factory
Creates a ServerStreamTracer for a new server stream.
newSslSocketFactoryForCa(Provider, File) - Static method in class io.grpc.testing.TestUtils
Deprecated.
Not for public use
newStub(AbstractStub.StubFactory<T>, Channel) - Static method in class io.grpc.stub.AbstractAsyncStub
Returns a new async stub with the given channel for the provided method configurations.
newStub(AbstractStub.StubFactory<T>, Channel, CallOptions) - Static method in class io.grpc.stub.AbstractAsyncStub
Returns a new async stub with the given channel for the provided method configurations.
newStub(AbstractStub.StubFactory<T>, Channel) - Static method in class io.grpc.stub.AbstractBlockingStub
Returns a new blocking stub with the given channel for the provided method configurations.
newStub(AbstractStub.StubFactory<T>, Channel, CallOptions) - Static method in class io.grpc.stub.AbstractBlockingStub
Returns a new blocking stub with the given channel for the provided method configurations.
newStub(AbstractStub.StubFactory<T>, Channel) - Static method in class io.grpc.stub.AbstractFutureStub
Returns a new future stub with the given channel for the provided method configurations.
newStub(AbstractStub.StubFactory<T>, Channel, CallOptions) - Static method in class io.grpc.stub.AbstractFutureStub
Returns a new future stub with the given channel for the provided method configurations.
newStub(AbstractStub.StubFactory<T>, Channel) - Static method in class io.grpc.stub.AbstractStub
Returns a new stub with the given channel for the provided method configurations.
newStub(AbstractStub.StubFactory<T>, Channel, CallOptions) - Static method in class io.grpc.stub.AbstractStub
Returns a new stub with the given channel for the provided method configurations.
newStub(Channel, CallOptions) - Method in interface io.grpc.stub.AbstractStub.StubFactory
 
NONE - Static variable in class io.grpc.Codec.Identity
Special sentinel codec indicating that no compression should be used.
NOT_FOUND - Static variable in class io.grpc.Status
Some requested entity (e.g., file or directory) was not found.
notifyUnused() - Method in class io.grpc.netty.GrpcHttp2ConnectionHandler
Calling this method indicates that the channel will no longer be used.
notifyWhenStateChanged(ConnectivityState, Runnable) - Method in class io.grpc.ManagedChannel
Registers a one-off callback that will be run if the connectivity state of the channel diverges from the given source, which is typically what has just been returned by ManagedChannel.getState(boolean).

O

of(String) - Static method in class io.grpc.Attributes.Key
Deprecated.
use Attributes.Key.create(java.lang.String) instead. This method will be removed in the future.
of(String, T) - Static method in class io.grpc.CallOptions.Key
of(String, Metadata.BinaryMarshaller<T>) - Static method in class io.grpc.Metadata.Key
Creates a key for a binary header.
of(String, Metadata.BinaryStreamMarshaller<T>) - Static method in class io.grpc.Metadata.Key
Creates a key for a binary header, serializing to input streams.
of(String, Metadata.AsciiMarshaller<T>) - Static method in class io.grpc.Metadata.Key
Creates a key for an ASCII header.
offloadExecutor(Executor) - Method in class io.grpc.ForwardingChannelBuilder
 
offloadExecutor(Executor) - Method in class io.grpc.ManagedChannelBuilder
Provides a custom executor that will be used for operations that block or are expensive.
offset(long, TimeUnit) - Method in class io.grpc.Deadline
Create a new deadline that is offset from this.
OK - Static variable in class io.grpc.Status
The operation completed successfully.
OkHttpChannelBuilder - Class in io.grpc.okhttp
Convenience class for building channels with the OkHttp transport.
OkHttpChannelBuilder(String, int) - Constructor for class io.grpc.okhttp.OkHttpChannelBuilder
 
OkHttpChannelProvider - Class in io.grpc.okhttp
Provider for OkHttpChannelBuilder instances.
OkHttpChannelProvider() - Constructor for class io.grpc.okhttp.OkHttpChannelProvider
 
onAddresses(List<EquivalentAddressGroup>, Attributes) - Method in interface io.grpc.NameResolver.Listener
Handles updates on resolved addresses and attributes.
onAddresses(List<EquivalentAddressGroup>, Attributes) - Method in class io.grpc.NameResolver.Listener2
Deprecated.
This will be removed in 1.22.0
onCancel() - Method in class io.grpc.ServerCall.Listener
The call was cancelled and the server is encouraged to abort processing to save resources, since the client will not process any further messages.
onClose(Status, Metadata) - Method in class io.grpc.ClientCall.Listener
The ClientCall has been closed.
onComplete() - Method in class io.grpc.ServerCall.Listener
The call is considered complete and ServerCall.Listener.onCancel() is guaranteed not to be called.
onCompleted() - Method in interface io.grpc.stub.StreamObserver
Receives a notification of successful stream completion.
onCompleted() - Method in class io.grpc.testing.StreamRecorder
Deprecated.
 
onError(Status) - Method in interface io.grpc.NameResolver.Listener
Handles an error from the resolver.
onError(Status) - Method in class io.grpc.NameResolver.Listener2
Handles a name resolving error from the resolver.
onError(Throwable) - Method in interface io.grpc.stub.StreamObserver
Receives a terminating error from the stream.
onError(Throwable) - Method in class io.grpc.testing.StreamRecorder
Deprecated.
 
onHalfClose() - Method in class io.grpc.ServerCall.Listener
The client completed all message sending.
onHeaders(Metadata) - Method in class io.grpc.ClientCall.Listener
The response headers have been received.
onMessage(T) - Method in class io.grpc.ClientCall.Listener
A response message has been received.
onMessage(RespT) - Method in class io.grpc.ForwardingClientCallListener
 
onMessage(ReqT) - Method in class io.grpc.ForwardingServerCallListener
 
onMessage(ReqT) - Method in class io.grpc.ServerCall.Listener
A request message has been received.
onNext(V) - Method in interface io.grpc.stub.StreamObserver
Receives a value from the stream.
onNext(T) - Method in class io.grpc.testing.StreamRecorder
Deprecated.
 
onReady() - Method in class io.grpc.ClientCall.Listener
This indicates that the ClientCall may now be capable of sending additional messages (via ClientCall.sendMessage(ReqT)) without requiring excessive buffering internally.
onReady() - Method in class io.grpc.ServerCall.Listener
This indicates that the call may now be capable of sending additional messages (via ServerCall.sendMessage(RespT)) without requiring excessive buffering internally.
onResult(NameResolver.ResolutionResult) - Method in class io.grpc.NameResolver.Listener2
Handles updates on resolved addresses and attributes.
onSubchannelState(ConnectivityStateInfo) - Method in interface io.grpc.LoadBalancer.SubchannelStateListener
Handles a state change on a Subchannel.
originalName() - Method in class io.grpc.Metadata.Key
 
OUT_OF_RANGE - Static variable in class io.grpc.Status
Operation was attempted past the valid range.
outboundHeaders() - Method in class io.grpc.ClientStreamTracer
Headers has been sent to the socket.
outboundHeaders() - Method in class io.grpc.util.ForwardingClientStreamTracer
 
outboundMessage(int) - Method in class io.grpc.StreamTracer
An outbound message has been passed to the stream.
outboundMessage(int) - Method in class io.grpc.util.ForwardingClientStreamTracer
 
outboundMessageSent(int, long, long) - Method in class io.grpc.StreamTracer
An outbound message has been serialized and sent to the transport.
outboundMessageSent(int, long, long) - Method in class io.grpc.util.ForwardingClientStreamTracer
 
outboundUncompressedSize(long) - Method in class io.grpc.StreamTracer
The uncompressed size of some outbound data is revealed.
outboundUncompressedSize(long) - Method in class io.grpc.util.ForwardingClientStreamTracer
 
outboundWireSize(long) - Method in class io.grpc.StreamTracer
The wire size of some outbound data is revealed.
outboundWireSize(long) - Method in class io.grpc.util.ForwardingClientStreamTracer
 
overrideAuthority(String) - Method in class io.grpc.ForwardingChannelBuilder
 
overrideAuthority(String) - Method in class io.grpc.ManagedChannelBuilder
Overrides the authority used with TLS and HTTP virtual hosting.

P

PARAMS_DEFAULT_PORT - Static variable in class io.grpc.NameResolver.Factory
Deprecated.
this will be deleted along with NameResolver.Factory.newNameResolver(URI, Attributes) in a future release.
PARAMS_DEFAULT_PORT - Static variable in class io.grpc.NameResolverProvider
Deprecated.
PARAMS_PROXY_DETECTOR - Static variable in class io.grpc.NameResolver.Factory
Deprecated.
this will be deleted along with NameResolver.Factory.newNameResolver(URI, Attributes) in a future release
parse(InputStream) - Method in interface io.grpc.MethodDescriptor.Marshaller
Given an InputStream parse it into an instance of the declared type so that it can be passed to application code.
parseAsciiString(String) - Method in interface io.grpc.Metadata.AsciiMarshaller
Parse a serialized metadata value from an ASCII string.
parseBytes(byte[]) - Method in interface io.grpc.Metadata.BinaryMarshaller
Parse a serialized metadata value from bytes.
parseLoadBalancingPolicyConfig(Map<String, ?>) - Method in class io.grpc.grpclb.GrpclbLoadBalancerProvider
 
parseLoadBalancingPolicyConfig(Map<String, ?>) - Method in class io.grpc.LoadBalancerProvider
Parses the config for the Load Balancing policy unpacked from the service config.
parseRequest(InputStream) - Method in class io.grpc.MethodDescriptor
Parse an incoming request message.
parseResponse(InputStream) - Method in class io.grpc.MethodDescriptor
Parse a response payload from the given InputStream.
parseServiceConfig(Map<String, ?>) - Method in class io.grpc.NameResolver.Helper
Deprecated.
Parses and validates the service configuration chosen by the name resolver.
parseServiceConfig(Map<String, ?>) - Method in class io.grpc.NameResolver.ServiceConfigParser
Parses and validates the service configuration chosen by the name resolver.
parseStream(InputStream) - Method in interface io.grpc.Metadata.BinaryStreamMarshaller
Parses a serialized metadata value from an InputStream.
PERMISSION_DENIED - Static variable in class io.grpc.Status
The caller does not have permission to execute the specified operation.
permitKeepAliveTime(long, TimeUnit) - Method in class io.grpc.netty.NettyServerBuilder
Specify the most aggressive keep-alive time clients are permitted to configure.
permitKeepAliveWithoutCalls(boolean) - Method in class io.grpc.netty.NettyServerBuilder
Sets whether to allow clients to send keep-alive HTTP/2 PINGs even if there are no outstanding RPCs on the connection.
perRpcBufferLimit(long) - Method in class io.grpc.ForwardingChannelBuilder
 
perRpcBufferLimit(long) - Method in class io.grpc.ManagedChannelBuilder
Sets the per RPC buffer limit in bytes used for retry.
pickSubchannel(LoadBalancer.PickSubchannelArgs) - Method in class io.grpc.LoadBalancer.SubchannelPicker
Make a balancing decision for a new RPC.
PickSubchannelArgs() - Constructor for class io.grpc.LoadBalancer.PickSubchannelArgs
 
preferredTestCiphers() - Static method in class io.grpc.testing.TestUtils
Deprecated.
Not for public use
priority() - Method in class io.grpc.ManagedChannelProvider
A priority, from 0 to 10 that this provider should be used, taking the current environment into consideration.
priority() - Method in class io.grpc.NameResolverProvider
A priority, from 0 to 10 that this provider should be used, taking the current environment into consideration.
priority() - Method in class io.grpc.netty.NettyChannelProvider
 
priority() - Method in class io.grpc.netty.NettyServerProvider
 
priority() - Method in class io.grpc.okhttp.OkHttpChannelProvider
 
priority() - Method in class io.grpc.ServerProvider
A priority, from 0 to 10 that this provider should be used, taking the current environment into consideration.
propagateCauseWithStatus(boolean) - Method in class io.grpc.inprocess.InProcessChannelBuilder
Sets whether to include the cause with the status that is propagated forward from the InProcessTransport.
ProtocolNegotiationEvent - Class in io.grpc.netty
Represents a completion of a protocol negotiation stage.
protocolNegotiator(ProtocolNegotiator) - Method in class io.grpc.netty.NettyServerBuilder
Sets the ProtocolNegotiator to be used.
ProtoFileDescriptorSupplier - Interface in io.grpc.protobuf
Provides access to the underlying proto file descriptor.
ProtoLiteUtils - Class in io.grpc.protobuf.lite
Utility methods for using protobuf with grpc.
ProtoMethodDescriptorSupplier - Interface in io.grpc.protobuf
Provides access to the underlying proto service method descriptor.
ProtoReflectionService - Class in io.grpc.protobuf.services
Provides a reflection service for Protobuf services (including the reflection service itself).
ProtoServiceDescriptorSupplier - Interface in io.grpc.protobuf
Provides access to the underlying proto service descriptor.
ProtoUtils - Class in io.grpc.protobuf
Utility methods for using protobuf with grpc.
provider() - Static method in class io.grpc.ManagedChannelProvider
Returns the ClassLoader-wide default channel.
provider() - Static method in class io.grpc.ServerProvider
Returns the ClassLoader-wide default server.
ProviderNotFoundException(String) - Constructor for exception io.grpc.ManagedChannelProvider.ProviderNotFoundException
 
providers() - Static method in class io.grpc.NameResolverProvider
Deprecated.
Has no replacement
ProxiedSocketAddress - Class in io.grpc
An address that contains the information about making a connection via a proxy.
ProxiedSocketAddress() - Constructor for class io.grpc.ProxiedSocketAddress
 
proxyDetector(ProxyDetector) - Method in class io.grpc.ForwardingChannelBuilder
 
proxyDetector(ProxyDetector) - Method in class io.grpc.ManagedChannelBuilder
Sets the proxy detector to be used in addresses name resolution.
ProxyDetector - Interface in io.grpc
A utility class to detect which proxy, if any, should be used for a given SocketAddress.
proxyFor(SocketAddress) - Method in interface io.grpc.ProxyDetector
Given a target address, returns a proxied address if a proxy should be used.
put(Metadata.Key<T>, T) - Method in class io.grpc.Metadata
Adds the key, value pair.

R

recordCallMetric(String, double) - Method in class io.grpc.services.CallMetricRecorder
Records a call metric measurement.
recordRequestHeadersInterceptor(AtomicReference<Metadata>) - Static method in class io.grpc.testing.TestUtils
Capture the request headers from a client.
refresh() - Method in class io.grpc.NameResolver
Re-resolve the name.
refreshNameResolution() - Method in class io.grpc.LoadBalancer.Helper
Call NameResolver.refresh() on the channel's resolver.
refreshNameResolution() - Method in class io.grpc.util.ForwardingLoadBalancerHelper
 
register(Compressor) - Method in class io.grpc.CompressorRegistry
Registers a compressor for both decompression and message encoding negotiation.
register(LoadBalancerProvider) - Method in class io.grpc.LoadBalancerRegistry
Register a provider.
register(NameResolverProvider) - Method in class io.grpc.NameResolverRegistry
Register a provider.
register(T) - Method in class io.grpc.testing.GrpcCleanupRule
Registers the given channel to the rule.
register(T) - Method in class io.grpc.testing.GrpcCleanupRule
Registers the given server to the rule.
remove(Metadata.Key<T>, T) - Method in class io.grpc.Metadata
Removes the first occurrence of value for key.
removeAll(Metadata.Key<T>) - Method in class io.grpc.Metadata
Remove all values for the given key.
removeListener(Context.CancellationListener) - Method in class io.grpc.Context.CancellableContext
 
removeListener(Context.CancellationListener) - Method in class io.grpc.Context
removeService(ServerServiceDefinition) - Method in class io.grpc.util.MutableHandlerRegistry
Removes a registered service
request(int) - Method in class io.grpc.ClientCall
Requests up to the given number of messages from the call to be delivered to ClientCall.Listener.onMessage(Object).
request(int) - Method in class io.grpc.ServerCall
Requests up to the given number of messages from the call to be delivered to ServerCall.Listener.onMessage(Object).
request(int) - Method in class io.grpc.stub.CallStreamObserver
Requests the peer to produce count more messages to be delivered to the 'inbound' StreamObserver.
requestConnection() - Method in class io.grpc.LoadBalancer
The channel asks the LoadBalancer to establish connections now (if applicable) so that the upcoming RPC may then just pick a ready connection without waiting for connections.
requestConnection() - Method in class io.grpc.LoadBalancer.Subchannel
Asks the Subchannel to create a connection (aka transport), if there isn't an active one.
requestConnection() - Method in class io.grpc.LoadBalancer.SubchannelPicker
Deprecated.
requestConnection() - Method in class io.grpc.util.ForwardingLoadBalancer
 
requestConnection() - Method in class io.grpc.util.ForwardingSubchannel
 
RequestInfo() - Constructor for class io.grpc.CallCredentials.RequestInfo
 
resetConnectBackoff() - Method in class io.grpc.ManagedChannel
For subchannels that are in TRANSIENT_FAILURE state, short-circuit the backoff timer and make them reconnect immediately.
RESOURCE_EXHAUSTED - Static variable in class io.grpc.Status
Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space.
retryBufferSize(long) - Method in class io.grpc.ForwardingChannelBuilder
 
retryBufferSize(long) - Method in class io.grpc.ManagedChannelBuilder
Sets the retry buffer size in bytes.
ROOT - Static variable in class io.grpc.Context
The logical root context which is the ultimate ancestor of all contexts.
RpcMethod - Annotation Type in io.grpc.stub.annotations
RpcMethod contains a limited subset of information about the RPC to assist Java Annotation Processors.
run(Runnable) - Method in class io.grpc.Context
Immediately run a Runnable with this context as the Context.current() context.
runOnExpiration(Runnable, ScheduledExecutorService) - Method in class io.grpc.Deadline
Schedule a task to be run when the deadline expires.
runSerialized(Runnable) - Method in class io.grpc.LoadBalancer.Helper
Deprecated.
use/implement getSynchronizationContext() instead
runSerialized(Runnable) - Method in class io.grpc.util.ForwardingLoadBalancerHelper
Deprecated.

S

schedule(Runnable, long, TimeUnit, ScheduledExecutorService) - Method in class io.grpc.SynchronizationContext
Schedules a task to be added and run via SynchronizationContext.execute(java.lang.Runnable) after a delay.
scheduledExecutorService(ScheduledExecutorService) - Method in class io.grpc.inprocess.InProcessChannelBuilder
Provides a custom scheduled executor service.
scheduledExecutorService(ScheduledExecutorService) - Method in class io.grpc.inprocess.InProcessServerBuilder
Provides a custom scheduled executor service.
scheduledExecutorService(ScheduledExecutorService) - Method in class io.grpc.okhttp.OkHttpChannelBuilder
Provides a custom scheduled executor service.
SecurityLevel - Enum in io.grpc
The level of security guarantee in communications.
sendHeaders(Metadata) - Method in class io.grpc.ServerCall
Send response header metadata prior to sending a response message.
sendMessage(ReqT) - Method in class io.grpc.ClientCall
Send a request message to the server.
sendMessage(ReqT) - Method in class io.grpc.ForwardingClientCall
 
sendMessage(RespT) - Method in class io.grpc.ForwardingServerCall
 
sendMessage(RespT) - Method in class io.grpc.ServerCall
Send a response message.
Server - Class in io.grpc
Server for listening for and dispatching incoming calls.
Server() - Constructor for class io.grpc.Server
 
ServerBuilder<T extends ServerBuilder<T>> - Class in io.grpc
A builder for Server instances.
ServerBuilder() - Constructor for class io.grpc.ServerBuilder
 
ServerCall<ReqT,RespT> - Class in io.grpc
Encapsulates a single call received from a remote client.
ServerCall() - Constructor for class io.grpc.ServerCall
 
ServerCall.Listener<ReqT> - Class in io.grpc
Callbacks for consuming incoming RPC messages.
ServerCallHandler<RequestT,ResponseT> - Interface in io.grpc
Interface to initiate processing of incoming remote calls.
ServerCallInfo() - Constructor for class io.grpc.ServerStreamTracer.ServerCallInfo
 
ServerCalls - Class in io.grpc.stub
Utility functions for adapting ServerCallHandlers to application service implementation, meant to be used by the generated code.
ServerCalls.BidiStreamingMethod<ReqT,RespT> - Interface in io.grpc.stub
Adaptor to a bidirectional streaming method.
ServerCalls.ClientStreamingMethod<ReqT,RespT> - Interface in io.grpc.stub
Adaptor to a client streaming method.
ServerCalls.ServerStreamingMethod<ReqT,RespT> - Interface in io.grpc.stub
Adaptor to a server streaming method.
ServerCalls.UnaryMethod<ReqT,RespT> - Interface in io.grpc.stub
Adaptor to a unary call method.
serverCallStarted(ServerStreamTracer.ServerCallInfo<?, ?>) - Method in class io.grpc.ServerStreamTracer
Called when ServerCall is created.
serverCallStarted(ServerCall<?, ?>) - Method in class io.grpc.ServerStreamTracer
Deprecated.
Implement ServerStreamTracer.serverCallStarted(ServerCallInfo) instead. This method will be removed in a future release of gRPC.
ServerCallStreamObserver<V> - Class in io.grpc.stub
A refinement of CallStreamObserver to allows for interaction with call cancellation events on the server side.
ServerCallStreamObserver() - Constructor for class io.grpc.stub.ServerCallStreamObserver
 
ServerInterceptor - Interface in io.grpc
Interface for intercepting incoming calls before that are dispatched by ServerCallHandler.
ServerInterceptors - Class in io.grpc
Utility methods for working with ServerInterceptors.
ServerMethodDefinition<ReqT,RespT> - Class in io.grpc
Definition of a method exposed by a Server.
ServerProvider - Class in io.grpc
Provider of servers for transport agnostic consumption.
ServerProvider() - Constructor for class io.grpc.ServerProvider
 
serverReflectionInfo(StreamObserver<ServerReflectionResponse>) - Method in class io.grpc.protobuf.services.ProtoReflectionService
 
serverSendsOneMessage() - Method in enum io.grpc.MethodDescriptor.MethodType
Returns true for UNARY and CLIENT_STREAMING, which do not permit the server to stream.
ServerServiceDefinition - Class in io.grpc
Definition of a service to be exposed via a Server.
ServerServiceDefinition.Builder - Class in io.grpc
Builder for constructing Service instances.
ServerStreamTracer - Class in io.grpc
Listens to events on a stream to collect metrics.
ServerStreamTracer() - Constructor for class io.grpc.ServerStreamTracer
 
ServerStreamTracer.Factory - Class in io.grpc
 
ServerStreamTracer.ServerCallInfo<ReqT,RespT> - Class in io.grpc
A data class with info about the started ServerCall.
ServerTransportFilter - Class in io.grpc
Listens on server transport life-cycle events, with the capability to read and/or change transport attributes.
ServerTransportFilter() - Constructor for class io.grpc.ServerTransportFilter
 
SERVICE_NAME_ALL_SERVICES - Static variable in class io.grpc.services.HealthStatusManager
The special "service name" that represent all services on a GRPC server.
ServiceConfigParser() - Constructor for class io.grpc.NameResolver.ServiceConfigParser
 
ServiceDescriptor - Class in io.grpc
Descriptor for a service.
ServiceDescriptor(String, MethodDescriptor<?, ?>...) - Constructor for class io.grpc.ServiceDescriptor
Constructs a new Service Descriptor.
ServiceDescriptor(String, Collection<MethodDescriptor<?, ?>>) - Constructor for class io.grpc.ServiceDescriptor
Constructs a new Service Descriptor.
ServiceDescriptor.Builder - Class in io.grpc
A builder for a ServiceDescriptor.
set(Attributes.Key<T>, T) - Method in class io.grpc.Attributes.Builder
 
setAddresses(EquivalentAddressGroup) - Method in class io.grpc.LoadBalancer.CreateSubchannelArgs.Builder
The addresses to connect to.
setAddresses(List<EquivalentAddressGroup>) - Method in class io.grpc.LoadBalancer.CreateSubchannelArgs.Builder
The addresses to connect to.
setAddresses(List<EquivalentAddressGroup>) - Method in class io.grpc.LoadBalancer.ResolvedAddresses.Builder
Sets the addresses.
setAddresses(List<EquivalentAddressGroup>) - Method in class io.grpc.NameResolver.ResolutionResult.Builder
Sets the addresses resolved by name resolution.
setAll(Attributes) - Method in class io.grpc.Attributes.Builder
 
setAttributes(Attributes) - Method in class io.grpc.LoadBalancer.CreateSubchannelArgs.Builder
Attributes provided here will be included in LoadBalancer.Subchannel.getAttributes().
setAttributes(Attributes) - Method in class io.grpc.LoadBalancer.ResolvedAddresses.Builder
Sets the attributes.
setAttributes(Attributes) - Method in class io.grpc.NameResolver.ResolutionResult.Builder
Sets the attributes for the addresses resolved by name resolution.
setBinaryLog(BinaryLog) - Method in class io.grpc.ForwardingChannelBuilder
 
setBinaryLog(BinaryLog) - Method in class io.grpc.ManagedChannelBuilder
Sets the BinaryLog object that this channel should log to.
setBinaryLog(BinaryLog) - Method in class io.grpc.ServerBuilder
Sets the BinaryLog object that this server should log to.
setCallOptions(CallOptions) - Method in class io.grpc.ClientStreamTracer.StreamInfo.Builder
Sets the effective CallOptions of the call.
setChannelLogger(ChannelLogger) - Method in class io.grpc.NameResolver.Args.Builder
setCompression(String) - Method in class io.grpc.ServerCall
Sets the compression algorithm for this call.
setCompression(String) - Method in class io.grpc.stub.ServerCallStreamObserver
Sets the compression algorithm to use for the call.
setDefaultPort(int) - Method in class io.grpc.NameResolver.Args.Builder
setExtensionRegistry(ExtensionRegistryLite) - Static method in class io.grpc.protobuf.lite.ProtoLiteUtils
Sets the global registry for proto marshalling shared across all servers and clients.
setExtensionRegistry(ExtensionRegistry) - Static method in class io.grpc.protobuf.ProtoUtils
Sets the global registry for proto marshalling shared across all servers and clients.
setFullMethodName(String) - Method in class io.grpc.MethodDescriptor.Builder
Sets the fully qualified (service and method) method name.
setIdempotent(boolean) - Method in class io.grpc.MethodDescriptor.Builder
Sets whether the method is idempotent.
setLoadBalancingPolicyConfig(Object) - Method in class io.grpc.LoadBalancer.ResolvedAddresses.Builder
Sets the load balancing policy config.
setMessageCompression(boolean) - Method in class io.grpc.ClientCall
Enables per-message compression, if an encoding type has been negotiated.
setMessageCompression(boolean) - Method in class io.grpc.ServerCall
Enables per-message compression, if an encoding type has been negotiated.
setMessageCompression(boolean) - Method in class io.grpc.stub.CallStreamObserver
Sets message compression for subsequent calls to StreamObserver.onNext(V).
setName(String) - Method in class io.grpc.ServiceDescriptor.Builder
Sets the name.
setOffloadExecutor(Executor) - Method in class io.grpc.NameResolver.Args.Builder
setOnCancelHandler(Runnable) - Method in class io.grpc.stub.ServerCallStreamObserver
Sets a Runnable to be called if the call is cancelled and the server is encouraged to abort processing to save resources, since the client will not process any further messages.
setOnReadyHandler(Runnable) - Method in class io.grpc.stub.CallStreamObserver
Set a Runnable that will be executed every time the stream CallStreamObserver.isReady() state changes from false to true.
setPassword(String) - Method in class io.grpc.HttpConnectProxiedSocketAddress.Builder
Sets the password used to connect to the proxy.
setProxyAddress(SocketAddress) - Method in class io.grpc.HttpConnectProxiedSocketAddress.Builder
Sets the address to the proxy, which is already resolved.
setProxyDetector(ProxyDetector) - Method in class io.grpc.NameResolver.Args.Builder
setRequestMarshaller(MethodDescriptor.Marshaller<ReqT>) - Method in class io.grpc.MethodDescriptor.Builder
Sets the request marshaller.
setResponseMarshaller(MethodDescriptor.Marshaller<RespT>) - Method in class io.grpc.MethodDescriptor.Builder
Sets the response marshaller.
setSafe(boolean) - Method in class io.grpc.MethodDescriptor.Builder
Sets whether this method is safe.
setSampledToLocalTracing(boolean) - Method in class io.grpc.MethodDescriptor.Builder
Sets whether RPCs for this method may be sampled into the local tracing store.
setScheduledExecutorService(ScheduledExecutorService) - Method in class io.grpc.NameResolver.Args.Builder
setSchemaDescriptor(Object) - Method in class io.grpc.MethodDescriptor.Builder
Sets the schema descriptor for this builder.
setSchemaDescriptor(Object) - Method in class io.grpc.ServiceDescriptor.Builder
Sets the schema descriptor for this builder.
setServiceConfig(NameResolver.ConfigOrError) - Method in class io.grpc.NameResolver.ResolutionResult.Builder
Sets the Service Config parsed by NameResolver.Helper.parseServiceConfig(Map).
setServiceConfigParser(NameResolver.ServiceConfigParser) - Method in class io.grpc.NameResolver.Args.Builder
setStatsEnabled(boolean) - Method in class io.grpc.netty.NettyChannelBuilder
 
setStatsEnabled(boolean) - Method in class io.grpc.netty.NettyServerBuilder
 
setStatsRecordRealTimeMetrics(boolean) - Method in class io.grpc.netty.NettyChannelBuilder
 
setStatsRecordRealTimeMetrics(boolean) - Method in class io.grpc.netty.NettyServerBuilder
 
setStatsRecordStartedRpcs(boolean) - Method in class io.grpc.netty.NettyChannelBuilder
 
setStatsRecordStartedRpcs(boolean) - Method in class io.grpc.netty.NettyServerBuilder
 
setStatus(String, HealthCheckResponse.ServingStatus) - Method in class io.grpc.services.HealthStatusManager
Updates the status of the server.
setSynchronizationContext(SynchronizationContext) - Method in class io.grpc.NameResolver.Args.Builder
setTargetAddress(InetSocketAddress) - Method in class io.grpc.HttpConnectProxiedSocketAddress.Builder
Sets the address to the target.
setTimeout(long, TimeUnit) - Method in class io.grpc.testing.GrpcCleanupRule
Sets a positive total time limit for the automatic resource cleanup.
setTracingEnabled(boolean) - Method in class io.grpc.netty.NettyChannelBuilder
 
setTracingEnabled(boolean) - Method in class io.grpc.netty.NettyServerBuilder
 
setTransportAttrs(Attributes) - Method in class io.grpc.ClientStreamTracer.StreamInfo.Builder
Sets the attributes of the transport that this stream was created on.
setType(MethodDescriptor.MethodType) - Method in class io.grpc.MethodDescriptor.Builder
Sets the method type.
setUsername(String) - Method in class io.grpc.HttpConnectProxiedSocketAddress.Builder
Sets the username used to connect to the proxy.
shutdown() - Method in class io.grpc.LoadBalancer
The channel asks the load-balancer to shutdown.
shutdown() - Method in class io.grpc.LoadBalancer.Subchannel
Shuts down the Subchannel.
shutdown() - Method in class io.grpc.ManagedChannel
Initiates an orderly shutdown in which preexisting calls continue but new calls are immediately cancelled.
shutdown() - Method in class io.grpc.NameResolver
Stops the resolution.
shutdown() - Method in class io.grpc.Server
Initiates an orderly shutdown in which preexisting calls continue but new calls are rejected.
shutdown() - Method in class io.grpc.util.ForwardingLoadBalancer
 
shutdown() - Method in class io.grpc.util.ForwardingSubchannel
 
shutdown() - Method in class io.grpc.util.GracefulSwitchLoadBalancer
 
shutdownNow() - Method in class io.grpc.ManagedChannel
Initiates a forceful shutdown in which preexisting and new calls are cancelled.
shutdownNow() - Method in class io.grpc.Server
Initiates a forceful shutdown in which preexisting and new calls are rejected.
SimpleForwardingClientCall(ClientCall<ReqT, RespT>) - Constructor for class io.grpc.ForwardingClientCall.SimpleForwardingClientCall
 
SimpleForwardingClientCallListener(ClientCall.Listener<RespT>) - Constructor for class io.grpc.ForwardingClientCallListener.SimpleForwardingClientCallListener
 
SimpleForwardingServerCall(ServerCall<ReqT, RespT>) - Constructor for class io.grpc.ForwardingServerCall.SimpleForwardingServerCall
 
SimpleForwardingServerCallListener(ServerCall.Listener<ReqT>) - Constructor for class io.grpc.ForwardingServerCallListener.SimpleForwardingServerCallListener
 
socketFactory(SocketFactory) - Method in class io.grpc.okhttp.OkHttpChannelBuilder
Override the default SocketFactory used to create sockets.
sslContext(SslContext) - Method in class io.grpc.netty.NettyChannelBuilder
SSL/TLS context to use instead of the system default.
sslContext(SslContext) - Method in class io.grpc.netty.NettyServerBuilder
Sets the TLS context to use for encryption.
sslSocketFactory(SSLSocketFactory) - Method in class io.grpc.okhttp.OkHttpChannelBuilder
Override the default SSLSocketFactory and enable TLS negotiation.
start(ClientCall.Listener<RespT>, Metadata) - Method in class io.grpc.ClientCall
Start a call, using responseListener for processing response messages.
start(ClientCall.Listener<RespT>, Metadata) - Method in class io.grpc.ClientInterceptors.CheckedForwardingClientCall
 
start(ClientCall.Listener<RespT>, Metadata) - Method in class io.grpc.ForwardingClientCall
 
start(LoadBalancer.SubchannelStateListener) - Method in class io.grpc.LoadBalancer.Subchannel
Starts the Subchannel.
start(NameResolver.Listener) - Method in class io.grpc.NameResolver
Starts the resolution.
start(NameResolver.Listener2) - Method in class io.grpc.NameResolver
Starts the resolution.
start() - Method in class io.grpc.Server
Bind and start the server.
start(LoadBalancer.SubchannelStateListener) - Method in class io.grpc.util.ForwardingSubchannel
 
startCall(ServerCall<RequestT, ResponseT>, Metadata) - Method in interface io.grpc.ServerCallHandler
Produce a non-null listener for the incoming call.
Status - Class in io.grpc
Defines the status of an operation by providing a standard Status.Code in conjunction with an optional descriptive message.
Status.Code - Enum in io.grpc
The set of canonical status codes.
StatusException - Exception in io.grpc
Status in Exception form, for propagating Status information via exceptions.
StatusException(Status) - Constructor for exception io.grpc.StatusException
Constructs an exception with both a status.
StatusException(Status, Metadata) - Constructor for exception io.grpc.StatusException
Constructs an exception with both a status and trailers.
statusFromCancelled(Context) - Static method in class io.grpc.Contexts
Returns the Status of a cancelled context or null if the context is not cancelled.
StatusProto - Class in io.grpc.protobuf
Utility methods for working with Status.
StatusRuntimeException - Exception in io.grpc
Status in RuntimeException form, for propagating Status information via exceptions.
StatusRuntimeException(Status) - Constructor for exception io.grpc.StatusRuntimeException
Constructs the exception with both a status.
StatusRuntimeException(Status, Metadata) - Constructor for exception io.grpc.StatusRuntimeException
Constructs the exception with both a status and trailers.
Storage() - Constructor for class io.grpc.Context.Storage
 
stream(T) - Method in interface io.grpc.MethodDescriptor.Marshaller
Given a message, produce an InputStream for it so that it can be written to the wire.
streamClosed(Status) - Method in class io.grpc.StreamTracer
Stream is closed.
streamClosed(Status) - Method in class io.grpc.util.ForwardingClientStreamTracer
 
StreamObserver<V> - Interface in io.grpc.stub
Receives notifications from an observable stream of messages.
StreamObservers - Class in io.grpc.stub
Utility functions for working with StreamObserver and it's common subclasses like CallStreamObserver.
StreamObservers() - Constructor for class io.grpc.stub.StreamObservers
 
StreamRecorder<T> - Class in io.grpc.testing
Deprecated.
Not for public use
streamRequest(ReqT) - Method in class io.grpc.MethodDescriptor
Convert a request message to an InputStream.
streamResponse(RespT) - Method in class io.grpc.MethodDescriptor
Serialize an outgoing response message.
StreamTracer - Class in io.grpc
Listens to events on a stream to collect metrics.
StreamTracer() - Constructor for class io.grpc.StreamTracer
 
Subchannel() - Constructor for class io.grpc.LoadBalancer.Subchannel
 
SubchannelPicker() - Constructor for class io.grpc.LoadBalancer.SubchannelPicker
 
switchTo(LoadBalancer.Factory) - Method in class io.grpc.util.GracefulSwitchLoadBalancer
Gracefully switch to a new policy defined by the given factory, if the given factory isn't equal to the current one.
SynchronizationContext - Class in io.grpc
A synchronization context is a queue of tasks that run in sequence.
SynchronizationContext(Thread.UncaughtExceptionHandler) - Constructor for class io.grpc.SynchronizationContext
Creates a SynchronizationContext.
SynchronizationContext.ScheduledHandle - Class in io.grpc

T

TestMethodDescriptors - Class in io.grpc.testing
A collection of method descriptor constructors useful for tests.
TestUtils - Class in io.grpc.testing
Common utility functions useful for writing tests.
thisT() - Method in class io.grpc.ForwardingChannelBuilder
Returns the correctly typed version of the builder.
thisUsesUnstableApi() - Method in class io.grpc.CallCredentials
Should be a noop but never called; tries to make it clearer to implementors that they may break in the future.
throwIfNotInThisSynchronizationContext() - Method in class io.grpc.SynchronizationContext
Throw IllegalStateException if this method is not called from this synchronization context.
Ticker() - Constructor for class io.grpc.Deadline.Ticker
 
timeRemaining(TimeUnit) - Method in class io.grpc.Deadline
How much time is remaining in the specified time unit.
TlsTesting - Class in io.grpc.testing
Convenience utilities for using TLS in tests.
toAsciiString(T) - Method in interface io.grpc.Metadata.AsciiMarshaller
Serialize a metadata value to a ASCII string that contains only the characters listed in the class comment of Metadata.AsciiMarshaller.
toBuilder() - Method in class io.grpc.Attributes
Creates a new builder that is pre-populated with the content of this container.
toBuilder() - Method in class io.grpc.ClientStreamTracer.StreamInfo
Converts this StreamInfo into a new Builder.
toBuilder() - Method in class io.grpc.LoadBalancer.CreateSubchannelArgs
Returns a builder with the same initial values as this object.
toBuilder() - Method in class io.grpc.LoadBalancer.ResolvedAddresses
Converts this back to a builder.
toBuilder() - Method in class io.grpc.MethodDescriptor
Turns this descriptor into a builder.
toBuilder(MethodDescriptor.Marshaller<NewReqT>, MethodDescriptor.Marshaller<NewRespT>) - Method in class io.grpc.MethodDescriptor
Turns this descriptor into a builder, replacing the request and response marshallers.
toBuilder() - Method in class io.grpc.NameResolver.Args
Returns a builder with the same initial values as this object.
toBuilder() - Method in class io.grpc.NameResolver.ResolutionResult
Converts these results back to a builder.
toBytes(T) - Method in interface io.grpc.Metadata.BinaryMarshaller
Serialize a metadata value to bytes.
TOKEN_METADATA_KEY - Static variable in class io.grpc.grpclb.GrpclbConstants
The opaque token given by the remote balancer for each returned server address.
toStatus() - Method in enum io.grpc.Status.Code
Returns a Status object corresponding to this status code.
toStatusException(Status) - Static method in class io.grpc.protobuf.StatusProto
Convert a Status instance to a StatusException.
toStatusException(Status, Metadata) - Static method in class io.grpc.protobuf.StatusProto
Convert a Status instance to a StatusException with additional metadata.
toStatusRuntimeException(Status) - Static method in class io.grpc.protobuf.StatusProto
Convert a Status instance to a StatusRuntimeException.
toStatusRuntimeException(Status, Metadata) - Static method in class io.grpc.protobuf.StatusProto
Convert a Status instance to a StatusRuntimeException with additional metadata.
toStream(T) - Method in interface io.grpc.Metadata.BinaryStreamMarshaller
Serializes a metadata value to an InputStream.
toString() - Method in class io.grpc.Attributes.Key
 
toString() - Method in class io.grpc.Attributes
 
toString() - Method in class io.grpc.CallOptions.Key
 
toString() - Method in class io.grpc.CallOptions
 
toString() - Method in class io.grpc.ClientStreamTracer.StreamInfo
 
toString() - Method in class io.grpc.ConnectivityStateInfo
 
toString() - Method in class io.grpc.Context.Key
 
toString() - Method in class io.grpc.Deadline
 
toString() - Method in class io.grpc.EquivalentAddressGroup
 
toString() - Method in class io.grpc.ForwardingChannelBuilder
 
toString() - Method in class io.grpc.HttpConnectProxiedSocketAddress
 
toString() - Method in class io.grpc.inprocess.InProcessSocketAddress
 
toString() - Method in class io.grpc.LoadBalancer.CreateSubchannelArgs.Key
 
toString() - Method in class io.grpc.LoadBalancer.CreateSubchannelArgs
 
toString() - Method in class io.grpc.LoadBalancer.PickResult
 
toString() - Method in class io.grpc.LoadBalancer.ResolvedAddresses
 
toString() - Method in class io.grpc.LoadBalancerProvider
 
toString() - Method in class io.grpc.Metadata.Key
 
toString() - Method in class io.grpc.Metadata
 
toString() - Method in class io.grpc.MethodDescriptor
 
toString() - Method in class io.grpc.NameResolver.Args
 
toString() - Method in class io.grpc.NameResolver.ConfigOrError
 
toString() - Method in class io.grpc.NameResolver.ResolutionResult
 
toString() - Method in class io.grpc.netty.ProtocolNegotiationEvent
 
toString() - Method in class io.grpc.ServiceDescriptor
 
toString() - Method in class io.grpc.Status
A string representation of the status useful for debugging.
toString() - Method in class io.grpc.util.ForwardingClientStreamTracer
 
toString() - Method in class io.grpc.util.ForwardingLoadBalancer
 
toString() - Method in class io.grpc.util.ForwardingLoadBalancerHelper
 
toString() - Method in class io.grpc.util.ForwardingSubchannel
 
trailersFromThrowable(Throwable) - Static method in class io.grpc.Status
Extract an error trailers from the causal chain of a Throwable.
TransmitStatusRuntimeExceptionInterceptor - Class in io.grpc.util
A class that intercepts uncaught exceptions of type StatusRuntimeException and handles them by closing the ServerCall, and transmitting the exception's status and metadata to the client.
TRANSPORT_ATTR_LOCAL_ADDR - Static variable in class io.grpc.Grpc
Attribute key for the local address of a transport.
TRANSPORT_ATTR_REMOTE_ADDR - Static variable in class io.grpc.Grpc
Attribute key for the remote address of a transport.
TRANSPORT_ATTR_SSL_SESSION - Static variable in class io.grpc.Grpc
Attribute key for SSL session of a transport.
transportExecutor(Executor) - Method in class io.grpc.okhttp.OkHttpChannelBuilder
Override the default executor necessary for internal transport use.
transportReady(Attributes) - Method in class io.grpc.ServerTransportFilter
Called when a transport is ready to process streams.
transportTerminated(Attributes) - Method in class io.grpc.ServerTransportFilter
Called when a transport is terminated.

U

UNAUTHENTICATED - Static variable in class io.grpc.Status
The request does not have valid authentication credentials for the operation.
UNAVAILABLE - Static variable in class io.grpc.Status
The service is currently unavailable.
UNIMPLEMENTED - Static variable in class io.grpc.Status
Operation is not implemented or not supported/enabled in this service.
UNKNOWN - Static variable in class io.grpc.Status
Unknown error.
updateAddresses(List<EquivalentAddressGroup>) - Method in class io.grpc.LoadBalancer.Subchannel
Replaces the existing addresses used with this Subchannel.
updateAddresses(List<EquivalentAddressGroup>) - Method in class io.grpc.util.ForwardingSubchannel
 
updateBalancingState(ConnectivityState, LoadBalancer.SubchannelPicker) - Method in class io.grpc.LoadBalancer.Helper
Set a new state with a new picker to the channel.
updateBalancingState(ConnectivityState, LoadBalancer.SubchannelPicker) - Method in class io.grpc.util.ForwardingLoadBalancerHelper
 
updateOobChannelAddresses(ManagedChannel, EquivalentAddressGroup) - Method in class io.grpc.LoadBalancer.Helper
Updates the addresses used for connections in the Channel that was created by LoadBalancer.Helper.createOobChannel(EquivalentAddressGroup, String).
updateOobChannelAddresses(ManagedChannel, EquivalentAddressGroup) - Method in class io.grpc.util.ForwardingLoadBalancerHelper
 
updateSubchannelAddresses(LoadBalancer.Subchannel, EquivalentAddressGroup) - Method in class io.grpc.LoadBalancer.Helper
updateSubchannelAddresses(LoadBalancer.Subchannel, List<EquivalentAddressGroup>) - Method in class io.grpc.LoadBalancer.Helper
updateSubchannelAddresses(LoadBalancer.Subchannel, List<EquivalentAddressGroup>) - Method in class io.grpc.util.ForwardingLoadBalancerHelper
Deprecated.
useInputStreamMessages(ServerServiceDefinition) - Static method in class io.grpc.ServerInterceptors
Create a new ServerServiceDefinition whose MethodDescriptor serializes to and from InputStream for all methods.
useMarshalledMessages(ServerServiceDefinition, MethodDescriptor.Marshaller<T>) - Static method in class io.grpc.ServerInterceptors
Create a new ServerServiceDefinition whose MethodDescriptor serializes to and from T for all methods.
usePlaintext() - Method in class io.grpc.ForwardingChannelBuilder
 
usePlaintext() - Method in class io.grpc.inprocess.InProcessChannelBuilder
Does nothing.
usePlaintext() - Method in class io.grpc.ManagedChannelBuilder
Use of a plaintext connection to the server.
usePlaintext() - Method in class io.grpc.netty.NettyChannelBuilder
Equivalent to using NettyChannelBuilder.negotiationType(NegotiationType) with PLAINTEXT.
usePlaintext() - Method in class io.grpc.okhttp.OkHttpChannelBuilder
Sets the negotiation type for the HTTP/2 connection to plaintext.
userAgent(String) - Method in class io.grpc.ForwardingChannelBuilder
 
userAgent(String) - Method in class io.grpc.ManagedChannelBuilder
Provides a custom User-Agent for the application.
useTransportSecurity() - Method in class io.grpc.ForwardingChannelBuilder
 
useTransportSecurity() - Method in class io.grpc.inprocess.InProcessChannelBuilder
Does nothing.
useTransportSecurity(File, File) - Method in class io.grpc.inprocess.InProcessServerBuilder
 
useTransportSecurity() - Method in class io.grpc.ManagedChannelBuilder
Makes the client use TLS.
useTransportSecurity() - Method in class io.grpc.netty.NettyChannelBuilder
useTransportSecurity(File, File) - Method in class io.grpc.netty.NettyServerBuilder
 
useTransportSecurity(InputStream, InputStream) - Method in class io.grpc.netty.NettyServerBuilder
 
useTransportSecurity() - Method in class io.grpc.okhttp.OkHttpChannelBuilder
Sets the negotiation type for the HTTP/2 connection to TLS (this is the default).
useTransportSecurity(File, File) - Method in class io.grpc.ServerBuilder
Makes the server use TLS.
useTransportSecurity(InputStream, InputStream) - Method in class io.grpc.ServerBuilder
Makes the server use TLS.

V

value() - Method in enum io.grpc.Status.Code
The numerical value of the code.
valueOf(String) - Static method in enum io.grpc.ChannelLogger.ChannelLogLevel
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.grpc.ConnectivityState
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.grpc.MethodDescriptor.MethodType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.grpc.netty.NegotiationType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.grpc.okhttp.NegotiationType
Deprecated.
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.grpc.SecurityLevel
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.grpc.Status.Code
Returns the enum constant of this type with the specified name.
values() - Static method in enum io.grpc.ChannelLogger.ChannelLogLevel
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.grpc.ConnectivityState
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.grpc.MethodDescriptor.MethodType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.grpc.netty.NegotiationType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.grpc.okhttp.NegotiationType
Deprecated.
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.grpc.SecurityLevel
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.grpc.Status.Code
Returns an array containing the constants of this enum type, in the order they are declared.
voidMarshaller() - Static method in class io.grpc.testing.TestMethodDescriptors
Creates a new marshaller that does nothing.
voidMethod() - Static method in class io.grpc.testing.TestMethodDescriptors
Creates a new method descriptor that always creates zero length messages, and always parses to null objects.

W

with(Decompressor, boolean) - Method in class io.grpc.DecompressorRegistry
Registers a decompressor for both decompression and message encoding negotiation.
withAuthority(String) - Method in class io.grpc.CallOptions
Override the HTTP/2 authority the channel claims to be connecting to.
withCallCredentials(CallCredentials) - Method in class io.grpc.CallOptions
Returns a new CallOptions with the given call credentials.
withCallCredentials(CallCredentials) - Method in class io.grpc.stub.AbstractStub
Returns a new stub that uses the given call credentials.
withCancellation() - Method in class io.grpc.Context
Create a new context which is independently cancellable and also cascades cancellation from its parent.
withCause(Throwable) - Method in class io.grpc.Status
Create a derived instance of Status with the given cause.
withChannel(Channel) - Method in class io.grpc.stub.AbstractStub
Deprecated.
withChildOption(ChannelOption<T>, T) - Method in class io.grpc.netty.NettyServerBuilder
Specifies a child channel option.
withCompression(String) - Method in class io.grpc.CallOptions
Sets the compression to use for the call.
withCompression(String) - Method in class io.grpc.stub.AbstractStub
Set's the compressor name to use for the call.
withDeadline(Deadline) - Method in class io.grpc.CallOptions
Returns a new CallOptions with the given absolute deadline.
withDeadline(Deadline, ScheduledExecutorService) - Method in class io.grpc.Context
Create a new context which will cancel itself at the given Deadline.
withDeadline(Deadline) - Method in class io.grpc.stub.AbstractStub
Returns a new stub with an absolute deadline.
withDeadlineAfter(long, TimeUnit) - Method in class io.grpc.CallOptions
Returns a new CallOptions with a deadline that is after the given duration from now.
withDeadlineAfter(long, TimeUnit, ScheduledExecutorService) - Method in class io.grpc.Context
Create a new context which will cancel itself after the given duration from now.
withDeadlineAfter(long, TimeUnit) - Method in class io.grpc.stub.AbstractStub
Returns a new stub with a deadline that is after the given duration from now.
withDescription(String) - Method in class io.grpc.Status
Create a derived instance of Status with the given description.
withDrop(Status) - Static method in class io.grpc.LoadBalancer.PickResult
A decision to fail an RPC immediately.
withError(Status) - Static method in class io.grpc.LoadBalancer.PickResult
A decision to report a connectivity error to the RPC.
withExecutor(Executor) - Method in class io.grpc.CallOptions
Returns a new CallOptions with executor to be used instead of the default executor specified with ManagedChannelBuilder.executor(java.util.concurrent.Executor).
withExecutor(Executor) - Method in class io.grpc.stub.AbstractStub
Returns a new stub with the given executor that is to be used instead of the default one specified with ManagedChannelBuilder.executor(java.util.concurrent.Executor).
withInterceptors(ClientInterceptor...) - Method in class io.grpc.stub.AbstractStub
Returns a new stub that has the given interceptors attached to the underlying channel.
withMaxInboundMessageSize(int) - Method in class io.grpc.CallOptions
Sets the maximum allowed message size acceptable from the remote peer.
withMaxInboundMessageSize(int) - Method in class io.grpc.stub.AbstractStub
Returns a new stub that limits the maximum acceptable message size from a remote peer.
withMaxOutboundMessageSize(int) - Method in class io.grpc.CallOptions
Sets the maximum allowed message size acceptable sent to the remote peer.
withMaxOutboundMessageSize(int) - Method in class io.grpc.stub.AbstractStub
Returns a new stub that limits the maximum acceptable message size to send a remote peer.
withNoResult() - Static method in class io.grpc.LoadBalancer.PickResult
No decision could be made.
withOption(CallOptions.Key<T>, T) - Method in class io.grpc.CallOptions
Sets a custom option.
withOption(ChannelOption<T>, T) - Method in class io.grpc.netty.NettyChannelBuilder
Specifies a channel option.
withOption(ChannelOption<T>, T) - Method in class io.grpc.netty.NettyServerBuilder
Specifies a channel option.
withOption(CallOptions.Key<T>, T) - Method in class io.grpc.stub.AbstractStub
Sets a custom option to be passed to client interceptors on the channel ClientInterceptor via the CallOptions parameter.
withoutWaitForReady() - Method in class io.grpc.CallOptions
Disables 'wait for ready' feature for the call.
withServerCallHandler(ServerCallHandler<ReqT, RespT>) - Method in class io.grpc.ServerMethodDefinition
Create a new method definition with a different call handler.
withStreamTracerFactory(ClientStreamTracer.Factory) - Method in class io.grpc.CallOptions
Returns a new CallOptions with a ClientStreamTracerFactory in addition to the existing factories.
withSubchannel(LoadBalancer.Subchannel, ClientStreamTracer.Factory) - Static method in class io.grpc.LoadBalancer.PickResult
A decision to proceed the RPC on a Subchannel.
withSubchannel(LoadBalancer.Subchannel) - Static method in class io.grpc.LoadBalancer.PickResult
Equivalent to withSubchannel(subchannel, null).
withValue(Context.Key<V>, V) - Method in class io.grpc.Context
Create a new context with the given key value set.
withValues(Context.Key<V1>, V1, Context.Key<V2>, V2) - Method in class io.grpc.Context
Create a new context with the given key value set.
withValues(Context.Key<V1>, V1, Context.Key<V2>, V2, Context.Key<V3>, V3) - Method in class io.grpc.Context
Create a new context with the given key value set.
withValues(Context.Key<V1>, V1, Context.Key<V2>, V2, Context.Key<V3>, V3, Context.Key<V4>, V4) - Method in class io.grpc.Context
Create a new context with the given key value set.
withWaitForReady() - Method in class io.grpc.CallOptions
Enables 'wait for ready' for the call.
withWaitForReady() - Method in class io.grpc.stub.AbstractStub
Returns a new stub that uses 'wait for ready' for the call.
workerEventLoopGroup(EventLoopGroup) - Method in class io.grpc.netty.NettyServerBuilder
Provides the worker EventGroupLoop to the server.
wrap(Runnable) - Method in class io.grpc.Context
Wrap a Runnable so that it executes with this context as the Context.current() context.
wrap(Callable<C>) - Method in class io.grpc.Context
Wrap a Callable so that it executes with this context as the Context.current() context.
wrapChannel(Channel) - Method in class io.grpc.BinaryLog
 
wrapChannel(Channel) - Method in class io.grpc.services.BinaryLogProvider
Wraps a channel to provide binary logging on ClientCalls as needed.
wrapMethodDefinition(ServerMethodDefinition<ReqT, RespT>) - Method in class io.grpc.BinaryLog
 
wrapMethodDefinition(ServerMethodDefinition<ReqT, RespT>) - Method in class io.grpc.services.BinaryLogProvider
Wraps a ServerMethodDefinition such that it performs binary logging if needed.
write(MessageLite) - Method in interface io.grpc.services.BinaryLogSink
Writes the message to the destination.
A B C D E F G H I K L M N O P R S T U V W 
Skip navigation links