Google Git
Sign in
apache / mina-site / refs/heads/mina-gen-docs / . / 0.9.1 / apidocs / org / apache / mina / protocol / handler / DemuxingProtocolHandler.html
blob: 0c84cdcbad9c7b18a718c4ab08f792da41f0bab2 [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 03:33:24 CET 2019 -->
<title>DemuxingProtocolHandler (Apache MINA 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="DemuxingProtocolHandler (Apache MINA API Documentation)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/DemuxingProtocolHandler.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/protocol/handler/MessageHandler.html" title="interface in org.apache.mina.protocol.handler"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/mina/protocol/handler/DemuxingProtocolHandler.html" target="_top">Frames</a></li>
<li><a href="DemuxingProtocolHandler.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><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&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.protocol.handler</div>
<h2 title="Class DemuxingProtocolHandler" class="title">Class DemuxingProtocolHandler</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/mina/protocol/ProtocolHandlerAdapter.html" title="class in org.apache.mina.protocol">org.apache.mina.protocol.ProtocolHandlerAdapter</a></li>
<li>
<ul class="inheritance">
<li>org.apache.mina.protocol.handler.DemuxingProtocolHandler</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../org/apache/mina/protocol/ProtocolHandler.html" title="interface in org.apache.mina.protocol">ProtocolHandler</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">DemuxingProtocolHandler</span>
extends <a href="../../../../../org/apache/mina/protocol/ProtocolHandlerAdapter.html" title="class in org.apache.mina.protocol">ProtocolHandlerAdapter</a></pre>
<div class="block">A <a href="../../../../../org/apache/mina/protocol/ProtocolHandler.html" title="interface in org.apache.mina.protocol"><code>ProtocolHandler</code></a> that demuxes <code>messageReceived</code> events
to the appropriate <a href="../../../../../org/apache/mina/protocol/handler/MessageHandler.html" title="interface in org.apache.mina.protocol.handler"><code>MessageHandler</code></a>.
You can freely register and deregister <a href="../../../../../org/apache/mina/protocol/handler/MessageHandler.html" title="interface in org.apache.mina.protocol.handler"><code>MessageHandler</code></a>s using
<a href="../../../../../org/apache/mina/protocol/handler/DemuxingProtocolHandler.html#addMessageHandler-java.lang.Class-org.apache.mina.protocol.handler.MessageHandler-"><code>addMessageHandler(Class, MessageHandler)</code></a> and
<a href="../../../../../org/apache/mina/protocol/handler/DemuxingProtocolHandler.html#removeMessageHandler-java.lang.Class-"><code>removeMessageHandler(Class)</code></a>.</div>
<dl>
<dt><span class="simpleTagLabel">Version:</span></dt>
<dd>$Rev: 330401 $, $Date: 2005-11-03 02:09:13 +0100 (Thu, 03 Nov 2005) $</dd>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>The Apache Directory Project</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier</th>
<th class="colLast" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/protocol/handler/DemuxingProtocolHandler.html#DemuxingProtocolHandler--">DemuxingProtocolHandler</a></span>()</code>
<div class="block">Creates a new instance with no registered <a href="../../../../../org/apache/mina/protocol/handler/MessageHandler.html" title="interface in org.apache.mina.protocol.handler"><code>MessageHandler</code></a>s.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== 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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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/protocol/handler/MessageHandler.html" title="interface in org.apache.mina.protocol.handler">MessageHandler</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/protocol/handler/DemuxingProtocolHandler.html#addMessageHandler-java.lang.Class-org.apache.mina.protocol.handler.MessageHandler-">addMessageHandler</a></span>(java.lang.Class&nbsp;type,
<a href="../../../../../org/apache/mina/protocol/handler/MessageHandler.html" title="interface in org.apache.mina.protocol.handler">MessageHandler</a>&nbsp;handler)</code>
<div class="block">Registers a <a href="../../../../../org/apache/mina/protocol/handler/MessageHandler.html" title="interface in org.apache.mina.protocol.handler"><code>MessageHandler</code></a> that receives the messages of
the specified <code>type</code>.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/mina/protocol/handler/MessageHandler.html" title="interface in org.apache.mina.protocol.handler">MessageHandler</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/protocol/handler/DemuxingProtocolHandler.html#getMessageHandler-java.lang.Class-">getMessageHandler</a></span>(java.lang.Class&nbsp;type)</code>
<div class="block">Returns the <a href="../../../../../org/apache/mina/protocol/handler/MessageHandler.html" title="interface in org.apache.mina.protocol.handler"><code>MessageHandler</code></a> which is registered to process
the specified <code>type</code>.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.util.Map</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/protocol/handler/DemuxingProtocolHandler.html#getMessageHandlerMap--">getMessageHandlerMap</a></span>()</code>
<div class="block">Returns the <code>Map</code> which contains all messageType-<a href="../../../../../org/apache/mina/protocol/handler/MessageHandler.html" title="interface in org.apache.mina.protocol.handler"><code>MessageHandler</code></a>
pairs registered to this handler.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/protocol/handler/DemuxingProtocolHandler.html#messageReceived-org.apache.mina.protocol.ProtocolSession-java.lang.Object-">messageReceived</a></span>(<a href="../../../../../org/apache/mina/protocol/ProtocolSession.html" title="interface in org.apache.mina.protocol">ProtocolSession</a>&nbsp;session,
java.lang.Object&nbsp;message)</code>
<div class="block">Forwards the received events into the appropriate <a href="../../../../../org/apache/mina/protocol/handler/MessageHandler.html" title="interface in org.apache.mina.protocol.handler"><code>MessageHandler</code></a>
which is registered by <a href="../../../../../org/apache/mina/protocol/handler/DemuxingProtocolHandler.html#addMessageHandler-java.lang.Class-org.apache.mina.protocol.handler.MessageHandler-"><code>addMessageHandler(Class, MessageHandler)</code></a>.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/mina/protocol/handler/MessageHandler.html" title="interface in org.apache.mina.protocol.handler">MessageHandler</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/protocol/handler/DemuxingProtocolHandler.html#removeMessageHandler-java.lang.Class-">removeMessageHandler</a></span>(java.lang.Class&nbsp;type)</code>
<div class="block">Deregisters a <a href="../../../../../org/apache/mina/protocol/handler/MessageHandler.html" title="interface in org.apache.mina.protocol.handler"><code>MessageHandler</code></a> that receives the messages of
the specified <code>type</code>.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.mina.protocol.ProtocolHandlerAdapter">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.mina.protocol.<a href="../../../../../org/apache/mina/protocol/ProtocolHandlerAdapter.html" title="class in org.apache.mina.protocol">ProtocolHandlerAdapter</a></h3>
<code><a href="../../../../../org/apache/mina/protocol/ProtocolHandlerAdapter.html#exceptionCaught-org.apache.mina.protocol.ProtocolSession-java.lang.Throwable-">exceptionCaught</a>, <a href="../../../../../org/apache/mina/protocol/ProtocolHandlerAdapter.html#messageSent-org.apache.mina.protocol.ProtocolSession-java.lang.Object-">messageSent</a>, <a href="../../../../../org/apache/mina/protocol/ProtocolHandlerAdapter.html#sessionClosed-org.apache.mina.protocol.ProtocolSession-">sessionClosed</a>, <a href="../../../../../org/apache/mina/protocol/ProtocolHandlerAdapter.html#sessionCreated-org.apache.mina.protocol.ProtocolSession-">sessionCreated</a>, <a href="../../../../../org/apache/mina/protocol/ProtocolHandlerAdapter.html#sessionIdle-org.apache.mina.protocol.ProtocolSession-org.apache.mina.common.IdleStatus-">sessionIdle</a>, <a href="../../../../../org/apache/mina/protocol/ProtocolHandlerAdapter.html#sessionOpened-org.apache.mina.protocol.ProtocolSession-">sessionOpened</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="DemuxingProtocolHandler--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DemuxingProtocolHandler</h4>
<pre>protected&nbsp;DemuxingProtocolHandler()</pre>
<div class="block">Creates a new instance with no registered <a href="../../../../../org/apache/mina/protocol/handler/MessageHandler.html" title="interface in org.apache.mina.protocol.handler"><code>MessageHandler</code></a>s.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="addMessageHandler-java.lang.Class-org.apache.mina.protocol.handler.MessageHandler-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addMessageHandler</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/mina/protocol/handler/MessageHandler.html" title="interface in org.apache.mina.protocol.handler">MessageHandler</a>&nbsp;addMessageHandler(java.lang.Class&nbsp;type,
<a href="../../../../../org/apache/mina/protocol/handler/MessageHandler.html" title="interface in org.apache.mina.protocol.handler">MessageHandler</a>&nbsp;handler)</pre>
<div class="block">Registers a <a href="../../../../../org/apache/mina/protocol/handler/MessageHandler.html" title="interface in org.apache.mina.protocol.handler"><code>MessageHandler</code></a> that receives the messages of
the specified <code>type</code>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the old handler if there is already a registered handler for
the specified <tt>type</tt>. <tt>null</tt> otherwise.</dd>
</dl>
</li>
</ul>
<a name="removeMessageHandler-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeMessageHandler</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/mina/protocol/handler/MessageHandler.html" title="interface in org.apache.mina.protocol.handler">MessageHandler</a>&nbsp;removeMessageHandler(java.lang.Class&nbsp;type)</pre>
<div class="block">Deregisters a <a href="../../../../../org/apache/mina/protocol/handler/MessageHandler.html" title="interface in org.apache.mina.protocol.handler"><code>MessageHandler</code></a> that receives the messages of
the specified <code>type</code>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the removed handler if successfully removed. <tt>null</tt> otherwise.</dd>
</dl>
</li>
</ul>
<a name="getMessageHandler-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMessageHandler</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/mina/protocol/handler/MessageHandler.html" title="interface in org.apache.mina.protocol.handler">MessageHandler</a>&nbsp;getMessageHandler(java.lang.Class&nbsp;type)</pre>
<div class="block">Returns the <a href="../../../../../org/apache/mina/protocol/handler/MessageHandler.html" title="interface in org.apache.mina.protocol.handler"><code>MessageHandler</code></a> which is registered to process
the specified <code>type</code>.</div>
</li>
</ul>
<a name="getMessageHandlerMap--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMessageHandlerMap</h4>
<pre>public&nbsp;java.util.Map&nbsp;getMessageHandlerMap()</pre>
<div class="block">Returns the <code>Map</code> which contains all messageType-<a href="../../../../../org/apache/mina/protocol/handler/MessageHandler.html" title="interface in org.apache.mina.protocol.handler"><code>MessageHandler</code></a>
pairs registered to this handler.</div>
</li>
</ul>
<a name="messageReceived-org.apache.mina.protocol.ProtocolSession-java.lang.Object-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>messageReceived</h4>
<pre>public&nbsp;void&nbsp;messageReceived(<a href="../../../../../org/apache/mina/protocol/ProtocolSession.html" title="interface in org.apache.mina.protocol">ProtocolSession</a>&nbsp;session,
java.lang.Object&nbsp;message)
throws java.lang.Exception</pre>
<div class="block">Forwards the received events into the appropriate <a href="../../../../../org/apache/mina/protocol/handler/MessageHandler.html" title="interface in org.apache.mina.protocol.handler"><code>MessageHandler</code></a>
which is registered by <a href="../../../../../org/apache/mina/protocol/handler/DemuxingProtocolHandler.html#addMessageHandler-java.lang.Class-org.apache.mina.protocol.handler.MessageHandler-"><code>addMessageHandler(Class, MessageHandler)</code></a>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/mina/protocol/ProtocolHandler.html#messageReceived-org.apache.mina.protocol.ProtocolSession-java.lang.Object-">messageReceived</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/mina/protocol/ProtocolHandler.html" title="interface in org.apache.mina.protocol">ProtocolHandler</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/mina/protocol/ProtocolHandlerAdapter.html#messageReceived-org.apache.mina.protocol.ProtocolSession-java.lang.Object-">messageReceived</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/mina/protocol/ProtocolHandlerAdapter.html" title="class in org.apache.mina.protocol">ProtocolHandlerAdapter</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code></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/DemuxingProtocolHandler.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/protocol/handler/MessageHandler.html" title="interface in org.apache.mina.protocol.handler"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/mina/protocol/handler/DemuxingProtocolHandler.html" target="_top">Frames</a></li>
<li><a href="DemuxingProtocolHandler.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><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>