org.neo4j.io.pagecache.tracing.MajorFlushEvent Maven / Gradle / Ivy

Go to download

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

Input/output abstraction layer for Neo4j.

There is a newer version: 2025.02.0

/*
 * Copyright (c) 2002-2016 "Neo Technology,"
 * Network Engine for Objects in Lund AB [http://neotechnology.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.io.pagecache.tracing;

/**
 * Begin a mass-flushing of pages.
 */
public interface MajorFlushEvent extends AutoCloseablePageCacheTracerEvent
{
    /**
     * A MajorFlushEvent that only returns the FlushEventOpportunity.NULL.
     */
    MajorFlushEvent NULL = new MajorFlushEvent()
    {
        @Override
        public FlushEventOpportunity flushEventOpportunity()
        {
            return FlushEventOpportunity.NULL;
        }

        @Override
        public void close()
        {
        }
    };

    /**
     * Mass-flushing obviously imply flushing opportunities.
     */
    public FlushEventOpportunity flushEventOpportunity();
}