/*
 * Copyright (c) "Neo4j"
 * Neo4j Sweden AB [http://neo4j.com]
 *
 * This file is part of Neo4j.
 *
 * Neo4j is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.neo4j.kernel.api;

import java.time.Duration;
import org.neo4j.kernel.api.exceptions.Status;

/**
 * Configuration of transaction timeout.
 * <p>
 * In case if timeout is {@link Duration#ZERO} - transaction does not have a timeout.
 *
 * @param timeout max transaction duration since its start.
 * @param timoutStatus status to use if the transaction actually times out.
 *                     It should be either {@link Status.Transaction#TransactionTimedOut}
 *                     or {@link Status.Transaction#TransactionTimedOutClientConfiguration}.
 *                     Which one depends on how the timeout was configured.
 */
public record TransactionTimeout(Duration timeout, Status timoutStatus) {

    public static final TransactionTimeout NO_TIMEOUT =
            new TransactionTimeout(Duration.ZERO, Status.Transaction.TransactionTimedOut);
}
