t.p.t.ThreadPool : class documentation

Part of twisted.python.threadpool View Source View In Hierarchy

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	Undocumented
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)

Undocumented

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.

def _worker(self): (source)

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 stop(self): (source)

Shutdown the threads in the threadpool.

def adjustPoolsize(self, minthreads=None, maxthreads=None): (source)

Undocumented

def dumpStats(self): (source)

Undocumented

API Documentation for Twisted, generated by pydoctor at 2011-10-27 15:57:47.