A B C D E F G H I K L M N O P R S T U V W
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- ABORTED - io.grpc.Status.Code
-
The operation was aborted, typically due to a concurrency issue like sequencer check failures, transaction aborts, etc.
- 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.
- acceptResolvedAddresses(LoadBalancer.ResolvedAddresses) - Method in class io.grpc.LoadBalancer
-
Accepts newly resolved addresses from the name resolution system.
- 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<?, ?>) - Method in class io.grpc.ServiceDescriptor.Builder
-
Adds a method to this service.
- 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.
- addMetricSink(MetricSink) - Method in class io.grpc.ForwardingChannelBuilder2
- addMetricSink(MetricSink) - Method in class io.grpc.ManagedChannelBuilder
-
Adds a
MetricSink
for channel to use for configuring and recording metrics. - addOption(LoadBalancer.CreateSubchannelArgs.Key<T>, T) - Method in class io.grpc.LoadBalancer.CreateSubchannelArgs.Builder
-
Add a custom option.
- addOptionalLabel(String, String) - Method in class io.grpc.ClientStreamTracer
-
Information providing context to the call became available.
- addOptionalLabel(String, String) - Method in interface io.grpc.LoadBalancer.PickDetailsConsumer
-
Optional labels that provide context of how the pick was routed.
- addService(BindableService) - Method in class io.grpc.ForwardingServerBuilder
- addService(BindableService) - Method in class io.grpc.ServerBuilder
-
Adds a service implementation to the handler registry.
- addService(ServerServiceDefinition) - Method in class io.grpc.ForwardingServerBuilder
- addService(ServerServiceDefinition) - Method in class io.grpc.ServerBuilder
-
Adds a service implementation to the handler registry.
- addServices(List<ServerServiceDefinition>) - Method in class io.grpc.ServerBuilder
-
Adds a list of service implementations to the handler registry together.
- addStreamTracerFactory(ServerStreamTracer.Factory) - Method in class io.grpc.ForwardingServerBuilder
- addStreamTracerFactory(ServerStreamTracer.Factory) - Method in class io.grpc.ServerBuilder
-
Adds a
ServerStreamTracer.Factory
to measure server-side traffic. - addTransportFilter(ClientTransportFilter) - Method in class io.grpc.ForwardingChannelBuilder2
- addTransportFilter(ClientTransportFilter) - Method in class io.grpc.ManagedChannelBuilder
-
Adds a
ClientTransportFilter
. - addTransportFilter(ServerTransportFilter) - Method in class io.grpc.ForwardingServerBuilder
- addTransportFilter(ServerTransportFilter) - Method in class io.grpc.ServerBuilder
-
Adds a
ServerTransportFilter
. - 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
. - ALREADY_EXISTS - io.grpc.Status.Code
-
Some entity that we attempted to create (e.g., file or directory) already exists.
- 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.
- 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, CallCredentials.MetadataApplier) - Method in class io.grpc.CompositeCallCredentials
- asChannel() - Method in class io.grpc.LoadBalancer.Subchannel
-
(Internal use only) returns a
Channel
that is backed by this Subchannel. - 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
- asException(Metadata) - Method in class io.grpc.Status
-
Same as
Status.asException()
but includes the provided trailers in the returned exception. - asFactory() - Method in class io.grpc.NameResolverRegistry
- asRuntimeException() - Method in class io.grpc.Status
-
Convert this
Status
to aRuntimeException
. - asRuntimeException(Metadata) - Method in class io.grpc.Status
-
Same as
Status.asRuntimeException()
but includes the provided trailers in the returned exception. - 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
- 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
- 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.
- awaitTermination() - Method in class io.grpc.Server
-
Waits for the server to become terminated.
- 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.
B
- BIDI_STREAMING - io.grpc.MethodDescriptor.MethodType
-
Zero or more request and response messages arbitrarily interleaved in time.
- 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
- 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. - 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.ForwardingChannelBuilder2
-
Returns the
ManagedChannel
built by the delegate by default. - build() - Method in class io.grpc.ForwardingServerBuilder
-
Returns the
Server
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
-
Constructs the
LoadBalancer.ResolvedAddresses
. - 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
-
Builds an
NameResolver.Args
. - 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() - Method in class io.grpc.TlsChannelCredentials.Builder
-
Construct the credentials.
- build() - Method in class io.grpc.TlsServerCredentials.Builder
-
Construct the credentials.
- builder(ServiceDescriptor) - Static method in class io.grpc.ServerServiceDefinition
- builder(String) - Static method in class io.grpc.ServerServiceDefinition
-
Convenience that constructs a
ServiceDescriptor
simultaneously. - builderForAddress(String, int) - Method in class io.grpc.ManagedChannelProvider
-
Creates a new builder with the given host and port.
- 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.
- byteBufferSupported() - Method in interface io.grpc.HasByteBuffer
-
Indicates whether or not
HasByteBuffer.getByteBuffer()
operation is supported.
C
- call(Callable<V>) - Method in class io.grpc.Context
-
Immediately call a
Callable
with this context as theContext.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()
. - callExecutor(ServerCallExecutorSupplier) - Method in class io.grpc.ForwardingServerBuilder
- callExecutor(ServerCallExecutorSupplier) - Method in class io.grpc.ServerBuilder
-
Allows for defining a way to provide a custom executor to handle the server call.
- 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.
- cancel() - Method in class io.grpc.SynchronizationContext.ScheduledHandle
-
Cancel the task if it's still
pending
. - 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. - 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 ornull
if context was cancelled without a cause. - cancelled(Context) - Method in interface io.grpc.Context.CancellationListener
-
Notifies that a context was cancelled.
- CANCELLED - io.grpc.Status.Code
-
The operation was cancelled (typically by the caller).
- 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)
. - Channel - Class in io.grpc
-
A virtual connection to a conceptual endpoint, to perform RPCs.
- Channel() - Constructor for class io.grpc.Channel
- channelBuilder(ManagedChannelBuilder<?>) - Static method in class io.grpc.ManagedChannelProvider.NewChannelBuilderResult
- ChannelCredentials - Class in io.grpc
-
Represents a security configuration to be used for channels.
- ChannelCredentials() - Constructor for class io.grpc.ChannelCredentials
- 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.
- 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()
. - ChoiceChannelCredentials - Class in io.grpc
-
Provides a list of
ChannelCredentials
, where any one may be used. - ChoiceServerCredentials - Class in io.grpc
-
Provides a list of
ServerCredentials
, where any one may be used. - clearOnReadyThreshold() - Method in class io.grpc.CallOptions
-
Resets to the default number of bytes that must be queued before the call will leave the 'wait for ready' state.
- CLIENT_STREAMING - io.grpc.MethodDescriptor.MethodType
-
Zero or more request messages with one response message.
- clientAuth(TlsServerCredentials.ClientAuth) - Method in class io.grpc.TlsServerCredentials.Builder
-
Indicates whether the server should expect a client's identity.
- 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.
- 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
ClientInterceptor
s. - 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
forUNARY
andSERVER_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
-
Builds
ClientStreamTracer.StreamInfo
objects. - ClientTransportFilter - Class in io.grpc
-
Listens on the client transport life-cycle events.
- ClientTransportFilter() - Constructor for class io.grpc.ClientTransportFilter
- 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.
- 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
- CompositeCallCredentials - Class in io.grpc
-
Uses multiple
CallCredentials
as if they were one. - CompositeCallCredentials(CallCredentials, CallCredentials) - Constructor for class io.grpc.CompositeCallCredentials
- CompositeChannelCredentials - Class in io.grpc
-
ChannelCredentials
which use per-RPCCallCredentials
. - 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(CompressorRegistry) - Method in class io.grpc.ForwardingChannelBuilder
- compressorRegistry(CompressorRegistry) - Method in class io.grpc.ForwardingChannelBuilder2
- compressorRegistry(CompressorRegistry) - Method in class io.grpc.ForwardingServerBuilder
- 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.
- CompressorRegistry - Class in io.grpc
-
Encloses classes related to the compression and decompression of messages.
- CONNECTING - io.grpc.ConnectivityState
-
The channel is trying to establish a connection and is waiting to make progress on one of the steps involved in name resolution, TCP connection establishment or TLS handshake.
- ConnectivityState - Enum in io.grpc
-
The connectivity states.
- ConnectivityStateInfo - Class in io.grpc
-
A tuple of a
ConnectivityState
and its associatedStatus
. - 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
Context
s in GRPC. - create() - Static method in class io.grpc.InsecureChannelCredentials
- create() - Static method in class io.grpc.InsecureServerCredentials
- create() - Static method in class io.grpc.TlsChannelCredentials
-
Use TLS with its defaults.
- create(ChannelCredentials...) - Static method in class io.grpc.ChoiceChannelCredentials
-
Constructs with the provided
creds
as options, with preferred credentials first. - create(ChannelCredentials, CallCredentials) - Static method in class io.grpc.CompositeChannelCredentials
- create(MethodDescriptor.MethodType, String, MethodDescriptor.Marshaller<RequestT>, MethodDescriptor.Marshaller<ResponseT>) - Static method in class io.grpc.MethodDescriptor
-
Deprecated.
- create(MethodDescriptor<ReqT, RespT>, ServerCallHandler<ReqT, RespT>) - Static method in class io.grpc.ServerMethodDefinition
-
Create a new instance.
- create(ServerCredentials...) - Static method in class io.grpc.ChoiceServerCredentials
-
Constructs with the provided
creds
as options, with preferred credentials first. - create(File, File) - Static method in class io.grpc.TlsServerCredentials
-
Creates an instance using provided certificate chain and private key.
- create(InputStream, InputStream) - Static method in class io.grpc.TlsServerCredentials
-
Creates an instance using provided certificate chain and private key.
- 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
. - 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(List<EquivalentAddressGroup>, String) - Method in class io.grpc.LoadBalancer.Helper
-
Accept a list of EAG for multiple authorities: https://github.com/grpc/grpc-java/issues/4618
- createPendingStream() - Method in class io.grpc.ClientStreamTracer
-
Name resolution is completed and the connection starts getting established.
- 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.
- createResolvingOobChannelBuilder(String) - Method in class io.grpc.LoadBalancer.Helper
-
Deprecated.
- createResolvingOobChannelBuilder(String, ChannelCredentials) - 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 and credentials.
- 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.
- 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 whenExecutor.execute(java.lang.Runnable)
is called as theContext.current()
context of theRunnable
scheduled. - CUSTOM_MANAGERS - io.grpc.TlsChannelCredentials.Feature
-
Key managers and trust managers may be specified as
KeyManager
andTrustManager
objects. - CUSTOM_MANAGERS - io.grpc.TlsServerCredentials.Feature
-
Key managers and trust managers may be specified as
KeyManager
andTrustManager
objects.
D
- DATA_LOSS - io.grpc.Status.Code
-
Unrecoverable data loss or corruption.
- 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_EXCEEDED - io.grpc.Status.Code
-
Deadline expired before operation could complete.
- DEADLINE_EXCEEDED - Static variable in class io.grpc.Status
-
Deadline expired before operation could complete.
- Deadline.Ticker - Class in io.grpc
-
Time source representing nanoseconds since fixed but arbitrary point in time.
- DEBUG - io.grpc.ChannelLogger.ChannelLogLevel
- 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(DecompressorRegistry) - Method in class io.grpc.ForwardingChannelBuilder
- decompressorRegistry(DecompressorRegistry) - Method in class io.grpc.ForwardingChannelBuilder2
- decompressorRegistry(DecompressorRegistry) - Method in class io.grpc.ForwardingServerBuilder
- 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.
- DecompressorRegistry - Class in io.grpc
-
Encloses classes related to the compression and decompression of messages.
- DEFAULT - Static variable in class io.grpc.CallOptions
-
A blank
CallOptions
that all fields are not set. - defaultLoadBalancingPolicy(String) - Method in class io.grpc.ForwardingChannelBuilder
- defaultLoadBalancingPolicy(String) - Method in class io.grpc.ForwardingChannelBuilder2
- 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.ForwardingChannelBuilder2
- 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
-
Deprecated.As of 1.60.0, use
ForwardingChannelBuilder2
instead. - delegate() - Method in class io.grpc.ForwardingChannelBuilder2
-
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.ForwardingServerBuilder
-
Returns the delegated
ServerBuilder
. - 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
- deregister(LoadBalancerProvider) - Method in class io.grpc.LoadBalancerRegistry
-
Deregisters a provider.
- deregister(ManagedChannelProvider) - Method in class io.grpc.ManagedChannelRegistry
-
Deregisters a provider.
- deregister(NameResolverProvider) - Method in class io.grpc.NameResolverRegistry
-
Deregisters a provider.
- deregister(ServerProvider) - Method in class io.grpc.ServerRegistry
-
Deregisters a provider.
- detach() - Method in interface io.grpc.Detachable
-
Detaches the underlying data source from this instance and transfers to an
InputStream
. - 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
-
Implements
Context.detach(io.grpc.Context)
. - Detachable - Interface in io.grpc
-
An extension of
InputStream
that allows the underlying data source to be detached and transferred to a new instance of the same kind. - 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.ForwardingChannelBuilder2
- directExecutor() - Method in class io.grpc.ForwardingServerBuilder
- 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.
- disableRetry() - Method in class io.grpc.ForwardingChannelBuilder
- disableRetry() - Method in class io.grpc.ForwardingChannelBuilder2
- disableRetry() - Method in class io.grpc.ManagedChannelBuilder
-
Disables the retry and hedging subsystem provided by the gRPC library.
- disableServiceConfigLookUp() - Method in class io.grpc.ForwardingChannelBuilder
- disableServiceConfigLookUp() - Method in class io.grpc.ForwardingChannelBuilder2
- 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 attributes.
- 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 anOutputStream
. - 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
- EMPTY_PICKER - Static variable in class io.grpc.LoadBalancer
-
Deprecated.Use
new FixedResultPicker(PickResult.withNoResult())
instead. - emptyInstance() - Static method in class io.grpc.DecompressorRegistry
- enableRetry() - Method in class io.grpc.ForwardingChannelBuilder
- enableRetry() - Method in class io.grpc.ForwardingChannelBuilder2
- enableRetry() - Method in class io.grpc.ManagedChannelBuilder
-
Enables the retry and hedging subsystem which will use per-method configuration.
- 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.
- 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.LoadBalancer.PickResult
- 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.Status
-
Equality on Statuses is not well defined.
- EquivalentAddressGroup - Class in io.grpc
-
A group of
SocketAddress
es that are considered equivalent when channel makes connections. - 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(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.Attr - Annotation Type in io.grpc
-
Annotation for
EquivalentAddressGroup
's attributes. - error(String) - Static method in class io.grpc.ManagedChannelProvider.NewChannelBuilderResult
- error(String) - Static method in class io.grpc.ServerProvider.NewServerBuilderResult
- ERROR - io.grpc.ChannelLogger.ChannelLogLevel
- ErrorPicker(Status) - Constructor for class io.grpc.LoadBalancer.ErrorPicker
-
Deprecated.
- 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.ForwardingChannelBuilder2
- executor(Executor) - Method in class io.grpc.ForwardingServerBuilder
- 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.
- extractBareMethodName(String) - Static method in class io.grpc.MethodDescriptor
-
Extract the method name out of a fully qualified method name.
- 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 - io.grpc.Status.Code
-
Operation was rejected because the system is not in a state required for the operation's execution.
- 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.
- FAKE - io.grpc.TlsChannelCredentials.Feature
-
A feature that no consumer should understand.
- FAKE - io.grpc.TlsServerCredentials.Feature
-
A feature that no consumer should understand.
- fallbackHandlerRegistry(HandlerRegistry) - Method in class io.grpc.ForwardingServerBuilder
- 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.
- 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.
- fixedContextExecutor(Executor) - Method in class io.grpc.Context
-
Wrap an
Executor
so that it always executes with this context as theContext.current()
context. - FixedResultPicker(LoadBalancer.PickResult) - Constructor for class io.grpc.LoadBalancer.FixedResultPicker
- forAddress(String, int) - Static method in class io.grpc.ForwardingChannelBuilder2
-
This method serves to force subclasses to "hide" this static factory.
- forAddress(String, int) - Static method in class io.grpc.ManagedChannelBuilder
-
Creates a channel with the target's address and port number.
- fork() - Method in class io.grpc.Context
-
Create a new context which propagates the values of this context but does not cascade its cancellation.
- 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.ForwardingServerBuilder
-
This method serves to force sub classes to "hide" this static factory.
- forPort(int) - Static method in class io.grpc.ServerBuilder
-
Static factory for creating a new ServerBuilder.
- forTarget(String) - Static method in class io.grpc.ForwardingChannelBuilder2
-
This method serves to force subclasses to "hide" this static factory.
- 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. - 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 methods to another builder by default. - ForwardingChannelBuilder() - Constructor for class io.grpc.ForwardingChannelBuilder
-
The default constructor.
- ForwardingChannelBuilder2<T extends ManagedChannelBuilder<T>> - Class in io.grpc
-
A
ManagedChannelBuilder
that delegates all its builder methods to another builder by default. - ForwardingChannelBuilder2() - Constructor for class io.grpc.ForwardingChannelBuilder2
-
The default constructor.
- ForwardingClientCall<ReqT,RespT> - Class in io.grpc
-
A
ClientCall
which forwards all of its methods to anotherClientCall
. - 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 aClientCall
as the delegate. - ForwardingClientCallListener<RespT> - Class in io.grpc
-
A
ClientCall.Listener
which forwards all of its methods to anotherClientCall.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 aClientCall.Listener
as the delegate. - ForwardingServerBuilder<T extends ServerBuilder<T>> - Class in io.grpc
-
A
ServerBuilder
that delegates all its builder methods to another builder by default. - ForwardingServerBuilder() - Constructor for class io.grpc.ForwardingServerBuilder
-
The default constructor.
- ForwardingServerCall<ReqT,RespT> - Class in io.grpc
-
A
ServerCall
which forwards all of its methods to anotherServerCall
. - 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 aServerCall
as the delegate. - ForwardingServerCallListener<ReqT> - Class in io.grpc
-
A
ServerCall.Listener
which forwards all of its methods to anotherServerCall.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 aServerCall.Listener
as the delegate. - fromCode(Status.Code) - Static method in class io.grpc.Status
-
Return a
Status
given a canonical errorStatus.Code
object. - fromCodeValue(int) - Static method in class io.grpc.Status
-
Return a
Status
given a canonical errorStatus.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. - fromThrowable(Throwable) - Static method in class io.grpc.Status
G
- generateFullMethodName(String, String) - Static method in class io.grpc.MethodDescriptor
-
Generate the fully qualified method name.
- get() - Method in class io.grpc.Context.Key
-
Get the value from the
Context.current()
context for this key. - get(Attributes.Key<T>) - Method in class io.grpc.Attributes
-
Gets the value for the key, or
null
if it's not present. - 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.
- 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
- 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.ServerCall
-
Gets the authority this call is addressed to.
- getAuthority() - Method in class io.grpc.ServerStreamTracer.ServerCallInfo
- getBareMethodName() - Method in class io.grpc.MethodDescriptor
-
A convenience method for
extractBareMethodName(getFullMethodName())
. - getByteBuffer() - Method in interface io.grpc.HasByteBuffer
-
Gets a
ByteBuffer
containing some bytes of the content next to be read, ornull
if has reached end of the content. - getCallCredentials() - Method in class io.grpc.CompositeChannelCredentials
- getCallOptions() - Method in class io.grpc.CallCredentials.RequestInfo
-
The call options used to call this RPC.
- 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.
- getCause() - Method in class io.grpc.Status
-
The underlying cause of an error.
- getCertificateChain() - Method in class io.grpc.TlsChannelCredentials
-
The certificate chain for the client's identity, as a new byte array.
- getCertificateChain() - Method in class io.grpc.TlsServerCredentials
-
The certificate chain for the server's identity, as a new byte array.
- getChannelBuilder() - Method in class io.grpc.ManagedChannelProvider.NewChannelBuilderResult
- getChannelCredentials() - Method in class io.grpc.CompositeChannelCredentials
- getChannelCredentials() - Method in class io.grpc.LoadBalancer.Helper
-
Returns the ChannelCredentials used to construct the channel, without bearer tokens.
- 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. - getChannelTarget() - Method in class io.grpc.LoadBalancer.Helper
-
Returns the target string of the channel, guaranteed to include its scheme.
- getClientAuth() - Method in class io.grpc.TlsServerCredentials
-
Non-
null
setting indicating whether the server should expect a client's identity. - 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.
- getCredentialsList() - Method in class io.grpc.ChoiceChannelCredentials
-
Non-empty list of credentials, in preference order.
- getCredentialsList() - Method in class io.grpc.ChoiceServerCredentials
-
Non-empty list of credentials, in preference order.
- 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.
- 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.ManagedChannelRegistry
-
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.
- getDefaultRegistry() - Static method in class io.grpc.ServerRegistry
-
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. - getDefaultScheme() - Method in class io.grpc.NameResolverRegistry
- getDescription() - Method in class io.grpc.Status
-
A description of this status for human consumption.
- getError() - Method in class io.grpc.ManagedChannelProvider.NewChannelBuilderResult
- getError() - Method in class io.grpc.NameResolver.ConfigOrError
-
Returns error status if exists, otherwise null.
- getError() - Method in class io.grpc.ServerProvider.NewServerBuilderResult
- getExecutor() - Method in class io.grpc.CallOptions
-
Returns the executor override to use for this specific call, or
null
if there is no override. - getExecutor(ServerCall<ReqT, RespT>, Metadata) - Method in interface io.grpc.ServerCallExecutorSupplier
-
Returns an executor to handle the server call.
- 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.
- 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. - getKeyManagers() - Method in class io.grpc.TlsChannelCredentials
-
Returns the key manager list which provides the client's identity.
- getKeyManagers() - Method in class io.grpc.TlsServerCredentials
-
Returns the key manager list which provides the server's identity.
- 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
- getMethodDescriptor() - Method in class io.grpc.LoadBalancer.PickSubchannelArgs
-
Call 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. - getMetricRecorder() - Method in class io.grpc.LoadBalancer.Helper
-
Returns the
MetricRecorder
that the channel uses to record metrics. - 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.ServiceDescriptor
-
Simple name of the service.
- getNameResolverArgs() - Method in class io.grpc.LoadBalancer.Helper
-
Returns the
NameResolver.Args
that the Channel uses to createNameResolver
s. - getNameResolverRegistry() - Method in class io.grpc.LoadBalancer.Helper
-
Returns the
NameResolverRegistry
that the Channel uses to look forNameResolver
s. - getOffloadExecutor() - Method in class io.grpc.NameResolver.Args
-
Returns the Executor on which this resolver should execute long-running or I/O bound work.
- getOnReadyThreshold() - Method in class io.grpc.CallOptions
-
Returns to the default number of bytes that must be queued before the call will leave the 'wait for ready' state.
- 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.
- getOverrideAuthority() - Method in class io.grpc.NameResolver.Args
-
Returns the overrideAuthority from channel
ManagedChannelBuilder.overrideAuthority(java.lang.String)
. - getPassword() - Method in class io.grpc.HttpConnectProxiedSocketAddress
-
Returns the password used to connect to the proxy.
- getPickDetailsConsumer() - Method in class io.grpc.LoadBalancer.PickSubchannelArgs
-
Gets an object that can be informed about what sort of pick was made.
- 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.
- getPreviousAttempts() - Method in class io.grpc.ClientStreamTracer.StreamInfo
-
Returns the number of preceding attempts for the RPC.
- 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.
- getPrivateKey() - Method in class io.grpc.TlsChannelCredentials
-
The private key for the client's identity, as a new byte array.
- getPrivateKey() - Method in class io.grpc.TlsServerCredentials
-
The private key for the server's identity, as a new byte array.
- getPrivateKeyPassword() - Method in class io.grpc.TlsChannelCredentials
-
Returns the password to decrypt the private key, or
null
if unencrypted. - getPrivateKeyPassword() - Method in class io.grpc.TlsServerCredentials
-
Returns the password to decrypt the private key, or
null
if unencrypted. - getProducedSocketAddressTypes() - Method in class io.grpc.NameResolverProvider
-
Returns the
SocketAddress
types this provider's name-resolver is capable of producing. - 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. - getProviderForScheme(String) - Method in class io.grpc.NameResolverRegistry
- 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
. - 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.
- getRootCertificates() - Method in class io.grpc.TlsChannelCredentials
-
Root trust certificates for verifying the server's identity that override the system's defaults.
- getRootCertificates() - Method in class io.grpc.TlsServerCredentials
-
Root trust certificates for verifying the client's identity that override the system's defaults.
- 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. - 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.
- getScheme() - Method in class io.grpc.NameResolverProvider
-
Returns the scheme associated with the provider.
- getSecurityLevel() - Method in class io.grpc.CallCredentials.RequestInfo
-
The security level on the transport.
- getSecurityLevel() - Method in class io.grpc.ServerCall
-
Returns the level of security guarantee in communications
- getServerBuilder() - Method in class io.grpc.ServerProvider.NewServerBuilderResult
- getServerCallHandler() - Method in class io.grpc.ServerMethodDefinition
-
Handler for incoming calls.
- 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.Args.getServiceConfigParser()
. - getServiceConfigParser() - Method in class io.grpc.NameResolver.Args
-
Returns the
NameResolver.ServiceConfigParser
. - 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())
. - getServices() - Method in class io.grpc.HandlerRegistry
-
Returns the
ServerServiceDefinition
s 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.
- 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
ClientStreamTracerFactory
s. - 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. - getSupportedSocketAddressTypes() - Method in class io.grpc.ManagedChannelProvider
-
Returns the
SocketAddress
types this ManagedChannelProvider supports. - 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 theLoadBalancer
interface are run in. - getSynchronizationContext() - Method in class io.grpc.NameResolver.Args
-
Returns the
SynchronizationContext
whereNameResolver.start(Listener2)
,NameResolver.shutdown()
andNameResolver.refresh()
are run from. - 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.
- 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.
- getTrustManagers() - Method in class io.grpc.TlsChannelCredentials
-
Returns the trust manager list which verifies the server's identity.
- getTrustManagers() - Method in class io.grpc.TlsServerCredentials
-
Returns the trust manager list which verifies the client's identity.
- getType() - Method in class io.grpc.MethodDescriptor
-
The call type of the method.
- getUnsafeChannelCredentials() - Method in class io.grpc.LoadBalancer.Helper
-
Returns the UNSAFE ChannelCredentials used to construct the channel, including bearer tokens.
- getUsername() - Method in class io.grpc.HttpConnectProxiedSocketAddress
-
Returns the username used to connect to the proxy.
- 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.
- 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.
- handleResolvedAddresses(LoadBalancer.ResolvedAddresses) - Method in class io.grpc.LoadBalancer
-
Handles newly resolved server groups and metadata attributes 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
- handleSubchannelState(LoadBalancer.Subchannel, ConnectivityStateInfo) - Method in class io.grpc.LoadBalancer
-
Deprecated.This method will be removed. Stop overriding it. Instead, pass
LoadBalancer.SubchannelStateListener
toLoadBalancer.Subchannel.start(io.grpc.LoadBalancer.SubchannelStateListener)
to receive Subchannel state updates - handshakeTimeout(long, TimeUnit) - Method in class io.grpc.ForwardingServerBuilder
- handshakeTimeout(long, TimeUnit) - Method in class io.grpc.ServerBuilder
-
Sets the permitted time for new connections to complete negotiation handshakes before being killed.
- HAS_HEALTH_PRODUCER_LISTENER_KEY - Static variable in class io.grpc.LoadBalancer
- HasByteBuffer - Interface in io.grpc
-
Extension to an
InputStream
whose content can be accessed asByteBuffer
s. - 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.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.Status
-
Hash codes on Statuses are not well defined.
- hasResult() - Method in class io.grpc.LoadBalancer.PickResult
-
Returns
true
if the pick was not created withLoadBalancer.PickResult.withNoResult()
. - HEALTH_CONSUMER_LISTENER_ARG_KEY - Static variable in class io.grpc.LoadBalancer
- Helper() - Constructor for class io.grpc.LoadBalancer.Helper
- 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
-
The builder for
HttpConnectProxiedSocketAddress
.
I
- IDLE - io.grpc.ConnectivityState
-
This is the state where the channel is not even trying to create a connection because of a lack of new or pending RPCs.
- idleTimeout(long, TimeUnit) - Method in class io.grpc.ForwardingChannelBuilder
- idleTimeout(long, TimeUnit) - Method in class io.grpc.ForwardingChannelBuilder2
- idleTimeout(long, TimeUnit) - Method in class io.grpc.ManagedChannelBuilder
-
Set the duration without ongoing RPCs before going to idle mode.
- ignoreRefreshNameResolutionCheck() - Method in class io.grpc.LoadBalancer.Helper
-
Deprecated.Warning has been removed
- inboundHeaders() - Method in class io.grpc.ClientStreamTracer
-
Headers has been received from the server.
- inboundMessage(int) - Method in class io.grpc.StreamTracer
-
An inbound message has been received by the stream.
- inboundMessageRead(int, long, long) - Method in class io.grpc.StreamTracer
-
An inbound message has been fully read from the transport.
- inboundTrailers(Metadata) - Method in class io.grpc.ClientStreamTracer
-
Trailing metadata has been received from the server.
- inboundUncompressedSize(long) - Method in class io.grpc.StreamTracer
-
The uncompressed size of some inbound data is revealed.
- inboundWireSize(long) - Method in class io.grpc.StreamTracer
-
The wire size of some inbound data is revealed.
- incomprehensible(Set<TlsChannelCredentials.Feature>) - Method in class io.grpc.TlsChannelCredentials
-
Returns an empty set if this credential can be adequately understood via the features listed, otherwise returns a hint of features that are lacking to understand the configuration to be used for manual debugging.
- incomprehensible(Set<TlsServerCredentials.Feature>) - Method in class io.grpc.TlsServerCredentials
-
Returns an empty set if this credential can be adequately understood via the features listed, otherwise returns a hint of features that are lacking to understand the configuration to be used for manual debugging.
- INFO - io.grpc.ChannelLogger.ChannelLogLevel
- InsecureChannelCredentials - Class in io.grpc
-
No client identity, authentication, or encryption is to be used.
- InsecureServerCredentials - Class in io.grpc
-
No server identity or encryption is to be used.
- INTEGRITY - io.grpc.SecurityLevel
-
The other party is authenticated and the data is not tampered with.
- intercept(BindableService, ServerInterceptor...) - Static method in class io.grpc.ServerInterceptors
- intercept(BindableService, List<? extends ServerInterceptor>) - Static method in class io.grpc.ServerInterceptors
- intercept(Channel, ClientInterceptor...) - Static method in class io.grpc.ClientInterceptors
-
Create a new
Channel
that will callinterceptors
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 callinterceptors
before starting a call on the given channel. - intercept(ClientInterceptor...) - Method in class io.grpc.ForwardingChannelBuilder
- intercept(ClientInterceptor...) - Method in class io.grpc.ForwardingChannelBuilder2
- 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.ForwardingServerBuilder
- 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
whoseServerCallHandler
s will callinterceptors
before calling the pre-existingServerCallHandler
. - intercept(ServerServiceDefinition, List<? extends ServerInterceptor>) - Static method in class io.grpc.ServerInterceptors
-
Create a new
ServerServiceDefinition
whoseServerCallHandler
s will callinterceptors
before calling the pre-existingServerCallHandler
. - intercept(List<ClientInterceptor>) - Method in class io.grpc.ForwardingChannelBuilder
- intercept(List<ClientInterceptor>) - Method in class io.grpc.ForwardingChannelBuilder2
- intercept(List<ClientInterceptor>) - Method in class io.grpc.ManagedChannelBuilder
-
Adds interceptors that will be called before the channel performs its real work.
- 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(MethodDescriptor<ReqT, RespT>, CallOptions, Channel) - Method in interface io.grpc.ClientInterceptor
- interceptCall(ServerCall<ReqT, RespT>, Metadata, ServerCallHandler<ReqT, RespT>) - Method in interface io.grpc.ServerInterceptor
- interceptForward(BindableService, ServerInterceptor...) - Static method in class io.grpc.ServerInterceptors
- interceptForward(BindableService, List<? extends ServerInterceptor>) - Static method in class io.grpc.ServerInterceptors
- interceptForward(Channel, ClientInterceptor...) - Static method in class io.grpc.ClientInterceptors
-
Create a new
Channel
that will callinterceptors
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 callinterceptors
before starting a call on the given channel. - interceptForward(ServerServiceDefinition, ServerInterceptor...) - Static method in class io.grpc.ServerInterceptors
-
Create a new
ServerServiceDefinition
whoseServerCallHandler
s will callinterceptors
before calling the pre-existingServerCallHandler
. - interceptForward(ServerServiceDefinition, List<? extends ServerInterceptor>) - Static method in class io.grpc.ServerInterceptors
-
Create a new
ServerServiceDefinition
whoseServerCallHandler
s will callinterceptors
before calling the pre-existingServerCallHandler
. - interceptWithTarget(ManagedChannelBuilder.InterceptorFactory) - Method in class io.grpc.ForwardingChannelBuilder2
- interceptWithTarget(ManagedChannelBuilder.InterceptorFactory) - Method in class io.grpc.ManagedChannelBuilder
-
Internal-only: Adds a factory that will construct an interceptor based on the channel's target.
- 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 - io.grpc.Status.Code
-
Internal errors.
- INTERNAL - Static variable in class io.grpc.Status
-
Internal errors.
- INVALID_ARGUMENT - io.grpc.Status.Code
-
Client specified an invalid argument.
- INVALID_ARGUMENT - Static variable in class io.grpc.Status
-
Client specified an invalid argument.
- io.grpc - package io.grpc
-
The gRPC core public API.
- IS_PETIOLE_POLICY - Static variable in class io.grpc.LoadBalancer
- 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.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. - 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 bywithDrop()
. - isExpired() - Method in class io.grpc.Deadline
-
Returns whether this has 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. - 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.
- isTransparentRetry() - Method in class io.grpc.ClientStreamTracer.StreamInfo
-
Whether the stream is a transparent retry.
- 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.ForwardingChannelBuilder2
- keepAliveTime(long, TimeUnit) - Method in class io.grpc.ForwardingServerBuilder
- 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.ServerBuilder
-
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.ForwardingChannelBuilder2
- keepAliveTimeout(long, TimeUnit) - Method in class io.grpc.ForwardingServerBuilder
- 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.ServerBuilder
-
Sets a 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.ForwardingChannelBuilder2
- keepAliveWithoutCalls(boolean) - Method in class io.grpc.ManagedChannelBuilder
-
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. - keyManager(File, File) - Method in class io.grpc.TlsChannelCredentials.Builder
-
Use the provided certificate chain and private key as the client's identity.
- keyManager(File, File) - Method in class io.grpc.TlsServerCredentials.Builder
-
Use the provided certificate chain and private key as the server's identity.
- keyManager(File, File, String) - Method in class io.grpc.TlsChannelCredentials.Builder
-
Use the provided certificate chain and possibly-encrypted private key as the client's identity.
- keyManager(File, File, String) - Method in class io.grpc.TlsServerCredentials.Builder
-
Use the provided certificate chain and possibly-encrypted private key as the server's identity.
- keyManager(InputStream, InputStream) - Method in class io.grpc.TlsChannelCredentials.Builder
-
Use the provided certificate chain and private key as the client's identity.
- keyManager(InputStream, InputStream) - Method in class io.grpc.TlsServerCredentials.Builder
-
Use the provided certificate chain and private key as the server's identity.
- keyManager(InputStream, InputStream, String) - Method in class io.grpc.TlsChannelCredentials.Builder
-
Use the provided certificate chain and possibly-encrypted private key as the client's identity.
- keyManager(InputStream, InputStream, String) - Method in class io.grpc.TlsServerCredentials.Builder
-
Use the provided certificate chain and possibly-encrypted private key as the server's identity.
- keyManager(KeyManager...) - Method in class io.grpc.TlsChannelCredentials.Builder
-
Have the provided key manager select the client's identity.
- keyManager(KeyManager...) - Method in class io.grpc.TlsServerCredentials.Builder
-
Have the provided key manager select the server's identity.
- 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.ErrorPicker - Class in io.grpc
-
Deprecated.Use
new FixedResultPicker(PickResult.withError(error))
instead. - LoadBalancer.Factory - Class in io.grpc
-
Factory to create
LoadBalancer
instance. - LoadBalancer.FixedResultPicker - Class in io.grpc
-
A picker that always returns the same result.
- LoadBalancer.Helper - Class in io.grpc
-
Provides essentials for LoadBalancer implementations.
- LoadBalancer.PickDetailsConsumer - Interface in io.grpc
-
Receives information about the pick being chosen.
- LoadBalancer.PickResult - Class in io.grpc
-
A balancing decision made by
SubchannelPicker
for an RPC. - LoadBalancer.PickSubchannelArgs - Class in io.grpc
-
Provides arguments for a
LoadBalancer.SubchannelPicker.pickSubchannel( LoadBalancer.PickSubchannelArgs)
. - 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
-
Builder for
LoadBalancer.ResolvedAddresses
. - 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
LoadBalancer
s. - LoadBalancerProvider() - Constructor for class io.grpc.LoadBalancerProvider
- LoadBalancerRegistry - Class in io.grpc
-
Registry of
LoadBalancerProvider
s. - LoadBalancerRegistry() - Constructor for class io.grpc.LoadBalancerRegistry
- 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) - Method in class io.grpc.HandlerRegistry
-
Lookup a
ServerMethodDefinition
by its fully-qualified name. - lookupMethod(String, String) - Method in class io.grpc.HandlerRegistry
-
Lookup a
ServerMethodDefinition
by its fully-qualified name.
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
- ManagedChannelBuilder.InterceptorFactory - Interface in io.grpc
-
Internal-only.
- ManagedChannelProvider - Class in io.grpc
-
Provider of managed channels for transport agnostic consumption.
- ManagedChannelProvider() - Constructor for class io.grpc.ManagedChannelProvider
- ManagedChannelProvider.NewChannelBuilderResult - Class in io.grpc
- ManagedChannelProvider.ProviderNotFoundException - Exception in io.grpc
-
Thrown when no suitable
ManagedChannelProvider
objects can be found. - ManagedChannelRegistry - Class in io.grpc
-
Registry of
ManagedChannelProvider
s. - ManagedChannelRegistry() - Constructor for class io.grpc.ManagedChannelRegistry
- ManagedChannelRegistry.ProviderNotFoundException - Exception in io.grpc
-
Thrown when no suitable
ManagedChannelProvider
objects can be found. - maxConnectionAge(long, TimeUnit) - Method in class io.grpc.ForwardingServerBuilder
- maxConnectionAge(long, TimeUnit) - Method in class io.grpc.ServerBuilder
-
Sets the maximum connection age, connections lasting longer than which will be gracefully terminated.
- maxConnectionAgeGrace(long, TimeUnit) - Method in class io.grpc.ForwardingServerBuilder
- maxConnectionAgeGrace(long, TimeUnit) - Method in class io.grpc.ServerBuilder
-
Sets the grace time for the graceful connection termination.
- maxConnectionIdle(long, TimeUnit) - Method in class io.grpc.ForwardingServerBuilder
- maxConnectionIdle(long, TimeUnit) - Method in class io.grpc.ServerBuilder
-
Sets the maximum connection idle time, connections being idle for longer than which will be gracefully terminated.
- maxHedgedAttempts(int) - Method in class io.grpc.ForwardingChannelBuilder
- maxHedgedAttempts(int) - Method in class io.grpc.ForwardingChannelBuilder2
- maxHedgedAttempts(int) - Method in class io.grpc.ManagedChannelBuilder
-
Sets the maximum number of hedged attempts that may be configured by the service config.
- maxInboundMessageSize(int) - Method in class io.grpc.ForwardingChannelBuilder
- maxInboundMessageSize(int) - Method in class io.grpc.ForwardingChannelBuilder2
- maxInboundMessageSize(int) - Method in class io.grpc.ForwardingServerBuilder
- 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.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.ForwardingChannelBuilder2
- maxInboundMetadataSize(int) - Method in class io.grpc.ForwardingServerBuilder
- 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.ServerBuilder
-
Sets the maximum size of metadata allowed to be received.
- maxRetryAttempts(int) - Method in class io.grpc.ForwardingChannelBuilder
- maxRetryAttempts(int) - Method in class io.grpc.ForwardingChannelBuilder2
- maxRetryAttempts(int) - Method in class io.grpc.ManagedChannelBuilder
-
Sets the maximum number of retry attempts that may be configured by the service config.
- maxTraceEvents(int) - Method in class io.grpc.ForwardingChannelBuilder
- maxTraceEvents(int) - Method in class io.grpc.ForwardingChannelBuilder2
- 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
- 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 its type parameter
T
at runtime. - minimum(Deadline) - Method in class io.grpc.Deadline
-
Return the minimum deadline of
this
or an other deadline. - MTLS - io.grpc.TlsChannelCredentials.Feature
-
Client identity may be provided and server verification can be tuned.
- MTLS - io.grpc.TlsServerCredentials.Feature
-
Client certificates may be requested and verified.
N
- name() - Method in class io.grpc.Metadata.Key
-
Returns the normalized name for this key.
- NAME_RESOLUTION_DELAYED - Static variable in class io.grpc.ClientStreamTracer
-
Indicates how long the call was delayed, in nanoseconds, due to waiting for name resolution result.
- 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 aNameResolver
. - NameResolver.Args.Builder - Class in io.grpc
-
Builder for
NameResolver.Args
. - NameResolver.ConfigOrError - Class in io.grpc
-
Represents either a successfully parsed service config, containing all necessary parts to be later applied by the channel, or a Status containing the error encountered while parsing.
- NameResolver.Factory - Class in io.grpc
-
Factory that creates
NameResolver
instances. - 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
-
A builder for
NameResolver.ResolutionResult
. - 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.ForwardingChannelBuilder2
-
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 orNameResolverRegistry.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
NameResolverProvider
s. - 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.
- 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() - 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() - Static method in class io.grpc.TlsChannelCredentials
-
Creates a builder for changing default configuration.
- newBuilder() - Static method in class io.grpc.TlsServerCredentials
-
Creates a builder for changing default configuration.
- newBuilder(Attributes) - Static method in class io.grpc.Attributes
-
Deprecated.Use
Attributes.toBuilder()
on theAttributes
instance instead. This method will be removed in the future. - newBuilder(MethodDescriptor.Marshaller<ReqT>, MethodDescriptor.Marshaller<RespT>) - Static method in class io.grpc.MethodDescriptor
-
Creates a new builder for a
MethodDescriptor
. - 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 givenMethodDescriptor
. - newChannelBuilder(String, ChannelCredentials) - Static method in class io.grpc.Grpc
-
Creates a channel builder with a target string and credentials.
- newChannelBuilder(String, ChannelCredentials) - Method in class io.grpc.ManagedChannelProvider
-
Creates a new builder with the given target URI and credentials.
- newChannelBuilderForAddress(String, int, ChannelCredentials) - Static method in class io.grpc.Grpc
-
Creates a channel builder from a host, port, and credentials.
- 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.
- newInterceptor(String) - Method in interface io.grpc.ManagedChannelBuilder.InterceptorFactory
- newLoadBalancer(LoadBalancer.Helper) - Method in class io.grpc.LoadBalancer.Factory
-
Creates a
LoadBalancer
that will be used inside a channel. - newNameResolver(URI, NameResolver.Args) - Method in class io.grpc.NameResolver.Factory
-
Creates a
NameResolver
for the given target URI, ornull
if the given URI cannot be resolved by this factory. - newServerBuilderForPort(int, ServerCredentials) - Static method in class io.grpc.Grpc
-
Static factory for creating a new ServerBuilder.
- newServerBuilderForPort(int, ServerCredentials) - Method in class io.grpc.ServerProvider
-
Creates a new builder with the given port and credentials.
- newServerStreamTracer(String, Metadata) - Method in class io.grpc.ServerStreamTracer.Factory
-
Creates a
ServerStreamTracer
for a new server stream. - NONE - io.grpc.SecurityLevel
-
No security guarantee.
- NONE - io.grpc.TlsServerCredentials.ClientAuth
-
Clients will not present any identity.
- NONE - Static variable in class io.grpc.Codec.Identity
-
Special sentinel codec indicating that no compression should be used.
- NOT_FOUND - io.grpc.Status.Code
-
Some requested entity (e.g., file or directory) was not found.
- NOT_FOUND - Static variable in class io.grpc.Status
-
Some requested entity (e.g., file or directory) was not found.
- 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 byManagedChannel.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, Metadata.AsciiMarshaller<T>) - Static method in class io.grpc.Metadata.Key
-
Creates a key for an ASCII header.
- 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, T) - Static method in class io.grpc.CallOptions.Key
-
Deprecated.Use
CallOptions.Key.create(java.lang.String)
orCallOptions.Key.createWithDefault(java.lang.String, T)
instead. This method will be removed. - offloadExecutor(Executor) - Method in class io.grpc.ForwardingChannelBuilder
- offloadExecutor(Executor) - Method in class io.grpc.ForwardingChannelBuilder2
- offloadExecutor(Executor) - Method in class io.grpc.ManagedChannelBuilder
-
Provides a custom executor that will be used for operations that block or are expensive, to avoid blocking asynchronous code paths.
- offset(long, TimeUnit) - Method in class io.grpc.Deadline
-
Create a new deadline that is offset from
this
. - OK - io.grpc.Status.Code
-
The operation completed successfully.
- OK - Static variable in class io.grpc.Status
-
The operation completed successfully.
- 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. - 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.
- 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(ReqT) - Method in class io.grpc.ForwardingServerCallListener
- onMessage(ReqT) - Method in class io.grpc.ServerCall.Listener
-
A request message has been received.
- onMessage(RespT) - Method in class io.grpc.ForwardingClientCallListener
- onMessage(T) - Method in class io.grpc.ClientCall.Listener
-
A response message has been received.
- 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.
- OPTIONAL - io.grpc.TlsServerCredentials.ClientAuth
-
Clients are requested to present their identity, but clients without identities are permitted.
- originalName() - Method in class io.grpc.Metadata.Key
-
Returns the original name used to create this key.
- OUT_OF_RANGE - io.grpc.Status.Code
-
Operation was attempted past the valid range.
- 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.
- outboundMessage(int) - Method in class io.grpc.StreamTracer
-
An outbound message has been passed to the stream.
- outboundMessageSent(int, long, long) - Method in class io.grpc.StreamTracer
-
An outbound message has been serialized and sent to the transport.
- outboundUncompressedSize(long) - Method in class io.grpc.StreamTracer
-
The uncompressed size of some outbound data is revealed.
- outboundWireSize(long) - Method in class io.grpc.StreamTracer
-
The wire size of some outbound data is revealed.
- overrideAuthority(String) - Method in class io.grpc.ForwardingChannelBuilder
- overrideAuthority(String) - Method in class io.grpc.ForwardingChannelBuilder2
- overrideAuthority(String) - Method in class io.grpc.ManagedChannelBuilder
-
Overrides the authority used with TLS and HTTP virtual hosting.
P
- 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.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.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 - io.grpc.Status.Code
-
The caller does not have permission to execute the specified operation.
- 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.ForwardingServerBuilder
- permitKeepAliveTime(long, TimeUnit) - Method in class io.grpc.ServerBuilder
-
Specify the most aggressive keep-alive time clients are permitted to configure.
- permitKeepAliveWithoutCalls(boolean) - Method in class io.grpc.ForwardingServerBuilder
- permitKeepAliveWithoutCalls(boolean) - Method in class io.grpc.ServerBuilder
-
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.ForwardingChannelBuilder2
- 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.ErrorPicker
-
Deprecated.
- pickSubchannel(LoadBalancer.PickSubchannelArgs) - Method in class io.grpc.LoadBalancer.FixedResultPicker
- 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
- 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.ServerProvider
-
A priority, from 0 to 10 that this provider should be used, taking the current environment into consideration.
- PRIVACY_AND_INTEGRITY - io.grpc.SecurityLevel
-
In addition to
INTEGRITY
, the data is only visible to the intended communication parties. - 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
- ProviderNotFoundException(String) - Constructor for exception io.grpc.ManagedChannelRegistry.ProviderNotFoundException
- ProviderNotFoundException(String) - Constructor for exception io.grpc.ServerRegistry.ProviderNotFoundException
- 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.ForwardingChannelBuilder2
- 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
- READY - io.grpc.ConnectivityState
-
The channel has successfully established a connection all the way through TLS handshake (or equivalent) and all subsequent attempt to communicate have succeeded (or are pending without any known failure ).
- 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. - 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(ManagedChannelProvider) - Method in class io.grpc.ManagedChannelRegistry
-
Register a provider.
- register(NameResolverProvider) - Method in class io.grpc.NameResolverRegistry
-
Register a provider.
- register(ServerProvider) - Method in class io.grpc.ServerRegistry
-
Register a provider.
- remove(Metadata.Key<T>, T) - Method in class io.grpc.Metadata
-
Removes the first occurrence of
value
forkey
. - 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
-
Remove a
Context.CancellationListener
. - 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)
. - 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.override
LoadBalancer.requestConnection()
instead. - RequestInfo() - Constructor for class io.grpc.CallCredentials.RequestInfo
- REQUIRE - io.grpc.TlsServerCredentials.ClientAuth
-
Clients are requested to present their identity, and are required to provide a valid identity.
- requireFakeFeature() - Method in class io.grpc.TlsChannelCredentials.Builder
-
Requires
TlsChannelCredentials.Feature.FAKE
to be understood. - requireFakeFeature() - Method in class io.grpc.TlsServerCredentials.Builder
-
Requires
TlsServerCredentials.Feature.FAKE
to be understood. - 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 - io.grpc.Status.Code
-
Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space.
- 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.ForwardingChannelBuilder2
- 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.
- run(Runnable) - Method in class io.grpc.Context
-
Immediately run a
Runnable
with this context as theContext.current()
context. - runOnExpiration(Runnable, ScheduledExecutorService) - Method in class io.grpc.Deadline
-
Schedule a task to be run when the deadline expires.
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. - scheduleWithFixedDelay(Runnable, long, long, TimeUnit, ScheduledExecutorService) - Method in class io.grpc.SynchronizationContext
-
Schedules a task to be added and run via
SynchronizationContext.execute(java.lang.Runnable)
after an inital delay and then repeated after the delay until cancelled. - 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
- SERVER_STREAMING - io.grpc.MethodDescriptor.MethodType
-
One request message followed by zero or more response messages.
- serverBuilder(ServerBuilder<?>) - Static method in class io.grpc.ServerProvider.NewServerBuilderResult
- 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.
- ServerCallExecutorSupplier - Interface in io.grpc
-
Defines what executor handles the server call, based on each RPC call information at runtime.
- ServerCallHandler<RequestT,ResponseT> - Interface in io.grpc
-
Interface to initiate processing of incoming remote calls.
- ServerCallInfo() - Constructor for class io.grpc.ServerStreamTracer.ServerCallInfo
- 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. - serverCallStarted(ServerStreamTracer.ServerCallInfo<?, ?>) - Method in class io.grpc.ServerStreamTracer
-
Called when
ServerCall
is created. - ServerCredentials - Class in io.grpc
-
Represents a security configuration to be used for servers.
- ServerCredentials() - Constructor for class io.grpc.ServerCredentials
- ServerInterceptor - Interface in io.grpc
-
Interface for intercepting incoming calls before they are dispatched by
ServerCallHandler
. - ServerInterceptors - Class in io.grpc
-
Utility methods for working with
ServerInterceptor
s. - 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
- ServerProvider.NewServerBuilderResult - Class in io.grpc
- ServerRegistry - Class in io.grpc
-
Registry of
ServerProvider
s. - ServerRegistry() - Constructor for class io.grpc.ServerRegistry
- ServerRegistry.ProviderNotFoundException - Exception in io.grpc
-
Thrown when no suitable
ServerProvider
objects can be found. - serverSendsOneMessage() - Method in enum io.grpc.MethodDescriptor.MethodType
-
Returns
true
forUNARY
andCLIENT_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
- 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.ForwardingChannelBuilder2
- setBinaryLog(BinaryLog) - Method in class io.grpc.ForwardingServerBuilder
- 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.
- setDefaultPort(int) - Method in class io.grpc.NameResolver.Args.Builder
- 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.
- setIsTransparentRetry(boolean) - Method in class io.grpc.ClientStreamTracer.StreamInfo.Builder
-
Sets whether the stream is a transparent retry.
- 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.
- setName(String) - Method in class io.grpc.ServiceDescriptor.Builder
-
Sets the name.
- setOffloadExecutor(Executor) - Method in class io.grpc.NameResolver.Args.Builder
- setOnReadyThreshold(int) - Method in class io.grpc.ServerCall
-
A hint to the call that specifies how many bytes must be queued before
ServerCall.isReady()
will return false. - setOverrideAuthority(String) - Method in class io.grpc.NameResolver.Args.Builder
- setPassword(String) - Method in class io.grpc.HttpConnectProxiedSocketAddress.Builder
-
Sets the password used to connect to the proxy.
- setPreviousAttempts(int) - Method in class io.grpc.ClientStreamTracer.StreamInfo.Builder
-
Set the number of preceding attempts of the RPC.
- 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.Args.getServiceConfigParser()
. - setServiceConfigParser(NameResolver.ServiceConfigParser) - Method in class io.grpc.NameResolver.Args.Builder
- 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.
- 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 - io.grpc.ConnectivityState
-
This channel has started shutting down.
- 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
- start() - Method in class io.grpc.Server
-
Bind and start the server.
- 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.
- startCall(ServerCall<RequestT, ResponseT>, Metadata) - Method in interface io.grpc.ServerCallHandler
-
Starts asynchronous processing of an 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 ornull
if the context is not cancelled. - 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.
- streamCreated(Attributes, Metadata) - Method in class io.grpc.ClientStreamTracer
-
The stream is being created on a ready transport.
- 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
- 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
-
Allows the user to check the status and/or cancel a task scheduled by
SynchronizationContext.schedule(java.lang.Runnable, long, java.util.concurrent.TimeUnit, java.util.concurrent.ScheduledExecutorService)
.
T
- thisUsesUnstableApi() - Method in class io.grpc.CallCredentials
-
Deprecated.
- 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.
- TlsChannelCredentials - Class in io.grpc
-
TLS credentials, providing server authentication and encryption.
- TlsChannelCredentials.Builder - Class in io.grpc
-
Builder for
TlsChannelCredentials
. - TlsChannelCredentials.Feature - Enum in io.grpc
-
Features to understand TLS configuration.
- TlsServerCredentials - Class in io.grpc
-
TLS credentials, providing server identity and encryption.
- TlsServerCredentials.Builder - Class in io.grpc
-
Builder for
TlsServerCredentials
. - TlsServerCredentials.ClientAuth - Enum in io.grpc
-
The level of authentication the server should expect from the client.
- TlsServerCredentials.Feature - Enum in io.grpc
-
Features to understand TLS configuration.
- 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() - 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.
- 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.
- toBytes(T) - Method in interface io.grpc.Metadata.BinaryMarshaller
-
Serialize a metadata value to bytes.
- toStatus() - Method in enum io.grpc.Status.Code
-
Returns a
Status
object corresponding to this status code. - 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.ForwardingChannelBuilder2
- toString() - Method in class io.grpc.ForwardingServerBuilder
- toString() - Method in class io.grpc.HttpConnectProxiedSocketAddress
- toString() - Method in class io.grpc.LoadBalancer.CreateSubchannelArgs.Key
- toString() - Method in class io.grpc.LoadBalancer.CreateSubchannelArgs
- toString() - Method in class io.grpc.LoadBalancer.ErrorPicker
-
Deprecated.
- toString() - Method in class io.grpc.LoadBalancer.FixedResultPicker
- 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.ServiceDescriptor
- toString() - Method in class io.grpc.Status
-
A string representation of the status useful for debugging.
- trailersFromThrowable(Throwable) - Static method in class io.grpc.Status
-
Extract an error trailers from the causal chain of a
Throwable
. - TRANSIENT_FAILURE - io.grpc.ConnectivityState
-
There has been some transient failure (such as a TCP 3-way handshake timing out or a socket error).
- 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.
- transportReady(Attributes) - Method in class io.grpc.ClientTransportFilter
-
Called when a transport is ready to accept traffic (when a connection has been established).
- transportReady(Attributes) - Method in class io.grpc.ServerTransportFilter
-
Called when a transport is ready to process streams.
- transportTerminated(Attributes) - Method in class io.grpc.ClientTransportFilter
-
Called when a transport completed shutting down.
- transportTerminated(Attributes) - Method in class io.grpc.ServerTransportFilter
-
Called when a transport is terminated.
- trustManager(File) - Method in class io.grpc.TlsChannelCredentials.Builder
-
Use the provided root certificates to verify the server's identity instead of the system's default.
- trustManager(File) - Method in class io.grpc.TlsServerCredentials.Builder
-
Use the provided root certificates to verify the client's identity instead of the system's default.
- trustManager(InputStream) - Method in class io.grpc.TlsChannelCredentials.Builder
-
Use the provided root certificates to verify the server's identity instead of the system's default.
- trustManager(InputStream) - Method in class io.grpc.TlsServerCredentials.Builder
-
Use the provided root certificates to verify the client's identity instead of the system's default.
- trustManager(TrustManager...) - Method in class io.grpc.TlsChannelCredentials.Builder
-
Have the provided trust manager verify the server's identity instead of the system's default.
- trustManager(TrustManager...) - Method in class io.grpc.TlsServerCredentials.Builder
-
Have the provided trust manager verify the client's identity instead of the system's default.
U
- UNARY - io.grpc.MethodDescriptor.MethodType
-
One request message followed by one response message.
- UNAUTHENTICATED - io.grpc.Status.Code
-
The request does not have valid authentication credentials for the operation.
- UNAUTHENTICATED - Static variable in class io.grpc.Status
-
The request does not have valid authentication credentials for the operation.
- UNAVAILABLE - io.grpc.Status.Code
-
The service is currently unavailable.
- UNAVAILABLE - Static variable in class io.grpc.Status
-
The service is currently unavailable.
- UNIMPLEMENTED - io.grpc.Status.Code
-
Operation is not implemented or not supported/enabled in this service.
- UNIMPLEMENTED - Static variable in class io.grpc.Status
-
Operation is not implemented or not supported/enabled in this service.
- UNKNOWN - io.grpc.MethodDescriptor.MethodType
-
Cardinality and temporal relationships are not known.
- UNKNOWN - io.grpc.Status.Code
-
Unknown error.
- 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
. - updateBalancingState(ConnectivityState, LoadBalancer.SubchannelPicker) - Method in class io.grpc.LoadBalancer.Helper
-
Set a new state with a new picker to the channel.
- updateOobChannelAddresses(ManagedChannel, EquivalentAddressGroup) - Method in class io.grpc.LoadBalancer.Helper
-
Updates the addresses used for connections in the
Channel
that was created byLoadBalancer.Helper.createOobChannel(EquivalentAddressGroup, String)
. - updateOobChannelAddresses(ManagedChannel, List<EquivalentAddressGroup>) - Method in class io.grpc.LoadBalancer.Helper
-
Updates the addresses with a new EAG list.
- useInputStreamMessages(ServerServiceDefinition) - Static method in class io.grpc.ServerInterceptors
-
Create a new
ServerServiceDefinition
whoseMethodDescriptor
serializes to and from InputStream for all methods. - useMarshalledMessages(ServerServiceDefinition, MethodDescriptor.Marshaller<ReqT>, MethodDescriptor.Marshaller<RespT>) - Static method in class io.grpc.ServerInterceptors
-
Create a new
ServerServiceDefinition
withMethodDescriptor
for deserializing requests and separateMethodDescriptor
for serializing responses. - useMarshalledMessages(ServerServiceDefinition, MethodDescriptor.Marshaller<T>) - Static method in class io.grpc.ServerInterceptors
-
Create a new
ServerServiceDefinition
whoseMethodDescriptor
serializes to and from T for all methods. - usePlaintext() - Method in class io.grpc.ForwardingChannelBuilder
- usePlaintext() - Method in class io.grpc.ForwardingChannelBuilder2
- usePlaintext() - Method in class io.grpc.ManagedChannelBuilder
-
Use of a plaintext connection to the server.
- userAgent(String) - Method in class io.grpc.ForwardingChannelBuilder
- userAgent(String) - Method in class io.grpc.ForwardingChannelBuilder2
- 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.ForwardingChannelBuilder2
- useTransportSecurity() - Method in class io.grpc.ManagedChannelBuilder
-
Makes the client use TLS.
- useTransportSecurity(File, File) - Method in class io.grpc.ForwardingServerBuilder
- useTransportSecurity(File, File) - Method in class io.grpc.ServerBuilder
-
Makes the server use TLS.
- useTransportSecurity(InputStream, InputStream) - Method in class io.grpc.ForwardingServerBuilder
- useTransportSecurity(InputStream, InputStream) - Method in class io.grpc.ServerBuilder
-
Makes the server use TLS.
V
- value() - Method in annotation type io.grpc.ExperimentalApi
-
Context information such as links to discussion thread, tracking issue etc.
- 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.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.
- valueOf(String) - Static method in enum io.grpc.TlsChannelCredentials.Feature
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum io.grpc.TlsServerCredentials.ClientAuth
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum io.grpc.TlsServerCredentials.Feature
-
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.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.
- values() - Static method in enum io.grpc.TlsChannelCredentials.Feature
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum io.grpc.TlsServerCredentials.ClientAuth
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum io.grpc.TlsServerCredentials.Feature
-
Returns an array containing the constants of this enum type, in the order they are declared.
W
- WARNING - io.grpc.ChannelLogger.ChannelLogLevel
- 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. - 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. - withCompression(String) - Method in class io.grpc.CallOptions
-
Sets the compression 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
. - withDeadlineAfter(long, TimeUnit) - Method in class io.grpc.CallOptions
-
Returns a new
CallOptions
with a deadline that is after the givenduration
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. - 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
withexecutor
to be used instead of the default executor specified withManagedChannelBuilder.executor(java.util.concurrent.Executor)
. - withMaxInboundMessageSize(int) - Method in class io.grpc.CallOptions
-
Sets the maximum allowed message size acceptable from the remote peer.
- withMaxOutboundMessageSize(int) - Method in class io.grpc.CallOptions
-
Sets the maximum allowed message size acceptable sent to the remote peer.
- withNoResult() - Static method in class io.grpc.LoadBalancer.PickResult
-
No decision could be made.
- withOnReadyThreshold(int) - Method in class io.grpc.CallOptions
-
Specifies how many bytes must be queued before the call is considered not ready to send more messages.
- withOption(CallOptions.Key<T>, T) - Method in class io.grpc.CallOptions
-
Sets a custom option.
- withoutBearerTokens() - Method in class io.grpc.ChannelCredentials
-
Returns the ChannelCredentials stripped of its CallCredentials.
- withoutBearerTokens() - Method in class io.grpc.ChoiceChannelCredentials
- withoutBearerTokens() - Method in class io.grpc.CompositeChannelCredentials
- withoutBearerTokens() - Method in class io.grpc.InsecureChannelCredentials
- withoutBearerTokens() - Method in class io.grpc.TlsChannelCredentials
- 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 aClientStreamTracerFactory
in addition to the existing factories. - withSubchannel(LoadBalancer.Subchannel) - Static method in class io.grpc.LoadBalancer.PickResult
-
Equivalent to
withSubchannel(subchannel, null)
. - withSubchannel(LoadBalancer.Subchannel, ClientStreamTracer.Factory) - Static method in class io.grpc.LoadBalancer.PickResult
-
A decision to proceed the RPC on a Subchannel.
- 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.
- wrap(Runnable) - Method in class io.grpc.Context
-
Wrap a
Runnable
so that it executes with this context as theContext.current()
context. - wrap(Callable<C>) - Method in class io.grpc.Context
-
Wrap a
Callable
so that it executes with this context as theContext.current()
context. - wrapChannel(Channel) - Method in class io.grpc.BinaryLog
- wrapMethodDefinition(ServerMethodDefinition<ReqT, RespT>) - Method in class io.grpc.BinaryLog
All Classes All Packages