com.devexperts.connector

Interface ConnectorMBean

All Known Implementing Classes:

Connector, MARSConnector

public interface ConnectorMBean

ConnectorMBean is a management interface for Connector class to use with JMX technology.

Method Summary

Modifier and Type	Method and Description
String	getAddress() Returns address string of this connector.
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.
double	getSkewFactor() Returns skew factor in a range [0,1].
void	restart() Restarts this connector by calling stop() and 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	setHeartbeatPeriod(int heartbeat_period) Sets new heartbeat period (in milliseconds) or 0 to disable heartbeats.
void	setHeartbeatTimeout(int heartbeat_timeout) Sets new heartbeat timeout (in milliseconds) or 0 to disable heartbeats.
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.

Method Detail

getHeartbeatPeriod

int getHeartbeatPeriod()

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

setHeartbeatPeriod

void setHeartbeatPeriod(int heartbeat_period)

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

Throws:

IllegalArgumentException - if specified period is negative.

getHeartbeatTimeout

int getHeartbeatTimeout()

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

setHeartbeatTimeout

void setHeartbeatTimeout(int heartbeat_timeout)

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

Throws:

IllegalArgumentException - if specified timeout is negative.

getReconnectionPeriod

int getReconnectionPeriod()

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

setReconnectionPeriod

void setReconnectionPeriod(int reconnection_period)

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

Throws:

IllegalArgumentException - if specified period is negative.

getSkewFactor

double getSkewFactor()

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.

setSkewFactor

void setSkewFactor(double skew_factor)

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

Throws:

IllegalArgumentException - if specified skew factor is out of range.

getAddress

String getAddress()

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.

setAddress

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. See getAddress() for details.

start

void start()

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

stop

void stop()

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

restart

void restart()

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