Package buildbot :: Module interfaces :: Class IStatusReceiver
[frames] | no frames]

Class IStatusReceiver

source code

zope.interface.Interface --+
                           |
                          IStatusReceiver

I am an object which can receive build status updates. I may be subscribed to an IStatus, an IBuilderStatus, or an IBuildStatus.

Instance Methods
 
buildsetSubmitted(buildset)
A new BuildSet has been submitted to the buildmaster.
source code
 
requestSubmitted(request)
A new BuildRequest has been submitted to the buildmaster.
source code
 
requestCancelled(builder, request)
A BuildRequest has been cancelled on the given Builder.
source code
implementor of IStatusReceiver
builderAdded(builderName, builder)
A new Builder has just been added.
source code
 
builderChangedState(builderName, state)
Builder 'builderName' has changed state.
source code
 
buildStarted(builderName, build)
Builder 'builderName' has just started a build.
source code
 
buildETAUpdate(build, ETA)
This is a periodic update on the progress this Build has made towards completion.
source code
 
changeAdded(change)
A new Change was added to the ChangeMaster.
source code
 
stepStarted(build, step)
A step has just started.
source code
 
stepTextChanged(build, step, text)
The text for a step has been updated.
source code
 
stepText2Changed(build, step, text2)
The text2 for a step has been updated.
source code
 
stepETAUpdate(build, step, ETA, expectations)
This is a periodic update on the progress this Step has made towards completion.
source code
 
logStarted(build, step, log)
A new Log has been started, probably because a step has just started running a shell command.
source code
 
logChunk(build, step, log, channel, text)
Some text has been added to this log.
source code
 
logFinished(build, step, log)
A Log has been closed.
source code
 
stepFinished(build, step, results)
A step has just finished.
source code
 
buildFinished(builderName, build, results)
A build has just finished.
source code
 
builderRemoved(builderName)
The Builder has been removed.
source code
 
slaveConnected(slaveName)
The slave has connected.
source code
 
slaveDisconnected(slaveName)
The slave has disconnected.
source code
Class Variables
  __bases__ = (<InterfaceClass zope.interface.Interface>)
  __identifier__ = 'buildbot.interfaces.IStatusReceiver'
  __iro__ = (<InterfaceClass buildbot.interfaces.IStatusReceiver...
  __name__ = 'IStatusReceiver'
  __sro__ = (<InterfaceClass buildbot.interfaces.IStatusReceiver...
  dependents = <WeakKeyDictionary at 21578816>
Method Details

buildsetSubmitted(buildset)

source code 

A new BuildSet has been submitted to the buildmaster.

Parameters:

requestSubmitted(request)

source code 

A new BuildRequest has been submitted to the buildmaster.

Parameters:

requestCancelled(builder, request)

source code 

A BuildRequest has been cancelled on the given Builder.

Parameters:

builderAdded(builderName, builder)

source code 

A new Builder has just been added. This method may return an IStatusReceiver (probably 'self') which will be subscribed to receive builderChangedState and buildStarted/Finished events.

Parameters:
Returns: implementor of IStatusReceiver

builderChangedState(builderName, state)

source code 

Builder 'builderName' has changed state. The possible values for 'state' are 'offline', 'idle', and 'building'.

buildStarted(builderName, build)

source code 

Builder 'builderName' has just started a build. The build is an object which implements IBuildStatus, and can be queried for more information.

This method may return an IStatusReceiver (it could even return 'self'). If it does so, stepStarted and stepFinished methods will be invoked on the object for the steps of this one build. This is a convenient way to subscribe to all build steps without missing any. This receiver will automatically be unsubscribed when the build finishes.

It can also return a tuple of (IStatusReceiver, interval), in which case buildETAUpdate messages are sent ever 'interval' seconds, in addition to the stepStarted and stepFinished messages.

changeAdded(change)

source code 

A new Change was added to the ChangeMaster. By the time this event is received, all schedulers have already received the change.

stepStarted(build, step)

source code 

A step has just started. 'step' is the IBuildStepStatus which represents the step: it can be queried for more information.

This method may return an IStatusReceiver (it could even return 'self'). If it does so, logStarted and logFinished methods will be invoked on the object for logs created by this one step. This receiver will be automatically unsubscribed when the step finishes.

Alternatively, the method may return a tuple of an IStatusReceiver and an integer named 'updateInterval'. In addition to logStarted/logFinished messages, it will also receive stepETAUpdate messages about every updateInterval seconds.

stepTextChanged(build, step, text)

source code 

The text for a step has been updated.

This is called when calling setText() on the step status, and hands in the text list.

stepText2Changed(build, step, text2)

source code 

The text2 for a step has been updated.

This is called when calling setText2() on the step status, and hands in text2 list.

stepETAUpdate(build, step, ETA, expectations)

source code 

This is a periodic update on the progress this Step has made towards completion. It gets an ETA (in seconds from the present) of when the step ought to be complete, and a list of expectation tuples (as returned by IBuildStepStatus.getExpectations) with more detailed information.

logStarted(build, step, log)

source code 

A new Log has been started, probably because a step has just started running a shell command. 'log' is the IStatusLog object which can be queried for more information.

This method may return an IStatusReceiver (such as 'self'), in which case the target's logChunk method will be invoked as text is added to the logfile. This receiver will automatically be unsubsribed when the log finishes.

logChunk(build, step, log, channel, text)

source code 

Some text has been added to this log. 'channel' is one of LOG_CHANNEL_STDOUT, LOG_CHANNEL_STDERR, or LOG_CHANNEL_HEADER, as defined in IStatusLog.getChunks.

stepFinished(build, step, results)

source code 

A step has just finished. 'results' is the result tuple described in IBuildStepStatus.getResults.

buildFinished(builderName, build, results)

source code 

A build has just finished. 'results' is the result tuple described in IBuildStatus.getResults.

Parameters:

Class Variable Details

__iro__

Value:
(<InterfaceClass buildbot.interfaces.IStatusReceiver>,
 <InterfaceClass zope.interface.Interface>)

__sro__

Value:
(<InterfaceClass buildbot.interfaces.IStatusReceiver>,
 <InterfaceClass zope.interface.Interface>)