Package twisted :: Package internet :: Module interfaces :: Class IDelayedCall
[show private | hide private]
[frames | no frames]

Class IDelayedCall

Interface --+
            |
           IDelayedCall


A scheduled call.

There are probably other useful methods we can add to this interface; suggestions are welcome.
Method Summary
  cancel(self)
Cancel the scheduled call.
  delay(self, secondsLater)
Delay the scheduled call.
  reset(self, secondsFromNow)
Reset the scheduled call's timer.

Method Details

cancel(self)

Cancel the scheduled call.
Raises:
twisted.internet.error.AlreadyCalled - if the call has already happened.
twisted.internet.error.AlreadyCancelled - if the call has already been cancelled.

delay(self, secondsLater)

Delay the scheduled call.
Parameters:
secondsLater - how many seconds from its current firing time to delay
Raises:
twisted.internet.error.AlreadyCalled - if the call has already happened.
twisted.internet.error.AlreadyCancelled - if the call has already been cancelled.

reset(self, secondsFromNow)

Reset the scheduled call's timer.
Parameters:
secondsFromNow - how many seconds from now it should fire, equivalent to self.cancel() and then doing another reactor.callLater(secondsLater, ...)
Raises:
twisted.internet.error.AlreadyCalled - if the call has already happened.
twisted.internet.error.AlreadyCancelled - if the call has already been cancelled.

Generated by Epydoc 1.1 on Thu Apr 17 12:55:07 2003 http://epydoc.sf.net