RpcClient (nacos-common 2.1.0-BETA 2.1.0-BETA API)

java.lang.Object
- com.alibaba.nacos.common.remote.client.RpcClient

所有已实现的接口:

Closeable

直接已知子类:

GrpcClient
```
public abstract class RpcClient
extends Object
implements Closeable
```
abstract remote client to connect to server.

版本:

$Id: RpcClient.java, v 0.1 2020年07月13日 9:15 PM liuzunfei Exp $

作者:

liuzunfei

嵌套类概要

嵌套类
限定符和类型类和说明

class RpcClient.ConnectionEvent

static class RpcClient.ServerInfo

嵌套类
限定符和类型	类和说明
`class`	`RpcClient.ConnectionEvent`
`static class`	`RpcClient.ServerInfo`

字段概要

字段
限定符和类型	字段和说明
`protected ClientAbilities`	`clientAbilities`
`protected ScheduledExecutorService`	`clientEventExecutor`
`protected List<ConnectionEventListener>`	`connectionEventListeners` listener called where connection's status changed.
`protected Connection`	`currentConnection`
`protected LinkedBlockingQueue<RpcClient.ConnectionEvent>`	`eventLinkedBlockingQueue`
`protected Map<String,String>`	`labels`
`protected AtomicReference<RpcClientStatus>`	`rpcClientStatus`
`protected List<ServerRequestHandler>`	`serverRequestHandlers` handlers to process server push request.

构造器概要

构造器
构造器和说明

RpcClient(ServerListFactory serverListFactory)

RpcClient(String name)

RpcClient(String name, ServerListFactory serverListFactory)

构造器
构造器和说明
`RpcClient(ServerListFactory serverListFactory)`
`RpcClient(String name)`
`RpcClient(String name, ServerListFactory serverListFactory)`

方法概要

所有方法实例方法抽象方法具体方法
限定符和类型	方法和说明
`void`	`asyncRequest(Request request, RequestCallBack callback)` send async request.
`RpcClient`	`clientAbilities(ClientAbilities clientAbilities)` init client abilities.
`abstract Connection`	`connectToServer(RpcClient.ServerInfo serverInfo)` connect to server.
`protected RpcClient.ServerInfo`	`currentRpcServer()`
`abstract ConnectionType`	`getConnectionType()` get connection type of this client.
`RpcClient.ServerInfo`	`getCurrentServer()` get current server.
`Map<String,String>`	`getLabels()` Getter method for property `labels`.
`String`	`getName()` Getter method for property `name`.
`ServerListFactory`	`getServerListFactory()` Getter method for property `serverListFactory`.
`String`	`getTenant()`
`protected Response`	`handleServerRequest(Request request)` handle server request.
`boolean`	`isRunning()` check is this client is running.
`boolean`	`isShutdown()` check is this client is shutdown.
`boolean`	`isWaitInitiated()` check is this client is initiated.
`RpcClient`	`keepAlive(long keepAliveTime, TimeUnit timeUnit)` init keepalive time.
`RpcClient`	`labels(Map<String,String> labels)` init labels.
`protected RpcClient.ServerInfo`	`nextRpcServer()`
`protected void`	`notifyConnected()` Notify when client new connected.
`protected void`	`notifyDisConnected()` Notify when client disconnected.
`void`	`onServerListChange()` check if current connected server is in server list, if not switch server.
`protected void`	`reconnect(RpcClient.ServerInfo recommendServerInfo, boolean onRequestFail)` switch server .
`void`	`registerConnectionListener(ConnectionEventListener connectionEventListener)` Register connection handler.
`void`	`registerServerRequestHandler(ServerRequestHandler serverRequestHandler)` Register serverRequestHandler, the handler will handle the request from server side.
`Response`	`request(Request request)` send request.
`Response`	`request(Request request, long timeoutMills)` send request.
`RequestFuture`	`requestFuture(Request request)` send async request.
`abstract int`	`rpcPortOffset()` increase offset of the nacos server port for the rpc server port.
`RpcClient`	`serverListFactory(ServerListFactory serverListFactory)` init server list factory. only can init once.
`void`	`setName(String name)` Setter method for property `name`.
`void`	`setTenant(String tenant)`
`void`	`shutdown()` Shutdown the Resources, such as Thread Pool.
`void`	`start()` Start this client.
`void`	`switchServerAsync()`
`protected void`	`switchServerAsync(RpcClient.ServerInfo recommendServerInfo, boolean onRequestFail)`
`void`	`switchServerAsyncOnRequestFail()`

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

eventLinkedBlockingQueue

protected LinkedBlockingQueue<RpcClient.ConnectionEvent> eventLinkedBlockingQueue

rpcClientStatus

protected volatile AtomicReference<RpcClientStatus> rpcClientStatus

clientEventExecutor

protected ScheduledExecutorService clientEventExecutor

currentConnection

protected volatile Connection currentConnection

labels
```
protected Map<String,String> labels
```

clientAbilities

protected ClientAbilities clientAbilities

connectionEventListeners
```
protected List<ConnectionEventListener> connectionEventListeners
```
listener called where connection's status changed.

serverRequestHandlers

protected List<ServerRequestHandler> serverRequestHandlers

handlers to process server push request.

构造器详细资料

RpcClient
```
public RpcClient(String name)
```

RpcClient

public RpcClient(ServerListFactory serverListFactory)

RpcClient

public RpcClient(String name,
                 ServerListFactory serverListFactory)

方法详细资料
- clientAbilities
```
public RpcClient clientAbilities(ClientAbilities clientAbilities)
```
  init client abilities.
  
  参数:
  
  clientAbilities - clientAbilities.
- serverListFactory
```
public RpcClient serverListFactory(ServerListFactory serverListFactory)
```
  init server list factory. only can init once.
  
  参数:
  
  serverListFactory - serverListFactory
- labels
```
public RpcClient labels(Map<String,String> labels)
```
  init labels.
  
  参数:
  
  labels - labels
- keepAlive
```
public RpcClient keepAlive(long keepAliveTime,
                           TimeUnit timeUnit)
```
  init keepalive time.
  
  参数:
  
  keepAliveTime - keepAliveTime
  
  timeUnit - timeUnit
- notifyDisConnected
```
protected void notifyDisConnected()
```
  Notify when client disconnected.
- notifyConnected
```
protected void notifyConnected()
```
  Notify when client new connected.
- isWaitInitiated
```
public boolean isWaitInitiated()
```
  check is this client is initiated.
  
  返回:
  
  is wait initiated or not.
- isRunning
```
public boolean isRunning()
```
  check is this client is running.
  
  返回:
  
  is running or not.
- isShutdown
```
public boolean isShutdown()
```
  check is this client is shutdown.
  
  返回:
  
  is shutdown or not.
- onServerListChange
```
public void onServerListChange()
```
  check if current connected server is in server list, if not switch server.
- start
```
public final void start()
                 throws NacosException
```
  Start this client.
  
  抛出:
  
  NacosException
- shutdown
```
public void shutdown()
              throws NacosException
```
  从接口复制的说明: Closeable
  
  Shutdown the Resources, such as Thread Pool.
  
  指定者:
  
  shutdown 在接口中 Closeable
  
  抛出:
  
  NacosException - exception.
- switchServerAsyncOnRequestFail
```
public void switchServerAsyncOnRequestFail()
```
- switchServerAsync
```
public void switchServerAsync()
```
- switchServerAsync
```
protected void switchServerAsync(RpcClient.ServerInfo recommendServerInfo,
                                 boolean onRequestFail)
```
- reconnect
```
protected void reconnect(RpcClient.ServerInfo recommendServerInfo,
                         boolean onRequestFail)
```
  switch server .
- getConnectionType
```
public abstract ConnectionType getConnectionType()
```
  get connection type of this client.
  
  返回:
  
  ConnectionType.
- rpcPortOffset
```
public abstract int rpcPortOffset()
```
  increase offset of the nacos server port for the rpc server port.
  
  返回:
  
  rpc port offset
- getCurrentServer
```
public RpcClient.ServerInfo getCurrentServer()
```
  get current server.
  
  返回:
  
  server info.
- request
```
public Response request(Request request)
                 throws NacosException
```
  send request.
  
  参数:
  
  request - request.
  
  返回:
  
  response from server.
  
  抛出:
  
  NacosException
- request
```
public Response request(Request request,
                        long timeoutMills)
                 throws NacosException
```
  send request.
  
  参数:
  
  request - request.
  
  返回:
  
  response from server.
  
  抛出:
  
  NacosException
- asyncRequest
```
public void asyncRequest(Request request,
                         RequestCallBack callback)
                  throws NacosException
```
  send async request.
  
  参数:
  
  request - request.
  
  抛出:
  
  NacosException
- requestFuture
```
public RequestFuture requestFuture(Request request)
                            throws NacosException
```
  send async request.
  
  参数:
  
  request - request.
  
  返回:
  
  request future.
  
  抛出:
  
  NacosException
- connectToServer
```
public abstract Connection connectToServer(RpcClient.ServerInfo serverInfo)
                                    throws Exception
```
  connect to server.
  
  参数:
  
  serverInfo - server address to connect.
  
  返回:
  
  return connection when successfully connect to server, or null if failed.
  
  抛出:
  
  Exception - exception when fail to connect to server.
- handleServerRequest
```
protected Response handleServerRequest(Request request)
```
  handle server request.
  
  参数:
  
  request - request.
  
  返回:
  
  response.
- registerConnectionListener
```
public void registerConnectionListener(ConnectionEventListener connectionEventListener)
```
  Register connection handler. Will be notified when inner connection's state changed.
  
  参数:
  
  connectionEventListener - connectionEventListener
- registerServerRequestHandler
```
public void registerServerRequestHandler(ServerRequestHandler serverRequestHandler)
```
  Register serverRequestHandler, the handler will handle the request from server side.
  
  参数:
  
  serverRequestHandler - serverRequestHandler
- getName
```
public String getName()
```
  Getter method for property name.
  
  返回:
  
  property value of name
- setName
```
public void setName(String name)
```
  Setter method for property name.
  
  参数:
  
  name - value to be assigned to property name
- getServerListFactory
```
public ServerListFactory getServerListFactory()
```
  Getter method for property serverListFactory.
  
  返回:
  
  property value of serverListFactory
- nextRpcServer
```
protected RpcClient.ServerInfo nextRpcServer()
```
- currentRpcServer
```
protected RpcClient.ServerInfo currentRpcServer()
```
- getLabels
```
public Map<String,String> getLabels()
```
  Getter method for property labels.
  
  返回:
  
  property value of labels
- getTenant
```
public String getTenant()
```
- setTenant
```
public void setTenant(String tenant)
```

类 RpcClient

嵌套类概要

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

eventLinkedBlockingQueue

rpcClientStatus

clientEventExecutor

currentConnection

labels

clientAbilities

connectionEventListeners

serverRequestHandlers

构造器详细资料

RpcClient

RpcClient

RpcClient

方法详细资料

clientAbilities

serverListFactory

labels

keepAlive

notifyDisConnected

notifyConnected

isWaitInitiated

isRunning

isShutdown

onServerListChange

start

shutdown

switchServerAsyncOnRequestFail

switchServerAsync

switchServerAsync

reconnect

getConnectionType

rpcPortOffset

getCurrentServer

request

request

asyncRequest

requestFuture

connectToServer

handleServerRequest

registerConnectionListener

registerServerRequestHandler

getName

setName

getServerListFactory

nextRpcServer

currentRpcServer

getLabels

getTenant

setTenant