2009-12-11 16:37:44 +01:00
|
|
|
/**
|
2012-01-19 18:21:06 +01:00
|
|
|
* Copyright (C) 2009-2012 Typesafe Inc. <http://www.typesafe.com>
|
2009-12-11 16:37:44 +01:00
|
|
|
*/
|
|
|
|
|
|
2010-10-26 12:49:25 +02:00
|
|
|
package akka.dispatch
|
2009-12-11 16:37:44 +01:00
|
|
|
|
2010-03-01 22:03:17 +01:00
|
|
|
import java.util.Collection
|
2011-11-15 10:25:05 +01:00
|
|
|
import java.util.concurrent.atomic.{ AtomicLong, AtomicInteger }
|
2011-03-02 00:14:45 +01:00
|
|
|
import akka.util.Duration
|
2011-11-15 10:25:05 +01:00
|
|
|
import java.util.concurrent._
|
2010-10-22 17:50:48 +02:00
|
|
|
|
|
|
|
|
object ThreadPoolConfig {
|
2011-05-18 17:25:30 +02:00
|
|
|
type QueueFactory = () ⇒ BlockingQueue[Runnable]
|
2010-10-22 17:50:48 +02:00
|
|
|
|
|
|
|
|
val defaultAllowCoreThreadTimeout: Boolean = false
|
2011-05-18 17:25:30 +02:00
|
|
|
val defaultCorePoolSize: Int = 16
|
|
|
|
|
val defaultMaxPoolSize: Int = 128
|
|
|
|
|
val defaultTimeout: Duration = Duration(60000L, TimeUnit.MILLISECONDS)
|
2010-10-22 17:50:48 +02:00
|
|
|
|
2011-12-07 11:25:27 +01:00
|
|
|
def scaledPoolSize(floor: Int, multiplier: Double, ceiling: Int): Int = {
|
|
|
|
|
import scala.math.{ min, max }
|
|
|
|
|
min(max((Runtime.getRuntime.availableProcessors * multiplier).ceil.toInt, floor), ceiling)
|
|
|
|
|
}
|
2010-10-22 17:50:48 +02:00
|
|
|
|
|
|
|
|
def arrayBlockingQueue(capacity: Int, fair: Boolean): QueueFactory =
|
2011-05-18 17:25:30 +02:00
|
|
|
() ⇒ new ArrayBlockingQueue[Runnable](capacity, fair)
|
2010-10-22 17:50:48 +02:00
|
|
|
|
|
|
|
|
def synchronousQueue(fair: Boolean): QueueFactory =
|
2011-05-18 17:25:30 +02:00
|
|
|
() ⇒ new SynchronousQueue[Runnable](fair)
|
2010-10-22 17:50:48 +02:00
|
|
|
|
|
|
|
|
def linkedBlockingQueue(): QueueFactory =
|
2011-05-18 17:25:30 +02:00
|
|
|
() ⇒ new LinkedBlockingQueue[Runnable]()
|
2010-10-22 17:50:48 +02:00
|
|
|
|
|
|
|
|
def linkedBlockingQueue(capacity: Int): QueueFactory =
|
2011-05-18 17:25:30 +02:00
|
|
|
() ⇒ new LinkedBlockingQueue[Runnable](capacity)
|
2010-10-22 17:50:48 +02:00
|
|
|
|
|
|
|
|
def reusableQueue(queue: BlockingQueue[Runnable]): QueueFactory =
|
2011-05-18 17:25:30 +02:00
|
|
|
() ⇒ queue
|
2010-10-22 17:50:48 +02:00
|
|
|
|
|
|
|
|
def reusableQueue(queueFactory: QueueFactory): QueueFactory = {
|
|
|
|
|
val queue = queueFactory()
|
2011-05-18 17:25:30 +02:00
|
|
|
() ⇒ queue
|
2010-10-22 17:50:48 +02:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2011-10-12 18:21:12 +02:00
|
|
|
/**
|
|
|
|
|
* Function0 without the fun stuff (mostly for the sake of the Java API side of things)
|
|
|
|
|
*/
|
2011-07-01 22:13:56 +02:00
|
|
|
trait ExecutorServiceFactory {
|
|
|
|
|
def createExecutorService: ExecutorService
|
|
|
|
|
}
|
|
|
|
|
|
2011-10-12 18:21:12 +02:00
|
|
|
/**
|
|
|
|
|
* Generic way to specify an ExecutorService to a Dispatcher, create it with the given name if desired
|
|
|
|
|
*/
|
2011-07-01 22:13:56 +02:00
|
|
|
trait ExecutorServiceFactoryProvider {
|
|
|
|
|
def createExecutorServiceFactory(name: String): ExecutorServiceFactory
|
|
|
|
|
}
|
|
|
|
|
|
2011-10-12 18:21:12 +02:00
|
|
|
/**
|
|
|
|
|
* A small configuration DSL to create ThreadPoolExecutors that can be provided as an ExecutorServiceFactoryProvider to Dispatcher
|
|
|
|
|
*/
|
2011-11-17 16:09:18 +01:00
|
|
|
case class ThreadPoolConfig(allowCorePoolTimeout: Boolean = ThreadPoolConfig.defaultAllowCoreThreadTimeout,
|
2011-05-18 17:25:30 +02:00
|
|
|
corePoolSize: Int = ThreadPoolConfig.defaultCorePoolSize,
|
|
|
|
|
maxPoolSize: Int = ThreadPoolConfig.defaultMaxPoolSize,
|
|
|
|
|
threadTimeout: Duration = ThreadPoolConfig.defaultTimeout,
|
2011-12-13 20:06:07 +01:00
|
|
|
queueFactory: ThreadPoolConfig.QueueFactory = ThreadPoolConfig.linkedBlockingQueue(),
|
|
|
|
|
daemonic: Boolean = false)
|
2011-07-01 22:13:56 +02:00
|
|
|
extends ExecutorServiceFactoryProvider {
|
2011-12-13 20:06:07 +01:00
|
|
|
class ThreadPoolExecutorServiceFactory(val threadFactory: ThreadFactory) extends ExecutorServiceFactory {
|
2011-11-15 10:25:05 +01:00
|
|
|
def createExecutorService: ExecutorService = {
|
|
|
|
|
val service = new ThreadPoolExecutor(corePoolSize, maxPoolSize, threadTimeout.length, threadTimeout.unit, queueFactory(), threadFactory, new SaneRejectedExecutionHandler)
|
|
|
|
|
service.allowCoreThreadTimeOut(allowCorePoolTimeout)
|
|
|
|
|
service
|
2010-10-22 17:50:48 +02:00
|
|
|
}
|
|
|
|
|
}
|
2011-12-13 20:06:07 +01:00
|
|
|
final def createExecutorServiceFactory(name: String): ExecutorServiceFactory = new ThreadPoolExecutorServiceFactory(new MonitorableThreadFactory(name, daemonic))
|
2010-10-22 17:50:48 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
trait DispatcherBuilder {
|
|
|
|
|
def build: MessageDispatcher
|
|
|
|
|
}
|
|
|
|
|
|
2010-10-24 00:36:56 +02:00
|
|
|
object ThreadPoolConfigDispatcherBuilder {
|
2011-05-18 17:25:30 +02:00
|
|
|
def conf_?[T](opt: Option[T])(fun: (T) ⇒ ThreadPoolConfigDispatcherBuilder ⇒ ThreadPoolConfigDispatcherBuilder): Option[(ThreadPoolConfigDispatcherBuilder) ⇒ ThreadPoolConfigDispatcherBuilder] = opt map fun
|
2010-10-24 00:36:56 +02:00
|
|
|
}
|
|
|
|
|
|
2011-10-12 18:21:12 +02:00
|
|
|
/**
|
|
|
|
|
* A DSL to configure and create a MessageDispatcher with a ThreadPoolExecutor
|
|
|
|
|
*/
|
2011-05-18 17:25:30 +02:00
|
|
|
case class ThreadPoolConfigDispatcherBuilder(dispatcherFactory: (ThreadPoolConfig) ⇒ MessageDispatcher, config: ThreadPoolConfig) extends DispatcherBuilder {
|
2010-10-22 17:50:48 +02:00
|
|
|
import ThreadPoolConfig._
|
2012-01-19 12:15:49 +01:00
|
|
|
def build: MessageDispatcher = dispatcherFactory(config)
|
2010-10-22 17:50:48 +02:00
|
|
|
|
|
|
|
|
def withNewThreadPoolWithCustomBlockingQueue(newQueueFactory: QueueFactory): ThreadPoolConfigDispatcherBuilder =
|
2011-11-15 10:25:05 +01:00
|
|
|
this.copy(config = config.copy(queueFactory = newQueueFactory))
|
2010-10-22 17:50:48 +02:00
|
|
|
|
2011-05-18 17:25:30 +02:00
|
|
|
def withNewThreadPoolWithCustomBlockingQueue(queue: BlockingQueue[Runnable]): ThreadPoolConfigDispatcherBuilder =
|
|
|
|
|
withNewThreadPoolWithCustomBlockingQueue(reusableQueue(queue))
|
2010-10-22 17:50:48 +02:00
|
|
|
|
|
|
|
|
def withNewThreadPoolWithLinkedBlockingQueueWithUnboundedCapacity: ThreadPoolConfigDispatcherBuilder =
|
2011-11-15 10:25:05 +01:00
|
|
|
this.copy(config = config.copy(queueFactory = linkedBlockingQueue()))
|
2010-10-22 17:50:48 +02:00
|
|
|
|
|
|
|
|
def withNewThreadPoolWithLinkedBlockingQueueWithCapacity(capacity: Int): ThreadPoolConfigDispatcherBuilder =
|
2011-11-15 10:25:05 +01:00
|
|
|
this.copy(config = config.copy(queueFactory = linkedBlockingQueue(capacity)))
|
2010-10-22 17:50:48 +02:00
|
|
|
|
|
|
|
|
def withNewThreadPoolWithSynchronousQueueWithFairness(fair: Boolean): ThreadPoolConfigDispatcherBuilder =
|
2011-11-15 10:25:05 +01:00
|
|
|
this.copy(config = config.copy(queueFactory = synchronousQueue(fair)))
|
2010-10-22 17:50:48 +02:00
|
|
|
|
|
|
|
|
def withNewThreadPoolWithArrayBlockingQueueWithCapacityAndFairness(capacity: Int, fair: Boolean): ThreadPoolConfigDispatcherBuilder =
|
2011-11-15 10:25:05 +01:00
|
|
|
this.copy(config = config.copy(queueFactory = arrayBlockingQueue(capacity, fair)))
|
2010-10-22 17:50:48 +02:00
|
|
|
|
|
|
|
|
def setCorePoolSize(size: Int): ThreadPoolConfigDispatcherBuilder =
|
2011-12-27 15:07:36 +01:00
|
|
|
if (config.maxPoolSize < size)
|
|
|
|
|
this.copy(config = config.copy(corePoolSize = size, maxPoolSize = size))
|
|
|
|
|
else
|
|
|
|
|
this.copy(config = config.copy(corePoolSize = size))
|
2010-10-22 17:50:48 +02:00
|
|
|
|
|
|
|
|
def setMaxPoolSize(size: Int): ThreadPoolConfigDispatcherBuilder =
|
2011-12-27 15:07:36 +01:00
|
|
|
if (config.corePoolSize > size)
|
|
|
|
|
this.copy(config = config.copy(corePoolSize = size, maxPoolSize = size))
|
|
|
|
|
else
|
|
|
|
|
this.copy(config = config.copy(maxPoolSize = size))
|
2010-10-22 17:50:48 +02:00
|
|
|
|
2011-12-07 11:25:27 +01:00
|
|
|
def setCorePoolSizeFromFactor(min: Int, multiplier: Double, max: Int): ThreadPoolConfigDispatcherBuilder =
|
|
|
|
|
setCorePoolSize(scaledPoolSize(min, multiplier, max))
|
2010-10-22 17:50:48 +02:00
|
|
|
|
2011-12-07 11:25:27 +01:00
|
|
|
def setMaxPoolSizeFromFactor(min: Int, multiplier: Double, max: Int): ThreadPoolConfigDispatcherBuilder =
|
|
|
|
|
setMaxPoolSize(scaledPoolSize(min, multiplier, max))
|
2010-10-22 17:50:48 +02:00
|
|
|
|
|
|
|
|
def setKeepAliveTimeInMillis(time: Long): ThreadPoolConfigDispatcherBuilder =
|
2011-05-18 17:25:30 +02:00
|
|
|
setKeepAliveTime(Duration(time, TimeUnit.MILLISECONDS))
|
2010-10-22 17:50:48 +02:00
|
|
|
|
|
|
|
|
def setKeepAliveTime(time: Duration): ThreadPoolConfigDispatcherBuilder =
|
|
|
|
|
this.copy(config = config.copy(threadTimeout = time))
|
|
|
|
|
|
|
|
|
|
def setAllowCoreThreadTimeout(allow: Boolean): ThreadPoolConfigDispatcherBuilder =
|
|
|
|
|
this.copy(config = config.copy(allowCorePoolTimeout = allow))
|
2009-12-11 16:37:44 +01:00
|
|
|
|
2011-08-24 12:41:21 +02:00
|
|
|
def setQueueFactory(newQueueFactory: QueueFactory): ThreadPoolConfigDispatcherBuilder =
|
|
|
|
|
this.copy(config = config.copy(queueFactory = newQueueFactory))
|
|
|
|
|
|
2011-05-18 17:25:30 +02:00
|
|
|
def configure(fs: Option[Function[ThreadPoolConfigDispatcherBuilder, ThreadPoolConfigDispatcherBuilder]]*): ThreadPoolConfigDispatcherBuilder = fs.foldLeft(this)((c, f) ⇒ f.map(_(c)).getOrElse(c))
|
2010-10-22 17:50:48 +02:00
|
|
|
}
|
2010-05-21 20:08:49 +02:00
|
|
|
|
2011-07-11 18:54:15 +02:00
|
|
|
class MonitorableThreadFactory(val name: String, val daemonic: Boolean = false) extends ThreadFactory {
|
2010-10-22 17:50:48 +02:00
|
|
|
protected val counter = new AtomicLong
|
2011-12-28 17:50:29 +01:00
|
|
|
protected val doNothing: Thread.UncaughtExceptionHandler =
|
|
|
|
|
new Thread.UncaughtExceptionHandler() {
|
|
|
|
|
def uncaughtException(thread: Thread, cause: Throwable) = {}
|
|
|
|
|
}
|
2009-12-11 16:37:44 +01:00
|
|
|
|
2011-07-11 18:54:15 +02:00
|
|
|
def newThread(runnable: Runnable) = {
|
2011-12-28 17:50:29 +01:00
|
|
|
val t = new Thread(runnable, name + counter.incrementAndGet())
|
|
|
|
|
t.setUncaughtExceptionHandler(doNothing)
|
2011-07-11 18:54:15 +02:00
|
|
|
t.setDaemon(daemonic)
|
|
|
|
|
t
|
|
|
|
|
}
|
2010-10-22 17:50:48 +02:00
|
|
|
}
|
2009-12-11 16:37:44 +01:00
|
|
|
|
2011-10-12 18:21:12 +02:00
|
|
|
/**
|
|
|
|
|
* As the name says
|
|
|
|
|
*/
|
2011-02-28 22:54:32 +01:00
|
|
|
trait ExecutorServiceDelegate extends ExecutorService {
|
2010-10-24 00:36:56 +02:00
|
|
|
|
|
|
|
|
def executor: ExecutorService
|
|
|
|
|
|
|
|
|
|
def execute(command: Runnable) = executor.execute(command)
|
2009-12-11 16:37:44 +01:00
|
|
|
|
2011-04-29 10:20:16 +02:00
|
|
|
def shutdown() { executor.shutdown() }
|
2009-12-11 16:37:44 +01:00
|
|
|
|
2011-04-29 10:20:16 +02:00
|
|
|
def shutdownNow() = executor.shutdownNow()
|
2009-12-11 16:37:44 +01:00
|
|
|
|
2010-10-22 17:50:48 +02:00
|
|
|
def isShutdown = executor.isShutdown
|
2009-12-11 16:37:44 +01:00
|
|
|
|
2010-10-22 17:50:48 +02:00
|
|
|
def isTerminated = executor.isTerminated
|
2009-12-11 16:37:44 +01:00
|
|
|
|
2010-10-22 17:50:48 +02:00
|
|
|
def awaitTermination(l: Long, timeUnit: TimeUnit) = executor.awaitTermination(l, timeUnit)
|
2009-12-11 16:37:44 +01:00
|
|
|
|
2010-10-22 17:50:48 +02:00
|
|
|
def submit[T](callable: Callable[T]) = executor.submit(callable)
|
2009-12-11 16:37:44 +01:00
|
|
|
|
2010-10-22 17:50:48 +02:00
|
|
|
def submit[T](runnable: Runnable, t: T) = executor.submit(runnable, t)
|
2009-12-11 16:37:44 +01:00
|
|
|
|
2010-10-22 17:50:48 +02:00
|
|
|
def submit(runnable: Runnable) = executor.submit(runnable)
|
2009-12-11 16:37:44 +01:00
|
|
|
|
2010-10-22 17:50:48 +02:00
|
|
|
def invokeAll[T](callables: Collection[_ <: Callable[T]]) = executor.invokeAll(callables)
|
2009-12-11 16:37:44 +01:00
|
|
|
|
2010-10-22 17:50:48 +02:00
|
|
|
def invokeAll[T](callables: Collection[_ <: Callable[T]], l: Long, timeUnit: TimeUnit) = executor.invokeAll(callables, l, timeUnit)
|
2009-12-11 16:37:44 +01:00
|
|
|
|
2010-10-22 17:50:48 +02:00
|
|
|
def invokeAny[T](callables: Collection[_ <: Callable[T]]) = executor.invokeAny(callables)
|
|
|
|
|
|
|
|
|
|
def invokeAny[T](callables: Collection[_ <: Callable[T]], l: Long, timeUnit: TimeUnit) = executor.invokeAny(callables, l, timeUnit)
|
2010-05-21 20:08:49 +02:00
|
|
|
}
|
2011-11-15 10:25:05 +01:00
|
|
|
|
2011-12-28 12:43:28 +01:00
|
|
|
/**
|
|
|
|
|
* The RejectedExecutionHandler used by Akka, it improves on CallerRunsPolicy
|
|
|
|
|
* by throwing a RejectedExecutionException if the executor isShutdown.
|
|
|
|
|
* (CallerRunsPolicy silently discards the runnable in this case, which is arguably broken)
|
|
|
|
|
*/
|
2011-11-15 10:25:05 +01:00
|
|
|
class SaneRejectedExecutionHandler extends RejectedExecutionHandler {
|
|
|
|
|
def rejectedExecution(runnable: Runnable, threadPoolExecutor: ThreadPoolExecutor): Unit = {
|
|
|
|
|
if (threadPoolExecutor.isShutdown) throw new RejectedExecutionException("Shutdown")
|
|
|
|
|
else runnable.run()
|
|
|
|
|
}
|
2012-01-19 12:15:49 +01:00
|
|
|
}
|