com.oracle.dio.utils.InterIsolateMutex Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of org.openjdk.dio Show documentation

Maven/OSGi repackaging of OpenJDK's Device I/O library

The newest version!

/*
 * 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 com.oracle.dio.utils;

/**
 * A wrapper class for named mutex that provides limited inter-Isolate synchronization.
 */
public final class InterIsolateMutex {

    private InterIsolateMutex() {
    }

    /**
     * Gets mutex instance. For any given mutex name, the method returnes the
     * same mutex per Isolate.
     */
    public static InterIsolateMutex getInstance(String mutexName) {
        return new InterIsolateMutex();
    }

    /**
     * Locks mutex. Throws an exception if the mutex is already locked in the
     * same Isolate.
     */
    public void lock() {
        //  stubbed, unless this feature is required
    }

    /** Unlocks mutex. */
    public void unlock() {
        //  stubbed, unless this feature is required
    }
}