KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > dream > synchro > Mutex


1 /**
2  * Dream
3  * Copyright (C) 2003-2004 INRIA Rhone-Alpes
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with this library; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18  *
19  * Contact : dream@objectweb.org
20  *
21  * Initial developer(s): Matthieu Leclercq, Vivien Quema
22  * Contributor(s):
23  */
24
25 package org.objectweb.dream.synchro;
26
27 /**
28  * A mutex component aims at synchronizing the execution of several components.
29  */
30 public interface Mutex
31 {
32
33   /** The default name of the {@link Mutex }interface. */
34   String JavaDoc MUTEX_ITF_NAME = "mutex";
35
36   /**
37    * Acquires the mutex.
38    *
39    * @throws InterruptedException the thread is interrupted.
40    */
41   void lock() throws InterruptedException JavaDoc;
42
43   /**
44    * Tries to acquire the mutex.
45    *
46    * @param msecs the number of milliseconds to wait for the lock.
47    * @return <code>true</code> if the lock is acquired, <code>false</code>
48    * otherwise.
49    * @throws InterruptedException if the thread is interrupted.
50    */
51   boolean timedLock(long msecs) throws InterruptedException JavaDoc;
52
53   /**
54    * Releases the mutex.
55    */
56   void unlock();
57 }
Popular Tags