100 lines
4.4 KiB
Java
100 lines
4.4 KiB
Java
/*
|
|
* 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;
|
|
|
|
import java.net.SocketAddress;
|
|
|
|
/**
|
|
* {@link ChannelHandler} which will get notified for IO-outbound-operations.
|
|
*/
|
|
public interface ChannelOutboundHandler extends ChannelHandler {
|
|
/**
|
|
* Called once a bind operation is made.
|
|
*
|
|
* @param ctx the {@link ChannelHandlerContext} for which the bind operation is made
|
|
* @param localAddress the {@link SocketAddress} to which it should bound
|
|
* @param promise the {@link ChannelPromise} to notify once the operation completes
|
|
* @throws Exception thrown if an error occurs
|
|
*/
|
|
void bind(ChannelHandlerContext ctx, SocketAddress localAddress, ChannelPromise promise) throws Exception;
|
|
|
|
/**
|
|
* Called once a connect operation is made.
|
|
*
|
|
* @param ctx the {@link ChannelHandlerContext} for which the connect operation is made
|
|
* @param remoteAddress the {@link SocketAddress} to which it should connect
|
|
* @param localAddress the {@link SocketAddress} which is used as source on connect
|
|
* @param promise the {@link ChannelPromise} to notify once the operation completes
|
|
* @throws Exception thrown if an error occurs
|
|
*/
|
|
void connect(
|
|
ChannelHandlerContext ctx, SocketAddress remoteAddress,
|
|
SocketAddress localAddress, ChannelPromise promise) throws Exception;
|
|
|
|
/**
|
|
* Called once a disconnect operation is made.
|
|
*
|
|
* @param ctx the {@link ChannelHandlerContext} for which the disconnect operation is made
|
|
* @param promise the {@link ChannelPromise} to notify once the operation completes
|
|
* @throws Exception thrown if an error occurs
|
|
*/
|
|
void disconnect(ChannelHandlerContext ctx, ChannelPromise promise) throws Exception;
|
|
|
|
/**
|
|
* Called once a close operation is made.
|
|
*
|
|
* @param ctx the {@link ChannelHandlerContext} for which the close operation is made
|
|
* @param promise the {@link ChannelPromise} to notify once the operation completes
|
|
* @throws Exception thrown if an error occurs
|
|
*/
|
|
void close(ChannelHandlerContext ctx, ChannelPromise promise) throws Exception;
|
|
|
|
/**
|
|
* Called once a deregister operation is made from the current registered {@link EventLoop}.
|
|
*
|
|
* @param ctx the {@link ChannelHandlerContext} for which the close operation is made
|
|
* @param promise the {@link ChannelPromise} to notify once the operation completes
|
|
* @throws Exception thrown if an error occurs
|
|
*/
|
|
void deregister(ChannelHandlerContext ctx, ChannelPromise promise) throws Exception;
|
|
|
|
/**
|
|
* Intercepts {@link ChannelHandlerContext#read()}.
|
|
*/
|
|
void read(ChannelHandlerContext ctx) throws Exception;
|
|
|
|
/**
|
|
* Called once a write operation is made. The write operation will write the messages through the
|
|
* {@link ChannelPipeline}. Those are then ready to be flushed to the actual {@link Channel} once
|
|
* {@link Channel#flush()} is called
|
|
*
|
|
* @param ctx the {@link ChannelHandlerContext} for which the write operation is made
|
|
* @param msg the message to write
|
|
* @param promise the {@link ChannelPromise} to notify once the operation completes
|
|
* @throws Exception thrown if an error occurs
|
|
*/
|
|
void write(ChannelHandlerContext ctx, Object msg, ChannelPromise promise) throws Exception;
|
|
|
|
/**
|
|
* Called once a flush operation is made. The flush operation will try to flush out all previous written messages
|
|
* that are pending.
|
|
*
|
|
* @param ctx the {@link ChannelHandlerContext} for which the flush operation is made
|
|
* @throws Exception thrown if an error occurs
|
|
*/
|
|
void flush(ChannelHandlerContext ctx) throws Exception;
|
|
}
|