You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mina.apache.org by mw...@apache.org on 2007/10/01 01:47:13 UTC

svn commit: r580812 - /mina/trunk/core/src/main/java/org/apache/mina/common/IoService.java

Author: mwebb
Date: Sun Sep 30 16:47:12 2007
New Revision: 580812

URL: http://svn.apache.org/viewvc?rev=580812&view=rev
Log:
Added javadoc information

Modified:
    mina/trunk/core/src/main/java/org/apache/mina/common/IoService.java

Modified: mina/trunk/core/src/main/java/org/apache/mina/common/IoService.java
URL: http://svn.apache.org/viewvc/mina/trunk/core/src/main/java/org/apache/mina/common/IoService.java?rev=580812&r1=580811&r2=580812&view=diff
==============================================================================
--- mina/trunk/core/src/main/java/org/apache/mina/common/IoService.java (original)
+++ mina/trunk/core/src/main/java/org/apache/mina/common/IoService.java Sun Sep 30 16:47:12 2007
@@ -102,20 +102,69 @@
      */
     DefaultIoFilterChainBuilder getFilterChain();
     
+    /**
+     * Returns a value of whether or not this service is active
+     * 
+     * @return
+     * 	whether of not the service is active.
+     */
     boolean isActive();
     
+    /**
+     * Returns the time when this service was activated.  Should return
+     * zero if the service has not been activated.  
+     * 
+     * @return
+     * 	The time by using <code>System.currentTimeMillis()</code>
+     */
     long getActivationTime();
     
+    /**
+     * Returns the number of bytes read by this service
+     * 
+     * @return
+     * 	The number of bytes this service has read
+     */
     long getReadBytes();
     
+    /**
+     * Returns the number of bytes written out by this service
+     * 
+     * @return
+     * 	The number of bytes this service has written
+     */
     long getWrittenBytes();
     
+    /**
+     * Returns the number of messages this services has read
+     * 
+     * @return
+     * 	The number of messages this services has read
+     */
     long getReadMessages();
     
+    /**
+     * Returns the number of messages this service has written
+     * 
+     * @return
+     * 	The number of messages this service has written
+     */
     long getWrittenMessages();
     
+    /**
+     * Returns the number of bytes scheduled to be written
+     * 
+     * @return
+     * 	The number of bytes scheduled to be written
+     */
     long getScheduledWriteBytes();
     
+    /**
+     * Returns the number of messages scheduled to be written
+     * 
+     * @return
+     * 	The number of messages scheduled to be written
+     */
     long getScheduledWriteMessages();
     
 }



Re: svn commit: r580812 - /mina/trunk/core/src/main/java/org/apache/mina/common/IoService.java

Posted by Trustin Lee <tr...@gmail.com>.
Thank you very much for adding documentation.  I had to do this when I add them.

Regards,
Trustin

On 10/1/07, mwebb@apache.org <mw...@apache.org> wrote:
> Author: mwebb
> Date: Sun Sep 30 16:47:12 2007
> New Revision: 580812
>
> URL: http://svn.apache.org/viewvc?rev=580812&view=rev
> Log:
> Added javadoc information
>
> Modified:
>     mina/trunk/core/src/main/java/org/apache/mina/common/IoService.java
>
> Modified: mina/trunk/core/src/main/java/org/apache/mina/common/IoService.java
> URL: http://svn.apache.org/viewvc/mina/trunk/core/src/main/java/org/apache/mina/common/IoService.java?rev=580812&r1=580811&r2=580812&view=diff
> ==============================================================================
> --- mina/trunk/core/src/main/java/org/apache/mina/common/IoService.java (original)
> +++ mina/trunk/core/src/main/java/org/apache/mina/common/IoService.java Sun Sep 30 16:47:12 2007
> @@ -102,20 +102,69 @@
>       */
>      DefaultIoFilterChainBuilder getFilterChain();
>
> +    /**
> +     * Returns a value of whether or not this service is active
> +     *
> +     * @return
> +     *         whether of not the service is active.
> +     */
>      boolean isActive();
>
> +    /**
> +     * Returns the time when this service was activated.  Should return
> +     * zero if the service has not been activated.
> +     *
> +     * @return
> +     *         The time by using <code>System.currentTimeMillis()</code>
> +     */
>      long getActivationTime();
>
> +    /**
> +     * Returns the number of bytes read by this service
> +     *
> +     * @return
> +     *         The number of bytes this service has read
> +     */
>      long getReadBytes();
>
> +    /**
> +     * Returns the number of bytes written out by this service
> +     *
> +     * @return
> +     *         The number of bytes this service has written
> +     */
>      long getWrittenBytes();
>
> +    /**
> +     * Returns the number of messages this services has read
> +     *
> +     * @return
> +     *         The number of messages this services has read
> +     */
>      long getReadMessages();
>
> +    /**
> +     * Returns the number of messages this service has written
> +     *
> +     * @return
> +     *         The number of messages this service has written
> +     */
>      long getWrittenMessages();
>
> +    /**
> +     * Returns the number of bytes scheduled to be written
> +     *
> +     * @return
> +     *         The number of bytes scheduled to be written
> +     */
>      long getScheduledWriteBytes();
>
> +    /**
> +     * Returns the number of messages scheduled to be written
> +     *
> +     * @return
> +     *         The number of messages scheduled to be written
> +     */
>      long getScheduledWriteMessages();
>
>  }
>
>
>


-- 
what we call human nature is actually human habit
--
http://gleamynode.net/
--
PGP Key ID: 0x0255ECA6