com.allanbank.mongodb.client.state

Class ClusterPinger

java.lang.Object

com.allanbank.mongodb.client.state.ClusterPinger

All Implemented Interfaces:

Closeable, AutoCloseable, Runnable

public class ClusterPinger
extends Object
implements Runnable, Closeable

ClusterPinger pings each of the connections in the cluster and updates the latency of the server from this client.

API Warning:

This class is NOT part of the drivers API. This class may be mutated in incompatible ways between any two releases of the driver.

Copyright ©:

2012-2014, Allanbank Consulting, Inc., All Rights Reserved

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	ClusterPinger.Pinger Pinger provides logic to ping servers.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_PING_INTERVAL_SECONDS The default interval between ping sweeps in seconds.
protected static Log	LOG The logger for the ClusterPinger.

Constructor Summary

Constructors

Constructor and Description
ClusterPinger(Cluster cluster, ProxiedConnectionFactory factory, MongoClientConfiguration config) Creates a new ClusterPinger.

Method Summary

Methods

Modifier and Type	Method and Description
void	addCluster(Cluster cluster) Adds a new cluster to the set of tracked clusters.
void	close()
TimeUnit	getIntervalUnits() Returns the units for the ping sweep intervals.
int	getPingSweepInterval() Returns the interval for a ping sweep across all of the servers..
void	initialSweep(Cluster cluster) Performs a single sweep through the servers sending a ping with a callback to set the latency and tags for each server.
static boolean	ping(Server server, Connection conn) Pings the server and suppresses all exceptions.
void	run()
void	setIntervalUnits(TimeUnit intervalUnits) Sets the value of units for the ping sweep intervals.
void	setPingSweepInterval(int pingSweepInterval) Sets the interval for a ping sweep across all of the servers..
void	start() Starts the background pinger.
protected void	startSweep() Extension point to notify derived classes that a new sweep is starting.
void	stop() Stops the background pinger.
void	wakeUp() Starts the background pinger.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PING_INTERVAL_SECONDS

public static final int DEFAULT_PING_INTERVAL_SECONDS

The default interval between ping sweeps in seconds.

See Also:

Constant Field Values

LOG

protected static final Log LOG

The logger for the ClusterPinger.

Constructor Detail

ClusterPinger

public ClusterPinger(Cluster cluster,
             ProxiedConnectionFactory factory,
             MongoClientConfiguration config)

Creates a new ClusterPinger.

Parameters:

cluster - The state of the cluster.

factory - The factory for creating connections to the servers.

config - The configuration for the connections.

Method Detail

ping

public static boolean ping(Server server,
           Connection conn)

Pings the server and suppresses all exceptions.

Parameters:

server - The address of the server. Used for logging.

conn - The connection to ping.

Returns:

True if the ping worked, false otherwise.

addCluster

public void addCluster(Cluster cluster)

Adds a new cluster to the set of tracked clusters.

Parameters:

cluster - A new cluster to the set of tracked clusters.

close

public void close()

Overridden to close the pinger.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

getIntervalUnits

public TimeUnit getIntervalUnits()

Returns the units for the ping sweep intervals.

Returns:

The units for the ping sweep intervals.

getPingSweepInterval

public int getPingSweepInterval()

Returns the interval for a ping sweep across all of the servers..

Returns:

The interval for a ping sweep across all of the servers..

initialSweep

public void initialSweep(Cluster cluster)

Performs a single sweep through the servers sending a ping with a callback to set the latency and tags for each server.

This method will not return until at least 50% of the servers have replied (which may be a failure) to the initial ping.

Parameters:

cluster - The cluster of servers to ping.

run

public void run()

Overridden to periodically wake-up and ping the servers. At first this will occur fairly often but eventually degrade to once every 5 minutes.

Specified by:

run in interface Runnable

setIntervalUnits

public void setIntervalUnits(TimeUnit intervalUnits)

Sets the value of units for the ping sweep intervals.

Parameters:

intervalUnits - The new value for the units for the ping sweep intervals.

setPingSweepInterval

public void setPingSweepInterval(int pingSweepInterval)

Sets the interval for a ping sweep across all of the servers..

Parameters:

pingSweepInterval - The new value for the interval for a ping sweep across all of the servers..

start

public void start()

Starts the background pinger.

stop

public void stop()

Stops the background pinger. Equivalent to close().

wakeUp

public void wakeUp()

Starts the background pinger.

startSweep

protected void startSweep()

Extension point to notify derived classes that a new sweep is starting.