📄 iosession.html
字号:
<!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>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -