Source code for iro.controller.pool

# Copyright (c) 2012 netzguerilla.net <iro@netzguerilla.net>
# 
# This file is part of Iro.
# 
# Permission is hereby granted, free of charge, to any person obtaining a copy of
# this software and associated documentation files (the "Software"), to deal in
# the Software without restriction, including without limitation the rights to use,
# copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
# #Software, and to permit persons to whom the Software is furnished to do so,
# subject to the following conditions:
# 
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
# 
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
# INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
# PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

from twisted.python.threadpool import ThreadPool
from twisted.internet import threads

class Pool:
    """wrapper class to handles a twisted threadpool"""
    def __init__(self,name,maxthreads):
        """
        :param string name: name of the threadpool
        :param integer maxthreads: how many thread a allowed at maximum
        """
        self.maxthreads = maxthreads
        self.pool =  ThreadPool(minthreads=1, maxthreads=maxthreads, name=name)
        self.reactor = None

    def start(self, reactor):
        """stats the pool and adds the pool.stop function to the stop procedure.
        
        :param reactor: a valid twisted reactor
        """
        self.pool.start()
        self.reactor = reactor
        self.reactor.addSystemEventTrigger('before', 'shutdown', self.pool.stop)

    def run(self,f,*args,**kwargs):
        """run a function in Twisted's thread pool"""
        return threads.deferToThreadPool(self.reactor, self.pool, f, *args, **kwargs)

taskPool = Pool('task',5)
"""taskpool to handle sending data"""

dbPool = Pool('database',5)
"""pool to handle database connection via sqlalchemy""" 

pools=[taskPool,dbPool]
"""all available pools"""

def startPool(reactor):
    '''run start function for all items in :attr:`pools`'''
    for pool in pools:
        pool.start(reactor)

__all__=["Pool", "startPool", "dbPool", "taskPool", "pools"]