File tree Expand file tree Collapse file tree 2 files changed +8
-1
lines changed
lib/concurrent-ruby/concurrent/executor Expand file tree Collapse file tree 2 files changed +8
-1
lines changed Original file line number Diff line number Diff line change @@ -16,6 +16,9 @@ module Concurrent
16
16
# Default maximum number of seconds a thread in the pool may remain idle
17
17
# before being reclaimed.
18
18
19
+ # @!macro thread_pool_executor_constant_default_synchronous
20
+ # Default value of the :synchronous option.
21
+
19
22
# @!macro thread_pool_executor_attr_reader_max_length
20
23
# The maximum number of threads that may be created in the pool.
21
24
# @return [Integer] The maximum number of threads that may be created in the pool.
@@ -40,6 +43,10 @@ module Concurrent
40
43
# The number of seconds that a thread may be idle before being reclaimed.
41
44
# @return [Integer] The number of seconds that a thread may be idle before being reclaimed.
42
45
46
+ # @!macro thread_pool_executor_attr_reader_synchronous
47
+ # Whether or not a value of 0 for :max_queue option means the queue must perform direct hand-off or rather unbounded queue.
48
+ # @return [true, false]
49
+
43
50
# @!macro thread_pool_executor_attr_reader_max_queue
44
51
# The maximum number of tasks that may be waiting in the work queue at any one time.
45
52
# When the queue size reaches `max_queue` subsequent tasks will be rejected in
Original file line number Diff line number Diff line change @@ -73,7 +73,7 @@ class ThreadPoolExecutor < ThreadPoolExecutorImplementation
73
73
# @option opts [Symbol] :fallback_policy (:abort) the policy for handling new
74
74
# tasks that are received when the queue size has reached
75
75
# `max_queue` or the executor has shut down
76
- # @options opts [Boolean] :synchronous (DEFAULT_SYNCHRONOUS) whether or not a value of 0
76
+ # @option opts [Boolean] :synchronous (DEFAULT_SYNCHRONOUS) whether or not a value of 0
77
77
# for :max_queue means the queue must perform direct hand-off rather than unbounded.
78
78
# @raise [ArgumentError] if `:max_threads` is less than one
79
79
# @raise [ArgumentError] if `:min_threads` is less than zero
You can’t perform that action at this time.
0 commit comments