Package buildbot :: Package schedulers :: Module timed :: Class Periodic

Class Periodic

 twisted.application.service.Service --+            
                                       |            
twisted.application.service.MultiService --+        
                                           |        
                    util.ComparableMixin --+        
                                           |        
                          base.BaseScheduler --+    
                                               |    
                                           Timed --+
                                                   |
                                                  Periodic

Instance Methods

__init__(self, name, builderNames, periodicBuildTimer, branch=None, properties={}, onlyImportant=False)
Initialize a Scheduler. source code

getNextBuildTime(self, lastActuated)
Called by to calculate the next time to actuate a BuildSet.

source code

startBuild(self)
The time has come to start a new build.

source code

Inherited from Timed: getPendingBuildTimes, now, scheduleNextBuild, startService, startTimedSchedulerService, stopService

Inherited from base.BaseScheduler: __provides__, addBuildsetForChanges, addBuildsetForChangesMultiRepo, addBuildsetForLatest, addBuildsetForSourceStamp, findNewSchedulerInstance, getState, gotChange, listBuilderNames, setState, startConsumingChanges

Inherited from twisted.application.service.MultiService: __iter__, addService, getServiceNamed, privilegedStartService, removeService

Inherited from twisted.application.service.Service: __getstate__, __providedBy__, disownServiceParent, setName, setServiceParent

Inherited from util.ComparableMixin: __cmp__, __hash__

Class Variables

compare_attrs = ('name', 'builderNames', 'properties', 'period...

Inherited from base.BaseScheduler: __implemented__

Inherited from twisted.application.service.Service: parent, running

Instance Variables
Inherited from `base.BaseScheduler`: `builderNames`, `name`, `properties`

Method Details

init(self, name, builderNames, periodicBuildTimer, branch=None, properties=`{}`, onlyImportant=False)
(Constructor)

source code

Initialize a Scheduler.

Parameters:

name - name of this scheduler (used as a key for state)
builderNames - list of builders this scheduler may start
properties - properties to add to builds triggered by this scheduler
consumeChanges - true if this scheduler wishes to be informed about the addition of new changes. Defaults to False. This should be passed explicitly from subclasses to indicate their interest in consuming changes.

Overrides: twisted.application.service.MultiService.__init__

getNextBuildTime(self, lastActuated)

source code

Called by to calculate the next time to actuate a BuildSet. Override in subclasses. To trigger a fresh call to this method, use rescheduleNextBuild.

Parameters:

lastActuation - the time of the last actuation, or None for never

Returns:

a Deferred firing with the next time a build should occur (in the future), or None for never.

Overrides: Timed.getNextBuildTime

(inherited documentation)

startBuild(self)

source code

The time has come to start a new build. Returns a Deferred. Override in subclasses.

Overrides: Timed.startBuild: (inherited documentation)

Class Variable Details

compare_attrs

Value:

('name', 'builderNames', 'properties', 'periodicBuildTimer', 'branch')

Class Periodic

__init__(self, name, builderNames, periodicBuildTimer, branch=None, properties={}, onlyImportant=False) (Constructor)

getNextBuildTime(self, lastActuated)

startBuild(self)

compare_attrs

init(self, name, builderNames, periodicBuildTimer, branch=None, properties=`{}`, onlyImportant=False)
(Constructor)