KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > avalon > excalibur > pool > Mutex


1 /*
2
3  ============================================================================
4                    The Apache Software License, Version 1.1
5  ============================================================================
6  
7  Copyright (C) 1999-2003 The Apache Software Foundation. All rights reserved.
8  
9  Redistribution and use in source and binary forms, with or without modifica-
10  tion, are permitted provided that the following conditions are met:
11  
12  1. Redistributions of source code must retain the above copyright notice,
13     this list of conditions and the following disclaimer.
14  
15  2. Redistributions in binary form must reproduce the above copyright notice,
16     this list of conditions and the following disclaimer in the documentation
17     and/or other materials provided with the distribution.
18  
19  3. The end-user documentation included with the redistribution, if any, must
20     include the following acknowledgment: "This product includes software
21     developed by the Apache Software Foundation (http://www.apache.org/)."
22     Alternately, this acknowledgment may appear in the software itself, if
23     and wherever such third-party acknowledgments normally appear.
24  
25  4. The names "Jakarta", "Avalon", "Excalibur" and "Apache Software Foundation"
26     must not be used to endorse or promote products derived from this software
27     without prior written permission. For written permission, please contact
28     apache@apache.org.
29  
30  5. Products derived from this software may not be called "Apache", nor may
31     "Apache" appear in their name, without prior written permission of the
32     Apache Software Foundation.
33  
34  THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
35  INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
36  FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
37  APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
38  INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLU-
39  DING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
40  OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
41  ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
42  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
43  THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
44  
45  This software consists of voluntary contributions made by many individuals
46  on behalf of the Apache Software Foundation. For more information on the
47  Apache Software Foundation, please see <http://www.apache.org/>.
48  
49 */

50 package org.apache.avalon.excalibur.pool;
51
52 /**
53  * This class implements a counting semaphore, also known as a
54  * Dijkstra semaphore. A semaphore is used to control access to
55  * resources. A counting semaphore has a count associated with it and
56  * each acquire() call reduces the count. A thread that tries to
57  * acquire() a semaphore with a zero count blocks until someone else
58  * calls release(), which increases the count.
59  *
60  * @version CVS $Revision: 1.2 $ $Date: 2003/02/20 17:09:24 $
61  * @since 4.0
62  */

63 class Mutex
64 {
65     private long m_tokens;
66
67     /**
68      * Creates a semaphore with the specified number of tokens, which
69      * determines the maximum number of acquisitions to allow.
70      *
71      * @param tokens the maximum number of acquisitions to allow
72      */

73     public Mutex()
74     {
75         m_tokens = 1;
76     }
77
78     public synchronized void acquire()
79         throws InterruptedException JavaDoc
80     {
81         //TODO: check for interuption outside sync block?
82
if( Thread.interrupted() ) throw new InterruptedException JavaDoc();
83
84         //While there is no more tokens left wait
85
while( 0 >= m_tokens )
86         {
87             wait();
88         }
89         m_tokens--;
90     }
91
92     public synchronized void release()
93     {
94         m_tokens++;
95         notify();
96     }
97
98     public synchronized boolean attempt( final long msecs )
99         throws InterruptedException JavaDoc
100     {
101         if( Thread.interrupted() ) throw new InterruptedException JavaDoc();
102
103         if( m_tokens > 0 )
104         {
105             m_tokens--;
106             return true;
107         }
108         else
109         {
110             final long start = System.currentTimeMillis();
111             long wait = msecs;
112
113             while( wait > 0 )
114             {
115                 wait( wait );
116
117                 if( m_tokens > 0 )
118                 {
119                     m_tokens--;
120                     return true;
121                 }
122                 else
123                 {
124                     wait = msecs - ( System.currentTimeMillis() - start );
125                 }
126             }
127
128             return false;
129         }
130     }
131 }
132
Popular Tags