@InterfaceAudience.LimitedPrivate(value={"HBase","HDFS","MapReduce"}) @InterfaceStability.Evolving

Package org.apache.hadoop.ipc

Tools to help define network clients and servers.

See: Description

Interface Summary

Interface	Description
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.
RpcEngine	An RPC implementation.
RpcInvocationHandler	This interface must be implemented by all InvocationHandler implementations.
VersionedProtocol	Superclass of all protocols that use Hadoop RPC.

Class Summary

Class	Description
Client	A client for an IPC service.
Client.ConnectionId	This class holds the address and the user ticket.
ClientCache
ClientId	A class defining a set of static helper methods to provide conversion between bytes and string for UUID-based client Id.
ProtobufHelper	Helper methods for protobuf related RPC implementation
ProtobufRpcEngine	RPC Engine for for protobuf based RPCs.
ProtobufRpcEngine.RpcRequestMessageWrapper
ProtobufRpcEngine.RpcResponseMessageWrapper
ProtobufRpcEngine.RpcResponseWrapper	Wrapper for Protocol Buffer Responses Note while this wrapper is writable, the request on the wire is in Protobuf.
ProtobufRpcEngine.Server
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
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
Server	An abstract IPC service.
Server.Call	A call queued for handling.
WritableRpcEngine	An RpcEngine implementation for Writable data.
WritableRpcEngine.Server	An RPC Server.

Enum Summary

Enum	Description
RPC.RpcKind
Server.AuthProtocol

Exception Summary

Exception	Description
IpcException	IPC exception is thrown by IPC layer when the IPC connection cannot be established.
RemoteException
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.

Package org.apache.hadoop.ipc Description

Tools to help define network clients and servers.