Uses of Annotation Interface
io.grpc.ExperimentalApi
Packages that use ExperimentalApi
Package
Description
The gRPC core public API.
API for gRPC over Protocol Buffers, including tools for serializing and de-serializing protobuf
messages.
API for gRPC over Protocol Buffers with proto message classes generated by the Lite Runtime
library.
API for the Stub layer.
-
Uses of ExperimentalApi in io.grpc
Classes in io.grpc with annotations of type ExperimentalApiModifier and TypeClassDescriptionfinal classAn immutable type-safe container of attributes.classA binary log that can be installed on a channel or server.classA Channel-specific logger provided by GRPC library toLoadBalancerimplementations.classStreamTracerfor the client-side.static final classInformation about a stream.classListens on the client transport life-cycle events.interfaceEncloses classes related to the compression and decompression of messages.final classUses multipleCallCredentialsas if they were one.interfaceRepresents a message compressor.final classEncloses classes related to the compression and decompression of messages.enumThe connectivity states.final classA tuple of aConnectivityStateand its associatedStatus.interfaceRepresents a message decompressor.final classEncloses classes related to the compression and decompression of messages.final classA group ofSocketAddresses that are considered equivalent when channel makes connections.static @interfaceAnnotation forEquivalentAddressGroup's attributes.static @interfaceAnnotation for transport attributes.classA pluggable component that receives resolved addresses fromNameResolverand provides the channel a usable subchannel when asked.static final classArguments for creating aLoadBalancer.Subchannel.static final classstatic final classKey for a key-value pair.static classFactory to createLoadBalancerinstance.static classProvides essentials for LoadBalancer implementations.static final classA balancing decision made bySubchannelPickerfor an RPC.static classProvides arguments for aLoadBalancer.SubchannelPicker.pickSubchannel(LoadBalancer.PickSubchannelArgs).static final classRepresents a combination of the resolved server address, associated attributes and a load balancing policy config.static final classBuilder forLoadBalancer.ResolvedAddresses.static classA logical connection to a server, or a group of equivalent servers represented by anEquivalentAddressGroup.static classThe main balancing logic.classProvider ofLoadBalancers.final classRegistry ofLoadBalancerProviders.static interfaceMarshaller for metadata values that are serialized to an InputStream.static interfaceA marshaller that uses a fixed instance of the type it produces.static interfaceA marshaller that supports retrieving its type parameterTat runtime.classA pluggable component that resolves a targetURIand return addresses to the caller.static final classInformation that aNameResolver.Factoryuses to create aNameResolver.static final classRepresents 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.static classFactory that createsNameResolverinstances.static interfaceReceives address updates.static classReceives address updates.static final classRepresents the results from a Name Resolver.static final classA builder forNameResolver.ResolutionResult.static @interfaceAnnotation for name resolution result attributes.static classParses and validates service configuration.classProvider of name resolvers for name agnostic consumption.final classRegistry ofNameResolverProviders.enumThe level of security guarantee in communications.interfaceDefines what executor handles the server call, based on each RPC call information at runtime.classListens to events on a stream to collect metrics.classListens on server transport life-cycle events, with the capability to read and/or change transport attributes.classListens to events on a stream to collect metrics.Fields in io.grpc with annotations of type ExperimentalApiModifier and TypeFieldDescriptionstatic final Attributes.Key<String>EquivalentAddressGroup.ATTR_AUTHORITY_OVERRIDEThe authority to be used when constructing Subchannels for this EquivalentAddressGroup.static final Attributes.Key<SocketAddress>Attribute key for the local address of a transport.static final Attributes.Key<SocketAddress>Attribute key for the remote address of a transport.static final Attributes.Key<SSLSession>Attribute key for SSL session of a transport.Methods in io.grpc with annotations of type ExperimentalApiModifier and TypeMethodDescriptionServerBuilder.addStreamTracerFactory(ServerStreamTracer.Factory factory) Adds aServerStreamTracer.Factoryto measure server-side traffic.ManagedChannelBuilder.addTransportFilter(ClientTransportFilter filter) Adds aClientTransportFilter.ServerBuilder.addTransportFilter(ServerTransportFilter filter) Adds aServerTransportFilter.ServerBuilder.callExecutor(ServerCallExecutorSupplier executorSupplier) Allows for defining a way to provide a custom executor to handle the server call.CallOptions.clearOnReadyThreshold()Resets to the default number of bytes that must be queued before the call will leave the 'wait for ready' state.abstract TManagedChannelBuilder.compressorRegistry(CompressorRegistry registry) Set the compression registry for use in the channel.abstract TServerBuilder.compressorRegistry(CompressorRegistry registry) Set the compression registry for use in the channel.abstract TManagedChannelBuilder.decompressorRegistry(DecompressorRegistry registry) Set the decompression registry for use in the channel.abstract TServerBuilder.decompressorRegistry(DecompressorRegistry registry) Set the decompression registry for use in the channel.ManagedChannelBuilder.defaultLoadBalancingPolicy(String policy) Sets the default load-balancing policy that will be used if the service config doesn't specify one.ManagedChannelBuilder.defaultServiceConfig(Map<String, ?> serviceConfig) Provides a service config to the channel.ManagedChannelBuilder.disableServiceConfigLookUp()Disables service config look-up from the naming system, which is enabled by default.<T> voidMetadata.discardAll(Metadata.Key<T> key) Remove all values for the given key without returning them.voidManagedChannel.enterIdle()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.static StringMethodDescriptor.extractBareMethodName(String fullMethodName) Extract the method name out of a fully qualified method name.DecompressorRegistry.getAdvertisedMessageEncodings()Provides a list of all message encodings that have decompressors available and should be advertised.ClientCall.getAttributes()Returns additional properties of the call.ServerCall.getAttributes()Returns properties of a single call.CallOptions.getAuthority()Override the HTTP/2 authority the channel claims to be connecting to.MethodDescriptor.getBareMethodName()A convenience method forextractBareMethodName(getFullMethodName()).NameResolver.Args.getChannelLogger()Returns theChannelLoggerfor the Channel served by this NameResolver.Server.getImmutableServices()Returns immutable services registered with the server, or an empty list if not supported by the implementation.CallOptions.getMaxInboundMessageSize()Gets the maximum allowed message size acceptable from the remote peer.CallOptions.getMaxOutboundMessageSize()Gets the maximum allowed message size acceptable to send the remote peer.Server.getMutableServices()Returns mutable services registered with the server, or an empty list if not supported by the implementation.CallOptions.getOnReadyThreshold()Returns to the default number of bytes that must be queued before the call will leave the 'wait for ready' state.<T> TCallOptions.getOption(CallOptions.Key<T> key) Get the value for a custom option or its inherent default.NameResolver.Args.getOverrideAuthority()Returns the overrideAuthority from channelManagedChannelBuilder.overrideAuthority(java.lang.String).NameResolver.Args.getScheduledExecutorService()Returns aScheduledExecutorServicefor scheduling delayed tasks.ServiceDescriptor.getSchemaDescriptor()Returns the schema descriptor for this service.ServerCall.getSecurityLevel()Returns the level of security guarantee in communicationsMethodDescriptor.getServiceName()A convenience method forextractFullServiceName(getFullMethodName()).HandlerRegistry.getServices()Returns theServerServiceDefinitions provided by the registry, or an empty list if not supported by the implementation.Server.getServices()Returns all services registered with the server, or an empty list if not supported by the implementation.ManagedChannel.getState(boolean requestConnection) Gets the current connectivity state.CallOptions.getStreamTracerFactories()Returns an immutable list ofClientStreamTracerFactorys.abstract TManagedChannelBuilder.idleTimeout(long value, TimeUnit unit) Set the duration without ongoing RPCs before going to idle mode.voidLoadBalancer.Helper.ignoreRefreshNameResolutionCheck()Deprecated.Warning has been removedServerBuilder.keepAliveTime(long keepAliveTime, TimeUnit timeUnit) Sets the time without read activity before sending a keepalive ping.ServerBuilder.keepAliveTimeout(long keepAliveTimeout, TimeUnit timeUnit) Sets a time waiting for read activity after sending a keepalive ping.ServerBuilder.maxConnectionAge(long maxConnectionAge, TimeUnit timeUnit) Sets the maximum connection age, connections lasting longer than which will be gracefully terminated.ServerBuilder.maxConnectionAgeGrace(long maxConnectionAgeGrace, TimeUnit timeUnit) Sets the grace time for the graceful connection termination.ServerBuilder.maxConnectionIdle(long maxConnectionIdle, TimeUnit timeUnit) Sets the maximum connection idle time, connections being idle for longer than which will be gracefully terminated.ManagedChannelBuilder.maxHedgedAttempts(int maxHedgedAttempts) Sets the maximum number of hedged attempts that may be configured by the service config.ManagedChannelBuilder.maxRetryAttempts(int maxRetryAttempts) Sets the maximum number of retry attempts that may be configured by the service config.ManagedChannelBuilder.maxTraceEvents(int maxTraceEvents) Sets the maximum number of channel trace events to keep in the tracer for each channel or subchannel.abstract TManagedChannelBuilder.nameResolverFactory(NameResolver.Factory resolverFactory) Deprecated.Most usages should use a globally-registeredNameResolverProviderinstead, with either the SPI mechanism orNameResolverRegistry.register(io.grpc.NameResolverProvider).voidManagedChannel.notifyWhenStateChanged(ConnectivityState source, Runnable callback) Registers a one-off callback that will be run if the connectivity state of the channel diverges from the givensource, which is typically what has just been returned byManagedChannel.getState(boolean).static <T> CallOptions.Key<T>Deprecated.static <T> Metadata.Key<T>Metadata.Key.of(String name, Metadata.BinaryStreamMarshaller<T> marshaller) Creates a key for a binary header, serializing to input streams.ServerBuilder.permitKeepAliveTime(long keepAliveTime, TimeUnit timeUnit) Specify the most aggressive keep-alive time clients are permitted to configure.ServerBuilder.permitKeepAliveWithoutCalls(boolean permit) Sets whether to allow clients to send keep-alive HTTP/2 PINGs even if there are no outstanding RPCs on the connection.ManagedChannelBuilder.perRpcBufferLimit(long bytes) Sets the per RPC buffer limit in bytes used for retry.voidManagedChannel.resetConnectBackoff()For subchannels that are in TRANSIENT_FAILURE state, short-circuit the backoff timer and make them reconnect immediately.ManagedChannelBuilder.retryBufferSize(long bytes) Sets the retry buffer size in bytes.ManagedChannelBuilder.setBinaryLog(BinaryLog binaryLog) Sets the BinaryLog object that this channel should log to.ServerBuilder.setBinaryLog(BinaryLog binaryLog) Sets the BinaryLog object that this server should log to.NameResolver.Args.Builder.setChannelLogger(ChannelLogger channelLogger) Sets the name.voidServerCall.setOnReadyThreshold(int numBytes) A hint to the call that specifies how many bytes must be queued beforeServerCall.isReady()will return false.NameResolver.Args.Builder.setOverrideAuthority(String authority) NameResolver.Args.Builder.setScheduledExecutorService(ScheduledExecutorService scheduledExecutorService) static StatusContexts.statusFromCancelled(Context context) Returns theStatusof a cancelled context ornullif the context is not cancelled.voidCallCredentials.thisUsesUnstableApi()Deprecated.static ServerServiceDefinitionServerInterceptors.useInputStreamMessages(ServerServiceDefinition serviceDef) Create a newServerServiceDefinitionwhoseMethodDescriptorserializes to and from InputStream for all methods.static <ReqT,RespT>
ServerServiceDefinitionServerInterceptors.useMarshalledMessages(ServerServiceDefinition serviceDef, MethodDescriptor.Marshaller<ReqT> requestMarshaller, MethodDescriptor.Marshaller<RespT> responseMarshaller) Create a newServerServiceDefinitionwithMethodDescriptorfor deserializing requests and separateMethodDescriptorfor serializing responses.static <T> ServerServiceDefinitionServerInterceptors.useMarshalledMessages(ServerServiceDefinition serviceDef, MethodDescriptor.Marshaller<T> marshaller) Create a newServerServiceDefinitionwhoseMethodDescriptorserializes to and from T for all methods.CallOptions.withAuthority(String authority) Override the HTTP/2 authority the channel claims to be connecting to.CallOptions.withMaxInboundMessageSize(int maxSize) Sets the maximum allowed message size acceptable from the remote peer.CallOptions.withMaxOutboundMessageSize(int maxSize) Sets the maximum allowed message size acceptable sent to the remote peer.CallOptions.withOnReadyThreshold(int numBytes) Specifies how many bytes must be queued before the call is considered not ready to send more messages.CallOptions.withStreamTracerFactory(ClientStreamTracer.Factory factory) Returns a newCallOptionswith aClientStreamTracerFactoryin addition to the existing factories. -
Uses of ExperimentalApi in io.grpc.protobuf
Classes in io.grpc.protobuf with annotations of type ExperimentalApiModifier and TypeClassDescriptionfinal classUtility methods for working withStatus.Methods in io.grpc.protobuf with annotations of type ExperimentalApiModifier and TypeMethodDescriptionstatic <T extends com.google.protobuf.Message>
MethodDescriptor.Marshaller<T>ProtoUtils.marshallerWithRecursionLimit(T defaultInstance, int recursionLimit) Creates aMethodDescriptor.Marshallerfor protos of the same type asdefaultInstanceand a custom limit for the recursion depth. -
Uses of ExperimentalApi in io.grpc.protobuf.lite
Classes in io.grpc.protobuf.lite with annotations of type ExperimentalApiModifier and TypeClassDescriptionfinal classUtility methods for using protobuf with grpc.Methods in io.grpc.protobuf.lite with annotations of type ExperimentalApiModifier and TypeMethodDescriptionstatic <T extends com.google.protobuf.MessageLite>
MethodDescriptor.Marshaller<T>ProtoLiteUtils.marshallerWithRecursionLimit(T defaultInstance, int recursionLimit) Creates aMethodDescriptor.Marshallerfor protos of the same type asdefaultInstanceand a custom limit for the recursion depth. -
Uses of ExperimentalApi in io.grpc.stub
Classes in io.grpc.stub with annotations of type ExperimentalApiModifier and TypeClassDescriptionclassA refinement of StreamObserver provided by the GRPC runtime to the application (the client or the server) that allows for more complex interactions with call behavior.final classDeprecated.Of questionable utility and generally not used.Methods in io.grpc.stub with annotations of type ExperimentalApiModifier and TypeMethodDescriptionvoidServerCallStreamObserver.setOnCloseHandler(Runnable onCloseHandler) Sets aRunnableto be executed when the call is closed cleanly from the server's point of view: eitherStreamObserver.onCompleted()orStreamObserver.onError(Throwable)has been called, all the messages and trailing metadata have been sent and the stream has been closed.voidServerCallStreamObserver.setOnReadyThreshold(int numBytes) A hint to the call that specifies how many bytes must be queued beforeServerCallStreamObserver.isReady()will return false.final SAbstractStub.withMaxInboundMessageSize(int maxSize) Returns a new stub that limits the maximum acceptable message size from a remote peer.final SAbstractStub.withMaxOutboundMessageSize(int maxSize) Returns a new stub that limits the maximum acceptable message size to send a remote peer.final SAbstractStub.withOnReadyThreshold(int numBytes) Returns a new stub that limits the maximum number of bytes per stream in the queue.final <T> SAbstractStub.withOption(CallOptions.Key<T> key, T value) Sets a custom option to be passed to client interceptors on the channelClientInterceptorvia the CallOptions parameter.