View Javadoc

1   /*
2    *  Licensed to the Apache Software Foundation (ASF) under one
3    *  or more contributor license agreements.  See the NOTICE file
4    *  distributed with this work for additional information
5    *  regarding copyright ownership.  The ASF licenses this file
6    *  to you under the Apache License, Version 2.0 (the
7    *  "License"); you may not use this file except in compliance
8    *  with the License.  You may obtain a copy of the License at
9    *
10   *    http://www.apache.org/licenses/LICENSE-2.0
11   *
12   *  Unless required by applicable law or agreed to in writing,
13   *  software distributed under the License is distributed on an
14   *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   *  KIND, either express or implied.  See the License for the
16   *  specific language governing permissions and limitations
17   *  under the License.
18   *
19   */
20  package org.apache.mina.filter.traffic;
21  
22  /**
23   * A tagging interface for identifying {@link ReadFloodException}
24   * and {@link WriteFloodException}; It's not really an exception.
25   * <p>
26   * This interface is useful when you want to do something if either
27   * reader or writer side is flooded:
28   * <pre><code>
29   * if (exception instanceof IoFloodException) {
30   *     session.close();
31   * }
32   * </code></pre>
33   * which is a way simpler than:
34   * <pre><code>
35   * if (exception instanceof ReadFloodException ||
36   *     exception instanceof WriteFloodException) {
37   *     
38   *     session.close();
39   * }
40   * </code></pre>
41   * @author The Apache MINA Project (dev@mina.apache.org)
42   * @version $Rev: 591600 $, $Date: 2007-11-03 05:32:13 -0600 (Sat, 03 Nov 2007) $
43   */
44  public interface IoFloodException {
45  }