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.
AbstractBufferingHandler(ChannelHandler...) - Constructor for class io.grpc.netty.ProtocolNegotiators.AbstractBufferingHandler
 
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, with the default CallOptions.
addListener(Context.CancellationListener, Executor) - Method in class io.grpc.Context
Add a listener that will be notified when the context becomes cancelled.
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.
addService(ServerServiceDefinition) - Method in class io.grpc.MutableHandlerRegistry
Returns null, or previous service if service replaced an existing service.
addService(ServerServiceDefinition) - Method in class io.grpc.MutableHandlerRegistryImpl
 
addService(ServerServiceDefinition) - Method in class io.grpc.ServerBuilder
Adds a service implementation to the handler registry.
ALREADY_EXISTS - Static variable in class io.grpc.Status
Some entity that we attempted to create (e.g., file or directory) already exists.
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.
asRuntimeException() - Method in class io.grpc.Status
Convert this Status to a RuntimeException.
asyncBidiStreamingCall(ClientCall<ReqT, RespT>, StreamObserver<RespT>) - Static method in class io.grpc.stub.ClientCalls
Executes a bidi-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.
attach() - Method in class io.grpc.Context
Attach this context to the thread and make it Context.current(), the previously current context is returned.
attach() - Method in class io.grpc.Context.CancellableContext
 
attachAsCloseable() - Method in class io.grpc.Context.CancellableContext
Attach this context to the thread and return a AutoCloseable that can be used with try-with-resource statements to properly attach the previously bound context when AutoCloseable.close() is called.
attachHeaders(T, Metadata) - Static method in class io.grpc.stub.MetadataUtils
Attaches a set of request headers to a stub.
Attributes - Class in io.grpc
An immutable type-safe container of attributes.
Attributes.Builder - Class in io.grpc
 
Attributes.Key<T> - Class in io.grpc
 
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.
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

BINARY_HEADER_SUFFIX - Static variable in class io.grpc.Metadata
All binary headers should have this suffix in their names.
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.ManagedChannelBuilder
Builds a channel using the given parameters.
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(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
 
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
 
buildTransportServer() - Method in class io.grpc.inprocess.InProcessServerBuilder
 
buildTransportServer() - Method in class io.grpc.netty.NettyServerBuilder
 

C

CallOptions - Class in io.grpc
The collection of runtime options for a new RPC call.
cancel() - 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 for the cancellation.
cancel() - Method in class io.grpc.ForwardingClientCall
 
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).
captureMetadata(T, AtomicReference<Metadata>, AtomicReference<Metadata>) - Static method in class io.grpc.stub.MetadataUtils
Captures the last received metadata for a stub.
cause() - Method in class io.grpc.Context.CancellableContext
 
cause() - 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.
Channel - Class in io.grpc
A Channel provides an abstraction over the transport layer that is designed to be consumed by stub implementations.
Channel() - Constructor for class io.grpc.Channel
 
channelInactive(ChannelHandlerContext) - Method in class io.grpc.netty.ProtocolNegotiators.AbstractBufferingHandler
 
channelRegistered(ChannelHandlerContext) - Method in class io.grpc.netty.ProtocolNegotiators.AbstractBufferingHandler
 
channelType(Class<? extends Channel>) - Method in class io.grpc.netty.NettyChannelBuilder
Specify the channel type to use, by default we use NioSocketChannel.
channelType(Class<? extends ServerChannel>) - Method in class io.grpc.netty.NettyServerBuilder
Specify the channel type to use, by default we use NioServerSocketChannel.
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().
ClientAuthInterceptor - Class in io.grpc.auth
Client interceptor that authenticates all calls by binding header data provided by a credential.
ClientAuthInterceptor(Credentials, Executor) - Constructor for class io.grpc.auth.ClientAuthInterceptor
 
ClientCall<ReqT,RespT> - Class in io.grpc
An instance of a call to 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.
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.
clientSendsOneMessage() - Method in enum io.grpc.MethodDescriptor.MethodType
Returns true if the client will immediately send one request message to the server after calling ClientCall.start(io.grpc.ClientCall.Listener, io.grpc.Metadata) and then immediately half-close the stream by calling ClientCall.halfClose().
close(Status, Metadata) - Method in class io.grpc.ForwardingServerCall
 
close(ChannelHandlerContext, ChannelPromise) - Method in class io.grpc.netty.ProtocolNegotiators.AbstractBufferingHandler
 
close(Status, Metadata) - Method in class io.grpc.ServerCall
Close the call with the provided status.
CODE_KEY - Static variable in class io.grpc.Status
Key to bind status code to trailing metadata.
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.
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.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.
connectionSpec(ConnectionSpec) - Method in class io.grpc.okhttp.OkHttpChannelBuilder
For secure connection, provides a ConnectionSpec to specify Cipher suite and TLS versions.
containsKey(Metadata.Key<?>) - Method in class io.grpc.Metadata
Returns true if a value is defined for the given key.
CONTENT_TYPE_HEADER - Static variable in class io.grpc.okhttp.Headers
 
Context - Class in io.grpc
A context propagation mechanism which carries deadlines, cancellation signals, and other 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.
Contexts - Class in io.grpc
Utility methods for working with Contexts in GRPC.
Contexts() - Constructor for class io.grpc.Contexts
 
create(MethodDescriptor.MethodType, String, MethodDescriptor.Marshaller<RequestT>, MethodDescriptor.Marshaller<ResponseT>) - Static method in class io.grpc.MethodDescriptor
Creates a new MethodDescriptor.
create(MethodDescriptor<ReqT, RespT>, ServerCallHandler<ReqT, RespT>) - Static method in class io.grpc.ServerMethodDefinition
Create a new instance.
createRequestHeaders(Metadata, String, String) - Static method in class io.grpc.okhttp.Headers
Serializes the given headers and creates a list of OkHttp Headers to be used when creating a stream.
current() - Static method in class io.grpc.Context
Return the context associated with the current thread, will never return null as the Context.ROOT context is implicitly associated with all threads.

D

DATA_LOSS - Static variable in class io.grpc.Status
Unrecoverable data loss or corruption.
DEADLINE_EXCEEDED - Static variable in class io.grpc.Status
Deadline expired before operation could complete.
deallocate() - Method in class io.grpc.netty.NettyChannelBuilder.NettyTransportFactory
 
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.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_CONNECTION_SPEC - Static variable in class io.grpc.okhttp.OkHttpChannelBuilder
 
DEFAULT_FLOW_CONTROL_WINDOW - Static variable in class io.grpc.netty.NettyChannelBuilder
 
DEFAULT_FLOW_CONTROL_WINDOW - Static variable in class io.grpc.netty.NettyServerBuilder
 
delegate() - Method in class io.grpc.ClientInterceptors.CheckedForwardingClientCall
 
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
 
detach(Context) - Method in class io.grpc.Context.CancellableContext
 
detach(Context) - Method in class io.grpc.Context
Detach the current context from the thread and attach the provided replacement.
detachAndCancel(Context, Throwable) - Method in class io.grpc.Context.CancellableContext
Cancel this context and detach it as the current context from the thread.
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.
DnsNameResolverFactory - Class in io.grpc
A factory for DnsNameResolver.
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
 
equals(Object) - Method in class io.grpc.EquivalentAddressGroup
 
equals(Object) - Method in class io.grpc.Metadata.Key
 
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
 
EquivalentAddressGroup(SocketAddress) - Constructor for class io.grpc.EquivalentAddressGroup
 
eventLoopGroup(EventLoopGroup) - Method in class io.grpc.netty.NettyChannelBuilder
Provides an EventGroupLoop to be used by the netty transport.
exceptionCaught(ChannelHandlerContext, Throwable) - Method in class io.grpc.netty.ProtocolNegotiators.AbstractBufferingHandler
 
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.LoadBalancer.Factory
 
Factory() - Constructor for class io.grpc.NameResolver.Factory
 
fail(ChannelHandlerContext, Throwable) - Method in class io.grpc.netty.ProtocolNegotiators.AbstractBufferingHandler
 
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.
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 HTTP/2 flow control window.
flush(ChannelHandlerContext) - Method in class io.grpc.netty.ProtocolNegotiators.AbstractBufferingHandler
 
forAddress(String, int) - Static method in class io.grpc.ManagedChannelBuilder
 
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 a SslContextBuilder with ciphers and APN appropriate for gRPC.
fork() - Method in class io.grpc.Context
Create a new context which copies the values of this context but does not propagate its cancellation and is its own independent root for 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, HandlerRegistry) - Static method in class io.grpc.inprocess.InProcessServerBuilder
Create a server builder that will bind 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.
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
 
forRegistryAndPort(HandlerRegistry, int) - Static method in class io.grpc.netty.NettyServerBuilder
Creates a server builder that will bind to the given port and use the HandlerRegistry for call dispatching.
forServer(File, File) - Static method in class io.grpc.netty.GrpcSslContexts
Creates a SslContextBuilder with ciphers and APN appropriate for gRPC.
forServer(File, File, String) - Static method in class io.grpc.netty.GrpcSslContexts
Creates a SslContextBuilder with ciphers and APN appropriate for gRPC.
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.
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.
ForwardingServerCall<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<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.
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.
fromCodeValue(int) - Static method in class io.grpc.Status
Return a Status given a canonical error Status.Code value.
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.
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.
getAddress() - Method in class io.grpc.ResolvedServerInfo
Returns the address.
getAddresses() - Method in class io.grpc.EquivalentAddressGroup
Returns an immutable list of the addresses.
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.
getAttributes() - Method in class io.grpc.ResolvedServerInfo
Returns the associated attributes.
getAuthority() - Method in class io.grpc.CallOptions
Override the HTTP/2 authority the channel claims to be connecting to.
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() - Method in class io.grpc.stub.AbstractStub
The underlying channel of the stub.
getCode() - Method in class io.grpc.Status
The canonical status code.
getCompressor() - Method in class io.grpc.CallOptions
Returns the compressor's name.
getDeadlineNanoTime() - Method in class io.grpc.CallOptions
Returns the deadline in nanoseconds in the clock as per System.nanoTime().
getDefaultInstance() - Static method in class io.grpc.CompressorRegistry
 
getDefaultInstance() - Static method in class io.grpc.DecompressorRegistry
 
getDefaultRegistry() - Static method in class io.grpc.NameResolverRegistry
 
getDefaultScheme() - Method in class io.grpc.DnsNameResolverFactory
 
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.
getDefaultScheme() - Method in class io.grpc.NameResolverRegistry
 
getDescription() - Method in class io.grpc.Status
A description of this status for human consumption.
getExecutor() - Method in class io.grpc.CallOptions
 
getFullMethodName() - Method in class io.grpc.MethodDescriptor
The fully qualified name of the method.
getInstance() - Static method in class io.grpc.DnsNameResolverFactory
 
getInstance() - Static method in class io.grpc.SimpleLoadBalancerFactory
 
getKnownMessageEncodings() - Method in class io.grpc.DecompressorRegistry
Provides a list of all message encodings that have decompressors available.
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.
getMethodDescriptor() - Method in class io.grpc.ServerMethodDefinition
The MethodDescriptor for this method.
getMethods() - Method in class io.grpc.ServerServiceDefinition
 
getName() - Method in class io.grpc.ServerServiceDefinition
Simple name of the service.
getNameResolverParams() - Method in class io.grpc.netty.NettyChannelBuilder
 
getNameResolverParams() - Method in class io.grpc.okhttp.OkHttpChannelBuilder
 
getRequestKey() - Method in class io.grpc.CallOptions
Returns the request key for affinity-based routing.
getServerCallHandler() - Method in class io.grpc.ServerMethodDefinition
Handler for incoming calls.
getServiceAuthority() - Method in class io.grpc.NameResolver
Returns the authority, which is also the name of the service.
getStatus() - Method in exception io.grpc.StatusException
 
getStatus() - Method in exception io.grpc.StatusRuntimeException
 
getTransport(EquivalentAddressGroup) - Method in class io.grpc.TransportManager
Returns the future of a transport for any of the addresses from the given address group.
getType() - Method in class io.grpc.MethodDescriptor
The call type of the method.
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.
halfClose() - Method in class io.grpc.ForwardingClientCall
 
handleNameResolutionError(Status) - Method in class io.grpc.LoadBalancer
Handles an error from the name resolution system.
handleResolvedAddresses(List<ResolvedServerInfo>, Attributes) - Method in class io.grpc.LoadBalancer
Handles newly resolved addresses and service config from name resolution system.
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
 
hashCode() - Method in class io.grpc.EquivalentAddressGroup
 
hashCode() - Method in class io.grpc.Metadata.Key
 
hashCode() - Method in class io.grpc.Status
Hash codes on Statuses are not well defined.
Headers - Class in io.grpc.okhttp
Constants for request/response headers.
Headers() - Constructor for class io.grpc.okhttp.Headers
 

I

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.
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.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(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(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.
interceptCall(MethodDescriptor<ReqT, RespT>, CallOptions, Channel) - Method in class io.grpc.auth.ClientAuthInterceptor
 
interceptCall(MethodDescriptor<ReqT, RespT>, CallOptions, Channel) - Method in interface io.grpc.ClientInterceptor
Intercept ClientCall creation by the next Channel.
interceptCall(Context, MethodDescriptor<ReqT, RespT>, ServerCall<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(MethodDescriptor<ReqT, RespT>, ServerCall<RespT>, Metadata, ServerCallHandler<ReqT, RespT>) - Method in interface io.grpc.ServerInterceptor
Intercept ServerCall dispatch by the next ServerCallHandler.
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.
io.grpc - package io.grpc
The gRPC core public API.
io.grpc.auth - package io.grpc.auth
 
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
 
io.grpc.protobuf.nano - package io.grpc.protobuf.nano
 
io.grpc.stub - package io.grpc.stub
 
isAndroid() - Static method in class io.grpc.ManagedChannelProvider
 
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.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.
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.ForwardingServerCall
 
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.
isCurrent() - Method in class io.grpc.Context.CancellableContext
 
isOk() - Method in class io.grpc.Status
Is this status OK, i.e., not an error.
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.ForwardingClientCall
 
isReady() - Method in class io.grpc.ForwardingServerCall
 
isReady() - Method in class io.grpc.ServerCall
If true, indicates that the call is capable of sending additional messages without requiring excessive buffering internally.
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.

K

Key(String) - Constructor for class io.grpc.Attributes.Key
Construct the key.
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.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
 
LoadBalancer<T> - Class in io.grpc
A pluggable component that receives resolved addresses from NameResolver and provides the channel a usable transport when asked.
LoadBalancer() - Constructor for class io.grpc.LoadBalancer
 
LoadBalancer.Factory - Class in io.grpc
 
loadBalancerFactory(LoadBalancer.Factory) - Method in class io.grpc.ManagedChannelBuilder
Provides a custom LoadBalancer.Factory for the channel.
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.MutableHandlerRegistryImpl
Note: This does not actually honor the authority provided.

M

makeChannel(T) - Method in class io.grpc.TransportManager
Returns a channel that uses transport; useful for issuing RPCs on a transport.
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
 
marshaller(MessageNanoFactory<T>) - Static method in class io.grpc.protobuf.nano.NanoUtils
Adapt parser to a Marshaller.
marshaller(T) - Static method in class io.grpc.protobuf.ProtoUtils
Create a 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.
maxHeaderListSize(int) - Method in class io.grpc.netty.NettyChannelBuilder
Sets the maximum size of header list allowed to be received on the channel.
maxHeaderListSize(int) - Method in class io.grpc.netty.NettyServerBuilder
Sets the maximum size of header list allowed to be received on the server.
maxMessageSize(int) - Method in class io.grpc.netty.NettyChannelBuilder
Sets the maximum message size allowed to be received on the channel.
maxMessageSize(int) - Method in class io.grpc.netty.NettyServerBuilder
Sets the maximum message size allowed to be received on the server.
maxMessageSize(int) - Method in class io.grpc.okhttp.OkHttpChannelBuilder
Sets the maximum message size allowed to be received on the channel.
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 for the given set of keys into this set of metadata.
MESSAGE_KEY - Static variable in class io.grpc.Status
Key to bind status message to trailing metadata.
MessageNanoFactory<T extends com.google.protobuf.nano.MessageNano> - Interface in io.grpc.protobuf.nano
Produce new message instances.
Metadata - Class in io.grpc
Provides access to read and write metadata values to be exchanged during a call.
Metadata(byte[]...) - Constructor for class io.grpc.Metadata
Constructor called by the transport layer when it receives binary metadata.
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 that contain only following characters: Space: 0x20, but must not be at the beginning or at the end of the value. ASCII visible characters (0x21-0x7E).
Metadata.BinaryMarshaller<T> - Interface in io.grpc
Marshaller for metadata values that are serialized into raw binary.
Metadata.Key<T> - Class in io.grpc
Key for metadata entries.
MetadataUtils - Class in io.grpc.stub
Utility functions for binding and receiving headers.
METHOD_HEADER - Static variable in class io.grpc.okhttp.Headers
 
MethodDescriptor<ReqT,RespT> - Class in io.grpc
Description of a remote method used by Channel to initiate a call.
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.
MutableHandlerRegistry - Class in io.grpc
Mutable base class of HandlerRegistry.
MutableHandlerRegistry() - Constructor for class io.grpc.MutableHandlerRegistry
 
MutableHandlerRegistryImpl - Class in io.grpc
Default implementation of MutableHandlerRegistry.
MutableHandlerRegistryImpl() - Constructor for class io.grpc.MutableHandlerRegistryImpl
 

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.Factory - Class in io.grpc
 
NameResolver.Listener - Interface in io.grpc
Receives address updates.
nameResolverFactory(NameResolver.Factory) - Method in class io.grpc.ManagedChannelBuilder
 
NameResolverRegistry - Class in io.grpc
A registry that holds various NameResolver.Factorys and dispatches target URI to the first one that can handle it.
NanoUtils - Class in io.grpc.protobuf.nano
Utility methods for using nano proto with grpc.
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
Identifies the negotiation used for starting up HTTP/2.
negotiationType(NegotiationType) - Method in class io.grpc.okhttp.OkHttpChannelBuilder
Sets the negotiation type for the HTTP/2 connection.
NettyChannelBuilder - Class in io.grpc.netty
A builder to help simplify construction of channels using the Netty transport.
NettyChannelBuilder(String, int) - Constructor for class io.grpc.netty.NettyChannelBuilder
 
NettyChannelBuilder(String) - Constructor for class io.grpc.netty.NettyChannelBuilder
 
NettyChannelBuilder(SocketAddress) - Constructor for class io.grpc.netty.NettyChannelBuilder
 
NettyChannelBuilder.NettyTransportFactory - Class in io.grpc.netty
Creates Netty transports.
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() - Static method in class io.grpc.Attributes
Create a new builder.
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.
newClientTransport(SocketAddress, String) - Method in class io.grpc.netty.NettyChannelBuilder.NettyTransportFactory
 
newClientTransport(SocketAddress, String, ProtocolNegotiator) - Method in class io.grpc.netty.NettyChannelBuilder.NettyTransportFactory
 
newEmptyInstance() - Static method in class io.grpc.CompressorRegistry
 
newEmptyInstance() - Static method in class io.grpc.DecompressorRegistry
 
newHandler(Http2ConnectionHandler) - Method in interface io.grpc.netty.ProtocolNegotiator
Creates a new handler to control the protocol negotiation.
newInstance() - Method in interface io.grpc.protobuf.nano.MessageNanoFactory
 
newLoadBalancer(String, TransportManager<T>) - Method in class io.grpc.LoadBalancer.Factory
Creates a LoadBalancer that will be used inside a channel.
newLoadBalancer(String, TransportManager<T>) - Method in class io.grpc.SimpleLoadBalancerFactory
 
newNameResolver(URI, Attributes) - Method in class io.grpc.DnsNameResolverFactory
 
newNameResolver(URI, Attributes) - 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.
newNameResolver(URI, Attributes) - Method in class io.grpc.NameResolverRegistry
Returns a NameResolver created by the first factory that can handle the given target URI, or null if no one can handle it.
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.

O

of(String, Metadata.BinaryMarshaller<T>) - Static method in class io.grpc.Metadata.Key
Creates a key for a binary header.
of(String, Metadata.AsciiMarshaller<T>) - Static method in class io.grpc.Metadata.Key
Creates a key for an ASCII header.
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
 
onCancel() - Method in class io.grpc.ForwardingServerCallListener
 
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.
onClose(Status, Metadata) - Method in class io.grpc.ForwardingClientCallListener
 
onComplete() - Method in class io.grpc.ForwardingServerCallListener
 
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.
onError(Status) - Method in interface io.grpc.NameResolver.Listener
Handles an error from the resolver.
onError(Throwable) - Method in interface io.grpc.stub.StreamObserver
Receives a terminating error from the stream.
onHalfClose() - Method in class io.grpc.ForwardingServerCallListener
 
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.
onHeaders(Metadata) - Method in class io.grpc.ForwardingClientCallListener
 
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.
onReady() - Method in class io.grpc.ClientCall.Listener
This indicates that the ClientCall is now capable of sending additional messages (via ClientCall.sendMessage(ReqT)) without requiring excessive buffering internally.
onReady() - Method in class io.grpc.ForwardingClientCallListener
 
onReady() - Method in class io.grpc.ForwardingServerCallListener
 
onReady() - Method in class io.grpc.ServerCall.Listener
This indicates that the call is now capable of sending additional messages (via ServerCall.sendMessage(RespT)) without requiring excessive buffering internally.
onUpdate(List<ResolvedServerInfo>, Attributes) - Method in interface io.grpc.NameResolver.Listener
Handles updates on resolved addresses and config.
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.
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
The port number used in case the target or the underlying naming system doesn't provide a port number.
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.
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.
PERMISSION_DENIED - Static variable in class io.grpc.Status
The caller does not have permission to execute the specified operation.
pickTransport(RequestKey) - Method in class io.grpc.LoadBalancer
Pick a transport that Channel will use for next RPC.
plaintext() - Static method in class io.grpc.netty.ProtocolNegotiators
Returns a ChannelHandler that ensures that the handler is added to the pipeline writes to the Channel may happen immediately, even before it is active.
plaintextUpgrade() - Static method in class io.grpc.netty.ProtocolNegotiators
Returns a ProtocolNegotiator used for upgrading to HTTP/2 from HTTP/1.x.
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.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.
propagate(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 to the Context.current() context of the Runnable scheduled.
protocolNegotiator(ProtocolNegotiator) - Method in class io.grpc.netty.NettyChannelBuilder
Sets the ProtocolNegotiator to be used.
protocolNegotiator(ProtocolNegotiator) - Method in class io.grpc.netty.NettyServerBuilder
Sets the ProtocolNegotiator to be used.
ProtocolNegotiator - Interface in io.grpc.netty
A class that provides a Netty handler to control protocol negotiation.
ProtocolNegotiator.Handler - Interface in io.grpc.netty
The Netty handler to control the protocol negotiation.
ProtocolNegotiators - Class in io.grpc.netty
Common ProtocolNegotiators used by gRPC.
ProtocolNegotiators.AbstractBufferingHandler - Class in io.grpc.netty
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
 
put(Metadata.Key<T>, T) - Method in class io.grpc.Metadata
Adds the key, value pair.

R

register(Compressor) - Method in class io.grpc.CompressorRegistry
Registers a compressor for both decompression and message encoding negotiation.
register(Decompressor, boolean) - Method in class io.grpc.DecompressorRegistry
Registers a decompressor for both decompression and message encoding negotiation.
register(NameResolver.Factory) - Method in class io.grpc.NameResolverRegistry
remove(Metadata.Key<T>, T) - Method in class io.grpc.Metadata
Removes the first occurence 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
removeService(ServerServiceDefinition) - Method in class io.grpc.MutableHandlerRegistry
Returns false if service was not registered.
removeService(ServerServiceDefinition) - Method in class io.grpc.MutableHandlerRegistryImpl
 
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.ForwardingClientCall
 
request(int) - Method in class io.grpc.ForwardingServerCall
 
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).
RequestKey - Class in io.grpc
A key generated from an RPC request, and to be used for affinity-based routing.
ResolvedServerInfo - Class in io.grpc
The information about a server from a NameResolver.
ResolvedServerInfo(SocketAddress, Attributes) - Constructor for class io.grpc.ResolvedServerInfo
Constructor.
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.
ROOT - Static variable in class io.grpc.Context
The logical root context which is Context.current() if no other context is bound.

S

scheme() - Method in interface io.grpc.netty.ProtocolNegotiator.Handler
The HTTP/2 scheme to be used when sending HEADERS.
SCHEME_HEADER - Static variable in class io.grpc.okhttp.Headers
 
sendHeaders(Metadata) - Method in class io.grpc.ForwardingServerCall
 
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.
serialize() - Method in class io.grpc.Metadata
Serialize all the metadata entries.
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<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.
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 bi-directional 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.
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.
serverPlaintext() - Static method in class io.grpc.netty.ProtocolNegotiators
Create a server plaintext handler for gRPC.
ServerProvider - Class in io.grpc
Provider of servers for transport agnostic consumption.
ServerProvider() - Constructor for class io.grpc.ServerProvider
 
serverSendsOneMessage() - Method in enum io.grpc.MethodDescriptor.MethodType
Returns true if the server will immediately send one response message to the client upon receipt of ServerCall.Listener.onHalfClose() and then immediately close the stream by calling ServerCall.close(Status, io.grpc.Metadata).
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.
serverTls(SslContext) - Static method in class io.grpc.netty.ProtocolNegotiators
Create a server TLS handler for HTTP/2 capable of using ALPN/NPN.
set(Attributes.Key<T>, T) - Method in class io.grpc.Attributes.Builder
 
setCompression(String) - Method in class io.grpc.ForwardingServerCall
 
setCompression(String) - Method in class io.grpc.ServerCall
Sets the compression algorithm for this call.
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.ForwardingClientCall
 
setMessageCompression(boolean) - Method in class io.grpc.ForwardingServerCall
 
setMessageCompression(boolean) - Method in class io.grpc.ServerCall
Enables per-message compression, if an encoding type has been negotiated.
shutdown() - Method in class io.grpc.LoadBalancer
Shuts down this LoadBalancer.
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.
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<RespT>) - Constructor for class io.grpc.ForwardingServerCall.SimpleForwardingServerCall
 
SimpleForwardingServerCallListener(ServerCall.Listener<ReqT>) - Constructor for class io.grpc.ForwardingServerCallListener.SimpleForwardingServerCallListener
 
SimpleLoadBalancerFactory - Class in io.grpc
A LoadBalancer that provides simple round-robin and pick-first routing mechanism over the addresses from the NameResolver.
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
Provides a SSLSocketFactory to replace the default SSLSocketFactory used for TLS.
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(NameResolver.Listener) - Method in class io.grpc.NameResolver
Starts the resolution.
start() - Method in class io.grpc.Server
Bind and start the server.
startCall(MethodDescriptor<RequestT, ResponseT>, ServerCall<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
 
StatusRuntimeException - Exception in io.grpc
Status in RuntimeException form, for propagating Status information via exceptions.
StatusRuntimeException(Status) - Constructor for exception io.grpc.StatusRuntimeException
 
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.
StreamObserver<V> - Interface in io.grpc.stub
Receives notifications from an observable stream of messages.
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.

T

TE_HEADER - Static variable in class io.grpc.okhttp.Headers
 
tls(SslContext, String) - Static method in class io.grpc.netty.ProtocolNegotiators
Returns a ProtocolNegotiator that ensures the pipeline is set up so that TLS will be negotiated, the handler is added and writes to the Channel may happen immediately, even before the TLS Handshake is complete.
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.
toBytes(T) - Method in interface io.grpc.Metadata.BinaryMarshaller
Serialize a metadata value to bytes.
toString() - Method in class io.grpc.Attributes.Key
 
toString() - Method in class io.grpc.Attributes
 
toString() - Method in class io.grpc.CallOptions
 
toString() - Method in class io.grpc.Context.Key
 
toString() - Method in class io.grpc.EquivalentAddressGroup
 
toString() - Method in class io.grpc.Metadata.Key
 
toString() - Method in class io.grpc.Metadata
 
toString() - Method in class io.grpc.ResolvedServerInfo
 
toString() - Method in class io.grpc.Status
A string representation of the status useful for debugging.
transportExecutor(Executor) - Method in class io.grpc.okhttp.OkHttpChannelBuilder
Override the default executor necessary for internal transport use.
TransportManager<T> - Class in io.grpc
Manages transport life-cycles and provide ready-to-use transports.
TransportManager() - Constructor for class io.grpc.TransportManager
 
transportReady(EquivalentAddressGroup, T) - Method in class io.grpc.LoadBalancer
Called when a transport is fully connected and ready to accept traffic.
transportShutdown(EquivalentAddressGroup, T, Status) - Method in class io.grpc.LoadBalancer
Called when a transport is shutting down.

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.
updateRetainedTransports(Collection<EquivalentAddressGroup>) - Method in class io.grpc.TransportManager
Advises this TransportManager to retain transports only to these servers, for warming up connections and discarding unused connections.
usePlaintext(boolean) - Method in class io.grpc.inprocess.InProcessChannelBuilder
Does nothing.
usePlaintext(boolean) - Method in class io.grpc.ManagedChannelBuilder
 
usePlaintext(boolean) - Method in class io.grpc.netty.NettyChannelBuilder
Equivalent to using NettyChannelBuilder.negotiationType(NegotiationType) with PLAINTEXT or PLAINTEXT_UPGRADE.
usePlaintext(boolean) - Method in class io.grpc.okhttp.OkHttpChannelBuilder
Equivalent to using OkHttpChannelBuilder.negotiationType(NegotiationType) with PLAINTEXT.
userAgent(String) - Method in class io.grpc.ManagedChannelBuilder
Provides a custom User-Agent for the application.
useTransportSecurity(File, File) - Method in class io.grpc.inprocess.InProcessServerBuilder
 
useTransportSecurity(File, File) - Method in class io.grpc.netty.NettyServerBuilder
 
useTransportSecurity(File, File) - 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.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
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.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
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.

W

withAuthority(String) - Method in class io.grpc.CallOptions
Override the HTTP/2 authority the channel claims to be connecting to.
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
Returns a new stub that uses the given channel.
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.
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.
withDeadlineNanoTime(Long) - Method in class io.grpc.CallOptions
Returns a new CallOptions with the given absolute deadline in nanoseconds in the clock as per System.nanoTime().
withDeadlineNanoTime(long, ScheduledExecutorService) - Method in class io.grpc.Context
Create a new context which will cancel itself after an absolute deadline expressed as nanoseconds in the System.nanoTime() clock.
withDeadlineNanoTime(Long) - Method in class io.grpc.stub.AbstractStub
Returns a new stub with an absolute deadline in nanoseconds in the clock as per System.nanoTime().
withDescription(String) - Method in class io.grpc.Status
Create a derived instance of Status with the given description.
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).
withInterceptors(ClientInterceptor...) - Method in class io.grpc.stub.AbstractStub
Returns a new stub that has the given interceptors attached to the underlying channel.
withRequestKey(RequestKey) - Method in class io.grpc.CallOptions
Returns a new CallOptions with a request key for affinity-based routing.
withServerCallHandler(ServerCallHandler<ReqT, RespT>) - Method in class io.grpc.ServerMethodDefinition
Create a new method definition with a different call handler.
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.
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.
wrap(Executor) - Method in class io.grpc.Context
Wrap an Executor so that it executes with this context as the Context.current() context.
write(ChannelHandlerContext, Object, ChannelPromise) - Method in class io.grpc.netty.ProtocolNegotiators.AbstractBufferingHandler
 
writeBufferedAndRemove(ChannelHandlerContext) - Method in class io.grpc.netty.ProtocolNegotiators.AbstractBufferingHandler
 
A B C D E F G H I K L M N O P R S T U V W 
Skip navigation links