001/**
002 * Copyright The Apache Software Foundation
003 *
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements.  See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership.  The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License.  You may obtain a copy of the License at
011 *
012 *     http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing, software
015 * distributed under the License is distributed on an "AS IS" BASIS,
016 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
017 * See the License for the specific language governing permissions and
018 * limitations under the License.
019 */
020package org.apache.hadoop.hbase;
021
022import org.apache.hadoop.hbase.classification.InterfaceAudience;
023
024/**
025 * An interface for a distributed reader-writer lock.
026 */
027@InterfaceAudience.Private
028public interface InterProcessReadWriteLock {
029
030  /**
031   * Obtain a read lock containing given metadata.
032   * @param metadata Serialized lock metadata (this may contain information
033   *                 such as the process owning the lock or the purpose for
034   *                 which the lock was acquired).
035   * @return An instantiated InterProcessLock instance
036   */
037  InterProcessLock readLock(byte[] metadata);
038
039  /**
040   * Obtain a write lock containing given metadata.
041   * @param metadata Serialized lock metadata (this may contain information
042   *                 such as the process owning the lock or the purpose for
043   *                 which the lock was acquired).
044   * @return An instantiated InterProcessLock instance
045   */
046  InterProcessLock writeLock(byte[] metadata);
047}