software.amazon.jdbc.util.monitoring

Interface Monitor

All Known Subinterfaces:

ClusterTopologyMonitor, CustomEndpointMonitor

All Known Implementing Classes:

AbstractMonitor, ClusterTopologyMonitorImpl, CustomEndpointMonitorImpl, HostMonitorImpl, LimitlessRouterMonitor, MultiAzClusterTopologyMonitorImpl, NodeResponseTimeMonitor

public interface Monitor

Method Summary

Modifier and Type	Method and Description
boolean	canDispose() Defines whether this monitor can be disposed.
void	close() Closes all resources used by this monitor.
long	getLastActivityTimestampNanos() Gets the timestamp for the last action performed by this monitor, in nanoseconds.
MonitorState	getState() Gets the current state of this monitor.
void	monitor() Executes the monitoring loop for this monitor.
void	start() Submits this monitor in a separate thread to begin its monitoring tasks.
void	stop() Stops the monitoring tasks for this monitor and closes all resources.

Method Detail

start

void start()

Submits this monitor in a separate thread to begin its monitoring tasks.

monitor

void monitor()
      throws java.lang.Exception

Executes the monitoring loop for this monitor. This method should be called in the run() method of the thread submitted during the call to start(). Additionally, the monitoring loop should regularly update the last activity timestamp so that the MonitorService can detect whether the monitor is stuck or not.

Throws:

java.lang.Exception

stop

void stop()

Stops the monitoring tasks for this monitor and closes all resources.

close

void close()

Closes all resources used by this monitor. This method will be called as part of stop().

getLastActivityTimestampNanos

long getLastActivityTimestampNanos()

Gets the timestamp for the last action performed by this monitor, in nanoseconds.

Returns:

the timestamp for the last action performed by this monitor, in nanoseconds.

getState

MonitorState getState()

Gets the current state of this monitor.

Returns:

the current state of this monitor.

canDispose

boolean canDispose()

Defines whether this monitor can be disposed.

Returns:

true if this monitor can be disposed, otherwise returns false.