Documentation error in IoHandler
--------------------------------

                 Key: DIRMINA-413
                 URL: https://issues.apache.org/jira/browse/DIRMINA-413
             Project: MINA
          Issue Type: Bug
          Components: Web Site / Documentation
    Affects Versions: 1.1.1, 1.0.4, 1.1.0, 1.0.3, 1.0.2, 1.0.1, 1.0.0
            Reporter: Trustin Lee
             Fix For: 1.0.5, 1.1.2


The following JavaDoc is somewhat incorrect and doesn't contain all the 
information about each event types.

    /**
     * Invoked when the session is created.  Initialize default socket
     * parameters and user-defined attributes here.
     */
    void sessionCreated(IoSession session) throws Exception;

    /**
     * Invoked when the connection is opened.  This method is not invoked if the
     * transport type is UDP.
     */
    void sessionOpened(IoSession session) throws Exception;

    /**
     * Invoked when the connection is closed.  This method is not invoked if the
     * transport type is UDP.
     */
    void sessionClosed(IoSession session) throws Exception;

    /**
     * Invoked when the connection is idle.  Refer to [EMAIL PROTECTED] 
IdleStatus}.  This
     * method is not invoked if the transport type is UDP.
     */
    void sessionIdle(IoSession session, IdleStatus status) throws Exception;

* sessionOpened and sessionClosed are invoked for UDP since 1.0.
* There's a known bug that sessionIdle is not invoked for UDP.  We need to 
explicitly explain that it will be fixed in 2.0.
* It must be explicitly specified that sessionCreated runs in the same thread 
with the I/O processor thread.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.

Reply via email to