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  import org.apache.mina.common.WriteFuture;
23  
24  /**
25   * Tells {@link WriteThrottleFilter} what to do when there are too many
26   * scheduled write requests in the session buffer.
27   * 
28   * @author The Apache MINA Project (dev@mina.apache.org)
29   * @version $Rev: 593474 $, $Date: 2007-11-09 03:14:12 -0700 (Fri, 09 Nov 2007) $
30   */
31  public enum WriteThrottlePolicy {
32      /**
33       * Do nothing; disables the filter.
34       */
35      OFF,
36      /**
37       * Log a warning message, but doesn't limit anything.
38       * The warning message is logged at most every 3 seconds to avoid
39       * log flooding.
40       */
41      LOG,
42      /**
43       * Block the write operation until the size of write request buffer
44       * is full.  You must use this policy in conjunction with the
45       * {@link WriteThrottleFilter} to prevent the
46       * {@link OutOfMemoryError} on the reader side.
47       */
48      BLOCK,
49      /**
50       * Make the write operation fail immediately.
51       * The '{@link WriteFuture#getException() exception}' property of
52       * the returned {@link WriteFuture} will be {@link WriteFloodException}.
53       * The exception will also be notified as an <tt>exceptionCaught</tt>
54       * event.
55       */
56      FAIL,
57  }