org.apache.hadoop.hbase.ipc

Interface RpcClient

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

AbstractRpcClient, BlockingRpcClient, NettyRpcClient

@InterfaceAudience.Private
public interface RpcClient
extends Closeable

Interface for RpcClient implementations so ConnectionManager can handle it.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_CODEC_CLASS
static int	DEFAULT_SOCKET_TIMEOUT_CONNECT
static int	DEFAULT_SOCKET_TIMEOUT_READ
static int	DEFAULT_SOCKET_TIMEOUT_WRITE
static int	FAILED_SERVER_EXPIRY_DEFAULT
static String	FAILED_SERVER_EXPIRY_KEY
static String	IDLE_TIME
static boolean	IPC_CLIENT_FALLBACK_TO_SIMPLE_AUTH_ALLOWED_DEFAULT
static String	IPC_CLIENT_FALLBACK_TO_SIMPLE_AUTH_ALLOWED_KEY
static int	PING_CALL_ID
static String	SOCKET_TIMEOUT_CONNECT
static String	SOCKET_TIMEOUT_READ How long we wait when we wait for an answer.
static String	SOCKET_TIMEOUT_WRITE
static String	SPECIFIC_WRITE_THREAD

Method Summary

Modifier and Type	Method and Description
void	cancelConnections(ServerName sn) Interrupt the connections to the given server.
void	close() Stop all threads related to this client.
org.apache.hbase.thirdparty.com.google.protobuf.BlockingRpcChannel	createBlockingRpcChannel(ServerName sn, User user, int rpcTimeout) Creates a "channel" that can be used by a blocking protobuf service.
org.apache.hbase.thirdparty.com.google.protobuf.RpcChannel	createRpcChannel(ServerName sn, User user, int rpcTimeout) Creates a "channel" that can be used by a protobuf service.
boolean	hasCellBlockSupport() Return true when this client uses a Codec and so supports cell blocks.

Field Detail

FAILED_SERVER_EXPIRY_KEY

static final String FAILED_SERVER_EXPIRY_KEY

See Also:

Constant Field Values

FAILED_SERVER_EXPIRY_DEFAULT

static final int FAILED_SERVER_EXPIRY_DEFAULT

See Also:

Constant Field Values

IDLE_TIME

static final String IDLE_TIME

See Also:

Constant Field Values

IPC_CLIENT_FALLBACK_TO_SIMPLE_AUTH_ALLOWED_KEY

static final String IPC_CLIENT_FALLBACK_TO_SIMPLE_AUTH_ALLOWED_KEY

See Also:

Constant Field Values

IPC_CLIENT_FALLBACK_TO_SIMPLE_AUTH_ALLOWED_DEFAULT

static final boolean IPC_CLIENT_FALLBACK_TO_SIMPLE_AUTH_ALLOWED_DEFAULT

See Also:

Constant Field Values

SPECIFIC_WRITE_THREAD

static final String SPECIFIC_WRITE_THREAD

See Also:

Constant Field Values

DEFAULT_CODEC_CLASS

static final String DEFAULT_CODEC_CLASS

See Also:

Constant Field Values

SOCKET_TIMEOUT_CONNECT

static final String SOCKET_TIMEOUT_CONNECT

See Also:

Constant Field Values

SOCKET_TIMEOUT_READ

static final String SOCKET_TIMEOUT_READ

How long we wait when we wait for an answer. It's not the operation time, it's the time we wait when we start to receive an answer, when the remote write starts to send the data.

See Also:

Constant Field Values

SOCKET_TIMEOUT_WRITE

static final String SOCKET_TIMEOUT_WRITE

See Also:

Constant Field Values

DEFAULT_SOCKET_TIMEOUT_CONNECT

static final int DEFAULT_SOCKET_TIMEOUT_CONNECT

See Also:

Constant Field Values

DEFAULT_SOCKET_TIMEOUT_READ

static final int DEFAULT_SOCKET_TIMEOUT_READ

See Also:

Constant Field Values

DEFAULT_SOCKET_TIMEOUT_WRITE

static final int DEFAULT_SOCKET_TIMEOUT_WRITE

See Also:

Constant Field Values

PING_CALL_ID

static final int PING_CALL_ID

See Also:

Constant Field Values

Method Detail

createBlockingRpcChannel

org.apache.hbase.thirdparty.com.google.protobuf.BlockingRpcChannel createBlockingRpcChannel(ServerName sn,
                                                                                            User user,
                                                                                            int rpcTimeout)

Creates a "channel" that can be used by a blocking protobuf service. Useful setting up protobuf blocking stubs.

Parameters:

sn - server name describing location of server

user - which is to use the connection

rpcTimeout - default rpc operation timeout

Returns:

A blocking rpc channel that goes via this rpc client instance.

createRpcChannel

org.apache.hbase.thirdparty.com.google.protobuf.RpcChannel createRpcChannel(ServerName sn,
                                                                            User user,
                                                                            int rpcTimeout)

Creates a "channel" that can be used by a protobuf service. Useful setting up protobuf stubs.

Parameters:

sn - server name describing location of server

user - which is to use the connection

rpcTimeout - default rpc operation timeout

Returns:

A rpc channel that goes via this rpc client instance.

cancelConnections

void cancelConnections(ServerName sn)

Interrupt the connections to the given server. This should be called if the server is known as actually dead. This will not prevent current operation to be retried, and, depending on their own behavior, they may retry on the same server. This can be a feature, for example at startup. In any case, they're likely to get connection refused (if the process died) or no route to host: i.e. their next retries should be faster and with a safe exception.

Parameters:

sn - server location to cancel connections of

close

void close()

Stop all threads related to this client. No further calls may be made using this client.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

hasCellBlockSupport

boolean hasCellBlockSupport()

Return true when this client uses a Codec and so supports cell blocks.