Rename method to better reflect its usage and update some javadocs. See

#187 and #140

codec/src/main/java/io/netty/handler/codec/embedder/AbstractCodecEmbedder.java

@@ -226,7 +226,7 @@ abstract class AbstractCodecEmbedder<E> implements CodecEmbedder<E> {
         }
 
         @Override
-        public void fireEventLater(ChannelPipeline pipeline, ChannelEvent e) throws Exception {
+        public void fireUpstreamEventLater(ChannelPipeline pipeline, ChannelEvent e) throws Exception {
             handleEvent(e);
         }
     }

transport-http/src/main/java/io/netty/channel/socket/http/AbstractHttpChannelSink.java

@@ -23,7 +23,7 @@ import io.netty.channel.ChannelPipeline;
 public abstract class AbstractHttpChannelSink extends AbstractChannelSink{
 
     @Override
-    public void fireEventLater(ChannelPipeline pipeline, ChannelEvent e) throws Exception {
+    public void fireUpstreamEventLater(ChannelPipeline pipeline, ChannelEvent e) throws Exception {
         pipeline.sendUpstream(e);
     }
 

transport-rxtx/src/main/java/io/netty/channel/rxtx/RxtxChannelSink.java

@@ -334,7 +334,7 @@ public class RxtxChannelSink extends AbstractChannelSink {
      * Just fire the event now by calling {@link ChannelPipeline#sendUpstream(ChannelEvent)} as this implementation does not support it otherwise
      */
     @Override
-    public void fireEventLater(ChannelPipeline pipeline, ChannelEvent event) throws Exception {
+    public void fireUpstreamEventLater(ChannelPipeline pipeline, ChannelEvent event) throws Exception {
         pipeline.sendUpstream(event);
     }
 }

transport-sctp/src/main/java/io/netty/channel/sctp/AbstractScptChannelSink.java

@@ -24,13 +24,13 @@ import io.netty.channel.ChannelPipeline;
 public abstract class AbstractScptChannelSink extends AbstractChannelSink{
 
     @Override
-    public void fireEventLater(final ChannelPipeline pipeline, final ChannelEvent e) throws Exception {
+    public void fireUpstreamEventLater(final ChannelPipeline pipeline, final ChannelEvent e) throws Exception {
         Channel ch = e.getChannel();
         if (ch instanceof SctpChannelImpl) {
             SctpChannelImpl channel = (SctpChannelImpl) ch;
             // check if the current thread is a worker thread, and only fire the event later if thats not the case
             if (channel.worker.thread != Thread.currentThread()) {
-                channel.worker.fireEventLater(new Runnable() {
+                channel.worker.executeInIoThread(new Runnable() {
                 
                     @Override
                     public void run() {

transport-sctp/src/main/java/io/netty/channel/sctp/SctpWorker.java

@@ -245,7 +245,8 @@ class SctpWorker implements Worker {
         }
     }
     
-    public void fireEventLater(Runnable eventRunnable) {
+    @Override
+    public void executeInIoThread(Runnable eventRunnable) {
        assert eventQueue.offer(eventRunnable);
        
        // wake up the selector to speed things

transport/src/main/java/io/netty/channel/ChannelSink.java

@@ -38,5 +38,8 @@ public interface ChannelSink {
      */
     void exceptionCaught(ChannelPipeline pipeline, ChannelEvent e, ChannelPipelineException cause) throws Exception;
     
-    void fireEventLater(ChannelPipeline pipeline, ChannelEvent e) throws Exception;
+    /**
+     * Schedule the given {@link ChannelEvent} for later execution (in the io-thread). Some implementation may not support his and just fire it directly
+     */
+    void fireUpstreamEventLater(ChannelPipeline pipeline, ChannelEvent e) throws Exception;
 }

transport/src/main/java/io/netty/channel/DefaultChannelPipeline.java

@@ -586,7 +586,7 @@ public class DefaultChannelPipeline implements ChannelPipeline {
     @Override
     public void sendUpstreamLater(ChannelEvent e) {
         try {
-            getSink().fireEventLater(this, e);
+            getSink().fireUpstreamEventLater(this, e);
         } catch (Throwable t) {
             notifyHandlerException(e, t);
         }
@@ -843,7 +843,7 @@ public class DefaultChannelPipeline implements ChannelPipeline {
         }
 
         @Override
-        public void fireEventLater(ChannelPipeline pipeline, ChannelEvent e) throws Exception {
+        public void fireUpstreamEventLater(ChannelPipeline pipeline, ChannelEvent e) throws Exception {
             if (logger.isWarnEnabled()) {
                 logger.warn("Not attached yet; discarding: " + e);
             }

transport/src/main/java/io/netty/channel/iostream/IoStreamChannelSink.java

@@ -182,7 +182,7 @@ public class IoStreamChannelSink extends AbstractChannelSink {
      * This just calls {@link ChannelPipeline#sendUpstream(ChannelEvent)} as the transport does not support it
      */
     @Override
-    public void fireEventLater(ChannelPipeline pipeline, ChannelEvent e) throws Exception {
+    public void fireUpstreamEventLater(ChannelPipeline pipeline, ChannelEvent e) throws Exception {
         pipeline.sendUpstream(e);
     }
 }

transport/src/main/java/io/netty/channel/local/LocalClientChannelSink.java

@@ -89,7 +89,7 @@ final class LocalClientChannelSink extends AbstractChannelSink {
      * Just fire the event now by calling {@link ChannelPipeline#sendUpstream(ChannelEvent)} as this implementation does not support it otherwise
      */
     @Override
-    public void fireEventLater(ChannelPipeline pipeline, ChannelEvent event) throws Exception {
+    public void fireUpstreamEventLater(ChannelPipeline pipeline, ChannelEvent event) throws Exception {
         pipeline.sendUpstream(event);
     }
     

transport/src/main/java/io/netty/channel/local/LocalServerChannelSink.java

@@ -46,7 +46,7 @@ final class LocalServerChannelSink extends AbstractChannelSink {
      * Just fire the event now by calling {@link ChannelPipeline#sendUpstream(ChannelEvent)} as this implementation does not support it otherwise
      */
     @Override
-    public void fireEventLater(ChannelPipeline pipeline, ChannelEvent event) throws Exception {
+    public void fireUpstreamEventLater(ChannelPipeline pipeline, ChannelEvent event) throws Exception {
         pipeline.sendUpstream(event);
     }
     

transport/src/main/java/io/netty/channel/socket/Worker.java

@@ -16,7 +16,16 @@
 
 package io.netty.channel.socket;
 
+/**
+ * A {@link Worker} is responsible to dispatch IO operations
+ *
+ */
 public interface Worker extends Runnable{
 
-    void fireEventLater(Runnable eventRunnable);
+    /**
+     * Execute the given {@link Runnable} in the IO-Thread. This may be now or later once the IO-Thread do some other work.
+     * 
+     * @param task the {@link Runnable} to execute 
+     */
+    void executeInIoThread(Runnable task);
 }

transport/src/main/java/io/netty/channel/socket/nio/AbstractNioChannelSink.java

@@ -24,13 +24,13 @@ import io.netty.channel.ChannelPipeline;
 public abstract class AbstractNioChannelSink extends AbstractChannelSink{
 
     @Override
-    public void fireEventLater(final ChannelPipeline pipeline, final ChannelEvent e) throws Exception {
+    public void fireUpstreamEventLater(final ChannelPipeline pipeline, final ChannelEvent e) throws Exception {
         Channel ch = e.getChannel();
         if (ch instanceof AbstractNioChannel<?>) {
             AbstractNioChannel<?> channel = (AbstractNioChannel<?>) ch;
             // check if the current thread is a worker thread if so we can send the event now
             if (channel.worker.thread != Thread.currentThread()) {
-                channel.worker.fireEventLater(new Runnable() {
+                channel.worker.executeInIoThread(new Runnable() {
                 
                     @Override
                     public void run() {

transport/src/main/java/io/netty/channel/socket/nio/AbstractNioWorker.java

@@ -271,7 +271,8 @@ abstract class AbstractNioWorker implements Worker {
         }
     }
     
-    public void fireEventLater(Runnable eventRunnable) {
+    @Override
+    public void executeInIoThread(Runnable eventRunnable) {
        assert eventQueue.offer(eventRunnable);
        
        // wake up the selector to speed things

transport/src/main/java/io/netty/channel/socket/oio/AbstractOioChannelSink.java

@@ -25,13 +25,13 @@ import io.netty.channel.socket.Worker;
 public abstract class AbstractOioChannelSink extends AbstractChannelSink{
 
     @Override
-    public void fireEventLater(final ChannelPipeline pipeline, final ChannelEvent e) throws Exception {
+    public void fireUpstreamEventLater(final ChannelPipeline pipeline, final ChannelEvent e) throws Exception {
         Channel ch = e.getChannel();
         if (ch instanceof AbstractOioChannel) {
             AbstractOioChannel channel = (AbstractOioChannel) ch;
             Worker worker = channel.worker;
             if (worker != null && channel.workerThread != Thread.currentThread()) {
-                channel.worker.fireEventLater(new Runnable() {
+                channel.worker.executeInIoThread(new Runnable() {
                     
                     @Override
                     public void run() {

transport/src/main/java/io/netty/channel/socket/oio/AbstractOioWorker.java

@@ -91,8 +91,10 @@ abstract class AbstractOioWorker<C extends AbstractOioChannel> implements Worker
     
     
     @Override
-    public void fireEventLater(Runnable eventRunnable) {
+    public void executeInIoThread(Runnable eventRunnable) {
         assert eventQueue.offer(eventRunnable);
+        
+        // as we set the SO_TIMEOUT to 1 second this task will get picked up in 1 second at latest
     }
     
     private void processEventQueue() throws IOException {