| <!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>IoAcceptor xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../apidocs/org/apache/mina/common/IoAcceptor.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.io.IOException; |
| <a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> java.net.SocketAddress; |
| <a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> java.util.List; |
| <a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> java.util.Set; |
| <a name="26" href="#26">26</a> |
| <a name="27" href="#27">27</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="28" href="#28">28</a> <em class="jxr_javadoccomment"> * Accepts incoming connection, communicates with clients, and fires events to</em> |
| <a name="29" href="#29">29</a> <em class="jxr_javadoccomment"> * {@link IoHandler}s.</em> |
| <a name="30" href="#30">30</a> <em class="jxr_javadoccomment"> * <p></em> |
| <a name="31" href="#31">31</a> <em class="jxr_javadoccomment"> * Please refer to</em> |
| <a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * <a href="../../../../../xref-examples/org/apache/mina/examples/echoserver/Main.html">EchoServer</a></em> |
| <a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * example.</em> |
| <a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * <p></em> |
| <a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * You should bind to the desired socket address to accept incoming</em> |
| <a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * connections, and then events for incoming connections will be sent to</em> |
| <a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * the specified default {@link IoHandler}.</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"> * Threads accept incoming connections start automatically when</em> |
| <a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * {@link #bind()} is invoked, and stop when {@link #unbind()} is invoked.</em> |
| <a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * @author The Apache MINA Project (dev@mina.apache.org)</em> |
| <a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * @version $Rev: 601229 $, $Date: 2007-12-05 00:13:18 -0700 (Wed, 05 Dec 2007) $</em> |
| <a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="45" href="#45">45</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a href="../../../../org/apache/mina/common/IoAcceptor.html">IoAcceptor</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../org/apache/mina/common/IoService.html">IoService</a> { |
| <a name="46" href="#46">46</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * Returns the local address which is bound currently. If more than one</em> |
| <a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * address are bound, only one of them will be returned, but it's not</em> |
| <a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * necessarily the firstly bound address.</em> |
| <a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="51" href="#51">51</a> SocketAddress getLocalAddress(); |
| <a name="52" href="#52">52</a> |
| <a name="53" href="#53">53</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * Returns a {@link Set} of the local addresses which are bound currently.</em> |
| <a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="56" href="#56">56</a> Set<SocketAddress> getLocalAddresses(); |
| <a name="57" href="#57">57</a> |
| <a name="58" href="#58">58</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="59" href="#59">59</a> <em class="jxr_javadoccomment"> * Returns the default local address to bind when no argument is specified</em> |
| <a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> * in {@link #bind()} method. Please note that the default will not be</em> |
| <a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * used if any local address is specified. If more than one address are</em> |
| <a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * set, only one of them will be returned, but it's not necessarily the</em> |
| <a name="63" href="#63">63</a> <em class="jxr_javadoccomment"> * firstly specified address in {@link #setDefaultLocalAddresses(List)}.</em> |
| <a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * </em> |
| <a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="66" href="#66">66</a> SocketAddress getDefaultLocalAddress(); |
| <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 a {@link List} of the default local addresses to bind when no</em> |
| <a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> * argument is specified in {@link #bind()} method. Please note that the</em> |
| <a name="71" href="#71">71</a> <em class="jxr_javadoccomment"> * default will not be used if any local address is specified.</em> |
| <a name="72" href="#72">72</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="73" href="#73">73</a> List<SocketAddress> getDefaultLocalAddresses(); |
| <a name="74" href="#74">74</a> |
| <a name="75" href="#75">75</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="76" href="#76">76</a> <em class="jxr_javadoccomment"> * Sets the default local address to bind when no argument is specified in</em> |
| <a name="77" href="#77">77</a> <em class="jxr_javadoccomment"> * {@link #bind()} method. Please note that the default will not be used</em> |
| <a name="78" href="#78">78</a> <em class="jxr_javadoccomment"> * if any local address is specified.</em> |
| <a name="79" href="#79">79</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="80" href="#80">80</a> <strong class="jxr_keyword">void</strong> setDefaultLocalAddress(SocketAddress localAddress); |
| <a name="81" href="#81">81</a> |
| <a name="82" href="#82">82</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="83" href="#83">83</a> <em class="jxr_javadoccomment"> * Sets the default local addresses to bind when no argument is specified</em> |
| <a name="84" href="#84">84</a> <em class="jxr_javadoccomment"> * in {@link #bind()} method. Please note that the default will not be</em> |
| <a name="85" href="#85">85</a> <em class="jxr_javadoccomment"> * used if any local address is specified.</em> |
| <a name="86" href="#86">86</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="87" href="#87">87</a> <strong class="jxr_keyword">void</strong> setDefaultLocalAddresses(SocketAddress firstLocalAddress, SocketAddress... otherLocalAddresses); |
| <a name="88" href="#88">88</a> |
| <a name="89" href="#89">89</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="90" href="#90">90</a> <em class="jxr_javadoccomment"> * Sets the default local addresses to bind when no argument is specified</em> |
| <a name="91" href="#91">91</a> <em class="jxr_javadoccomment"> * in {@link #bind()} method. Please note that the default will not be</em> |
| <a name="92" href="#92">92</a> <em class="jxr_javadoccomment"> * used if any local address is specified.</em> |
| <a name="93" href="#93">93</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="94" href="#94">94</a> <strong class="jxr_keyword">void</strong> setDefaultLocalAddresses(Iterable<? <strong class="jxr_keyword">extends</strong> SocketAddress> localAddresses); |
| <a name="95" href="#95">95</a> |
| <a name="96" href="#96">96</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="97" href="#97">97</a> <em class="jxr_javadoccomment"> * Sets the default local addresses to bind when no argument is specified</em> |
| <a name="98" href="#98">98</a> <em class="jxr_javadoccomment"> * in {@link #bind()} method. Please note that the default will not be</em> |
| <a name="99" href="#99">99</a> <em class="jxr_javadoccomment"> * used if any local address is specified.</em> |
| <a name="100" href="#100">100</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="101" href="#101">101</a> <strong class="jxr_keyword">void</strong> setDefaultLocalAddresses(List<? <strong class="jxr_keyword">extends</strong> SocketAddress> localAddresses); |
| <a name="102" href="#102">102</a> |
| <a name="103" href="#103">103</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="104" href="#104">104</a> <em class="jxr_javadoccomment"> * Returns <tt>true</tt> if and only if all clients are closed when this</em> |
| <a name="105" href="#105">105</a> <em class="jxr_javadoccomment"> * acceptor unbinds from all the related local address (i.e. when the</em> |
| <a name="106" href="#106">106</a> <em class="jxr_javadoccomment"> * service is deactivated).</em> |
| <a name="107" href="#107">107</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="108" href="#108">108</a> <strong class="jxr_keyword">boolean</strong> isCloseOnDeactivation(); |
| <a name="109" href="#109">109</a> |
| <a name="110" href="#110">110</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="111" href="#111">111</a> <em class="jxr_javadoccomment"> * Sets whether all client sessions are closed when this acceptor unbinds</em> |
| <a name="112" href="#112">112</a> <em class="jxr_javadoccomment"> * from all the related local addresses (i.e. when the service is</em> |
| <a name="113" href="#113">113</a> <em class="jxr_javadoccomment"> * deactivated). The default value is <tt>true</tt>.</em> |
| <a name="114" href="#114">114</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="115" href="#115">115</a> <strong class="jxr_keyword">void</strong> setCloseOnDeactivation(<strong class="jxr_keyword">boolean</strong> closeOnDeactivation); |
| <a name="116" href="#116">116</a> |
| <a name="117" href="#117">117</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="118" href="#118">118</a> <em class="jxr_javadoccomment"> * Binds to the default local address(es) and start to accept incoming</em> |
| <a name="119" href="#119">119</a> <em class="jxr_javadoccomment"> * connections.</em> |
| <a name="120" href="#120">120</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="121" href="#121">121</a> <em class="jxr_javadoccomment"> * @throws IOException if failed to bind</em> |
| <a name="122" href="#122">122</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="123" href="#123">123</a> <strong class="jxr_keyword">void</strong> bind() <strong class="jxr_keyword">throws</strong> IOException; |
| <a name="124" href="#124">124</a> |
| <a name="125" href="#125">125</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="126" href="#126">126</a> <em class="jxr_javadoccomment"> * Binds to the specified local address and start to accept incoming</em> |
| <a name="127" href="#127">127</a> <em class="jxr_javadoccomment"> * connections.</em> |
| <a name="128" href="#128">128</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="129" href="#129">129</a> <em class="jxr_javadoccomment"> * @throws IOException if failed to bind</em> |
| <a name="130" href="#130">130</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="131" href="#131">131</a> <strong class="jxr_keyword">void</strong> bind(SocketAddress localAddress) <strong class="jxr_keyword">throws</strong> IOException; |
| <a name="132" href="#132">132</a> |
| <a name="133" href="#133">133</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="134" href="#134">134</a> <em class="jxr_javadoccomment"> * Binds to the specified local addresses and start to accept incoming</em> |
| <a name="135" href="#135">135</a> <em class="jxr_javadoccomment"> * connections.</em> |
| <a name="136" href="#136">136</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="137" href="#137">137</a> <em class="jxr_javadoccomment"> * @throws IOException if failed to bind</em> |
| <a name="138" href="#138">138</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="139" href="#139">139</a> <strong class="jxr_keyword">void</strong> bind(SocketAddress firstLocalAddress, SocketAddress... otherLocalAddresses) <strong class="jxr_keyword">throws</strong> IOException; |
| <a name="140" href="#140">140</a> |
| <a name="141" href="#141">141</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="142" href="#142">142</a> <em class="jxr_javadoccomment"> * Binds to the specified local addresses and start to accept incoming</em> |
| <a name="143" href="#143">143</a> <em class="jxr_javadoccomment"> * connections.</em> |
| <a name="144" href="#144">144</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="145" href="#145">145</a> <em class="jxr_javadoccomment"> * @throws IOException if failed to bind</em> |
| <a name="146" href="#146">146</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="147" href="#147">147</a> <strong class="jxr_keyword">void</strong> bind(Iterable<? <strong class="jxr_keyword">extends</strong> SocketAddress> localAddresses) <strong class="jxr_keyword">throws</strong> IOException; |
| <a name="148" href="#148">148</a> |
| <a name="149" href="#149">149</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="150" href="#150">150</a> <em class="jxr_javadoccomment"> * Unbinds from all local addresses that this service is bound to and stops</em> |
| <a name="151" href="#151">151</a> <em class="jxr_javadoccomment"> * to accept incoming connections. All managed connections will be closed</em> |
| <a name="152" href="#152">152</a> <em class="jxr_javadoccomment"> * if {@link #setCloseOnDeactivation(boolean) disconnectOnUnbind} property</em> |
| <a name="153" href="#153">153</a> <em class="jxr_javadoccomment"> * is <tt>true</tt>. This method returns silently if no local address is</em> |
| <a name="154" href="#154">154</a> <em class="jxr_javadoccomment"> * bound yet.</em> |
| <a name="155" href="#155">155</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="156" href="#156">156</a> <strong class="jxr_keyword">void</strong> unbind(); |
| <a name="157" href="#157">157</a> |
| <a name="158" href="#158">158</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="159" href="#159">159</a> <em class="jxr_javadoccomment"> * Unbinds from the specified local address and stop to accept incoming</em> |
| <a name="160" href="#160">160</a> <em class="jxr_javadoccomment"> * connections. All managed connections will be closed if</em> |
| <a name="161" href="#161">161</a> <em class="jxr_javadoccomment"> * {@link #setCloseOnDeactivation(boolean) disconnectOnUnbind} property is</em> |
| <a name="162" href="#162">162</a> <em class="jxr_javadoccomment"> * <tt>true</tt>. This method returns silently if the default local</em> |
| <a name="163" href="#163">163</a> <em class="jxr_javadoccomment"> * address is not bound yet.</em> |
| <a name="164" href="#164">164</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="165" href="#165">165</a> <strong class="jxr_keyword">void</strong> unbind(SocketAddress localAddress); |
| <a name="166" href="#166">166</a> |
| <a name="167" href="#167">167</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="168" href="#168">168</a> <em class="jxr_javadoccomment"> * Unbinds from the specified local addresses and stop to accept incoming</em> |
| <a name="169" href="#169">169</a> <em class="jxr_javadoccomment"> * connections. All managed connections will be closed if</em> |
| <a name="170" href="#170">170</a> <em class="jxr_javadoccomment"> * {@link #setCloseOnDeactivation(boolean) disconnectOnUnbind} property is</em> |
| <a name="171" href="#171">171</a> <em class="jxr_javadoccomment"> * <tt>true</tt>. This method returns silently if the default local</em> |
| <a name="172" href="#172">172</a> <em class="jxr_javadoccomment"> * addresses are not bound yet.</em> |
| <a name="173" href="#173">173</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="174" href="#174">174</a> <strong class="jxr_keyword">void</strong> unbind(SocketAddress firstLocalAddress, SocketAddress... otherLocalAddresses); |
| <a name="175" href="#175">175</a> |
| <a name="176" href="#176">176</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="177" href="#177">177</a> <em class="jxr_javadoccomment"> * Unbinds from the specified local addresses and stop to accept incoming</em> |
| <a name="178" href="#178">178</a> <em class="jxr_javadoccomment"> * connections. All managed connections will be closed if</em> |
| <a name="179" href="#179">179</a> <em class="jxr_javadoccomment"> * {@link #setCloseOnDeactivation(boolean) disconnectOnUnbind} property is</em> |
| <a name="180" href="#180">180</a> <em class="jxr_javadoccomment"> * <tt>true</tt>. This method returns silently if the default local</em> |
| <a name="181" href="#181">181</a> <em class="jxr_javadoccomment"> * addresses are not bound yet.</em> |
| <a name="182" href="#182">182</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="183" href="#183">183</a> <strong class="jxr_keyword">void</strong> unbind(Iterable<? <strong class="jxr_keyword">extends</strong> SocketAddress> localAddresses); |
| <a name="184" href="#184">184</a> |
| <a name="185" href="#185">185</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="186" href="#186">186</a> <em class="jxr_javadoccomment"> * (Optional) Returns an {@link IoSession} that is bound to the specified</em> |
| <a name="187" href="#187">187</a> <em class="jxr_javadoccomment"> * <tt>localAddress</tt> and the specified <tt>remoteAddress</tt> which</em> |
| <a name="188" href="#188">188</a> <em class="jxr_javadoccomment"> * reuses the local address that is already bound by this service.</em> |
| <a name="189" href="#189">189</a> <em class="jxr_javadoccomment"> * <p></em> |
| <a name="190" href="#190">190</a> <em class="jxr_javadoccomment"> * This operation is optional. Please throw {@link UnsupportedOperationException}</em> |
| <a name="191" href="#191">191</a> <em class="jxr_javadoccomment"> * if the transport type doesn't support this operation. This operation is</em> |
| <a name="192" href="#192">192</a> <em class="jxr_javadoccomment"> * usually implemented for connectionless transport types.</em> |
| <a name="193" href="#193">193</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="194" href="#194">194</a> <em class="jxr_javadoccomment"> * @throws UnsupportedOperationException if this operation is not supported</em> |
| <a name="195" href="#195">195</a> <em class="jxr_javadoccomment"> * @throws IllegalStateException if this service is not running.</em> |
| <a name="196" href="#196">196</a> <em class="jxr_javadoccomment"> * @throws IllegalArgumentException if this service is not bound to the</em> |
| <a name="197" href="#197">197</a> <em class="jxr_javadoccomment"> * specified <tt>localAddress</tt>.</em> |
| <a name="198" href="#198">198</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="199" href="#199">199</a> <a href="../../../../org/apache/mina/common/IoSession.html">IoSession</a> newSession(SocketAddress remoteAddress, SocketAddress localAddress); |
| <a name="200" href="#200">200</a> } |
| </pre> |
| <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> |
| </html> |
| |
