com.allanbank.mongodb.connection.state

Class ClusterPinger.Pinger

java.lang.Object

com.allanbank.mongodb.connection.state.ClusterPinger.Pinger

Enclosing class:

ClusterPinger

protected static final class ClusterPinger.Pinger
extends Object

Pinger provides logic to ping servers.

Copyright ©:

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ClusterPinger.Pinger()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	ping(InetSocketAddress addr, Connection conn, ServerState state) Pings the server and suppresses all exceptions.
Future<Reply>	pingAsync(ClusterType type, InetSocketAddress addr, Connection conn, ServerState state) Pings the server and suppresses all exceptions.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClusterPinger.Pinger

protected ClusterPinger.Pinger()

Method Detail

ping

public boolean ping(InetSocketAddress addr,
           Connection conn,
           ServerState state)

Pings the server and suppresses all exceptions. Updates the server state with a latency and the tags found in the response, if any.

Parameters:

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

conn - The connection to ping.

state - The server state to update with the results of the ping. If false is returned then the state will not have been updated. Passing null for the state is allowed.

Returns:

True if the ping worked, false otherwise.

pingAsync

public Future<Reply> pingAsync(ClusterType type,
                      InetSocketAddress addr,
                      Connection conn,
                      ServerState state)

Pings the server and suppresses all exceptions. Returns a future that can be used to determine if a response has been received. The future will update the ServerState latency and tags if found.

Parameters:

type - The type of cluster to ping.

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

conn - The connection to ping.

state - The server state to update with the results of the ping. If false is returned then the state will not have been updated. Passing null for the state is allowed.

Returns:

A Future that will be updated once the reply is received.