blob: 60a464cc8bac7f47ef53794299386ccc1e068c0f [file] [log] [blame]
<!DOCTYPE html>
<html lang="en">
<head>
<title>User Guide &mdash; Apache MINA</title>
<link href="/assets/css/common.css" rel="stylesheet" type="text/css"/>
<link href="/assets/css/mina.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<script src="https://www.apachecon.com/event-images/snippet.js"></script>
<div id="container">
<div id="header">
<div id="subProjectsNavBar">
<a href="/">
Apache MINA Project
</a>
&nbsp;|&nbsp;
<a href="/mina-project/">
<strong>MINA</strong>
</a>
&nbsp;|&nbsp;
<a href="/asyncweb-project/">
AsyncWeb
</a>
&nbsp;|&nbsp;
<a href="/ftpserver-project/">
FtpServer
</a>
&nbsp;|&nbsp;
<a href="/sshd-project/">
SSHD
</a>
&nbsp;|&nbsp;
<a href="/vysper-project/">
Vysper
</a>
</div>
</div>
<div id="content">
<div id="leftColumn">
<div id="navigation">
<a class="acevent" data-format="wide" data-width="170"></a>
<h5>Social Networks</h5>
<ul>
<li><a href="https://fosstodon.org/@apachemina">Apache MINA Mastodon</a></li>
</ul>
<h5>Latest Downloads</h5>
<ul>
<li><a href="/mina-project/downloads_2_0.html">Mina 2.0.25</a></li>
<li><a href="/mina-project/downloads_2_1.html">Mina 2.1.8</a></li>
<li><a href="/mina-project/downloads_2_2.html">Mina 2.2.3</a></li>
<li><a href="/mina-project/downloads_old.html">Mina old versions</a></li>
</ul>
<h5>Documentation</h5>
<ul>
<li><a href="/mina-project/documentation.html" class="external-link" rel="nofollow">Base documentation</a></li>
<li><a href="/mina-project/userguide/user-guide-toc.html" class="external-link" rel="nofollow">User guide</a></li>
<li><a href="/mina-project/2.2-vs-2.1.html" class="external-link" rel="nofollow">2.2 vs 2.1</a></li>
<li><a href="/mina-project/2.1-vs-2.0.html" class="external-link" rel="nofollow">2.1 vs 2.0</a></li>
<li><a href="/mina-project/features.html" class="external-link" rel="nofollow">Features</a></li>
<li><a href="/mina-project/road-map.html" class="external-link" rel="nofollow">Road Map</a></li>
<li><a href="/mina-project/quick-start-guide.html" class="external-link" rel="nofollow">Quick Start Guide</a></li>
<li><a href="/mina-project/faq.html" class="external-link" rel="nofollow">FAQ</a></li>
</ul>
<h5>Resources</h5>
<ul>
<li><a href="/mina-project/mailing-lists.html" class="external-link" rel="nofollow">Mailing lists &amp; IRC</a></li>
<li><a href="/mina-project/issue-tracking.html" class="external-link" rel="nofollow">Issue tracking</a></li>
<li><a href="/mina-project/sources.html" class="external-link" rel="nofollow">Sources</a></li>
<li><a href="/mina-project/gen-docs/latest-2.0/apidocs/index.html" class="external-link" rel="nofollow">API Javadoc 2.0.25</a></li>
<li><a href="/mina-project/gen-docs/latest-2.1/apidocs/index.html" class="external-link" rel="nofollow">API Javadoc 2.1.8</a></li>
<li><a href="/mina-project/gen-docs/latest-2.2/apidocs/index.html" class="external-link" rel="nofollow">API Javadoc 2.2.3</a></li>
<li><a href="/mina-project/gen-docs/latest-2.0/xref/index.html" class="external-link" rel="nofollow">API xref 2.0.25</a></li>
<li><a href="/mina-project/gen-docs/latest-2.1/xref/index.html" class="external-link" rel="nofollow">API xref 2.1.8</a></li>
<li><a href="/mina-project/gen-docs/latest-2.2/xref/index.html" class="external-link" rel="nofollow">API xref 2.2.3</a></li>
<li><a href="/mina-project/performances.html" class="external-link" rel="nofollow">Performances</a></li>
<li><a href="/mina-project/testimonials.html" class="external-link" rel="nofollow">Testimonials</a></li>
<li><a href="/mina-project/conferences.html" class="external-link" rel="nofollow">Conferences</a></li>
<li><a href="/mina-project/developer-guide.html" class="external-link" rel="nofollow">Developers Guide</a></li>
<li><a href="/mina-project/related-projects.html" class="external-link" rel="nofollow">Related Projects</a></li>
<li><a href="https://people.apache.org/~vgritsenko/stats/projects/mina.html" class="external-link" rel="nofollow">Statistics</a></li>
</ul>
<h5>Community</h5>
<ul>
<li><a href="https://www.apache.org/foundation/contributing.html" class="external-link" rel="nofollow">Contributing</a></li>
<li><a href="/contributors.html" class="external-link" rel="nofollow">Team</a></li>
<li><a href="/special-thanks.html" class="external-link" rel="nofollow">Special Thanks</a></li>
<li><a href="https://www.apache.org/security/" class="external-link" rel="nofollow">Security</a></li>
</ul>
<h5>About Apache</h5>
<ul>
<li><a href="https://www.apache.org" class="external-link" rel="nofollow">Apache main site</a></li>
<li><a href="https://www.apache.org/licenses/" class="external-link" rel="nofollow">License</a></li>
<li><a href="https://www.apache.org/foundation/sponsorship.html" title="The ASF sponsorship program" class="external-link" rel="nofollow">Sponsorship program</a></li>
<li><a href="https://www.apache.org/foundation/thanks.html" class="external-link" rel="nofollow">Thanks</a></li>
</ul>
<h3><a name="Navigation-Upcoming"></a>Upcoming</h3>
<ul>
<li>No event</li>
</ul>
</div>
</div>
<div id="rightColumn">
<h2 id="mina-20-user-guide">MINA 2.0 User Guide</h2>
<p>Part I - Basics</p>
<ul>
<li><a href="ch1-getting-started/ch1-getting-started.html">Chapter 1 - Getting Started</a>
<ul>
<li><a href="ch1-getting-started/ch1.1-nio-overview.html">1.1 - NIO Overview</a></li>
<li><a href="ch1-getting-started/ch1.2-why-mina.html">1.2 - Why MINA ?</a></li>
<li><a href="ch1-getting-started/ch1.3-features.html">1.3 - Features</a></li>
<li><a href="ch1-getting-started/ch1.4-first-steps.html">1.4 - First Steps</a></li>
<li><a href="ch1-getting-started/ch1.5-summary.html">1.5 - Summary</a></li>
</ul>
</li>
<li><a href="ch2-basics/ch2-basics.html">Chapter 2 - Basics</a>
<ul>
<li><a href="ch2-basics/ch2.1-application-architecture.html">2.1 - Application Architecture</a>
<ul>
<li><a href="ch2-basics/ch2.1.1-server-architecture.html">2.1.1 - Server Architecture</a></li>
<li><a href="ch2-basics/ch2.1.2-client-architecture.html">2.1.2 - Client Architecture</a></li>
</ul>
</li>
<li><a href="ch2-basics/ch2.2-sample-tcp-server.html">2.2 - Sample TCP Server</a></li>
<li><a href="ch2-basics/ch2.3-sample-tcp-client.html">2.3 - Sample TCP Client</a></li>
<li><a href="ch2-basics/ch2.4-sample-udp-server.html">2.4 - Sample UDP Server</a></li>
<li><a href="ch2-basics/ch2.5-sample-udp-client.html">2.5 - Sample UDP Client</a></li>
<li><a href="ch2-basics/ch2.6-summary.html">2.6 - Summary</a></li>
</ul>
</li>
<li><a href="ch3-service/ch3-service.html">Chapter 3 - Service</a>
<ul>
<li><a href="ch3-service/ch3.1-io-service.html">3.1 - IoService Introduction</a></li>
<li><a href="ch3-service/ch3.2-io-service-details.html">3.2 - IoService Details</a></li>
<li><a href="ch3-service/ch3.3-acceptor.html">3.3 - IoAcceptor</a></li>
<li><a href="ch3-service/ch3.4-connector.html">3.4 - IoConnector</a></li>
</ul>
</li>
<li><a href="ch4-session/ch4-session.html">Chapter 4 - Session</a>
<ul>
<li><a href="ch4-session/ch4.1-session-configuration.html">4.1 - Session Configuration</a></li>
<li><a href="ch4-session/ch4.2-session-statistics.html">4.2 - Session Statistics</a></li>
</ul>
</li>
<li><a href="ch5-filters/ch5-filters.html">Chapter 5 - Filters</a>
<ul>
<li><a href="ch5-filters/ch5.1-blacklist-filter.html">5.1 - Blacklist Filter</a></li>
<li><a href="ch5-filters/ch5.2-buffered-write-filter.html">5.2 - Buffered Write Filter</a></li>
<li><a href="ch5-filters/ch5.3-compression-filter.html">5.3 - Compression Filter</a></li>
<li><a href="ch5-filters/ch5.4-connection-throttle-filter.html">5.4 - Connection Throttle Filter</a></li>
<li><a href="ch5-filters/ch5.5-error-generating-filter.html">5.5 - Error Generating Filter</a></li>
<li><a href="ch5-filters/ch5.6-executor-filter.html">5.6 - Executor Filter</a></li>
<li><a href="ch5-filters/ch5.7-file-region-write-filter.html">5.7 - FileRegion Write Filter</a></li>
<li><a href="ch5-filters/ch5.8-keep-alive-filter.html">5.8 - KeepAlive Filter</a></li>
<li><a href="ch5-filters/ch5.9-logging-filter.html">5.9 - Logging Filter</a></li>
<li><a href="ch5-filters/ch5.10-mdc-injection-filter.html">5.10 - MDC Injection Filter</a></li>
<li><a href="ch5-filters/ch5.11-noop-filter.html">5.11 - NOOP Filter</a></li>
<li><a href="ch5-filters/ch5.12-profiler-filter.html">5.12 - Profiler Filter</a></li>
<li><a href="ch5-filters/ch5.13-protocol-codec-filter.html">5.13 - Protocol Codec Filter</a></li>
<li><a href="ch5-filters/ch5.14-proxy-filter.html">5.14 - Proxy Filter</a></li>
<li><a href="ch5-filters/ch5.15-reference-counting-filter.html">5.15 - Reference Counting Filter</a></li>
<li><a href="ch5-filters/ch5.16-request-response-filter.html">5.16 - Request/Response Filter</a></li>
<li><a href="ch5-filters/ch5.17-session-attribute-initializing-filter.html">5.17 - Session Attribute Initializing Filter</a></li>
<li><a href="ch5-filters/ch5.18-stream-write-filter.html">5.18 - Stream Write Filter</a></li>
<li><a href="ch5-filters/ch5.19-ssl-filter.html">5.19 - SSL/TLS Filter</a></li>
<li><a href="ch5-filters/ch5.20-write-request-filter.html">5.20 - Write Request Filter</a></li>
</ul>
</li>
<li><a href="ch6-transports/ch6-transports.html">Chapter 6 - Transports</a>
<ul>
<li><a href="ch6-transports/ch6.1-apr-transport.html">6.1 - APR Transport</a></li>
<li><a href="ch6-transports/ch6.2-serial-transport.html">6.2 - Serial Transport</a></li>
</ul>
</li>
<li><a href="ch7-handler/ch7-handler.html">Chapter 7 - Handler</a></li>
</ul>
<p>Part II - MINA Core</p>
<ul>
<li><a href="ch8-iobuffer/ch8-iobuffer.html">Chapter 8 - IoBuffer</a></li>
<li><a href="ch9-codec-filter/ch9-codec-filter.html">Chapter 9 - Codec Filter</a></li>
<li><a href="ch10-executor-filter/ch10-executor-filter.html">Chapter 10 - Executor Filter</a></li>
<li><a href="ch11-ssl-filter/ch11-ssl-filter.html">Chapter 11 - SSL Filter</a></li>
<li><a href="ch12-logging-filter/ch12-logging-filter.html">Chapter 12 - Logging Filter</a></li>
</ul>
<p>Part III - MINA Advanced</p>
<ul>
<li><a href="ch13-debugging/ch13-debugging.html">Chapter 13 - Debugging</a></li>
<li><a href="ch14-state-machine/ch14-state-machine.html">Chapter 14 - State Machine</a></li>
<li><a href="ch15-proxy/ch15-proxy.html">Chapter 15 - Proxy</a></li>
<li><a href="ch16-jmx-support/ch16-jmx-support.html">Chapter 16 - JMX Integration</a></li>
<li><a href="ch17-spring-integration/ch17-spring-integration.html">Chapter 17 - Spring Integration</a></li>
</ul>
</div>
<div id="endContent"></div>
</div>
<div id="footer">
&copy; 2003-2024, <a href="https://www.apache.org">The Apache Software Foundation</a> - <a href="https://privacy.apache.org/policies/privacy-policy-public.html">Privacy Policy</a><br />
Apache MINA, MINA, Apache Vysper, Vysper, Apache SSHd, SSHd, Apache FtpServer, FtpServer, Apache AsyncWeb, AsyncWeb,
Apache, the Apache feather logo, and the Apache Mina project logos are trademarks of The Apache Software Foundation.
</div>
</div>
</body>
</html>