/FileExtraction/Java_unseen/dlitz_resin/modules/kernel/src/com/caucho/vfs/LockableStream.java
/*
 * Copyright (c) 1998-2011 Caucho Technology -- all rights reserved
 *
 * This file is part of Resin(R) Open Source
 *
 * Each copy or derived work must preserve the copyright notice and this
 * notice unmodified.
 *
 * Resin Open Source 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 2 of the License, or
 * (at your option) any later version.
 *
 * Resin Open Source 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, or any warranty
 * of NON-INFRINGEMENT.  See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Resin Open Source; if not, write to the
 *
 *   Free Software Foundation, Inc.
 *   59 Temple Place, Suite 330
 *   Boston, MA 02111-1307  USA
 *
 * @author Emil Ong
 */

package com.caucho.vfs;

public interface LockableStream
{
  /**
   * Lock the shared advisory lock. This method will
   * create a shared "read" lock when the shared
   * argument is true and an exclusive "write" lock
   * when the shared argument is false. If the block
   * argument is false then this call will not block
   * if the lock can't be obtained.
   */
  public boolean lock(boolean shared, boolean block);

  /**
   * Unlock the advisory lock. Return true if a
   * lock was held, false otherwise.
   */
  public boolean unlock();

}
