org.apache.hive.spark.client.rpc

Class RpcServer

java.lang.Object

org.apache.hive.spark.client.rpc.RpcServer

All Implemented Interfaces:

Closeable, AutoCloseable

@InterfaceAudience.Private
public class RpcServer
extends Object
implements Closeable

An RPC server. The server matches remote clients based on a secret that is generated on the server - the secret needs to be given to the client through some other mechanism for this to work.

Constructor Summary

Constructors

Constructor and Description
RpcServer(Map<String,String> mapConf)

Method Summary

Modifier and Type	Method and Description
void	cancelClient(String clientId, String msg) Tells the RPC server to cancel the connection from an existing pending client
void	close()
String	createSecret() Creates a secret for identifying a client connection.
String	getAddress()
int	getPort()
io.netty.util.concurrent.Future<Rpc>	registerClient(String clientId, String secret, RpcDispatcher serverDispatcher) Tells the RPC server to expect a connection from a new client.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RpcServer

public RpcServer(Map<String,String> mapConf)
          throws IOException,
                 InterruptedException

Throws:

IOException

InterruptedException

Method Detail

registerClient

public io.netty.util.concurrent.Future<Rpc> registerClient(String clientId,
                                                           String secret,
                                                           RpcDispatcher serverDispatcher)

Tells the RPC server to expect a connection from a new client.

Parameters:

clientId - An identifier for the client. Must be unique.

secret - The secret the client will send to the server to identify itself.

serverDispatcher - The dispatcher to use when setting up the RPC instance.

Returns:

A future that can be used to wait for the client connection, which also provides the secret needed for the client to connect.

cancelClient

public void cancelClient(String clientId,
                         String msg)

Tells the RPC server to cancel the connection from an existing pending client

Parameters:

clientId - The identifier for the client

msg - The error message about why the connection should be canceled

createSecret

public String createSecret()

Creates a secret for identifying a client connection.

getAddress

public String getAddress()

getPort

public int getPort()

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable