Class: Thread::Pool

Inherits:
Object
  • Object
show all
Defined in:
lib/balotelli/thread/pool.rb

Overview

A pool is a container of a limited amount of threads to which you can add tasks to run.

This is usually more performant and less memory intensive than creating a new thread for every task.

Defined Under Namespace

Classes: Task

Class Attribute Summary collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(min, max = nil, &block) ⇒ Pool

Create the pool with minimum and maximum threads.

The pool will start with the minimum amount of threads created and will spawn new threads until the max is reached in case of need.

A default block can be passed, which will be used to #process the passed data.



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/balotelli/thread/pool.rb', line 116

def initialize(min, max = nil, &block)
  @min   = min
  @max   = max || min
  @block = block

  @cond  = ConditionVariable.new
  @mutex = Mutex.new

  @done       = ConditionVariable.new
  @done_mutex = Mutex.new

  @todo     = []
  @workers  = []
  @timeouts = {}

  @spawned       = 0
  @waiting       = 0
  @shutdown      = false
  @trim_requests = 0
  @auto_trim     = false
  @idle_trim     = nil
  @timeout       = nil

  @mutex.synchronize {
    min.times {
      spawn_thread
    }
  }
end

Class Attribute Details

.abort_on_exception ⇒ Object

If true, tasks will allow raised exceptions to pass through.

Similar to Thread.abort_on_exception



339
340
341
 
# File 'lib/balotelli/thread/pool.rb', line 339

def abort_on_exception
  @abort_on_exception
end

Instance Attribute Details

#max ⇒ Object (readonly)

Returns the value of attribute max.



107
108
109
 
# File 'lib/balotelli/thread/pool.rb', line 107

def max
  @max
end

#min ⇒ Object (readonly)

Returns the value of attribute min.



107
108
109
 
# File 'lib/balotelli/thread/pool.rb', line 107

def min
  @min
end

#spawned ⇒ Object (readonly)

Returns the value of attribute spawned.



107
108
109
 
# File 'lib/balotelli/thread/pool.rb', line 107

def spawned
  @spawned
end

#waiting ⇒ Object (readonly)

Returns the value of attribute waiting.



107
108
109
 
# File 'lib/balotelli/thread/pool.rb', line 107

def waiting
  @waiting
end

Class Method Details

.cpu_count ⇒ Object 



341
342
343
344
345
 
# File 'lib/balotelli/thread/pool.rb', line 341

def cpu_count
  Etc.nprocessors * 2
rescue
  16
end

Instance Method Details

#auto_trim! ⇒ Object

Enable auto trimming, unneeded threads will be deleted until the minimum is reached.



158
159
160
161
162
 
# File 'lib/balotelli/thread/pool.rb', line 158

def auto_trim!
  @auto_trim = true

  self
end

#auto_trim? ⇒ Boolean

Check if auto trimming is enabled.

Returns:

  • (Boolean) 


152
153
154
 
# File 'lib/balotelli/thread/pool.rb', line 152

def auto_trim?
  @auto_trim
end

#backlog ⇒ Object

Get the amount of tasks that still have to be run.



200
201
202
203
204
 
# File 'lib/balotelli/thread/pool.rb', line 200

def backlog
  @mutex.synchronize {
    @todo.length
  }
end

#done? ⇒ Boolean

Are all tasks consumed?

Returns:

  • (Boolean) 


207
208
209
210
211
 
# File 'lib/balotelli/thread/pool.rb', line 207

def done?
  @mutex.synchronize {
    _done?
  }
end

#idle? ⇒ Boolean

Check if there are idle workers.

Returns:

  • (Boolean) 


239
240
241
242
243
 
# File 'lib/balotelli/thread/pool.rb', line 239

def idle?
  @mutex.synchronize {
    _idle?
  }
end

#idle_trim!(timeout) ⇒ Object

Enable idle trimming. Unneeded threads will be deleted after the given number of seconds of inactivity. The minimum number of threads is respeced.



178
179
180
181
182
 
# File 'lib/balotelli/thread/pool.rb', line 178

def idle_trim!(timeout)
  @idle_trim = timeout

  self
end

#idle_trim? ⇒ Boolean

Check if idle trimming is enabled.

Returns:

  • (Boolean) 


172
173
174
 
# File 'lib/balotelli/thread/pool.rb', line 172

def idle_trim?
  !@idle_trim.nil?
end

#no_auto_trim! ⇒ Object

Disable auto trimming.



165
166
167
168
169
 
# File 'lib/balotelli/thread/pool.rb', line 165

def no_auto_trim!
  @auto_trim = false

  self
end

#no_idle_trim! ⇒ Object

Turn of idle trimming.



185
186
187
188
189
 
# File 'lib/balotelli/thread/pool.rb', line 185

def no_idle_trim!
  @idle_trim = nil

  self
end

#process(*args, &block) ⇒ Object Also known as: <<

Add a task to the pool which will execute the block with the given argument.

If no block is passed the default block will be used if present, an ArgumentError will be raised otherwise.



250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/balotelli/thread/pool.rb', line 250

def process(*args, &block)
  unless block || @block
    raise ArgumentError, 'you must pass a block'
  end

  task = Task.new(self, *args, &(block || @block))

  @mutex.synchronize {
    raise 'unable to add work while shutting down' if shutdown?

    @todo << task

    if @waiting == 0 && @spawned < @max
      spawn_thread
    end

    @cond.signal
  }

  task
end

#resize(min, max = nil) ⇒ Object

Resize the pool with the passed arguments.



192
193
194
195
196
197
 
# File 'lib/balotelli/thread/pool.rb', line 192

def resize(min, max = nil)
  @min = min
  @max = max || min

  trim!
end

#shutdown ⇒ Object

Shut down the pool, it will block until all tasks have finished running.



305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/balotelli/thread/pool.rb', line 305

def shutdown
  @mutex.synchronize {
    @shutdown = :nicely
    @cond.broadcast
  }

  until @workers.empty?
    if worker = @workers.first
      worker.join
    end
  end

  if @timeout
    @shutdown = :now

    wake_up_timeout

    @timeout.join
  end
end

#shutdown! ⇒ Object

Shut down the pool instantly without finishing to execute tasks.



293
294
295
296
297
298
299
300
301
302
 
# File 'lib/balotelli/thread/pool.rb', line 293

def shutdown!
  @mutex.synchronize {
    @shutdown = :now
    @cond.broadcast
  }

  wake_up_timeout

  self
end

#shutdown? ⇒ Boolean

Check if the pool has been shut down.

Returns:

  • (Boolean) 


147
148
149
 
# File 'lib/balotelli/thread/pool.rb', line 147

def shutdown?
  !!@shutdown
end

#shutdown_after(timeout) ⇒ Object

Shutdown the pool after a given amount of time.



327
328
329
330
331
332
333
 
# File 'lib/balotelli/thread/pool.rb', line 327

def shutdown_after(timeout)
  Thread.new {
    sleep timeout

    shutdown
  }
end

#trim(force = false) ⇒ Object

Trim the unused threads, if forced threads will be trimmed even if there are tasks waiting.



276
277
278
279
280
281
282
283
284
285
 
# File 'lib/balotelli/thread/pool.rb', line 276

def trim(force = false)
  @mutex.synchronize {
    if (force || @waiting > 0) && @spawned - @trim_requests > @min
      @trim_requests += 1
      @cond.signal
    end
  }

  self
end

#trim! ⇒ Object

Force ##trim.



288
289
290
 
# File 'lib/balotelli/thread/pool.rb', line 288

def trim!
  trim true
end

#wait(what = :idle) ⇒ Object

Wait until all tasks are consumed. The caller will be blocked until then.



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/balotelli/thread/pool.rb', line 214

def wait(what = :idle)
  case what
  when :done
    until done?
      @done_mutex.synchronize {
        break if _done?

        @done.wait @done_mutex
      }
    end

  when :idle
    until idle?
      @done_mutex.synchronize {
        break if _idle?

        @done.wait @done_mutex
      }
    end
  end

  self
end