ThreadPuddle

Like a smaller, lamer thread pool.

---

Public Class Methods

ThreadPuddle.new(capacity, klass=Thread)

Creates a new ThreadPuddle object, with a fixed capacity.

To use with a different threading model, specify a different klass, for example:

tp = ThreadPuddle.new c, ForkingThread

Public Instance Methods

tp.capacity → int

Retrieves the ThreadPuddle object's capacity.

tp.size → int

Number of threads currently occupying the puddle.

tp.block → tp

Blocks execution of the calling thread until there's a free slot in the puddle.

WARNING: there is no guarantee this will ever return.

tp.spawn(*args) {|*args| ... } → Thread

Spawns a new thread in the puddle.

If the puddle is full, this call blocks.

 @yields *args
 @see ThreadPuddle#block
 @return the new Thread object

tp.join → tp

Waits for all threads in the puddle to join.

 @return this ThreadPuddle object

tp.kill → int

Kills all threads in the puddle.

 @return the number of threads killed

Contributing

We require all contributors to comply with the Developer Certificate of Origin. This ensures that all contributions are properly licensed and attributed.

Contributor Code of Conduct

This repository is subject to a Contributor Code of Conduct adapted from the Contributor Covenant, version 3.0, available at https://www.contributor-covenant.org/version/3/0/

Licence

This project is licensed under the ISC licence. See LICENSE for details

Copyright (c) 2013, Matthew Kerwin <matthew@kerwin.net.au>

Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.