Package io.grpc

The gRPC core public API.

See: Description

Interface Summary

Interface	Description
ClientInterceptor	Interface for intercepting outgoing calls before they are dispatched by a Channel.
Codec	Encloses classes related to the compression and decompression of messages.
Compressor	Represents a message compressor.
Context.CancellationListener	A listener notified on context cancellation.
Decompressor	Represents a message decompressor.
Drainable	Extension to an InputStream or alike by adding a method that transfers all content to an OutputStream.
KnownLength	An InputStream or alike whose total number of bytes that can be read is known upfront.
Metadata.AsciiMarshaller<T>	Marshaller for metadata values that are serialized into ASCII strings that contain only following characters: Space: 0x20, but must not be at the beginning or at the end of the value. ASCII visible characters (0x21-0x7E), but excluding comma (",", 0x2C).
Metadata.BinaryMarshaller<T>	Marshaller for metadata values that are serialized into raw binary.
MethodDescriptor.Marshaller<T>	A typed abstraction over message serialization and deserialization, a.k.a.
ServerCallHandler<RequestT,ResponseT>	Interface to initiate processing of incoming remote calls.
ServerInterceptor	Interface for intercepting incoming calls before that are dispatched by ServerCallHandler.

Class Summary

Class	Description
CallOptions	The collection of runtime options for a new RPC call.
Channel	A Channel provides an abstraction over the transport layer that is designed to be consumed by stub implementations.
ClientCall<ReqT,RespT>	An instance of a call to to a remote method.
ClientCall.Listener<T>	Callbacks for receiving metadata, response messages and completion status from the server.
ClientInterceptors	Utility methods for working with ClientInterceptors.
ClientInterceptors.CheckedForwardingClientCall<ReqT,RespT>	A ForwardingClientCall that delivers exceptions from its start logic to the call listener.
Codec.Gzip	A gzip compressor and decompressor.
Codec.Identity	The "identity", or "none" codec.
Context	A context propagation mechanism which carries deadlines, cancellation signals, and other scoped values across API boundaries and between threads.
Context.CancellableContext	A context which inherits cancellation from its parent but which can also be independently cancelled and which will propagate cancellation to its descendants.
Context.Key<T>	Key for indexing values stored in a context.
DecompressorRegistry	Encloses classes related to the compression and decompression of messages.
ForwardingClientCall<ReqT,RespT>	A ClientCall which forwards all of it's methods to another ClientCall.
ForwardingClientCall.SimpleForwardingClientCall<ReqT,RespT>	A simplified version of ForwardingClientCall where subclasses can pass in a ClientCall as the delegate.
ForwardingClientCallListener<RespT>	A ClientCall.Listener which forwards all of its methods to another ClientCall.Listener.
ForwardingClientCallListener.SimpleForwardingClientCallListener<RespT>	A simplified version of ForwardingClientCallListener where subclasses can pass in a ClientCall.Listener as the delegate.
ForwardingServerCall<RespT>	A ServerCall which forwards all of it's methods to another ServerCall.
ForwardingServerCall.SimpleForwardingServerCall<RespT>	A simplified version of ForwardingServerCall where subclasses can pass in a ServerCall as the delegate.
ForwardingServerCallListener<ReqT>	A ServerCall.Listener which forwards all of its methods to another ServerCall.Listener.
ForwardingServerCallListener.SimpleForwardingServerCallListener<ReqT>	A simplified version of ForwardingServerCallListener where subclasses can pass in a ServerCall.Listener as the delegate.
HandlerRegistry	Registry of services and their methods used by servers to dispatching incoming calls.
ManagedChannel	A Channel that provides lifecycle management.
ManagedChannelBuilder<T extends ManagedChannelBuilder<T>>	A builder for ManagedChannel instances.
ManagedChannelProvider	Provider of managed channels for transport agnostic consumption.
Metadata	Provides access to read and write metadata values to be exchanged during a call.
Metadata.Key<T>	Key for metadata entries.
MethodDescriptor<ReqT,RespT>	Description of a remote method used by Channel to initiate a call.
MutableHandlerRegistry	Mutable base class of HandlerRegistry.
MutableHandlerRegistryImpl	Default implementation of MutableHandlerRegistry.
Server	Server for listening for and dispatching incoming calls.
ServerBuilder<T extends ServerBuilder<T>>	A builder for Server instances.
ServerCall<RespT>	Encapsulates a single call received from a remote client.
ServerCall.Listener<ReqT>	Callbacks for consuming incoming RPC messages.
ServerInterceptors	Utility methods for working with ServerInterceptors.
ServerMethodDefinition<ReqT,RespT>	Definition of a method exposed by a Server.
ServerProvider	Provider of servers for transport agnostic consumption.
ServerServiceDefinition	Definition of a service to be exposed via a Server.
ServerServiceDefinition.Builder	Builder for constructing Service instances.
Status	Defines the status of an operation by providing a standard Status.Code in conjunction with an optional descriptive message.

Enum Summary

Enum	Description
MethodDescriptor.MethodType	The call type of a method.
Status.Code	The set of canonical status codes.

Exception Summary

Exception	Description
ManagedChannelProvider.ProviderNotFoundException
StatusException	Status in Exception form, for propagating Status information via exceptions.
StatusRuntimeException	Status in RuntimeException form, for propagating Status information via exceptions.

Annotation Types Summary

Annotation Type	Description
ExperimentalApi	Indicates a public API that can change at any time, and has no guarantee of API stability and backward-compatibility.
Internal	Annotates a program element which is internal to gRPC, not part of the public API, and should not be used outside of gRPC codebase.

Package io.grpc Description

The gRPC core public API.