t.i.b.DelayedCall : class documentation

Part of twisted.internet.base View Source View In Hierarchy

No class docstring
Method __init__ No summary
Method getTime Return the time at which this call will fire
Method cancel Unschedule this call
Method reset Reschedule this call for a different time
Method delay Reschedule this call for a later time
Method activate_delay Undocumented
Method active Determine whether this call is still pending
Method __le__ Implement <= operator between two DelayedCall instances.
Method __lt__ Implement < operator between two DelayedCall instances.
Method __str__ Undocumented
def __init__(self, time, func, args, kw, cancel, reset, seconds=runtimeSeconds): (source)
ParameterstimeSeconds from the epoch at which to call func.
funcThe callable to call.
argsThe positional arguments to pass to the callable.
kwThe keyword arguments to pass to the callable.
cancelA callable which will be called with this DelayedCall before cancellation.
resetA callable which will be called with this DelayedCall after changing this DelayedCall's scheduled execution time. The callable should adjust any necessary scheduling details to ensure this DelayedCall is invoked at the new appropriate time.
secondsIf provided, a no-argument callable which will be used to determine the current time any time that information is needed.
def getTime(self): (source)
Return the time at which this call will fire
ReturnsThe number of seconds after the epoch at which this call is scheduled to be made. (type: float)
def cancel(self): (source)
Unschedule this call
RaisesAlreadyCancelledRaised if this call has already been unscheduled.
AlreadyCalledRaised if this call has already been made.
def reset(self, secondsFromNow): (source)
Reschedule this call for a different time
ParameterssecondsFromNowThe number of seconds from the time of the reset call at which this call will be scheduled. (type: float)
RaisesAlreadyCancelledRaised if this call has been cancelled.
AlreadyCalledRaised if this call has already been made.
def delay(self, secondsLater): (source)
Reschedule this call for a later time
ParameterssecondsLaterThe number of seconds after the originally scheduled time for which to reschedule this call. (type: float)
RaisesAlreadyCancelledRaised if this call has been cancelled.
AlreadyCalledRaised if this call has already been made.
def activate_delay(self): (source)
Undocumented
def active(self): (source)
Determine whether this call is still pending
ReturnsTrue if this call has not yet been made or cancelled, False otherwise. (type: bool)
def __le__(self, other): (source)
Implement <= operator between two DelayedCall instances.

Comparison is based on the time attribute (unadjusted by the delayed time).

def __lt__(self, other): (source)
Implement < operator between two DelayedCall instances.

Comparison is based on the time attribute (unadjusted by the delayed time).

def __str__(self): (source)
Undocumented
API Documentation for Twisted, generated by pydoctor at 2014-05-12 18:27:00.