Package com.mongodb.connection

Enum Class ServerMonitoringMode

java.lang.Object

java.lang.Enum<ServerMonitoringMode>

com.mongodb.connection.ServerMonitoringMode

All Implemented Interfaces:

Serializable, Comparable<ServerMonitoringMode>, java.lang.constant.Constable

public enum ServerMonitoringMode
extends Enum<ServerMonitoringMode>

The server monitoring mode, which defines the monitoring protocol to use.

Since:

5.1

See Also:

• server discovery and monitoring (SDAM)

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AUTO	Behave the same as POLL if running in a FaaS environment, otherwise behave as STREAM.
POLL	Use the polling protocol.
STREAM	Use the streaming protocol when the server supports it or fall back to the polling protocol otherwise.

Method Summary

Modifier and Type	Method	Description
static ServerMonitoringMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ServerMonitoringMode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

STREAM

public static final ServerMonitoringMode STREAM

Use the streaming protocol when the server supports it or fall back to the polling protocol otherwise. When the streaming protocol comes into play, ServerHeartbeatStartedEvent.isAwaited(), ServerHeartbeatSucceededEvent.isAwaited(), ServerHeartbeatFailedEvent.isAwaited() return true for new events.

The streaming protocol uses long polling for server monitoring, and is intended to reduce the delay between a server change that warrants a new event for ServerListener/ClusterListener, and that event being emitted, as well as the related housekeeping work being done.

POLL

public static final ServerMonitoringMode POLL

Use the polling protocol.

AUTO

public static final ServerMonitoringMode AUTO

Behave the same as POLL if running in a FaaS environment, otherwise behave as STREAM. This is the default.

Method Details

values

public static ServerMonitoringMode[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static ServerMonitoringMode valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null