/*
 * Copyright (c) 2014, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code 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
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package jdk.internal.misc;

public interface JavaLangRefAccess {

    /**
     * Triggers discovery of new Reference(s) and returns the phase sequence number
     * in which they were discovered or previous phase sequence number if no new
     * Reference(s) were discovered.
     */
    int discoverReferences();

    /**
     * Blocks until all Reference(s) that were discovered in given
     * {@code discoveryPhase} (as returned by {@link #discoverReferences()})
     * have been enqueued.
     *
     * @param discoveryPhase the discovery phase sequence number.
     * @throws InterruptedException if interrupted while waiting.
     */
    void awaitReferencesEnqueued(int discoveryPhase) throws InterruptedException;
}