| <?xml version="1.0" encoding="UTF-8"?> |
| <document> |
| <properties> |
| <author email="trustin@apache.org">Trustin Lee</author> |
| <title>Getting Started</title> |
| </properties> |
| |
| <body> |
| <section name="Getting Started"> |
| <p> |
| Must-reads: |
| <ul> |
| <li>Introduction to MINA (from ApacheCon US 2005) |
| <ul> |
| <li><a href="mina.ppt" target="_blank">PPT version with animations</a></li> |
| <li><a href="mina.pdf" target="_blank">PDF version without animations</a></li> |
| <li><a href="demo.htm" target="_blank">Demo movie</a></li> |
| </ul> |
| </li> |
| <li><a href="http://wiki.apache.org/directory/MinaTutorial" target="_blank">MINA Tutorial</a></li> |
| </ul> |
| </p> |
| |
| <subsection name="Examples"> |
| <p> |
| You'll learn faster with |
| <a target="_blank" href="http://svn.apache.org/viewcvs.cgi/directory/trunks/mina/examples/src/main/java/org/apache/mina/examples/">examples</a> |
| referring to |
| <a target="_blank" href="apidocs/index.html">JavaDocs</a>. |
| <table> |
| <tr> |
| <th>Name</th> |
| <th>Feature it demonstrates</th> |
| <th>Side</th> |
| </tr> |
| <tr> |
| <td><a href="http://svn.apache.org/viewcvs.cgi/directory/trunks/mina/examples/src/main/java/org/apache/mina/examples/reverser/">Reverser</a></td> |
| <td>Text protocol based on a protocol codec</td> |
| <td>Server</td> |
| </tr> |
| <tr> |
| <td><a href="http://svn.apache.org/viewcvs.cgi/directory/trunks/mina/examples/src/main/java/org/apache/mina/examples/sumup/">SumUp server</a></td> |
| <td>Complex binary protocol based on a protocol codec</td> |
| <td>Both</td> |
| </tr> |
| <tr> |
| <td><a href="http://svn.apache.org/viewcvs.cgi/directory/trunks/mina/examples/src/main/java/org/apache/mina/examples/echoserver/">Echo server</a></td> |
| <td>Low-level I/O and SSL</td> |
| <td>Server</td> |
| </tr> |
| <tr> |
| <td><a href="http://svn.apache.org/viewcvs.cgi/directory/trunks/mina/examples/src/main/java/org/apache/mina/examples/netcat/">NetCat</a></td> |
| <td>Client programming</td> |
| <td>Client</td> |
| </tr> |
| <tr> |
| <td><a href="http://svn.apache.org/viewcvs.cgi/directory/trunks/mina/examples/src/main/java/org/apache/mina/examples/httpserver/">HTTP server</a></td> |
| <td>Stream-based synchronous I/O</td> |
| <td>Server</td> |
| </tr> |
| <tr> |
| <td><a href="http://svn.apache.org/viewcvs.cgi/directory/trunks/mina/examples/src/main/java/org/apache/mina/examples/tennis/">Tennis</a></td> |
| <td>In-VM pipe communication</td> |
| <td>Both</td> |
| </tr> |
| </table> |
| </p> |
| </subsection> |
| |
| <subsection name="Source code"> |
| <p> |
| Source code: |
| <source> |
| $ svn co https://svn.apache.org/repos/asf/directory/trunks/mina |
| $ cd mina |
| $ mvn package # Build packages (JARs) for the core API and other extensions |
| $ mvn -N site # Generate documentation |
| $ mvn assembly:assembly # Generate a tarball |
| $ mvn eclipse:eclipse # Generate Eclipse project files if you want |
| </source> |
| </p> |
| </subsection> |
| </section> |
| </body> |
| </document> |
