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

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

View file

@ -162,11 +162,13 @@ akka {
# property
# NOTE: setting a mailbox to 'blocking' can be a bit dangerous, could lead to
# 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
# 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
# FQCN of the MailboxType, if not specified the default bounded or unbounded

View file

@ -166,7 +166,7 @@ if not specified otherwise.
default-dispatcher {
# 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
task-queue-size = 1000
mailbox-capacity = 1000
}
}
}

View file

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

View file

@ -164,7 +164,7 @@ if not specified otherwise.
default-dispatcher {
# 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
task-queue-size = 1000
mailbox-capacity = 1000
}
}
}