.. _fbf.lib.tick:

tick
~~~~

.. automodule:: fbf.lib.tick
        :show-inheritance:
        :members:
        :undoc-members:

CODE
----

    ::

        # fbf/tick.py
        #
        #
        
        """ provide system wide clock tick. """
        
.. _fbf.lib.tick_fbf_imports:

fbf imports
--------------

    ::

        
        from fbf.lib.threadloop import TimedLoop
        from fbf.lib.eventbase import EventBase
        from fbf.lib.callbacks import callbacks
        from fbf.lib.config import getmainconfig
        
.. _fbf.lib.tick_TickLoop_class:

TickLoop class
-----------------

    ::

        
        class TickLoop(TimedLoop):
        
        
            def start(self, bot=None):
                """ start the loop. """
                self.bot = bot
                self.counter = 0
                TimedLoop.start(self)
        
            def handle(self):
                """ send TICK events to callback. """
                self.counter += 1
                event = EventBase()
                event.nolog = True
                event.nobind = True
                if self.counter % 60 == 0:
                    event.type = event.cbtype = 'TICK60'
                    callbacks.check(self.bot, event)
                if self.counter % 10 == 0:
                    event.type = event.cbtype = 'TICK10'
                    callbacks.check(self.bot, event)
                maincfg = getmainconfig()
                t = maincfg.ticksleep or 1
                if self.counter % t == 0:
                    event.type = event.cbtype = 'TICK'
                    callbacks.check(self.bot, event)
        
.. _fbf.lib.tick_global_tick_loop:

global tick loop
-------------------

    ::

        
        tickloop = TickLoop('tickloop', 1)