com.alipay.remoting

Interface BoltClient

All Superinterfaces:

Configuration, LifeCycle

All Known Implementing Classes:

AbstractBoltClient, RpcClient

public interface BoltClient
extends Configuration, LifeCycle

Bolt client interface.

Method Summary

Modifier and Type	Method and Description
void	addConnectionEventProcessor(ConnectionEventType type, ConnectionEventProcessor processor) Add processor to process connection event.
boolean	checkConnection(String address) check connection, the address format example - 127.0.0.1:12200?
boolean	checkConnection(String address, boolean createIfAbsent) check connection, the address format example - 127.0.0.1:12200?
boolean	checkConnection(String address, boolean createIfAbsent, boolean createAsync) check connection, the address format example - 127.0.0.1:12200?
void	closeConnection(String address) 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 address, 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 RpcClient.init()
void	disableConnHeartbeat(String address) 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 RpcClient.init()
void	enableConnectionMonitorSwitch() enable connection monitor switch on
void	enableConnHeartbeat(String address) 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 RpcClient.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.
ConnectionManager	getConnectionManager() Getter method for property connectionManager.
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 address, Object request, int timeoutMillis) Synchronous invocation using a string address, address format example - 127.0.0.1:12200?
Object	invokeSync(String address, 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 address, Object request, int timeoutMillis) Future invocation using a string address, address format example - 127.0.0.1:12200?
RpcResponseFuture	invokeWithFuture(String address, 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 address, Object request) One way invocation using a string address, address format example - 127.0.0.1:12200?
void	oneway(String address, 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	setConnectionManager(ConnectionManager connectionManager) Setter method for property connectionManager.
void	setMonitorStrategy(ConnectionMonitorStrategy monitorStrategy) Setter method for property monitorStrategy.

Methods inherited from interface com.alipay.remoting.config.Configuration

option, option

Methods inherited from interface com.alipay.remoting.LifeCycle

isStarted, shutdown, startup

Method Detail

oneway

void oneway(String address,
            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.

Parameters:

address - target address

request - request

Throws:

RemotingException

InterruptedException

oneway

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

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

Parameters:

address - target address

request - request

invokeContext - invoke context

Throws:

RemotingException

InterruptedException

oneway

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.

Parameters:

url - target url

request - object

Throws:

RemotingException

InterruptedException

oneway

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

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

Parameters:

url - url

request - request

invokeContext - invoke context

Throws:

RemotingException

InterruptedException

oneway

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.

Parameters:

conn - target connection

request - request

Throws:

RemotingException

oneway

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

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

Parameters:

conn - target connection

request - request

invokeContext - invoke context

Throws:

RemotingException

invokeSync

Object invokeSync(String address,
                  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.

Parameters:

address - target address

request - request

timeoutMillis - timeout millisecond

Returns:

result object

Throws:

RemotingException

InterruptedException

invokeSync

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

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

Parameters:

address - target address

request - request

invokeContext - invoke context

timeoutMillis - timeout in millisecond

Returns:

result object

Throws:

RemotingException

InterruptedException

invokeSync

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.

Parameters:

url - target url

request - request

timeoutMillis - timeout in millisecond

Returns:

Object

Throws:

RemotingException

InterruptedException

invokeSync

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)

Parameters:

url - target url

request - request

invokeContext - invoke context

timeoutMillis - timeout in millisecond

Returns:

result object

Throws:

RemotingException

InterruptedException

invokeSync

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.

Parameters:

conn - target connection

request - request

timeoutMillis - timeout in millisecond

Returns:

Object

Throws:

RemotingException

InterruptedException

invokeSync

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)

Parameters:

conn - target connection

request - request

invokeContext - invoke context

timeoutMillis - timeout in millis

Returns:

Object

Throws:

RemotingException

InterruptedException

invokeWithFuture

RpcResponseFuture invokeWithFuture(String address,
                                   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.

Parameters:

address - target address

request - request

timeoutMillis - timeout in millisecond

Returns:

RpcResponseFuture

Throws:

RemotingException

InterruptedException

invokeWithFuture

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

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

Parameters:

address - target address

request - request

invokeContext - invoke context

timeoutMillis - timeout in millisecond

Returns:

RpcResponseFuture

Throws:

RemotingException

InterruptedException

invokeWithFuture

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.

Parameters:

url - target url

request - request

timeoutMillis - timeout in millisecond

Returns:

RpcResponseFuture

Throws:

RemotingException

InterruptedException

invokeWithFuture

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)

Parameters:

url - target url

request - request

invokeContext - invoke context

timeoutMillis - timeout in millis

Returns:

RpcResponseFuture

Throws:

RemotingException

InterruptedException

invokeWithFuture

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.

Parameters:

conn - target connection

request - request

timeoutMillis - timeout in millis

Returns:

RpcResponseFuture

Throws:

RemotingException

invokeWithFuture

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)

Parameters:

conn - target connection

request - request

invokeContext - context

timeoutMillis - timeout millisecond

Returns:

RpcResponseFuture

Throws:

RemotingException

invokeWithCallback

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.

Parameters:

addr - target address

request - request

invokeCallback - callback

timeoutMillis - timeout in millisecond

Throws:

RemotingException

InterruptedException

invokeWithCallback

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)

Parameters:

addr - target address

request - request

invokeContext - context

invokeCallback - callback

timeoutMillis - timeout in millisecond

Throws:

RemotingException

InterruptedException

invokeWithCallback

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.

Parameters:

url - target url

request - request

invokeCallback - callback

timeoutMillis - timeout in millisecond

Throws:

RemotingException

InterruptedException

invokeWithCallback

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)

Parameters:

url - target url

request - request

invokeContext - context

invokeCallback - callback

timeoutMillis - timeout in millisecond

Throws:

RemotingException

InterruptedException

invokeWithCallback

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.

Parameters:

conn - target connection

request - request

invokeCallback - callback

timeoutMillis - timeout in millisecond

Throws:

RemotingException

invokeWithCallback

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)

Parameters:

conn - target connection

request - request

invokeContext - invoke context

invokeCallback - callback

timeoutMillis - timeout in millisecond

Throws:

RemotingException

addConnectionEventProcessor

void addConnectionEventProcessor(ConnectionEventType type,
                                 ConnectionEventProcessor processor)

Add processor to process connection event.

Parameters:

type - connection event type

processor - connection event process

registerUserProcessor

void registerUserProcessor(UserProcessor<?> processor)

Use UserProcessorRegisterHelperUserProcessorRegisterHelper to help register user processor for client side.

createStandaloneConnection

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.

Parameters:

ip - ip

port - port

connectTimeout - timeout in millisecond

Throws:

RemotingException

createStandaloneConnection

Connection createStandaloneConnection(String address,
                                      int connectTimeout)
                               throws RemotingException

Create a stand alone connection using address, address format example - 127.0.0.1:12200

Notice:

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

Parameters:

address - target address

connectTimeout - timeout in millisecond

Throws:

RemotingException

closeStandaloneConnection

void closeStandaloneConnection(Connection conn)

Close a standalone connection

Parameters:

conn - target connection

getConnection

Connection getConnection(String addr,
                         int connectTimeout)
                  throws RemotingException,
                         InterruptedException

Get a connection using address, address format example - 127.0.0.1:12200?key1=value1&key2=value2

Notice:

1. Get a connection, if none then create.
• 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]
2. Bolt will control this connection in ConnectionPool
3. You should use closeConnection(String addr) to close it.

Parameters:

addr - target address

connectTimeout - this is prior to url args RpcConfigs.CONNECT_TIMEOUT_KEY

Throws:

RemotingException

InterruptedException

getConnection

Connection getConnection(Url url,
                         int connectTimeout)
                  throws RemotingException,
                         InterruptedException

Get a connection using a Url.

Notice:

1. Get a connection, if none then create.
2. Bolt will control this connection in ConnectionPool
3. You should use closeConnection(Url url) to close it.

Parameters:

url - target url

connectTimeout - this is prior to url args RpcConfigs.CONNECT_TIMEOUT_KEY

Throws:

RemotingException

InterruptedException

getAllManagedConnections

Map<String,List<Connection>> getAllManagedConnections()

get all connections managed by rpc client

Returns:

map key is ip+port, value is a list of connections of this key.

checkConnection

boolean checkConnection(String address)

check connection, the address format example - 127.0.0.1:12200?key1=value1&key2=value2

Parameters:

address - target address

Returns:

true if and only if there is a connection, and the connection is active and writable;else return false

checkConnection

boolean checkConnection(String address,
                        boolean createIfAbsent)

check connection, the address format example - 127.0.0.1:12200?key1=value1&key2=value2 and if there is no connection, try create new one

Parameters:

address - target address

createIfAbsent - if need to create

Returns:

true if and only if there is a connection, and the connection is active and writable, or can create a new one

checkConnection

boolean checkConnection(String address,
                        boolean createIfAbsent,
                        boolean createAsync)

check connection, the address format example - 127.0.0.1:12200?key1=value1&key2=value2 and if there is no connection, try create new one in asynchronous

Parameters:

address - target address

createIfAbsent - if need to create

createAsync - create connection asynchronous

Returns:

true if and only if there is a connection, and the connection is active and writable

closeConnection

void closeConnection(String address)

Close all connections of a address

Parameters:

address - target address

closeConnection

void closeConnection(Url url)

Close all connections of a Url

Parameters:

url - target url

enableConnHeartbeat

void enableConnHeartbeat(String address)

Enable heart beat for a certain connection. If this address not connected, then do nothing.

Notice: this method takes no effect on a stand alone connection.

Parameters:

address - target address

enableConnHeartbeat

void enableConnHeartbeat(Url url)

Enable heart beat for a certain connection. If this Url not connected, then do nothing.

Notice: this method takes no effect on a stand alone connection.

Parameters:

url - target url

disableConnHeartbeat

void disableConnHeartbeat(String address)

Disable heart beat for a certain connection. If this addr not connected, then do nothing.

Notice: this method takes no effect on a stand alone connection.

Parameters:

address - target address

disableConnHeartbeat

void disableConnHeartbeat(Url url)

Disable heart beat for a certain connection. If this Url not connected, then do nothing.

Notice: this method takes no effect on a stand alone connection.

Parameters:

url - target url

enableReconnectSwitch

void enableReconnectSwitch()

enable connection reconnect switch on

Notice: This api should be called before RpcClient.init()

disableReconnectSwith

void disableReconnectSwith()

disable connection reconnect switch off

Notice: This api should be called before RpcClient.init()

isReconnectSwitchOn

boolean isReconnectSwitchOn()

is reconnect switch on

enableConnectionMonitorSwitch

void enableConnectionMonitorSwitch()

enable connection monitor switch on

disableConnectionMonitorSwitch

void disableConnectionMonitorSwitch()

disable connection monitor switch off

Notice: This api should be called before RpcClient.init()

isConnectionMonitorSwitchOn

boolean isConnectionMonitorSwitchOn()

is connection monitor switch on

getConnectionManager

ConnectionManager getConnectionManager()

Getter method for property connectionManager.

Returns:

property value of connectionManager

setConnectionManager

void setConnectionManager(ConnectionManager connectionManager)

Setter method for property connectionManager.

Parameters:

connectionManager - ConnectionManager

getAddressParser

RemotingAddressParser getAddressParser()

Getter method for property addressParser.

Returns:

property value of addressParser

setAddressParser

void setAddressParser(RemotingAddressParser addressParser)

Setter method for property addressParser.

Parameters:

addressParser - value to be assigned to property addressParser

setMonitorStrategy

void setMonitorStrategy(ConnectionMonitorStrategy monitorStrategy)

Setter method for property monitorStrategy.

Parameters:

monitorStrategy - value to be assigned to property monitorStrategy