blob: e7c4c921597dca49cc26f8c2fdcdea6f80d739db [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_55) on Mon Sep 15 17:28:20 CEST 2014 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>DatagramSessionConfig (Apache MINA 2.0.8 API)</title>
<meta name="date" content="2014-09-15">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="DatagramSessionConfig (Apache MINA 2.0.8 API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/DatagramSessionConfig.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/mina/transport/socket/DatagramConnector.html" title="interface in org.apache.mina.transport.socket"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/mina/transport/socket/DefaultDatagramSessionConfig.html" title="class in org.apache.mina.transport.socket"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/mina/transport/socket/DatagramSessionConfig.html" target="_top">Frames</a></li>
<li><a href="DatagramSessionConfig.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.mina.transport.socket</div>
<h2 title="Interface DatagramSessionConfig" class="title">Interface DatagramSessionConfig</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../../../org/apache/mina/core/session/IoSessionConfig.html" title="interface in org.apache.mina.core.session">IoSessionConfig</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/apache/mina/transport/socket/AbstractDatagramSessionConfig.html" title="class in org.apache.mina.transport.socket">AbstractDatagramSessionConfig</a>, <a href="../../../../../org/apache/mina/transport/socket/DefaultDatagramSessionConfig.html" title="class in org.apache.mina.transport.socket">DefaultDatagramSessionConfig</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">DatagramSessionConfig</span>
extends <a href="../../../../../org/apache/mina/core/session/IoSessionConfig.html" title="interface in org.apache.mina.core.session">IoSessionConfig</a></pre>
<div class="block">An <a href="../../../../../org/apache/mina/core/session/IoSessionConfig.html" title="interface in org.apache.mina.core.session"><code>IoSessionConfig</code></a> for datagram transport type.</div>
<dl><dt><span class="strong">Author:</span></dt>
<dd><a href="http://mina.apache.org">Apache MINA Project</a></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/mina/transport/socket/DatagramSessionConfig.html#getReceiveBufferSize()">getReceiveBufferSize</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/mina/transport/socket/DatagramSessionConfig.html#getSendBufferSize()">getSendBufferSize</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/mina/transport/socket/DatagramSessionConfig.html#getTrafficClass()">getTrafficClass</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/mina/transport/socket/DatagramSessionConfig.html#isBroadcast()">isBroadcast</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/mina/transport/socket/DatagramSessionConfig.html#isCloseOnPortUnreachable()">isCloseOnPortUnreachable</a></strong>()</code>
<div class="block">If method returns true, it means session should be closed when a
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/net/PortUnreachableException.html?is-external=true" title="class or interface in java.net"><code>PortUnreachableException</code></a> occurs.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/mina/transport/socket/DatagramSessionConfig.html#isReuseAddress()">isReuseAddress</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/mina/transport/socket/DatagramSessionConfig.html#setBroadcast(boolean)">setBroadcast</a></strong>(boolean&nbsp;broadcast)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/mina/transport/socket/DatagramSessionConfig.html#setCloseOnPortUnreachable(boolean)">setCloseOnPortUnreachable</a></strong>(boolean&nbsp;closeOnPortUnreachable)</code>
<div class="block">Sets if the session should be closed if an <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/net/PortUnreachableException.html?is-external=true" title="class or interface in java.net"><code>PortUnreachableException</code></a>
occurs.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/mina/transport/socket/DatagramSessionConfig.html#setReceiveBufferSize(int)">setReceiveBufferSize</a></strong>(int&nbsp;receiveBufferSize)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/mina/transport/socket/DatagramSessionConfig.html#setReuseAddress(boolean)">setReuseAddress</a></strong>(boolean&nbsp;reuseAddress)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/mina/transport/socket/DatagramSessionConfig.html#setSendBufferSize(int)">setSendBufferSize</a></strong>(int&nbsp;sendBufferSize)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/mina/transport/socket/DatagramSessionConfig.html#setTrafficClass(int)">setTrafficClass</a></strong>(int&nbsp;trafficClass)</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.mina.core.session.IoSessionConfig">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.mina.core.session.<a href="../../../../../org/apache/mina/core/session/IoSessionConfig.html" title="interface in org.apache.mina.core.session">IoSessionConfig</a></h3>
<code><a href="../../../../../org/apache/mina/core/session/IoSessionConfig.html#getBothIdleTime()">getBothIdleTime</a>, <a href="../../../../../org/apache/mina/core/session/IoSessionConfig.html#getBothIdleTimeInMillis()">getBothIdleTimeInMillis</a>, <a href="../../../../../org/apache/mina/core/session/IoSessionConfig.html#getIdleTime(org.apache.mina.core.session.IdleStatus)">getIdleTime</a>, <a href="../../../../../org/apache/mina/core/session/IoSessionConfig.html#getIdleTimeInMillis(org.apache.mina.core.session.IdleStatus)">getIdleTimeInMillis</a>, <a href="../../../../../org/apache/mina/core/session/IoSessionConfig.html#getMaxReadBufferSize()">getMaxReadBufferSize</a>, <a href="../../../../../org/apache/mina/core/session/IoSessionConfig.html#getMinReadBufferSize()">getMinReadBufferSize</a>, <a href="../../../../../org/apache/mina/core/session/IoSessionConfig.html#getReadBufferSize()">getReadBufferSize</a>, <a href="../../../../../org/apache/mina/core/session/IoSessionConfig.html#getReaderIdleTime()">getReaderIdleTime</a>, <a href="../../../../../org/apache/mina/core/session/IoSessionConfig.html#getReaderIdleTimeInMillis()">getReaderIdleTimeInMillis</a>, <a href="../../../../../org/apache/mina/core/session/IoSessionConfig.html#getThroughputCalculationInterval()">getThroughputCalculationInterval</a>, <a href="../../../../../org/apache/mina/core/session/IoSessionConfig.html#getThroughputCalculationIntervalInMillis()">getThroughputCalculationIntervalInMillis</a>, <a href="../../../../../org/apache/mina/core/session/IoSessionConfig.html#getWriterIdleTime()">getWriterIdleTime</a>, <a href="../../../../../org/apache/mina/core/session/IoSessionConfig.html#getWriterIdleTimeInMillis()">getWriterIdleTimeInMillis</a>, <a href="../../../../../org/apache/mina/core/session/IoSessionConfig.html#getWriteTimeout()">getWriteTimeout</a>, <a href="../../../../../org/apache/mina/core/session/IoSessionConfig.html#getWriteTimeoutInMillis()">getWriteTimeoutInMillis</a>, <a href="../../../../../org/apache/mina/core/session/IoSessionConfig.html#isUseReadOperation()">isUseReadOperation</a>, <a href="../../../../../org/apache/mina/core/session/IoSessionConfig.html#setAll(org.apache.mina.core.session.IoSessionConfig)">setAll</a>, <a href="../../../../../org/apache/mina/core/session/IoSessionConfig.html#setBothIdleTime(int)">setBothIdleTime</a>, <a href="../../../../../org/apache/mina/core/session/IoSessionConfig.html#setIdleTime(org.apache.mina.core.session.IdleStatus, int)">setIdleTime</a>, <a href="../../../../../org/apache/mina/core/session/IoSessionConfig.html#setMaxReadBufferSize(int)">setMaxReadBufferSize</a>, <a href="../../../../../org/apache/mina/core/session/IoSessionConfig.html#setMinReadBufferSize(int)">setMinReadBufferSize</a>, <a href="../../../../../org/apache/mina/core/session/IoSessionConfig.html#setReadBufferSize(int)">setReadBufferSize</a>, <a href="../../../../../org/apache/mina/core/session/IoSessionConfig.html#setReaderIdleTime(int)">setReaderIdleTime</a>, <a href="../../../../../org/apache/mina/core/session/IoSessionConfig.html#setThroughputCalculationInterval(int)">setThroughputCalculationInterval</a>, <a href="../../../../../org/apache/mina/core/session/IoSessionConfig.html#setUseReadOperation(boolean)">setUseReadOperation</a>, <a href="../../../../../org/apache/mina/core/session/IoSessionConfig.html#setWriterIdleTime(int)">setWriterIdleTime</a>, <a href="../../../../../org/apache/mina/core/session/IoSessionConfig.html#setWriteTimeout(int)">setWriteTimeout</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="isBroadcast()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isBroadcast</h4>
<pre>boolean&nbsp;isBroadcast()</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/net/DatagramSocket.html?is-external=true#getBroadcast()" title="class or interface in java.net"><code>DatagramSocket.getBroadcast()</code></a></dd></dl>
</li>
</ul>
<a name="setBroadcast(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBroadcast</h4>
<pre>void&nbsp;setBroadcast(boolean&nbsp;broadcast)</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/net/DatagramSocket.html?is-external=true#setBroadcast(boolean)" title="class or interface in java.net"><code>DatagramSocket.setBroadcast(boolean)</code></a></dd></dl>
</li>
</ul>
<a name="isReuseAddress()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isReuseAddress</h4>
<pre>boolean&nbsp;isReuseAddress()</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/net/DatagramSocket.html?is-external=true#getReuseAddress()" title="class or interface in java.net"><code>DatagramSocket.getReuseAddress()</code></a></dd></dl>
</li>
</ul>
<a name="setReuseAddress(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setReuseAddress</h4>
<pre>void&nbsp;setReuseAddress(boolean&nbsp;reuseAddress)</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/net/DatagramSocket.html?is-external=true#setReuseAddress(boolean)" title="class or interface in java.net"><code>DatagramSocket.setReuseAddress(boolean)</code></a></dd></dl>
</li>
</ul>
<a name="getReceiveBufferSize()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReceiveBufferSize</h4>
<pre>int&nbsp;getReceiveBufferSize()</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/net/DatagramSocket.html?is-external=true#getReceiveBufferSize()" title="class or interface in java.net"><code>DatagramSocket.getReceiveBufferSize()</code></a></dd></dl>
</li>
</ul>
<a name="setReceiveBufferSize(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setReceiveBufferSize</h4>
<pre>void&nbsp;setReceiveBufferSize(int&nbsp;receiveBufferSize)</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/net/DatagramSocket.html?is-external=true#setReceiveBufferSize(int)" title="class or interface in java.net"><code>DatagramSocket.setReceiveBufferSize(int)</code></a></dd></dl>
</li>
</ul>
<a name="getSendBufferSize()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSendBufferSize</h4>
<pre>int&nbsp;getSendBufferSize()</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/net/DatagramSocket.html?is-external=true#getSendBufferSize()" title="class or interface in java.net"><code>DatagramSocket.getSendBufferSize()</code></a></dd></dl>
</li>
</ul>
<a name="setSendBufferSize(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSendBufferSize</h4>
<pre>void&nbsp;setSendBufferSize(int&nbsp;sendBufferSize)</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/net/DatagramSocket.html?is-external=true#setSendBufferSize(int)" title="class or interface in java.net"><code>DatagramSocket.setSendBufferSize(int)</code></a></dd></dl>
</li>
</ul>
<a name="getTrafficClass()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTrafficClass</h4>
<pre>int&nbsp;getTrafficClass()</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/net/DatagramSocket.html?is-external=true#getTrafficClass()" title="class or interface in java.net"><code>DatagramSocket.getTrafficClass()</code></a></dd></dl>
</li>
</ul>
<a name="setTrafficClass(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTrafficClass</h4>
<pre>void&nbsp;setTrafficClass(int&nbsp;trafficClass)</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/net/DatagramSocket.html?is-external=true#setTrafficClass(int)" title="class or interface in java.net"><code>DatagramSocket.setTrafficClass(int)</code></a></dd></dl>
</li>
</ul>
<a name="isCloseOnPortUnreachable()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isCloseOnPortUnreachable</h4>
<pre>boolean&nbsp;isCloseOnPortUnreachable()</pre>
<div class="block">If method returns true, it means session should be closed when a
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/net/PortUnreachableException.html?is-external=true" title="class or interface in java.net"><code>PortUnreachableException</code></a> occurs.</div>
</li>
</ul>
<a name="setCloseOnPortUnreachable(boolean)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setCloseOnPortUnreachable</h4>
<pre>void&nbsp;setCloseOnPortUnreachable(boolean&nbsp;closeOnPortUnreachable)</pre>
<div class="block">Sets if the session should be closed if an <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/net/PortUnreachableException.html?is-external=true" title="class or interface in java.net"><code>PortUnreachableException</code></a>
occurs.</div>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/DatagramSessionConfig.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/mina/transport/socket/DatagramConnector.html" title="interface in org.apache.mina.transport.socket"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/mina/transport/socket/DefaultDatagramSessionConfig.html" title="class in org.apache.mina.transport.socket"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/mina/transport/socket/DatagramSessionConfig.html" target="_top">Frames</a></li>
<li><a href="DatagramSessionConfig.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2004&#x2013;2014 <a href="http://mina.apache.org/">Apache MINA Project</a>. All rights reserved.</small></p>
</body>
</html>