Repository: mina Updated Branches: refs/heads/2.0 80af8c368 -> 27abeb33f
Updated the Javadoc Project: http://git-wip-us.apache.org/repos/asf/mina/repo Commit: http://git-wip-us.apache.org/repos/asf/mina/commit/27abeb33 Tree: http://git-wip-us.apache.org/repos/asf/mina/tree/27abeb33 Diff: http://git-wip-us.apache.org/repos/asf/mina/diff/27abeb33 Branch: refs/heads/2.0 Commit: 27abeb33f3e713f6f733905aff7a6281f6e8e7e8 Parents: 80af8c3 Author: Emmanuel Lécharny <[email protected]> Authored: Sat Oct 11 08:33:59 2014 +0200 Committer: Emmanuel Lécharny <[email protected]> Committed: Sat Oct 11 08:33:59 2014 +0200 ---------------------------------------------------------------------- .../apache/mina/core/filterchain/IoFilter.java | 86 ++++++++++++++++++-- .../mina/core/filterchain/IoFilterAdapter.java | 3 + 2 files changed, 81 insertions(+), 8 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/mina/blob/27abeb33/mina-core/src/main/java/org/apache/mina/core/filterchain/IoFilter.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/core/filterchain/IoFilter.java b/mina-core/src/main/java/org/apache/mina/core/filterchain/IoFilter.java index e04ec38..c0b335a 100644 --- a/mina-core/src/main/java/org/apache/mina/core/filterchain/IoFilter.java +++ b/mina-core/src/main/java/org/apache/mina/core/filterchain/IoFilter.java @@ -147,52 +147,122 @@ public interface IoFilter { /** * Filters {@link IoHandler#sessionCreated(IoSession)} event. + * + * @param nextFilter + * the {@link NextFilter} for this filter. You can reuse this + * object until this filter is removed from the chain. + * @param session + * The {@link IoSession} which has received this event */ void sessionCreated(NextFilter nextFilter, IoSession session) throws Exception; /** * Filters {@link IoHandler#sessionOpened(IoSession)} event. + * + * @param nextFilter + * the {@link NextFilter} for this filter. You can reuse this + * object until this filter is removed from the chain. + * @param session + * The {@link IoSession} which has received this event */ void sessionOpened(NextFilter nextFilter, IoSession session) throws Exception; /** * Filters {@link IoHandler#sessionClosed(IoSession)} event. + * + * @param nextFilter + * the {@link NextFilter} for this filter. You can reuse this + * object until this filter is removed from the chain. + * @param session + * The {@link IoSession} which has received this event */ void sessionClosed(NextFilter nextFilter, IoSession session) throws Exception; /** - * Filters {@link IoHandler#sessionIdle(IoSession,IdleStatus)} - * event. + * Filters {@link IoHandler#sessionIdle(IoSession,IdleStatus)} event. + * + * @param nextFilter + * the {@link NextFilter} for this filter. You can reuse this + * object until this filter is removed from the chain. + * @param session + * The {@link IoSession} which has received this event + * @param status + * The {@link IdleStatus} type */ void sessionIdle(NextFilter nextFilter, IoSession session, IdleStatus status) throws Exception; /** - * Filters {@link IoHandler#exceptionCaught(IoSession,Throwable)} - * event. + * Filters {@link IoHandler#exceptionCaught(IoSession,Throwable)} event. + * + * @param nextFilter + * the {@link NextFilter} for this filter. You can reuse this + * object until this filter is removed from the chain. + * @param session + * The {@link IoSession} which has received this event + * @param cause + * The exception that cause this event to be received */ void exceptionCaught(NextFilter nextFilter, IoSession session, Throwable cause) throws Exception; + /** + * Filters {@link IoHandler#inputClosed(IoSession)} event. + * + * @param nextFilter + * the {@link NextFilter} for this filter. You can reuse this + * object until this filter is removed from the chain. + * @param session + * The {@link IoSession} which has received this event + */ void inputClosed(NextFilter nextFilter, IoSession session) throws Exception; /** - * Filters {@link IoHandler#messageReceived(IoSession,Object)} - * event. + * Filters {@link IoHandler#messageReceived(IoSession,Object)} event. + * + * @param nextFilter + * the {@link NextFilter} for this filter. You can reuse this + * object until this filter is removed from the chain. + * @param session + * The {@link IoSession} which has received this event + * @param message + * The received message */ void messageReceived(NextFilter nextFilter, IoSession session, Object message) throws Exception; /** - * Filters {@link IoHandler#messageSent(IoSession,Object)} - * event. + * Filters {@link IoHandler#messageSent(IoSession,Object)} event. + * + * @param nextFilter + * the {@link NextFilter} for this filter. You can reuse this + * object until this filter is removed from the chain. + * @param session + * The {@link IoSession} which has received this event + * @param writeRequest + * The {@link WriteRequest} that contains the sent message */ void messageSent(NextFilter nextFilter, IoSession session, WriteRequest writeRequest) throws Exception; /** * Filters {@link IoSession#close()} method invocation. + * + * @param nextFilter + * the {@link NextFilter} for this filter. You can reuse this + * object until this filter is removed from the chain. + * @param session + * The {@link IoSession} which has to process this method + * invocation */ void filterClose(NextFilter nextFilter, IoSession session) throws Exception; /** * Filters {@link IoSession#write(Object)} method invocation. + * + * @param nextFilter + * the {@link NextFilter} for this filter. You can reuse this + * object until this filter is removed from the chain. + * @param session + * The {@link IoSession} which has to process this invocation + * @param writeRequest + * The {@link WriteRequest} to process */ void filterWrite(NextFilter nextFilter, IoSession session, WriteRequest writeRequest) throws Exception; http://git-wip-us.apache.org/repos/asf/mina/blob/27abeb33/mina-core/src/main/java/org/apache/mina/core/filterchain/IoFilterAdapter.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/core/filterchain/IoFilterAdapter.java b/mina-core/src/main/java/org/apache/mina/core/filterchain/IoFilterAdapter.java index 39c5508..2324b55 100644 --- a/mina-core/src/main/java/org/apache/mina/core/filterchain/IoFilterAdapter.java +++ b/mina-core/src/main/java/org/apache/mina/core/filterchain/IoFilterAdapter.java @@ -130,6 +130,9 @@ public class IoFilterAdapter implements IoFilter { nextFilter.filterClose(session); } + /** + * {@inheritDoc} + */ public void inputClosed(NextFilter nextFilter, IoSession session) throws Exception { nextFilter.inputClosed(session); }
