Google Git
Sign in
apache / mina-site / refs/heads/mina-gen-docs / . / 0.8.4 / apidocs / org / apache / mina / protocol / package-summary.html
blob: 98124dc7fa020cb63c9c7c0c25db779a5f732a07 [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 Fri Mar 15 10:07:11 CET 2019 -->
<title>org.apache.mina.protocol (Apache MINA API Documentation)</title>
<meta name="date" content="2019-03-15">
<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="org.apache.mina.protocol (Apache MINA API Documentation)";
}
}
catch(err) {
}
//-->
</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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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/io/socket/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../org/apache/mina/protocol/codec/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/mina/protocol/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.mina.protocol</h1>
<div class="docSummary">
<div class="block">High-level protocol implementation layer (Protocol layer).</div>
</div>
<p>See:&nbsp;<a href="#package.description">Description</a></p>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/mina/protocol/ProtocolAcceptor.html" title="interface in org.apache.mina.protocol">ProtocolAcceptor</a></td>
<td class="colLast">
<div class="block">Accepts incoming connection, communicates with clients, and fires events to
<a href="../../../../org/apache/mina/protocol/ProtocolHandler.html" title="interface in org.apache.mina.protocol"><code>ProtocolHandler</code></a>s.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/mina/protocol/ProtocolCodecFactory.html" title="interface in org.apache.mina.protocol">ProtocolCodecFactory</a></td>
<td class="colLast">
<div class="block">Provides <a href="../../../../org/apache/mina/protocol/ProtocolEncoder.html" title="interface in org.apache.mina.protocol"><code>ProtocolEncoder</code></a> and <a href="../../../../org/apache/mina/protocol/ProtocolDecoder.html" title="interface in org.apache.mina.protocol"><code>ProtocolDecoder</code></a> which translates
binary or protocol specific data into message object and vice versa.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/mina/protocol/ProtocolConnector.html" title="interface in org.apache.mina.protocol">ProtocolConnector</a></td>
<td class="colLast">
<div class="block">Connects to endpoint, communicates with the server, and fires events to
<a href="../../../../org/apache/mina/protocol/ProtocolProvider.html" title="interface in org.apache.mina.protocol"><code>ProtocolProvider</code></a>s.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/mina/protocol/ProtocolDecoder.html" title="interface in org.apache.mina.protocol">ProtocolDecoder</a></td>
<td class="colLast">
<div class="block">Decodes binary or protocol-specific data into higher-level message objects.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/mina/protocol/ProtocolDecoderOutput.html" title="interface in org.apache.mina.protocol">ProtocolDecoderOutput</a></td>
<td class="colLast">
<div class="block">Callback for <a href="../../../../org/apache/mina/protocol/ProtocolDecoder.html" title="interface in org.apache.mina.protocol"><code>ProtocolDecoder</code></a> to generate decoded messages.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/mina/protocol/ProtocolEncoder.html" title="interface in org.apache.mina.protocol">ProtocolEncoder</a></td>
<td class="colLast">
<div class="block">Encodes higher-level message objects into binary or protocol-specific data.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/mina/protocol/ProtocolEncoderOutput.html" title="interface in org.apache.mina.protocol">ProtocolEncoderOutput</a></td>
<td class="colLast">
<div class="block">Callback for <a href="../../../../org/apache/mina/protocol/ProtocolEncoder.html" title="interface in org.apache.mina.protocol"><code>ProtocolEncoder</code></a> to generate encoded <a href="../../../../org/apache/mina/common/ByteBuffer.html" title="class in org.apache.mina.common"><code>ByteBuffer</code></a>s.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/mina/protocol/ProtocolFilter.html" title="interface in org.apache.mina.protocol">ProtocolFilter</a></td>
<td class="colLast">
<div class="block">A filter which intercepts <a href="../../../../org/apache/mina/protocol/ProtocolHandler.html" title="interface in org.apache.mina.protocol"><code>ProtocolHandler</code></a> events like Servlet
filters.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/mina/protocol/ProtocolFilter.NextFilter.html" title="interface in org.apache.mina.protocol">ProtocolFilter.NextFilter</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/mina/protocol/ProtocolFilterChain.html" title="interface in org.apache.mina.protocol">ProtocolFilterChain</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/mina/protocol/ProtocolHandler.html" title="interface in org.apache.mina.protocol">ProtocolHandler</a></td>
<td class="colLast">
<div class="block">Handles all protocol events fired by MINA.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/mina/protocol/ProtocolProvider.html" title="interface in org.apache.mina.protocol">ProtocolProvider</a></td>
<td class="colLast">
<div class="block">Provides a required information to implement high-level protocols.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/mina/protocol/ProtocolSession.html" title="interface in org.apache.mina.protocol">ProtocolSession</a></td>
<td class="colLast">
<div class="block">A <a href="../../../../org/apache/mina/common/Session.html" title="interface in org.apache.mina.common"><code>Session</code></a> which represents high-level protocol connection between two
endpoints regardless of underlying transport types.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/mina/protocol/ProtocolSessionManager.html" title="interface in org.apache.mina.protocol">ProtocolSessionManager</a></td>
<td class="colLast">
<div class="block">A <a href="../../../../org/apache/mina/common/SessionManager.html" title="interface in org.apache.mina.common"><code>SessionManager</code></a> for Protocol layer.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/mina/protocol/AbstractProtocolFilterChain.html" title="class in org.apache.mina.protocol">AbstractProtocolFilterChain</a></td>
<td class="colLast">
<div class="block">An abstract implementation of <a href="../../../../org/apache/mina/protocol/ProtocolFilterChain.html" title="interface in org.apache.mina.protocol"><code>ProtocolFilterChain</code></a> that provides
common operations for developers to extend protocol layer.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/mina/protocol/ProtocolFilterAdapter.html" title="class in org.apache.mina.protocol">ProtocolFilterAdapter</a></td>
<td class="colLast">
<div class="block">An abstract adapter class for <a href="../../../../org/apache/mina/protocol/ProtocolFilter.html" title="interface in org.apache.mina.protocol"><code>ProtocolFilter</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/mina/protocol/ProtocolHandlerAdapter.html" title="class in org.apache.mina.protocol">ProtocolHandlerAdapter</a></td>
<td class="colLast">
<div class="block">An abstract adapter class for <a href="../../../../org/apache/mina/protocol/ProtocolHandler.html" title="interface in org.apache.mina.protocol"><code>ProtocolHandler</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/mina/protocol/ProtocolSessionFilterChain.html" title="class in org.apache.mina.protocol">ProtocolSessionFilterChain</a></td>
<td class="colLast">
<div class="block">An <a href="../../../../org/apache/mina/io/IoFilterChain.html" title="interface in org.apache.mina.io"><code>IoFilterChain</code></a> that forwards <tt>filterWrite</tt>
requests to the specified <a href="../../../../org/apache/mina/io/IoSessionManagerFilterChain.html" title="class in org.apache.mina.io"><code>IoSessionManagerFilterChain</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/mina/protocol/ProtocolSessionManagerFilterChain.html" title="class in org.apache.mina.protocol">ProtocolSessionManagerFilterChain</a></td>
<td class="colLast">
<div class="block">An <a href="../../../../org/apache/mina/protocol/ProtocolFilterChain.html" title="interface in org.apache.mina.protocol"><code>ProtocolFilterChain</code></a> that forwards all events
except <tt>filterWrite</tt> to the <a href="../../../../org/apache/mina/protocol/ProtocolSessionFilterChain.html" title="class in org.apache.mina.protocol"><code>ProtocolSessionFilterChain</code></a>
of the recipient session.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/mina/protocol/SimpleProtocolDecoderOutput.html" title="class in org.apache.mina.protocol">SimpleProtocolDecoderOutput</a></td>
<td class="colLast">
<div class="block">A <a href="../../../../org/apache/mina/protocol/ProtocolDecoderOutput.html" title="interface in org.apache.mina.protocol"><code>ProtocolDecoderOutput</code></a> based on queue.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/mina/protocol/SimpleProtocolEncoderOutput.html" title="class in org.apache.mina.protocol">SimpleProtocolEncoderOutput</a></td>
<td class="colLast">
<div class="block">A <a href="../../../../org/apache/mina/protocol/ProtocolEncoderOutput.html" title="interface in org.apache.mina.protocol"><code>ProtocolEncoderOutput</code></a> based on queue.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation">
<caption><span>Exception Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Exception</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/mina/protocol/ProtocolViolationException.html" title="class in org.apache.mina.protocol">ProtocolViolationException</a></td>
<td class="colLast">
<div class="block">An exception that is thrown when <a href="../../../../org/apache/mina/protocol/ProtocolEncoder.html" title="interface in org.apache.mina.protocol"><code>ProtocolEncoder</code></a> cannot understand or
failed to validate the specified message, or when <a href="../../../../org/apache/mina/protocol/ProtocolDecoder.html" title="interface in org.apache.mina.protocol"><code>ProtocolDecoder</code></a>
cannot understand or failed to validate the specified <a href="../../../../org/apache/mina/common/ByteBuffer.html" title="class in org.apache.mina.common"><code>ByteBuffer</code></a>
content.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package org.apache.mina.protocol Description">Package org.apache.mina.protocol Description</h2>
<div class="block">High-level protocol implementation layer (Protocol layer).</div>
</div>
<!-- ======= 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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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/io/socket/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../org/apache/mina/protocol/codec/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/mina/protocol/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>