| <!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.session;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span><a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.net.SocketAddress;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import java.util.Set;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span><a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.mina.core.filterchain.IoFilter;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.mina.core.filterchain.IoFilterChain;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.mina.core.future.CloseFuture;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.apache.mina.core.future.ReadFuture;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import org.apache.mina.core.future.WriteFuture;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import org.apache.mina.core.service.IoAcceptor;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import org.apache.mina.core.service.IoConnector;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import org.apache.mina.core.service.IoHandler;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import org.apache.mina.core.service.IoService;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span>import org.apache.mina.core.service.TransportMetadata;<a name="line.34"></a> |
| <span class="sourceLineNo">035</span>import org.apache.mina.core.write.WriteRequest;<a name="line.35"></a> |
| <span class="sourceLineNo">036</span>import org.apache.mina.core.write.WriteRequestQueue;<a name="line.36"></a> |
| <span class="sourceLineNo">037</span><a name="line.37"></a> |
| <span class="sourceLineNo">038</span>/**<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * <p><a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * A handle which represents connection between two end-points regardless of<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * transport types.<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * </p><a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * <p><a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * {@link IoSession} provides user-defined attributes. User-defined attributes<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * are application-specific data which are associated with a session.<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * It often contains objects that represents the state of a higher-level protocol<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * and becomes a way to exchange data between filters and handlers.<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * </p><a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * <h3>Adjusting Transport Type Specific Properties</h3><a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * <p><a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * You can simply downcast the session to an appropriate subclass.<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * </p><a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * <h3>Thread Safety</h3><a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * <p><a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * {@link IoSession} is thread-safe. But please note that performing<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * more than one {@link #write(Object)} calls at the same time will<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * cause the {@link IoFilter#filterWrite(IoFilter.NextFilter,IoSession,WriteRequest)}<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * to be executed simultaneously, and therefore you have to make sure the<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> * {@link IoFilter} implementations you're using are thread-safe, too.<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> * </p><a name="line.60"></a> |
| <span class="sourceLineNo">061</span> * <h3>Equality of Sessions</h3><a name="line.61"></a> |
| <span class="sourceLineNo">062</span> * TODO : The getId() method is totally wrong. We can't base<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> * a method which is designed to create a unique ID on the hashCode method.<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> * {@link Object#equals(Object)} and {@link Object#hashCode()} shall not be overriden<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> * to the default behavior that is defined in {@link Object}.<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> *<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> * @author <a href="http://mina.apache.org">Apache MINA Project</a><a name="line.67"></a> |
| <span class="sourceLineNo">068</span> */<a name="line.68"></a> |
| <span class="sourceLineNo">069</span>public interface IoSession {<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> /**<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> * @return a unique identifier for this session. Every session has its own<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> * ID which is different from each other.<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> * <a name="line.73"></a> |
| <span class="sourceLineNo">074</span> * TODO : The way it's implemented does not guarantee that the contract is<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> * respected. It uses the HashCode() method which don't guarantee the key<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> * unicity.<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> */<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> long getId();<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> * @return the {@link IoService} which provides I/O service to this session.<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> */<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> IoService getService();<a name="line.83"></a> |
| <span class="sourceLineNo">084</span><a name="line.84"></a> |
| <span class="sourceLineNo">085</span> /**<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> * @return the {@link IoHandler} which handles this session.<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> */<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> IoHandler getHandler();<a name="line.88"></a> |
| <span class="sourceLineNo">089</span><a name="line.89"></a> |
| <span class="sourceLineNo">090</span> /**<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> * @return the configuration of this session.<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> */<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> IoSessionConfig getConfig();<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> * @return the filter chain that only affects this session.<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> */<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> IoFilterChain getFilterChain();<a name="line.98"></a> |
| <span class="sourceLineNo">099</span><a name="line.99"></a> |
| <span class="sourceLineNo">100</span> /**<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> * Get the queue that contains the message waiting for being written.<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> * As the reader might not be ready, it's frequent that the messages<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> * aren't written completely, or that some older messages are waiting<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> * to be written when a new message arrives. This queue is used to manage<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> * the backlog of messages.<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> * <a name="line.106"></a> |
| <span class="sourceLineNo">107</span> * @return The queue containing the pending messages.<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> */<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> WriteRequestQueue getWriteRequestQueue();<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> * @return the {@link TransportMetadata} that this session runs on.<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> */<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> TransportMetadata getTransportMetadata();<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> * TODO This javadoc is wrong. The return tag should be short.<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> * <a name="line.118"></a> |
| <span class="sourceLineNo">119</span> * @return a {@link ReadFuture} which is notified when a new message is<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> * received, the connection is closed or an exception is caught. This<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> * operation is especially useful when you implement a client application.<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> * TODO : Describe here how we enable this feature.<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> * However, please note that this operation is disabled by default and<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> * throw {@link IllegalStateException} because all received events must be<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> * queued somewhere to support this operation, possibly leading to memory<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> * leak. This means you have to keep calling {@link #read()} once you<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> * enabled this operation. To enable this operation, please call<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> * {@link IoSessionConfig#setUseReadOperation(boolean)} with <tt>true</tt>.<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> *<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> * @throws IllegalStateException if<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> * {@link IoSessionConfig#setUseReadOperation(boolean) useReadOperation}<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> * option has not been enabled.<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> */<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> ReadFuture read();<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> * Writes the specified <code>message</code> to remote peer. This<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> * operation is asynchronous; {@link IoHandler#messageSent(IoSession,Object)}<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> * will be invoked when the message is actually sent to remote peer.<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> * You can also wait for the returned {@link WriteFuture} if you want<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> * to wait for the message actually written.<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> * <a name="line.142"></a> |
| <span class="sourceLineNo">143</span> * @param message The message to write<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> * @return The associated WriteFuture<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> */<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> WriteFuture write(Object message);<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> * (Optional) Writes the specified <tt>message</tt> to the specified <tt>destination</tt>.<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> * This operation is asynchronous; {@link IoHandler#messageSent(IoSession, Object)}<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> * will be invoked when the message is actually sent to remote peer. You can<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> * also wait for the returned {@link WriteFuture} if you want to wait for<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> * the message actually written.<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> * <p><a name="line.154"></a> |
| <span class="sourceLineNo">155</span> * When you implement a client that receives a broadcast message from a server<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> * such as DHCP server, the client might need to send a response message for the<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> * broadcast message the server sent. Because the remote address of the session<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> * is not the address of the server in case of broadcasting, there should be a<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> * way to specify the destination when you write the response message.<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> * This interface provides {@link #write(Object, SocketAddress)} method so you<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> * can specify the destination.<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> * <a name="line.162"></a> |
| <span class="sourceLineNo">163</span> * @param message The message to write<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> * @param destination <tt>null</tt> if you want the message sent to the<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> * default remote address<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> * @return The associated WriteFuture<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> */<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> WriteFuture write(Object message, SocketAddress destination);<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> * Closes this session immediately or after all queued write requests<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> * are flushed. This operation is asynchronous. Wait for the returned<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> * {@link CloseFuture} if you want to wait for the session actually closed.<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> *<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> * @param immediately {@code true} to close this session immediately<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> * . The pending write requests<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> * will simply be discarded.<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> * {@code false} to close this session after all queued<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> * write requests are flushed.<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> * @return The associated CloseFuture<a name="line.180"></a> |
| <span class="sourceLineNo">181</span> * @deprecated Use either the closeNow() or the flushAndClose() methods<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> */<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> CloseFuture close(boolean immediately);<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> * Closes this session immediately. This operation is asynchronous, it <a name="line.186"></a> |
| <span class="sourceLineNo">187</span> * returns a {@link CloseFuture}.<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> * <a name="line.188"></a> |
| <span class="sourceLineNo">189</span> * @return The {@link CloseFuture} that can be use to wait for the completion of this operation<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> */<a name="line.190"></a> |
| <span class="sourceLineNo">191</span> CloseFuture closeNow();<a name="line.191"></a> |
| <span class="sourceLineNo">192</span><a name="line.192"></a> |
| <span class="sourceLineNo">193</span> /**<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> * Closes this session after all queued write requests are flushed. This operation <a name="line.194"></a> |
| <span class="sourceLineNo">195</span> * is asynchronous. Wait for the returned {@link CloseFuture} if you want to wait <a name="line.195"></a> |
| <span class="sourceLineNo">196</span> * for the session actually closed.<a name="line.196"></a> |
| <span class="sourceLineNo">197</span> *<a name="line.197"></a> |
| <span class="sourceLineNo">198</span> * @return The associated CloseFuture<a name="line.198"></a> |
| <span class="sourceLineNo">199</span> */<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> CloseFuture closeOnFlush();<a name="line.200"></a> |
| <span class="sourceLineNo">201</span><a name="line.201"></a> |
| <span class="sourceLineNo">202</span> /**<a name="line.202"></a> |
| <span class="sourceLineNo">203</span> * Closes this session after all queued write requests<a name="line.203"></a> |
| <span class="sourceLineNo">204</span> * are flushed. This operation is asynchronous. Wait for the returned<a name="line.204"></a> |
| <span class="sourceLineNo">205</span> * {@link CloseFuture} if you want to wait for the session actually closed.<a name="line.205"></a> |
| <span class="sourceLineNo">206</span> * @deprecated use {@link #close(boolean)}<a name="line.206"></a> |
| <span class="sourceLineNo">207</span> * <a name="line.207"></a> |
| <span class="sourceLineNo">208</span> * @return The associated CloseFuture<a name="line.208"></a> |
| <span class="sourceLineNo">209</span> */<a name="line.209"></a> |
| <span class="sourceLineNo">210</span> @Deprecated<a name="line.210"></a> |
| <span class="sourceLineNo">211</span> CloseFuture close();<a name="line.211"></a> |
| <span class="sourceLineNo">212</span><a name="line.212"></a> |
| <span class="sourceLineNo">213</span> /**<a name="line.213"></a> |
| <span class="sourceLineNo">214</span> * Returns an attachment of this session.<a name="line.214"></a> |
| <span class="sourceLineNo">215</span> * This method is identical with <tt>getAttribute( "" )</tt>.<a name="line.215"></a> |
| <span class="sourceLineNo">216</span> *<a name="line.216"></a> |
| <span class="sourceLineNo">217</span> * @return The attachment<a name="line.217"></a> |
| <span class="sourceLineNo">218</span> * @deprecated Use {@link #getAttribute(Object)} instead.<a name="line.218"></a> |
| <span class="sourceLineNo">219</span> */<a name="line.219"></a> |
| <span class="sourceLineNo">220</span> @Deprecated<a name="line.220"></a> |
| <span class="sourceLineNo">221</span> Object getAttachment();<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> * Sets an attachment of this session.<a name="line.224"></a> |
| <span class="sourceLineNo">225</span> * This method is identical with <tt>setAttribute( "", attachment )</tt>.<a name="line.225"></a> |
| <span class="sourceLineNo">226</span> *<a name="line.226"></a> |
| <span class="sourceLineNo">227</span> * @param attachment The attachment<a name="line.227"></a> |
| <span class="sourceLineNo">228</span> * @return Old attachment. <tt>null</tt> if it is new.<a name="line.228"></a> |
| <span class="sourceLineNo">229</span> * @deprecated Use {@link #setAttribute(Object, Object)} instead.<a name="line.229"></a> |
| <span class="sourceLineNo">230</span> */<a name="line.230"></a> |
| <span class="sourceLineNo">231</span> @Deprecated<a name="line.231"></a> |
| <span class="sourceLineNo">232</span> Object setAttachment(Object attachment);<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> * Returns the value of the user-defined attribute of this session.<a name="line.235"></a> |
| <span class="sourceLineNo">236</span> *<a name="line.236"></a> |
| <span class="sourceLineNo">237</span> * @param key the key of the attribute<a name="line.237"></a> |
| <span class="sourceLineNo">238</span> * @return <tt>null</tt> if there is no attribute with the specified key<a name="line.238"></a> |
| <span class="sourceLineNo">239</span> */<a name="line.239"></a> |
| <span class="sourceLineNo">240</span> Object getAttribute(Object key);<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> * Returns the value of user defined attribute associated with the<a name="line.243"></a> |
| <span class="sourceLineNo">244</span> * specified key. If there's no such attribute, the specified default<a name="line.244"></a> |
| <span class="sourceLineNo">245</span> * value is associated with the specified key, and the default value is<a name="line.245"></a> |
| <span class="sourceLineNo">246</span> * returned. This method is same with the following code except that the<a name="line.246"></a> |
| <span class="sourceLineNo">247</span> * operation is performed atomically.<a name="line.247"></a> |
| <span class="sourceLineNo">248</span> * <pre><a name="line.248"></a> |
| <span class="sourceLineNo">249</span> * if (containsAttribute(key)) {<a name="line.249"></a> |
| <span class="sourceLineNo">250</span> * return getAttribute(key);<a name="line.250"></a> |
| <span class="sourceLineNo">251</span> * } else {<a name="line.251"></a> |
| <span class="sourceLineNo">252</span> * setAttribute(key, defaultValue);<a name="line.252"></a> |
| <span class="sourceLineNo">253</span> * return defaultValue;<a name="line.253"></a> |
| <span class="sourceLineNo">254</span> * }<a name="line.254"></a> |
| <span class="sourceLineNo">255</span> * </pre><a name="line.255"></a> |
| <span class="sourceLineNo">256</span> * <a name="line.256"></a> |
| <span class="sourceLineNo">257</span> * @param key the key of the attribute we want to retreive<a name="line.257"></a> |
| <span class="sourceLineNo">258</span> * @param defaultValue the default value of the attribute<a name="line.258"></a> |
| <span class="sourceLineNo">259</span> * @return The retrieved attribute or <tt>null</tt> if not found<a name="line.259"></a> |
| <span class="sourceLineNo">260</span> */<a name="line.260"></a> |
| <span class="sourceLineNo">261</span> Object getAttribute(Object key, Object defaultValue);<a name="line.261"></a> |
| <span class="sourceLineNo">262</span><a name="line.262"></a> |
| <span class="sourceLineNo">263</span> /**<a name="line.263"></a> |
| <span class="sourceLineNo">264</span> * Sets a user-defined attribute.<a name="line.264"></a> |
| <span class="sourceLineNo">265</span> *<a name="line.265"></a> |
| <span class="sourceLineNo">266</span> * @param key the key of the attribute<a name="line.266"></a> |
| <span class="sourceLineNo">267</span> * @param value the value of the attribute<a name="line.267"></a> |
| <span class="sourceLineNo">268</span> * @return The old value of the attribute. <tt>null</tt> if it is new.<a name="line.268"></a> |
| <span class="sourceLineNo">269</span> */<a name="line.269"></a> |
| <span class="sourceLineNo">270</span> Object setAttribute(Object key, Object value);<a name="line.270"></a> |
| <span class="sourceLineNo">271</span><a name="line.271"></a> |
| <span class="sourceLineNo">272</span> /**<a name="line.272"></a> |
| <span class="sourceLineNo">273</span> * Sets a user defined attribute without a value. This is useful when<a name="line.273"></a> |
| <span class="sourceLineNo">274</span> * you just want to put a 'mark' attribute. Its value is set to<a name="line.274"></a> |
| <span class="sourceLineNo">275</span> * {@link Boolean#TRUE}.<a name="line.275"></a> |
| <span class="sourceLineNo">276</span> *<a name="line.276"></a> |
| <span class="sourceLineNo">277</span> * @param key the key of the attribute<a name="line.277"></a> |
| <span class="sourceLineNo">278</span> * @return The old value of the attribute. <tt>null</tt> if it is new.<a name="line.278"></a> |
| <span class="sourceLineNo">279</span> */<a name="line.279"></a> |
| <span class="sourceLineNo">280</span> Object setAttribute(Object key);<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> * Sets a user defined attribute if the attribute with the specified key<a name="line.283"></a> |
| <span class="sourceLineNo">284</span> * is not set yet. This method is same with the following code except<a name="line.284"></a> |
| <span class="sourceLineNo">285</span> * that the operation is performed atomically.<a name="line.285"></a> |
| <span class="sourceLineNo">286</span> * <pre><a name="line.286"></a> |
| <span class="sourceLineNo">287</span> * if (containsAttribute(key)) {<a name="line.287"></a> |
| <span class="sourceLineNo">288</span> * return getAttribute(key);<a name="line.288"></a> |
| <span class="sourceLineNo">289</span> * } else {<a name="line.289"></a> |
| <span class="sourceLineNo">290</span> * return setAttribute(key, value);<a name="line.290"></a> |
| <span class="sourceLineNo">291</span> * }<a name="line.291"></a> |
| <span class="sourceLineNo">292</span> * </pre><a name="line.292"></a> |
| <span class="sourceLineNo">293</span> * <a name="line.293"></a> |
| <span class="sourceLineNo">294</span> * @param key The key of the attribute we want to set<a name="line.294"></a> |
| <span class="sourceLineNo">295</span> * @param value The value we want to set<a name="line.295"></a> |
| <span class="sourceLineNo">296</span> * @return The old value of the attribute. <tt>null</tt> if not found.<a name="line.296"></a> |
| <span class="sourceLineNo">297</span> */<a name="line.297"></a> |
| <span class="sourceLineNo">298</span> Object setAttributeIfAbsent(Object key, Object value);<a name="line.298"></a> |
| <span class="sourceLineNo">299</span><a name="line.299"></a> |
| <span class="sourceLineNo">300</span> /**<a name="line.300"></a> |
| <span class="sourceLineNo">301</span> * Sets a user defined attribute without a value if the attribute with<a name="line.301"></a> |
| <span class="sourceLineNo">302</span> * the specified key is not set yet. This is useful when you just want to<a name="line.302"></a> |
| <span class="sourceLineNo">303</span> * put a 'mark' attribute. Its value is set to {@link Boolean#TRUE}.<a name="line.303"></a> |
| <span class="sourceLineNo">304</span> * This method is same with the following code except that the operation<a name="line.304"></a> |
| <span class="sourceLineNo">305</span> * is performed atomically.<a name="line.305"></a> |
| <span class="sourceLineNo">306</span> * <pre><a name="line.306"></a> |
| <span class="sourceLineNo">307</span> * if (containsAttribute(key)) {<a name="line.307"></a> |
| <span class="sourceLineNo">308</span> * return getAttribute(key); // might not always be Boolean.TRUE.<a name="line.308"></a> |
| <span class="sourceLineNo">309</span> * } else {<a name="line.309"></a> |
| <span class="sourceLineNo">310</span> * return setAttribute(key);<a name="line.310"></a> |
| <span class="sourceLineNo">311</span> * }<a name="line.311"></a> |
| <span class="sourceLineNo">312</span> * </pre><a name="line.312"></a> |
| <span class="sourceLineNo">313</span> * <a name="line.313"></a> |
| <span class="sourceLineNo">314</span> * @param key The key of the attribute we want to set<a name="line.314"></a> |
| <span class="sourceLineNo">315</span> * @return The old value of the attribute. <tt>null</tt> if not found.<a name="line.315"></a> |
| <span class="sourceLineNo">316</span> */<a name="line.316"></a> |
| <span class="sourceLineNo">317</span> Object setAttributeIfAbsent(Object key);<a name="line.317"></a> |
| <span class="sourceLineNo">318</span><a name="line.318"></a> |
| <span class="sourceLineNo">319</span> /**<a name="line.319"></a> |
| <span class="sourceLineNo">320</span> * Removes a user-defined attribute with the specified key.<a name="line.320"></a> |
| <span class="sourceLineNo">321</span> *<a name="line.321"></a> |
| <span class="sourceLineNo">322</span> * @param key The key of the attribute we want to remove<a name="line.322"></a> |
| <span class="sourceLineNo">323</span> * @return The old value of the attribute. <tt>null</tt> if not found.<a name="line.323"></a> |
| <span class="sourceLineNo">324</span> */<a name="line.324"></a> |
| <span class="sourceLineNo">325</span> Object removeAttribute(Object key);<a name="line.325"></a> |
| <span class="sourceLineNo">326</span><a name="line.326"></a> |
| <span class="sourceLineNo">327</span> /**<a name="line.327"></a> |
| <span class="sourceLineNo">328</span> * Removes a user defined attribute with the specified key if the current<a name="line.328"></a> |
| <span class="sourceLineNo">329</span> * attribute value is equal to the specified value. This method is same<a name="line.329"></a> |
| <span class="sourceLineNo">330</span> * with the following code except that the operation is performed<a name="line.330"></a> |
| <span class="sourceLineNo">331</span> * atomically.<a name="line.331"></a> |
| <span class="sourceLineNo">332</span> * <pre><a name="line.332"></a> |
| <span class="sourceLineNo">333</span> * if (containsAttribute(key) &amp;&amp; getAttribute(key).equals(value)) {<a name="line.333"></a> |
| <span class="sourceLineNo">334</span> * removeAttribute(key);<a name="line.334"></a> |
| <span class="sourceLineNo">335</span> * return true;<a name="line.335"></a> |
| <span class="sourceLineNo">336</span> * } else {<a name="line.336"></a> |
| <span class="sourceLineNo">337</span> * return false;<a name="line.337"></a> |
| <span class="sourceLineNo">338</span> * }<a name="line.338"></a> |
| <span class="sourceLineNo">339</span> * </pre><a name="line.339"></a> |
| <span class="sourceLineNo">340</span> * <a name="line.340"></a> |
| <span class="sourceLineNo">341</span> * @param key The key we want to remove<a name="line.341"></a> |
| <span class="sourceLineNo">342</span> * @param value The value we want to remove<a name="line.342"></a> |
| <span class="sourceLineNo">343</span> * @return <tt>true</tt> if the removal was successful<a name="line.343"></a> |
| <span class="sourceLineNo">344</span> */<a name="line.344"></a> |
| <span class="sourceLineNo">345</span> boolean removeAttribute(Object key, Object value);<a name="line.345"></a> |
| <span class="sourceLineNo">346</span><a name="line.346"></a> |
| <span class="sourceLineNo">347</span> /**<a name="line.347"></a> |
| <span class="sourceLineNo">348</span> * Replaces a user defined attribute with the specified key if the<a name="line.348"></a> |
| <span class="sourceLineNo">349</span> * value of the attribute is equals to the specified old value.<a name="line.349"></a> |
| <span class="sourceLineNo">350</span> * This method is same with the following code except that the operation<a name="line.350"></a> |
| <span class="sourceLineNo">351</span> * is performed atomically.<a name="line.351"></a> |
| <span class="sourceLineNo">352</span> * <pre><a name="line.352"></a> |
| <span class="sourceLineNo">353</span> * if (containsAttribute(key) &amp;&amp; getAttribute(key).equals(oldValue)) {<a name="line.353"></a> |
| <span class="sourceLineNo">354</span> * setAttribute(key, newValue);<a name="line.354"></a> |
| <span class="sourceLineNo">355</span> * return true;<a name="line.355"></a> |
| <span class="sourceLineNo">356</span> * } else {<a name="line.356"></a> |
| <span class="sourceLineNo">357</span> * return false;<a name="line.357"></a> |
| <span class="sourceLineNo">358</span> * }<a name="line.358"></a> |
| <span class="sourceLineNo">359</span> * </pre><a name="line.359"></a> |
| <span class="sourceLineNo">360</span> * <a name="line.360"></a> |
| <span class="sourceLineNo">361</span> * @param key The key we want to replace<a name="line.361"></a> |
| <span class="sourceLineNo">362</span> * @param oldValue The previous value<a name="line.362"></a> |
| <span class="sourceLineNo">363</span> * @param newValue The new value<a name="line.363"></a> |
| <span class="sourceLineNo">364</span> * @return <tt>true</tt> if the replacement was successful<a name="line.364"></a> |
| <span class="sourceLineNo">365</span> */<a name="line.365"></a> |
| <span class="sourceLineNo">366</span> boolean replaceAttribute(Object key, Object oldValue, Object newValue);<a name="line.366"></a> |
| <span class="sourceLineNo">367</span><a name="line.367"></a> |
| <span class="sourceLineNo">368</span> /**<a name="line.368"></a> |
| <span class="sourceLineNo">369</span> * @param key The key of the attribute we are looking for in the session <a name="line.369"></a> |
| <span class="sourceLineNo">370</span> * @return <tt>true</tt> if this session contains the attribute with<a name="line.370"></a> |
| <span class="sourceLineNo">371</span> * the specified <tt>key</tt>.<a name="line.371"></a> |
| <span class="sourceLineNo">372</span> */<a name="line.372"></a> |
| <span class="sourceLineNo">373</span> boolean containsAttribute(Object key);<a name="line.373"></a> |
| <span class="sourceLineNo">374</span><a name="line.374"></a> |
| <span class="sourceLineNo">375</span> /**<a name="line.375"></a> |
| <span class="sourceLineNo">376</span> * @return the set of keys of all user-defined attributes.<a name="line.376"></a> |
| <span class="sourceLineNo">377</span> */<a name="line.377"></a> |
| <span class="sourceLineNo">378</span> Set<Object> getAttributeKeys();<a name="line.378"></a> |
| <span class="sourceLineNo">379</span><a name="line.379"></a> |
| <span class="sourceLineNo">380</span> /**<a name="line.380"></a> |
| <span class="sourceLineNo">381</span> * @return <tt>true</tt> if this session is connected with remote peer.<a name="line.381"></a> |
| <span class="sourceLineNo">382</span> */<a name="line.382"></a> |
| <span class="sourceLineNo">383</span> boolean isConnected();<a name="line.383"></a> |
| <span class="sourceLineNo">384</span> <a name="line.384"></a> |
| <span class="sourceLineNo">385</span> /**<a name="line.385"></a> |
| <span class="sourceLineNo">386</span> * @return <tt>true</tt> if this session is active.<a name="line.386"></a> |
| <span class="sourceLineNo">387</span> */<a name="line.387"></a> |
| <span class="sourceLineNo">388</span> boolean isActive();<a name="line.388"></a> |
| <span class="sourceLineNo">389</span><a name="line.389"></a> |
| <span class="sourceLineNo">390</span> /**<a name="line.390"></a> |
| <span class="sourceLineNo">391</span> * @return <tt>true</tt> if and only if this session is being closed<a name="line.391"></a> |
| <span class="sourceLineNo">392</span> * (but not disconnected yet) or is closed.<a name="line.392"></a> |
| <span class="sourceLineNo">393</span> */<a name="line.393"></a> |
| <span class="sourceLineNo">394</span> boolean isClosing();<a name="line.394"></a> |
| <span class="sourceLineNo">395</span> <a name="line.395"></a> |
| <span class="sourceLineNo">396</span> /**<a name="line.396"></a> |
| <span class="sourceLineNo">397</span> * @return <tt>true</tt> if the session has started and initialized a SslEngine,<a name="line.397"></a> |
| <span class="sourceLineNo">398</span> * <tt>false</tt> if the session is not yet secured (the handshake is not completed)<a name="line.398"></a> |
| <span class="sourceLineNo">399</span> * or if SSL is not set for this session, or if SSL is not even an option.<a name="line.399"></a> |
| <span class="sourceLineNo">400</span> */<a name="line.400"></a> |
| <span class="sourceLineNo">401</span> boolean isSecured();<a name="line.401"></a> |
| <span class="sourceLineNo">402</span><a name="line.402"></a> |
| <span class="sourceLineNo">403</span> /**<a name="line.403"></a> |
| <span class="sourceLineNo">404</span> * @return the {@link CloseFuture} of this session. This method returns<a name="line.404"></a> |
| <span class="sourceLineNo">405</span> * the same instance whenever user calls it.<a name="line.405"></a> |
| <span class="sourceLineNo">406</span> */<a name="line.406"></a> |
| <span class="sourceLineNo">407</span> CloseFuture getCloseFuture();<a name="line.407"></a> |
| <span class="sourceLineNo">408</span><a name="line.408"></a> |
| <span class="sourceLineNo">409</span> /**<a name="line.409"></a> |
| <span class="sourceLineNo">410</span> * @return the socket address of remote peer.<a name="line.410"></a> |
| <span class="sourceLineNo">411</span> */<a name="line.411"></a> |
| <span class="sourceLineNo">412</span> SocketAddress getRemoteAddress();<a name="line.412"></a> |
| <span class="sourceLineNo">413</span><a name="line.413"></a> |
| <span class="sourceLineNo">414</span> /**<a name="line.414"></a> |
| <span class="sourceLineNo">415</span> * @return the socket address of local machine which is associated with this<a name="line.415"></a> |
| <span class="sourceLineNo">416</span> * session.<a name="line.416"></a> |
| <span class="sourceLineNo">417</span> */<a name="line.417"></a> |
| <span class="sourceLineNo">418</span> SocketAddress getLocalAddress();<a name="line.418"></a> |
| <span class="sourceLineNo">419</span><a name="line.419"></a> |
| <span class="sourceLineNo">420</span> /**<a name="line.420"></a> |
| <span class="sourceLineNo">421</span> * @return the socket address of the {@link IoService} listens to to manage<a name="line.421"></a> |
| <span class="sourceLineNo">422</span> * this session. If this session is managed by {@link IoAcceptor}, it<a name="line.422"></a> |
| <span class="sourceLineNo">423</span> * returns the {@link SocketAddress} which is specified as a parameter of<a name="line.423"></a> |
| <span class="sourceLineNo">424</span> * {@link IoAcceptor#bind()}. If this session is managed by<a name="line.424"></a> |
| <span class="sourceLineNo">425</span> * {@link IoConnector}, this method returns the same address with<a name="line.425"></a> |
| <span class="sourceLineNo">426</span> * that of {@link #getRemoteAddress()}.<a name="line.426"></a> |
| <span class="sourceLineNo">427</span> */<a name="line.427"></a> |
| <span class="sourceLineNo">428</span> SocketAddress getServiceAddress();<a name="line.428"></a> |
| <span class="sourceLineNo">429</span><a name="line.429"></a> |
| <span class="sourceLineNo">430</span> /**<a name="line.430"></a> |
| <span class="sourceLineNo">431</span> * <a name="line.431"></a> |
| <span class="sourceLineNo">432</span> * Associate the current write request with the session<a name="line.432"></a> |
| <span class="sourceLineNo">433</span> *<a name="line.433"></a> |
| <span class="sourceLineNo">434</span> * @param currentWriteRequest the current write request to associate<a name="line.434"></a> |
| <span class="sourceLineNo">435</span> */<a name="line.435"></a> |
| <span class="sourceLineNo">436</span> void setCurrentWriteRequest(WriteRequest currentWriteRequest);<a name="line.436"></a> |
| <span class="sourceLineNo">437</span><a name="line.437"></a> |
| <span class="sourceLineNo">438</span> /**<a name="line.438"></a> |
| <span class="sourceLineNo">439</span> * Suspends read operations for this session.<a name="line.439"></a> |
| <span class="sourceLineNo">440</span> */<a name="line.440"></a> |
| <span class="sourceLineNo">441</span> void suspendRead();<a name="line.441"></a> |
| <span class="sourceLineNo">442</span><a name="line.442"></a> |
| <span class="sourceLineNo">443</span> /**<a name="line.443"></a> |
| <span class="sourceLineNo">444</span> * Suspends write operations for this session.<a name="line.444"></a> |
| <span class="sourceLineNo">445</span> */<a name="line.445"></a> |
| <span class="sourceLineNo">446</span> void suspendWrite();<a name="line.446"></a> |
| <span class="sourceLineNo">447</span><a name="line.447"></a> |
| <span class="sourceLineNo">448</span> /**<a name="line.448"></a> |
| <span class="sourceLineNo">449</span> * Resumes read operations for this session.<a name="line.449"></a> |
| <span class="sourceLineNo">450</span> */<a name="line.450"></a> |
| <span class="sourceLineNo">451</span> void resumeRead();<a name="line.451"></a> |
| <span class="sourceLineNo">452</span><a name="line.452"></a> |
| <span class="sourceLineNo">453</span> /**<a name="line.453"></a> |
| <span class="sourceLineNo">454</span> * Resumes write operations for this session.<a name="line.454"></a> |
| <span class="sourceLineNo">455</span> */<a name="line.455"></a> |
| <span class="sourceLineNo">456</span> void resumeWrite();<a name="line.456"></a> |
| <span class="sourceLineNo">457</span><a name="line.457"></a> |
| <span class="sourceLineNo">458</span> /**<a name="line.458"></a> |
| <span class="sourceLineNo">459</span> * Is read operation is suspended for this session. <a name="line.459"></a> |
| <span class="sourceLineNo">460</span> * <a name="line.460"></a> |
| <span class="sourceLineNo">461</span> * @return <tt>true</tt> if suspended<a name="line.461"></a> |
| <span class="sourceLineNo">462</span> */<a name="line.462"></a> |
| <span class="sourceLineNo">463</span> boolean isReadSuspended();<a name="line.463"></a> |
| <span class="sourceLineNo">464</span><a name="line.464"></a> |
| <span class="sourceLineNo">465</span> /**<a name="line.465"></a> |
| <span class="sourceLineNo">466</span> * Is write operation is suspended for this session.<a name="line.466"></a> |
| <span class="sourceLineNo">467</span> * <a name="line.467"></a> |
| <span class="sourceLineNo">468</span> * @return <tt>true</tt> if suspended<a name="line.468"></a> |
| <span class="sourceLineNo">469</span> */<a name="line.469"></a> |
| <span class="sourceLineNo">470</span> boolean isWriteSuspended();<a name="line.470"></a> |
| <span class="sourceLineNo">471</span><a name="line.471"></a> |
| <span class="sourceLineNo">472</span> /**<a name="line.472"></a> |
| <span class="sourceLineNo">473</span> * Update all statistical properties related with throughput assuming<a name="line.473"></a> |
| <span class="sourceLineNo">474</span> * the specified time is the current time. By default this method returns<a name="line.474"></a> |
| <span class="sourceLineNo">475</span> * silently without updating the throughput properties if they were<a name="line.475"></a> |
| <span class="sourceLineNo">476</span> * calculated already within last<a name="line.476"></a> |
| <span class="sourceLineNo">477</span> * {@link IoSessionConfig#getThroughputCalculationInterval() calculation interval}.<a name="line.477"></a> |
| <span class="sourceLineNo">478</span> * If, however, <tt>force</tt> is specified as <tt>true</tt>, this method<a name="line.478"></a> |
| <span class="sourceLineNo">479</span> * updates the throughput properties immediately.<a name="line.479"></a> |
| <span class="sourceLineNo">480</span><a name="line.480"></a> |
| <span class="sourceLineNo">481</span> * @param currentTime the current time in milliseconds<a name="line.481"></a> |
| <span class="sourceLineNo">482</span> * @param force Force the update if <tt>true</tt><a name="line.482"></a> |
| <span class="sourceLineNo">483</span> */<a name="line.483"></a> |
| <span class="sourceLineNo">484</span> void updateThroughput(long currentTime, boolean force);<a name="line.484"></a> |
| <span class="sourceLineNo">485</span><a name="line.485"></a> |
| <span class="sourceLineNo">486</span> /**<a name="line.486"></a> |
| <span class="sourceLineNo">487</span> * @return the total number of bytes which were read from this session.<a name="line.487"></a> |
| <span class="sourceLineNo">488</span> */<a name="line.488"></a> |
| <span class="sourceLineNo">489</span> long getReadBytes();<a name="line.489"></a> |
| <span class="sourceLineNo">490</span><a name="line.490"></a> |
| <span class="sourceLineNo">491</span> /**<a name="line.491"></a> |
| <span class="sourceLineNo">492</span> * @return the total number of bytes which were written to this session.<a name="line.492"></a> |
| <span class="sourceLineNo">493</span> */<a name="line.493"></a> |
| <span class="sourceLineNo">494</span> long getWrittenBytes();<a name="line.494"></a> |
| <span class="sourceLineNo">495</span><a name="line.495"></a> |
| <span class="sourceLineNo">496</span> /**<a name="line.496"></a> |
| <span class="sourceLineNo">497</span> * @return the total number of messages which were read and decoded from this session.<a name="line.497"></a> |
| <span class="sourceLineNo">498</span> */<a name="line.498"></a> |
| <span class="sourceLineNo">499</span> long getReadMessages();<a name="line.499"></a> |
| <span class="sourceLineNo">500</span><a name="line.500"></a> |
| <span class="sourceLineNo">501</span> /**<a name="line.501"></a> |
| <span class="sourceLineNo">502</span> * @return the total number of messages which were written and encoded by this session.<a name="line.502"></a> |
| <span class="sourceLineNo">503</span> */<a name="line.503"></a> |
| <span class="sourceLineNo">504</span> long getWrittenMessages();<a name="line.504"></a> |
| <span class="sourceLineNo">505</span><a name="line.505"></a> |
| <span class="sourceLineNo">506</span> /**<a name="line.506"></a> |
| <span class="sourceLineNo">507</span> * @return the number of read bytes per second.<a name="line.507"></a> |
| <span class="sourceLineNo">508</span> */<a name="line.508"></a> |
| <span class="sourceLineNo">509</span> double getReadBytesThroughput();<a name="line.509"></a> |
| <span class="sourceLineNo">510</span><a name="line.510"></a> |
| <span class="sourceLineNo">511</span> /**<a name="line.511"></a> |
| <span class="sourceLineNo">512</span> * @return the number of written bytes per second.<a name="line.512"></a> |
| <span class="sourceLineNo">513</span> */<a name="line.513"></a> |
| <span class="sourceLineNo">514</span> double getWrittenBytesThroughput();<a name="line.514"></a> |
| <span class="sourceLineNo">515</span><a name="line.515"></a> |
| <span class="sourceLineNo">516</span> /**<a name="line.516"></a> |
| <span class="sourceLineNo">517</span> * @return the number of read messages per second.<a name="line.517"></a> |
| <span class="sourceLineNo">518</span> */<a name="line.518"></a> |
| <span class="sourceLineNo">519</span> double getReadMessagesThroughput();<a name="line.519"></a> |
| <span class="sourceLineNo">520</span><a name="line.520"></a> |
| <span class="sourceLineNo">521</span> /**<a name="line.521"></a> |
| <span class="sourceLineNo">522</span> * @return the number of written messages per second.<a name="line.522"></a> |
| <span class="sourceLineNo">523</span> */<a name="line.523"></a> |
| <span class="sourceLineNo">524</span> double getWrittenMessagesThroughput();<a name="line.524"></a> |
| <span class="sourceLineNo">525</span><a name="line.525"></a> |
| <span class="sourceLineNo">526</span> /**<a name="line.526"></a> |
| <span class="sourceLineNo">527</span> * @return the number of messages which are scheduled to be written to this session.<a name="line.527"></a> |
| <span class="sourceLineNo">528</span> */<a name="line.528"></a> |
| <span class="sourceLineNo">529</span> int getScheduledWriteMessages();<a name="line.529"></a> |
| <span class="sourceLineNo">530</span><a name="line.530"></a> |
| <span class="sourceLineNo">531</span> /**<a name="line.531"></a> |
| <span class="sourceLineNo">532</span> * @return the number of bytes which are scheduled to be written to this<a name="line.532"></a> |
| <span class="sourceLineNo">533</span> * session.<a name="line.533"></a> |
| <span class="sourceLineNo">534</span> */<a name="line.534"></a> |
| <span class="sourceLineNo">535</span> long getScheduledWriteBytes();<a name="line.535"></a> |
| <span class="sourceLineNo">536</span><a name="line.536"></a> |
| <span class="sourceLineNo">537</span> /**<a name="line.537"></a> |
| <span class="sourceLineNo">538</span> * Returns the message which is being written by {@link IoService}.<a name="line.538"></a> |
| <span class="sourceLineNo">539</span> * @return <tt>null</tt> if and if only no message is being written<a name="line.539"></a> |
| <span class="sourceLineNo">540</span> */<a name="line.540"></a> |
| <span class="sourceLineNo">541</span> Object getCurrentWriteMessage();<a name="line.541"></a> |
| <span class="sourceLineNo">542</span><a name="line.542"></a> |
| <span class="sourceLineNo">543</span> /**<a name="line.543"></a> |
| <span class="sourceLineNo">544</span> * Returns the {@link WriteRequest} which is being processed by<a name="line.544"></a> |
| <span class="sourceLineNo">545</span> * {@link IoService}.<a name="line.545"></a> |
| <span class="sourceLineNo">546</span> *<a name="line.546"></a> |
| <span class="sourceLineNo">547</span> * @return <tt>null</tt> if and if only no message is being written<a name="line.547"></a> |
| <span class="sourceLineNo">548</span> */<a name="line.548"></a> |
| <span class="sourceLineNo">549</span> WriteRequest getCurrentWriteRequest();<a name="line.549"></a> |
| <span class="sourceLineNo">550</span><a name="line.550"></a> |
| <span class="sourceLineNo">551</span> /**<a name="line.551"></a> |
| <span class="sourceLineNo">552</span> * @return the session's creation time in milliseconds<a name="line.552"></a> |
| <span class="sourceLineNo">553</span> */<a name="line.553"></a> |
| <span class="sourceLineNo">554</span> long getCreationTime();<a name="line.554"></a> |
| <span class="sourceLineNo">555</span><a name="line.555"></a> |
| <span class="sourceLineNo">556</span> /**<a name="line.556"></a> |
| <span class="sourceLineNo">557</span> * @return the time in millis when I/O occurred lastly.<a name="line.557"></a> |
| <span class="sourceLineNo">558</span> */<a name="line.558"></a> |
| <span class="sourceLineNo">559</span> long getLastIoTime();<a name="line.559"></a> |
| <span class="sourceLineNo">560</span><a name="line.560"></a> |
| <span class="sourceLineNo">561</span> /**<a name="line.561"></a> |
| <span class="sourceLineNo">562</span> * @return the time in millis when read operation occurred lastly.<a name="line.562"></a> |
| <span class="sourceLineNo">563</span> */<a name="line.563"></a> |
| <span class="sourceLineNo">564</span> long getLastReadTime();<a name="line.564"></a> |
| <span class="sourceLineNo">565</span><a name="line.565"></a> |
| <span class="sourceLineNo">566</span> /**<a name="line.566"></a> |
| <span class="sourceLineNo">567</span> * @return the time in millis when write operation occurred lastly.<a name="line.567"></a> |
| <span class="sourceLineNo">568</span> */<a name="line.568"></a> |
| <span class="sourceLineNo">569</span> long getLastWriteTime();<a name="line.569"></a> |
| <span class="sourceLineNo">570</span><a name="line.570"></a> |
| <span class="sourceLineNo">571</span> /**<a name="line.571"></a> |
| <span class="sourceLineNo">572</span> * @param status The researched idle status<a name="line.572"></a> |
| <span class="sourceLineNo">573</span> * @return <tt>true</tt> if this session is idle for the specified<a name="line.573"></a> |
| <span class="sourceLineNo">574</span> * {@link IdleStatus}.<a name="line.574"></a> |
| <span class="sourceLineNo">575</span> */<a name="line.575"></a> |
| <span class="sourceLineNo">576</span> boolean isIdle(IdleStatus status);<a name="line.576"></a> |
| <span class="sourceLineNo">577</span><a name="line.577"></a> |
| <span class="sourceLineNo">578</span> /**<a name="line.578"></a> |
| <span class="sourceLineNo">579</span> * @return <tt>true</tt> if this session is {@link IdleStatus#READER_IDLE}.<a name="line.579"></a> |
| <span class="sourceLineNo">580</span> * @see #isIdle(IdleStatus)<a name="line.580"></a> |
| <span class="sourceLineNo">581</span> */<a name="line.581"></a> |
| <span class="sourceLineNo">582</span> boolean isReaderIdle();<a name="line.582"></a> |
| <span class="sourceLineNo">583</span><a name="line.583"></a> |
| <span class="sourceLineNo">584</span> /**<a name="line.584"></a> |
| <span class="sourceLineNo">585</span> * @return <tt>true</tt> if this session is {@link IdleStatus#WRITER_IDLE}.<a name="line.585"></a> |
| <span class="sourceLineNo">586</span> * @see #isIdle(IdleStatus)<a name="line.586"></a> |
| <span class="sourceLineNo">587</span> */<a name="line.587"></a> |
| <span class="sourceLineNo">588</span> boolean isWriterIdle();<a name="line.588"></a> |
| <span class="sourceLineNo">589</span><a name="line.589"></a> |
| <span class="sourceLineNo">590</span> /**<a name="line.590"></a> |
| <span class="sourceLineNo">591</span> * @return <tt>true</tt> if this session is {@link IdleStatus#BOTH_IDLE}.<a name="line.591"></a> |
| <span class="sourceLineNo">592</span> * @see #isIdle(IdleStatus)<a name="line.592"></a> |
| <span class="sourceLineNo">593</span> */<a name="line.593"></a> |
| <span class="sourceLineNo">594</span> boolean isBothIdle();<a name="line.594"></a> |
| <span class="sourceLineNo">595</span><a name="line.595"></a> |
| <span class="sourceLineNo">596</span> /**<a name="line.596"></a> |
| <span class="sourceLineNo">597</span> * @param status The researched idle status<a name="line.597"></a> |
| <span class="sourceLineNo">598</span> * @return the number of the fired continuous <tt>sessionIdle</tt> events<a name="line.598"></a> |
| <span class="sourceLineNo">599</span> * for the specified {@link IdleStatus}.<a name="line.599"></a> |
| <span class="sourceLineNo">600</span> * <p><a name="line.600"></a> |
| <span class="sourceLineNo">601</span> * If <tt>sessionIdle</tt> event is fired first after some time after I/O,<a name="line.601"></a> |
| <span class="sourceLineNo">602</span> * <tt>idleCount</tt> becomes <tt>1</tt>. <tt>idleCount</tt> resets to<a name="line.602"></a> |
| <span class="sourceLineNo">603</span> * <tt>0</tt> if any I/O occurs again, otherwise it increases to<a name="line.603"></a> |
| <span class="sourceLineNo">604</span> * <tt>2</tt> and so on if <tt>sessionIdle</tt> event is fired again without<a name="line.604"></a> |
| <span class="sourceLineNo">605</span> * any I/O between two (or more) <tt>sessionIdle</tt> events.<a name="line.605"></a> |
| <span class="sourceLineNo">606</span> */<a name="line.606"></a> |
| <span class="sourceLineNo">607</span> int getIdleCount(IdleStatus status);<a name="line.607"></a> |
| <span class="sourceLineNo">608</span><a name="line.608"></a> |
| <span class="sourceLineNo">609</span> /**<a name="line.609"></a> |
| <span class="sourceLineNo">610</span> * @return the number of the fired continuous <tt>sessionIdle</tt> events<a name="line.610"></a> |
| <span class="sourceLineNo">611</span> * for {@link IdleStatus#READER_IDLE}.<a name="line.611"></a> |
| <span class="sourceLineNo">612</span> * @see #getIdleCount(IdleStatus)<a name="line.612"></a> |
| <span class="sourceLineNo">613</span> */<a name="line.613"></a> |
| <span class="sourceLineNo">614</span> int getReaderIdleCount();<a name="line.614"></a> |
| <span class="sourceLineNo">615</span><a name="line.615"></a> |
| <span class="sourceLineNo">616</span> /**<a name="line.616"></a> |
| <span class="sourceLineNo">617</span> * @return the number of the fired continuous <tt>sessionIdle</tt> events<a name="line.617"></a> |
| <span class="sourceLineNo">618</span> * for {@link IdleStatus#WRITER_IDLE}.<a name="line.618"></a> |
| <span class="sourceLineNo">619</span> * @see #getIdleCount(IdleStatus)<a name="line.619"></a> |
| <span class="sourceLineNo">620</span> */<a name="line.620"></a> |
| <span class="sourceLineNo">621</span> int getWriterIdleCount();<a name="line.621"></a> |
| <span class="sourceLineNo">622</span><a name="line.622"></a> |
| <span class="sourceLineNo">623</span> /**<a name="line.623"></a> |
| <span class="sourceLineNo">624</span> * @return the number of the fired continuous <tt>sessionIdle</tt> events<a name="line.624"></a> |
| <span class="sourceLineNo">625</span> * for {@link IdleStatus#BOTH_IDLE}.<a name="line.625"></a> |
| <span class="sourceLineNo">626</span> * @see #getIdleCount(IdleStatus)<a name="line.626"></a> |
| <span class="sourceLineNo">627</span> */<a name="line.627"></a> |
| <span class="sourceLineNo">628</span> int getBothIdleCount();<a name="line.628"></a> |
| <span class="sourceLineNo">629</span><a name="line.629"></a> |
| <span class="sourceLineNo">630</span> /**<a name="line.630"></a> |
| <span class="sourceLineNo">631</span> * @param status The researched idle status<a name="line.631"></a> |
| <span class="sourceLineNo">632</span> * @return the time in milliseconds when the last <tt>sessionIdle</tt> event<a name="line.632"></a> |
| <span class="sourceLineNo">633</span> * is fired for the specified {@link IdleStatus}.<a name="line.633"></a> |
| <span class="sourceLineNo">634</span> */<a name="line.634"></a> |
| <span class="sourceLineNo">635</span> long getLastIdleTime(IdleStatus status);<a name="line.635"></a> |
| <span class="sourceLineNo">636</span><a name="line.636"></a> |
| <span class="sourceLineNo">637</span> /**<a name="line.637"></a> |
| <span class="sourceLineNo">638</span> * @return the time in milliseconds when the last <tt>sessionIdle</tt> event<a name="line.638"></a> |
| <span class="sourceLineNo">639</span> * is fired for {@link IdleStatus#READER_IDLE}.<a name="line.639"></a> |
| <span class="sourceLineNo">640</span> * @see #getLastIdleTime(IdleStatus)<a name="line.640"></a> |
| <span class="sourceLineNo">641</span> */<a name="line.641"></a> |
| <span class="sourceLineNo">642</span> long getLastReaderIdleTime();<a name="line.642"></a> |
| <span class="sourceLineNo">643</span><a name="line.643"></a> |
| <span class="sourceLineNo">644</span> /**<a name="line.644"></a> |
| <span class="sourceLineNo">645</span> * @return the time in milliseconds when the last <tt>sessionIdle</tt> event<a name="line.645"></a> |
| <span class="sourceLineNo">646</span> * is fired for {@link IdleStatus#WRITER_IDLE}.<a name="line.646"></a> |
| <span class="sourceLineNo">647</span> * @see #getLastIdleTime(IdleStatus)<a name="line.647"></a> |
| <span class="sourceLineNo">648</span> */<a name="line.648"></a> |
| <span class="sourceLineNo">649</span> long getLastWriterIdleTime();<a name="line.649"></a> |
| <span class="sourceLineNo">650</span><a name="line.650"></a> |
| <span class="sourceLineNo">651</span> /**<a name="line.651"></a> |
| <span class="sourceLineNo">652</span> * @return the time in milliseconds when the last <tt>sessionIdle</tt> event<a name="line.652"></a> |
| <span class="sourceLineNo">653</span> * is fired for {@link IdleStatus#BOTH_IDLE}.<a name="line.653"></a> |
| <span class="sourceLineNo">654</span> * @see #getLastIdleTime(IdleStatus)<a name="line.654"></a> |
| <span class="sourceLineNo">655</span> */<a name="line.655"></a> |
| <span class="sourceLineNo">656</span> long getLastBothIdleTime();<a name="line.656"></a> |
| <span class="sourceLineNo">657</span>}<a name="line.657"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
