The heat.openstack.common.loopingcall Module

class heat.openstack.common.loopingcall.LoopingCall(f=None, *args, **kw)

Bases: object

start(interval, initial_delay=None)

stop()

wait()

exception heat.openstack.common.loopingcall.LoopingCallDone(retvalue=True)

Bases: exceptions.Exception

Exception to break out and stop a LoopingCall.

The poll-function passed to LoopingCall can raise this exception to break out of the loop normally. This is somewhat analogous to StopIteration.

An optional return-value can be included as the argument to the exception; this return-value will be returned by LoopingCall.wait()