svn commit: r811618 - /httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/nio/reactor/ListeningIOReactor.java

[ol...@apache.org]

Author: olegk
Date: Sat Sep  5 10:43:07 2009
New Revision: 811618

URL: http://svn.apache.org/viewvc?rev=811618&view=rev
Log:
Javadoc improvement

Modified:
    httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/nio/reactor/ListeningIOReactor.java

Modified: httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/nio/reactor/ListeningIOReactor.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/nio/reactor/ListeningIOReactor.java?rev=811618&r1=811617&r2=811618&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/nio/reactor/ListeningIOReactor.java (original)
+++ httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/nio/reactor/ListeningIOReactor.java Sat Sep  5 10:43:07 2009
@@ -44,6 +44,12 @@
      * the endpoint is fully initialized it starts accepting incoming 
      * connections and propagates I/O activity notifications to the I/O event
      * dispatcher. 
+     * <p>
+     * {@link ListenerEndpoint#waitFor()} can be used to wait for the
+     *  listener to be come ready to accept incoming connections.
+     * <p>
+     * {@link ListenerEndpoint#close()} can be used to shut down 
+     * the listener even before it is fully initialized.
      * 
      * @param address the socket address to listen on.
      * @return listener endpoint.