blob: b59dc4194d5d656528770b80dbe0782c354bc4c9 [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;<a name="line.20"></a>
<span class="sourceLineNo">021</span><a name="line.21"></a>
<span class="sourceLineNo">022</span>import org.apache.mina.core.session.AbstractIoSessionConfig;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.apache.mina.core.session.IoSessionConfig;<a name="line.23"></a>
<span class="sourceLineNo">024</span><a name="line.24"></a>
<span class="sourceLineNo">025</span>/**<a name="line.25"></a>
<span class="sourceLineNo">026</span> * TODO Add documentation<a name="line.26"></a>
<span class="sourceLineNo">027</span> * <a name="line.27"></a>
<span class="sourceLineNo">028</span> * @author &lt;a href="http://mina.apache.org"&gt;Apache MINA Project&lt;/a&gt;<a name="line.28"></a>
<span class="sourceLineNo">029</span> */<a name="line.29"></a>
<span class="sourceLineNo">030</span>public abstract class AbstractDatagramSessionConfig extends AbstractIoSessionConfig implements DatagramSessionConfig {<a name="line.30"></a>
<span class="sourceLineNo">031</span><a name="line.31"></a>
<span class="sourceLineNo">032</span> private static final boolean DEFAULT_CLOSE_ON_PORT_UNREACHABLE = true;<a name="line.32"></a>
<span class="sourceLineNo">033</span><a name="line.33"></a>
<span class="sourceLineNo">034</span> private boolean closeOnPortUnreachable = DEFAULT_CLOSE_ON_PORT_UNREACHABLE;<a name="line.34"></a>
<span class="sourceLineNo">035</span><a name="line.35"></a>
<span class="sourceLineNo">036</span> protected AbstractDatagramSessionConfig() {<a name="line.36"></a>
<span class="sourceLineNo">037</span> // Do nothing<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> @Override<a name="line.40"></a>
<span class="sourceLineNo">041</span> protected void doSetAll(IoSessionConfig config) {<a name="line.41"></a>
<span class="sourceLineNo">042</span> if (!(config instanceof DatagramSessionConfig)) {<a name="line.42"></a>
<span class="sourceLineNo">043</span> return;<a name="line.43"></a>
<span class="sourceLineNo">044</span> }<a name="line.44"></a>
<span class="sourceLineNo">045</span><a name="line.45"></a>
<span class="sourceLineNo">046</span> if (config instanceof AbstractDatagramSessionConfig) {<a name="line.46"></a>
<span class="sourceLineNo">047</span> // Minimize unnecessary system calls by checking all 'propertyChanged' properties.<a name="line.47"></a>
<span class="sourceLineNo">048</span> AbstractDatagramSessionConfig cfg = (AbstractDatagramSessionConfig) config;<a name="line.48"></a>
<span class="sourceLineNo">049</span> if (cfg.isBroadcastChanged()) {<a name="line.49"></a>
<span class="sourceLineNo">050</span> setBroadcast(cfg.isBroadcast());<a name="line.50"></a>
<span class="sourceLineNo">051</span> }<a name="line.51"></a>
<span class="sourceLineNo">052</span> if (cfg.isReceiveBufferSizeChanged()) {<a name="line.52"></a>
<span class="sourceLineNo">053</span> setReceiveBufferSize(cfg.getReceiveBufferSize());<a name="line.53"></a>
<span class="sourceLineNo">054</span> }<a name="line.54"></a>
<span class="sourceLineNo">055</span> if (cfg.isReuseAddressChanged()) {<a name="line.55"></a>
<span class="sourceLineNo">056</span> setReuseAddress(cfg.isReuseAddress());<a name="line.56"></a>
<span class="sourceLineNo">057</span> }<a name="line.57"></a>
<span class="sourceLineNo">058</span> if (cfg.isSendBufferSizeChanged()) {<a name="line.58"></a>
<span class="sourceLineNo">059</span> setSendBufferSize(cfg.getSendBufferSize());<a name="line.59"></a>
<span class="sourceLineNo">060</span> }<a name="line.60"></a>
<span class="sourceLineNo">061</span> if (cfg.isTrafficClassChanged() &amp;&amp; getTrafficClass() != cfg.getTrafficClass()) {<a name="line.61"></a>
<span class="sourceLineNo">062</span> setTrafficClass(cfg.getTrafficClass());<a name="line.62"></a>
<span class="sourceLineNo">063</span> }<a name="line.63"></a>
<span class="sourceLineNo">064</span> } else {<a name="line.64"></a>
<span class="sourceLineNo">065</span> DatagramSessionConfig cfg = (DatagramSessionConfig) config;<a name="line.65"></a>
<span class="sourceLineNo">066</span> setBroadcast(cfg.isBroadcast());<a name="line.66"></a>
<span class="sourceLineNo">067</span> setReceiveBufferSize(cfg.getReceiveBufferSize());<a name="line.67"></a>
<span class="sourceLineNo">068</span> setReuseAddress(cfg.isReuseAddress());<a name="line.68"></a>
<span class="sourceLineNo">069</span> setSendBufferSize(cfg.getSendBufferSize());<a name="line.69"></a>
<span class="sourceLineNo">070</span> if (getTrafficClass() != cfg.getTrafficClass()) {<a name="line.70"></a>
<span class="sourceLineNo">071</span> setTrafficClass(cfg.getTrafficClass());<a name="line.71"></a>
<span class="sourceLineNo">072</span> }<a name="line.72"></a>
<span class="sourceLineNo">073</span> }<a name="line.73"></a>
<span class="sourceLineNo">074</span> }<a name="line.74"></a>
<span class="sourceLineNo">075</span><a name="line.75"></a>
<span class="sourceLineNo">076</span> /**<a name="line.76"></a>
<span class="sourceLineNo">077</span> * Returns &lt;tt&gt;true&lt;/tt&gt; if and only if the &lt;tt&gt;broadcast&lt;/tt&gt; property<a name="line.77"></a>
<span class="sourceLineNo">078</span> * has been changed by its setter method. The system call related with<a name="line.78"></a>
<span class="sourceLineNo">079</span> * the property is made only when this method returns &lt;tt&gt;true&lt;/tt&gt;. By<a name="line.79"></a>
<span class="sourceLineNo">080</span> * default, this method always returns &lt;tt&gt;true&lt;/tt&gt; to simplify implementation<a name="line.80"></a>
<span class="sourceLineNo">081</span> * of subclasses, but overriding the default behavior is always encouraged.<a name="line.81"></a>
<span class="sourceLineNo">082</span> */<a name="line.82"></a>
<span class="sourceLineNo">083</span> protected boolean isBroadcastChanged() {<a name="line.83"></a>
<span class="sourceLineNo">084</span> return true;<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> * Returns &lt;tt&gt;true&lt;/tt&gt; if and only if the &lt;tt&gt;receiveBufferSize&lt;/tt&gt; property<a name="line.88"></a>
<span class="sourceLineNo">089</span> * has been changed by its setter method. The system call related with<a name="line.89"></a>
<span class="sourceLineNo">090</span> * the property is made only when this method returns &lt;tt&gt;true&lt;/tt&gt;. By<a name="line.90"></a>
<span class="sourceLineNo">091</span> * default, this method always returns &lt;tt&gt;true&lt;/tt&gt; to simplify implementation<a name="line.91"></a>
<span class="sourceLineNo">092</span> * of subclasses, but overriding the default behavior is always encouraged.<a name="line.92"></a>
<span class="sourceLineNo">093</span> */<a name="line.93"></a>
<span class="sourceLineNo">094</span> protected boolean isReceiveBufferSizeChanged() {<a name="line.94"></a>
<span class="sourceLineNo">095</span> return true;<a name="line.95"></a>
<span class="sourceLineNo">096</span> }<a name="line.96"></a>
<span class="sourceLineNo">097</span><a name="line.97"></a>
<span class="sourceLineNo">098</span> /**<a name="line.98"></a>
<span class="sourceLineNo">099</span> * Returns &lt;tt&gt;true&lt;/tt&gt; if and only if the &lt;tt&gt;reuseAddress&lt;/tt&gt; property<a name="line.99"></a>
<span class="sourceLineNo">100</span> * has been changed by its setter method. The system call related with<a name="line.100"></a>
<span class="sourceLineNo">101</span> * the property is made only when this method returns &lt;tt&gt;true&lt;/tt&gt;. By<a name="line.101"></a>
<span class="sourceLineNo">102</span> * default, this method always returns &lt;tt&gt;true&lt;/tt&gt; to simplify implementation<a name="line.102"></a>
<span class="sourceLineNo">103</span> * of subclasses, but overriding the default behavior is always encouraged.<a name="line.103"></a>
<span class="sourceLineNo">104</span> */<a name="line.104"></a>
<span class="sourceLineNo">105</span> protected boolean isReuseAddressChanged() {<a name="line.105"></a>
<span class="sourceLineNo">106</span> return true;<a name="line.106"></a>
<span class="sourceLineNo">107</span> }<a name="line.107"></a>
<span class="sourceLineNo">108</span><a name="line.108"></a>
<span class="sourceLineNo">109</span> /**<a name="line.109"></a>
<span class="sourceLineNo">110</span> * Returns &lt;tt&gt;true&lt;/tt&gt; if and only if the &lt;tt&gt;sendBufferSize&lt;/tt&gt; property<a name="line.110"></a>
<span class="sourceLineNo">111</span> * has been changed by its setter method. The system call related with<a name="line.111"></a>
<span class="sourceLineNo">112</span> * the property is made only when this method returns &lt;tt&gt;true&lt;/tt&gt;. By<a name="line.112"></a>
<span class="sourceLineNo">113</span> * default, this method always returns &lt;tt&gt;true&lt;/tt&gt; to simplify implementation<a name="line.113"></a>
<span class="sourceLineNo">114</span> * of subclasses, but overriding the default behavior is always encouraged.<a name="line.114"></a>
<span class="sourceLineNo">115</span> */<a name="line.115"></a>
<span class="sourceLineNo">116</span> protected boolean isSendBufferSizeChanged() {<a name="line.116"></a>
<span class="sourceLineNo">117</span> return true;<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> /**<a name="line.120"></a>
<span class="sourceLineNo">121</span> * Returns &lt;tt&gt;true&lt;/tt&gt; if and only if the &lt;tt&gt;trafficClass&lt;/tt&gt; property<a name="line.121"></a>
<span class="sourceLineNo">122</span> * has been changed by its setter method. The system call related with<a name="line.122"></a>
<span class="sourceLineNo">123</span> * the property is made only when this method returns &lt;tt&gt;true&lt;/tt&gt;. By<a name="line.123"></a>
<span class="sourceLineNo">124</span> * default, this method always returns &lt;tt&gt;true&lt;/tt&gt; to simplify implementation<a name="line.124"></a>
<span class="sourceLineNo">125</span> * of subclasses, but overriding the default behavior is always encouraged.<a name="line.125"></a>
<span class="sourceLineNo">126</span> */<a name="line.126"></a>
<span class="sourceLineNo">127</span> protected boolean isTrafficClassChanged() {<a name="line.127"></a>
<span class="sourceLineNo">128</span> return true;<a name="line.128"></a>
<span class="sourceLineNo">129</span> }<a name="line.129"></a>
<span class="sourceLineNo">130</span><a name="line.130"></a>
<span class="sourceLineNo">131</span> /**<a name="line.131"></a>
<span class="sourceLineNo">132</span> * {@inheritDoc}<a name="line.132"></a>
<span class="sourceLineNo">133</span> */<a name="line.133"></a>
<span class="sourceLineNo">134</span> public boolean isCloseOnPortUnreachable() {<a name="line.134"></a>
<span class="sourceLineNo">135</span> return closeOnPortUnreachable;<a name="line.135"></a>
<span class="sourceLineNo">136</span> }<a name="line.136"></a>
<span class="sourceLineNo">137</span><a name="line.137"></a>
<span class="sourceLineNo">138</span> /**<a name="line.138"></a>
<span class="sourceLineNo">139</span> * {@inheritDoc}<a name="line.139"></a>
<span class="sourceLineNo">140</span> */<a name="line.140"></a>
<span class="sourceLineNo">141</span> public void setCloseOnPortUnreachable(boolean closeOnPortUnreachable) {<a name="line.141"></a>
<span class="sourceLineNo">142</span> this.closeOnPortUnreachable = closeOnPortUnreachable;<a name="line.142"></a>
<span class="sourceLineNo">143</span> }<a name="line.143"></a>
<span class="sourceLineNo">144</span>}<a name="line.144"></a>
</pre>
</div>
</body>
</html>