ad922fa47e
Motivation:
41e03adf24 marked ChannelHandler.exceptionCaught(...) as @deprecated but missed to also mark ChannelHandlerAdapter.exceptionCaught(...) as @deprecated. We should do so as most people extend the base classes and not implement the interfaces directly.
Modifications:
Mark ChannelHandlerAdapter.exceptionCaught(...) as @deprecated as well.
Result:
Mark method as @deprecated to warn users about its removal.
93 lines
3.1 KiB
Java
93 lines
3.1 KiB
Java
/*
|
|
* Copyright 2013 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 io.netty.util.internal.InternalThreadLocalMap;
|
|
|
|
import java.util.Map;
|
|
|
|
/**
|
|
* Skeleton implementation of a {@link ChannelHandler}.
|
|
*/
|
|
public abstract class ChannelHandlerAdapter implements ChannelHandler {
|
|
|
|
// Not using volatile because it's used only for a sanity check.
|
|
boolean added;
|
|
|
|
/**
|
|
* Throws {@link IllegalStateException} if {@link ChannelHandlerAdapter#isSharable()} returns {@code true}
|
|
*/
|
|
protected void ensureNotSharable() {
|
|
if (isSharable()) {
|
|
throw new IllegalStateException("ChannelHandler " + getClass().getName() + " is not allowed to be shared");
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Return {@code true} if the implementation is {@link Sharable} and so can be added
|
|
* to different {@link ChannelPipeline}s.
|
|
*/
|
|
public boolean isSharable() {
|
|
/**
|
|
* Cache the result of {@link Sharable} annotation detection to workaround a condition. We use a
|
|
* {@link ThreadLocal} and {@link WeakHashMap} to eliminate the volatile write/reads. Using different
|
|
* {@link WeakHashMap} instances per {@link Thread} is good enough for us and the number of
|
|
* {@link Thread}s are quite limited anyway.
|
|
*
|
|
* See <a href="https://github.com/netty/netty/issues/2289">#2289</a>.
|
|
*/
|
|
Class<?> clazz = getClass();
|
|
Map<Class<?>, Boolean> cache = InternalThreadLocalMap.get().handlerSharableCache();
|
|
Boolean sharable = cache.get(clazz);
|
|
if (sharable == null) {
|
|
sharable = clazz.isAnnotationPresent(Sharable.class);
|
|
cache.put(clazz, sharable);
|
|
}
|
|
return sharable;
|
|
}
|
|
|
|
/**
|
|
* Do nothing by default, sub-classes may override this method.
|
|
*/
|
|
@Override
|
|
public void handlerAdded(ChannelHandlerContext ctx) throws Exception {
|
|
// NOOP
|
|
}
|
|
|
|
/**
|
|
* Do nothing by default, sub-classes may override this method.
|
|
*/
|
|
@Override
|
|
public void handlerRemoved(ChannelHandlerContext ctx) throws Exception {
|
|
// NOOP
|
|
}
|
|
|
|
/**
|
|
* Calls {@link ChannelHandlerContext#fireExceptionCaught(Throwable)} to forward
|
|
* to the next {@link ChannelHandler} in the {@link ChannelPipeline}.
|
|
*
|
|
* Sub-classes may override this method to change behavior.
|
|
*
|
|
* @deprecated is part of {@link ChannelInboundHandler}
|
|
*/
|
|
@Override
|
|
@Deprecated
|
|
public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception {
|
|
ctx.fireExceptionCaught(cause);
|
|
}
|
|
}
|