org.aoju.bus.socket.origin.StateMachine Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of bus-socket Show documentation
Bus Socket
There is a newer version: 8.0.0
/*
 * The MIT License
 *
 * Copyright (c) 2017 aoju.org All rights reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package org.aoju.bus.socket.origin;

import java.nio.ByteBuffer;

/**
 * 列举了当前所关注的各类状态枚举。
 * 
 * 当前枚举的各状态机事件在发生后都会及时触发{@link Message#stateEvent(AioSession, StateMachine, Throwable)}方法。因此用户在实现的{@linkplain Message}接口中可对自己关心的状态机事件进行处理。
 *
 * @author Kimi Liu
 * @version 5.0.8
 * @since JDK 1.8+
 */
public enum StateMachine {

    /**
     * 连接已建立并构建Session对象
     */
    NEW_SESSION,
    /**
     * 读通道已被关闭
     * 通常由以下几种情况会触发该状态：
     * 

     * 对端主动关闭write通道，致使本通常满足了EOF条件
     * 当前AioSession处理完读操作后检测到自身正处于{@link StateMachine#SESSION_CLOSING}状态
     * 
     *
     * 未来该状态机可能会废除，并转移至NetMonitor
     */
    INPUT_SHUTDOWN,
    /**
     * 业务处理异常。
     * 执行{@link Message#process(AioSession, Object)}期间发生用户未捕获的异常。
     */
    PROCESS_EXCEPTION,

    /**
     * 协议解码异常
     * 执行{@link Protocol#decode(ByteBuffer, AioSession)}期间发生未捕获的异常。
     */
    DECODE_EXCEPTION,
    /**
     * 读操作异常
     * 在底层服务执行read操作期间因发生异常情况出发了{@link java.nio.channels.CompletionHandler#failed(Throwable, Object)}
     * 未来该状态机可能会废除，并转移至NetMonitor
     */
    INPUT_EXCEPTION,
    /**
     * 写操作异常。
     * 在底层服务执行write操作期间因发生异常情况出发了{@link java.nio.channels.CompletionHandler#failed(Throwable, Object)}
     * 未来该状态机可能会废除，并转移至NetMonitor
     */
    OUTPUT_EXCEPTION,
    /**
     * 会话正在关闭中
     * 执行了{@link AioSession#close(boolean)}方法，并且当前还存在待输出的数据
     */
    SESSION_CLOSING,
    /**
     * 会话关闭成功。
     * AioSession关闭成功
     */
    SESSION_CLOSED,

    /**
     * 拒绝接受连接,仅Server端有效
     */
    REJECT_ACCEPT

}