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

DOC: Fixed wrong documentation of bounded mailbox, mailbox-capacity should be used, not task-queue-type. See #1601

Browse source
This commit is contained in:
Patrik Nordwall 2012-01-03 10:03:58 +01:00
parent 774584642e
commit 0a3021eb60
4 changed files with 8 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

6
akka-actor/src/main/resources/reference.conf
View file

@ -162,11 +162,13 @@ akka {
# property # property
# NOTE: setting a mailbox to 'blocking' can be a bit dangerous, could lead to # NOTE: setting a mailbox to 'blocking' can be a bit dangerous, could lead to
# deadlock, use with care # deadlock, use with care
# The following are only used for Dispatcher and only if mailbox-capacity > 0 # The following mailbox-push-timeout-time is only used for type=Dispatcher and
# only if mailbox-capacity > 0
mailbox-capacity = -1 mailbox-capacity = -1
# Specifies the timeout to add a new message to a mailbox that is full - # Specifies the timeout to add a new message to a mailbox that is full -
# negative number means infinite timeout # negative number means infinite timeout. It is only used for type=Dispatcher
# and only if mailbox-capacity > 0
mailbox-push-timeout-time = 10s mailbox-push-timeout-time = 10s
# FQCN of the MailboxType, if not specified the default bounded or unbounded # FQCN of the MailboxType, if not specified the default bounded or unbounded

2
akka-docs/java/dispatchers.rst
View file

@ -166,7 +166,7 @@ if not specified otherwise.
default-dispatcher { default-dispatcher {
# If negative (or zero) then an unbounded mailbox is used (default) # If negative (or zero) then an unbounded mailbox is used (default)
# If positive then a bounded mailbox is used and the capacity is set to the number specified # If positive then a bounded mailbox is used and the capacity is set to the number specified
task-queue-size = 1000 mailbox-capacity = 1000
} }
} }
} }

6
akka-docs/scala/code/akka/docs/dispatcher/DispatcherDocSpec.scala
View file

@ -41,10 +41,8 @@ object DispatcherDocSpec {
type = Dispatcher type = Dispatcher
core-pool-size-factor = 8.0 core-pool-size-factor = 8.0
max-pool-size-factor = 16.0 max-pool-size-factor = 16.0
# Specifies the bounded capacity of the task queue # Specifies the bounded capacity of the mailbox queue
task-queue-size = 100 mailbox-capacity = 100
# Specifies which type of task queue will be used, can be "array" or "linked" (default)
task-queue-type = "array"
throughput = 3 throughput = 3
} }
//#my-bounded-config //#my-bounded-config

2
akka-docs/scala/dispatchers.rst
View file

@ -164,7 +164,7 @@ if not specified otherwise.
default-dispatcher { default-dispatcher {
# If negative (or zero) then an unbounded mailbox is used (default) # If negative (or zero) then an unbounded mailbox is used (default)
# If positive then a bounded mailbox is used and the capacity is set to the number specified # If positive then a bounded mailbox is used and the capacity is set to the number specified
task-queue-size = 1000 mailbox-capacity = 1000
} }
} }
} }