| <!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.filterchain;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span><a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.util.List;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span><a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.apache.mina.core.filterchain.IoFilter.NextFilter;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.mina.core.service.IoHandler;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.mina.core.session.IdleStatus;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.mina.core.session.IoSession;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.apache.mina.core.write.WriteRequest;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span><a name="line.29"></a> |
| <span class="sourceLineNo">030</span>/**<a name="line.30"></a> |
| <span class="sourceLineNo">031</span> * A container of {@link IoFilter}s that forwards {@link IoHandler} events<a name="line.31"></a> |
| <span class="sourceLineNo">032</span> * to the consisting filters and terminal {@link IoHandler} sequentially.<a name="line.32"></a> |
| <span class="sourceLineNo">033</span> * Every {@link IoSession} has its own {@link IoFilterChain} (1-to-1 relationship).<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> *<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * @author <a href="http://mina.apache.org">Apache MINA Project</a><a name="line.35"></a> |
| <span class="sourceLineNo">036</span> */<a name="line.36"></a> |
| <span class="sourceLineNo">037</span>public interface IoFilterChain {<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> /**<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * Returns the parent {@link IoSession} of this chain.<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * <a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * @return {@link IoSession}<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> */<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> IoSession getSession();<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> * Returns the {@link Entry} with the specified <tt>name</tt> in this chain.<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * <a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * @param name The filter's name we are looking for<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * @return <tt>null</tt> if there's no such name in this chain<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> */<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> Entry getEntry(String name);<a name="line.51"></a> |
| <span class="sourceLineNo">052</span><a name="line.52"></a> |
| <span class="sourceLineNo">053</span> /**<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * Returns the {@link Entry} with the specified <tt>filter</tt> in this chain.<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * <a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * @param filter The Filter we are looking for<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * @return <tt>null</tt> if there's no such filter in this chain<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> */<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> Entry getEntry(IoFilter filter);<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> * Returns the {@link Entry} with the specified <tt>filterType</tt><a name="line.62"></a> |
| <span class="sourceLineNo">063</span> * in this chain. If there's more than one filter with the specified<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> * type, the first match will be chosen.<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> * <a name="line.65"></a> |
| <span class="sourceLineNo">066</span> * @param filterType The filter class we are looking for<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> * @return <tt>null</tt> if there's no such name in this chain<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> */<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> Entry getEntry(Class<? extends IoFilter> filterType);<a name="line.69"></a> |
| <span class="sourceLineNo">070</span><a name="line.70"></a> |
| <span class="sourceLineNo">071</span> /**<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> * Returns the {@link IoFilter} with the specified <tt>name</tt> in this chain.<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> * <a name="line.73"></a> |
| <span class="sourceLineNo">074</span> * @param name the filter's name<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> * @return <tt>null</tt> if there's no such name in this chain<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> */<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> IoFilter get(String name);<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> * Returns the {@link IoFilter} with the specified <tt>filterType</tt><a name="line.80"></a> |
| <span class="sourceLineNo">081</span> * in this chain. If there's more than one filter with the specified<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> * type, the first match will be chosen.<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> * <a name="line.83"></a> |
| <span class="sourceLineNo">084</span> * @param filterType The filter class<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> * @return <tt>null</tt> if there's no such name in this chain<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> */<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> IoFilter get(Class<? extends IoFilter> filterType);<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> * Returns the {@link NextFilter} of the {@link IoFilter} with the<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> * specified <tt>name</tt> in this chain.<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> * <a name="line.92"></a> |
| <span class="sourceLineNo">093</span> * @param name The filter's name we want the next filter<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> * @return <tt>null</tt> if there's no such name in this chain<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> */<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> NextFilter getNextFilter(String name);<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> * Returns the {@link NextFilter} of the specified {@link IoFilter}<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> * in this chain.<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> * <a name="line.101"></a> |
| <span class="sourceLineNo">102</span> * @param filter The filter for which we want the next filter<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> * @return <tt>null</tt> if there's no such name in this chain<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> */<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> NextFilter getNextFilter(IoFilter filter);<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> * Returns the {@link NextFilter} of the specified <tt>filterType</tt><a name="line.108"></a> |
| <span class="sourceLineNo">109</span> * in this chain. If there's more than one filter with the specified<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> * type, the first match will be chosen.<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> * <a name="line.111"></a> |
| <span class="sourceLineNo">112</span> * @param filterType The Filter class for which we want the next filter<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> * @return <tt>null</tt> if there's no such name in this chain<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> */<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> NextFilter getNextFilter(Class<? extends IoFilter> filterType);<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> * @return The list of all {@link Entry}s this chain contains.<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> */<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> List<Entry> getAll();<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> * @return The reversed list of all {@link Entry}s this chain contains.<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> */<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> List<Entry> getAllReversed();<a name="line.125"></a> |
| <span class="sourceLineNo">126</span><a name="line.126"></a> |
| <span class="sourceLineNo">127</span> /**<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> * @param name The filter's name we are looking for<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> * <a name="line.129"></a> |
| <span class="sourceLineNo">130</span> * @return <tt>true</tt> if this chain contains an {@link IoFilter} with the<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> * specified <tt>name</tt>.<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> */<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> boolean contains(String name);<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> * @param filter The filter we are looking for<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> * <a name="line.137"></a> |
| <span class="sourceLineNo">138</span> * @return <tt>true</tt> if this chain contains the specified <tt>filter</tt>.<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> */<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> boolean contains(IoFilter filter);<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> * @param filterType The filter's class we are looking for<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> * <a name="line.144"></a> |
| <span class="sourceLineNo">145</span> * @return <tt>true</tt> if this chain contains an {@link IoFilter} of the<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> * specified <tt>filterType</tt>.<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> */<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> boolean contains(Class<? extends IoFilter> filterType);<a name="line.148"></a> |
| <span class="sourceLineNo">149</span><a name="line.149"></a> |
| <span class="sourceLineNo">150</span> /**<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> * Adds the specified filter with the specified name at the beginning of this chain.<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> * <a name="line.152"></a> |
| <span class="sourceLineNo">153</span> * @param name The filter's name<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> * @param filter The filter to add<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> */<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> void addFirst(String name, IoFilter filter);<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> * Adds the specified filter with the specified name at the end of this chain.<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> * <a name="line.160"></a> |
| <span class="sourceLineNo">161</span> * @param name The filter's name<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> * @param filter The filter to add<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> */<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> void addLast(String name, IoFilter filter);<a name="line.164"></a> |
| <span class="sourceLineNo">165</span><a name="line.165"></a> |
| <span class="sourceLineNo">166</span> /**<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> * Adds the specified filter with the specified name just before the filter whose name is<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> * <code>baseName</code> in this chain.<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> * <a name="line.169"></a> |
| <span class="sourceLineNo">170</span> * @param baseName The targeted Filter's name<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> * @param name The filter's name<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> * @param filter The filter to add<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> */<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> void addBefore(String baseName, String name, IoFilter filter);<a name="line.174"></a> |
| <span class="sourceLineNo">175</span><a name="line.175"></a> |
| <span class="sourceLineNo">176</span> /**<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> * Adds the specified filter with the specified name just after the filter whose name is<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> * <code>baseName</code> in this chain.<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> * <a name="line.179"></a> |
| <span class="sourceLineNo">180</span> * @param baseName The targeted Filter's name<a name="line.180"></a> |
| <span class="sourceLineNo">181</span> * @param name The filter's name<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> * @param filter The filter to add<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> */<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> void addAfter(String baseName, String name, IoFilter filter);<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> |
| <span class="sourceLineNo">187</span> * Replace the filter with the specified name with the specified new<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> * filter.<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> *<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> * @param name The name of the filter we want to replace<a name="line.190"></a> |
| <span class="sourceLineNo">191</span> * @param newFilter The new filter<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> * @return the old filter<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> */<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> IoFilter replace(String name, IoFilter newFilter);<a name="line.194"></a> |
| <span class="sourceLineNo">195</span><a name="line.195"></a> |
| <span class="sourceLineNo">196</span> /**<a name="line.196"></a> |
| <span class="sourceLineNo">197</span> * Replace the filter with the specified name with the specified new<a name="line.197"></a> |
| <span class="sourceLineNo">198</span> * filter.<a name="line.198"></a> |
| <span class="sourceLineNo">199</span> *<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> * @param oldFilter The filter we want to replace<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> * @param newFilter The new filter<a name="line.201"></a> |
| <span class="sourceLineNo">202</span> */<a name="line.202"></a> |
| <span class="sourceLineNo">203</span> void replace(IoFilter oldFilter, IoFilter newFilter);<a name="line.203"></a> |
| <span class="sourceLineNo">204</span><a name="line.204"></a> |
| <span class="sourceLineNo">205</span> /**<a name="line.205"></a> |
| <span class="sourceLineNo">206</span> * Replace the filter of the specified type with the specified new<a name="line.206"></a> |
| <span class="sourceLineNo">207</span> * filter. If there's more than one filter with the specified type,<a name="line.207"></a> |
| <span class="sourceLineNo">208</span> * the first match will be replaced.<a name="line.208"></a> |
| <span class="sourceLineNo">209</span> *<a name="line.209"></a> |
| <span class="sourceLineNo">210</span> * @param oldFilterType The filter class we want to replace<a name="line.210"></a> |
| <span class="sourceLineNo">211</span> * @param newFilter The new filter<a name="line.211"></a> |
| <span class="sourceLineNo">212</span> */<a name="line.212"></a> |
| <span class="sourceLineNo">213</span> IoFilter replace(Class<? extends IoFilter> oldFilterType, IoFilter newFilter);<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> * Removes the filter with the specified name from this chain.<a name="line.216"></a> |
| <span class="sourceLineNo">217</span> * <a name="line.217"></a> |
| <span class="sourceLineNo">218</span> * @param name The name of the filter to remove<a name="line.218"></a> |
| <span class="sourceLineNo">219</span> * @return The removed filter<a name="line.219"></a> |
| <span class="sourceLineNo">220</span> */<a name="line.220"></a> |
| <span class="sourceLineNo">221</span> IoFilter remove(String name);<a name="line.221"></a> |
| <span class="sourceLineNo">222</span><a name="line.222"></a> |
| <span class="sourceLineNo">223</span> /**<a name="line.223"></a> |
| <span class="sourceLineNo">224</span> * Replace the filter with the specified name with the specified new filter.<a name="line.224"></a> |
| <span class="sourceLineNo">225</span> * <a name="line.225"></a> |
| <span class="sourceLineNo">226</span> * @param filter<a name="line.226"></a> |
| <span class="sourceLineNo">227</span> * The filter to remove<a name="line.227"></a> |
| <span class="sourceLineNo">228</span> */<a name="line.228"></a> |
| <span class="sourceLineNo">229</span> void remove(IoFilter filter);<a name="line.229"></a> |
| <span class="sourceLineNo">230</span><a name="line.230"></a> |
| <span class="sourceLineNo">231</span> /**<a name="line.231"></a> |
| <span class="sourceLineNo">232</span> * Replace the filter of the specified type with the specified new filter.<a name="line.232"></a> |
| <span class="sourceLineNo">233</span> * If there's more than one filter with the specified type, the first match<a name="line.233"></a> |
| <span class="sourceLineNo">234</span> * will be replaced.<a name="line.234"></a> |
| <span class="sourceLineNo">235</span> * <a name="line.235"></a> |
| <span class="sourceLineNo">236</span> * @param filterType<a name="line.236"></a> |
| <span class="sourceLineNo">237</span> * The filter class to remove<a name="line.237"></a> |
| <span class="sourceLineNo">238</span> * @return The removed filter<a name="line.238"></a> |
| <span class="sourceLineNo">239</span> */<a name="line.239"></a> |
| <span class="sourceLineNo">240</span> IoFilter remove(Class<? extends IoFilter> filterType);<a name="line.240"></a> |
| <span class="sourceLineNo">241</span><a name="line.241"></a> |
| <span class="sourceLineNo">242</span> /**<a name="line.242"></a> |
| <span class="sourceLineNo">243</span> * Removes all filters added to this chain.<a name="line.243"></a> |
| <span class="sourceLineNo">244</span> */<a name="line.244"></a> |
| <span class="sourceLineNo">245</span> void clear() throws Exception;<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> * Fires a {@link IoHandler#sessionCreated(IoSession)} event. Most users don't need to<a name="line.248"></a> |
| <span class="sourceLineNo">249</span> * call this method at all. Please use this method only when you implement a new transport<a name="line.249"></a> |
| <span class="sourceLineNo">250</span> * or fire a virtual event.<a name="line.250"></a> |
| <span class="sourceLineNo">251</span> */<a name="line.251"></a> |
| <span class="sourceLineNo">252</span> public void fireSessionCreated();<a name="line.252"></a> |
| <span class="sourceLineNo">253</span><a name="line.253"></a> |
| <span class="sourceLineNo">254</span> /**<a name="line.254"></a> |
| <span class="sourceLineNo">255</span> * Fires a {@link IoHandler#sessionOpened(IoSession)} event. Most users don't need to call<a name="line.255"></a> |
| <span class="sourceLineNo">256</span> * this method at all. Please use this method only when you implement a new transport or<a name="line.256"></a> |
| <span class="sourceLineNo">257</span> * fire a virtual event.<a name="line.257"></a> |
| <span class="sourceLineNo">258</span> */<a name="line.258"></a> |
| <span class="sourceLineNo">259</span> public void fireSessionOpened();<a name="line.259"></a> |
| <span class="sourceLineNo">260</span><a name="line.260"></a> |
| <span class="sourceLineNo">261</span> /**<a name="line.261"></a> |
| <span class="sourceLineNo">262</span> * Fires a {@link IoHandler#sessionClosed(IoSession)} event. Most users don't need to call<a name="line.262"></a> |
| <span class="sourceLineNo">263</span> * this method at all. Please use this method only when you implement a new transport or<a name="line.263"></a> |
| <span class="sourceLineNo">264</span> * fire a virtual event.<a name="line.264"></a> |
| <span class="sourceLineNo">265</span> */<a name="line.265"></a> |
| <span class="sourceLineNo">266</span> public void fireSessionClosed();<a name="line.266"></a> |
| <span class="sourceLineNo">267</span><a name="line.267"></a> |
| <span class="sourceLineNo">268</span> /**<a name="line.268"></a> |
| <span class="sourceLineNo">269</span> * Fires a {@link IoHandler#sessionIdle(IoSession, IdleStatus)} event. Most users don't<a name="line.269"></a> |
| <span class="sourceLineNo">270</span> * need to call this method at all. Please use this method only when you implement a new<a name="line.270"></a> |
| <span class="sourceLineNo">271</span> * transport or fire a virtual event.<a name="line.271"></a> |
| <span class="sourceLineNo">272</span> * <a name="line.272"></a> |
| <span class="sourceLineNo">273</span> * @param status The current status to propagate<a name="line.273"></a> |
| <span class="sourceLineNo">274</span> */<a name="line.274"></a> |
| <span class="sourceLineNo">275</span> public void fireSessionIdle(IdleStatus status);<a name="line.275"></a> |
| <span class="sourceLineNo">276</span><a name="line.276"></a> |
| <span class="sourceLineNo">277</span> /**<a name="line.277"></a> |
| <span class="sourceLineNo">278</span> * Fires a {@link IoHandler#messageReceived(IoSession, Object)} event. Most<a name="line.278"></a> |
| <span class="sourceLineNo">279</span> * users don't need to call this method at all. Please use this method only<a name="line.279"></a> |
| <span class="sourceLineNo">280</span> * when you implement a new transport or fire a virtual event.<a name="line.280"></a> |
| <span class="sourceLineNo">281</span> * <a name="line.281"></a> |
| <span class="sourceLineNo">282</span> * @param message<a name="line.282"></a> |
| <span class="sourceLineNo">283</span> * The received message<a name="line.283"></a> |
| <span class="sourceLineNo">284</span> */<a name="line.284"></a> |
| <span class="sourceLineNo">285</span> public void fireMessageReceived(Object message);<a name="line.285"></a> |
| <span class="sourceLineNo">286</span><a name="line.286"></a> |
| <span class="sourceLineNo">287</span> /**<a name="line.287"></a> |
| <span class="sourceLineNo">288</span> * Fires a {@link IoHandler#messageSent(IoSession, Object)} event. Most<a name="line.288"></a> |
| <span class="sourceLineNo">289</span> * users don't need to call this method at all. Please use this method only<a name="line.289"></a> |
| <span class="sourceLineNo">290</span> * when you implement a new transport or fire a virtual event.<a name="line.290"></a> |
| <span class="sourceLineNo">291</span> * <a name="line.291"></a> |
| <span class="sourceLineNo">292</span> * @param request<a name="line.292"></a> |
| <span class="sourceLineNo">293</span> * The sent request<a name="line.293"></a> |
| <span class="sourceLineNo">294</span> */<a name="line.294"></a> |
| <span class="sourceLineNo">295</span> public void fireMessageSent(WriteRequest request);<a name="line.295"></a> |
| <span class="sourceLineNo">296</span><a name="line.296"></a> |
| <span class="sourceLineNo">297</span> /**<a name="line.297"></a> |
| <span class="sourceLineNo">298</span> * Fires a {@link IoHandler#exceptionCaught(IoSession, Throwable)} event. Most users don't<a name="line.298"></a> |
| <span class="sourceLineNo">299</span> * need to call this method at all. Please use this method only when you implement a new<a name="line.299"></a> |
| <span class="sourceLineNo">300</span> * transport or fire a virtual event.<a name="line.300"></a> |
| <span class="sourceLineNo">301</span> * <a name="line.301"></a> |
| <span class="sourceLineNo">302</span> * @param cause The exception cause<a name="line.302"></a> |
| <span class="sourceLineNo">303</span> */<a name="line.303"></a> |
| <span class="sourceLineNo">304</span> public void fireExceptionCaught(Throwable cause);<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> * Fires a {@link IoHandler#inputClosed(IoSession)} event. Most users don't<a name="line.307"></a> |
| <span class="sourceLineNo">308</span> * need to call this method at all. Please use this method only when you<a name="line.308"></a> |
| <span class="sourceLineNo">309</span> * implement a new transport or fire a virtual event.<a name="line.309"></a> |
| <span class="sourceLineNo">310</span> */<a name="line.310"></a> |
| <span class="sourceLineNo">311</span> public void fireInputClosed();<a name="line.311"></a> |
| <span class="sourceLineNo">312</span><a name="line.312"></a> |
| <span class="sourceLineNo">313</span> /**<a name="line.313"></a> |
| <span class="sourceLineNo">314</span> * Fires a {@link IoSession#write(Object)} event. Most users don't need to<a name="line.314"></a> |
| <span class="sourceLineNo">315</span> * call this method at all. Please use this method only when you implement a<a name="line.315"></a> |
| <span class="sourceLineNo">316</span> * new transport or fire a virtual event.<a name="line.316"></a> |
| <span class="sourceLineNo">317</span> * <a name="line.317"></a> |
| <span class="sourceLineNo">318</span> * @param writeRequest<a name="line.318"></a> |
| <span class="sourceLineNo">319</span> * The message to write<a name="line.319"></a> |
| <span class="sourceLineNo">320</span> */<a name="line.320"></a> |
| <span class="sourceLineNo">321</span> public void fireFilterWrite(WriteRequest writeRequest);<a name="line.321"></a> |
| <span class="sourceLineNo">322</span><a name="line.322"></a> |
| <span class="sourceLineNo">323</span> /**<a name="line.323"></a> |
| <span class="sourceLineNo">324</span> * Fires a {@link IoSession#close(boolean)} event. Most users don't need to call this method at<a name="line.324"></a> |
| <span class="sourceLineNo">325</span> * all. Please use this method only when you implement a new transport or fire a virtual<a name="line.325"></a> |
| <span class="sourceLineNo">326</span> * event.<a name="line.326"></a> |
| <span class="sourceLineNo">327</span> */<a name="line.327"></a> |
| <span class="sourceLineNo">328</span> public void fireFilterClose();<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> * Represents a name-filter pair that an {@link IoFilterChain} contains.<a name="line.331"></a> |
| <span class="sourceLineNo">332</span> *<a name="line.332"></a> |
| <span class="sourceLineNo">333</span> * @author <a href="http://mina.apache.org">Apache MINA Project</a><a name="line.333"></a> |
| <span class="sourceLineNo">334</span> */<a name="line.334"></a> |
| <span class="sourceLineNo">335</span> public interface Entry {<a name="line.335"></a> |
| <span class="sourceLineNo">336</span> /**<a name="line.336"></a> |
| <span class="sourceLineNo">337</span> * Returns the name of the filter.<a name="line.337"></a> |
| <span class="sourceLineNo">338</span> */<a name="line.338"></a> |
| <span class="sourceLineNo">339</span> String getName();<a name="line.339"></a> |
| <span class="sourceLineNo">340</span><a name="line.340"></a> |
| <span class="sourceLineNo">341</span> /**<a name="line.341"></a> |
| <span class="sourceLineNo">342</span> * Returns the filter.<a name="line.342"></a> |
| <span class="sourceLineNo">343</span> */<a name="line.343"></a> |
| <span class="sourceLineNo">344</span> IoFilter getFilter();<a name="line.344"></a> |
| <span class="sourceLineNo">345</span><a name="line.345"></a> |
| <span class="sourceLineNo">346</span> /**<a name="line.346"></a> |
| <span class="sourceLineNo">347</span> * @return The {@link NextFilter} of the filter.<a name="line.347"></a> |
| <span class="sourceLineNo">348</span> */<a name="line.348"></a> |
| <span class="sourceLineNo">349</span> NextFilter getNextFilter();<a name="line.349"></a> |
| <span class="sourceLineNo">350</span><a name="line.350"></a> |
| <span class="sourceLineNo">351</span> /**<a name="line.351"></a> |
| <span class="sourceLineNo">352</span> * Adds the specified filter with the specified name just before this entry.<a name="line.352"></a> |
| <span class="sourceLineNo">353</span> */<a name="line.353"></a> |
| <span class="sourceLineNo">354</span> void addBefore(String name, IoFilter filter);<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> * Adds the specified filter with the specified name just after this entry.<a name="line.357"></a> |
| <span class="sourceLineNo">358</span> */<a name="line.358"></a> |
| <span class="sourceLineNo">359</span> void addAfter(String name, IoFilter filter);<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> * Replace the filter of this entry with the specified new filter.<a name="line.362"></a> |
| <span class="sourceLineNo">363</span> */<a name="line.363"></a> |
| <span class="sourceLineNo">364</span> void replace(IoFilter newFilter);<a name="line.364"></a> |
| <span class="sourceLineNo">365</span><a name="line.365"></a> |
| <span class="sourceLineNo">366</span> /**<a name="line.366"></a> |
| <span class="sourceLineNo">367</span> * Removes this entry from the chain it belongs to.<a name="line.367"></a> |
| <span class="sourceLineNo">368</span> */<a name="line.368"></a> |
| <span class="sourceLineNo">369</span> void remove();<a name="line.369"></a> |
| <span class="sourceLineNo">370</span> }<a name="line.370"></a> |
| <span class="sourceLineNo">371</span>}<a name="line.371"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
