com.mongodb.connection.ServerMonitoringMode Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mongodb-driver-core Show documentation

The Java operations layer for the MongoDB Java Driver. Third parties can wrap this layer to provide custom higher-level APIs

There is a newer version: 5.3.0-beta0

Show newest version

/*
 * Copyright 2008-present MongoDB, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.mongodb.connection;

import com.mongodb.event.ClusterListener;
import com.mongodb.event.ServerHeartbeatFailedEvent;
import com.mongodb.event.ServerHeartbeatStartedEvent;
import com.mongodb.event.ServerHeartbeatSucceededEvent;
import com.mongodb.event.ServerListener;

/**
 * The server monitoring mode, which defines the monitoring protocol to use.
 *
 * @see 
 * server discovery and monitoring (SDAM)
 * @since 5.1
 */
public enum ServerMonitoringMode {
    /**
     * Use the streaming protocol when the server supports it or fall back to the polling protocol otherwise.
     * When the streaming protocol comes into play,
     * {@link ServerHeartbeatStartedEvent#isAwaited()}, {@link ServerHeartbeatSucceededEvent#isAwaited()},
     * {@link ServerHeartbeatFailedEvent#isAwaited()} return {@code 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 {@link ServerListener}/{@link ClusterListener},
     * and that event being emitted, as well as the related housekeeping work being done.
     */
    STREAM(),
    /**
     * Use the polling protocol.
     */
    POLL(),
    /**
     * Behave the same as {@link #POLL} if running in a FaaS environment, otherwise behave as {@link #STREAM}.
     * This is the default.
     */
    AUTO()
}