twisted.python.threadpool.ThreadPool : API documentation

This class (hopefully) generalizes the functionality of a pool of threads to which work can be dispatched.

callInThread() and stop() should only be called from a single thread, unless you make a subclass where stop() and _startSomeWorkers() are synchronized.

Method	__init__	Create a new threadpool.
Method	start	Start the threadpool.
Method	startAWorker	Undocumented
Method	stopAWorker	Undocumented
Method	__setstate__	Undocumented
Method	__getstate__	Undocumented
Method	dispatch	DEPRECATED: use `callInThread` instead.
Method	callInThread	Call a callable object in a separate thread.
Method	callInThreadWithCallback	Call a callable object in a separate thread and call onResult with the return value, or a `twisted.python.failure.Failure` if the callable raises an exception.
Method	dispatchWithCallback	DEPRECATED: use `twisted.internet.threads.deferToThread` instead.
Method	stop	Shutdown the threads in the threadpool.
Method	adjustPoolsize	Undocumented
Method	dumpStats	Undocumented
Method	_startSomeWorkers	Undocumented
Method	_runWithCallback	Undocumented
Method	_worker	Method used as target of the created threads: retrieve task to run from the threadpool, run it, and proceed to the next task until threadpool is stopped.

def __init__(self, minthreads=5, maxthreads=20, name=None): (source)

Create a new threadpool.

Parameters	minthreads	minimum number of threads in the pool
	maxthreads	maximum number of threads in the pool

def start(self): (source)

Start the threadpool.

def startAWorker(self): (source)

Undocumented

def stopAWorker(self): (source)

Undocumented

def __setstate__(self, state): (source)

Undocumented

def __getstate__(self): (source)

Undocumented

def _startSomeWorkers(self): (source)

Undocumented

def dispatch(self, owner, func, *args, **kw): (source)

DEPRECATED: use callInThread instead.

Dispatch a function to be a run in a thread.

def callInThread(self, func, *args, **kw): (source)

Call a callable object in a separate thread.

Parameters	func	callable object to be called in separate thread
	*args	positional arguments to be passed to func
	**kw	keyword args to be passed to func

def callInThreadWithCallback(self, onResult, func, *args, **kw): (source)

Call a callable object in a separate thread and call onResult with the return value, or a twisted.python.failure.Failure if the callable raises an exception.

The callable is allowed to block, but the onResult function must not block and should perform as little work as possible.

A typical action for onResult for a threadpool used with a Twisted reactor would be to schedule a Deferred to fire in the main reactor thread using .callFromThread. Note that onResult is called inside the separate thread, not inside the reactor thread.

Parameters	onResult	a callable with the signature (success, result). If the callable returns normally, onResult is called with (True, result) where result is the return value of the callable. If the callable throws an exception, onResult is called with (False, failure). Optionally, onResult may be None, in which case it is not called at all.
	func	callable object to be called in separate thread
	*args	positional arguments to be passed to func
	**kwargs	keyword arguments to be passed to func

def _runWithCallback(self, callback, errback, func, args, kwargs): (source)

Undocumented

def dispatchWithCallback(self, owner, callback, errback, func, *args, **kw): (source)

DEPRECATED: use twisted.internet.threads.deferToThread instead.

Dispatch a function, returning the result to a callback function.

The callback function will be called in the thread - make sure it is thread-safe.

t.p.t.ThreadPool : class documentation