Package Jobber :: Module interfaces :: Class IJobLogFile

Class IJobLogFile

zope.interface.Interface --+
                           |
                          IJobLogFile

Job output of any kind.

Instance Methods

[hide private]

write(data)
Write data to the Log. source code

finish()
No further data will be added to the log file, so close it and notify anyone who cares.

source code

subscribe(subscriber, catchup=False)
Register to receive output as data is added to the log.

source code

unsubscribe(subscriber)
Remove a previously registered subscriber.

source code

getStatus()
Return the IJobStatus that owns this log.

source code

getFilename()
Return the filename of the file on disk containing the log data.

source code

isFinished()
Return a boolean indicating whether or not the log has finished.

source code

waitUntilFinished()
Return a Deferred that will fire when the log finishes.

source code

Method Details

[hide private]

subscribe(subscriber, catchup=False)

source code

Register to receive output as data is added to the log. If catchup is True, log contents up to that point will be returned immediately to the receiver.

Parameters:

subscriber (file-like) - The receiver of data as it comes in

waitUntilFinished()

source code

Return a Deferred that will fire when the log finishes. If the log has finished, this Deferred will fire right away.