raboof/pekko
1
0
Fork 0
Code Issues Pull requests Projects Releases 6 Packages Wiki Activity Actions 11

Adding docs and privatizing some fields in Dispatchers.scala

Browse source
This commit is contained in:
Viktor Klang 2012-05-16 17:21:58 +02:00
parent 630c4a0153
commit 72f12c89cd
1 changed files with 14 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

23
akka-actor/src/main/scala/akka/dispatch/Dispatchers.scala
View file

@ -5,17 +5,15 @@
package akka.dispatch package akka.dispatch
import java.util.concurrent.{ ConcurrentHashMap, TimeUnit, ThreadFactory } import java.util.concurrent.{ ConcurrentHashMap, TimeUnit, ThreadFactory }
import scala.collection.JavaConverters.mapAsJavaMapConverter
import com.typesafe.config.{ ConfigFactory, Config } import com.typesafe.config.{ ConfigFactory, Config }
import Dispatchers.DefaultDispatcherId
import akka.actor.{ Scheduler, DynamicAccess, ActorSystem } import akka.actor.{ Scheduler, DynamicAccess, ActorSystem }
import akka.event.Logging.Warning import akka.event.Logging.Warning
import akka.event.EventStream import akka.event.EventStream
import akka.util.Duration import akka.util.Duration
/**
* DispatcherPrerequisites represents useful contextual pieces when constructing a MessageDispatcher
*/
trait DispatcherPrerequisites { trait DispatcherPrerequisites {
def threadFactory: ThreadFactory def threadFactory: ThreadFactory
def eventStream: EventStream def eventStream: EventStream
@ -25,7 +23,10 @@ trait DispatcherPrerequisites {
def settings: ActorSystem.Settings def settings: ActorSystem.Settings
} }
case class DefaultDispatcherPrerequisites( /**
* INTERNAL USE ONLY
*/
private[akka] case class DefaultDispatcherPrerequisites(
val threadFactory: ThreadFactory, val threadFactory: ThreadFactory,
val eventStream: EventStream, val eventStream: EventStream,
val deadLetterMailbox: Mailbox, val deadLetterMailbox: Mailbox,
@ -110,7 +111,7 @@ class Dispatchers(val settings: ActorSystem.Settings, val prerequisites: Dispatc
ConfigFactory.parseMap(Map("id" -> id).asJava) ConfigFactory.parseMap(Map("id" -> id).asJava)
} }
/* /**
* Creates a dispatcher from a Config. Internal test purpose only. * Creates a dispatcher from a Config. Internal test purpose only.
* *
* ex: from(config.getConfig(id)) * ex: from(config.getConfig(id))
@ -119,18 +120,22 @@ class Dispatchers(val settings: ActorSystem.Settings, val prerequisites: Dispatc
* *
* Throws: IllegalArgumentException if the value of "type" is not valid * Throws: IllegalArgumentException if the value of "type" is not valid
* IllegalArgumentException if it cannot create the MessageDispatcherConfigurator * IllegalArgumentException if it cannot create the MessageDispatcherConfigurator
*
* INTERNAL USE ONLY
*/ */
private[akka] def from(cfg: Config): MessageDispatcher = { private[akka] def from(cfg: Config): MessageDispatcher = {
configuratorFrom(cfg).dispatcher() configuratorFrom(cfg).dispatcher()
} }
/* /**
* Creates a MessageDispatcherConfigurator from a Config. * Creates a MessageDispatcherConfigurator from a Config.
* *
* The Config must also contain a `id` property, which is the identifier of the dispatcher. * The Config must also contain a `id` property, which is the identifier of the dispatcher.
* *
* Throws: IllegalArgumentException if the value of "type" is not valid * Throws: IllegalArgumentException if the value of "type" is not valid
* IllegalArgumentException if it cannot create the MessageDispatcherConfigurator * IllegalArgumentException if it cannot create the MessageDispatcherConfigurator
*
* INTERNAL USE ONLY
*/ */
private def configuratorFrom(cfg: Config): MessageDispatcherConfigurator = { private def configuratorFrom(cfg: Config): MessageDispatcherConfigurator = {
if (!cfg.hasPath("id")) throw new IllegalArgumentException("Missing dispatcher 'id' property in config: " + cfg.root.render) if (!cfg.hasPath("id")) throw new IllegalArgumentException("Missing dispatcher 'id' property in config: " + cfg.root.render)
@ -208,7 +213,7 @@ class BalancingDispatcherConfigurator(config: Config, prerequisites: DispatcherP
class PinnedDispatcherConfigurator(config: Config, prerequisites: DispatcherPrerequisites) class PinnedDispatcherConfigurator(config: Config, prerequisites: DispatcherPrerequisites)
extends MessageDispatcherConfigurator(config, prerequisites) { extends MessageDispatcherConfigurator(config, prerequisites) {
val threadPoolConfig: ThreadPoolConfig = configureExecutor() match { private val threadPoolConfig: ThreadPoolConfig = configureExecutor() match {
case e: ThreadPoolExecutorConfigurator ⇒ e.threadPoolConfig case e: ThreadPoolExecutorConfigurator ⇒ e.threadPoolConfig
case other ⇒ case other ⇒
prerequisites.eventStream.publish( prerequisites.eventStream.publish(