+ * To shut down a network application service which is managed by a factory. + * you should follow the following steps: + *
+ * For detailed transport-specific information on shutting down a factory, + * please refer to the Javadoc of {@link ChannelFactory}'s subtypes. * * @author The Netty Project (netty-dev@lists.jboss.org) * @author Trustin Lee (tlee@redhat.com) @@ -62,12 +74,14 @@ public interface ChannelFactory { Channel newChannel(ChannelPipeline pipeline); /** - * Returns the external resources that this factory depends on to function. - * Please note that {@link ChannelFactoryResource#release()} can be called - * to release all external resources conveniently when the resources are not - * used by this factory or any other part of your application. - * An unexpected behavior will be resulted in if the returned resources are - * released when there's an open channel which is managed by this factory. + * Releases the external resources that this factory depends on to function. + * An external resource is a resource that this factory didn't create by + * itself. For example, {@link Executor}s that you specified in the factory + * constructor are external resources. You can call this method to release + * all external resources conveniently when the resources are not used by + * this factory or any other part of your application. An unexpected + * behavior will be resulted in if the resources are released when there's + * an open channel which is managed by this factory. */ - ChannelFactoryResource getExternalResource(); + void releaseExternalResources(); } diff --git a/src/main/java/org/jboss/netty/channel/ChannelFactoryResource.java b/src/main/java/org/jboss/netty/channel/ChannelFactoryResource.java deleted file mode 100644 index 3b6d6879c5..0000000000 --- a/src/main/java/org/jboss/netty/channel/ChannelFactoryResource.java +++ /dev/null @@ -1,45 +0,0 @@ -/* - * JBoss, Home of Professional Open Source - * - * Copyright 2008, Red Hat Middleware LLC, and individual contributors - * by the @author tags. See the COPYRIGHT.txt in the distribution for a - * full listing of individual contributors. - * - * This is free software; you can redistribute it and/or modify it - * under the terms of the GNU Lesser General Public License as - * published by the Free Software Foundation; either version 2.1 of - * the License, or (at your option) any later version. - * - * This software is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public - * License along with this software; if not, write to the Free - * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA - * 02110-1301 USA, or see the FSF site: http://www.fsf.org. - */ -package org.jboss.netty.channel; - -import java.util.concurrent.ExecutorService; - - -/** - * The abstract representation of external resources that a - * {@link ChannelFactory} depends on. A user can release the external - * resources such as {@link ExecutorService}s conveniently. - * - * @author The Netty Project (netty-dev@lists.jboss.org) - * @author Trustin Lee (tlee@redhat.com) - * - * @version $Rev$, $Date$ - * - * @apiviz.exclude - */ -public interface ChannelFactoryResource { - /** - * Releases this resource. - */ - void release(); -} diff --git a/src/main/java/org/jboss/netty/channel/socket/nio/DefaultNioSocketChannelConfig.java b/src/main/java/org/jboss/netty/channel/socket/nio/DefaultNioSocketChannelConfig.java index 364e62b762..fba4fa15d5 100644 --- a/src/main/java/org/jboss/netty/channel/socket/nio/DefaultNioSocketChannelConfig.java +++ b/src/main/java/org/jboss/netty/channel/socket/nio/DefaultNioSocketChannelConfig.java @@ -44,8 +44,8 @@ class DefaultNioSocketChannelConfig extends DefaultSocketChannelConfig private static final InternalLogger logger = InternalLoggerFactory.getInstance(DefaultNioSocketChannelConfig.class); - private volatile int writeBufferHighWaterMark = 256 * 1024; - private volatile int writeBufferLowWaterMark = 128 * 1024; + private volatile int writeBufferHighWaterMark = 64 * 1024; + private volatile int writeBufferLowWaterMark = 32 * 1024; private volatile ReceiveBufferSizePredictor predictor = new DefaultReceiveBufferSizePredictor(); private volatile int writeSpinCount = 16; diff --git a/src/main/java/org/jboss/netty/channel/socket/nio/NioClientSocketChannelFactory.java b/src/main/java/org/jboss/netty/channel/socket/nio/NioClientSocketChannelFactory.java index 0399c54092..ce52c7f107 100644 --- a/src/main/java/org/jboss/netty/channel/socket/nio/NioClientSocketChannelFactory.java +++ b/src/main/java/org/jboss/netty/channel/socket/nio/NioClientSocketChannelFactory.java @@ -24,18 +24,15 @@ package org.jboss.netty.channel.socket.nio; import java.nio.channels.Selector; import java.util.concurrent.Executor; -import java.util.concurrent.ExecutorService; import java.util.concurrent.Executors; import java.util.concurrent.RejectedExecutionException; -import java.util.concurrent.TimeUnit; import org.jboss.netty.channel.Channel; -import org.jboss.netty.channel.ChannelFactoryExecutorResource; -import org.jboss.netty.channel.ChannelFactoryResource; import org.jboss.netty.channel.ChannelPipeline; import org.jboss.netty.channel.ChannelSink; import org.jboss.netty.channel.socket.ClientSocketChannelFactory; import org.jboss.netty.channel.socket.SocketChannel; +import org.jboss.netty.util.ExecutorShutdownUtil; /** * A {@link ClientSocketChannelFactory} which creates a client-side NIO-based @@ -62,7 +59,6 @@ import org.jboss.netty.channel.socket.SocketChannel; * more {@link Channel}s in a non-blocking mode. * *
* All threads are acquired from the {@link Executor}s which were specified * when a {@link NioClientSocketChannelFactory} was created. A boss thread is @@ -78,11 +74,8 @@ import org.jboss.netty.channel.socket.SocketChannel; * following: * *
* All threads are acquired from the {@link Executor}s which were specified * when a {@link NioServerSocketChannelFactory} was created. Boss threads are @@ -81,11 +77,8 @@ import org.jboss.netty.channel.socket.ServerSocketChannelFactory; * *
* Worker threads are acquired from the {@link Executor} which was specified * when a {@link OioClientSocketChannelFactory} was created (i.e. {@code workerExecutor}.) @@ -64,11 +60,8 @@ import org.jboss.netty.channel.socket.SocketChannel; * you should do the following: * *
* All threads are acquired from the {@link Executor}s which were specified * when a {@link OioServerSocketChannelFactory} was created. Boss threads are @@ -103,7 +101,7 @@ import org.jboss.netty.channel.socket.ServerSocketChannelFactory; public class OioServerSocketChannelFactory implements ServerSocketChannelFactory { final Executor bossExecutor; - private final ChannelFactoryResource externalResource; + private final Executor workerExecutor; private final ChannelSink sink; /** @@ -123,7 +121,7 @@ public class OioServerSocketChannelFactory implements ServerSocketChannelFactory throw new NullPointerException("workerExecutor"); } this.bossExecutor = bossExecutor; - externalResource = new ChannelFactoryExecutorResource(bossExecutor, workerExecutor); + this.workerExecutor = workerExecutor; sink = new OioServerSocketPipelineSink(workerExecutor); } @@ -131,7 +129,7 @@ public class OioServerSocketChannelFactory implements ServerSocketChannelFactory return new OioServerSocketChannel(this, pipeline, sink); } - public ChannelFactoryResource getExternalResource() { - return externalResource; + public void releaseExternalResources() { + ExecutorShutdownUtil.shutdown(bossExecutor, workerExecutor); } } diff --git a/src/main/java/org/jboss/netty/example/discard/DiscardClient.java b/src/main/java/org/jboss/netty/example/discard/DiscardClient.java index 021c408865..af15efe863 100644 --- a/src/main/java/org/jboss/netty/example/discard/DiscardClient.java +++ b/src/main/java/org/jboss/netty/example/discard/DiscardClient.java @@ -69,6 +69,7 @@ public class DiscardClient { ClientBootstrap bootstrap = new ClientBootstrap(factory); DiscardClientHandler handler = new DiscardClientHandler(firstMessageSize); + //bootstrap.getPipeline().addLast("executor", new ExecutionHandler(new MemoryAwareThreadPoolExecutor(16, 0, 0))); bootstrap.getPipeline().addLast("handler", handler); bootstrap.setOption("tcpNoDelay", true); bootstrap.setOption("keepAlive", true); @@ -80,6 +81,6 @@ public class DiscardClient { future.getChannel().getCloseFuture().awaitUninterruptibly(); // Shut down thread pools to exit. - factory.getExternalResource().release(); + factory.releaseExternalResources(); } } diff --git a/src/main/java/org/jboss/netty/example/factorial/FactorialClient.java b/src/main/java/org/jboss/netty/example/factorial/FactorialClient.java index ff3c2abe0c..e62bb2aa91 100644 --- a/src/main/java/org/jboss/netty/example/factorial/FactorialClient.java +++ b/src/main/java/org/jboss/netty/example/factorial/FactorialClient.java @@ -87,6 +87,6 @@ public class FactorialClient { "Factorial of %,d is: %,d", count, handler.getFactorial()); // Shut down all thread pools to exit. - factory.getExternalResource().release(); + factory.releaseExternalResources(); } } diff --git a/src/main/java/org/jboss/netty/example/http/HttpClient.java b/src/main/java/org/jboss/netty/example/http/HttpClient.java index 453c6e1aad..eeb11e9352 100644 --- a/src/main/java/org/jboss/netty/example/http/HttpClient.java +++ b/src/main/java/org/jboss/netty/example/http/HttpClient.java @@ -82,7 +82,7 @@ public class HttpClient { Channel channel = future.awaitUninterruptibly().getChannel(); if (!future.isSuccess()) { future.getCause().printStackTrace(); - factory.getExternalResource().release(); + factory.releaseExternalResources(); return; } @@ -95,6 +95,6 @@ public class HttpClient { channel.getCloseFuture().awaitUninterruptibly(); // Shut down executor threads to exit. - factory.getExternalResource().release(); + factory.releaseExternalResources(); } } \ No newline at end of file diff --git a/src/main/java/org/jboss/netty/example/securechat/SecureChatClient.java b/src/main/java/org/jboss/netty/example/securechat/SecureChatClient.java index 18ae423e9f..bd285c2d29 100644 --- a/src/main/java/org/jboss/netty/example/securechat/SecureChatClient.java +++ b/src/main/java/org/jboss/netty/example/securechat/SecureChatClient.java @@ -78,7 +78,7 @@ public class SecureChatClient { Channel channel = future.awaitUninterruptibly().getChannel(); if (!future.isSuccess()) { future.getCause().printStackTrace(); - factory.getExternalResource().release(); + factory.releaseExternalResources(); return; } @@ -103,6 +103,6 @@ public class SecureChatClient { channel.close().awaitUninterruptibly(); // Shut down all thread pools to exit. - factory.getExternalResource().release(); + factory.releaseExternalResources(); } } diff --git a/src/main/java/org/jboss/netty/example/telnet/TelnetClient.java b/src/main/java/org/jboss/netty/example/telnet/TelnetClient.java index 831bc72726..7fe087d141 100644 --- a/src/main/java/org/jboss/netty/example/telnet/TelnetClient.java +++ b/src/main/java/org/jboss/netty/example/telnet/TelnetClient.java @@ -76,7 +76,7 @@ public class TelnetClient { Channel channel = future.awaitUninterruptibly().getChannel(); if (!future.isSuccess()) { future.getCause().printStackTrace(); - factory.getExternalResource(); + factory.releaseExternalResources(); return; } @@ -103,6 +103,6 @@ public class TelnetClient { channel.close().awaitUninterruptibly(); // Shut down all thread pools to exit. - factory.getExternalResource().release(); + factory.releaseExternalResources(); } } diff --git a/src/main/java/org/jboss/netty/channel/ChannelFactoryExecutorResource.java b/src/main/java/org/jboss/netty/util/ExecutorShutdownUtil.java similarity index 67% rename from src/main/java/org/jboss/netty/channel/ChannelFactoryExecutorResource.java rename to src/main/java/org/jboss/netty/util/ExecutorShutdownUtil.java index 2cadf30dd8..7eebb02a19 100644 --- a/src/main/java/org/jboss/netty/channel/ChannelFactoryExecutorResource.java +++ b/src/main/java/org/jboss/netty/util/ExecutorShutdownUtil.java @@ -20,49 +20,37 @@ * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA * 02110-1301 USA, or see the FSF site: http://www.fsf.org. */ -package org.jboss.netty.channel; +package org.jboss.netty.util; import java.util.concurrent.Executor; import java.util.concurrent.ExecutorService; import java.util.concurrent.TimeUnit; /** - * A {@link ChannelFactoryResource} whose underlying resource is a list of - * {@link Executor}s. {@link #release()} will shut down all specified - * {@link ExecutorService}s immediately and wait for their termination. - * An {@link Executor} which is not an {@link ExecutorService} will be ignored. + * Shuts down a list of {@link Executor}s. {@link #shutdown(Executor...)} will + * shut down all specified {@link ExecutorService}s immediately and wait for + * their termination. An {@link Executor} which is not an {@link ExecutorService} + * will be ignored silently. * * @author The Netty Project (netty-dev@lists.jboss.org) * @author Trustin Lee (tlee@redhat.com) * @version $Rev$, $Date$ - * - * @apiviz.exclude */ -public class ChannelFactoryExecutorResource implements - ChannelFactoryResource { - - private final Executor[] executors; +public class ExecutorShutdownUtil { /** - * Creates a new instance with the specified executors. - * - * @param executors a list of {@link Executor}s + * Shuts down the specified executors. */ - public ChannelFactoryExecutorResource(Executor... executors) { - if (executors == null) { - throw new NullPointerException("executors"); - } - this.executors = new Executor[executors.length]; + public static void shutdown(Executor... executors) { + Executor[] executorsCopy = new Executor[executors.length]; for (int i = 0; i < executors.length; i ++) { if (executors[i] == null) { throw new NullPointerException("executors[" + i + "]"); } - this.executors[i] = executors[i]; + executorsCopy[i] = executors[i]; } - } - public void release() { - for (Executor e: executors) { + for (Executor e: executorsCopy) { if (!(e instanceof ExecutorService)) { continue; } @@ -80,4 +68,8 @@ public class ChannelFactoryExecutorResource implements } } } + + private ExecutorShutdownUtil() { + super(); + } } diff --git a/src/test/java/org/jboss/netty/channel/socket/NioClientSocketShutdownTimeTest.java b/src/test/java/org/jboss/netty/channel/socket/NioClientSocketShutdownTimeTest.java index 4387d72c61..e3ebe89d64 100644 --- a/src/test/java/org/jboss/netty/channel/socket/NioClientSocketShutdownTimeTest.java +++ b/src/test/java/org/jboss/netty/channel/socket/NioClientSocketShutdownTimeTest.java @@ -85,7 +85,7 @@ public class NioClientSocketShutdownTimeTest { f.getChannel().close().awaitUninterruptibly(); } finally { - b.getFactory().getExternalResource().release(); + b.getFactory().releaseExternalResources(); try { serverSocket.close(); diff --git a/src/test/java/org/jboss/netty/channel/socket/NioServerSocketShutdownTimeTest.java b/src/test/java/org/jboss/netty/channel/socket/NioServerSocketShutdownTimeTest.java index 917c3855d0..e3566b2e06 100644 --- a/src/test/java/org/jboss/netty/channel/socket/NioServerSocketShutdownTimeTest.java +++ b/src/test/java/org/jboss/netty/channel/socket/NioServerSocketShutdownTimeTest.java @@ -106,7 +106,7 @@ public class NioServerSocketShutdownTimeTest { } } channel.close().awaitUninterruptibly(); - bootstrap.getFactory().getExternalResource().release(); + bootstrap.getFactory().releaseExternalResources(); } long shutdownTime = System.currentTimeMillis() - startTime;