| <!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.filter.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.util.Queue;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import java.util.concurrent.ConcurrentLinkedQueue;<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.buffer.IoBuffer;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.mina.core.filterchain.IoFilterAdapter;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.apache.mina.core.filterchain.IoFilterChain;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import org.apache.mina.core.session.AttributeKey;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import org.apache.mina.core.session.IoSession;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import org.apache.mina.core.write.DefaultWriteRequest;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import org.apache.mina.core.write.WriteRequest;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span><a name="line.33"></a> |
| <span class="sourceLineNo">034</span>/**<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * TODO Add documentation<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * <a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * @author <a href="http://mina.apache.org">Apache MINA Project</a><a name="line.37"></a> |
| <span class="sourceLineNo">038</span> */<a name="line.38"></a> |
| <span class="sourceLineNo">039</span>public abstract class AbstractStreamWriteFilter<T> extends IoFilterAdapter {<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> /**<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * The default buffer size this filter uses for writing.<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> */<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> public static final int DEFAULT_STREAM_BUFFER_SIZE = 4096;<a name="line.43"></a> |
| <span class="sourceLineNo">044</span><a name="line.44"></a> |
| <span class="sourceLineNo">045</span> /**<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * The attribute name used when binding the streaming object to the session.<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> */<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> protected final AttributeKey CURRENT_STREAM = new AttributeKey(getClass(), "stream");<a name="line.48"></a> |
| <span class="sourceLineNo">049</span><a name="line.49"></a> |
| <span class="sourceLineNo">050</span> protected final AttributeKey WRITE_REQUEST_QUEUE = new AttributeKey(getClass(), "queue");<a name="line.50"></a> |
| <span class="sourceLineNo">051</span><a name="line.51"></a> |
| <span class="sourceLineNo">052</span> protected final AttributeKey CURRENT_WRITE_REQUEST = new AttributeKey(getClass(), "writeRequest");<a name="line.52"></a> |
| <span class="sourceLineNo">053</span><a name="line.53"></a> |
| <span class="sourceLineNo">054</span> private int writeBufferSize = DEFAULT_STREAM_BUFFER_SIZE;<a name="line.54"></a> |
| <span class="sourceLineNo">055</span><a name="line.55"></a> |
| <span class="sourceLineNo">056</span> @Override<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> public void onPreAdd(IoFilterChain parent, String name, NextFilter nextFilter) throws Exception {<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> Class<? extends IoFilterAdapter> clazz = getClass();<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> if (parent.contains(clazz)) {<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> throw new IllegalStateException("Only one " + clazz.getName() + " is permitted.");<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> }<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> @Override<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> public void filterWrite(NextFilter nextFilter, IoSession session, WriteRequest writeRequest) throws Exception {<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> // If we're already processing a stream we need to queue the WriteRequest.<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> if (session.getAttribute(CURRENT_STREAM) != null) {<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> Queue<WriteRequest> queue = getWriteRequestQueue(session);<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> if (queue == null) {<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> queue = new ConcurrentLinkedQueue<WriteRequest>();<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> session.setAttribute(WRITE_REQUEST_QUEUE, queue);<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> }<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> queue.add(writeRequest);<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> return;<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> }<a name="line.75"></a> |
| <span class="sourceLineNo">076</span><a name="line.76"></a> |
| <span class="sourceLineNo">077</span> Object message = writeRequest.getMessage();<a name="line.77"></a> |
| <span class="sourceLineNo">078</span><a name="line.78"></a> |
| <span class="sourceLineNo">079</span> if (getMessageClass().isInstance(message)) {<a name="line.79"></a> |
| <span class="sourceLineNo">080</span><a name="line.80"></a> |
| <span class="sourceLineNo">081</span> T stream = getMessageClass().cast(message);<a name="line.81"></a> |
| <span class="sourceLineNo">082</span><a name="line.82"></a> |
| <span class="sourceLineNo">083</span> IoBuffer buffer = getNextBuffer(stream);<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> if (buffer == null) {<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> // End of stream reached.<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> writeRequest.getFuture().setWritten();<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> nextFilter.messageSent(session, writeRequest);<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> } else {<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> session.setAttribute(CURRENT_STREAM, message);<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> session.setAttribute(CURRENT_WRITE_REQUEST, writeRequest);<a name="line.90"></a> |
| <span class="sourceLineNo">091</span><a name="line.91"></a> |
| <span class="sourceLineNo">092</span> nextFilter.filterWrite(session, new DefaultWriteRequest(buffer));<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> }<a name="line.93"></a> |
| <span class="sourceLineNo">094</span><a name="line.94"></a> |
| <span class="sourceLineNo">095</span> } else {<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> nextFilter.filterWrite(session, writeRequest);<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> }<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> }<a name="line.98"></a> |
| <span class="sourceLineNo">099</span><a name="line.99"></a> |
| <span class="sourceLineNo">100</span> abstract protected Class<T> getMessageClass();<a name="line.100"></a> |
| <span class="sourceLineNo">101</span><a name="line.101"></a> |
| <span class="sourceLineNo">102</span> @SuppressWarnings("unchecked")<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> private Queue<WriteRequest> getWriteRequestQueue(IoSession session) {<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> return (Queue<WriteRequest>) session.getAttribute(WRITE_REQUEST_QUEUE);<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> @SuppressWarnings("unchecked")<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> private Queue<WriteRequest> removeWriteRequestQueue(IoSession session) {<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> return (Queue<WriteRequest>) session.removeAttribute(WRITE_REQUEST_QUEUE);<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> }<a name="line.110"></a> |
| <span class="sourceLineNo">111</span><a name="line.111"></a> |
| <span class="sourceLineNo">112</span> @Override<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> public void messageSent(NextFilter nextFilter, IoSession session, WriteRequest writeRequest) throws Exception {<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> T stream = getMessageClass().cast(session.getAttribute(CURRENT_STREAM));<a name="line.114"></a> |
| <span class="sourceLineNo">115</span><a name="line.115"></a> |
| <span class="sourceLineNo">116</span> if (stream == null) {<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> nextFilter.messageSent(session, writeRequest);<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> } else {<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> IoBuffer buffer = getNextBuffer(stream);<a name="line.119"></a> |
| <span class="sourceLineNo">120</span><a name="line.120"></a> |
| <span class="sourceLineNo">121</span> if (buffer == null) {<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> // End of stream reached.<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> session.removeAttribute(CURRENT_STREAM);<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> WriteRequest currentWriteRequest = (WriteRequest) session.removeAttribute(CURRENT_WRITE_REQUEST);<a name="line.124"></a> |
| <span class="sourceLineNo">125</span><a name="line.125"></a> |
| <span class="sourceLineNo">126</span> // Write queued WriteRequests.<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> Queue<WriteRequest> queue = removeWriteRequestQueue(session);<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> if (queue != null) {<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> WriteRequest wr = queue.poll();<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> while (wr != null) {<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> filterWrite(nextFilter, session, wr);<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> wr = queue.poll();<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> }<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> currentWriteRequest.getFuture().setWritten();<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> nextFilter.messageSent(session, currentWriteRequest);<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> } else {<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> nextFilter.filterWrite(session, new DefaultWriteRequest(buffer));<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> }<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> }<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> }<a name="line.142"></a> |
| <span class="sourceLineNo">143</span><a name="line.143"></a> |
| <span class="sourceLineNo">144</span> /**<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> * @return the size of the write buffer in bytes. Data will be read from the<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> * stream in chunks of this size and then written to the next filter.<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> */<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> public int getWriteBufferSize() {<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> return writeBufferSize;<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> }<a name="line.150"></a> |
| <span class="sourceLineNo">151</span><a name="line.151"></a> |
| <span class="sourceLineNo">152</span> /**<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> * Sets the size of the write buffer in bytes. Data will be read from the<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> * stream in chunks of this size and then written to the next filter.<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> *<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> * @param writeBufferSize The size of the write buffer<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> * @throws IllegalArgumentException if the specified size is &lt; 1.<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> */<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> public void setWriteBufferSize(int writeBufferSize) {<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> if (writeBufferSize < 1) {<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> throw new IllegalArgumentException("writeBufferSize must be at least 1");<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> }<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> this.writeBufferSize = writeBufferSize;<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> }<a name="line.164"></a> |
| <span class="sourceLineNo">165</span><a name="line.165"></a> |
| <span class="sourceLineNo">166</span> abstract protected IoBuffer getNextBuffer(T message) throws IOException;<a name="line.166"></a> |
| <span class="sourceLineNo">167</span>}<a name="line.167"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
