64 lines
2.5 KiB
Java
Executable File
64 lines
2.5 KiB
Java
Executable File
/*
|
|
* Copyright 2012 The Netty Project
|
|
*
|
|
* The Netty Project 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 io.netty.channel;
|
|
|
|
/**
|
|
* {@link ChannelHandler} which adds callbacks for state changes. This allows the user
|
|
* to hook in to state changes easily.
|
|
*/
|
|
public interface ChannelStateHandler extends ChannelHandler {
|
|
|
|
/**
|
|
* The {@link Channel} of the {@link ChannelHandlerContext} was registered with its {@link EventLoop}
|
|
*/
|
|
void channelRegistered(ChannelHandlerContext ctx) throws Exception;
|
|
|
|
/**
|
|
* The {@link Channel} of the {@link ChannelHandlerContext} was unregistered from its {@link EventLoop}
|
|
*/
|
|
void channelUnregistered(ChannelHandlerContext ctx) throws Exception;
|
|
|
|
/**
|
|
* The {@link Channel} of the {@link ChannelHandlerContext} is now active
|
|
*/
|
|
void channelActive(ChannelHandlerContext ctx) throws Exception;
|
|
|
|
/**
|
|
* The {@link Channel} of the {@link ChannelHandlerContext} was registered is now inactive and reached its
|
|
* end of lifetime.
|
|
*/
|
|
void channelInactive(ChannelHandlerContext ctx) throws Exception;
|
|
|
|
/**
|
|
* Invoked when a {@link ChannelHandlerContext#read()} is finished and the inbound buffer of this handler will not
|
|
* be updated until another {@link ChannelHandlerContext#read()} request is issued.
|
|
*/
|
|
void channelReadSuspended(ChannelHandlerContext ctx) throws Exception;
|
|
|
|
/**
|
|
* The inbound buffer of the {@link ChannelHandlerContext} was updated with new data.
|
|
* This means something may be ready to get processed by the actual {@link ChannelStateHandler}
|
|
* implementation. It's up to the implementation to consume it or keep it in the buffer
|
|
* to wait for more data and consume it later.
|
|
*/
|
|
void inboundBufferUpdated(ChannelHandlerContext ctx) throws Exception;
|
|
|
|
/**
|
|
* Gets called if an user event was triggered.
|
|
*/
|
|
void userEventTriggered(ChannelHandlerContext ctx, Object evt) throws Exception;
|
|
}
|