The oslo_vmware.common.loopingcall Module

class oslo_vmware.common.loopingcall.DynamicLoopingCall(f=None, *args, **kw)

Bases: oslo_vmware.common.loopingcall.LoopingCallBase

A looping call which sleeps until the next known event.

The function called should return how long to sleep for before being called again.

start(initial_delay=None, periodic_interval_max=None)

class oslo_vmware.common.loopingcall.FixedIntervalLoopingCall(f=None, *args, **kw)

Bases: oslo_vmware.common.loopingcall.LoopingCallBase

A fixed interval looping call.

start(interval, initial_delay=None)

oslo_vmware.common.loopingcall.LoopingCall

alias of FixedIntervalLoopingCall

class oslo_vmware.common.loopingcall.LoopingCallBase(f=None, *args, **kw)

Bases: object

stop()

wait()

exception oslo_vmware.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()