blob: 628d7659cba74dea00ccb5a8a957a8526a5fdfc2 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>IoProtocolSession xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../apidocs/org/apache/mina/protocol/io/IoProtocolSession.html">View Javadoc</a></div><pre>
<a name="1" href="#1">1</a> <em>/**<em>*</em></em>
<a name="2" href="#2">2</a> <em> * </em>
<a name="3" href="#3">3</a> <em> */</em>
<a name="4" href="#4">4</a> <strong>package</strong> <a href="../../../../../org/apache/mina/protocol/io/package-summary.html">org.apache.mina.protocol.io</a>;
<a name="5" href="#5">5</a>
<a name="6" href="#6">6</a> <strong>import</strong> java.net.SocketAddress;
<a name="7" href="#7">7</a> <strong>import</strong> java.util.Set;
<a name="8" href="#8">8</a>
<a name="9" href="#9">9</a> <strong>import</strong> org.apache.mina.common.IdleStatus;
<a name="10" href="#10">10</a> <strong>import</strong> org.apache.mina.common.SessionConfig;
<a name="11" href="#11">11</a> <strong>import</strong> org.apache.mina.common.TransportType;
<a name="12" href="#12">12</a> <strong>import</strong> org.apache.mina.io.IoSession;
<a name="13" href="#13">13</a> <strong>import</strong> org.apache.mina.protocol.ProtocolDecoder;
<a name="14" href="#14">14</a> <strong>import</strong> org.apache.mina.protocol.ProtocolEncoder;
<a name="15" href="#15">15</a> <strong>import</strong> org.apache.mina.protocol.ProtocolHandler;
<a name="16" href="#16">16</a> <strong>import</strong> org.apache.mina.protocol.ProtocolFilterChain;
<a name="17" href="#17">17</a> <strong>import</strong> org.apache.mina.protocol.ProtocolSession;
<a name="18" href="#18">18</a> <strong>import</strong> org.apache.mina.protocol.ProtocolSessionFilterChain;
<a name="19" href="#19">19</a> <strong>import</strong> org.apache.mina.protocol.ProtocolSessionManagerFilterChain;
<a name="20" href="#20">20</a> <strong>import</strong> org.apache.mina.protocol.SimpleProtocolDecoderOutput;
<a name="21" href="#21">21</a> <strong>import</strong> org.apache.mina.protocol.SimpleProtocolEncoderOutput;
<a name="22" href="#22">22</a> <strong>import</strong> org.apache.mina.protocol.io.IoAdapter.SessionHandlerAdapter;
<a name="23" href="#23">23</a> <strong>import</strong> org.apache.mina.util.Queue;
<a name="24" href="#24">24</a>
<a name="25" href="#25">25</a> <em>/**<em>*</em></em>
<a name="26" href="#26">26</a> <em> * A {@link ProtocolSession} that is backed by {@link IoSession}.</em>
<a name="27" href="#27">27</a> <em> * </em>
<a name="28" href="#28">28</a> <em> * @author Trustin Lee (trustin@apache.org)</em>
<a name="29" href="#29">29</a> <em> * @version $Rev: 210062 $, $Date: 2005-07-11 12:52:38 +0900 $</em>
<a name="30" href="#30">30</a> <em> */</em>
<a name="31" href="#31">31</a> <strong>public</strong> <strong>class</strong> <a href="../../../../../org/apache/mina/protocol/io/IoProtocolSession.html">IoProtocolSession</a> implements <a href="../../../../../org/apache/mina/protocol/ProtocolSession.html">ProtocolSession</a>
<a name="32" href="#32">32</a> {
<a name="33" href="#33">33</a> <strong>private</strong> <strong>final</strong> <a href="../../../../../org/apache/mina/protocol/ProtocolSessionFilterChain.html">ProtocolSessionFilterChain</a> filterChain;
<a name="34" href="#34">34</a>
<a name="35" href="#35">35</a> <strong>final</strong> <a href="../../../../../org/apache/mina/io/IoSession.html">IoSession</a> session;
<a name="36" href="#36">36</a>
<a name="37" href="#37">37</a> <strong>final</strong> SessionHandlerAdapter shAdapter;
<a name="38" href="#38">38</a>
<a name="39" href="#39">39</a> <strong>final</strong> <a href="../../../../../org/apache/mina/util/Queue.html">Queue</a> writeQueue = <strong>new</strong> <a href="../../../../../org/apache/mina/util/Queue.html">Queue</a>();
<a name="40" href="#40">40</a>
<a name="41" href="#41">41</a> <strong>final</strong> <a href="../../../../../org/apache/mina/protocol/ProtocolEncoder.html">ProtocolEncoder</a> encoder;
<a name="42" href="#42">42</a>
<a name="43" href="#43">43</a> <strong>final</strong> <a href="../../../../../org/apache/mina/protocol/ProtocolDecoder.html">ProtocolDecoder</a> decoder;
<a name="44" href="#44">44</a>
<a name="45" href="#45">45</a> <strong>final</strong> <a href="../../../../../org/apache/mina/protocol/SimpleProtocolEncoderOutput.html">SimpleProtocolEncoderOutput</a> encOut;
<a name="46" href="#46">46</a>
<a name="47" href="#47">47</a> <strong>final</strong> <a href="../../../../../org/apache/mina/protocol/SimpleProtocolDecoderOutput.html">SimpleProtocolDecoderOutput</a> decOut;
<a name="48" href="#48">48</a>
<a name="49" href="#49">49</a> <a href="../../../../../org/apache/mina/protocol/io/IoProtocolSession.html">IoProtocolSession</a>( ProtocolSessionManagerFilterChain managerFilterChain,
<a name="50" href="#50">50</a> <a href="../../../../../org/apache/mina/io/IoSession.html">IoSession</a> session, SessionHandlerAdapter shAdapter )
<a name="51" href="#51">51</a> {
<a name="52" href="#52">52</a> <strong>this</strong>.filterChain = <strong>new</strong> <a href="../../../../../org/apache/mina/protocol/ProtocolSessionFilterChain.html">ProtocolSessionFilterChain</a>( managerFilterChain );
<a name="53" href="#53">53</a> <strong>this</strong>.session = session;
<a name="54" href="#54">54</a> <strong>this</strong>.shAdapter = shAdapter;
<a name="55" href="#55">55</a> <strong>this</strong>.encoder = shAdapter.codecFactory.newEncoder();
<a name="56" href="#56">56</a> <strong>this</strong>.decoder = shAdapter.codecFactory.newDecoder();
<a name="57" href="#57">57</a> <strong>this</strong>.encOut = <strong>new</strong> <a href="../../../../../org/apache/mina/protocol/SimpleProtocolEncoderOutput.html">SimpleProtocolEncoderOutput</a>();
<a name="58" href="#58">58</a> <strong>this</strong>.decOut = <strong>new</strong> <a href="../../../../../org/apache/mina/protocol/SimpleProtocolDecoderOutput.html">SimpleProtocolDecoderOutput</a>();
<a name="59" href="#59">59</a> }
<a name="60" href="#60">60</a>
<a name="61" href="#61">61</a> <em>/**<em>*</em></em>
<a name="62" href="#62">62</a> <em> * Returns the {@link IoSession} this session is backed by.</em>
<a name="63" href="#63">63</a> <em> */</em>
<a name="64" href="#64">64</a> <strong>public</strong> <a href="../../../../../org/apache/mina/io/IoSession.html">IoSession</a> getIoSession()
<a name="65" href="#65">65</a> {
<a name="66" href="#66">66</a> <strong>return</strong> session;
<a name="67" href="#67">67</a> }
<a name="68" href="#68">68</a>
<a name="69" href="#69">69</a> <strong>public</strong> <a href="../../../../../org/apache/mina/protocol/ProtocolFilterChain.html">ProtocolFilterChain</a> getFilterChain()
<a name="70" href="#70">70</a> {
<a name="71" href="#71">71</a> <strong>return</strong> filterChain;
<a name="72" href="#72">72</a> }
<a name="73" href="#73">73</a>
<a name="74" href="#74">74</a> <strong>public</strong> <a href="../../../../../org/apache/mina/protocol/ProtocolHandler.html">ProtocolHandler</a> getHandler()
<a name="75" href="#75">75</a> {
<a name="76" href="#76">76</a> <strong>return</strong> shAdapter.handler;
<a name="77" href="#77">77</a> }
<a name="78" href="#78">78</a>
<a name="79" href="#79">79</a> <strong>public</strong> <a href="../../../../../org/apache/mina/protocol/ProtocolEncoder.html">ProtocolEncoder</a> getEncoder()
<a name="80" href="#80">80</a> {
<a name="81" href="#81">81</a> <strong>return</strong> encoder;
<a name="82" href="#82">82</a> }
<a name="83" href="#83">83</a>
<a name="84" href="#84">84</a> <strong>public</strong> <a href="../../../../../org/apache/mina/protocol/ProtocolDecoder.html">ProtocolDecoder</a> getDecoder()
<a name="85" href="#85">85</a> {
<a name="86" href="#86">86</a> <strong>return</strong> decoder;
<a name="87" href="#87">87</a> }
<a name="88" href="#88">88</a>
<a name="89" href="#89">89</a> <strong>public</strong> <strong>void</strong> close()
<a name="90" href="#90">90</a> {
<a name="91" href="#91">91</a> session.close();
<a name="92" href="#92">92</a> }
<a name="93" href="#93">93</a>
<a name="94" href="#94">94</a> <strong>public</strong> <strong>void</strong> close( <strong>boolean</strong> wait )
<a name="95" href="#95">95</a> {
<a name="96" href="#96">96</a> session.close( wait );
<a name="97" href="#97">97</a> }
<a name="98" href="#98">98</a>
<a name="99" href="#99">99</a> <strong>public</strong> Object getAttachment()
<a name="100" href="#100">100</a> {
<a name="101" href="#101">101</a> <strong>return</strong> session.getAttachment();
<a name="102" href="#102">102</a> }
<a name="103" href="#103">103</a>
<a name="104" href="#104">104</a> <strong>public</strong> Object setAttachment( Object attachment )
<a name="105" href="#105">105</a> {
<a name="106" href="#106">106</a> <strong>return</strong> session.setAttachment( attachment );
<a name="107" href="#107">107</a> }
<a name="108" href="#108">108</a>
<a name="109" href="#109">109</a> <strong>public</strong> Object getAttribute( String key )
<a name="110" href="#110">110</a> {
<a name="111" href="#111">111</a> <strong>return</strong> session.getAttribute( key );
<a name="112" href="#112">112</a> }
<a name="113" href="#113">113</a>
<a name="114" href="#114">114</a> <strong>public</strong> Object setAttribute( String key, Object value )
<a name="115" href="#115">115</a> {
<a name="116" href="#116">116</a> <strong>return</strong> session.setAttribute( key, value );
<a name="117" href="#117">117</a> }
<a name="118" href="#118">118</a>
<a name="119" href="#119">119</a> <strong>public</strong> Object removeAttribute( String key )
<a name="120" href="#120">120</a> {
<a name="121" href="#121">121</a> <strong>return</strong> session.removeAttribute( key );
<a name="122" href="#122">122</a> }
<a name="123" href="#123">123</a>
<a name="124" href="#124">124</a> <strong>public</strong> Set getAttributeKeys()
<a name="125" href="#125">125</a> {
<a name="126" href="#126">126</a> <strong>return</strong> session.getAttributeKeys();
<a name="127" href="#127">127</a> }
<a name="128" href="#128">128</a>
<a name="129" href="#129">129</a> <strong>public</strong> <strong>void</strong> write( Object message )
<a name="130" href="#130">130</a> {
<a name="131" href="#131">131</a> filterChain.filterWrite( <strong>this</strong>, message );
<a name="132" href="#132">132</a> }
<a name="133" href="#133">133</a>
<a name="134" href="#134">134</a> <strong>public</strong> <strong>long</strong> getWrittenWriteRequests()
<a name="135" href="#135">135</a> {
<a name="136" href="#136">136</a> <strong>return</strong> session.getWrittenWriteRequests();
<a name="137" href="#137">137</a> }
<a name="138" href="#138">138</a>
<a name="139" href="#139">139</a> <strong>public</strong> <strong>int</strong> getScheduledWriteRequests()
<a name="140" href="#140">140</a> {
<a name="141" href="#141">141</a> <strong>return</strong> session.getScheduledWriteRequests();
<a name="142" href="#142">142</a> }
<a name="143" href="#143">143</a>
<a name="144" href="#144">144</a> <strong>public</strong> <a href="../../../../../org/apache/mina/common/TransportType.html">TransportType</a> getTransportType()
<a name="145" href="#145">145</a> {
<a name="146" href="#146">146</a> <strong>return</strong> session.getTransportType();
<a name="147" href="#147">147</a> }
<a name="148" href="#148">148</a>
<a name="149" href="#149">149</a> <strong>public</strong> <strong>boolean</strong> isConnected()
<a name="150" href="#150">150</a> {
<a name="151" href="#151">151</a> <strong>return</strong> session.isConnected();
<a name="152" href="#152">152</a> }
<a name="153" href="#153">153</a>
<a name="154" href="#154">154</a> <strong>public</strong> <a href="../../../../../org/apache/mina/common/SessionConfig.html">SessionConfig</a> getConfig()
<a name="155" href="#155">155</a> {
<a name="156" href="#156">156</a> <strong>return</strong> session.getConfig();
<a name="157" href="#157">157</a> }
<a name="158" href="#158">158</a>
<a name="159" href="#159">159</a> <strong>public</strong> SocketAddress getRemoteAddress()
<a name="160" href="#160">160</a> {
<a name="161" href="#161">161</a> <strong>return</strong> session.getRemoteAddress();
<a name="162" href="#162">162</a> }
<a name="163" href="#163">163</a>
<a name="164" href="#164">164</a> <strong>public</strong> SocketAddress getLocalAddress()
<a name="165" href="#165">165</a> {
<a name="166" href="#166">166</a> <strong>return</strong> session.getLocalAddress();
<a name="167" href="#167">167</a> }
<a name="168" href="#168">168</a>
<a name="169" href="#169">169</a> <strong>public</strong> <strong>long</strong> getReadBytes()
<a name="170" href="#170">170</a> {
<a name="171" href="#171">171</a> <strong>return</strong> session.getReadBytes();
<a name="172" href="#172">172</a> }
<a name="173" href="#173">173</a>
<a name="174" href="#174">174</a> <strong>public</strong> <strong>long</strong> getWrittenBytes()
<a name="175" href="#175">175</a> {
<a name="176" href="#176">176</a> <strong>return</strong> session.getWrittenBytes();
<a name="177" href="#177">177</a> }
<a name="178" href="#178">178</a>
<a name="179" href="#179">179</a> <strong>public</strong> <strong>long</strong> getLastIoTime()
<a name="180" href="#180">180</a> {
<a name="181" href="#181">181</a> <strong>return</strong> session.getLastIoTime();
<a name="182" href="#182">182</a> }
<a name="183" href="#183">183</a>
<a name="184" href="#184">184</a> <strong>public</strong> <strong>long</strong> getLastReadTime()
<a name="185" href="#185">185</a> {
<a name="186" href="#186">186</a> <strong>return</strong> session.getLastReadTime();
<a name="187" href="#187">187</a> }
<a name="188" href="#188">188</a>
<a name="189" href="#189">189</a> <strong>public</strong> <strong>long</strong> getLastWriteTime()
<a name="190" href="#190">190</a> {
<a name="191" href="#191">191</a> <strong>return</strong> session.getLastWriteTime();
<a name="192" href="#192">192</a> }
<a name="193" href="#193">193</a>
<a name="194" href="#194">194</a> <strong>public</strong> <strong>boolean</strong> isIdle( IdleStatus status )
<a name="195" href="#195">195</a> {
<a name="196" href="#196">196</a> <strong>return</strong> session.isIdle( status );
<a name="197" href="#197">197</a> }
<a name="198" href="#198">198</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>