com.alipay.remoting.rpc

类 RpcClient

java.lang.Object

com.alipay.remoting.config.AbstractConfigurableInstance

com.alipay.remoting.rpc.RpcClient

所有已实现的接口:

NettyConfigure, ConfigurableInstance

public class RpcClient
extends AbstractConfigurableInstance

Client for Rpc.

字段概要

字段

限定符和类型	字段和说明
protected RpcRemoting	rpcRemoting rpc remoting

构造器概要

构造器

构造器和说明
RpcClient()

方法概要

限定符和类型	方法和说明
void	addConnectionEventProcessor(ConnectionEventType type, ConnectionEventProcessor processor) Add processor to process connection event.
boolean	checkConnection(String addr) check connection, the address format example - 127.0.0.1:12200?
void	closeConnection(String addr) Close all connections of a address
void	closeConnection(Url url) Close all connections of a Url
void	closeStandaloneConnection(Connection conn) Close a standalone connection
Connection	createStandaloneConnection(String addr, int connectTimeout) Create a stand alone connection using address, address format example - 127.0.0.1:12200 Notice: Each time you can this method, will create a new connection.
Connection	createStandaloneConnection(String ip, int port, int connectTimeout) Create a stand alone connection using ip and port.
void	disableConnectionMonitorSwitch() disable connection monitor switch off Notice: This api should be called before init()
void	disableConnHeartbeat(String addr) Disable heart beat for a certain connection.
void	disableConnHeartbeat(Url url) Disable heart beat for a certain connection.
void	disableReconnectSwith() disable connection reconnect switch off Notice: This api should be called before init()
void	enableConnectionMonitorSwitch() enable connection monitor switch on
void	enableConnHeartbeat(String addr) Enable heart beat for a certain connection.
void	enableConnHeartbeat(Url url) Enable heart beat for a certain connection.
void	enableReconnectSwitch() enable connection reconnect switch on Notice: This api should be called before init()
RemotingAddressParser	getAddressParser() Getter method for property addressParser.
Map<String,List<Connection>>	getAllManagedConnections() get all connections managed by rpc client
Connection	getConnection(String addr, int connectTimeout) Get a connection using address, address format example - 127.0.0.1:12200?
Connection	getConnection(Url url, int connectTimeout) Get a connection using a Url.
protected DefaultConnectionManager	getConnectionManager()
void	init()
Object	invokeSync(Connection conn, Object request, int timeoutMillis) Synchronous invocation using a Connection Notice: DO NOT modify the request object concurrently when this method is called.
Object	invokeSync(Connection conn, Object request, InvokeContext invokeContext, int timeoutMillis) Synchronous invocation with a InvokeContext, common api notice please see invokeSync(Connection, Object, int)
Object	invokeSync(String addr, Object request, int timeoutMillis) Synchronous invocation using a string address, address format example - 127.0.0.1:12200?
Object	invokeSync(String addr, Object request, InvokeContext invokeContext, int timeoutMillis) Synchronous invocation with a InvokeContext, common api notice please see invokeSync(String, Object, int)
Object	invokeSync(Url url, Object request, int timeoutMillis) Synchronous invocation using a parsed Url Notice: DO NOT modify the request object concurrently when this method is called.
Object	invokeSync(Url url, Object request, InvokeContext invokeContext, int timeoutMillis) Synchronous invocation with a InvokeContext, common api notice please see invokeSync(Url, Object, int)
void	invokeWithCallback(Connection conn, Object request, InvokeCallback invokeCallback, int timeoutMillis) Callback invocation using a Connection You can specify an implementation of InvokeCallback to get the result.
void	invokeWithCallback(Connection conn, Object request, InvokeContext invokeContext, InvokeCallback invokeCallback, int timeoutMillis) Callback invocation with a InvokeContext, common api notice please see invokeWithCallback(Connection, Object, InvokeCallback, int)
void	invokeWithCallback(String addr, Object request, InvokeCallback invokeCallback, int timeoutMillis) Callback invocation using a string address, address format example - 127.0.0.1:12200?
void	invokeWithCallback(String addr, Object request, InvokeContext invokeContext, InvokeCallback invokeCallback, int timeoutMillis) Callback invocation with a InvokeContext, common api notice please see invokeWithCallback(String, Object, InvokeCallback, int)
void	invokeWithCallback(Url url, Object request, InvokeCallback invokeCallback, int timeoutMillis) Callback invocation using a parsed Url You can specify an implementation of InvokeCallback to get the result.
void	invokeWithCallback(Url url, Object request, InvokeContext invokeContext, InvokeCallback invokeCallback, int timeoutMillis) Callback invocation with a InvokeContext, common api notice please see invokeWithCallback(Url, Object, InvokeCallback, int)
RpcResponseFuture	invokeWithFuture(Connection conn, Object request, int timeoutMillis) Future invocation using a Connection You can get result use the returned RpcResponseFuture.
RpcResponseFuture	invokeWithFuture(Connection conn, Object request, InvokeContext invokeContext, int timeoutMillis) Future invocation with a InvokeContext, common api notice please see invokeWithFuture(Connection, Object, int)
RpcResponseFuture	invokeWithFuture(String addr, Object request, int timeoutMillis) Future invocation using a string address, address format example - 127.0.0.1:12200?
RpcResponseFuture	invokeWithFuture(String addr, Object request, InvokeContext invokeContext, int timeoutMillis) Future invocation with a InvokeContext, common api notice please see invokeWithFuture(String, Object, int)
RpcResponseFuture	invokeWithFuture(Url url, Object request, int timeoutMillis) Future invocation using a parsed Url You can get result use the returned RpcResponseFuture.
RpcResponseFuture	invokeWithFuture(Url url, Object request, InvokeContext invokeContext, int timeoutMillis) Future invocation with a InvokeContext, common api notice please see invokeWithFuture(Url, Object, int)
boolean	isConnectionMonitorSwitchOn() is connection monitor switch on
boolean	isReconnectSwitchOn() is reconnect switch on
void	oneway(Connection conn, Object request) One way invocation using a Connection Notice: DO NOT modify the request object concurrently when this method is called.
void	oneway(Connection conn, Object request, InvokeContext invokeContext) Oneway invocation with a InvokeContext, common api notice please see oneway(Connection, Object)
void	oneway(String addr, Object request) One way invocation using a string address, address format example - 127.0.0.1:12200?
void	oneway(String addr, Object request, InvokeContext invokeContext) Oneway invocation with a InvokeContext, common api notice please see oneway(Connection, Object)
void	oneway(Url url, Object request) One way invocation using a parsed Url Notice: DO NOT modify the request object concurrently when this method is called.
void	oneway(Url url, Object request, InvokeContext invokeContext) Oneway invocation with a InvokeContext, common api notice please see oneway(Url, Object)
void	registerUserProcessor(UserProcessor<?> processor) Use UserProcessorRegisterHelperUserProcessorRegisterHelper to help register user processor for client side.
void	setAddressParser(RemotingAddressParser addressParser) Setter method for property addressParser.
void	setMonitorStrategy(ConnectionMonitorStrategy monitorStrategy) Setter method for property monitorStrategy.
void	shutdown() Shutdown.

从类继承的方法 com.alipay.remoting.config.AbstractConfigurableInstance

conf, initWriteBufferWaterMark, netty_buffer_high_watermark, netty_buffer_low_watermark, switches

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

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

字段详细资料

rpcRemoting

protected RpcRemoting rpcRemoting

rpc remoting

构造器详细资料

RpcClient

public RpcClient()

方法详细资料

init

public void init()

shutdown

public void shutdown()

Shutdown.

Notice:

Rpc client can not be used any more after shutdown. If you need, you should destroy it, and instantiate another one.

oneway

public void oneway(String addr,
                   Object request)
            throws RemotingException,
                   InterruptedException

One way invocation using a string address, address format example - 127.0.0.1:12200?key1=value1&key2=value2

Notice:

1. DO NOT modify the request object concurrently when this method is called.
2. When do invocation, use the string address to find a available connection, if none then create one.
• You can use RpcConfigs.CONNECT_TIMEOUT_KEY to specify connection timeout, time unit is milliseconds, e.g [127.0.0.1:12200?_CONNECTTIMEOUT=3000]
• You can use RpcConfigs.CONNECTION_NUM_KEY to specify connection number for each ip and port, e.g [127.0.0.1:12200?_CONNECTIONNUM=30]
• You can use RpcConfigs.CONNECTION_WARMUP_KEY to specify whether need warmup all connections for the first time you call this method, e.g [127.0.0.1:12200?_CONNECTIONWARMUP=false]
3. You should use closeConnection(String addr) to close it if you want.

参数:

addr -

request -

抛出:

RemotingException

InterruptedException

oneway

public void oneway(String addr,
                   Object request,
                   InvokeContext invokeContext)
            throws RemotingException,
                   InterruptedException

Oneway invocation with a InvokeContext, common api notice please see oneway(Connection, Object)

参数:

addr -

request -

invokeContext -

抛出:

RemotingException

InterruptedException

oneway

public void oneway(Url url,
                   Object request)
            throws RemotingException,
                   InterruptedException

One way invocation using a parsed Url

Notice:

1. DO NOT modify the request object concurrently when this method is called.
2. When do invocation, use the parsed Url to find a available connection, if none then create one.
• You can use Url.setConnectTimeout(int) to specify connection timeout, time unit is milliseconds.
• You can use Url.setConnNum(int) to specify connection number for each ip and port.
• You can use Url.setConnWarmup(boolean) to specify whether need warmup all connections for the first time you call this method.
3. You should use closeConnection(Url url) to close it if you want.

参数:

url -

request -

抛出:

RemotingException

InterruptedException

oneway

public void oneway(Url url,
                   Object request,
                   InvokeContext invokeContext)
            throws RemotingException,
                   InterruptedException

Oneway invocation with a InvokeContext, common api notice please see oneway(Url, Object)

参数:

url -

request -

invokeContext -

抛出:

RemotingException

InterruptedException

oneway

public void oneway(Connection conn,
                   Object request)
            throws RemotingException

One way invocation using a Connection

Notice:
DO NOT modify the request object concurrently when this method is called.

参数:

conn -

request -

抛出:

RemotingException

oneway

public void oneway(Connection conn,
                   Object request,
                   InvokeContext invokeContext)
            throws RemotingException

Oneway invocation with a InvokeContext, common api notice please see oneway(Connection, Object)

参数:

conn -

request -

invokeContext -

抛出:

RemotingException

invokeSync

public Object invokeSync(String addr,
                         Object request,
                         int timeoutMillis)
                  throws RemotingException,
                         InterruptedException

Synchronous invocation using a string address, address format example - 127.0.0.1:12200?key1=value1&key2=value2

Notice:

1. DO NOT modify the request object concurrently when this method is called.
2. When do invocation, use the string address to find a available connection, if none then create one.
• You can use RpcConfigs.CONNECT_TIMEOUT_KEY to specify connection timeout, time unit is milliseconds, e.g [127.0.0.1:12200?_CONNECTTIMEOUT=3000]
• You can use RpcConfigs.CONNECTION_NUM_KEY to specify connection number for each ip and port, e.g [127.0.0.1:12200?_CONNECTIONNUM=30]
• You can use RpcConfigs.CONNECTION_WARMUP_KEY to specify whether need warmup all connections for the first time you call this method, e.g [127.0.0.1:12200?_CONNECTIONWARMUP=false]
3. You should use closeConnection(String addr) to close it if you want.

参数:

addr -

request -

timeoutMillis -

返回:

Object

抛出:

RemotingException

InterruptedException

invokeSync

public Object invokeSync(String addr,
                         Object request,
                         InvokeContext invokeContext,
                         int timeoutMillis)
                  throws RemotingException,
                         InterruptedException

Synchronous invocation with a InvokeContext, common api notice please see invokeSync(String, Object, int)

参数:

addr -

request -

invokeContext -

timeoutMillis -

返回:

抛出:

RemotingException

InterruptedException

invokeSync

public Object invokeSync(Url url,
                         Object request,
                         int timeoutMillis)
                  throws RemotingException,
                         InterruptedException

Synchronous invocation using a parsed Url

Notice:

1. DO NOT modify the request object concurrently when this method is called.
2. When do invocation, use the parsed Url to find a available connection, if none then create one.
• You can use Url.setConnectTimeout(int) to specify connection timeout, time unit is milliseconds.
• You can use Url.setConnNum(int) to specify connection number for each ip and port.
• You can use Url.setConnWarmup(boolean) to specify whether need warmup all connections for the first time you call this method.
3. You should use closeConnection(Url url) to close it if you want.

参数:

url -

request -

timeoutMillis -

返回:

Object

抛出:

RemotingException

InterruptedException

invokeSync

public Object invokeSync(Url url,
                         Object request,
                         InvokeContext invokeContext,
                         int timeoutMillis)
                  throws RemotingException,
                         InterruptedException

Synchronous invocation with a InvokeContext, common api notice please see invokeSync(Url, Object, int)

参数:

url -

request -

invokeContext -

timeoutMillis -

返回:

抛出:

RemotingException

InterruptedException

invokeSync

public Object invokeSync(Connection conn,
                         Object request,
                         int timeoutMillis)
                  throws RemotingException,
                         InterruptedException

Synchronous invocation using a Connection

Notice:
DO NOT modify the request object concurrently when this method is called.

参数:

conn -

request -

timeoutMillis -

返回:

Object

抛出:

RemotingException

InterruptedException

invokeSync

public Object invokeSync(Connection conn,
                         Object request,
                         InvokeContext invokeContext,
                         int timeoutMillis)
                  throws RemotingException,
                         InterruptedException

Synchronous invocation with a InvokeContext, common api notice please see invokeSync(Connection, Object, int)

参数:

conn -

request -

invokeContext -

timeoutMillis -

返回:

Object

抛出:

RemotingException

InterruptedException

invokeWithFuture

public RpcResponseFuture invokeWithFuture(String addr,
                                          Object request,
                                          int timeoutMillis)
                                   throws RemotingException,
                                          InterruptedException

Future invocation using a string address, address format example - 127.0.0.1:12200?key1=value1&key2=value2
You can get result use the returned RpcResponseFuture.

Notice:

1. DO NOT modify the request object concurrently when this method is called.
2. When do invocation, use the string address to find a available connection, if none then create one.
• You can use RpcConfigs.CONNECT_TIMEOUT_KEY to specify connection timeout, time unit is milliseconds, e.g [127.0.0.1:12200?_CONNECTTIMEOUT=3000]
• You can use RpcConfigs.CONNECTION_NUM_KEY to specify connection number for each ip and port, e.g [127.0.0.1:12200?_CONNECTIONNUM=30]
• You can use RpcConfigs.CONNECTION_WARMUP_KEY to specify whether need warmup all connections for the first time you call this method, e.g [127.0.0.1:12200?_CONNECTIONWARMUP=false]
3. You should use closeConnection(String addr) to close it if you want.

参数:

addr -

request -

timeoutMillis -

返回:

RpcResponseFuture

抛出:

RemotingException

InterruptedException

invokeWithFuture

public RpcResponseFuture invokeWithFuture(String addr,
                                          Object request,
                                          InvokeContext invokeContext,
                                          int timeoutMillis)
                                   throws RemotingException,
                                          InterruptedException

Future invocation with a InvokeContext, common api notice please see invokeWithFuture(String, Object, int)

参数:

addr -

request -

invokeContext -

timeoutMillis -

返回:

RpcResponseFuture

抛出:

RemotingException

InterruptedException

invokeWithFuture

public RpcResponseFuture invokeWithFuture(Url url,
                                          Object request,
                                          int timeoutMillis)
                                   throws RemotingException,
                                          InterruptedException

Future invocation using a parsed Url
You can get result use the returned RpcResponseFuture.

Notice:

1. DO NOT modify the request object concurrently when this method is called.
2. When do invocation, use the parsed Url to find a available connection, if none then create one.
• You can use Url.setConnectTimeout(int) to specify connection timeout, time unit is milliseconds.
• You can use Url.setConnNum(int) to specify connection number for each ip and port.
• You can use Url.setConnWarmup(boolean) to specify whether need warmup all connections for the first time you call this method.
3. You should use closeConnection(Url url) to close it if you want.

参数:

url -

request -

timeoutMillis -

返回:

抛出:

RemotingException

InterruptedException

invokeWithFuture

public RpcResponseFuture invokeWithFuture(Url url,
                                          Object request,
                                          InvokeContext invokeContext,
                                          int timeoutMillis)
                                   throws RemotingException,
                                          InterruptedException

Future invocation with a InvokeContext, common api notice please see invokeWithFuture(Url, Object, int)

参数:

url -

request -

invokeContext -

timeoutMillis -

返回:

抛出:

RemotingException

InterruptedException

invokeWithFuture

public RpcResponseFuture invokeWithFuture(Connection conn,
                                          Object request,
                                          int timeoutMillis)
                                   throws RemotingException

Future invocation using a Connection
You can get result use the returned RpcResponseFuture.

Notice:
DO NOT modify the request object concurrently when this method is called.

参数:

conn -

request -

timeoutMillis -

返回:

抛出:

RemotingException

invokeWithFuture

public RpcResponseFuture invokeWithFuture(Connection conn,
                                          Object request,
                                          InvokeContext invokeContext,
                                          int timeoutMillis)
                                   throws RemotingException

Future invocation with a InvokeContext, common api notice please see invokeWithFuture(Connection, Object, int)

参数:

conn -

request -

invokeContext -

timeoutMillis -

返回:

抛出:

RemotingException

invokeWithCallback

public void invokeWithCallback(String addr,
                               Object request,
                               InvokeCallback invokeCallback,
                               int timeoutMillis)
                        throws RemotingException,
                               InterruptedException

Callback invocation using a string address, address format example - 127.0.0.1:12200?key1=value1&key2=value2
You can specify an implementation of InvokeCallback to get the result.

Notice:

1. DO NOT modify the request object concurrently when this method is called.
2. When do invocation, use the string address to find a available connection, if none then create one.
• You can use RpcConfigs.CONNECT_TIMEOUT_KEY to specify connection timeout, time unit is milliseconds, e.g [127.0.0.1:12200?_CONNECTTIMEOUT=3000]
• You can use RpcConfigs.CONNECTION_NUM_KEY to specify connection number for each ip and port, e.g [127.0.0.1:12200?_CONNECTIONNUM=30]
• You can use RpcConfigs.CONNECTION_WARMUP_KEY to specify whether need warmup all connections for the first time you call this method, e.g [127.0.0.1:12200?_CONNECTIONWARMUP=false]
3. You should use closeConnection(String addr) to close it if you want.

参数:

addr -

request -

invokeCallback -

timeoutMillis -

抛出:

RemotingException

InterruptedException

invokeWithCallback

public void invokeWithCallback(String addr,
                               Object request,
                               InvokeContext invokeContext,
                               InvokeCallback invokeCallback,
                               int timeoutMillis)
                        throws RemotingException,
                               InterruptedException

Callback invocation with a InvokeContext, common api notice please see invokeWithCallback(String, Object, InvokeCallback, int)

参数:

addr -

request -

invokeContext -

invokeCallback -

timeoutMillis -

抛出:

RemotingException

InterruptedException

invokeWithCallback

public void invokeWithCallback(Url url,
                               Object request,
                               InvokeCallback invokeCallback,
                               int timeoutMillis)
                        throws RemotingException,
                               InterruptedException

Callback invocation using a parsed Url
You can specify an implementation of InvokeCallback to get the result.

Notice:

1. DO NOT modify the request object concurrently when this method is called.
2. When do invocation, use the parsed Url to find a available connection, if none then create one.
• You can use Url.setConnectTimeout(int) to specify connection timeout, time unit is milliseconds.
• You can use Url.setConnNum(int) to specify connection number for each ip and port.
• You can use Url.setConnWarmup(boolean) to specify whether need warmup all connections for the first time you call this method.
3. You should use closeConnection(Url url) to close it if you want.

参数:

url -

request -

invokeCallback -

timeoutMillis -

抛出:

RemotingException

InterruptedException

invokeWithCallback

public void invokeWithCallback(Url url,
                               Object request,
                               InvokeContext invokeContext,
                               InvokeCallback invokeCallback,
                               int timeoutMillis)
                        throws RemotingException,
                               InterruptedException

Callback invocation with a InvokeContext, common api notice please see invokeWithCallback(Url, Object, InvokeCallback, int)

参数:

url -

request -

invokeContext -

invokeCallback -

timeoutMillis -

抛出:

RemotingException

InterruptedException

invokeWithCallback

public void invokeWithCallback(Connection conn,
                               Object request,
                               InvokeCallback invokeCallback,
                               int timeoutMillis)
                        throws RemotingException

Callback invocation using a Connection
You can specify an implementation of InvokeCallback to get the result.

Notice:
DO NOT modify the request object concurrently when this method is called.

参数:

conn -

request -

invokeCallback -

timeoutMillis -

抛出:

RemotingException

invokeWithCallback

public void invokeWithCallback(Connection conn,
                               Object request,
                               InvokeContext invokeContext,
                               InvokeCallback invokeCallback,
                               int timeoutMillis)
                        throws RemotingException

Callback invocation with a InvokeContext, common api notice please see invokeWithCallback(Connection, Object, InvokeCallback, int)

参数:

conn -

request -

invokeContext -

invokeCallback -

timeoutMillis -

抛出:

RemotingException

addConnectionEventProcessor

public void addConnectionEventProcessor(ConnectionEventType type,
                                        ConnectionEventProcessor processor)

Add processor to process connection event.

参数:

type -

processor -

registerUserProcessor

public void registerUserProcessor(UserProcessor<?> processor)

Use UserProcessorRegisterHelperUserProcessorRegisterHelper to help register user processor for client side.

参数:

processor -

抛出:

RemotingException

createStandaloneConnection

public Connection createStandaloneConnection(String ip,
                                             int port,
                                             int connectTimeout)
                                      throws RemotingException

Create a stand alone connection using ip and port.

Notice:

Each time you call this method, will create a new connection. Bolt will not control this connection. You should use closeStandaloneConnection(com.alipay.remoting.Connection) to close it.