You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@directory.apache.org by pr...@apache.org on 2006/10/31 05:05:41 UTC
svn commit: r469362 - in /directory/branches/mina/1.0/src/site: fml/faq.fml
site.xml xdoc/features.xml xdoc/getting_started.xml xdoc/index.xml
Author: proyal
Date: Mon Oct 30 20:05:40 2006
New Revision: 469362
URL: http://svn.apache.org/viewvc?view=rev&rev=469362
Log:
documentation updates
Modified:
directory/branches/mina/1.0/src/site/fml/faq.fml
directory/branches/mina/1.0/src/site/site.xml
directory/branches/mina/1.0/src/site/xdoc/features.xml
directory/branches/mina/1.0/src/site/xdoc/getting_started.xml
directory/branches/mina/1.0/src/site/xdoc/index.xml
Modified: directory/branches/mina/1.0/src/site/fml/faq.fml
URL: http://svn.apache.org/viewvc/directory/branches/mina/1.0/src/site/fml/faq.fml?view=diff&rev=469362&r1=469361&r2=469362
==============================================================================
--- directory/branches/mina/1.0/src/site/fml/faq.fml (original)
+++ directory/branches/mina/1.0/src/site/fml/faq.fml Mon Oct 30 20:05:40 2006
@@ -42,18 +42,7 @@
<question>Which version of MINA should I use?</question>
<answer>
<p>
- MINA uses Linux-like version numbers. This means that even numbers, such as 0.8, will guarantee
- API stability between releases in the series. With 0.9, you may have to modify your code when moving
- from 0.9.x to 0.9.y. In practice, the 0.9 series is stablizing and changes shouldn't be too drastic.
- </p>
- <p>
- Here are the general rules for choosing an appropriate release:
- <ul>
- <li>Prefer the latest release with even version numbers to with
- odd ones.</li>
- <li>Try the latest release with odd version numbers if there are
- missing features in the stable release.</li>
- </ul>
+ Use the latest point-release of 1.0
</p>
</answer>
</faq>
@@ -91,8 +80,7 @@
</p>
<p>
You can also contact us via <a href="mail-lists.html">the mailing
- list</a> or <a href="http://gleamynode.net/dev/forum/list.php?1">the
- support forum</a> to ask questions on MINA or to contribute to it.
+ list</a> to ask questions on MINA or to contribute to it.
Please do not send messages to the authors directly.
</p>
<p>
@@ -111,9 +99,7 @@
You can contribute anything related with MINA; examples, useful
codecs for existing protocols, tutorials, feature improvements,
bug fixes, benchmarks, and whatever. Please contact us via
- <a href="mail-lists.html">the mailing list</a> or
- <a href="http://gleamynode.net/dev/forum/list.php?1">the support
- forum</a>.
+ <a href="mail-lists.html">the mailing list</a>.
</p>
</answer>
</faq>
@@ -129,8 +115,7 @@
<answer>
<p>
Yes. You can create both client and server applications with MINA.
- Please take a look at <tt>IoConnector</tt> and
- <tt>ProtocolConnector</tt>.
+ Please take a look at <tt>IoConnector</tt> and <tt>IoAcceptor</tt>.
</p>
</answer>
</faq>
@@ -165,7 +150,7 @@
<answer>
<p>
Yes. MINA doesn't close any connections unless you called
- <tt>Session.close()</tt> or connection is closed by the remote peer.
+ <tt>IoSession.close()</tt> or connection is closed by the remote peer.
</p>
</answer>
</faq>
@@ -177,7 +162,7 @@
<answer>
<p>
Not yet. We're going to provide an easy way to implement TLS
- and SASL in version 0.9.
+ and SASL in a future version.
</p>
</answer>
</faq>
@@ -194,9 +179,9 @@
by only one session (e.g. storing context information as a session
attribute), then you don't need to make it thread-safe. It is
because all events generated by MINA are transmitted to your
- handler in order, and the newer event is not processed if the
- event handler method for the older event for the same session didn't
- return yet because MINA uses leader-followers thread pool by default.
+ handler in order (when using the Executor Filter), and the newer event is not processed if the
+ event handler method for the older event for the same session hasn't
+ returned yet.
</p>
</answer>
</faq>
@@ -210,7 +195,7 @@
Virtually all kind of transport types. MINA API is designed to be
transport-independent. You can implement any transport type support
only if you can conform to MINA API. Support for Pre-1.4 I/O (aka BIO),
- reliable multicast, Java Communications API, and file I/O is planned.
+ reliable multicast, Java Communications API, and file I/O are planned.
</p>
</answer>
</faq>
@@ -292,7 +277,7 @@
</question>
<answer>
<p>
- Filters (both <tt>IoFilter</tt> and <tt>ProtocolFilter</tt>) are
+ Filters (both <tt>IoFilter</tt> and <tt>ProtocolCodecFilter</tt>) are
usually considered reusable just like we think Servlet filters.
Please implement commonly used business logic such as authorization
and logging as a filter. In case you implement just complex
@@ -310,7 +295,7 @@
</question>
<answer>
You can't use <tt>sessionIdle</tt> event simply here. You'll have to
- use <tt>java.util.Timer</tt> and <tt>java.util.TimerTask</tt> (or
+ use <tt>java.util.concurrent.ScheduledExecutor</tt> (or
<a href="http://www.opensymphony.com/quartz/">OpenSymphony Quartz</a>
as an alternative). Schedule a timeout task to be executed on timeout
situation for each request message, and cancel it when you receive the
@@ -323,13 +308,10 @@
How can I add filters to a specific session or port?
</question>
<answer>
- There is <tt>IoSession.getFilterChain()</tt> and
- <tt>ProtocolSession.getFilterChain()</tt> that returns
- <tt>IoFilterChain</tt> and <tt>ProtocolFilterChain</tt> respectively.
- You can add any session-specific filters using the returned chain.
- But you cannot add port-specific filters right now. You'll have to
- create more than one <tt>IoAcceptor</tt> or <tt>ProtocolAcceptor</tt>
- because each acceptors have one filter chain you can adjust.
+ You can use <tt>IoSession.getFilterChain()</tt> to add filters to a
+ specific session. For <em>global</em> filters, you can add filters
+ to an <tt>IoService</tt> (to affect all connections from that service),
+ or to the <tt>IoServiceConfig</tt> when binding/connecting
</answer>
</faq>
Modified: directory/branches/mina/1.0/src/site/site.xml
URL: http://svn.apache.org/viewvc/directory/branches/mina/1.0/src/site/site.xml?view=diff&rev=469362&r1=469361&r2=469362
==============================================================================
--- directory/branches/mina/1.0/src/site/site.xml (original)
+++ directory/branches/mina/1.0/src/site/site.xml Mon Oct 30 20:05:40 2006
@@ -37,7 +37,7 @@
<menu name="MINA References">
<item name="JavaDocs" href="/apidocs/index.html"/>
- <item name="Examples" href="http://svn.apache.org/viewvc/directory/trunks/mina/examples/src/main/java/org/apache/mina/examples/"/>
+ <item name="Examples" href="http://svn.apache.org/viewvc/directory/branches/mina/1.0/example/src/main/java/org/apache/mina/example/"/>
<item name="Source code" href="http://svn.apache.org/viewvc/directory/trunks/mina/"/>
</menu>
Modified: directory/branches/mina/1.0/src/site/xdoc/features.xml
URL: http://svn.apache.org/viewvc/directory/branches/mina/1.0/src/site/xdoc/features.xml?view=diff&rev=469362&r1=469361&r2=469362
==============================================================================
--- directory/branches/mina/1.0/src/site/xdoc/features.xml (original)
+++ directory/branches/mina/1.0/src/site/xdoc/features.xml Mon Oct 30 20:05:40 2006
@@ -33,8 +33,7 @@
<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>Integration with well known containers such as PicoContainer, Spring and (coming soon), OSGi</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>
Modified: directory/branches/mina/1.0/src/site/xdoc/getting_started.xml
URL: http://svn.apache.org/viewvc/directory/branches/mina/1.0/src/site/xdoc/getting_started.xml?view=diff&rev=469362&r1=469361&r2=469362
==============================================================================
--- directory/branches/mina/1.0/src/site/xdoc/getting_started.xml (original)
+++ directory/branches/mina/1.0/src/site/xdoc/getting_started.xml Mon Oct 30 20:05:40 2006
@@ -8,7 +8,7 @@
<body>
<section name="Getting Started">
<p>
- Must-reads:
+ Must-reads (but out of date for the current API)
<ul>
<li>Introduction to MINA (from ApacheCon US 2005)
<ul>
@@ -82,7 +82,7 @@
<p>
Source code:
<source>
-$ svn co https://svn.apache.org/repos/asf/directory/trunks/mina
+$ svn co https://svn.apache.org/repos/asf/directory/branches/mina/1.0
$ cd mina
$ mvn package # Build packages (JARs) for the core API and other extensions
$ mvn -N site # Generate documentation
Modified: directory/branches/mina/1.0/src/site/xdoc/index.xml
URL: http://svn.apache.org/viewvc/directory/branches/mina/1.0/src/site/xdoc/index.xml?view=diff&rev=469362&r1=469361&r2=469362
==============================================================================
--- directory/branches/mina/1.0/src/site/xdoc/index.xml (original)
+++ directory/branches/mina/1.0/src/site/xdoc/index.xml Mon Oct 30 20:05:40 2006
@@ -6,6 +6,21 @@
</properties>
<body>
+ <section name="News">
+ <p>
+ MINA 1.0 was just released! (early October 2006), and MINA has just been accepted as a top-level
+ project here at the Apache Software foundation. Look for our move to mina.apache.org very soon!
+ </p>
+
+ <p>
+ We apoligize that our documentation is not yet up-to-date with the 1.0 release. Much of it still
+ refers to the previous 0.8 release. Our mailing list is very active, and the community is
+ very happy to answer any questions you may have. Of course, patches to improve the documentation
+ are always welcome!
+ </p>
+
+ </section>
+
<section name="Overview">
<p>
MINA (Multipurpose Infrastructure for Network Applications) is a
@@ -38,8 +53,8 @@
<p>
<ul>
<li><a href="apidocs/index.html">JavaDocs</a></li>
- <li><a href="http://svn.apache.org/viewcvs.cgi/directory/trunks/mina/examples/src/main/java/org/apache/mina/examples/">Examples</a></li>
- <li><a href="http://svn.apache.org/viewcvs.cgi/directory/trunks/mina/">Source code</a></li>
+ <li><a href="http://svn.apache.org/viewvc/directory/branches/mina/1.0/example/src/main/java/org/apache/mina/example/">Examples (1.0 branch)</a></li>
+ <li><a href="http://svn.apache.org/viewvc/directory/branches/mina/1.0/">Source code (1.0 branch)</a></li>
</ul>
</p>
</section>