| <!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=UTF-8" /> |
| <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="jxr_comment">/*</em> |
| <a name="2" href="#2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em> |
| <a name="3" href="#3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em> |
| <a name="4" href="#4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em> |
| <a name="5" href="#5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em> |
| <a name="6" href="#6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em> |
| <a name="7" href="#7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em> |
| <a name="8" href="#8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em> |
| <a name="9" href="#9">9</a> <em class="jxr_comment"> *</em> |
| <a name="10" href="#10">10</a> <em class="jxr_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="jxr_comment"> *</em> |
| <a name="12" href="#12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em> |
| <a name="13" href="#13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em> |
| <a name="14" href="#14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em> |
| <a name="15" href="#15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em> |
| <a name="16" href="#16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em> |
| <a name="17" href="#17">17</a> <em class="jxr_comment"> * under the License.</em> |
| <a name="18" href="#18">18</a> <em class="jxr_comment"> *</em> |
| <a name="19" href="#19">19</a> <em class="jxr_comment"> */</em> |
| <a name="20" href="#20">20</a> <strong class="jxr_keyword">package</strong> org.apache.mina.common; |
| <a name="21" href="#21">21</a> |
| <a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> java.net.SocketAddress; |
| <a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> java.util.Set; |
| <a name="24" href="#24">24</a> |
| <a name="25" href="#25">25</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="26" href="#26">26</a> <em class="jxr_javadoccomment"> * A handle which represents connection between two end-points regardless of</em> |
| <a name="27" href="#27">27</a> <em class="jxr_javadoccomment"> * transport types.</em> |
| <a name="28" href="#28">28</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="29" href="#29">29</a> <em class="jxr_javadoccomment"> * {@link IoSession} provides user-defined attributes. User-defined attributes</em> |
| <a name="30" href="#30">30</a> <em class="jxr_javadoccomment"> * are application-specific data which is associated with a session.</em> |
| <a name="31" href="#31">31</a> <em class="jxr_javadoccomment"> * It often contains objects that represents the state of a higher-level protocol</em> |
| <a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * and becomes a way to exchange data between filters and handlers.</em> |
| <a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * <h3>Adjusting Transport Type Specific Properties</h3></em> |
| <a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * You can simply downcast the session to an appropriate subclass.</em> |
| <a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * </p></em> |
| <a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * <h3>Thread Safety</h3></em> |
| <a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * {@link IoSession} is thread-safe. But please note that performing</em> |
| <a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * more than one {@link #write(Object)} calls at the same time will</em> |
| <a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * cause the {@link IoFilter#filterWrite(IoFilter.NextFilter,IoSession,WriteRequest)}</em> |
| <a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * is executed simultaneously, and therefore you have to make sure the</em> |
| <a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * {@link IoFilter} implementations you're using are thread-safe, too.</em> |
| <a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * </p></em> |
| <a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * <h3>Equality of Sessions</h3></em> |
| <a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * {@link #equals(Object)} and {@link #hashCode()} shall not be overriden</em> |
| <a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * to the default behavior that is defined in {@link Object}.</em> |
| <a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * @author The Apache MINA Project (dev@mina.apache.org)</em> |
| <a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * @version $Rev: 601679 $, $Date: 2007-12-06 03:13:21 -0700 (Thu, 06 Dec 2007) $</em> |
| <a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="55" href="#55">55</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a href="../../../../org/apache/mina/common/IoSession.html">IoSession</a> { |
| <a name="56" href="#56">56</a> |
| <a name="57" href="#57">57</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="58" href="#58">58</a> <em class="jxr_javadoccomment"> * Returns a unique identifier of this session. Every session has its own</em> |
| <a name="59" href="#59">59</a> <em class="jxr_javadoccomment"> * ID which is different from each other.</em> |
| <a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="61" href="#61">61</a> <strong class="jxr_keyword">long</strong> getId(); |
| <a name="62" href="#62">62</a> |
| <a name="63" href="#63">63</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * Returns the {@link IoService} which provides I/O service to this session.</em> |
| <a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="66" href="#66">66</a> <a href="../../../../org/apache/mina/common/IoService.html">IoService</a> getService(); |
| <a name="67" href="#67">67</a> |
| <a name="68" href="#68">68</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="69" href="#69">69</a> <em class="jxr_javadoccomment"> * Returns the {@link IoHandler} which handles this session.</em> |
| <a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="71" href="#71">71</a> <a href="../../../../org/apache/mina/common/IoHandler.html">IoHandler</a> getHandler(); |
| <a name="72" href="#72">72</a> |
| <a name="73" href="#73">73</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="74" href="#74">74</a> <em class="jxr_javadoccomment"> * Returns the configuration of this session.</em> |
| <a name="75" href="#75">75</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="76" href="#76">76</a> <a href="../../../../org/apache/mina/common/IoSessionConfig.html">IoSessionConfig</a> getConfig(); |
| <a name="77" href="#77">77</a> |
| <a name="78" href="#78">78</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="79" href="#79">79</a> <em class="jxr_javadoccomment"> * Returns the filter chain that only affects this session.</em> |
| <a name="80" href="#80">80</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="81" href="#81">81</a> <a href="../../../../org/apache/mina/common/IoFilterChain.html">IoFilterChain</a> getFilterChain(); |
| <a name="82" href="#82">82</a> |
| <a name="83" href="#83">83</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="84" href="#84">84</a> <em class="jxr_javadoccomment"> * Returns the {@link TransportMetadata} that this session runs on.</em> |
| <a name="85" href="#85">85</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="86" href="#86">86</a> <a href="../../../../org/apache/mina/common/TransportMetadata.html">TransportMetadata</a> getTransportMetadata(); |
| <a name="87" href="#87">87</a> |
| <a name="88" href="#88">88</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="89" href="#89">89</a> <em class="jxr_javadoccomment"> * Returns a {@link ReadFuture} which is notified when a new message is</em> |
| <a name="90" href="#90">90</a> <em class="jxr_javadoccomment"> * received, the connection is closed or an exception is caught. This</em> |
| <a name="91" href="#91">91</a> <em class="jxr_javadoccomment"> * operation is especially useful when you implement a client application.</em> |
| <a name="92" href="#92">92</a> <em class="jxr_javadoccomment"> * However, please note that this operation is disabled by default and</em> |
| <a name="93" href="#93">93</a> <em class="jxr_javadoccomment"> * throw {@link IllegalStateException} because all received events must be</em> |
| <a name="94" href="#94">94</a> <em class="jxr_javadoccomment"> * queued somewhere to support this operation, possibly leading to memory</em> |
| <a name="95" href="#95">95</a> <em class="jxr_javadoccomment"> * leak. This means you have to keep calling {@link #read()} once you</em> |
| <a name="96" href="#96">96</a> <em class="jxr_javadoccomment"> * enabled this operation. To enable this operation, please call</em> |
| <a name="97" href="#97">97</a> <em class="jxr_javadoccomment"> * {@link IoSessionConfig#setUseReadOperation(boolean)} with <tt>true</tt>. </em> |
| <a name="98" href="#98">98</a> <em class="jxr_javadoccomment"> * </em> |
| <a name="99" href="#99">99</a> <em class="jxr_javadoccomment"> * @throws IllegalStateException if</em> |
| <a name="100" href="#100">100</a> <em class="jxr_javadoccomment"> * {@link IoSessionConfig#setUseReadOperation(boolean) useReadOperation}</em> |
| <a name="101" href="#101">101</a> <em class="jxr_javadoccomment"> * option has not been enabled.</em> |
| <a name="102" href="#102">102</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="103" href="#103">103</a> <a href="../../../../org/apache/mina/common/ReadFuture.html">ReadFuture</a> read(); |
| <a name="104" href="#104">104</a> |
| <a name="105" href="#105">105</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="106" href="#106">106</a> <em class="jxr_javadoccomment"> * Writes the specified <code>message</code> to remote peer. This</em> |
| <a name="107" href="#107">107</a> <em class="jxr_javadoccomment"> * operation is asynchronous; {@link IoHandler#messageSent(IoSession,Object)}</em> |
| <a name="108" href="#108">108</a> <em class="jxr_javadoccomment"> * will be invoked when the message is actually sent to remote peer.</em> |
| <a name="109" href="#109">109</a> <em class="jxr_javadoccomment"> * You can also wait for the returned {@link WriteFuture} if you want</em> |
| <a name="110" href="#110">110</a> <em class="jxr_javadoccomment"> * to wait for the message actually written.</em> |
| <a name="111" href="#111">111</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="112" href="#112">112</a> <a href="../../../../org/apache/mina/common/WriteFuture.html">WriteFuture</a> write(Object message); |
| <a name="113" href="#113">113</a> |
| <a name="114" href="#114">114</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="115" href="#115">115</a> <em class="jxr_javadoccomment"> * (Optional) Writes the specified <tt>message</tt> to the specified <tt>destination</tt>.</em> |
| <a name="116" href="#116">116</a> <em class="jxr_javadoccomment"> * This operation is asynchronous; {@link IoHandler#messageSent(IoSession, Object)}</em> |
| <a name="117" href="#117">117</a> <em class="jxr_javadoccomment"> * will be invoked when the message is actually sent to remote peer. You can</em> |
| <a name="118" href="#118">118</a> <em class="jxr_javadoccomment"> * also wait for the returned {@link WriteFuture} if you want to wait for</em> |
| <a name="119" href="#119">119</a> <em class="jxr_javadoccomment"> * the message actually written.</em> |
| <a name="120" href="#120">120</a> <em class="jxr_javadoccomment"> * <p></em> |
| <a name="121" href="#121">121</a> <em class="jxr_javadoccomment"> * When you implement a client that receives a broadcast message from a server</em> |
| <a name="122" href="#122">122</a> <em class="jxr_javadoccomment"> * such as DHCP server, the client might need to send a response message for the</em> |
| <a name="123" href="#123">123</a> <em class="jxr_javadoccomment"> * broadcast message the server sent. Because the remote address of the session</em> |
| <a name="124" href="#124">124</a> <em class="jxr_javadoccomment"> * is not the address of the server in case of broadcasting, there should be a</em> |
| <a name="125" href="#125">125</a> <em class="jxr_javadoccomment"> * way to specify the destination when you write the response message.</em> |
| <a name="126" href="#126">126</a> <em class="jxr_javadoccomment"> * This interface provides {@link #write(Object, SocketAddress)} method so you</em> |
| <a name="127" href="#127">127</a> <em class="jxr_javadoccomment"> * can specify the destination.</em> |
| <a name="128" href="#128">128</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="129" href="#129">129</a> <em class="jxr_javadoccomment"> * @param destination <tt>null</tt> if you want the message sent to the</em> |
| <a name="130" href="#130">130</a> <em class="jxr_javadoccomment"> * default remote address</em> |
| <a name="131" href="#131">131</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="132" href="#132">132</a> <em class="jxr_javadoccomment"> * @throws UnsupportedOperationException if this operation is not supported</em> |
| <a name="133" href="#133">133</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="134" href="#134">134</a> <a href="../../../../org/apache/mina/common/WriteFuture.html">WriteFuture</a> write(Object message, SocketAddress destination); |
| <a name="135" href="#135">135</a> |
| <a name="136" href="#136">136</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="137" href="#137">137</a> <em class="jxr_javadoccomment"> * Closes this session immediately. This operation is asynchronous.</em> |
| <a name="138" href="#138">138</a> <em class="jxr_javadoccomment"> * Wait for the returned {@link CloseFuture} if you want to wait for</em> |
| <a name="139" href="#139">139</a> <em class="jxr_javadoccomment"> * the session actually closed.</em> |
| <a name="140" href="#140">140</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="141" href="#141">141</a> <a href="../../../../org/apache/mina/common/CloseFuture.html">CloseFuture</a> close(); |
| <a name="142" href="#142">142</a> |
| <a name="143" href="#143">143</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="144" href="#144">144</a> <em class="jxr_javadoccomment"> * Closes this session after all queued write requests are flushed.</em> |
| <a name="145" href="#145">145</a> <em class="jxr_javadoccomment"> * This operation is asynchronous. Wait for the returned {@link CloseFuture}</em> |
| <a name="146" href="#146">146</a> <em class="jxr_javadoccomment"> * if you want to wait for the session actually closed.</em> |
| <a name="147" href="#147">147</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="148" href="#148">148</a> <a href="../../../../org/apache/mina/common/CloseFuture.html">CloseFuture</a> closeOnFlush(); |
| <a name="149" href="#149">149</a> |
| <a name="150" href="#150">150</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="151" href="#151">151</a> <em class="jxr_javadoccomment"> * Closes this session immediately or after all queued write requests</em> |
| <a name="152" href="#152">152</a> <em class="jxr_javadoccomment"> * are flushed. This operation is asynchronous. Wait for the returned</em> |
| <a name="153" href="#153">153</a> <em class="jxr_javadoccomment"> * {@link CloseFuture} if you want to wait for the session actually closed.</em> |
| <a name="154" href="#154">154</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="155" href="#155">155</a> <em class="jxr_javadoccomment"> * @param immediately {@code true} to close this session immediately</em> |
| <a name="156" href="#156">156</a> <em class="jxr_javadoccomment"> * (i.e. {@link #close()}).</em> |
| <a name="157" href="#157">157</a> <em class="jxr_javadoccomment"> * {@code false} to close this session after all queued</em> |
| <a name="158" href="#158">158</a> <em class="jxr_javadoccomment"> * write requests are flushed (i.e. {@link #closeOnFlush()}).</em> |
| <a name="159" href="#159">159</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="160" href="#160">160</a> <a href="../../../../org/apache/mina/common/CloseFuture.html">CloseFuture</a> close(<strong class="jxr_keyword">boolean</strong> immediately); |
| <a name="161" href="#161">161</a> |
| <a name="162" href="#162">162</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="163" href="#163">163</a> <em class="jxr_javadoccomment"> * Returns an attachment of this session.</em> |
| <a name="164" href="#164">164</a> <em class="jxr_javadoccomment"> * This method is identical with <tt>getAttribute( "" )</tt>.</em> |
| <a name="165" href="#165">165</a> <em class="jxr_javadoccomment"> * </em> |
| <a name="166" href="#166">166</a> <em class="jxr_javadoccomment"> * @deprecated Use {@link #getAttribute(Object)} instead.</em> |
| <a name="167" href="#167">167</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="168" href="#168">168</a> @Deprecated Object getAttachment(); |
| <a name="169" href="#169">169</a> |
| <a name="170" href="#170">170</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="171" href="#171">171</a> <em class="jxr_javadoccomment"> * Sets an attachment of this session.</em> |
| <a name="172" href="#172">172</a> <em class="jxr_javadoccomment"> * This method is identical with <tt>setAttribute( "", attachment )</tt>.</em> |
| <a name="173" href="#173">173</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="174" href="#174">174</a> <em class="jxr_javadoccomment"> * @return Old attachment. <tt>null</tt> if it is new.</em> |
| <a name="175" href="#175">175</a> <em class="jxr_javadoccomment"> * @deprecated Use {@link #setAttribute(Object, Object)} instead.</em> |
| <a name="176" href="#176">176</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="177" href="#177">177</a> @Deprecated Object setAttachment(Object attachment); |
| <a name="178" href="#178">178</a> |
| <a name="179" href="#179">179</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="180" href="#180">180</a> <em class="jxr_javadoccomment"> * Returns the value of the user-defined attribute of this session.</em> |
| <a name="181" href="#181">181</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="182" href="#182">182</a> <em class="jxr_javadoccomment"> * @param key the key of the attribute</em> |
| <a name="183" href="#183">183</a> <em class="jxr_javadoccomment"> * @return <tt>null</tt> if there is no attribute with the specified key</em> |
| <a name="184" href="#184">184</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="185" href="#185">185</a> Object getAttribute(Object key); |
| <a name="186" href="#186">186</a> |
| <a name="187" href="#187">187</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="188" href="#188">188</a> <em class="jxr_javadoccomment"> * Returns the value of user defined attribute associated with the</em> |
| <a name="189" href="#189">189</a> <em class="jxr_javadoccomment"> * specified key. If there's no such attribute, the specified default</em> |
| <a name="190" href="#190">190</a> <em class="jxr_javadoccomment"> * value is associated with the specified key, and the default value is</em> |
| <a name="191" href="#191">191</a> <em class="jxr_javadoccomment"> * returned. This method is same with the following code except that the</em> |
| <a name="192" href="#192">192</a> <em class="jxr_javadoccomment"> * operation is performed atomically.</em> |
| <a name="193" href="#193">193</a> <em class="jxr_javadoccomment"> * <pre></em> |
| <a name="194" href="#194">194</a> <em class="jxr_javadoccomment"> * if (containsAttribute(key)) {</em> |
| <a name="195" href="#195">195</a> <em class="jxr_javadoccomment"> * return getAttribute(key);</em> |
| <a name="196" href="#196">196</a> <em class="jxr_javadoccomment"> * } else {</em> |
| <a name="197" href="#197">197</a> <em class="jxr_javadoccomment"> * setAttribute(key, defaultValue);</em> |
| <a name="198" href="#198">198</a> <em class="jxr_javadoccomment"> * return defaultValue;</em> |
| <a name="199" href="#199">199</a> <em class="jxr_javadoccomment"> * }</em> |
| <a name="200" href="#200">200</a> <em class="jxr_javadoccomment"> * </pre></em> |
| <a name="201" href="#201">201</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="202" href="#202">202</a> Object getAttribute(Object key, Object defaultValue); |
| <a name="203" href="#203">203</a> |
| <a name="204" href="#204">204</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="205" href="#205">205</a> <em class="jxr_javadoccomment"> * Sets a user-defined attribute.</em> |
| <a name="206" href="#206">206</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="207" href="#207">207</a> <em class="jxr_javadoccomment"> * @param key the key of the attribute</em> |
| <a name="208" href="#208">208</a> <em class="jxr_javadoccomment"> * @param value the value of the attribute</em> |
| <a name="209" href="#209">209</a> <em class="jxr_javadoccomment"> * @return The old value of the attribute. <tt>null</tt> if it is new.</em> |
| <a name="210" href="#210">210</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="211" href="#211">211</a> Object setAttribute(Object key, Object value); |
| <a name="212" href="#212">212</a> |
| <a name="213" href="#213">213</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="214" href="#214">214</a> <em class="jxr_javadoccomment"> * Sets a user defined attribute without a value. This is useful when</em> |
| <a name="215" href="#215">215</a> <em class="jxr_javadoccomment"> * you just want to put a 'mark' attribute. Its value is set to</em> |
| <a name="216" href="#216">216</a> <em class="jxr_javadoccomment"> * {@link Boolean#TRUE}.</em> |
| <a name="217" href="#217">217</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="218" href="#218">218</a> <em class="jxr_javadoccomment"> * @param key the key of the attribute</em> |
| <a name="219" href="#219">219</a> <em class="jxr_javadoccomment"> * @return The old value of the attribute. <tt>null</tt> if it is new.</em> |
| <a name="220" href="#220">220</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="221" href="#221">221</a> Object setAttribute(Object key); |
| <a name="222" href="#222">222</a> |
| <a name="223" href="#223">223</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="224" href="#224">224</a> <em class="jxr_javadoccomment"> * Sets a user defined attribute if the attribute with the specified key</em> |
| <a name="225" href="#225">225</a> <em class="jxr_javadoccomment"> * is not set yet. This method is same with the following code except</em> |
| <a name="226" href="#226">226</a> <em class="jxr_javadoccomment"> * that the operation is performed atomically.</em> |
| <a name="227" href="#227">227</a> <em class="jxr_javadoccomment"> * <pre></em> |
| <a name="228" href="#228">228</a> <em class="jxr_javadoccomment"> * if (containsAttribute(key)) {</em> |
| <a name="229" href="#229">229</a> <em class="jxr_javadoccomment"> * return getAttribute(key);</em> |
| <a name="230" href="#230">230</a> <em class="jxr_javadoccomment"> * } else {</em> |
| <a name="231" href="#231">231</a> <em class="jxr_javadoccomment"> * return setAttribute(key, value);</em> |
| <a name="232" href="#232">232</a> <em class="jxr_javadoccomment"> * }</em> |
| <a name="233" href="#233">233</a> <em class="jxr_javadoccomment"> * </pre></em> |
| <a name="234" href="#234">234</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="235" href="#235">235</a> Object setAttributeIfAbsent(Object key, Object value); |
| <a name="236" href="#236">236</a> |
| <a name="237" href="#237">237</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="238" href="#238">238</a> <em class="jxr_javadoccomment"> * Sets a user defined attribute without a value if the attribute with</em> |
| <a name="239" href="#239">239</a> <em class="jxr_javadoccomment"> * the specified key is not set yet. This is useful when you just want to</em> |
| <a name="240" href="#240">240</a> <em class="jxr_javadoccomment"> * put a 'mark' attribute. Its value is set to {@link Boolean#TRUE}.</em> |
| <a name="241" href="#241">241</a> <em class="jxr_javadoccomment"> * This method is same with the following code except that the operation</em> |
| <a name="242" href="#242">242</a> <em class="jxr_javadoccomment"> * is performed atomically.</em> |
| <a name="243" href="#243">243</a> <em class="jxr_javadoccomment"> * <pre></em> |
| <a name="244" href="#244">244</a> <em class="jxr_javadoccomment"> * if (containsAttribute(key)) {</em> |
| <a name="245" href="#245">245</a> <em class="jxr_javadoccomment"> * return getAttribute(key); // might not always be Boolean.TRUE.</em> |
| <a name="246" href="#246">246</a> <em class="jxr_javadoccomment"> * } else {</em> |
| <a name="247" href="#247">247</a> <em class="jxr_javadoccomment"> * return setAttribute(key);</em> |
| <a name="248" href="#248">248</a> <em class="jxr_javadoccomment"> * }</em> |
| <a name="249" href="#249">249</a> <em class="jxr_javadoccomment"> * </pre></em> |
| <a name="250" href="#250">250</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="251" href="#251">251</a> Object setAttributeIfAbsent(Object key); |
| <a name="252" href="#252">252</a> |
| <a name="253" href="#253">253</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="254" href="#254">254</a> <em class="jxr_javadoccomment"> * Removes a user-defined attribute with the specified key.</em> |
| <a name="255" href="#255">255</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="256" href="#256">256</a> <em class="jxr_javadoccomment"> * @return The old value of the attribute. <tt>null</tt> if not found.</em> |
| <a name="257" href="#257">257</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="258" href="#258">258</a> Object removeAttribute(Object key); |
| <a name="259" href="#259">259</a> |
| <a name="260" href="#260">260</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="261" href="#261">261</a> <em class="jxr_javadoccomment"> * Removes a user defined attribute with the specified key if the current</em> |
| <a name="262" href="#262">262</a> <em class="jxr_javadoccomment"> * attribute value is equal to the specified value. This method is same</em> |
| <a name="263" href="#263">263</a> <em class="jxr_javadoccomment"> * with the following code except that the operation is performed</em> |
| <a name="264" href="#264">264</a> <em class="jxr_javadoccomment"> * atomically.</em> |
| <a name="265" href="#265">265</a> <em class="jxr_javadoccomment"> * <pre></em> |
| <a name="266" href="#266">266</a> <em class="jxr_javadoccomment"> * if (containsAttribute(key) && getAttribute(key).equals(value)) {</em> |
| <a name="267" href="#267">267</a> <em class="jxr_javadoccomment"> * removeAttribute(key);</em> |
| <a name="268" href="#268">268</a> <em class="jxr_javadoccomment"> * return true;</em> |
| <a name="269" href="#269">269</a> <em class="jxr_javadoccomment"> * } else {</em> |
| <a name="270" href="#270">270</a> <em class="jxr_javadoccomment"> * return false;</em> |
| <a name="271" href="#271">271</a> <em class="jxr_javadoccomment"> * }</em> |
| <a name="272" href="#272">272</a> <em class="jxr_javadoccomment"> * </pre></em> |
| <a name="273" href="#273">273</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="274" href="#274">274</a> <strong class="jxr_keyword">boolean</strong> removeAttribute(Object key, Object value); |
| <a name="275" href="#275">275</a> |
| <a name="276" href="#276">276</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="277" href="#277">277</a> <em class="jxr_javadoccomment"> * Replaces a user defined attribute with the specified key if the</em> |
| <a name="278" href="#278">278</a> <em class="jxr_javadoccomment"> * value of the attribute is equals to the specified old value.</em> |
| <a name="279" href="#279">279</a> <em class="jxr_javadoccomment"> * This method is same with the following code except that the operation</em> |
| <a name="280" href="#280">280</a> <em class="jxr_javadoccomment"> * is performed atomically.</em> |
| <a name="281" href="#281">281</a> <em class="jxr_javadoccomment"> * <pre></em> |
| <a name="282" href="#282">282</a> <em class="jxr_javadoccomment"> * if (containsAttribute(key) && getAttribute(key).equals(oldValue)) {</em> |
| <a name="283" href="#283">283</a> <em class="jxr_javadoccomment"> * setAttribute(key, newValue);</em> |
| <a name="284" href="#284">284</a> <em class="jxr_javadoccomment"> * return true;</em> |
| <a name="285" href="#285">285</a> <em class="jxr_javadoccomment"> * } else {</em> |
| <a name="286" href="#286">286</a> <em class="jxr_javadoccomment"> * return false;</em> |
| <a name="287" href="#287">287</a> <em class="jxr_javadoccomment"> * }</em> |
| <a name="288" href="#288">288</a> <em class="jxr_javadoccomment"> * </pre></em> |
| <a name="289" href="#289">289</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="290" href="#290">290</a> <strong class="jxr_keyword">boolean</strong> replaceAttribute(Object key, Object oldValue, Object newValue); |
| <a name="291" href="#291">291</a> |
| <a name="292" href="#292">292</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="293" href="#293">293</a> <em class="jxr_javadoccomment"> * Returns <tt>true</tt> if this session contains the attribute with</em> |
| <a name="294" href="#294">294</a> <em class="jxr_javadoccomment"> * the specified <tt>key</tt>.</em> |
| <a name="295" href="#295">295</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="296" href="#296">296</a> <strong class="jxr_keyword">boolean</strong> containsAttribute(Object key); |
| <a name="297" href="#297">297</a> |
| <a name="298" href="#298">298</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="299" href="#299">299</a> <em class="jxr_javadoccomment"> * Returns the set of keys of all user-defined attributes.</em> |
| <a name="300" href="#300">300</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="301" href="#301">301</a> Set<Object> getAttributeKeys(); |
| <a name="302" href="#302">302</a> |
| <a name="303" href="#303">303</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="304" href="#304">304</a> <em class="jxr_javadoccomment"> * Returns <code>true</code> if this session is connected with remote peer.</em> |
| <a name="305" href="#305">305</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="306" href="#306">306</a> <strong class="jxr_keyword">boolean</strong> isConnected(); |
| <a name="307" href="#307">307</a> |
| <a name="308" href="#308">308</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="309" href="#309">309</a> <em class="jxr_javadoccomment"> * Returns <code>true</tt> if and only if this session is being closed</em> |
| <a name="310" href="#310">310</a> <em class="jxr_javadoccomment"> * (but not disconnected yet) or is closed.</em> |
| <a name="311" href="#311">311</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="312" href="#312">312</a> <strong class="jxr_keyword">boolean</strong> isClosing(); |
| <a name="313" href="#313">313</a> |
| <a name="314" href="#314">314</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="315" href="#315">315</a> <em class="jxr_javadoccomment"> * Returns the {@link CloseFuture} of this session. This method returns</em> |
| <a name="316" href="#316">316</a> <em class="jxr_javadoccomment"> * the same instance whenever user calls it.</em> |
| <a name="317" href="#317">317</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="318" href="#318">318</a> <a href="../../../../org/apache/mina/common/CloseFuture.html">CloseFuture</a> getCloseFuture(); |
| <a name="319" href="#319">319</a> |
| <a name="320" href="#320">320</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="321" href="#321">321</a> <em class="jxr_javadoccomment"> * Returns the socket address of remote peer.</em> |
| <a name="322" href="#322">322</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="323" href="#323">323</a> SocketAddress getRemoteAddress(); |
| <a name="324" href="#324">324</a> |
| <a name="325" href="#325">325</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="326" href="#326">326</a> <em class="jxr_javadoccomment"> * Returns the socket address of local machine which is associated with this</em> |
| <a name="327" href="#327">327</a> <em class="jxr_javadoccomment"> * session.</em> |
| <a name="328" href="#328">328</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="329" href="#329">329</a> SocketAddress getLocalAddress(); |
| <a name="330" href="#330">330</a> |
| <a name="331" href="#331">331</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="332" href="#332">332</a> <em class="jxr_javadoccomment"> * Returns the socket address of the {@link IoService} listens to to manage</em> |
| <a name="333" href="#333">333</a> <em class="jxr_javadoccomment"> * this session. If this session is managed by {@link IoAcceptor}, it</em> |
| <a name="334" href="#334">334</a> <em class="jxr_javadoccomment"> * returns the {@link SocketAddress} which is specified as a parameter of</em> |
| <a name="335" href="#335">335</a> <em class="jxr_javadoccomment"> * {@link IoAcceptor#bind()}. If this session is managed by</em> |
| <a name="336" href="#336">336</a> <em class="jxr_javadoccomment"> * {@link IoConnector}, this method returns the same address with</em> |
| <a name="337" href="#337">337</a> <em class="jxr_javadoccomment"> * that of {@link #getRemoteAddress()}.</em> |
| <a name="338" href="#338">338</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="339" href="#339">339</a> SocketAddress getServiceAddress(); |
| <a name="340" href="#340">340</a> |
| <a name="341" href="#341">341</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="342" href="#342">342</a> <em class="jxr_javadoccomment"> * Returns the current {@link TrafficMask} of this session.</em> |
| <a name="343" href="#343">343</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="344" href="#344">344</a> <a href="../../../../org/apache/mina/common/TrafficMask.html">TrafficMask</a> getTrafficMask(); |
| <a name="345" href="#345">345</a> |
| <a name="346" href="#346">346</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="347" href="#347">347</a> <em class="jxr_javadoccomment"> * Sets the {@link TrafficMask} of this session which will result</em> |
| <a name="348" href="#348">348</a> <em class="jxr_javadoccomment"> * the parent {@link IoService} to start to control the traffic</em> |
| <a name="349" href="#349">349</a> <em class="jxr_javadoccomment"> * of this session immediately.</em> |
| <a name="350" href="#350">350</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="351" href="#351">351</a> <strong class="jxr_keyword">void</strong> setTrafficMask(<a href="../../../../org/apache/mina/common/TrafficMask.html">TrafficMask</a> trafficMask); |
| <a name="352" href="#352">352</a> |
| <a name="353" href="#353">353</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="354" href="#354">354</a> <em class="jxr_javadoccomment"> * A shortcut method for {@link #setTrafficMask(TrafficMask)} that</em> |
| <a name="355" href="#355">355</a> <em class="jxr_javadoccomment"> * suspends read operations for this session.</em> |
| <a name="356" href="#356">356</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="357" href="#357">357</a> <strong class="jxr_keyword">void</strong> suspendRead(); |
| <a name="358" href="#358">358</a> |
| <a name="359" href="#359">359</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="360" href="#360">360</a> <em class="jxr_javadoccomment"> * A shortcut method for {@link #setTrafficMask(TrafficMask)} that</em> |
| <a name="361" href="#361">361</a> <em class="jxr_javadoccomment"> * suspends write operations for this session.</em> |
| <a name="362" href="#362">362</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="363" href="#363">363</a> <strong class="jxr_keyword">void</strong> suspendWrite(); |
| <a name="364" href="#364">364</a> |
| <a name="365" href="#365">365</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="366" href="#366">366</a> <em class="jxr_javadoccomment"> * A shortcut method for {@link #setTrafficMask(TrafficMask)} that</em> |
| <a name="367" href="#367">367</a> <em class="jxr_javadoccomment"> * resumes read operations for this session.</em> |
| <a name="368" href="#368">368</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="369" href="#369">369</a> <strong class="jxr_keyword">void</strong> resumeRead(); |
| <a name="370" href="#370">370</a> |
| <a name="371" href="#371">371</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="372" href="#372">372</a> <em class="jxr_javadoccomment"> * A shortcut method for {@link #setTrafficMask(TrafficMask)} that</em> |
| <a name="373" href="#373">373</a> <em class="jxr_javadoccomment"> * resumes write operations for this session.</em> |
| <a name="374" href="#374">374</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="375" href="#375">375</a> <strong class="jxr_keyword">void</strong> resumeWrite(); |
| <a name="376" href="#376">376</a> |
| <a name="377" href="#377">377</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="378" href="#378">378</a> <em class="jxr_javadoccomment"> * Returns the total number of bytes which were read from this session.</em> |
| <a name="379" href="#379">379</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="380" href="#380">380</a> <strong class="jxr_keyword">long</strong> getReadBytes(); |
| <a name="381" href="#381">381</a> |
| <a name="382" href="#382">382</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="383" href="#383">383</a> <em class="jxr_javadoccomment"> * Returns the total number of bytes which were written to this session.</em> |
| <a name="384" href="#384">384</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="385" href="#385">385</a> <strong class="jxr_keyword">long</strong> getWrittenBytes(); |
| <a name="386" href="#386">386</a> |
| <a name="387" href="#387">387</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="388" href="#388">388</a> <em class="jxr_javadoccomment"> * Returns the total number of messages which were read and decoded from this session.</em> |
| <a name="389" href="#389">389</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="390" href="#390">390</a> <strong class="jxr_keyword">long</strong> getReadMessages(); |
| <a name="391" href="#391">391</a> |
| <a name="392" href="#392">392</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="393" href="#393">393</a> <em class="jxr_javadoccomment"> * Returns the total number of messages which were written and encoded by this session.</em> |
| <a name="394" href="#394">394</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="395" href="#395">395</a> <strong class="jxr_keyword">long</strong> getWrittenMessages(); |
| <a name="396" href="#396">396</a> |
| <a name="397" href="#397">397</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="398" href="#398">398</a> <em class="jxr_javadoccomment"> * Returns the number of read bytes per second.</em> |
| <a name="399" href="#399">399</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="400" href="#400">400</a> <strong class="jxr_keyword">double</strong> getReadBytesThroughput(); |
| <a name="401" href="#401">401</a> |
| <a name="402" href="#402">402</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="403" href="#403">403</a> <em class="jxr_javadoccomment"> * Returns the number of written bytes per second.</em> |
| <a name="404" href="#404">404</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="405" href="#405">405</a> <strong class="jxr_keyword">double</strong> getWrittenBytesThroughput(); |
| <a name="406" href="#406">406</a> |
| <a name="407" href="#407">407</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="408" href="#408">408</a> <em class="jxr_javadoccomment"> * Returns the number of read messages per second.</em> |
| <a name="409" href="#409">409</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="410" href="#410">410</a> <strong class="jxr_keyword">double</strong> getReadMessagesThroughput(); |
| <a name="411" href="#411">411</a> |
| <a name="412" href="#412">412</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="413" href="#413">413</a> <em class="jxr_javadoccomment"> * Returns the number of written messages per second.</em> |
| <a name="414" href="#414">414</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="415" href="#415">415</a> <strong class="jxr_keyword">double</strong> getWrittenMessagesThroughput(); |
| <a name="416" href="#416">416</a> |
| <a name="417" href="#417">417</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="418" href="#418">418</a> <em class="jxr_javadoccomment"> * Returns the number of messages which are scheduled to be written to this session.</em> |
| <a name="419" href="#419">419</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="420" href="#420">420</a> <strong class="jxr_keyword">int</strong> getScheduledWriteMessages(); |
| <a name="421" href="#421">421</a> |
| <a name="422" href="#422">422</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="423" href="#423">423</a> <em class="jxr_javadoccomment"> * Returns the number of bytes which are scheduled to be written to this</em> |
| <a name="424" href="#424">424</a> <em class="jxr_javadoccomment"> * session.</em> |
| <a name="425" href="#425">425</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="426" href="#426">426</a> <strong class="jxr_keyword">long</strong> getScheduledWriteBytes(); |
| <a name="427" href="#427">427</a> |
| <a name="428" href="#428">428</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="429" href="#429">429</a> <em class="jxr_javadoccomment"> * Returns the time in millis when this session is created.</em> |
| <a name="430" href="#430">430</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="431" href="#431">431</a> <strong class="jxr_keyword">long</strong> getCreationTime(); |
| <a name="432" href="#432">432</a> |
| <a name="433" href="#433">433</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="434" href="#434">434</a> <em class="jxr_javadoccomment"> * Returns the time in millis when I/O occurred lastly.</em> |
| <a name="435" href="#435">435</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="436" href="#436">436</a> <strong class="jxr_keyword">long</strong> getLastIoTime(); |
| <a name="437" href="#437">437</a> |
| <a name="438" href="#438">438</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="439" href="#439">439</a> <em class="jxr_javadoccomment"> * Returns the time in millis when read operation occurred lastly.</em> |
| <a name="440" href="#440">440</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="441" href="#441">441</a> <strong class="jxr_keyword">long</strong> getLastReadTime(); |
| <a name="442" href="#442">442</a> |
| <a name="443" href="#443">443</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="444" href="#444">444</a> <em class="jxr_javadoccomment"> * Returns the time in millis when write operation occurred lastly.</em> |
| <a name="445" href="#445">445</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="446" href="#446">446</a> <strong class="jxr_keyword">long</strong> getLastWriteTime(); |
| <a name="447" href="#447">447</a> |
| <a name="448" href="#448">448</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="449" href="#449">449</a> <em class="jxr_javadoccomment"> * Returns <code>true</code> if this session is idle for the specified</em> |
| <a name="450" href="#450">450</a> <em class="jxr_javadoccomment"> * {@link IdleStatus}.</em> |
| <a name="451" href="#451">451</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="452" href="#452">452</a> <strong class="jxr_keyword">boolean</strong> isIdle(<a href="../../../../org/apache/mina/common/IdleStatus.html">IdleStatus</a> status); |
| <a name="453" href="#453">453</a> |
| <a name="454" href="#454">454</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="455" href="#455">455</a> <em class="jxr_javadoccomment"> * Returns the number of the fired continuous <tt>sessionIdle</tt> events</em> |
| <a name="456" href="#456">456</a> <em class="jxr_javadoccomment"> * for the specified {@link IdleStatus}.</em> |
| <a name="457" href="#457">457</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="458" href="#458">458</a> <em class="jxr_javadoccomment"> * If <tt>sessionIdle</tt> event is fired first after some time after I/O,</em> |
| <a name="459" href="#459">459</a> <em class="jxr_javadoccomment"> * <tt>idleCount</tt> becomes <tt>1</tt>. <tt>idleCount</tt> resets to</em> |
| <a name="460" href="#460">460</a> <em class="jxr_javadoccomment"> * <tt>0</tt> if any I/O occurs again, otherwise it increases to</em> |
| <a name="461" href="#461">461</a> <em class="jxr_javadoccomment"> * <tt>2</tt> and so on if <tt>sessionIdle</tt> event is fired again without</em> |
| <a name="462" href="#462">462</a> <em class="jxr_javadoccomment"> * any I/O between two (or more) <tt>sessionIdle</tt> events.</em> |
| <a name="463" href="#463">463</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="464" href="#464">464</a> <strong class="jxr_keyword">int</strong> getIdleCount(<a href="../../../../org/apache/mina/common/IdleStatus.html">IdleStatus</a> status); |
| <a name="465" href="#465">465</a> |
| <a name="466" href="#466">466</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="467" href="#467">467</a> <em class="jxr_javadoccomment"> * Returns the number of the fired continuous <tt>sessionIdle</tt> events</em> |
| <a name="468" href="#468">468</a> <em class="jxr_javadoccomment"> * for {@link IdleStatus#READER_IDLE}.</em> |
| <a name="469" href="#469">469</a> <em class="jxr_javadoccomment"> * @see #getIdleCount(IdleStatus)</em> |
| <a name="470" href="#470">470</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="471" href="#471">471</a> <strong class="jxr_keyword">int</strong> getReaderIdleCount(); |
| <a name="472" href="#472">472</a> |
| <a name="473" href="#473">473</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="474" href="#474">474</a> <em class="jxr_javadoccomment"> * Returns the number of the fired continuous <tt>sessionIdle</tt> events</em> |
| <a name="475" href="#475">475</a> <em class="jxr_javadoccomment"> * for {@link IdleStatus#WRITER_IDLE}.</em> |
| <a name="476" href="#476">476</a> <em class="jxr_javadoccomment"> * @see #getIdleCount(IdleStatus)</em> |
| <a name="477" href="#477">477</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="478" href="#478">478</a> <strong class="jxr_keyword">int</strong> getWriterIdleCount(); |
| <a name="479" href="#479">479</a> |
| <a name="480" href="#480">480</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="481" href="#481">481</a> <em class="jxr_javadoccomment"> * Returns the number of the fired continuous <tt>sessionIdle</tt> events</em> |
| <a name="482" href="#482">482</a> <em class="jxr_javadoccomment"> * for {@link IdleStatus#BOTH_IDLE}.</em> |
| <a name="483" href="#483">483</a> <em class="jxr_javadoccomment"> * @see #getIdleCount(IdleStatus)</em> |
| <a name="484" href="#484">484</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="485" href="#485">485</a> <strong class="jxr_keyword">int</strong> getBothIdleCount(); |
| <a name="486" href="#486">486</a> |
| <a name="487" href="#487">487</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="488" href="#488">488</a> <em class="jxr_javadoccomment"> * Returns the time in milliseconds when the last <tt>sessionIdle</tt> event</em> |
| <a name="489" href="#489">489</a> <em class="jxr_javadoccomment"> * is fired for the specified {@link IdleStatus}.</em> |
| <a name="490" href="#490">490</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="491" href="#491">491</a> <strong class="jxr_keyword">long</strong> getLastIdleTime(<a href="../../../../org/apache/mina/common/IdleStatus.html">IdleStatus</a> status); |
| <a name="492" href="#492">492</a> |
| <a name="493" href="#493">493</a> |
| <a name="494" href="#494">494</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="495" href="#495">495</a> <em class="jxr_javadoccomment"> * Returns the time in milliseconds when the last <tt>sessionIdle</tt> event</em> |
| <a name="496" href="#496">496</a> <em class="jxr_javadoccomment"> * is fired for {@link IdleStatus#READER_IDLE}.</em> |
| <a name="497" href="#497">497</a> <em class="jxr_javadoccomment"> * @see #getLastIdleTime(IdleStatus)</em> |
| <a name="498" href="#498">498</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="499" href="#499">499</a> <strong class="jxr_keyword">long</strong> getLastReaderIdleTime(); |
| <a name="500" href="#500">500</a> |
| <a name="501" href="#501">501</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="502" href="#502">502</a> <em class="jxr_javadoccomment"> * Returns the time in milliseconds when the last <tt>sessionIdle</tt> event</em> |
| <a name="503" href="#503">503</a> <em class="jxr_javadoccomment"> * is fired for {@link IdleStatus#WRITER_IDLE}.</em> |
| <a name="504" href="#504">504</a> <em class="jxr_javadoccomment"> * @see #getLastIdleTime(IdleStatus)</em> |
| <a name="505" href="#505">505</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="506" href="#506">506</a> <strong class="jxr_keyword">long</strong> getLastWriterIdleTime(); |
| <a name="507" href="#507">507</a> |
| <a name="508" href="#508">508</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="509" href="#509">509</a> <em class="jxr_javadoccomment"> * Returns the time in milliseconds when the last <tt>sessionIdle</tt> event</em> |
| <a name="510" href="#510">510</a> <em class="jxr_javadoccomment"> * is fired for {@link IdleStatus#BOTH_IDLE}.</em> |
| <a name="511" href="#511">511</a> <em class="jxr_javadoccomment"> * @see #getLastIdleTime(IdleStatus)</em> |
| <a name="512" href="#512">512</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="513" href="#513">513</a> <strong class="jxr_keyword">long</strong> getLastBothIdleTime(); |
| <a name="514" href="#514">514</a> } |
| </pre> |
| <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> |
| </html> |
| |
