Return-Path: Delivered-To: apmail-directory-commits-archive@www.apache.org Received: (qmail 54445 invoked from network); 1 Dec 2005 02:57:26 -0000 Received: from hermes.apache.org (HELO mail.apache.org) (209.237.227.199) by minotaur.apache.org with SMTP; 1 Dec 2005 02:57:26 -0000 Received: (qmail 86265 invoked by uid 500); 1 Dec 2005 02:57:25 -0000 Delivered-To: apmail-directory-commits-archive@directory.apache.org Received: (qmail 86231 invoked by uid 500); 1 Dec 2005 02:57:25 -0000 Mailing-List: contact commits-help@directory.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@directory.apache.org Delivered-To: mailing list commits@directory.apache.org Received: (qmail 86220 invoked by uid 99); 1 Dec 2005 02:57:25 -0000 Received: from asf.osuosl.org (HELO asf.osuosl.org) (140.211.166.49) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 30 Nov 2005 18:57:25 -0800 X-ASF-Spam-Status: No, hits=-9.4 required=10.0 tests=ALL_TRUSTED,NO_REAL_NAME X-Spam-Check-By: apache.org Received: from [209.237.227.194] (HELO minotaur.apache.org) (209.237.227.194) by apache.org (qpsmtpd/0.29) with SMTP; Wed, 30 Nov 2005 18:58:54 -0800 Received: (qmail 54203 invoked by uid 65534); 1 Dec 2005 02:57:04 -0000 Message-ID: <20051201025704.54202.qmail@minotaur.apache.org> Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r350119 - /directory/network/branches/chain_refactor/src/java/org/apache/mina/common/IoFilter.java Date: Thu, 01 Dec 2005 02:57:03 -0000 To: commits@directory.apache.org From: trustin@apache.org X-Mailer: svnmailer-1.0.5 X-Virus-Checked: Checked by ClamAV on apache.org X-Spam-Rating: minotaur.apache.org 1.6.2 0/1000/N Author: trustin Date: Wed Nov 30 18:57:01 2005 New Revision: 350119 URL: http://svn.apache.org/viewcvs?rev=350119&view=rev Log: Added description on IoFilter life cycle. Modified: directory/network/branches/chain_refactor/src/java/org/apache/mina/common/IoFilter.java Modified: directory/network/branches/chain_refactor/src/java/org/apache/mina/common/IoFilter.java URL: http://svn.apache.org/viewcvs/directory/network/branches/chain_refactor/src/java/org/apache/mina/common/IoFilter.java?rev=350119&r1=350118&r2=350119&view=diff ============================================================================== --- directory/network/branches/chain_refactor/src/java/org/apache/mina/common/IoFilter.java (original) +++ directory/network/branches/chain_refactor/src/java/org/apache/mina/common/IoFilter.java Wed Nov 30 18:57:01 2005 @@ -36,6 +36,29 @@ * {@link IoSession}s. Users can cache the reference to the * session, which might malfunction if any filters are added or removed later. * + *

The Life Cycle

+ * When you add an {@link IoFilter} to an {@link IoFilterChain}: + *
    + *
  1. {@link #init()} is invoked by {@link IoFilterChain} if the filter is + * added at the first time.
    2. + *
  2. The filter is added to the chain, and all events and I/O requests + * pass through the filter from now.
    3. + *
  3. {@link #onAdd(IoFilterChain, String, NextFilter)} is invoked to notify + * that the filter is added to the chain.
    4. + *
  4. The filter is removed from the chain if {@link #onAdd(IoFilterChain, String, org.apache.mina.common.IoFilter.NextFilter)} + * threw an exception. {@link #destroy()} is also invoked if the filter + * is the last filter which was added to {@link IoFilterChain}s.
    5. + *
+ * + * When you remove an {@link IoFilter} from an {@link IoFilterChain}: + *
    + *
  1. The filter is removed from the chain, and any events and I/O requests + * don't pass through the filter from now.
    2. + *
  2. {@link #onRemove(IoFilterChain, String, NextFilter)} is invoked to + * notify that the filter is removed from the chain.
    3. + *
  3. {@link #destroy()} is invoked if the removed filter was the last one.
    4. + *
+ * * @author The Apache Directory Project (dev@directory.apache.org) * @version $Rev$, $Date$ *