org.littleshoot.mina.common.IdleStatus Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*
*/
package org.littleshoot.mina.common;
/**
* Represents the type of idleness of {@link IoSession} or
* {@link IoSession}. There are three types of idleness:
*
* - {@link #READER_IDLE} - No data is coming from the remote peer.
* - {@link #WRITER_IDLE} - Session is not writing any data.
* - {@link #BOTH_IDLE} - Both {@link #READER_IDLE} and {@link #WRITER_IDLE}.
*
*
* Idle time settings are all disabled by default. You can enable them
* using {@link IoSession#setIdleTime(IdleStatus,int)}.
*
* @author The Apache Directory Project ([email protected])
* @version $Rev: 555855 $, $Date: 2007-07-13 12:19:00 +0900 (Fri, 13 Jul 2007) $
*/
public class IdleStatus {
/**
* Represents the session status that no data is coming from the remote
* peer.
*/
public static final IdleStatus READER_IDLE = new IdleStatus("reader idle");
/**
* Represents the session status that the session is not writing any data.
*/
public static final IdleStatus WRITER_IDLE = new IdleStatus("writer idle");
/**
* Represents both {@link #READER_IDLE} and {@link #WRITER_IDLE}.
*/
public static final IdleStatus BOTH_IDLE = new IdleStatus("both idle");
private final String strValue;
/**
* Creates a new instance.
*/
private IdleStatus(String strValue) {
this.strValue = strValue;
}
/**
* Returns the string representation of this status.
*
* - {@link #READER_IDLE} - "reader idle"
* - {@link #WRITER_IDLE} - "writer idle"
* - {@link #BOTH_IDLE} - "both idle"
*
*/
public String toString() {
return strValue;
}
}