| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
| <head> |
| <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>IoSession xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../apidocs/org/apache/mina/common/IoSession.html">View Javadoc</a></div><pre> |
|
|
| <a name="1" href="#1">1</a> <em class="comment">/*</em>
|
| <a name="2" href="#2">2</a> <em class="comment"> * @(#) $Id: IoSession.java 355016 2005-12-08 07:00:30Z trustin $</em>
|
| <a name="3" href="#3">3</a> <em class="comment"> *</em>
|
| <a name="4" href="#4">4</a> <em class="comment"> * Copyright 2004 The Apache Software Foundation</em>
|
| <a name="5" href="#5">5</a> <em class="comment"> *</em>
|
| <a name="6" href="#6">6</a> <em class="comment"> * Licensed under the Apache License, Version 2.0 (the "License");</em>
|
| <a name="7" href="#7">7</a> <em class="comment"> * you may not use this file except in compliance with the License.</em>
|
| <a name="8" href="#8">8</a> <em class="comment"> * You may obtain a copy of the License at</em>
|
| <a name="9" href="#9">9</a> <em class="comment"> *</em>
|
| <a name="10" href="#10">10</a> <em class="comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
|
| <a name="11" href="#11">11</a> <em class="comment"> *</em>
|
| <a name="12" href="#12">12</a> <em class="comment"> * Unless required by applicable law or agreed to in writing, software</em>
|
| <a name="13" href="#13">13</a> <em class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
|
| <a name="14" href="#14">14</a> <em class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
|
| <a name="15" href="#15">15</a> <em class="comment"> * See the License for the specific language governing permissions and</em>
|
| <a name="16" href="#16">16</a> <em class="comment"> * limitations under the License.</em>
|
| <a name="17" href="#17">17</a> <em class="comment"> *</em>
|
| <a name="18" href="#18">18</a> <em class="comment"> */</em>
|
| <a name="19" href="#19">19</a> <strong>package</strong> <a href="../../../../org/apache/mina/common/package-summary.html">org.apache.mina.common</a>;
|
| <a name="20" href="#20">20</a>
|
| <a name="21" href="#21">21</a> <strong>import</strong> java.net.SocketAddress;
|
| <a name="22" href="#22">22</a> <strong>import</strong> java.util.Set;
|
| <a name="23" href="#23">23</a>
|
| <a name="24" href="#24">24</a> <em>/**<em>*</em></em>
|
| <a name="25" href="#25">25</a> <em> * A handle which represents connection between two endpoints regardless of </em>
|
| <a name="26" href="#26">26</a> <em> * transport types.</em>
|
| <a name="27" href="#27">27</a> <em> * <p></em>
|
| <a name="28" href="#28">28</a> <em> * {@link IoSession} provides user-defined attributes. User-defined attributes</em>
|
| <a name="29" href="#29">29</a> <em> * are application-specific data which is associated with a session.</em>
|
| <a name="30" href="#30">30</a> <em> * It often contains objects that represents the state of a higher-level protocol</em>
|
| <a name="31" href="#31">31</a> <em> * and becomes a way to exchange data between filters and handlers.</em>
|
| <a name="32" href="#32">32</a> <em> * </em>
|
| <a name="33" href="#33">33</a> <em> * <h3>Adjusting Transport Type Specific Properties</h3></em>
|
| <a name="34" href="#34">34</a> <em> * <p></em>
|
| <a name="35" href="#35">35</a> <em> * You can simply downcast the session to an appropriate subclass.</em>
|
| <a name="36" href="#36">36</a> <em> * </p></em>
|
| <a name="37" href="#37">37</a> <em> * </em>
|
| <a name="38" href="#38">38</a> <em> * <h3>Thread Safety</h3></em>
|
| <a name="39" href="#39">39</a> <em> * <p></em>
|
| <a name="40" href="#40">40</a> <em> * {@link IoSession} is thread-safe. But please note that performing</em>
|
| <a name="41" href="#41">41</a> <em> * more than one {@link #write(Object)} calls at the same time will</em>
|
| <a name="42" href="#42">42</a> <em> * cause the {@link IoFilter#filterWrite(IoFilter.NextFilter, IoSession, IoFilter.WriteRequest)}</em>
|
| <a name="43" href="#43">43</a> <em> * is executed simnutaneously, and therefore you have to make sure the</em>
|
| <a name="44" href="#44">44</a> <em> * {@link IoFilter} implementations you're using are thread-safe, too. </em>
|
| <a name="45" href="#45">45</a> <em> * </p></em>
|
| <a name="46" href="#46">46</a> <em> * </em>
|
| <a name="47" href="#47">47</a> <em> * @author The Apache Directory Project (dev@directory.apache.org)</em>
|
| <a name="48" href="#48">48</a> <em> * @version $Rev: 355016 $, $Date: 2005-12-08 16:00:30 +0900 (Thu, 08 Dec 2005) $</em>
|
| <a name="49" href="#49">49</a> <em> */</em>
|
| <a name="50" href="#50">50</a> <strong>public</strong> <strong>interface</strong> <a href="../../../../org/apache/mina/common/IoSession.html">IoSession</a> {
|
| <a name="51" href="#51">51</a>
|
| <a name="52" href="#52">52</a> <em>/**<em>*</em></em>
|
| <a name="53" href="#53">53</a> <em> * Returns the {@link IoSessionManager} which manages this session.</em>
|
| <a name="54" href="#54">54</a> <em> */</em>
|
| <a name="55" href="#55">55</a> <a href="../../../../org/apache/mina/common/IoSessionManager.html">IoSessionManager</a> getManager();
|
| <a name="56" href="#56">56</a>
|
| <a name="57" href="#57">57</a> <em>/**<em>*</em></em>
|
| <a name="58" href="#58">58</a> <em> * Returns the {@link IoHandler} which handles this session.</em>
|
| <a name="59" href="#59">59</a> <em> */</em>
|
| <a name="60" href="#60">60</a> <a href="../../../../org/apache/mina/common/IoHandler.html">IoHandler</a> getHandler();
|
| <a name="61" href="#61">61</a>
|
| <a name="62" href="#62">62</a> <em>/**<em>*</em></em>
|
| <a name="63" href="#63">63</a> <em> * Returns the filter chain that only affects this session.</em>
|
| <a name="64" href="#64">64</a> <em> */</em>
|
| <a name="65" href="#65">65</a> <a href="../../../../org/apache/mina/common/IoFilterChain.html">IoFilterChain</a> getFilterChain();
|
| <a name="66" href="#66">66</a>
|
| <a name="67" href="#67">67</a> <em>/**<em>*</em></em>
|
| <a name="68" href="#68">68</a> <em> * Writes the specified <code>message</code> to remote peer. This</em>
|
| <a name="69" href="#69">69</a> <em> * operation is asynchronous; {@link IoHandler#messageSent(IoSession, Object)}</em>
|
| <a name="70" href="#70">70</a> <em> * will be invoked when the message is actually sent to remote peer.</em>
|
| <a name="71" href="#71">71</a> <em> * You can also ait for the returned {@link WriteFuture} if you want</em>
|
| <a name="72" href="#72">72</a> <em> * to wait for the session actually closed.</em>
|
| <a name="73" href="#73">73</a> <em> */</em>
|
| <a name="74" href="#74">74</a> <a href="../../../../org/apache/mina/common/WriteFuture.html">WriteFuture</a> write( Object message );
|
| <a name="75" href="#75">75</a>
|
| <a name="76" href="#76">76</a> <em>/**<em>*</em></em>
|
| <a name="77" href="#77">77</a> <em> * Closes this session immediately. This operation is asynthronous.</em>
|
| <a name="78" href="#78">78</a> <em> * Wait for the returned {@link CloseFuture} if you want to wait for</em>
|
| <a name="79" href="#79">79</a> <em> * the session actually closed.</em>
|
| <a name="80" href="#80">80</a> <em> */</em>
|
| <a name="81" href="#81">81</a> <a href="../../../../org/apache/mina/common/CloseFuture.html">CloseFuture</a> close();
|
| <a name="82" href="#82">82</a>
|
| <a name="83" href="#83">83</a> <em>/**<em>*</em></em>
|
| <a name="84" href="#84">84</a> <em> * Returns an attachment of this session.</em>
|
| <a name="85" href="#85">85</a> <em> * This method is identical with <tt>getAttribute( "" )</tt>.</em>
|
| <a name="86" href="#86">86</a> <em> */</em>
|
| <a name="87" href="#87">87</a> Object getAttachment();
|
| <a name="88" href="#88">88</a>
|
| <a name="89" href="#89">89</a> <em>/**<em>*</em></em>
|
| <a name="90" href="#90">90</a> <em> * Sets an attachment of this session.</em>
|
| <a name="91" href="#91">91</a> <em> * This method is identical with <tt>setAttribute( "", attachment )</tt>.</em>
|
| <a name="92" href="#92">92</a> <em> * </em>
|
| <a name="93" href="#93">93</a> <em> * @return Old attachment. <tt>null</tt> if it is new.</em>
|
| <a name="94" href="#94">94</a> <em> */</em>
|
| <a name="95" href="#95">95</a> Object setAttachment( Object attachment );
|
| <a name="96" href="#96">96</a>
|
| <a name="97" href="#97">97</a> <em>/**<em>*</em></em>
|
| <a name="98" href="#98">98</a> <em> * Returns the value of user-defined attribute of this session.</em>
|
| <a name="99" href="#99">99</a> <em> * </em>
|
| <a name="100" href="#100">100</a> <em> * @param key the key of the attribute</em>
|
| <a name="101" href="#101">101</a> <em> * @return <tt>null</tt> if there is no attribute with the specified key</em>
|
| <a name="102" href="#102">102</a> <em> */</em>
|
| <a name="103" href="#103">103</a> Object getAttribute( String key );
|
| <a name="104" href="#104">104</a>
|
| <a name="105" href="#105">105</a> <em>/**<em>*</em></em>
|
| <a name="106" href="#106">106</a> <em> * Sets a user-defined attribute.</em>
|
| <a name="107" href="#107">107</a> <em> * </em>
|
| <a name="108" href="#108">108</a> <em> * @param key the key of the attribute</em>
|
| <a name="109" href="#109">109</a> <em> * @param value the value of the attribute</em>
|
| <a name="110" href="#110">110</a> <em> * @return The old value of the attribute. <tt>null</tt> if it is new.</em>
|
| <a name="111" href="#111">111</a> <em> */</em>
|
| <a name="112" href="#112">112</a> Object setAttribute( String key, Object value );
|
| <a name="113" href="#113">113</a>
|
| <a name="114" href="#114">114</a> <em>/**<em>*</em></em>
|
| <a name="115" href="#115">115</a> <em> * Sets a user defined attribute without a value. This is useful when</em>
|
| <a name="116" href="#116">116</a> <em> * you just want to put a 'mark' attribute. Its value is set to</em>
|
| <a name="117" href="#117">117</a> <em> * {@link Boolean#TRUE}.</em>
|
| <a name="118" href="#118">118</a> <em> * </em>
|
| <a name="119" href="#119">119</a> <em> * @param key the key of the attribute</em>
|
| <a name="120" href="#120">120</a> <em> * @return The old value of the attribute. <tt>null</tt> if it is new.</em>
|
| <a name="121" href="#121">121</a> <em> */</em>
|
| <a name="122" href="#122">122</a> Object setAttribute( String key );
|
| <a name="123" href="#123">123</a>
|
| <a name="124" href="#124">124</a> <em>/**<em>*</em></em>
|
| <a name="125" href="#125">125</a> <em> * Removes a user-defined attribute with the specified key.</em>
|
| <a name="126" href="#126">126</a> <em> * </em>
|
| <a name="127" href="#127">127</a> <em> * @return The old value of the attribute. <tt>null</tt> if not found.</em>
|
| <a name="128" href="#128">128</a> <em> */</em>
|
| <a name="129" href="#129">129</a> Object removeAttribute( String key );
|
| <a name="130" href="#130">130</a>
|
| <a name="131" href="#131">131</a> <em>/**<em>*</em></em>
|
| <a name="132" href="#132">132</a> <em> * Returns <tt>true</tt> if this session contains the attribute with</em>
|
| <a name="133" href="#133">133</a> <em> * the specified <tt>key</tt>.</em>
|
| <a name="134" href="#134">134</a> <em> */</em>
|
| <a name="135" href="#135">135</a> <strong>boolean</strong> containsAttribute( String key );
|
| <a name="136" href="#136">136</a>
|
| <a name="137" href="#137">137</a> <em>/**<em>*</em></em>
|
| <a name="138" href="#138">138</a> <em> * Returns the set of keys of all user-defined attributes.</em>
|
| <a name="139" href="#139">139</a> <em> */</em>
|
| <a name="140" href="#140">140</a> Set getAttributeKeys();
|
| <a name="141" href="#141">141</a>
|
| <a name="142" href="#142">142</a> <em>/**<em>*</em></em>
|
| <a name="143" href="#143">143</a> <em> * Returns transport type of this session.</em>
|
| <a name="144" href="#144">144</a> <em> */</em>
|
| <a name="145" href="#145">145</a> <a href="../../../../org/apache/mina/common/TransportType.html">TransportType</a> getTransportType();
|
| <a name="146" href="#146">146</a>
|
| <a name="147" href="#147">147</a> <em>/**<em>*</em></em>
|
| <a name="148" href="#148">148</a> <em> * Returns <code>true</code> if this session is connected with remote peer.</em>
|
| <a name="149" href="#149">149</a> <em> */</em>
|
| <a name="150" href="#150">150</a> <strong>boolean</strong> isConnected();
|
| <a name="151" href="#151">151</a>
|
| <a name="152" href="#152">152</a> <em>/**<em>*</em></em>
|
| <a name="153" href="#153">153</a> <em> * Returns <code>true</tt> if and only if this session is being closed</em>
|
| <a name="154" href="#154">154</a> <em> * (but not disconnected yet) or is closed.</em>
|
| <a name="155" href="#155">155</a> <em> */</em>
|
| <a name="156" href="#156">156</a> <strong>boolean</strong> isClosing();
|
| <a name="157" href="#157">157</a>
|
| <a name="158" href="#158">158</a> <em>/**<em>*</em></em>
|
| <a name="159" href="#159">159</a> <em> * Returns the {@link CloseFuture} of this session. This method returns</em>
|
| <a name="160" href="#160">160</a> <em> * the same instance whenever user calls it.</em>
|
| <a name="161" href="#161">161</a> <em> */</em>
|
| <a name="162" href="#162">162</a> <a href="../../../../org/apache/mina/common/CloseFuture.html">CloseFuture</a> getCloseFuture();
|
| <a name="163" href="#163">163</a>
|
| <a name="164" href="#164">164</a> <em>/**<em>*</em></em>
|
| <a name="165" href="#165">165</a> <em> * Returns the socket address of remote peer. </em>
|
| <a name="166" href="#166">166</a> <em> */</em>
|
| <a name="167" href="#167">167</a> SocketAddress getRemoteAddress();
|
| <a name="168" href="#168">168</a>
|
| <a name="169" href="#169">169</a> <em>/**<em>*</em></em>
|
| <a name="170" href="#170">170</a> <em> * Returns the socket address of local machine which is associated with this</em>
|
| <a name="171" href="#171">171</a> <em> * session.</em>
|
| <a name="172" href="#172">172</a> <em> */</em>
|
| <a name="173" href="#173">173</a> SocketAddress getLocalAddress();
|
| <a name="174" href="#174">174</a>
|
| <a name="175" href="#175">175</a> <em>/**<em>*</em></em>
|
| <a name="176" href="#176">176</a> <em> * Returns idle time for the specified type of idleness in seconds.</em>
|
| <a name="177" href="#177">177</a> <em> */</em>
|
| <a name="178" href="#178">178</a> <strong>int</strong> getIdleTime( IdleStatus status );
|
| <a name="179" href="#179">179</a>
|
| <a name="180" href="#180">180</a> <em>/**<em>*</em></em>
|
| <a name="181" href="#181">181</a> <em> * Returns idle time for the specified type of idleness in milliseconds.</em>
|
| <a name="182" href="#182">182</a> <em> */</em>
|
| <a name="183" href="#183">183</a> <strong>long</strong> getIdleTimeInMillis( IdleStatus status );
|
| <a name="184" href="#184">184</a>
|
| <a name="185" href="#185">185</a> <em>/**<em>*</em></em>
|
| <a name="186" href="#186">186</a> <em> * Sets idle time for the specified type of idleness in seconds.</em>
|
| <a name="187" href="#187">187</a> <em> */</em>
|
| <a name="188" href="#188">188</a> <strong>void</strong> setIdleTime( IdleStatus status, <strong>int</strong> idleTime );
|
| <a name="189" href="#189">189</a>
|
| <a name="190" href="#190">190</a> <em>/**<em>*</em></em>
|
| <a name="191" href="#191">191</a> <em> * Returns write timeout in seconds.</em>
|
| <a name="192" href="#192">192</a> <em> */</em>
|
| <a name="193" href="#193">193</a> <strong>int</strong> getWriteTimeout();
|
| <a name="194" href="#194">194</a>
|
| <a name="195" href="#195">195</a> <em>/**<em>*</em></em>
|
| <a name="196" href="#196">196</a> <em> * Returns write timeout in milliseconds.</em>
|
| <a name="197" href="#197">197</a> <em> */</em>
|
| <a name="198" href="#198">198</a> <strong>long</strong> getWriteTimeoutInMillis();
|
| <a name="199" href="#199">199</a>
|
| <a name="200" href="#200">200</a> <em>/**<em>*</em></em>
|
| <a name="201" href="#201">201</a> <em> * Sets write timeout in seconds.</em>
|
| <a name="202" href="#202">202</a> <em> */</em>
|
| <a name="203" href="#203">203</a> <strong>void</strong> setWriteTimeout( <strong>int</strong> writeTimeout );
|
| <a name="204" href="#204">204</a>
|
| <a name="205" href="#205">205</a> <em>/**<em>*</em></em>
|
| <a name="206" href="#206">206</a> <em> * Returns the current {@link TrafficMask} of this session.</em>
|
| <a name="207" href="#207">207</a> <em> */</em>
|
| <a name="208" href="#208">208</a> <a href="../../../../org/apache/mina/common/TrafficMask.html">TrafficMask</a> getTrafficMask();
|
| <a name="209" href="#209">209</a>
|
| <a name="210" href="#210">210</a> <em>/**<em>*</em></em>
|
| <a name="211" href="#211">211</a> <em> * Sets the {@link TrafficMask} of this session which will result</em>
|
| <a name="212" href="#212">212</a> <em> * the parent {@link IoSessionManager} to start to control the traffic</em>
|
| <a name="213" href="#213">213</a> <em> * of this session immediately.</em>
|
| <a name="214" href="#214">214</a> <em> */</em>
|
| <a name="215" href="#215">215</a> <strong>void</strong> setTrafficMask( TrafficMask trafficMask );
|
| <a name="216" href="#216">216</a>
|
| <a name="217" href="#217">217</a> <em>/**<em>*</em></em>
|
| <a name="218" href="#218">218</a> <em> * A shortcut method for {@link #setTrafficMask(TrafficMask)} that</em>
|
| <a name="219" href="#219">219</a> <em> * suspends read operations for this session.</em>
|
| <a name="220" href="#220">220</a> <em> */</em>
|
| <a name="221" href="#221">221</a> <strong>void</strong> suspendRead();
|
| <a name="222" href="#222">222</a>
|
| <a name="223" href="#223">223</a> <em>/**<em>*</em></em>
|
| <a name="224" href="#224">224</a> <em> * A shortcut method for {@link #setTrafficMask(TrafficMask)} that</em>
|
| <a name="225" href="#225">225</a> <em> * suspends write operations for this session.</em>
|
| <a name="226" href="#226">226</a> <em> */</em>
|
| <a name="227" href="#227">227</a> <strong>void</strong> suspendWrite();
|
| <a name="228" href="#228">228</a>
|
| <a name="229" href="#229">229</a> <em>/**<em>*</em></em>
|
| <a name="230" href="#230">230</a> <em> * A shortcut method for {@link #setTrafficMask(TrafficMask)} that</em>
|
| <a name="231" href="#231">231</a> <em> * resumes read operations for this session.</em>
|
| <a name="232" href="#232">232</a> <em> */</em>
|
| <a name="233" href="#233">233</a> <strong>void</strong> resumeRead();
|
| <a name="234" href="#234">234</a>
|
| <a name="235" href="#235">235</a> <em>/**<em>*</em></em>
|
| <a name="236" href="#236">236</a> <em> * A shortcut method for {@link #setTrafficMask(TrafficMask)} that</em>
|
| <a name="237" href="#237">237</a> <em> * resumes write operations for this session.</em>
|
| <a name="238" href="#238">238</a> <em> */</em>
|
| <a name="239" href="#239">239</a> <strong>void</strong> resumeWrite();
|
| <a name="240" href="#240">240</a>
|
| <a name="241" href="#241">241</a> <em>/**<em>*</em></em>
|
| <a name="242" href="#242">242</a> <em> * Returns the total number of bytes which were read from this session.</em>
|
| <a name="243" href="#243">243</a> <em> */</em>
|
| <a name="244" href="#244">244</a> <strong>long</strong> getReadBytes();
|
| <a name="245" href="#245">245</a>
|
| <a name="246" href="#246">246</a> <em>/**<em>*</em></em>
|
| <a name="247" href="#247">247</a> <em> * Returns the total number of bytes which were written to this session.</em>
|
| <a name="248" href="#248">248</a> <em> */</em>
|
| <a name="249" href="#249">249</a> <strong>long</strong> getWrittenBytes();
|
| <a name="250" href="#250">250</a>
|
| <a name="251" href="#251">251</a> <em>/**<em>*</em></em>
|
| <a name="252" href="#252">252</a> <em> * Returns the total number of write requests which were written to this session.</em>
|
| <a name="253" href="#253">253</a> <em> */</em>
|
| <a name="254" href="#254">254</a> <strong>long</strong> getWrittenWriteRequests();
|
| <a name="255" href="#255">255</a>
|
| <a name="256" href="#256">256</a> <em>/**<em>*</em></em>
|
| <a name="257" href="#257">257</a> <em> * Returns the number of write requests which are scheduled to be written</em>
|
| <a name="258" href="#258">258</a> <em> * to this session.</em>
|
| <a name="259" href="#259">259</a> <em> */</em>
|
| <a name="260" href="#260">260</a> <strong>int</strong> getScheduledWriteRequests();
|
| <a name="261" href="#261">261</a>
|
| <a name="262" href="#262">262</a> <em>/**<em>*</em></em>
|
| <a name="263" href="#263">263</a> <em> * Returns the time in millis when this session is created.</em>
|
| <a name="264" href="#264">264</a> <em> */</em>
|
| <a name="265" href="#265">265</a> <strong>long</strong> getCreationTime();
|
| <a name="266" href="#266">266</a>
|
| <a name="267" href="#267">267</a> <em>/**<em>*</em></em>
|
| <a name="268" href="#268">268</a> <em> * Returns the time in millis when I/O occurred lastly.</em>
|
| <a name="269" href="#269">269</a> <em> */</em>
|
| <a name="270" href="#270">270</a> <strong>long</strong> getLastIoTime();
|
| <a name="271" href="#271">271</a>
|
| <a name="272" href="#272">272</a> <em>/**<em>*</em></em>
|
| <a name="273" href="#273">273</a> <em> * Returns the time in millis when read operation occurred lastly.</em>
|
| <a name="274" href="#274">274</a> <em> */</em>
|
| <a name="275" href="#275">275</a> <strong>long</strong> getLastReadTime();
|
| <a name="276" href="#276">276</a>
|
| <a name="277" href="#277">277</a> <em>/**<em>*</em></em>
|
| <a name="278" href="#278">278</a> <em> * Returns the time in millis when write operation occurred lastly.</em>
|
| <a name="279" href="#279">279</a> <em> */</em>
|
| <a name="280" href="#280">280</a> <strong>long</strong> getLastWriteTime();
|
| <a name="281" href="#281">281</a>
|
| <a name="282" href="#282">282</a> <em>/**<em>*</em></em>
|
| <a name="283" href="#283">283</a> <em> * Returns <code>true</code> if this session is idle for the specified </em>
|
| <a name="284" href="#284">284</a> <em> * {@link IdleStatus}.</em>
|
| <a name="285" href="#285">285</a> <em> */</em>
|
| <a name="286" href="#286">286</a> <strong>boolean</strong> isIdle( IdleStatus status );
|
| <a name="287" href="#287">287</a>
|
| <a name="288" href="#288">288</a> <em>/**<em>*</em></em>
|
| <a name="289" href="#289">289</a> <em> * Returns the number of the fired continuous <tt>sessionIdle</tt> events</em>
|
| <a name="290" href="#290">290</a> <em> * for the specified {@link IdleStatus}.</em>
|
| <a name="291" href="#291">291</a> <em> * <p></em>
|
| <a name="292" href="#292">292</a> <em> * If <tt>sessionIdle</tt> event is fired first after some time after I/O,</em>
|
| <a name="293" href="#293">293</a> <em> * <tt>idleCount</tt> becomes <tt>1</tt>. <tt>idleCount</tt> resets to</em>
|
| <a name="294" href="#294">294</a> <em> * <tt>0</tt> if any I/O occurs again, otherwise it increases to</em>
|
| <a name="295" href="#295">295</a> <em> * <tt>2</tt> and so on if <tt>sessionIdle</tt> event is fired again without</em>
|
| <a name="296" href="#296">296</a> <em> * any I/O between two (or more) <tt>sessionIdle</tt> events.</em>
|
| <a name="297" href="#297">297</a> <em> */</em>
|
| <a name="298" href="#298">298</a> <strong>int</strong> getIdleCount( IdleStatus status );
|
| <a name="299" href="#299">299</a>
|
| <a name="300" href="#300">300</a> <em>/**<em>*</em></em>
|
| <a name="301" href="#301">301</a> <em> * Returns the time in millis when the last <tt>sessionIdle</tt> event</em>
|
| <a name="302" href="#302">302</a> <em> * is fired for the specified {@link IdleStatus}.</em>
|
| <a name="303" href="#303">303</a> <em> */</em>
|
| <a name="304" href="#304">304</a> <strong>long</strong> getLastIdleTime( IdleStatus status );
|
| <a name="305" href="#305">305</a> }
|
| </pre> |
| <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> |
| </html> |
|
|
