t.p.j.b.Journal : class documentation

Part of twisted.persisted.journal.base View Source View In Hierarchy

Known subclasses: twisted.persisted.journal.base.MemoryJournal, twisted.persisted.journal.rowjournal.RowJournal

All commands to the system get routed through here.

Subclasses should implement the actual snapshotting capability.
Method __init__ Undocumented
Method updateFromLog Run all commands from log that haven't been run yet.
Method executeCommand Log and execute a command.
Method getLastSnapshot Return command index of the last snapshot taken.
Method sync Save journal to disk, returns Deferred of finish status.
Method _reallyExecute Callback called when logging command is done.
def __init__(self, log, journaledService): (source)
overridden in twisted.persisted.journal.base.MemoryJournal, twisted.persisted.journal.rowjournal.RowJournal
Undocumented
def updateFromLog(self): (source)

Run all commands from log that haven't been run yet.

This method should be run on startup to ensure the snapshot is up-to-date.
def executeCommand(self, command): (source)
Log and execute a command.
def _reallyExecute(self, index, command, runTime): (source)
Callback called when logging command is done.
def getLastSnapshot(self): (source)
overridden in twisted.persisted.journal.base.MemoryJournal, twisted.persisted.journal.rowjournal.RowJournal
Return command index of the last snapshot taken.
def sync(self, *args, **kwargs): (source)
overridden in twisted.persisted.journal.base.MemoryJournal, twisted.persisted.journal.rowjournal.RowJournal

Save journal to disk, returns Deferred of finish status.

Subclasses may choose whatever signature is appropriate, or may not implement this at all.
API Documentation for Twisted, generated by pydoctor at 2011-10-27 15:57:47.