blob: 47ab344abb088c64cf01998c46266c8ca633c19d [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 19:48:11 CET 2019 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Overview (Apache MINA 2.0.0-M4 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="Overview (Apache MINA 2.0.0-M4 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 class="navBarCell1Rev">Overview</li>
<li>Package</li>
<li>Class</li>
<li>Use</li>
<li><a href="overview-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</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="index.html?overview-summary.html" target="_top">Frames</a></li>
<li><a href="overview-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 class="title">Apache MINA 2.0.0-M4 API Documentation</h1>
</div>
<div class="contentContainer">
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Packages table, listing packages, and an explanation">
<caption><span>Packages</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Package</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/mina/core/package-summary.html">org.apache.mina.core</a></td>
<td class="colLast">
<div class="block">Common types required for users to use MINA.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/mina/core/buffer/package-summary.html">org.apache.mina.core.buffer</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/mina/core/file/package-summary.html">org.apache.mina.core.file</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/mina/core/filterchain/package-summary.html">org.apache.mina.core.filterchain</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/mina/core/future/package-summary.html">org.apache.mina.core.future</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/mina/core/polling/package-summary.html">org.apache.mina.core.polling</a></td>
<td class="colLast">
<div class="block">Base class for implementing transport based on active polling strategies like NIO select call, or any API
based on I/O polling system calls (epoll, poll, select, kqueue, etc).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/mina/core/service/package-summary.html">org.apache.mina.core.service</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/mina/core/session/package-summary.html">org.apache.mina.core.session</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/mina/core/write/package-summary.html">org.apache.mina.core.write</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/mina/filter/buffer/package-summary.html">org.apache.mina.filter.buffer</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/mina/filter/codec/package-summary.html">org.apache.mina.filter.codec</a></td>
<td class="colLast">
<div class="block">Filter implementations that helps you to implement complex protocols
via 'codec' concept.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/mina/filter/codec/demux/package-summary.html">org.apache.mina.filter.codec.demux</a></td>
<td class="colLast">
<div class="block">Protocol codecs that helps you to implement even more complex protocols by
splitting a codec into multiple sub-codecs.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/mina/filter/codec/netty/package-summary.html">org.apache.mina.filter.codec.netty</a></td>
<td class="colLast">
<div class="block">Protocol codec which provides the integration with <a href="http://gleamynode.net/dev/tl-netty2/docs/">Netty2</a> messages.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/mina/filter/codec/prefixedstring/package-summary.html">org.apache.mina.filter.codec.prefixedstring</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/mina/filter/codec/serialization/package-summary.html">org.apache.mina.filter.codec.serialization</a></td>
<td class="colLast">
<div class="block">Protocol codecs which uses Java object serilization and leads to rapid protocol
implementation.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/mina/filter/codec/statemachine/package-summary.html">org.apache.mina.filter.codec.statemachine</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/mina/filter/codec/textline/package-summary.html">org.apache.mina.filter.codec.textline</a></td>
<td class="colLast">
<div class="block">A protocol codec for text-based protocols.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/mina/filter/compression/package-summary.html">org.apache.mina.filter.compression</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/mina/filter/errorgenerating/package-summary.html">org.apache.mina.filter.errorgenerating</a></td>
<td class="colLast">
<div class="block">An <tt>IoFilter</tt> that provides flexible error generation facilities.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/mina/filter/executor/package-summary.html">org.apache.mina.filter.executor</a></td>
<td class="colLast">
<div class="block"><tt>IoFilter</tt>s that provide flexible thread model and event queue
monitoring interface.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/mina/filter/firewall/package-summary.html">org.apache.mina.filter.firewall</a></td>
<td class="colLast">
<div class="block">Classes that implement <tt>IoFilter</tt> and provide host blocking and throttling.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/mina/filter/keepalive/package-summary.html">org.apache.mina.filter.keepalive</a></td>
<td class="colLast">
<div class="block"><tt>IoFilter</tt> that provides the ability for connections to remain open when data is not being transferred.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/mina/filter/logging/package-summary.html">org.apache.mina.filter.logging</a></td>
<td class="colLast">
<div class="block">Classes that implement <tt>IoFilter</tt> and provide logging of the events and data that flows through a MINA-based system.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/mina/filter/reqres/package-summary.html">org.apache.mina.filter.reqres</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/mina/filter/ssl/package-summary.html">org.apache.mina.filter.ssl</a></td>
<td class="colLast">
<div class="block">Classes that implement <tt>IoFilter</tt> and provide Secure Sockets Layer functionality.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/mina/filter/statistic/package-summary.html">org.apache.mina.filter.statistic</a></td>
<td class="colLast">
<div class="block">Classes that implement <tt>IoFilter</tt> and provide the ability for filters to be timed on their performance.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/mina/filter/stream/package-summary.html">org.apache.mina.filter.stream</a></td>
<td class="colLast">
<div class="block">Stream based <tt>IoFilter</tt> implementation.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/mina/filter/util/package-summary.html">org.apache.mina.filter.util</a></td>
<td class="colLast">
<div class="block">Utility classes for the MINA filtering portion of the library.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/mina/handler/chain/package-summary.html">org.apache.mina.handler.chain</a></td>
<td class="colLast">
<div class="block">A handler implementation that helps you implement sequentially layered protocols
using Chains of Responsibility pattern.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/mina/handler/demux/package-summary.html">org.apache.mina.handler.demux</a></td>
<td class="colLast">
<div class="block">A handler implementation that helps you implement complex protocols
by splitting <tt>messageReceived</tt> handlers into multiple sub-handlers.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/mina/handler/multiton/package-summary.html">org.apache.mina.handler.multiton</a></td>
<td class="colLast">
<div class="block">Enables creating a handler per session instead of having one handler for many
sessions, using
<a href="http://en.wikipedia.org/wiki/Multiton_pattern">Multiton pattern</a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/mina/handler/stream/package-summary.html">org.apache.mina.handler.stream</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/mina/integration/beans/package-summary.html">org.apache.mina.integration.beans</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/mina/integration/jmx/package-summary.html">org.apache.mina.integration.jmx</a></td>
<td class="colLast">
<div class="block">JMX (Java Management eXtension) integration.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/mina/integration/ognl/package-summary.html">org.apache.mina.integration.ognl</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/mina/integration/xbean/package-summary.html">org.apache.mina.integration.xbean</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/mina/proxy/package-summary.html">org.apache.mina.proxy</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/mina/proxy/event/package-summary.html">org.apache.mina.proxy.event</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/mina/proxy/filter/package-summary.html">org.apache.mina.proxy.filter</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/mina/proxy/handlers/package-summary.html">org.apache.mina.proxy.handlers</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/mina/proxy/handlers/http/package-summary.html">org.apache.mina.proxy.handlers.http</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/mina/proxy/handlers/http/basic/package-summary.html">org.apache.mina.proxy.handlers.http.basic</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/mina/proxy/handlers/http/digest/package-summary.html">org.apache.mina.proxy.handlers.http.digest</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/mina/proxy/handlers/http/ntlm/package-summary.html">org.apache.mina.proxy.handlers.http.ntlm</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/mina/proxy/handlers/socks/package-summary.html">org.apache.mina.proxy.handlers.socks</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/mina/proxy/session/package-summary.html">org.apache.mina.proxy.session</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/mina/proxy/utils/package-summary.html">org.apache.mina.proxy.utils</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/mina/statemachine/package-summary.html">org.apache.mina.statemachine</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/mina/statemachine/annotation/package-summary.html">org.apache.mina.statemachine.annotation</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/mina/statemachine/context/package-summary.html">org.apache.mina.statemachine.context</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/mina/statemachine/event/package-summary.html">org.apache.mina.statemachine.event</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/mina/statemachine/transition/package-summary.html">org.apache.mina.statemachine.transition</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/mina/transport/serial/package-summary.html">org.apache.mina.transport.serial</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/mina/transport/socket/package-summary.html">org.apache.mina.transport.socket</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/mina/transport/socket/apr/package-summary.html">org.apache.mina.transport.socket.apr</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/mina/transport/socket/nio/package-summary.html">org.apache.mina.transport.socket.nio</a></td>
<td class="colLast">
<div class="block">Socket (TCP/IP) and Datagram (UDP/IP) support based on Java
<a href="http://java.sun.com/j2se/1.5.0/docs/guide/nio/">NIO (New I/O) API</a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/mina/transport/vmpipe/package-summary.html">org.apache.mina.transport.vmpipe</a></td>
<td class="colLast">
<div class="block">In-VM pipe support which removes the overhead of local loopback communication.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/mina/util/package-summary.html">org.apache.mina.util</a></td>
<td class="colLast">
<div class="block">Miscellaneous utility classes</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/mina/util/byteaccess/package-summary.html">org.apache.mina.util.byteaccess</a></td>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</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 class="navBarCell1Rev">Overview</li>
<li>Package</li>
<li>Class</li>
<li>Use</li>
<li><a href="overview-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</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="index.html?overview-summary.html" target="_top">Frames</a></li>
<li><a href="overview-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 ======= -->
<p class="legalCopy"><small>Copyright &#169; 2004-2019 <a href="http://mina.apache.org/">Apache MINA Project</a>. All Rights Reserved.</small></p>
</body>
</html>