Google Git
Sign in
apache / mina-site / refs/heads/mina-gen-docs / . / 2.0.16 / apidocs / src-html / org / apache / mina / transport / socket / nio / NioDatagramConnector.html
blob: 81d7da6f5502b9878c5da5f13c36890699dcad36 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a>
<span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a>
<span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a>
<span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a>
<span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a>
<span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a>
<span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a>
<span class="sourceLineNo">009</span> *<a name="line.9"></a>
<span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<span class="sourceLineNo">011</span> *<a name="line.11"></a>
<span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing,<a name="line.12"></a>
<span class="sourceLineNo">013</span> * software distributed under the License is distributed on an<a name="line.13"></a>
<span class="sourceLineNo">014</span> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a>
<span class="sourceLineNo">015</span> * KIND, either express or implied. See the License for the<a name="line.15"></a>
<span class="sourceLineNo">016</span> * specific language governing permissions and limitations<a name="line.16"></a>
<span class="sourceLineNo">017</span> * under the License.<a name="line.17"></a>
<span class="sourceLineNo">018</span> *<a name="line.18"></a>
<span class="sourceLineNo">019</span> */<a name="line.19"></a>
<span class="sourceLineNo">020</span>package org.apache.mina.transport.socket.nio;<a name="line.20"></a>
<span class="sourceLineNo">021</span><a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.io.IOException;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.net.InetSocketAddress;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.net.SocketAddress;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.nio.channels.DatagramChannel;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import java.util.Collections;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import java.util.Iterator;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import java.util.concurrent.Executor;<a name="line.28"></a>
<span class="sourceLineNo">029</span><a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.mina.core.polling.AbstractPollingIoConnector;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.apache.mina.core.service.IoConnector;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.mina.core.service.IoProcessor;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.apache.mina.core.service.SimpleIoProcessorPool;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.apache.mina.core.service.TransportMetadata;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import org.apache.mina.transport.socket.DatagramConnector;<a name="line.35"></a>
<span class="sourceLineNo">036</span>import org.apache.mina.transport.socket.DatagramSessionConfig;<a name="line.36"></a>
<span class="sourceLineNo">037</span>import org.apache.mina.transport.socket.DefaultDatagramSessionConfig;<a name="line.37"></a>
<span class="sourceLineNo">038</span><a name="line.38"></a>
<span class="sourceLineNo">039</span>/**<a name="line.39"></a>
<span class="sourceLineNo">040</span> * {@link IoConnector} for datagram transport (UDP/IP).<a name="line.40"></a>
<span class="sourceLineNo">041</span> *<a name="line.41"></a>
<span class="sourceLineNo">042</span> * @author &lt;a href="http://mina.apache.org"&gt;Apache MINA Project&lt;/a&gt;<a name="line.42"></a>
<span class="sourceLineNo">043</span> */<a name="line.43"></a>
<span class="sourceLineNo">044</span>public final class NioDatagramConnector extends AbstractPollingIoConnector&lt;NioSession, DatagramChannel&gt; implements<a name="line.44"></a>
<span class="sourceLineNo">045</span>DatagramConnector {<a name="line.45"></a>
<span class="sourceLineNo">046</span><a name="line.46"></a>
<span class="sourceLineNo">047</span> /**<a name="line.47"></a>
<span class="sourceLineNo">048</span> * Creates a new instance.<a name="line.48"></a>
<span class="sourceLineNo">049</span> */<a name="line.49"></a>
<span class="sourceLineNo">050</span> public NioDatagramConnector() {<a name="line.50"></a>
<span class="sourceLineNo">051</span> super(new DefaultDatagramSessionConfig(), NioProcessor.class);<a name="line.51"></a>
<span class="sourceLineNo">052</span> }<a name="line.52"></a>
<span class="sourceLineNo">053</span><a name="line.53"></a>
<span class="sourceLineNo">054</span> /**<a name="line.54"></a>
<span class="sourceLineNo">055</span> * Creates a new instance.<a name="line.55"></a>
<span class="sourceLineNo">056</span> * <a name="line.56"></a>
<span class="sourceLineNo">057</span> * @param processorCount The number of IoProcessor instance to create<a name="line.57"></a>
<span class="sourceLineNo">058</span> */<a name="line.58"></a>
<span class="sourceLineNo">059</span> public NioDatagramConnector(int processorCount) {<a name="line.59"></a>
<span class="sourceLineNo">060</span> super(new DefaultDatagramSessionConfig(), NioProcessor.class, processorCount);<a name="line.60"></a>
<span class="sourceLineNo">061</span> }<a name="line.61"></a>
<span class="sourceLineNo">062</span><a name="line.62"></a>
<span class="sourceLineNo">063</span> /**<a name="line.63"></a>
<span class="sourceLineNo">064</span> * Creates a new instance.<a name="line.64"></a>
<span class="sourceLineNo">065</span> * <a name="line.65"></a>
<span class="sourceLineNo">066</span> * @param processor The IoProcessor instance to use<a name="line.66"></a>
<span class="sourceLineNo">067</span> */<a name="line.67"></a>
<span class="sourceLineNo">068</span> public NioDatagramConnector(IoProcessor&lt;NioSession&gt; processor) {<a name="line.68"></a>
<span class="sourceLineNo">069</span> super(new DefaultDatagramSessionConfig(), processor);<a name="line.69"></a>
<span class="sourceLineNo">070</span> }<a name="line.70"></a>
<span class="sourceLineNo">071</span><a name="line.71"></a>
<span class="sourceLineNo">072</span> /**<a name="line.72"></a>
<span class="sourceLineNo">073</span> * Constructor for {@link NioDatagramConnector} with default configuration which will use a built-in<a name="line.73"></a>
<span class="sourceLineNo">074</span> * thread pool executor to manage the given number of processor instances. The processor class must have<a name="line.74"></a>
<span class="sourceLineNo">075</span> * a constructor that accepts ExecutorService or Executor as its single argument, or, failing that, a<a name="line.75"></a>
<span class="sourceLineNo">076</span> * no-arg constructor.<a name="line.76"></a>
<span class="sourceLineNo">077</span> * <a name="line.77"></a>
<span class="sourceLineNo">078</span> * @param processorClass the processor class.<a name="line.78"></a>
<span class="sourceLineNo">079</span> * @param processorCount the number of processors to instantiate.<a name="line.79"></a>
<span class="sourceLineNo">080</span> * @see SimpleIoProcessorPool#SimpleIoProcessorPool(Class, Executor, int, java.nio.channels.spi.SelectorProvider)<a name="line.80"></a>
<span class="sourceLineNo">081</span> * @since 2.0.0-M4<a name="line.81"></a>
<span class="sourceLineNo">082</span> */<a name="line.82"></a>
<span class="sourceLineNo">083</span> public NioDatagramConnector(Class&lt;? extends IoProcessor&lt;NioSession&gt;&gt; processorClass, int processorCount) {<a name="line.83"></a>
<span class="sourceLineNo">084</span> super(new DefaultDatagramSessionConfig(), processorClass, processorCount);<a name="line.84"></a>
<span class="sourceLineNo">085</span> }<a name="line.85"></a>
<span class="sourceLineNo">086</span><a name="line.86"></a>
<span class="sourceLineNo">087</span> /**<a name="line.87"></a>
<span class="sourceLineNo">088</span> * Constructor for {@link NioDatagramConnector} with default configuration with default configuration which will use a built-in<a name="line.88"></a>
<span class="sourceLineNo">089</span> * thread pool executor to manage the default number of processor instances. The processor class must have<a name="line.89"></a>
<span class="sourceLineNo">090</span> * a constructor that accepts ExecutorService or Executor as its single argument, or, failing that, a<a name="line.90"></a>
<span class="sourceLineNo">091</span> * no-arg constructor. The default number of instances is equal to the number of processor cores<a name="line.91"></a>
<span class="sourceLineNo">092</span> * in the system, plus one.<a name="line.92"></a>
<span class="sourceLineNo">093</span> * <a name="line.93"></a>
<span class="sourceLineNo">094</span> * @param processorClass the processor class.<a name="line.94"></a>
<span class="sourceLineNo">095</span> * @see SimpleIoProcessorPool#SimpleIoProcessorPool(Class, Executor, int, java.nio.channels.spi.SelectorProvider)<a name="line.95"></a>
<span class="sourceLineNo">096</span> * @see org.apache.mina.core.service.SimpleIoProcessorPool#DEFAULT_SIZE<a name="line.96"></a>
<span class="sourceLineNo">097</span> * @since 2.0.0-M4<a name="line.97"></a>
<span class="sourceLineNo">098</span> */<a name="line.98"></a>
<span class="sourceLineNo">099</span> public NioDatagramConnector(Class&lt;? extends IoProcessor&lt;NioSession&gt;&gt; processorClass) {<a name="line.99"></a>
<span class="sourceLineNo">100</span> super(new DefaultDatagramSessionConfig(), processorClass);<a name="line.100"></a>
<span class="sourceLineNo">101</span> }<a name="line.101"></a>
<span class="sourceLineNo">102</span><a name="line.102"></a>
<span class="sourceLineNo">103</span> public TransportMetadata getTransportMetadata() {<a name="line.103"></a>
<span class="sourceLineNo">104</span> return NioDatagramSession.METADATA;<a name="line.104"></a>
<span class="sourceLineNo">105</span> }<a name="line.105"></a>
<span class="sourceLineNo">106</span><a name="line.106"></a>
<span class="sourceLineNo">107</span> public DatagramSessionConfig getSessionConfig() {<a name="line.107"></a>
<span class="sourceLineNo">108</span> return (DatagramSessionConfig) sessionConfig;<a name="line.108"></a>
<span class="sourceLineNo">109</span> }<a name="line.109"></a>
<span class="sourceLineNo">110</span><a name="line.110"></a>
<span class="sourceLineNo">111</span> @Override<a name="line.111"></a>
<span class="sourceLineNo">112</span> public InetSocketAddress getDefaultRemoteAddress() {<a name="line.112"></a>
<span class="sourceLineNo">113</span> return (InetSocketAddress) super.getDefaultRemoteAddress();<a name="line.113"></a>
<span class="sourceLineNo">114</span> }<a name="line.114"></a>
<span class="sourceLineNo">115</span><a name="line.115"></a>
<span class="sourceLineNo">116</span> public void setDefaultRemoteAddress(InetSocketAddress defaultRemoteAddress) {<a name="line.116"></a>
<span class="sourceLineNo">117</span> super.setDefaultRemoteAddress(defaultRemoteAddress);<a name="line.117"></a>
<span class="sourceLineNo">118</span> }<a name="line.118"></a>
<span class="sourceLineNo">119</span><a name="line.119"></a>
<span class="sourceLineNo">120</span> @Override<a name="line.120"></a>
<span class="sourceLineNo">121</span> protected void init() throws Exception {<a name="line.121"></a>
<span class="sourceLineNo">122</span> // Do nothing<a name="line.122"></a>
<span class="sourceLineNo">123</span> }<a name="line.123"></a>
<span class="sourceLineNo">124</span><a name="line.124"></a>
<span class="sourceLineNo">125</span> @Override<a name="line.125"></a>
<span class="sourceLineNo">126</span> protected DatagramChannel newHandle(SocketAddress localAddress) throws Exception {<a name="line.126"></a>
<span class="sourceLineNo">127</span> DatagramChannel ch = DatagramChannel.open();<a name="line.127"></a>
<span class="sourceLineNo">128</span><a name="line.128"></a>
<span class="sourceLineNo">129</span> try {<a name="line.129"></a>
<span class="sourceLineNo">130</span> if (localAddress != null) {<a name="line.130"></a>
<span class="sourceLineNo">131</span> try {<a name="line.131"></a>
<span class="sourceLineNo">132</span> ch.socket().bind(localAddress);<a name="line.132"></a>
<span class="sourceLineNo">133</span> setDefaultLocalAddress(localAddress);<a name="line.133"></a>
<span class="sourceLineNo">134</span> } catch (IOException ioe) {<a name="line.134"></a>
<span class="sourceLineNo">135</span> // Add some info regarding the address we try to bind to the<a name="line.135"></a>
<span class="sourceLineNo">136</span> // message<a name="line.136"></a>
<span class="sourceLineNo">137</span> String newMessage = "Error while binding on " + localAddress + "\n" + "original message : "<a name="line.137"></a>
<span class="sourceLineNo">138</span> + ioe.getMessage();<a name="line.138"></a>
<span class="sourceLineNo">139</span> Exception e = new IOException(newMessage);<a name="line.139"></a>
<span class="sourceLineNo">140</span> e.initCause(ioe.getCause());<a name="line.140"></a>
<span class="sourceLineNo">141</span><a name="line.141"></a>
<span class="sourceLineNo">142</span> // and close the channel<a name="line.142"></a>
<span class="sourceLineNo">143</span> ch.close();<a name="line.143"></a>
<span class="sourceLineNo">144</span><a name="line.144"></a>
<span class="sourceLineNo">145</span> throw e;<a name="line.145"></a>
<span class="sourceLineNo">146</span> }<a name="line.146"></a>
<span class="sourceLineNo">147</span> }<a name="line.147"></a>
<span class="sourceLineNo">148</span><a name="line.148"></a>
<span class="sourceLineNo">149</span> return ch;<a name="line.149"></a>
<span class="sourceLineNo">150</span> } catch (Exception e) {<a name="line.150"></a>
<span class="sourceLineNo">151</span> // If we got an exception while binding the datagram,<a name="line.151"></a>
<span class="sourceLineNo">152</span> // we have to close it otherwise we will loose an handle<a name="line.152"></a>
<span class="sourceLineNo">153</span> ch.close();<a name="line.153"></a>
<span class="sourceLineNo">154</span> throw e;<a name="line.154"></a>
<span class="sourceLineNo">155</span> }<a name="line.155"></a>
<span class="sourceLineNo">156</span> }<a name="line.156"></a>
<span class="sourceLineNo">157</span><a name="line.157"></a>
<span class="sourceLineNo">158</span> @Override<a name="line.158"></a>
<span class="sourceLineNo">159</span> protected boolean connect(DatagramChannel handle, SocketAddress remoteAddress) throws Exception {<a name="line.159"></a>
<span class="sourceLineNo">160</span> handle.connect(remoteAddress);<a name="line.160"></a>
<span class="sourceLineNo">161</span> return true;<a name="line.161"></a>
<span class="sourceLineNo">162</span> }<a name="line.162"></a>
<span class="sourceLineNo">163</span><a name="line.163"></a>
<span class="sourceLineNo">164</span> @Override<a name="line.164"></a>
<span class="sourceLineNo">165</span> protected NioSession newSession(IoProcessor&lt;NioSession&gt; processor, DatagramChannel handle) {<a name="line.165"></a>
<span class="sourceLineNo">166</span> NioSession session = new NioDatagramSession(this, handle, processor);<a name="line.166"></a>
<span class="sourceLineNo">167</span> session.getConfig().setAll(getSessionConfig());<a name="line.167"></a>
<span class="sourceLineNo">168</span> return session;<a name="line.168"></a>
<span class="sourceLineNo">169</span> }<a name="line.169"></a>
<span class="sourceLineNo">170</span><a name="line.170"></a>
<span class="sourceLineNo">171</span> @Override<a name="line.171"></a>
<span class="sourceLineNo">172</span> protected void close(DatagramChannel handle) throws Exception {<a name="line.172"></a>
<span class="sourceLineNo">173</span> handle.disconnect();<a name="line.173"></a>
<span class="sourceLineNo">174</span> handle.close();<a name="line.174"></a>
<span class="sourceLineNo">175</span> }<a name="line.175"></a>
<span class="sourceLineNo">176</span><a name="line.176"></a>
<span class="sourceLineNo">177</span> // Unused extension points.<a name="line.177"></a>
<span class="sourceLineNo">178</span> @Override<a name="line.178"></a>
<span class="sourceLineNo">179</span> @SuppressWarnings("unchecked")<a name="line.179"></a>
<span class="sourceLineNo">180</span> protected Iterator&lt;DatagramChannel&gt; allHandles() {<a name="line.180"></a>
<span class="sourceLineNo">181</span> return Collections.EMPTY_LIST.iterator();<a name="line.181"></a>
<span class="sourceLineNo">182</span> }<a name="line.182"></a>
<span class="sourceLineNo">183</span><a name="line.183"></a>
<span class="sourceLineNo">184</span> @Override<a name="line.184"></a>
<span class="sourceLineNo">185</span> protected ConnectionRequest getConnectionRequest(DatagramChannel handle) {<a name="line.185"></a>
<span class="sourceLineNo">186</span> throw new UnsupportedOperationException();<a name="line.186"></a>
<span class="sourceLineNo">187</span> }<a name="line.187"></a>
<span class="sourceLineNo">188</span><a name="line.188"></a>
<span class="sourceLineNo">189</span> @Override<a name="line.189"></a>
<span class="sourceLineNo">190</span> protected void destroy() throws Exception {<a name="line.190"></a>
<span class="sourceLineNo">191</span> // Do nothing<a name="line.191"></a>
<span class="sourceLineNo">192</span> }<a name="line.192"></a>
<span class="sourceLineNo">193</span><a name="line.193"></a>
<span class="sourceLineNo">194</span> @Override<a name="line.194"></a>
<span class="sourceLineNo">195</span> protected boolean finishConnect(DatagramChannel handle) throws Exception {<a name="line.195"></a>
<span class="sourceLineNo">196</span> throw new UnsupportedOperationException();<a name="line.196"></a>
<span class="sourceLineNo">197</span> }<a name="line.197"></a>
<span class="sourceLineNo">198</span><a name="line.198"></a>
<span class="sourceLineNo">199</span> @Override<a name="line.199"></a>
<span class="sourceLineNo">200</span> protected void register(DatagramChannel handle, ConnectionRequest request) throws Exception {<a name="line.200"></a>
<span class="sourceLineNo">201</span> throw new UnsupportedOperationException();<a name="line.201"></a>
<span class="sourceLineNo">202</span> }<a name="line.202"></a>
<span class="sourceLineNo">203</span><a name="line.203"></a>
<span class="sourceLineNo">204</span> @Override<a name="line.204"></a>
<span class="sourceLineNo">205</span> protected int select(int timeout) throws Exception {<a name="line.205"></a>
<span class="sourceLineNo">206</span> return 0;<a name="line.206"></a>
<span class="sourceLineNo">207</span> }<a name="line.207"></a>
<span class="sourceLineNo">208</span><a name="line.208"></a>
<span class="sourceLineNo">209</span> @Override<a name="line.209"></a>
<span class="sourceLineNo">210</span> @SuppressWarnings("unchecked")<a name="line.210"></a>
<span class="sourceLineNo">211</span> protected Iterator&lt;DatagramChannel&gt; selectedHandles() {<a name="line.211"></a>
<span class="sourceLineNo">212</span> return Collections.EMPTY_LIST.iterator();<a name="line.212"></a>
<span class="sourceLineNo">213</span> }<a name="line.213"></a>
<span class="sourceLineNo">214</span><a name="line.214"></a>
<span class="sourceLineNo">215</span> @Override<a name="line.215"></a>
<span class="sourceLineNo">216</span> protected void wakeup() {<a name="line.216"></a>
<span class="sourceLineNo">217</span> // Do nothing<a name="line.217"></a>
<span class="sourceLineNo">218</span> }<a name="line.218"></a>
<span class="sourceLineNo">219</span>}<a name="line.219"></a>
</pre>
</div>
</body>
</html>