@LimitedPrivate({"HBase","HDFS","MapReduce","YARN","Hive","Ozone"}) @Evolving

Package org.apache.hadoop.ipc

Tools to help define network clients and servers. Other ASF projects use this package, often with their own shaded/unshaded versions of protobuf messages. Changes to the API signatures will break things, especially changes to RPC and RpcEngine.

Interface Summary

Interface	Description
AlignmentContext	This interface intends to align the state between client and server via RPC communication.
CostProvider	Used by DecayRpcScheduler to get the cost of users' operations.
DecayRpcSchedulerMXBean	Provides metrics for Decay scheduler.
FairCallQueueMXBean
GenericRefreshProtocol	Protocol which is used to refresh arbitrary things at runtime.
IdentityProvider	The IdentityProvider creates identities for each schedulable by extracting fields and returning an identity string.
ProtobufRpcEngineCallback	Deprecated.
ProtobufRpcEngineCallback2
ProtocolMetaInfoPB	Protocol to get versions and signatures for supported protocols from the server.
ProtocolMetaInterface	This interface is implemented by the client side translators and can be used to obtain information about underlying protocol e.g.
ProtocolTranslator	An interface implemented by client-side protocol translators to get the underlying proxy object the translator is operating on.
RefreshCallQueueProtocol	Protocol which is used to refresh the call queue in use currently.
RefreshHandler	Used to registry custom methods to refresh at runtime.
RpcEngine	An RPC implementation.
RpcInvocationHandler	This interface must be implemented by all InvocationHandler implementations.
RpcMultiplexer	Implement this interface to make a pluggable multiplexer in the FairCallQueue.
RpcScheduler	Implement this interface to be used for RPC scheduling and backoff.
Schedulable	Interface which allows extracting information necessary to create schedulable identity strings.
VersionedProtocol	Superclass of all protocols that use Hadoop RPC.

Class Summary

Class	Description
CallerContext	A class defining the caller context for auditing coarse granularity operations.
CallerContext.Builder	The caller context builder.
CallQueueManager<E extends Schedulable>	Abstracts queue operations for different blocking queues.
Client	A client for an IPC service.
Client.ConnectionId	This class holds the address and the user ticket.
Client.IpcStreams	Manages the input and output streams for an IPC connection.
ClientCache
ClientId	A class defining a set of static helper methods to provide conversion between bytes and string for UUID-based client Id.
DecayRpcScheduler	The decay RPC scheduler tracks the cost of incoming requests in a map, then decays the costs at a fixed time interval.
DecayRpcScheduler.DecayTask	This TimerTask will call decayCurrentCosts until the scheduler has been garbage collected.
DecayRpcScheduler.MetricsProxy	MetricsProxy is a singleton because we may init multiple schedulers and we want to clean up resources when a new scheduler replaces the old one.
DefaultCostProvider	Ignores process details and returns a constant value for each call.
DefaultRpcScheduler	No op default RPC scheduler.
ExternalCall<T>
FairCallQueue<E extends Schedulable>	A queue with multiple levels for each priority.
ProcessingDetails	Stores the times that a call takes to be processed through each step and its response status.
ProtobufHelper	Deprecated. hadoop code MUST use ShadedProtobufHelper.
ProtobufRpcEngine	Deprecated.
ProtobufRpcEngine.Invoker
ProtobufRpcEngine.Server	Server implementation is always ProtobufRpcEngine2 based implementation, supports backward compatibility for protobuf 2.5 based implementations, which uses non-shaded protobuf classes.
ProtobufRpcEngine2	RPC Engine for for protobuf based RPCs.
ProtobufRpcEngine2.Invoker
ProtobufRpcEngine2.Server
ProtobufWrapperLegacy	A RpcWritable wrapper for unshaded protobuf messages.
ProtocolMetaInfoServerSideTranslatorPB	This class serves the requests for protocol versions and signatures by looking them up in the server registry.
ProtocolProxy<T>	a class wraps around a server's proxy, containing a list of its supported methods.
ProtocolSignature
ProxyCombiner	A utility class used to combine two protocol proxies.
RefreshRegistry	Used to registry custom methods to refresh at runtime.
RefreshResponse	Return a response in the handler method for the user to see.
ResponseBuffer
RetryCache	Maintains a cache of non-idempotent requests that have been successfully processed by the RPC server implementation, to handle the retries.
RetryCache.CacheEntry	CacheEntry is tracked using unique client ID and callId of the RPC request.
RetryCache.CacheEntryWithPayload	CacheEntry with payload that tracks the previous response or parts of previous response to be used for generating response for retried requests.
RPC	A simple RPC mechanism.
RPC.Builder	Class to construct instances of RPC server with specific options.
RPC.Server	An RPC Server.
RpcClientUtil	This class maintains a cache of protocol versions and corresponding protocol signatures, keyed by server address, protocol and rpc kind.
RpcConstants
RpcWritable
RpcWritable.Buffer	adapter to allow decoding of writables and protobufs from a byte buffer.
Server	An abstract IPC service.
Server.Call	A generic call queued for handling.
UserIdentityProvider	The UserIdentityProvider creates uses the username as the identity.
WeightedRoundRobinMultiplexer	Determines which queue to start reading from, occasionally drawing from low-priority queues in order to prevent starvation.
WeightedTimeCostProvider	A CostProvider that calculates the cost for an operation as a weighted sum of its processing time values (see ProcessingDetails).
WritableRpcEngine	Deprecated.
WritableRpcEngine.Server	Deprecated.

Enum Summary

Enum	Description
ProcessingDetails.Timing	The different stages to track the time of.
RPC.RpcKind
Server.AuthProtocol

Exception Summary

Exception	Description
AsyncCallLimitExceededException	Signals that an AsyncCallLimitExceededException has occurred.
IpcException	IPC exception is thrown by IPC layer when the IPC connection cannot be established.
ObserverRetryOnActiveException	Thrown by a remote ObserverNode indicating the operation has failed and the client should retry active namenode directly (instead of retry other ObserverNodes).
RemoteException
RetriableException	Exception thrown by a server typically to indicate that server is in a state where request cannot be processed temporarily (such as still starting up).
RPC.VersionMismatch	A version mismatch for the RPC protocol.
RpcClientException	Indicates an exception in the RPC client
RpcException	Indicates an exception during the execution of remote procedure call.
RpcNoSuchMethodException	No such Method for an Rpc Call
RpcNoSuchProtocolException	No such protocol (i.e.
RpcServerException	Indicates an exception on the RPC server
StandbyException	Thrown by a remote server when it is up, but is not the active server in a set of servers in which only a subset may be active.
UnexpectedServerException	Indicates that the RPC server encountered an undeclared exception from the service

Annotation Types Summary

Annotation Type	Description
ProtocolInfo	The protocol name that is used when a client and server connect.