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.keepalive;
21  
22  
23  
24  /**
25   * Tells {@link KeepAliveFilter} what to do when a keep-alive response message
26   * was not received within a certain timeout.
27   * 
28   * @author The Apache MINA Project (dev@mina.apache.org)
29   * @version $Rev: 594745 $, $Date: 2007-11-13 20:51:36 -0700 (Tue, 13 Nov 2007) $
30   */
31  public enum KeepAlivePolicy {
32      /**
33       * Do nothing; disables the filter.
34       */
35      OFF,
36      /**
37       * Log a warning message, but doesn't do anything else.
38       */
39      LOG,
40      /**
41       * Throw a {@link KeepAliveTimeoutException}.
42       */
43      EXCEPTION,
44      /**
45       * Close the connection.
46       */
47      CLOSE,
48  }