Go to the latest version of this document.
search in docstrings

Search bar offers the following options:

- Term presence. The below example searches for documents that must contain “foo”, might contain “bar” and must not contain “baz”: `+foo bar -baz`
- Wildcards. The below example searches for documents with words beginning with “foo”: `foo*`
- Search in specific fields. The following search matches all objects in "twisted.mail" that matches “search”: `+qname:twisted.mail.* +search`

  Possible fields: 'name', 'qname' (fully qualified name), 'docstring', and 'kind'. Last two fields are only applicable if "search in docstrings" is enabled.

- Fuzzy matches. The following search matches all documents that have a word within 1 edit distance of “foo”: `foo~1`

Results provided by Lunr.js

# ``twisted`.`internet`.`interfaces`.`IDelayedCall``

interface documentation

`class IDelayedCall(Interface): (source)`

Known implementations: `twisted.internet.base.DelayedCall`

View In Hierarchy

A scheduled call.

There are probably other useful methods we can add to this interface; suggestions are welcome.

Method | `active` | No summary
Method | `cancel` | Cancel the scheduled call.
Method | `delay` | Delay the scheduled call.
Method | `getTime` | Get time when delayed call will happen.
Method | `reset` | Reset the scheduled call's timer.

def active(): (source)

Returns
`bool` | True if this call is still active, False if it has been called or cancelled.

def cancel(): (source)

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.

def delay(secondsLater): (source)

Delay the scheduled call.

Parameters
secondsLater:`float` | 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.

def getTime(): (source)

Get time when delayed call will happen.

Returns
`float` | time in seconds since epoch (a float).

def reset(secondsFromNow): (source)

Reset the scheduled call's timer.

Parameters
secondsFromNow:`float` | how many seconds from now it should fire, equivalent to `.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.