com.mongodb.connection

Class ServerSettings

java.lang.Object

com.mongodb.connection.ServerSettings

@Immutable
public class ServerSettings
extends java.lang.Object

Settings relating to monitoring of each server.

Since:

3.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ServerSettings.Builder A builder for the settings.

Field Summary

Fields

Modifier and Type	Field and Description
private long	heartbeatFrequencyMS
private long	minHeartbeatFrequencyMS
private java.util.List<ServerListener>	serverListeners
private java.util.List<ServerMonitorListener>	serverMonitorListeners

Constructor Summary

Constructors

Constructor and Description
ServerSettings(ServerSettings.Builder builder)

Method Summary

Modifier and Type	Method and Description
static ServerSettings.Builder	builder() Creates a builder for ServerSettings.
boolean	equals(java.lang.Object o)
long	getHeartbeatFrequency(java.util.concurrent.TimeUnit timeUnit) Gets the frequency that the cluster monitor attempts to reach each server.
long	getMinHeartbeatFrequency(java.util.concurrent.TimeUnit timeUnit) Gets the minimum heartbeat frequency.
java.util.List<ServerListener>	getServerListeners() Gets the server listeners.
java.util.List<ServerMonitorListener>	getServerMonitorListeners() Gets the server monitor listeners.
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

heartbeatFrequencyMS

private final long heartbeatFrequencyMS

minHeartbeatFrequencyMS

private final long minHeartbeatFrequencyMS

serverListeners

private final java.util.List<ServerListener> serverListeners

serverMonitorListeners

private final java.util.List<ServerMonitorListener> serverMonitorListeners

Constructor Detail

ServerSettings

ServerSettings(ServerSettings.Builder builder)

Method Detail

builder

public static ServerSettings.Builder builder()

Creates a builder for ServerSettings.

Returns:

a new Builder for creating ServerSettings.

getHeartbeatFrequency

public long getHeartbeatFrequency(java.util.concurrent.TimeUnit timeUnit)

Gets the frequency that the cluster monitor attempts to reach each server. The default value is 10 seconds.

Parameters:

timeUnit - the time unit

Returns:

the heartbeat frequency

getMinHeartbeatFrequency

public long getMinHeartbeatFrequency(java.util.concurrent.TimeUnit timeUnit)

Gets the minimum heartbeat frequency. In the event that the driver has to frequently re-check a server's availability, it will wait at least this long since the previous check to avoid wasted effort. The default value is 500 milliseconds.

Parameters:

timeUnit - the time unit

Returns:

the heartbeat reconnect retry frequency

getServerListeners

public java.util.List<ServerListener> getServerListeners()

Gets the server listeners. The default value is an empty list.

Returns:

the server listeners

Since:

3.3

getServerMonitorListeners

public java.util.List<ServerMonitorListener> getServerMonitorListeners()

Gets the server monitor listeners. The default value is an empty list.

Returns:

the server monitor listeners

Since:

3.3

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object