[DIRMINA-413] Documentation error in IoHandler

• Type: Bug
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 1.0.0, 1.0.1, 1.0.2, 1.0.3, 1.1.0, 1.0.4, 1.1.1
• Fix Version/s: 1.0.5, 1.1.2
• Component/s: Web Site / Documentation
• Assignee: Trustin Lee
• Reporter: Trustin Lee
• Created: 31/Jul/07 07:28
• Updated: 03/Aug/07 05:54
• Resolved: 03/Aug/07 05:54

Description

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 {@link 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.