| <!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.handler.stream;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span><a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.io.IOException;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import java.io.InputStream;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import java.io.OutputStream;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import java.net.SocketTimeoutException;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span><a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.mina.core.buffer.IoBuffer;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.apache.mina.core.service.IoHandler;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import org.apache.mina.core.service.IoHandlerAdapter;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import org.apache.mina.core.session.AttributeKey;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import org.apache.mina.core.session.IdleStatus;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import org.apache.mina.core.session.IoSession;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import org.slf4j.Logger;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span>import org.slf4j.LoggerFactory;<a name="line.34"></a> |
| <span class="sourceLineNo">035</span><a name="line.35"></a> |
| <span class="sourceLineNo">036</span>/**<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * A {@link IoHandler} that adapts asynchronous MINA events to stream I/O.<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * <p><a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * Please extend this class and implement<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * {@link #processStreamIo(IoSession, InputStream, OutputStream)} to<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * execute your stream I/O logic; <b>please note that you must forward<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * the process request to other thread or thread pool.</b><a name="line.42"></a> |
| <span class="sourceLineNo">043</span> *<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * @author <a href="http://mina.apache.org">Apache MINA Project</a><a name="line.44"></a> |
| <span class="sourceLineNo">045</span> */<a name="line.45"></a> |
| <span class="sourceLineNo">046</span>public abstract class StreamIoHandler extends IoHandlerAdapter {<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> private final static Logger LOGGER = LoggerFactory.getLogger(StreamIoHandler.class);<a name="line.47"></a> |
| <span class="sourceLineNo">048</span><a name="line.48"></a> |
| <span class="sourceLineNo">049</span> private static final AttributeKey KEY_IN = new AttributeKey(StreamIoHandler.class, "in");<a name="line.49"></a> |
| <span class="sourceLineNo">050</span><a name="line.50"></a> |
| <span class="sourceLineNo">051</span> private static final AttributeKey KEY_OUT = new AttributeKey(StreamIoHandler.class, "out");<a name="line.51"></a> |
| <span class="sourceLineNo">052</span><a name="line.52"></a> |
| <span class="sourceLineNo">053</span> private int readTimeout;<a name="line.53"></a> |
| <span class="sourceLineNo">054</span><a name="line.54"></a> |
| <span class="sourceLineNo">055</span> private int writeTimeout;<a name="line.55"></a> |
| <span class="sourceLineNo">056</span><a name="line.56"></a> |
| <span class="sourceLineNo">057</span> protected StreamIoHandler() {<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> // Do nothing<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> }<a name="line.59"></a> |
| <span class="sourceLineNo">060</span><a name="line.60"></a> |
| <span class="sourceLineNo">061</span> /**<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> * Implement this method to execute your stream I/O logic;<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> * <b>please note that you must forward the process request to other<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> * thread or thread pool.</b><a name="line.64"></a> |
| <span class="sourceLineNo">065</span> * <a name="line.65"></a> |
| <span class="sourceLineNo">066</span> * @param session The current session<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> * @param in The input stream<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> * @param out The output stream<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> */<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> protected abstract void processStreamIo(IoSession session, InputStream in, OutputStream out);<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> * @return read timeout in seconds.<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> * The default value is <tt>0</tt> (disabled).<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> */<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> public int getReadTimeout() {<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> return readTimeout;<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> * Sets read timeout in seconds.<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> * The default value is <tt>0</tt> (disabled).<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> * @param readTimeout The Read timeout<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> */<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> public void setReadTimeout(int readTimeout) {<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> this.readTimeout = readTimeout;<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> /**<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> * @return write timeout in seconds.<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> * The default value is <tt>0</tt> (disabled).<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> */<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> public int getWriteTimeout() {<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> return writeTimeout;<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> /**<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> * Sets write timeout in seconds.<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> * The default value is <tt>0</tt> (disabled).<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> * <a name="line.100"></a> |
| <span class="sourceLineNo">101</span> * @param writeTimeout The Write timeout<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> */<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> public void setWriteTimeout(int writeTimeout) {<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> this.writeTimeout = writeTimeout;<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> }<a name="line.105"></a> |
| <span class="sourceLineNo">106</span><a name="line.106"></a> |
| <span class="sourceLineNo">107</span> /**<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> * Initializes streams and timeout settings.<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> */<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> @Override<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> public void sessionOpened(IoSession session) {<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> // Set timeouts<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> session.getConfig().setWriteTimeout(writeTimeout);<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> session.getConfig().setIdleTime(IdleStatus.READER_IDLE, readTimeout);<a name="line.114"></a> |
| <span class="sourceLineNo">115</span><a name="line.115"></a> |
| <span class="sourceLineNo">116</span> // Create streams<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> InputStream in = new IoSessionInputStream();<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> OutputStream out = new IoSessionOutputStream(session);<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> session.setAttribute(KEY_IN, in);<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> session.setAttribute(KEY_OUT, out);<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> processStreamIo(session, in, out);<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> }<a name="line.122"></a> |
| <span class="sourceLineNo">123</span><a name="line.123"></a> |
| <span class="sourceLineNo">124</span> /**<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> * Closes streams<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> */<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> @Override<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> public void sessionClosed(IoSession session) throws Exception {<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> final InputStream in = (InputStream) session.getAttribute(KEY_IN);<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> final OutputStream out = (OutputStream) session.getAttribute(KEY_OUT);<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> try {<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> in.close();<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> } finally {<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> out.close();<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><a name="line.137"></a> |
| <span class="sourceLineNo">138</span> /**<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> * Forwards read data to input stream.<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> */<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> @Override<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> public void messageReceived(IoSession session, Object buf) {<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> final IoSessionInputStream in = (IoSessionInputStream) session.getAttribute(KEY_IN);<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> in.write((IoBuffer) buf);<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> }<a name="line.145"></a> |
| <span class="sourceLineNo">146</span><a name="line.146"></a> |
| <span class="sourceLineNo">147</span> /**<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> * Forwards caught exceptions to input stream.<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> */<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> @Override<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> public void exceptionCaught(IoSession session, Throwable cause) {<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> final IoSessionInputStream in = (IoSessionInputStream) session.getAttribute(KEY_IN);<a name="line.152"></a> |
| <span class="sourceLineNo">153</span><a name="line.153"></a> |
| <span class="sourceLineNo">154</span> IOException e = null;<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> if (cause instanceof StreamIoException) {<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> e = (IOException) cause.getCause();<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> } else if (cause instanceof IOException) {<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> e = (IOException) cause;<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> if (e != null && in != null) {<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> in.throwException(e);<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> } else {<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> LOGGER.warn("Unexpected exception.", cause);<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> session.close(true);<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> }<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> }<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> * Handles read timeout.<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> */<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> @Override<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> public void sessionIdle(IoSession session, IdleStatus status) {<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> if (status == IdleStatus.READER_IDLE) {<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> throw new StreamIoException(new SocketTimeoutException("Read timeout"));<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> }<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> }<a name="line.177"></a> |
| <span class="sourceLineNo">178</span><a name="line.178"></a> |
| <span class="sourceLineNo">179</span> private static class StreamIoException extends RuntimeException {<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> private static final long serialVersionUID = 3976736960742503222L;<a name="line.180"></a> |
| <span class="sourceLineNo">181</span><a name="line.181"></a> |
| <span class="sourceLineNo">182</span> public StreamIoException(IOException cause) {<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> super(cause);<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> }<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> }<a name="line.185"></a> |
| <span class="sourceLineNo">186</span>}<a name="line.186"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |