Author: trustin
Date: Fri May 6 23:31:11 2005
New Revision: 169050
URL: http://svn.apache.org/viewcvs?rev=169050&view=rev
Log:
Pulled out feature list and getting started section to separate pages.
Added:
directory/network/trunk/xdocs/features.xml (with props)
directory/network/trunk/xdocs/getting_started.xml (with props)
Modified:
directory/network/trunk/xdocs/index.xml
directory/network/trunk/xdocs/navigation.xml
Added: directory/network/trunk/xdocs/features.xml
URL:
http://svn.apache.org/viewcvs/directory/network/trunk/xdocs/features.xml?rev=169050&view=auto
==============================================================================
--- directory/network/trunk/xdocs/features.xml (added)
+++ directory/network/trunk/xdocs/features.xml Fri May 6 23:31:11 2005
@@ -0,0 +1,98 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<document>
+ <properties>
+ <author email="[EMAIL PROTECTED]">Trustin Lee</author>
+ <title>Overview</title>
+ </properties>
+
+ <body>
+ <section name="Features">
+ <p>
+ MINA is a simple yet full-featured network application framework
+ which provides:
+ <ul>
+ <li>Unified API for various transport types:
+ <ul>
+ <li>TCP/IP</li>
+ <li>UDP/IP</li>
+ <li>In-VM pipe communication</li>
+ <li>You can implement your own!</li>
+ </ul></li>
+ <li>Low-level and high-level API:
+ <ul>
+ <li>Low-level: uses ByteBuffers</li>
+ <li>High-level: uses user-defined message objects
and codecs</li>
+ </ul></li>
+ <li>Stream-based I/O support via
<code>StreamIoHandler</code></li>
+ <li>Filter interface as an extension point; similar to <a
href="http://java.sun.com/products/servlet/Filters.html";>Servlet filters</a>
+ <ul>
+ <li>SSL support via <code>SSLFilter</code> thanks to Java 5
<code>SSLEngine</code></li>
+ <li>Thread pools are implemented as filters so that users can
customize thread model.</li>
+ </ul></li>
+ <li>Unit testability using <a
href="http://www.mockobjects.com/";>mock objects</a>,</li>
+ <li>JMX managability, (coming soon)</li>
+ <li>Traffic throttling, (coming soon)</li>
+ <li>Overload shielding, (coming soon)</li>
+ <li>Integration with well known containers such as Spring
+ and OSGi, (coming soon)</li>
+ <li>Smooth migration from Netty, a popular NIO framework.
+ (See <a
href="http://gleamynode.net/dev/tl-netty2-example-sumup/docs/";>Netty
Tutorial</a>)</li>
+ </ul>
+ </p>
+ </section>
+
+ <section name="Getting Started">
+ <p>
+ Please look at <a href="mina.pdf">this presentation</a> first of all.
+ </p>
+ <p>
+ Are you interested? Now check out the source code from SVN repository:
+<source>
+$ svn co https://svn.apache.org/repos/asf/directory/network/trunk mina
+$ cd mina
+$ maven jar # Build JAR
+$ maven site # Generate documentation
+$ maven eclipse # Generate Eclipse project file if you want
+</source>
+ </p>
+ <p>
+ Tutorial is under construction. Please start from
+ <a target="_blank" href="xref-examples/index.html">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 target="classFrame"
href="xref-examples/org/apache/mina/examples/reverser/package-summary.html">Reverser</a></td>
+ <td>High-level protocol layer</td>
+ <td>Server</td>
+ </tr>
+ <tr>
+ <td><a target="classFrame"
href="xref-examples/org/apache/mina/examples/echoserver/package-summary.html">Echo
server</a></td>
+ <td>Low-level I/O layer and SSL support</td>
+ <td>Server</td>
+ </tr>
+ <tr>
+ <td><a target="classFrame"
href="xref-examples/org/apache/mina/examples/netcat/package-summary.html">NetCat</a></td>
+ <td>Low-level I/O layer</td>
+ <td>Client</td>
+ </tr>
+ <tr>
+ <td><a target="classFrame"
href="xref-examples/org/apache/mina/examples/httpserver/package-summary.html">HTTP
server</a></td>
+ <td>Stream-based synchronous I/O support.</td>
+ <td>Server</td>
+ </tr>
+ <tr>
+ <td><a target="classFrame"
href="xref-examples/org/apache/mina/examples/tennis/package-summary.html">Tennis</a></td>
+ <td>In-VM pipe communication support in protocol layer.</td>
+ <td>Both</td>
+ </tr>
+ </table>
+ </p>
+ </section>
+ </body>
+</document>
Propchange: directory/network/trunk/xdocs/features.xml
------------------------------------------------------------------------------
svn:keywords = HeadURL Id LastChangedBy LastChangedDate LastChangedRevision
Added: directory/network/trunk/xdocs/getting_started.xml
URL:
http://svn.apache.org/viewcvs/directory/network/trunk/xdocs/getting_started.xml?rev=169050&view=auto
==============================================================================
--- directory/network/trunk/xdocs/getting_started.xml (added)
+++ directory/network/trunk/xdocs/getting_started.xml Fri May 6 23:31:11 2005
@@ -0,0 +1,73 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<document>
+ <properties>
+ <author email="[EMAIL PROTECTED]">Trustin Lee</author>
+ <title>Overview</title>
+ </properties>
+
+ <body>
+ <section name="Getting Started">
+ <p>
+ Must-reads:
+ <ul>
+ <li><a href="mina.pdf" target="_blank">Introduction to MINA: A PDF
Slideshow</a></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="xref-examples/index.html">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 target="classFrame"
href="xref-examples/org/apache/mina/examples/reverser/package-summary.html">Reverser</a></td>
+ <td>High-level protocol layer</td>
+ <td>Server</td>
+ </tr>
+ <tr>
+ <td><a target="classFrame"
href="xref-examples/org/apache/mina/examples/echoserver/package-summary.html">Echo
server</a></td>
+ <td>Low-level I/O layer and SSL support</td>
+ <td>Server</td>
+ </tr>
+ <tr>
+ <td><a target="classFrame"
href="xref-examples/org/apache/mina/examples/netcat/package-summary.html">NetCat</a></td>
+ <td>Low-level I/O layer</td>
+ <td>Client</td>
+ </tr>
+ <tr>
+ <td><a target="classFrame"
href="xref-examples/org/apache/mina/examples/httpserver/package-summary.html">HTTP
server</a></td>
+ <td>Stream-based synchronous I/O support.</td>
+ <td>Server</td>
+ </tr>
+ <tr>
+ <td><a target="classFrame"
href="xref-examples/org/apache/mina/examples/tennis/package-summary.html">Tennis</a></td>
+ <td>In-VM pipe communication support in protocol layer.</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/network/trunk mina
+$ cd mina
+$ maven jar # Build JAR
+$ maven site # Generate documentation
+$ maven eclipse # Generate Eclipse project file if you want
+</source>
+ </p>
+ </subsection>
+ </section>
+ </body>
+</document>
Propchange: directory/network/trunk/xdocs/getting_started.xml
------------------------------------------------------------------------------
svn:keywords = HeadURL Id LastChangedBy LastChangedDate LastChangedRevision
Modified: directory/network/trunk/xdocs/index.xml
URL:
http://svn.apache.org/viewcvs/directory/network/trunk/xdocs/index.xml?rev=169050&r1=169049&r2=169050&view=diff
==============================================================================
--- directory/network/trunk/xdocs/index.xml (original)
+++ directory/network/trunk/xdocs/index.xml Fri May 6 23:31:11 2005
@@ -6,97 +6,16 @@
</properties>
<body>
- <section name="Introduction">
+ <section name="Overview">
<p>
MINA (Multipurpose Infrastructure for Network Applications) is a
network application framework which helps users develop high
performance and high scalability network applications easily.
- </p>
- <p>
- MINA is a simple yet full-featured network application framework
- which provides:
+
<ul>
- <li>Unified API for various transport types:
- <ul>
- <li>TCP/IP</li>
- <li>UDP/IP</li>
- <li>In-VM pipe communication</li>
- <li>You can implement your own!</li>
- </ul></li>
- <li>Low-level and high-level API:
- <ul>
- <li>Low-level: uses ByteBuffers</li>
- <li>High-level: uses user-defined message objects
and codecs</li>
- </ul></li>
- <li>Stream-based I/O support via
<code>StreamIoHandler</code></li>
- <li>Filter interface as an extension point; similar to <a
href="http://java.sun.com/products/servlet/Filters.html";>Servlet filters</a>
- <ul>
- <li>SSL support via <code>SSLFilter</code> thanks to Java 5
<code>SSLEngine</code></li>
- <li>Thread pools are implemented as filters so that users can
customize thread model.</li>
- </ul></li>
- <li>Unit testability using <a
href="http://www.mockobjects.com/";>mock objects</a>,</li>
- <li>JMX managability, (coming soon)</li>
- <li>Traffic throttling, (coming soon)</li>
- <li>Overload shielding, (coming soon)</li>
- <li>Integration with well known containers such as Spring
- and OSGi, (coming soon)</li>
- <li>Smooth migration from Netty, a popular NIO framework.
- (See <a
href="http://gleamynode.net/dev/tl-netty2-example-sumup/docs/";>Netty
Tutorial</a>)</li>
+ <li><a href="features.html">Feature List</a></li>
+ <li><a href="getting_started.html">Getting Started</a></li>
</ul>
- </p>
- </section>
-
- <section name="Getting Started">
- <p>
- Please look at <a href="mina.pdf">this presentation</a> first of all.
- </p>
- <p>
- Are you interested? Now check out the source code from SVN repository:
-<source>
-$ svn co https://svn.apache.org/repos/asf/directory/network/trunk mina
-$ cd mina
-$ maven jar # Build JAR
-$ maven site # Generate documentation
-$ maven eclipse # Generate Eclipse project file if you want
-</source>
- </p>
- <p>
- Tutorial is under construction. Please start from
- <a target="_blank" href="xref-examples/index.html">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 target="classFrame"
href="xref-examples/org/apache/mina/examples/reverser/package-summary.html">Reverser</a></td>
- <td>High-level protocol layer</td>
- <td>Server</td>
- </tr>
- <tr>
- <td><a target="classFrame"
href="xref-examples/org/apache/mina/examples/echoserver/package-summary.html">Echo
server</a></td>
- <td>Low-level I/O layer and SSL support</td>
- <td>Server</td>
- </tr>
- <tr>
- <td><a target="classFrame"
href="xref-examples/org/apache/mina/examples/netcat/package-summary.html">NetCat</a></td>
- <td>Low-level I/O layer</td>
- <td>Client</td>
- </tr>
- <tr>
- <td><a target="classFrame"
href="xref-examples/org/apache/mina/examples/httpserver/package-summary.html">HTTP
server</a></td>
- <td>Stream-based synchronous I/O support.</td>
- <td>Server</td>
- </tr>
- <tr>
- <td><a target="classFrame"
href="xref-examples/org/apache/mina/examples/tennis/package-summary.html">Tennis</a></td>
- <td>In-VM pipe communication support in protocol layer.</td>
- <td>Both</td>
- </tr>
- </table>
</p>
</section>
</body>
Modified: directory/network/trunk/xdocs/navigation.xml
URL:
http://svn.apache.org/viewcvs/directory/network/trunk/xdocs/navigation.xml?rev=169050&r1=169049&r2=169050&view=diff
==============================================================================
--- directory/network/trunk/xdocs/navigation.xml (original)
+++ directory/network/trunk/xdocs/navigation.xml Fri May 6 23:31:11 2005
@@ -18,8 +18,8 @@
<menu name="MINA">
<item name="Overview" href="/index.html"/>
- <item name="Introduction" href="/mina.pdf"/>
- <item name="Tutorial"
href="http://wiki.apache.org/directory/MinaTutorial"/>
+ <item name="Features" href="/features.html"/>
+ <item name="Getting Started" href="/getting_started.html"/>
<item name="Roadmap" href="/roadmap.html"/>
</menu>
@@ -27,7 +27,7 @@
<item name="JavaDocs" href="/apidocs/index.html" target="_blank"/>
<item name="Source code" href="/xref/index.html" target="_blank"/>
<item name="Source code (SVN)"
href="http://svn.apache.org/viewcvs.cgi/directory/network/mina/trunk/?root=Apache-SVN";
target="_blank"/>
- <item name="Wiki" href="http://wiki.apache.org/directory/MinaHome"/>
+ <item name="Wiki" href="http://wiki.apache.org/directory/MinaHome";
target="_blank"/>
</menu>
<menu name="MINA Examples">
