com.devexperts.connector

Class Connector

java.lang.Object

com.devexperts.connector.Connector

All Implemented Interfaces:

ConnectorMBean

Direct Known Subclasses:

MARSConnector

public abstract class Connector
extends Object
implements ConnectorMBean

Connector manages single set of communication links (defined as address string).

Field Summary

Fields

Modifier and Type	Field and Description
protected static boolean	isAdvancedStatEnabled
static String	SYS_PROPERTY_NO_ADV_STATISTICS

Constructor Summary

Constructors

Constructor and Description
Connector()

Method Summary

Modifier and Type	Method and Description
protected abstract ConnectionAdapter	createConnectionAdapter(Socket socket) Creates and returns new ConnectionAdapter for specified Socket. This method may block if required.
protected void	fireConnectorListenerProcessing(String message, Throwable error, String state)
String	getAddress() Returns address string of this connector.
ConnectorListener	getConnectorListener()
int	getHeartbeatPeriod() Returns heartbeat period (in milliseconds) or 0 if heartbeats are disabled.
int	getHeartbeatTimeout() Returns heartbeat timeout (in milliseconds) or 0 if heartbeats are disabled.
int	getReconnectionPeriod() Returns reconnection period (in milliseconds) or 0 for immediate reeconnect.
protected int	getSkewedPeriod(int period) Applies skew factor to specified period and returns result.
double	getSkewFactor() Returns skew factor in a range [0,1].
protected String	getSocketAddress(Socket socket) Returns string representation of specified socket address.
protected void	log(String message, Throwable error, boolean shouldBePrintStackTrace, String state) Logs specified message and error if not null.
protected void	log(String message, Throwable error, String state) Logs specified message and error if not null.
void	restart() Restarts this connector by calling ConnectorMBean.stop() and ConnectorMBean.start() methods in succession.
void	setAddress(String address) Sets new address string for this connector, closes connections that were established for addresses that are no longer in the address string, starts (if required) new connections for new addresses, does nothing for connections those addresses have not changed.
void	setConnectorListener(ConnectorListener connectorListener)
void	setHeartbeatPeriod(int heartbeat_period) Sets new heartbeat period (in milliseconds) or 0 to disable heartbeats.
void	setHeartbeatTimeout(int heartbeat_timeout) The timeout must be >= 0.
void	setReconnectionPeriod(int reconnection_period) Sets new reconnection period (in milliseconds) or 0 for immediate reconnect.
void	setSkewFactor(double skew_factor) Sets new skew factor in a range [0,1].
void	start() Starts this connector.
void	stop() Stops this connector and closes all open connections.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

SYS_PROPERTY_NO_ADV_STATISTICS

public static final String SYS_PROPERTY_NO_ADV_STATISTICS

See Also:

Constant Field Values

isAdvancedStatEnabled

protected static final boolean isAdvancedStatEnabled

Constructor Detail

Connector

public Connector()

Method Detail

toString

public String toString()

Overrides:

toString in class Object

getHeartbeatPeriod

public int getHeartbeatPeriod()

Description copied from interface: ConnectorMBean

Returns heartbeat period (in milliseconds) or 0 if heartbeats are disabled.

Specified by:

getHeartbeatPeriod in interface ConnectorMBean

setHeartbeatPeriod

public void setHeartbeatPeriod(int heartbeat_period)

Description copied from interface: ConnectorMBean

Sets new heartbeat period (in milliseconds) or 0 to disable heartbeats.

Specified by:

setHeartbeatPeriod in interface ConnectorMBean

getHeartbeatTimeout

public int getHeartbeatTimeout()

Description copied from interface: ConnectorMBean

Returns heartbeat timeout (in milliseconds) or 0 if heartbeats are disabled.

Specified by:

getHeartbeatTimeout in interface ConnectorMBean

setHeartbeatTimeout

public void setHeartbeatTimeout(int heartbeat_timeout)

The timeout must be >= 0. A timeout of zero is interpreted as an infinite timeout.

Specified by:

setHeartbeatTimeout in interface ConnectorMBean

Parameters:

heartbeat_timeout - timeout in ms

getReconnectionPeriod

public int getReconnectionPeriod()

Description copied from interface: ConnectorMBean

Returns reconnection period (in milliseconds) or 0 for immediate reeconnect.

Specified by:

getReconnectionPeriod in interface ConnectorMBean

setReconnectionPeriod

public void setReconnectionPeriod(int reconnection_period)

Description copied from interface: ConnectorMBean

Sets new reconnection period (in milliseconds) or 0 for immediate reconnect.

Specified by:

setReconnectionPeriod in interface ConnectorMBean

getSkewFactor

public double getSkewFactor()

Description copied from interface: ConnectorMBean

Returns skew factor in a range [0,1]. Skew factor is used to randomize (skew) waiting periods for heartbeats and reconnects. Periods are randomized from their specified values toward 0 according to skew factor with 0 factor meaning no randomization and 1 factor meaning full randomization.

Specified by:

getSkewFactor in interface ConnectorMBean

setSkewFactor

public void setSkewFactor(double skew_factor)

Description copied from interface: ConnectorMBean

Sets new skew factor in a range [0,1]. See ConnectorMBean.getSkewFactor() for details.

Specified by:

setSkewFactor in interface ConnectorMBean

getAddress

public String getAddress()

Description copied from interface: ConnectorMBean

Returns address string of this connector. The address string has format of "addr1[/addr2[/...]]", where "addr1" may be either server-side address with format ":port" or client-side address with format "host1:port1[,host2:port2[,...]]". Empty addresses are ignored.

Specified by:

getAddress in interface ConnectorMBean

setAddress

public void setAddress(String address)

Description copied from interface: ConnectorMBean

Sets new address string for this connector, closes connections that were established for addresses that are no longer in the address string, starts (if required) new connections for new addresses, does nothing for connections those addresses have not changed. See ConnectorMBean.getAddress() for details.

Specified by:

setAddress in interface ConnectorMBean

start

public void start()

Description copied from interface: ConnectorMBean

Starts this connector. Does nothing if connector is already started.

Specified by:

start in interface ConnectorMBean

stop

public void stop()

Description copied from interface: ConnectorMBean

Stops this connector and closes all open connections. Does nothing if connector is already stopped.

Specified by:

stop in interface ConnectorMBean

restart

public void restart()

Description copied from interface: ConnectorMBean

Restarts this connector by calling ConnectorMBean.stop() and ConnectorMBean.start() methods in succession.

Specified by:

restart in interface ConnectorMBean

getConnectorListener

public ConnectorListener getConnectorListener()

setConnectorListener

public void setConnectorListener(ConnectorListener connectorListener)

createConnectionAdapter

protected abstract ConnectionAdapter createConnectionAdapter(Socket socket)
                                                      throws Throwable

Creates and returns new ConnectionAdapter for specified Socket.
This method may block if required.

If this method returns 'null' or throws an exception, then connection is closed.

Throws:

Throwable

getSkewedPeriod

protected int getSkewedPeriod(int period)

Applies skew factor to specified period and returns result.

log

protected void log(String message,
                   Throwable error,
                   String state)

Logs specified message and error if not null.

Parameters:

message - a message to log

error - is null for information messages

state - see and use ConnectorStates for this field only or null

fireConnectorListenerProcessing

protected void fireConnectorListenerProcessing(String message,
                                               Throwable error,
                                               String state)

log

protected void log(String message,
                   Throwable error,
                   boolean shouldBePrintStackTrace,
                   String state)

Logs specified message and error if not null.

Parameters:

message - info

error - is null for information messages.

shouldBePrintStackTrace - print StackTrace?

getSocketAddress

protected String getSocketAddress(Socket socket)

Returns string representation of specified socket address.

By default, returns "host:port" string using numeric IP address as "host".