844362a947
Motivation:
While the default thread model provided by Netty is reasonable enough for most applications, some users might have a special requirement for the thread model. Here are a few examples:
- A user might want to invoke handlers from the caller thread directly, assuming that his or her application is completely asynchronous and does not make any invocation from non-I/O thread. In this case, the default invoker implementation will only add the overhead of checking if the current thread is an I/O thread or not.
- A user might want to invoke handlers from different threads depending on the type of events flexibly.
Modifications:
- Backport 132af3a485 which is a fix for #1912
- Add a new interface called 'ChannelHandlerInvoker' that performs the invocation of event handler methods.
- Add pipeline manipulation methods that accept ChannelHandlerInvoker
- The differences from the original commit:
- Separated the irrelevant changes out
- Channel.eventLoop is null until the registration is complete in this branch, so Channel.Unsafe.invoker() doesn't work before registration.
- Deregistration is not gone in this branch, so the methods related with deregistration were added to ChannelHandlerInvoker
82 lines
2.5 KiB
Java
82 lines
2.5 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 io.netty.util.concurrent.SingleThreadEventExecutor;
|
|
|
|
import java.util.concurrent.Executor;
|
|
import java.util.concurrent.ThreadFactory;
|
|
|
|
/**
|
|
* Abstract base class for {@link EventLoop}s that execute all its submitted tasks in a single thread.
|
|
*
|
|
*/
|
|
public abstract class SingleThreadEventLoop extends SingleThreadEventExecutor implements EventLoop {
|
|
|
|
private final ChannelHandlerInvoker invoker = new DefaultChannelHandlerInvoker(this);
|
|
|
|
protected SingleThreadEventLoop(EventLoopGroup parent, ThreadFactory threadFactory, boolean addTaskWakesUp) {
|
|
super(parent, threadFactory, addTaskWakesUp);
|
|
}
|
|
|
|
protected SingleThreadEventLoop(EventLoopGroup parent, Executor executor, boolean addTaskWakesUp) {
|
|
super(parent, executor, addTaskWakesUp);
|
|
}
|
|
|
|
@Override
|
|
public EventLoopGroup parent() {
|
|
return (EventLoopGroup) super.parent();
|
|
}
|
|
|
|
@Override
|
|
public EventLoop next() {
|
|
return (EventLoop) super.next();
|
|
}
|
|
|
|
@Override
|
|
public ChannelHandlerInvoker asInvoker() {
|
|
return invoker;
|
|
}
|
|
|
|
@Override
|
|
public ChannelFuture register(Channel channel) {
|
|
return register(channel, new DefaultChannelPromise(channel, this));
|
|
}
|
|
|
|
@Override
|
|
public ChannelFuture register(final Channel channel, final ChannelPromise promise) {
|
|
if (channel == null) {
|
|
throw new NullPointerException("channel");
|
|
}
|
|
if (promise == null) {
|
|
throw new NullPointerException("promise");
|
|
}
|
|
|
|
channel.unsafe().register(this, promise);
|
|
return promise;
|
|
}
|
|
|
|
@Override
|
|
protected boolean wakesUpForTask(Runnable task) {
|
|
return !(task instanceof NonWakeupRunnable);
|
|
}
|
|
|
|
/**
|
|
* Marker interface for {@link Runnable} that will not trigger an {@link #wakeup(boolean)} in all cases.
|
|
*/
|
|
interface NonWakeupRunnable extends Runnable { }
|
|
}
|