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.api;
21
22 /**
23 * Represents the type of idleness of {@link IoSession}.
24 * There are three types of idleness:
25 * <ul>
26 * <li>{@link #READ_IDLE} - No data is coming from the remote peer.</li>
27 * <li>{@link #WRITE_IDLE} - Session is not writing any data.</li>
28 * </ul>
29 *
30 * @author <a href="http://mina.apache.org">Apache MINA Project</a>
31 */
32 public enum IdleStatus {
33 READ_IDLE("read idle"), WRITE_IDLE("write idle");
34
35 private final String description;
36
37 IdleStatus(String description) {
38 this.description = description;
39 }
40
41 /**
42 * Returns the string representation of this status.
43 */
44 @Override
45 public String toString() {
46 return description;
47 }
48 }