com.alipay.remoting.rpc

类 RpcServer

java.lang.Object

com.alipay.remoting.AbstractLifeCycle

com.alipay.remoting.AbstractRemotingServer

com.alipay.remoting.rpc.RpcServer

所有已实现的接口:

NettyConfigure, Configurable, ConfigurableInstance, LifeCycle, RemotingServer

public class RpcServer
extends AbstractRemotingServer

Server for Rpc. Usage: You can initialize RpcServer with one of the three constructors: RpcServer(int), RpcServer(int, boolean), RpcServer(int, boolean, boolean) Then call start() to start a rpc server, and call stop() to stop a rpc server. Notice: Once rpc server has been stopped, it can never be start again. You should init another instance of RpcServer to use.

字段概要

字段

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

构造器概要

构造器

构造器和说明
RpcServer() Construct a rpc server with random port the random port will determined after server startup Note: You can only use invoke methods with params Connection, for example invokeSync(Connection, Object, int) Otherwise UnsupportedOperationException will be thrown.
RpcServer(boolean manageConnection) Construct a rpc server with random port the random port will determined after server startup Note: You can only use invoke methods with params Connection, for example invokeSync(Connection, Object, int) Otherwise UnsupportedOperationException will be thrown.
RpcServer(int port) Construct a rpc server.
RpcServer(int port, boolean manageConnection) Construct a rpc server.
RpcServer(int port, boolean manageConnection, boolean syncStop) Construct a rpc server.
RpcServer(String ip, int port) Construct a rpc server.
RpcServer(String ip, int port, boolean manageConnection) Construct a rpc server.

方法概要

限定符和类型	方法和说明
void	addConnectionEventProcessor(ConnectionEventType type, ConnectionEventProcessor processor) Add processor to process connection event.
protected void	doInit()
protected boolean	doStart()
protected boolean	doStop() Notice: only GlobalSwitch.SERVER_MANAGE_CONNECTION_SWITCH switch on, will close all connections.
RemotingAddressParser	getAddressParser() Getter method for property addressParser.
DefaultConnectionManager	getConnectionManager() Getter method for property connectionManager.
protected void	initRpcRemoting() init rpc remoting
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	isConnected(String remoteAddr) check whether a client address connected
boolean	isConnected(Url url) check whether a Url connected
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) One way 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) One way invocation with a InvokeContext, common api notice please see oneway(String, 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) One way invocation with a InvokeContext, common api notice please see oneway(Url, Object)
void	registerDefaultExecutor(byte protocolCode, ExecutorService executor) Register default executor service for server.
void	registerProcessor(byte protocolCode, CommandCode cmd, RemotingProcessor<?> processor) Register processor for command with the command code.
void	registerUserProcessor(UserProcessor<?> processor) Use UserProcessorRegisterHelperUserProcessorRegisterHelper to help register user processor for server side.
void	setAddressParser(RemotingAddressParser addressParser) Setter method for property addressParser.

从类继承的方法 com.alipay.remoting.AbstractRemotingServer

conf, init, initWriteBufferWaterMark, ip, netty_buffer_high_watermark, netty_buffer_low_watermark, option, option, port, setLocalBindingPort, shutdown, start, startup, stop, switches

从类继承的方法 com.alipay.remoting.AbstractLifeCycle

ensureStarted, isStarted

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

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

从接口继承的方法 com.alipay.remoting.LifeCycle

isStarted

字段详细资料

rpcRemoting

protected RpcRemoting rpcRemoting

rpc remoting

构造器详细资料

RpcServer

public RpcServer()

Construct a rpc server with random port
the random port will determined after server startup Note:
You can only use invoke methods with params Connection, for example invokeSync(Connection, Object, int)
Otherwise UnsupportedOperationException will be thrown.

RpcServer

public RpcServer(boolean manageConnection)

Construct a rpc server with random port
the random port will determined after server startup Note:
You can only use invoke methods with params Connection, for example invokeSync(Connection, Object, int)
Otherwise UnsupportedOperationException will be thrown.

参数:

manageConnection - true to enable connection management feature

RpcServer

public RpcServer(int port)

Construct a rpc server.
Note:
You can only use invoke methods with params Connection, for example invokeSync(Connection, Object, int)
Otherwise UnsupportedOperationException will be thrown.

RpcServer

public RpcServer(String ip,
                 int port)

Construct a rpc server.
Note:
You can only use invoke methods with params Connection, for example invokeSync(Connection, Object, int)
Otherwise UnsupportedOperationException will be thrown.

RpcServer

public RpcServer(int port,
                 boolean manageConnection)

Construct a rpc server.

• You can enable connection management feature by specify @param manageConnection true.
• When connection management feature enabled, you can use all invoke methods with params String, Url, Connection methods.
• When connection management feature disabled, you can only use invoke methods with params Connection, otherwise UnsupportedOperationException will be thrown.

参数:

port - listened port

manageConnection - true to enable connection management feature

RpcServer

public RpcServer(String ip,
                 int port,
                 boolean manageConnection)

Construct a rpc server.

• You can enable connection management feature by specify @param manageConnection true.
• When connection management feature enabled, you can use all invoke methods with params String, Url, Connection methods.
• When connection management feature disabled, you can only use invoke methods with params Connection, otherwise UnsupportedOperationException will be thrown.

参数:

port - listened port

manageConnection - true to enable connection management feature

RpcServer

public RpcServer(int port,
                 boolean manageConnection,
                 boolean syncStop)

Construct a rpc server.
You can construct a rpc server with synchronous or asynchronous stop strategy by .

参数:

port - listened port

manageConnection - manage connection

syncStop - true to enable stop in synchronous way

方法详细资料

doInit

protected void doInit()

指定者:

doInit 在类中 AbstractRemotingServer

doStart

protected boolean doStart()
                   throws InterruptedException

指定者:

doStart 在类中 AbstractRemotingServer

抛出:

InterruptedException

doStop

protected boolean doStop()

Notice: only GlobalSwitch.SERVER_MANAGE_CONNECTION_SWITCH switch on, will close all connections.

指定者:

doStop 在类中 AbstractRemotingServer

另请参阅:

AbstractRemotingServer.doStop()

initRpcRemoting

protected void initRpcRemoting()

init rpc remoting

registerProcessor

public void registerProcessor(byte protocolCode,
                              CommandCode cmd,
                              RemotingProcessor<?> processor)

从接口复制的说明: RemotingServer

Register processor for command with the command code.

参数:

protocolCode - protocol code

cmd - command code

processor - processor

另请参阅:

RemotingServer.registerProcessor(byte, com.alipay.remoting.CommandCode, com.alipay.remoting.RemotingProcessor)

registerDefaultExecutor

public void registerDefaultExecutor(byte protocolCode,
                                    ExecutorService executor)

从接口复制的说明: RemotingServer

Register default executor service for server.

参数:

protocolCode - protocol code

executor - the executor service for the protocol code

另请参阅:

RemotingServer.registerDefaultExecutor(byte, ExecutorService)

addConnectionEventProcessor

public void addConnectionEventProcessor(ConnectionEventType type,
                                        ConnectionEventProcessor processor)

Add processor to process connection event.

参数:

type - connection event type

processor - connection event processor

registerUserProcessor

public void registerUserProcessor(UserProcessor<?> processor)

Use UserProcessorRegisterHelperUserProcessorRegisterHelper to help register user processor for server side.

参数:

processor - user processor which can be a single-interest processor or a multi-interest processor

另请参阅:

RemotingServer.registerUserProcessor(com.alipay.remoting.rpc.protocol.UserProcessor)

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 client connection, if none then throw exception
3. Unlike rpc client, address arguments takes no effect here, for rpc server will not create connection.

参数:

addr - address addr

request - request request

抛出:

RemotingException - remoting exception remoting exception

InterruptedException - interrupted exception

oneway

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

One way invocation with a InvokeContext, common api notice please see oneway(String, Object)

参数:

addr - address

request - request

invokeContext - invokeContext

抛出:

RemotingException - remoting exception

InterruptedException - interrupted exception

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 client connection, if none then throw exception

参数:

url - url

request - request request

抛出:

RemotingException - remoting exception remoting exception

InterruptedException - interrupted exception

oneway

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

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

参数:

url - url

request - request request

invokeContext - invokeContext invokeContext

抛出:

RemotingException - remoting exception remoting exception

InterruptedException - interrupted exception

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 - connection connection

request - request request

抛出:

RemotingException - remoting exception remoting exception

oneway

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

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

参数:

conn - connection connection

request - request request

invokeContext - invokeContext invokeContext

抛出:

RemotingException - remoting exception remoting exception

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 client connection, if none then throw exception
3. Unlike rpc client, address arguments takes no effect here, for rpc server will not create connection.

参数:

addr - address addr

request - request request

timeoutMillis - timeoutMillis timeoutMillis

返回:

Object

抛出:

RemotingException - remoting exception remoting exception

InterruptedException - interrupted exception

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 - address addr

request - request request

invokeContext - invokeContext invokeContext

timeoutMillis - timeoutMillis timeoutMillis

返回:

object

抛出:

RemotingException - remoting exception remoting exception

InterruptedException - interrupted exception

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 client connection, if none then throw exception

参数:

url - url

request - request request

timeoutMillis - timeoutMillis timeoutMillis

返回:

Object

抛出:

RemotingException - remoting exception remoting exception

InterruptedException - interrupted exception

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 - url

request - request

invokeContext - invokeContext

timeoutMillis - timeoutMillis

返回:

object

抛出:

RemotingException - remoting exception remoting exception

InterruptedException - interrupted exception

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 - connection

request - request

timeoutMillis - timeoutMillis

返回:

Object

抛出:

RemotingException - remoting exception remoting exception

InterruptedException - interrupted exception

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 - connection connection

request - request request

invokeContext - invokeContext invokeContext

timeoutMillis - timeoutMillis timeoutMillis

返回:

object

抛出:

RemotingException - remoting exception remoting exception

InterruptedException - interrupted exception

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 client connection, if none then throw exception
3. Unlike rpc client, address arguments takes no effect here, for rpc server will not create connection.

参数:

addr - address address

request - request request

timeoutMillis - timeoutMillis timeoutMillis

返回:

RpcResponseFuture

抛出:

RemotingException - remoting exception remoting exception

InterruptedException - interrupted exception

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 - address address

request - request request

invokeContext - invokeContext invokeContext

timeoutMillis - timeoutMillis timeoutMillis

返回:

RpcResponseFuture

抛出:

RemotingException - remoting exception remoting exception

InterruptedException - interrupted exception

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 client connection, if none then throw exception

参数:

url - url

request - request request

timeoutMillis - timeoutMillis timeoutMillis

返回:

RpcResponseFuture

抛出:

RemotingException - remoting exception remoting exception

InterruptedException - interrupted exception

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 - url

request - request request

invokeContext - invokeContext

timeoutMillis - timeoutMillis

返回:

RpcResponseFuture

抛出:

RemotingException - remoting exception remoting exception

InterruptedException - interrupted exception

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 - connection

request - request

timeoutMillis - timeoutMillis

返回:

RpcResponseFuture

抛出:

RemotingException - remoting exception

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 - connection connection

request - request request

invokeContext - invokeContext invokeContext

timeoutMillis - timeoutMillis timeoutMillis

返回:

RpcResponseFuture

抛出:

RemotingException - remoting exception

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 client connection, if none then throw exception
3. Unlike rpc client, address arguments takes no effect here, for rpc server will not create connection.

参数:

addr - address

request - request

invokeCallback - invokeCallback

timeoutMillis - timeoutMillis

抛出:

RemotingException - remoting exception remoting exception

InterruptedException - interrupted exception

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 - address address

request - request request

invokeContext - invokeContext

invokeCallback - invokeCallback

timeoutMillis - timeoutMillis

抛出:

RemotingException - remoting exception remoting exception

InterruptedException - interrupted exception

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 client connection, if none then throw exception

参数:

url - url

request - request request

invokeCallback - invokeCallback invokeCallback

timeoutMillis - timeoutMillis timeoutMillis

抛出:

RemotingException - remoting exception remoting exception

InterruptedException - interrupted exception

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 - url

request - request request

invokeContext - invokeContext invokeContext

invokeCallback - invokeCallback invokeCallback

timeoutMillis - timeoutMillis timeoutMillis

抛出:

RemotingException - remoting exception remoting exception

InterruptedException - interrupted exception

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 - connection connection

request - request request

invokeCallback - invokeCallback invokeCallback

timeoutMillis - timeoutMillis timeoutMillis

抛出:

RemotingException - remoting exception remoting exception

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 - connection connection

request - request request

invokeCallback - invokeCallback invokeCallback

timeoutMillis - timeoutMillis timeoutMillis

抛出:

RemotingException - remoting exception remoting exception

isConnected

public boolean isConnected(String remoteAddr)

check whether a client address connected

参数:

remoteAddr - remote address

返回:

true means url is connected and false means disconnected.

isConnected

public boolean isConnected(Url url)

check whether a Url connected

参数:

url - url

返回:

true means url is connected and false means disconnected.

getAddressParser

public RemotingAddressParser getAddressParser()

Getter method for property addressParser.

返回:

property value of addressParser

setAddressParser

public void setAddressParser(RemotingAddressParser addressParser)

Setter method for property addressParser.

参数:

addressParser - address Parser value to be assigned to property addressParser

getConnectionManager

public DefaultConnectionManager getConnectionManager()

Getter method for property connectionManager.

返回:

property value of connectionManager