| <!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/core/session/IoSession.html">View Javadoc</a></div><pre> |
| <a class="jxr_linenumber" name="L1" href="#L1">1</a> <em class="jxr_comment">/*</em> |
| <a class="jxr_linenumber" name="L2" href="#L2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em> |
| <a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em> |
| <a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em> |
| <a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em> |
| <a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em> |
| <a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em> |
| <a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em> |
| <a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> *</em> |
| <a class="jxr_linenumber" name="L10" href="#L10">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 class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> *</em> |
| <a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em> |
| <a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em> |
| <a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em> |
| <a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em> |
| <a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em> |
| <a class="jxr_linenumber" name="L17" href="#L17">17</a> <em class="jxr_comment"> * under the License.</em> |
| <a class="jxr_linenumber" name="L18" href="#L18">18</a> <em class="jxr_comment"> *</em> |
| <a class="jxr_linenumber" name="L19" href="#L19">19</a> <em class="jxr_comment"> */</em> |
| <a class="jxr_linenumber" name="L20" href="#L20">20</a> <strong class="jxr_keyword">package</strong> org.apache.mina.core.session; |
| <a class="jxr_linenumber" name="L21" href="#L21">21</a> |
| <a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> java.net.SocketAddress; |
| <a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> java.util.Set; |
| <a class="jxr_linenumber" name="L24" href="#L24">24</a> |
| <a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> org.apache.mina.core.filterchain.IoFilter; |
| <a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> org.apache.mina.core.filterchain.IoFilterChain; |
| <a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> org.apache.mina.core.future.CloseFuture; |
| <a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> org.apache.mina.core.future.ReadFuture; |
| <a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> org.apache.mina.core.future.WriteFuture; |
| <a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> org.apache.mina.core.service.IoAcceptor; |
| <a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> org.apache.mina.core.service.IoConnector; |
| <a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> org.apache.mina.core.service.IoHandler; |
| <a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> org.apache.mina.core.service.IoService; |
| <a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> org.apache.mina.core.service.TransportMetadata; |
| <a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> org.apache.mina.core.write.WriteRequest; |
| <a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> org.apache.mina.core.write.WriteRequestQueue; |
| <a class="jxr_linenumber" name="L37" href="#L37">37</a> |
| <a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment"> * <p></em> |
| <a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> * A handle which represents connection between two end-points regardless of</em> |
| <a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> * transport types.</em> |
| <a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> * </p></em> |
| <a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> * <p></em> |
| <a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> * {@link IoSession} provides user-defined attributes. User-defined attributes</em> |
| <a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> * are application-specific data which are associated with a session.</em> |
| <a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> * It often contains objects that represents the state of a higher-level protocol</em> |
| <a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> * and becomes a way to exchange data between filters and handlers.</em> |
| <a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> * </p></em> |
| <a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> * <h3>Adjusting Transport Type Specific Properties</h3></em> |
| <a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> * <p></em> |
| <a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> * You can simply downcast the session to an appropriate subclass.</em> |
| <a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> * </p></em> |
| <a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> * <h3>Thread Safety</h3></em> |
| <a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment"> * <p></em> |
| <a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment"> * {@link IoSession} is thread-safe. But please note that performing</em> |
| <a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment"> * more than one {@link #write(Object)} calls at the same time will</em> |
| <a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment"> * cause the {@link IoFilter#filterWrite(IoFilter.NextFilter,IoSession,WriteRequest)}</em> |
| <a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> * to be executed simultaneously, and therefore you have to make sure the</em> |
| <a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment"> * {@link IoFilter} implementations you're using are thread-safe, too.</em> |
| <a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment"> * </p></em> |
| <a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment"> * <h3>Equality of Sessions</h3></em> |
| <a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> * TODO : The getId() method is totally wrong. We can't base</em> |
| <a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> * a method which is designed to create a unique ID on the hashCode method.</em> |
| <a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment"> * {@link Object#equals(Object)} and {@link Object#hashCode()} shall not be overriden</em> |
| <a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment"> * to the default behavior that is defined in {@link Object}.</em> |
| <a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="http://mina.apache.org" target="alexandria_uri">http://mina.apache.org</a>">Apache MINA Project</a></em> |
| <a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L69" href="#L69">69</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a name="IoSession" href="../../../../../org/apache/mina/core/session/IoSession.html#IoSession">IoSession</a> { |
| <a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment"> * @return a unique identifier for this session. Every session has its own</em> |
| <a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment"> * ID which is different from each other.</em> |
| <a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment"> * </em> |
| <a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment"> * TODO : The way it's implemented does not guarantee that the contract is</em> |
| <a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment"> * respected. It uses the HashCode() method which don't guarantee the key</em> |
| <a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_javadoccomment"> * unicity.</em> |
| <a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L78" href="#L78">78</a> <strong class="jxr_keyword">long</strong> getId(); |
| <a class="jxr_linenumber" name="L79" href="#L79">79</a> |
| <a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L81" href="#L81">81</a> <em class="jxr_javadoccomment"> * @return the {@link IoService} which provides I/O service to this session.</em> |
| <a class="jxr_linenumber" name="L82" href="#L82">82</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L83" href="#L83">83</a> <a name="IoService" href="../../../../../org/apache/mina/core/service/IoService.html#IoService">IoService</a> getService(); |
| <a class="jxr_linenumber" name="L84" href="#L84">84</a> |
| <a class="jxr_linenumber" name="L85" href="#L85">85</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L86" href="#L86">86</a> <em class="jxr_javadoccomment"> * @return the {@link IoHandler} which handles this session.</em> |
| <a class="jxr_linenumber" name="L87" href="#L87">87</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L88" href="#L88">88</a> <a name="IoHandler" href="../../../../../org/apache/mina/core/service/IoHandler.html#IoHandler">IoHandler</a> getHandler(); |
| <a class="jxr_linenumber" name="L89" href="#L89">89</a> |
| <a class="jxr_linenumber" name="L90" href="#L90">90</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L91" href="#L91">91</a> <em class="jxr_javadoccomment"> * @return the configuration of this session.</em> |
| <a class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L93" href="#L93">93</a> <a name="IoSessionConfig" href="../../../../../org/apache/mina/core/session/IoSessionConfig.html#IoSessionConfig">IoSessionConfig</a> getConfig(); |
| <a class="jxr_linenumber" name="L94" href="#L94">94</a> |
| <a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_javadoccomment"> * @return the filter chain that only affects this session.</em> |
| <a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L98" href="#L98">98</a> <a name="IoFilterChain" href="../../../../../org/apache/mina/core/filterchain/IoFilterChain.html#IoFilterChain">IoFilterChain</a> getFilterChain(); |
| <a class="jxr_linenumber" name="L99" href="#L99">99</a> |
| <a class="jxr_linenumber" name="L100" href="#L100">100</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L101" href="#L101">101</a> <em class="jxr_javadoccomment"> * Get the queue that contains the message waiting for being written.</em> |
| <a class="jxr_linenumber" name="L102" href="#L102">102</a> <em class="jxr_javadoccomment"> * As the reader might not be ready, it's frequent that the messages</em> |
| <a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_javadoccomment"> * aren't written completely, or that some older messages are waiting</em> |
| <a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_javadoccomment"> * to be written when a new message arrives. This queue is used to manage</em> |
| <a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment"> * the backlog of messages.</em> |
| <a class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_javadoccomment"> * </em> |
| <a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_javadoccomment"> * @return The queue containing the pending messages.</em> |
| <a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L109" href="#L109">109</a> <a name="WriteRequestQueue" href="../../../../../org/apache/mina/core/write/WriteRequestQueue.html#WriteRequestQueue">WriteRequestQueue</a> getWriteRequestQueue(); |
| <a class="jxr_linenumber" name="L110" href="#L110">110</a> |
| <a class="jxr_linenumber" name="L111" href="#L111">111</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L112" href="#L112">112</a> <em class="jxr_javadoccomment"> * @return the {@link TransportMetadata} that this session runs on.</em> |
| <a class="jxr_linenumber" name="L113" href="#L113">113</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L114" href="#L114">114</a> <a name="TransportMetadata" href="../../../../../org/apache/mina/core/service/TransportMetadata.html#TransportMetadata">TransportMetadata</a> getTransportMetadata(); |
| <a class="jxr_linenumber" name="L115" href="#L115">115</a> |
| <a class="jxr_linenumber" name="L116" href="#L116">116</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L117" href="#L117">117</a> <em class="jxr_javadoccomment"> * TODO This javadoc is wrong. The return tag should be short.</em> |
| <a class="jxr_linenumber" name="L118" href="#L118">118</a> <em class="jxr_javadoccomment"> * </em> |
| <a class="jxr_linenumber" name="L119" href="#L119">119</a> <em class="jxr_javadoccomment"> * @return a {@link ReadFuture} which is notified when a new message is</em> |
| <a class="jxr_linenumber" name="L120" href="#L120">120</a> <em class="jxr_javadoccomment"> * received, the connection is closed or an exception is caught. This</em> |
| <a class="jxr_linenumber" name="L121" href="#L121">121</a> <em class="jxr_javadoccomment"> * operation is especially useful when you implement a client application.</em> |
| <a class="jxr_linenumber" name="L122" href="#L122">122</a> <em class="jxr_javadoccomment"> * TODO : Describe here how we enable this feature.</em> |
| <a class="jxr_linenumber" name="L123" href="#L123">123</a> <em class="jxr_javadoccomment"> * However, please note that this operation is disabled by default and</em> |
| <a class="jxr_linenumber" name="L124" href="#L124">124</a> <em class="jxr_javadoccomment"> * throw {@link IllegalStateException} because all received events must be</em> |
| <a class="jxr_linenumber" name="L125" href="#L125">125</a> <em class="jxr_javadoccomment"> * queued somewhere to support this operation, possibly leading to memory</em> |
| <a class="jxr_linenumber" name="L126" href="#L126">126</a> <em class="jxr_javadoccomment"> * leak. This means you have to keep calling {@link #read()} once you</em> |
| <a class="jxr_linenumber" name="L127" href="#L127">127</a> <em class="jxr_javadoccomment"> * enabled this operation. To enable this operation, please call</em> |
| <a class="jxr_linenumber" name="L128" href="#L128">128</a> <em class="jxr_javadoccomment"> * {@link IoSessionConfig#setUseReadOperation(boolean)} with <tt>true</tt>.</em> |
| <a class="jxr_linenumber" name="L129" href="#L129">129</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L130" href="#L130">130</a> <em class="jxr_javadoccomment"> * @throws IllegalStateException if</em> |
| <a class="jxr_linenumber" name="L131" href="#L131">131</a> <em class="jxr_javadoccomment"> * {@link IoSessionConfig#setUseReadOperation(boolean) useReadOperation}</em> |
| <a class="jxr_linenumber" name="L132" href="#L132">132</a> <em class="jxr_javadoccomment"> * option has not been enabled.</em> |
| <a class="jxr_linenumber" name="L133" href="#L133">133</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L134" href="#L134">134</a> <a name="ReadFuture" href="../../../../../org/apache/mina/core/future/ReadFuture.html#ReadFuture">ReadFuture</a> read(); |
| <a class="jxr_linenumber" name="L135" href="#L135">135</a> |
| <a class="jxr_linenumber" name="L136" href="#L136">136</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L137" href="#L137">137</a> <em class="jxr_javadoccomment"> * Writes the specified <code>message</code> to remote peer. This</em> |
| <a class="jxr_linenumber" name="L138" href="#L138">138</a> <em class="jxr_javadoccomment"> * operation is asynchronous; {@link IoHandler#messageSent(IoSession,Object)}</em> |
| <a class="jxr_linenumber" name="L139" href="#L139">139</a> <em class="jxr_javadoccomment"> * will be invoked when the message is actually sent to remote peer.</em> |
| <a class="jxr_linenumber" name="L140" href="#L140">140</a> <em class="jxr_javadoccomment"> * You can also wait for the returned {@link WriteFuture} if you want</em> |
| <a class="jxr_linenumber" name="L141" href="#L141">141</a> <em class="jxr_javadoccomment"> * to wait for the message actually written.</em> |
| <a class="jxr_linenumber" name="L142" href="#L142">142</a> <em class="jxr_javadoccomment"> * </em> |
| <a class="jxr_linenumber" name="L143" href="#L143">143</a> <em class="jxr_javadoccomment"> * @param message The message to write</em> |
| <a class="jxr_linenumber" name="L144" href="#L144">144</a> <em class="jxr_javadoccomment"> * @return The associated WriteFuture</em> |
| <a class="jxr_linenumber" name="L145" href="#L145">145</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L146" href="#L146">146</a> <a name="WriteFuture" href="../../../../../org/apache/mina/core/future/WriteFuture.html#WriteFuture">WriteFuture</a> write(Object message); |
| <a class="jxr_linenumber" name="L147" href="#L147">147</a> |
| <a class="jxr_linenumber" name="L148" href="#L148">148</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L149" href="#L149">149</a> <em class="jxr_javadoccomment"> * (Optional) Writes the specified <tt>message</tt> to the specified <tt>destination</tt>.</em> |
| <a class="jxr_linenumber" name="L150" href="#L150">150</a> <em class="jxr_javadoccomment"> * This operation is asynchronous; {@link IoHandler#messageSent(IoSession, Object)}</em> |
| <a class="jxr_linenumber" name="L151" href="#L151">151</a> <em class="jxr_javadoccomment"> * will be invoked when the message is actually sent to remote peer. You can</em> |
| <a class="jxr_linenumber" name="L152" href="#L152">152</a> <em class="jxr_javadoccomment"> * also wait for the returned {@link WriteFuture} if you want to wait for</em> |
| <a class="jxr_linenumber" name="L153" href="#L153">153</a> <em class="jxr_javadoccomment"> * the message actually written.</em> |
| <a class="jxr_linenumber" name="L154" href="#L154">154</a> <em class="jxr_javadoccomment"> * <p></em> |
| <a class="jxr_linenumber" name="L155" href="#L155">155</a> <em class="jxr_javadoccomment"> * When you implement a client that receives a broadcast message from a server</em> |
| <a class="jxr_linenumber" name="L156" href="#L156">156</a> <em class="jxr_javadoccomment"> * such as DHCP server, the client might need to send a response message for the</em> |
| <a class="jxr_linenumber" name="L157" href="#L157">157</a> <em class="jxr_javadoccomment"> * broadcast message the server sent. Because the remote address of the session</em> |
| <a class="jxr_linenumber" name="L158" href="#L158">158</a> <em class="jxr_javadoccomment"> * is not the address of the server in case of broadcasting, there should be a</em> |
| <a class="jxr_linenumber" name="L159" href="#L159">159</a> <em class="jxr_javadoccomment"> * way to specify the destination when you write the response message.</em> |
| <a class="jxr_linenumber" name="L160" href="#L160">160</a> <em class="jxr_javadoccomment"> * This interface provides {@link #write(Object, SocketAddress)} method so you</em> |
| <a class="jxr_linenumber" name="L161" href="#L161">161</a> <em class="jxr_javadoccomment"> * can specify the destination.</em> |
| <a class="jxr_linenumber" name="L162" href="#L162">162</a> <em class="jxr_javadoccomment"> * </em> |
| <a class="jxr_linenumber" name="L163" href="#L163">163</a> <em class="jxr_javadoccomment"> * @param message The message to write</em> |
| <a class="jxr_linenumber" name="L164" href="#L164">164</a> <em class="jxr_javadoccomment"> * @param destination <tt>null</tt> if you want the message sent to the</em> |
| <a class="jxr_linenumber" name="L165" href="#L165">165</a> <em class="jxr_javadoccomment"> * default remote address</em> |
| <a class="jxr_linenumber" name="L166" href="#L166">166</a> <em class="jxr_javadoccomment"> * @return The associated WriteFuture</em> |
| <a class="jxr_linenumber" name="L167" href="#L167">167</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L168" href="#L168">168</a> <a name="WriteFuture" href="../../../../../org/apache/mina/core/future/WriteFuture.html#WriteFuture">WriteFuture</a> write(Object message, SocketAddress destination); |
| <a class="jxr_linenumber" name="L169" href="#L169">169</a> |
| <a class="jxr_linenumber" name="L170" href="#L170">170</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L171" href="#L171">171</a> <em class="jxr_javadoccomment"> * Closes this session immediately or after all queued write requests</em> |
| <a class="jxr_linenumber" name="L172" href="#L172">172</a> <em class="jxr_javadoccomment"> * are flushed. This operation is asynchronous. Wait for the returned</em> |
| <a class="jxr_linenumber" name="L173" href="#L173">173</a> <em class="jxr_javadoccomment"> * {@link CloseFuture} if you want to wait for the session actually closed.</em> |
| <a class="jxr_linenumber" name="L174" href="#L174">174</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L175" href="#L175">175</a> <em class="jxr_javadoccomment"> * @param immediately {@code true} to close this session immediately</em> |
| <a class="jxr_linenumber" name="L176" href="#L176">176</a> <em class="jxr_javadoccomment"> * . The pending write requests</em> |
| <a class="jxr_linenumber" name="L177" href="#L177">177</a> <em class="jxr_javadoccomment"> * will simply be discarded.</em> |
| <a class="jxr_linenumber" name="L178" href="#L178">178</a> <em class="jxr_javadoccomment"> * {@code false} to close this session after all queued</em> |
| <a class="jxr_linenumber" name="L179" href="#L179">179</a> <em class="jxr_javadoccomment"> * write requests are flushed.</em> |
| <a class="jxr_linenumber" name="L180" href="#L180">180</a> <em class="jxr_javadoccomment"> * @return The associated CloseFuture</em> |
| <a class="jxr_linenumber" name="L181" href="#L181">181</a> <em class="jxr_javadoccomment"> * @deprecated Use either the {@link #closeNow()} or the {@link #closeOnFlush()} methods</em> |
| <a class="jxr_linenumber" name="L182" href="#L182">182</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L183" href="#L183">183</a> @Deprecated |
| <a class="jxr_linenumber" name="L184" href="#L184">184</a> <a name="CloseFuture" href="../../../../../org/apache/mina/core/future/CloseFuture.html#CloseFuture">CloseFuture</a> close(<strong class="jxr_keyword">boolean</strong> immediately); |
| <a class="jxr_linenumber" name="L185" href="#L185">185</a> |
| <a class="jxr_linenumber" name="L186" href="#L186">186</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L187" href="#L187">187</a> <em class="jxr_javadoccomment"> * Closes this session immediately. This operation is asynchronous, it </em> |
| <a class="jxr_linenumber" name="L188" href="#L188">188</a> <em class="jxr_javadoccomment"> * returns a {@link CloseFuture}.</em> |
| <a class="jxr_linenumber" name="L189" href="#L189">189</a> <em class="jxr_javadoccomment"> * </em> |
| <a class="jxr_linenumber" name="L190" href="#L190">190</a> <em class="jxr_javadoccomment"> * @return The {@link CloseFuture} that can be use to wait for the completion of this operation</em> |
| <a class="jxr_linenumber" name="L191" href="#L191">191</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L192" href="#L192">192</a> <a name="CloseFuture" href="../../../../../org/apache/mina/core/future/CloseFuture.html#CloseFuture">CloseFuture</a> closeNow(); |
| <a class="jxr_linenumber" name="L193" href="#L193">193</a> |
| <a class="jxr_linenumber" name="L194" href="#L194">194</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L195" href="#L195">195</a> <em class="jxr_javadoccomment"> * Closes this session after all queued write requests are flushed. This operation </em> |
| <a class="jxr_linenumber" name="L196" href="#L196">196</a> <em class="jxr_javadoccomment"> * is asynchronous. Wait for the returned {@link CloseFuture} if you want to wait </em> |
| <a class="jxr_linenumber" name="L197" href="#L197">197</a> <em class="jxr_javadoccomment"> * for the session actually closed.</em> |
| <a class="jxr_linenumber" name="L198" href="#L198">198</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L199" href="#L199">199</a> <em class="jxr_javadoccomment"> * @return The associated CloseFuture</em> |
| <a class="jxr_linenumber" name="L200" href="#L200">200</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L201" href="#L201">201</a> <a name="CloseFuture" href="../../../../../org/apache/mina/core/future/CloseFuture.html#CloseFuture">CloseFuture</a> closeOnFlush(); |
| <a class="jxr_linenumber" name="L202" href="#L202">202</a> |
| <a class="jxr_linenumber" name="L203" href="#L203">203</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L204" href="#L204">204</a> <em class="jxr_javadoccomment"> * Closes this session after all queued write requests</em> |
| <a class="jxr_linenumber" name="L205" href="#L205">205</a> <em class="jxr_javadoccomment"> * are flushed. This operation is asynchronous. Wait for the returned</em> |
| <a class="jxr_linenumber" name="L206" href="#L206">206</a> <em class="jxr_javadoccomment"> * {@link CloseFuture} if you want to wait for the session actually closed.</em> |
| <a class="jxr_linenumber" name="L207" href="#L207">207</a> <em class="jxr_javadoccomment"> * @deprecated use {@link #closeNow()}</em> |
| <a class="jxr_linenumber" name="L208" href="#L208">208</a> <em class="jxr_javadoccomment"> * </em> |
| <a class="jxr_linenumber" name="L209" href="#L209">209</a> <em class="jxr_javadoccomment"> * @return The associated CloseFuture</em> |
| <a class="jxr_linenumber" name="L210" href="#L210">210</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L211" href="#L211">211</a> @Deprecated |
| <a class="jxr_linenumber" name="L212" href="#L212">212</a> <a name="CloseFuture" href="../../../../../org/apache/mina/core/future/CloseFuture.html#CloseFuture">CloseFuture</a> close(); |
| <a class="jxr_linenumber" name="L213" href="#L213">213</a> |
| <a class="jxr_linenumber" name="L214" href="#L214">214</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L215" href="#L215">215</a> <em class="jxr_javadoccomment"> * Returns an attachment of this session.</em> |
| <a class="jxr_linenumber" name="L216" href="#L216">216</a> <em class="jxr_javadoccomment"> * This method is identical with <tt>getAttribute( "" )</tt>.</em> |
| <a class="jxr_linenumber" name="L217" href="#L217">217</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L218" href="#L218">218</a> <em class="jxr_javadoccomment"> * @return The attachment</em> |
| <a class="jxr_linenumber" name="L219" href="#L219">219</a> <em class="jxr_javadoccomment"> * @deprecated Use {@link #getAttribute(Object)} instead.</em> |
| <a class="jxr_linenumber" name="L220" href="#L220">220</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L221" href="#L221">221</a> @Deprecated |
| <a class="jxr_linenumber" name="L222" href="#L222">222</a> Object getAttachment(); |
| <a class="jxr_linenumber" name="L223" href="#L223">223</a> |
| <a class="jxr_linenumber" name="L224" href="#L224">224</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L225" href="#L225">225</a> <em class="jxr_javadoccomment"> * Sets an attachment of this session.</em> |
| <a class="jxr_linenumber" name="L226" href="#L226">226</a> <em class="jxr_javadoccomment"> * This method is identical with <tt>setAttribute( "", attachment )</tt>.</em> |
| <a class="jxr_linenumber" name="L227" href="#L227">227</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L228" href="#L228">228</a> <em class="jxr_javadoccomment"> * @param attachment The attachment</em> |
| <a class="jxr_linenumber" name="L229" href="#L229">229</a> <em class="jxr_javadoccomment"> * @return Old attachment. <tt>null</tt> if it is new.</em> |
| <a class="jxr_linenumber" name="L230" href="#L230">230</a> <em class="jxr_javadoccomment"> * @deprecated Use {@link #setAttribute(Object, Object)} instead.</em> |
| <a class="jxr_linenumber" name="L231" href="#L231">231</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L232" href="#L232">232</a> @Deprecated |
| <a class="jxr_linenumber" name="L233" href="#L233">233</a> Object setAttachment(Object attachment); |
| <a class="jxr_linenumber" name="L234" href="#L234">234</a> |
| <a class="jxr_linenumber" name="L235" href="#L235">235</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L236" href="#L236">236</a> <em class="jxr_javadoccomment"> * Returns the value of the user-defined attribute of this session.</em> |
| <a class="jxr_linenumber" name="L237" href="#L237">237</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L238" href="#L238">238</a> <em class="jxr_javadoccomment"> * @param key the key of the attribute</em> |
| <a class="jxr_linenumber" name="L239" href="#L239">239</a> <em class="jxr_javadoccomment"> * @return <tt>null</tt> if there is no attribute with the specified key</em> |
| <a class="jxr_linenumber" name="L240" href="#L240">240</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L241" href="#L241">241</a> Object getAttribute(Object key); |
| <a class="jxr_linenumber" name="L242" href="#L242">242</a> |
| <a class="jxr_linenumber" name="L243" href="#L243">243</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L244" href="#L244">244</a> <em class="jxr_javadoccomment"> * Returns the value of user defined attribute associated with the</em> |
| <a class="jxr_linenumber" name="L245" href="#L245">245</a> <em class="jxr_javadoccomment"> * specified key. If there's no such attribute, the specified default</em> |
| <a class="jxr_linenumber" name="L246" href="#L246">246</a> <em class="jxr_javadoccomment"> * value is associated with the specified key, and the default value is</em> |
| <a class="jxr_linenumber" name="L247" href="#L247">247</a> <em class="jxr_javadoccomment"> * returned. This method is same with the following code except that the</em> |
| <a class="jxr_linenumber" name="L248" href="#L248">248</a> <em class="jxr_javadoccomment"> * operation is performed atomically.</em> |
| <a class="jxr_linenumber" name="L249" href="#L249">249</a> <em class="jxr_javadoccomment"> * <pre></em> |
| <a class="jxr_linenumber" name="L250" href="#L250">250</a> <em class="jxr_javadoccomment"> * if (containsAttribute(key)) {</em> |
| <a class="jxr_linenumber" name="L251" href="#L251">251</a> <em class="jxr_javadoccomment"> * return getAttribute(key);</em> |
| <a class="jxr_linenumber" name="L252" href="#L252">252</a> <em class="jxr_javadoccomment"> * } else {</em> |
| <a class="jxr_linenumber" name="L253" href="#L253">253</a> <em class="jxr_javadoccomment"> * setAttribute(key, defaultValue);</em> |
| <a class="jxr_linenumber" name="L254" href="#L254">254</a> <em class="jxr_javadoccomment"> * return defaultValue;</em> |
| <a class="jxr_linenumber" name="L255" href="#L255">255</a> <em class="jxr_javadoccomment"> * }</em> |
| <a class="jxr_linenumber" name="L256" href="#L256">256</a> <em class="jxr_javadoccomment"> * </pre></em> |
| <a class="jxr_linenumber" name="L257" href="#L257">257</a> <em class="jxr_javadoccomment"> * </em> |
| <a class="jxr_linenumber" name="L258" href="#L258">258</a> <em class="jxr_javadoccomment"> * @param key the key of the attribute we want to retreive</em> |
| <a class="jxr_linenumber" name="L259" href="#L259">259</a> <em class="jxr_javadoccomment"> * @param defaultValue the default value of the attribute</em> |
| <a class="jxr_linenumber" name="L260" href="#L260">260</a> <em class="jxr_javadoccomment"> * @return The retrieved attribute or <tt>null</tt> if not found</em> |
| <a class="jxr_linenumber" name="L261" href="#L261">261</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L262" href="#L262">262</a> Object getAttribute(Object key, Object defaultValue); |
| <a class="jxr_linenumber" name="L263" href="#L263">263</a> |
| <a class="jxr_linenumber" name="L264" href="#L264">264</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L265" href="#L265">265</a> <em class="jxr_javadoccomment"> * Sets a user-defined attribute.</em> |
| <a class="jxr_linenumber" name="L266" href="#L266">266</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L267" href="#L267">267</a> <em class="jxr_javadoccomment"> * @param key the key of the attribute</em> |
| <a class="jxr_linenumber" name="L268" href="#L268">268</a> <em class="jxr_javadoccomment"> * @param value the value of the attribute</em> |
| <a class="jxr_linenumber" name="L269" href="#L269">269</a> <em class="jxr_javadoccomment"> * @return The old value of the attribute. <tt>null</tt> if it is new.</em> |
| <a class="jxr_linenumber" name="L270" href="#L270">270</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L271" href="#L271">271</a> Object setAttribute(Object key, Object value); |
| <a class="jxr_linenumber" name="L272" href="#L272">272</a> |
| <a class="jxr_linenumber" name="L273" href="#L273">273</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L274" href="#L274">274</a> <em class="jxr_javadoccomment"> * Sets a user defined attribute without a value. This is useful when</em> |
| <a class="jxr_linenumber" name="L275" href="#L275">275</a> <em class="jxr_javadoccomment"> * you just want to put a 'mark' attribute. Its value is set to</em> |
| <a class="jxr_linenumber" name="L276" href="#L276">276</a> <em class="jxr_javadoccomment"> * {@link Boolean#TRUE}.</em> |
| <a class="jxr_linenumber" name="L277" href="#L277">277</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L278" href="#L278">278</a> <em class="jxr_javadoccomment"> * @param key the key of the attribute</em> |
| <a class="jxr_linenumber" name="L279" href="#L279">279</a> <em class="jxr_javadoccomment"> * @return The old value of the attribute. <tt>null</tt> if it is new.</em> |
| <a class="jxr_linenumber" name="L280" href="#L280">280</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L281" href="#L281">281</a> Object setAttribute(Object key); |
| <a class="jxr_linenumber" name="L282" href="#L282">282</a> |
| <a class="jxr_linenumber" name="L283" href="#L283">283</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L284" href="#L284">284</a> <em class="jxr_javadoccomment"> * Sets a user defined attribute if the attribute with the specified key</em> |
| <a class="jxr_linenumber" name="L285" href="#L285">285</a> <em class="jxr_javadoccomment"> * is not set yet. This method is same with the following code except</em> |
| <a class="jxr_linenumber" name="L286" href="#L286">286</a> <em class="jxr_javadoccomment"> * that the operation is performed atomically.</em> |
| <a class="jxr_linenumber" name="L287" href="#L287">287</a> <em class="jxr_javadoccomment"> * <pre></em> |
| <a class="jxr_linenumber" name="L288" href="#L288">288</a> <em class="jxr_javadoccomment"> * if (containsAttribute(key)) {</em> |
| <a class="jxr_linenumber" name="L289" href="#L289">289</a> <em class="jxr_javadoccomment"> * return getAttribute(key);</em> |
| <a class="jxr_linenumber" name="L290" href="#L290">290</a> <em class="jxr_javadoccomment"> * } else {</em> |
| <a class="jxr_linenumber" name="L291" href="#L291">291</a> <em class="jxr_javadoccomment"> * return setAttribute(key, value);</em> |
| <a class="jxr_linenumber" name="L292" href="#L292">292</a> <em class="jxr_javadoccomment"> * }</em> |
| <a class="jxr_linenumber" name="L293" href="#L293">293</a> <em class="jxr_javadoccomment"> * </pre></em> |
| <a class="jxr_linenumber" name="L294" href="#L294">294</a> <em class="jxr_javadoccomment"> * </em> |
| <a class="jxr_linenumber" name="L295" href="#L295">295</a> <em class="jxr_javadoccomment"> * @param key The key of the attribute we want to set</em> |
| <a class="jxr_linenumber" name="L296" href="#L296">296</a> <em class="jxr_javadoccomment"> * @param value The value we want to set</em> |
| <a class="jxr_linenumber" name="L297" href="#L297">297</a> <em class="jxr_javadoccomment"> * @return The old value of the attribute. <tt>null</tt> if not found.</em> |
| <a class="jxr_linenumber" name="L298" href="#L298">298</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L299" href="#L299">299</a> Object setAttributeIfAbsent(Object key, Object value); |
| <a class="jxr_linenumber" name="L300" href="#L300">300</a> |
| <a class="jxr_linenumber" name="L301" href="#L301">301</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L302" href="#L302">302</a> <em class="jxr_javadoccomment"> * Sets a user defined attribute without a value if the attribute with</em> |
| <a class="jxr_linenumber" name="L303" href="#L303">303</a> <em class="jxr_javadoccomment"> * the specified key is not set yet. This is useful when you just want to</em> |
| <a class="jxr_linenumber" name="L304" href="#L304">304</a> <em class="jxr_javadoccomment"> * put a 'mark' attribute. Its value is set to {@link Boolean#TRUE}.</em> |
| <a class="jxr_linenumber" name="L305" href="#L305">305</a> <em class="jxr_javadoccomment"> * This method is same with the following code except that the operation</em> |
| <a class="jxr_linenumber" name="L306" href="#L306">306</a> <em class="jxr_javadoccomment"> * is performed atomically.</em> |
| <a class="jxr_linenumber" name="L307" href="#L307">307</a> <em class="jxr_javadoccomment"> * <pre></em> |
| <a class="jxr_linenumber" name="L308" href="#L308">308</a> <em class="jxr_javadoccomment"> * if (containsAttribute(key)) {</em> |
| <a class="jxr_linenumber" name="L309" href="#L309">309</a> <em class="jxr_javadoccomment"> * return getAttribute(key); // might not always be Boolean.TRUE.</em> |
| <a class="jxr_linenumber" name="L310" href="#L310">310</a> <em class="jxr_javadoccomment"> * } else {</em> |
| <a class="jxr_linenumber" name="L311" href="#L311">311</a> <em class="jxr_javadoccomment"> * return setAttribute(key);</em> |
| <a class="jxr_linenumber" name="L312" href="#L312">312</a> <em class="jxr_javadoccomment"> * }</em> |
| <a class="jxr_linenumber" name="L313" href="#L313">313</a> <em class="jxr_javadoccomment"> * </pre></em> |
| <a class="jxr_linenumber" name="L314" href="#L314">314</a> <em class="jxr_javadoccomment"> * </em> |
| <a class="jxr_linenumber" name="L315" href="#L315">315</a> <em class="jxr_javadoccomment"> * @param key The key of the attribute we want to set</em> |
| <a class="jxr_linenumber" name="L316" href="#L316">316</a> <em class="jxr_javadoccomment"> * @return The old value of the attribute. <tt>null</tt> if not found.</em> |
| <a class="jxr_linenumber" name="L317" href="#L317">317</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L318" href="#L318">318</a> Object setAttributeIfAbsent(Object key); |
| <a class="jxr_linenumber" name="L319" href="#L319">319</a> |
| <a class="jxr_linenumber" name="L320" href="#L320">320</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L321" href="#L321">321</a> <em class="jxr_javadoccomment"> * Removes a user-defined attribute with the specified key.</em> |
| <a class="jxr_linenumber" name="L322" href="#L322">322</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L323" href="#L323">323</a> <em class="jxr_javadoccomment"> * @param key The key of the attribute we want to remove</em> |
| <a class="jxr_linenumber" name="L324" href="#L324">324</a> <em class="jxr_javadoccomment"> * @return The old value of the attribute. <tt>null</tt> if not found.</em> |
| <a class="jxr_linenumber" name="L325" href="#L325">325</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L326" href="#L326">326</a> Object removeAttribute(Object key); |
| <a class="jxr_linenumber" name="L327" href="#L327">327</a> |
| <a class="jxr_linenumber" name="L328" href="#L328">328</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L329" href="#L329">329</a> <em class="jxr_javadoccomment"> * Removes a user defined attribute with the specified key if the current</em> |
| <a class="jxr_linenumber" name="L330" href="#L330">330</a> <em class="jxr_javadoccomment"> * attribute value is equal to the specified value. This method is same</em> |
| <a class="jxr_linenumber" name="L331" href="#L331">331</a> <em class="jxr_javadoccomment"> * with the following code except that the operation is performed</em> |
| <a class="jxr_linenumber" name="L332" href="#L332">332</a> <em class="jxr_javadoccomment"> * atomically.</em> |
| <a class="jxr_linenumber" name="L333" href="#L333">333</a> <em class="jxr_javadoccomment"> * <pre></em> |
| <a class="jxr_linenumber" name="L334" href="#L334">334</a> <em class="jxr_javadoccomment"> * if (containsAttribute(key) &amp;&amp; getAttribute(key).equals(value)) {</em> |
| <a class="jxr_linenumber" name="L335" href="#L335">335</a> <em class="jxr_javadoccomment"> * removeAttribute(key);</em> |
| <a class="jxr_linenumber" name="L336" href="#L336">336</a> <em class="jxr_javadoccomment"> * return true;</em> |
| <a class="jxr_linenumber" name="L337" href="#L337">337</a> <em class="jxr_javadoccomment"> * } else {</em> |
| <a class="jxr_linenumber" name="L338" href="#L338">338</a> <em class="jxr_javadoccomment"> * return false;</em> |
| <a class="jxr_linenumber" name="L339" href="#L339">339</a> <em class="jxr_javadoccomment"> * }</em> |
| <a class="jxr_linenumber" name="L340" href="#L340">340</a> <em class="jxr_javadoccomment"> * </pre></em> |
| <a class="jxr_linenumber" name="L341" href="#L341">341</a> <em class="jxr_javadoccomment"> * </em> |
| <a class="jxr_linenumber" name="L342" href="#L342">342</a> <em class="jxr_javadoccomment"> * @param key The key we want to remove</em> |
| <a class="jxr_linenumber" name="L343" href="#L343">343</a> <em class="jxr_javadoccomment"> * @param value The value we want to remove</em> |
| <a class="jxr_linenumber" name="L344" href="#L344">344</a> <em class="jxr_javadoccomment"> * @return <tt>true</tt> if the removal was successful</em> |
| <a class="jxr_linenumber" name="L345" href="#L345">345</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L346" href="#L346">346</a> <strong class="jxr_keyword">boolean</strong> removeAttribute(Object key, Object value); |
| <a class="jxr_linenumber" name="L347" href="#L347">347</a> |
| <a class="jxr_linenumber" name="L348" href="#L348">348</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L349" href="#L349">349</a> <em class="jxr_javadoccomment"> * Replaces a user defined attribute with the specified key if the</em> |
| <a class="jxr_linenumber" name="L350" href="#L350">350</a> <em class="jxr_javadoccomment"> * value of the attribute is equals to the specified old value.</em> |
| <a class="jxr_linenumber" name="L351" href="#L351">351</a> <em class="jxr_javadoccomment"> * This method is same with the following code except that the operation</em> |
| <a class="jxr_linenumber" name="L352" href="#L352">352</a> <em class="jxr_javadoccomment"> * is performed atomically.</em> |
| <a class="jxr_linenumber" name="L353" href="#L353">353</a> <em class="jxr_javadoccomment"> * <pre></em> |
| <a class="jxr_linenumber" name="L354" href="#L354">354</a> <em class="jxr_javadoccomment"> * if (containsAttribute(key) &amp;&amp; getAttribute(key).equals(oldValue)) {</em> |
| <a class="jxr_linenumber" name="L355" href="#L355">355</a> <em class="jxr_javadoccomment"> * setAttribute(key, newValue);</em> |
| <a class="jxr_linenumber" name="L356" href="#L356">356</a> <em class="jxr_javadoccomment"> * return true;</em> |
| <a class="jxr_linenumber" name="L357" href="#L357">357</a> <em class="jxr_javadoccomment"> * } else {</em> |
| <a class="jxr_linenumber" name="L358" href="#L358">358</a> <em class="jxr_javadoccomment"> * return false;</em> |
| <a class="jxr_linenumber" name="L359" href="#L359">359</a> <em class="jxr_javadoccomment"> * }</em> |
| <a class="jxr_linenumber" name="L360" href="#L360">360</a> <em class="jxr_javadoccomment"> * </pre></em> |
| <a class="jxr_linenumber" name="L361" href="#L361">361</a> <em class="jxr_javadoccomment"> * </em> |
| <a class="jxr_linenumber" name="L362" href="#L362">362</a> <em class="jxr_javadoccomment"> * @param key The key we want to replace</em> |
| <a class="jxr_linenumber" name="L363" href="#L363">363</a> <em class="jxr_javadoccomment"> * @param oldValue The previous value</em> |
| <a class="jxr_linenumber" name="L364" href="#L364">364</a> <em class="jxr_javadoccomment"> * @param newValue The new value</em> |
| <a class="jxr_linenumber" name="L365" href="#L365">365</a> <em class="jxr_javadoccomment"> * @return <tt>true</tt> if the replacement was successful</em> |
| <a class="jxr_linenumber" name="L366" href="#L366">366</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L367" href="#L367">367</a> <strong class="jxr_keyword">boolean</strong> replaceAttribute(Object key, Object oldValue, Object newValue); |
| <a class="jxr_linenumber" name="L368" href="#L368">368</a> |
| <a class="jxr_linenumber" name="L369" href="#L369">369</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L370" href="#L370">370</a> <em class="jxr_javadoccomment"> * @param key The key of the attribute we are looking for in the session </em> |
| <a class="jxr_linenumber" name="L371" href="#L371">371</a> <em class="jxr_javadoccomment"> * @return <tt>true</tt> if this session contains the attribute with</em> |
| <a class="jxr_linenumber" name="L372" href="#L372">372</a> <em class="jxr_javadoccomment"> * the specified <tt>key</tt>.</em> |
| <a class="jxr_linenumber" name="L373" href="#L373">373</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L374" href="#L374">374</a> <strong class="jxr_keyword">boolean</strong> containsAttribute(Object key); |
| <a class="jxr_linenumber" name="L375" href="#L375">375</a> |
| <a class="jxr_linenumber" name="L376" href="#L376">376</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L377" href="#L377">377</a> <em class="jxr_javadoccomment"> * @return the set of keys of all user-defined attributes.</em> |
| <a class="jxr_linenumber" name="L378" href="#L378">378</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L379" href="#L379">379</a> Set<Object> getAttributeKeys(); |
| <a class="jxr_linenumber" name="L380" href="#L380">380</a> |
| <a class="jxr_linenumber" name="L381" href="#L381">381</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L382" href="#L382">382</a> <em class="jxr_javadoccomment"> * @return <tt>true</tt> if this session is connected with remote peer.</em> |
| <a class="jxr_linenumber" name="L383" href="#L383">383</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L384" href="#L384">384</a> <strong class="jxr_keyword">boolean</strong> isConnected(); |
| <a class="jxr_linenumber" name="L385" href="#L385">385</a> |
| <a class="jxr_linenumber" name="L386" href="#L386">386</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L387" href="#L387">387</a> <em class="jxr_javadoccomment"> * @return <tt>true</tt> if this session is active.</em> |
| <a class="jxr_linenumber" name="L388" href="#L388">388</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L389" href="#L389">389</a> <strong class="jxr_keyword">boolean</strong> isActive(); |
| <a class="jxr_linenumber" name="L390" href="#L390">390</a> |
| <a class="jxr_linenumber" name="L391" href="#L391">391</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L392" href="#L392">392</a> <em class="jxr_javadoccomment"> * @return <tt>true</tt> if and only if this session is being closed</em> |
| <a class="jxr_linenumber" name="L393" href="#L393">393</a> <em class="jxr_javadoccomment"> * (but not disconnected yet) or is closed.</em> |
| <a class="jxr_linenumber" name="L394" href="#L394">394</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L395" href="#L395">395</a> <strong class="jxr_keyword">boolean</strong> isClosing(); |
| <a class="jxr_linenumber" name="L396" href="#L396">396</a> |
| <a class="jxr_linenumber" name="L397" href="#L397">397</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L398" href="#L398">398</a> <em class="jxr_javadoccomment"> * @return <tt>true</tt> if the session has started and initialized a SslEngine,</em> |
| <a class="jxr_linenumber" name="L399" href="#L399">399</a> <em class="jxr_javadoccomment"> * <tt>false</tt> if the session is not yet secured (the handshake is not completed)</em> |
| <a class="jxr_linenumber" name="L400" href="#L400">400</a> <em class="jxr_javadoccomment"> * or if SSL is not set for this session, or if SSL is not even an option.</em> |
| <a class="jxr_linenumber" name="L401" href="#L401">401</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L402" href="#L402">402</a> <strong class="jxr_keyword">boolean</strong> isSecured(); |
| <a class="jxr_linenumber" name="L403" href="#L403">403</a> |
| <a class="jxr_linenumber" name="L404" href="#L404">404</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L405" href="#L405">405</a> <em class="jxr_javadoccomment"> * @return the {@link CloseFuture} of this session. This method returns</em> |
| <a class="jxr_linenumber" name="L406" href="#L406">406</a> <em class="jxr_javadoccomment"> * the same instance whenever user calls it.</em> |
| <a class="jxr_linenumber" name="L407" href="#L407">407</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L408" href="#L408">408</a> <a name="CloseFuture" href="../../../../../org/apache/mina/core/future/CloseFuture.html#CloseFuture">CloseFuture</a> getCloseFuture(); |
| <a class="jxr_linenumber" name="L409" href="#L409">409</a> |
| <a class="jxr_linenumber" name="L410" href="#L410">410</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L411" href="#L411">411</a> <em class="jxr_javadoccomment"> * @return the socket address of remote peer.</em> |
| <a class="jxr_linenumber" name="L412" href="#L412">412</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L413" href="#L413">413</a> SocketAddress getRemoteAddress(); |
| <a class="jxr_linenumber" name="L414" href="#L414">414</a> |
| <a class="jxr_linenumber" name="L415" href="#L415">415</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L416" href="#L416">416</a> <em class="jxr_javadoccomment"> * @return the socket address of local machine which is associated with this</em> |
| <a class="jxr_linenumber" name="L417" href="#L417">417</a> <em class="jxr_javadoccomment"> * session.</em> |
| <a class="jxr_linenumber" name="L418" href="#L418">418</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L419" href="#L419">419</a> SocketAddress getLocalAddress(); |
| <a class="jxr_linenumber" name="L420" href="#L420">420</a> |
| <a class="jxr_linenumber" name="L421" href="#L421">421</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L422" href="#L422">422</a> <em class="jxr_javadoccomment"> * @return the socket address of the {@link IoService} listens to to manage</em> |
| <a class="jxr_linenumber" name="L423" href="#L423">423</a> <em class="jxr_javadoccomment"> * this session. If this session is managed by {@link IoAcceptor}, it</em> |
| <a class="jxr_linenumber" name="L424" href="#L424">424</a> <em class="jxr_javadoccomment"> * returns the {@link SocketAddress} which is specified as a parameter of</em> |
| <a class="jxr_linenumber" name="L425" href="#L425">425</a> <em class="jxr_javadoccomment"> * {@link IoAcceptor#bind()}. If this session is managed by</em> |
| <a class="jxr_linenumber" name="L426" href="#L426">426</a> <em class="jxr_javadoccomment"> * {@link IoConnector}, this method returns the same address with</em> |
| <a class="jxr_linenumber" name="L427" href="#L427">427</a> <em class="jxr_javadoccomment"> * that of {@link #getRemoteAddress()}.</em> |
| <a class="jxr_linenumber" name="L428" href="#L428">428</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L429" href="#L429">429</a> SocketAddress getServiceAddress(); |
| <a class="jxr_linenumber" name="L430" href="#L430">430</a> |
| <a class="jxr_linenumber" name="L431" href="#L431">431</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L432" href="#L432">432</a> <em class="jxr_javadoccomment"> * </em> |
| <a class="jxr_linenumber" name="L433" href="#L433">433</a> <em class="jxr_javadoccomment"> * Associate the current write request with the session</em> |
| <a class="jxr_linenumber" name="L434" href="#L434">434</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L435" href="#L435">435</a> <em class="jxr_javadoccomment"> * @param currentWriteRequest the current write request to associate</em> |
| <a class="jxr_linenumber" name="L436" href="#L436">436</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L437" href="#L437">437</a> <strong class="jxr_keyword">void</strong> setCurrentWriteRequest(<a name="WriteRequest" href="../../../../../org/apache/mina/core/write/WriteRequest.html#WriteRequest">WriteRequest</a> currentWriteRequest); |
| <a class="jxr_linenumber" name="L438" href="#L438">438</a> |
| <a class="jxr_linenumber" name="L439" href="#L439">439</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L440" href="#L440">440</a> <em class="jxr_javadoccomment"> * Suspends read operations for this session.</em> |
| <a class="jxr_linenumber" name="L441" href="#L441">441</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L442" href="#L442">442</a> <strong class="jxr_keyword">void</strong> suspendRead(); |
| <a class="jxr_linenumber" name="L443" href="#L443">443</a> |
| <a class="jxr_linenumber" name="L444" href="#L444">444</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L445" href="#L445">445</a> <em class="jxr_javadoccomment"> * Suspends write operations for this session.</em> |
| <a class="jxr_linenumber" name="L446" href="#L446">446</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L447" href="#L447">447</a> <strong class="jxr_keyword">void</strong> suspendWrite(); |
| <a class="jxr_linenumber" name="L448" href="#L448">448</a> |
| <a class="jxr_linenumber" name="L449" href="#L449">449</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L450" href="#L450">450</a> <em class="jxr_javadoccomment"> * Resumes read operations for this session.</em> |
| <a class="jxr_linenumber" name="L451" href="#L451">451</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L452" href="#L452">452</a> <strong class="jxr_keyword">void</strong> resumeRead(); |
| <a class="jxr_linenumber" name="L453" href="#L453">453</a> |
| <a class="jxr_linenumber" name="L454" href="#L454">454</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L455" href="#L455">455</a> <em class="jxr_javadoccomment"> * Resumes write operations for this session.</em> |
| <a class="jxr_linenumber" name="L456" href="#L456">456</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L457" href="#L457">457</a> <strong class="jxr_keyword">void</strong> resumeWrite(); |
| <a class="jxr_linenumber" name="L458" href="#L458">458</a> |
| <a class="jxr_linenumber" name="L459" href="#L459">459</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L460" href="#L460">460</a> <em class="jxr_javadoccomment"> * Is read operation is suspended for this session. </em> |
| <a class="jxr_linenumber" name="L461" href="#L461">461</a> <em class="jxr_javadoccomment"> * </em> |
| <a class="jxr_linenumber" name="L462" href="#L462">462</a> <em class="jxr_javadoccomment"> * @return <tt>true</tt> if suspended</em> |
| <a class="jxr_linenumber" name="L463" href="#L463">463</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L464" href="#L464">464</a> <strong class="jxr_keyword">boolean</strong> isReadSuspended(); |
| <a class="jxr_linenumber" name="L465" href="#L465">465</a> |
| <a class="jxr_linenumber" name="L466" href="#L466">466</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L467" href="#L467">467</a> <em class="jxr_javadoccomment"> * Is write operation is suspended for this session.</em> |
| <a class="jxr_linenumber" name="L468" href="#L468">468</a> <em class="jxr_javadoccomment"> * </em> |
| <a class="jxr_linenumber" name="L469" href="#L469">469</a> <em class="jxr_javadoccomment"> * @return <tt>true</tt> if suspended</em> |
| <a class="jxr_linenumber" name="L470" href="#L470">470</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L471" href="#L471">471</a> <strong class="jxr_keyword">boolean</strong> isWriteSuspended(); |
| <a class="jxr_linenumber" name="L472" href="#L472">472</a> |
| <a class="jxr_linenumber" name="L473" href="#L473">473</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L474" href="#L474">474</a> <em class="jxr_javadoccomment"> * Update all statistical properties related with throughput assuming</em> |
| <a class="jxr_linenumber" name="L475" href="#L475">475</a> <em class="jxr_javadoccomment"> * the specified time is the current time. By default this method returns</em> |
| <a class="jxr_linenumber" name="L476" href="#L476">476</a> <em class="jxr_javadoccomment"> * silently without updating the throughput properties if they were</em> |
| <a class="jxr_linenumber" name="L477" href="#L477">477</a> <em class="jxr_javadoccomment"> * calculated already within last</em> |
| <a class="jxr_linenumber" name="L478" href="#L478">478</a> <em class="jxr_javadoccomment"> * {@link IoSessionConfig#getThroughputCalculationInterval() calculation interval}.</em> |
| <a class="jxr_linenumber" name="L479" href="#L479">479</a> <em class="jxr_javadoccomment"> * If, however, <tt>force</tt> is specified as <tt>true</tt>, this method</em> |
| <a class="jxr_linenumber" name="L480" href="#L480">480</a> <em class="jxr_javadoccomment"> * updates the throughput properties immediately.</em> |
| <a class="jxr_linenumber" name="L481" href="#L481">481</a> |
| <a class="jxr_linenumber" name="L482" href="#L482">482</a> <em class="jxr_javadoccomment"> * @param currentTime the current time in milliseconds</em> |
| <a class="jxr_linenumber" name="L483" href="#L483">483</a> <em class="jxr_javadoccomment"> * @param force Force the update if <tt>true</tt></em> |
| <a class="jxr_linenumber" name="L484" href="#L484">484</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L485" href="#L485">485</a> <strong class="jxr_keyword">void</strong> updateThroughput(<strong class="jxr_keyword">long</strong> currentTime, <strong class="jxr_keyword">boolean</strong> force); |
| <a class="jxr_linenumber" name="L486" href="#L486">486</a> |
| <a class="jxr_linenumber" name="L487" href="#L487">487</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L488" href="#L488">488</a> <em class="jxr_javadoccomment"> * @return the total number of bytes which were read from this session.</em> |
| <a class="jxr_linenumber" name="L489" href="#L489">489</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L490" href="#L490">490</a> <strong class="jxr_keyword">long</strong> getReadBytes(); |
| <a class="jxr_linenumber" name="L491" href="#L491">491</a> |
| <a class="jxr_linenumber" name="L492" href="#L492">492</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L493" href="#L493">493</a> <em class="jxr_javadoccomment"> * @return the total number of bytes which were written to this session.</em> |
| <a class="jxr_linenumber" name="L494" href="#L494">494</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L495" href="#L495">495</a> <strong class="jxr_keyword">long</strong> getWrittenBytes(); |
| <a class="jxr_linenumber" name="L496" href="#L496">496</a> |
| <a class="jxr_linenumber" name="L497" href="#L497">497</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L498" href="#L498">498</a> <em class="jxr_javadoccomment"> * @return the total number of messages which were read and decoded from this session.</em> |
| <a class="jxr_linenumber" name="L499" href="#L499">499</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L500" href="#L500">500</a> <strong class="jxr_keyword">long</strong> getReadMessages(); |
| <a class="jxr_linenumber" name="L501" href="#L501">501</a> |
| <a class="jxr_linenumber" name="L502" href="#L502">502</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L503" href="#L503">503</a> <em class="jxr_javadoccomment"> * @return the total number of messages which were written and encoded by this session.</em> |
| <a class="jxr_linenumber" name="L504" href="#L504">504</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L505" href="#L505">505</a> <strong class="jxr_keyword">long</strong> getWrittenMessages(); |
| <a class="jxr_linenumber" name="L506" href="#L506">506</a> |
| <a class="jxr_linenumber" name="L507" href="#L507">507</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L508" href="#L508">508</a> <em class="jxr_javadoccomment"> * @return the number of read bytes per second.</em> |
| <a class="jxr_linenumber" name="L509" href="#L509">509</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L510" href="#L510">510</a> <strong class="jxr_keyword">double</strong> getReadBytesThroughput(); |
| <a class="jxr_linenumber" name="L511" href="#L511">511</a> |
| <a class="jxr_linenumber" name="L512" href="#L512">512</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L513" href="#L513">513</a> <em class="jxr_javadoccomment"> * @return the number of written bytes per second.</em> |
| <a class="jxr_linenumber" name="L514" href="#L514">514</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L515" href="#L515">515</a> <strong class="jxr_keyword">double</strong> getWrittenBytesThroughput(); |
| <a class="jxr_linenumber" name="L516" href="#L516">516</a> |
| <a class="jxr_linenumber" name="L517" href="#L517">517</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L518" href="#L518">518</a> <em class="jxr_javadoccomment"> * @return the number of read messages per second.</em> |
| <a class="jxr_linenumber" name="L519" href="#L519">519</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L520" href="#L520">520</a> <strong class="jxr_keyword">double</strong> getReadMessagesThroughput(); |
| <a class="jxr_linenumber" name="L521" href="#L521">521</a> |
| <a class="jxr_linenumber" name="L522" href="#L522">522</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L523" href="#L523">523</a> <em class="jxr_javadoccomment"> * @return the number of written messages per second.</em> |
| <a class="jxr_linenumber" name="L524" href="#L524">524</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L525" href="#L525">525</a> <strong class="jxr_keyword">double</strong> getWrittenMessagesThroughput(); |
| <a class="jxr_linenumber" name="L526" href="#L526">526</a> |
| <a class="jxr_linenumber" name="L527" href="#L527">527</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L528" href="#L528">528</a> <em class="jxr_javadoccomment"> * @return the number of messages which are scheduled to be written to this session.</em> |
| <a class="jxr_linenumber" name="L529" href="#L529">529</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L530" href="#L530">530</a> <strong class="jxr_keyword">int</strong> getScheduledWriteMessages(); |
| <a class="jxr_linenumber" name="L531" href="#L531">531</a> |
| <a class="jxr_linenumber" name="L532" href="#L532">532</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L533" href="#L533">533</a> <em class="jxr_javadoccomment"> * @return the number of bytes which are scheduled to be written to this</em> |
| <a class="jxr_linenumber" name="L534" href="#L534">534</a> <em class="jxr_javadoccomment"> * session.</em> |
| <a class="jxr_linenumber" name="L535" href="#L535">535</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L536" href="#L536">536</a> <strong class="jxr_keyword">long</strong> getScheduledWriteBytes(); |
| <a class="jxr_linenumber" name="L537" href="#L537">537</a> |
| <a class="jxr_linenumber" name="L538" href="#L538">538</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L539" href="#L539">539</a> <em class="jxr_javadoccomment"> * Returns the message which is being written by {@link IoService}.</em> |
| <a class="jxr_linenumber" name="L540" href="#L540">540</a> <em class="jxr_javadoccomment"> * @return <tt>null</tt> if and if only no message is being written</em> |
| <a class="jxr_linenumber" name="L541" href="#L541">541</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L542" href="#L542">542</a> Object getCurrentWriteMessage(); |
| <a class="jxr_linenumber" name="L543" href="#L543">543</a> |
| <a class="jxr_linenumber" name="L544" href="#L544">544</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L545" href="#L545">545</a> <em class="jxr_javadoccomment"> * Returns the {@link WriteRequest} which is being processed by</em> |
| <a class="jxr_linenumber" name="L546" href="#L546">546</a> <em class="jxr_javadoccomment"> * {@link IoService}.</em> |
| <a class="jxr_linenumber" name="L547" href="#L547">547</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L548" href="#L548">548</a> <em class="jxr_javadoccomment"> * @return <tt>null</tt> if and if only no message is being written</em> |
| <a class="jxr_linenumber" name="L549" href="#L549">549</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L550" href="#L550">550</a> <a name="WriteRequest" href="../../../../../org/apache/mina/core/write/WriteRequest.html#WriteRequest">WriteRequest</a> getCurrentWriteRequest(); |
| <a class="jxr_linenumber" name="L551" href="#L551">551</a> |
| <a class="jxr_linenumber" name="L552" href="#L552">552</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L553" href="#L553">553</a> <em class="jxr_javadoccomment"> * @return the session's creation time in milliseconds</em> |
| <a class="jxr_linenumber" name="L554" href="#L554">554</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L555" href="#L555">555</a> <strong class="jxr_keyword">long</strong> getCreationTime(); |
| <a class="jxr_linenumber" name="L556" href="#L556">556</a> |
| <a class="jxr_linenumber" name="L557" href="#L557">557</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L558" href="#L558">558</a> <em class="jxr_javadoccomment"> * @return the time in millis when I/O occurred lastly.</em> |
| <a class="jxr_linenumber" name="L559" href="#L559">559</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L560" href="#L560">560</a> <strong class="jxr_keyword">long</strong> getLastIoTime(); |
| <a class="jxr_linenumber" name="L561" href="#L561">561</a> |
| <a class="jxr_linenumber" name="L562" href="#L562">562</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L563" href="#L563">563</a> <em class="jxr_javadoccomment"> * @return the time in millis when read operation occurred lastly.</em> |
| <a class="jxr_linenumber" name="L564" href="#L564">564</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L565" href="#L565">565</a> <strong class="jxr_keyword">long</strong> getLastReadTime(); |
| <a class="jxr_linenumber" name="L566" href="#L566">566</a> |
| <a class="jxr_linenumber" name="L567" href="#L567">567</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L568" href="#L568">568</a> <em class="jxr_javadoccomment"> * @return the time in millis when write operation occurred lastly.</em> |
| <a class="jxr_linenumber" name="L569" href="#L569">569</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L570" href="#L570">570</a> <strong class="jxr_keyword">long</strong> getLastWriteTime(); |
| <a class="jxr_linenumber" name="L571" href="#L571">571</a> |
| <a class="jxr_linenumber" name="L572" href="#L572">572</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L573" href="#L573">573</a> <em class="jxr_javadoccomment"> * @param status The researched idle status</em> |
| <a class="jxr_linenumber" name="L574" href="#L574">574</a> <em class="jxr_javadoccomment"> * @return <tt>true</tt> if this session is idle for the specified</em> |
| <a class="jxr_linenumber" name="L575" href="#L575">575</a> <em class="jxr_javadoccomment"> * {@link IdleStatus}.</em> |
| <a class="jxr_linenumber" name="L576" href="#L576">576</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L577" href="#L577">577</a> <strong class="jxr_keyword">boolean</strong> isIdle(<a name="IdleStatus" href="../../../../../org/apache/mina/core/session/IdleStatus.html#IdleStatus">IdleStatus</a> status); |
| <a class="jxr_linenumber" name="L578" href="#L578">578</a> |
| <a class="jxr_linenumber" name="L579" href="#L579">579</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L580" href="#L580">580</a> <em class="jxr_javadoccomment"> * @return <tt>true</tt> if this session is {@link IdleStatus#READER_IDLE}.</em> |
| <a class="jxr_linenumber" name="L581" href="#L581">581</a> <em class="jxr_javadoccomment"> * @see #isIdle(IdleStatus)</em> |
| <a class="jxr_linenumber" name="L582" href="#L582">582</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L583" href="#L583">583</a> <strong class="jxr_keyword">boolean</strong> isReaderIdle(); |
| <a class="jxr_linenumber" name="L584" href="#L584">584</a> |
| <a class="jxr_linenumber" name="L585" href="#L585">585</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L586" href="#L586">586</a> <em class="jxr_javadoccomment"> * @return <tt>true</tt> if this session is {@link IdleStatus#WRITER_IDLE}.</em> |
| <a class="jxr_linenumber" name="L587" href="#L587">587</a> <em class="jxr_javadoccomment"> * @see #isIdle(IdleStatus)</em> |
| <a class="jxr_linenumber" name="L588" href="#L588">588</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L589" href="#L589">589</a> <strong class="jxr_keyword">boolean</strong> isWriterIdle(); |
| <a class="jxr_linenumber" name="L590" href="#L590">590</a> |
| <a class="jxr_linenumber" name="L591" href="#L591">591</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L592" href="#L592">592</a> <em class="jxr_javadoccomment"> * @return <tt>true</tt> if this session is {@link IdleStatus#BOTH_IDLE}.</em> |
| <a class="jxr_linenumber" name="L593" href="#L593">593</a> <em class="jxr_javadoccomment"> * @see #isIdle(IdleStatus)</em> |
| <a class="jxr_linenumber" name="L594" href="#L594">594</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L595" href="#L595">595</a> <strong class="jxr_keyword">boolean</strong> isBothIdle(); |
| <a class="jxr_linenumber" name="L596" href="#L596">596</a> |
| <a class="jxr_linenumber" name="L597" href="#L597">597</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L598" href="#L598">598</a> <em class="jxr_javadoccomment"> * @param status The researched idle status</em> |
| <a class="jxr_linenumber" name="L599" href="#L599">599</a> <em class="jxr_javadoccomment"> * @return the number of the fired continuous <tt>sessionIdle</tt> events</em> |
| <a class="jxr_linenumber" name="L600" href="#L600">600</a> <em class="jxr_javadoccomment"> * for the specified {@link IdleStatus}.</em> |
| <a class="jxr_linenumber" name="L601" href="#L601">601</a> <em class="jxr_javadoccomment"> * <p></em> |
| <a class="jxr_linenumber" name="L602" href="#L602">602</a> <em class="jxr_javadoccomment"> * If <tt>sessionIdle</tt> event is fired first after some time after I/O,</em> |
| <a class="jxr_linenumber" name="L603" href="#L603">603</a> <em class="jxr_javadoccomment"> * <tt>idleCount</tt> becomes <tt>1</tt>. <tt>idleCount</tt> resets to</em> |
| <a class="jxr_linenumber" name="L604" href="#L604">604</a> <em class="jxr_javadoccomment"> * <tt>0</tt> if any I/O occurs again, otherwise it increases to</em> |
| <a class="jxr_linenumber" name="L605" href="#L605">605</a> <em class="jxr_javadoccomment"> * <tt>2</tt> and so on if <tt>sessionIdle</tt> event is fired again without</em> |
| <a class="jxr_linenumber" name="L606" href="#L606">606</a> <em class="jxr_javadoccomment"> * any I/O between two (or more) <tt>sessionIdle</tt> events.</em> |
| <a class="jxr_linenumber" name="L607" href="#L607">607</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L608" href="#L608">608</a> <strong class="jxr_keyword">int</strong> getIdleCount(<a name="IdleStatus" href="../../../../../org/apache/mina/core/session/IdleStatus.html#IdleStatus">IdleStatus</a> status); |
| <a class="jxr_linenumber" name="L609" href="#L609">609</a> |
| <a class="jxr_linenumber" name="L610" href="#L610">610</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L611" href="#L611">611</a> <em class="jxr_javadoccomment"> * @return the number of the fired continuous <tt>sessionIdle</tt> events</em> |
| <a class="jxr_linenumber" name="L612" href="#L612">612</a> <em class="jxr_javadoccomment"> * for {@link IdleStatus#READER_IDLE}.</em> |
| <a class="jxr_linenumber" name="L613" href="#L613">613</a> <em class="jxr_javadoccomment"> * @see #getIdleCount(IdleStatus)</em> |
| <a class="jxr_linenumber" name="L614" href="#L614">614</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L615" href="#L615">615</a> <strong class="jxr_keyword">int</strong> getReaderIdleCount(); |
| <a class="jxr_linenumber" name="L616" href="#L616">616</a> |
| <a class="jxr_linenumber" name="L617" href="#L617">617</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L618" href="#L618">618</a> <em class="jxr_javadoccomment"> * @return the number of the fired continuous <tt>sessionIdle</tt> events</em> |
| <a class="jxr_linenumber" name="L619" href="#L619">619</a> <em class="jxr_javadoccomment"> * for {@link IdleStatus#WRITER_IDLE}.</em> |
| <a class="jxr_linenumber" name="L620" href="#L620">620</a> <em class="jxr_javadoccomment"> * @see #getIdleCount(IdleStatus)</em> |
| <a class="jxr_linenumber" name="L621" href="#L621">621</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L622" href="#L622">622</a> <strong class="jxr_keyword">int</strong> getWriterIdleCount(); |
| <a class="jxr_linenumber" name="L623" href="#L623">623</a> |
| <a class="jxr_linenumber" name="L624" href="#L624">624</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L625" href="#L625">625</a> <em class="jxr_javadoccomment"> * @return the number of the fired continuous <tt>sessionIdle</tt> events</em> |
| <a class="jxr_linenumber" name="L626" href="#L626">626</a> <em class="jxr_javadoccomment"> * for {@link IdleStatus#BOTH_IDLE}.</em> |
| <a class="jxr_linenumber" name="L627" href="#L627">627</a> <em class="jxr_javadoccomment"> * @see #getIdleCount(IdleStatus)</em> |
| <a class="jxr_linenumber" name="L628" href="#L628">628</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L629" href="#L629">629</a> <strong class="jxr_keyword">int</strong> getBothIdleCount(); |
| <a class="jxr_linenumber" name="L630" href="#L630">630</a> |
| <a class="jxr_linenumber" name="L631" href="#L631">631</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L632" href="#L632">632</a> <em class="jxr_javadoccomment"> * @param status The researched idle status</em> |
| <a class="jxr_linenumber" name="L633" href="#L633">633</a> <em class="jxr_javadoccomment"> * @return the time in milliseconds when the last <tt>sessionIdle</tt> event</em> |
| <a class="jxr_linenumber" name="L634" href="#L634">634</a> <em class="jxr_javadoccomment"> * is fired for the specified {@link IdleStatus}.</em> |
| <a class="jxr_linenumber" name="L635" href="#L635">635</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L636" href="#L636">636</a> <strong class="jxr_keyword">long</strong> getLastIdleTime(<a name="IdleStatus" href="../../../../../org/apache/mina/core/session/IdleStatus.html#IdleStatus">IdleStatus</a> status); |
| <a class="jxr_linenumber" name="L637" href="#L637">637</a> |
| <a class="jxr_linenumber" name="L638" href="#L638">638</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L639" href="#L639">639</a> <em class="jxr_javadoccomment"> * @return the time in milliseconds when the last <tt>sessionIdle</tt> event</em> |
| <a class="jxr_linenumber" name="L640" href="#L640">640</a> <em class="jxr_javadoccomment"> * is fired for {@link IdleStatus#READER_IDLE}.</em> |
| <a class="jxr_linenumber" name="L641" href="#L641">641</a> <em class="jxr_javadoccomment"> * @see #getLastIdleTime(IdleStatus)</em> |
| <a class="jxr_linenumber" name="L642" href="#L642">642</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L643" href="#L643">643</a> <strong class="jxr_keyword">long</strong> getLastReaderIdleTime(); |
| <a class="jxr_linenumber" name="L644" href="#L644">644</a> |
| <a class="jxr_linenumber" name="L645" href="#L645">645</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L646" href="#L646">646</a> <em class="jxr_javadoccomment"> * @return the time in milliseconds when the last <tt>sessionIdle</tt> event</em> |
| <a class="jxr_linenumber" name="L647" href="#L647">647</a> <em class="jxr_javadoccomment"> * is fired for {@link IdleStatus#WRITER_IDLE}.</em> |
| <a class="jxr_linenumber" name="L648" href="#L648">648</a> <em class="jxr_javadoccomment"> * @see #getLastIdleTime(IdleStatus)</em> |
| <a class="jxr_linenumber" name="L649" href="#L649">649</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L650" href="#L650">650</a> <strong class="jxr_keyword">long</strong> getLastWriterIdleTime(); |
| <a class="jxr_linenumber" name="L651" href="#L651">651</a> |
| <a class="jxr_linenumber" name="L652" href="#L652">652</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L653" href="#L653">653</a> <em class="jxr_javadoccomment"> * @return the time in milliseconds when the last <tt>sessionIdle</tt> event</em> |
| <a class="jxr_linenumber" name="L654" href="#L654">654</a> <em class="jxr_javadoccomment"> * is fired for {@link IdleStatus#BOTH_IDLE}.</em> |
| <a class="jxr_linenumber" name="L655" href="#L655">655</a> <em class="jxr_javadoccomment"> * @see #getLastIdleTime(IdleStatus)</em> |
| <a class="jxr_linenumber" name="L656" href="#L656">656</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L657" href="#L657">657</a> <strong class="jxr_keyword">long</strong> getLastBothIdleTime(); |
| <a class="jxr_linenumber" name="L658" href="#L658">658</a> } |
| </pre> |
| <hr/> |
| <div id="footer">Copyright © 2004–2019 <a href="http://mina.apache.org/">Apache MINA Project</a>. All rights reserved.</div> |
| </body> |
| </html> |
