org.neo4j.procedure.TerminationGuard Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of neo4j-procedure-api Show documentation

Procedure API for Neo4j.

There is a newer version: 5.25.1

/*
 * 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 .
 */
package org.neo4j.procedure;

/**
 * TerminationGuard allows a long running procedure to check at regular intervals if the surrounding executing
 * query has been terminated by the user or a database administrator or was timed out for some other reason.
 *
 */
public interface TerminationGuard
{
    /**
     * Check that the surrounding executing query has not yet been terminated or timed out. Throws an appropriate
     * exception if it has.
     */
    void check();
}