org.neo4j.driver.exceptions.ConnectionReadTimeoutException Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of neo4j-java-driver Show documentation

Access to the Neo4j graph database through Java

The newest version!

/*
 * Copyright (c) "Neo4j"
 * Neo4j Sweden AB [https://neo4j.com]
 *
 * 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 org.neo4j.driver.exceptions;

import java.io.Serial;

/**
 * Indicates that read timed out due to it taking longer than the server-supplied timeout value via the {@code connection.recv_timeout_seconds} configuration
 * hint. The server might provide this value to clients to let them know when a given connection may be considered broken if client does not get any
 * communication from the server within the specified timeout period. This results in the server being removed from the routing table.
 */
public class ConnectionReadTimeoutException extends ServiceUnavailableException {
    @Serial
    private static final long serialVersionUID = -9222586212813330140L;

    /**
     * An instance of {@link ConnectionReadTimeoutException}.
     */
    public static final ConnectionReadTimeoutException INSTANCE = new ConnectionReadTimeoutException(
            "Connection read timed out due to it taking longer than the server-supplied timeout value via configuration hint.");

    /**
     * Creates a new instance.
     * @param message the message
     * @deprecated superseded by the {@link ConnectionReadTimeoutException#INSTANCE} value
     */
    @Deprecated
    @SuppressWarnings("DeprecatedIsStillUsed")
    public ConnectionReadTimeoutException(String message) {
        super(message);
    }
}