Google Git
Sign in
apache / mina-site / refs/heads/mina-gen-docs / . / 1.1.6 / apidocs / org / apache / mina / common / BroadcastIoSession.html
blob: 8a8ebc1b46eef4db5e0df2500c312d9bf1001400 [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 (1.8.0_191) on Sat Mar 16 10:17:08 CET 2019 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>BroadcastIoSession (Apache MINA 1.1.6 API Documentation)</title>
<meta name="date" content="2019-03-16">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="BroadcastIoSession (Apache MINA 1.1.6 API Documentation)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<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/BroadcastIoSession.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>Prev&nbsp;Class</li>
<li><a href="../../../../org/apache/mina/common/BufferDataException.html" title="class in org.apache.mina.common"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/mina/common/BroadcastIoSession.html" target="_top">Frames</a></li>
<li><a href="BroadcastIoSession.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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.common</div>
<h2 title="Interface BroadcastIoSession" class="title">Interface BroadcastIoSession</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/common/IoSession.html" title="interface in org.apache.mina.common">IoSession</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">BroadcastIoSession</span>
extends <a href="../../../../org/apache/mina/common/IoSession.html" title="interface in org.apache.mina.common">IoSession</a></pre>
<div class="block">An <a href="../../../../org/apache/mina/common/IoSession.html" title="interface in org.apache.mina.common"><code>IoSession</code></a> for broadcast transports. (e.g. UDP broadcast or multicast)
<h2>Writing Back to the Broadcasting Server</h2>
<p>
When you implement a client that receives a broadcast message from a server
such as DHCP server, the client might need to send a response message for the
broadcast message the server sent. Because the remote address of the session
is not the address of the server in case of broadcasting, there should be a
way to specify the destination when you write the response message.
This interface provides <a href="../../../../org/apache/mina/common/BroadcastIoSession.html#write-java.lang.Object-java.net.SocketAddress-"><code>write(Object, SocketAddress)</code></a> method so you
can specify the destination.
</p></div>
<dl>
<dt><span class="simpleTagLabel">Version:</span></dt>
<dd>$Rev: 555855 $, $Date: 2007-07-13 05:19:00 +0200 (Fri, 13 Jul 2007) $</dd>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>The Apache Directory Project (mina-dev@directory.apache.org)</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/mina/common/WriteFuture.html" title="interface in org.apache.mina.common">WriteFuture</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/BroadcastIoSession.html#write-java.lang.Object-java.net.SocketAddress-">write</a></span>(java.lang.Object&nbsp;message,
java.net.SocketAddress&nbsp;destination)</code>
<div class="block">Writes the specified <tt>message</tt> to the specified <tt>destination</tt>.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.mina.common.IoSession">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.mina.common.<a href="../../../../org/apache/mina/common/IoSession.html" title="interface in org.apache.mina.common">IoSession</a></h3>
<code><a href="../../../../org/apache/mina/common/IoSession.html#close--">close</a>, <a href="../../../../org/apache/mina/common/IoSession.html#containsAttribute-java.lang.String-">containsAttribute</a>, <a href="../../../../org/apache/mina/common/IoSession.html#getAttachment--">getAttachment</a>, <a href="../../../../org/apache/mina/common/IoSession.html#getAttribute-java.lang.String-">getAttribute</a>, <a href="../../../../org/apache/mina/common/IoSession.html#getAttributeKeys--">getAttributeKeys</a>, <a href="../../../../org/apache/mina/common/IoSession.html#getCloseFuture--">getCloseFuture</a>, <a href="../../../../org/apache/mina/common/IoSession.html#getConfig--">getConfig</a>, <a href="../../../../org/apache/mina/common/IoSession.html#getCreationTime--">getCreationTime</a>, <a href="../../../../org/apache/mina/common/IoSession.html#getFilterChain--">getFilterChain</a>, <a href="../../../../org/apache/mina/common/IoSession.html#getHandler--">getHandler</a>, <a href="../../../../org/apache/mina/common/IoSession.html#getIdleCount-org.apache.mina.common.IdleStatus-">getIdleCount</a>, <a href="../../../../org/apache/mina/common/IoSession.html#getIdleTime-org.apache.mina.common.IdleStatus-">getIdleTime</a>, <a href="../../../../org/apache/mina/common/IoSession.html#getIdleTimeInMillis-org.apache.mina.common.IdleStatus-">getIdleTimeInMillis</a>, <a href="../../../../org/apache/mina/common/IoSession.html#getLastIdleTime-org.apache.mina.common.IdleStatus-">getLastIdleTime</a>, <a href="../../../../org/apache/mina/common/IoSession.html#getLastIoTime--">getLastIoTime</a>, <a href="../../../../org/apache/mina/common/IoSession.html#getLastReadTime--">getLastReadTime</a>, <a href="../../../../org/apache/mina/common/IoSession.html#getLastWriteTime--">getLastWriteTime</a>, <a href="../../../../org/apache/mina/common/IoSession.html#getLocalAddress--">getLocalAddress</a>, <a href="../../../../org/apache/mina/common/IoSession.html#getReadBytes--">getReadBytes</a>, <a href="../../../../org/apache/mina/common/IoSession.html#getReadMessages--">getReadMessages</a>, <a href="../../../../org/apache/mina/common/IoSession.html#getRemoteAddress--">getRemoteAddress</a>, <a href="../../../../org/apache/mina/common/IoSession.html#getScheduledWriteBytes--">getScheduledWriteBytes</a>, <a href="../../../../org/apache/mina/common/IoSession.html#getScheduledWriteRequests--">getScheduledWriteRequests</a>, <a href="../../../../org/apache/mina/common/IoSession.html#getService--">getService</a>, <a href="../../../../org/apache/mina/common/IoSession.html#getServiceAddress--">getServiceAddress</a>, <a href="../../../../org/apache/mina/common/IoSession.html#getServiceConfig--">getServiceConfig</a>, <a href="../../../../org/apache/mina/common/IoSession.html#getTrafficMask--">getTrafficMask</a>, <a href="../../../../org/apache/mina/common/IoSession.html#getTransportType--">getTransportType</a>, <a href="../../../../org/apache/mina/common/IoSession.html#getWriteTimeout--">getWriteTimeout</a>, <a href="../../../../org/apache/mina/common/IoSession.html#getWriteTimeoutInMillis--">getWriteTimeoutInMillis</a>, <a href="../../../../org/apache/mina/common/IoSession.html#getWrittenBytes--">getWrittenBytes</a>, <a href="../../../../org/apache/mina/common/IoSession.html#getWrittenMessages--">getWrittenMessages</a>, <a href="../../../../org/apache/mina/common/IoSession.html#getWrittenWriteRequests--">getWrittenWriteRequests</a>, <a href="../../../../org/apache/mina/common/IoSession.html#isClosing--">isClosing</a>, <a href="../../../../org/apache/mina/common/IoSession.html#isConnected--">isConnected</a>, <a href="../../../../org/apache/mina/common/IoSession.html#isIdle-org.apache.mina.common.IdleStatus-">isIdle</a>, <a href="../../../../org/apache/mina/common/IoSession.html#removeAttribute-java.lang.String-">removeAttribute</a>, <a href="../../../../org/apache/mina/common/IoSession.html#resumeRead--">resumeRead</a>, <a href="../../../../org/apache/mina/common/IoSession.html#resumeWrite--">resumeWrite</a>, <a href="../../../../org/apache/mina/common/IoSession.html#setAttachment-java.lang.Object-">setAttachment</a>, <a href="../../../../org/apache/mina/common/IoSession.html#setAttribute-java.lang.String-">setAttribute</a>, <a href="../../../../org/apache/mina/common/IoSession.html#setAttribute-java.lang.String-java.lang.Object-">setAttribute</a>, <a href="../../../../org/apache/mina/common/IoSession.html#setIdleTime-org.apache.mina.common.IdleStatus-int-">setIdleTime</a>, <a href="../../../../org/apache/mina/common/IoSession.html#setTrafficMask-org.apache.mina.common.TrafficMask-">setTrafficMask</a>, <a href="../../../../org/apache/mina/common/IoSession.html#setWriteTimeout-int-">setWriteTimeout</a>, <a href="../../../../org/apache/mina/common/IoSession.html#suspendRead--">suspendRead</a>, <a href="../../../../org/apache/mina/common/IoSession.html#suspendWrite--">suspendWrite</a>, <a href="../../../../org/apache/mina/common/IoSession.html#write-java.lang.Object-">write</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="write-java.lang.Object-java.net.SocketAddress-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>write</h4>
<pre><a href="../../../../org/apache/mina/common/WriteFuture.html" title="interface in org.apache.mina.common">WriteFuture</a>&nbsp;write(java.lang.Object&nbsp;message,
java.net.SocketAddress&nbsp;destination)</pre>
<div class="block">Writes the specified <tt>message</tt> to the specified <tt>destination</tt>.
This operation is asynchronous; <a href="../../../../org/apache/mina/common/IoHandler.html#messageSent-org.apache.mina.common.IoSession-java.lang.Object-"><code>IoHandler.messageSent(IoSession, Object)</code></a>
will be invoked when the message is actually sent to remote peer. You can
also wait for the returned <a href="../../../../org/apache/mina/common/WriteFuture.html" title="interface in org.apache.mina.common"><code>WriteFuture</code></a> if you want to wait for
the message actually written.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>destination</code> - <tt>null</tt> if you want the message sent to the
default remote address</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<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/BroadcastIoSession.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>Prev&nbsp;Class</li>
<li><a href="../../../../org/apache/mina/common/BufferDataException.html" title="class in org.apache.mina.common"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/mina/common/BroadcastIoSession.html" target="_top">Frames</a></li>
<li><a href="BroadcastIoSession.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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 © 2004-2019 <a href="http://mina.apache.org/">Apache MINA Project</a>. All Rights Reserved.</small></p>
</body>
</html>