blob: ca99eff4d714c023836a92fa0497416d289fb4e5 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a>
<span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a>
<span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a>
<span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a>
<span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a>
<span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a>
<span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a>
<span class="sourceLineNo">009</span> *<a name="line.9"></a>
<span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<span class="sourceLineNo">011</span> *<a name="line.11"></a>
<span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing,<a name="line.12"></a>
<span class="sourceLineNo">013</span> * software distributed under the License is distributed on an<a name="line.13"></a>
<span class="sourceLineNo">014</span> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a>
<span class="sourceLineNo">015</span> * KIND, either express or implied. See the License for the<a name="line.15"></a>
<span class="sourceLineNo">016</span> * specific language governing permissions and limitations<a name="line.16"></a>
<span class="sourceLineNo">017</span> * under the License.<a name="line.17"></a>
<span class="sourceLineNo">018</span> *<a name="line.18"></a>
<span class="sourceLineNo">019</span> */<a name="line.19"></a>
<span class="sourceLineNo">020</span>package org.apache.mina.core.future;<a name="line.20"></a>
<span class="sourceLineNo">021</span><a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.util.ArrayList;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.util.List;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.util.concurrent.TimeUnit;<a name="line.24"></a>
<span class="sourceLineNo">025</span><a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.mina.core.polling.AbstractPollingIoProcessor;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.mina.core.service.IoProcessor;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.mina.core.session.IoSession;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.mina.util.ExceptionMonitor;<a name="line.29"></a>
<span class="sourceLineNo">030</span><a name="line.30"></a>
<span class="sourceLineNo">031</span>/**<a name="line.31"></a>
<span class="sourceLineNo">032</span> * A default implementation of {@link IoFuture} associated with<a name="line.32"></a>
<span class="sourceLineNo">033</span> * an {@link IoSession}.<a name="line.33"></a>
<span class="sourceLineNo">034</span> * <a name="line.34"></a>
<span class="sourceLineNo">035</span> * @author &lt;a href="http://mina.apache.org"&gt;Apache MINA Project&lt;/a&gt;<a name="line.35"></a>
<span class="sourceLineNo">036</span> */<a name="line.36"></a>
<span class="sourceLineNo">037</span>public class DefaultIoFuture implements IoFuture {<a name="line.37"></a>
<span class="sourceLineNo">038</span><a name="line.38"></a>
<span class="sourceLineNo">039</span> /** A number of milliseconds to wait between two deadlock controls ( 5 seconds ) */<a name="line.39"></a>
<span class="sourceLineNo">040</span> private static final long DEAD_LOCK_CHECK_INTERVAL = 5000L;<a name="line.40"></a>
<span class="sourceLineNo">041</span><a name="line.41"></a>
<span class="sourceLineNo">042</span> /** The associated session */<a name="line.42"></a>
<span class="sourceLineNo">043</span> private final IoSession session;<a name="line.43"></a>
<span class="sourceLineNo">044</span><a name="line.44"></a>
<span class="sourceLineNo">045</span> /** A lock used by the wait() method */<a name="line.45"></a>
<span class="sourceLineNo">046</span> private final Object lock;<a name="line.46"></a>
<span class="sourceLineNo">047</span><a name="line.47"></a>
<span class="sourceLineNo">048</span> /** The first listener. This is easier to have this variable<a name="line.48"></a>
<span class="sourceLineNo">049</span> * when we most of the time have one single listener */<a name="line.49"></a>
<span class="sourceLineNo">050</span> private IoFutureListener&lt;?&gt; firstListener;<a name="line.50"></a>
<span class="sourceLineNo">051</span><a name="line.51"></a>
<span class="sourceLineNo">052</span> /** All the other listeners, in case we have more than one */<a name="line.52"></a>
<span class="sourceLineNo">053</span> private List&lt;IoFutureListener&lt;?&gt;&gt; otherListeners;<a name="line.53"></a>
<span class="sourceLineNo">054</span><a name="line.54"></a>
<span class="sourceLineNo">055</span> private Object result;<a name="line.55"></a>
<span class="sourceLineNo">056</span><a name="line.56"></a>
<span class="sourceLineNo">057</span> /** The flag used to determinate if the Future is completed or not */<a name="line.57"></a>
<span class="sourceLineNo">058</span> private boolean ready;<a name="line.58"></a>
<span class="sourceLineNo">059</span><a name="line.59"></a>
<span class="sourceLineNo">060</span> /** A counter for the number of threads waiting on this future */<a name="line.60"></a>
<span class="sourceLineNo">061</span> private int waiters;<a name="line.61"></a>
<span class="sourceLineNo">062</span><a name="line.62"></a>
<span class="sourceLineNo">063</span> /**<a name="line.63"></a>
<span class="sourceLineNo">064</span> * Creates a new instance associated with an {@link IoSession}.<a name="line.64"></a>
<span class="sourceLineNo">065</span> *<a name="line.65"></a>
<span class="sourceLineNo">066</span> * @param session an {@link IoSession} which is associated with this future<a name="line.66"></a>
<span class="sourceLineNo">067</span> */<a name="line.67"></a>
<span class="sourceLineNo">068</span> public DefaultIoFuture(IoSession session) {<a name="line.68"></a>
<span class="sourceLineNo">069</span> this.session = session;<a name="line.69"></a>
<span class="sourceLineNo">070</span> this.lock = this;<a name="line.70"></a>
<span class="sourceLineNo">071</span> }<a name="line.71"></a>
<span class="sourceLineNo">072</span><a name="line.72"></a>
<span class="sourceLineNo">073</span> /**<a name="line.73"></a>
<span class="sourceLineNo">074</span> * {@inheritDoc}<a name="line.74"></a>
<span class="sourceLineNo">075</span> */<a name="line.75"></a>
<span class="sourceLineNo">076</span> public IoSession getSession() {<a name="line.76"></a>
<span class="sourceLineNo">077</span> return session;<a name="line.77"></a>
<span class="sourceLineNo">078</span> }<a name="line.78"></a>
<span class="sourceLineNo">079</span><a name="line.79"></a>
<span class="sourceLineNo">080</span> /**<a name="line.80"></a>
<span class="sourceLineNo">081</span> * @deprecated Replaced with {@link #awaitUninterruptibly()}.<a name="line.81"></a>
<span class="sourceLineNo">082</span> */<a name="line.82"></a>
<span class="sourceLineNo">083</span> @Deprecated<a name="line.83"></a>
<span class="sourceLineNo">084</span> public void join() {<a name="line.84"></a>
<span class="sourceLineNo">085</span> awaitUninterruptibly();<a name="line.85"></a>
<span class="sourceLineNo">086</span> }<a name="line.86"></a>
<span class="sourceLineNo">087</span><a name="line.87"></a>
<span class="sourceLineNo">088</span> /**<a name="line.88"></a>
<span class="sourceLineNo">089</span> * @deprecated Replaced with {@link #awaitUninterruptibly(long)}.<a name="line.89"></a>
<span class="sourceLineNo">090</span> */<a name="line.90"></a>
<span class="sourceLineNo">091</span> @Deprecated<a name="line.91"></a>
<span class="sourceLineNo">092</span> public boolean join(long timeoutMillis) {<a name="line.92"></a>
<span class="sourceLineNo">093</span> return awaitUninterruptibly(timeoutMillis);<a name="line.93"></a>
<span class="sourceLineNo">094</span> }<a name="line.94"></a>
<span class="sourceLineNo">095</span><a name="line.95"></a>
<span class="sourceLineNo">096</span> /**<a name="line.96"></a>
<span class="sourceLineNo">097</span> * {@inheritDoc}<a name="line.97"></a>
<span class="sourceLineNo">098</span> */<a name="line.98"></a>
<span class="sourceLineNo">099</span> public IoFuture await() throws InterruptedException {<a name="line.99"></a>
<span class="sourceLineNo">100</span> synchronized (lock) {<a name="line.100"></a>
<span class="sourceLineNo">101</span> while (!ready) {<a name="line.101"></a>
<span class="sourceLineNo">102</span> waiters++;<a name="line.102"></a>
<span class="sourceLineNo">103</span> <a name="line.103"></a>
<span class="sourceLineNo">104</span> try {<a name="line.104"></a>
<span class="sourceLineNo">105</span> // Wait for a notify, or if no notify is called,<a name="line.105"></a>
<span class="sourceLineNo">106</span> // assume that we have a deadlock and exit the<a name="line.106"></a>
<span class="sourceLineNo">107</span> // loop to check for a potential deadlock.<a name="line.107"></a>
<span class="sourceLineNo">108</span> lock.wait(DEAD_LOCK_CHECK_INTERVAL);<a name="line.108"></a>
<span class="sourceLineNo">109</span> } finally {<a name="line.109"></a>
<span class="sourceLineNo">110</span> waiters--;<a name="line.110"></a>
<span class="sourceLineNo">111</span> <a name="line.111"></a>
<span class="sourceLineNo">112</span> if (!ready) {<a name="line.112"></a>
<span class="sourceLineNo">113</span> checkDeadLock();<a name="line.113"></a>
<span class="sourceLineNo">114</span> }<a name="line.114"></a>
<span class="sourceLineNo">115</span> }<a name="line.115"></a>
<span class="sourceLineNo">116</span> }<a name="line.116"></a>
<span class="sourceLineNo">117</span> }<a name="line.117"></a>
<span class="sourceLineNo">118</span> <a name="line.118"></a>
<span class="sourceLineNo">119</span> return this;<a name="line.119"></a>
<span class="sourceLineNo">120</span> }<a name="line.120"></a>
<span class="sourceLineNo">121</span><a name="line.121"></a>
<span class="sourceLineNo">122</span> /**<a name="line.122"></a>
<span class="sourceLineNo">123</span> * {@inheritDoc}<a name="line.123"></a>
<span class="sourceLineNo">124</span> */<a name="line.124"></a>
<span class="sourceLineNo">125</span> public boolean await(long timeout, TimeUnit unit) throws InterruptedException {<a name="line.125"></a>
<span class="sourceLineNo">126</span> return await0(unit.toMillis(timeout), true);<a name="line.126"></a>
<span class="sourceLineNo">127</span> }<a name="line.127"></a>
<span class="sourceLineNo">128</span><a name="line.128"></a>
<span class="sourceLineNo">129</span> /**<a name="line.129"></a>
<span class="sourceLineNo">130</span> * {@inheritDoc}<a name="line.130"></a>
<span class="sourceLineNo">131</span> */<a name="line.131"></a>
<span class="sourceLineNo">132</span> public boolean await(long timeoutMillis) throws InterruptedException {<a name="line.132"></a>
<span class="sourceLineNo">133</span> return await0(timeoutMillis, true);<a name="line.133"></a>
<span class="sourceLineNo">134</span> }<a name="line.134"></a>
<span class="sourceLineNo">135</span><a name="line.135"></a>
<span class="sourceLineNo">136</span> /**<a name="line.136"></a>
<span class="sourceLineNo">137</span> * {@inheritDoc}<a name="line.137"></a>
<span class="sourceLineNo">138</span> */<a name="line.138"></a>
<span class="sourceLineNo">139</span> public IoFuture awaitUninterruptibly() {<a name="line.139"></a>
<span class="sourceLineNo">140</span> try {<a name="line.140"></a>
<span class="sourceLineNo">141</span> await0(Long.MAX_VALUE, false);<a name="line.141"></a>
<span class="sourceLineNo">142</span> } catch (InterruptedException ie) {<a name="line.142"></a>
<span class="sourceLineNo">143</span> // Do nothing : this catch is just mandatory by contract<a name="line.143"></a>
<span class="sourceLineNo">144</span> }<a name="line.144"></a>
<span class="sourceLineNo">145</span><a name="line.145"></a>
<span class="sourceLineNo">146</span> return this;<a name="line.146"></a>
<span class="sourceLineNo">147</span> }<a name="line.147"></a>
<span class="sourceLineNo">148</span><a name="line.148"></a>
<span class="sourceLineNo">149</span> /**<a name="line.149"></a>
<span class="sourceLineNo">150</span> * {@inheritDoc}<a name="line.150"></a>
<span class="sourceLineNo">151</span> */<a name="line.151"></a>
<span class="sourceLineNo">152</span> public boolean awaitUninterruptibly(long timeout, TimeUnit unit) {<a name="line.152"></a>
<span class="sourceLineNo">153</span> try {<a name="line.153"></a>
<span class="sourceLineNo">154</span> return await0(unit.toMillis(timeout), false);<a name="line.154"></a>
<span class="sourceLineNo">155</span> } catch (InterruptedException e) {<a name="line.155"></a>
<span class="sourceLineNo">156</span> throw new InternalError();<a name="line.156"></a>
<span class="sourceLineNo">157</span> }<a name="line.157"></a>
<span class="sourceLineNo">158</span> }<a name="line.158"></a>
<span class="sourceLineNo">159</span><a name="line.159"></a>
<span class="sourceLineNo">160</span> /**<a name="line.160"></a>
<span class="sourceLineNo">161</span> * {@inheritDoc}<a name="line.161"></a>
<span class="sourceLineNo">162</span> */<a name="line.162"></a>
<span class="sourceLineNo">163</span> public boolean awaitUninterruptibly(long timeoutMillis) {<a name="line.163"></a>
<span class="sourceLineNo">164</span> try {<a name="line.164"></a>
<span class="sourceLineNo">165</span> return await0(timeoutMillis, false);<a name="line.165"></a>
<span class="sourceLineNo">166</span> } catch (InterruptedException e) {<a name="line.166"></a>
<span class="sourceLineNo">167</span> throw new InternalError();<a name="line.167"></a>
<span class="sourceLineNo">168</span> }<a name="line.168"></a>
<span class="sourceLineNo">169</span> }<a name="line.169"></a>
<span class="sourceLineNo">170</span><a name="line.170"></a>
<span class="sourceLineNo">171</span> /**<a name="line.171"></a>
<span class="sourceLineNo">172</span> * Wait for the Future to be ready. If the requested delay is 0 or<a name="line.172"></a>
<span class="sourceLineNo">173</span> * negative, this method immediately returns the value of the<a name="line.173"></a>
<span class="sourceLineNo">174</span> * 'ready' flag.<a name="line.174"></a>
<span class="sourceLineNo">175</span> * Every 5 second, the wait will be suspended to be able to check if<a name="line.175"></a>
<span class="sourceLineNo">176</span> * there is a deadlock or not.<a name="line.176"></a>
<span class="sourceLineNo">177</span> * <a name="line.177"></a>
<span class="sourceLineNo">178</span> * @param timeoutMillis The delay we will wait for the Future to be ready<a name="line.178"></a>
<span class="sourceLineNo">179</span> * @param interruptable Tells if the wait can be interrupted or not<a name="line.179"></a>
<span class="sourceLineNo">180</span> * @return &lt;tt&gt;true&lt;/tt&gt; if the Future is ready<a name="line.180"></a>
<span class="sourceLineNo">181</span> * @throws InterruptedException If the thread has been interrupted<a name="line.181"></a>
<span class="sourceLineNo">182</span> * when it's not allowed.<a name="line.182"></a>
<span class="sourceLineNo">183</span> */<a name="line.183"></a>
<span class="sourceLineNo">184</span> private boolean await0(long timeoutMillis, boolean interruptable) throws InterruptedException {<a name="line.184"></a>
<span class="sourceLineNo">185</span> long endTime = System.currentTimeMillis() + timeoutMillis;<a name="line.185"></a>
<span class="sourceLineNo">186</span><a name="line.186"></a>
<span class="sourceLineNo">187</span> if (endTime &lt; 0) {<a name="line.187"></a>
<span class="sourceLineNo">188</span> endTime = Long.MAX_VALUE;<a name="line.188"></a>
<span class="sourceLineNo">189</span> }<a name="line.189"></a>
<span class="sourceLineNo">190</span><a name="line.190"></a>
<span class="sourceLineNo">191</span> synchronized (lock) {<a name="line.191"></a>
<span class="sourceLineNo">192</span> // We can quit if the ready flag is set to true, or if<a name="line.192"></a>
<span class="sourceLineNo">193</span> // the timeout is set to 0 or below : we don't wait in this case.<a name="line.193"></a>
<span class="sourceLineNo">194</span> if (ready||(timeoutMillis &lt;= 0)) {<a name="line.194"></a>
<span class="sourceLineNo">195</span> return ready;<a name="line.195"></a>
<span class="sourceLineNo">196</span> }<a name="line.196"></a>
<span class="sourceLineNo">197</span><a name="line.197"></a>
<span class="sourceLineNo">198</span> // The operation is not completed : we have to wait<a name="line.198"></a>
<span class="sourceLineNo">199</span> waiters++;<a name="line.199"></a>
<span class="sourceLineNo">200</span><a name="line.200"></a>
<span class="sourceLineNo">201</span> try {<a name="line.201"></a>
<span class="sourceLineNo">202</span> for (;;) {<a name="line.202"></a>
<span class="sourceLineNo">203</span> try {<a name="line.203"></a>
<span class="sourceLineNo">204</span> long timeOut = Math.min(timeoutMillis, DEAD_LOCK_CHECK_INTERVAL);<a name="line.204"></a>
<span class="sourceLineNo">205</span> <a name="line.205"></a>
<span class="sourceLineNo">206</span> // Wait for the requested period of time,<a name="line.206"></a>
<span class="sourceLineNo">207</span> // but every DEAD_LOCK_CHECK_INTERVAL seconds, we will<a name="line.207"></a>
<span class="sourceLineNo">208</span> // check that we aren't blocked.<a name="line.208"></a>
<span class="sourceLineNo">209</span> lock.wait(timeOut);<a name="line.209"></a>
<span class="sourceLineNo">210</span> } catch (InterruptedException e) {<a name="line.210"></a>
<span class="sourceLineNo">211</span> if (interruptable) {<a name="line.211"></a>
<span class="sourceLineNo">212</span> throw e;<a name="line.212"></a>
<span class="sourceLineNo">213</span> }<a name="line.213"></a>
<span class="sourceLineNo">214</span> }<a name="line.214"></a>
<span class="sourceLineNo">215</span><a name="line.215"></a>
<span class="sourceLineNo">216</span> if (ready || (endTime &lt; System.currentTimeMillis())) {<a name="line.216"></a>
<span class="sourceLineNo">217</span> return ready;<a name="line.217"></a>
<span class="sourceLineNo">218</span> } else {<a name="line.218"></a>
<span class="sourceLineNo">219</span> // Take a chance, detect a potential deadlock<a name="line.219"></a>
<span class="sourceLineNo">220</span> checkDeadLock();<a name="line.220"></a>
<span class="sourceLineNo">221</span> }<a name="line.221"></a>
<span class="sourceLineNo">222</span> }<a name="line.222"></a>
<span class="sourceLineNo">223</span> } finally {<a name="line.223"></a>
<span class="sourceLineNo">224</span> // We get here for 3 possible reasons :<a name="line.224"></a>
<span class="sourceLineNo">225</span> // 1) We have been notified (the operation has completed a way or another)<a name="line.225"></a>
<span class="sourceLineNo">226</span> // 2) We have reached the timeout<a name="line.226"></a>
<span class="sourceLineNo">227</span> // 3) The thread has been interrupted<a name="line.227"></a>
<span class="sourceLineNo">228</span> // In any case, we decrement the number of waiters, and we get out.<a name="line.228"></a>
<span class="sourceLineNo">229</span> waiters--;<a name="line.229"></a>
<span class="sourceLineNo">230</span> <a name="line.230"></a>
<span class="sourceLineNo">231</span> if (!ready) {<a name="line.231"></a>
<span class="sourceLineNo">232</span> checkDeadLock();<a name="line.232"></a>
<span class="sourceLineNo">233</span> }<a name="line.233"></a>
<span class="sourceLineNo">234</span> }<a name="line.234"></a>
<span class="sourceLineNo">235</span> }<a name="line.235"></a>
<span class="sourceLineNo">236</span> }<a name="line.236"></a>
<span class="sourceLineNo">237</span><a name="line.237"></a>
<span class="sourceLineNo">238</span> /**<a name="line.238"></a>
<span class="sourceLineNo">239</span> * Check for a deadlock, ie look into the stack trace that we don't have already an <a name="line.239"></a>
<span class="sourceLineNo">240</span> * instance of the caller.<a name="line.240"></a>
<span class="sourceLineNo">241</span> */<a name="line.241"></a>
<span class="sourceLineNo">242</span> private void checkDeadLock() {<a name="line.242"></a>
<span class="sourceLineNo">243</span> // Only read / write / connect / write future can cause dead lock.<a name="line.243"></a>
<span class="sourceLineNo">244</span> if (!(this instanceof CloseFuture || this instanceof WriteFuture || this instanceof ReadFuture || this instanceof ConnectFuture)) {<a name="line.244"></a>
<span class="sourceLineNo">245</span> return;<a name="line.245"></a>
<span class="sourceLineNo">246</span> }<a name="line.246"></a>
<span class="sourceLineNo">247</span><a name="line.247"></a>
<span class="sourceLineNo">248</span> // Get the current thread stackTrace.<a name="line.248"></a>
<span class="sourceLineNo">249</span> // Using Thread.currentThread().getStackTrace() is the best solution,<a name="line.249"></a>
<span class="sourceLineNo">250</span> // even if slightly less efficient than doing a new Exception().getStackTrace(),<a name="line.250"></a>
<span class="sourceLineNo">251</span> // as internally, it does exactly the same thing. The advantage of using<a name="line.251"></a>
<span class="sourceLineNo">252</span> // this solution is that we may benefit some improvement with some<a name="line.252"></a>
<span class="sourceLineNo">253</span> // future versions of Java.<a name="line.253"></a>
<span class="sourceLineNo">254</span> StackTraceElement[] stackTrace = Thread.currentThread().getStackTrace();<a name="line.254"></a>
<span class="sourceLineNo">255</span><a name="line.255"></a>
<span class="sourceLineNo">256</span> // Simple and quick check.<a name="line.256"></a>
<span class="sourceLineNo">257</span> for (StackTraceElement stackElement : stackTrace) {<a name="line.257"></a>
<span class="sourceLineNo">258</span> if (AbstractPollingIoProcessor.class.getName().equals(stackElement.getClassName())) {<a name="line.258"></a>
<span class="sourceLineNo">259</span> IllegalStateException e = new IllegalStateException("t");<a name="line.259"></a>
<span class="sourceLineNo">260</span> e.getStackTrace();<a name="line.260"></a>
<span class="sourceLineNo">261</span> throw new IllegalStateException("DEAD LOCK: " + IoFuture.class.getSimpleName()<a name="line.261"></a>
<span class="sourceLineNo">262</span> + ".await() was invoked from an I/O processor thread. " + "Please use "<a name="line.262"></a>
<span class="sourceLineNo">263</span> + IoFutureListener.class.getSimpleName() + " or configure a proper thread model alternatively.");<a name="line.263"></a>
<span class="sourceLineNo">264</span> }<a name="line.264"></a>
<span class="sourceLineNo">265</span> }<a name="line.265"></a>
<span class="sourceLineNo">266</span><a name="line.266"></a>
<span class="sourceLineNo">267</span> // And then more precisely.<a name="line.267"></a>
<span class="sourceLineNo">268</span> for (StackTraceElement s : stackTrace) {<a name="line.268"></a>
<span class="sourceLineNo">269</span> try {<a name="line.269"></a>
<span class="sourceLineNo">270</span> Class&lt;?&gt; cls = DefaultIoFuture.class.getClassLoader().loadClass(s.getClassName());<a name="line.270"></a>
<span class="sourceLineNo">271</span> <a name="line.271"></a>
<span class="sourceLineNo">272</span> if (IoProcessor.class.isAssignableFrom(cls)) {<a name="line.272"></a>
<span class="sourceLineNo">273</span> throw new IllegalStateException("DEAD LOCK: " + IoFuture.class.getSimpleName()<a name="line.273"></a>
<span class="sourceLineNo">274</span> + ".await() was invoked from an I/O processor thread. " + "Please use "<a name="line.274"></a>
<span class="sourceLineNo">275</span> + IoFutureListener.class.getSimpleName()<a name="line.275"></a>
<span class="sourceLineNo">276</span> + " or configure a proper thread model alternatively.");<a name="line.276"></a>
<span class="sourceLineNo">277</span> }<a name="line.277"></a>
<span class="sourceLineNo">278</span> } catch (ClassNotFoundException cnfe) {<a name="line.278"></a>
<span class="sourceLineNo">279</span> // Ignore<a name="line.279"></a>
<span class="sourceLineNo">280</span> }<a name="line.280"></a>
<span class="sourceLineNo">281</span> }<a name="line.281"></a>
<span class="sourceLineNo">282</span> }<a name="line.282"></a>
<span class="sourceLineNo">283</span><a name="line.283"></a>
<span class="sourceLineNo">284</span> /**<a name="line.284"></a>
<span class="sourceLineNo">285</span> * {@inheritDoc}<a name="line.285"></a>
<span class="sourceLineNo">286</span> */<a name="line.286"></a>
<span class="sourceLineNo">287</span> public boolean isDone() {<a name="line.287"></a>
<span class="sourceLineNo">288</span> synchronized (lock) {<a name="line.288"></a>
<span class="sourceLineNo">289</span> return ready;<a name="line.289"></a>
<span class="sourceLineNo">290</span> }<a name="line.290"></a>
<span class="sourceLineNo">291</span> }<a name="line.291"></a>
<span class="sourceLineNo">292</span><a name="line.292"></a>
<span class="sourceLineNo">293</span> /**<a name="line.293"></a>
<span class="sourceLineNo">294</span> * Sets the result of the asynchronous operation, and mark it as finished.<a name="line.294"></a>
<span class="sourceLineNo">295</span> * <a name="line.295"></a>
<span class="sourceLineNo">296</span> * @param newValue The result to store into the Future<a name="line.296"></a>
<span class="sourceLineNo">297</span> * @return {@code true} if the value has been set, {@code false} if<a name="line.297"></a>
<span class="sourceLineNo">298</span> * the future already has a value (thus is in ready state)<a name="line.298"></a>
<span class="sourceLineNo">299</span> */<a name="line.299"></a>
<span class="sourceLineNo">300</span> public boolean setValue(Object newValue) {<a name="line.300"></a>
<span class="sourceLineNo">301</span> synchronized (lock) {<a name="line.301"></a>
<span class="sourceLineNo">302</span> // Allowed only once.<a name="line.302"></a>
<span class="sourceLineNo">303</span> if (ready) {<a name="line.303"></a>
<span class="sourceLineNo">304</span> return false;<a name="line.304"></a>
<span class="sourceLineNo">305</span> }<a name="line.305"></a>
<span class="sourceLineNo">306</span><a name="line.306"></a>
<span class="sourceLineNo">307</span> result = newValue;<a name="line.307"></a>
<span class="sourceLineNo">308</span> ready = true;<a name="line.308"></a>
<span class="sourceLineNo">309</span> <a name="line.309"></a>
<span class="sourceLineNo">310</span> // Now, if we have waiters, notify them that the operation has completed<a name="line.310"></a>
<span class="sourceLineNo">311</span> if (waiters &gt; 0) {<a name="line.311"></a>
<span class="sourceLineNo">312</span> lock.notifyAll();<a name="line.312"></a>
<span class="sourceLineNo">313</span> }<a name="line.313"></a>
<span class="sourceLineNo">314</span> }<a name="line.314"></a>
<span class="sourceLineNo">315</span><a name="line.315"></a>
<span class="sourceLineNo">316</span> // Last, not least, inform the listeners<a name="line.316"></a>
<span class="sourceLineNo">317</span> notifyListeners();<a name="line.317"></a>
<span class="sourceLineNo">318</span> <a name="line.318"></a>
<span class="sourceLineNo">319</span> return true;<a name="line.319"></a>
<span class="sourceLineNo">320</span> }<a name="line.320"></a>
<span class="sourceLineNo">321</span><a name="line.321"></a>
<span class="sourceLineNo">322</span> /**<a name="line.322"></a>
<span class="sourceLineNo">323</span> * @return the result of the asynchronous operation.<a name="line.323"></a>
<span class="sourceLineNo">324</span> */<a name="line.324"></a>
<span class="sourceLineNo">325</span> protected Object getValue() {<a name="line.325"></a>
<span class="sourceLineNo">326</span> synchronized (lock) {<a name="line.326"></a>
<span class="sourceLineNo">327</span> return result;<a name="line.327"></a>
<span class="sourceLineNo">328</span> }<a name="line.328"></a>
<span class="sourceLineNo">329</span> }<a name="line.329"></a>
<span class="sourceLineNo">330</span><a name="line.330"></a>
<span class="sourceLineNo">331</span> /**<a name="line.331"></a>
<span class="sourceLineNo">332</span> * {@inheritDoc}<a name="line.332"></a>
<span class="sourceLineNo">333</span> */<a name="line.333"></a>
<span class="sourceLineNo">334</span> public IoFuture addListener(IoFutureListener&lt;?&gt; listener) {<a name="line.334"></a>
<span class="sourceLineNo">335</span> if (listener == null) {<a name="line.335"></a>
<span class="sourceLineNo">336</span> throw new IllegalArgumentException("listener");<a name="line.336"></a>
<span class="sourceLineNo">337</span> }<a name="line.337"></a>
<span class="sourceLineNo">338</span><a name="line.338"></a>
<span class="sourceLineNo">339</span> synchronized (lock) {<a name="line.339"></a>
<span class="sourceLineNo">340</span> if (ready) {<a name="line.340"></a>
<span class="sourceLineNo">341</span> // Shortcut : if the operation has completed, no need to <a name="line.341"></a>
<span class="sourceLineNo">342</span> // add a new listener, we just have to notify it. The existing<a name="line.342"></a>
<span class="sourceLineNo">343</span> // listeners have already been notified anyway, when the <a name="line.343"></a>
<span class="sourceLineNo">344</span> // 'ready' flag has been set.<a name="line.344"></a>
<span class="sourceLineNo">345</span> notifyListener(listener);<a name="line.345"></a>
<span class="sourceLineNo">346</span> } else {<a name="line.346"></a>
<span class="sourceLineNo">347</span> if (firstListener == null) {<a name="line.347"></a>
<span class="sourceLineNo">348</span> firstListener = listener;<a name="line.348"></a>
<span class="sourceLineNo">349</span> } else {<a name="line.349"></a>
<span class="sourceLineNo">350</span> if (otherListeners == null) {<a name="line.350"></a>
<span class="sourceLineNo">351</span> otherListeners = new ArrayList&lt;IoFutureListener&lt;?&gt;&gt;(1);<a name="line.351"></a>
<span class="sourceLineNo">352</span> }<a name="line.352"></a>
<span class="sourceLineNo">353</span> <a name="line.353"></a>
<span class="sourceLineNo">354</span> otherListeners.add(listener);<a name="line.354"></a>
<span class="sourceLineNo">355</span> }<a name="line.355"></a>
<span class="sourceLineNo">356</span> }<a name="line.356"></a>
<span class="sourceLineNo">357</span> }<a name="line.357"></a>
<span class="sourceLineNo">358</span> <a name="line.358"></a>
<span class="sourceLineNo">359</span> return this;<a name="line.359"></a>
<span class="sourceLineNo">360</span> }<a name="line.360"></a>
<span class="sourceLineNo">361</span><a name="line.361"></a>
<span class="sourceLineNo">362</span> /**<a name="line.362"></a>
<span class="sourceLineNo">363</span> * {@inheritDoc}<a name="line.363"></a>
<span class="sourceLineNo">364</span> */<a name="line.364"></a>
<span class="sourceLineNo">365</span> public IoFuture removeListener(IoFutureListener&lt;?&gt; listener) {<a name="line.365"></a>
<span class="sourceLineNo">366</span> if (listener == null) {<a name="line.366"></a>
<span class="sourceLineNo">367</span> throw new IllegalArgumentException("listener");<a name="line.367"></a>
<span class="sourceLineNo">368</span> }<a name="line.368"></a>
<span class="sourceLineNo">369</span><a name="line.369"></a>
<span class="sourceLineNo">370</span> synchronized (lock) {<a name="line.370"></a>
<span class="sourceLineNo">371</span> if (!ready) {<a name="line.371"></a>
<span class="sourceLineNo">372</span> if (listener == firstListener) {<a name="line.372"></a>
<span class="sourceLineNo">373</span> if ((otherListeners != null) &amp;&amp; !otherListeners.isEmpty()) {<a name="line.373"></a>
<span class="sourceLineNo">374</span> firstListener = otherListeners.remove(0);<a name="line.374"></a>
<span class="sourceLineNo">375</span> } else {<a name="line.375"></a>
<span class="sourceLineNo">376</span> firstListener = null;<a name="line.376"></a>
<span class="sourceLineNo">377</span> }<a name="line.377"></a>
<span class="sourceLineNo">378</span> } else if (otherListeners != null) {<a name="line.378"></a>
<span class="sourceLineNo">379</span> otherListeners.remove(listener);<a name="line.379"></a>
<span class="sourceLineNo">380</span> }<a name="line.380"></a>
<span class="sourceLineNo">381</span> }<a name="line.381"></a>
<span class="sourceLineNo">382</span> }<a name="line.382"></a>
<span class="sourceLineNo">383</span><a name="line.383"></a>
<span class="sourceLineNo">384</span> return this;<a name="line.384"></a>
<span class="sourceLineNo">385</span> }<a name="line.385"></a>
<span class="sourceLineNo">386</span><a name="line.386"></a>
<span class="sourceLineNo">387</span> /**<a name="line.387"></a>
<span class="sourceLineNo">388</span> * Notify the listeners, if we have some.<a name="line.388"></a>
<span class="sourceLineNo">389</span> */<a name="line.389"></a>
<span class="sourceLineNo">390</span> private void notifyListeners() {<a name="line.390"></a>
<span class="sourceLineNo">391</span> // There won't be any visibility problem or concurrent modification<a name="line.391"></a>
<span class="sourceLineNo">392</span> // because 'ready' flag will be checked against both addListener and<a name="line.392"></a>
<span class="sourceLineNo">393</span> // removeListener calls.<a name="line.393"></a>
<span class="sourceLineNo">394</span> if (firstListener != null) {<a name="line.394"></a>
<span class="sourceLineNo">395</span> notifyListener(firstListener);<a name="line.395"></a>
<span class="sourceLineNo">396</span> firstListener = null;<a name="line.396"></a>
<span class="sourceLineNo">397</span><a name="line.397"></a>
<span class="sourceLineNo">398</span> if (otherListeners != null) {<a name="line.398"></a>
<span class="sourceLineNo">399</span> for (IoFutureListener&lt;?&gt; listener : otherListeners) {<a name="line.399"></a>
<span class="sourceLineNo">400</span> notifyListener(listener);<a name="line.400"></a>
<span class="sourceLineNo">401</span> }<a name="line.401"></a>
<span class="sourceLineNo">402</span> <a name="line.402"></a>
<span class="sourceLineNo">403</span> otherListeners = null;<a name="line.403"></a>
<span class="sourceLineNo">404</span> }<a name="line.404"></a>
<span class="sourceLineNo">405</span> }<a name="line.405"></a>
<span class="sourceLineNo">406</span> }<a name="line.406"></a>
<span class="sourceLineNo">407</span><a name="line.407"></a>
<span class="sourceLineNo">408</span> @SuppressWarnings("unchecked")<a name="line.408"></a>
<span class="sourceLineNo">409</span> private void notifyListener(IoFutureListener listener) {<a name="line.409"></a>
<span class="sourceLineNo">410</span> try {<a name="line.410"></a>
<span class="sourceLineNo">411</span> listener.operationComplete(this);<a name="line.411"></a>
<span class="sourceLineNo">412</span> } catch (Exception e) {<a name="line.412"></a>
<span class="sourceLineNo">413</span> ExceptionMonitor.getInstance().exceptionCaught(e);<a name="line.413"></a>
<span class="sourceLineNo">414</span> }<a name="line.414"></a>
<span class="sourceLineNo">415</span> }<a name="line.415"></a>
<span class="sourceLineNo">416</span>}<a name="line.416"></a>
</pre>
</div>
</body>
</html>