| <!DOCTYPE html>
|
|
|
| <html lang="en">
|
| <head>
|
| <title>Documentation — 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>
|
| |
|
| <a href="/mina-project/">
|
|
|
| <strong>MINA</strong>
|
|
|
| </a>
|
| |
|
| <a href="/asyncweb-project/">
|
|
|
| AsyncWeb
|
|
|
| </a>
|
| |
|
| <a href="/ftpserver-project/">
|
|
|
| FtpServer
|
|
|
| </a>
|
| |
|
| <a href="/sshd-project/">
|
|
|
| SSHD
|
|
|
| </a>
|
| |
|
| <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 & 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">
|
|
|
|
|
| |
| <h1 id="documentation">Documentation</h1> |
| <div class="note" markdown="1"> |
| The MINA 2.0 User Guide can be found here : [User Guide](userguide/user-guide-toc.html) |
| </div> |
| <nav id="TableOfContents"> |
| <ul> |
| <li><a href="#presentation-materials">Presentation Materials</a></li> |
| <li><a href="#versions--references">Versions & References</a></li> |
| <li><a href="#tutorials">Tutorials</a> |
| <ul> |
| <li><a href="#for-developers">For Developers</a></li> |
| </ul> |
| </li> |
| <li><a href="#examples">Examples</a></li> |
| <li><a href="#older-presentation-materials">Older Presentation Materials</a></li> |
| </ul> |
| </nav> |
| <h2 id="presentation-materials">Presentation Materials</h2> |
| <p>These presentation materials will help you understand the overall architecture and core constructs of MINA</p> |
| <ul> |
| <li><a href="resources/Mina_in_real_life_ASEU-2009.pdf">MINA in real life (ApacheCon EU 2009)</a> by Emmanuel Lécharny</li> |
| <li><a href="resources/JavaOne2008.pdf">Rapid Network Application Development with Apache MINA (JavaOne 2008)</a> by Trustin Lee</li> |
| <li><a href="resources/ACUS2007.pdf">Apache MINA - The High Performance Protocol Construction Toolkit (ApacheCon US 2007)</a> by Peter Royal</li> |
| <li><a href="resources/ACAsia2006.pdf">Introduction to MINA (ApacheCon Asia 2006)</a> by Trustin Lee</li> |
| </ul> |
| <h2 id="versions--references">Versions & References</h2> |
| <p>There are currently three branches in MINA:</p> |
| <table> |
| <thead> |
| <tr> |
| <th>JavaDoc</th> |
| <th>Source Code</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><a href="http://mina.apache.org/mina-project/gen-docs/latest-2.0/apidocs/index.html">2.0</a></td> |
| <td><a href="http://mina.apache.org/mina-project/gen-docs/latest-2.0/xref/">main</a>, <a href="http://mina.apache.org/mina-project/gen-docs/latest-2.0/xref-test/">test</a></td> |
| <td>The officially recommended production-ready branch</td> |
| </tr> |
| <tr> |
| <td><a href="http://mina.apache.org/mina-project/gen-docs/latest-2.1/apidocs/index.html">2.1</a></td> |
| <td><a href="http://mina.apache.org/mina-project/gen-docs/latest-2.1/xref/">main</a>, <a href="http://mina.apache.org/mina-project/gen-docs/latest-2.1/xref-test/">test</a></td> |
| <td>The new recommended production-ready branch</td> |
| </tr> |
| <tr> |
| <td>3.0</td> |
| <td><a href="http://svn.apache.org/viewvc/mina/mina/trunk/">trunk</a></td> |
| <td>The version we are currently working on</td> |
| </tr> |
| </tbody> |
| </table> |
| <p>You might also want to read the [frequently asked questions](faq.html] and learn how to <a href="../contact.html">contact us</a> before getting started.</p> |
| <h2 id="tutorials">Tutorials</h2> |
| <ul> |
| <li><a href="quick-start-guide.html">MINA v2.0 Quick Start Guide</a> - Create your first MINA based program using MINA version 2.0</li> |
| <li><a href="userguide/ch12-logging-filter/ch12-logging-filter.html">Logging Configuration</a> - Configuring your MINA-based application for logging</li> |
| <li>Transport-specific Configuration |
| <ul> |
| <li><a href="userguide/ch6-transports/ch6.2-serial-transport.html">Serial Tutorial</a> - Serial communications with MINA trunk</li> |
| <li><a href="userguide/ch6-transports/ch6-transports">UDP Tutorial</a> - Writing a User Datagram Protocol (UDP) client and server using MINA</li> |
| <li><a href="userguide/ch6-transports/ch6.1-apr-transport.html">APR Transport</a> - Describes use of APR Transport with MINA</li> |
| </ul> |
| </li> |
| <li><a href="userguide/ch17-spring-integration/ch17-spring-integration.html">Integrating with Spring</a> - Demonstrates how to integrate MINA application with Spring</li> |
| <li><a href="codec-repo.html">Codec Repository</a> - Links to available codec implementations for MINA</li> |
| <li>Advanced Topic |
| <ul> |
| <li><a href="userguide/ch5-filters/ch5-filters.html">Writing IoFilter</a> - Writing your own <em>IoFilter</em> implementation to deal with cross-cutting concerns</li> |
| <li><a href="userguide/ch9-codec-filter/ch9-codec-filter.html">Writing Protocol Codec for MINA 2.x</a> - Implementing a protocol codec for separation of concern</li> |
| <li><a href="userguide/ch10-executor-filter/ch10-executor-filter.html">Using an Executor Filter</a> - Controlling the size of thread pool and choosing the right thread model</li> |
| <li><a href="userguide/ch16-jmx-support/ch16-jmx-support.html">JMX Integration</a> - Making your network application manageable</li> |
| <li><a href="userguide/ch14-state-machine/ch14-state-machine.html">Introduction to mina-statemachine</a> - Implementing state machine based MINA applications using Java5 annotations</li> |
| </ul> |
| </li> |
| <li><a href="userguide/user-guide-toc.html">User Guide</a> - The new draft MINA User Guide.</li> |
| </ul> |
| <h3 id="for-developers">For Developers</h3> |
| <ul> |
| <li><a href="developer-guide.html">Developer Guide</a> - Building & deploying MINA, Coding Standard, and more</li> |
| </ul> |
| <h2 id="examples">Examples</h2> |
| <p>You can browse all examples <a href="http://mina.apache.org/mina-project/gen-docs/latest-2.0/xref/org/apache/mina/example/">here</a>.</p> |
| <table> |
| <thead> |
| <tr> |
| <th>Name</th> |
| <th>Feature it demonstrates</th> |
| <th>Side</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><a href="http://mina.apache.org/mina-project/gen-docs/latest-2.0/xref/org/apache/mina/example/reverser/">Reverser</a></td> |
| <td>Text protocol based on a protocol codec</td> |
| <td>Server</td> |
| </tr> |
| <tr> |
| <td><a href="http://mina.apache.org/mina-project/gen-docs/latest-2.0/xref/org/apache/mina/example/sumup/">SumUp server</a></td> |
| <td>Complex binary protocol based on a protocol codec</td> |
| <td>Both</td> |
| </tr> |
| <tr> |
| <td><a href="http://mina.apache.org/mina-project/gen-docs/latest-2.0/xref/org/apache/mina/example/echoserver/">Echo server</a></td> |
| <td>Low-level I/O and SSL</td> |
| <td>Server</td> |
| </tr> |
| <tr> |
| <td><a href="http://mina.apache.org/mina-project/gen-docs/latest-2.0/xref/org/apache/mina/example/netcat/">NetCat</a></td> |
| <td>Client programming</td> |
| <td>Client</td> |
| </tr> |
| <tr> |
| <td><a href="http://mina.apache.org/mina-project/gen-docs/latest-2.0/xref/org/apache/mina/http/">HTTP server</a></td> |
| <td>Stream-based synchronous I/O</td> |
| <td>Server</td> |
| </tr> |
| <tr> |
| <td><a href="http://mina.apache.org/mina-project/gen-docs/latest-2.0/xref/org/apache/mina/example/tennis/">Tennis</a></td> |
| <td>In-VM pipe communication</td> |
| <td>Both</td> |
| </tr> |
| <tr> |
| <td><a href="http://mina.apache.org/mina-project/gen-docs/latest-2.0/xref/org/apache/mina/example/chat/">Chat server</a></td> |
| <td>Spring integration</td> |
| <td>Both</td> |
| </tr> |
| <tr> |
| <td><a href="http://mina.apache.org/mina-project/gen-docs/latest-2.0/xref/org/apache/mina/example/proxy/">Proxy</a></td> |
| <td>Resending received bytes on another session.</td> |
| <td>Both</td> |
| </tr> |
| </tbody> |
| </table> |
| <h2 id="older-presentation-materials">Older Presentation Materials</h2> |
| <ul> |
| <li><a href="resources/ACEU2007.pdf">Building TCP/IP Servers with Apache MINA (ApacheCon EU 2007)</a> by Peter Royal</li> |
| <li><a href="resources/ACEU2006.pdf">Building TCP/IP Servers with Apache MINA (ApacheCon EU 2006)</a> by Peter Royal</li> |
| <li><a href="resources/ACUS2005.pdf">Introduction to MINA (ApacheCon US 2005)</a> by Trustin Lee (<a href="resources/ACUS2005.swf">Demo movie</a>)</li> |
| </ul> |
| |
|
|
|
|
|
|
| </div>
|
| <div id="endContent"></div>
|
| </div>
|
|
|
| <div id="footer">
|
| © 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>
|
