com.alipay.remoting

Class AbstractRemotingServer

java.lang.Object

com.alipay.remoting.AbstractLifeCycle

com.alipay.remoting.AbstractRemotingServer

All Implemented Interfaces:

ConfigurableInstance, Configuration, LifeCycle, RemotingServer

Direct Known Subclasses:

RpcServer

public abstract class AbstractRemotingServer
extends AbstractLifeCycle
implements RemotingServer, ConfigurableInstance

Server template for remoting.

Constructor Summary

Constructors

Constructor and Description
AbstractRemotingServer(int port)
AbstractRemotingServer(String ip, int port)

Method Summary

Modifier and Type	Method and Description
ConfigContainer	conf() Deprecated.
protected abstract void	doInit()
protected abstract boolean	doStart()
protected abstract boolean	doStop()
void	init() Deprecated.
void	initWriteBufferWaterMark(int low, int high) Initialize netty write buffer water mark for remoting instance.
String	ip() Get the ip of the server.
int	netty_buffer_high_watermark() get the high water mark for netty write buffer deprecated, use instance#option(BoltClientOption.NETTY_BUFFER_HIGH_WATER_MARK) instead
int	netty_buffer_low_watermark() get the low water mark for netty write buffer deprecated, use instance#option(BoltClientOption.NETTY_BUFFER_LOW_WATER_MARK) instead
<T> T	option(BoltOption<T> option) Get the option value.
<T> Configuration	option(BoltOption<T> option, T value) Allow to specify a BoltOption which is used for the Configuration instances once they got created.
int	port() Get the port of the server.
protected void	setLocalBindingPort(int port) override the random port zero with the actual binding port value.
void	shutdown()
boolean	start() Deprecated.
void	startup()
boolean	stop() Deprecated.
GlobalSwitch	switches() Deprecated.

Methods inherited from class com.alipay.remoting.AbstractLifeCycle

ensureStarted, isStarted

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.alipay.remoting.RemotingServer

registerDefaultExecutor, registerProcessor, registerUserProcessor

Methods inherited from interface com.alipay.remoting.LifeCycle

isStarted

Constructor Detail

AbstractRemotingServer

public AbstractRemotingServer(int port)

AbstractRemotingServer

public AbstractRemotingServer(String ip,
                              int port)

Method Detail

init

@Deprecated
public void init()

Deprecated.

Description copied from interface: RemotingServer

init the server

Specified by:

init in interface RemotingServer

start

@Deprecated
public boolean start()

Deprecated.

Description copied from interface: RemotingServer

Start the server. Use startup() instead.

Specified by:

start in interface RemotingServer

stop

@Deprecated
public boolean stop()

Deprecated.

Description copied from interface: RemotingServer

Stop the server. Use shutdown() instead. Remoting server can not be used any more after stop. If you need, you should destroy it, and instantiate another one.

Specified by:

stop in interface RemotingServer

startup

public void startup()
             throws LifeCycleException

Specified by:

startup in interface LifeCycle

Overrides:

startup in class AbstractLifeCycle

Throws:

LifeCycleException

shutdown

public void shutdown()
              throws LifeCycleException

Specified by:

shutdown in interface LifeCycle

Overrides:

shutdown in class AbstractLifeCycle

Throws:

LifeCycleException

ip

public String ip()

Description copied from interface: RemotingServer

Get the ip of the server.

Specified by:

ip in interface RemotingServer

Returns:

ip

port

public int port()

Description copied from interface: RemotingServer

Get the port of the server.

Specified by:

port in interface RemotingServer

Returns:

listened port

setLocalBindingPort

protected void setLocalBindingPort(int port)

override the random port zero with the actual binding port value.

Parameters:

port - local binding port

doInit

protected abstract void doInit()

doStart

protected abstract boolean doStart()
                            throws InterruptedException

Throws:

InterruptedException

doStop

protected abstract boolean doStop()

option

public <T> T option(BoltOption<T> option)

Description copied from interface: Configuration

Get the option value.

Specified by:

option in interface Configuration

Parameters:

option - target option

Returns:

BoltOption

option

public <T> Configuration option(BoltOption<T> option,
                                T value)

Description copied from interface: Configuration

Allow to specify a BoltOption which is used for the Configuration instances once they got created. Use a value of null to remove a previous set BoltOption.

Specified by:

option in interface Configuration

Parameters:

option - target option

value - option value, null to remove the previous option

Returns:

Configurable instance

conf

@Deprecated
public ConfigContainer conf()

Deprecated.

Description copied from interface: ConfigurableInstance

get the config container for current instance

Specified by:

conf in interface ConfigurableInstance

Returns:

the config container

switches

@Deprecated
public GlobalSwitch switches()

Deprecated.

Description copied from interface: ConfigurableInstance

get the global switch for current instance

Specified by:

switches in interface ConfigurableInstance

Returns:

the global switch

initWriteBufferWaterMark

public void initWriteBufferWaterMark(int low,
                                     int high)

Description copied from interface: ConfigurableInstance

Initialize netty write buffer water mark for remoting instance.

Notice: This api should be called before init remoting instance. deprecated, use option() instead: instance#option(BoltOption.NETTY_BUFFER_LOW_WATER_MARK, low); instance#option(BoltOption.NETTY_BUFFER_HIGH_WATER_MARK, high);

Specified by:

initWriteBufferWaterMark in interface ConfigurableInstance

Parameters:

low - [0, high]

high - [high, Integer.MAX_VALUE)

netty_buffer_low_watermark

public int netty_buffer_low_watermark()

Description copied from interface: ConfigurableInstance

get the low water mark for netty write buffer deprecated, use instance#option(BoltClientOption.NETTY_BUFFER_LOW_WATER_MARK) instead

Specified by:

netty_buffer_low_watermark in interface ConfigurableInstance

Returns:

low watermark

netty_buffer_high_watermark

public int netty_buffer_high_watermark()

Description copied from interface: ConfigurableInstance

get the high water mark for netty write buffer deprecated, use instance#option(BoltClientOption.NETTY_BUFFER_HIGH_WATER_MARK) instead

Specified by:

netty_buffer_high_watermark in interface ConfigurableInstance

Returns:

high watermark