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`.`tcp`.`_FileDescriptorReservation``

class documentation

`class _FileDescriptorReservation: (source)`

Implements interfaces: `twisted.internet.tcp._IFileDescriptorReservation`

View In Hierarchy

`_IFileDescriptorReservation` implementation.

Method | `__enter__` | See `_IFileDescriptorReservation.__enter__`.
Method | `__exit__` | See `_IFileDescriptorReservation.__exit__`.
Method | `available` | See `_IFileDescriptorReservation.available`.
Method | `reserve` | See `_IFileDescriptorReservation.reserve`.
Instance Variable | `fileFactory` | A factory that will be called to reserve a file descriptor.
Class Variable | `_log` | Undocumented
Instance Variable | `_fileDescriptor` | Undocumented
Instance Variable | `_fileFactory` | Undocumented

def __enter__(self): (source)
from `twisted.internet.tcp._IFileDescriptorReservation`

See `_IFileDescriptorReservation.__enter__`.

def __exit__(self, excType, excValue, traceback): (source)
from `twisted.internet.tcp._IFileDescriptorReservation`

See `_IFileDescriptorReservation.__exit__`.

def available(self): (source)
from `twisted.internet.tcp._IFileDescriptorReservation`

See `_IFileDescriptorReservation.available`.

Returns
`True` if the reserved file descriptor is open and can thus be closed to allow a new file to be opened in its place; `False` if it is not open.

def reserve(self): (source)
from `twisted.internet.tcp._IFileDescriptorReservation`

See `_IFileDescriptorReservation.reserve`.

fileFactory: A `callable` that accepts no arguments and returns an object with a `close` method. = (source)

A factory that will be called to reserve a file descriptor.

_log: `ClassVar[Logger]` = (source)

Undocumented

_fileDescriptor: `Optional[_HasClose]` = (source)

Undocumented

_fileFactory: `Callable[[], _HasClose]` = (source)

Undocumented