Go to the latest version of this document.

# All Documents

- twisted
  index.html
  Package
  Package
  PUBLIC
  Twisted: The Framework Of Your Internet.
- twisted.__main__
  twisted.__main__.html
  Module
  Module
  PRIVATE
  Undocumented
- twisted._threads
  twisted._threads.html
  Package
  Package
  PRIVATE
  Twisted integration with operating system threads.
- twisted._threads._convenience
  twisted._threads._convenience.html
  Module
  Module
  PRIVATE
  Common functionality used within the implementation of various workers.
- twisted._threads._ithreads
  twisted._threads._ithreads.html
  Module
  Module
  PRIVATE
  Interfaces related to threads.
- twisted._threads._memory
  twisted._threads._memory.html
  Module
  Module
  PRIVATE
  Implementation of an in-memory worker that defers execution.
- twisted._threads._pool
  twisted._threads._pool.html
  Module
  Module
  PRIVATE
  Top level thread pool interface, used to implement `twisted.python.threadpool`.
- twisted._threads._team
  twisted._threads._team.html
  Module
  Module
  PRIVATE
  Implementation of a `Team` of workers; a thread-pool that can allocate work to workers.
- twisted._threads._threadworker
  twisted._threads._threadworker.html
  Module
  Module
  PRIVATE
  Implementation of an `IWorker` based on native threads and queues.
- twisted._version
  twisted._version.html
  Module
  Module
  PRIVATE
  Provides Twisted version information.
- twisted.application
  twisted.application.html
  Package
  Package
  PUBLIC
  Configuration objects for Twisted Applications.
- twisted.application.app
  twisted.application.app.html
  Module
  Module
  PUBLIC
  No module docstring; 2/10 functions, 7/8 classes documented
- twisted.application.internet
  twisted.application.internet.html
  Module
  Module
  PUBLIC
  Reactor-based Services
- twisted.application.reactors
  twisted.application.reactors.html
  Module
  Module
  PUBLIC
  Plugin-based system for enumerating available reactors and installing one of them.
- twisted.application.runner
  twisted.application.runner.html
  Package
  Package
  PUBLIC
  Facilities for running a Twisted application.
- twisted.application.runner._exit
  twisted.application.runner._exit.html
  Module
  Module
  PRIVATE
  System exit support.
- twisted.application.runner._pidfile
  twisted.application.runner._pidfile.html
  Module
  Module
  PRIVATE
  PID file.
- twisted.application.runner._runner
  twisted.application.runner._runner.html
  Module
  Module
  PRIVATE
  Twisted application runner.
- twisted.application.service
  twisted.application.service.html
  Module
  Module
  PUBLIC
  Service architecture for Twisted.
- twisted.application.strports
  twisted.application.strports.html
  Module
  Module
  PUBLIC
  Construct listening port services from a simple string description.
- twisted.application.twist
  twisted.application.twist.html
  Package
  Package
  PUBLIC
  `twist` command line tool.
- twisted.application.twist._options
  twisted.application.twist._options.html
  Module
  Module
  PRIVATE
  Command line options for `twist`.
- twisted.application.twist._twist
  twisted.application.twist._twist.html
  Module
  Module
  PRIVATE
  Run a Twisted application.
- twisted.conch
  twisted.conch.html
  Package
  Package
  PUBLIC
  Twisted Conch: The Twisted Shell. Terminal emulation, SSHv2 and telnet.
- twisted.conch.avatar
  twisted.conch.avatar.html
  Module
  Module
  PUBLIC
  Undocumented
- twisted.conch.checkers
  twisted.conch.checkers.html
  Module
  Module
  PUBLIC
  Provide `ICredentialsChecker` implementations to be used in Conch protocols.
- twisted.conch.client
  twisted.conch.client.html
  Package
  Package
  PUBLIC
  Client support code for Conch.
- twisted.conch.client.agent
  twisted.conch.client.agent.html
  Module
  Module
  PUBLIC
  Accesses the key agent for user authentication.
- twisted.conch.client.connect
  twisted.conch.client.connect.html
  Module
  Module
  PUBLIC
  Undocumented
- twisted.conch.client.default
  twisted.conch.client.default.html
  Module
  Module
  PUBLIC
  Various classes and functions for implementing user-interaction in the command-line conch client.
- twisted.conch.client.direct
  twisted.conch.client.direct.html
  Module
  Module
  PUBLIC
  Undocumented
- twisted.conch.client.knownhosts
  twisted.conch.client.knownhosts.html
  Module
  Module
  PUBLIC
  An implementation of the OpenSSH known_hosts database.
- twisted.conch.client.options
  twisted.conch.client.options.html
  Module
  Module
  PUBLIC
  Undocumented
- twisted.conch.endpoints
  twisted.conch.endpoints.html
  Module
  Module
  PUBLIC
  Endpoint implementations of various SSH interactions.
- twisted.conch.error
  twisted.conch.error.html
  Module
  Module
  PUBLIC
  An error to represent bad things happening in Conch.
- twisted.conch.insults
  twisted.conch.insults.html
  Package
  Package
  PUBLIC
  Insults: a replacement for Curses/S-Lang.
- twisted.conch.insults.helper
  twisted.conch.insults.helper.html
  Module
  Module
  PUBLIC
  Partial in-memory terminal emulator
- twisted.conch.insults.insults
  twisted.conch.insults.insults.html
  Module
  Module
  PUBLIC
  VT102 and VT220 terminal manipulation.
- twisted.conch.insults.text
  twisted.conch.insults.text.html
  Module
  Module
  PUBLIC
  Character attribute manipulation API.
- twisted.conch.insults.window
  twisted.conch.insults.window.html
  Module
  Module
  PUBLIC
  Simple insults-based widget library
- twisted.conch.interfaces
  twisted.conch.interfaces.html
  Module
  Module
  PUBLIC
  This module contains interfaces defined for the `twisted.conch` package.
- twisted.conch.ls
  twisted.conch.ls.html
  Module
  Module
  PUBLIC
  No module docstring; 0/1 constant, 1/1 function documented
- twisted.conch.manhole
  twisted.conch.manhole.html
  Module
  Module
  PUBLIC
  Line-input oriented interactive interpreter loop.
- twisted.conch.manhole_ssh
  twisted.conch.manhole_ssh.html
  Module
  Module
  PUBLIC
  insults/SSH integration support.
- twisted.conch.manhole_tap
  twisted.conch.manhole_tap.html
  Module
  Module
  PUBLIC
  TAP plugin for creating telnet- and ssh-accessible manhole servers.
- twisted.conch.mixin
  twisted.conch.mixin.html
  Module
  Module
  PUBLIC
  Experimental optimization
- twisted.conch.openssh_compat
  twisted.conch.openssh_compat.html
  Package
  Package
  PUBLIC
  Support for OpenSSH configuration files.
- twisted.conch.openssh_compat.factory
  twisted.conch.openssh_compat.factory.html
  Module
  Module
  PUBLIC
  Factory for reading openssh configuration files: public keys, private keys, and moduli file.
- twisted.conch.openssh_compat.primes
  twisted.conch.openssh_compat.primes.html
  Module
  Module
  PUBLIC
  Parsing for the moduli file, which contains Diffie-Hellman prime groups.
- twisted.conch.recvline
  twisted.conch.recvline.html
  Module
  Module
  PUBLIC
  Basic line editing support.
- twisted.conch.scripts
  twisted.conch.scripts.html
  Package
  Package
  PUBLIC
  conch scripts
- twisted.conch.scripts.cftp
  twisted.conch.scripts.cftp.html
  Module
  Module
  PUBLIC
  Implementation module for the cftp command.
- twisted.conch.scripts.ckeygen
  twisted.conch.scripts.ckeygen.html
  Module
  Module
  PUBLIC
  Implementation module for the `ckeygen` command.
- twisted.conch.scripts.conch
  twisted.conch.scripts.conch.html
  Module
  Module
  PUBLIC
  Undocumented
- twisted.conch.scripts.tkconch
  twisted.conch.scripts.tkconch.html
  Module
  Module
  PUBLIC
  Implementation module for the `tkconch` command.
- twisted.conch.ssh
  twisted.conch.ssh.html
  Package
  Package
  PUBLIC
  An SSHv2 implementation for Twisted. Part of the Twisted.Conch package.
- twisted.conch.ssh._kex
  twisted.conch.ssh._kex.html
  Module
  Module
  PRIVATE
  SSH key exchange handling.
- twisted.conch.ssh._keys_pynacl
  twisted.conch.ssh._keys_pynacl.html
  Module
  Module
  PRIVATE
  Optional PyNaCl fallback code for Ed25519 keys.
- twisted.conch.ssh.address
  twisted.conch.ssh.address.html
  Module
  Module
  PUBLIC
  Address object for SSH network connections.
- twisted.conch.ssh.agent
  twisted.conch.ssh.agent.html
  Module
  Module
  PUBLIC
  Implements the SSH v2 key agent protocol. This protocol is documented in the SSH source code, in the file PROTOCOL.agent.
- twisted.conch.ssh.channel
  twisted.conch.ssh.channel.html
  Module
  Module
  PUBLIC
  The parent class for all the SSH Channels. Currently implemented channels are session, direct-tcp, and forwarded-tcp.
- twisted.conch.ssh.common
  twisted.conch.ssh.common.html
  Module
  Module
  PUBLIC
  Common functions for the SSH classes.
- twisted.conch.ssh.connection
  twisted.conch.ssh.connection.html
  Module
  Module
  PUBLIC
  This module contains the implementation of the ssh-connection service, which allows access to the shell and port-forwarding.
- twisted.conch.ssh.factory
  twisted.conch.ssh.factory.html
  Module
  Module
  PUBLIC
  A Factory for SSH servers.
- twisted.conch.ssh.filetransfer
  twisted.conch.ssh.filetransfer.html
  Module
  Module
  PUBLIC
  Undocumented
- twisted.conch.ssh.forwarding
  twisted.conch.ssh.forwarding.html
  Module
  Module
  PUBLIC
  This module contains the implementation of the TCP forwarding, which allows clients and servers to forward arbitrary TCP data across the connection.
- twisted.conch.ssh.keys
  twisted.conch.ssh.keys.html
  Module
  Module
  PUBLIC
  Handling of RSA, DSA, ECDSA, and Ed25519 keys.
- twisted.conch.ssh.service
  twisted.conch.ssh.service.html
  Module
  Module
  PUBLIC
  The parent class for all the SSH services. Currently implemented services are ssh-userauth and ssh-connection.
- twisted.conch.ssh.session
  twisted.conch.ssh.session.html
  Module
  Module
  PUBLIC
  This module contains the implementation of SSHSession, which (by default) allows access to a shell and a python interpreter over SSH.
- twisted.conch.ssh.sexpy
  twisted.conch.ssh.sexpy.html
  Module
  Module
  PUBLIC
  Undocumented
- twisted.conch.ssh.transport
  twisted.conch.ssh.transport.html
  Module
  Module
  PUBLIC
  The lowest level SSH protocol. This handles the key negotiation, the encryption and the compression. The transport layer is described in RFC 4253.
- twisted.conch.ssh.userauth
  twisted.conch.ssh.userauth.html
  Module
  Module
  PUBLIC
  Implementation of the ssh-userauth service. Currently implemented authentication types are public-key and password.
- twisted.conch.stdio
  twisted.conch.stdio.html
  Module
  Module
  PUBLIC
  Asynchronous local terminal input handling
- twisted.conch.tap
  twisted.conch.tap.html
  Module
  Module
  PUBLIC
  Support module for making SSH servers with twistd.
- twisted.conch.telnet
  twisted.conch.telnet.html
  Module
  Module
  PUBLIC
  Telnet protocol implementation.
- twisted.conch.ttymodes
  twisted.conch.ttymodes.html
  Module
  Module
  PUBLIC
  Undocumented
- twisted.conch.ui
  twisted.conch.ui.html
  Package
  Package
  PUBLIC
  twisted.conch.ui is home to the UI elements for tkconch.
- twisted.conch.ui.ansi
  twisted.conch.ui.ansi.html
  Module
  Module
  PUBLIC
  Module to parse ANSI escape sequences
- twisted.conch.ui.tkvt100
  twisted.conch.ui.tkvt100.html
  Module
  Module
  PUBLIC
  Module to emulate a VT100 terminal in Tkinter.
- twisted.conch.unix
  twisted.conch.unix.html
  Module
  Module
  PUBLIC
  A UNIX SSH server.
- twisted.copyright
  twisted.copyright.html
  Module
  Module
  PUBLIC
  Copyright information for Twisted.
- twisted.cred
  twisted.cred.html
  Package
  Package
  PUBLIC
  Twisted Cred: Support for verifying credentials, and providing services to user based on those credentials.
- twisted.cred._digest
  twisted.cred._digest.html
  Module
  Module
  PRIVATE
  Calculations for HTTP Digest authentication.
- twisted.cred.checkers
  twisted.cred.checkers.html
  Module
  Module
  PUBLIC
  Basic credential checkers
- twisted.cred.credentials
  twisted.cred.credentials.html
  Module
  Module
  PUBLIC
  This module defines `ICredentials`, an interface for objects that represent authentication credentials to provide, and also includes a number of useful implementations of that interface.
- twisted.cred.error
  twisted.cred.error.html
  Module
  Module
  PUBLIC
  Cred errors.
- twisted.cred.portal
  twisted.cred.portal.html
  Module
  Module
  PUBLIC
  The point of integration of application and authentication.
- twisted.cred.strcred
  twisted.cred.strcred.html
  Module
  Module
  PUBLIC
  Support for resolving command-line strings that represent different checkers available to cred.
- twisted.enterprise
  twisted.enterprise.html
  Package
  Package
  PUBLIC
  Twisted Enterprise: Database support for Twisted services.
- twisted.enterprise.adbapi
  twisted.enterprise.adbapi.html
  Module
  Module
  PUBLIC
  An asynchronous mapping to DB-API 2.0.
- twisted.internet
  twisted.internet.html
  Package
  Package
  PUBLIC
  Twisted Internet: Asynchronous I/O and Events.
- twisted.internet._baseprocess
  twisted.internet._baseprocess.html
  Module
  Module
  PRIVATE
  Cross-platform process-related functionality used by different `IReactorProcess` implementations.
- twisted.internet._dumbwin32proc
  twisted.internet._dumbwin32proc.html
  Module
  Module
  PRIVATE
  Windows Process Management, used with reactor.spawnProcess
- twisted.internet._glibbase
  twisted.internet._glibbase.html
  Module
  Module
  PRIVATE
  This module provides base support for Twisted to interact with the glib/gtk mainloops.
- twisted.internet._idna
  twisted.internet._idna.html
  Module
  Module
  PRIVATE
  Shared interface to IDNA encoding and decoding, using the `idna` PyPI package if available, otherwise the stdlib implementation.
- twisted.internet._newtls
  twisted.internet._newtls.html
  Module
  Module
  PRIVATE
  This module implements memory BIO based TLS support. It is the preferred implementation and will be used whenever pyOpenSSL 0.10 or newer is installed (whenever `twisted.protocols.tls` is importable).
- twisted.internet._pollingfile
  twisted.internet._pollingfile.html
  Module
  Module
  PRIVATE
  Implements a simple polling interface for file descriptors that don't work with select() - this is pretty much only useful on Windows.
- twisted.internet._posixserialport
  twisted.internet._posixserialport.html
  Module
  Module
  PRIVATE
  Serial Port Protocol
- twisted.internet._posixstdio
  twisted.internet._posixstdio.html
  Module
  Module
  PRIVATE
  Standard input/out/err support.
- twisted.internet._producer_helpers
  twisted.internet._producer_helpers.html
  Module
  Module
  PRIVATE
  Helpers for working with producers.
- twisted.internet._resolver
  twisted.internet._resolver.html
  Module
  Module
  PRIVATE
  IPv6-aware hostname resolution.
- twisted.internet._signals
  twisted.internet._signals.html
  Module
  Module
  PRIVATE
  This module is used to integrate child process termination into a reactor event loop. This is a challenging feature to provide because most platforms indicate process termination via SIGCHLD and do not provide a way to wait for that signal and arbitrary I/O events at the same time...
- twisted.internet._sslverify
  twisted.internet._sslverify.html
  Module
  Module
  PRIVATE
  No module docstring; 0/6 variable, 10/10 functions, 1/1 exception, 6/6 classes, 1/1 interface documented
- twisted.internet._threadedselect
  twisted.internet._threadedselect.html
  Module
  Module
  PRIVATE
  Threaded select reactor
- twisted.internet._win32serialport
  twisted.internet._win32serialport.html
  Module
  Module
  PRIVATE
  Serial port support for Windows.
- twisted.internet._win32stdio
  twisted.internet._win32stdio.html
  Module
  Module
  PRIVATE
  Windows-specific implementation of the `twisted.internet.stdio` interface.
- twisted.internet.abstract
  twisted.internet.abstract.html
  Module
  Module
  PUBLIC
  Support for generic select()able objects.
- twisted.internet.address
  twisted.internet.address.html
  Module
  Module
  PUBLIC
  Address objects for network connections.
- twisted.internet.asyncioreactor
  twisted.internet.asyncioreactor.html
  Module
  Module
  PUBLIC
  asyncio-based reactor implementation.
- twisted.internet.base
  twisted.internet.base.html
  Module
  Module
  PUBLIC
  Very basic functionality for a Reactor implementation.
- twisted.internet.cfreactor
  twisted.internet.cfreactor.html
  Module
  Module
  PUBLIC
  A reactor for integrating with CFRunLoop, the CoreFoundation main loop used by macOS.
- twisted.internet.default
  twisted.internet.default.html
  Module
  Module
  PUBLIC
  The most suitable default reactor for the current platform.
- twisted.internet.defer
  twisted.internet.defer.html
  Module
  Module
  PUBLIC
  Support for results that aren't immediately available.
- twisted.internet.endpoints
  twisted.internet.endpoints.html
  Module
  Module
  PUBLIC
  Implementations of `IStreamServerEndpoint` and `IStreamClientEndpoint` that wrap the `IReactorTCP`, `IReactorSSL`, and `IReactorUNIX` interfaces.
- twisted.internet.epollreactor
  twisted.internet.epollreactor.html
  Module
  Module
  PUBLIC
  An epoll() based implementation of the twisted main loop.
- twisted.internet.error
  twisted.internet.error.html
  Module
  Module
  PUBLIC
  Exceptions and errors for use in twisted.internet modules.
- twisted.internet.fdesc
  twisted.internet.fdesc.html
  Module
  Module
  PUBLIC
  Utility functions for dealing with POSIX file descriptors.
- twisted.internet.gireactor
  twisted.internet.gireactor.html
  Module
  Module
  PUBLIC
  This module provides support for Twisted to interact with the glib mainloop via GObject Introspection.
- twisted.internet.glib2reactor
  twisted.internet.glib2reactor.html
  Module
  Module
  PUBLIC
  This module provides support for Twisted to interact with the glib mainloop. This is like gtk2, but slightly faster and does not require a working $DISPLAY. However, you cannot run GUIs under this reactor: for that you must use the gtk2reactor instead.
- twisted.internet.gtk2reactor
  twisted.internet.gtk2reactor.html
  Module
  Module
  PUBLIC
  This module provides support for Twisted to interact with the glib/gtk2 mainloop.
- twisted.internet.gtk3reactor
  twisted.internet.gtk3reactor.html
  Module
  Module
  PUBLIC
  This module provides support for Twisted to interact with the gtk3 mainloop via Gobject introspection. This is like gi, but slightly slower and requires a working $DISPLAY.
- twisted.internet.inotify
  twisted.internet.inotify.html
  Module
  Module
  PUBLIC
  This module provides support for Twisted to linux inotify API.
- twisted.internet.interfaces
  twisted.internet.interfaces.html
  Module
  Module
  PUBLIC
  Interface documentation.
- twisted.internet.iocpreactor
  twisted.internet.iocpreactor.html
  Package
  Package
  PUBLIC
  I/O Completion Ports reactor
- twisted.internet.iocpreactor.abstract
  twisted.internet.iocpreactor.abstract.html
  Module
  Module
  PUBLIC
  Abstract file handle class
- twisted.internet.iocpreactor.const
  twisted.internet.iocpreactor.const.html
  Module
  Module
  PUBLIC
  Windows constants for IOCP
- twisted.internet.iocpreactor.interfaces
  twisted.internet.iocpreactor.interfaces.html
  Module
  Module
  PUBLIC
  Interfaces for iocpreactor
- twisted.internet.iocpreactor.iocpsupport
  twisted.internet.iocpreactor.iocpsupport.html
  Module
  Module
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.reactor
  twisted.internet.iocpreactor.reactor.html
  Module
  Module
  PUBLIC
  Reactor that uses IO completion ports
- twisted.internet.iocpreactor.tcp
  twisted.internet.iocpreactor.tcp.html
  Module
  Module
  PUBLIC
  TCP support for IOCP reactor
- twisted.internet.iocpreactor.udp
  twisted.internet.iocpreactor.udp.html
  Module
  Module
  PUBLIC
  UDP support for IOCP reactor
- twisted.internet.kqreactor
  twisted.internet.kqreactor.html
  Module
  Module
  PUBLIC
  A kqueue()/kevent() based implementation of the Twisted main loop.
- twisted.internet.main
  twisted.internet.main.html
  Module
  Module
  PUBLIC
  Backwards compatibility, and utility functions.
- twisted.internet.pollreactor
  twisted.internet.pollreactor.html
  Module
  Module
  PUBLIC
  A poll() based implementation of the twisted main loop.
- twisted.internet.posixbase
  twisted.internet.posixbase.html
  Module
  Module
  PUBLIC
  Posix reactor base class
- twisted.internet.process
  twisted.internet.process.html
  Module
  Module
  PUBLIC
  UNIX Process management.
- twisted.internet.protocol
  twisted.internet.protocol.html
  Module
  Module
  PUBLIC
  Standard implementations of Twisted protocol-related interfaces.
- twisted.internet.pyuisupport
  twisted.internet.pyuisupport.html
  Module
  Module
  PUBLIC
  This module integrates PyUI with twisted.internet's mainloop.
- twisted.internet.reactor
  twisted.internet.reactor.html
  Module
  Module
  PUBLIC
  The reactor is the Twisted event loop within Twisted, the loop which drives applications using Twisted. The reactor provides APIs for networking, threading, dispatching events, and more.
- twisted.internet.selectreactor
  twisted.internet.selectreactor.html
  Module
  Module
  PUBLIC
  Select reactor
- twisted.internet.serialport
  twisted.internet.serialport.html
  Module
  Module
  PUBLIC
  Serial Port Protocol
- twisted.internet.ssl
  twisted.internet.ssl.html
  Module
  Module
  PUBLIC
  This module implements Transport Layer Security (TLS) support for Twisted. It requires PyOpenSSL.
- twisted.internet.stdio
  twisted.internet.stdio.html
  Module
  Module
  PUBLIC
  Standard input/out/err support.
- twisted.internet.task
  twisted.internet.task.html
  Module
  Module
  PUBLIC
  Scheduling utility methods and classes.
- twisted.internet.tcp
  twisted.internet.tcp.html
  Module
  Module
  PUBLIC
  Various asynchronous TCP/IP classes.
- twisted.internet.testing
  twisted.internet.testing.html
  Module
  Module
  PUBLIC
  Assorted functionality which is commonly useful when writing unit tests.
- twisted.internet.threads
  twisted.internet.threads.html
  Module
  Module
  PUBLIC
  Extended thread dispatching support.
- twisted.internet.tksupport
  twisted.internet.tksupport.html
  Module
  Module
  PUBLIC
  This module integrates Tkinter with twisted.internet's mainloop.
- twisted.internet.udp
  twisted.internet.udp.html
  Module
  Module
  PUBLIC
  Various asynchronous UDP classes.
- twisted.internet.unix
  twisted.internet.unix.html
  Module
  Module
  PUBLIC
  UNIX socket support for Twisted.
- twisted.internet.utils
  twisted.internet.utils.html
  Module
  Module
  PUBLIC
  Utility methods.
- twisted.internet.win32eventreactor
  twisted.internet.win32eventreactor.html
  Module
  Module
  PUBLIC
  A win32event based implementation of the Twisted main loop.
- twisted.internet.wxreactor
  twisted.internet.wxreactor.html
  Module
  Module
  PUBLIC
  This module provides wxPython event loop support for Twisted.
- twisted.internet.wxsupport
  twisted.internet.wxsupport.html
  Module
  Module
  PUBLIC
  Old method of wxPython support for Twisted.
- twisted.logger
  twisted.logger.html
  Package
  Package
  PUBLIC
  Twisted Logger: Classes and functions to do granular logging.
- twisted.logger._buffer
  twisted.logger._buffer.html
  Module
  Module
  PRIVATE
  Log observer that maintains a buffer.
- twisted.logger._capture
  twisted.logger._capture.html
  Module
  Module
  PRIVATE
  Context manager for capturing logs.
- twisted.logger._file
  twisted.logger._file.html
  Module
  Module
  PRIVATE
  File log observer.
- twisted.logger._filter
  twisted.logger._filter.html
  Module
  Module
  PRIVATE
  Filtering log observer.
- twisted.logger._flatten
  twisted.logger._flatten.html
  Module
  Module
  PRIVATE
  Code related to "flattening" events; that is, extracting a description of all relevant fields from the format string and persisting them for later examination.
- twisted.logger._format
  twisted.logger._format.html
  Module
  Module
  PRIVATE
  Tools for formatting logging events.
- twisted.logger._global
  twisted.logger._global.html
  Module
  Module
  PRIVATE
  This module includes process-global state associated with the logging system, and implementation of logic for managing that global state.
- twisted.logger._interfaces
  twisted.logger._interfaces.html
  Module
  Module
  PRIVATE
  Logger interfaces.
- twisted.logger._io
  twisted.logger._io.html
  Module
  Module
  PRIVATE
  File-like object that logs.
- twisted.logger._json
  twisted.logger._json.html
  Module
  Module
  PRIVATE
  Tools for saving and loading log events in a structured format.
- twisted.logger._legacy
  twisted.logger._legacy.html
  Module
  Module
  PRIVATE
  Integration with `twisted.python.log`.
- twisted.logger._levels
  twisted.logger._levels.html
  Module
  Module
  PRIVATE
  Log levels.
- twisted.logger._logger
  twisted.logger._logger.html
  Module
  Module
  PRIVATE
  Logger class.
- twisted.logger._observer
  twisted.logger._observer.html
  Module
  Module
  PRIVATE
  Basic log observers.
- twisted.logger._stdlib
  twisted.logger._stdlib.html
  Module
  Module
  PRIVATE
  Integration with Python standard library logging.
- twisted.logger._util
  twisted.logger._util.html
  Module
  Module
  PRIVATE
  Logging utilities.
- twisted.mail
  twisted.mail.html
  Package
  Package
  PUBLIC
  Twisted Mail: Servers and clients for POP3, ESMTP, and IMAP.
- twisted.mail._cred
  twisted.mail._cred.html
  Module
  Module
  PRIVATE
  Credential managers for `twisted.mail`.
- twisted.mail._except
  twisted.mail._except.html
  Module
  Module
  PRIVATE
  Exceptions in `twisted.mail`.
- twisted.mail._pop3client
  twisted.mail._pop3client.html
  Module
  Module
  PRIVATE
  A POP3 client protocol implementation.
- twisted.mail.alias
  twisted.mail.alias.html
  Module
  Module
  PUBLIC
  Support for aliases(5) configuration files.
- twisted.mail.bounce
  twisted.mail.bounce.html
  Module
  Module
  PUBLIC
  Support for bounce message generation.
- twisted.mail.imap4
  twisted.mail.imap4.html
  Module
  Module
  PUBLIC
  An IMAP4 protocol implementation
- twisted.mail.interfaces
  twisted.mail.interfaces.html
  Module
  Module
  PUBLIC
  Interfaces for `twisted.mail`.
- twisted.mail.mail
  twisted.mail.mail.html
  Module
  Module
  PUBLIC
  Mail service support.
- twisted.mail.maildir
  twisted.mail.maildir.html
  Module
  Module
  PUBLIC
  Maildir-style mailbox support.
- twisted.mail.pb
  twisted.mail.pb.html
  Module
  Module
  PUBLIC
  Undocumented
- twisted.mail.pop3
  twisted.mail.pop3.html
  Module
  Module
  PUBLIC
  Post-office Protocol version 3.
- twisted.mail.pop3client
  twisted.mail.pop3client.html
  Module
  Module
  PUBLIC
  Deprecated POP3 client protocol implementation.
- twisted.mail.protocols
  twisted.mail.protocols.html
  Module
  Module
  PUBLIC
  Mail protocol support.
- twisted.mail.relay
  twisted.mail.relay.html
  Module
  Module
  PUBLIC
  Support for relaying mail.
- twisted.mail.relaymanager
  twisted.mail.relaymanager.html
  Module
  Module
  PUBLIC
  Infrastructure for relaying mail through a smart host.
- twisted.mail.scripts
  twisted.mail.scripts.html
  Package
  Package
  PUBLIC
  mail scripts
- twisted.mail.scripts.mailmail
  twisted.mail.scripts.mailmail.html
  Module
  Module
  PUBLIC
  Implementation module for the mailmail command.
- twisted.mail.smtp
  twisted.mail.smtp.html
  Module
  Module
  PUBLIC
  Simple Mail Transfer Protocol implementation.
- twisted.mail.tap
  twisted.mail.tap.html
  Module
  Module
  PUBLIC
  Support for creating mail servers with twistd.
- twisted.names
  twisted.names.html
  Package
  Package
  PUBLIC
  Twisted Names: DNS server and client implementations.
- twisted.names._rfc1982
  twisted.names._rfc1982.html
  Module
  Module
  PRIVATE
  Utilities for handling RFC1982 Serial Number Arithmetic.
- twisted.names.authority
  twisted.names.authority.html
  Module
  Module
  PUBLIC
  Authoritative resolvers.
- twisted.names.cache
  twisted.names.cache.html
  Module
  Module
  PUBLIC
  An in-memory caching resolver.
- twisted.names.client
  twisted.names.client.html
  Module
  Module
  PUBLIC
  Asynchronous client DNS
- twisted.names.common
  twisted.names.common.html
  Module
  Module
  PUBLIC
  Base functionality useful to various parts of Twisted Names.
- twisted.names.dns
  twisted.names.dns.html
  Module
  Module
  PUBLIC
  DNS protocol implementation.
- twisted.names.error
  twisted.names.error.html
  Module
  Module
  PUBLIC
  Exception class definitions for Twisted Names.
- twisted.names.hosts
  twisted.names.hosts.html
  Module
  Module
  PUBLIC
  hosts(5) support.
- twisted.names.resolve
  twisted.names.resolve.html
  Module
  Module
  PUBLIC
  Lookup a name using multiple resolvers.
- twisted.names.root
  twisted.names.root.html
  Module
  Module
  PUBLIC
  Resolver implementation for querying successive authoritative servers to lookup a record, starting from the root nameservers.
- twisted.names.secondary
  twisted.names.secondary.html
  Module
  Module
  PUBLIC
  No module docstring; 2/2 classes documented
- twisted.names.server
  twisted.names.server.html
  Module
  Module
  PUBLIC
  Async DNS server
- twisted.names.srvconnect
  twisted.names.srvconnect.html
  Module
  Module
  PUBLIC
  No module docstring; 1/2 class documented
- twisted.names.tap
  twisted.names.tap.html
  Module
  Module
  PUBLIC
  Domain Name Server
- twisted.pair
  twisted.pair.html
  Package
  Package
  PUBLIC
  Twisted Pair: The framework of your ethernet.
- twisted.pair.ethernet
  twisted.pair.ethernet.html
  Module
  Module
  PUBLIC
  Support for working directly with ethernet frames
- twisted.pair.ip
  twisted.pair.ip.html
  Module
  Module
  PUBLIC
  Support for working directly with IP packets
- twisted.pair.raw
  twisted.pair.raw.html
  Module
  Module
  PUBLIC
  Interface definitions for working with raw packets
- twisted.pair.rawudp
  twisted.pair.rawudp.html
  Module
  Module
  PUBLIC
  Implementation of raw packet interfaces for UDP
- twisted.pair.testing
  twisted.pair.testing.html
  Module
  Module
  PUBLIC
  Tools for automated testing of `twisted.pair`-based applications.
- twisted.pair.tuntap
  twisted.pair.tuntap.html
  Module
  Module
  PUBLIC
  Support for Linux ethernet and IP tunnel devices.
- twisted.persisted
  twisted.persisted.html
  Package
  Package
  PUBLIC
  Twisted Persisted: Utilities for managing persistence.
- twisted.persisted.aot
  twisted.persisted.aot.html
  Module
  Module
  PUBLIC
  AOT: Abstract Object Trees The source-code-marshallin'est abstract-object-serializin'est persister this side of Marmalade!
- twisted.persisted.crefutil
  twisted.persisted.crefutil.html
  Module
  Module
  PUBLIC
  Utility classes for dealing with circular references.
- twisted.persisted.dirdbm
  twisted.persisted.dirdbm.html
  Module
  Module
  PUBLIC
  DBM-style interface to a directory.
- twisted.persisted.sob
  twisted.persisted.sob.html
  Module
  Module
  PUBLIC
  Save and load Small OBjects to and from files, using various formats.
- twisted.persisted.styles
  twisted.persisted.styles.html
  Module
  Module
  PUBLIC
  Different styles of persisted objects.
- twisted.plugin
  twisted.plugin.html
  Module
  Module
  PUBLIC
  Plugin system for Twisted.
- twisted.plugins
  twisted.plugins.html
  Package
  Package
  PUBLIC
  Plugins for services implemented in Twisted.
- twisted.plugins.cred_anonymous
  twisted.plugins.cred_anonymous.html
  Module
  Module
  PUBLIC
  Cred plugin for anonymous logins.
- twisted.plugins.cred_file
  twisted.plugins.cred_file.html
  Module
  Module
  PUBLIC
  Cred plugin for a file of the format 'username:password'.
- twisted.plugins.cred_memory
  twisted.plugins.cred_memory.html
  Module
  Module
  PUBLIC
  Cred plugin for an in-memory user database.
- twisted.plugins.cred_sshkeys
  twisted.plugins.cred_sshkeys.html
  Module
  Module
  PUBLIC
  Cred plugin for ssh key login.
- twisted.plugins.cred_unix
  twisted.plugins.cred_unix.html
  Module
  Module
  PUBLIC
  Cred plugin for UNIX user accounts.
- twisted.plugins.twisted_conch
  twisted.plugins.twisted_conch.html
  Module
  Module
  PUBLIC
  Undocumented
- twisted.plugins.twisted_core
  twisted.plugins.twisted_core.html
  Module
  Module
  PUBLIC
  Undocumented
- twisted.plugins.twisted_ftp
  twisted.plugins.twisted_ftp.html
  Module
  Module
  PUBLIC
  Undocumented
- twisted.plugins.twisted_inet
  twisted.plugins.twisted_inet.html
  Module
  Module
  PUBLIC
  Undocumented
- twisted.plugins.twisted_mail
  twisted.plugins.twisted_mail.html
  Module
  Module
  PUBLIC
  Undocumented
- twisted.plugins.twisted_names
  twisted.plugins.twisted_names.html
  Module
  Module
  PUBLIC
  Undocumented
- twisted.plugins.twisted_portforward
  twisted.plugins.twisted_portforward.html
  Module
  Module
  PUBLIC
  Undocumented
- twisted.plugins.twisted_reactors
  twisted.plugins.twisted_reactors.html
  Module
  Module
  PUBLIC
  Undocumented
- twisted.plugins.twisted_runner
  twisted.plugins.twisted_runner.html
  Module
  Module
  PUBLIC
  Undocumented
- twisted.plugins.twisted_socks
  twisted.plugins.twisted_socks.html
  Module
  Module
  PUBLIC
  Undocumented
- twisted.plugins.twisted_trial
  twisted.plugins.twisted_trial.html
  Module
  Module
  PUBLIC
  Undocumented
- twisted.plugins.twisted_web
  twisted.plugins.twisted_web.html
  Module
  Module
  PUBLIC
  Undocumented
- twisted.plugins.twisted_words
  twisted.plugins.twisted_words.html
  Module
  Module
  PUBLIC
  Undocumented
- twisted.positioning
  twisted.positioning.html
  Package
  Package
  PUBLIC
  Twisted Positioning: Framework for applications that make use of positioning.
- twisted.positioning._sentence
  twisted.positioning._sentence.html
  Module
  Module
  PRIVATE
  Generic sentence handling tools: hopefully reusable.
- twisted.positioning.base
  twisted.positioning.base.html
  Module
  Module
  PUBLIC
  Generic positioning base classes.
- twisted.positioning.ipositioning
  twisted.positioning.ipositioning.html
  Module
  Module
  PUBLIC
  Positioning interfaces.
- twisted.positioning.nmea
  twisted.positioning.nmea.html
  Module
  Module
  PUBLIC
  Classes for working with NMEA 0183 sentence producing devices. This standard is generally just called "NMEA", which is actually the name of the body that produces the standard, not the standard itself..
- twisted.protocols
  twisted.protocols.html
  Package
  Package
  PUBLIC
  Twisted Protocols: A collection of internet protocol implementations.
- twisted.protocols.amp
  twisted.protocols.amp.html
  Module
  Module
  PUBLIC
  This module implements AMP, the Asynchronous Messaging Protocol.
- twisted.protocols.basic
  twisted.protocols.basic.html
  Module
  Module
  PUBLIC
  Basic protocols, such as line-oriented, netstring, and int prefixed strings.
- twisted.protocols.dict
  twisted.protocols.dict.html
  Module
  Module
  PUBLIC
  Dict client protocol implementation.
- twisted.protocols.finger
  twisted.protocols.finger.html
  Module
  Module
  PUBLIC
  The Finger User Information Protocol (RFC 1288)
- twisted.protocols.ftp
  twisted.protocols.ftp.html
  Module
  Module
  PUBLIC
  An FTP protocol implementation
- twisted.protocols.haproxy
  twisted.protocols.haproxy.html
  Package
  Package
  PUBLIC
  HAProxy PROXY protocol implementations.
- twisted.protocols.haproxy._exceptions
  twisted.protocols.haproxy._exceptions.html
  Module
  Module
  PRIVATE
  HAProxy specific exceptions.
- twisted.protocols.haproxy._info
  twisted.protocols.haproxy._info.html
  Module
  Module
  PRIVATE
  IProxyInfo implementation.
- twisted.protocols.haproxy._interfaces
  twisted.protocols.haproxy._interfaces.html
  Module
  Module
  PRIVATE
  Interfaces used by the PROXY protocol modules.
- twisted.protocols.haproxy._parser
  twisted.protocols.haproxy._parser.html
  Module
  Module
  PRIVATE
  Parser for 'haproxy:' string endpoint.
- twisted.protocols.haproxy._v1parser
  twisted.protocols.haproxy._v1parser.html
  Module
  Module
  PRIVATE
  IProxyParser implementation for version one of the PROXY protocol.
- twisted.protocols.haproxy._v2parser
  twisted.protocols.haproxy._v2parser.html
  Module
  Module
  PRIVATE
  IProxyParser implementation for version two of the PROXY protocol.
- twisted.protocols.haproxy._wrapper
  twisted.protocols.haproxy._wrapper.html
  Module
  Module
  PRIVATE
  Protocol wrapper that provides HAProxy PROXY protocol support.
- twisted.protocols.htb
  twisted.protocols.htb.html
  Module
  Module
  PUBLIC
  Hierarchical Token Bucket traffic shaping.
- twisted.protocols.ident
  twisted.protocols.ident.html
  Module
  Module
  PUBLIC
  Ident protocol implementation.
- twisted.protocols.loopback
  twisted.protocols.loopback.html
  Module
  Module
  PUBLIC
  Testing support for protocols -- loopback between client and server.
- twisted.protocols.memcache
  twisted.protocols.memcache.html
  Module
  Module
  PUBLIC
  Memcache client protocol. Memcached is a caching server, storing data in the form of pairs key/value, and memcache is the protocol to talk with it.
- twisted.protocols.pcp
  twisted.protocols.pcp.html
  Module
  Module
  PUBLIC
  Producer-Consumer Proxy.
- twisted.protocols.policies
  twisted.protocols.policies.html
  Module
  Module
  PUBLIC
  Resource limiting policies.
- twisted.protocols.portforward
  twisted.protocols.portforward.html
  Module
  Module
  PUBLIC
  A simple port forwarder.
- twisted.protocols.postfix
  twisted.protocols.postfix.html
  Module
  Module
  PUBLIC
  Postfix mail transport agent related protocols.
- twisted.protocols.shoutcast
  twisted.protocols.shoutcast.html
  Module
  Module
  PUBLIC
  Chop up shoutcast stream into MP3s and metadata, if available.
- twisted.protocols.sip
  twisted.protocols.sip.html
  Module
  Module
  PUBLIC
  Session Initialization Protocol.
- twisted.protocols.socks
  twisted.protocols.socks.html
  Module
  Module
  PUBLIC
  Implementation of the SOCKSv4 protocol.
- twisted.protocols.stateful
  twisted.protocols.stateful.html
  Module
  Module
  PUBLIC
  No module docstring; 1/1 class documented
- twisted.protocols.tls
  twisted.protocols.tls.html
  Module
  Module
  PUBLIC
  Implementation of a TLS transport (`ISSLTransport`) as an `IProtocol` layered on top of any `ITransport` implementation, based on OpenSSL's memory BIO features.
- twisted.protocols.wire
  twisted.protocols.wire.html
  Module
  Module
  PUBLIC
  Implement standard (and unused) TCP protocols.
- twisted.python
  twisted.python.html
  Package
  Package
  PUBLIC
  Twisted Python: Utilities and Enhancements for Python.
- twisted.python._appdirs
  twisted.python._appdirs.html
  Module
  Module
  PRIVATE
  Application data directory support.
- twisted.python._inotify
  twisted.python._inotify.html
  Module
  Module
  PRIVATE
  Very low-level ctypes-based interface to Linux inotify(7).
- twisted.python._release
  twisted.python._release.html
  Module
  Module
  PRIVATE
  Twisted's automated release system.
- twisted.python._shellcomp
  twisted.python._shellcomp.html
  Module
  Module
  PRIVATE
  No public APIs are provided by this module. Internal use only.
- twisted.python._textattributes
  twisted.python._textattributes.html
  Module
  Module
  PRIVATE
  This module provides some common functionality for the manipulation of formatting states.
- twisted.python._tzhelper
  twisted.python._tzhelper.html
  Module
  Module
  PRIVATE
  Time zone utilities.
- twisted.python._url
  twisted.python._url.html
  Module
  Module
  PRIVATE
  URL parsing, construction and rendering.
- twisted.python.compat
  twisted.python.compat.html
  Module
  Module
  PUBLIC
  Compatibility module to provide backwards compatibility for useful Python features.
- twisted.python.components
  twisted.python.components.html
  Module
  Module
  PUBLIC
  Component architecture for Twisted, based on Zope3 components.
- twisted.python.constants
  twisted.python.constants.html
  Module
  Module
  PUBLIC
  Symbolic constant support, including collections and constants with text, numeric, and bit flag values.
- twisted.python.context
  twisted.python.context.html
  Module
  Module
  PUBLIC
  Dynamic pseudo-scoping for Python.
- twisted.python.deprecate
  twisted.python.deprecate.html
  Module
  Module
  PUBLIC
  Deprecation framework for Twisted.
- twisted.python.failure
  twisted.python.failure.html
  Module
  Module
  PUBLIC
  Asynchronous-friendly error mechanism.
- twisted.python.fakepwd
  twisted.python.fakepwd.html
  Module
  Module
  PUBLIC
  `twisted.python.fakepwd` provides a fake implementation of the `pwd` API.
- twisted.python.filepath
  twisted.python.filepath.html
  Module
  Module
  PUBLIC
  Object-oriented filesystem path representation.
- twisted.python.formmethod
  twisted.python.formmethod.html
  Module
  Module
  PUBLIC
  Form-based method objects.
- twisted.python.htmlizer
  twisted.python.htmlizer.html
  Module
  Module
  PUBLIC
  HTML rendering of Python source.
- twisted.python.lockfile
  twisted.python.lockfile.html
  Module
  Module
  PUBLIC
  Filesystem-based interprocess mutex.
- twisted.python.log
  twisted.python.log.html
  Module
  Module
  PUBLIC
  Logging and metrics infrastructure.
- twisted.python.logfile
  twisted.python.logfile.html
  Module
  Module
  PUBLIC
  A rotating, browsable log file.
- twisted.python.modules
  twisted.python.modules.html
  Module
  Module
  PUBLIC
  This module aims to provide a unified, object-oriented view of Python's runtime hierarchy.
- twisted.python.monkey
  twisted.python.monkey.html
  Module
  Module
  PUBLIC
  No module docstring; 1/1 class documented
- twisted.python.procutils
  twisted.python.procutils.html
  Module
  Module
  PUBLIC
  Utilities for dealing with processes.
- twisted.python.randbytes
  twisted.python.randbytes.html
  Module
  Module
  PUBLIC
  Cryptographically secure random implementation, with fallback on normal random.
- twisted.python.rebuild
  twisted.python.rebuild.html
  Module
  Module
  PUBLIC
  *Real* reloading support for Python.
- twisted.python.reflect
  twisted.python.reflect.html
  Module
  Module
  PUBLIC
  Standardized versions of various cool and/or strange things that you can do with Python's reflection capabilities.
- twisted.python.release
  twisted.python.release.html
  Module
  Module
  PUBLIC
  A release-automation toolkit.
- twisted.python.roots
  twisted.python.roots.html
  Module
  Module
  PUBLIC
  Twisted Python Roots: an abstract hierarchy representation for Twisted.
- twisted.python.runtime
  twisted.python.runtime.html
  Module
  Module
  PUBLIC
  No module docstring; 0/3 variable, 1/1 function, 1/1 class documented
- twisted.python.sendmsg
  twisted.python.sendmsg.html
  Module
  Module
  PUBLIC
  sendmsg(2) and recvmsg(2) support for Python.
- twisted.python.shortcut
  twisted.python.shortcut.html
  Module
  Module
  PUBLIC
  Creation of Windows shortcuts.
- twisted.python.syslog
  twisted.python.syslog.html
  Module
  Module
  PUBLIC
  Classes and utility functions for integrating Twisted and syslog.
- twisted.python.systemd
  twisted.python.systemd.html
  Module
  Module
  PUBLIC
  Integration with systemd.
- twisted.python.text
  twisted.python.text.html
  Module
  Module
  PUBLIC
  Miscellany of text-munging functions.
- twisted.python.threadable
  twisted.python.threadable.html
  Module
  Module
  PUBLIC
  A module to provide some very basic threading primitives, such as synchronization.
- twisted.python.threadpool
  twisted.python.threadpool.html
  Module
  Module
  PUBLIC
  twisted.python.threadpool: a pool of threads to which we dispatch tasks.
- twisted.python.url
  twisted.python.url.html
  Module
  Module
  PUBLIC
  URL parsing, construction and rendering.
- twisted.python.urlpath
  twisted.python.urlpath.html
  Module
  Module
  PUBLIC
  `URLPath`, a representation of a URL.
- twisted.python.usage
  twisted.python.usage.html
  Module
  Module
  PUBLIC
  twisted.python.usage is a module for parsing/handling the command line of your program.
- twisted.python.util
  twisted.python.util.html
  Module
  Module
  PUBLIC
  No module docstring; 18/22 functions, 5/6 classes documented
- twisted.python.versions
  twisted.python.versions.html
  Module
  Module
  PUBLIC
  Versions for Python packages.
- twisted.python.win32
  twisted.python.win32.html
  Module
  Module
  PUBLIC
  Win32 utilities.
- twisted.python.zippath
  twisted.python.zippath.html
  Module
  Module
  PUBLIC
  This module contains implementations of `IFilePath` for zip files.
- twisted.python.zipstream
  twisted.python.zipstream.html
  Module
  Module
  PUBLIC
  An incremental approach to unzipping files. This allows you to unzip a little bit of a file at a time, which means you can report progress as a file unzips.
- twisted.runner
  twisted.runner.html
  Package
  Package
  PUBLIC
  Twisted Runner: Run and monitor processes.
- twisted.runner.inetd
  twisted.runner.inetd.html
  Module
  Module
  PUBLIC
  Twisted inetd.
- twisted.runner.inetdconf
  twisted.runner.inetdconf.html
  Module
  Module
  PUBLIC
  Parser for inetd.conf files
- twisted.runner.inetdtap
  twisted.runner.inetdtap.html
  Module
  Module
  PUBLIC
  Twisted inetd TAP support
- twisted.runner.procmon
  twisted.runner.procmon.html
  Module
  Module
  PUBLIC
  Support for starting, monitoring, and restarting child process.
- twisted.runner.procmontap
  twisted.runner.procmontap.html
  Module
  Module
  PUBLIC
  Support for creating a service which runs a process monitor.
- twisted.scripts
  twisted.scripts.html
  Package
  Package
  PUBLIC
  Subpackage containing the modules that implement the command line tools.
- twisted.scripts._twistd_unix
  twisted.scripts._twistd_unix.html
  Module
  Module
  PRIVATE
  No module docstring; 0/3 function, 2/3 classes documented
- twisted.scripts._twistw
  twisted.scripts._twistw.html
  Module
  Module
  PRIVATE
  No module docstring; 1/2 class documented
- twisted.scripts.htmlizer
  twisted.scripts.htmlizer.html
  Module
  Module
  PUBLIC
  HTML pretty-printing for Python source code.
- twisted.scripts.trial
  twisted.scripts.trial.html
  Module
  Module
  PUBLIC
  No module docstring; 0/1 variable, 0/1 constant, 7/13 functions, 1/1 exception, 2/2 classes documented
- twisted.scripts.twistd
  twisted.scripts.twistd.html
  Module
  Module
  PUBLIC
  The Twisted Daemon: platform-independent interface.
- twisted.spread
  twisted.spread.html
  Package
  Package
  PUBLIC
  Twisted Spread: Spreadable (Distributed) Computing.
- twisted.spread.banana
  twisted.spread.banana.html
  Module
  Module
  PUBLIC
  Banana -- s-exp based protocol.
- twisted.spread.flavors
  twisted.spread.flavors.html
  Module
  Module
  PUBLIC
  This module represents flavors of remotely accessible objects.
- twisted.spread.interfaces
  twisted.spread.interfaces.html
  Module
  Module
  PUBLIC
  Twisted Spread Interfaces.
- twisted.spread.jelly
  twisted.spread.jelly.html
  Module
  Module
  PUBLIC
  S-expression-based persistence of python objects.
- twisted.spread.pb
  twisted.spread.pb.html
  Module
  Module
  PUBLIC
  Perspective Broker
- twisted.spread.publish
  twisted.spread.publish.html
  Module
  Module
  PUBLIC
  Persistently cached objects for PB.
- twisted.spread.util
  twisted.spread.util.html
  Module
  Module
  PUBLIC
  Utility classes for spread.
- twisted.tap
  twisted.tap.html
  Package
  Package
  PUBLIC
  Twisted TAP: Twisted Application Persistence builders for other Twisted servers.
- twisted.tap.ftp
  twisted.tap.ftp.html
  Module
  Module
  PUBLIC
  I am the support module for making a ftp server with twistd.
- twisted.tap.portforward
  twisted.tap.portforward.html
  Module
  Module
  PUBLIC
  Support module for making a port forwarder with twistd.
- twisted.tap.socks
  twisted.tap.socks.html
  Module
  Module
  PUBLIC
  I am a support module for making SOCKSv4 servers with twistd.
- twisted.test
  twisted.test.html
  Package
  Package
  PUBLIC
  Twisted's unit tests.
- twisted.test.proto_helpers
  twisted.test.proto_helpers.html
  Module
  Module
  PUBLIC
  Assorted functionality which is commonly useful when writing unit tests.
- twisted.trial
  twisted.trial.html
  Package
  Package
  PUBLIC
  Twisted Trial: Asynchronous unit testing framework.
- twisted.trial.__main__
  twisted.trial.__main__.html
  Module
  Module
  PRIVATE
  Undocumented
- twisted.trial._asyncrunner
  twisted.trial._asyncrunner.html
  Module
  Module
  PRIVATE
  Infrastructure for test running and suites.
- twisted.trial._asynctest
  twisted.trial._asynctest.html
  Module
  Module
  PRIVATE
  Things likely to be used by writers of unit tests.
- twisted.trial._dist
  twisted.trial._dist.html
  Package
  Package
  PRIVATE
  This package implements the distributed Trial test runner:
- twisted.trial._dist.distreporter
  twisted.trial._dist.distreporter.html
  Module
  Module
  PUBLIC
  The reporter is not made to support concurrent test running, so we will hold test results in here and only send them to the reporter once the test is over.
- twisted.trial._dist.disttrial
  twisted.trial._dist.disttrial.html
  Module
  Module
  PUBLIC
  This module contains the trial distributed runner, the management class responsible for coordinating all of trial's behavior at the highest level.
- twisted.trial._dist.managercommands
  twisted.trial._dist.managercommands.html
  Module
  Module
  PUBLIC
  Commands for reporting test success of failure to the manager.
- twisted.trial._dist.options
  twisted.trial._dist.options.html
  Module
  Module
  PUBLIC
  Options handling specific to trial's workers.
- twisted.trial._dist.worker
  twisted.trial._dist.worker.html
  Module
  Module
  PUBLIC
  This module implements the worker classes.
- twisted.trial._dist.workercommands
  twisted.trial._dist.workercommands.html
  Module
  Module
  PUBLIC
  Commands for telling a worker to load tests or run tests.
- twisted.trial._dist.workerreporter
  twisted.trial._dist.workerreporter.html
  Module
  Module
  PUBLIC
  Test reporter forwarding test results over trial distributed AMP commands.
- twisted.trial._dist.workertrial
  twisted.trial._dist.workertrial.html
  Module
  Module
  PUBLIC
  Implementation of `AMP` worker commands, and main executable entry point for the workers.
- twisted.trial._synctest
  twisted.trial._synctest.html
  Module
  Module
  PRIVATE
  Things likely to be used by writers of unit tests.
- twisted.trial.itrial
  twisted.trial.itrial.html
  Module
  Module
  PUBLIC
  Interfaces for Trial.
- twisted.trial.reporter
  twisted.trial.reporter.html
  Module
  Module
  PUBLIC
  Defines classes that handle the results of tests.
- twisted.trial.runner
  twisted.trial.runner.html
  Module
  Module
  PUBLIC
  A miscellany of code used to run Trial tests.
- twisted.trial.unittest
  twisted.trial.unittest.html
  Module
  Module
  PUBLIC
  Things likely to be used by writers of unit tests.
- twisted.trial.util
  twisted.trial.util.html
  Module
  Module
  PUBLIC
  A collection of utility functions and classes, used internally by Trial.
- twisted.web
  twisted.web.html
  Package
  Package
  PUBLIC
  Twisted Web: HTTP clients and servers, plus tools for implementing them.
- twisted.web._auth
  twisted.web._auth.html
  Package
  Package
  PRIVATE
  HTTP header-based authentication migrated from web2
- twisted.web._auth.basic
  twisted.web._auth.basic.html
  Module
  Module
  PUBLIC
  HTTP BASIC authentication.
- twisted.web._auth.digest
  twisted.web._auth.digest.html
  Module
  Module
  PUBLIC
  Implementation of RFC2617: HTTP Digest Authentication
- twisted.web._auth.wrapper
  twisted.web._auth.wrapper.html
  Module
  Module
  PUBLIC
  A guard implementation which supports HTTP header-based authentication schemes.
- twisted.web._element
  twisted.web._element.html
  Module
  Module
  PRIVATE
  No module docstring; 0/1 type variable, 0/1 function, 1/1 class documented
- twisted.web._flatten
  twisted.web._flatten.html
  Module
  Module
  PRIVATE
  Context-free flattener/serializer for rendering Python objects, possibly complex or arbitrarily nested, as strings.
- twisted.web._http2
  twisted.web._http2.html
  Module
  Module
  PRIVATE
  HTTP2 Implementation
- twisted.web._newclient
  twisted.web._newclient.html
  Module
  Module
  PRIVATE
  An HTTP 1.1 client.
- twisted.web._responses
  twisted.web._responses.html
  Module
  Module
  PRIVATE
  HTTP response code definitions.
- twisted.web._stan
  twisted.web._stan.html
  Module
  Module
  PRIVATE
  An s-expression-like syntax for expressing xml in pure python.
- twisted.web._template_util
  twisted.web._template_util.html
  Module
  Module
  PRIVATE
  twisted.web.util and twisted.web.template merged to avoid cyclic deps
- twisted.web.client
  twisted.web.client.html
  Module
  Module
  PUBLIC
  HTTP client.
- twisted.web.demo
  twisted.web.demo.html
  Module
  Module
  PUBLIC
  I am a simple test resource.
- twisted.web.distrib
  twisted.web.distrib.html
  Module
  Module
  PUBLIC
  Distributed web servers.
- twisted.web.domhelpers
  twisted.web.domhelpers.html
  Module
  Module
  PUBLIC
  A library for performing interesting tasks with DOM objects.
- twisted.web.error
  twisted.web.error.html
  Module
  Module
  PUBLIC
  Exception definitions for `twisted.web`.
- twisted.web.guard
  twisted.web.guard.html
  Module
  Module
  PUBLIC
  Resource traversal integration with `twisted.cred` to allow for authentication and authorization of HTTP requests.
- twisted.web.html
  twisted.web.html.html
  Module
  Module
  PUBLIC
  I hold HTML generation helpers.
- twisted.web.http
  twisted.web.http.html
  Module
  Module
  PUBLIC
  HyperText Transfer Protocol implementation.
- twisted.web.http_headers
  twisted.web.http_headers.html
  Module
  Module
  PUBLIC
  An API for storing HTTP header names and values.
- twisted.web.iweb
  twisted.web.iweb.html
  Module
  Module
  PUBLIC
  Interface definitions for `twisted.web`.
- twisted.web.microdom
  twisted.web.microdom.html
  Module
  Module
  PUBLIC
  Micro Document Object Model: a partial DOM implementation with SUX.
- twisted.web.pages
  twisted.web.pages.html
  Module
  Module
  PUBLIC
  Utility implementations of `IResource`.
- twisted.web.proxy
  twisted.web.proxy.html
  Module
  Module
  PUBLIC
  Simplistic HTTP proxy support.
- twisted.web.resource
  twisted.web.resource.html
  Module
  Module
  PUBLIC
  Implementation of the lowest-level Resource class.
- twisted.web.rewrite
  twisted.web.rewrite.html
  Module
  Module
  PUBLIC
  No module docstring; 1/2 function, 0/1 class documented
- twisted.web.script
  twisted.web.script.html
  Module
  Module
  PUBLIC
  I contain PythonScript, which is a very simple python script resource.
- twisted.web.server
  twisted.web.server.html
  Module
  Module
  PUBLIC
  This is a web server which integrates with the twisted.internet infrastructure.
- twisted.web.soap
  twisted.web.soap.html
  Module
  Module
  PUBLIC
  SOAP support for twisted.web.
- twisted.web.static
  twisted.web.static.html
  Module
  Module
  PUBLIC
  Static resources for `twisted.web`.
- twisted.web.sux
  twisted.web.sux.html
  Module
  Module
  PUBLIC
  *S*mall, *U*ncomplicated *X*ML.
- twisted.web.tap
  twisted.web.tap.html
  Module
  Module
  PUBLIC
  Support for creating a service which runs a web server.
- twisted.web.template
  twisted.web.template.html
  Module
  Module
  PUBLIC
  HTML rendering for twisted.web.
- twisted.web.twcgi
  twisted.web.twcgi.html
  Module
  Module
  PUBLIC
  I hold resource classes and helper classes that deal with CGI scripts.
- twisted.web.util
  twisted.web.util.html
  Module
  Module
  PUBLIC
  An assortment of web server-related utilities.
- twisted.web.vhost
  twisted.web.vhost.html
  Module
  Module
  PUBLIC
  I am a virtual hosts implementation.
- twisted.web.wsgi
  twisted.web.wsgi.html
  Module
  Module
  PUBLIC
  An implementation of Python Web Server Gateway Interface v1.0.1.
- twisted.web.xmlrpc
  twisted.web.xmlrpc.html
  Module
  Module
  PUBLIC
  A generic resource for publishing objects via XML-RPC.
- twisted.words
  twisted.words.html
  Package
  Package
  PUBLIC
  Twisted Words: Client and server implementations for IRC, XMPP, and other chat services.
- twisted.words.ewords
  twisted.words.ewords.html
  Module
  Module
  PUBLIC
  Exception definitions for Words
- twisted.words.im
  twisted.words.im.html
  Package
  Package
  PUBLIC
  Instance Messenger, Pan-protocol chat client.
- twisted.words.im.baseaccount
  twisted.words.im.baseaccount.html
  Module
  Module
  PUBLIC
  No module docstring; 1/1 class documented
- twisted.words.im.basechat
  twisted.words.im.basechat.html
  Module
  Module
  PUBLIC
  Base classes for Instance Messenger clients.
- twisted.words.im.basesupport
  twisted.words.im.basesupport.html
  Module
  Module
  PUBLIC
  Instance Messenger base classes for protocol support.
- twisted.words.im.interfaces
  twisted.words.im.interfaces.html
  Module
  Module
  PUBLIC
  Pan-protocol chat client.
- twisted.words.im.ircsupport
  twisted.words.im.ircsupport.html
  Module
  Module
  PUBLIC
  IRC support for Instance Messenger.
- twisted.words.im.locals
  twisted.words.im.locals.html
  Module
  Module
  PUBLIC
  No module docstring; 0/3 constant, 1/1 exception, 0/2 class documented
- twisted.words.im.pbsupport
  twisted.words.im.pbsupport.html
  Module
  Module
  PUBLIC
  `twisted.words` support for Instance Messenger.
- twisted.words.iwords
  twisted.words.iwords.html
  Module
  Module
  PUBLIC
  No module docstring; 3/5 interfaces documented
- twisted.words.protocols
  twisted.words.protocols.html
  Package
  Package
  PUBLIC
  Chat protocols.
- twisted.words.protocols.irc
  twisted.words.protocols.irc.html
  Module
  Module
  PUBLIC
  Internet Relay Chat protocol for client and server.
- twisted.words.protocols.jabber
  twisted.words.protocols.jabber.html
  Package
  Package
  PUBLIC
  Twisted Jabber: Jabber Protocol Helpers
- twisted.words.protocols.jabber.client
  twisted.words.protocols.jabber.client.html
  Module
  Module
  PUBLIC
  No module docstring; 0/2 variable, 0/4 constant, 1/2 function, 7/7 classes documented
- twisted.words.protocols.jabber.component
  twisted.words.protocols.jabber.component.html
  Module
  Module
  PUBLIC
  External server-side components.
- twisted.words.protocols.jabber.error
  twisted.words.protocols.jabber.error.html
  Module
  Module
  PUBLIC
  XMPP Error support.
- twisted.words.protocols.jabber.ijabber
  twisted.words.protocols.jabber.ijabber.html
  Module
  Module
  PUBLIC
  Public Jabber Interfaces.
- twisted.words.protocols.jabber.jid
  twisted.words.protocols.jabber.jid.html
  Module
  Module
  PUBLIC
  Jabber Identifier support.
- twisted.words.protocols.jabber.jstrports
  twisted.words.protocols.jabber.jstrports.html
  Module
  Module
  PUBLIC
  A temporary placeholder for client-capable strports, until we sufficient use cases get identified
- twisted.words.protocols.jabber.sasl
  twisted.words.protocols.jabber.sasl.html
  Module
  Module
  PUBLIC
  XMPP-specific SASL profile.
- twisted.words.protocols.jabber.sasl_mechanisms
  twisted.words.protocols.jabber.sasl_mechanisms.html
  Module
  Module
  PUBLIC
  Protocol agnostic implementations of SASL authentication mechanisms.
- twisted.words.protocols.jabber.xmlstream
  twisted.words.protocols.jabber.xmlstream.html
  Module
  Module
  PUBLIC
  XMPP XML Streams
- twisted.words.protocols.jabber.xmpp_stringprep
  twisted.words.protocols.jabber.xmpp_stringprep.html
  Module
  Module
  PUBLIC
  No module docstring; 0/4 variable, 0/13 constant, 1/6 class, 2/2 interfaces documented
- twisted.words.service
  twisted.words.service.html
  Module
  Module
  PUBLIC
  A module that needs a better name.
- twisted.words.tap
  twisted.words.tap.html
  Module
  Module
  PUBLIC
  Shiny new words service maker
- twisted.words.xish
  twisted.words.xish.html
  Package
  Package
  PUBLIC
  Twisted X-ish: XML-ish DOM and XPath-ish engine
- twisted.words.xish.domish
  twisted.words.xish.domish.html
  Module
  Module
  PUBLIC
  DOM-like XML processing support.
- twisted.words.xish.utility
  twisted.words.xish.utility.html
  Module
  Module
  PUBLIC
  Event Dispatching and Callback utilities.
- twisted.words.xish.xmlstream
  twisted.words.xish.xmlstream.html
  Module
  Module
  PUBLIC
  XML Stream processing.
- twisted.words.xish.xpath
  twisted.words.xish.xpath.html
  Module
  Module
  PUBLIC
  XPath query support.
- twisted.words.xish.xpathparser
  twisted.words.xish.xpathparser.html
  Module
  Module
  PUBLIC
  XPath Parser.
- twisted.words.xmpproutertap
  twisted.words.xmpproutertap.html
  Module
  Module
  PUBLIC
  Undocumented
- twisted._version.__version__
  twisted._version.html#__version__
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted._threads._ithreads.IExclusiveWorker
  twisted._threads._ithreads.IExclusiveWorker.html
  Class
  Interface
  PUBLIC
  Like `IWorker`, but with the additional guarantee that the callables passed to `do` will not be called exclusively with each other.
- twisted._threads.AlreadyQuit
  twisted._threads.AlreadyQuit.html
  Class
  Exception
  PUBLIC
  This worker worker is dead and cannot execute more instructions.
- twisted._threads.IWorker
  twisted._threads.IWorker.html
  Class
  Interface
  PUBLIC
  A worker that can perform some work concurrently.
- twisted._threads.IWorker.do
  twisted._threads.IWorker.html#do
  Function
  Method
  PUBLIC
  Perform the given task.
- twisted._threads.IWorker.quit
  twisted._threads.IWorker.html#quit
  Function
  Method
  PUBLIC
  Free any resources associated with this `IWorker` and cause it to reject all future work.
- twisted._threads._convenience.Quit
  twisted._threads._convenience.Quit.html
  Class
  Class
  PUBLIC
  A flag representing whether a worker has been quit.
- twisted._threads._convenience.Quit.isSet
  twisted._threads._convenience.Quit.html#isSet
  Attribute
  Instance Variable
  PUBLIC
  Whether this flag is set.
- twisted._threads._convenience.Quit.__init__
  twisted._threads._convenience.Quit.html#__init__
  Function
  Method
  PUBLIC
  Create a `Quit` un-set.
- twisted._threads._convenience.Quit.set
  twisted._threads._convenience.Quit.html#set
  Function
  Method
  PUBLIC
  Set the flag if it has not been set.
- twisted._threads._convenience.Quit.check
  twisted._threads._convenience.Quit.html#check
  Function
  Method
  PUBLIC
  Check if the flag has been set.
- twisted._threads._memory.NoMoreWork
  twisted._threads._memory.html#NoMoreWork
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted._threads._memory.MemoryWorker
  twisted._threads._memory.MemoryWorker.html
  Class
  Class
  PUBLIC
  An `IWorker` that queues work for later performance.
- twisted._threads._memory.MemoryWorker._quit
  twisted._threads._memory.MemoryWorker.html#_quit
  Attribute
  Instance Variable
  PRIVATE
  a flag indicating
- twisted._threads._memory.MemoryWorker.__init__
  twisted._threads._memory.MemoryWorker.html#__init__
  Function
  Method
  PUBLIC
  Create a `MemoryWorker`.
- twisted._threads._memory.MemoryWorker._pending
  twisted._threads._memory.MemoryWorker.html#_pending
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted._threads._memory.MemoryWorker.do
  twisted._threads._memory.MemoryWorker.html#do
  Function
  Method
  PUBLIC
  Queue some work for to perform later; see `createMemoryWorker`.
- twisted._threads._memory.MemoryWorker.quit
  twisted._threads._memory.MemoryWorker.html#quit
  Function
  Method
  PUBLIC
  Quit this worker.
- twisted._threads.createMemoryWorker
  twisted._threads.html#createMemoryWorker
  Function
  Function
  PUBLIC
  Create an `IWorker` that does nothing but defer work, to be performed later.
- twisted.logger.globalLogPublisher
  twisted.logger.html#globalLogPublisher
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.logger.globalLogBeginner
  twisted.logger.html#globalLogBeginner
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.logger.InvalidLogLevelError
  twisted.logger.InvalidLogLevelError.html
  Class
  Exception
  PUBLIC
  Someone tried to use a `LogLevel` that is unknown to the logging system.
- twisted.logger.InvalidLogLevelError.__init__
  twisted.logger.InvalidLogLevelError.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.logger.InvalidLogLevelError.level
  twisted.logger.InvalidLogLevelError.html#level
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.logger.LogLevel
  twisted.logger.LogLevel.html
  Class
  Class
  PUBLIC
  Constants describing log levels.
- twisted.logger.LogLevel.debug
  twisted.logger.LogLevel.html#debug
  Attribute
  Class Variable
  PUBLIC
  Debugging events: Information of use to a developer of the software, not generally of interest to someone running the software unless they are attempting to diagnose a software issue.
- twisted.logger.LogLevel.info
  twisted.logger.LogLevel.html#info
  Attribute
  Class Variable
  PUBLIC
  Informational events: Routine information about the status of an application, such as incoming connections, startup of a subsystem, etc.
- twisted.logger.LogLevel.warn
  twisted.logger.LogLevel.html#warn
  Attribute
  Class Variable
  PUBLIC
  Warning events: Events that may require greater attention than informational events but are not a systemic failure condition, such as authorization failures, bad data from a network client, etc. Such events are of potential interest to system administrators, and should ideally be phrased in such a way, or documented, so as to indicate an action that an administrator might take to mitigate the warning.
- twisted.logger.LogLevel.error
  twisted.logger.LogLevel.html#error
  Attribute
  Class Variable
  PUBLIC
  Error conditions: Events indicating a systemic failure, such as programming errors in the form of unhandled exceptions, loss of connectivity to an external system without which no useful work can proceed, such as a database or API endpoint, or resource exhaustion...
- twisted.logger.LogLevel.critical
  twisted.logger.LogLevel.html#critical
  Attribute
  Class Variable
  PUBLIC
  Critical failures: Errors indicating systemic failure (ie. service outage), data corruption, imminent data loss, etc. which must be handled immediately. This includes errors unanticipated by the software, such as unhandled exceptions, wherein the cause and consequences are unknown.
- twisted.logger.LogLevel.levelWithName
  twisted.logger.LogLevel.html#levelWithName
  Function
  Class Method
  PUBLIC
  Get the log level with the given name.
- twisted.python.compat.unicode
  twisted.python.compat.html#unicode
  Attribute
  Variable
  PUBLIC
  The type of Unicode strings, `unicode` on Python 2 and `str` on Python 3.
- twisted.python.compat.NativeStringIO
  twisted.python.compat.html#NativeStringIO
  Attribute
  Variable
  PUBLIC
  An in-memory file-like object that operates on the native string type (bytes in Python 2, unicode in Python 3).
- twisted.python.compat.urllib_parse
  twisted.python.compat.html#urllib_parse
  Attribute
  Variable
  PUBLIC
  a URL-parsing module (urlparse on Python 2, urllib.parse on Python 3)
- twisted.python.deprecate.DEPRECATION_WARNING_FORMAT
  twisted.python.deprecate.html#DEPRECATION_WARNING_FORMAT
  Attribute
  Constant
  PUBLIC
  The default deprecation warning string format to use when one is not provided by the user.
- twisted.python.deprecate._getReplacementString
  twisted.python.deprecate.html#_getReplacementString
  Function
  Function
  PRIVATE
  Surround a replacement for a deprecated API with some polite text exhorting the user to consider it as an alternative.
- twisted.python.deprecate._getDeprecationDocstring
  twisted.python.deprecate.html#_getDeprecationDocstring
  Function
  Function
  PRIVATE
  Generate an addition to a deprecated object's docstring that explains its deprecation.
- twisted.python.deprecate._getDeprecationWarningString
  twisted.python.deprecate.html#_getDeprecationWarningString
  Function
  Function
  PRIVATE
  Return a string indicating that the Python name was deprecated in the given version.
- twisted.python.deprecate.getDeprecationWarningString
  twisted.python.deprecate.html#getDeprecationWarningString
  Function
  Function
  PUBLIC
  Return a string indicating that the callable was deprecated in the given version.
- twisted.python.deprecate._appendToDocstring
  twisted.python.deprecate.html#_appendToDocstring
  Function
  Function
  PRIVATE
  Append the given text to the docstring of `thingWithDoc`.
- twisted.python.deprecate.deprecated
  twisted.python.deprecate.html#deprecated
  Function
  Function
  PUBLIC
  Return a decorator that marks callables as deprecated. To deprecate a property, see `deprecatedProperty`.
- twisted.python.deprecate.deprecatedProperty
  twisted.python.deprecate.html#deprecatedProperty
  Function
  Function
  PUBLIC
  Return a decorator that marks a property as deprecated. To deprecate a regular callable or class, see `deprecated`.
- twisted.python.deprecate.getWarningMethod
  twisted.python.deprecate.html#getWarningMethod
  Function
  Function
  PUBLIC
  Return the warning method currently used to record deprecation warnings.
- twisted.python.deprecate.setWarningMethod
  twisted.python.deprecate.html#setWarningMethod
  Function
  Function
  PUBLIC
  Set the warning method to use to record deprecation warnings.
- twisted.python.deprecate._InternalState
  twisted.python.deprecate._InternalState.html
  Class
  Class
  PRIVATE
  An `_InternalState` is a helper object for a `_ModuleProxy`, so that it can easily access its own attributes, bypassing its logic for delegating to another object that it's proxying for.
- twisted.python.deprecate._InternalState.proxy
  twisted.python.deprecate._InternalState.html#proxy
  Attribute
  Instance Variable
  PUBLIC
  a `_ModuleProxy`
- twisted.python.deprecate._InternalState.__init__
  twisted.python.deprecate._InternalState.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.deprecate._InternalState.__getattribute__
  twisted.python.deprecate._InternalState.html#__getattribute__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.deprecate._InternalState.__setattr__
  twisted.python.deprecate._InternalState.html#__setattr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.deprecate._ModuleProxy
  twisted.python.deprecate._ModuleProxy.html
  Class
  Class
  PRIVATE
  Python module wrapper to hook module-level attribute access.
- twisted.python.deprecate._ModuleProxy._module
  twisted.python.deprecate._ModuleProxy.html#_module
  Attribute
  Instance Variable
  PRIVATE
  Module on which to hook attribute access.
- twisted.python.deprecate._ModuleProxy._deprecatedAttributes
  twisted.python.deprecate._ModuleProxy.html#_deprecatedAttributes
  Attribute
  Instance Variable
  PRIVATE
  Mapping of attribute names to objects that retrieve the module attribute's original value.
- twisted.python.deprecate._ModuleProxy._lastWasPath
  twisted.python.deprecate._ModuleProxy.html#_lastWasPath
  Attribute
  Instance Variable
  PRIVATE
  Heuristic guess as to whether warnings about this package should be ignored for the next call. If the last attribute access of this module was a `getattr` of `__path__`, we will assume that it was the import system doing it and we won't emit a warning for the next access, even if it is to a deprecated attribute...
- twisted.python.deprecate._ModuleProxy.__init__
  twisted.python.deprecate._ModuleProxy.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.deprecate._ModuleProxy.__repr__
  twisted.python.deprecate._ModuleProxy.html#__repr__
  Function
  Method
  PUBLIC
  Get a string containing the type of the module proxy and a representation of the wrapped module object.
- twisted.python.deprecate._ModuleProxy.__setattr__
  twisted.python.deprecate._ModuleProxy.html#__setattr__
  Function
  Method
  PUBLIC
  Set an attribute on the wrapped module object.
- twisted.python.deprecate._ModuleProxy.__getattribute__
  twisted.python.deprecate._ModuleProxy.html#__getattribute__
  Function
  Method
  PUBLIC
  Get an attribute from the module object, possibly emitting a warning.
- twisted.python.deprecate._DeprecatedAttribute
  twisted.python.deprecate._DeprecatedAttribute.html
  Class
  Class
  PRIVATE
  Wrapper for deprecated attributes.
- twisted.python.deprecate._DeprecatedAttribute.module
  twisted.python.deprecate._DeprecatedAttribute.html#module
  Attribute
  Instance Variable
  PUBLIC
  The original module instance containing this attribute
- twisted.python.deprecate._DeprecatedAttribute.fqpn
  twisted.python.deprecate._DeprecatedAttribute.html#fqpn
  Attribute
  Instance Variable
  PUBLIC
  Fully qualified Python name for the deprecated attribute
- twisted.python.deprecate._DeprecatedAttribute.version
  twisted.python.deprecate._DeprecatedAttribute.html#version
  Attribute
  Instance Variable
  PUBLIC
  Version that the attribute was deprecated in
- twisted.python.deprecate._DeprecatedAttribute.message
  twisted.python.deprecate._DeprecatedAttribute.html#message
  Attribute
  Instance Variable
  PUBLIC
  Deprecation message
- twisted.python.deprecate._DeprecatedAttribute.__init__
  twisted.python.deprecate._DeprecatedAttribute.html#__init__
  Function
  Method
  PUBLIC
  Initialise a deprecated name wrapper.
- twisted.python.deprecate._DeprecatedAttribute.__name__
  twisted.python.deprecate._DeprecatedAttribute.html#__name__
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.deprecate._DeprecatedAttribute.get
  twisted.python.deprecate._DeprecatedAttribute.html#get
  Function
  Method
  PUBLIC
  Get the underlying attribute value and issue a deprecation warning.
- twisted.python.deprecate._deprecateAttribute
  twisted.python.deprecate.html#_deprecateAttribute
  Function
  Function
  PRIVATE
  Mark a module-level attribute as being deprecated.
- twisted.python.deprecate.deprecatedModuleAttribute
  twisted.python.deprecate.html#deprecatedModuleAttribute
  Function
  Function
  PUBLIC
  Declare a module-level attribute as being deprecated.
- twisted.python.deprecate.warnAboutFunction
  twisted.python.deprecate.html#warnAboutFunction
  Function
  Function
  PUBLIC
  Issue a warning string, identifying `offender` as the responsible code.
- twisted.python.deprecate._passedArgSpec
  twisted.python.deprecate.html#_passedArgSpec
  Function
  Function
  PRIVATE
  Take an inspect.ArgSpec, a tuple of positional arguments, and a dict of keyword arguments, and return a mapping of arguments that were actually passed to their passed values.
- twisted.python.deprecate._passedSignature
  twisted.python.deprecate.html#_passedSignature
  Function
  Function
  PRIVATE
  Take an `inspect.Signature`, a tuple of positional arguments, and a dict of keyword arguments, and return a mapping of arguments that were actually passed to their passed values.
- twisted.python.deprecate._mutuallyExclusiveArguments
  twisted.python.deprecate.html#_mutuallyExclusiveArguments
  Function
  Function
  PRIVATE
  Decorator which causes its decoratee to raise a `TypeError` if two of the given arguments are passed at the same time.
- twisted.python.deprecate._Tc
  twisted.python.deprecate.html#_Tc
  Attribute
  Type Variable
  PRIVATE
  Undocumented
- twisted.python.deprecate.deprecatedKeywordParameter
  twisted.python.deprecate.html#deprecatedKeywordParameter
  Function
  Function
  PUBLIC
  Return a decorator that marks a keyword parameter of a callable as deprecated. A warning will be emitted if a caller supplies a value for the parameter, whether the caller uses a keyword or positional syntax.
- twisted.python.compat._PY37PLUS
  twisted.python.compat.html#_PY37PLUS
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.python.compat._PYPY
  twisted.python.compat.html#_PYPY
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.python.compat.iteritems
  twisted.python.compat.html#iteritems
  Function
  Function
  PUBLIC
  Return an iterable of the items of `d`.
- twisted.python.compat.itervalues
  twisted.python.compat.html#itervalues
  Function
  Function
  PUBLIC
  Return an iterable of the values of `d`.
- twisted.python.compat.items
  twisted.python.compat.html#items
  Function
  Function
  PUBLIC
  Return a list of the items of `d`.
- twisted.python.compat.currentframe
  twisted.python.compat.html#currentframe
  Function
  Function
  PUBLIC
  In Python 3, `inspect.currentframe` does not take a stack-level argument. Restore that functionality from Python 2 so we don't have to re-implement the `f_back`-walking loop in places where it's called.
- twisted.python.compat.execfile
  twisted.python.compat.html#execfile
  Function
  Function
  PUBLIC
  Execute a Python script in the given namespaces.
- twisted.python.compat.cmp
  twisted.python.compat.html#cmp
  Function
  Function
  PUBLIC
  Compare two objects.
- twisted.python.compat.comparable
  twisted.python.compat.html#comparable
  Function
  Function
  PUBLIC
  Class decorator that ensures support for the special `__cmp__` method.
- twisted.python.compat.ioType
  twisted.python.compat.html#ioType
  Function
  Function
  PUBLIC
  Determine the type which will be returned from the given file object's read() and accepted by its write() method as an argument.
- twisted.python.compat.nativeString
  twisted.python.compat.html#nativeString
  Function
  Function
  PUBLIC
  Convert `bytes` or `str` to `str` type, using ASCII encoding if conversion is necessary.
- twisted.python.compat._matchingString
  twisted.python.compat.html#_matchingString
  Function
  Function
  PRIVATE
  Some functions, such as `os.path.join`, operate on string arguments which may be bytes or text, and wish to return a value of the same type. In those cases you may wish to have a string constant (in the case of ...
- twisted.python.compat.reraise
  twisted.python.compat.html#reraise
  Function
  Function
  PUBLIC
  Re-raise an exception, with an optional traceback.
- twisted.python.compat.iterbytes
  twisted.python.compat.html#iterbytes
  Function
  Function
  PUBLIC
  Return an iterable wrapper for a `bytes` object that provides the behavior of iterating over `bytes` on Python 2.
- twisted.python.compat.intToBytes
  twisted.python.compat.html#intToBytes
  Function
  Function
  PUBLIC
  Convert the given integer into `bytes`, as ASCII-encoded Arab numeral.
- twisted.python.compat.lazyByteSlice
  twisted.python.compat.html#lazyByteSlice
  Function
  Function
  PUBLIC
  Return a copy of the given bytes-like object.
- twisted.python.compat.networkString
  twisted.python.compat.html#networkString
  Function
  Function
  PUBLIC
  Convert a string to `bytes` using ASCII encoding.
- twisted.python.compat.bytesEnviron
  twisted.python.compat.html#bytesEnviron
  Function
  Function
  PUBLIC
  Return a `dict` of `os.environ` where all text-strings are encoded into `bytes`.
- twisted.python.compat._constructMethod
  twisted.python.compat.html#_constructMethod
  Function
  Function
  PRIVATE
  Construct a bound method.
- twisted.python.compat._get_async_param
  twisted.python.compat.html#_get_async_param
  Function
  Function
  PRIVATE
  Provide a backwards-compatible way to get async param value that does not cause a syntax error under Python 3.7.
- twisted.python.compat._pypy3BlockingHack
  twisted.python.compat.html#_pypy3BlockingHack
  Function
  Function
  PRIVATE
  Work around https://foss.heptapod.net/pypy/pypy/-/issues/3051 by replacing `socket.fromfd` with a more conservative version.
- twisted.python.reflect.fullyQualifiedName
  twisted.python.reflect.html#fullyQualifiedName
  Function
  Function
  PUBLIC
  Return the fully qualified name of a module, class, method or function. Classes and functions need to be module level ones to be correctly qualified.
- twisted.python.reflect.RegexType
  twisted.python.reflect.html#RegexType
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.python.reflect.prefixedMethodNames
  twisted.python.reflect.html#prefixedMethodNames
  Function
  Function
  PUBLIC
  Given a class object `classObj`, returns a list of method names that match the string `prefix`.
- twisted.python.reflect.addMethodNamesToDict
  twisted.python.reflect.html#addMethodNamesToDict
  Function
  Function
  PUBLIC
  This goes through `classObj` (and its bases) and puts method names starting with 'prefix' in 'dict' with a value of 1. if baseClass isn't None, methods will only be added if classObj is-a baseClass
- twisted.python.reflect.prefixedMethods
  twisted.python.reflect.html#prefixedMethods
  Function
  Function
  PUBLIC
  Given an object `obj`, returns a list of method objects that match the string `prefix`.
- twisted.python.reflect.accumulateMethods
  twisted.python.reflect.html#accumulateMethods
  Function
  Function
  PUBLIC
  Given an object `obj`, add all methods that begin with `prefix`.
- twisted.python.reflect.namedModule
  twisted.python.reflect.html#namedModule
  Function
  Function
  PUBLIC
  Return a module given its name.
- twisted.python.reflect.namedObject
  twisted.python.reflect.html#namedObject
  Function
  Function
  PUBLIC
  Get a fully named module-global object.
- twisted.python.reflect.requireModule
  twisted.python.reflect.html#requireModule
  Function
  Function
  PUBLIC
  Try to import a module given its name, returning `default` value if `ImportError` is raised during import.
- twisted.python.reflect._NoModuleFound
  twisted.python.reflect._NoModuleFound.html
  Class
  Exception
  PRIVATE
  No module was found because none exists.
- twisted.python.reflect.InvalidName
  twisted.python.reflect.InvalidName.html
  Class
  Exception
  PUBLIC
  The given name is not a dot-separated list of Python objects.
- twisted.python.reflect.ModuleNotFound
  twisted.python.reflect.ModuleNotFound.html
  Class
  Exception
  PUBLIC
  The module associated with the given name doesn't exist and it can't be imported.
- twisted.python.reflect.ObjectNotFound
  twisted.python.reflect.ObjectNotFound.html
  Class
  Exception
  PUBLIC
  The object associated with the given name doesn't exist and it can't be imported.
- twisted.python.reflect._importAndCheckStack
  twisted.python.reflect.html#_importAndCheckStack
  Function
  Function
  PRIVATE
  Import the given name as a module, then walk the stack to determine whether the failure was the module not existing, or some code in the module (for example a dependent import) failing. This can be helpful to determine whether any actual application code was run...
- twisted.python.reflect.namedAny
  twisted.python.reflect.html#namedAny
  Function
  Function
  PUBLIC
  Retrieve a Python object by its fully qualified name from the global Python module namespace. The first part of the name, that describes a module, will be discovered and imported. Each subsequent part of the name is treated as the name of an attribute of the object specified by all of the name which came before it...
- twisted.python.reflect.filenameToModuleName
  twisted.python.reflect.html#filenameToModuleName
  Function
  Function
  PUBLIC
  Convert a name in the filesystem to the name of the Python module it is.
- twisted.python.reflect.qual
  twisted.python.reflect.html#qual
  Function
  Function
  PUBLIC
  Return full import path of a class.
- twisted.python.reflect._determineClass
  twisted.python.reflect.html#_determineClass
  Function
  Function
  PRIVATE
  Undocumented
- twisted.python.reflect._determineClassName
  twisted.python.reflect.html#_determineClassName
  Function
  Function
  PRIVATE
  Undocumented
- twisted.python.reflect._safeFormat
  twisted.python.reflect.html#_safeFormat
  Function
  Function
  PRIVATE
  Helper function for `safe_repr` and `safe_str`.
- twisted.python.reflect.safe_repr
  twisted.python.reflect.html#safe_repr
  Function
  Function
  PUBLIC
  Returns a string representation of an object, or a string containing a traceback, if that object's __repr__ raised an exception.
- twisted.python.reflect.safe_str
  twisted.python.reflect.html#safe_str
  Function
  Function
  PUBLIC
  Returns a string representation of an object, or a string containing a traceback, if that object's __str__ raised an exception.
- twisted.python.reflect.QueueMethod
  twisted.python.reflect.QueueMethod.html
  Class
  Class
  PUBLIC
  I represent a method that doesn't exist yet.
- twisted.python.reflect.QueueMethod.__init__
  twisted.python.reflect.QueueMethod.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.reflect.QueueMethod.name
  twisted.python.reflect.QueueMethod.html#name
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.reflect.QueueMethod.calls
  twisted.python.reflect.QueueMethod.html#calls
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.reflect.QueueMethod.__call__
  twisted.python.reflect.QueueMethod.html#__call__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.reflect.fullFuncName
  twisted.python.reflect.html#fullFuncName
  Function
  Function
  PUBLIC
  Undocumented
- twisted.python.reflect.getClass
  twisted.python.reflect.html#getClass
  Function
  Function
  PUBLIC
  Return the class or type of object 'obj'.
- twisted.python.reflect.accumulateClassDict
  twisted.python.reflect.html#accumulateClassDict
  Function
  Function
  PUBLIC
  Accumulate all attributes of a given name in a class hierarchy into a single dictionary.
- twisted.python.reflect.accumulateClassList
  twisted.python.reflect.html#accumulateClassList
  Function
  Function
  PUBLIC
  Accumulate all attributes of a given name in a class hierarchy into a single list.
- twisted.python.reflect.isSame
  twisted.python.reflect.html#isSame
  Function
  Function
  PUBLIC
  Undocumented
- twisted.python.reflect.isLike
  twisted.python.reflect.html#isLike
  Function
  Function
  PUBLIC
  Undocumented
- twisted.python.reflect.modgrep
  twisted.python.reflect.html#modgrep
  Function
  Function
  PUBLIC
  Undocumented
- twisted.python.reflect.isOfType
  twisted.python.reflect.html#isOfType
  Function
  Function
  PUBLIC
  Undocumented
- twisted.python.reflect.findInstances
  twisted.python.reflect.html#findInstances
  Function
  Function
  PUBLIC
  Undocumented
- twisted.python.reflect.objgrep
  twisted.python.reflect.html#objgrep
  Function
  Function
  PUBLIC
  `objgrep` finds paths between `start` and `goal`.
- twisted.python.failure.count
  twisted.python.failure.html#count
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.python.failure.traceupLength
  twisted.python.failure.html#traceupLength
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.python.failure.DefaultException
  twisted.python.failure.DefaultException.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.python.failure.format_frames
  twisted.python.failure.html#format_frames
  Function
  Function
  PUBLIC
  Format and write frames.
- twisted.python.failure.EXCEPTION_CAUGHT_HERE
  twisted.python.failure.html#EXCEPTION_CAUGHT_HERE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.python.failure.NoCurrentExceptionError
  twisted.python.failure.NoCurrentExceptionError.html
  Class
  Exception
  PUBLIC
  Raised when trying to create a Failure from the current interpreter exception state and there is no current exception state.
- twisted.python.failure._Traceback
  twisted.python.failure.html#_Traceback
  Function
  Function
  PRIVATE
  Construct a fake traceback object using a list of frames.
- twisted.python.failure._TracebackFrame
  twisted.python.failure._TracebackFrame.html
  Class
  Class
  PRIVATE
  Fake traceback object which can be passed to functions in the standard library `traceback` module.
- twisted.python.failure._TracebackFrame.__init__
  twisted.python.failure._TracebackFrame.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.python.failure._TracebackFrame.tb_frame
  twisted.python.failure._TracebackFrame.html#tb_frame
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.failure._TracebackFrame.tb_lineno
  twisted.python.failure._TracebackFrame.html#tb_lineno
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.failure._TracebackFrame.tb_lasti
  twisted.python.failure._TracebackFrame.html#tb_lasti
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.failure._TracebackFrame.tb_next
  twisted.python.failure._TracebackFrame.html#tb_next
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.failure._Frame
  twisted.python.failure._Frame.html
  Class
  Class
  PRIVATE
  A fake frame object, used by `_Traceback`.
- twisted.python.failure._Frame.f_code
  twisted.python.failure._Frame.html#f_code
  Attribute
  Instance Variable
  PUBLIC
  fake `code` object
- twisted.python.failure._Frame.f_lineno
  twisted.python.failure._Frame.html#f_lineno
  Attribute
  Instance Variable
  PUBLIC
  line number
- twisted.python.failure._Frame.f_globals
  twisted.python.failure._Frame.html#f_globals
  Attribute
  Instance Variable
  PUBLIC
  fake f_globals dictionary (usually empty)
- twisted.python.failure._Frame.f_locals
  twisted.python.failure._Frame.html#f_locals
  Attribute
  Instance Variable
  PUBLIC
  fake f_locals dictionary (usually empty)
- twisted.python.failure._Frame.f_back
  twisted.python.failure._Frame.html#f_back
  Attribute
  Instance Variable
  PUBLIC
  previous stack frame (towards the caller)
- twisted.python.failure._Frame.__init__
  twisted.python.failure._Frame.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.python.failure._Frame.f_lasti
  twisted.python.failure._Frame.html#f_lasti
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.failure._Frame.f_builtins
  twisted.python.failure._Frame.html#f_builtins
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.failure._Frame.f_trace
  twisted.python.failure._Frame.html#f_trace
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.failure._Code
  twisted.python.failure._Code.html
  Class
  Class
  PRIVATE
  A fake code object, used by `_Traceback` via `_Frame`.
- twisted.python.failure._Code.__init__
  twisted.python.failure._Code.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.failure._Code.co_name
  twisted.python.failure._Code.html#co_name
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.failure._Code.co_filename
  twisted.python.failure._Code.html#co_filename
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.failure._Code.co_lnotab
  twisted.python.failure._Code.html#co_lnotab
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.failure._Code.co_firstlineno
  twisted.python.failure._Code.html#co_firstlineno
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.failure._Code.co_argcount
  twisted.python.failure._Code.html#co_argcount
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.failure._Code.co_varnames
  twisted.python.failure._Code.html#co_varnames
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.failure._Code.co_code
  twisted.python.failure._Code.html#co_code
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.failure._Code.co_cellvars
  twisted.python.failure._Code.html#co_cellvars
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.failure._Code.co_consts
  twisted.python.failure._Code.html#co_consts
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.failure._Code.co_flags
  twisted.python.failure._Code.html#co_flags
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.failure._Code.co_freevars
  twisted.python.failure._Code.html#co_freevars
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.failure._Code.co_posonlyargcount
  twisted.python.failure._Code.html#co_posonlyargcount
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.failure._Code.co_kwonlyargcount
  twisted.python.failure._Code.html#co_kwonlyargcount
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.failure._Code.co_names
  twisted.python.failure._Code.html#co_names
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.failure._Code.co_nlocals
  twisted.python.failure._Code.html#co_nlocals
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.failure._Code.co_stacksize
  twisted.python.failure._Code.html#co_stacksize
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.failure._Code.co_positions
  twisted.python.failure._Code.html#co_positions
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.failure._inlineCallbacksExtraneous
  twisted.python.failure.html#_inlineCallbacksExtraneous
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.python.failure._extraneous
  twisted.python.failure.html#_extraneous
  Function
  Function
  PRIVATE
  Mark the given callable as extraneous to inlineCallbacks exception reporting; don't show these functions.
- twisted.python.failure.Failure
  twisted.python.failure.Failure.html
  Class
  Exception
  PUBLIC
  A basic abstraction for an error that has occurred.
- twisted.python.failure.Failure.value
  twisted.python.failure.Failure.html#value
  Attribute
  Instance Variable
  PUBLIC
  The exception instance responsible for this failure.
- twisted.python.failure.Failure.type
  twisted.python.failure.Failure.html#type
  Attribute
  Instance Variable
  PUBLIC
  The exception's class.
- twisted.python.failure.Failure.stack
  twisted.python.failure.Failure.html#stack
  Attribute
  Instance Variable
  PUBLIC
  list of frames, innermost last, excluding `Failure.__init__`.
- twisted.python.failure.Failure.frames
  twisted.python.failure.Failure.html#frames
  Attribute
  Instance Variable
  PUBLIC
  list of frames, innermost first.
- twisted.python.failure.Failure.pickled
  twisted.python.failure.Failure.html#pickled
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.python.failure.Failure._yieldOpcode
  twisted.python.failure.Failure.html#_yieldOpcode
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.python.failure.Failure.__init__
  twisted.python.failure.Failure.html#__init__
  Function
  Method
  PUBLIC
  Initialize me with an explanation of the error.
- twisted.python.failure.Failure.count
  twisted.python.failure.Failure.html#count
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.failure.Failure.captureVars
  twisted.python.failure.Failure.html#captureVars
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.failure.Failure.tb
  twisted.python.failure.Failure.html#tb
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.failure.Failure.parents
  twisted.python.failure.Failure.html#parents
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.failure.Failure._extrapolate
  twisted.python.failure.Failure.html#_extrapolate
  Function
  Method
  PRIVATE
  Extrapolate from one failure into another, copying its stack frames.
- twisted.python.failure.Failure.__dict__
  twisted.python.failure.Failure.html#__dict__
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.failure.Failure.trap
  twisted.python.failure.Failure.html#trap
  Function
  Method
  PUBLIC
  Trap this failure if its type is in a predetermined list.
- twisted.python.failure.Failure.check
  twisted.python.failure.Failure.html#check
  Function
  Method
  PUBLIC
  Check if this failure's type is in a predetermined list.
- twisted.python.failure.Failure.raiseException
  twisted.python.failure.Failure.html#raiseException
  Function
  Method
  PUBLIC
  raise the original exception, preserving traceback information if available.
- twisted.python.failure.Failure.throwExceptionIntoGenerator
  twisted.python.failure.Failure.html#throwExceptionIntoGenerator
  Function
  Method
  PUBLIC
  Throw the original exception into the given generator, preserving traceback information if available.
- twisted.python.failure.Failure._findFailure
  twisted.python.failure.Failure.html#_findFailure
  Function
  Class Method
  PRIVATE
  Find the failure that represents the exception currently in context.
- twisted.python.failure.Failure.__repr__
  twisted.python.failure.Failure.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.failure.Failure.__str__
  twisted.python.failure.Failure.html#__str__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.failure.Failure.__getstate__
  twisted.python.failure.Failure.html#__getstate__
  Function
  Method
  PUBLIC
  Avoid pickling objects in the traceback.
- twisted.python.failure.Failure.cleanFailure
  twisted.python.failure.Failure.html#cleanFailure
  Function
  Method
  PUBLIC
  Remove references to other objects, replacing them with strings.
- twisted.python.failure.Failure.getTracebackObject
  twisted.python.failure.Failure.html#getTracebackObject
  Function
  Method
  PUBLIC
  Get an object that represents this Failure's stack that can be passed to traceback.extract_tb.
- twisted.python.failure.Failure.getErrorMessage
  twisted.python.failure.Failure.html#getErrorMessage
  Function
  Method
  PUBLIC
  Get a string of the exception which caused this Failure.
- twisted.python.failure.Failure.getBriefTraceback
  twisted.python.failure.Failure.html#getBriefTraceback
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.failure.Failure.getTraceback
  twisted.python.failure.Failure.html#getTraceback
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.failure.Failure.printTraceback
  twisted.python.failure.Failure.html#printTraceback
  Function
  Method
  PUBLIC
  Emulate Python's standard error reporting mechanism.
- twisted.python.failure.Failure.printBriefTraceback
  twisted.python.failure.Failure.html#printBriefTraceback
  Function
  Method
  PUBLIC
  Print a traceback as densely as possible.
- twisted.python.failure.Failure.printDetailedTraceback
  twisted.python.failure.Failure.html#printDetailedTraceback
  Function
  Method
  PUBLIC
  Print a traceback with detailed locals and globals information.
- twisted.python.failure._safeReprVars
  twisted.python.failure.html#_safeReprVars
  Function
  Function
  PRIVATE
  Convert a list of (name, object) pairs into (name, repr) pairs.
- twisted.python.failure.DO_POST_MORTEM
  twisted.python.failure.html#DO_POST_MORTEM
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.python.failure._debuginit
  twisted.python.failure.html#_debuginit
  Function
  Function
  PRIVATE
  Initialize failure object, possibly spawning pdb.
- twisted.python.failure.startDebugMode
  twisted.python.failure.html#startDebugMode
  Function
  Function
  PUBLIC
  Enable debug hooks for Failures.
- twisted.logger._logger._log
  twisted.logger._logger.html#_log
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.logger._interfaces.LogTrace
  twisted.logger._interfaces.html#LogTrace
  Attribute
  Type Alias
  PUBLIC
  Undocumented
- twisted.logger._flatten.aFormatter
  twisted.logger._flatten.html#aFormatter
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.logger._flatten.KeyFlattener
  twisted.logger._flatten.KeyFlattener.html
  Class
  Class
  PUBLIC
  A `KeyFlattener` computes keys for the things within curly braces in PEP-3101-style format strings as parsed by `string.Formatter.parse`.
- twisted.logger._flatten.KeyFlattener.__init__
  twisted.logger._flatten.KeyFlattener.html#__init__
  Function
  Method
  PUBLIC
  Initialize a `KeyFlattener`.
- twisted.logger._flatten.KeyFlattener.keys
  twisted.logger._flatten.KeyFlattener.html#keys
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.logger._flatten.KeyFlattener.flatKey
  twisted.logger._flatten.KeyFlattener.html#flatKey
  Function
  Method
  PUBLIC
  Compute a string key for a given field/format/conversion.
- twisted.logger._flatten.flattenEvent
  twisted.logger._flatten.html#flattenEvent
  Function
  Function
  PUBLIC
  Flatten the given event by pre-associating format fields with specific objects and callable results in a `dict` put into the `"log_flattened"` key in the event.
- twisted.logger._flatten.flatFormat
  twisted.logger._flatten.html#flatFormat
  Function
  Function
  PUBLIC
  Format an event which has been flattened with `flattenEvent`.
- twisted.logger.extractField
  twisted.logger.html#extractField
  Function
  Function
  PUBLIC
  Extract a given format field from the given event.
- twisted.python._tzhelper.FixedOffsetTimeZone
  twisted.python._tzhelper.FixedOffsetTimeZone.html
  Class
  Class
  PUBLIC
  Represents a fixed timezone offset (without daylight saving time).
- twisted.python._tzhelper.FixedOffsetTimeZone.name
  twisted.python._tzhelper.FixedOffsetTimeZone.html#name
  Attribute
  Instance Variable
  PUBLIC
  A `str` giving the name of this timezone; the name just includes how much time this offset represents.
- twisted.python._tzhelper.FixedOffsetTimeZone.offset
  twisted.python._tzhelper.FixedOffsetTimeZone.html#offset
  Attribute
  Instance Variable
  PUBLIC
  A `TimeDelta` giving the amount of time this timezone is offset.
- twisted.python._tzhelper.FixedOffsetTimeZone.__init__
  twisted.python._tzhelper.FixedOffsetTimeZone.html#__init__
  Function
  Method
  PUBLIC
  Construct a `FixedOffsetTimeZone` with a fixed offset.
- twisted.python._tzhelper.FixedOffsetTimeZone.fromSignHoursMinutes
  twisted.python._tzhelper.FixedOffsetTimeZone.html#fromSignHoursMinutes
  Function
  Class Method
  PUBLIC
  Construct a `FixedOffsetTimeZone` from an offset described by sign ('+' or '-'), hours, and minutes.
- twisted.python._tzhelper.FixedOffsetTimeZone.fromLocalTimeStamp
  twisted.python._tzhelper.FixedOffsetTimeZone.html#fromLocalTimeStamp
  Function
  Class Method
  PUBLIC
  Create a time zone with a fixed offset corresponding to a time stamp in the system's locally configured time zone.
- twisted.python._tzhelper.FixedOffsetTimeZone.utcoffset
  twisted.python._tzhelper.FixedOffsetTimeZone.html#utcoffset
  Function
  Method
  PUBLIC
  Return the given timezone's offset from UTC.
- twisted.python._tzhelper.FixedOffsetTimeZone.dst
  twisted.python._tzhelper.FixedOffsetTimeZone.html#dst
  Function
  Method
  PUBLIC
  Return a zero `TimeDelta` for the daylight saving time offset, since there is never one.
- twisted.python._tzhelper.FixedOffsetTimeZone.tzname
  twisted.python._tzhelper.FixedOffsetTimeZone.html#tzname
  Function
  Method
  PUBLIC
  Return a string describing this timezone.
- twisted.python._tzhelper.UTC
  twisted.python._tzhelper.html#UTC
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.logger._format.formatUnformattableEvent
  twisted.logger._format.html#formatUnformattableEvent
  Function
  Function
  PUBLIC
  Formats an event as text that describes the event generically and a formatting error.
- twisted.logger._format.CallMapping
  twisted.logger._format.CallMapping.html
  Class
  Class
  PUBLIC
  Read-only mapping that turns a `()`-suffix in key names into an invocation of the key rather than a lookup of the key.
- twisted.logger._format.CallMapping.__init__
  twisted.logger._format.CallMapping.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.logger._format.CallMapping._submapping
  twisted.logger._format.CallMapping.html#_submapping
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.logger._format.CallMapping.__iter__
  twisted.logger._format.CallMapping.html#__iter__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.logger._format.CallMapping.__len__
  twisted.logger._format.CallMapping.html#__len__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.logger._format.CallMapping.__getitem__
  twisted.logger._format.CallMapping.html#__getitem__
  Function
  Method
  PUBLIC
  Look up an item in the submapping for this `CallMapping`, calling it if `key` ends with `"()"`.
- twisted.logger._format.formatWithCall
  twisted.logger._format.html#formatWithCall
  Function
  Function
  PUBLIC
  Format a string like `str.format`, but:
- twisted.logger._format._formatEvent
  twisted.logger._format.html#_formatEvent
  Function
  Function
  PRIVATE
  Formats an event as a string, using the format in `event["log_format"]`.
- twisted.logger._format._formatTraceback
  twisted.logger._format.html#_formatTraceback
  Function
  Function
  PRIVATE
  Format a failure traceback, assuming UTF-8 and using a replacement strategy for errors. Every effort is made to provide a usable traceback, but should not that not be possible, a message and the captured exception are logged.
- twisted.logger._format._formatSystem
  twisted.logger._format.html#_formatSystem
  Function
  Function
  PRIVATE
  Format the system specified in the event in the "log_system" key if set, otherwise the `"log_namespace"` and `"log_level"`, joined by a `"#"`. Each defaults to `"-"` is not set. If formatting fails completely, "UNFORMATTABLE" is returned.
- twisted.logger.formatEvent
  twisted.logger.html#formatEvent
  Function
  Function
  PUBLIC
  Formats an event as text, using the format in `event["log_format"]`.
- twisted.logger.formatEventAsClassicLogText
  twisted.logger.html#formatEventAsClassicLogText
  Function
  Function
  PUBLIC
  Format an event as a line of human-readable text for, e.g. traditional log file output.
- twisted.logger.formatTime
  twisted.logger.html#formatTime
  Function
  Function
  PUBLIC
  Format a timestamp as text.
- twisted.logger.timeFormatRFC3339
  twisted.logger.html#timeFormatRFC3339
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.logger.eventAsText
  twisted.logger.html#eventAsText
  Function
  Function
  PUBLIC
  Format an event as text. Optionally, attach timestamp, traceback, and system information.
- twisted.logger.ILogObserver
  twisted.logger.ILogObserver.html
  Class
  Interface
  PUBLIC
  An observer which can handle log events.
- twisted.logger.ILogObserver.__call__
  twisted.logger.ILogObserver.html#__call__
  Function
  Method
  PUBLIC
  Log an event.
- twisted.logger.LogEvent
  twisted.logger.html#LogEvent
  Attribute
  Type Alias
  PUBLIC
  Undocumented
- twisted.logger.Logger
  twisted.logger.Logger.html
  Class
  Class
  PUBLIC
  A `Logger` emits log messages to an observer. You should instantiate it as a class or module attribute, as documented in `this module's documentation`.
- twisted.logger.Logger.namespace
  twisted.logger.Logger.html#namespace
  Attribute
  Instance Variable
  PUBLIC
  the namespace for this logger
- twisted.logger.Logger.source
  twisted.logger.Logger.html#source
  Attribute
  Instance Variable
  PUBLIC
  The object which is emitting events via this logger
- twisted.logger.Logger.observer
  twisted.logger.Logger.html#observer
  Attribute
  Instance Variable
  PUBLIC
  The observer that this logger will send events to.
- twisted.logger.Logger._namespaceFromCallingContext
  twisted.logger.Logger.html#_namespaceFromCallingContext
  Function
  Static Method
  PRIVATE
  Derive a namespace from the module containing the caller's caller.
- twisted.logger.Logger.__init__
  twisted.logger.Logger.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.logger.Logger.__get__
  twisted.logger.Logger.html#__get__
  Function
  Method
  PUBLIC
  When used as a descriptor, i.e.:
- twisted.logger.Logger.__repr__
  twisted.logger.Logger.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.logger.Logger.emit
  twisted.logger.Logger.html#emit
  Function
  Method
  PUBLIC
  Emit a log event to all log observers at the given level.
- twisted.logger.Logger.failure
  twisted.logger.Logger.html#failure
  Function
  Method
  PUBLIC
  Log a failure and emit a traceback.
- twisted.logger.Logger.debug
  twisted.logger.Logger.html#debug
  Function
  Method
  PUBLIC
  Emit a log event at log level `LogLevel.debug`.
- twisted.logger.Logger.info
  twisted.logger.Logger.html#info
  Function
  Method
  PUBLIC
  Emit a log event at log level `LogLevel.info`.
- twisted.logger.Logger.warn
  twisted.logger.Logger.html#warn
  Function
  Method
  PUBLIC
  Emit a log event at log level `LogLevel.warn`.
- twisted.logger.Logger.error
  twisted.logger.Logger.html#error
  Function
  Method
  PUBLIC
  Emit a log event at log level `LogLevel.error`.
- twisted.logger.Logger.critical
  twisted.logger.Logger.html#critical
  Function
  Method
  PUBLIC
  Emit a log event at log level `LogLevel.critical`.
- twisted.logger._loggerFor
  twisted.logger.html#_loggerFor
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.logger._observer.OBSERVER_DISABLED
  twisted.logger._observer.html#OBSERVER_DISABLED
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.logger._observer.bitbucketLogObserver
  twisted.logger._observer.html#bitbucketLogObserver
  Function
  Function
  PUBLIC
  ILogObserver that does nothing with the events it sees.
- twisted.logger.LogPublisher
  twisted.logger.LogPublisher.html
  Class
  Class
  PUBLIC
  ILogObserver that fans out events to other observers.
- twisted.logger.LogPublisher.__init__
  twisted.logger.LogPublisher.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.logger.LogPublisher._observers
  twisted.logger.LogPublisher.html#_observers
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.logger.LogPublisher.log
  twisted.logger.LogPublisher.html#log
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.logger.LogPublisher.addObserver
  twisted.logger.LogPublisher.html#addObserver
  Function
  Method
  PUBLIC
  Registers an observer with this publisher.
- twisted.logger.LogPublisher.removeObserver
  twisted.logger.LogPublisher.html#removeObserver
  Function
  Method
  PUBLIC
  Unregisters an observer with this publisher.
- twisted.logger.LogPublisher.__call__
  twisted.logger.LogPublisher.html#__call__
  Function
  Method
  PUBLIC
  Forward events to contained observers.
- twisted.logger.LogPublisher._errorLoggerForObserver
  twisted.logger.LogPublisher.html#_errorLoggerForObserver
  Function
  Method
  PRIVATE
  Create an error-logger based on this logger, which does not contain the given bad observer.
- twisted.logger._buffer._DEFAULT_BUFFER_MAXIMUM
  twisted.logger._buffer.html#_DEFAULT_BUFFER_MAXIMUM
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.logger.LimitedHistoryLogObserver
  twisted.logger.LimitedHistoryLogObserver.html
  Class
  Class
  PUBLIC
  `ILogObserver` that stores events in a buffer of a fixed size:
- twisted.logger.LimitedHistoryLogObserver.__init__
  twisted.logger.LimitedHistoryLogObserver.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.logger.LimitedHistoryLogObserver._buffer
  twisted.logger.LimitedHistoryLogObserver.html#_buffer
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.logger.LimitedHistoryLogObserver.__call__
  twisted.logger.LimitedHistoryLogObserver.html#__call__
  Function
  Method
  PUBLIC
  Log an event.
- twisted.logger.LimitedHistoryLogObserver.replayTo
  twisted.logger.LimitedHistoryLogObserver.html#replayTo
  Function
  Method
  PUBLIC
  Re-play the buffered events to another log observer.
- twisted.logger.FileLogObserver
  twisted.logger.FileLogObserver.html
  Class
  Class
  PUBLIC
  Log observer that writes to a file-like object.
- twisted.logger.FileLogObserver.__init__
  twisted.logger.FileLogObserver.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.logger.FileLogObserver._encoding
  twisted.logger.FileLogObserver.html#_encoding
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.logger.FileLogObserver._outFile
  twisted.logger.FileLogObserver.html#_outFile
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.logger.FileLogObserver.formatEvent
  twisted.logger.FileLogObserver.html#formatEvent
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.logger.FileLogObserver.__call__
  twisted.logger.FileLogObserver.html#__call__
  Function
  Method
  PUBLIC
  Write event to file.
- twisted.logger.textFileLogObserver
  twisted.logger.html#textFileLogObserver
  Function
  Function
  PUBLIC
  Create a `FileLogObserver` that emits text to a specified (writable) file-like object.
- twisted.logger._filter.shouldLogEvent
  twisted.logger._filter.html#shouldLogEvent
  Function
  Function
  PUBLIC
  Determine whether an event should be logged, based on the result of `predicates`.
- twisted.logger.PredicateResult
  twisted.logger.PredicateResult.html
  Class
  Class
  PUBLIC
  Predicate results.
- twisted.logger.PredicateResult.yes
  twisted.logger.PredicateResult.html#yes
  Attribute
  Class Variable
  PUBLIC
  Log the specified event. When this value is used, `FilteringLogObserver` will always log the message, without evaluating other predicates.
- twisted.logger.PredicateResult.no
  twisted.logger.PredicateResult.html#no
  Attribute
  Class Variable
  PUBLIC
  Do not log the specified event. When this value is used, `FilteringLogObserver` will not log the message, without evaluating other predicates.
- twisted.logger.PredicateResult.maybe
  twisted.logger.PredicateResult.html#maybe
  Attribute
  Class Variable
  PUBLIC
  Do not have an opinion on the event. When this value is used, `FilteringLogObserver` will consider subsequent predicate results; if returned by the last predicate being considered, then the event will be logged.
- twisted.logger.ILogFilterPredicate
  twisted.logger.ILogFilterPredicate.html
  Class
  Interface
  PUBLIC
  A predicate that determined whether an event should be logged.
- twisted.logger.ILogFilterPredicate.__call__
  twisted.logger.ILogFilterPredicate.html#__call__
  Function
  Method
  PUBLIC
  Determine whether an event should be logged.
- twisted.logger.FilteringLogObserver
  twisted.logger.FilteringLogObserver.html
  Class
  Class
  PUBLIC
  `ILogObserver` that wraps another `ILogObserver`, but filters out events based on applying a series of `ILogFilterPredicate`s.
- twisted.logger.FilteringLogObserver.__init__
  twisted.logger.FilteringLogObserver.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.logger.FilteringLogObserver._observer
  twisted.logger.FilteringLogObserver.html#_observer
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.logger.FilteringLogObserver._shouldLogEvent
  twisted.logger.FilteringLogObserver.html#_shouldLogEvent
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.logger.FilteringLogObserver._negativeObserver
  twisted.logger.FilteringLogObserver.html#_negativeObserver
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.logger.FilteringLogObserver.__call__
  twisted.logger.FilteringLogObserver.html#__call__
  Function
  Method
  PUBLIC
  Forward to next observer if predicate allows it.
- twisted.logger.LogLevelFilterPredicate
  twisted.logger.LogLevelFilterPredicate.html
  Class
  Class
  PUBLIC
  `ILogFilterPredicate` that filters out events with a log level lower than the log level for the event's namespace.
- twisted.logger.LogLevelFilterPredicate.__init__
  twisted.logger.LogLevelFilterPredicate.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.logger.LogLevelFilterPredicate._logLevelsByNamespace
  twisted.logger.LogLevelFilterPredicate.html#_logLevelsByNamespace
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.logger.LogLevelFilterPredicate.defaultLogLevel
  twisted.logger.LogLevelFilterPredicate.html#defaultLogLevel
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.logger.LogLevelFilterPredicate.logLevelForNamespace
  twisted.logger.LogLevelFilterPredicate.html#logLevelForNamespace
  Function
  Method
  PUBLIC
  Determine an appropriate log level for the given namespace.
- twisted.logger.LogLevelFilterPredicate.setLogLevelForNamespace
  twisted.logger.LogLevelFilterPredicate.html#setLogLevelForNamespace
  Function
  Method
  PUBLIC
  Sets the log level for a logging namespace.
- twisted.logger.LogLevelFilterPredicate.clearLogLevels
  twisted.logger.LogLevelFilterPredicate.html#clearLogLevels
  Function
  Method
  PUBLIC
  Clears all log levels to the default.
- twisted.logger.LogLevelFilterPredicate.__call__
  twisted.logger.LogLevelFilterPredicate.html#__call__
  Function
  Method
  PUBLIC
  Determine whether an event should be logged.
- twisted.logger._stdlib.toStdlibLogLevelMapping
  twisted.logger._stdlib.html#toStdlibLogLevelMapping
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.logger._stdlib._reverseLogLevelMapping
  twisted.logger._stdlib.html#_reverseLogLevelMapping
  Function
  Function
  PRIVATE
  Reverse the above mapping, adding both the numerical keys used above and the corresponding string keys also used by python logging.
- twisted.logger._stdlib.fromStdlibLogLevelMapping
  twisted.logger._stdlib.html#fromStdlibLogLevelMapping
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.logger._stdlib.StringifiableFromEvent
  twisted.logger._stdlib.StringifiableFromEvent.html
  Class
  Class
  PUBLIC
  An object that implements `__str__()` in order to defer the work of formatting until it's converted into a `str`.
- twisted.logger._stdlib.StringifiableFromEvent.__init__
  twisted.logger._stdlib.StringifiableFromEvent.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.logger._stdlib.StringifiableFromEvent.event
  twisted.logger._stdlib.StringifiableFromEvent.html#event
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.logger._stdlib.StringifiableFromEvent.__str__
  twisted.logger._stdlib.StringifiableFromEvent.html#__str__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.logger._stdlib.StringifiableFromEvent.__bytes__
  twisted.logger._stdlib.StringifiableFromEvent.html#__bytes__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.logger.STDLibLogObserver
  twisted.logger.STDLibLogObserver.html
  Class
  Class
  PUBLIC
  Log observer that writes to the python standard library's `logging` module.
- twisted.logger.STDLibLogObserver.defaultStackDepth
  twisted.logger.STDLibLogObserver.html#defaultStackDepth
  Attribute
  Class Variable
  PUBLIC
  This is the default number of frames that it takes to get from `STDLibLogObserver` through the logging module, plus one; in other words, the number of frames if you were to call a `STDLibLogObserver` directly...
- twisted.logger.STDLibLogObserver.__init__
  twisted.logger.STDLibLogObserver.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.logger.STDLibLogObserver.logger
  twisted.logger.STDLibLogObserver.html#logger
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.logger.STDLibLogObserver.stackDepth
  twisted.logger.STDLibLogObserver.html#stackDepth
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.logger.STDLibLogObserver._findCaller
  twisted.logger.STDLibLogObserver.html#_findCaller
  Function
  Method
  PRIVATE
  Based on the stack depth passed to this `STDLibLogObserver`, identify the calling function.
- twisted.logger.STDLibLogObserver.__call__
  twisted.logger.STDLibLogObserver.html#__call__
  Function
  Method
  PUBLIC
  Format an event and bridge it to Python logging.
- twisted.logger.LoggingFile.softspace 0
  twisted.logger.LoggingFile.html#softspace%200
  Attribute
  Instance Variable
  PUBLIC
  Attribute to make this class more file-like under Python 2; value is zero or one. Do not use.
- twisted.logger.LoggingFile
  twisted.logger.LoggingFile.html
  Class
  Class
  PUBLIC
  File-like object that turns `write()` calls into logging events.
- twisted.logger.LoggingFile.softspace
  twisted.logger.LoggingFile.html#softspace
  Attribute
  Property
  PUBLIC
  Undocumented
- twisted.logger.LoggingFile._softspace
  twisted.logger.LoggingFile.html#_softspace
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.logger.LoggingFile.softspace.setter
  twisted.logger.LoggingFile.html#softspace.setter
  Function
  Method
  PUBLIC
  Undocumented
- twisted.logger.LoggingFile.__init__
  twisted.logger.LoggingFile.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.logger.LoggingFile.level
  twisted.logger.LoggingFile.html#level
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.logger.LoggingFile.log
  twisted.logger.LoggingFile.html#log
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.logger.LoggingFile._encoding
  twisted.logger.LoggingFile.html#_encoding
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.logger.LoggingFile._buffer
  twisted.logger.LoggingFile.html#_buffer
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.logger.LoggingFile._closed
  twisted.logger.LoggingFile.html#_closed
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.logger.LoggingFile.closed
  twisted.logger.LoggingFile.html#closed
  Attribute
  Property
  PUBLIC
  Read-only property. Is the file closed?
- twisted.logger.LoggingFile.encoding
  twisted.logger.LoggingFile.html#encoding
  Attribute
  Property
  PUBLIC
  Read-only property. File encoding.
- twisted.logger.LoggingFile.mode
  twisted.logger.LoggingFile.html#mode
  Attribute
  Property
  PUBLIC
  Read-only property. File mode.
- twisted.logger.LoggingFile.newlines
  twisted.logger.LoggingFile.html#newlines
  Attribute
  Property
  PUBLIC
  Read-only property. Types of newlines encountered.
- twisted.logger.LoggingFile.name
  twisted.logger.LoggingFile.html#name
  Attribute
  Property
  PUBLIC
  The name of this file; a repr-style string giving information about its namespace.
- twisted.logger.LoggingFile.close
  twisted.logger.LoggingFile.html#close
  Function
  Method
  PUBLIC
  Close this file so it can no longer be written to.
- twisted.logger.LoggingFile.flush
  twisted.logger.LoggingFile.html#flush
  Function
  Method
  PUBLIC
  No-op; this file does not buffer.
- twisted.logger.LoggingFile.fileno
  twisted.logger.LoggingFile.html#fileno
  Function
  Method
  PUBLIC
  Returns an invalid file descriptor, since this is not backed by an FD.
- twisted.logger.LoggingFile.isatty
  twisted.logger.LoggingFile.html#isatty
  Function
  Method
  PUBLIC
  A `LoggingFile` is not a TTY.
- twisted.logger.LoggingFile.write
  twisted.logger.LoggingFile.html#write
  Function
  Method
  PUBLIC
  Log the given message.
- twisted.logger.LoggingFile.writelines
  twisted.logger.LoggingFile.html#writelines
  Function
  Method
  PUBLIC
  Log each of the given lines as a separate message.
- twisted.logger.LoggingFile._unsupported
  twisted.logger.LoggingFile.html#_unsupported
  Function
  Method
  PRIVATE
  Template for unsupported operations.
- twisted.logger._legacy.publishToNewObserver
  twisted.logger._legacy.html#publishToNewObserver
  Function
  Function
  PUBLIC
  Publish an old-style (`twisted.python.log`) event to a new-style (`twisted.logger`) observer.
- twisted.logger.LegacyLogObserverWrapper
  twisted.logger.LegacyLogObserverWrapper.html
  Class
  Class
  PUBLIC
  `ILogObserver` that wraps a `twisted.python.log.ILogObserver`.
- twisted.logger.LegacyLogObserverWrapper.__init__
  twisted.logger.LegacyLogObserverWrapper.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.logger.LegacyLogObserverWrapper.legacyObserver
  twisted.logger.LegacyLogObserverWrapper.html#legacyObserver
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.logger.LegacyLogObserverWrapper.__repr__
  twisted.logger.LegacyLogObserverWrapper.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.logger.LegacyLogObserverWrapper.__call__
  twisted.logger.LegacyLogObserverWrapper.html#__call__
  Function
  Method
  PUBLIC
  Forward events to the legacy observer after editing them to ensure compatibility.
- twisted.logger._global.MORE_THAN_ONCE_WARNING
  twisted.logger._global.html#MORE_THAN_ONCE_WARNING
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.logger.LogBeginner
  twisted.logger.LogBeginner.html
  Class
  Class
  PUBLIC
  A `LogBeginner` holds state related to logging before logging has begun, and begins logging when told to do so. Logging "begins" when someone has selected a set of observers, like, for example, a `FileLogObserver`...
- twisted.logger.LogBeginner._DEFAULT_BUFFER_SIZE
  twisted.logger.LogBeginner.html#_DEFAULT_BUFFER_SIZE
  Attribute
  Constant
  PRIVATE
  The default size for the initial log events buffer.
- twisted.logger.LogBeginner._initialBuffer
  twisted.logger.LogBeginner.html#_initialBuffer
  Attribute
  Instance Variable
  PRIVATE
  A buffer of messages logged before logging began.
- twisted.logger.LogBeginner._publisher
  twisted.logger.LogBeginner.html#_publisher
  Attribute
  Instance Variable
  PRIVATE
  The log publisher passed in to `LogBeginner`'s constructor.
- twisted.logger.LogBeginner._log
  twisted.logger.LogBeginner.html#_log
  Attribute
  Instance Variable
  PRIVATE
  The logger used to log messages about the operation of the `LogBeginner` itself.
- twisted.logger.LogBeginner._stdio
  twisted.logger.LogBeginner.html#_stdio
  Attribute
  Instance Variable
  PRIVATE
  An object with `stderr` and `stdout` attributes (like the `sys` module) which will be replaced when redirecting standard I/O.
- twisted.logger.LogBeginner._temporaryObserver
  twisted.logger.LogBeginner.html#_temporaryObserver
  Attribute
  Instance Variable
  PRIVATE
  If not `None`, an `ILogObserver` that observes events on `_publisher` for this `LogBeginner`.
- twisted.logger.LogBeginner.__init__
  twisted.logger.LogBeginner.html#__init__
  Function
  Method
  PUBLIC
  Initialize this `LogBeginner`.
- twisted.logger.LogBeginner._warningsModule
  twisted.logger.LogBeginner.html#_warningsModule
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.logger.LogBeginner._previousBegin
  twisted.logger.LogBeginner.html#_previousBegin
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.logger.LogBeginner._oldshowwarning
  twisted.logger.LogBeginner.html#_oldshowwarning
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.logger.LogBeginner.beginLoggingTo
  twisted.logger.LogBeginner.html#beginLoggingTo
  Function
  Method
  PUBLIC
  Begin logging to the given set of observers. This will:
- twisted.logger.LogBeginner.showwarning
  twisted.logger.LogBeginner.html#showwarning
  Function
  Method
  PUBLIC
  Twisted-enabled wrapper around `warnings.showwarning`.
- twisted.logger._json.log
  twisted.logger._json.html#log
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.logger._json.JSONDict
  twisted.logger._json.html#JSONDict
  Attribute
  Type Alias
  PUBLIC
  Undocumented
- twisted.logger._json.failureAsJSON
  twisted.logger._json.html#failureAsJSON
  Function
  Function
  PUBLIC
  Convert a failure to a JSON-serializable data structure.
- twisted.logger._json.failureFromJSON
  twisted.logger._json.html#failureFromJSON
  Function
  Function
  PUBLIC
  Load a `Failure` from a dictionary deserialized from JSON.
- twisted.logger._json.classInfo
  twisted.logger._json.html#classInfo
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.logger._json.uuidToLoader
  twisted.logger._json.html#uuidToLoader
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.logger._json.objectLoadHook
  twisted.logger._json.html#objectLoadHook
  Function
  Function
  PUBLIC
  Dictionary-to-object-translation hook for certain value types used within the logging system.
- twisted.logger._json.objectSaveHook
  twisted.logger._json.html#objectSaveHook
  Function
  Function
  PUBLIC
  Object-to-serializable hook for certain value types used within the logging system.
- twisted.logger.eventAsJSON
  twisted.logger.html#eventAsJSON
  Function
  Function
  PUBLIC
  Encode an event as JSON, flattening it if necessary to preserve as much structure as possible.
- twisted.logger.eventFromJSON
  twisted.logger.html#eventFromJSON
  Function
  Function
  PUBLIC
  Decode a log event from JSON.
- twisted.logger.jsonFileLogObserver
  twisted.logger.html#jsonFileLogObserver
  Function
  Function
  PUBLIC
  Create a `FileLogObserver` that emits JSON-serialized events to a specified (writable) file-like object.
- twisted.logger.eventsFromJSONLogFile
  twisted.logger.html#eventsFromJSONLogFile
  Function
  Function
  PUBLIC
  Load events from a file previously saved with `jsonFileLogObserver`. Event records that are truncated or otherwise unreadable are ignored.
- twisted.logger.capturedLogs
  twisted.logger.html#capturedLogs
  Function
  Function
  PUBLIC
  Undocumented
- twisted.python.context.defaultContextDict
  twisted.python.context.html#defaultContextDict
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.python.context.ContextTracker
  twisted.python.context.ContextTracker.html
  Class
  Class
  PUBLIC
  A `ContextTracker` provides a way to pass arbitrary key/value data up and down a call stack without passing them as parameters to the functions on that call stack.
- twisted.python.context.ContextTracker.contexts
  twisted.python.context.ContextTracker.html#contexts
  Attribute
  Instance Variable
  PUBLIC
  A `list` of `dict`s tracking the context state. Each new `ContextTracker.callWithContext` pushes a new `dict` onto this stack for the duration of the call, making the data available to the function called and restoring the previous data once it is complete...
- twisted.python.context.ContextTracker.__init__
  twisted.python.context.ContextTracker.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.context.ContextTracker.callWithContext
  twisted.python.context.ContextTracker.html#callWithContext
  Function
  Method
  PUBLIC
  Call `func(*args, **kw)` such that the contents of `newContext` will be available for it to retrieve using `getContext`.
- twisted.python.context.ContextTracker.getContext
  twisted.python.context.ContextTracker.html#getContext
  Function
  Method
  PUBLIC
  Retrieve the value for a key from the context.
- twisted.python.context.ThreadedContextTracker
  twisted.python.context.ThreadedContextTracker.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.python.context.ThreadedContextTracker.__init__
  twisted.python.context.ThreadedContextTracker.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.context.ThreadedContextTracker.storage
  twisted.python.context.ThreadedContextTracker.html#storage
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.context.ThreadedContextTracker.currentContext
  twisted.python.context.ThreadedContextTracker.html#currentContext
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.context.ThreadedContextTracker.callWithContext
  twisted.python.context.ThreadedContextTracker.html#callWithContext
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.context.ThreadedContextTracker.getContext
  twisted.python.context.ThreadedContextTracker.html#getContext
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.context.theContextTracker
  twisted.python.context.html#theContextTracker
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.python.context.installContextTracker
  twisted.python.context.html#installContextTracker
  Function
  Function
  PUBLIC
  Undocumented
- twisted.python.util.InsensitiveDict
  twisted.python.util.InsensitiveDict.html
  Class
  Class
  PUBLIC
  Dictionary, that has case-insensitive keys.
- twisted.python.util.InsensitiveDict.__init__
  twisted.python.util.InsensitiveDict.html#__init__
  Function
  Method
  PUBLIC
  Create an empty dictionary, or update from 'dict'.
- twisted.python.util.InsensitiveDict.data
  twisted.python.util.InsensitiveDict.html#data
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.util.InsensitiveDict.preserve
  twisted.python.util.InsensitiveDict.html#preserve
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.util.InsensitiveDict.__delitem__
  twisted.python.util.InsensitiveDict.html#__delitem__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.util.InsensitiveDict._lowerOrReturn
  twisted.python.util.InsensitiveDict.html#_lowerOrReturn
  Function
  Method
  PRIVATE
  Undocumented
- twisted.python.util.InsensitiveDict.__getitem__
  twisted.python.util.InsensitiveDict.html#__getitem__
  Function
  Method
  PUBLIC
  Retrieve the value associated with 'key' (in any case).
- twisted.python.util.InsensitiveDict.__setitem__
  twisted.python.util.InsensitiveDict.html#__setitem__
  Function
  Method
  PUBLIC
  Associate 'value' with 'key'. If 'key' already exists, but in different case, it will be replaced.
- twisted.python.util.InsensitiveDict.has_key
  twisted.python.util.InsensitiveDict.html#has_key
  Function
  Method
  PUBLIC
  Case insensitive test whether 'key' exists.
- twisted.python.util.InsensitiveDict._doPreserve
  twisted.python.util.InsensitiveDict.html#_doPreserve
  Function
  Method
  PRIVATE
  Undocumented
- twisted.python.util.InsensitiveDict.keys
  twisted.python.util.InsensitiveDict.html#keys
  Function
  Method
  PUBLIC
  List of keys in their original case.
- twisted.python.util.InsensitiveDict.values
  twisted.python.util.InsensitiveDict.html#values
  Function
  Method
  PUBLIC
  List of values.
- twisted.python.util.InsensitiveDict.items
  twisted.python.util.InsensitiveDict.html#items
  Function
  Method
  PUBLIC
  List of (key,value) pairs.
- twisted.python.util.InsensitiveDict.get
  twisted.python.util.InsensitiveDict.html#get
  Function
  Method
  PUBLIC
  Retrieve value associated with 'key' or return default value if 'key' doesn't exist.
- twisted.python.util.InsensitiveDict.setdefault
  twisted.python.util.InsensitiveDict.html#setdefault
  Function
  Method
  PUBLIC
  If 'key' doesn't exist, associate it with the 'default' value. Return value associated with 'key'.
- twisted.python.util.InsensitiveDict.update
  twisted.python.util.InsensitiveDict.html#update
  Function
  Method
  PUBLIC
  Copy (key,value) pairs from 'dict'.
- twisted.python.util.InsensitiveDict.__repr__
  twisted.python.util.InsensitiveDict.html#__repr__
  Function
  Method
  PUBLIC
  String representation of the dictionary.
- twisted.python.util.InsensitiveDict.iterkeys
  twisted.python.util.InsensitiveDict.html#iterkeys
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.util.InsensitiveDict.itervalues
  twisted.python.util.InsensitiveDict.html#itervalues
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.util.InsensitiveDict.iteritems
  twisted.python.util.InsensitiveDict.html#iteritems
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.util.InsensitiveDict._notFound
  twisted.python.util.InsensitiveDict.html#_notFound
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.python.util.InsensitiveDict.pop
  twisted.python.util.InsensitiveDict.html#pop
  Function
  Method
  PUBLIC
  No summary
- twisted.python.util.InsensitiveDict.popitem
  twisted.python.util.InsensitiveDict.html#popitem
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.util.InsensitiveDict.clear
  twisted.python.util.InsensitiveDict.html#clear
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.util.InsensitiveDict.copy
  twisted.python.util.InsensitiveDict.html#copy
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.util.InsensitiveDict.__len__
  twisted.python.util.InsensitiveDict.html#__len__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.util.InsensitiveDict.__eq__
  twisted.python.util.InsensitiveDict.html#__eq__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.util.uniquify
  twisted.python.util.html#uniquify
  Function
  Function
  PUBLIC
  Make the elements of a list unique by inserting them into a dictionary. This must not change the order of the input lst.
- twisted.python.util.padTo
  twisted.python.util.html#padTo
  Function
  Function
  PUBLIC
  Pads a sequence out to n elements,
- twisted.python.util.getPluginDirs
  twisted.python.util.html#getPluginDirs
  Function
  Function
  PUBLIC
  Undocumented
- twisted.python.util.addPluginDir
  twisted.python.util.html#addPluginDir
  Function
  Function
  PUBLIC
  Undocumented
- twisted.python.util.sibpath
  twisted.python.util.html#sibpath
  Function
  Function
  PUBLIC
  Return the path to a sibling of a file in the filesystem.
- twisted.python.util._getpass
  twisted.python.util.html#_getpass
  Function
  Function
  PRIVATE
  Helper to turn IOErrors into KeyboardInterrupts.
- twisted.python.util.getPassword
  twisted.python.util.html#getPassword
  Function
  Function
  PUBLIC
  Obtain a password by prompting or from stdin.
- twisted.python.util.println
  twisted.python.util.html#println
  Function
  Function
  PUBLIC
  Undocumented
- twisted.python.util.str_xor
  twisted.python.util.html#str_xor
  Function
  Function
  PUBLIC
  Undocumented
- twisted.python.util.makeStatBar
  twisted.python.util.html#makeStatBar
  Function
  Function
  PUBLIC
  Creates a function that will return a string representing a progress bar.
- twisted.python.util.spewer
  twisted.python.util.html#spewer
  Function
  Function
  PUBLIC
  A trace function for sys.settrace that prints every function or method call.
- twisted.python.util.searchupwards
  twisted.python.util.html#searchupwards
  Function
  Function
  PUBLIC
  Walk upwards from start, looking for a directory containing all files and directories given as arguments:
- twisted.python.util.LineLog
  twisted.python.util.LineLog.html
  Class
  Class
  PUBLIC
  A limited-size line-based log, useful for logging line-based protocols such as SMTP.
- twisted.python.util.LineLog.__init__
  twisted.python.util.LineLog.html#__init__
  Function
  Method
  PUBLIC
  Create a new log, with size lines of storage (default 10). A log size of 0 (or less) means an infinite log.
- twisted.python.util.LineLog.log
  twisted.python.util.LineLog.html#log
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.util.LineLog.size
  twisted.python.util.LineLog.html#size
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.util.LineLog.append
  twisted.python.util.LineLog.html#append
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.util.LineLog.str
  twisted.python.util.LineLog.html#str
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.util.LineLog.__bytes__
  twisted.python.util.LineLog.html#__bytes__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.util.LineLog.__getitem__
  twisted.python.util.LineLog.html#__getitem__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.util.LineLog.clear
  twisted.python.util.LineLog.html#clear
  Function
  Method
  PUBLIC
  Empty the log.
- twisted.python.util.raises
  twisted.python.util.html#raises
  Function
  Function
  PUBLIC
  Determine whether the given call raises the given exception.
- twisted.python.util.IntervalDifferential
  twisted.python.util.IntervalDifferential.html
  Class
  Class
  PUBLIC
  Given a list of intervals, generate the amount of time to sleep between "instants".
- twisted.python.util.IntervalDifferential.__init__
  twisted.python.util.IntervalDifferential.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.python.util.IntervalDifferential.intervals
  twisted.python.util.IntervalDifferential.html#intervals
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.util.IntervalDifferential.default
  twisted.python.util.IntervalDifferential.html#default
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.util.IntervalDifferential.__iter__
  twisted.python.util.IntervalDifferential.html#__iter__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.util._IntervalDifferentialIterator
  twisted.python.util._IntervalDifferentialIterator.html
  Class
  Class
  PRIVATE
  Undocumented
- twisted.python.util._IntervalDifferentialIterator.__init__
  twisted.python.util._IntervalDifferentialIterator.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.util._IntervalDifferentialIterator.intervals
  twisted.python.util._IntervalDifferentialIterator.html#intervals
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.util._IntervalDifferentialIterator.default
  twisted.python.util._IntervalDifferentialIterator.html#default
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.util._IntervalDifferentialIterator.last
  twisted.python.util._IntervalDifferentialIterator.html#last
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.util._IntervalDifferentialIterator.__next__
  twisted.python.util._IntervalDifferentialIterator.html#__next__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.util._IntervalDifferentialIterator.addInterval
  twisted.python.util._IntervalDifferentialIterator.html#addInterval
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.util._IntervalDifferentialIterator.removeInterval
  twisted.python.util._IntervalDifferentialIterator.html#removeInterval
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.util.FancyStrMixin
  twisted.python.util.FancyStrMixin.html
  Class
  Class
  PUBLIC
  Mixin providing a flexible implementation of `__str__`.
- twisted.python.util.FancyStrMixin.showAttributes
  twisted.python.util.FancyStrMixin.html#showAttributes
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.python.util.FancyStrMixin.__str__
  twisted.python.util.FancyStrMixin.html#__str__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.util.FancyEqMixin
  twisted.python.util.FancyEqMixin.html
  Class
  Class
  PUBLIC
  Mixin that implements `__eq__` and `__ne__`.
- twisted.python.util.FancyEqMixin.compareAttributes
  twisted.python.util.FancyEqMixin.html#compareAttributes
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.python.util.FancyEqMixin.__eq__
  twisted.python.util.FancyEqMixin.html#__eq__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.util.FancyEqMixin.__ne__
  twisted.python.util.FancyEqMixin.html#__ne__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.util.initgroups
  twisted.python.util.html#initgroups
  Function
  Function
  PUBLIC
  Do nothing.
- twisted.python.util.switchUID
  twisted.python.util.html#switchUID
  Function
  Function
  PUBLIC
  Attempts to switch the uid/euid and gid/egid for the current process.
- twisted.python.util.untilConcludes
  twisted.python.util.html#untilConcludes
  Function
  Function
  PUBLIC
  Call `f` with the given arguments, handling `EINTR` by retrying.
- twisted.python.util.mergeFunctionMetadata
  twisted.python.util.html#mergeFunctionMetadata
  Function
  Function
  PUBLIC
  Overwrite `g`'s name and docstring with values from `f`. Update `g`'s instance dictionary with `f`'s.
- twisted.python.util.nameToLabel
  twisted.python.util.html#nameToLabel
  Function
  Function
  PUBLIC
  Convert a string like a variable name into a slightly more human-friendly string with spaces and capitalized letters.
- twisted.python.util.uidFromString
  twisted.python.util.html#uidFromString
  Function
  Function
  PUBLIC
  Convert a user identifier, as a string, into an integer UID.
- twisted.python.util.gidFromString
  twisted.python.util.html#gidFromString
  Function
  Function
  PUBLIC
  Convert a group identifier, as a string, into an integer GID.
- twisted.python.util.runAsEffectiveUser
  twisted.python.util.html#runAsEffectiveUser
  Function
  Function
  PUBLIC
  Run the given function wrapped with seteuid/setegid calls.
- twisted.python.util.runWithWarningsSuppressed
  twisted.python.util.html#runWithWarningsSuppressed
  Function
  Function
  PUBLIC
  Run `f(*args, **kwargs)`, but with some warnings suppressed.
- twisted.python.threadable.DummyLock
  twisted.python.threadable.DummyLock.html
  Class
  Class
  PUBLIC
  Hack to allow locks to be unpickled on an unthreaded system.
- twisted.python.threadable.DummyLock.__reduce__
  twisted.python.threadable.DummyLock.html#__reduce__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.threadable.unpickle_lock
  twisted.python.threadable.html#unpickle_lock
  Function
  Function
  PUBLIC
  Undocumented
- twisted.python.threadable._synchPre
  twisted.python.threadable.html#_synchPre
  Function
  Function
  PRIVATE
  Undocumented
- twisted.python.threadable._synchPost
  twisted.python.threadable.html#_synchPost
  Function
  Function
  PRIVATE
  Undocumented
- twisted.python.threadable._sync
  twisted.python.threadable.html#_sync
  Function
  Function
  PRIVATE
  Undocumented
- twisted.python.threadable.synchronize
  twisted.python.threadable.html#synchronize
  Function
  Function
  PUBLIC
  Make all methods listed in each class' synchronized attribute synchronized.
- twisted.python.threadable.init
  twisted.python.threadable.html#init
  Function
  Function
  PUBLIC
  Initialize threading.
- twisted.python.threadable._dummyID
  twisted.python.threadable.html#_dummyID
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.python.threadable.getThreadID
  twisted.python.threadable.html#getThreadID
  Function
  Function
  PUBLIC
  Undocumented
- twisted.python.threadable.isInIOThread
  twisted.python.threadable.html#isInIOThread
  Function
  Function
  PUBLIC
  Are we in the thread responsible for I/O requests (the event loop)?
- twisted.python.threadable.registerAsIOThread
  twisted.python.threadable.html#registerAsIOThread
  Function
  Function
  PUBLIC
  Mark the current thread as responsible for I/O requests.
- twisted.python.threadable.ioThread
  twisted.python.threadable.html#ioThread
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.python.threadable.threaded
  twisted.python.threadable.html#threaded
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.python.threadable._synchLockCreator
  twisted.python.threadable.html#_synchLockCreator
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.python.threadable.XLock
  twisted.python.threadable.html#XLock
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.python.log.EventDict
  twisted.python.log.html#EventDict
  Attribute
  Type Alias
  PUBLIC
  Undocumented
- twisted.python.log.ILogContext
  twisted.python.log.ILogContext.html
  Class
  Class
  PUBLIC
  Actually, this interface is just a synonym for the dictionary interface, but it serves as a key for the default information in a log.
- twisted.python.log.ILogObserver
  twisted.python.log.ILogObserver.html
  Class
  Interface
  PUBLIC
  An observer which can do something with log events.
- twisted.python.log.ILogObserver.__call__
  twisted.python.log.ILogObserver.html#__call__
  Function
  Method
  PUBLIC
  Log an event.
- twisted.python.log.callWithContext
  twisted.python.log.html#callWithContext
  Function
  Function
  PUBLIC
  Undocumented
- twisted.python.log.callWithLogger
  twisted.python.log.html#callWithLogger
  Function
  Function
  PUBLIC
  Utility method which wraps a function in a try:/except:, logs a failure if one occurs, and uses the system's logPrefix.
- twisted.python.log.err
  twisted.python.log.html#err
  Function
  Function
  PUBLIC
  Write a failure to the log.
- twisted.python.log.Logger
  twisted.python.log.Logger.html
  Class
  Class
  PUBLIC
  This represents a class which may 'own' a log. Used by subclassing.
- twisted.python.log.Logger.logPrefix
  twisted.python.log.Logger.html#logPrefix
  Function
  Method
  PUBLIC
  Override this method to insert custom logging behavior. Its return value will be inserted in front of every line. It may be called more times than the number of output lines.
- twisted.python.log.LogPublisher
  twisted.python.log.LogPublisher.html
  Class
  Class
  PUBLIC
  Class for singleton log message publishing.
- twisted.python.log.LogPublisher.synchronized
  twisted.python.log.LogPublisher.html#synchronized
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.python.log.LogPublisher.__init__
  twisted.python.log.LogPublisher.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.log.LogPublisher._observerPublisher
  twisted.python.log.LogPublisher.html#_observerPublisher
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.python.log.LogPublisher._publishPublisher
  twisted.python.log.LogPublisher.html#_publishPublisher
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.python.log.LogPublisher._legacyObservers
  twisted.python.log.LogPublisher.html#_legacyObservers
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.python.log.LogPublisher._logBeginner
  twisted.python.log.LogPublisher.html#_logBeginner
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.python.log.LogPublisher._warningsModule
  twisted.python.log.LogPublisher.html#_warningsModule
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.python.log.LogPublisher._oldshowwarning
  twisted.python.log.LogPublisher.html#_oldshowwarning
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.python.log.LogPublisher.showwarning
  twisted.python.log.LogPublisher.html#showwarning
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.log.LogPublisher.observers
  twisted.python.log.LogPublisher.html#observers
  Attribute
  Property
  PUBLIC
  Property returning all observers registered on this `LogPublisher`.
- twisted.python.log.LogPublisher._startLogging
  twisted.python.log.LogPublisher.html#_startLogging
  Function
  Method
  PRIVATE
  Begin logging to the `LogBeginner` associated with this `LogPublisher`.
- twisted.python.log.LogPublisher._stopLogging
  twisted.python.log.LogPublisher.html#_stopLogging
  Function
  Method
  PRIVATE
  Clean-up hook for fixing potentially global state. Only for testing of this module itself. If you want less global state, use the new warnings system in `twisted.logger`.
- twisted.python.log.LogPublisher.addObserver
  twisted.python.log.LogPublisher.html#addObserver
  Function
  Method
  PUBLIC
  Add a new observer.
- twisted.python.log.LogPublisher.removeObserver
  twisted.python.log.LogPublisher.html#removeObserver
  Function
  Method
  PUBLIC
  Remove an observer.
- twisted.python.log.LogPublisher.msg
  twisted.python.log.LogPublisher.html#msg
  Function
  Method
  PUBLIC
  Log a new message.
- twisted.python.log._actually
  twisted.python.log.html#_actually
  Function
  Function
  PRIVATE
  A decorator that returns its argument rather than the thing it is decorating.
- twisted.python.log.theLogPublisher
  twisted.python.log.html#theLogPublisher
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.python.log.addObserver
  twisted.python.log.html#addObserver
  Function
  Function
  PUBLIC
  Add a log observer to the global publisher.
- twisted.python.log.removeObserver
  twisted.python.log.html#removeObserver
  Function
  Function
  PUBLIC
  Remove a log observer from the global publisher.
- twisted.python.log.msg
  twisted.python.log.html#msg
  Function
  Function
  PUBLIC
  Publish a message to the global log publisher.
- twisted.python.log.showwarning
  twisted.python.log.html#showwarning
  Function
  Function
  PUBLIC
  Publish a Python warning through the global log publisher.
- twisted.python.log._safeFormat
  twisted.python.log.html#_safeFormat
  Function
  Function
  PRIVATE
  Try to format a string, swallowing all errors to always return a string.
- twisted.python.log.textFromEventDict
  twisted.python.log.html#textFromEventDict
  Function
  Function
  PUBLIC
  Extract text from an event dict passed to a log observer. If it cannot handle the dict, it returns None.
- twisted.python.log._GlobalStartStopObserver
  twisted.python.log._GlobalStartStopObserver.html
  Class
  Class
  PRIVATE
  Mix-in for global log observers that can start and stop.
- twisted.python.log._GlobalStartStopObserver.emit
  twisted.python.log._GlobalStartStopObserver.html#emit
  Function
  Method
  PUBLIC
  Emit the given log event.
- twisted.python.log._GlobalStartStopObserver.start
  twisted.python.log._GlobalStartStopObserver.html#start
  Function
  Method
  PUBLIC
  Start observing log events.
- twisted.python.log._GlobalStartStopObserver.stop
  twisted.python.log._GlobalStartStopObserver.html#stop
  Function
  Method
  PUBLIC
  Stop observing log events.
- twisted.python.log.FileLogObserver
  twisted.python.log.FileLogObserver.html
  Class
  Class
  PUBLIC
  Log observer that writes to a file-like object.
- twisted.python.log.FileLogObserver.timeFormat
  twisted.python.log.FileLogObserver.html#timeFormat
  Attribute
  Instance Variable
  PUBLIC
  If not `None`, the format string passed to strftime().
- twisted.python.log.FileLogObserver.__init__
  twisted.python.log.FileLogObserver.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.log.FileLogObserver.write
  twisted.python.log.FileLogObserver.html#write
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.log.FileLogObserver.flush
  twisted.python.log.FileLogObserver.html#flush
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.log.FileLogObserver.getTimezoneOffset
  twisted.python.log.FileLogObserver.html#getTimezoneOffset
  Function
  Method
  PUBLIC
  Return the current local timezone offset from UTC.
- twisted.python.log.FileLogObserver.formatTime
  twisted.python.log.FileLogObserver.html#formatTime
  Function
  Method
  PUBLIC
  Format the given UTC value as a string representing that time in the local timezone.
- twisted.python.log.FileLogObserver.emit
  twisted.python.log.FileLogObserver.html#emit
  Function
  Method
  PUBLIC
  Format the given log event as text and write it to the output file.
- twisted.python.log.PythonLoggingObserver
  twisted.python.log.PythonLoggingObserver.html
  Class
  Class
  PUBLIC
  Output twisted messages to Python standard library `logging` module.
- twisted.python.log.PythonLoggingObserver.__init__
  twisted.python.log.PythonLoggingObserver.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.python.log.PythonLoggingObserver._newObserver
  twisted.python.log.PythonLoggingObserver.html#_newObserver
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.python.log.PythonLoggingObserver.emit
  twisted.python.log.PythonLoggingObserver.html#emit
  Function
  Method
  PUBLIC
  Receive a twisted log entry, format it and bridge it to python.
- twisted.python.log.StdioOnnaStick
  twisted.python.log.StdioOnnaStick.html
  Class
  Class
  PUBLIC
  Class that pretends to be stdout/err, and turns writes into log messages.
- twisted.python.log.StdioOnnaStick.isError
  twisted.python.log.StdioOnnaStick.html#isError
  Attribute
  Instance Variable
  PUBLIC
  boolean indicating whether this is stderr, in which cases log messages will be logged as errors.
- twisted.python.log.StdioOnnaStick.encoding
  twisted.python.log.StdioOnnaStick.html#encoding
  Attribute
  Instance Variable
  PUBLIC
  unicode encoding used to encode any unicode strings written to this object.
- twisted.python.log.StdioOnnaStick.closed
  twisted.python.log.StdioOnnaStick.html#closed
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.python.log.StdioOnnaStick.softspace
  twisted.python.log.StdioOnnaStick.html#softspace
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.python.log.StdioOnnaStick.mode
  twisted.python.log.StdioOnnaStick.html#mode
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.python.log.StdioOnnaStick.name
  twisted.python.log.StdioOnnaStick.html#name
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.python.log.StdioOnnaStick.__init__
  twisted.python.log.StdioOnnaStick.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.log.StdioOnnaStick.buf
  twisted.python.log.StdioOnnaStick.html#buf
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.log.StdioOnnaStick.close
  twisted.python.log.StdioOnnaStick.html#close
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.log.StdioOnnaStick.fileno
  twisted.python.log.StdioOnnaStick.html#fileno
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.log.StdioOnnaStick.flush
  twisted.python.log.StdioOnnaStick.html#flush
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.log.StdioOnnaStick.read
  twisted.python.log.StdioOnnaStick.html#read
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.log.StdioOnnaStick.write
  twisted.python.log.StdioOnnaStick.html#write
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.log.StdioOnnaStick.writelines
  twisted.python.log.StdioOnnaStick.html#writelines
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.log.startLogging
  twisted.python.log.html#startLogging
  Function
  Function
  PUBLIC
  Initialize logging to a specified file.
- twisted.python.log.startLoggingWithObserver
  twisted.python.log.html#startLoggingWithObserver
  Function
  Function
  PUBLIC
  Initialize logging to a specified observer. If setStdout is true (defaults to yes), also redirect sys.stdout and sys.stderr to the specified file.
- twisted.python.log.NullFile
  twisted.python.log.NullFile.html
  Class
  Class
  PUBLIC
  A file-like object that discards everything.
- twisted.python.log.NullFile.softspace
  twisted.python.log.NullFile.html#softspace
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.python.log.NullFile.read
  twisted.python.log.NullFile.html#read
  Function
  Method
  PUBLIC
  Do nothing.
- twisted.python.log.NullFile.write
  twisted.python.log.NullFile.html#write
  Function
  Method
  PUBLIC
  Do nothing.
- twisted.python.log.NullFile.flush
  twisted.python.log.NullFile.html#flush
  Function
  Method
  PUBLIC
  Do nothing.
- twisted.python.log.NullFile.close
  twisted.python.log.NullFile.html#close
  Function
  Method
  PUBLIC
  Do nothing.
- twisted.python.log.discardLogs
  twisted.python.log.html#discardLogs
  Function
  Function
  PUBLIC
  Discard messages logged via the global `logfile` object.
- twisted.python.log.logfile
  twisted.python.log.html#logfile
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.python.log.logerr
  twisted.python.log.html#logerr
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.python.log.DefaultObserver
  twisted.python.log.DefaultObserver.html
  Class
  Class
  PUBLIC
  Default observer.
- twisted.python.log.DefaultObserver.emit
  twisted.python.log.DefaultObserver.html#emit
  Function
  Method
  PUBLIC
  Emit an event dict.
- twisted.python.log.defaultObserver
  twisted.python.log.html#defaultObserver
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted._threads._team.Statistics
  twisted._threads._team.Statistics.html
  Class
  Class
  PUBLIC
  Statistics about a `Team`'s current activity.
- twisted._threads._team.Statistics.idleWorkerCount
  twisted._threads._team.Statistics.html#idleWorkerCount
  Attribute
  Instance Variable
  PUBLIC
  The number of idle workers.
- twisted._threads._team.Statistics.busyWorkerCount
  twisted._threads._team.Statistics.html#busyWorkerCount
  Attribute
  Instance Variable
  PUBLIC
  The number of busy workers.
- twisted._threads._team.Statistics.backloggedWorkCount
  twisted._threads._team.Statistics.html#backloggedWorkCount
  Attribute
  Instance Variable
  PUBLIC
  The number of work items passed to `Team.do` which have not yet been sent to a worker to be performed because not enough workers are available.
- twisted._threads._team.Statistics.__init__
  twisted._threads._team.Statistics.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted._threads._threadworker._stop
  twisted._threads._threadworker.html#_stop
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted._threads.pool
  twisted._threads.html#pool
  Function
  Function
  PUBLIC
  Construct a `Team` that spawns threads as a thread pool, with the given limiting function.
- twisted._threads.Team
  twisted._threads.Team.html
  Class
  Class
  PUBLIC
  A composite `IWorker` implementation.
- twisted._threads.Team._quit
  twisted._threads.Team.html#_quit
  Attribute
  Instance Variable
  PRIVATE
  A `Quit` flag indicating whether this `Team` has been quit yet. This may be set by an arbitrary thread since `Team.quit` may be called from anywhere.
- twisted._threads.Team._coordinator
  twisted._threads.Team.html#_coordinator
  Attribute
  Instance Variable
  PRIVATE
  the `IExclusiveWorker` coordinating access to this `Team`'s internal resources.
- twisted._threads.Team._createWorker
  twisted._threads.Team.html#_createWorker
  Attribute
  Instance Variable
  PRIVATE
  a callable that will create new workers.
- twisted._threads.Team._logException
  twisted._threads.Team.html#_logException
  Attribute
  Instance Variable
  PRIVATE
  a 0-argument callable called in an exception context when there is an unhandled error from a task passed to `Team.do`
- twisted._threads.Team._idle
  twisted._threads.Team.html#_idle
  Attribute
  Instance Variable
  PRIVATE
  a `set` of idle workers.
- twisted._threads.Team._busyCount
  twisted._threads.Team.html#_busyCount
  Attribute
  Instance Variable
  PRIVATE
  the number of workers currently busy.
- twisted._threads.Team._pending
  twisted._threads.Team.html#_pending
  Attribute
  Instance Variable
  PRIVATE
  a `deque` of tasks - that is, 0-argument callables passed to `Team.do` - that are outstanding.
- twisted._threads.Team._shouldQuitCoordinator
  twisted._threads.Team.html#_shouldQuitCoordinator
  Attribute
  Instance Variable
  PRIVATE
  A flag indicating that the coordinator should be quit at the next available opportunity. Unlike `Team._quit`, this flag is only set by the coordinator.
- twisted._threads.Team._toShrink
  twisted._threads.Team.html#_toShrink
  Attribute
  Instance Variable
  PRIVATE
  the number of workers to shrink this `Team` by at the next available opportunity; set in the coordinator.
- twisted._threads.Team.__init__
  twisted._threads.Team.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted._threads.Team.statistics
  twisted._threads.Team.html#statistics
  Function
  Method
  PUBLIC
  Gather information on the current status of this `Team`.
- twisted._threads.Team.grow
  twisted._threads.Team.html#grow
  Function
  Method
  PUBLIC
  Increase the the number of idle workers by `n`.
- twisted._threads.Team.shrink
  twisted._threads.Team.html#shrink
  Function
  Method
  PUBLIC
  Decrease the number of idle workers by `n`.
- twisted._threads.Team._quitIdlers
  twisted._threads.Team.html#_quitIdlers
  Function
  Method
  PRIVATE
  The implmentation of `shrink`, performed by the coordinator worker.
- twisted._threads.Team.do
  twisted._threads.Team.html#do
  Function
  Method
  PUBLIC
  Perform some work in a worker created by `createWorker`.
- twisted._threads.Team._coordinateThisTask
  twisted._threads.Team.html#_coordinateThisTask
  Function
  Method
  PRIVATE
  Select a worker to dispatch to, either an idle one or a new one, and perform it.
- twisted._threads.Team._recycleWorker
  twisted._threads.Team.html#_recycleWorker
  Function
  Method
  PRIVATE
  Called only from coordinator.
- twisted._threads.Team.quit
  twisted._threads.Team.html#quit
  Function
  Method
  PUBLIC
  Stop doing work and shut down all idle workers.
- twisted._threads.LockWorker
  twisted._threads.LockWorker.html
  Class
  Class
  PUBLIC
  An `IWorker` implemented based on a mutual-exclusion lock.
- twisted._threads.LockWorker.__init__
  twisted._threads.LockWorker.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted._threads.LockWorker._quit
  twisted._threads.LockWorker.html#_quit
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted._threads.LockWorker._lock
  twisted._threads.LockWorker.html#_lock
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted._threads.LockWorker._local
  twisted._threads.LockWorker.html#_local
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted._threads.LockWorker.do
  twisted._threads.LockWorker.html#do
  Function
  Method
  PUBLIC
  Do the given work on this thread, with the mutex acquired. If this is called re-entrantly, return and wait for the outer invocation to do the work.
- twisted._threads.LockWorker.quit
  twisted._threads.LockWorker.html#quit
  Function
  Method
  PUBLIC
  Quit this `LockWorker`.
- twisted._threads.ThreadWorker
  twisted._threads.ThreadWorker.html
  Class
  Class
  PUBLIC
  An `IExclusiveWorker` implemented based on a single thread and a queue.
- twisted._threads.ThreadWorker.__init__
  twisted._threads.ThreadWorker.html#__init__
  Function
  Method
  PUBLIC
  Create a `ThreadWorker` with a function to start a thread and a queue to use to communicate with that thread.
- twisted._threads.ThreadWorker._q
  twisted._threads.ThreadWorker.html#_q
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted._threads.ThreadWorker._hasQuit
  twisted._threads.ThreadWorker.html#_hasQuit
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted._threads.ThreadWorker.do
  twisted._threads.ThreadWorker.html#do
  Function
  Method
  PUBLIC
  Perform the given task on the thread owned by this `ThreadWorker`.
- twisted._threads.ThreadWorker.quit
  twisted._threads.ThreadWorker.html#quit
  Function
  Method
  PUBLIC
  Reject all future work and stop the thread started by `__init__`.
- twisted.python.components.globalRegistry
  twisted.python.components.html#globalRegistry
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.python.components.ALLOW_DUPLICATES
  twisted.python.components.html#ALLOW_DUPLICATES
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.python.components.registerAdapter
  twisted.python.components.html#registerAdapter
  Function
  Function
  PUBLIC
  Register an adapter class.
- twisted.python.components.getAdapterFactory
  twisted.python.components.html#getAdapterFactory
  Function
  Function
  PUBLIC
  Return registered adapter for a given class and interface.
- twisted.python.components._addHook
  twisted.python.components.html#_addHook
  Function
  Function
  PRIVATE
  Add an adapter hook which will attempt to look up adapters in the given registry.
- twisted.python.components._removeHook
  twisted.python.components.html#_removeHook
  Function
  Function
  PRIVATE
  Remove a previously added adapter hook.
- twisted.python.components.getRegistry
  twisted.python.components.html#getRegistry
  Function
  Function
  PUBLIC
  Returns the Twisted global `zope.interface.adapter.AdapterRegistry` instance.
- twisted.python.components.Adapter
  twisted.python.components.Adapter.html
  Class
  Class
  PUBLIC
  I am the default implementation of an Adapter for some interface.
- twisted.python.components.Adapter.temporaryAdapter
  twisted.python.components.Adapter.html#temporaryAdapter
  Attribute
  Class Variable
  PUBLIC
  If this is True, the adapter will not be persisted on the Componentized.
- twisted.python.components.Adapter.multiComponent
  twisted.python.components.Adapter.html#multiComponent
  Attribute
  Class Variable
  PUBLIC
  If this adapter is persistent, should it be automatically registered for all appropriate interfaces.
- twisted.python.components.Adapter.__init__
  twisted.python.components.Adapter.html#__init__
  Function
  Method
  PUBLIC
  Set my 'original' attribute to be the object I am adapting.
- twisted.python.components.Adapter.original
  twisted.python.components.Adapter.html#original
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.components.Adapter.__conform__
  twisted.python.components.Adapter.html#__conform__
  Function
  Method
  PUBLIC
  I forward __conform__ to self.original if it has it, otherwise I simply return None.
- twisted.python.components.Adapter.isuper
  twisted.python.components.Adapter.html#isuper
  Function
  Method
  PUBLIC
  Forward isuper to self.original
- twisted.python.components.Componentized
  twisted.python.components.Componentized.html
  Class
  Class
  PUBLIC
  I am a mixin to allow you to be adapted in various ways persistently.
- twisted.python.components.Componentized.persistenceVersion
  twisted.python.components.Componentized.html#persistenceVersion
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.python.components.Componentized.__init__
  twisted.python.components.Componentized.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.components.Componentized._adapterCache
  twisted.python.components.Componentized.html#_adapterCache
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.python.components.Componentized.locateAdapterClass
  twisted.python.components.Componentized.html#locateAdapterClass
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.components.Componentized.setAdapter
  twisted.python.components.Componentized.html#setAdapter
  Function
  Method
  PUBLIC
  Cache a provider for the given interface, by adapting `self` using the given adapter class.
- twisted.python.components.Componentized.addAdapter
  twisted.python.components.Componentized.html#addAdapter
  Function
  Method
  PUBLIC
  Utility method that calls addComponent. I take an adapter class and instantiate it with myself as the first argument.
- twisted.python.components.Componentized.setComponent
  twisted.python.components.Componentized.html#setComponent
  Function
  Method
  PUBLIC
  Cache a provider of the given interface.
- twisted.python.components.Componentized.addComponent
  twisted.python.components.Componentized.html#addComponent
  Function
  Method
  PUBLIC
  Add a component to me, for all appropriate interfaces.
- twisted.python.components.Componentized.unsetComponent
  twisted.python.components.Componentized.html#unsetComponent
  Function
  Method
  PUBLIC
  Remove my component specified by the given interface class.
- twisted.python.components.Componentized.removeComponent
  twisted.python.components.Componentized.html#removeComponent
  Function
  Method
  PUBLIC
  Remove the given component from me entirely, for all interfaces for which it has been registered.
- twisted.python.components.Componentized.getComponent
  twisted.python.components.Componentized.html#getComponent
  Function
  Method
  PUBLIC
  Create or retrieve an adapter for the given interface.
- twisted.python.components.Componentized.__conform__
  twisted.python.components.Componentized.html#__conform__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.components.ReprableComponentized
  twisted.python.components.ReprableComponentized.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.python.components.ReprableComponentized.__init__
  twisted.python.components.ReprableComponentized.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.components.ReprableComponentized.__repr__
  twisted.python.components.ReprableComponentized.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.components.proxyForInterface
  twisted.python.components.html#proxyForInterface
  Function
  Function
  PUBLIC
  Create a class which proxies all method calls which adhere to an interface to another provider of that interface.
- twisted.python.components._ProxiedClassMethod
  twisted.python.components._ProxiedClassMethod.html
  Class
  Class
  PRIVATE
  A proxied class method.
- twisted.python.components._ProxiedClassMethod.methodName
  twisted.python.components._ProxiedClassMethod.html#methodName
  Attribute
  Instance Variable
  PUBLIC
  the name of the method which this should invoke when called.
- twisted.python.components._ProxiedClassMethod.__name__
  twisted.python.components._ProxiedClassMethod.html#__name__
  Attribute
  Instance Variable
  PUBLIC
  The name of the method being proxied (the same as `methodName`).
- twisted.python.components._ProxiedClassMethod.originalAttribute
  twisted.python.components._ProxiedClassMethod.html#originalAttribute
  Attribute
  Instance Variable
  PUBLIC
  name of the attribute of the proxy where the original object is stored.
- twisted.python.components._ProxiedClassMethod.__init__
  twisted.python.components._ProxiedClassMethod.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.components._ProxiedClassMethod.__call__
  twisted.python.components._ProxiedClassMethod.html#__call__
  Function
  Method
  PUBLIC
  Invoke the specified `methodName` method of the `original` attribute for proxyForInterface.
- twisted.python.components._ProxyDescriptor
  twisted.python.components._ProxyDescriptor.html
  Class
  Class
  PRIVATE
  A descriptor which will proxy attribute access, mutation, and deletion to the `_ProxyDescriptor.originalAttribute` of the object it is being accessed from.
- twisted.python.components._ProxyDescriptor.attributeName
  twisted.python.components._ProxyDescriptor.html#attributeName
  Attribute
  Instance Variable
  PUBLIC
  the name of the attribute which this descriptor will retrieve from instances' `original` attribute.
- twisted.python.components._ProxyDescriptor.originalAttribute
  twisted.python.components._ProxyDescriptor.html#originalAttribute
  Attribute
  Instance Variable
  PUBLIC
  name of the attribute of the proxy where the original object is stored.
- twisted.python.components._ProxyDescriptor.__init__
  twisted.python.components._ProxyDescriptor.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.components._ProxyDescriptor.__get__
  twisted.python.components._ProxyDescriptor.html#__get__
  Function
  Method
  PUBLIC
  Retrieve the `self.attributeName` property from oself.
- twisted.python.components._ProxyDescriptor.__set__
  twisted.python.components._ProxyDescriptor.html#__set__
  Function
  Method
  PUBLIC
  Set the `self.attributeName` property of oself.
- twisted.python.components._ProxyDescriptor.__delete__
  twisted.python.components._ProxyDescriptor.html#__delete__
  Function
  Method
  PUBLIC
  Delete the `self.attributeName` property of oself.
- twisted.trial.itrial.ITestCase
  twisted.trial.itrial.ITestCase.html
  Class
  Interface
  PUBLIC
  The interface that a test case must implement in order to be used in Trial.
- twisted.trial.itrial.ITestCase.failureException
  twisted.trial.itrial.ITestCase.html#failureException
  Attribute
  Attribute
  PUBLIC
  The exception class that is raised by failed assertions
- twisted.trial.itrial.ITestCase.__call__
  twisted.trial.itrial.ITestCase.html#__call__
  Function
  Method
  PUBLIC
  Run the test. Should always do exactly the same thing as run().
- twisted.trial.itrial.ITestCase.countTestCases
  twisted.trial.itrial.ITestCase.html#countTestCases
  Function
  Method
  PUBLIC
  Return the number of tests in this test case. Usually 1.
- twisted.trial.itrial.ITestCase.id
  twisted.trial.itrial.ITestCase.html#id
  Function
  Method
  PUBLIC
  Return a unique identifier for the test, usually the fully-qualified Python name.
- twisted.trial.itrial.ITestCase.run
  twisted.trial.itrial.ITestCase.html#run
  Function
  Method
  PUBLIC
  Run the test, storing the results in `result`.
- twisted.trial.itrial.ITestCase.shortDescription
  twisted.trial.itrial.ITestCase.html#shortDescription
  Function
  Method
  PUBLIC
  Return a short description of the test.
- twisted.trial.itrial.IReporter
  twisted.trial.itrial.IReporter.html
  Class
  Interface
  PUBLIC
  I report results from a run of a test suite.
- twisted.trial.itrial.IReporter.shouldStop
  twisted.trial.itrial.IReporter.html#shouldStop
  Attribute
  Attribute
  PUBLIC
  A boolean indicating that this reporter would like the test run to stop.
- twisted.trial.itrial.IReporter.testsRun
  twisted.trial.itrial.IReporter.html#testsRun
  Attribute
  Attribute
  PUBLIC
  The number of tests that seem to have been run according to this reporter.
- twisted.trial.itrial.IReporter.startTest
  twisted.trial.itrial.IReporter.html#startTest
  Function
  Method
  PUBLIC
  Report the beginning of a run of a single test method.
- twisted.trial.itrial.IReporter.stopTest
  twisted.trial.itrial.IReporter.html#stopTest
  Function
  Method
  PUBLIC
  Report the status of a single test method
- twisted.trial.itrial.IReporter.addSuccess
  twisted.trial.itrial.IReporter.html#addSuccess
  Function
  Method
  PUBLIC
  Record that test passed.
- twisted.trial.itrial.IReporter.addError
  twisted.trial.itrial.IReporter.html#addError
  Function
  Method
  PUBLIC
  Record that a test has raised an unexpected exception.
- twisted.trial.itrial.IReporter.addFailure
  twisted.trial.itrial.IReporter.html#addFailure
  Function
  Method
  PUBLIC
  Record that a test has failed with the given failure.
- twisted.trial.itrial.IReporter.addExpectedFailure
  twisted.trial.itrial.IReporter.html#addExpectedFailure
  Function
  Method
  PUBLIC
  Record that the given test failed, and was expected to do so.
- twisted.trial.itrial.IReporter.addUnexpectedSuccess
  twisted.trial.itrial.IReporter.html#addUnexpectedSuccess
  Function
  Method
  PUBLIC
  Record that the given test failed, and was expected to do so.
- twisted.trial.itrial.IReporter.addSkip
  twisted.trial.itrial.IReporter.html#addSkip
  Function
  Method
  PUBLIC
  Record that a test has been skipped for the given reason.
- twisted.trial.itrial.IReporter.wasSuccessful
  twisted.trial.itrial.IReporter.html#wasSuccessful
  Function
  Method
  PUBLIC
  Return a boolean indicating whether all test results that were reported to this reporter were successful or not.
- twisted.trial.itrial.IReporter.done
  twisted.trial.itrial.IReporter.html#done
  Function
  Method
  PUBLIC
  Called when the test run is complete.
- twisted.trial.util.DEFAULT_TIMEOUT_DURATION
  twisted.trial.util.html#DEFAULT_TIMEOUT_DURATION
  Attribute
  Constant
  PUBLIC
  The default timeout which will be applied to asynchronous (ie, Deferred-returning) test methods, in seconds.
- twisted.internet.error.BindError
  twisted.internet.error.BindError.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.internet.error.BindError.__doc__
  twisted.internet.error.BindError.html#__doc__
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet.error.BindError.MESSAGE
  twisted.internet.error.BindError.html#MESSAGE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.error.BindError.__str__
  twisted.internet.error.BindError.html#__str__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.error.CannotListenError
  twisted.internet.error.CannotListenError.html
  Class
  Exception
  PUBLIC
  This gets raised by a call to startListening, when the object cannotstart listening.
- twisted.internet.error.CannotListenError.interface
  twisted.internet.error.CannotListenError.html#interface
  Attribute
  Instance Variable
  PUBLIC
  the interface I tried to listen on
- twisted.internet.error.CannotListenError.port
  twisted.internet.error.CannotListenError.html#port
  Attribute
  Instance Variable
  PUBLIC
  the port I tried to listen on
- twisted.internet.error.CannotListenError.socketError
  twisted.internet.error.CannotListenError.html#socketError
  Attribute
  Instance Variable
  PUBLIC
  the exception I got when I tried to listen
- twisted.internet.error.CannotListenError.__init__
  twisted.internet.error.CannotListenError.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.error.CannotListenError.__str__
  twisted.internet.error.CannotListenError.html#__str__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.error.MulticastJoinError
  twisted.internet.error.MulticastJoinError.html
  Class
  Exception
  PUBLIC
  An attempt to join a multicast group failed.
- twisted.internet.error.MessageLengthError
  twisted.internet.error.MessageLengthError.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.internet.error.MessageLengthError.__doc__
  twisted.internet.error.MessageLengthError.html#__doc__
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet.error.MessageLengthError.MESSAGE
  twisted.internet.error.MessageLengthError.html#MESSAGE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.error.MessageLengthError.__str__
  twisted.internet.error.MessageLengthError.html#__str__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.error.DNSLookupError
  twisted.internet.error.DNSLookupError.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.internet.error.DNSLookupError.__doc__
  twisted.internet.error.DNSLookupError.html#__doc__
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet.error.DNSLookupError.MESSAGE
  twisted.internet.error.DNSLookupError.html#MESSAGE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.error.DNSLookupError.__str__
  twisted.internet.error.DNSLookupError.html#__str__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.error.ConnectInProgressError
  twisted.internet.error.ConnectInProgressError.html
  Class
  Exception
  PUBLIC
  A connect operation was started and isn't done yet.
- twisted.internet.error.ConnectError
  twisted.internet.error.ConnectError.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.internet.error.ConnectError.__doc__
  twisted.internet.error.ConnectError.html#__doc__
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet.error.ConnectError.MESSAGE
  twisted.internet.error.ConnectError.html#MESSAGE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.error.ConnectError.__init__
  twisted.internet.error.ConnectError.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.error.ConnectError.osError
  twisted.internet.error.ConnectError.html#osError
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.error.ConnectError.__str__
  twisted.internet.error.ConnectError.html#__str__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.error.ConnectBindError
  twisted.internet.error.ConnectBindError.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.internet.error.ConnectBindError.__doc__
  twisted.internet.error.ConnectBindError.html#__doc__
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet.error.ConnectBindError.MESSAGE
  twisted.internet.error.ConnectBindError.html#MESSAGE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.error.UnknownHostError
  twisted.internet.error.UnknownHostError.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.internet.error.UnknownHostError.__doc__
  twisted.internet.error.UnknownHostError.html#__doc__
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet.error.UnknownHostError.MESSAGE
  twisted.internet.error.UnknownHostError.html#MESSAGE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.error.NoRouteError
  twisted.internet.error.NoRouteError.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.internet.error.NoRouteError.__doc__
  twisted.internet.error.NoRouteError.html#__doc__
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet.error.NoRouteError.MESSAGE
  twisted.internet.error.NoRouteError.html#MESSAGE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.error.ConnectionRefusedError
  twisted.internet.error.ConnectionRefusedError.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.internet.error.ConnectionRefusedError.__doc__
  twisted.internet.error.ConnectionRefusedError.html#__doc__
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet.error.ConnectionRefusedError.MESSAGE
  twisted.internet.error.ConnectionRefusedError.html#MESSAGE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.error.TCPTimedOutError
  twisted.internet.error.TCPTimedOutError.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.internet.error.TCPTimedOutError.__doc__
  twisted.internet.error.TCPTimedOutError.html#__doc__
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet.error.TCPTimedOutError.MESSAGE
  twisted.internet.error.TCPTimedOutError.html#MESSAGE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.error.BadFileError
  twisted.internet.error.BadFileError.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.internet.error.BadFileError.__doc__
  twisted.internet.error.BadFileError.html#__doc__
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet.error.BadFileError.MESSAGE
  twisted.internet.error.BadFileError.html#MESSAGE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.error.ServiceNameUnknownError
  twisted.internet.error.ServiceNameUnknownError.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.internet.error.ServiceNameUnknownError.__doc__
  twisted.internet.error.ServiceNameUnknownError.html#__doc__
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet.error.ServiceNameUnknownError.MESSAGE
  twisted.internet.error.ServiceNameUnknownError.html#MESSAGE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.error.UserError
  twisted.internet.error.UserError.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.internet.error.UserError.__doc__
  twisted.internet.error.UserError.html#__doc__
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet.error.UserError.MESSAGE
  twisted.internet.error.UserError.html#MESSAGE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.error.TimeoutError
  twisted.internet.error.TimeoutError.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.internet.error.TimeoutError.__doc__
  twisted.internet.error.TimeoutError.html#__doc__
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet.error.TimeoutError.MESSAGE
  twisted.internet.error.TimeoutError.html#MESSAGE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.error.SSLError
  twisted.internet.error.SSLError.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.internet.error.SSLError.__doc__
  twisted.internet.error.SSLError.html#__doc__
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet.error.SSLError.MESSAGE
  twisted.internet.error.SSLError.html#MESSAGE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.error.VerifyError
  twisted.internet.error.VerifyError.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.internet.error.VerifyError.__doc__
  twisted.internet.error.VerifyError.html#__doc__
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet.error.VerifyError.MESSAGE
  twisted.internet.error.VerifyError.html#MESSAGE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.error.PeerVerifyError
  twisted.internet.error.PeerVerifyError.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.internet.error.PeerVerifyError.__doc__
  twisted.internet.error.PeerVerifyError.html#__doc__
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet.error.PeerVerifyError.MESSAGE
  twisted.internet.error.PeerVerifyError.html#MESSAGE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.error.CertificateError
  twisted.internet.error.CertificateError.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.internet.error.CertificateError.__doc__
  twisted.internet.error.CertificateError.html#__doc__
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet.error.CertificateError.MESSAGE
  twisted.internet.error.CertificateError.html#MESSAGE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.error.errnoMapping
  twisted.internet.error.html#errnoMapping
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.internet.error.getConnectError
  twisted.internet.error.html#getConnectError
  Function
  Function
  PUBLIC
  Given a socket exception, return connection error.
- twisted.internet.error.ConnectionClosed
  twisted.internet.error.ConnectionClosed.html
  Class
  Exception
  PUBLIC
  Connection was closed, whether cleanly or non-cleanly.
- twisted.internet.error.ConnectionLost
  twisted.internet.error.ConnectionLost.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.internet.error.ConnectionLost.__doc__
  twisted.internet.error.ConnectionLost.html#__doc__
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet.error.ConnectionLost.MESSAGE
  twisted.internet.error.ConnectionLost.html#MESSAGE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.error.ConnectionLost.__str__
  twisted.internet.error.ConnectionLost.html#__str__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.error.ConnectionAborted
  twisted.internet.error.ConnectionAborted.html
  Class
  Exception
  PUBLIC
  Connection was aborted locally, using `twisted.internet.interfaces.ITCPTransport.abortConnection`.
- twisted.internet.error.ConnectionAborted.MESSAGE
  twisted.internet.error.ConnectionAborted.html#MESSAGE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.error.ConnectionDone
  twisted.internet.error.ConnectionDone.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.internet.error.ConnectionDone.__doc__
  twisted.internet.error.ConnectionDone.html#__doc__
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet.error.ConnectionDone.MESSAGE
  twisted.internet.error.ConnectionDone.html#MESSAGE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.error.ConnectionDone.__str__
  twisted.internet.error.ConnectionDone.html#__str__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.error.FileDescriptorOverrun
  twisted.internet.error.FileDescriptorOverrun.html
  Class
  Exception
  PUBLIC
  A mis-use of `IUNIXTransport.sendFileDescriptor` caused the connection to be closed.
- twisted.internet.error.FileDescriptorOverrun.MESSAGE
  twisted.internet.error.FileDescriptorOverrun.html#MESSAGE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.error.ConnectionFdescWentAway
  twisted.internet.error.ConnectionFdescWentAway.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.internet.error.ConnectionFdescWentAway.__doc__
  twisted.internet.error.ConnectionFdescWentAway.html#__doc__
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet.error.ConnectionFdescWentAway.MESSAGE
  twisted.internet.error.ConnectionFdescWentAway.html#MESSAGE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.error.AlreadyCalled
  twisted.internet.error.AlreadyCalled.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.internet.error.AlreadyCalled.__doc__
  twisted.internet.error.AlreadyCalled.html#__doc__
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet.error.AlreadyCalled.MESSAGE
  twisted.internet.error.AlreadyCalled.html#MESSAGE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.error.AlreadyCalled.__str__
  twisted.internet.error.AlreadyCalled.html#__str__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.error.AlreadyCancelled
  twisted.internet.error.AlreadyCancelled.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.internet.error.AlreadyCancelled.__doc__
  twisted.internet.error.AlreadyCancelled.html#__doc__
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet.error.AlreadyCancelled.MESSAGE
  twisted.internet.error.AlreadyCancelled.html#MESSAGE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.error.AlreadyCancelled.__str__
  twisted.internet.error.AlreadyCancelled.html#__str__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.error.PotentialZombieWarning
  twisted.internet.error.PotentialZombieWarning.html
  Class
  Exception
  PUBLIC
  Emitted when `IReactorProcess.spawnProcess` is called in a way which may result in termination of the created child process not being reported.
- twisted.internet.error.PotentialZombieWarning.MESSAGE
  twisted.internet.error.PotentialZombieWarning.html#MESSAGE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.error.ProcessDone
  twisted.internet.error.ProcessDone.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.internet.error.ProcessDone.__doc__
  twisted.internet.error.ProcessDone.html#__doc__
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet.error.ProcessDone.MESSAGE
  twisted.internet.error.ProcessDone.html#MESSAGE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.error.ProcessDone.__init__
  twisted.internet.error.ProcessDone.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.error.ProcessDone.exitCode
  twisted.internet.error.ProcessDone.html#exitCode
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.error.ProcessDone.signal
  twisted.internet.error.ProcessDone.html#signal
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.error.ProcessDone.status
  twisted.internet.error.ProcessDone.html#status
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.error.ProcessTerminated
  twisted.internet.error.ProcessTerminated.html
  Class
  Exception
  PUBLIC
  No exception docstring; 0/3 instance variable, 0/1 class variable, 0/1 constant, 1/1 method documented
- twisted.internet.error.ProcessTerminated.__doc__
  twisted.internet.error.ProcessTerminated.html#__doc__
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet.error.ProcessTerminated.MESSAGE
  twisted.internet.error.ProcessTerminated.html#MESSAGE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.error.ProcessTerminated.__init__
  twisted.internet.error.ProcessTerminated.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.internet.error.ProcessTerminated.exitCode
  twisted.internet.error.ProcessTerminated.html#exitCode
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.error.ProcessTerminated.signal
  twisted.internet.error.ProcessTerminated.html#signal
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.error.ProcessTerminated.status
  twisted.internet.error.ProcessTerminated.html#status
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.error.ProcessExitedAlready
  twisted.internet.error.ProcessExitedAlready.html
  Class
  Exception
  PUBLIC
  The process has already exited and the operation requested can no longer be performed.
- twisted.internet.error.NotConnectingError
  twisted.internet.error.NotConnectingError.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.internet.error.NotConnectingError.__doc__
  twisted.internet.error.NotConnectingError.html#__doc__
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet.error.NotConnectingError.MESSAGE
  twisted.internet.error.NotConnectingError.html#MESSAGE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.error.NotConnectingError.__str__
  twisted.internet.error.NotConnectingError.html#__str__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.error.NotListeningError
  twisted.internet.error.NotListeningError.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.internet.error.NotListeningError.__doc__
  twisted.internet.error.NotListeningError.html#__doc__
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet.error.NotListeningError.MESSAGE
  twisted.internet.error.NotListeningError.html#MESSAGE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.error.NotListeningError.__str__
  twisted.internet.error.NotListeningError.html#__str__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.error.ReactorNotRunning
  twisted.internet.error.ReactorNotRunning.html
  Class
  Exception
  PUBLIC
  Error raised when trying to stop a reactor which is not running.
- twisted.internet.error.ReactorNotRestartable
  twisted.internet.error.ReactorNotRestartable.html
  Class
  Exception
  PUBLIC
  Error raised when trying to run a reactor which was stopped.
- twisted.internet.error.ReactorAlreadyRunning
  twisted.internet.error.ReactorAlreadyRunning.html
  Class
  Exception
  PUBLIC
  Error raised when trying to start the reactor multiple times.
- twisted.internet.error.ReactorAlreadyInstalledError
  twisted.internet.error.ReactorAlreadyInstalledError.html
  Class
  Exception
  PUBLIC
  Could not install reactor because one is already installed.
- twisted.internet.error.ConnectingCancelledError
  twisted.internet.error.ConnectingCancelledError.html
  Class
  Exception
  PUBLIC
  An `Exception` that will be raised when an `IStreamClientEndpoint` is cancelled before it connects.
- twisted.internet.error.ConnectingCancelledError.address
  twisted.internet.error.ConnectingCancelledError.html#address
  Attribute
  Instance Variable
  PUBLIC
  The `IAddress` that is the destination of the cancelled `IStreamClientEndpoint`.
- twisted.internet.error.ConnectingCancelledError.__init__
  twisted.internet.error.ConnectingCancelledError.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.internet.error.NoProtocol
  twisted.internet.error.NoProtocol.html
  Class
  Exception
  PUBLIC
  An `Exception` that will be raised when the factory given to a `IStreamClientEndpoint` returns `None` from `buildProtocol`.
- twisted.internet.error.UnsupportedAddressFamily
  twisted.internet.error.UnsupportedAddressFamily.html
  Class
  Exception
  PUBLIC
  An attempt was made to use a socket with an address family (eg AF_INET, AF_INET6, etc) which is not supported by the reactor.
- twisted.internet.error.UnsupportedSocketType
  twisted.internet.error.UnsupportedSocketType.html
  Class
  Exception
  PUBLIC
  An attempt was made to use a socket of a type (eg SOCK_STREAM, SOCK_DGRAM, etc) which is not supported by the reactor.
- twisted.internet.error.AlreadyListened
  twisted.internet.error.AlreadyListened.html
  Class
  Exception
  PUBLIC
  An attempt was made to listen on a file descriptor which can only be listened on once.
- twisted.internet.error.InvalidAddressError
  twisted.internet.error.InvalidAddressError.html
  Class
  Exception
  PUBLIC
  An invalid address was specified (i.e. neither IPv4 or IPv6, or expected one and got the other).
- twisted.internet.error.InvalidAddressError.address
  twisted.internet.error.InvalidAddressError.html#address
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`
- twisted.internet.error.InvalidAddressError.message
  twisted.internet.error.InvalidAddressError.html#message
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`
- twisted.internet.error.InvalidAddressError.__init__
  twisted.internet.error.InvalidAddressError.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.internet.main.CONNECTION_DONE
  twisted.internet.main.html#CONNECTION_DONE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.main.CONNECTION_LOST
  twisted.internet.main.html#CONNECTION_LOST
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.main.installReactor
  twisted.internet.main.html#installReactor
  Function
  Function
  PUBLIC
  Install reactor `reactor`.
- twisted.internet.abstract._dataMustBeBytes
  twisted.internet.abstract.html#_dataMustBeBytes
  Function
  Function
  PRIVATE
  Undocumented
- twisted.internet.abstract._concatenate
  twisted.internet.abstract.html#_concatenate
  Function
  Function
  PRIVATE
  Undocumented
- twisted.internet.abstract._ConsumerMixin
  twisted.internet.abstract._ConsumerMixin.html
  Class
  Class
  PRIVATE
  `IConsumer` implementations can mix this in to get `registerProducer` and `unregisterProducer` methods which take care of keeping track of a producer's state.
- twisted.internet.abstract._ConsumerMixin.producer
  twisted.internet.abstract._ConsumerMixin.html#producer
  Attribute
  Instance Variable
  PUBLIC
  `None` if no producer is registered, otherwise the registered producer.
- twisted.internet.abstract._ConsumerMixin.producerPaused
  twisted.internet.abstract._ConsumerMixin.html#producerPaused
  Attribute
  Instance Variable
  PUBLIC
  A flag indicating whether the producer is currently paused.
- twisted.internet.abstract._ConsumerMixin.streamingProducer
  twisted.internet.abstract._ConsumerMixin.html#streamingProducer
  Attribute
  Instance Variable
  PUBLIC
  `bool` or `int`
- twisted.internet.abstract._ConsumerMixin.startWriting
  twisted.internet.abstract._ConsumerMixin.html#startWriting
  Function
  Method
  PUBLIC
  Override in a subclass to cause the reactor to monitor this selectable for write events. This will be called once in `unregisterProducer` if `loseConnection` has previously been called, so that the connection can actually close.
- twisted.internet.abstract._ConsumerMixin.registerProducer
  twisted.internet.abstract._ConsumerMixin.html#registerProducer
  Function
  Method
  PUBLIC
  Register to receive data from a producer.
- twisted.internet.abstract._ConsumerMixin.unregisterProducer
  twisted.internet.abstract._ConsumerMixin.html#unregisterProducer
  Function
  Method
  PUBLIC
  Stop consuming data from a producer, without disconnecting.
- twisted.internet.abstract._LogOwner
  twisted.internet.abstract._LogOwner.html
  Class
  Class
  PRIVATE
  Mixin to help implement `interfaces.ILoggingContext` for transports which have a protocol, the log prefix of which should also appear in the transport's log prefix.
- twisted.internet.abstract._LogOwner._getLogPrefix
  twisted.internet.abstract._LogOwner.html#_getLogPrefix
  Function
  Method
  PRIVATE
  Determine the log prefix to use for messages related to `applicationObject`, which may or may not be an `interfaces.ILoggingContext` provider.
- twisted.internet.abstract._LogOwner.logPrefix
  twisted.internet.abstract._LogOwner.html#logPrefix
  Function
  Method
  PUBLIC
  Override this method to insert custom logging behavior. Its return value will be inserted in front of every line. It may be called more times than the number of output lines.
- twisted.internet.abstract.FileDescriptor
  twisted.internet.abstract.FileDescriptor.html
  Class
  Class
  PUBLIC
  An object which can be operated on by select().
- twisted.internet.abstract.FileDescriptor.connected
  twisted.internet.abstract.FileDescriptor.html#connected
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.abstract.FileDescriptor.disconnected
  twisted.internet.abstract.FileDescriptor.html#disconnected
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.abstract.FileDescriptor.disconnecting
  twisted.internet.abstract.FileDescriptor.html#disconnecting
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet.abstract.FileDescriptor._writeDisconnecting
  twisted.internet.abstract.FileDescriptor.html#_writeDisconnecting
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.abstract.FileDescriptor._writeDisconnected
  twisted.internet.abstract.FileDescriptor.html#_writeDisconnected
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.internet.abstract.FileDescriptor.dataBuffer
  twisted.internet.abstract.FileDescriptor.html#dataBuffer
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.abstract.FileDescriptor.offset
  twisted.internet.abstract.FileDescriptor.html#offset
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.abstract.FileDescriptor.SEND_LIMIT
  twisted.internet.abstract.FileDescriptor.html#SEND_LIMIT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.abstract.FileDescriptor.__init__
  twisted.internet.abstract.FileDescriptor.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.internet.abstract.FileDescriptor.reactor
  twisted.internet.abstract.FileDescriptor.html#reactor
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.abstract.FileDescriptor._tempDataBuffer
  twisted.internet.abstract.FileDescriptor.html#_tempDataBuffer
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.abstract.FileDescriptor._tempDataLen
  twisted.internet.abstract.FileDescriptor.html#_tempDataLen
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.abstract.FileDescriptor.connectionLost
  twisted.internet.abstract.FileDescriptor.html#connectionLost
  Function
  Method
  PUBLIC
  The connection was lost.
- twisted.internet.abstract.FileDescriptor.producer
  twisted.internet.abstract.FileDescriptor.html#producer
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.abstract.FileDescriptor.writeSomeData
  twisted.internet.abstract.FileDescriptor.html#writeSomeData
  Function
  Method
  PUBLIC
  Write as much as possible of the given data, immediately.
- twisted.internet.abstract.FileDescriptor.doRead
  twisted.internet.abstract.FileDescriptor.html#doRead
  Function
  Method
  PUBLIC
  Called when data is available for reading.
- twisted.internet.abstract.FileDescriptor.doWrite
  twisted.internet.abstract.FileDescriptor.html#doWrite
  Function
  Method
  PUBLIC
  Called when data can be written.
- twisted.internet.abstract.FileDescriptor.producerPaused
  twisted.internet.abstract.FileDescriptor.html#producerPaused
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.abstract.FileDescriptor._postLoseConnection
  twisted.internet.abstract.FileDescriptor.html#_postLoseConnection
  Function
  Method
  PRIVATE
  Called after a loseConnection(), when all data has been written.
- twisted.internet.abstract.FileDescriptor._closeWriteConnection
  twisted.internet.abstract.FileDescriptor.html#_closeWriteConnection
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet.abstract.FileDescriptor.writeConnectionLost
  twisted.internet.abstract.FileDescriptor.html#writeConnectionLost
  Function
  Method
  PUBLIC
  Indicates write connection was lost.
- twisted.internet.abstract.FileDescriptor.readConnectionLost
  twisted.internet.abstract.FileDescriptor.html#readConnectionLost
  Function
  Method
  PUBLIC
  Indicates read connection was lost.
- twisted.internet.abstract.FileDescriptor.getHost
  twisted.internet.abstract.FileDescriptor.html#getHost
  Function
  Method
  PUBLIC
  Similar to getPeer, but returns an address describing this side of the connection.
- twisted.internet.abstract.FileDescriptor.getPeer
  twisted.internet.abstract.FileDescriptor.html#getPeer
  Function
  Method
  PUBLIC
  Get the remote address of this connection.
- twisted.internet.abstract.FileDescriptor._isSendBufferFull
  twisted.internet.abstract.FileDescriptor.html#_isSendBufferFull
  Function
  Method
  PRIVATE
  Determine whether the user-space send buffer for this transport is full or not.
- twisted.internet.abstract.FileDescriptor._maybePauseProducer
  twisted.internet.abstract.FileDescriptor.html#_maybePauseProducer
  Function
  Method
  PRIVATE
  Possibly pause a producer, if there is one and the send buffer is full.
- twisted.internet.abstract.FileDescriptor.write
  twisted.internet.abstract.FileDescriptor.html#write
  Function
  Method
  PUBLIC
  Reliably write some data.
- twisted.internet.abstract.FileDescriptor.writeSequence
  twisted.internet.abstract.FileDescriptor.html#writeSequence
  Function
  Method
  PUBLIC
  Reliably write a sequence of data.
- twisted.internet.abstract.FileDescriptor.loseConnection
  twisted.internet.abstract.FileDescriptor.html#loseConnection
  Function
  Method
  PUBLIC
  Close the connection at the next available opportunity.
- twisted.internet.abstract.FileDescriptor.loseWriteConnection
  twisted.internet.abstract.FileDescriptor.html#loseWriteConnection
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.abstract.FileDescriptor.stopReading
  twisted.internet.abstract.FileDescriptor.html#stopReading
  Function
  Method
  PUBLIC
  Stop waiting for read availability.
- twisted.internet.abstract.FileDescriptor.stopWriting
  twisted.internet.abstract.FileDescriptor.html#stopWriting
  Function
  Method
  PUBLIC
  Stop waiting for write availability.
- twisted.internet.abstract.FileDescriptor.startReading
  twisted.internet.abstract.FileDescriptor.html#startReading
  Function
  Method
  PUBLIC
  Start waiting for read availability.
- twisted.internet.abstract.FileDescriptor.startWriting
  twisted.internet.abstract.FileDescriptor.html#startWriting
  Function
  Method
  PUBLIC
  Start waiting for write availability.
- twisted.internet.abstract.FileDescriptor.bufferSize
  twisted.internet.abstract.FileDescriptor.html#bufferSize
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet.abstract.FileDescriptor.stopConsuming
  twisted.internet.abstract.FileDescriptor.html#stopConsuming
  Function
  Method
  PUBLIC
  Stop consuming data.
- twisted.internet.abstract.FileDescriptor.resumeProducing
  twisted.internet.abstract.FileDescriptor.html#resumeProducing
  Function
  Method
  PUBLIC
  Resume producing data.
- twisted.internet.abstract.FileDescriptor.pauseProducing
  twisted.internet.abstract.FileDescriptor.html#pauseProducing
  Function
  Method
  PUBLIC
  Pause producing data.
- twisted.internet.abstract.FileDescriptor.stopProducing
  twisted.internet.abstract.FileDescriptor.html#stopProducing
  Function
  Method
  PUBLIC
  Stop producing data.
- twisted.internet.abstract.FileDescriptor.fileno
  twisted.internet.abstract.FileDescriptor.html#fileno
  Function
  Method
  PUBLIC
  File Descriptor number for select().
- twisted.internet.abstract.isIPAddress
  twisted.internet.abstract.html#isIPAddress
  Function
  Function
  PUBLIC
  Determine whether the given string represents an IP address of the given family; by default, an IPv4 address.
- twisted.internet.abstract.isIPv6Address
  twisted.internet.abstract.html#isIPv6Address
  Function
  Function
  PUBLIC
  Determine whether the given string represents an IPv6 address.
- twisted.python.runtime.shortPythonVersion
  twisted.python.runtime.html#shortPythonVersion
  Function
  Function
  PUBLIC
  Returns the Python version as a dot-separated string.
- twisted.python.runtime.knownPlatforms
  twisted.python.runtime.html#knownPlatforms
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.python.runtime.Platform
  twisted.python.runtime.Platform.html
  Class
  Class
  PUBLIC
  Gives us information about the platform we're running on.
- twisted.python.runtime.Platform.type
  twisted.python.runtime.Platform.html#type
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.runtime.Platform.seconds
  twisted.python.runtime.Platform.html#seconds
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.python.runtime.Platform.__init__
  twisted.python.runtime.Platform.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.runtime.Platform._platform
  twisted.python.runtime.Platform.html#_platform
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.python.runtime.Platform.isKnown
  twisted.python.runtime.Platform.html#isKnown
  Function
  Method
  PUBLIC
  Do we know about this platform?
- twisted.python.runtime.Platform.getType
  twisted.python.runtime.Platform.html#getType
  Function
  Method
  PUBLIC
  Get platform type.
- twisted.python.runtime.Platform.isMacOSX
  twisted.python.runtime.Platform.html#isMacOSX
  Function
  Method
  PUBLIC
  Check if current platform is macOS.
- twisted.python.runtime.Platform.isWinNT
  twisted.python.runtime.Platform.html#isWinNT
  Function
  Method
  PUBLIC
  Are we running in Windows NT?
- twisted.python.runtime.Platform.isWindows
  twisted.python.runtime.Platform.html#isWindows
  Function
  Method
  PUBLIC
  Are we running in Windows?
- twisted.python.runtime.Platform.isVista
  twisted.python.runtime.Platform.html#isVista
  Function
  Method
  PUBLIC
  Check if current platform is Windows Vista or Windows Server 2008.
- twisted.python.runtime.Platform.isLinux
  twisted.python.runtime.Platform.html#isLinux
  Function
  Method
  PUBLIC
  Check if current platform is Linux.
- twisted.python.runtime.Platform.isDocker
  twisted.python.runtime.Platform.html#isDocker
  Function
  Method
  PUBLIC
  Check if the current platform is Linux in a Docker container.
- twisted.python.runtime.Platform._supportsSymlinks
  twisted.python.runtime.Platform.html#_supportsSymlinks
  Function
  Method
  PRIVATE
  Check for symlink support usable for Twisted's purposes.
- twisted.python.runtime.Platform.supportsThreads
  twisted.python.runtime.Platform.html#supportsThreads
  Function
  Method
  PUBLIC
  Can threads be created?
- twisted.python.runtime.Platform.supportsINotify
  twisted.python.runtime.Platform.html#supportsINotify
  Function
  Method
  PUBLIC
  Return `True` if we can use the inotify API on this platform.
- twisted.python.runtime.platform
  twisted.python.runtime.html#platform
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.python.runtime.platformType
  twisted.python.runtime.html#platformType
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.python.win32.O_BINARY
  twisted.python.win32.html#O_BINARY
  Attribute
  Constant
  PUBLIC
  the 'binary' mode flag on Windows, or 0 on other platforms, so it may safely be OR'ed into a mask for os.open.
- twisted.python.win32.ERROR_FILE_NOT_FOUND
  twisted.python.win32.html#ERROR_FILE_NOT_FOUND
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.python.win32.ERROR_PATH_NOT_FOUND
  twisted.python.win32.html#ERROR_PATH_NOT_FOUND
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.python.win32.ERROR_INVALID_NAME
  twisted.python.win32.html#ERROR_INVALID_NAME
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.python.win32.ERROR_DIRECTORY
  twisted.python.win32.html#ERROR_DIRECTORY
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.python.win32.FakeWindowsError
  twisted.python.win32.FakeWindowsError.html
  Class
  Exception
  PUBLIC
  Stand-in for sometimes-builtin exception on platforms for which it is missing.
- twisted.python.win32._cmdLineQuoteRe
  twisted.python.win32.html#_cmdLineQuoteRe
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.python.win32._cmdLineQuoteRe2
  twisted.python.win32.html#_cmdLineQuoteRe2
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.python.win32.cmdLineQuote
  twisted.python.win32.html#cmdLineQuote
  Function
  Function
  PUBLIC
  Internal method for quoting a single command-line argument.
- twisted.python.win32.quoteArguments
  twisted.python.win32.html#quoteArguments
  Function
  Function
  PUBLIC
  Quote an iterable of command-line arguments for passing to CreateProcess or a similar API. This allows the list passed to `reactor.spawnProcess` to match the child process's `sys.argv` properly.
- twisted.python.win32._ErrorFormatter
  twisted.python.win32._ErrorFormatter.html
  Class
  Class
  PRIVATE
  Formatter for Windows error messages.
- twisted.python.win32._ErrorFormatter.winError
  twisted.python.win32._ErrorFormatter.html#winError
  Attribute
  Instance Variable
  PUBLIC
  A callable which takes one integer error number argument and returns a `WindowsError` instance for that error (like `ctypes.WinError`).
- twisted.python.win32._ErrorFormatter.formatMessage
  twisted.python.win32._ErrorFormatter.html#formatMessage
  Attribute
  Instance Variable
  PUBLIC
  A callable which takes one integer error number argument and returns a `str` giving the message for that error (like win32api.FormatMessage).
- twisted.python.win32._ErrorFormatter.errorTab
  twisted.python.win32._ErrorFormatter.html#errorTab
  Attribute
  Instance Variable
  PUBLIC
  A mapping from integer error numbers to `str` messages which correspond to those erorrs (like socket.errorTab).
- twisted.python.win32._ErrorFormatter.__init__
  twisted.python.win32._ErrorFormatter.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.win32._ErrorFormatter.fromEnvironment
  twisted.python.win32._ErrorFormatter.html#fromEnvironment
  Function
  Class Method
  PUBLIC
  Get as many of the platform-specific error translation objects as possible and return an instance of `cls` created with them.
- twisted.python.win32._ErrorFormatter.formatError
  twisted.python.win32._ErrorFormatter.html#formatError
  Function
  Method
  PUBLIC
  Returns the string associated with a Windows error message, such as the ones found in socket.error.
- twisted.python.win32.formatError
  twisted.python.win32.html#formatError
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.python.filepath._CREATE_FLAGS
  twisted.python.filepath.html#_CREATE_FLAGS
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.python.filepath._stub_islink
  twisted.python.filepath.html#_stub_islink
  Function
  Function
  PRIVATE
  Always return `False` if the operating system does not support symlinks.
- twisted.python.filepath.islink
  twisted.python.filepath.html#islink
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.python.filepath.IFilePath
  twisted.python.filepath.IFilePath.html
  Class
  Interface
  PUBLIC
  File path object.
- twisted.python.filepath.IFilePath.sep
  twisted.python.filepath.IFilePath.html#sep
  Attribute
  Attribute
  PUBLIC
  The path separator to use in string representations
- twisted.python.filepath.IFilePath.child
  twisted.python.filepath.IFilePath.html#child
  Function
  Method
  PUBLIC
  Obtain a direct child of this file path. The child may or may not exist.
- twisted.python.filepath.IFilePath.open
  twisted.python.filepath.IFilePath.html#open
  Function
  Method
  PUBLIC
  Opens this file path with the given mode.
- twisted.python.filepath.IFilePath.changed
  twisted.python.filepath.IFilePath.html#changed
  Function
  Method
  PUBLIC
  Clear any cached information about the state of this path on disk.
- twisted.python.filepath.IFilePath.getsize
  twisted.python.filepath.IFilePath.html#getsize
  Function
  Method
  PUBLIC
  Retrieve the size of this file in bytes.
- twisted.python.filepath.IFilePath.getModificationTime
  twisted.python.filepath.IFilePath.html#getModificationTime
  Function
  Method
  PUBLIC
  Retrieve the time of last access from this file.
- twisted.python.filepath.IFilePath.getStatusChangeTime
  twisted.python.filepath.IFilePath.html#getStatusChangeTime
  Function
  Method
  PUBLIC
  Retrieve the time of the last status change for this file.
- twisted.python.filepath.IFilePath.getAccessTime
  twisted.python.filepath.IFilePath.html#getAccessTime
  Function
  Method
  PUBLIC
  Retrieve the time that this file was last accessed.
- twisted.python.filepath.IFilePath.exists
  twisted.python.filepath.IFilePath.html#exists
  Function
  Method
  PUBLIC
  Check if this file path exists.
- twisted.python.filepath.IFilePath.isdir
  twisted.python.filepath.IFilePath.html#isdir
  Function
  Method
  PUBLIC
  Check if this file path refers to a directory.
- twisted.python.filepath.IFilePath.isfile
  twisted.python.filepath.IFilePath.html#isfile
  Function
  Method
  PUBLIC
  Check if this file path refers to a regular file.
- twisted.python.filepath.IFilePath.children
  twisted.python.filepath.IFilePath.html#children
  Function
  Method
  PUBLIC
  List the children of this path object.
- twisted.python.filepath.IFilePath.basename
  twisted.python.filepath.IFilePath.html#basename
  Function
  Method
  PUBLIC
  Retrieve the final component of the file path's path (everything after the final path separator).
- twisted.python.filepath.IFilePath.parent
  twisted.python.filepath.IFilePath.html#parent
  Function
  Method
  PUBLIC
  A file path for the directory containing the file at this file path.
- twisted.python.filepath.IFilePath.sibling
  twisted.python.filepath.IFilePath.html#sibling
  Function
  Method
  PUBLIC
  A file path for the directory containing the file at this file path.
- twisted.python.filepath.InsecurePath
  twisted.python.filepath.InsecurePath.html
  Class
  Exception
  PUBLIC
  Error that is raised when the path provided to `FilePath` is invalid.
- twisted.python.filepath.LinkError
  twisted.python.filepath.LinkError.html
  Class
  Exception
  PUBLIC
  An error with symlinks - either that there are cyclical symlinks or that symlink are not supported on this platform.
- twisted.python.filepath.UnlistableError
  twisted.python.filepath.UnlistableError.html
  Class
  Exception
  PUBLIC
  An exception which is used to distinguish between errors which mean 'this is not a directory you can list' and other, more catastrophic errors.
- twisted.python.filepath.UnlistableError.originalException
  twisted.python.filepath.UnlistableError.html#originalException
  Attribute
  Instance Variable
  PUBLIC
  the actual original exception instance.
- twisted.python.filepath.UnlistableError.__init__
  twisted.python.filepath.UnlistableError.html#__init__
  Function
  Method
  PUBLIC
  Create an UnlistableError exception.
- twisted.python.filepath._secureEnoughString
  twisted.python.filepath.html#_secureEnoughString
  Function
  Function
  PRIVATE
  Compute a string usable as a new, temporary filename.
- twisted.python.filepath.AbstractFilePath
  twisted.python.filepath.AbstractFilePath.html
  Class
  Class
  PUBLIC
  Abstract implementation of an `IFilePath`; must be completed by a subclass.
- twisted.python.filepath.AbstractFilePath.getContent
  twisted.python.filepath.AbstractFilePath.html#getContent
  Function
  Method
  PUBLIC
  Retrieve the contents of the file at this path.
- twisted.python.filepath.AbstractFilePath.parents
  twisted.python.filepath.AbstractFilePath.html#parents
  Function
  Method
  PUBLIC
  Retrieve an iterator of all the ancestors of this path.
- twisted.python.filepath.AbstractFilePath.children
  twisted.python.filepath.AbstractFilePath.html#children
  Function
  Method
  PUBLIC
  List the children of this path object.
- twisted.python.filepath.AbstractFilePath.walk
  twisted.python.filepath.AbstractFilePath.html#walk
  Function
  Method
  PUBLIC
  Yield myself, then each of my children, and each of those children's children in turn.
- twisted.python.filepath.AbstractFilePath.sibling
  twisted.python.filepath.AbstractFilePath.html#sibling
  Function
  Method
  PUBLIC
  Return a `FilePath` with the same directory as this instance but with a basename of `path`.
- twisted.python.filepath.AbstractFilePath.descendant
  twisted.python.filepath.AbstractFilePath.html#descendant
  Function
  Method
  PUBLIC
  Retrieve a child or child's child of this path.
- twisted.python.filepath.AbstractFilePath.segmentsFrom
  twisted.python.filepath.AbstractFilePath.html#segmentsFrom
  Function
  Method
  PUBLIC
  Return a list of segments between a child and its ancestor.
- twisted.python.filepath.AbstractFilePath.__hash__
  twisted.python.filepath.AbstractFilePath.html#__hash__
  Function
  Method
  PUBLIC
  Hash the same as another `FilePath` with the same path as mine.
- twisted.python.filepath.AbstractFilePath.getmtime
  twisted.python.filepath.AbstractFilePath.html#getmtime
  Function
  Method
  PUBLIC
  Deprecated. Use getModificationTime instead.
- twisted.python.filepath.AbstractFilePath.getatime
  twisted.python.filepath.AbstractFilePath.html#getatime
  Function
  Method
  PUBLIC
  Deprecated. Use getAccessTime instead.
- twisted.python.filepath.AbstractFilePath.getctime
  twisted.python.filepath.AbstractFilePath.html#getctime
  Function
  Method
  PUBLIC
  Deprecated. Use getStatusChangeTime instead.
- twisted.python.filepath.RWX
  twisted.python.filepath.RWX.html
  Class
  Class
  PUBLIC
  A class representing read/write/execute permissions for a single user category (i.e. user/owner, group, or other/world). Instantiate with three boolean values: readable? writable? executable?.
- twisted.python.filepath.RWX.read
  twisted.python.filepath.RWX.html#read
  Attribute
  Instance Variable
  PUBLIC
  Whether permission to read is given
- twisted.python.filepath.RWX.write
  twisted.python.filepath.RWX.html#write
  Attribute
  Instance Variable
  PUBLIC
  Whether permission to write is given
- twisted.python.filepath.RWX.execute
  twisted.python.filepath.RWX.html#execute
  Attribute
  Instance Variable
  PUBLIC
  Whether permission to execute is given
- twisted.python.filepath.RWX.compareAttributes
  twisted.python.filepath.RWX.html#compareAttributes
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.python.filepath.RWX.__init__
  twisted.python.filepath.RWX.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.filepath.RWX.__repr__
  twisted.python.filepath.RWX.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.filepath.RWX.shorthand
  twisted.python.filepath.RWX.html#shorthand
  Function
  Method
  PUBLIC
  Returns a short string representing the permission bits. Looks like part of what is printed by command line utilities such as 'ls -l' (e.g. 'rwx')
- twisted.python.filepath.Permissions
  twisted.python.filepath.Permissions.html
  Class
  Class
  PUBLIC
  A class representing read/write/execute permissions. Instantiate with any portion of the file's mode that includes the permission bits.
- twisted.python.filepath.Permissions.user
  twisted.python.filepath.Permissions.html#user
  Attribute
  Instance Variable
  PUBLIC
  User/Owner permissions
- twisted.python.filepath.Permissions.group
  twisted.python.filepath.Permissions.html#group
  Attribute
  Instance Variable
  PUBLIC
  Group permissions
- twisted.python.filepath.Permissions.other
  twisted.python.filepath.Permissions.html#other
  Attribute
  Instance Variable
  PUBLIC
  Other/World permissions
- twisted.python.filepath.Permissions.compareAttributes
  twisted.python.filepath.Permissions.html#compareAttributes
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.python.filepath.Permissions.__init__
  twisted.python.filepath.Permissions.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.filepath.Permissions.__repr__
  twisted.python.filepath.Permissions.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.filepath.Permissions.shorthand
  twisted.python.filepath.Permissions.html#shorthand
  Function
  Method
  PUBLIC
  Returns a short string representing the permission bits. Looks like what is printed by command line utilities such as 'ls -l' (e.g. 'rwx-wx--x')
- twisted.python.filepath._asFilesystemBytes
  twisted.python.filepath.html#_asFilesystemBytes
  Function
  Function
  PRIVATE
  Return `path` as a string of `bytes` suitable for use on this system's filesystem.
- twisted.python.filepath._asFilesystemText
  twisted.python.filepath.html#_asFilesystemText
  Function
  Function
  PRIVATE
  Return `path` as a string of `unicode` suitable for use on this system's filesystem.
- twisted.python.filepath._coerceToFilesystemEncoding
  twisted.python.filepath.html#_coerceToFilesystemEncoding
  Function
  Function
  PRIVATE
  Return a `newpath` that is suitable for joining to `path`.
- twisted.python.filepath.FilePath
  twisted.python.filepath.FilePath.html
  Class
  Class
  PUBLIC
  I am a path on the filesystem that only permits 'downwards' access.
- twisted.python.filepath.FilePath.alwaysCreate
  twisted.python.filepath.FilePath.html#alwaysCreate
  Attribute
  Instance Variable
  PUBLIC
  When opening this file, only succeed if the file does not already exist.
- twisted.python.filepath.FilePath.path
  twisted.python.filepath.FilePath.html#path
  Attribute
  Instance Variable
  PUBLIC
  The path from which 'downward' traversal is permitted.
- twisted.python.filepath.FilePath._statinfo
  twisted.python.filepath.FilePath.html#_statinfo
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.python.filepath.FilePath.__init__
  twisted.python.filepath.FilePath.html#__init__
  Function
  Method
  PUBLIC
  Convert a path string to an absolute path if necessary and initialize the `FilePath` with the result.
- twisted.python.filepath.FilePath.__getstate__
  twisted.python.filepath.FilePath.html#__getstate__
  Function
  Method
  PUBLIC
  Support serialization by discarding cached `os.stat` results and returning everything else.
- twisted.python.filepath.FilePath.sep
  twisted.python.filepath.FilePath.html#sep
  Attribute
  Property
  PUBLIC
  Return a filesystem separator.
- twisted.python.filepath.FilePath._asBytesPath
  twisted.python.filepath.FilePath.html#_asBytesPath
  Function
  Method
  PRIVATE
  Return the path of this `FilePath` as bytes.
- twisted.python.filepath.FilePath._asTextPath
  twisted.python.filepath.FilePath.html#_asTextPath
  Function
  Method
  PRIVATE
  Return the path of this `FilePath` as text.
- twisted.python.filepath.FilePath.asBytesMode
  twisted.python.filepath.FilePath.html#asBytesMode
  Function
  Method
  PUBLIC
  Return this `FilePath` in `bytes`-mode.
- twisted.python.filepath.FilePath.asTextMode
  twisted.python.filepath.FilePath.html#asTextMode
  Function
  Method
  PUBLIC
  Return this `FilePath` in `unicode`-mode.
- twisted.python.filepath.FilePath._getPathAsSameTypeAs
  twisted.python.filepath.FilePath.html#_getPathAsSameTypeAs
  Function
  Method
  PRIVATE
  If `pattern` is `bytes`, return `FilePath.path` as `bytes`. Otherwise, return `FilePath.path` as `unicode`.
- twisted.python.filepath.FilePath.child
  twisted.python.filepath.FilePath.html#child
  Function
  Method
  PUBLIC
  Create and return a new `FilePath` representing a path contained by `self`.
- twisted.python.filepath.FilePath.preauthChild
  twisted.python.filepath.FilePath.html#preauthChild
  Function
  Method
  PUBLIC
  Use me if `path` might have slashes in it, but you know they're safe.
- twisted.python.filepath.FilePath.childSearchPreauth
  twisted.python.filepath.FilePath.html#childSearchPreauth
  Function
  Method
  PUBLIC
  Return my first existing child with a name in `paths`.
- twisted.python.filepath.FilePath.siblingExtensionSearch
  twisted.python.filepath.FilePath.html#siblingExtensionSearch
  Function
  Method
  PUBLIC
  Attempt to return a path with my name, given multiple possible extensions.
- twisted.python.filepath.FilePath.realpath
  twisted.python.filepath.FilePath.html#realpath
  Function
  Method
  PUBLIC
  Returns the absolute target as a `FilePath` if self is a link, self otherwise.
- twisted.python.filepath.FilePath.siblingExtension
  twisted.python.filepath.FilePath.html#siblingExtension
  Function
  Method
  PUBLIC
  Attempt to return a path with my name, given the extension at `ext`.
- twisted.python.filepath.FilePath.linkTo
  twisted.python.filepath.FilePath.html#linkTo
  Function
  Method
  PUBLIC
  Creates a symlink to self to at the path in the `FilePath` `linkFilePath`.
- twisted.python.filepath.FilePath.open
  twisted.python.filepath.FilePath.html#open
  Function
  Method
  PUBLIC
  Open this file using `mode` or for writing if `alwaysCreate` is `True`.
- twisted.python.filepath.FilePath.restat
  twisted.python.filepath.FilePath.html#restat
  Function
  Method
  PUBLIC
  Re-calculate cached effects of 'stat'. To refresh information on this path after you know the filesystem may have changed, call this method.
- twisted.python.filepath.FilePath.changed
  twisted.python.filepath.FilePath.html#changed
  Function
  Method
  PUBLIC
  Clear any cached information about the state of this path on disk.
- twisted.python.filepath.FilePath.chmod
  twisted.python.filepath.FilePath.html#chmod
  Function
  Method
  PUBLIC
  Changes the permissions on self, if possible. Propagates errors from `os.chmod` up.
- twisted.python.filepath.FilePath.getsize
  twisted.python.filepath.FilePath.html#getsize
  Function
  Method
  PUBLIC
  Retrieve the size of this file in bytes.
- twisted.python.filepath.FilePath.getModificationTime
  twisted.python.filepath.FilePath.html#getModificationTime
  Function
  Method
  PUBLIC
  Retrieve the time of last access from this file.
- twisted.python.filepath.FilePath.getStatusChangeTime
  twisted.python.filepath.FilePath.html#getStatusChangeTime
  Function
  Method
  PUBLIC
  Retrieve the time of the last status change for this file.
- twisted.python.filepath.FilePath.getAccessTime
  twisted.python.filepath.FilePath.html#getAccessTime
  Function
  Method
  PUBLIC
  Retrieve the time that this file was last accessed.
- twisted.python.filepath.FilePath.getInodeNumber
  twisted.python.filepath.FilePath.html#getInodeNumber
  Function
  Method
  PUBLIC
  Retrieve the file serial number, also called inode number, which distinguishes this file from all other files on the same device.
- twisted.python.filepath.FilePath.getDevice
  twisted.python.filepath.FilePath.html#getDevice
  Function
  Method
  PUBLIC
  Retrieves the device containing the file. The inode number and device number together uniquely identify the file, but the device number is not necessarily consistent across reboots or system crashes.
- twisted.python.filepath.FilePath.getNumberOfHardLinks
  twisted.python.filepath.FilePath.html#getNumberOfHardLinks
  Function
  Method
  PUBLIC
  Retrieves the number of hard links to the file.
- twisted.python.filepath.FilePath.getUserID
  twisted.python.filepath.FilePath.html#getUserID
  Function
  Method
  PUBLIC
  Returns the user ID of the file's owner.
- twisted.python.filepath.FilePath.getGroupID
  twisted.python.filepath.FilePath.html#getGroupID
  Function
  Method
  PUBLIC
  Returns the group ID of the file.
- twisted.python.filepath.FilePath.getPermissions
  twisted.python.filepath.FilePath.html#getPermissions
  Function
  Method
  PUBLIC
  Returns the permissions of the file. Should also work on Windows, however, those permissions may not be what is expected in Windows.
- twisted.python.filepath.FilePath.exists
  twisted.python.filepath.FilePath.html#exists
  Function
  Method
  PUBLIC
  Check if this `FilePath` exists.
- twisted.python.filepath.FilePath.isdir
  twisted.python.filepath.FilePath.html#isdir
  Function
  Method
  PUBLIC
  Check if this `FilePath` refers to a directory.
- twisted.python.filepath.FilePath.isfile
  twisted.python.filepath.FilePath.html#isfile
  Function
  Method
  PUBLIC
  Check if this file path refers to a regular file.
- twisted.python.filepath.FilePath.isBlockDevice
  twisted.python.filepath.FilePath.html#isBlockDevice
  Function
  Method
  PUBLIC
  Returns whether the underlying path is a block device.
- twisted.python.filepath.FilePath.isSocket
  twisted.python.filepath.FilePath.html#isSocket
  Function
  Method
  PUBLIC
  Returns whether the underlying path is a socket.
- twisted.python.filepath.FilePath.islink
  twisted.python.filepath.FilePath.html#islink
  Function
  Method
  PUBLIC
  Check if this `FilePath` points to a symbolic link.
- twisted.python.filepath.FilePath.isabs
  twisted.python.filepath.FilePath.html#isabs
  Function
  Method
  PUBLIC
  Check if this `FilePath` refers to an absolute path.
- twisted.python.filepath.FilePath.listdir
  twisted.python.filepath.FilePath.html#listdir
  Function
  Method
  PUBLIC
  List the base names of the direct children of this `FilePath`.
- twisted.python.filepath.FilePath.splitext
  twisted.python.filepath.FilePath.html#splitext
  Function
  Method
  PUBLIC
  Split the file path into a pair `(root, ext)` such that `root + ext == path`.
- twisted.python.filepath.FilePath.__repr__
  twisted.python.filepath.FilePath.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.filepath.FilePath.touch
  twisted.python.filepath.FilePath.html#touch
  Function
  Method
  PUBLIC
  Updates the access and last modification times of the file at this file path to the current time. Also creates the file if it does not already exist.
- twisted.python.filepath.FilePath.remove
  twisted.python.filepath.FilePath.html#remove
  Function
  Method
  PUBLIC
  Removes the file or directory that is represented by self. If `self.path` is a directory, recursively remove all its children before removing the directory. If it's a file or link, just delete it.
- twisted.python.filepath.FilePath.makedirs
  twisted.python.filepath.FilePath.html#makedirs
  Function
  Method
  PUBLIC
  Create all directories not yet existing in `path` segments, using `os.makedirs`.
- twisted.python.filepath.FilePath.globChildren
  twisted.python.filepath.FilePath.html#globChildren
  Function
  Method
  PUBLIC
  Assuming I am representing a directory, return a list of FilePaths representing my children that match the given pattern.
- twisted.python.filepath.FilePath.basename
  twisted.python.filepath.FilePath.html#basename
  Function
  Method
  PUBLIC
  Retrieve the final component of the file path's path (everything after the final path separator).
- twisted.python.filepath.FilePath.dirname
  twisted.python.filepath.FilePath.html#dirname
  Function
  Method
  PUBLIC
  Retrieve all of the components of the `FilePath`'s path except the last one (everything up to the final path separator).
- twisted.python.filepath.FilePath.parent
  twisted.python.filepath.FilePath.html#parent
  Function
  Method
  PUBLIC
  A file path for the directory containing the file at this file path.
- twisted.python.filepath.FilePath.setContent
  twisted.python.filepath.FilePath.html#setContent
  Function
  Method
  PUBLIC
  Replace the file at this path with a new file that contains the given bytes, trying to avoid data-loss in the meanwhile.
- twisted.python.filepath.FilePath.__cmp__
  twisted.python.filepath.FilePath.html#__cmp__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.filepath.FilePath.createDirectory
  twisted.python.filepath.FilePath.html#createDirectory
  Function
  Method
  PUBLIC
  Create the directory the `FilePath` refers to.
- twisted.python.filepath.FilePath.requireCreate
  twisted.python.filepath.FilePath.html#requireCreate
  Function
  Method
  PUBLIC
  Sets the `alwaysCreate` variable.
- twisted.python.filepath.FilePath.create
  twisted.python.filepath.FilePath.html#create
  Function
  Method
  PUBLIC
  Exclusively create a file, only if this file previously did not exist.
- twisted.python.filepath.FilePath.temporarySibling
  twisted.python.filepath.FilePath.html#temporarySibling
  Function
  Method
  PUBLIC
  Construct a path referring to a sibling of this path.
- twisted.python.filepath.FilePath._chunkSize
  twisted.python.filepath.FilePath.html#_chunkSize
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.python.filepath.FilePath.copyTo
  twisted.python.filepath.FilePath.html#copyTo
  Function
  Method
  PUBLIC
  Copies self to destination.
- twisted.python.filepath.FilePath.moveTo
  twisted.python.filepath.FilePath.html#moveTo
  Function
  Method
  PUBLIC
  Move self to destination - basically renaming self to whatever destination is named.
- twisted.internet.address.IPv4Address
  twisted.internet.address.IPv4Address.html
  Class
  Class
  PUBLIC
  An `IPv4Address` represents the address of an IPv4 socket endpoint.
- twisted.internet.address.IPv4Address.type
  twisted.internet.address.IPv4Address.html#type
  Attribute
  Instance Variable
  PUBLIC
  A string describing the type of transport, either 'TCP' or 'UDP'.
- twisted.internet.address.IPv4Address.host
  twisted.internet.address.IPv4Address.html#host
  Attribute
  Instance Variable
  PUBLIC
  A string containing a dotted-quad IPv4 address; for example, "127.0.0.1".
- twisted.internet.address.IPv4Address.port
  twisted.internet.address.IPv4Address.html#port
  Attribute
  Instance Variable
  PUBLIC
  An integer representing the port number.
- twisted.internet.address.IPv6Address
  twisted.internet.address.IPv6Address.html
  Class
  Class
  PUBLIC
  An `IPv6Address` represents the address of an IPv6 socket endpoint.
- twisted.internet.address.IPv6Address.type
  twisted.internet.address.IPv6Address.html#type
  Attribute
  Instance Variable
  PUBLIC
  A string describing the type of transport, either 'TCP' or 'UDP'.
- twisted.internet.address.IPv6Address.host
  twisted.internet.address.IPv6Address.html#host
  Attribute
  Instance Variable
  PUBLIC
  A string containing a colon-separated, hexadecimal formatted IPv6 address; for example, "::1".
- twisted.internet.address.IPv6Address.port
  twisted.internet.address.IPv6Address.html#port
  Attribute
  Instance Variable
  PUBLIC
  An integer representing the port number.
- twisted.internet.address.IPv6Address.flowInfo
  twisted.internet.address.IPv6Address.html#flowInfo
  Attribute
  Instance Variable
  PUBLIC
  the IPv6 flow label. This can be used by QoS routers to identify flows of traffic; you may generally safely ignore it.
- twisted.internet.address.IPv6Address.scopeID
  twisted.internet.address.IPv6Address.html#scopeID
  Attribute
  Instance Variable
  PUBLIC
  the IPv6 scope identifier - roughly analagous to what interface traffic destined for this address must be transmitted over.
- twisted.internet.address._ProcessAddress
  twisted.internet.address._ProcessAddress.html
  Class
  Class
  PRIVATE
  An `interfaces.IAddress` provider for process transports.
- twisted.internet.address.HostnameAddress
  twisted.internet.address.HostnameAddress.html
  Class
  Class
  PUBLIC
  A `HostnameAddress` represents the address of a `HostnameEndpoint`.
- twisted.internet.address.HostnameAddress.hostname
  twisted.internet.address.HostnameAddress.html#hostname
  Attribute
  Instance Variable
  PUBLIC
  A hostname byte string; for example, b"example.com".
- twisted.internet.address.HostnameAddress.port
  twisted.internet.address.HostnameAddress.html#port
  Attribute
  Instance Variable
  PUBLIC
  An integer representing the port number.
- twisted.internet.address.UNIXAddress
  twisted.internet.address.UNIXAddress.html
  Class
  Class
  PUBLIC
  Object representing a UNIX socket endpoint.
- twisted.internet.address.UNIXAddress.name
  twisted.internet.address.UNIXAddress.html#name
  Attribute
  Instance Variable
  PUBLIC
  The filename associated with this socket.
- twisted.internet.address.UNIXAddress.__eq__
  twisted.internet.address.UNIXAddress.html#__eq__
  Function
  Method
  PUBLIC
  Overriding `attrs` to ensure the os level samefile check is done if the name attributes do not match.
- twisted.internet.address.UNIXAddress.__repr__
  twisted.internet.address.UNIXAddress.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.address.UNIXAddress.__hash__
  twisted.internet.address.UNIXAddress.html#__hash__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.address._ServerFactoryIPv4Address
  twisted.internet.address._ServerFactoryIPv4Address.html
  Class
  Class
  PRIVATE
  Backwards compatibility hack. Just like IPv4Address in practice.
- twisted.internet.address._ServerFactoryIPv4Address.__eq__
  twisted.internet.address._ServerFactoryIPv4Address.html#__eq__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.lockfile.unique
  twisted.python.lockfile.html#unique
  Function
  Function
  PUBLIC
  Undocumented
- twisted.python.lockfile._windows
  twisted.python.lockfile.html#_windows
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.python.lockfile.FilesystemLock
  twisted.python.lockfile.FilesystemLock.html
  Class
  Class
  PUBLIC
  A mutex.
- twisted.python.lockfile.FilesystemLock.name
  twisted.python.lockfile.FilesystemLock.html#name
  Attribute
  Instance Variable
  PUBLIC
  The name of the file associated with this lock.
- twisted.python.lockfile.FilesystemLock.clean
  twisted.python.lockfile.FilesystemLock.html#clean
  Attribute
  Instance Variable
  PUBLIC
  Indicates whether this lock was released cleanly by its last owner. Only meaningful after `lock` has been called and returns True.
- twisted.python.lockfile.FilesystemLock.locked
  twisted.python.lockfile.FilesystemLock.html#locked
  Attribute
  Instance Variable
  PUBLIC
  Indicates whether the lock is currently held by this object.
- twisted.python.lockfile.FilesystemLock.__init__
  twisted.python.lockfile.FilesystemLock.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.lockfile.FilesystemLock.lock
  twisted.python.lockfile.FilesystemLock.html#lock
  Function
  Method
  PUBLIC
  Acquire this lock.
- twisted.python.lockfile.FilesystemLock.unlock
  twisted.python.lockfile.FilesystemLock.html#unlock
  Function
  Method
  PUBLIC
  Release this lock.
- twisted.python.lockfile.isLocked
  twisted.python.lockfile.html#isLocked
  Function
  Function
  PUBLIC
  Determine if the lock of the given name is held or not.
- twisted.internet.defer._contextvarsSupport
  twisted.internet.defer.html#_contextvarsSupport
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.internet.defer.log
  twisted.internet.defer.html#log
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.internet.defer._T
  twisted.internet.defer.html#_T
  Attribute
  Type Variable
  PRIVATE
  Undocumented
- twisted.internet.defer.AlreadyCalledError
  twisted.internet.defer.AlreadyCalledError.html
  Class
  Exception
  PUBLIC
  This error is raised when one of `Deferred.callback` or `Deferred.errback` is called after one of the two had already been called.
- twisted.internet.defer.CancelledError
  twisted.internet.defer.CancelledError.html
  Class
  Exception
  PUBLIC
  This error is raised by default when a `Deferred` is cancelled.
- twisted.internet.defer.TimeoutError
  twisted.internet.defer.TimeoutError.html
  Class
  Exception
  PUBLIC
  This error is raised by default when a `Deferred` times out.
- twisted.internet.defer.NotACoroutineError
  twisted.internet.defer.NotACoroutineError.html
  Class
  Exception
  PUBLIC
  This error is raised when a coroutine is expected and something else is encountered.
- twisted.internet.defer.logError
  twisted.internet.defer.html#logError
  Function
  Function
  PUBLIC
  Log and return failure.
- twisted.internet.defer.succeed
  twisted.internet.defer.html#succeed
  Function
  Function
  PUBLIC
  Return a `Deferred` that has already had `.callback(result)` called.
- twisted.internet.defer.fail
  twisted.internet.defer.html#fail
  Function
  Function
  PUBLIC
  Return a `Deferred` that has already had `.errback(result)` called.
- twisted.internet.defer.execute
  twisted.internet.defer.html#execute
  Function
  Function
  PUBLIC
  Create a `Deferred` from a callable and arguments.
- twisted.internet.defer.maybeDeferred
  twisted.internet.defer.html#maybeDeferred
  Function
  Function
  PUBLIC
  Invoke a function that may or may not return a `Deferred`.
- twisted.internet.defer.timeout
  twisted.internet.defer.html#timeout
  Function
  Function
  PUBLIC
  Undocumented
- twisted.internet.defer.passthru
  twisted.internet.defer.html#passthru
  Function
  Function
  PUBLIC
  Undocumented
- twisted.internet.defer._failthru
  twisted.internet.defer.html#_failthru
  Function
  Function
  PRIVATE
  Undocumented
- twisted.internet.defer.setDebugging
  twisted.internet.defer.html#setDebugging
  Function
  Function
  PUBLIC
  Enable or disable `Deferred` debugging.
- twisted.internet.defer.getDebugging
  twisted.internet.defer.html#getDebugging
  Function
  Function
  PUBLIC
  Determine whether `Deferred` debugging is enabled.
- twisted.internet.defer._cancelledToTimedOutError
  twisted.internet.defer.html#_cancelledToTimedOutError
  Function
  Function
  PRIVATE
  A default translation function that translates `Failure`s that are `CancelledError`s to `TimeoutError`s.
- twisted.internet.defer._Sentinel
  twisted.internet.defer._Sentinel.html
  Class
  Class
  PRIVATE
  No summary
- twisted.internet.defer._Sentinel._NO_RESULT
  twisted.internet.defer._Sentinel.html#_NO_RESULT
  Attribute
  Constant
  PRIVATE
  The result used to represent the fact that there is no result. Never ever ever use this as an actual result for a Deferred. You have been warned.
- twisted.internet.defer._Sentinel._CONTINUE
  twisted.internet.defer._Sentinel.html#_CONTINUE
  Attribute
  Constant
  PRIVATE
  A marker left in `Deferred.callback`s to indicate a Deferred chain. Always accompanied by a Deferred instance in the args tuple pointing at the Deferred which is chained to the Deferred which has this marker.
- twisted.internet.defer.DeferredCallback
  twisted.internet.defer.html#DeferredCallback
  Attribute
  Type Alias
  PUBLIC
  Undocumented
- twisted.internet.defer.DeferredErrback
  twisted.internet.defer.html#DeferredErrback
  Attribute
  Type Alias
  PUBLIC
  Undocumented
- twisted.internet.defer._CallbackOrderedArguments
  twisted.internet.defer.html#_CallbackOrderedArguments
  Attribute
  Type Alias
  PRIVATE
  Undocumented
- twisted.internet.defer._CallbackKeywordArguments
  twisted.internet.defer.html#_CallbackKeywordArguments
  Attribute
  Type Alias
  PRIVATE
  Undocumented
- twisted.internet.defer._CallbackChain
  twisted.internet.defer.html#_CallbackChain
  Attribute
  Type Alias
  PRIVATE
  Undocumented
- twisted.internet.defer._NONE_KWARGS
  twisted.internet.defer.html#_NONE_KWARGS
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.internet.defer._DeferredResultT
  twisted.internet.defer.html#_DeferredResultT
  Attribute
  Type Variable
  PRIVATE
  Undocumented
- twisted.internet.defer._NextDeferredResultT
  twisted.internet.defer.html#_NextDeferredResultT
  Attribute
  Type Variable
  PRIVATE
  Undocumented
- twisted.internet.defer.DebugInfo
  twisted.internet.defer.DebugInfo.html
  Class
  Class
  PUBLIC
  Deferred debug helper.
- twisted.internet.defer.DebugInfo.failResult
  twisted.internet.defer.DebugInfo.html#failResult
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet.defer.DebugInfo.creator
  twisted.internet.defer.DebugInfo.html#creator
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet.defer.DebugInfo.invoker
  twisted.internet.defer.DebugInfo.html#invoker
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet.defer.DebugInfo._getDebugTracebacks
  twisted.internet.defer.DebugInfo.html#_getDebugTracebacks
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet.defer.DebugInfo.__del__
  twisted.internet.defer.DebugInfo.html#__del__
  Function
  Method
  PUBLIC
  Print tracebacks and die.
- twisted.internet.defer.Deferred
  twisted.internet.defer.Deferred.html
  Class
  Class
  PUBLIC
  This is a callback which will be put off until later.
- twisted.internet.defer.Deferred.called
  twisted.internet.defer.Deferred.html#called
  Attribute
  Instance Variable
  PUBLIC
  A flag which is `False` until either `callback` or `errback` is called and afterwards always `True`.
- twisted.internet.defer.Deferred.paused
  twisted.internet.defer.Deferred.html#paused
  Attribute
  Instance Variable
  PUBLIC
  A counter of how many unmatched `pause` calls have been made on this instance.
- twisted.internet.defer.Deferred._suppressAlreadyCalled
  twisted.internet.defer.Deferred.html#_suppressAlreadyCalled
  Attribute
  Instance Variable
  PRIVATE
  A flag used by the cancellation mechanism which is `True` if the Deferred has no canceller and has been cancelled, `False` otherwise. If `True`, it can be expected that `callback` or `errback` will eventually be called and the result should be silently discarded.
- twisted.internet.defer.Deferred._runningCallbacks
  twisted.internet.defer.Deferred.html#_runningCallbacks
  Attribute
  Instance Variable
  PRIVATE
  A flag which is `True` while this instance is executing its callback chain, used to stop recursive execution of `_runCallbacks`
- twisted.internet.defer.Deferred._chainedTo
  twisted.internet.defer.Deferred.html#_chainedTo
  Attribute
  Instance Variable
  PRIVATE
  If this `Deferred` is waiting for the result of another `Deferred`, this is a reference to the other Deferred. Otherwise, `None`.
- twisted.internet.defer.Deferred._debugInfo
  twisted.internet.defer.Deferred.html#_debugInfo
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.defer.Deferred.debug
  twisted.internet.defer.Deferred.html#debug
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet.defer.Deferred.__init__
  twisted.internet.defer.Deferred.html#__init__
  Function
  Method
  PUBLIC
  Initialize a `Deferred`.
- twisted.internet.defer.Deferred.callbacks
  twisted.internet.defer.Deferred.html#callbacks
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.defer.Deferred._canceller
  twisted.internet.defer.Deferred.html#_canceller
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.defer.Deferred.addCallbacks
  twisted.internet.defer.Deferred.html#addCallbacks
  Function
  Method
  PUBLIC
  Add a pair of callbacks (success and error) to this `Deferred`.
- twisted.internet.defer.Deferred.addCallback
  twisted.internet.defer.Deferred.html#addCallback
  Function
  Method
  PUBLIC
  Convenience method for adding just a callback.
- twisted.internet.defer.Deferred.addErrback
  twisted.internet.defer.Deferred.html#addErrback
  Function
  Method
  PUBLIC
  Convenience method for adding just an errback.
- twisted.internet.defer.Deferred.addBoth
  twisted.internet.defer.Deferred.html#addBoth
  Function
  Method
  PUBLIC
  Convenience method for adding a single callable as both a callback and an errback.
- twisted.internet.defer.Deferred.addTimeout
  twisted.internet.defer.Deferred.html#addTimeout
  Function
  Method
  PUBLIC
  Time out this `Deferred` by scheduling it to be cancelled after `timeout` seconds.
- twisted.internet.defer.Deferred.chainDeferred
  twisted.internet.defer.Deferred.html#chainDeferred
  Function
  Method
  PUBLIC
  Chain another `Deferred` to this `Deferred`.
- twisted.internet.defer.Deferred.callback
  twisted.internet.defer.Deferred.html#callback
  Function
  Method
  PUBLIC
  Run all success callbacks that have been added to this `Deferred`.
- twisted.internet.defer.Deferred.errback
  twisted.internet.defer.Deferred.html#errback
  Function
  Method
  PUBLIC
  Run all error callbacks that have been added to this `Deferred`.
- twisted.internet.defer.Deferred.pause
  twisted.internet.defer.Deferred.html#pause
  Function
  Method
  PUBLIC
  Stop processing on a `Deferred` until `unpause`() is called.
- twisted.internet.defer.Deferred.unpause
  twisted.internet.defer.Deferred.html#unpause
  Function
  Method
  PUBLIC
  Process all callbacks made since `pause`() was called.
- twisted.internet.defer.Deferred.cancel
  twisted.internet.defer.Deferred.html#cancel
  Function
  Method
  PUBLIC
  Cancel this `Deferred`.
- twisted.internet.defer.Deferred._startRunCallbacks
  twisted.internet.defer.Deferred.html#_startRunCallbacks
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet.defer.Deferred.result
  twisted.internet.defer.Deferred.html#result
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.defer.Deferred._continuation
  twisted.internet.defer.Deferred.html#_continuation
  Function
  Method
  PRIVATE
  Build a tuple of callback and errback with `_Sentinel._CONTINUE`.
- twisted.internet.defer.Deferred._runCallbacks
  twisted.internet.defer.Deferred.html#_runCallbacks
  Function
  Method
  PRIVATE
  Run the chain of callbacks once a result is available.
- twisted.internet.defer.Deferred.__str__
  twisted.internet.defer.Deferred.html#__str__
  Function
  Method
  PUBLIC
  Return a string representation of this `Deferred`.
- twisted.internet.defer.Deferred.__iter__
  twisted.internet.defer.Deferred.html#__iter__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.defer.Deferred.send
  twisted.internet.defer.Deferred.html#send
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.defer.Deferred.__await__
  twisted.internet.defer.Deferred.html#__await__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.defer.Deferred.asFuture
  twisted.internet.defer.Deferred.html#asFuture
  Function
  Method
  PUBLIC
  Adapt this `Deferred` into a `Future` which is bound to `loop`.
- twisted.internet.defer.Deferred.fromFuture
  twisted.internet.defer.Deferred.html#fromFuture
  Function
  Class Method
  PUBLIC
  Adapt a `Future` to a `Deferred`.
- twisted.internet.defer.Deferred.fromCoroutine
  twisted.internet.defer.Deferred.html#fromCoroutine
  Function
  Class Method
  PUBLIC
  Schedule the execution of a coroutine that awaits on `Deferred`s, wrapping it in a `Deferred` that will fire on success/failure of the coroutine.
- twisted.internet.defer.ensureDeferred
  twisted.internet.defer.html#ensureDeferred
  Function
  Function
  PUBLIC
  Schedule the execution of a coroutine that awaits/yields from `Deferred`s, wrapping it in a `Deferred` that will fire on success/failure of the coroutine. If a Deferred is passed to this function, it will be returned directly (mimicing the ...
- twisted.internet.defer.FirstError
  twisted.internet.defer.FirstError.html
  Class
  Exception
  PUBLIC
  First error to occur in a `DeferredList` if `fireOnOneErrback` is set.
- twisted.internet.defer.FirstError.subFailure
  twisted.internet.defer.FirstError.html#subFailure
  Attribute
  Instance Variable
  PUBLIC
  The `Failure` that occurred.
- twisted.internet.defer.FirstError.index
  twisted.internet.defer.FirstError.html#index
  Attribute
  Instance Variable
  PUBLIC
  The index of the `Deferred` in the `DeferredList` where it happened.
- twisted.internet.defer.FirstError.__init__
  twisted.internet.defer.FirstError.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.defer.FirstError.__repr__
  twisted.internet.defer.FirstError.html#__repr__
  Function
  Method
  PUBLIC
  The repr of `FirstError` instances includes the repr of the wrapped failure's exception and the index of the `FirstError`.
- twisted.internet.defer.FirstError.__str__
  twisted.internet.defer.FirstError.html#__str__
  Function
  Method
  PUBLIC
  The str of `FirstError` instances includes the str of the entire wrapped failure (including its traceback and exception) and the index of the `FirstError`.
- twisted.internet.defer.FirstError.__cmp__
  twisted.internet.defer.FirstError.html#__cmp__
  Function
  Method
  PUBLIC
  Comparison between `FirstError` and other `FirstError` instances is defined as the comparison of the index and sub-failure of each instance. `FirstError` instances don't compare equal to anything that isn't a ...
- twisted.internet.defer._DeferredListSingleResultT
  twisted.internet.defer.html#_DeferredListSingleResultT
  Attribute
  Type Alias
  PRIVATE
  Undocumented
- twisted.internet.defer._DeferredListResultItemT
  twisted.internet.defer.html#_DeferredListResultItemT
  Attribute
  Type Alias
  PRIVATE
  Undocumented
- twisted.internet.defer._DeferredListResultListT
  twisted.internet.defer.html#_DeferredListResultListT
  Attribute
  Type Alias
  PRIVATE
  Undocumented
- twisted.internet.defer._DeferredList 0
  twisted.internet.defer.html#_DeferredList%200
  Function
  Function
  PRIVATE
  Undocumented
- twisted.internet.defer._DeferredList 1
  twisted.internet.defer.html#_DeferredList%201
  Function
  Function
  PRIVATE
  Undocumented
- twisted.internet.defer._DeferredList
  twisted.internet.defer.html#_DeferredList
  Function
  Function
  PRIVATE
  Undocumented
- twisted.internet.defer.DeferredList
  twisted.internet.defer.DeferredList.html
  Class
  Class
  PUBLIC
  `DeferredList` is a tool for collecting the results of several Deferreds.
- twisted.internet.defer.DeferredList._deferredList
  twisted.internet.defer.DeferredList.html#_deferredList
  Attribute
  Instance Variable
  PRIVATE
  The `list` of `Deferred`s to track.
- twisted.internet.defer.DeferredList.fireOnOneCallback
  twisted.internet.defer.DeferredList.html#fireOnOneCallback
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.defer.DeferredList.fireOnOneErrback
  twisted.internet.defer.DeferredList.html#fireOnOneErrback
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.defer.DeferredList.__init__
  twisted.internet.defer.DeferredList.html#__init__
  Function
  Method
  PUBLIC
  Initialize a DeferredList.
- twisted.internet.defer.DeferredList.resultList
  twisted.internet.defer.DeferredList.html#resultList
  Attribute
  Instance Variable
  PUBLIC
  The final result, in progress. Each item in the list corresponds to the `Deferred` at the same position in `_deferredList`. It will be `None` if the `Deferred` did not complete yet, or a `(success, result)` pair if it did.
- twisted.internet.defer.DeferredList.consumeErrors
  twisted.internet.defer.DeferredList.html#consumeErrors
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.defer.DeferredList.finishedCount
  twisted.internet.defer.DeferredList.html#finishedCount
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.defer.DeferredList._cbDeferred
  twisted.internet.defer.DeferredList.html#_cbDeferred
  Function
  Method
  PRIVATE
  (internal) Callback for when one of my deferreds fires.
- twisted.internet.defer.DeferredList.cancel
  twisted.internet.defer.DeferredList.html#cancel
  Function
  Method
  PUBLIC
  Cancel this `DeferredList`.
- twisted.internet.defer._parseDeferredListResult
  twisted.internet.defer.html#_parseDeferredListResult
  Function
  Function
  PRIVATE
  Undocumented
- twisted.internet.defer.gatherResults
  twisted.internet.defer.html#gatherResults
  Function
  Function
  PUBLIC
  Returns, via a `Deferred`, a list with the results of the given `Deferred`s - in effect, a "join" of multiple deferred operations.
- twisted.internet.defer.SUCCESS
  twisted.internet.defer.html#SUCCESS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.defer.FAILURE
  twisted.internet.defer.html#FAILURE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.defer.waitForDeferred
  twisted.internet.defer.waitForDeferred.html
  Class
  Class
  PUBLIC
  See `deferredGenerator`.
- twisted.internet.defer.waitForDeferred.__init__
  twisted.internet.defer.waitForDeferred.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.defer.waitForDeferred.d
  twisted.internet.defer.waitForDeferred.html#d
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.defer.waitForDeferred.getResult
  twisted.internet.defer.waitForDeferred.html#getResult
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.defer._DeferableGenerator
  twisted.internet.defer.html#_DeferableGenerator
  Attribute
  Type Alias
  PRIVATE
  Undocumented
- twisted.internet.defer._deferGenerator
  twisted.internet.defer.html#_deferGenerator
  Function
  Function
  PRIVATE
  See `deferredGenerator`.
- twisted.internet.defer.deferredGenerator
  twisted.internet.defer.html#deferredGenerator
  Function
  Function
  PUBLIC
  `deferredGenerator` and `waitForDeferred` help you write `Deferred`-using code that looks like a regular sequential function. Consider the use of `inlineCallbacks` instead, which can accomplish the same thing in a more concise manner.
- twisted.internet.defer._DefGen_Return
  twisted.internet.defer._DefGen_Return.html
  Class
  Exception
  PRIVATE
  Undocumented
- twisted.internet.defer._DefGen_Return.__init__
  twisted.internet.defer._DefGen_Return.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.defer._DefGen_Return.value
  twisted.internet.defer._DefGen_Return.html#value
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.defer.returnValue
  twisted.internet.defer.html#returnValue
  Function
  Function
  PUBLIC
  Return val from a `inlineCallbacks` generator.
- twisted.internet.defer._CancellationStatus
  twisted.internet.defer._CancellationStatus.html
  Class
  Class
  PRIVATE
  Cancellation status of an `inlineCallbacks` invocation.
- twisted.internet.defer._CancellationStatus.deferred
  twisted.internet.defer._CancellationStatus.html#deferred
  Attribute
  Instance Variable
  PUBLIC
  the `Deferred` to callback or errback when the generator invocation has finished.
- twisted.internet.defer._CancellationStatus.waitingOn
  twisted.internet.defer._CancellationStatus.html#waitingOn
  Attribute
  Instance Variable
  PUBLIC
  the `Deferred` being waited upon (which `_inlineCallbacks` must fill out before returning)
- twisted.internet.defer._inlineCallbacks
  twisted.internet.defer.html#_inlineCallbacks
  Function
  Function
  PRIVATE
  Carry out the work of `inlineCallbacks`.
- twisted.internet.defer._cancellableInlineCallbacks
  twisted.internet.defer.html#_cancellableInlineCallbacks
  Function
  Function
  PRIVATE
  Make an `@``inlineCallbacks` cancellable.
- twisted.internet.defer._InternalInlineCallbacksCancelledError
  twisted.internet.defer._InternalInlineCallbacksCancelledError.html
  Class
  Exception
  PRIVATE
  A unique exception used only in `_cancellableInlineCallbacks` to verify that an `inlineCallbacks` is being cancelled as expected.
- twisted.internet.defer.inlineCallbacks
  twisted.internet.defer.html#inlineCallbacks
  Function
  Function
  PUBLIC
  `inlineCallbacks` helps you write `Deferred`-using code that looks like a regular sequential function. For example:
- twisted.internet.defer._ConcurrencyPrimitiveT
  twisted.internet.defer.html#_ConcurrencyPrimitiveT
  Attribute
  Type Variable
  PRIVATE
  Undocumented
- twisted.internet.defer._ConcurrencyPrimitive
  twisted.internet.defer._ConcurrencyPrimitive.html
  Class
  Class
  PRIVATE
  No class docstring; 0/1 instance variable, 2/7 methods documented
- twisted.internet.defer._ConcurrencyPrimitive.__init__
  twisted.internet.defer._ConcurrencyPrimitive.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.defer._ConcurrencyPrimitive.waiting
  twisted.internet.defer._ConcurrencyPrimitive.html#waiting
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.defer._ConcurrencyPrimitive._releaseAndReturn
  twisted.internet.defer._ConcurrencyPrimitive.html#_releaseAndReturn
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet.defer._ConcurrencyPrimitive.run
  twisted.internet.defer._ConcurrencyPrimitive.html#run
  Function
  Method
  PUBLIC
  Acquire, run, release.
- twisted.internet.defer._ConcurrencyPrimitive.__aenter__
  twisted.internet.defer._ConcurrencyPrimitive.html#__aenter__
  Function
  Method
  PUBLIC
  We can be used as an asynchronous context manager.
- twisted.internet.defer._ConcurrencyPrimitive.__aexit__
  twisted.internet.defer._ConcurrencyPrimitive.html#__aexit__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.defer._ConcurrencyPrimitive.acquire
  twisted.internet.defer._ConcurrencyPrimitive.html#acquire
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.defer._ConcurrencyPrimitive.release
  twisted.internet.defer._ConcurrencyPrimitive.html#release
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.defer._DeferredLockT
  twisted.internet.defer.html#_DeferredLockT
  Attribute
  Type Variable
  PRIVATE
  Undocumented
- twisted.internet.defer.DeferredLock
  twisted.internet.defer.DeferredLock.html
  Class
  Class
  PUBLIC
  A lock for event driven systems.
- twisted.internet.defer.DeferredLock.locked
  twisted.internet.defer.DeferredLock.html#locked
  Attribute
  Instance Variable
  PUBLIC
  `True` when this Lock has been acquired, false at all other times. Do not change this value, but it is useful to examine for the equivalent of a "non-blocking" acquisition.
- twisted.internet.defer.DeferredLock._cancelAcquire
  twisted.internet.defer.DeferredLock.html#_cancelAcquire
  Function
  Method
  PRIVATE
  Remove a deferred d from our waiting list, as the deferred has been canceled.
- twisted.internet.defer.DeferredLock.acquire
  twisted.internet.defer.DeferredLock.html#acquire
  Function
  Method
  PUBLIC
  Attempt to acquire the lock. Returns a `Deferred` that fires on lock acquisition with the `DeferredLock` as the value. If the lock is locked, then the Deferred is placed at the end of a waiting list.
- twisted.internet.defer.DeferredLock.release
  twisted.internet.defer.DeferredLock.html#release
  Function
  Method
  PUBLIC
  Release the lock. If there is a waiting list, then the first `Deferred` in that waiting list will be called back.
- twisted.internet.defer._DeferredSemaphoreT
  twisted.internet.defer.html#_DeferredSemaphoreT
  Attribute
  Type Variable
  PRIVATE
  Undocumented
- twisted.internet.defer.DeferredSemaphore
  twisted.internet.defer.DeferredSemaphore.html
  Class
  Class
  PUBLIC
  A semaphore for event driven systems.
- twisted.internet.defer.DeferredSemaphore.limit
  twisted.internet.defer.DeferredSemaphore.html#limit
  Attribute
  Instance Variable
  PUBLIC
  At most this many users may acquire this semaphore at once.
- twisted.internet.defer.DeferredSemaphore.tokens
  twisted.internet.defer.DeferredSemaphore.html#tokens
  Attribute
  Instance Variable
  PUBLIC
  The difference between `limit` and the number of users which have currently acquired this semaphore.
- twisted.internet.defer.DeferredSemaphore.__init__
  twisted.internet.defer.DeferredSemaphore.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.internet.defer.DeferredSemaphore._cancelAcquire
  twisted.internet.defer.DeferredSemaphore.html#_cancelAcquire
  Function
  Method
  PRIVATE
  Remove a deferred d from our waiting list, as the deferred has been canceled.
- twisted.internet.defer.DeferredSemaphore.acquire
  twisted.internet.defer.DeferredSemaphore.html#acquire
  Function
  Method
  PUBLIC
  Attempt to acquire the token.
- twisted.internet.defer.DeferredSemaphore.release
  twisted.internet.defer.DeferredSemaphore.html#release
  Function
  Method
  PUBLIC
  Release the token.
- twisted.internet.defer.QueueOverflow
  twisted.internet.defer.QueueOverflow.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.internet.defer.QueueUnderflow
  twisted.internet.defer.QueueUnderflow.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.internet.defer.DeferredQueue
  twisted.internet.defer.DeferredQueue.html
  Class
  Class
  PUBLIC
  An event driven queue.
- twisted.internet.defer.DeferredQueue.size
  twisted.internet.defer.DeferredQueue.html#size
  Attribute
  Instance Variable
  PUBLIC
  The maximum number of objects to allow into the queue at a time. When an attempt to add a new object would exceed this limit, `QueueOverflow` is raised synchronously. `None` for no limit.
- twisted.internet.defer.DeferredQueue.backlog
  twisted.internet.defer.DeferredQueue.html#backlog
  Attribute
  Instance Variable
  PUBLIC
  The maximum number of `Deferred` gets to allow at one time. When an attempt is made to get an object which would exceed this limit, `QueueUnderflow` is raised synchronously. `None` for no limit.
- twisted.internet.defer.DeferredQueue.__init__
  twisted.internet.defer.DeferredQueue.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.defer.DeferredQueue.waiting
  twisted.internet.defer.DeferredQueue.html#waiting
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.defer.DeferredQueue.pending
  twisted.internet.defer.DeferredQueue.html#pending
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.defer.DeferredQueue._cancelGet
  twisted.internet.defer.DeferredQueue.html#_cancelGet
  Function
  Method
  PRIVATE
  Remove a deferred d from our waiting list, as the deferred has been canceled.
- twisted.internet.defer.DeferredQueue.put
  twisted.internet.defer.DeferredQueue.html#put
  Function
  Method
  PUBLIC
  Add an object to this queue.
- twisted.internet.defer.DeferredQueue.get
  twisted.internet.defer.DeferredQueue.html#get
  Function
  Method
  PUBLIC
  Attempt to retrieve and remove an object from the queue.
- twisted.internet.defer.AlreadyTryingToLockError
  twisted.internet.defer.AlreadyTryingToLockError.html
  Class
  Exception
  PUBLIC
  Raised when `DeferredFilesystemLock.deferUntilLocked` is called twice on a single `DeferredFilesystemLock`.
- twisted.internet.defer.DeferredFilesystemLock
  twisted.internet.defer.DeferredFilesystemLock.html
  Class
  Class
  PUBLIC
  A `FilesystemLock` that allows for a `Deferred` to be fired when the lock is acquired.
- twisted.internet.defer.DeferredFilesystemLock._scheduler
  twisted.internet.defer.DeferredFilesystemLock.html#_scheduler
  Attribute
  Instance Variable
  PRIVATE
  The object in charge of scheduling retries. In this implementation this is parameterized for testing.
- twisted.internet.defer.DeferredFilesystemLock._interval
  twisted.internet.defer.DeferredFilesystemLock.html#_interval
  Attribute
  Instance Variable
  PRIVATE
  The retry interval for an `IReactorTime` based scheduler.
- twisted.internet.defer.DeferredFilesystemLock._tryLockCall
  twisted.internet.defer.DeferredFilesystemLock.html#_tryLockCall
  Attribute
  Instance Variable
  PRIVATE
  An `IDelayedCall` based on `_interval` that will manage the next retry for acquiring the lock.
- twisted.internet.defer.DeferredFilesystemLock._timeoutCall
  twisted.internet.defer.DeferredFilesystemLock.html#_timeoutCall
  Attribute
  Instance Variable
  PRIVATE
  An `IDelayedCall` based on `deferUntilLocked`'s timeout argument. This is in charge of timing out our attempt to acquire the lock.
- twisted.internet.defer.DeferredFilesystemLock.__init__
  twisted.internet.defer.DeferredFilesystemLock.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.internet.defer.DeferredFilesystemLock.deferUntilLocked
  twisted.internet.defer.DeferredFilesystemLock.html#deferUntilLocked
  Function
  Method
  PUBLIC
  Wait until we acquire this lock. This method is not safe for concurrent use.
- twisted.internet.protocol.Factory
  twisted.internet.protocol.Factory.html
  Class
  Class
  PUBLIC
  This is a factory which produces protocols.
- twisted.internet.protocol.Factory.protocol
  twisted.internet.protocol.Factory.html#protocol
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet.protocol.Factory.numPorts
  twisted.internet.protocol.Factory.html#numPorts
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.protocol.Factory.noisy
  twisted.internet.protocol.Factory.html#noisy
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet.protocol.Factory.forProtocol
  twisted.internet.protocol.Factory.html#forProtocol
  Function
  Class Method
  PUBLIC
  Create a factory for the given protocol.
- twisted.internet.protocol.Factory.logPrefix
  twisted.internet.protocol.Factory.html#logPrefix
  Function
  Method
  PUBLIC
  Describe this factory for log messages.
- twisted.internet.protocol.Factory.doStart
  twisted.internet.protocol.Factory.html#doStart
  Function
  Method
  PUBLIC
  Make sure startFactory is called.
- twisted.internet.protocol.Factory.doStop
  twisted.internet.protocol.Factory.html#doStop
  Function
  Method
  PUBLIC
  Make sure stopFactory is called.
- twisted.internet.protocol.Factory.startFactory
  twisted.internet.protocol.Factory.html#startFactory
  Function
  Method
  PUBLIC
  This will be called before I begin listening on a Port or Connector.
- twisted.internet.protocol.Factory.stopFactory
  twisted.internet.protocol.Factory.html#stopFactory
  Function
  Method
  PUBLIC
  This will be called before I stop listening on all Ports/Connectors.
- twisted.internet.protocol.Factory.buildProtocol
  twisted.internet.protocol.Factory.html#buildProtocol
  Function
  Method
  PUBLIC
  Create an instance of a subclass of Protocol.
- twisted.internet.protocol.ClientFactory
  twisted.internet.protocol.ClientFactory.html
  Class
  Class
  PUBLIC
  A Protocol factory for clients.
- twisted.internet.protocol.ClientFactory.startedConnecting
  twisted.internet.protocol.ClientFactory.html#startedConnecting
  Function
  Method
  PUBLIC
  Called when a connection has been started.
- twisted.internet.protocol.ClientFactory.clientConnectionFailed
  twisted.internet.protocol.ClientFactory.html#clientConnectionFailed
  Function
  Method
  PUBLIC
  Called when a connection has failed to connect.
- twisted.internet.protocol.ClientFactory.clientConnectionLost
  twisted.internet.protocol.ClientFactory.html#clientConnectionLost
  Function
  Method
  PUBLIC
  Called when an established connection is lost.
- twisted.internet.protocol._InstanceFactory
  twisted.internet.protocol._InstanceFactory.html
  Class
  Class
  PRIVATE
  Factory used by ClientCreator.
- twisted.internet.protocol._InstanceFactory.deferred
  twisted.internet.protocol._InstanceFactory.html#deferred
  Attribute
  Instance Variable
  PUBLIC
  The `Deferred` which represents this connection attempt and which will be fired when it succeeds or fails.
- twisted.internet.protocol._InstanceFactory.pending
  twisted.internet.protocol._InstanceFactory.html#pending
  Attribute
  Instance Variable
  PUBLIC
  After a connection attempt succeeds or fails, a delayed call which will fire the `Deferred` representing this connection attempt.
- twisted.internet.protocol._InstanceFactory.noisy
  twisted.internet.protocol._InstanceFactory.html#noisy
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet.protocol._InstanceFactory.__init__
  twisted.internet.protocol._InstanceFactory.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.protocol._InstanceFactory.reactor
  twisted.internet.protocol._InstanceFactory.html#reactor
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.protocol._InstanceFactory.instance
  twisted.internet.protocol._InstanceFactory.html#instance
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.protocol._InstanceFactory.__repr__
  twisted.internet.protocol._InstanceFactory.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.protocol._InstanceFactory.buildProtocol
  twisted.internet.protocol._InstanceFactory.html#buildProtocol
  Function
  Method
  PUBLIC
  Return the pre-constructed protocol instance and arrange to fire the waiting `Deferred` to indicate success establishing the connection.
- twisted.internet.protocol._InstanceFactory.clientConnectionFailed
  twisted.internet.protocol._InstanceFactory.html#clientConnectionFailed
  Function
  Method
  PUBLIC
  Arrange to fire the waiting `Deferred` with the given failure to indicate the connection could not be established.
- twisted.internet.protocol._InstanceFactory.fire
  twisted.internet.protocol._InstanceFactory.html#fire
  Function
  Method
  PUBLIC
  Clear `self.pending` to avoid a reference cycle and then invoke func with the value.
- twisted.internet.protocol.ClientCreator
  twisted.internet.protocol.ClientCreator.html
  Class
  Class
  PUBLIC
  Client connections that do not require a factory.
- twisted.internet.protocol.ClientCreator.__init__
  twisted.internet.protocol.ClientCreator.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.protocol.ClientCreator.reactor
  twisted.internet.protocol.ClientCreator.html#reactor
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.protocol.ClientCreator.protocolClass
  twisted.internet.protocol.ClientCreator.html#protocolClass
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.protocol.ClientCreator.args
  twisted.internet.protocol.ClientCreator.html#args
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.protocol.ClientCreator.kwargs
  twisted.internet.protocol.ClientCreator.html#kwargs
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.protocol.ClientCreator._connect
  twisted.internet.protocol.ClientCreator.html#_connect
  Function
  Method
  PRIVATE
  Initiate a connection attempt.
- twisted.internet.protocol.ClientCreator.connectTCP
  twisted.internet.protocol.ClientCreator.html#connectTCP
  Function
  Method
  PUBLIC
  Connect to a TCP server.
- twisted.internet.protocol.ClientCreator.connectUNIX
  twisted.internet.protocol.ClientCreator.html#connectUNIX
  Function
  Method
  PUBLIC
  Connect to a Unix socket.
- twisted.internet.protocol.ClientCreator.connectSSL
  twisted.internet.protocol.ClientCreator.html#connectSSL
  Function
  Method
  PUBLIC
  Connect to an SSL server.
- twisted.internet.protocol.ReconnectingClientFactory
  twisted.internet.protocol.ReconnectingClientFactory.html
  Class
  Class
  PUBLIC
  Factory which auto-reconnects clients with an exponential back-off.
- twisted.internet.protocol.ReconnectingClientFactory.maxDelay
  twisted.internet.protocol.ReconnectingClientFactory.html#maxDelay
  Attribute
  Instance Variable
  PUBLIC
  Maximum number of seconds between connection attempts.
- twisted.internet.protocol.ReconnectingClientFactory.initialDelay
  twisted.internet.protocol.ReconnectingClientFactory.html#initialDelay
  Attribute
  Instance Variable
  PUBLIC
  Delay for the first reconnection attempt.
- twisted.internet.protocol.ReconnectingClientFactory.factor
  twisted.internet.protocol.ReconnectingClientFactory.html#factor
  Attribute
  Instance Variable
  PUBLIC
  A multiplicitive factor by which the delay grows
- twisted.internet.protocol.ReconnectingClientFactory.jitter
  twisted.internet.protocol.ReconnectingClientFactory.html#jitter
  Attribute
  Instance Variable
  PUBLIC
  Percentage of randomness to introduce into the delay length to prevent stampeding.
- twisted.internet.protocol.ReconnectingClientFactory.clock
  twisted.internet.protocol.ReconnectingClientFactory.html#clock
  Attribute
  Instance Variable
  PUBLIC
  The clock used to schedule reconnection. It's mainly useful to be parametrized in tests. If the factory is serialized, this attribute will not be serialized, and the default value (the reactor) will be restored when deserialized.
- twisted.internet.protocol.ReconnectingClientFactory.maxRetries
  twisted.internet.protocol.ReconnectingClientFactory.html#maxRetries
  Attribute
  Instance Variable
  PUBLIC
  Maximum number of consecutive unsuccessful connection attempts, after which no further connection attempts will be made. If this is not explicitly set, no maximum is applied.
- twisted.internet.protocol.ReconnectingClientFactory.retries
  twisted.internet.protocol.ReconnectingClientFactory.html#retries
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.protocol.ReconnectingClientFactory._callID
  twisted.internet.protocol.ReconnectingClientFactory.html#_callID
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.protocol.ReconnectingClientFactory.connector
  twisted.internet.protocol.ReconnectingClientFactory.html#connector
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.protocol.ReconnectingClientFactory.continueTrying
  twisted.internet.protocol.ReconnectingClientFactory.html#continueTrying
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.protocol.ReconnectingClientFactory.clientConnectionFailed
  twisted.internet.protocol.ReconnectingClientFactory.html#clientConnectionFailed
  Function
  Method
  PUBLIC
  Called when a connection has failed to connect.
- twisted.internet.protocol.ReconnectingClientFactory.clientConnectionLost
  twisted.internet.protocol.ReconnectingClientFactory.html#clientConnectionLost
  Function
  Method
  PUBLIC
  Called when an established connection is lost.
- twisted.internet.protocol.ReconnectingClientFactory.retry
  twisted.internet.protocol.ReconnectingClientFactory.html#retry
  Function
  Method
  PUBLIC
  Have this connector connect again, after a suitable delay.
- twisted.internet.protocol.ReconnectingClientFactory.delay
  twisted.internet.protocol.ReconnectingClientFactory.html#delay
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.protocol.ReconnectingClientFactory.stopTrying
  twisted.internet.protocol.ReconnectingClientFactory.html#stopTrying
  Function
  Method
  PUBLIC
  Put a stop to any attempt to reconnect in progress.
- twisted.internet.protocol.ReconnectingClientFactory.resetDelay
  twisted.internet.protocol.ReconnectingClientFactory.html#resetDelay
  Function
  Method
  PUBLIC
  Call this method after a successful connection: it resets the delay and the retry counter.
- twisted.internet.protocol.ReconnectingClientFactory.__getstate__
  twisted.internet.protocol.ReconnectingClientFactory.html#__getstate__
  Function
  Method
  PUBLIC
  Remove all of the state which is mutated by connection attempts and failures, returning just the state which describes how reconnections should be attempted. This will make the unserialized instance behave just as this one did when it was first instantiated.
- twisted.internet.protocol.ServerFactory
  twisted.internet.protocol.ServerFactory.html
  Class
  Class
  PUBLIC
  Subclass this to indicate that your protocol.Factory is only usable for servers.
- twisted.internet.protocol.BaseProtocol
  twisted.internet.protocol.BaseProtocol.html
  Class
  Class
  PUBLIC
  This is the abstract superclass of all protocols.
- twisted.internet.protocol.BaseProtocol.connected
  twisted.internet.protocol.BaseProtocol.html#connected
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.protocol.BaseProtocol.transport
  twisted.internet.protocol.BaseProtocol.html#transport
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.protocol.BaseProtocol.makeConnection
  twisted.internet.protocol.BaseProtocol.html#makeConnection
  Function
  Method
  PUBLIC
  Make a connection to a transport and a server.
- twisted.internet.protocol.BaseProtocol.connectionMade
  twisted.internet.protocol.BaseProtocol.html#connectionMade
  Function
  Method
  PUBLIC
  Called when a connection is made.
- twisted.internet.protocol.connectionDone
  twisted.internet.protocol.html#connectionDone
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.internet.protocol.Protocol
  twisted.internet.protocol.Protocol.html
  Class
  Class
  PUBLIC
  This is the base class for streaming connection-oriented protocols.
- twisted.internet.protocol.Protocol.factory
  twisted.internet.protocol.Protocol.html#factory
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet.protocol.Protocol.logPrefix
  twisted.internet.protocol.Protocol.html#logPrefix
  Function
  Method
  PUBLIC
  Return a prefix matching the class name, to identify log messages related to this protocol instance.
- twisted.internet.protocol.Protocol.dataReceived
  twisted.internet.protocol.Protocol.html#dataReceived
  Function
  Method
  PUBLIC
  Called whenever data is received.
- twisted.internet.protocol.Protocol.connectionLost
  twisted.internet.protocol.Protocol.html#connectionLost
  Function
  Method
  PUBLIC
  Called when the connection is shut down.
- twisted.internet.protocol.ProtocolToConsumerAdapter
  twisted.internet.protocol.ProtocolToConsumerAdapter.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.internet.protocol.ProtocolToConsumerAdapter.write
  twisted.internet.protocol.ProtocolToConsumerAdapter.html#write
  Function
  Method
  PUBLIC
  The producer will write data by calling this method.
- twisted.internet.protocol.ProtocolToConsumerAdapter.registerProducer
  twisted.internet.protocol.ProtocolToConsumerAdapter.html#registerProducer
  Function
  Method
  PUBLIC
  Register to receive data from a producer.
- twisted.internet.protocol.ProtocolToConsumerAdapter.unregisterProducer
  twisted.internet.protocol.ProtocolToConsumerAdapter.html#unregisterProducer
  Function
  Method
  PUBLIC
  Stop consuming data from a producer, without disconnecting.
- twisted.internet.protocol.ConsumerToProtocolAdapter
  twisted.internet.protocol.ConsumerToProtocolAdapter.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.internet.protocol.ConsumerToProtocolAdapter.dataReceived
  twisted.internet.protocol.ConsumerToProtocolAdapter.html#dataReceived
  Function
  Method
  PUBLIC
  Called whenever data is received.
- twisted.internet.protocol.ConsumerToProtocolAdapter.connectionLost
  twisted.internet.protocol.ConsumerToProtocolAdapter.html#connectionLost
  Function
  Method
  PUBLIC
  Called when the connection is shut down.
- twisted.internet.protocol.ConsumerToProtocolAdapter.makeConnection
  twisted.internet.protocol.ConsumerToProtocolAdapter.html#makeConnection
  Function
  Method
  PUBLIC
  Make a connection to a transport and a server.
- twisted.internet.protocol.ConsumerToProtocolAdapter.connectionMade
  twisted.internet.protocol.ConsumerToProtocolAdapter.html#connectionMade
  Function
  Method
  PUBLIC
  Called when a connection is made.
- twisted.internet.protocol.ProcessProtocol
  twisted.internet.protocol.ProcessProtocol.html
  Class
  Class
  PUBLIC
  Base process protocol implementation which does simple dispatching for stdin, stdout, and stderr file descriptors.
- twisted.internet.protocol.ProcessProtocol.childDataReceived
  twisted.internet.protocol.ProcessProtocol.html#childDataReceived
  Function
  Method
  PUBLIC
  Called when data arrives from the child process.
- twisted.internet.protocol.ProcessProtocol.outReceived
  twisted.internet.protocol.ProcessProtocol.html#outReceived
  Function
  Method
  PUBLIC
  Some data was received from stdout.
- twisted.internet.protocol.ProcessProtocol.errReceived
  twisted.internet.protocol.ProcessProtocol.html#errReceived
  Function
  Method
  PUBLIC
  Some data was received from stderr.
- twisted.internet.protocol.ProcessProtocol.childConnectionLost
  twisted.internet.protocol.ProcessProtocol.html#childConnectionLost
  Function
  Method
  PUBLIC
  Called when a file descriptor associated with the child process is closed.
- twisted.internet.protocol.ProcessProtocol.inConnectionLost
  twisted.internet.protocol.ProcessProtocol.html#inConnectionLost
  Function
  Method
  PUBLIC
  This will be called when stdin is closed.
- twisted.internet.protocol.ProcessProtocol.outConnectionLost
  twisted.internet.protocol.ProcessProtocol.html#outConnectionLost
  Function
  Method
  PUBLIC
  This will be called when stdout is closed.
- twisted.internet.protocol.ProcessProtocol.errConnectionLost
  twisted.internet.protocol.ProcessProtocol.html#errConnectionLost
  Function
  Method
  PUBLIC
  This will be called when stderr is closed.
- twisted.internet.protocol.ProcessProtocol.processExited
  twisted.internet.protocol.ProcessProtocol.html#processExited
  Function
  Method
  PUBLIC
  This will be called when the subprocess exits.
- twisted.internet.protocol.ProcessProtocol.processEnded
  twisted.internet.protocol.ProcessProtocol.html#processEnded
  Function
  Method
  PUBLIC
  Called when the child process exits and all file descriptors associated with it have been closed.
- twisted.internet.protocol.AbstractDatagramProtocol
  twisted.internet.protocol.AbstractDatagramProtocol.html
  Class
  Class
  PUBLIC
  Abstract protocol for datagram-oriented transports, e.g. IP, ICMP, ARP, UDP.
- twisted.internet.protocol.AbstractDatagramProtocol.transport
  twisted.internet.protocol.AbstractDatagramProtocol.html#transport
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.protocol.AbstractDatagramProtocol.numPorts
  twisted.internet.protocol.AbstractDatagramProtocol.html#numPorts
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.protocol.AbstractDatagramProtocol.noisy
  twisted.internet.protocol.AbstractDatagramProtocol.html#noisy
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet.protocol.AbstractDatagramProtocol.__getstate__
  twisted.internet.protocol.AbstractDatagramProtocol.html#__getstate__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.protocol.AbstractDatagramProtocol.doStart
  twisted.internet.protocol.AbstractDatagramProtocol.html#doStart
  Function
  Method
  PUBLIC
  Make sure startProtocol is called.
- twisted.internet.protocol.AbstractDatagramProtocol.doStop
  twisted.internet.protocol.AbstractDatagramProtocol.html#doStop
  Function
  Method
  PUBLIC
  Make sure stopProtocol is called.
- twisted.internet.protocol.AbstractDatagramProtocol.startProtocol
  twisted.internet.protocol.AbstractDatagramProtocol.html#startProtocol
  Function
  Method
  PUBLIC
  Called when a transport is connected to this protocol.
- twisted.internet.protocol.AbstractDatagramProtocol.stopProtocol
  twisted.internet.protocol.AbstractDatagramProtocol.html#stopProtocol
  Function
  Method
  PUBLIC
  Called when the transport is disconnected.
- twisted.internet.protocol.AbstractDatagramProtocol.makeConnection
  twisted.internet.protocol.AbstractDatagramProtocol.html#makeConnection
  Function
  Method
  PUBLIC
  Make a connection to a transport and a server.
- twisted.internet.protocol.AbstractDatagramProtocol.datagramReceived
  twisted.internet.protocol.AbstractDatagramProtocol.html#datagramReceived
  Function
  Method
  PUBLIC
  Called when a datagram is received.
- twisted.internet.protocol.DatagramProtocol
  twisted.internet.protocol.DatagramProtocol.html
  Class
  Class
  PUBLIC
  Protocol for datagram-oriented transport, e.g. UDP.
- twisted.internet.protocol.DatagramProtocol.transport
  twisted.internet.protocol.DatagramProtocol.html#transport
  Attribute
  Instance Variable
  PUBLIC
  The transport with which this protocol is associated, if it is associated with one.
- twisted.internet.protocol.DatagramProtocol.logPrefix
  twisted.internet.protocol.DatagramProtocol.html#logPrefix
  Function
  Method
  PUBLIC
  Return a prefix matching the class name, to identify log messages related to this protocol instance.
- twisted.internet.protocol.DatagramProtocol.connectionRefused
  twisted.internet.protocol.DatagramProtocol.html#connectionRefused
  Function
  Method
  PUBLIC
  Called due to error from write in connected mode.
- twisted.internet.protocol.ConnectedDatagramProtocol
  twisted.internet.protocol.ConnectedDatagramProtocol.html
  Class
  Class
  PUBLIC
  Protocol for connected datagram-oriented transport.
- twisted.internet.protocol.ConnectedDatagramProtocol.datagramReceived
  twisted.internet.protocol.ConnectedDatagramProtocol.html#datagramReceived
  Function
  Method
  PUBLIC
  Called when a datagram is received.
- twisted.internet.protocol.ConnectedDatagramProtocol.connectionFailed
  twisted.internet.protocol.ConnectedDatagramProtocol.html#connectionFailed
  Function
  Method
  PUBLIC
  Called if connecting failed.
- twisted.internet.protocol.FileWrapper
  twisted.internet.protocol.FileWrapper.html
  Class
  Class
  PUBLIC
  A wrapper around a file-like object to make it behave as a Transport.
- twisted.internet.protocol.FileWrapper.closed
  twisted.internet.protocol.FileWrapper.html#closed
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.protocol.FileWrapper.disconnecting
  twisted.internet.protocol.FileWrapper.html#disconnecting
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet.protocol.FileWrapper.producer
  twisted.internet.protocol.FileWrapper.html#producer
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.protocol.FileWrapper.streamingProducer
  twisted.internet.protocol.FileWrapper.html#streamingProducer
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.protocol.FileWrapper.__init__
  twisted.internet.protocol.FileWrapper.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.protocol.FileWrapper.file
  twisted.internet.protocol.FileWrapper.html#file
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.protocol.FileWrapper.write
  twisted.internet.protocol.FileWrapper.html#write
  Function
  Method
  PUBLIC
  Write some data to the physical connection, in sequence, in a non-blocking fashion.
- twisted.internet.protocol.FileWrapper._checkProducer
  twisted.internet.protocol.FileWrapper.html#_checkProducer
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet.protocol.FileWrapper.registerProducer
  twisted.internet.protocol.FileWrapper.html#registerProducer
  Function
  Method
  PUBLIC
  From abstract.FileDescriptor
- twisted.internet.protocol.FileWrapper.unregisterProducer
  twisted.internet.protocol.FileWrapper.html#unregisterProducer
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.protocol.FileWrapper.stopConsuming
  twisted.internet.protocol.FileWrapper.html#stopConsuming
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.protocol.FileWrapper.writeSequence
  twisted.internet.protocol.FileWrapper.html#writeSequence
  Function
  Method
  PUBLIC
  Write an iterable of byte strings to the physical connection.
- twisted.internet.protocol.FileWrapper.loseConnection
  twisted.internet.protocol.FileWrapper.html#loseConnection
  Function
  Method
  PUBLIC
  Close my connection, after writing all pending data.
- twisted.internet.protocol.FileWrapper.getPeer
  twisted.internet.protocol.FileWrapper.html#getPeer
  Function
  Method
  PUBLIC
  Get the remote address of this connection.
- twisted.internet.protocol.FileWrapper.getHost
  twisted.internet.protocol.FileWrapper.html#getHost
  Function
  Method
  PUBLIC
  Similar to getPeer, but returns an address describing this side of the connection.
- twisted.internet.protocol.FileWrapper.handleException
  twisted.internet.protocol.FileWrapper.html#handleException
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.protocol.FileWrapper.resumeProducing
  twisted.internet.protocol.FileWrapper.html#resumeProducing
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.protocol.FileWrapper.pauseProducing
  twisted.internet.protocol.FileWrapper.html#pauseProducing
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.protocol.FileWrapper.stopProducing
  twisted.internet.protocol.FileWrapper.html#stopProducing
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.fdesc.setNonBlocking
  twisted.internet.fdesc.html#setNonBlocking
  Function
  Function
  PUBLIC
  Set the file description of the given file descriptor to non-blocking.
- twisted.internet.fdesc.setBlocking
  twisted.internet.fdesc.html#setBlocking
  Function
  Function
  PUBLIC
  Set the file description of the given file descriptor to blocking.
- twisted.internet.fdesc._setCloseOnExec
  twisted.internet.fdesc.html#_setCloseOnExec
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.internet.fdesc._unsetCloseOnExec
  twisted.internet.fdesc.html#_unsetCloseOnExec
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.internet.fdesc.readFromFD
  twisted.internet.fdesc.html#readFromFD
  Function
  Function
  PUBLIC
  Read from file descriptor, calling callback with resulting data.
- twisted.internet.fdesc.writeToFD
  twisted.internet.fdesc.html#writeToFD
  Function
  Function
  PUBLIC
  Write data to file descriptor.
- twisted.internet.threads.deferToThreadPool
  twisted.internet.threads.html#deferToThreadPool
  Function
  Function
  PUBLIC
  Call the function `f` using a thread from the given threadpool and return the result as a Deferred.
- twisted.internet.threads.deferToThread
  twisted.internet.threads.html#deferToThread
  Function
  Function
  PUBLIC
  Run a function in a thread and return the result as a Deferred.
- twisted.internet.threads._runMultiple
  twisted.internet.threads.html#_runMultiple
  Function
  Function
  PRIVATE
  Run a list of functions.
- twisted.internet.threads.callMultipleInThread
  twisted.internet.threads.html#callMultipleInThread
  Function
  Function
  PUBLIC
  Run a list of functions in the same thread.
- twisted.internet.threads.blockingCallFromThread
  twisted.internet.threads.html#blockingCallFromThread
  Function
  Function
  PUBLIC
  Run a function in the reactor from a thread, and wait for the result synchronously. If the function returns a `Deferred`, wait for its result and return that.
- twisted.internet._idna._idnaBytes
  twisted.internet._idna.html#_idnaBytes
  Function
  Function
  PRIVATE
  Convert some text typed by a human into some ASCII bytes.
- twisted.internet._idna._idnaText
  twisted.internet._idna.html#_idnaText
  Function
  Function
  PRIVATE
  Convert some IDNA-encoded octets into some human-readable text.
- twisted.internet._resolver.HostResolution
  twisted.internet._resolver.HostResolution.html
  Class
  Class
  PUBLIC
  The in-progress resolution of a given hostname.
- twisted.internet._resolver.HostResolution.__init__
  twisted.internet._resolver.HostResolution.html#__init__
  Function
  Method
  PUBLIC
  Create a `HostResolution` with the given name.
- twisted.internet._resolver.HostResolution.name
  twisted.internet._resolver.HostResolution.html#name
  Attribute
  Instance Variable
  PUBLIC
  `unicode`; the name of the host being resolved.
- twisted.internet._resolver.HostResolution.cancel
  twisted.internet._resolver.HostResolution.html#cancel
  Function
  Method
  PUBLIC
  Stop the hostname resolution in progress.
- twisted.internet._resolver._any
  twisted.internet._resolver.html#_any
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.internet._resolver._typesToAF
  twisted.internet._resolver.html#_typesToAF
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.internet._resolver._afToType
  twisted.internet._resolver.html#_afToType
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.internet._resolver._transportToSocket
  twisted.internet._resolver.html#_transportToSocket
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.internet._resolver._socktypeToType
  twisted.internet._resolver.html#_socktypeToType
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.internet._resolver.GAIResolver
  twisted.internet._resolver.GAIResolver.html
  Class
  Class
  PUBLIC
  `IHostnameResolver` implementation that resolves hostnames by calling `getaddrinfo` in a thread.
- twisted.internet._resolver.GAIResolver.__init__
  twisted.internet._resolver.GAIResolver.html#__init__
  Function
  Method
  PUBLIC
  Create a `GAIResolver`.
- twisted.internet._resolver.GAIResolver._reactor
  twisted.internet._resolver.GAIResolver.html#_reactor
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet._resolver.GAIResolver._getThreadPool
  twisted.internet._resolver.GAIResolver.html#_getThreadPool
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet._resolver.GAIResolver._getaddrinfo
  twisted.internet._resolver.GAIResolver.html#_getaddrinfo
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet._resolver.GAIResolver.resolveHostName
  twisted.internet._resolver.GAIResolver.html#resolveHostName
  Function
  Method
  PUBLIC
  See `IHostnameResolver.resolveHostName`
- twisted.internet._resolver.SimpleResolverComplexifier
  twisted.internet._resolver.SimpleResolverComplexifier.html
  Class
  Class
  PUBLIC
  A converter from `IResolverSimple` to `IHostnameResolver`.
- twisted.internet._resolver.SimpleResolverComplexifier._log
  twisted.internet._resolver.SimpleResolverComplexifier.html#_log
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.internet._resolver.SimpleResolverComplexifier.__init__
  twisted.internet._resolver.SimpleResolverComplexifier.html#__init__
  Function
  Method
  PUBLIC
  Construct a `SimpleResolverComplexifier` with an `IResolverSimple`.
- twisted.internet._resolver.SimpleResolverComplexifier._simpleResolver
  twisted.internet._resolver.SimpleResolverComplexifier.html#_simpleResolver
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet._resolver.SimpleResolverComplexifier.resolveHostName
  twisted.internet._resolver.SimpleResolverComplexifier.html#resolveHostName
  Function
  Method
  PUBLIC
  See `IHostnameResolver.resolveHostName`
- twisted.internet._resolver.FirstOneWins
  twisted.internet._resolver.FirstOneWins.html
  Class
  Class
  PUBLIC
  An `IResolutionReceiver` which fires a `Deferred` with its first result.
- twisted.internet._resolver.FirstOneWins.__init__
  twisted.internet._resolver.FirstOneWins.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.internet._resolver.FirstOneWins._deferred
  twisted.internet._resolver.FirstOneWins.html#_deferred
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet._resolver.FirstOneWins._resolved
  twisted.internet._resolver.FirstOneWins.html#_resolved
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet._resolver.FirstOneWins.resolutionBegan
  twisted.internet._resolver.FirstOneWins.html#resolutionBegan
  Function
  Method
  PUBLIC
  See `IResolutionReceiver.resolutionBegan`
- twisted.internet._resolver.FirstOneWins._resolution
  twisted.internet._resolver.FirstOneWins.html#_resolution
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet._resolver.FirstOneWins.addressResolved
  twisted.internet._resolver.FirstOneWins.html#addressResolved
  Function
  Method
  PUBLIC
  See `IResolutionReceiver.addressResolved`
- twisted.internet._resolver.FirstOneWins.resolutionComplete
  twisted.internet._resolver.FirstOneWins.html#resolutionComplete
  Function
  Method
  PUBLIC
  See `IResolutionReceiver.resolutionComplete`
- twisted.internet._resolver.ComplexResolverSimplifier
  twisted.internet._resolver.ComplexResolverSimplifier.html
  Class
  Class
  PUBLIC
  A converter from `IHostnameResolver` to `IResolverSimple`
- twisted.internet._resolver.ComplexResolverSimplifier.__init__
  twisted.internet._resolver.ComplexResolverSimplifier.html#__init__
  Function
  Method
  PUBLIC
  Create a `ComplexResolverSimplifier` with an `IHostnameResolver`.
- twisted.internet._resolver.ComplexResolverSimplifier._nameResolver
  twisted.internet._resolver.ComplexResolverSimplifier.html#_nameResolver
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet._resolver.ComplexResolverSimplifier.getHostByName
  twisted.internet._resolver.ComplexResolverSimplifier.html#getHostByName
  Function
  Method
  PUBLIC
  See `IResolverSimple.getHostByName`
- twisted.python.threadpool.WorkerStop
  twisted.python.threadpool.html#WorkerStop
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.python.threadpool.ThreadPool
  twisted.python.threadpool.ThreadPool.html
  Class
  Class
  PUBLIC
  This class (hopefully) generalizes the functionality of a pool of threads to which work can be dispatched.
- twisted.python.threadpool.ThreadPool.started
  twisted.python.threadpool.ThreadPool.html#started
  Attribute
  Instance Variable
  PUBLIC
  Whether or not the thread pool is currently running.
- twisted.python.threadpool.ThreadPool.threads
  twisted.python.threadpool.ThreadPool.html#threads
  Attribute
  Instance Variable
  PUBLIC
  List of workers currently running in this thread pool.
- twisted.python.threadpool.ThreadPool._pool
  twisted.python.threadpool.ThreadPool.html#_pool
  Attribute
  Instance Variable
  PRIVATE
  A hook for testing.
- twisted.python.threadpool.ThreadPool.min
  twisted.python.threadpool.ThreadPool.html#min
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.threadpool.ThreadPool.max
  twisted.python.threadpool.ThreadPool.html#max
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.threadpool.ThreadPool.joined
  twisted.python.threadpool.ThreadPool.html#joined
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.threadpool.ThreadPool.name
  twisted.python.threadpool.ThreadPool.html#name
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.threadpool.ThreadPool.currentThread
  twisted.python.threadpool.ThreadPool.html#currentThread
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.python.threadpool.ThreadPool.__init__
  twisted.python.threadpool.ThreadPool.html#__init__
  Function
  Method
  PUBLIC
  Create a new threadpool.
- twisted.python.threadpool.ThreadPool._team
  twisted.python.threadpool.ThreadPool.html#_team
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.python.threadpool.ThreadPool.workers
  twisted.python.threadpool.ThreadPool.html#workers
  Attribute
  Property
  PUBLIC
  For legacy compatibility purposes, return a total number of workers.
- twisted.python.threadpool.ThreadPool.working
  twisted.python.threadpool.ThreadPool.html#working
  Attribute
  Property
  PUBLIC
  For legacy compatibility purposes, return the number of busy workers as expressed by a list the length of that number.
- twisted.python.threadpool.ThreadPool.waiters
  twisted.python.threadpool.ThreadPool.html#waiters
  Attribute
  Property
  PUBLIC
  For legacy compatibility purposes, return the number of idle workers as expressed by a list the length of that number.
- twisted.python.threadpool.ThreadPool._queue
  twisted.python.threadpool.ThreadPool.html#_queue
  Attribute
  Property
  PRIVATE
  For legacy compatibility purposes, return an object with a `qsize` method that indicates the amount of work not yet allocated to a worker.
- twisted.python.threadpool.ThreadPool.start
  twisted.python.threadpool.ThreadPool.html#start
  Function
  Method
  PUBLIC
  Start the threadpool.
- twisted.python.threadpool.ThreadPool.startAWorker
  twisted.python.threadpool.ThreadPool.html#startAWorker
  Function
  Method
  PUBLIC
  Increase the number of available workers for the thread pool by 1, up to the maximum allowed by `ThreadPool.max`.
- twisted.python.threadpool.ThreadPool._generateName
  twisted.python.threadpool.ThreadPool.html#_generateName
  Function
  Method
  PRIVATE
  Generate a name for a new pool thread.
- twisted.python.threadpool.ThreadPool.stopAWorker
  twisted.python.threadpool.ThreadPool.html#stopAWorker
  Function
  Method
  PUBLIC
  Decrease the number of available workers by 1, by quitting one as soon as it's idle.
- twisted.python.threadpool.ThreadPool.__setstate__
  twisted.python.threadpool.ThreadPool.html#__setstate__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.threadpool.ThreadPool.__getstate__
  twisted.python.threadpool.ThreadPool.html#__getstate__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.threadpool.ThreadPool.callInThread
  twisted.python.threadpool.ThreadPool.html#callInThread
  Function
  Method
  PUBLIC
  Call a callable object in a separate thread.
- twisted.python.threadpool.ThreadPool.callInThreadWithCallback
  twisted.python.threadpool.ThreadPool.html#callInThreadWithCallback
  Function
  Method
  PUBLIC
  Call a callable object in a separate thread and call `onResult` with the return value, or a `twisted.python.failure.Failure` if the callable raises an exception.
- twisted.python.threadpool.ThreadPool.stop
  twisted.python.threadpool.ThreadPool.html#stop
  Function
  Method
  PUBLIC
  Shutdown the threads in the threadpool.
- twisted.python.threadpool.ThreadPool.adjustPoolsize
  twisted.python.threadpool.ThreadPool.html#adjustPoolsize
  Function
  Method
  PUBLIC
  Adjust the number of available threads by setting `min` and `max` to new values.
- twisted.python.threadpool.ThreadPool.dumpStats
  twisted.python.threadpool.ThreadPool.html#dumpStats
  Function
  Method
  PUBLIC
  Dump some plain-text informational messages to the log about the state of this `ThreadPool`.
- twisted.internet.base.DelayedCall
  twisted.internet.base.DelayedCall.html
  Class
  Class
  PUBLIC
  No class docstring; 0/11 instance variable, 0/2 class variable, 9/10 methods documented
- twisted.internet.base.DelayedCall.debug
  twisted.internet.base.DelayedCall.html#debug
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet.base.DelayedCall._repr
  twisted.internet.base.DelayedCall.html#_repr
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.internet.base.DelayedCall.__init__
  twisted.internet.base.DelayedCall.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.internet.base.DelayedCall.time
  twisted.internet.base.DelayedCall.html#time
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.base.DelayedCall.func
  twisted.internet.base.DelayedCall.html#func
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.base.DelayedCall.args
  twisted.internet.base.DelayedCall.html#args
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.base.DelayedCall.kw
  twisted.internet.base.DelayedCall.html#kw
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.base.DelayedCall.resetter
  twisted.internet.base.DelayedCall.html#resetter
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.base.DelayedCall.canceller
  twisted.internet.base.DelayedCall.html#canceller
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.base.DelayedCall.seconds
  twisted.internet.base.DelayedCall.html#seconds
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.base.DelayedCall.cancelled
  twisted.internet.base.DelayedCall.html#cancelled
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.base.DelayedCall.called
  twisted.internet.base.DelayedCall.html#called
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.base.DelayedCall.delayed_time
  twisted.internet.base.DelayedCall.html#delayed_time
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.base.DelayedCall.creator
  twisted.internet.base.DelayedCall.html#creator
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.base.DelayedCall.getTime
  twisted.internet.base.DelayedCall.html#getTime
  Function
  Method
  PUBLIC
  Return the time at which this call will fire
- twisted.internet.base.DelayedCall.cancel
  twisted.internet.base.DelayedCall.html#cancel
  Function
  Method
  PUBLIC
  Unschedule this call
- twisted.internet.base.DelayedCall.reset
  twisted.internet.base.DelayedCall.html#reset
  Function
  Method
  PUBLIC
  Reschedule this call for a different time
- twisted.internet.base.DelayedCall.delay
  twisted.internet.base.DelayedCall.html#delay
  Function
  Method
  PUBLIC
  Reschedule this call for a later time
- twisted.internet.base.DelayedCall.activate_delay
  twisted.internet.base.DelayedCall.html#activate_delay
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.base.DelayedCall.active
  twisted.internet.base.DelayedCall.html#active
  Function
  Method
  PUBLIC
  Determine whether this call is still pending
- twisted.internet.base.DelayedCall.__le__
  twisted.internet.base.DelayedCall.html#__le__
  Function
  Method
  PUBLIC
  Implement `<=` operator between two `DelayedCall` instances.
- twisted.internet.base.DelayedCall.__lt__
  twisted.internet.base.DelayedCall.html#__lt__
  Function
  Method
  PUBLIC
  Implement `<` operator between two `DelayedCall` instances.
- twisted.internet.base.DelayedCall.__repr__
  twisted.internet.base.DelayedCall.html#__repr__
  Function
  Method
  PUBLIC
  Implement `repr()` for `DelayedCall` instances.
- twisted.internet.base.ThreadedResolver
  twisted.internet.base.ThreadedResolver.html
  Class
  Class
  PUBLIC
  `ThreadedResolver` uses a reactor, a threadpool, and `socket.gethostbyname` to perform name lookups without blocking the reactor thread. It also supports timeouts indepedently from whatever timeout logic ...
- twisted.internet.base.ThreadedResolver.reactor
  twisted.internet.base.ThreadedResolver.html#reactor
  Attribute
  Instance Variable
  PUBLIC
  The reactor the threadpool of which will be used to call `socket.gethostbyname` and the I/O thread of which the result will be delivered.
- twisted.internet.base.ThreadedResolver.__init__
  twisted.internet.base.ThreadedResolver.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.base.ThreadedResolver._runningQueries
  twisted.internet.base.ThreadedResolver.html#_runningQueries
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.base.ThreadedResolver._fail
  twisted.internet.base.ThreadedResolver.html#_fail
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet.base.ThreadedResolver._cleanup
  twisted.internet.base.ThreadedResolver.html#_cleanup
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet.base.ThreadedResolver._checkTimeout
  twisted.internet.base.ThreadedResolver.html#_checkTimeout
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet.base.ThreadedResolver.getHostByName
  twisted.internet.base.ThreadedResolver.html#getHostByName
  Function
  Method
  PUBLIC
  See `twisted.internet.interfaces.IResolverSimple.getHostByName`.
- twisted.internet.base.BlockingResolver
  twisted.internet.base.BlockingResolver.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.internet.base.BlockingResolver.getHostByName
  twisted.internet.base.BlockingResolver.html#getHostByName
  Function
  Method
  PUBLIC
  Resolve the domain name `name` into an IP address.
- twisted.internet.base._ThreePhaseEventTriggerCallable
  twisted.internet.base.html#_ThreePhaseEventTriggerCallable
  Attribute
  Type Alias
  PRIVATE
  Undocumented
- twisted.internet.base._ThreePhaseEventTrigger
  twisted.internet.base.html#_ThreePhaseEventTrigger
  Attribute
  Type Alias
  PRIVATE
  Undocumented
- twisted.internet.base._ThreePhaseEventTriggerHandle
  twisted.internet.base.html#_ThreePhaseEventTriggerHandle
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.internet.base._ThreePhaseEvent
  twisted.internet.base._ThreePhaseEvent.html
  Class
  Class
  PRIVATE
  Collection of callables (with arguments) which can be invoked as a group in a particular order.
- twisted.internet.base._ThreePhaseEvent.before
  twisted.internet.base._ThreePhaseEvent.html#before
  Attribute
  Instance Variable
  PUBLIC
  A list of the before-phase triggers containing three-tuples of a callable, a tuple of positional arguments, and a dict of keyword arguments
- twisted.internet.base._ThreePhaseEvent.finishedBefore
  twisted.internet.base._ThreePhaseEvent.html#finishedBefore
  Attribute
  Instance Variable
  PUBLIC
  A list of the before-phase triggers which have already been executed. This is only populated in the `'BEFORE'` state.
- twisted.internet.base._ThreePhaseEvent.during
  twisted.internet.base._ThreePhaseEvent.html#during
  Attribute
  Instance Variable
  PUBLIC
  A list of the during-phase triggers containing three-tuples of a callable, a tuple of positional arguments, and a dict of keyword arguments
- twisted.internet.base._ThreePhaseEvent.after
  twisted.internet.base._ThreePhaseEvent.html#after
  Attribute
  Instance Variable
  PUBLIC
  A list of the after-phase triggers containing three-tuples of a callable, a tuple of positional arguments, and a dict of keyword arguments
- twisted.internet.base._ThreePhaseEvent.state
  twisted.internet.base._ThreePhaseEvent.html#state
  Attribute
  Instance Variable
  PUBLIC
  A string indicating what is currently going on with this object. One of `'BASE'` (for when nothing in particular is happening; this is the initial value), `'BEFORE'` (when the before-phase triggers are in the process of being executed).
- twisted.internet.base._ThreePhaseEvent.__init__
  twisted.internet.base._ThreePhaseEvent.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.base._ThreePhaseEvent.addTrigger
  twisted.internet.base._ThreePhaseEvent.html#addTrigger
  Function
  Method
  PUBLIC
  Add a trigger to the indicate phase.
- twisted.internet.base._ThreePhaseEvent.removeTrigger
  twisted.internet.base._ThreePhaseEvent.html#removeTrigger
  Function
  Method
  PUBLIC
  Remove a previously added trigger callable.
- twisted.internet.base._ThreePhaseEvent.removeTrigger_BASE
  twisted.internet.base._ThreePhaseEvent.html#removeTrigger_BASE
  Function
  Method
  PUBLIC
  Just try to remove the trigger.
- twisted.internet.base._ThreePhaseEvent.removeTrigger_BEFORE
  twisted.internet.base._ThreePhaseEvent.html#removeTrigger_BEFORE
  Function
  Method
  PUBLIC
  Remove the trigger if it has yet to be executed, otherwise emit a warning that in the future an exception will be raised when removing an already-executed trigger.
- twisted.internet.base._ThreePhaseEvent.fireEvent
  twisted.internet.base._ThreePhaseEvent.html#fireEvent
  Function
  Method
  PUBLIC
  Call the triggers added to this event.
- twisted.internet.base._ThreePhaseEvent._continueFiring
  twisted.internet.base._ThreePhaseEvent.html#_continueFiring
  Function
  Method
  PRIVATE
  Call the during and after phase triggers for this event.
- twisted.internet.base.PluggableResolverMixin
  twisted.internet.base.PluggableResolverMixin.html
  Class
  Class
  PUBLIC
  A mixin which implements the pluggable resolver reactor interfaces.
- twisted.internet.base.PluggableResolverMixin.resolver
  twisted.internet.base.PluggableResolverMixin.html#resolver
  Attribute
  Instance Variable
  PUBLIC
  The installed `IResolverSimple`.
- twisted.internet.base.PluggableResolverMixin._nameResolver
  twisted.internet.base.PluggableResolverMixin.html#_nameResolver
  Attribute
  Instance Variable
  PRIVATE
  The installed `IHostnameResolver`.
- twisted.internet.base.PluggableResolverMixin.installResolver
  twisted.internet.base.PluggableResolverMixin.html#installResolver
  Function
  Method
  PUBLIC
  See `IReactorPluggableResolver`.
- twisted.internet.base.PluggableResolverMixin.installNameResolver
  twisted.internet.base.PluggableResolverMixin.html#installNameResolver
  Function
  Method
  PUBLIC
  See `IReactorPluggableNameResolver`.
- twisted.internet.base.PluggableResolverMixin.nameResolver
  twisted.internet.base.PluggableResolverMixin.html#nameResolver
  Attribute
  Property
  PUBLIC
  Implementation of read-only `IReactorPluggableNameResolver.nameResolver`.
- twisted.internet.base._SystemEventID
  twisted.internet.base.html#_SystemEventID
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.internet.base._ThreadCall
  twisted.internet.base.html#_ThreadCall
  Attribute
  Type Alias
  PRIVATE
  Undocumented
- twisted.internet.base.ReactorBase
  twisted.internet.base.ReactorBase.html
  Class
  Class
  PUBLIC
  Default base class for Reactors.
- twisted.internet.base.ReactorBase._stopped
  twisted.internet.base.ReactorBase.html#_stopped
  Attribute
  Instance Variable
  PRIVATE
  A flag which is true between paired calls to `reactor.run` and `reactor.stop`. This should be replaced with an explicit state machine.
- twisted.internet.base.ReactorBase._justStopped
  twisted.internet.base.ReactorBase.html#_justStopped
  Attribute
  Instance Variable
  PRIVATE
  A flag which is true between the time `reactor.stop` is called and the time the shutdown system event is fired. This is used to determine whether that event should be fired after each iteration through the mainloop...
- twisted.internet.base.ReactorBase._started
  twisted.internet.base.ReactorBase.html#_started
  Attribute
  Instance Variable
  PRIVATE
  A flag which is true from the time `reactor.run` is called until the time `reactor.run` returns. This is used to prevent calls to `reactor.run` on a running reactor. This should be replaced with an explicit state machine.
- twisted.internet.base.ReactorBase.running
  twisted.internet.base.ReactorBase.html#running
  Attribute
  Instance Variable
  PUBLIC
  See `IReactorCore.running`
- twisted.internet.base.ReactorBase._registerAsIOThread
  twisted.internet.base.ReactorBase.html#_registerAsIOThread
  Attribute
  Instance Variable
  PRIVATE
  A flag controlling whether the reactor will register the thread it is running in as the I/O thread when it starts. If `True`, registration will be done, otherwise it will not be.
- twisted.internet.base.ReactorBase._exitSignal
  twisted.internet.base.ReactorBase.html#_exitSignal
  Attribute
  Instance Variable
  PRIVATE
  See `_ISupportsExitSignalCapturing._exitSignal`
- twisted.internet.base.ReactorBase.installed
  twisted.internet.base.ReactorBase.html#installed
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet.base.ReactorBase.usingThreads
  twisted.internet.base.ReactorBase.html#usingThreads
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.base.ReactorBase.__name__
  twisted.internet.base.ReactorBase.html#__name__
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet.base.ReactorBase.__init__
  twisted.internet.base.ReactorBase.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.base.ReactorBase.threadCallQueue
  twisted.internet.base.ReactorBase.html#threadCallQueue
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.base.ReactorBase._eventTriggers
  twisted.internet.base.ReactorBase.html#_eventTriggers
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.base.ReactorBase._pendingTimedCalls
  twisted.internet.base.ReactorBase.html#_pendingTimedCalls
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.base.ReactorBase._newTimedCalls
  twisted.internet.base.ReactorBase.html#_newTimedCalls
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.base.ReactorBase._cancellations
  twisted.internet.base.ReactorBase.html#_cancellations
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.base.ReactorBase._startedBefore
  twisted.internet.base.ReactorBase.html#_startedBefore
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.base.ReactorBase._internalReaders
  twisted.internet.base.ReactorBase.html#_internalReaders
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.base.ReactorBase.waker
  twisted.internet.base.ReactorBase.html#waker
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.base.ReactorBase._lock
  twisted.internet.base.ReactorBase.html#_lock
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.internet.base.ReactorBase.installWaker
  twisted.internet.base.ReactorBase.html#installWaker
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.base.ReactorBase.wakeUp
  twisted.internet.base.ReactorBase.html#wakeUp
  Function
  Method
  PUBLIC
  Wake up the event loop.
- twisted.internet.base.ReactorBase.doIteration
  twisted.internet.base.ReactorBase.html#doIteration
  Function
  Method
  PUBLIC
  Do one iteration over the readers and writers which have been added.
- twisted.internet.base.ReactorBase.addReader
  twisted.internet.base.ReactorBase.html#addReader
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.base.ReactorBase.addWriter
  twisted.internet.base.ReactorBase.html#addWriter
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.base.ReactorBase.removeReader
  twisted.internet.base.ReactorBase.html#removeReader
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.base.ReactorBase.removeWriter
  twisted.internet.base.ReactorBase.html#removeWriter
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.base.ReactorBase.removeAll
  twisted.internet.base.ReactorBase.html#removeAll
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.base.ReactorBase.getReaders
  twisted.internet.base.ReactorBase.html#getReaders
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.base.ReactorBase.getWriters
  twisted.internet.base.ReactorBase.html#getWriters
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.base.ReactorBase.resolve
  twisted.internet.base.ReactorBase.html#resolve
  Function
  Method
  PUBLIC
  Return a Deferred that will resolve a hostname.
- twisted.internet.base.ReactorBase.stop
  twisted.internet.base.ReactorBase.html#stop
  Function
  Method
  PUBLIC
  See twisted.internet.interfaces.IReactorCore.stop.
- twisted.internet.base.ReactorBase.crash
  twisted.internet.base.ReactorBase.html#crash
  Function
  Method
  PUBLIC
  See twisted.internet.interfaces.IReactorCore.crash.
- twisted.internet.base.ReactorBase.sigInt
  twisted.internet.base.ReactorBase.html#sigInt
  Function
  Method
  PUBLIC
  Handle a SIGINT interrupt.
- twisted.internet.base.ReactorBase.sigBreak
  twisted.internet.base.ReactorBase.html#sigBreak
  Function
  Method
  PUBLIC
  Handle a SIGBREAK interrupt.
- twisted.internet.base.ReactorBase.sigTerm
  twisted.internet.base.ReactorBase.html#sigTerm
  Function
  Method
  PUBLIC
  Handle a SIGTERM interrupt.
- twisted.internet.base.ReactorBase.disconnectAll
  twisted.internet.base.ReactorBase.html#disconnectAll
  Function
  Method
  PUBLIC
  Disconnect every reader, and writer in the system.
- twisted.internet.base.ReactorBase.iterate
  twisted.internet.base.ReactorBase.html#iterate
  Function
  Method
  PUBLIC
  See twisted.internet.interfaces.IReactorCore.iterate.
- twisted.internet.base.ReactorBase.fireSystemEvent
  twisted.internet.base.ReactorBase.html#fireSystemEvent
  Function
  Method
  PUBLIC
  See twisted.internet.interfaces.IReactorCore.fireSystemEvent.
- twisted.internet.base.ReactorBase.addSystemEventTrigger
  twisted.internet.base.ReactorBase.html#addSystemEventTrigger
  Function
  Method
  PUBLIC
  See twisted.internet.interfaces.IReactorCore.addSystemEventTrigger.
- twisted.internet.base.ReactorBase.removeSystemEventTrigger
  twisted.internet.base.ReactorBase.html#removeSystemEventTrigger
  Function
  Method
  PUBLIC
  See twisted.internet.interfaces.IReactorCore.removeSystemEventTrigger.
- twisted.internet.base.ReactorBase.callWhenRunning
  twisted.internet.base.ReactorBase.html#callWhenRunning
  Function
  Method
  PUBLIC
  See twisted.internet.interfaces.IReactorCore.callWhenRunning.
- twisted.internet.base.ReactorBase.startRunning
  twisted.internet.base.ReactorBase.html#startRunning
  Function
  Method
  PUBLIC
  Method called when reactor starts: do some initialization and fire startup events.
- twisted.internet.base.ReactorBase._reallyStartRunning
  twisted.internet.base.ReactorBase.html#_reallyStartRunning
  Function
  Method
  PRIVATE
  Method called to transition to the running state. This should happen in the during startup event trigger phase.
- twisted.internet.base.ReactorBase.run
  twisted.internet.base.ReactorBase.html#run
  Function
  Method
  PUBLIC
  Fire 'startup' System Events, move the reactor to the 'running' state, then run the main loop until it is stopped with `stop()` or `crash()`.
- twisted.internet.base.ReactorBase.seconds
  twisted.internet.base.ReactorBase.html#seconds
  Attribute
  Class Variable
  PUBLIC
  Get the current time in seconds.
- twisted.internet.base.ReactorBase.callLater
  twisted.internet.base.ReactorBase.html#callLater
  Function
  Method
  PUBLIC
  See twisted.internet.interfaces.IReactorTime.callLater.
- twisted.internet.base.ReactorBase._moveCallLaterSooner
  twisted.internet.base.ReactorBase.html#_moveCallLaterSooner
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet.base.ReactorBase._cancelCallLater
  twisted.internet.base.ReactorBase.html#_cancelCallLater
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet.base.ReactorBase.getDelayedCalls
  twisted.internet.base.ReactorBase.html#getDelayedCalls
  Function
  Method
  PUBLIC
  See `twisted.internet.interfaces.IReactorTime.getDelayedCalls`
- twisted.internet.base.ReactorBase._insertNewDelayedCalls
  twisted.internet.base.ReactorBase.html#_insertNewDelayedCalls
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet.base.ReactorBase.timeout
  twisted.internet.base.ReactorBase.html#timeout
  Function
  Method
  PUBLIC
  Determine the longest time the reactor may sleep (waiting on I/O notification, perhaps) before it must wake up to service a time-related event.
- twisted.internet.base.ReactorBase.runUntilCurrent
  twisted.internet.base.ReactorBase.html#runUntilCurrent
  Function
  Method
  PUBLIC
  Run all pending timed calls.
- twisted.internet.base.ReactorBase.threadpool
  twisted.internet.base.ReactorBase.html#threadpool
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.base.ReactorBase._threadpoolStartupID
  twisted.internet.base.ReactorBase.html#_threadpoolStartupID
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.base.ReactorBase.threadpoolShutdownID
  twisted.internet.base.ReactorBase.html#threadpoolShutdownID
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.base.ReactorBase._initThreads
  twisted.internet.base.ReactorBase.html#_initThreads
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet.base.ReactorBase.callFromThread
  twisted.internet.base.ReactorBase.html#callFromThread
  Function
  Method
  PUBLIC
  See `twisted.internet.interfaces.IReactorFromThreads.callFromThread`.
- twisted.internet.base.ReactorBase._initThreadPool
  twisted.internet.base.ReactorBase.html#_initThreadPool
  Function
  Method
  PRIVATE
  Create the threadpool accessible with callFromThread.
- twisted.internet.base.ReactorBase._uninstallHandler
  twisted.internet.base.ReactorBase.html#_uninstallHandler
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet.base.ReactorBase._stopThreadPool
  twisted.internet.base.ReactorBase.html#_stopThreadPool
  Function
  Method
  PRIVATE
  Stop the reactor threadpool. This method is only valid if there is currently a threadpool (created by `_initThreadPool`). It is not intended to be called directly; instead, it will be called by a shutdown trigger created in ...
- twisted.internet.base.ReactorBase.getThreadPool
  twisted.internet.base.ReactorBase.html#getThreadPool
  Function
  Method
  PUBLIC
  See `twisted.internet.interfaces.IReactorThreads.getThreadPool`.
- twisted.internet.base.ReactorBase.callInThread
  twisted.internet.base.ReactorBase.html#callInThread
  Function
  Method
  PUBLIC
  See `twisted.internet.interfaces.IReactorInThreads.callInThread`.
- twisted.internet.base.ReactorBase.suggestThreadPoolSize
  twisted.internet.base.ReactorBase.html#suggestThreadPoolSize
  Function
  Method
  PUBLIC
  See `twisted.internet.interfaces.IReactorThreads.suggestThreadPoolSize`.
- twisted.internet.base.BaseConnector
  twisted.internet.base.BaseConnector.html
  Class
  Class
  PUBLIC
  Basic implementation of `IConnector`.
- twisted.internet.base.BaseConnector.timeoutID
  twisted.internet.base.BaseConnector.html#timeoutID
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.base.BaseConnector.factoryStarted
  twisted.internet.base.BaseConnector.html#factoryStarted
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.base.BaseConnector.__init__
  twisted.internet.base.BaseConnector.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.base.BaseConnector.state
  twisted.internet.base.BaseConnector.html#state
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.base.BaseConnector.reactor
  twisted.internet.base.BaseConnector.html#reactor
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.base.BaseConnector.factory
  twisted.internet.base.BaseConnector.html#factory
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.base.BaseConnector.timeout
  twisted.internet.base.BaseConnector.html#timeout
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.base.BaseConnector.disconnect
  twisted.internet.base.BaseConnector.html#disconnect
  Function
  Method
  PUBLIC
  Disconnect whatever our state is.
- twisted.internet.base.BaseConnector._makeTransport
  twisted.internet.base.BaseConnector.html#_makeTransport
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet.base.BaseConnector.connect
  twisted.internet.base.BaseConnector.html#connect
  Function
  Method
  PUBLIC
  Start connection to remote server.
- twisted.internet.base.BaseConnector.transport
  twisted.internet.base.BaseConnector.html#transport
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.base.BaseConnector.stopConnecting
  twisted.internet.base.BaseConnector.html#stopConnecting
  Function
  Method
  PUBLIC
  Stop attempting to connect.
- twisted.internet.base.BaseConnector.cancelTimeout
  twisted.internet.base.BaseConnector.html#cancelTimeout
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.base.BaseConnector.buildProtocol
  twisted.internet.base.BaseConnector.html#buildProtocol
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.base.BaseConnector.connectionFailed
  twisted.internet.base.BaseConnector.html#connectionFailed
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.base.BaseConnector.connectionLost
  twisted.internet.base.BaseConnector.html#connectionLost
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.base.BaseConnector.getDestination
  twisted.internet.base.BaseConnector.html#getDestination
  Function
  Method
  PUBLIC
  Return destination this will try to connect to.
- twisted.internet.base.BaseConnector.__repr__
  twisted.internet.base.BaseConnector.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.base.BasePort
  twisted.internet.base.BasePort.html
  Class
  Class
  PUBLIC
  Basic implementation of a ListeningPort.
- twisted.internet.base.BasePort.addressFamily
  twisted.internet.base.BasePort.html#addressFamily
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet.base.BasePort.socketType
  twisted.internet.base.BasePort.html#socketType
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet.base.BasePort.createInternetSocket
  twisted.internet.base.BasePort.html#createInternetSocket
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.base.BasePort.doWrite
  twisted.internet.base.BasePort.html#doWrite
  Function
  Method
  PUBLIC
  Raises a RuntimeError
- twisted.internet.base._SignalReactorMixin
  twisted.internet.base._SignalReactorMixin.html
  Class
  Class
  PRIVATE
  Private mixin to manage signals: it installs signal handlers at start time, and define run method.
- twisted.internet.base._SignalReactorMixin._installSignalHandlers
  twisted.internet.base._SignalReactorMixin.html#_installSignalHandlers
  Attribute
  Instance Variable
  PRIVATE
  A flag which indicates whether any signal handlers will be installed during startup. This includes handlers for SIGCHLD to monitor child processes, and SIGINT, SIGTERM, and SIGBREAK to stop the reactor.
- twisted.internet.base._SignalReactorMixin._handleSignals
  twisted.internet.base._SignalReactorMixin.html#_handleSignals
  Function
  Method
  PRIVATE
  Install the signal handlers for the Twisted event loop.
- twisted.internet.base._SignalReactorMixin.startRunning
  twisted.internet.base._SignalReactorMixin.html#startRunning
  Function
  Method
  PUBLIC
  Extend the base implementation in order to remember whether signal handlers should be installed later.
- twisted.internet.base._SignalReactorMixin._reallyStartRunning
  twisted.internet.base._SignalReactorMixin.html#_reallyStartRunning
  Function
  Method
  PRIVATE
  Extend the base implementation by also installing signal handlers, if `self._installSignalHandlers` is true.
- twisted.internet.base._SignalReactorMixin.run
  twisted.internet.base._SignalReactorMixin.html#run
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.base._SignalReactorMixin.mainLoop
  twisted.internet.base._SignalReactorMixin.html#mainLoop
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.task._T
  twisted.internet.task.html#_T
  Attribute
  Type Variable
  PRIVATE
  Undocumented
- twisted.internet.task.LoopingCall
  twisted.internet.task.LoopingCall.html
  Class
  Class
  PUBLIC
  Call a function repeatedly.
- twisted.internet.task.LoopingCall.f
  twisted.internet.task.LoopingCall.html#f
  Attribute
  Instance Variable
  PUBLIC
  The function to call.
- twisted.internet.task.LoopingCall.a
  twisted.internet.task.LoopingCall.html#a
  Attribute
  Instance Variable
  PUBLIC
  A tuple of arguments to pass the function.
- twisted.internet.task.LoopingCall.kw
  twisted.internet.task.LoopingCall.html#kw
  Attribute
  Instance Variable
  PUBLIC
  A dictionary of keyword arguments to pass to the function.
- twisted.internet.task.LoopingCall.clock
  twisted.internet.task.LoopingCall.html#clock
  Attribute
  Instance Variable
  PUBLIC
  A provider of `twisted.internet.interfaces.IReactorTime`. The default is `twisted.internet.reactor`. Feel free to set this to something else, but it probably ought to be set *before* calling `start`.
- twisted.internet.task.LoopingCall.running
  twisted.internet.task.LoopingCall.html#running
  Attribute
  Instance Variable
  PUBLIC
  A flag which is `True` while `f` is scheduled to be called (or is currently being called). It is set to `True` when `start` is called and set to `False` when `stop` is called or if `f` raises an exception. In either case, it will be ...
- twisted.internet.task.LoopingCall._realLastTime
  twisted.internet.task.LoopingCall.html#_realLastTime
  Attribute
  Instance Variable
  PRIVATE
  When counting skips, the time at which the skip counter was last invoked.
- twisted.internet.task.LoopingCall._runAtStart
  twisted.internet.task.LoopingCall.html#_runAtStart
  Attribute
  Instance Variable
  PRIVATE
  A flag indicating whether the 'now' argument was passed to `LoopingCall.start`.
- twisted.internet.task.LoopingCall.call
  twisted.internet.task.LoopingCall.html#call
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.task.LoopingCall._deferred
  twisted.internet.task.LoopingCall.html#_deferred
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.task.LoopingCall.interval
  twisted.internet.task.LoopingCall.html#interval
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.task.LoopingCall.starttime
  twisted.internet.task.LoopingCall.html#starttime
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.task.LoopingCall.__init__
  twisted.internet.task.LoopingCall.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.task.LoopingCall.deferred
  twisted.internet.task.LoopingCall.html#deferred
  Attribute
  Property
  PUBLIC
  DEPRECATED. `Deferred` fired when loop stops or fails.
- twisted.internet.task.LoopingCall.withCount
  twisted.internet.task.LoopingCall.html#withCount
  Function
  Class Method
  PUBLIC
  An alternate constructor for `LoopingCall` that makes available the number of calls which should have occurred since it was last invoked.
- twisted.internet.task.LoopingCall._intervalOf
  twisted.internet.task.LoopingCall.html#_intervalOf
  Function
  Method
  PRIVATE
  Determine the number of intervals passed as of the given point in time.
- twisted.internet.task.LoopingCall.start
  twisted.internet.task.LoopingCall.html#start
  Function
  Method
  PUBLIC
  Start running function every interval seconds.
- twisted.internet.task.LoopingCall.stop
  twisted.internet.task.LoopingCall.html#stop
  Function
  Method
  PUBLIC
  Stop running function.
- twisted.internet.task.LoopingCall.reset
  twisted.internet.task.LoopingCall.html#reset
  Function
  Method
  PUBLIC
  Skip the next iteration and reset the timer.
- twisted.internet.task.LoopingCall.__call__
  twisted.internet.task.LoopingCall.html#__call__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.task.LoopingCall._scheduleFrom
  twisted.internet.task.LoopingCall.html#_scheduleFrom
  Function
  Method
  PRIVATE
  Schedule the next iteration of this looping call.
- twisted.internet.task.LoopingCall.__repr__
  twisted.internet.task.LoopingCall.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.task.SchedulerError
  twisted.internet.task.SchedulerError.html
  Class
  Exception
  PUBLIC
  The operation could not be completed because the scheduler or one of its tasks was in an invalid state. This exception should not be raised directly, but is a superclass of various scheduler-state-related exceptions.
- twisted.internet.task.SchedulerStopped
  twisted.internet.task.SchedulerStopped.html
  Class
  Exception
  PUBLIC
  The operation could not complete because the scheduler was stopped in progress or was already stopped.
- twisted.internet.task.TaskFinished
  twisted.internet.task.TaskFinished.html
  Class
  Exception
  PUBLIC
  The operation could not complete because the task was already completed, stopped, encountered an error or otherwise permanently stopped running.
- twisted.internet.task.TaskDone
  twisted.internet.task.TaskDone.html
  Class
  Exception
  PUBLIC
  The operation could not complete because the task was already completed.
- twisted.internet.task.TaskStopped
  twisted.internet.task.TaskStopped.html
  Class
  Exception
  PUBLIC
  The operation could not complete because the task was stopped.
- twisted.internet.task.TaskFailed
  twisted.internet.task.TaskFailed.html
  Class
  Exception
  PUBLIC
  The operation could not complete because the task died with an unhandled error.
- twisted.internet.task.NotPaused
  twisted.internet.task.NotPaused.html
  Class
  Exception
  PUBLIC
  This exception is raised when a task is resumed which was not previously paused.
- twisted.internet.task._Timer
  twisted.internet.task._Timer.html
  Class
  Class
  PRIVATE
  Undocumented
- twisted.internet.task._Timer.MAX_SLICE
  twisted.internet.task._Timer.html#MAX_SLICE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.task._Timer.__init__
  twisted.internet.task._Timer.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.task._Timer.end
  twisted.internet.task._Timer.html#end
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.task._Timer.__call__
  twisted.internet.task._Timer.html#__call__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.task._EPSILON
  twisted.internet.task.html#_EPSILON
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.internet.task._defaultScheduler
  twisted.internet.task.html#_defaultScheduler
  Function
  Function
  PRIVATE
  Undocumented
- twisted.internet.task._TaskResultT
  twisted.internet.task.html#_TaskResultT
  Attribute
  Type Variable
  PRIVATE
  Undocumented
- twisted.internet.task.CooperativeTask
  twisted.internet.task.CooperativeTask.html
  Class
  Class
  PUBLIC
  A `CooperativeTask` is a task object inside a `Cooperator`, which can be paused, resumed, and stopped. It can also have its completion (or termination) monitored.
- twisted.internet.task.CooperativeTask._iterator
  twisted.internet.task.CooperativeTask.html#_iterator
  Attribute
  Instance Variable
  PRIVATE
  the iterator to iterate when this `CooperativeTask` is asked to do work.
- twisted.internet.task.CooperativeTask._cooperator
  twisted.internet.task.CooperativeTask.html#_cooperator
  Attribute
  Instance Variable
  PRIVATE
  the `Cooperator` that this `CooperativeTask` participates in, which is used to re-insert it upon resume.
- twisted.internet.task.CooperativeTask._deferreds
  twisted.internet.task.CooperativeTask.html#_deferreds
  Attribute
  Instance Variable
  PRIVATE
  the list of `Deferred`s to fire when this task completes, fails, or finishes.
- twisted.internet.task.CooperativeTask._pauseCount
  twisted.internet.task.CooperativeTask.html#_pauseCount
  Attribute
  Instance Variable
  PRIVATE
  the number of times that this `CooperativeTask` has been paused; if 0, it is running.
- twisted.internet.task.CooperativeTask._completionState
  twisted.internet.task.CooperativeTask.html#_completionState
  Attribute
  Instance Variable
  PRIVATE
  The completion-state of this `CooperativeTask`. `None` if the task is not yet completed, an instance of `TaskStopped` if `stop` was called to stop this task early, of `TaskFailed` if the application code in the iterator raised an exception which caused it to terminate, and of ...
- twisted.internet.task.CooperativeTask.__init__
  twisted.internet.task.CooperativeTask.html#__init__
  Function
  Method
  PUBLIC
  A private constructor: to create a new `CooperativeTask`, see `Cooperator.cooperate`.
- twisted.internet.task.CooperativeTask._completionResult
  twisted.internet.task.CooperativeTask.html#_completionResult
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.task.CooperativeTask.whenDone
  twisted.internet.task.CooperativeTask.html#whenDone
  Function
  Method
  PUBLIC
  Get a `Deferred` notification of when this task is complete.
- twisted.internet.task.CooperativeTask.pause
  twisted.internet.task.CooperativeTask.html#pause
  Function
  Method
  PUBLIC
  Pause this `CooperativeTask`. Stop doing work until `CooperativeTask.resume` is called. If `pause` is called more than once, `resume` must be called an equal number of times to resume this task.
- twisted.internet.task.CooperativeTask.resume
  twisted.internet.task.CooperativeTask.html#resume
  Function
  Method
  PUBLIC
  Resume processing of a paused `CooperativeTask`.
- twisted.internet.task.CooperativeTask._completeWith
  twisted.internet.task.CooperativeTask.html#_completeWith
  Function
  Method
  PRIVATE
  No summary
- twisted.internet.task.CooperativeTask.stop
  twisted.internet.task.CooperativeTask.html#stop
  Function
  Method
  PUBLIC
  Stop further processing of this task.
- twisted.internet.task.CooperativeTask._checkFinish
  twisted.internet.task.CooperativeTask.html#_checkFinish
  Function
  Method
  PRIVATE
  If this task has been stopped, raise the appropriate subclass of `TaskFinished`.
- twisted.internet.task.CooperativeTask._oneWorkUnit
  twisted.internet.task.CooperativeTask.html#_oneWorkUnit
  Function
  Method
  PRIVATE
  Perform one unit of work for this task, retrieving one item from its iterator, stopping if there are no further items in the iterator, and pausing if the result was a `Deferred`.
- twisted.internet.task.Cooperator
  twisted.internet.task.Cooperator.html
  Class
  Class
  PUBLIC
  Cooperative task scheduler.
- twisted.internet.task.Cooperator.__init__
  twisted.internet.task.Cooperator.html#__init__
  Function
  Method
  PUBLIC
  Create a scheduler-like object to which iterators may be added.
- twisted.internet.task.Cooperator._tasks
  twisted.internet.task.Cooperator.html#_tasks
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.task.Cooperator._metarator
  twisted.internet.task.Cooperator.html#_metarator
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.task.Cooperator._terminationPredicateFactory
  twisted.internet.task.Cooperator.html#_terminationPredicateFactory
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.task.Cooperator._scheduler
  twisted.internet.task.Cooperator.html#_scheduler
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.task.Cooperator._delayedCall
  twisted.internet.task.Cooperator.html#_delayedCall
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.task.Cooperator._stopped
  twisted.internet.task.Cooperator.html#_stopped
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.task.Cooperator._started
  twisted.internet.task.Cooperator.html#_started
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.task.Cooperator.coiterate
  twisted.internet.task.Cooperator.html#coiterate
  Function
  Method
  PUBLIC
  Add an iterator to the list of iterators this `Cooperator` is currently running.
- twisted.internet.task.Cooperator.cooperate
  twisted.internet.task.Cooperator.html#cooperate
  Function
  Method
  PUBLIC
  Start running the given iterator as a long-running cooperative task, by calling next() on it as a periodic timed event.
- twisted.internet.task.Cooperator._addTask
  twisted.internet.task.Cooperator.html#_addTask
  Function
  Method
  PRIVATE
  Add a `CooperativeTask` object to this `Cooperator`.
- twisted.internet.task.Cooperator._removeTask
  twisted.internet.task.Cooperator.html#_removeTask
  Function
  Method
  PRIVATE
  Remove a `CooperativeTask` from this `Cooperator`.
- twisted.internet.task.Cooperator._tasksWhileNotStopped
  twisted.internet.task.Cooperator.html#_tasksWhileNotStopped
  Function
  Method
  PRIVATE
  Yield all `CooperativeTask` objects in a loop as long as this `Cooperator`'s termination condition has not been met.
- twisted.internet.task.Cooperator._tick
  twisted.internet.task.Cooperator.html#_tick
  Function
  Method
  PRIVATE
  Run one scheduler tick.
- twisted.internet.task.Cooperator._mustScheduleOnStart
  twisted.internet.task.Cooperator.html#_mustScheduleOnStart
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.task.Cooperator._reschedule
  twisted.internet.task.Cooperator.html#_reschedule
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet.task.Cooperator.start
  twisted.internet.task.Cooperator.html#start
  Function
  Method
  PUBLIC
  Begin scheduling steps.
- twisted.internet.task.Cooperator.stop
  twisted.internet.task.Cooperator.html#stop
  Function
  Method
  PUBLIC
  Stop scheduling steps. Errback the completion Deferreds of all iterators which have been added and forget about them.
- twisted.internet.task.Cooperator.running
  twisted.internet.task.Cooperator.html#running
  Attribute
  Property
  PUBLIC
  Is this `Cooperator` is currently running?
- twisted.internet.task._theCooperator
  twisted.internet.task.html#_theCooperator
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.internet.task.coiterate
  twisted.internet.task.html#coiterate
  Function
  Function
  PUBLIC
  Cooperatively iterate over the given iterator, dividing runtime between it and all other iterators which have been passed to this function and not yet exhausted.
- twisted.internet.task.cooperate
  twisted.internet.task.html#cooperate
  Function
  Function
  PUBLIC
  Start running the given iterator as a long-running cooperative task, by calling next() on it as a periodic timed event.
- twisted.internet.task.Clock
  twisted.internet.task.Clock.html
  Class
  Class
  PUBLIC
  Provide a deterministic, easily-controlled implementation of `IReactorTime.callLater`. This is commonly useful for writing deterministic unit tests for code which schedules events using this API.
- twisted.internet.task.Clock.rightNow
  twisted.internet.task.Clock.html#rightNow
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet.task.Clock.__init__
  twisted.internet.task.Clock.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.task.Clock.calls
  twisted.internet.task.Clock.html#calls
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.task.Clock.seconds
  twisted.internet.task.Clock.html#seconds
  Function
  Method
  PUBLIC
  Pretend to be time.time(). This is used internally when an operation such as `IDelayedCall.reset` needs to determine a time value relative to the current time.
- twisted.internet.task.Clock._sortCalls
  twisted.internet.task.Clock.html#_sortCalls
  Function
  Method
  PRIVATE
  Sort the pending calls according to the time they are scheduled.
- twisted.internet.task.Clock.callLater
  twisted.internet.task.Clock.html#callLater
  Function
  Method
  PUBLIC
  See `twisted.internet.interfaces.IReactorTime.callLater`.
- twisted.internet.task.Clock.getDelayedCalls
  twisted.internet.task.Clock.html#getDelayedCalls
  Function
  Method
  PUBLIC
  See `twisted.internet.interfaces.IReactorTime.getDelayedCalls`
- twisted.internet.task.Clock.advance
  twisted.internet.task.Clock.html#advance
  Function
  Method
  PUBLIC
  Move time on this clock forward by the given amount and run whatever pending calls should be run.
- twisted.internet.task.Clock.pump
  twisted.internet.task.Clock.html#pump
  Function
  Method
  PUBLIC
  Advance incrementally by the given set of times.
- twisted.internet.task.deferLater
  twisted.internet.task.html#deferLater
  Function
  Function
  PUBLIC
  Call the given function after a certain period of time has passed.
- twisted.internet.task.react
  twisted.internet.task.html#react
  Function
  Function
  PUBLIC
  Call `main` and run the reactor until the `Deferred` it returns fires or the coroutine it returns completes.
- twisted.internet._producer_helpers._PullToPush
  twisted.internet._producer_helpers._PullToPush.html
  Class
  Class
  PRIVATE
  An adapter that converts a non-streaming to a streaming producer.
- twisted.internet._producer_helpers._PullToPush._producer
  twisted.internet._producer_helpers._PullToPush.html#_producer
  Attribute
  Instance Variable
  PRIVATE
  the underling non-streaming producer.
- twisted.internet._producer_helpers._PullToPush._consumer
  twisted.internet._producer_helpers._PullToPush.html#_consumer
  Attribute
  Instance Variable
  PRIVATE
  the consumer with which the underlying producer was registered.
- twisted.internet._producer_helpers._PullToPush._finished
  twisted.internet._producer_helpers._PullToPush.html#_finished
  Attribute
  Instance Variable
  PRIVATE
  `bool` indicating whether the producer has finished.
- twisted.internet._producer_helpers._PullToPush._coopTask
  twisted.internet._producer_helpers._PullToPush.html#_coopTask
  Attribute
  Instance Variable
  PRIVATE
  the result of calling `cooperate`, the task driving the streaming producer.
- twisted.internet._producer_helpers._PullToPush.__init__
  twisted.internet._producer_helpers._PullToPush.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet._producer_helpers._PullToPush._pull
  twisted.internet._producer_helpers._PullToPush.html#_pull
  Function
  Method
  PRIVATE
  A generator that calls `resumeProducing` on the underlying producer forever.
- twisted.internet._producer_helpers._PullToPush.startStreaming
  twisted.internet._producer_helpers._PullToPush.html#startStreaming
  Function
  Method
  PUBLIC
  This should be called by the consumer when the producer is registered.
- twisted.internet._producer_helpers._PullToPush.stopStreaming
  twisted.internet._producer_helpers._PullToPush.html#stopStreaming
  Function
  Method
  PUBLIC
  This should be called by the consumer when the producer is unregistered.
- twisted.internet._producer_helpers._PullToPush.pauseProducing
  twisted.internet._producer_helpers._PullToPush.html#pauseProducing
  Function
  Method
  PUBLIC
  No summary
- twisted.internet._producer_helpers._PullToPush.resumeProducing
  twisted.internet._producer_helpers._PullToPush.html#resumeProducing
  Function
  Method
  PUBLIC
  No summary
- twisted.internet._producer_helpers._PullToPush.stopProducing
  twisted.internet._producer_helpers._PullToPush.html#stopProducing
  Function
  Method
  PUBLIC
  No summary
- twisted.python.randbytes.getrandbits
  twisted.python.randbytes.html#getrandbits
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.python.randbytes.SecureRandomNotAvailable
  twisted.python.randbytes.SecureRandomNotAvailable.html
  Class
  Exception
  PUBLIC
  Exception raised when no secure random algorithm is found.
- twisted.python.randbytes.SourceNotAvailable
  twisted.python.randbytes.SourceNotAvailable.html
  Class
  Exception
  PUBLIC
  Internal exception used when a specific random source is not available.
- twisted.python.randbytes.RandomFactory
  twisted.python.randbytes.RandomFactory.html
  Class
  Class
  PUBLIC
  Factory providing `secureRandom` and `insecureRandom` methods.
- twisted.python.randbytes.RandomFactory.randomSources
  twisted.python.randbytes.RandomFactory.html#randomSources
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.python.randbytes.RandomFactory._osUrandom
  twisted.python.randbytes.RandomFactory.html#_osUrandom
  Function
  Method
  PRIVATE
  Wrapper around `os.urandom` that cleanly manage its absence.
- twisted.python.randbytes.RandomFactory.secureRandom
  twisted.python.randbytes.RandomFactory.html#secureRandom
  Function
  Method
  PUBLIC
  Return a number of secure random bytes.
- twisted.python.randbytes.RandomFactory._randBits
  twisted.python.randbytes.RandomFactory.html#_randBits
  Function
  Method
  PRIVATE
  Wrapper around `os.getrandbits`.
- twisted.python.randbytes.RandomFactory._BYTES
  twisted.python.randbytes.RandomFactory.html#_BYTES
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.python.randbytes.RandomFactory._randModule
  twisted.python.randbytes.RandomFactory.html#_randModule
  Function
  Method
  PRIVATE
  Wrapper around the `random` module.
- twisted.python.randbytes.RandomFactory.insecureRandom
  twisted.python.randbytes.RandomFactory.html#insecureRandom
  Function
  Method
  PUBLIC
  Return a number of non secure random bytes.
- twisted.python.randbytes.factory
  twisted.python.randbytes.html#factory
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.internet._sslverify._tlsDisableFlags
  twisted.internet._sslverify.html#_tlsDisableFlags
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.internet._sslverify._getExcludedTLSProtocols
  twisted.internet._sslverify.html#_getExcludedTLSProtocols
  Function
  Function
  PRIVATE
  Given a pair of `TLSVersion` constants, figure out what versions we want to disable (as OpenSSL is an exclusion based API).
- twisted.internet._sslverify.SimpleVerificationError
  twisted.internet._sslverify.SimpleVerificationError.html
  Class
  Exception
  PUBLIC
  Not a very useful verification error.
- twisted.internet._sslverify.simpleVerifyHostname
  twisted.internet._sslverify.html#simpleVerifyHostname
  Function
  Function
  PUBLIC
  Check only the common name in the certificate presented by the peer and only for an exact match.
- twisted.internet._sslverify.simpleVerifyIPAddress
  twisted.internet._sslverify.html#simpleVerifyIPAddress
  Function
  Function
  PUBLIC
  Always fails validation of IP addresses
- twisted.internet._sslverify._usablePyOpenSSL
  twisted.internet._sslverify.html#_usablePyOpenSSL
  Function
  Function
  PRIVATE
  Check pyOpenSSL version string whether we can use it for host verification.
- twisted.internet._sslverify._selectVerifyImplementation
  twisted.internet._sslverify.html#_selectVerifyImplementation
  Function
  Function
  PRIVATE
  Determine if `service_identity` is installed. If so, use it. If not, use simplistic and incorrect checking as implemented in `simpleVerifyHostname`.
- twisted.internet._sslverify.verifyHostname
  twisted.internet._sslverify.html#verifyHostname
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.internet._sslverify.verifyIPAddress
  twisted.internet._sslverify.html#verifyIPAddress
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.internet._sslverify._x509names
  twisted.internet._sslverify.html#_x509names
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.internet._sslverify.CertBase
  twisted.internet._sslverify.CertBase.html
  Class
  Class
  PUBLIC
  Base class for public (certificate only) and private (certificate + key pair) certificates.
- twisted.internet._sslverify.CertBase.original
  twisted.internet._sslverify.CertBase.html#original
  Attribute
  Instance Variable
  PUBLIC
  The underlying OpenSSL certificate object.
- twisted.internet._sslverify.CertBase.__init__
  twisted.internet._sslverify.CertBase.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet._sslverify.CertBase._copyName
  twisted.internet._sslverify.CertBase.html#_copyName
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet._sslverify.CertBase.getSubject
  twisted.internet._sslverify.CertBase.html#getSubject
  Function
  Method
  PUBLIC
  Retrieve the subject of this certificate.
- twisted.internet._sslverify.CertBase.__conform__
  twisted.internet._sslverify.CertBase.html#__conform__
  Function
  Method
  PUBLIC
  Convert this `CertBase` into a provider of the given interface.
- twisted.internet._sslverify._handleattrhelper
  twisted.internet._sslverify.html#_handleattrhelper
  Function
  Function
  PRIVATE
  (private) Helper for `Certificate.peerFromTransport` and `Certificate.hostFromTransport` which checks for incompatible handle types and null certificates and raises the appropriate exception or returns the appropriate certificate object.
- twisted.internet._sslverify.PublicKey
  twisted.internet._sslverify.PublicKey.html
  Class
  Class
  PUBLIC
  A `PublicKey` is a representation of the public part of a key pair.
- twisted.internet._sslverify.PublicKey.original
  twisted.internet._sslverify.PublicKey.html#original
  Attribute
  Instance Variable
  PUBLIC
  The original private key.
- twisted.internet._sslverify.PublicKey.__init__
  twisted.internet._sslverify.PublicKey.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.internet._sslverify.PublicKey.matches
  twisted.internet._sslverify.PublicKey.html#matches
  Function
  Method
  PUBLIC
  Does this `PublicKey` contain the same value as another `PublicKey`?
- twisted.internet._sslverify.PublicKey.__repr__
  twisted.internet._sslverify.PublicKey.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet._sslverify.PublicKey.keyHash
  twisted.internet._sslverify.PublicKey.html#keyHash
  Function
  Method
  PUBLIC
  Compute a hash of the underlying PKey object.
- twisted.internet._sslverify.PublicKey.inspect
  twisted.internet._sslverify.PublicKey.html#inspect
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet._sslverify.IOpenSSLTrustRoot
  twisted.internet._sslverify.IOpenSSLTrustRoot.html
  Class
  Interface
  PUBLIC
  Trust settings for an OpenSSL context.
- twisted.internet._sslverify.IOpenSSLTrustRoot._addCACertsToContext
  twisted.internet._sslverify.IOpenSSLTrustRoot.html#_addCACertsToContext
  Function
  Method
  PRIVATE
  Add certificate-authority certificates to an SSL context whose connections should trust those authorities.
- twisted.internet._sslverify.OpenSSLCertificateAuthorities
  twisted.internet._sslverify.OpenSSLCertificateAuthorities.html
  Class
  Class
  PUBLIC
  Trust an explicitly specified set of certificates, represented by a list of `OpenSSL.crypto.X509` objects.
- twisted.internet._sslverify.OpenSSLCertificateAuthorities.__init__
  twisted.internet._sslverify.OpenSSLCertificateAuthorities.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.internet._sslverify.OpenSSLCertificateAuthorities._caCerts
  twisted.internet._sslverify.OpenSSLCertificateAuthorities.html#_caCerts
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet._sslverify.OpenSSLCertificateAuthorities._addCACertsToContext
  twisted.internet._sslverify.OpenSSLCertificateAuthorities.html#_addCACertsToContext
  Function
  Method
  PRIVATE
  Add certificate-authority certificates to an SSL context whose connections should trust those authorities.
- twisted.internet._sslverify._tolerateErrors
  twisted.internet._sslverify.html#_tolerateErrors
  Function
  Function
  PRIVATE
  Wrap up an `info_callback` for pyOpenSSL so that if something goes wrong the error is immediately logged and the connection is dropped if possible.
- twisted.internet._sslverify.ClientTLSOptions
  twisted.internet._sslverify.ClientTLSOptions.html
  Class
  Class
  PUBLIC
  Client creator for TLS.
- twisted.internet._sslverify.ClientTLSOptions._ctx
  twisted.internet._sslverify.ClientTLSOptions.html#_ctx
  Attribute
  Instance Variable
  PRIVATE
  The context to use for new connections.
- twisted.internet._sslverify.ClientTLSOptions._hostname
  twisted.internet._sslverify.ClientTLSOptions.html#_hostname
  Attribute
  Instance Variable
  PRIVATE
  The hostname to verify, as specified by the application, as some human-readable text.
- twisted.internet._sslverify.ClientTLSOptions._hostnameBytes
  twisted.internet._sslverify.ClientTLSOptions.html#_hostnameBytes
  Attribute
  Instance Variable
  PRIVATE
  The hostname to verify, decoded into IDNA-encoded bytes. This is passed to APIs which think that hostnames are bytes, such as OpenSSL's SNI implementation.
- twisted.internet._sslverify.ClientTLSOptions._hostnameASCII
  twisted.internet._sslverify.ClientTLSOptions.html#_hostnameASCII
  Attribute
  Instance Variable
  PRIVATE
  The hostname, as transcoded into IDNA ASCII-range unicode code points. This is pre-transcoded because the `service_identity` package is rather strict about requiring the `idna` package from PyPI for internationalized domain names, rather than working with Python's built-in (but sometimes broken) IDNA encoding...
- twisted.internet._sslverify.ClientTLSOptions._hostnameIsDnsName
  twisted.internet._sslverify.ClientTLSOptions.html#_hostnameIsDnsName
  Attribute
  Instance Variable
  PRIVATE
  Whether or not the `_hostname` is a DNSName. Will be `False` if `_hostname` is an IP address or `True` if `_hostname` is a DNSName
- twisted.internet._sslverify.ClientTLSOptions.__init__
  twisted.internet._sslverify.ClientTLSOptions.html#__init__
  Function
  Method
  PUBLIC
  Initialize `ClientTLSOptions`.
- twisted.internet._sslverify.ClientTLSOptions.clientConnectionForTLS
  twisted.internet._sslverify.ClientTLSOptions.html#clientConnectionForTLS
  Function
  Method
  PUBLIC
  Create a TLS connection for a client.
- twisted.internet._sslverify.ClientTLSOptions._identityVerifyingInfoCallback
  twisted.internet._sslverify.ClientTLSOptions.html#_identityVerifyingInfoCallback
  Function
  Method
  PRIVATE
  info_callback <http://pythonhosted.org/pyOpenSSL/api/ssl.html#OpenSSL.SSL.Context.set_info_callback> for pyOpenSSL that verifies the hostname in the presented certificate matches the one passed to this ...
- twisted.internet._sslverify.OpenSSLCipher
  twisted.internet._sslverify.OpenSSLCipher.html
  Class
  Class
  PUBLIC
  A representation of an OpenSSL cipher.
- twisted.internet._sslverify.OpenSSLCipher.fullName
  twisted.internet._sslverify.OpenSSLCipher.html#fullName
  Attribute
  Instance Variable
  PUBLIC
  The full name of the cipher. For example `u"ECDHE-RSA-AES256-GCM-SHA384"`.
- twisted.internet._sslverify._expandCipherString
  twisted.internet._sslverify.html#_expandCipherString
  Function
  Function
  PRIVATE
  Expand `cipherString` according to `method` and `options` to a tuple of explicit ciphers that are supported by the current platform.
- twisted.internet._sslverify._selectCiphers
  twisted.internet._sslverify.html#_selectCiphers
  Function
  Function
  PRIVATE
  Caclulate the acceptable list of ciphers from the ciphers we want and the ciphers we have support for.
- twisted.internet._sslverify.defaultCiphers
  twisted.internet._sslverify.html#defaultCiphers
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.internet._sslverify._defaultCurveName
  twisted.internet._sslverify.html#_defaultCurveName
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.internet._sslverify._ChooseDiffieHellmanEllipticCurve
  twisted.internet._sslverify._ChooseDiffieHellmanEllipticCurve.html
  Class
  Class
  PRIVATE
  Chooses the best elliptic curve for Elliptic Curve Diffie-Hellman key exchange, and provides a `configureECDHCurve` method to set the curve, when appropriate, on a new `OpenSSL.SSL.Context`.
- twisted.internet._sslverify._ChooseDiffieHellmanEllipticCurve.__init__
  twisted.internet._sslverify._ChooseDiffieHellmanEllipticCurve.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet._sslverify._ChooseDiffieHellmanEllipticCurve._openSSLlib
  twisted.internet._sslverify._ChooseDiffieHellmanEllipticCurve.html#_openSSLlib
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet._sslverify._ChooseDiffieHellmanEllipticCurve._openSSLcrypto
  twisted.internet._sslverify._ChooseDiffieHellmanEllipticCurve.html#_openSSLcrypto
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet._sslverify._ChooseDiffieHellmanEllipticCurve.configureECDHCurve
  twisted.internet._sslverify._ChooseDiffieHellmanEllipticCurve.html#configureECDHCurve
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet._sslverify._ChooseDiffieHellmanEllipticCurve._configureOpenSSL110
  twisted.internet._sslverify._ChooseDiffieHellmanEllipticCurve.html#_configureOpenSSL110
  Function
  Method
  PRIVATE
  OpenSSL 1.1.0 Contexts are preconfigured with an optimal set of ECDH curves. This method does nothing.
- twisted.internet._sslverify._ChooseDiffieHellmanEllipticCurve._configureOpenSSL102
  twisted.internet._sslverify._ChooseDiffieHellmanEllipticCurve.html#_configureOpenSSL102
  Function
  Method
  PRIVATE
  Have the context automatically choose elliptic curves for ECDH. Run on OpenSSL 1.0.2 and OpenSSL 1.1.0+, but only has an effect on OpenSSL 1.0.2.
- twisted.internet._sslverify._ChooseDiffieHellmanEllipticCurve._configureOpenSSL101
  twisted.internet._sslverify._ChooseDiffieHellmanEllipticCurve.html#_configureOpenSSL101
  Function
  Method
  PRIVATE
  Set the default elliptic curve for ECDH on the context. Only run on OpenSSL 1.0.1.
- twisted.internet._sslverify._ChooseDiffieHellmanEllipticCurve._configureOpenSSL101NoCurves
  twisted.internet._sslverify._ChooseDiffieHellmanEllipticCurve.html#_configureOpenSSL101NoCurves
  Function
  Method
  PRIVATE
  No elliptic curves are available on OpenSSL 1.0.1. We can't set anything, so do nothing.
- twisted.internet._sslverify._setAcceptableProtocols
  twisted.internet._sslverify.html#_setAcceptableProtocols
  Function
  Function
  PRIVATE
  Called to set up the `OpenSSL.SSL.Context` for doing NPN and/or ALPN negotiation.
- twisted.protocols.policies._wrappedLogPrefix
  twisted.protocols.policies.html#_wrappedLogPrefix
  Function
  Function
  PRIVATE
  Compute a log prefix for a wrapper and the object it wraps.
- twisted.protocols.policies.ProtocolWrapper
  twisted.protocols.policies.ProtocolWrapper.html
  Class
  Class
  PUBLIC
  Wraps protocol instances and acts as their transport as well.
- twisted.protocols.policies.ProtocolWrapper.wrappedProtocol
  twisted.protocols.policies.ProtocolWrapper.html#wrappedProtocol
  Attribute
  Instance Variable
  PUBLIC
  An `IProtocol` provider to which `IProtocol` method calls onto this `ProtocolWrapper` will be proxied.
- twisted.protocols.policies.ProtocolWrapper.factory
  twisted.protocols.policies.ProtocolWrapper.html#factory
  Attribute
  Instance Variable
  PUBLIC
  The `WrappingFactory` which created this `ProtocolWrapper`.
- twisted.protocols.policies.ProtocolWrapper.disconnecting
  twisted.protocols.policies.ProtocolWrapper.html#disconnecting
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.policies.ProtocolWrapper.__init__
  twisted.protocols.policies.ProtocolWrapper.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.policies.ProtocolWrapper.logPrefix
  twisted.protocols.policies.ProtocolWrapper.html#logPrefix
  Function
  Method
  PUBLIC
  Use a customized log prefix mentioning both the wrapped protocol and the current one.
- twisted.protocols.policies.ProtocolWrapper.makeConnection
  twisted.protocols.policies.ProtocolWrapper.html#makeConnection
  Function
  Method
  PUBLIC
  When a connection is made, register this wrapper with its factory, save the real transport, and connect the wrapped protocol to this `ProtocolWrapper` to intercept any transport calls it makes.
- twisted.protocols.policies.ProtocolWrapper.write
  twisted.protocols.policies.ProtocolWrapper.html#write
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.policies.ProtocolWrapper.writeSequence
  twisted.protocols.policies.ProtocolWrapper.html#writeSequence
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.policies.ProtocolWrapper.loseConnection
  twisted.protocols.policies.ProtocolWrapper.html#loseConnection
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.policies.ProtocolWrapper.getPeer
  twisted.protocols.policies.ProtocolWrapper.html#getPeer
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.policies.ProtocolWrapper.getHost
  twisted.protocols.policies.ProtocolWrapper.html#getHost
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.policies.ProtocolWrapper.registerProducer
  twisted.protocols.policies.ProtocolWrapper.html#registerProducer
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.policies.ProtocolWrapper.unregisterProducer
  twisted.protocols.policies.ProtocolWrapper.html#unregisterProducer
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.policies.ProtocolWrapper.stopConsuming
  twisted.protocols.policies.ProtocolWrapper.html#stopConsuming
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.policies.ProtocolWrapper.__getattr__
  twisted.protocols.policies.ProtocolWrapper.html#__getattr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.policies.ProtocolWrapper.dataReceived
  twisted.protocols.policies.ProtocolWrapper.html#dataReceived
  Function
  Method
  PUBLIC
  Called whenever data is received.
- twisted.protocols.policies.ProtocolWrapper.connectionLost
  twisted.protocols.policies.ProtocolWrapper.html#connectionLost
  Function
  Method
  PUBLIC
  Called when the connection is shut down.
- twisted.protocols.policies.WrappingFactory
  twisted.protocols.policies.WrappingFactory.html
  Class
  Class
  PUBLIC
  Wraps a factory and its protocols, and keeps track of them.
- twisted.protocols.policies.WrappingFactory.__init__
  twisted.protocols.policies.WrappingFactory.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.policies.WrappingFactory.wrappedFactory
  twisted.protocols.policies.WrappingFactory.html#wrappedFactory
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.policies.WrappingFactory.protocols
  twisted.protocols.policies.WrappingFactory.html#protocols
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.policies.WrappingFactory.logPrefix
  twisted.protocols.policies.WrappingFactory.html#logPrefix
  Function
  Method
  PUBLIC
  Generate a log prefix mentioning both the wrapped factory and this one.
- twisted.protocols.policies.WrappingFactory.doStart
  twisted.protocols.policies.WrappingFactory.html#doStart
  Function
  Method
  PUBLIC
  Make sure startFactory is called.
- twisted.protocols.policies.WrappingFactory.doStop
  twisted.protocols.policies.WrappingFactory.html#doStop
  Function
  Method
  PUBLIC
  Make sure stopFactory is called.
- twisted.protocols.policies.WrappingFactory.startedConnecting
  twisted.protocols.policies.WrappingFactory.html#startedConnecting
  Function
  Method
  PUBLIC
  Called when a connection has been started.
- twisted.protocols.policies.WrappingFactory.clientConnectionFailed
  twisted.protocols.policies.WrappingFactory.html#clientConnectionFailed
  Function
  Method
  PUBLIC
  Called when a connection has failed to connect.
- twisted.protocols.policies.WrappingFactory.clientConnectionLost
  twisted.protocols.policies.WrappingFactory.html#clientConnectionLost
  Function
  Method
  PUBLIC
  Called when an established connection is lost.
- twisted.protocols.policies.WrappingFactory.buildProtocol
  twisted.protocols.policies.WrappingFactory.html#buildProtocol
  Function
  Method
  PUBLIC
  Create an instance of a subclass of Protocol.
- twisted.protocols.policies.WrappingFactory.registerProtocol
  twisted.protocols.policies.WrappingFactory.html#registerProtocol
  Function
  Method
  PUBLIC
  Called by protocol to register itself.
- twisted.protocols.policies.WrappingFactory.unregisterProtocol
  twisted.protocols.policies.WrappingFactory.html#unregisterProtocol
  Function
  Method
  PUBLIC
  Called by protocols when they go away.
- twisted.protocols.policies.ThrottlingProtocol
  twisted.protocols.policies.ThrottlingProtocol.html
  Class
  Class
  PUBLIC
  Protocol for `ThrottlingFactory`.
- twisted.protocols.policies.ThrottlingProtocol.write
  twisted.protocols.policies.ThrottlingProtocol.html#write
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.policies.ThrottlingProtocol.writeSequence
  twisted.protocols.policies.ThrottlingProtocol.html#writeSequence
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.policies.ThrottlingProtocol.dataReceived
  twisted.protocols.policies.ThrottlingProtocol.html#dataReceived
  Function
  Method
  PUBLIC
  Called whenever data is received.
- twisted.protocols.policies.ThrottlingProtocol.registerProducer
  twisted.protocols.policies.ThrottlingProtocol.html#registerProducer
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.policies.ThrottlingProtocol.producer
  twisted.protocols.policies.ThrottlingProtocol.html#producer
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.policies.ThrottlingProtocol.unregisterProducer
  twisted.protocols.policies.ThrottlingProtocol.html#unregisterProducer
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.policies.ThrottlingProtocol.throttleReads
  twisted.protocols.policies.ThrottlingProtocol.html#throttleReads
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.policies.ThrottlingProtocol.unthrottleReads
  twisted.protocols.policies.ThrottlingProtocol.html#unthrottleReads
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.policies.ThrottlingProtocol.throttleWrites
  twisted.protocols.policies.ThrottlingProtocol.html#throttleWrites
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.policies.ThrottlingProtocol.unthrottleWrites
  twisted.protocols.policies.ThrottlingProtocol.html#unthrottleWrites
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.policies.ThrottlingFactory
  twisted.protocols.policies.ThrottlingFactory.html
  Class
  Class
  PUBLIC
  Throttles bandwidth and number of connections.
- twisted.protocols.policies.ThrottlingFactory.__init__
  twisted.protocols.policies.ThrottlingFactory.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.policies.ThrottlingFactory.connectionCount
  twisted.protocols.policies.ThrottlingFactory.html#connectionCount
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.policies.ThrottlingFactory.maxConnectionCount
  twisted.protocols.policies.ThrottlingFactory.html#maxConnectionCount
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.policies.ThrottlingFactory.readLimit
  twisted.protocols.policies.ThrottlingFactory.html#readLimit
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.policies.ThrottlingFactory.writeLimit
  twisted.protocols.policies.ThrottlingFactory.html#writeLimit
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.policies.ThrottlingFactory.readThisSecond
  twisted.protocols.policies.ThrottlingFactory.html#readThisSecond
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.policies.ThrottlingFactory.writtenThisSecond
  twisted.protocols.policies.ThrottlingFactory.html#writtenThisSecond
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.policies.ThrottlingFactory.unthrottleReadsID
  twisted.protocols.policies.ThrottlingFactory.html#unthrottleReadsID
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.policies.ThrottlingFactory.checkReadBandwidthID
  twisted.protocols.policies.ThrottlingFactory.html#checkReadBandwidthID
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.policies.ThrottlingFactory.unthrottleWritesID
  twisted.protocols.policies.ThrottlingFactory.html#unthrottleWritesID
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.policies.ThrottlingFactory.checkWriteBandwidthID
  twisted.protocols.policies.ThrottlingFactory.html#checkWriteBandwidthID
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.policies.ThrottlingFactory.callLater
  twisted.protocols.policies.ThrottlingFactory.html#callLater
  Function
  Method
  PUBLIC
  Wrapper around `reactor.callLater` for test purpose.
- twisted.protocols.policies.ThrottlingFactory.registerWritten
  twisted.protocols.policies.ThrottlingFactory.html#registerWritten
  Function
  Method
  PUBLIC
  Called by protocol to tell us more bytes were written.
- twisted.protocols.policies.ThrottlingFactory.registerRead
  twisted.protocols.policies.ThrottlingFactory.html#registerRead
  Function
  Method
  PUBLIC
  Called by protocol to tell us more bytes were read.
- twisted.protocols.policies.ThrottlingFactory.checkReadBandwidth
  twisted.protocols.policies.ThrottlingFactory.html#checkReadBandwidth
  Function
  Method
  PUBLIC
  Checks if we've passed bandwidth limits.
- twisted.protocols.policies.ThrottlingFactory.checkWriteBandwidth
  twisted.protocols.policies.ThrottlingFactory.html#checkWriteBandwidth
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.policies.ThrottlingFactory.throttleReads
  twisted.protocols.policies.ThrottlingFactory.html#throttleReads
  Function
  Method
  PUBLIC
  Throttle reads on all protocols.
- twisted.protocols.policies.ThrottlingFactory.unthrottleReads
  twisted.protocols.policies.ThrottlingFactory.html#unthrottleReads
  Function
  Method
  PUBLIC
  Stop throttling reads on all protocols.
- twisted.protocols.policies.ThrottlingFactory.throttleWrites
  twisted.protocols.policies.ThrottlingFactory.html#throttleWrites
  Function
  Method
  PUBLIC
  Throttle writes on all protocols.
- twisted.protocols.policies.ThrottlingFactory.unthrottleWrites
  twisted.protocols.policies.ThrottlingFactory.html#unthrottleWrites
  Function
  Method
  PUBLIC
  Stop throttling writes on all protocols.
- twisted.protocols.policies.ThrottlingFactory.buildProtocol
  twisted.protocols.policies.ThrottlingFactory.html#buildProtocol
  Function
  Method
  PUBLIC
  Create an instance of a subclass of Protocol.
- twisted.protocols.policies.ThrottlingFactory.unregisterProtocol
  twisted.protocols.policies.ThrottlingFactory.html#unregisterProtocol
  Function
  Method
  PUBLIC
  Called by protocols when they go away.
- twisted.protocols.policies.SpewingProtocol
  twisted.protocols.policies.SpewingProtocol.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.protocols.policies.SpewingProtocol.dataReceived
  twisted.protocols.policies.SpewingProtocol.html#dataReceived
  Function
  Method
  PUBLIC
  Called whenever data is received.
- twisted.protocols.policies.SpewingProtocol.write
  twisted.protocols.policies.SpewingProtocol.html#write
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.policies.SpewingFactory
  twisted.protocols.policies.SpewingFactory.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.protocols.policies.LimitConnectionsByPeer
  twisted.protocols.policies.LimitConnectionsByPeer.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.protocols.policies.LimitConnectionsByPeer.maxConnectionsPerPeer
  twisted.protocols.policies.LimitConnectionsByPeer.html#maxConnectionsPerPeer
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.protocols.policies.LimitConnectionsByPeer.startFactory
  twisted.protocols.policies.LimitConnectionsByPeer.html#startFactory
  Function
  Method
  PUBLIC
  This will be called before I begin listening on a Port or Connector.
- twisted.protocols.policies.LimitConnectionsByPeer.peerConnections
  twisted.protocols.policies.LimitConnectionsByPeer.html#peerConnections
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.policies.LimitConnectionsByPeer.buildProtocol
  twisted.protocols.policies.LimitConnectionsByPeer.html#buildProtocol
  Function
  Method
  PUBLIC
  Create an instance of a subclass of Protocol.
- twisted.protocols.policies.LimitConnectionsByPeer.unregisterProtocol
  twisted.protocols.policies.LimitConnectionsByPeer.html#unregisterProtocol
  Function
  Method
  PUBLIC
  Called by protocols when they go away.
- twisted.protocols.policies.LimitTotalConnectionsFactory
  twisted.protocols.policies.LimitTotalConnectionsFactory.html
  Class
  Class
  PUBLIC
  Factory that limits the number of simultaneous connections.
- twisted.protocols.policies.LimitTotalConnectionsFactory.connectionCount
  twisted.protocols.policies.LimitTotalConnectionsFactory.html#connectionCount
  Attribute
  Instance Variable
  PUBLIC
  number of current connections.
- twisted.protocols.policies.LimitTotalConnectionsFactory.connectionLimit
  twisted.protocols.policies.LimitTotalConnectionsFactory.html#connectionLimit
  Attribute
  Class Variable
  PUBLIC
  maximum number of connections.
- twisted.protocols.policies.LimitTotalConnectionsFactory.overflowProtocol
  twisted.protocols.policies.LimitTotalConnectionsFactory.html#overflowProtocol
  Attribute
  Class Variable
  PUBLIC
  Protocol to use for new connections when connectionLimit is exceeded. If `None` (the default value), excess connections will be closed immediately.
- twisted.protocols.policies.LimitTotalConnectionsFactory.buildProtocol
  twisted.protocols.policies.LimitTotalConnectionsFactory.html#buildProtocol
  Function
  Method
  PUBLIC
  Create an instance of a subclass of Protocol.
- twisted.protocols.policies.LimitTotalConnectionsFactory.registerProtocol
  twisted.protocols.policies.LimitTotalConnectionsFactory.html#registerProtocol
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.policies.LimitTotalConnectionsFactory.unregisterProtocol
  twisted.protocols.policies.LimitTotalConnectionsFactory.html#unregisterProtocol
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.policies.TimeoutProtocol
  twisted.protocols.policies.TimeoutProtocol.html
  Class
  Class
  PUBLIC
  Protocol that automatically disconnects when the connection is idle.
- twisted.protocols.policies.TimeoutProtocol.__init__
  twisted.protocols.policies.TimeoutProtocol.html#__init__
  Function
  Method
  PUBLIC
  Constructor.
- twisted.protocols.policies.TimeoutProtocol.timeoutCall
  twisted.protocols.policies.TimeoutProtocol.html#timeoutCall
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.policies.TimeoutProtocol.timeoutPeriod
  twisted.protocols.policies.TimeoutProtocol.html#timeoutPeriod
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.policies.TimeoutProtocol.setTimeout
  twisted.protocols.policies.TimeoutProtocol.html#setTimeout
  Function
  Method
  PUBLIC
  Set a timeout.
- twisted.protocols.policies.TimeoutProtocol.cancelTimeout
  twisted.protocols.policies.TimeoutProtocol.html#cancelTimeout
  Function
  Method
  PUBLIC
  Cancel the timeout.
- twisted.protocols.policies.TimeoutProtocol.resetTimeout
  twisted.protocols.policies.TimeoutProtocol.html#resetTimeout
  Function
  Method
  PUBLIC
  Reset the timeout, usually because some activity just happened.
- twisted.protocols.policies.TimeoutProtocol.write
  twisted.protocols.policies.TimeoutProtocol.html#write
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.policies.TimeoutProtocol.writeSequence
  twisted.protocols.policies.TimeoutProtocol.html#writeSequence
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.policies.TimeoutProtocol.dataReceived
  twisted.protocols.policies.TimeoutProtocol.html#dataReceived
  Function
  Method
  PUBLIC
  Called whenever data is received.
- twisted.protocols.policies.TimeoutProtocol.connectionLost
  twisted.protocols.policies.TimeoutProtocol.html#connectionLost
  Function
  Method
  PUBLIC
  Called when the connection is shut down.
- twisted.protocols.policies.TimeoutProtocol.timeoutFunc
  twisted.protocols.policies.TimeoutProtocol.html#timeoutFunc
  Function
  Method
  PUBLIC
  This method is called when the timeout is triggered.
- twisted.protocols.policies.TimeoutFactory
  twisted.protocols.policies.TimeoutFactory.html
  Class
  Class
  PUBLIC
  Factory for TimeoutWrapper.
- twisted.protocols.policies.TimeoutFactory.__init__
  twisted.protocols.policies.TimeoutFactory.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.policies.TimeoutFactory.timeoutPeriod
  twisted.protocols.policies.TimeoutFactory.html#timeoutPeriod
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.policies.TimeoutFactory.buildProtocol
  twisted.protocols.policies.TimeoutFactory.html#buildProtocol
  Function
  Method
  PUBLIC
  Create an instance of a subclass of Protocol.
- twisted.protocols.policies.TimeoutFactory.callLater
  twisted.protocols.policies.TimeoutFactory.html#callLater
  Function
  Method
  PUBLIC
  Wrapper around `reactor.callLater` for test purpose.
- twisted.protocols.policies.TrafficLoggingProtocol
  twisted.protocols.policies.TrafficLoggingProtocol.html
  Class
  Class
  PUBLIC
  No class docstring; 0/3 instance variable, 1/9 method documented
- twisted.protocols.policies.TrafficLoggingProtocol.__init__
  twisted.protocols.policies.TrafficLoggingProtocol.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.protocols.policies.TrafficLoggingProtocol.logfile
  twisted.protocols.policies.TrafficLoggingProtocol.html#logfile
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.policies.TrafficLoggingProtocol.lengthLimit
  twisted.protocols.policies.TrafficLoggingProtocol.html#lengthLimit
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.policies.TrafficLoggingProtocol._number
  twisted.protocols.policies.TrafficLoggingProtocol.html#_number
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.protocols.policies.TrafficLoggingProtocol._log
  twisted.protocols.policies.TrafficLoggingProtocol.html#_log
  Function
  Method
  PRIVATE
  Undocumented
- twisted.protocols.policies.TrafficLoggingProtocol._mungeData
  twisted.protocols.policies.TrafficLoggingProtocol.html#_mungeData
  Function
  Method
  PRIVATE
  Undocumented
- twisted.protocols.policies.TrafficLoggingProtocol.connectionMade
  twisted.protocols.policies.TrafficLoggingProtocol.html#connectionMade
  Function
  Method
  PUBLIC
  Called when a connection is made.
- twisted.protocols.policies.TrafficLoggingProtocol.dataReceived
  twisted.protocols.policies.TrafficLoggingProtocol.html#dataReceived
  Function
  Method
  PUBLIC
  Called whenever data is received.
- twisted.protocols.policies.TrafficLoggingProtocol.connectionLost
  twisted.protocols.policies.TrafficLoggingProtocol.html#connectionLost
  Function
  Method
  PUBLIC
  Called when the connection is shut down.
- twisted.protocols.policies.TrafficLoggingProtocol.write
  twisted.protocols.policies.TrafficLoggingProtocol.html#write
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.policies.TrafficLoggingProtocol.writeSequence
  twisted.protocols.policies.TrafficLoggingProtocol.html#writeSequence
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.policies.TrafficLoggingProtocol.loseConnection
  twisted.protocols.policies.TrafficLoggingProtocol.html#loseConnection
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.policies.TrafficLoggingFactory
  twisted.protocols.policies.TrafficLoggingFactory.html
  Class
  Class
  PUBLIC
  No class docstring; 0/3 instance variable, 1/4 method documented
- twisted.protocols.policies.TrafficLoggingFactory._counter
  twisted.protocols.policies.TrafficLoggingFactory.html#_counter
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.protocols.policies.TrafficLoggingFactory.__init__
  twisted.protocols.policies.TrafficLoggingFactory.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.policies.TrafficLoggingFactory.logfilePrefix
  twisted.protocols.policies.TrafficLoggingFactory.html#logfilePrefix
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.policies.TrafficLoggingFactory.lengthLimit
  twisted.protocols.policies.TrafficLoggingFactory.html#lengthLimit
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.policies.TrafficLoggingFactory.open
  twisted.protocols.policies.TrafficLoggingFactory.html#open
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.policies.TrafficLoggingFactory.buildProtocol
  twisted.protocols.policies.TrafficLoggingFactory.html#buildProtocol
  Function
  Method
  PUBLIC
  Create an instance of a subclass of Protocol.
- twisted.protocols.policies.TrafficLoggingFactory.resetCounter
  twisted.protocols.policies.TrafficLoggingFactory.html#resetCounter
  Function
  Method
  PUBLIC
  Reset the value of the counter used to identify connections.
- twisted.protocols.policies.TimeoutMixin
  twisted.protocols.policies.TimeoutMixin.html
  Class
  Class
  PUBLIC
  Mixin for protocols which wish to timeout connections.
- twisted.protocols.policies.TimeoutMixin.timeOut
  twisted.protocols.policies.TimeoutMixin.html#timeOut
  Attribute
  Instance Variable
  PUBLIC
  The number of seconds after which to timeout the connection.
- twisted.protocols.policies.TimeoutMixin.__timeoutCall
  twisted.protocols.policies.TimeoutMixin.html#__timeoutCall
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.protocols.policies.TimeoutMixin.callLater
  twisted.protocols.policies.TimeoutMixin.html#callLater
  Function
  Method
  PUBLIC
  Wrapper around `reactor.callLater` for test purpose.
- twisted.protocols.policies.TimeoutMixin.resetTimeout
  twisted.protocols.policies.TimeoutMixin.html#resetTimeout
  Function
  Method
  PUBLIC
  Reset the timeout count down.
- twisted.protocols.policies.TimeoutMixin.setTimeout
  twisted.protocols.policies.TimeoutMixin.html#setTimeout
  Function
  Method
  PUBLIC
  Change the timeout period
- twisted.protocols.policies.TimeoutMixin.__timedOut
  twisted.protocols.policies.TimeoutMixin.html#__timedOut
  Function
  Method
  PRIVATE
  Undocumented
- twisted.protocols.policies.TimeoutMixin.timeoutConnection
  twisted.protocols.policies.TimeoutMixin.html#timeoutConnection
  Function
  Method
  PUBLIC
  Called when the connection times out.
- twisted.protocols.tls._ProducerMembrane
  twisted.protocols.tls._ProducerMembrane.html
  Class
  Class
  PRIVATE
  Stand-in for producer registered with a `TLSMemoryBIOProtocol` transport.
- twisted.protocols.tls._ProducerMembrane._producer
  twisted.protocols.tls._ProducerMembrane.html#_producer
  Attribute
  Instance Variable
  PRIVATE
  The application-layer producer.
- twisted.protocols.tls._ProducerMembrane._producerPaused
  twisted.protocols.tls._ProducerMembrane.html#_producerPaused
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.protocols.tls._ProducerMembrane.__init__
  twisted.protocols.tls._ProducerMembrane.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.tls._ProducerMembrane.pauseProducing
  twisted.protocols.tls._ProducerMembrane.html#pauseProducing
  Function
  Method
  PUBLIC
  `pauseProducing` the underlying producer, if it's not paused.
- twisted.protocols.tls._ProducerMembrane.resumeProducing
  twisted.protocols.tls._ProducerMembrane.html#resumeProducing
  Function
  Method
  PUBLIC
  `resumeProducing` the underlying producer, if it's paused.
- twisted.protocols.tls._ProducerMembrane.stopProducing
  twisted.protocols.tls._ProducerMembrane.html#stopProducing
  Function
  Method
  PUBLIC
  `stopProducing` the underlying producer.
- twisted.protocols.tls.TLSMemoryBIOProtocol
  twisted.protocols.tls.TLSMemoryBIOProtocol.html
  Class
  Class
  PUBLIC
  `TLSMemoryBIOProtocol` is a protocol wrapper which uses OpenSSL via a memory BIO to encrypt bytes written to it before sending them on to the underlying transport and decrypts bytes received from the underlying transport before delivering them to the wrapped protocol.
- twisted.protocols.tls.TLSMemoryBIOProtocol._tlsConnection
  twisted.protocols.tls.TLSMemoryBIOProtocol.html#_tlsConnection
  Attribute
  Instance Variable
  PRIVATE
  The `OpenSSL.SSL.Connection` instance which is encrypted and decrypting this connection.
- twisted.protocols.tls.TLSMemoryBIOProtocol._lostTLSConnection
  twisted.protocols.tls.TLSMemoryBIOProtocol.html#_lostTLSConnection
  Attribute
  Instance Variable
  PRIVATE
  A flag indicating whether connection loss has already been dealt with (`True`) or not (`False`). TLS disconnection is distinct from the underlying connection being lost.
- twisted.protocols.tls.TLSMemoryBIOProtocol._appSendBuffer
  twisted.protocols.tls.TLSMemoryBIOProtocol.html#_appSendBuffer
  Attribute
  Instance Variable
  PRIVATE
  application-level (cleartext) data that is waiting to be transferred to the TLS buffer, but can't be because the TLS connection is handshaking.
- twisted.protocols.tls.TLSMemoryBIOProtocol._connectWrapped
  twisted.protocols.tls.TLSMemoryBIOProtocol.html#_connectWrapped
  Attribute
  Instance Variable
  PRIVATE
  A flag indicating whether or not to call `makeConnection` on the wrapped protocol. This is for the reactor's `twisted.internet.interfaces.ITLSTransport.startTLS` implementation, since it has a protocol which it has already called ...
- twisted.protocols.tls.TLSMemoryBIOProtocol._handshakeDone
  twisted.protocols.tls.TLSMemoryBIOProtocol.html#_handshakeDone
  Attribute
  Instance Variable
  PRIVATE
  A flag indicating whether or not the handshake is known to have completed successfully (`True`) or not (`False`). This is used to control error reporting behavior. If the handshake has not completed, the underlying ...
- twisted.protocols.tls.TLSMemoryBIOProtocol._reason
  twisted.protocols.tls.TLSMemoryBIOProtocol.html#_reason
  Attribute
  Instance Variable
  PRIVATE
  If an unexpected `OpenSSL.SSL.Error` occurs which causes the connection to be lost, it is saved here. If appropriate, this may be used as the reason passed to the application protocol's `connectionLost` method.
- twisted.protocols.tls.TLSMemoryBIOProtocol._producer
  twisted.protocols.tls.TLSMemoryBIOProtocol.html#_producer
  Attribute
  Instance Variable
  PRIVATE
  The current producer registered via `registerProducer`, or `None` if no producer has been registered or a previous one was unregistered.
- twisted.protocols.tls.TLSMemoryBIOProtocol._aborted
  twisted.protocols.tls.TLSMemoryBIOProtocol.html#_aborted
  Attribute
  Instance Variable
  PRIVATE
  `abortConnection` has been called. No further data will be received to the wrapped protocol's `dataReceived`.
- twisted.protocols.tls.TLSMemoryBIOProtocol.__init__
  twisted.protocols.tls.TLSMemoryBIOProtocol.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.tls.TLSMemoryBIOProtocol.getHandle
  twisted.protocols.tls.TLSMemoryBIOProtocol.html#getHandle
  Function
  Method
  PUBLIC
  Return the `OpenSSL.SSL.Connection` object being used to encrypt and decrypt this connection.
- twisted.protocols.tls.TLSMemoryBIOProtocol.makeConnection
  twisted.protocols.tls.TLSMemoryBIOProtocol.html#makeConnection
  Function
  Method
  PUBLIC
  Connect this wrapper to the given transport and initialize the necessary `OpenSSL.SSL.Connection` with a memory BIO.
- twisted.protocols.tls.TLSMemoryBIOProtocol._checkHandshakeStatus
  twisted.protocols.tls.TLSMemoryBIOProtocol.html#_checkHandshakeStatus
  Function
  Method
  PRIVATE
  Ask OpenSSL to proceed with a handshake in progress.
- twisted.protocols.tls.TLSMemoryBIOProtocol._flushSendBIO
  twisted.protocols.tls.TLSMemoryBIOProtocol.html#_flushSendBIO
  Function
  Method
  PRIVATE
  Read any bytes out of the send BIO and write them to the underlying transport.
- twisted.protocols.tls.TLSMemoryBIOProtocol._flushReceiveBIO
  twisted.protocols.tls.TLSMemoryBIOProtocol.html#_flushReceiveBIO
  Function
  Method
  PRIVATE
  Try to receive any application-level bytes which are now available because of a previous write into the receive BIO. This will take care of delivering any application-level bytes which are received to the protocol, as well as handling of the various exceptions which can come from trying to get such bytes.
- twisted.protocols.tls.TLSMemoryBIOProtocol.dataReceived
  twisted.protocols.tls.TLSMemoryBIOProtocol.html#dataReceived
  Function
  Method
  PUBLIC
  Deliver any received bytes to the receive BIO and then read and deliver to the application any application-level data which becomes available as a result of this.
- twisted.protocols.tls.TLSMemoryBIOProtocol._shutdownTLS
  twisted.protocols.tls.TLSMemoryBIOProtocol.html#_shutdownTLS
  Function
  Method
  PRIVATE
  Initiate, or reply to, the shutdown handshake of the TLS layer.
- twisted.protocols.tls.TLSMemoryBIOProtocol._tlsShutdownFinished
  twisted.protocols.tls.TLSMemoryBIOProtocol.html#_tlsShutdownFinished
  Function
  Method
  PRIVATE
  Called when TLS connection has gone away; tell underlying transport to disconnect.
- twisted.protocols.tls.TLSMemoryBIOProtocol.connectionLost
  twisted.protocols.tls.TLSMemoryBIOProtocol.html#connectionLost
  Function
  Method
  PUBLIC
  Handle the possible repetition of calls to this method (due to either the underlying transport going away or due to an error at the TLS layer) and make sure the base implementation only gets invoked once.
- twisted.protocols.tls.TLSMemoryBIOProtocol.connected
  twisted.protocols.tls.TLSMemoryBIOProtocol.html#connected
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.tls.TLSMemoryBIOProtocol.loseConnection
  twisted.protocols.tls.TLSMemoryBIOProtocol.html#loseConnection
  Function
  Method
  PUBLIC
  Send a TLS close alert and close the underlying connection.
- twisted.protocols.tls.TLSMemoryBIOProtocol.disconnecting
  twisted.protocols.tls.TLSMemoryBIOProtocol.html#disconnecting
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.tls.TLSMemoryBIOProtocol.abortConnection
  twisted.protocols.tls.TLSMemoryBIOProtocol.html#abortConnection
  Function
  Method
  PUBLIC
  Tear down TLS state so that if the connection is aborted mid-handshake we don't deliver any further data from the application.
- twisted.protocols.tls.TLSMemoryBIOProtocol.failVerification
  twisted.protocols.tls.TLSMemoryBIOProtocol.html#failVerification
  Function
  Method
  PUBLIC
  Abort the connection during connection setup, giving a reason that certificate verification failed.
- twisted.protocols.tls.TLSMemoryBIOProtocol.write
  twisted.protocols.tls.TLSMemoryBIOProtocol.html#write
  Function
  Method
  PUBLIC
  Process the given application bytes and send any resulting TLS traffic which arrives in the send BIO.
- twisted.protocols.tls.TLSMemoryBIOProtocol._bufferedWrite
  twisted.protocols.tls.TLSMemoryBIOProtocol.html#_bufferedWrite
  Function
  Method
  PRIVATE
  Put the given octets into `TLSMemoryBIOProtocol._appSendBuffer`, and tell any listening producer that it should pause because we are now buffering.
- twisted.protocols.tls.TLSMemoryBIOProtocol._unbufferPendingWrites
  twisted.protocols.tls.TLSMemoryBIOProtocol.html#_unbufferPendingWrites
  Function
  Method
  PRIVATE
  Un-buffer all waiting writes in `TLSMemoryBIOProtocol._appSendBuffer`.
- twisted.protocols.tls.TLSMemoryBIOProtocol._write
  twisted.protocols.tls.TLSMemoryBIOProtocol.html#_write
  Function
  Method
  PRIVATE
  Process the given application bytes and send any resulting TLS traffic which arrives in the send BIO.
- twisted.protocols.tls.TLSMemoryBIOProtocol.writeSequence
  twisted.protocols.tls.TLSMemoryBIOProtocol.html#writeSequence
  Function
  Method
  PUBLIC
  Write a sequence of application bytes by joining them into one string and passing them to `write`.
- twisted.protocols.tls.TLSMemoryBIOProtocol.getPeerCertificate
  twisted.protocols.tls.TLSMemoryBIOProtocol.html#getPeerCertificate
  Function
  Method
  PUBLIC
  Return an object with the peer's certificate info.
- twisted.protocols.tls.TLSMemoryBIOProtocol.negotiatedProtocol
  twisted.protocols.tls.TLSMemoryBIOProtocol.html#negotiatedProtocol
  Attribute
  Property
  PUBLIC
  No summary
- twisted.protocols.tls.TLSMemoryBIOProtocol.registerProducer
  twisted.protocols.tls.TLSMemoryBIOProtocol.html#registerProducer
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.tls.TLSMemoryBIOProtocol.unregisterProducer
  twisted.protocols.tls.TLSMemoryBIOProtocol.html#unregisterProducer
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.tls.TLSMemoryBIOProtocol._producerPaused
  twisted.protocols.tls.TLSMemoryBIOProtocol.html#_producerPaused
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.protocols.tls._ContextFactoryToConnectionFactory
  twisted.protocols.tls._ContextFactoryToConnectionFactory.html
  Class
  Class
  PRIVATE
  Adapter wrapping a `twisted.internet.interfaces.IOpenSSLContextFactory` into a `IOpenSSLClientConnectionCreator` or `IOpenSSLServerConnectionCreator`.
- twisted.protocols.tls._ContextFactoryToConnectionFactory.__init__
  twisted.protocols.tls._ContextFactoryToConnectionFactory.html#__init__
  Function
  Method
  PUBLIC
  Construct a `_ContextFactoryToConnectionFactory` with a `twisted.internet.interfaces.IOpenSSLContextFactory`.
- twisted.protocols.tls._ContextFactoryToConnectionFactory._oldStyleContextFactory
  twisted.protocols.tls._ContextFactoryToConnectionFactory.html#_oldStyleContextFactory
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.protocols.tls._ContextFactoryToConnectionFactory._connectionForTLS
  twisted.protocols.tls._ContextFactoryToConnectionFactory.html#_connectionForTLS
  Function
  Method
  PRIVATE
  Create an `OpenSSL.SSL.Connection` object.
- twisted.protocols.tls._ContextFactoryToConnectionFactory.serverConnectionForTLS
  twisted.protocols.tls._ContextFactoryToConnectionFactory.html#serverConnectionForTLS
  Function
  Method
  PUBLIC
  Construct an OpenSSL server connection from the wrapped old-style context factory.
- twisted.protocols.tls._ContextFactoryToConnectionFactory.clientConnectionForTLS
  twisted.protocols.tls._ContextFactoryToConnectionFactory.html#clientConnectionForTLS
  Function
  Method
  PUBLIC
  Construct an OpenSSL server connection from the wrapped old-style context factory.
- twisted.protocols.tls.TLSMemoryBIOFactory
  twisted.protocols.tls.TLSMemoryBIOFactory.html
  Class
  Class
  PUBLIC
  `TLSMemoryBIOFactory` adds TLS to connections.
- twisted.protocols.tls.TLSMemoryBIOFactory._creatorInterface
  twisted.protocols.tls.TLSMemoryBIOFactory.html#_creatorInterface
  Attribute
  Instance Variable
  PRIVATE
  the interface which `_connectionCreator` is expected to implement.
- twisted.protocols.tls.TLSMemoryBIOFactory._connectionCreator
  twisted.protocols.tls.TLSMemoryBIOFactory.html#_connectionCreator
  Attribute
  Instance Variable
  PRIVATE
  a callable which creates an OpenSSL Connection object.
- twisted.protocols.tls.TLSMemoryBIOFactory.noisy
  twisted.protocols.tls.TLSMemoryBIOFactory.html#noisy
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.protocols.tls.TLSMemoryBIOFactory.__init__
  twisted.protocols.tls.TLSMemoryBIOFactory.html#__init__
  Function
  Method
  PUBLIC
  Create a `TLSMemoryBIOFactory`.
- twisted.protocols.tls.TLSMemoryBIOFactory.logPrefix
  twisted.protocols.tls.TLSMemoryBIOFactory.html#logPrefix
  Function
  Method
  PUBLIC
  Annotate the wrapped factory's log prefix with some text indicating TLS is in use.
- twisted.protocols.tls.TLSMemoryBIOFactory._applyProtocolNegotiation
  twisted.protocols.tls.TLSMemoryBIOFactory.html#_applyProtocolNegotiation
  Function
  Method
  PRIVATE
  Applies ALPN/NPN protocol neogitation to the connection, if the factory supports it.
- twisted.protocols.tls.TLSMemoryBIOFactory._createConnection
  twisted.protocols.tls.TLSMemoryBIOFactory.html#_createConnection
  Function
  Method
  PRIVATE
  Create an OpenSSL connection and set it up good.
- twisted.internet._newtls._BypassTLS
  twisted.internet._newtls._BypassTLS.html
  Class
  Class
  PRIVATE
  `_BypassTLS` is used as the transport object for the TLS protocol object used to implement `startTLS`. Its methods skip any TLS logic which `startTLS` enables.
- twisted.internet._newtls._BypassTLS._base
  twisted.internet._newtls._BypassTLS.html#_base
  Attribute
  Instance Variable
  PRIVATE
  A transport class `_BypassTLS` has been mixed in with to which methods will be forwarded. This class is only responsible for sending bytes over the connection, not doing TLS.
- twisted.internet._newtls._BypassTLS._connection
  twisted.internet._newtls._BypassTLS.html#_connection
  Attribute
  Instance Variable
  PRIVATE
  A `Connection` which TLS has been started on which will be proxied to by this object. Any method which has its behavior altered after `startTLS` will be skipped in favor of the base class's implementation...
- twisted.internet._newtls._BypassTLS.__init__
  twisted.internet._newtls._BypassTLS.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet._newtls._BypassTLS.__getattr__
  twisted.internet._newtls._BypassTLS.html#__getattr__
  Function
  Method
  PUBLIC
  Forward any extra attribute access to the original transport object. For example, this exposes `getHost`, the behavior of which does not change after TLS is enabled.
- twisted.internet._newtls._BypassTLS.write
  twisted.internet._newtls._BypassTLS.html#write
  Function
  Method
  PUBLIC
  Write some bytes directly to the connection.
- twisted.internet._newtls._BypassTLS.writeSequence
  twisted.internet._newtls._BypassTLS.html#writeSequence
  Function
  Method
  PUBLIC
  Write a some bytes directly to the connection.
- twisted.internet._newtls._BypassTLS.loseConnection
  twisted.internet._newtls._BypassTLS.html#loseConnection
  Function
  Method
  PUBLIC
  Close the underlying connection.
- twisted.internet._newtls._BypassTLS.registerProducer
  twisted.internet._newtls._BypassTLS.html#registerProducer
  Function
  Method
  PUBLIC
  Register a producer with the underlying connection.
- twisted.internet._newtls._BypassTLS.unregisterProducer
  twisted.internet._newtls._BypassTLS.html#unregisterProducer
  Function
  Method
  PUBLIC
  Unregister a producer with the underlying connection.
- twisted.internet._newtls.startTLS
  twisted.internet._newtls.html#startTLS
  Function
  Function
  PUBLIC
  Add a layer of SSL to a transport.
- twisted.internet._newtls.ConnectionMixin
  twisted.internet._newtls.ConnectionMixin.html
  Class
  Class
  PUBLIC
  A mixin for `twisted.internet.abstract.FileDescriptor` which adds an `ITLSTransport` implementation.
- twisted.internet._newtls.ConnectionMixin.TLS
  twisted.internet._newtls.ConnectionMixin.html#TLS
  Attribute
  Constant
  PUBLIC
  A flag indicating whether TLS is currently in use on this transport. This is not a good way for applications to check for TLS, instead use `twisted.internet.interfaces.ISSLTransport`.
- twisted.internet._newtls.ConnectionMixin.startTLS
  twisted.internet._newtls.ConnectionMixin.html#startTLS
  Function
  Method
  PUBLIC
  No summary
- twisted.internet._newtls.ConnectionMixin.write
  twisted.internet._newtls.ConnectionMixin.html#write
  Function
  Method
  PUBLIC
  Write some bytes to this connection, passing them through a TLS layer if necessary, or discarding them if the connection has already been lost.
- twisted.internet._newtls.ConnectionMixin.writeSequence
  twisted.internet._newtls.ConnectionMixin.html#writeSequence
  Function
  Method
  PUBLIC
  Write some bytes to this connection, scatter/gather-style, passing them through a TLS layer if necessary, or discarding them if the connection has already been lost.
- twisted.internet._newtls.ConnectionMixin.loseConnection
  twisted.internet._newtls.ConnectionMixin.html#loseConnection
  Function
  Method
  PUBLIC
  Close this connection after writing all pending data.
- twisted.internet._newtls.ConnectionMixin.registerProducer
  twisted.internet._newtls.ConnectionMixin.html#registerProducer
  Function
  Method
  PUBLIC
  Register a producer.
- twisted.internet._newtls.ConnectionMixin.unregisterProducer
  twisted.internet._newtls.ConnectionMixin.html#unregisterProducer
  Function
  Method
  PUBLIC
  Unregister a producer.
- twisted.internet._newtls.ClientMixin
  twisted.internet._newtls.ClientMixin.html
  Class
  Class
  PUBLIC
  A mixin for `twisted.internet.tcp.Client` which just marks it as a client for the purposes of the default TLS handshake.
- twisted.internet._newtls.ClientMixin._tlsClientDefault
  twisted.internet._newtls.ClientMixin.html#_tlsClientDefault
  Attribute
  Instance Variable
  PRIVATE
  Always `True`, indicating that this is a client connection, and by default when TLS is negotiated this class will act as a TLS client.
- twisted.internet._newtls.ServerMixin
  twisted.internet._newtls.ServerMixin.html
  Class
  Class
  PUBLIC
  A mixin for `twisted.internet.tcp.Server` which just marks it as a server for the purposes of the default TLS handshake.
- twisted.internet._newtls.ServerMixin._tlsClientDefault
  twisted.internet._newtls.ServerMixin.html#_tlsClientDefault
  Attribute
  Instance Variable
  PRIVATE
  Always `False`, indicating that this is a server connection, and by default when TLS is negotiated this class will act as a TLS server.
- twisted.internet.tcp.EPERM
  twisted.internet.tcp.html#EPERM
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.tcp.ENFILE
  twisted.internet.tcp.html#ENFILE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.tcp.ENOMEM
  twisted.internet.tcp.html#ENOMEM
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.tcp._AI_NUMERICSERV
  twisted.internet.tcp.html#_AI_NUMERICSERV
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.internet.tcp._getrealname
  twisted.internet.tcp.html#_getrealname
  Function
  Function
  PRIVATE
  Return a 2-tuple of socket IP and port for IPv4 and a 4-tuple of socket IP, port, flowInfo, and scopeID for IPv6. For IPv6, it returns the interface portion (the part after the %) as a part of the IPv6 address, which Python 3...
- twisted.internet.tcp._getpeername
  twisted.internet.tcp.html#_getpeername
  Function
  Function
  PRIVATE
  See `_getrealname`.
- twisted.internet.tcp._getsockname
  twisted.internet.tcp.html#_getsockname
  Function
  Function
  PRIVATE
  See `_getrealname`.
- twisted.internet.tcp._SocketCloser
  twisted.internet.tcp._SocketCloser.html
  Class
  Class
  PRIVATE
  No summary
- twisted.internet.tcp._SocketCloser._shouldShutdown
  twisted.internet.tcp._SocketCloser.html#_shouldShutdown
  Attribute
  Instance Variable
  PRIVATE
  Set to `True` if `shutdown` should be called before calling `close` on the underlying socket.
- twisted.internet.tcp._SocketCloser._closeSocket
  twisted.internet.tcp._SocketCloser.html#_closeSocket
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet.tcp._AbortingMixin
  twisted.internet.tcp._AbortingMixin.html
  Class
  Class
  PRIVATE
  Common implementation of `abortConnection`.
- twisted.internet.tcp._AbortingMixin._aborting
  twisted.internet.tcp._AbortingMixin.html#_aborting
  Attribute
  Instance Variable
  PRIVATE
  Set to `True` when `abortConnection` is called.
- twisted.internet.tcp._AbortingMixin.abortConnection
  twisted.internet.tcp._AbortingMixin.html#abortConnection
  Function
  Method
  PUBLIC
  Aborts the connection immediately, dropping any buffered data.
- twisted.internet.tcp._AbortingMixin.doRead
  twisted.internet.tcp._AbortingMixin.html#doRead
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.tcp._AbortingMixin.doWrite
  twisted.internet.tcp._AbortingMixin.html#doWrite
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.tcp.Connection
  twisted.internet.tcp.Connection.html
  Class
  Class
  PUBLIC
  Superclass of all socket-based FileDescriptors.
- twisted.internet.tcp.Connection.logstr
  twisted.internet.tcp.Connection.html#logstr
  Attribute
  Instance Variable
  PUBLIC
  prefix used when logging events related to this connection.
- twisted.internet.tcp.Connection.__init__
  twisted.internet.tcp.Connection.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.internet.tcp.Connection.socket
  twisted.internet.tcp.Connection.html#socket
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.tcp.Connection.protocol
  twisted.internet.tcp.Connection.html#protocol
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.tcp.Connection.getHandle
  twisted.internet.tcp.Connection.html#getHandle
  Function
  Method
  PUBLIC
  Return the socket for this connection.
- twisted.internet.tcp.Connection.doRead
  twisted.internet.tcp.Connection.html#doRead
  Function
  Method
  PUBLIC
  Calls self.protocol.dataReceived with all available data.
- twisted.internet.tcp.Connection._dataReceived
  twisted.internet.tcp.Connection.html#_dataReceived
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet.tcp.Connection.writeSomeData
  twisted.internet.tcp.Connection.html#writeSomeData
  Function
  Method
  PUBLIC
  Write as much as possible of the given data to this TCP connection.
- twisted.internet.tcp.Connection._closeWriteConnection
  twisted.internet.tcp.Connection.html#_closeWriteConnection
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet.tcp.Connection.readConnectionLost
  twisted.internet.tcp.Connection.html#readConnectionLost
  Function
  Method
  PUBLIC
  Indicates read connection was lost.
- twisted.internet.tcp.Connection.connectionLost
  twisted.internet.tcp.Connection.html#connectionLost
  Function
  Method
  PUBLIC
  See abstract.FileDescriptor.connectionLost().
- twisted.internet.tcp.Connection.logPrefix
  twisted.internet.tcp.Connection.html#logPrefix
  Function
  Method
  PUBLIC
  Return the prefix to log with when I own the logging thread.
- twisted.internet.tcp.Connection.getTcpNoDelay
  twisted.internet.tcp.Connection.html#getTcpNoDelay
  Function
  Method
  PUBLIC
  Return if `TCP_NODELAY` is enabled.
- twisted.internet.tcp.Connection.setTcpNoDelay
  twisted.internet.tcp.Connection.html#setTcpNoDelay
  Function
  Method
  PUBLIC
  Enable/disable `TCP_NODELAY`.
- twisted.internet.tcp.Connection.getTcpKeepAlive
  twisted.internet.tcp.Connection.html#getTcpKeepAlive
  Function
  Method
  PUBLIC
  Return if `SO_KEEPALIVE` is enabled.
- twisted.internet.tcp.Connection.setTcpKeepAlive
  twisted.internet.tcp.Connection.html#setTcpKeepAlive
  Function
  Method
  PUBLIC
  Enable/disable `SO_KEEPALIVE`.
- twisted.internet.tcp._BaseBaseClient
  twisted.internet.tcp._BaseBaseClient.html
  Class
  Class
  PRIVATE
  Code shared with other (non-POSIX) reactors for management of general outgoing connections.
- twisted.internet.tcp._BaseBaseClient.addressFamily
  twisted.internet.tcp._BaseBaseClient.html#addressFamily
  Attribute
  Instance Variable
  PUBLIC
  The address family constant (`socket.AF_INET`, `socket.AF_INET6`, `socket.AF_UNIX`) of the underlying socket of this client connection.
- twisted.internet.tcp._BaseBaseClient.socketType
  twisted.internet.tcp._BaseBaseClient.html#socketType
  Attribute
  Instance Variable
  PUBLIC
  The socket type constant (`socket.SOCK_STREAM` or `socket.SOCK_DGRAM`) of the underlying socket.
- twisted.internet.tcp._BaseBaseClient._requiresResolution
  twisted.internet.tcp._BaseBaseClient.html#_requiresResolution
  Attribute
  Instance Variable
  PRIVATE
  A flag indicating whether the address of this client will require name resolution. `True` if the hostname of said address indicates a name that must be resolved by hostname lookup, `False` if it indicates an IP address literal.
- twisted.internet.tcp._BaseBaseClient._commonConnection
  twisted.internet.tcp._BaseBaseClient.html#_commonConnection
  Attribute
  Class Variable
  PRIVATE
  Subclasses must provide this attribute, which indicates the `Connection`-alike class to invoke `__init__` and `connectionLost` on.
- twisted.internet.tcp._BaseBaseClient._stopReadingAndWriting
  twisted.internet.tcp._BaseBaseClient.html#_stopReadingAndWriting
  Attribute
  Instance Variable
  PRIVATE
  Subclasses must implement in order to remove this transport from its reactor's notifications in response to a terminated connection attempt.
- twisted.internet.tcp._BaseBaseClient._closeSocket
  twisted.internet.tcp._BaseBaseClient.html#_closeSocket
  Attribute
  Instance Variable
  PRIVATE
  Subclasses must implement in order to close the socket in response to a terminated connection attempt.
- twisted.internet.tcp._BaseBaseClient._collectSocketDetails
  twisted.internet.tcp._BaseBaseClient.html#_collectSocketDetails
  Attribute
  Instance Variable
  PRIVATE
  Clean up references to the attached socket in its underlying OS resource (such as a file descriptor or file handle), as part of post connection-failure cleanup.
- twisted.internet.tcp._BaseBaseClient.reactor
  twisted.internet.tcp._BaseBaseClient.html#reactor
  Attribute
  Instance Variable
  PUBLIC
  The class pointed to by `_commonConnection` should set this attribute in its constructor.
- twisted.internet.tcp._BaseBaseClient._finishInit
  twisted.internet.tcp._BaseBaseClient.html#_finishInit
  Function
  Method
  PRIVATE
  Called by subclasses to continue to the stage of initialization where the socket connect attempt is made.
- twisted.internet.tcp._BaseBaseClient.resolveAddress
  twisted.internet.tcp._BaseBaseClient.html#resolveAddress
  Function
  Method
  PUBLIC
  Resolve the name that was passed to this `_BaseBaseClient`, if necessary, and then move on to attempting the connection once an address has been determined. (The connection will be attempted immediately within this function if either name resolution can be synchronous or the address was an IP address literal...
- twisted.internet.tcp._BaseBaseClient._setRealAddress
  twisted.internet.tcp._BaseBaseClient.html#_setRealAddress
  Function
  Method
  PRIVATE
  Set the resolved address of this `_BaseBaseClient` and initiate the connection attempt.
- twisted.internet.tcp._BaseBaseClient.realAddress
  twisted.internet.tcp._BaseBaseClient.html#realAddress
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.tcp._BaseBaseClient.failIfNotConnected
  twisted.internet.tcp._BaseBaseClient.html#failIfNotConnected
  Function
  Method
  PUBLIC
  Generic method called when the attempts to connect failed. It basically cleans everything it can: call connectionFailed, stop read and write, delete socket related members.
- twisted.internet.tcp._BaseBaseClient.stopConnecting
  twisted.internet.tcp._BaseBaseClient.html#stopConnecting
  Function
  Method
  PUBLIC
  If a connection attempt is still outstanding (i.e. no connection is yet established), immediately stop attempting to connect.
- twisted.internet.tcp._BaseBaseClient.connectionLost
  twisted.internet.tcp._BaseBaseClient.html#connectionLost
  Function
  Method
  PUBLIC
  Invoked by lower-level logic when it's time to clean the socket up. Depending on the state of the connection, either inform the attached `Connector` that the connection attempt has failed, or inform the connected ...
- twisted.internet.tcp.BaseClient
  twisted.internet.tcp.BaseClient.html
  Class
  Class
  PUBLIC
  A base class for client TCP (and similar) sockets.
- twisted.internet.tcp.BaseClient.realAddress
  twisted.internet.tcp.BaseClient.html#realAddress
  Attribute
  Instance Variable
  PUBLIC
  The address object that will be used for socket.connect; this address is an address tuple (the number of elements dependent upon the address family) which does not contain any names which need to be resolved.
- twisted.internet.tcp.BaseClient._base
  twisted.internet.tcp.BaseClient.html#_base
  Attribute
  Instance Variable
  PRIVATE
  `Connection`, which is the base class of this class which has all of the useful file descriptor methods. This is used by `_TLSServerMixin` to call the right methods to directly manipulate the transport, as is necessary for writing TLS-encrypted bytes (whereas those methods on ...
- twisted.internet.tcp.BaseClient._stopReadingAndWriting
  twisted.internet.tcp.BaseClient.html#_stopReadingAndWriting
  Function
  Method
  PRIVATE
  Implement the POSIX-ish (i.e. `twisted.internet.interfaces.IReactorFDSet`) method of detaching this socket from the reactor for `_BaseBaseClient`.
- twisted.internet.tcp.BaseClient._collectSocketDetails
  twisted.internet.tcp.BaseClient.html#_collectSocketDetails
  Function
  Method
  PRIVATE
  Clean up references to the socket and its file descriptor.
- twisted.internet.tcp.BaseClient.createInternetSocket
  twisted.internet.tcp.BaseClient.html#createInternetSocket
  Function
  Method
  PUBLIC
  (internal) Create a non-blocking socket using self.addressFamily, self.socketType.
- twisted.internet.tcp.BaseClient.doConnect
  twisted.internet.tcp.BaseClient.html#doConnect
  Function
  Method
  PUBLIC
  Initiate the outgoing connection attempt.
- twisted.internet.tcp.BaseClient._connectDone
  twisted.internet.tcp.BaseClient.html#_connectDone
  Function
  Method
  PRIVATE
  This is a hook for when a connection attempt has succeeded.
- twisted.internet.tcp.BaseClient.protocol
  twisted.internet.tcp.BaseClient.html#protocol
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.tcp.BaseClient.connected
  twisted.internet.tcp.BaseClient.html#connected
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.tcp.BaseClient.logstr
  twisted.internet.tcp.BaseClient.html#logstr
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.tcp._NUMERIC_ONLY
  twisted.internet.tcp.html#_NUMERIC_ONLY
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.internet.tcp._resolveIPv6
  twisted.internet.tcp.html#_resolveIPv6
  Function
  Function
  PRIVATE
  Resolve an IPv6 literal into an IPv6 address.
- twisted.internet.tcp._BaseTCPClient
  twisted.internet.tcp._BaseTCPClient.html
  Class
  Class
  PRIVATE
  Code shared with other (non-POSIX) reactors for management of outgoing TCP connections (both TCPv4 and TCPv6).
- twisted.internet.tcp._BaseTCPClient._addressType
  twisted.internet.tcp._BaseTCPClient.html#_addressType
  Attribute
  Instance Variable
  PRIVATE
  The Twisted _IPAddress implementation for this client
- twisted.internet.tcp._BaseTCPClient.connector
  twisted.internet.tcp._BaseTCPClient.html#connector
  Attribute
  Instance Variable
  PUBLIC
  The `Connector` which is driving this `_BaseTCPClient`'s connection attempt.
- twisted.internet.tcp._BaseTCPClient.addr
  twisted.internet.tcp._BaseTCPClient.html#addr
  Attribute
  Instance Variable
  PUBLIC
  The address that this socket will be connecting to.
- twisted.internet.tcp._BaseTCPClient.createInternetSocket
  twisted.internet.tcp._BaseTCPClient.html#createInternetSocket
  Attribute
  Instance Variable
  PUBLIC
  Subclasses must implement this as a method to create a python socket object of the appropriate address family and socket type.
- twisted.internet.tcp._BaseTCPClient.__init__
  twisted.internet.tcp._BaseTCPClient.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.tcp._BaseTCPClient._requiresResolution
  twisted.internet.tcp._BaseTCPClient.html#_requiresResolution
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.tcp._BaseTCPClient.getHost
  twisted.internet.tcp._BaseTCPClient.html#getHost
  Function
  Method
  PUBLIC
  Returns an `IPv4Address` or `IPv6Address`.
- twisted.internet.tcp._BaseTCPClient.getPeer
  twisted.internet.tcp._BaseTCPClient.html#getPeer
  Function
  Method
  PUBLIC
  Returns an `IPv4Address` or `IPv6Address`.
- twisted.internet.tcp._BaseTCPClient.__repr__
  twisted.internet.tcp._BaseTCPClient.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.tcp.Client
  twisted.internet.tcp.Client.html
  Class
  Class
  PUBLIC
  A transport for a TCP protocol; either TCPv4 or TCPv6.
- twisted.internet.tcp.Server
  twisted.internet.tcp.Server.html
  Class
  Class
  PUBLIC
  Serverside socket-stream connection class.
- twisted.internet.tcp.Server._base
  twisted.internet.tcp.Server.html#_base
  Attribute
  Instance Variable
  PRIVATE
  `Connection`, which is the base class of this class which has all of the useful file descriptor methods. This is used by `_TLSServerMixin` to call the right methods to directly manipulate the transport, as is necessary for writing TLS-encrypted bytes (whereas those methods on ...
- twisted.internet.tcp.Server.__init__
  twisted.internet.tcp.Server.html#__init__
  Function
  Method
  PUBLIC
  Server(sock, protocol, client, server, sessionno)
- twisted.internet.tcp.Server._addressType
  twisted.internet.tcp.Server.html#_addressType
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.tcp.Server.server
  twisted.internet.tcp.Server.html#server
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.tcp.Server.client
  twisted.internet.tcp.Server.html#client
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.tcp.Server.sessionno
  twisted.internet.tcp.Server.html#sessionno
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.tcp.Server.hostname
  twisted.internet.tcp.Server.html#hostname
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.tcp.Server.logstr
  twisted.internet.tcp.Server.html#logstr
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.tcp.Server.repstr
  twisted.internet.tcp.Server.html#repstr
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.tcp.Server.connected
  twisted.internet.tcp.Server.html#connected
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.tcp.Server.__repr__
  twisted.internet.tcp.Server.html#__repr__
  Function
  Method
  PUBLIC
  A string representation of this connection.
- twisted.internet.tcp.Server._fromConnectedSocket
  twisted.internet.tcp.Server.html#_fromConnectedSocket
  Function
  Class Method
  PRIVATE
  Create a new `Server` based on an existing connected SOCK_STREAM socket.
- twisted.internet.tcp.Server.getHost
  twisted.internet.tcp.Server.html#getHost
  Function
  Method
  PUBLIC
  Returns an `IPv4Address` or `IPv6Address`.
- twisted.internet.tcp.Server.getPeer
  twisted.internet.tcp.Server.html#getPeer
  Function
  Method
  PUBLIC
  Returns an `IPv4Address` or `IPv6Address`.
- twisted.internet.tcp._IFileDescriptorReservation
  twisted.internet.tcp._IFileDescriptorReservation.html
  Class
  Interface
  PRIVATE
  An open file that represents an emergency reservation in the process' file descriptor table. If `Port` encounters `EMFILE` on `accept(2)`, it can close this file descriptor, retry the `accept` so that the incoming connection occupies this file descriptor's space, and then close that connection and reopen this one.
- twisted.internet.tcp._IFileDescriptorReservation.available
  twisted.internet.tcp._IFileDescriptorReservation.html#available
  Function
  Method
  PUBLIC
  Is the reservation available?
- twisted.internet.tcp._IFileDescriptorReservation.reserve
  twisted.internet.tcp._IFileDescriptorReservation.html#reserve
  Function
  Method
  PUBLIC
  Attempt to open the reserved file descriptor; if this fails because of `EMFILE`, internal state is reset so that another reservation attempt can be made.
- twisted.internet.tcp._IFileDescriptorReservation.__enter__
  twisted.internet.tcp._IFileDescriptorReservation.html#__enter__
  Function
  Method
  PUBLIC
  Release the underlying file descriptor so that code within the context manager can open a new file.
- twisted.internet.tcp._IFileDescriptorReservation.__exit__
  twisted.internet.tcp._IFileDescriptorReservation.html#__exit__
  Function
  Method
  PUBLIC
  Attempt to re-open the reserved file descriptor. See `reserve` for caveats.
- twisted.internet.tcp._HasClose
  twisted.internet.tcp._HasClose.html
  Class
  Class
  PRIVATE
  Undocumented
- twisted.internet.tcp._HasClose.close
  twisted.internet.tcp._HasClose.html#close
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.tcp._FileDescriptorReservation
  twisted.internet.tcp._FileDescriptorReservation.html
  Class
  Class
  PRIVATE
  `_IFileDescriptorReservation` implementation.
- twisted.internet.tcp._FileDescriptorReservation.fileFactory
  twisted.internet.tcp._FileDescriptorReservation.html#fileFactory
  Attribute
  Instance Variable
  PUBLIC
  A factory that will be called to reserve a file descriptor.
- twisted.internet.tcp._FileDescriptorReservation._log
  twisted.internet.tcp._FileDescriptorReservation.html#_log
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.internet.tcp._FileDescriptorReservation._fileFactory
  twisted.internet.tcp._FileDescriptorReservation.html#_fileFactory
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.tcp._FileDescriptorReservation._fileDescriptor
  twisted.internet.tcp._FileDescriptorReservation.html#_fileDescriptor
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.tcp._FileDescriptorReservation.available
  twisted.internet.tcp._FileDescriptorReservation.html#available
  Function
  Method
  PUBLIC
  See `_IFileDescriptorReservation.available`.
- twisted.internet.tcp._FileDescriptorReservation.reserve
  twisted.internet.tcp._FileDescriptorReservation.html#reserve
  Function
  Method
  PUBLIC
  See `_IFileDescriptorReservation.reserve`.
- twisted.internet.tcp._FileDescriptorReservation.__enter__
  twisted.internet.tcp._FileDescriptorReservation.html#__enter__
  Function
  Method
  PUBLIC
  See `_IFileDescriptorReservation.__enter__`.
- twisted.internet.tcp._FileDescriptorReservation.__exit__
  twisted.internet.tcp._FileDescriptorReservation.html#__exit__
  Function
  Method
  PUBLIC
  See `_IFileDescriptorReservation.__exit__`.
- twisted.internet.tcp._NullFileDescriptorReservation
  twisted.internet.tcp._NullFileDescriptorReservation.html
  Class
  Class
  PRIVATE
  A null implementation of `_IFileDescriptorReservation`.
- twisted.internet.tcp._NullFileDescriptorReservation.available
  twisted.internet.tcp._NullFileDescriptorReservation.html#available
  Function
  Method
  PUBLIC
  The reserved file is never available. See `_IFileDescriptorReservation.available`.
- twisted.internet.tcp._NullFileDescriptorReservation.reserve
  twisted.internet.tcp._NullFileDescriptorReservation.html#reserve
  Function
  Method
  PUBLIC
  Do nothing. See `_IFileDescriptorReservation.reserve`.
- twisted.internet.tcp._NullFileDescriptorReservation.__enter__
  twisted.internet.tcp._NullFileDescriptorReservation.html#__enter__
  Function
  Method
  PUBLIC
  Do nothing. See `_IFileDescriptorReservation.__enter__`
- twisted.internet.tcp._NullFileDescriptorReservation.__exit__
  twisted.internet.tcp._NullFileDescriptorReservation.html#__exit__
  Function
  Method
  PUBLIC
  Do nothing. See `_IFileDescriptorReservation.__exit__`.
- twisted.internet.tcp._reservedFD
  twisted.internet.tcp.html#_reservedFD
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.internet.tcp._ACCEPT_ERRORS
  twisted.internet.tcp.html#_ACCEPT_ERRORS
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.internet.tcp._BuffersLogs
  twisted.internet.tcp._BuffersLogs.html
  Class
  Class
  PRIVATE
  A context manager that buffers any log events until after its block exits.
- twisted.internet.tcp._BuffersLogs._namespace
  twisted.internet.tcp._BuffersLogs.html#_namespace
  Attribute
  Instance Variable
  PRIVATE
  The namespace of the buffered events.
- twisted.internet.tcp._BuffersLogs._observer
  twisted.internet.tcp._BuffersLogs.html#_observer
  Attribute
  Instance Variable
  PRIVATE
  The observer to which buffered log events will be written
- twisted.internet.tcp._BuffersLogs._logs
  twisted.internet.tcp._BuffersLogs.html#_logs
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.tcp._BuffersLogs.__enter__
  twisted.internet.tcp._BuffersLogs.html#__enter__
  Function
  Method
  PUBLIC
  Enter a log buffering context.
- twisted.internet.tcp._BuffersLogs.__exit__
  twisted.internet.tcp._BuffersLogs.html#__exit__
  Function
  Method
  PUBLIC
  Exit a log buffering context and log all buffered events to the provided observer.
- twisted.internet.tcp._accept
  twisted.internet.tcp.html#_accept
  Function
  Function
  PRIVATE
  Return a generator that yields client sockets from the provided listening socket until there are none left or an unrecoverable error occurs.
- twisted.internet.tcp.Port
  twisted.internet.tcp.Port.html
  Class
  Class
  PUBLIC
  A TCP server port, listening for connections.
- twisted.internet.tcp.Port.deferred
  twisted.internet.tcp.Port.html#deferred
  Attribute
  Instance Variable
  PUBLIC
  a deferred created when `stopListening` is called, and that will fire when connection is lost. This is not to be used it directly: prefer the deferred returned by `stopListening` instead.
- twisted.internet.tcp.Port.disconnecting
  twisted.internet.tcp.Port.html#disconnecting
  Attribute
  Instance Variable
  PUBLIC
  flag indicating that the `stopListening` method has been called and that no connections should be accepted anymore.
- twisted.internet.tcp.Port.connected
  twisted.internet.tcp.Port.html#connected
  Attribute
  Instance Variable
  PUBLIC
  flag set once the listen has successfully been called on the socket.
- twisted.internet.tcp.Port._type
  twisted.internet.tcp.Port.html#_type
  Attribute
  Instance Variable
  PRIVATE
  A string describing the connections which will be created by this port. Normally this is `"TCP"`, since this is a TCP port, but when the TLS implementation re-uses this class it overrides the value with ...
- twisted.internet.tcp.Port._preexistingSocket
  twisted.internet.tcp.Port.html#_preexistingSocket
  Attribute
  Instance Variable
  PRIVATE
  If not `None`, a `socket.socket` instance which was created and initialized outside of the reactor and will be used to listen for connections (instead of a new socket being created by this `Port`).
- twisted.internet.tcp.Port.sessionno
  twisted.internet.tcp.Port.html#sessionno
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.tcp.Port.interface
  twisted.internet.tcp.Port.html#interface
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.tcp.Port.backlog
  twisted.internet.tcp.Port.html#backlog
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.tcp.Port._realPortNumber
  twisted.internet.tcp.Port.html#_realPortNumber
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.tcp.Port._logger
  twisted.internet.tcp.Port.html#_logger
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.internet.tcp.Port.__init__
  twisted.internet.tcp.Port.html#__init__
  Function
  Method
  PUBLIC
  Initialize with a numeric port to listen on.
- twisted.internet.tcp.Port.port
  twisted.internet.tcp.Port.html#port
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.tcp.Port.factory
  twisted.internet.tcp.Port.html#factory
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.tcp.Port.addressFamily
  twisted.internet.tcp.Port.html#addressFamily
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.tcp.Port._addressType
  twisted.internet.tcp.Port.html#_addressType
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.tcp.Port._fromListeningDescriptor
  twisted.internet.tcp.Port.html#_fromListeningDescriptor
  Function
  Class Method
  PRIVATE
  Create a new `Port` based on an existing listening SOCK_STREAM socket.
- twisted.internet.tcp.Port.__repr__
  twisted.internet.tcp.Port.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.tcp.Port.createInternetSocket
  twisted.internet.tcp.Port.html#createInternetSocket
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.tcp.Port.startListening
  twisted.internet.tcp.Port.html#startListening
  Function
  Method
  PUBLIC
  Create and bind my socket, and begin listening on it.
- twisted.internet.tcp.Port.socket
  twisted.internet.tcp.Port.html#socket
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.tcp.Port.numberAccepts
  twisted.internet.tcp.Port.html#numberAccepts
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.tcp.Port._buildAddr
  twisted.internet.tcp.Port.html#_buildAddr
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet.tcp.Port.doRead
  twisted.internet.tcp.Port.html#doRead
  Function
  Method
  PUBLIC
  Called when my socket is ready for reading.
- twisted.internet.tcp.Port.loseConnection
  twisted.internet.tcp.Port.html#loseConnection
  Function
  Method
  PUBLIC
  Stop accepting connections on this port.
- twisted.internet.tcp.Port._logConnectionLostMsg
  twisted.internet.tcp.Port.html#_logConnectionLostMsg
  Function
  Method
  PRIVATE
  Log message for closing port
- twisted.internet.tcp.Port.connectionLost
  twisted.internet.tcp.Port.html#connectionLost
  Function
  Method
  PUBLIC
  Cleans up the socket.
- twisted.internet.tcp.Port.logPrefix
  twisted.internet.tcp.Port.html#logPrefix
  Function
  Method
  PUBLIC
  Returns the name of my class, to prefix log entries with.
- twisted.internet.tcp.Port.getHost
  twisted.internet.tcp.Port.html#getHost
  Function
  Method
  PUBLIC
  Return an `IPv4Address` or `IPv6Address` indicating the listening address of this port.
- twisted.internet.tcp.Connector
  twisted.internet.tcp.Connector.html
  Class
  Class
  PUBLIC
  A `Connector` provides of `twisted.internet.interfaces.IConnector` for all POSIX-style reactors.
- twisted.internet.tcp.Connector._addressType
  twisted.internet.tcp.Connector.html#_addressType
  Attribute
  Instance Variable
  PRIVATE
  the type returned by `Connector.getDestination`. Either `IPv4Address` or `IPv6Address`, depending on the type of address.
- twisted.internet.tcp.Connector.__init__
  twisted.internet.tcp.Connector.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.tcp.Connector.host
  twisted.internet.tcp.Connector.html#host
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.tcp.Connector.port
  twisted.internet.tcp.Connector.html#port
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.tcp.Connector.bindAddress
  twisted.internet.tcp.Connector.html#bindAddress
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.tcp.Connector._makeTransport
  twisted.internet.tcp.Connector.html#_makeTransport
  Function
  Method
  PRIVATE
  Create a `Client` bound to this `Connector`.
- twisted.internet.tcp.Connector.getDestination
  twisted.internet.tcp.Connector.html#getDestination
  Function
  Method
  PUBLIC
  No summary
- twisted.internet.ssl.supported
  twisted.internet.ssl.html#supported
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.internet.ssl.ContextFactory
  twisted.internet.ssl.ContextFactory.html
  Class
  Class
  PUBLIC
  A factory for SSL context objects, for server SSL connections.
- twisted.internet.ssl.ContextFactory.isClient
  twisted.internet.ssl.ContextFactory.html#isClient
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet.ssl.ContextFactory.getContext
  twisted.internet.ssl.ContextFactory.html#getContext
  Function
  Method
  PUBLIC
  Return a SSL.Context object. override in subclasses.
- twisted.internet.ssl.DefaultOpenSSLContextFactory
  twisted.internet.ssl.DefaultOpenSSLContextFactory.html
  Class
  Class
  PUBLIC
  `DefaultOpenSSLContextFactory` is a factory for server-side SSL context objects. These objects define certain parameters related to SSL handshakes and the subsequent connection.
- twisted.internet.ssl.DefaultOpenSSLContextFactory._contextFactory
  twisted.internet.ssl.DefaultOpenSSLContextFactory.html#_contextFactory
  Attribute
  Instance Variable
  PRIVATE
  A callable which will be used to create new context objects. This is typically `OpenSSL.SSL.Context`.
- twisted.internet.ssl.DefaultOpenSSLContextFactory._context
  twisted.internet.ssl.DefaultOpenSSLContextFactory.html#_context
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.ssl.DefaultOpenSSLContextFactory.__init__
  twisted.internet.ssl.DefaultOpenSSLContextFactory.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.internet.ssl.DefaultOpenSSLContextFactory.privateKeyFileName
  twisted.internet.ssl.DefaultOpenSSLContextFactory.html#privateKeyFileName
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.ssl.DefaultOpenSSLContextFactory.certificateFileName
  twisted.internet.ssl.DefaultOpenSSLContextFactory.html#certificateFileName
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.ssl.DefaultOpenSSLContextFactory.sslmethod
  twisted.internet.ssl.DefaultOpenSSLContextFactory.html#sslmethod
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.ssl.DefaultOpenSSLContextFactory.cacheContext
  twisted.internet.ssl.DefaultOpenSSLContextFactory.html#cacheContext
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.ssl.DefaultOpenSSLContextFactory.__getstate__
  twisted.internet.ssl.DefaultOpenSSLContextFactory.html#__getstate__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.ssl.DefaultOpenSSLContextFactory.__setstate__
  twisted.internet.ssl.DefaultOpenSSLContextFactory.html#__setstate__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.ssl.DefaultOpenSSLContextFactory.__dict__
  twisted.internet.ssl.DefaultOpenSSLContextFactory.html#__dict__
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.ssl.DefaultOpenSSLContextFactory.getContext
  twisted.internet.ssl.DefaultOpenSSLContextFactory.html#getContext
  Function
  Method
  PUBLIC
  Return an SSL context.
- twisted.internet.ssl.ClientContextFactory
  twisted.internet.ssl.ClientContextFactory.html
  Class
  Class
  PUBLIC
  A context factory for SSL clients.
- twisted.internet.ssl.ClientContextFactory.isClient
  twisted.internet.ssl.ClientContextFactory.html#isClient
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet.ssl.ClientContextFactory.getContext
  twisted.internet.ssl.ClientContextFactory.html#getContext
  Function
  Method
  PUBLIC
  Returns a TLS context object, suitable for securing a TLS connection. This context object will be appropriately customized for the connection based on the state in this object.
- twisted.internet.ssl.Client
  twisted.internet.ssl.Client.html
  Class
  Class
  PUBLIC
  I am an SSL client.
- twisted.internet.ssl.Client.__init__
  twisted.internet.ssl.Client.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.internet.ssl.Client.ctxFactory
  twisted.internet.ssl.Client.html#ctxFactory
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.ssl.Client._connectDone
  twisted.internet.ssl.Client.html#_connectDone
  Function
  Method
  PRIVATE
  This is a hook for when a connection attempt has succeeded.
- twisted.internet.ssl.Server
  twisted.internet.ssl.Server.html
  Class
  Class
  PUBLIC
  I am an SSL server.
- twisted.internet.ssl.Server.__init__
  twisted.internet.ssl.Server.html#__init__
  Function
  Method
  PUBLIC
  Server(sock, protocol, client, server, sessionno)
- twisted.internet.ssl.Server.getPeerCertificate
  twisted.internet.ssl.Server.html#getPeerCertificate
  Function
  Method
  PUBLIC
  Return an object with the peer's certificate info.
- twisted.internet.ssl.Port
  twisted.internet.ssl.Port.html
  Class
  Class
  PUBLIC
  I am an SSL port.
- twisted.internet.ssl.Port._type
  twisted.internet.ssl.Port.html#_type
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.internet.ssl.Port.__init__
  twisted.internet.ssl.Port.html#__init__
  Function
  Method
  PUBLIC
  Initialize with a numeric port to listen on.
- twisted.internet.ssl.Port.ctxFactory
  twisted.internet.ssl.Port.html#ctxFactory
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.ssl.Port._getLogPrefix
  twisted.internet.ssl.Port.html#_getLogPrefix
  Function
  Method
  PRIVATE
  Override the normal prefix to include an annotation indicating this is a port for TLS connections.
- twisted.internet.ssl.Connector
  twisted.internet.ssl.Connector.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.internet.ssl.Connector.__init__
  twisted.internet.ssl.Connector.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.ssl.Connector.contextFactory
  twisted.internet.ssl.Connector.html#contextFactory
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.ssl.Connector._makeTransport
  twisted.internet.ssl.Connector.html#_makeTransport
  Function
  Method
  PRIVATE
  Create a `Client` bound to this `Connector`.
- twisted.internet.ssl.Certificate
  twisted.internet.ssl.Certificate.html
  Class
  Class
  PUBLIC
  An x509 certificate.
- twisted.internet.ssl.Certificate.__repr__
  twisted.internet.ssl.Certificate.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.ssl.Certificate.__eq__
  twisted.internet.ssl.Certificate.html#__eq__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.ssl.Certificate.load
  twisted.internet.ssl.Certificate.html#load
  Function
  Class Method
  PUBLIC
  Load a certificate from an ASN.1- or PEM-format string.
- twisted.internet.ssl.Certificate.dumpPEM
  twisted.internet.ssl.Certificate.html#dumpPEM
  Function
  Method
  PUBLIC
  Dump this certificate to a PEM-format data string.
- twisted.internet.ssl.Certificate.loadPEM
  twisted.internet.ssl.Certificate.html#loadPEM
  Function
  Class Method
  PUBLIC
  Load a certificate from a PEM-format data string.
- twisted.internet.ssl.Certificate.peerFromTransport
  twisted.internet.ssl.Certificate.html#peerFromTransport
  Function
  Class Method
  PUBLIC
  Get the certificate for the remote end of the given transport.
- twisted.internet.ssl.Certificate.hostFromTransport
  twisted.internet.ssl.Certificate.html#hostFromTransport
  Function
  Class Method
  PUBLIC
  Get the certificate for the local end of the given transport.
- twisted.internet.ssl.Certificate.getPublicKey
  twisted.internet.ssl.Certificate.html#getPublicKey
  Function
  Method
  PUBLIC
  Get the public key for this certificate.
- twisted.internet.ssl.Certificate.dump
  twisted.internet.ssl.Certificate.html#dump
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.ssl.Certificate.serialNumber
  twisted.internet.ssl.Certificate.html#serialNumber
  Function
  Method
  PUBLIC
  Retrieve the serial number of this certificate.
- twisted.internet.ssl.Certificate.digest
  twisted.internet.ssl.Certificate.html#digest
  Function
  Method
  PUBLIC
  Return a digest hash of this certificate using the specified hash algorithm.
- twisted.internet.ssl.Certificate._inspect
  twisted.internet.ssl.Certificate.html#_inspect
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet.ssl.Certificate.inspect
  twisted.internet.ssl.Certificate.html#inspect
  Function
  Method
  PUBLIC
  Return a multi-line, human-readable representation of this Certificate, including information about the subject, issuer, and public key.
- twisted.internet.ssl.Certificate.getIssuer
  twisted.internet.ssl.Certificate.html#getIssuer
  Function
  Method
  PUBLIC
  Retrieve the issuer of this certificate.
- twisted.internet.ssl.Certificate.options
  twisted.internet.ssl.Certificate.html#options
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.ssl.CertificateRequest
  twisted.internet.ssl.CertificateRequest.html
  Class
  Class
  PUBLIC
  An x509 certificate request.
- twisted.internet.ssl.CertificateRequest.load
  twisted.internet.ssl.CertificateRequest.html#load
  Function
  Class Method
  PUBLIC
  Undocumented
- twisted.internet.ssl.CertificateRequest.dump
  twisted.internet.ssl.CertificateRequest.html#dump
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.ssl.DistinguishedName
  twisted.internet.ssl.DistinguishedName.html
  Class
  Class
  PUBLIC
  Identify and describe an entity.
- twisted.internet.ssl.DistinguishedName.__slots__
  twisted.internet.ssl.DistinguishedName.html#__slots__
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet.ssl.DistinguishedName.__init__
  twisted.internet.ssl.DistinguishedName.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.ssl.DistinguishedName._copyFrom
  twisted.internet.ssl.DistinguishedName.html#_copyFrom
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet.ssl.DistinguishedName._copyInto
  twisted.internet.ssl.DistinguishedName.html#_copyInto
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet.ssl.DistinguishedName.__repr__
  twisted.internet.ssl.DistinguishedName.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.ssl.DistinguishedName.__getattr__
  twisted.internet.ssl.DistinguishedName.html#__getattr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.ssl.DistinguishedName.__setattr__
  twisted.internet.ssl.DistinguishedName.html#__setattr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.ssl.DistinguishedName.inspect
  twisted.internet.ssl.DistinguishedName.html#inspect
  Function
  Method
  PUBLIC
  Return a multi-line, human-readable representation of this DN.
- twisted.internet.ssl.KeyPair
  twisted.internet.ssl.KeyPair.html
  Class
  Class
  PUBLIC
  No class docstring; 3/10 methods, 0/2 class method documented
- twisted.internet.ssl.KeyPair.load
  twisted.internet.ssl.KeyPair.html#load
  Function
  Class Method
  PUBLIC
  Undocumented
- twisted.internet.ssl.KeyPair.dump
  twisted.internet.ssl.KeyPair.html#dump
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.ssl.KeyPair.__getstate__
  twisted.internet.ssl.KeyPair.html#__getstate__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.ssl.KeyPair.__setstate__
  twisted.internet.ssl.KeyPair.html#__setstate__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.ssl.KeyPair.inspect
  twisted.internet.ssl.KeyPair.html#inspect
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.ssl.KeyPair.generate
  twisted.internet.ssl.KeyPair.html#generate
  Function
  Class Method
  PUBLIC
  Undocumented
- twisted.internet.ssl.KeyPair.newCertificate
  twisted.internet.ssl.KeyPair.html#newCertificate
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.ssl.KeyPair.requestObject
  twisted.internet.ssl.KeyPair.html#requestObject
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.ssl.KeyPair.certificateRequest
  twisted.internet.ssl.KeyPair.html#certificateRequest
  Function
  Method
  PUBLIC
  Create a certificate request signed with this key.
- twisted.internet.ssl.KeyPair.signCertificateRequest
  twisted.internet.ssl.KeyPair.html#signCertificateRequest
  Function
  Method
  PUBLIC
  Given a blob of certificate request data and a certificate authority's DistinguishedName, return a blob of signed certificate data.
- twisted.internet.ssl.KeyPair.signRequestObject
  twisted.internet.ssl.KeyPair.html#signRequestObject
  Function
  Method
  PUBLIC
  Sign a CertificateRequest instance, returning a Certificate instance.
- twisted.internet.ssl.KeyPair.selfSignedCert
  twisted.internet.ssl.KeyPair.html#selfSignedCert
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.ssl.AcceptableCiphers
  twisted.internet.ssl.AcceptableCiphers.html
  Class
  Class
  PUBLIC
  A representation of ciphers that are acceptable for TLS connections.
- twisted.internet.ssl.AcceptableCiphers.__init__
  twisted.internet.ssl.AcceptableCiphers.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.ssl.AcceptableCiphers._ciphers
  twisted.internet.ssl.AcceptableCiphers.html#_ciphers
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.ssl.AcceptableCiphers.selectCiphers
  twisted.internet.ssl.AcceptableCiphers.html#selectCiphers
  Function
  Method
  PUBLIC
  Choose which ciphers to allow to be negotiated on a TLS connection.
- twisted.internet.ssl.AcceptableCiphers.fromOpenSSLCipherString
  twisted.internet.ssl.AcceptableCiphers.html#fromOpenSSLCipherString
  Function
  Class Method
  PUBLIC
  Create a new instance using an OpenSSL cipher string.
- twisted.internet.ssl.CertificateOptions
  twisted.internet.ssl.CertificateOptions.html
  Class
  Class
  PUBLIC
  A `CertificateOptions` specifies the security properties for a client or server TLS connection used with OpenSSL.
- twisted.internet.ssl.CertificateOptions._options
  twisted.internet.ssl.CertificateOptions.html#_options
  Attribute
  Instance Variable
  PRIVATE
  Any option flags to set on the `OpenSSL.SSL.Context` object that will be created.
- twisted.internet.ssl.CertificateOptions._cipherString
  twisted.internet.ssl.CertificateOptions.html#_cipherString
  Attribute
  Instance Variable
  PRIVATE
  An OpenSSL-specific cipher string.
- twisted.internet.ssl.CertificateOptions._defaultMinimumTLSVersion
  twisted.internet.ssl.CertificateOptions.html#_defaultMinimumTLSVersion
  Attribute
  Instance Variable
  PRIVATE
  The default TLS version that will be negotiated. This should be a "safe default", with wide client and server support, vs an optimally secure one that excludes a large number of users. As of late 2016, TLSv1...
- twisted.internet.ssl.CertificateOptions._context
  twisted.internet.ssl.CertificateOptions.html#_context
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.ssl.CertificateOptions._OP_NO_TLSv1_3
  twisted.internet.ssl.CertificateOptions.html#_OP_NO_TLSv1_3
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.internet.ssl.CertificateOptions.__init__
  twisted.internet.ssl.CertificateOptions.html#__init__
  Function
  Method
  PUBLIC
  Create an OpenSSL context SSL connection context factory.
- twisted.internet.ssl.CertificateOptions.privateKey
  twisted.internet.ssl.CertificateOptions.html#privateKey
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.ssl.CertificateOptions.certificate
  twisted.internet.ssl.CertificateOptions.html#certificate
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.ssl.CertificateOptions._mode
  twisted.internet.ssl.CertificateOptions.html#_mode
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.ssl.CertificateOptions.method
  twisted.internet.ssl.CertificateOptions.html#method
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.ssl.CertificateOptions.verify
  twisted.internet.ssl.CertificateOptions.html#verify
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.ssl.CertificateOptions.extraCertChain
  twisted.internet.ssl.CertificateOptions.html#extraCertChain
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.ssl.CertificateOptions.caCerts
  twisted.internet.ssl.CertificateOptions.html#caCerts
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.ssl.CertificateOptions.verifyDepth
  twisted.internet.ssl.CertificateOptions.html#verifyDepth
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.ssl.CertificateOptions.requireCertificate
  twisted.internet.ssl.CertificateOptions.html#requireCertificate
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.ssl.CertificateOptions.verifyOnce
  twisted.internet.ssl.CertificateOptions.html#verifyOnce
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.ssl.CertificateOptions.enableSingleUseKeys
  twisted.internet.ssl.CertificateOptions.html#enableSingleUseKeys
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.ssl.CertificateOptions.enableSessions
  twisted.internet.ssl.CertificateOptions.html#enableSessions
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.ssl.CertificateOptions.fixBrokenPeers
  twisted.internet.ssl.CertificateOptions.html#fixBrokenPeers
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.ssl.CertificateOptions.enableSessionTickets
  twisted.internet.ssl.CertificateOptions.html#enableSessionTickets
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.ssl.CertificateOptions.dhParameters
  twisted.internet.ssl.CertificateOptions.html#dhParameters
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.ssl.CertificateOptions._ecChooser
  twisted.internet.ssl.CertificateOptions.html#_ecChooser
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.ssl.CertificateOptions.trustRoot
  twisted.internet.ssl.CertificateOptions.html#trustRoot
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.ssl.CertificateOptions._acceptableProtocols
  twisted.internet.ssl.CertificateOptions.html#_acceptableProtocols
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.ssl.CertificateOptions.__getstate__
  twisted.internet.ssl.CertificateOptions.html#__getstate__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.ssl.CertificateOptions.__setstate__
  twisted.internet.ssl.CertificateOptions.html#__setstate__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.ssl.CertificateOptions.__dict__
  twisted.internet.ssl.CertificateOptions.html#__dict__
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.ssl.CertificateOptions.getContext
  twisted.internet.ssl.CertificateOptions.html#getContext
  Function
  Method
  PUBLIC
  Return an `OpenSSL.SSL.Context` object.
- twisted.internet.ssl.CertificateOptions._makeContext
  twisted.internet.ssl.CertificateOptions.html#_makeContext
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet.ssl.OpenSSLDefaultPaths
  twisted.internet.ssl.OpenSSLDefaultPaths.html
  Class
  Class
  PUBLIC
  Trust the set of default verify paths that OpenSSL was built with, as specified by SSL_CTX_set_default_verify_paths.
- twisted.internet.ssl.OpenSSLDefaultPaths._addCACertsToContext
  twisted.internet.ssl.OpenSSLDefaultPaths.html#_addCACertsToContext
  Function
  Method
  PRIVATE
  Add certificate-authority certificates to an SSL context whose connections should trust those authorities.
- twisted.internet.ssl.DiffieHellmanParameters
  twisted.internet.ssl.DiffieHellmanParameters.html
  Class
  Class
  PUBLIC
  A representation of key generation parameters that are required for Diffie-Hellman key exchange.
- twisted.internet.ssl.DiffieHellmanParameters.__init__
  twisted.internet.ssl.DiffieHellmanParameters.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.ssl.DiffieHellmanParameters._dhFile
  twisted.internet.ssl.DiffieHellmanParameters.html#_dhFile
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.ssl.DiffieHellmanParameters.fromFile
  twisted.internet.ssl.DiffieHellmanParameters.html#fromFile
  Function
  Class Method
  PUBLIC
  Load parameters from a file.
- twisted.internet.ssl.PrivateCertificate
  twisted.internet.ssl.PrivateCertificate.html
  Class
  Class
  PUBLIC
  An x509 certificate and private key.
- twisted.internet.ssl.PrivateCertificate.__repr__
  twisted.internet.ssl.PrivateCertificate.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.ssl.PrivateCertificate._setPrivateKey
  twisted.internet.ssl.PrivateCertificate.html#_setPrivateKey
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet.ssl.PrivateCertificate.privateKey
  twisted.internet.ssl.PrivateCertificate.html#privateKey
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.ssl.PrivateCertificate.newCertificate
  twisted.internet.ssl.PrivateCertificate.html#newCertificate
  Function
  Method
  PUBLIC
  Create a new `PrivateCertificate` from the given certificate data and this instance's private key.
- twisted.internet.ssl.PrivateCertificate.load
  twisted.internet.ssl.PrivateCertificate.html#load
  Function
  Class Method
  PUBLIC
  Load a certificate from an ASN.1- or PEM-format string.
- twisted.internet.ssl.PrivateCertificate.inspect
  twisted.internet.ssl.PrivateCertificate.html#inspect
  Function
  Method
  PUBLIC
  Return a multi-line, human-readable representation of this Certificate, including information about the subject, issuer, and public key.
- twisted.internet.ssl.PrivateCertificate.dumpPEM
  twisted.internet.ssl.PrivateCertificate.html#dumpPEM
  Function
  Method
  PUBLIC
  Dump both public and private parts of a private certificate to PEM-format data.
- twisted.internet.ssl.PrivateCertificate.loadPEM
  twisted.internet.ssl.PrivateCertificate.html#loadPEM
  Function
  Class Method
  PUBLIC
  Load both private and public parts of a private certificate from a chunk of PEM-format data.
- twisted.internet.ssl.PrivateCertificate.fromCertificateAndKeyPair
  twisted.internet.ssl.PrivateCertificate.html#fromCertificateAndKeyPair
  Function
  Class Method
  PUBLIC
  Undocumented
- twisted.internet.ssl.PrivateCertificate.options
  twisted.internet.ssl.PrivateCertificate.html#options
  Function
  Method
  PUBLIC
  Create a context factory using this `PrivateCertificate`'s certificate and private key.
- twisted.internet.ssl.PrivateCertificate.certificateRequest
  twisted.internet.ssl.PrivateCertificate.html#certificateRequest
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.ssl.PrivateCertificate.signCertificateRequest
  twisted.internet.ssl.PrivateCertificate.html#signCertificateRequest
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.ssl.PrivateCertificate.signRequestObject
  twisted.internet.ssl.PrivateCertificate.html#signRequestObject
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.ssl.ProtocolNegotiationSupport
  twisted.internet.ssl.ProtocolNegotiationSupport.html
  Class
  Class
  PUBLIC
  `ProtocolNegotiationSupport` defines flags which are used to indicate the level of NPN/ALPN support provided by the TLS backend.
- twisted.internet.ssl.ProtocolNegotiationSupport.NOSUPPORT
  twisted.internet.ssl.ProtocolNegotiationSupport.html#NOSUPPORT
  Attribute
  Class Variable
  PUBLIC
  There is no support for NPN or ALPN. This is exclusive with both `NPN` and `ALPN`.
- twisted.internet.ssl.ProtocolNegotiationSupport.NPN
  twisted.internet.ssl.ProtocolNegotiationSupport.html#NPN
  Attribute
  Constant
  PUBLIC
  The implementation supports Next Protocol Negotiation.
- twisted.internet.ssl.ProtocolNegotiationSupport.ALPN
  twisted.internet.ssl.ProtocolNegotiationSupport.html#ALPN
  Attribute
  Constant
  PUBLIC
  The implementation supports Application Layer Protocol Negotiation.
- twisted.internet.ssl.TLSVersion
  twisted.internet.ssl.TLSVersion.html
  Class
  Class
  PUBLIC
  TLS versions that we can negotiate with the client/server.
- twisted.internet.ssl.TLSVersion.SSLv3
  twisted.internet.ssl.TLSVersion.html#SSLv3
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet.ssl.TLSVersion.TLSv1_0
  twisted.internet.ssl.TLSVersion.html#TLSv1_0
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet.ssl.TLSVersion.TLSv1_1
  twisted.internet.ssl.TLSVersion.html#TLSv1_1
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet.ssl.TLSVersion.TLSv1_2
  twisted.internet.ssl.TLSVersion.html#TLSv1_2
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet.ssl.TLSVersion.TLSv1_3
  twisted.internet.ssl.TLSVersion.html#TLSv1_3
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet.ssl.VerificationError
  twisted.internet.ssl.html#VerificationError
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.internet.ssl.optionsForClientTLS
  twisted.internet.ssl.html#optionsForClientTLS
  Function
  Function
  PUBLIC
  Create a `client connection creator` for use with APIs such as `SSL4ClientEndpoint`, `connectSSL`, and `startTLS`.
- twisted.internet.ssl.platformTrust
  twisted.internet.ssl.html#platformTrust
  Function
  Function
  PUBLIC
  Attempt to discover a set of trusted certificate authority certificates (or, in other words: trust roots, or root certificates) whose trust is managed and updated by tools outside of Twisted.
- twisted.internet.ssl.protocolNegotiationMechanisms
  twisted.internet.ssl.html#protocolNegotiationMechanisms
  Function
  Function
  PUBLIC
  Checks whether your versions of PyOpenSSL and OpenSSL are recent enough to support protocol negotiation, and if they are, what kind of protocol negotiation is supported.
- twisted.internet.ssl.trustRootFromCertificates
  twisted.internet.ssl.html#trustRootFromCertificates
  Function
  Function
  PUBLIC
  Builds an object that trusts multiple root `Certificate`s.
- twisted.names.dns._ord2bytes
  twisted.names.dns.html#_ord2bytes
  Function
  Function
  PRIVATE
  Construct a bytes object representing a single byte with the given ordinal value.
- twisted.names.dns._nicebytes
  twisted.names.dns.html#_nicebytes
  Function
  Function
  PRIVATE
  Represent a mostly textful bytes object in a way suitable for presentation to an end user.
- twisted.names.dns._nicebyteslist
  twisted.names.dns.html#_nicebyteslist
  Function
  Function
  PRIVATE
  Represent a list of mostly textful bytes objects in a way suitable for presentation to an end user.
- twisted.names.dns.randomSource
  twisted.names.dns.html#randomSource
  Function
  Function
  PUBLIC
  Wrapper around `twisted.python.randbytes.RandomFactory.secureRandom` to return 2 random bytes.
- twisted.names.dns.PORT
  twisted.names.dns.html#PORT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.names.dns.A
  twisted.names.dns.html#A
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.names.dns.NS
  twisted.names.dns.html#NS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.names.dns.MD
  twisted.names.dns.html#MD
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.names.dns.MF
  twisted.names.dns.html#MF
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.names.dns.CNAME
  twisted.names.dns.html#CNAME
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.names.dns.SOA
  twisted.names.dns.html#SOA
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.names.dns.MB
  twisted.names.dns.html#MB
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.names.dns.MG
  twisted.names.dns.html#MG
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.names.dns.MR
  twisted.names.dns.html#MR
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.names.dns.NULL
  twisted.names.dns.html#NULL
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.names.dns.WKS
  twisted.names.dns.html#WKS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.names.dns.PTR
  twisted.names.dns.html#PTR
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.names.dns.HINFO
  twisted.names.dns.html#HINFO
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.names.dns.MINFO
  twisted.names.dns.html#MINFO
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.names.dns.MX
  twisted.names.dns.html#MX
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.names.dns.TXT
  twisted.names.dns.html#TXT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.names.dns.RP
  twisted.names.dns.html#RP
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.names.dns.AFSDB
  twisted.names.dns.html#AFSDB
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.names.dns.AAAA
  twisted.names.dns.html#AAAA
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.names.dns.SRV
  twisted.names.dns.html#SRV
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.names.dns.NAPTR
  twisted.names.dns.html#NAPTR
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.names.dns.A6
  twisted.names.dns.html#A6
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.names.dns.DNAME
  twisted.names.dns.html#DNAME
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.names.dns.OPT
  twisted.names.dns.html#OPT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.names.dns.SSHFP
  twisted.names.dns.html#SSHFP
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.names.dns.SPF
  twisted.names.dns.html#SPF
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.names.dns.TKEY
  twisted.names.dns.html#TKEY
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.names.dns.TSIG
  twisted.names.dns.html#TSIG
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.names.dns.QUERY_TYPES
  twisted.names.dns.html#QUERY_TYPES
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.names.dns.IXFR
  twisted.names.dns.html#IXFR
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.names.dns.AXFR
  twisted.names.dns.html#AXFR
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.names.dns.MAILB
  twisted.names.dns.html#MAILB
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.names.dns.MAILA
  twisted.names.dns.html#MAILA
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.names.dns.ALL_RECORDS
  twisted.names.dns.html#ALL_RECORDS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.names.dns.EXT_QUERIES
  twisted.names.dns.html#EXT_QUERIES
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.names.dns.REV_TYPES
  twisted.names.dns.html#REV_TYPES
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.names.dns.IN
  twisted.names.dns.html#IN
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.names.dns.CS
  twisted.names.dns.html#CS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.names.dns.CH
  twisted.names.dns.html#CH
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.names.dns.HS
  twisted.names.dns.html#HS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.names.dns.ANY
  twisted.names.dns.html#ANY
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.names.dns.QUERY_CLASSES
  twisted.names.dns.html#QUERY_CLASSES
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.names.dns.REV_CLASSES
  twisted.names.dns.html#REV_CLASSES
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.names.dns.OP_QUERY
  twisted.names.dns.html#OP_QUERY
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.names.dns.OP_INVERSE
  twisted.names.dns.html#OP_INVERSE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.names.dns.OP_STATUS
  twisted.names.dns.html#OP_STATUS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.names.dns.OP_NOTIFY
  twisted.names.dns.html#OP_NOTIFY
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.names.dns.OP_UPDATE
  twisted.names.dns.html#OP_UPDATE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.names.dns.OK
  twisted.names.dns.html#OK
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.names.dns.EFORMAT
  twisted.names.dns.html#EFORMAT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.names.dns.ESERVER
  twisted.names.dns.html#ESERVER
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.names.dns.ENAME
  twisted.names.dns.html#ENAME
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.names.dns.ENOTIMP
  twisted.names.dns.html#ENOTIMP
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.names.dns.EREFUSED
  twisted.names.dns.html#EREFUSED
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.names.dns.EBADVERSION
  twisted.names.dns.html#EBADVERSION
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.names.dns.EBADSIG
  twisted.names.dns.html#EBADSIG
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.names.dns.EBADKEY
  twisted.names.dns.html#EBADKEY
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.names.dns.EBADTIME
  twisted.names.dns.html#EBADTIME
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.names.dns.IRecord
  twisted.names.dns.IRecord.html
  Class
  Interface
  PUBLIC
  A single entry in a zone of authority.
- twisted.names.dns.IRecord.TYPE
  twisted.names.dns.IRecord.html#TYPE
  Attribute
  Attribute
  PUBLIC
  An indicator of what kind of record this is.
- twisted.names.error.DomainError
  twisted.names.error.DomainError.html
  Class
  Exception
  PUBLIC
  Indicates a lookup failed because there were no records matching the given `name, class, type` triple.
- twisted.names.error.AuthoritativeDomainError
  twisted.names.error.AuthoritativeDomainError.html
  Class
  Exception
  PUBLIC
  Indicates a lookup failed for a name for which this server is authoritative because there were no records matching the given `name, class, type` triple.
- twisted.names.error.DNSQueryTimeoutError
  twisted.names.error.DNSQueryTimeoutError.html
  Class
  Exception
  PUBLIC
  Indicates a lookup failed due to a timeout.
- twisted.names.error.DNSQueryTimeoutError.id
  twisted.names.error.DNSQueryTimeoutError.html#id
  Attribute
  Instance Variable
  PUBLIC
  The id of the message which timed out.
- twisted.names.error.DNSQueryTimeoutError.__init__
  twisted.names.error.DNSQueryTimeoutError.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.error.DNSFormatError
  twisted.names.error.DNSFormatError.html
  Class
  Exception
  PUBLIC
  Indicates a query failed with a result of `twisted.names.dns.EFORMAT`.
- twisted.names.error.DNSServerError
  twisted.names.error.DNSServerError.html
  Class
  Exception
  PUBLIC
  Indicates a query failed with a result of `twisted.names.dns.ESERVER`.
- twisted.names.error.DNSNameError
  twisted.names.error.DNSNameError.html
  Class
  Exception
  PUBLIC
  Indicates a query failed with a result of `twisted.names.dns.ENAME`.
- twisted.names.error.DNSNotImplementedError
  twisted.names.error.DNSNotImplementedError.html
  Class
  Exception
  PUBLIC
  Indicates a query failed with a result of `twisted.names.dns.ENOTIMP`.
- twisted.names.error.DNSQueryRefusedError
  twisted.names.error.DNSQueryRefusedError.html
  Class
  Exception
  PUBLIC
  Indicates a query failed with a result of `twisted.names.dns.EREFUSED`.
- twisted.names.error.DNSUnknownError
  twisted.names.error.DNSUnknownError.html
  Class
  Exception
  PUBLIC
  Indicates a query failed with an unknown result.
- twisted.names.error.ResolverError
  twisted.names.error.ResolverError.html
  Class
  Exception
  PUBLIC
  Indicates a query failed because of a decision made by the local resolver object.
- twisted.names.dns._nameToLabels
  twisted.names.dns.html#_nameToLabels
  Function
  Function
  PRIVATE
  Split a domain name into its constituent labels.
- twisted.names.dns.domainString
  twisted.names.dns.html#domainString
  Function
  Function
  PUBLIC
  Coerce a domain name string to bytes.
- twisted.names.dns._isSubdomainOf
  twisted.names.dns.html#_isSubdomainOf
  Function
  Function
  PRIVATE
  Test whether `descendantName` is equal to or is a subdomain of `ancestorName`.
- twisted.names.dns.str2time
  twisted.names.dns.html#str2time
  Function
  Function
  PUBLIC
  Parse a string description of an interval into an integer number of seconds.
- twisted.names.dns.readPrecisely
  twisted.names.dns.html#readPrecisely
  Function
  Function
  PUBLIC
  Undocumented
- twisted.names.dns.IEncodable
  twisted.names.dns.IEncodable.html
  Class
  Interface
  PUBLIC
  Interface for something which can be encoded to and decoded to the DNS wire format.
- twisted.names.dns.IEncodable.encode
  twisted.names.dns.IEncodable.html#encode
  Function
  Method
  PUBLIC
  Write a representation of this object to the given file object.
- twisted.names.dns.IEncodable.decode
  twisted.names.dns.IEncodable.html#decode
  Function
  Method
  PUBLIC
  Reconstruct an object from data read from the given file object.
- twisted.names.dns.IEncodableRecord
  twisted.names.dns.IEncodableRecord.html
  Class
  Interface
  PUBLIC
  Interface for DNS records that can be encoded and decoded.
- twisted.names.dns.Charstr
  twisted.names.dns.Charstr.html
  Class
  Class
  PUBLIC
  No class docstring; 0/1 instance variable, 3/6 methods documented
- twisted.names.dns.Charstr.__init__
  twisted.names.dns.Charstr.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.dns.Charstr.string
  twisted.names.dns.Charstr.html#string
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.dns.Charstr.encode
  twisted.names.dns.Charstr.html#encode
  Function
  Method
  PUBLIC
  Encode this Character string into the appropriate byte format.
- twisted.names.dns.Charstr.decode
  twisted.names.dns.Charstr.html#decode
  Function
  Method
  PUBLIC
  Decode a byte string into this Charstr.
- twisted.names.dns.Charstr.__eq__
  twisted.names.dns.Charstr.html#__eq__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.dns.Charstr.__hash__
  twisted.names.dns.Charstr.html#__hash__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.dns.Charstr.__str__
  twisted.names.dns.Charstr.html#__str__
  Function
  Method
  PUBLIC
  Represent this `Charstr` instance by its string value.
- twisted.names.dns.Name
  twisted.names.dns.Name.html
  Class
  Class
  PUBLIC
  A name in the domain name system, made up of multiple labels. For example, twistedmatrix.com.
- twisted.names.dns.Name.name
  twisted.names.dns.Name.html#name
  Attribute
  Instance Variable
  PUBLIC
  A byte string giving the name.
- twisted.names.dns.Name.__init__
  twisted.names.dns.Name.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.names.dns.Name.encode
  twisted.names.dns.Name.html#encode
  Function
  Method
  PUBLIC
  Encode this Name into the appropriate byte format.
- twisted.names.dns.Name.decode
  twisted.names.dns.Name.html#decode
  Function
  Method
  PUBLIC
  Decode a byte string into this Name.
- twisted.names.dns.Name.__eq__
  twisted.names.dns.Name.html#__eq__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.dns.Name.__hash__
  twisted.names.dns.Name.html#__hash__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.dns.Name.__str__
  twisted.names.dns.Name.html#__str__
  Function
  Method
  PUBLIC
  Represent this `Name` instance by its string name.
- twisted.names.dns.Query
  twisted.names.dns.Query.html
  Class
  Class
  PUBLIC
  Represent a single DNS query.
- twisted.names.dns.Query.name
  twisted.names.dns.Query.html#name
  Attribute
  Instance Variable
  PUBLIC
  The name about which this query is requesting information.
- twisted.names.dns.Query.type
  twisted.names.dns.Query.html#type
  Attribute
  Instance Variable
  PUBLIC
  The query type.
- twisted.names.dns.Query.cls
  twisted.names.dns.Query.html#cls
  Attribute
  Instance Variable
  PUBLIC
  The query class.
- twisted.names.dns.Query.__init__
  twisted.names.dns.Query.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.names.dns.Query.encode
  twisted.names.dns.Query.html#encode
  Function
  Method
  PUBLIC
  Write a representation of this object to the given file object.
- twisted.names.dns.Query.decode
  twisted.names.dns.Query.html#decode
  Function
  Method
  PUBLIC
  Reconstruct an object from data read from the given file object.
- twisted.names.dns.Query.__hash__
  twisted.names.dns.Query.html#__hash__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.dns.Query.__cmp__
  twisted.names.dns.Query.html#__cmp__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.dns.Query.__str__
  twisted.names.dns.Query.html#__str__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.dns.Query.__repr__
  twisted.names.dns.Query.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.dns._OPTHeader
  twisted.names.dns._OPTHeader.html
  Class
  Class
  PRIVATE
  An OPT record header.
- twisted.names.dns._OPTHeader.showAttributes
  twisted.names.dns._OPTHeader.html#showAttributes
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.dns._OPTHeader.compareAttributes
  twisted.names.dns._OPTHeader.html#compareAttributes
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.dns._OPTHeader.__init__
  twisted.names.dns._OPTHeader.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.names.dns._OPTHeader.udpPayloadSize
  twisted.names.dns._OPTHeader.html#udpPayloadSize
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.dns._OPTHeader.extendedRCODE
  twisted.names.dns._OPTHeader.html#extendedRCODE
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.dns._OPTHeader.version
  twisted.names.dns._OPTHeader.html#version
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.dns._OPTHeader.dnssecOK
  twisted.names.dns._OPTHeader.html#dnssecOK
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.dns._OPTHeader.options
  twisted.names.dns._OPTHeader.html#options
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.dns._OPTHeader.name 0
  twisted.names.dns._OPTHeader.html#name%200
  Attribute
  Instance Variable
  PUBLIC
  The DNS name associated with this record. Since this is a pseudo record, the name is always an `Name` instance with value b'', which represents the DNS root zone. This attribute is a readonly property.
- twisted.names.dns._OPTHeader.name
  twisted.names.dns._OPTHeader.html#name
  Attribute
  Property
  PUBLIC
  A readonly property for accessing the `name` attribute of this record.
- twisted.names.dns._OPTHeader.type 0
  twisted.names.dns._OPTHeader.html#type%200
  Attribute
  Instance Variable
  PUBLIC
  The DNS record type. This is a fixed value of 41 `dns.OPT` for OPT Record. This attribute is a readonly property.
- twisted.names.dns._OPTHeader.type
  twisted.names.dns._OPTHeader.html#type
  Attribute
  Property
  PUBLIC
  A readonly property for accessing the `type` attribute of this record.
- twisted.names.dns._OPTHeader.encode
  twisted.names.dns._OPTHeader.html#encode
  Function
  Method
  PUBLIC
  Encode this `_OPTHeader` instance to bytes.
- twisted.names.dns._OPTHeader.decode
  twisted.names.dns._OPTHeader.html#decode
  Function
  Method
  PUBLIC
  Decode bytes into an `_OPTHeader` instance.
- twisted.names.dns._OPTHeader.fromRRHeader
  twisted.names.dns._OPTHeader.html#fromRRHeader
  Function
  Class Method
  PUBLIC
  A classmethod for constructing a new `_OPTHeader` from the attributes and payload of an existing `RRHeader` instance.
- twisted.names.dns._OPTVariableOption
  twisted.names.dns._OPTVariableOption.html
  Class
  Class
  PRIVATE
  A class to represent OPT record variable options.
- twisted.names.dns._OPTVariableOption.showAttributes
  twisted.names.dns._OPTVariableOption.html#showAttributes
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.dns._OPTVariableOption.compareAttributes
  twisted.names.dns._OPTVariableOption.html#compareAttributes
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.dns._OPTVariableOption._fmt
  twisted.names.dns._OPTVariableOption.html#_fmt
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.names.dns._OPTVariableOption.__init__
  twisted.names.dns._OPTVariableOption.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.names.dns._OPTVariableOption.code
  twisted.names.dns._OPTVariableOption.html#code
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.dns._OPTVariableOption.data
  twisted.names.dns._OPTVariableOption.html#data
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.dns._OPTVariableOption.encode
  twisted.names.dns._OPTVariableOption.html#encode
  Function
  Method
  PUBLIC
  Encode this `_OPTVariableOption` to bytes.
- twisted.names.dns._OPTVariableOption.decode
  twisted.names.dns._OPTVariableOption.html#decode
  Function
  Method
  PUBLIC
  Decode bytes into an `_OPTVariableOption` instance.
- twisted.names.dns.RRHeader
  twisted.names.dns.RRHeader.html
  Class
  Class
  PUBLIC
  A resource record header.
- twisted.names.dns.RRHeader.fmt
  twisted.names.dns.RRHeader.html#fmt
  Attribute
  Class Variable
  PUBLIC
  `str` specifying the byte format of an RR.
- twisted.names.dns.RRHeader.name
  twisted.names.dns.RRHeader.html#name
  Attribute
  Instance Variable
  PUBLIC
  The name about which this reply contains information.
- twisted.names.dns.RRHeader.type
  twisted.names.dns.RRHeader.html#type
  Attribute
  Instance Variable
  PUBLIC
  The query type of the original request.
- twisted.names.dns.RRHeader.cls
  twisted.names.dns.RRHeader.html#cls
  Attribute
  Instance Variable
  PUBLIC
  The query class of the original request.
- twisted.names.dns.RRHeader.ttl
  twisted.names.dns.RRHeader.html#ttl
  Attribute
  Instance Variable
  PUBLIC
  The time-to-live for this record.
- twisted.names.dns.RRHeader.payload
  twisted.names.dns.RRHeader.html#payload
  Attribute
  Instance Variable
  PUBLIC
  The record described by this header.
- twisted.names.dns.RRHeader.auth
  twisted.names.dns.RRHeader.html#auth
  Attribute
  Instance Variable
  PUBLIC
  A `bool` indicating whether this `RRHeader` was parsed from an authoritative message.
- twisted.names.dns.RRHeader.compareAttributes
  twisted.names.dns.RRHeader.html#compareAttributes
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.dns.RRHeader.rdlength
  twisted.names.dns.RRHeader.html#rdlength
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.dns.RRHeader.cachedResponse
  twisted.names.dns.RRHeader.html#cachedResponse
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.dns.RRHeader.__init__
  twisted.names.dns.RRHeader.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.names.dns.RRHeader.encode
  twisted.names.dns.RRHeader.html#encode
  Function
  Method
  PUBLIC
  Write a representation of this object to the given file object.
- twisted.names.dns.RRHeader.decode
  twisted.names.dns.RRHeader.html#decode
  Function
  Method
  PUBLIC
  Reconstruct an object from data read from the given file object.
- twisted.names.dns.RRHeader.isAuthoritative
  twisted.names.dns.RRHeader.html#isAuthoritative
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.dns.RRHeader.__str__
  twisted.names.dns.RRHeader.html#__str__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.dns.SimpleRecord
  twisted.names.dns.SimpleRecord.html
  Class
  Class
  PUBLIC
  A Resource Record which consists of a single RFC 1035 domain-name.
- twisted.names.dns.SimpleRecord.name
  twisted.names.dns.SimpleRecord.html#name
  Attribute
  Instance Variable
  PUBLIC
  The name associated with this record.
- twisted.names.dns.SimpleRecord.ttl
  twisted.names.dns.SimpleRecord.html#ttl
  Attribute
  Instance Variable
  PUBLIC
  The maximum number of seconds which this record should be cached.
- twisted.names.dns.SimpleRecord.showAttributes
  twisted.names.dns.SimpleRecord.html#showAttributes
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.dns.SimpleRecord.compareAttributes
  twisted.names.dns.SimpleRecord.html#compareAttributes
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.dns.SimpleRecord.TYPE
  twisted.names.dns.SimpleRecord.html#TYPE
  Attribute
  Constant
  PUBLIC
  An indicator of what kind of record this is.
- twisted.names.dns.SimpleRecord.__init__
  twisted.names.dns.SimpleRecord.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.names.dns.SimpleRecord.encode
  twisted.names.dns.SimpleRecord.html#encode
  Function
  Method
  PUBLIC
  Write a representation of this object to the given file object.
- twisted.names.dns.SimpleRecord.decode
  twisted.names.dns.SimpleRecord.html#decode
  Function
  Method
  PUBLIC
  Reconstruct an object from data read from the given file object.
- twisted.names.dns.SimpleRecord.__hash__
  twisted.names.dns.SimpleRecord.html#__hash__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.dns.Record_NS
  twisted.names.dns.Record_NS.html
  Class
  Class
  PUBLIC
  An authoritative nameserver.
- twisted.names.dns.Record_NS.fancybasename
  twisted.names.dns.Record_NS.html#fancybasename
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.dns.Record_MD
  twisted.names.dns.Record_MD.html
  Class
  Class
  PUBLIC
  A mail destination.
- twisted.names.dns.Record_MD.fancybasename
  twisted.names.dns.Record_MD.html#fancybasename
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.dns.Record_MF
  twisted.names.dns.Record_MF.html
  Class
  Class
  PUBLIC
  A mail forwarder.
- twisted.names.dns.Record_MF.fancybasename
  twisted.names.dns.Record_MF.html#fancybasename
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.dns.Record_CNAME
  twisted.names.dns.Record_CNAME.html
  Class
  Class
  PUBLIC
  The canonical name for an alias.
- twisted.names.dns.Record_CNAME.fancybasename
  twisted.names.dns.Record_CNAME.html#fancybasename
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.dns.Record_MB
  twisted.names.dns.Record_MB.html
  Class
  Class
  PUBLIC
  A mailbox domain name.
- twisted.names.dns.Record_MB.fancybasename
  twisted.names.dns.Record_MB.html#fancybasename
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.dns.Record_MG
  twisted.names.dns.Record_MG.html
  Class
  Class
  PUBLIC
  A mail group member.
- twisted.names.dns.Record_MG.fancybasename
  twisted.names.dns.Record_MG.html#fancybasename
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.dns.Record_MR
  twisted.names.dns.Record_MR.html
  Class
  Class
  PUBLIC
  A mail rename domain name.
- twisted.names.dns.Record_MR.fancybasename
  twisted.names.dns.Record_MR.html#fancybasename
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.dns.Record_PTR
  twisted.names.dns.Record_PTR.html
  Class
  Class
  PUBLIC
  A domain name pointer.
- twisted.names.dns.Record_PTR.fancybasename
  twisted.names.dns.Record_PTR.html#fancybasename
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.dns.Record_DNAME
  twisted.names.dns.Record_DNAME.html
  Class
  Class
  PUBLIC
  A non-terminal DNS name redirection.
- twisted.names.dns.Record_DNAME.fancybasename
  twisted.names.dns.Record_DNAME.html#fancybasename
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.dns.Record_A
  twisted.names.dns.Record_A.html
  Class
  Class
  PUBLIC
  An IPv4 host address.
- twisted.names.dns.Record_A.address
  twisted.names.dns.Record_A.html#address
  Attribute
  Instance Variable
  PUBLIC
  The packed network-order representation of the IPv4 address associated with this record.
- twisted.names.dns.Record_A.ttl
  twisted.names.dns.Record_A.html#ttl
  Attribute
  Instance Variable
  PUBLIC
  The maximum number of seconds which this record should be cached.
- twisted.names.dns.Record_A.compareAttributes
  twisted.names.dns.Record_A.html#compareAttributes
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.dns.Record_A.__init__
  twisted.names.dns.Record_A.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.names.dns.Record_A.encode
  twisted.names.dns.Record_A.html#encode
  Function
  Method
  PUBLIC
  Write a representation of this object to the given file object.
- twisted.names.dns.Record_A.decode
  twisted.names.dns.Record_A.html#decode
  Function
  Method
  PUBLIC
  Reconstruct an object from data read from the given file object.
- twisted.names.dns.Record_A.__hash__
  twisted.names.dns.Record_A.html#__hash__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.dns.Record_A.__str__
  twisted.names.dns.Record_A.html#__str__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.dns.Record_A.dottedQuad
  twisted.names.dns.Record_A.html#dottedQuad
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.dns.Record_SOA
  twisted.names.dns.Record_SOA.html
  Class
  Class
  PUBLIC
  Marks the start of a zone of authority.
- twisted.names.dns.Record_SOA.mname
  twisted.names.dns.Record_SOA.html#mname
  Attribute
  Instance Variable
  PUBLIC
  The domain-name of the name server that was the original or primary source of data for this zone.
- twisted.names.dns.Record_SOA.rname
  twisted.names.dns.Record_SOA.html#rname
  Attribute
  Instance Variable
  PUBLIC
  A domain-name which specifies the mailbox of the person responsible for this zone.
- twisted.names.dns.Record_SOA.serial
  twisted.names.dns.Record_SOA.html#serial
  Attribute
  Instance Variable
  PUBLIC
  The unsigned 32 bit version number of the original copy of the zone. Zone transfers preserve this value. This value wraps and should be compared using sequence space arithmetic.
- twisted.names.dns.Record_SOA.refresh
  twisted.names.dns.Record_SOA.html#refresh
  Attribute
  Instance Variable
  PUBLIC
  A 32 bit time interval before the zone should be refreshed.
- twisted.names.dns.Record_SOA.minimum
  twisted.names.dns.Record_SOA.html#minimum
  Attribute
  Instance Variable
  PUBLIC
  The unsigned 32 bit minimum TTL field that should be exported with any RR from this zone.
- twisted.names.dns.Record_SOA.expire
  twisted.names.dns.Record_SOA.html#expire
  Attribute
  Instance Variable
  PUBLIC
  A 32 bit time value that specifies the upper limit on the time interval that can elapse before the zone is no longer authoritative.
- twisted.names.dns.Record_SOA.retry
  twisted.names.dns.Record_SOA.html#retry
  Attribute
  Instance Variable
  PUBLIC
  A 32 bit time interval that should elapse before a failed refresh should be retried.
- twisted.names.dns.Record_SOA.ttl
  twisted.names.dns.Record_SOA.html#ttl
  Attribute
  Instance Variable
  PUBLIC
  The default TTL to use for records served from this zone.
- twisted.names.dns.Record_SOA.fancybasename
  twisted.names.dns.Record_SOA.html#fancybasename
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.dns.Record_SOA.compareAttributes
  twisted.names.dns.Record_SOA.html#compareAttributes
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.dns.Record_SOA.showAttributes
  twisted.names.dns.Record_SOA.html#showAttributes
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.dns.Record_SOA.__init__
  twisted.names.dns.Record_SOA.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.names.dns.Record_SOA.encode
  twisted.names.dns.Record_SOA.html#encode
  Function
  Method
  PUBLIC
  Write a representation of this object to the given file object.
- twisted.names.dns.Record_SOA.decode
  twisted.names.dns.Record_SOA.html#decode
  Function
  Method
  PUBLIC
  Reconstruct an object from data read from the given file object.
- twisted.names.dns.Record_SOA.__hash__
  twisted.names.dns.Record_SOA.html#__hash__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.dns.Record_NULL
  twisted.names.dns.Record_NULL.html
  Class
  Class
  PUBLIC
  A null record.
- twisted.names.dns.Record_NULL.ttl
  twisted.names.dns.Record_NULL.html#ttl
  Attribute
  Instance Variable
  PUBLIC
  The maximum number of seconds which this record should be cached.
- twisted.names.dns.Record_NULL.fancybasename
  twisted.names.dns.Record_NULL.html#fancybasename
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.dns.Record_NULL.showAttributes
  twisted.names.dns.Record_NULL.html#showAttributes
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.dns.Record_NULL.compareAttributes
  twisted.names.dns.Record_NULL.html#compareAttributes
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.dns.Record_NULL.__init__
  twisted.names.dns.Record_NULL.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.dns.Record_NULL.payload
  twisted.names.dns.Record_NULL.html#payload
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.dns.Record_NULL.encode
  twisted.names.dns.Record_NULL.html#encode
  Function
  Method
  PUBLIC
  Write a representation of this object to the given file object.
- twisted.names.dns.Record_NULL.decode
  twisted.names.dns.Record_NULL.html#decode
  Function
  Method
  PUBLIC
  Reconstruct an object from data read from the given file object.
- twisted.names.dns.Record_NULL.__hash__
  twisted.names.dns.Record_NULL.html#__hash__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.dns.Record_WKS
  twisted.names.dns.Record_WKS.html
  Class
  Class
  PUBLIC
  A well known service description.
- twisted.names.dns.Record_WKS.address
  twisted.names.dns.Record_WKS.html#address
  Attribute
  Instance Variable
  PUBLIC
  The packed network-order representation of the IPv4 address associated with this record.
- twisted.names.dns.Record_WKS.protocol
  twisted.names.dns.Record_WKS.html#protocol
  Attribute
  Instance Variable
  PUBLIC
  The 8 bit IP protocol number for which this service map is relevant.
- twisted.names.dns.Record_WKS.map
  twisted.names.dns.Record_WKS.html#map
  Attribute
  Instance Variable
  PUBLIC
  A bitvector indicating the services available at the specified address.
- twisted.names.dns.Record_WKS.ttl
  twisted.names.dns.Record_WKS.html#ttl
  Attribute
  Instance Variable
  PUBLIC
  The maximum number of seconds which this record should be cached.
- twisted.names.dns.Record_WKS.fancybasename
  twisted.names.dns.Record_WKS.html#fancybasename
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.dns.Record_WKS.compareAttributes
  twisted.names.dns.Record_WKS.html#compareAttributes
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.dns.Record_WKS.showAttributes
  twisted.names.dns.Record_WKS.html#showAttributes
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.dns.Record_WKS._address
  twisted.names.dns.Record_WKS.html#_address
  Attribute
  Property
  PRIVATE
  Undocumented
- twisted.names.dns.Record_WKS.__init__
  twisted.names.dns.Record_WKS.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.names.dns.Record_WKS.encode
  twisted.names.dns.Record_WKS.html#encode
  Function
  Method
  PUBLIC
  Write a representation of this object to the given file object.
- twisted.names.dns.Record_WKS.decode
  twisted.names.dns.Record_WKS.html#decode
  Function
  Method
  PUBLIC
  Reconstruct an object from data read from the given file object.
- twisted.names.dns.Record_WKS.__hash__
  twisted.names.dns.Record_WKS.html#__hash__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.dns.Record_AAAA
  twisted.names.dns.Record_AAAA.html
  Class
  Class
  PUBLIC
  An IPv6 host address.
- twisted.names.dns.Record_AAAA.address
  twisted.names.dns.Record_AAAA.html#address
  Attribute
  Instance Variable
  PUBLIC
  The packed network-order representation of the IPv6 address associated with this record.
- twisted.names.dns.Record_AAAA.ttl
  twisted.names.dns.Record_AAAA.html#ttl
  Attribute
  Instance Variable
  PUBLIC
  The maximum number of seconds which this record should be cached.
- twisted.names.dns.Record_AAAA.fancybasename
  twisted.names.dns.Record_AAAA.html#fancybasename
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.dns.Record_AAAA.showAttributes
  twisted.names.dns.Record_AAAA.html#showAttributes
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.dns.Record_AAAA.compareAttributes
  twisted.names.dns.Record_AAAA.html#compareAttributes
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.dns.Record_AAAA._address
  twisted.names.dns.Record_AAAA.html#_address
  Attribute
  Property
  PRIVATE
  Undocumented
- twisted.names.dns.Record_AAAA.__init__
  twisted.names.dns.Record_AAAA.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.names.dns.Record_AAAA.encode
  twisted.names.dns.Record_AAAA.html#encode
  Function
  Method
  PUBLIC
  Write a representation of this object to the given file object.
- twisted.names.dns.Record_AAAA.decode
  twisted.names.dns.Record_AAAA.html#decode
  Function
  Method
  PUBLIC
  Reconstruct an object from data read from the given file object.
- twisted.names.dns.Record_AAAA.__hash__
  twisted.names.dns.Record_AAAA.html#__hash__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.dns.Record_A6
  twisted.names.dns.Record_A6.html
  Class
  Class
  PUBLIC
  An IPv6 address.
- twisted.names.dns.Record_A6.prefixLen
  twisted.names.dns.Record_A6.html#prefixLen
  Attribute
  Instance Variable
  PUBLIC
  The length of the suffix.
- twisted.names.dns.Record_A6.suffix
  twisted.names.dns.Record_A6.html#suffix
  Attribute
  Instance Variable
  PUBLIC
  An IPv6 address suffix in network order.
- twisted.names.dns.Record_A6.prefix
  twisted.names.dns.Record_A6.html#prefix
  Attribute
  Instance Variable
  PUBLIC
  If specified, a name which will be used as a prefix for other A6 records.
- twisted.names.dns.Record_A6.bytes
  twisted.names.dns.Record_A6.html#bytes
  Attribute
  Instance Variable
  PUBLIC
  The length of the prefix.
- twisted.names.dns.Record_A6.ttl
  twisted.names.dns.Record_A6.html#ttl
  Attribute
  Instance Variable
  PUBLIC
  The maximum number of seconds which this record should be cached.
- twisted.names.dns.Record_A6.fancybasename
  twisted.names.dns.Record_A6.html#fancybasename
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.dns.Record_A6.showAttributes
  twisted.names.dns.Record_A6.html#showAttributes
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.dns.Record_A6.compareAttributes
  twisted.names.dns.Record_A6.html#compareAttributes
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.dns.Record_A6._suffix
  twisted.names.dns.Record_A6.html#_suffix
  Attribute
  Property
  PRIVATE
  Undocumented
- twisted.names.dns.Record_A6.__init__
  twisted.names.dns.Record_A6.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.names.dns.Record_A6.encode
  twisted.names.dns.Record_A6.html#encode
  Function
  Method
  PUBLIC
  Write a representation of this object to the given file object.
- twisted.names.dns.Record_A6.decode
  twisted.names.dns.Record_A6.html#decode
  Function
  Method
  PUBLIC
  Reconstruct an object from data read from the given file object.
- twisted.names.dns.Record_A6.__eq__
  twisted.names.dns.Record_A6.html#__eq__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.dns.Record_A6.__hash__
  twisted.names.dns.Record_A6.html#__hash__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.dns.Record_A6.__str__
  twisted.names.dns.Record_A6.html#__str__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.dns.Record_SRV
  twisted.names.dns.Record_SRV.html
  Class
  Class
  PUBLIC
  The location of the server(s) for a specific protocol and domain.
- twisted.names.dns.Record_SRV.priority
  twisted.names.dns.Record_SRV.html#priority
  Attribute
  Instance Variable
  PUBLIC
  The priority of this target host. A client MUST attempt to contact the target host with the lowest-numbered priority it can reach; target hosts with the same priority SHOULD be tried in an order defined by the weight field.
- twisted.names.dns.Record_SRV.weight
  twisted.names.dns.Record_SRV.html#weight
  Attribute
  Instance Variable
  PUBLIC
  Specifies a relative weight for entries with the same priority. Larger weights SHOULD be given a proportionately higher probability of being selected.
- twisted.names.dns.Record_SRV.port
  twisted.names.dns.Record_SRV.html#port
  Attribute
  Instance Variable
  PUBLIC
  The port on this target host of this service.
- twisted.names.dns.Record_SRV.target
  twisted.names.dns.Record_SRV.html#target
  Attribute
  Instance Variable
  PUBLIC
  The domain name of the target host. There MUST be one or more address records for this name, the name MUST NOT be an alias (in the sense of RFC 1034 or RFC 2181). Implementors are urged, but not required, to return the address record(s) in the Additional Data section...
- twisted.names.dns.Record_SRV.ttl
  twisted.names.dns.Record_SRV.html#ttl
  Attribute
  Instance Variable
  PUBLIC
  The maximum number of seconds which this record should be cached.
- twisted.names.dns.Record_SRV.fancybasename
  twisted.names.dns.Record_SRV.html#fancybasename
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.dns.Record_SRV.compareAttributes
  twisted.names.dns.Record_SRV.html#compareAttributes
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.dns.Record_SRV.showAttributes
  twisted.names.dns.Record_SRV.html#showAttributes
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.dns.Record_SRV.__init__
  twisted.names.dns.Record_SRV.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.names.dns.Record_SRV.encode
  twisted.names.dns.Record_SRV.html#encode
  Function
  Method
  PUBLIC
  Write a representation of this object to the given file object.
- twisted.names.dns.Record_SRV.decode
  twisted.names.dns.Record_SRV.html#decode
  Function
  Method
  PUBLIC
  Reconstruct an object from data read from the given file object.
- twisted.names.dns.Record_SRV.__hash__
  twisted.names.dns.Record_SRV.html#__hash__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.dns.Record_NAPTR
  twisted.names.dns.Record_NAPTR.html
  Class
  Class
  PUBLIC
  The location of the server(s) for a specific protocol and domain.
- twisted.names.dns.Record_NAPTR.order
  twisted.names.dns.Record_NAPTR.html#order
  Attribute
  Instance Variable
  PUBLIC
  An integer specifying the order in which the NAPTR records MUST be processed to ensure the correct ordering of rules. Low numbers are processed before high numbers.
- twisted.names.dns.Record_NAPTR.preference
  twisted.names.dns.Record_NAPTR.html#preference
  Attribute
  Instance Variable
  PUBLIC
  An integer that specifies the order in which NAPTR records with equal "order" values SHOULD be processed, low numbers being processed before high numbers.
- twisted.names.dns.Record_NAPTR.flag
  twisted.names.dns.Record_NAPTR.html#flag
  Attribute
  Instance Variable
  PUBLIC
  A <character-string> containing flags to control aspects of the rewriting and interpretation of the fields in the record. Flags are single characters from the set [A-Z0-9]. The case of the alphabetic characters is not significant.
- twisted.names.dns.Record_NAPTR.service
  twisted.names.dns.Record_NAPTR.html#service
  Attribute
  Instance Variable
  PUBLIC
  Specifies the service(s) available down this rewrite path. It may also specify the particular protocol that is used to talk with a service. A protocol MUST be specified if the flags field states that the NAPTR is terminal.
- twisted.names.dns.Record_NAPTR.regexp
  twisted.names.dns.Record_NAPTR.html#regexp
  Attribute
  Instance Variable
  PUBLIC
  A STRING containing a substitution expression that is applied to the original string held by the client in order to construct the next domain name to lookup.
- twisted.names.dns.Record_NAPTR.replacement
  twisted.names.dns.Record_NAPTR.html#replacement
  Attribute
  Instance Variable
  PUBLIC
  The next NAME to query for NAPTR, SRV, or address records depending on the value of the flags field. This MUST be a fully qualified domain-name.
- twisted.names.dns.Record_NAPTR.ttl
  twisted.names.dns.Record_NAPTR.html#ttl
  Attribute
  Instance Variable
  PUBLIC
  The maximum number of seconds which this record should be cached.
- twisted.names.dns.Record_NAPTR.compareAttributes
  twisted.names.dns.Record_NAPTR.html#compareAttributes
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.dns.Record_NAPTR.fancybasename
  twisted.names.dns.Record_NAPTR.html#fancybasename
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.dns.Record_NAPTR.showAttributes
  twisted.names.dns.Record_NAPTR.html#showAttributes
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.dns.Record_NAPTR.__init__
  twisted.names.dns.Record_NAPTR.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.names.dns.Record_NAPTR.flags
  twisted.names.dns.Record_NAPTR.html#flags
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.dns.Record_NAPTR.encode
  twisted.names.dns.Record_NAPTR.html#encode
  Function
  Method
  PUBLIC
  Write a representation of this object to the given file object.
- twisted.names.dns.Record_NAPTR.decode
  twisted.names.dns.Record_NAPTR.html#decode
  Function
  Method
  PUBLIC
  Reconstruct an object from data read from the given file object.
- twisted.names.dns.Record_NAPTR.__hash__
  twisted.names.dns.Record_NAPTR.html#__hash__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.dns.Record_AFSDB
  twisted.names.dns.Record_AFSDB.html
  Class
  Class
  PUBLIC
  Map from a domain name to the name of an AFS cell database server.
- twisted.names.dns.Record_AFSDB.subtype
  twisted.names.dns.Record_AFSDB.html#subtype
  Attribute
  Instance Variable
  PUBLIC
  In the case of subtype 1, the host has an AFS version 3.0 Volume Location Server for the named AFS cell. In the case of subtype 2, the host has an authenticated name server holding the cell-root directory node for the named DCE/NCA cell.
- twisted.names.dns.Record_AFSDB.hostname
  twisted.names.dns.Record_AFSDB.html#hostname
  Attribute
  Instance Variable
  PUBLIC
  The domain name of a host that has a server for the cell named by this record.
- twisted.names.dns.Record_AFSDB.ttl
  twisted.names.dns.Record_AFSDB.html#ttl
  Attribute
  Instance Variable
  PUBLIC
  The maximum number of seconds which this record should be cached.
- twisted.names.dns.Record_AFSDB.fancybasename
  twisted.names.dns.Record_AFSDB.html#fancybasename
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.dns.Record_AFSDB.compareAttributes
  twisted.names.dns.Record_AFSDB.html#compareAttributes
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.dns.Record_AFSDB.showAttributes
  twisted.names.dns.Record_AFSDB.html#showAttributes
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.dns.Record_AFSDB.__init__
  twisted.names.dns.Record_AFSDB.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.names.dns.Record_AFSDB.encode
  twisted.names.dns.Record_AFSDB.html#encode
  Function
  Method
  PUBLIC
  Write a representation of this object to the given file object.
- twisted.names.dns.Record_AFSDB.decode
  twisted.names.dns.Record_AFSDB.html#decode
  Function
  Method
  PUBLIC
  Reconstruct an object from data read from the given file object.
- twisted.names.dns.Record_AFSDB.__hash__
  twisted.names.dns.Record_AFSDB.html#__hash__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.dns.Record_RP
  twisted.names.dns.Record_RP.html
  Class
  Class
  PUBLIC
  The responsible person for a domain.
- twisted.names.dns.Record_RP.mbox
  twisted.names.dns.Record_RP.html#mbox
  Attribute
  Instance Variable
  PUBLIC
  A domain name that specifies the mailbox for the responsible person.
- twisted.names.dns.Record_RP.txt
  twisted.names.dns.Record_RP.html#txt
  Attribute
  Instance Variable
  PUBLIC
  A domain name for which TXT RR's exist (indirection through which allows information sharing about the contents of this RP record).
- twisted.names.dns.Record_RP.ttl
  twisted.names.dns.Record_RP.html#ttl
  Attribute
  Instance Variable
  PUBLIC
  The maximum number of seconds which this record should be cached.
- twisted.names.dns.Record_RP.fancybasename
  twisted.names.dns.Record_RP.html#fancybasename
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.dns.Record_RP.compareAttributes
  twisted.names.dns.Record_RP.html#compareAttributes
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.dns.Record_RP.showAttributes
  twisted.names.dns.Record_RP.html#showAttributes
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.dns.Record_RP.__init__
  twisted.names.dns.Record_RP.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.names.dns.Record_RP.encode
  twisted.names.dns.Record_RP.html#encode
  Function
  Method
  PUBLIC
  Write a representation of this object to the given file object.
- twisted.names.dns.Record_RP.decode
  twisted.names.dns.Record_RP.html#decode
  Function
  Method
  PUBLIC
  Reconstruct an object from data read from the given file object.
- twisted.names.dns.Record_RP.__hash__
  twisted.names.dns.Record_RP.html#__hash__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.dns.Record_HINFO
  twisted.names.dns.Record_HINFO.html
  Class
  Class
  PUBLIC
  Host information.
- twisted.names.dns.Record_HINFO.cpu
  twisted.names.dns.Record_HINFO.html#cpu
  Attribute
  Instance Variable
  PUBLIC
  Specifies the CPU type.
- twisted.names.dns.Record_HINFO.os
  twisted.names.dns.Record_HINFO.html#os
  Attribute
  Instance Variable
  PUBLIC
  Specifies the OS.
- twisted.names.dns.Record_HINFO.ttl
  twisted.names.dns.Record_HINFO.html#ttl
  Attribute
  Instance Variable
  PUBLIC
  The maximum number of seconds which this record should be cached.
- twisted.names.dns.Record_HINFO.fancybasename
  twisted.names.dns.Record_HINFO.html#fancybasename
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.dns.Record_HINFO.showAttributes
  twisted.names.dns.Record_HINFO.html#showAttributes
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.dns.Record_HINFO.compareAttributes
  twisted.names.dns.Record_HINFO.html#compareAttributes
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.dns.Record_HINFO.__init__
  twisted.names.dns.Record_HINFO.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.dns.Record_HINFO.encode
  twisted.names.dns.Record_HINFO.html#encode
  Function
  Method
  PUBLIC
  Write a representation of this object to the given file object.
- twisted.names.dns.Record_HINFO.decode
  twisted.names.dns.Record_HINFO.html#decode
  Function
  Method
  PUBLIC
  Reconstruct an object from data read from the given file object.
- twisted.names.dns.Record_HINFO.__eq__
  twisted.names.dns.Record_HINFO.html#__eq__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.dns.Record_HINFO.__hash__
  twisted.names.dns.Record_HINFO.html#__hash__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.dns.Record_MINFO
  twisted.names.dns.Record_MINFO.html
  Class
  Class
  PUBLIC
  Mailbox or mail list information.
- twisted.names.dns.Record_MINFO.rmailbx
  twisted.names.dns.Record_MINFO.html#rmailbx
  Attribute
  Instance Variable
  PUBLIC
  A domain-name which specifies a mailbox which is responsible for the mailing list or mailbox. If this domain name names the root, the owner of the MINFO RR is responsible for itself.
- twisted.names.dns.Record_MINFO.emailbx
  twisted.names.dns.Record_MINFO.html#emailbx
  Attribute
  Instance Variable
  PUBLIC
  A domain-name which specifies a mailbox which is to receive error messages related to the mailing list or mailbox specified by the owner of the MINFO record. If this domain name names the root, errors should be returned to the sender of the message.
- twisted.names.dns.Record_MINFO.ttl
  twisted.names.dns.Record_MINFO.html#ttl
  Attribute
  Instance Variable
  PUBLIC
  The maximum number of seconds which this record should be cached.
- twisted.names.dns.Record_MINFO.fancybasename
  twisted.names.dns.Record_MINFO.html#fancybasename
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.dns.Record_MINFO.compareAttributes
  twisted.names.dns.Record_MINFO.html#compareAttributes
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.dns.Record_MINFO.showAttributes
  twisted.names.dns.Record_MINFO.html#showAttributes
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.dns.Record_MINFO.__init__
  twisted.names.dns.Record_MINFO.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.names.dns.Record_MINFO.encode
  twisted.names.dns.Record_MINFO.html#encode
  Function
  Method
  PUBLIC
  Write a representation of this object to the given file object.
- twisted.names.dns.Record_MINFO.decode
  twisted.names.dns.Record_MINFO.html#decode
  Function
  Method
  PUBLIC
  Reconstruct an object from data read from the given file object.
- twisted.names.dns.Record_MINFO.__hash__
  twisted.names.dns.Record_MINFO.html#__hash__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.dns.Record_MX
  twisted.names.dns.Record_MX.html
  Class
  Class
  PUBLIC
  Mail exchange.
- twisted.names.dns.Record_MX.preference
  twisted.names.dns.Record_MX.html#preference
  Attribute
  Instance Variable
  PUBLIC
  Specifies the preference given to this RR among others at the same owner. Lower values are preferred.
- twisted.names.dns.Record_MX.name
  twisted.names.dns.Record_MX.html#name
  Attribute
  Instance Variable
  PUBLIC
  A domain-name which specifies a host willing to act as a mail exchange.
- twisted.names.dns.Record_MX.ttl
  twisted.names.dns.Record_MX.html#ttl
  Attribute
  Instance Variable
  PUBLIC
  The maximum number of seconds which this record should be cached.
- twisted.names.dns.Record_MX.fancybasename
  twisted.names.dns.Record_MX.html#fancybasename
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.dns.Record_MX.compareAttributes
  twisted.names.dns.Record_MX.html#compareAttributes
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.dns.Record_MX.showAttributes
  twisted.names.dns.Record_MX.html#showAttributes
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.dns.Record_MX.__init__
  twisted.names.dns.Record_MX.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.names.dns.Record_MX.encode
  twisted.names.dns.Record_MX.html#encode
  Function
  Method
  PUBLIC
  Write a representation of this object to the given file object.
- twisted.names.dns.Record_MX.decode
  twisted.names.dns.Record_MX.html#decode
  Function
  Method
  PUBLIC
  Reconstruct an object from data read from the given file object.
- twisted.names.dns.Record_MX.__hash__
  twisted.names.dns.Record_MX.html#__hash__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.dns.Record_SSHFP
  twisted.names.dns.Record_SSHFP.html
  Class
  Class
  PUBLIC
  A record containing the fingerprint of an SSH key.
- twisted.names.dns.Record_SSHFP.algorithm
  twisted.names.dns.Record_SSHFP.html#algorithm
  Attribute
  Instance Variable
  PUBLIC
  The SSH key's algorithm, such as `ALGORITHM_RSA`. Note that the numbering used for SSH key algorithms is specific to the SSHFP record, and is not the same as the numbering used for KEY or SIG records.
- twisted.names.dns.Record_SSHFP.fingerprintType
  twisted.names.dns.Record_SSHFP.html#fingerprintType
  Attribute
  Instance Variable
  PUBLIC
  The fingerprint type, such as `FINGERPRINT_TYPE_SHA256`.
- twisted.names.dns.Record_SSHFP.fingerprint
  twisted.names.dns.Record_SSHFP.html#fingerprint
  Attribute
  Instance Variable
  PUBLIC
  The key's fingerprint, e.g. a 32-byte SHA-256 digest.
- twisted.names.dns.Record_SSHFP.ALGORITHM_RSA
  twisted.names.dns.Record_SSHFP.html#ALGORITHM_RSA
  Attribute
  Constant
  PUBLIC
  The algorithm value for `ssh-rsa` keys.
- twisted.names.dns.Record_SSHFP.ALGORITHM_DSS
  twisted.names.dns.Record_SSHFP.html#ALGORITHM_DSS
  Attribute
  Constant
  PUBLIC
  The algorithm value for `ssh-dss` keys.
- twisted.names.dns.Record_SSHFP.ALGORITHM_ECDSA
  twisted.names.dns.Record_SSHFP.html#ALGORITHM_ECDSA
  Attribute
  Constant
  PUBLIC
  The algorithm value for `ecdsa-sha2-*` keys.
- twisted.names.dns.Record_SSHFP.ALGORITHM_Ed25519
  twisted.names.dns.Record_SSHFP.html#ALGORITHM_Ed25519
  Attribute
  Class Variable
  PUBLIC
  The algorithm value for `ed25519` keys.
- twisted.names.dns.Record_SSHFP.FINGERPRINT_TYPE_SHA1
  twisted.names.dns.Record_SSHFP.html#FINGERPRINT_TYPE_SHA1
  Attribute
  Constant
  PUBLIC
  The type for SHA-1 fingerprints.
- twisted.names.dns.Record_SSHFP.FINGERPRINT_TYPE_SHA256
  twisted.names.dns.Record_SSHFP.html#FINGERPRINT_TYPE_SHA256
  Attribute
  Constant
  PUBLIC
  The type for SHA-256 fingerprints.
- twisted.names.dns.Record_SSHFP.fancybasename
  twisted.names.dns.Record_SSHFP.html#fancybasename
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.dns.Record_SSHFP.compareAttributes
  twisted.names.dns.Record_SSHFP.html#compareAttributes
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.dns.Record_SSHFP.showAttributes
  twisted.names.dns.Record_SSHFP.html#showAttributes
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.dns.Record_SSHFP.__init__
  twisted.names.dns.Record_SSHFP.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.dns.Record_SSHFP.ttl
  twisted.names.dns.Record_SSHFP.html#ttl
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.dns.Record_SSHFP.encode
  twisted.names.dns.Record_SSHFP.html#encode
  Function
  Method
  PUBLIC
  Write a representation of this object to the given file object.
- twisted.names.dns.Record_SSHFP.decode
  twisted.names.dns.Record_SSHFP.html#decode
  Function
  Method
  PUBLIC
  Reconstruct an object from data read from the given file object.
- twisted.names.dns.Record_SSHFP.__hash__
  twisted.names.dns.Record_SSHFP.html#__hash__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.dns.Record_TXT
  twisted.names.dns.Record_TXT.html
  Class
  Class
  PUBLIC
  Freeform text.
- twisted.names.dns.Record_TXT.data
  twisted.names.dns.Record_TXT.html#data
  Attribute
  Instance Variable
  PUBLIC
  Freeform text which makes up this record.
- twisted.names.dns.Record_TXT.ttl
  twisted.names.dns.Record_TXT.html#ttl
  Attribute
  Instance Variable
  PUBLIC
  The maximum number of seconds which this record should be cached.
- twisted.names.dns.Record_TXT.fancybasename
  twisted.names.dns.Record_TXT.html#fancybasename
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.dns.Record_TXT.showAttributes
  twisted.names.dns.Record_TXT.html#showAttributes
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.dns.Record_TXT.compareAttributes
  twisted.names.dns.Record_TXT.html#compareAttributes
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.dns.Record_TXT.__init__
  twisted.names.dns.Record_TXT.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.dns.Record_TXT.encode
  twisted.names.dns.Record_TXT.html#encode
  Function
  Method
  PUBLIC
  Write a representation of this object to the given file object.
- twisted.names.dns.Record_TXT.decode
  twisted.names.dns.Record_TXT.html#decode
  Function
  Method
  PUBLIC
  Reconstruct an object from data read from the given file object.
- twisted.names.dns.Record_TXT.__hash__
  twisted.names.dns.Record_TXT.html#__hash__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.dns.UnknownRecord
  twisted.names.dns.UnknownRecord.html
  Class
  Class
  PUBLIC
  Encapsulate the wire data for unknown record types so that they can pass through the system unchanged.
- twisted.names.dns.UnknownRecord.data
  twisted.names.dns.UnknownRecord.html#data
  Attribute
  Instance Variable
  PUBLIC
  Wire data which makes up this record.
- twisted.names.dns.UnknownRecord.ttl
  twisted.names.dns.UnknownRecord.html#ttl
  Attribute
  Instance Variable
  PUBLIC
  The maximum number of seconds which this record should be cached.
- twisted.names.dns.UnknownRecord.TYPE
  twisted.names.dns.UnknownRecord.html#TYPE
  Attribute
  Constant
  PUBLIC
  An indicator of what kind of record this is.
- twisted.names.dns.UnknownRecord.fancybasename
  twisted.names.dns.UnknownRecord.html#fancybasename
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.dns.UnknownRecord.compareAttributes
  twisted.names.dns.UnknownRecord.html#compareAttributes
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.dns.UnknownRecord.showAttributes
  twisted.names.dns.UnknownRecord.html#showAttributes
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.dns.UnknownRecord.__init__
  twisted.names.dns.UnknownRecord.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.dns.UnknownRecord.encode
  twisted.names.dns.UnknownRecord.html#encode
  Function
  Method
  PUBLIC
  Write the raw bytes corresponding to this record's payload to the stream.
- twisted.names.dns.UnknownRecord.decode
  twisted.names.dns.UnknownRecord.html#decode
  Function
  Method
  PUBLIC
  Load the bytes which are part of this record from the stream and store them unparsed and unmodified.
- twisted.names.dns.UnknownRecord.__hash__
  twisted.names.dns.UnknownRecord.html#__hash__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.dns.Record_SPF
  twisted.names.dns.Record_SPF.html
  Class
  Class
  PUBLIC
  Structurally, freeform text. Semantically, a policy definition, formatted as defined in rfc 4408.
- twisted.names.dns.Record_SPF.data
  twisted.names.dns.Record_SPF.html#data
  Attribute
  Instance Variable
  PUBLIC
  Freeform text which makes up this record.
- twisted.names.dns.Record_SPF.ttl
  twisted.names.dns.Record_SPF.html#ttl
  Attribute
  Instance Variable
  PUBLIC
  The maximum number of seconds which this record should be cached.
- twisted.names.dns.Record_SPF.fancybasename
  twisted.names.dns.Record_SPF.html#fancybasename
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.dns.Record_TSIG
  twisted.names.dns.Record_TSIG.html
  Class
  Class
  PUBLIC
  A transaction signature, encapsulated in a RR, as described in RFC 2845.
- twisted.names.dns.Record_TSIG.algorithm
  twisted.names.dns.Record_TSIG.html#algorithm
  Attribute
  Instance Variable
  PUBLIC
  The name of the signature or MAC algorithm.
- twisted.names.dns.Record_TSIG.timeSigned
  twisted.names.dns.Record_TSIG.html#timeSigned
  Attribute
  Instance Variable
  PUBLIC
  Signing time, as seconds from the POSIX epoch.
- twisted.names.dns.Record_TSIG.fudge
  twisted.names.dns.Record_TSIG.html#fudge
  Attribute
  Instance Variable
  PUBLIC
  Allowable time skew, in seconds.
- twisted.names.dns.Record_TSIG.MAC
  twisted.names.dns.Record_TSIG.html#MAC
  Attribute
  Instance Variable
  PUBLIC
  The message digest or signature.
- twisted.names.dns.Record_TSIG.originalID
  twisted.names.dns.Record_TSIG.html#originalID
  Attribute
  Instance Variable
  PUBLIC
  A message ID.
- twisted.names.dns.Record_TSIG.error
  twisted.names.dns.Record_TSIG.html#error
  Attribute
  Instance Variable
  PUBLIC
  An error code (extended `RCODE`) carried in exceptional cases.
- twisted.names.dns.Record_TSIG.otherData
  twisted.names.dns.Record_TSIG.html#otherData
  Attribute
  Instance Variable
  PUBLIC
  Other data carried in exceptional cases.
- twisted.names.dns.Record_TSIG.fancybasename
  twisted.names.dns.Record_TSIG.html#fancybasename
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.dns.Record_TSIG.compareAttributes
  twisted.names.dns.Record_TSIG.html#compareAttributes
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.dns.Record_TSIG.showAttributes
  twisted.names.dns.Record_TSIG.html#showAttributes
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.dns.Record_TSIG.__init__
  twisted.names.dns.Record_TSIG.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.dns.Record_TSIG.ttl
  twisted.names.dns.Record_TSIG.html#ttl
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.dns.Record_TSIG.encode
  twisted.names.dns.Record_TSIG.html#encode
  Function
  Method
  PUBLIC
  Write a representation of this object to the given file object.
- twisted.names.dns.Record_TSIG.decode
  twisted.names.dns.Record_TSIG.html#decode
  Function
  Method
  PUBLIC
  Reconstruct an object from data read from the given file object.
- twisted.names.dns.Record_TSIG.__hash__
  twisted.names.dns.Record_TSIG.html#__hash__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.dns._responseFromMessage
  twisted.names.dns.html#_responseFromMessage
  Function
  Function
  PRIVATE
  Generate a `Message` like instance suitable for use as the response to `message`.
- twisted.names.dns._getDisplayableArguments
  twisted.names.dns.html#_getDisplayableArguments
  Function
  Function
  PRIVATE
  Inspect the function signature of `obj`'s constructor, and get a list of which arguments should be displayed. This is a helper function for `_compactRepr`.
- twisted.names.dns._compactRepr
  twisted.names.dns.html#_compactRepr
  Function
  Function
  PRIVATE
  Return a `str` representation of `obj` which only shows fields with non-default values, flags which are True and sections which have been explicitly set.
- twisted.names.dns.Message
  twisted.names.dns.Message.html
  Class
  Class
  PUBLIC
  `Message` contains all the information represented by a single DNS request or response.
- twisted.names.dns.Message.id
  twisted.names.dns.Message.html#id
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`
- twisted.names.dns.Message.answer
  twisted.names.dns.Message.html#answer
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`
- twisted.names.dns.Message.opCode
  twisted.names.dns.Message.html#opCode
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`
- twisted.names.dns.Message.recDes
  twisted.names.dns.Message.html#recDes
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`
- twisted.names.dns.Message.recAv
  twisted.names.dns.Message.html#recAv
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`
- twisted.names.dns.Message.auth
  twisted.names.dns.Message.html#auth
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`
- twisted.names.dns.Message.rCode
  twisted.names.dns.Message.html#rCode
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`
- twisted.names.dns.Message.trunc
  twisted.names.dns.Message.html#trunc
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`
- twisted.names.dns.Message.maxSize
  twisted.names.dns.Message.html#maxSize
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`
- twisted.names.dns.Message.authenticData
  twisted.names.dns.Message.html#authenticData
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`
- twisted.names.dns.Message.checkingDisabled
  twisted.names.dns.Message.html#checkingDisabled
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`
- twisted.names.dns.Message.queries
  twisted.names.dns.Message.html#queries
  Attribute
  Instance Variable
  PUBLIC
  The queries which are being asked of or answered by DNS server.
- twisted.names.dns.Message.answers
  twisted.names.dns.Message.html#answers
  Attribute
  Instance Variable
  PUBLIC
  Records containing the answers to `queries` if this is a response message.
- twisted.names.dns.Message.authority
  twisted.names.dns.Message.html#authority
  Attribute
  Instance Variable
  PUBLIC
  Records containing information about the authoritative DNS servers for the names in `queries`.
- twisted.names.dns.Message.additional
  twisted.names.dns.Message.html#additional
  Attribute
  Instance Variable
  PUBLIC
  Records containing IP addresses of host names in `answers` and `authority`.
- twisted.names.dns.Message._flagNames
  twisted.names.dns.Message.html#_flagNames
  Attribute
  Instance Variable
  PRIVATE
  The names of attributes representing the flag header fields.
- twisted.names.dns.Message._fieldNames
  twisted.names.dns.Message.html#_fieldNames
  Attribute
  Instance Variable
  PRIVATE
  The names of attributes representing non-flag fixed header fields.
- twisted.names.dns.Message._sectionNames
  twisted.names.dns.Message.html#_sectionNames
  Attribute
  Instance Variable
  PRIVATE
  The names of attributes representing the record sections of this message.
- twisted.names.dns.Message.compareAttributes
  twisted.names.dns.Message.html#compareAttributes
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.dns.Message.headerFmt
  twisted.names.dns.Message.html#headerFmt
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.dns.Message.headerSize
  twisted.names.dns.Message.html#headerSize
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.dns.Message.add
  twisted.names.dns.Message.html#add
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.dns.Message.ns
  twisted.names.dns.Message.html#ns
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.dns.Message.__init__
  twisted.names.dns.Message.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.names.dns.Message.__repr__
  twisted.names.dns.Message.html#__repr__
  Function
  Method
  PUBLIC
  Generate a repr of this `Message`.
- twisted.names.dns.Message.addQuery
  twisted.names.dns.Message.html#addQuery
  Function
  Method
  PUBLIC
  Add another query to this Message.
- twisted.names.dns.Message.encode
  twisted.names.dns.Message.html#encode
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.dns.Message.decode
  twisted.names.dns.Message.html#decode
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.dns.Message.parseRecords
  twisted.names.dns.Message.html#parseRecords
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.dns.Message._recordTypes
  twisted.names.dns.Message.html#_recordTypes
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.names.dns.Message.lookupRecordType
  twisted.names.dns.Message.html#lookupRecordType
  Function
  Method
  PUBLIC
  Retrieve the `IRecord` implementation for the given record type.
- twisted.names.dns.Message.toStr
  twisted.names.dns.Message.html#toStr
  Function
  Method
  PUBLIC
  Encode this `Message` into a byte string in the format described by RFC
- twisted.names.dns.Message.fromStr
  twisted.names.dns.Message.html#fromStr
  Function
  Method
  PUBLIC
  Decode a byte string in the format described by RFC 1035 into this `Message`.
- twisted.names.dns._EDNSMessage
  twisted.names.dns._EDNSMessage.html
  Class
  Class
  PRIVATE
  An EDNS message.
- twisted.names.dns._EDNSMessage.id
  twisted.names.dns._EDNSMessage.html#id
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`
- twisted.names.dns._EDNSMessage.answer
  twisted.names.dns._EDNSMessage.html#answer
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`
- twisted.names.dns._EDNSMessage.opCode
  twisted.names.dns._EDNSMessage.html#opCode
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`
- twisted.names.dns._EDNSMessage.auth
  twisted.names.dns._EDNSMessage.html#auth
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`
- twisted.names.dns._EDNSMessage.trunc
  twisted.names.dns._EDNSMessage.html#trunc
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`
- twisted.names.dns._EDNSMessage.recDes
  twisted.names.dns._EDNSMessage.html#recDes
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`
- twisted.names.dns._EDNSMessage.recAv
  twisted.names.dns._EDNSMessage.html#recAv
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`
- twisted.names.dns._EDNSMessage.rCode
  twisted.names.dns._EDNSMessage.html#rCode
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`
- twisted.names.dns._EDNSMessage.ednsVersion
  twisted.names.dns._EDNSMessage.html#ednsVersion
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`
- twisted.names.dns._EDNSMessage.dnssecOK
  twisted.names.dns._EDNSMessage.html#dnssecOK
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`
- twisted.names.dns._EDNSMessage.authenticData
  twisted.names.dns._EDNSMessage.html#authenticData
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`
- twisted.names.dns._EDNSMessage.checkingDisabled
  twisted.names.dns._EDNSMessage.html#checkingDisabled
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`
- twisted.names.dns._EDNSMessage.maxSize
  twisted.names.dns._EDNSMessage.html#maxSize
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`
- twisted.names.dns._EDNSMessage.queries
  twisted.names.dns._EDNSMessage.html#queries
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`
- twisted.names.dns._EDNSMessage.answers
  twisted.names.dns._EDNSMessage.html#answers
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`
- twisted.names.dns._EDNSMessage.authority
  twisted.names.dns._EDNSMessage.html#authority
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`
- twisted.names.dns._EDNSMessage.additional
  twisted.names.dns._EDNSMessage.html#additional
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`
- twisted.names.dns._EDNSMessage._messageFactory
  twisted.names.dns._EDNSMessage.html#_messageFactory
  Attribute
  Instance Variable
  PRIVATE
  A constructor of `Message` instances. Called by `_toMessage` and `_fromMessage`.
- twisted.names.dns._EDNSMessage.compareAttributes
  twisted.names.dns._EDNSMessage.html#compareAttributes
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.dns._EDNSMessage.__init__
  twisted.names.dns._EDNSMessage.html#__init__
  Function
  Method
  PUBLIC
  Construct a new `_EDNSMessage`
- twisted.names.dns._EDNSMessage.__repr__
  twisted.names.dns._EDNSMessage.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.dns._EDNSMessage._toMessage
  twisted.names.dns._EDNSMessage.html#_toMessage
  Function
  Method
  PRIVATE
  Convert to a standard `dns.Message`.
- twisted.names.dns._EDNSMessage.toStr
  twisted.names.dns._EDNSMessage.html#toStr
  Function
  Method
  PUBLIC
  Encode to wire format by first converting to a standard `dns.Message`.
- twisted.names.dns._EDNSMessage._fromMessage
  twisted.names.dns._EDNSMessage.html#_fromMessage
  Function
  Class Method
  PRIVATE
  Construct and return a new `_EDNSMessage` whose attributes and records are derived from the attributes and records of `message` (a `Message` instance).
- twisted.names.dns._EDNSMessage.fromStr
  twisted.names.dns._EDNSMessage.html#fromStr
  Function
  Method
  PUBLIC
  Decode from wire format, saving flags, values and records to this `_EDNSMessage` instance in place.
- twisted.names.dns.DNSMixin
  twisted.names.dns.DNSMixin.html
  Class
  Class
  PUBLIC
  DNS protocol mixin shared by UDP and TCP implementations.
- twisted.names.dns.DNSMixin._reactor
  twisted.names.dns.DNSMixin.html#_reactor
  Attribute
  Instance Variable
  PRIVATE
  A `IReactorTime` and `IReactorUDP` provider which will be used to issue DNS queries and manage request timeouts.
- twisted.names.dns.DNSMixin.id
  twisted.names.dns.DNSMixin.html#id
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.dns.DNSMixin.liveMessages
  twisted.names.dns.DNSMixin.html#liveMessages
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.dns.DNSMixin.__init__
  twisted.names.dns.DNSMixin.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.dns.DNSMixin.controller
  twisted.names.dns.DNSMixin.html#controller
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.dns.DNSMixin.pickID
  twisted.names.dns.DNSMixin.html#pickID
  Function
  Method
  PUBLIC
  Return a unique ID for queries.
- twisted.names.dns.DNSMixin.callLater
  twisted.names.dns.DNSMixin.html#callLater
  Function
  Method
  PUBLIC
  Wrapper around reactor.callLater, mainly for test purpose.
- twisted.names.dns.DNSMixin._query
  twisted.names.dns.DNSMixin.html#_query
  Function
  Method
  PRIVATE
  Send out a message with the given queries.
- twisted.names.dns.DNSMixin._clearFailed
  twisted.names.dns.DNSMixin.html#_clearFailed
  Function
  Method
  PRIVATE
  Clean the Deferred after a timeout.
- twisted.names.dns.DNSDatagramProtocol
  twisted.names.dns.DNSDatagramProtocol.html
  Class
  Class
  PUBLIC
  DNS protocol over UDP.
- twisted.names.dns.DNSDatagramProtocol.resends
  twisted.names.dns.DNSDatagramProtocol.html#resends
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.dns.DNSDatagramProtocol.stopProtocol
  twisted.names.dns.DNSDatagramProtocol.html#stopProtocol
  Function
  Method
  PUBLIC
  Stop protocol: reset state variables.
- twisted.names.dns.DNSDatagramProtocol.liveMessages
  twisted.names.dns.DNSDatagramProtocol.html#liveMessages
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.dns.DNSDatagramProtocol.transport
  twisted.names.dns.DNSDatagramProtocol.html#transport
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.dns.DNSDatagramProtocol.startProtocol
  twisted.names.dns.DNSDatagramProtocol.html#startProtocol
  Function
  Method
  PUBLIC
  Upon start, reset internal state.
- twisted.names.dns.DNSDatagramProtocol.writeMessage
  twisted.names.dns.DNSDatagramProtocol.html#writeMessage
  Function
  Method
  PUBLIC
  Send a message holding DNS queries.
- twisted.names.dns.DNSDatagramProtocol.startListening
  twisted.names.dns.DNSDatagramProtocol.html#startListening
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.dns.DNSDatagramProtocol.datagramReceived
  twisted.names.dns.DNSDatagramProtocol.html#datagramReceived
  Function
  Method
  PUBLIC
  Read a datagram, extract the message in it and trigger the associated Deferred.
- twisted.names.dns.DNSDatagramProtocol.removeResend
  twisted.names.dns.DNSDatagramProtocol.html#removeResend
  Function
  Method
  PUBLIC
  Mark message ID as no longer having duplication suppression.
- twisted.names.dns.DNSDatagramProtocol.query
  twisted.names.dns.DNSDatagramProtocol.html#query
  Function
  Method
  PUBLIC
  Send out a message with the given queries.
- twisted.names.dns.DNSProtocol
  twisted.names.dns.DNSProtocol.html
  Class
  Class
  PUBLIC
  DNS protocol over TCP.
- twisted.names.dns.DNSProtocol.length
  twisted.names.dns.DNSProtocol.html#length
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.dns.DNSProtocol.buffer
  twisted.names.dns.DNSProtocol.html#buffer
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.dns.DNSProtocol.writeMessage
  twisted.names.dns.DNSProtocol.html#writeMessage
  Function
  Method
  PUBLIC
  Send a message holding DNS queries.
- twisted.names.dns.DNSProtocol.connectionMade
  twisted.names.dns.DNSProtocol.html#connectionMade
  Function
  Method
  PUBLIC
  Connection is made: reset internal state, and notify the controller.
- twisted.names.dns.DNSProtocol.liveMessages
  twisted.names.dns.DNSProtocol.html#liveMessages
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.dns.DNSProtocol.connectionLost
  twisted.names.dns.DNSProtocol.html#connectionLost
  Function
  Method
  PUBLIC
  Notify the controller that this protocol is no longer connected.
- twisted.names.dns.DNSProtocol.dataReceived
  twisted.names.dns.DNSProtocol.html#dataReceived
  Function
  Method
  PUBLIC
  Called whenever data is received.
- twisted.names.dns.DNSProtocol.query
  twisted.names.dns.DNSProtocol.html#query
  Function
  Method
  PUBLIC
  Send out a message with the given queries.
- twisted.internet.interfaces.IAddress
  twisted.internet.interfaces.IAddress.html
  Class
  Interface
  PUBLIC
  An address, e.g. a TCP `(host, port)`.
- twisted.internet.interfaces.IConnector
  twisted.internet.interfaces.IConnector.html
  Class
  Interface
  PUBLIC
  Object used to interface between connections and protocols.
- twisted.internet.interfaces.IConnector.stopConnecting
  twisted.internet.interfaces.IConnector.html#stopConnecting
  Function
  Method
  PUBLIC
  Stop attempting to connect.
- twisted.internet.interfaces.IConnector.disconnect
  twisted.internet.interfaces.IConnector.html#disconnect
  Function
  Method
  PUBLIC
  Disconnect regardless of the connection state.
- twisted.internet.interfaces.IConnector.connect
  twisted.internet.interfaces.IConnector.html#connect
  Function
  Method
  PUBLIC
  Try to connect to remote address.
- twisted.internet.interfaces.IConnector.getDestination
  twisted.internet.interfaces.IConnector.html#getDestination
  Function
  Method
  PUBLIC
  Return destination this will try to connect to.
- twisted.internet.interfaces.IResolverSimple
  twisted.internet.interfaces.IResolverSimple.html
  Class
  Interface
  PUBLIC
  No interface docstring; 1/1 method documented
- twisted.internet.interfaces.IResolverSimple.getHostByName
  twisted.internet.interfaces.IResolverSimple.html#getHostByName
  Function
  Method
  PUBLIC
  Resolve the domain name `name` into an IP address.
- twisted.internet.interfaces.IHostResolution
  twisted.internet.interfaces.IHostResolution.html
  Class
  Interface
  PUBLIC
  An `IHostResolution` represents represents an in-progress recursive query for a DNS name.
- twisted.internet.interfaces.IHostResolution.name
  twisted.internet.interfaces.IHostResolution.html#name
  Attribute
  Attribute
  PUBLIC
  `unicode`; the name of the host being resolved.
- twisted.internet.interfaces.IHostResolution.cancel
  twisted.internet.interfaces.IHostResolution.html#cancel
  Function
  Method
  PUBLIC
  Stop the hostname resolution in progress.
- twisted.internet.interfaces.IResolutionReceiver
  twisted.internet.interfaces.IResolutionReceiver.html
  Class
  Interface
  PUBLIC
  An `IResolutionReceiver` receives the results of a hostname resolution in progress, initiated by an `IHostnameResolver`.
- twisted.internet.interfaces.IResolutionReceiver.resolutionBegan
  twisted.internet.interfaces.IResolutionReceiver.html#resolutionBegan
  Function
  Method
  PUBLIC
  A hostname resolution began.
- twisted.internet.interfaces.IResolutionReceiver.addressResolved
  twisted.internet.interfaces.IResolutionReceiver.html#addressResolved
  Function
  Method
  PUBLIC
  An internet address. This is called when an address for the given name is discovered. In the current implementation this practically means `IPv4Address` or `IPv6Address`, but implementations of this interface should be lenient to other types being passed to this interface as well, for future-proofing.
- twisted.internet.interfaces.IResolutionReceiver.resolutionComplete
  twisted.internet.interfaces.IResolutionReceiver.html#resolutionComplete
  Function
  Method
  PUBLIC
  Resolution has completed; no further addresses will be relayed to `IResolutionReceiver.addressResolved`.
- twisted.internet.interfaces.IHostnameResolver
  twisted.internet.interfaces.IHostnameResolver.html
  Class
  Interface
  PUBLIC
  An `IHostnameResolver` can resolve a host name and port number into a series of `IAddress` objects.
- twisted.internet.interfaces.IHostnameResolver.resolveHostName
  twisted.internet.interfaces.IHostnameResolver.html#resolveHostName
  Function
  Method
  PUBLIC
  Initiate a hostname resolution.
- twisted.internet.interfaces.IResolver
  twisted.internet.interfaces.IResolver.html
  Class
  Interface
  PUBLIC
  No interface docstring; 24/24 methods documented
- twisted.internet.interfaces.IResolver.query
  twisted.internet.interfaces.IResolver.html#query
  Function
  Method
  PUBLIC
  Dispatch `query` to the method which can handle its type.
- twisted.internet.interfaces.IResolver.lookupAddress
  twisted.internet.interfaces.IResolver.html#lookupAddress
  Function
  Method
  PUBLIC
  Perform an A record lookup.
- twisted.internet.interfaces.IResolver.lookupAddress6
  twisted.internet.interfaces.IResolver.html#lookupAddress6
  Function
  Method
  PUBLIC
  Perform an A6 record lookup.
- twisted.internet.interfaces.IResolver.lookupIPV6Address
  twisted.internet.interfaces.IResolver.html#lookupIPV6Address
  Function
  Method
  PUBLIC
  Perform an AAAA record lookup.
- twisted.internet.interfaces.IResolver.lookupMailExchange
  twisted.internet.interfaces.IResolver.html#lookupMailExchange
  Function
  Method
  PUBLIC
  Perform an MX record lookup.
- twisted.internet.interfaces.IResolver.lookupNameservers
  twisted.internet.interfaces.IResolver.html#lookupNameservers
  Function
  Method
  PUBLIC
  Perform an NS record lookup.
- twisted.internet.interfaces.IResolver.lookupCanonicalName
  twisted.internet.interfaces.IResolver.html#lookupCanonicalName
  Function
  Method
  PUBLIC
  Perform a CNAME record lookup.
- twisted.internet.interfaces.IResolver.lookupMailBox
  twisted.internet.interfaces.IResolver.html#lookupMailBox
  Function
  Method
  PUBLIC
  Perform an MB record lookup.
- twisted.internet.interfaces.IResolver.lookupMailGroup
  twisted.internet.interfaces.IResolver.html#lookupMailGroup
  Function
  Method
  PUBLIC
  Perform an MG record lookup.
- twisted.internet.interfaces.IResolver.lookupMailRename
  twisted.internet.interfaces.IResolver.html#lookupMailRename
  Function
  Method
  PUBLIC
  Perform an MR record lookup.
- twisted.internet.interfaces.IResolver.lookupPointer
  twisted.internet.interfaces.IResolver.html#lookupPointer
  Function
  Method
  PUBLIC
  Perform a PTR record lookup.
- twisted.internet.interfaces.IResolver.lookupAuthority
  twisted.internet.interfaces.IResolver.html#lookupAuthority
  Function
  Method
  PUBLIC
  Perform an SOA record lookup.
- twisted.internet.interfaces.IResolver.lookupNull
  twisted.internet.interfaces.IResolver.html#lookupNull
  Function
  Method
  PUBLIC
  Perform a NULL record lookup.
- twisted.internet.interfaces.IResolver.lookupWellKnownServices
  twisted.internet.interfaces.IResolver.html#lookupWellKnownServices
  Function
  Method
  PUBLIC
  Perform a WKS record lookup.
- twisted.internet.interfaces.IResolver.lookupHostInfo
  twisted.internet.interfaces.IResolver.html#lookupHostInfo
  Function
  Method
  PUBLIC
  Perform a HINFO record lookup.
- twisted.internet.interfaces.IResolver.lookupMailboxInfo
  twisted.internet.interfaces.IResolver.html#lookupMailboxInfo
  Function
  Method
  PUBLIC
  Perform an MINFO record lookup.
- twisted.internet.interfaces.IResolver.lookupText
  twisted.internet.interfaces.IResolver.html#lookupText
  Function
  Method
  PUBLIC
  Perform a TXT record lookup.
- twisted.internet.interfaces.IResolver.lookupResponsibility
  twisted.internet.interfaces.IResolver.html#lookupResponsibility
  Function
  Method
  PUBLIC
  Perform an RP record lookup.
- twisted.internet.interfaces.IResolver.lookupAFSDatabase
  twisted.internet.interfaces.IResolver.html#lookupAFSDatabase
  Function
  Method
  PUBLIC
  Perform an AFSDB record lookup.
- twisted.internet.interfaces.IResolver.lookupService
  twisted.internet.interfaces.IResolver.html#lookupService
  Function
  Method
  PUBLIC
  Perform an SRV record lookup.
- twisted.internet.interfaces.IResolver.lookupAllRecords
  twisted.internet.interfaces.IResolver.html#lookupAllRecords
  Function
  Method
  PUBLIC
  Perform an ALL_RECORD lookup.
- twisted.internet.interfaces.IResolver.lookupSenderPolicy
  twisted.internet.interfaces.IResolver.html#lookupSenderPolicy
  Function
  Method
  PUBLIC
  Perform a SPF record lookup.
- twisted.internet.interfaces.IResolver.lookupNamingAuthorityPointer
  twisted.internet.interfaces.IResolver.html#lookupNamingAuthorityPointer
  Function
  Method
  PUBLIC
  Perform a NAPTR record lookup.
- twisted.internet.interfaces.IResolver.lookupZone
  twisted.internet.interfaces.IResolver.html#lookupZone
  Function
  Method
  PUBLIC
  Perform an AXFR record lookup.
- twisted.internet.interfaces.IReactorTCP
  twisted.internet.interfaces.IReactorTCP.html
  Class
  Interface
  PUBLIC
  No interface docstring; 2/2 methods documented
- twisted.internet.interfaces.IReactorTCP.listenTCP
  twisted.internet.interfaces.IReactorTCP.html#listenTCP
  Function
  Method
  PUBLIC
  Connects a given protocol factory to the given numeric TCP/IP port.
- twisted.internet.interfaces.IReactorTCP.connectTCP
  twisted.internet.interfaces.IReactorTCP.html#connectTCP
  Function
  Method
  PUBLIC
  Connect a TCP client.
- twisted.internet.interfaces.IReactorSSL
  twisted.internet.interfaces.IReactorSSL.html
  Class
  Interface
  PUBLIC
  No interface docstring; 2/2 methods documented
- twisted.internet.interfaces.IReactorSSL.connectSSL
  twisted.internet.interfaces.IReactorSSL.html#connectSSL
  Function
  Method
  PUBLIC
  Connect a client Protocol to a remote SSL socket.
- twisted.internet.interfaces.IReactorSSL.listenSSL
  twisted.internet.interfaces.IReactorSSL.html#listenSSL
  Function
  Method
  PUBLIC
  Connects a given protocol factory to the given numeric TCP/IP port. The connection is a SSL one, using contexts created by the context factory.
- twisted.internet.interfaces.IReactorUNIX
  twisted.internet.interfaces.IReactorUNIX.html
  Class
  Interface
  PUBLIC
  UNIX socket methods.
- twisted.internet.interfaces.IReactorUNIX.connectUNIX
  twisted.internet.interfaces.IReactorUNIX.html#connectUNIX
  Function
  Method
  PUBLIC
  Connect a client protocol to a UNIX socket.
- twisted.internet.interfaces.IReactorUNIX.listenUNIX
  twisted.internet.interfaces.IReactorUNIX.html#listenUNIX
  Function
  Method
  PUBLIC
  Listen on a UNIX socket.
- twisted.internet.interfaces.IReactorUNIXDatagram
  twisted.internet.interfaces.IReactorUNIXDatagram.html
  Class
  Interface
  PUBLIC
  Datagram UNIX socket methods.
- twisted.internet.interfaces.IReactorUNIXDatagram.connectUNIXDatagram
  twisted.internet.interfaces.IReactorUNIXDatagram.html#connectUNIXDatagram
  Function
  Method
  PUBLIC
  Connect a client protocol to a datagram UNIX socket.
- twisted.internet.interfaces.IReactorUNIXDatagram.listenUNIXDatagram
  twisted.internet.interfaces.IReactorUNIXDatagram.html#listenUNIXDatagram
  Function
  Method
  PUBLIC
  Listen on a datagram UNIX socket.
- twisted.internet.interfaces.IReactorWin32Events
  twisted.internet.interfaces.IReactorWin32Events.html
  Class
  Interface
  PUBLIC
  Win32 Event API methods
- twisted.internet.interfaces.IReactorWin32Events.addEvent
  twisted.internet.interfaces.IReactorWin32Events.html#addEvent
  Function
  Method
  PUBLIC
  Add a new win32 event to the event loop.
- twisted.internet.interfaces.IReactorWin32Events.removeEvent
  twisted.internet.interfaces.IReactorWin32Events.html#removeEvent
  Function
  Method
  PUBLIC
  Remove an event.
- twisted.internet.interfaces.IReactorUDP
  twisted.internet.interfaces.IReactorUDP.html
  Class
  Interface
  PUBLIC
  UDP socket methods.
- twisted.internet.interfaces.IReactorUDP.listenUDP
  twisted.internet.interfaces.IReactorUDP.html#listenUDP
  Function
  Method
  PUBLIC
  Connects a given `DatagramProtocol` to the given numeric UDP port.
- twisted.internet.interfaces.IReactorMulticast
  twisted.internet.interfaces.IReactorMulticast.html
  Class
  Interface
  PUBLIC
  UDP socket methods that support multicast.
- twisted.internet.interfaces.IReactorMulticast.listenMulticast
  twisted.internet.interfaces.IReactorMulticast.html#listenMulticast
  Function
  Method
  PUBLIC
  Connects a given `DatagramProtocol` to the given numeric UDP port.
- twisted.internet.interfaces.IReactorSocket
  twisted.internet.interfaces.IReactorSocket.html
  Class
  Interface
  PUBLIC
  Methods which allow a reactor to use externally created sockets.
- twisted.internet.interfaces.IReactorSocket.adoptStreamPort
  twisted.internet.interfaces.IReactorSocket.html#adoptStreamPort
  Function
  Method
  PUBLIC
  Add an existing listening SOCK_STREAM socket to the reactor to monitor for new connections to accept and handle.
- twisted.internet.interfaces.IReactorSocket.adoptStreamConnection
  twisted.internet.interfaces.IReactorSocket.html#adoptStreamConnection
  Function
  Method
  PUBLIC
  Add an existing connected SOCK_STREAM socket to the reactor to monitor for data.
- twisted.internet.interfaces.IReactorSocket.adoptDatagramPort
  twisted.internet.interfaces.IReactorSocket.html#adoptDatagramPort
  Function
  Method
  PUBLIC
  Add an existing listening SOCK_DGRAM socket to the reactor to monitor for read and write readiness.
- twisted.internet.interfaces.IReactorProcess
  twisted.internet.interfaces.IReactorProcess.html
  Class
  Interface
  PUBLIC
  No interface docstring; 1/1 method documented
- twisted.internet.interfaces.IReactorProcess.spawnProcess
  twisted.internet.interfaces.IReactorProcess.html#spawnProcess
  Function
  Method
  PUBLIC
  Spawn a process, with a process protocol.
- twisted.internet.interfaces.IReactorTime
  twisted.internet.interfaces.IReactorTime.html
  Class
  Interface
  PUBLIC
  Time methods that a Reactor should implement.
- twisted.internet.interfaces.IReactorTime.seconds
  twisted.internet.interfaces.IReactorTime.html#seconds
  Function
  Method
  PUBLIC
  Get the current time in seconds.
- twisted.internet.interfaces.IReactorTime.callLater
  twisted.internet.interfaces.IReactorTime.html#callLater
  Function
  Method
  PUBLIC
  Call a function later.
- twisted.internet.interfaces.IReactorTime.getDelayedCalls
  twisted.internet.interfaces.IReactorTime.html#getDelayedCalls
  Function
  Method
  PUBLIC
  See `twisted.internet.interfaces.IReactorTime.getDelayedCalls`
- twisted.internet.interfaces.IDelayedCall
  twisted.internet.interfaces.IDelayedCall.html
  Class
  Interface
  PUBLIC
  A scheduled call.
- twisted.internet.interfaces.IDelayedCall.getTime
  twisted.internet.interfaces.IDelayedCall.html#getTime
  Function
  Method
  PUBLIC
  Get time when delayed call will happen.
- twisted.internet.interfaces.IDelayedCall.cancel
  twisted.internet.interfaces.IDelayedCall.html#cancel
  Function
  Method
  PUBLIC
  Cancel the scheduled call.
- twisted.internet.interfaces.IDelayedCall.delay
  twisted.internet.interfaces.IDelayedCall.html#delay
  Function
  Method
  PUBLIC
  Delay the scheduled call.
- twisted.internet.interfaces.IDelayedCall.reset
  twisted.internet.interfaces.IDelayedCall.html#reset
  Function
  Method
  PUBLIC
  Reset the scheduled call's timer.
- twisted.internet.interfaces.IDelayedCall.active
  twisted.internet.interfaces.IDelayedCall.html#active
  Function
  Method
  PUBLIC
  No summary
- twisted.internet.interfaces.IReactorFromThreads
  twisted.internet.interfaces.IReactorFromThreads.html
  Class
  Interface
  PUBLIC
  This interface is the set of thread-safe methods which may be invoked on the reactor from other threads.
- twisted.internet.interfaces.IReactorFromThreads.callFromThread
  twisted.internet.interfaces.IReactorFromThreads.html#callFromThread
  Function
  Method
  PUBLIC
  Cause a function to be executed by the reactor thread.
- twisted.internet.interfaces.IReactorInThreads
  twisted.internet.interfaces.IReactorInThreads.html
  Class
  Interface
  PUBLIC
  This interface contains the methods exposed by a reactor which will let you run functions in another thread.
- twisted.internet.interfaces.IReactorInThreads.callInThread
  twisted.internet.interfaces.IReactorInThreads.html#callInThread
  Function
  Method
  PUBLIC
  Run the given callable object in a separate thread, with the given arguments and keyword arguments.
- twisted.internet.interfaces.IReactorThreads
  twisted.internet.interfaces.IReactorThreads.html
  Class
  Interface
  PUBLIC
  Dispatch methods to be run in threads.
- twisted.internet.interfaces.IReactorThreads.getThreadPool
  twisted.internet.interfaces.IReactorThreads.html#getThreadPool
  Function
  Method
  PUBLIC
  Return the threadpool used by `IReactorInThreads.callInThread`. Create it first if necessary.
- twisted.internet.interfaces.IReactorThreads.suggestThreadPoolSize
  twisted.internet.interfaces.IReactorThreads.html#suggestThreadPoolSize
  Function
  Method
  PUBLIC
  Suggest the size of the internal threadpool used to dispatch functions passed to `IReactorInThreads.callInThread`.
- twisted.internet.interfaces.IReactorCore
  twisted.internet.interfaces.IReactorCore.html
  Class
  Interface
  PUBLIC
  Core methods that a Reactor must implement.
- twisted.internet.interfaces.IReactorCore.running
  twisted.internet.interfaces.IReactorCore.html#running
  Attribute
  Attribute
  PUBLIC
  A `bool` which is `True` from during startup to during shutdown and `False` the rest of the time.
- twisted.internet.interfaces.IReactorCore.resolve
  twisted.internet.interfaces.IReactorCore.html#resolve
  Function
  Method
  PUBLIC
  Return a `twisted.internet.defer.Deferred` that will resolve a hostname.
- twisted.internet.interfaces.IReactorCore.run
  twisted.internet.interfaces.IReactorCore.html#run
  Function
  Method
  PUBLIC
  Fire 'startup' System Events, move the reactor to the 'running' state, then run the main loop until it is stopped with `stop()` or `crash()`.
- twisted.internet.interfaces.IReactorCore.stop
  twisted.internet.interfaces.IReactorCore.html#stop
  Function
  Method
  PUBLIC
  Fire 'shutdown' System Events, which will move the reactor to the 'stopped' state and cause `reactor.run()` to exit.
- twisted.internet.interfaces.IReactorCore.crash
  twisted.internet.interfaces.IReactorCore.html#crash
  Function
  Method
  PUBLIC
  Stop the main loop *immediately*, without firing any system events.
- twisted.internet.interfaces.IReactorCore.iterate
  twisted.internet.interfaces.IReactorCore.html#iterate
  Function
  Method
  PUBLIC
  Run the main loop's I/O polling function for a period of time.
- twisted.internet.interfaces.IReactorCore.fireSystemEvent
  twisted.internet.interfaces.IReactorCore.html#fireSystemEvent
  Function
  Method
  PUBLIC
  Fire a system-wide event.
- twisted.internet.interfaces.IReactorCore.addSystemEventTrigger
  twisted.internet.interfaces.IReactorCore.html#addSystemEventTrigger
  Function
  Method
  PUBLIC
  Add a function to be called when a system event occurs.
- twisted.internet.interfaces.IReactorCore.removeSystemEventTrigger
  twisted.internet.interfaces.IReactorCore.html#removeSystemEventTrigger
  Function
  Method
  PUBLIC
  Removes a trigger added with addSystemEventTrigger.
- twisted.internet.interfaces.IReactorCore.callWhenRunning
  twisted.internet.interfaces.IReactorCore.html#callWhenRunning
  Function
  Method
  PUBLIC
  Call a function when the reactor is running.
- twisted.internet.interfaces.IReactorPluggableResolver
  twisted.internet.interfaces.IReactorPluggableResolver.html
  Class
  Interface
  PUBLIC
  An `IReactorPluggableResolver` is a reactor which can be customized with an `IResolverSimple`. This is a fairly limited interface, that supports only IPv4; you should use `IReactorPluggableNameResolver` instead.
- twisted.internet.interfaces.IReactorPluggableResolver.installResolver
  twisted.internet.interfaces.IReactorPluggableResolver.html#installResolver
  Function
  Method
  PUBLIC
  Set the internal resolver to use to for name lookups.
- twisted.internet.interfaces.IReactorPluggableNameResolver
  twisted.internet.interfaces.IReactorPluggableNameResolver.html
  Class
  Interface
  PUBLIC
  An `IReactorPluggableNameResolver` is a reactor whose name resolver can be set to a user-supplied object.
- twisted.internet.interfaces.IReactorPluggableNameResolver.nameResolver
  twisted.internet.interfaces.IReactorPluggableNameResolver.html#nameResolver
  Attribute
  Attribute
  PUBLIC
  Read-only attribute; the resolver installed with `installResolver`. An `IHostnameResolver`.
- twisted.internet.interfaces.IReactorPluggableNameResolver.installNameResolver
  twisted.internet.interfaces.IReactorPluggableNameResolver.html#installNameResolver
  Function
  Method
  PUBLIC
  Set the internal resolver to use for name lookups.
- twisted.internet.interfaces.IReactorDaemonize
  twisted.internet.interfaces.IReactorDaemonize.html
  Class
  Interface
  PUBLIC
  A reactor which provides hooks that need to be called before and after daemonization.
- twisted.internet.interfaces.IReactorDaemonize.beforeDaemonize
  twisted.internet.interfaces.IReactorDaemonize.html#beforeDaemonize
  Function
  Method
  PUBLIC
  Hook to be called immediately before daemonization. No reactor methods may be called until `afterDaemonize` is called.
- twisted.internet.interfaces.IReactorDaemonize.afterDaemonize
  twisted.internet.interfaces.IReactorDaemonize.html#afterDaemonize
  Function
  Method
  PUBLIC
  Hook to be called immediately after daemonization. This may only be called after `beforeDaemonize` had been called previously.
- twisted.internet.interfaces.IReactorFDSet
  twisted.internet.interfaces.IReactorFDSet.html
  Class
  Interface
  PUBLIC
  Implement me to be able to use `IFileDescriptor` type resources.
- twisted.internet.interfaces.IReactorFDSet.addReader
  twisted.internet.interfaces.IReactorFDSet.html#addReader
  Function
  Method
  PUBLIC
  I add reader to the set of file descriptors to get read events for.
- twisted.internet.interfaces.IReactorFDSet.addWriter
  twisted.internet.interfaces.IReactorFDSet.html#addWriter
  Function
  Method
  PUBLIC
  I add writer to the set of file descriptors to get write events for.
- twisted.internet.interfaces.IReactorFDSet.removeReader
  twisted.internet.interfaces.IReactorFDSet.html#removeReader
  Function
  Method
  PUBLIC
  Removes an object previously added with `addReader`.
- twisted.internet.interfaces.IReactorFDSet.removeWriter
  twisted.internet.interfaces.IReactorFDSet.html#removeWriter
  Function
  Method
  PUBLIC
  Removes an object previously added with `addWriter`.
- twisted.internet.interfaces.IReactorFDSet.removeAll
  twisted.internet.interfaces.IReactorFDSet.html#removeAll
  Function
  Method
  PUBLIC
  Remove all readers and writers.
- twisted.internet.interfaces.IReactorFDSet.getReaders
  twisted.internet.interfaces.IReactorFDSet.html#getReaders
  Function
  Method
  PUBLIC
  Return the list of file descriptors currently monitored for input events by the reactor.
- twisted.internet.interfaces.IReactorFDSet.getWriters
  twisted.internet.interfaces.IReactorFDSet.html#getWriters
  Function
  Method
  PUBLIC
  Return the list file descriptors currently monitored for output events by the reactor.
- twisted.internet.interfaces.IListeningPort
  twisted.internet.interfaces.IListeningPort.html
  Class
  Interface
  PUBLIC
  A listening port.
- twisted.internet.interfaces.IListeningPort.startListening
  twisted.internet.interfaces.IListeningPort.html#startListening
  Function
  Method
  PUBLIC
  Start listening on this port.
- twisted.internet.interfaces.IListeningPort.stopListening
  twisted.internet.interfaces.IListeningPort.html#stopListening
  Function
  Method
  PUBLIC
  Stop listening on this port.
- twisted.internet.interfaces.IListeningPort.getHost
  twisted.internet.interfaces.IListeningPort.html#getHost
  Function
  Method
  PUBLIC
  Get the host that this port is listening for.
- twisted.internet.interfaces.ILoggingContext
  twisted.internet.interfaces.ILoggingContext.html
  Class
  Interface
  PUBLIC
  Give context information that will be used to log events generated by this item.
- twisted.internet.interfaces.ILoggingContext.logPrefix
  twisted.internet.interfaces.ILoggingContext.html#logPrefix
  Function
  Method
  PUBLIC
  No summary
- twisted.internet.interfaces.IFileDescriptor
  twisted.internet.interfaces.IFileDescriptor.html
  Class
  Interface
  PUBLIC
  An interface representing a UNIX-style numeric file descriptor.
- twisted.internet.interfaces.IFileDescriptor.fileno
  twisted.internet.interfaces.IFileDescriptor.html#fileno
  Function
  Method
  PUBLIC
  No summary
- twisted.internet.interfaces.IFileDescriptor.connectionLost
  twisted.internet.interfaces.IFileDescriptor.html#connectionLost
  Function
  Method
  PUBLIC
  Called when the connection was lost.
- twisted.internet.interfaces.IReadDescriptor
  twisted.internet.interfaces.IReadDescriptor.html
  Class
  Interface
  PUBLIC
  An `IFileDescriptor` that can read.
- twisted.internet.interfaces.IReadDescriptor.doRead
  twisted.internet.interfaces.IReadDescriptor.html#doRead
  Function
  Method
  PUBLIC
  Some data is available for reading on your descriptor.
- twisted.internet.interfaces.IWriteDescriptor
  twisted.internet.interfaces.IWriteDescriptor.html
  Class
  Interface
  PUBLIC
  An `IFileDescriptor` that can write.
- twisted.internet.interfaces.IWriteDescriptor.doWrite
  twisted.internet.interfaces.IWriteDescriptor.html#doWrite
  Function
  Method
  PUBLIC
  Some data can be written to your descriptor.
- twisted.internet.interfaces.IReadWriteDescriptor
  twisted.internet.interfaces.IReadWriteDescriptor.html
  Class
  Interface
  PUBLIC
  An `IFileDescriptor` that can both read and write.
- twisted.internet.interfaces.IHalfCloseableDescriptor
  twisted.internet.interfaces.IHalfCloseableDescriptor.html
  Class
  Interface
  PUBLIC
  A descriptor that can be half-closed.
- twisted.internet.interfaces.IHalfCloseableDescriptor.writeConnectionLost
  twisted.internet.interfaces.IHalfCloseableDescriptor.html#writeConnectionLost
  Function
  Method
  PUBLIC
  Indicates write connection was lost.
- twisted.internet.interfaces.IHalfCloseableDescriptor.readConnectionLost
  twisted.internet.interfaces.IHalfCloseableDescriptor.html#readConnectionLost
  Function
  Method
  PUBLIC
  Indicates read connection was lost.
- twisted.internet.interfaces.ISystemHandle
  twisted.internet.interfaces.ISystemHandle.html
  Class
  Interface
  PUBLIC
  An object that wraps a networking OS-specific handle.
- twisted.internet.interfaces.ISystemHandle.getHandle
  twisted.internet.interfaces.ISystemHandle.html#getHandle
  Function
  Method
  PUBLIC
  Return a system- and reactor-specific handle.
- twisted.internet.interfaces.IConsumer
  twisted.internet.interfaces.IConsumer.html
  Class
  Interface
  PUBLIC
  A consumer consumes data from a producer.
- twisted.internet.interfaces.IConsumer.registerProducer
  twisted.internet.interfaces.IConsumer.html#registerProducer
  Function
  Method
  PUBLIC
  Register to receive data from a producer.
- twisted.internet.interfaces.IConsumer.unregisterProducer
  twisted.internet.interfaces.IConsumer.html#unregisterProducer
  Function
  Method
  PUBLIC
  Stop consuming data from a producer, without disconnecting.
- twisted.internet.interfaces.IConsumer.write
  twisted.internet.interfaces.IConsumer.html#write
  Function
  Method
  PUBLIC
  The producer will write data by calling this method.
- twisted.internet.interfaces.IProducer
  twisted.internet.interfaces.IProducer.html
  Class
  Interface
  PUBLIC
  A producer produces data for a consumer.
- twisted.internet.interfaces.IProducer.stopProducing
  twisted.internet.interfaces.IProducer.html#stopProducing
  Function
  Method
  PUBLIC
  Stop producing data.
- twisted.internet.interfaces.IPushProducer
  twisted.internet.interfaces.IPushProducer.html
  Class
  Interface
  PUBLIC
  A push producer, also known as a streaming producer is expected to produce (write to this consumer) data on a continuous basis, unless it has been paused. A paused push producer will resume producing after its ...
- twisted.internet.interfaces.IPushProducer.pauseProducing
  twisted.internet.interfaces.IPushProducer.html#pauseProducing
  Function
  Method
  PUBLIC
  Pause producing data.
- twisted.internet.interfaces.IPushProducer.resumeProducing
  twisted.internet.interfaces.IPushProducer.html#resumeProducing
  Function
  Method
  PUBLIC
  Resume producing data.
- twisted.internet.interfaces.IPullProducer
  twisted.internet.interfaces.IPullProducer.html
  Class
  Interface
  PUBLIC
  A pull producer, also known as a non-streaming producer, is expected to produce data each time `resumeProducing()` is called.
- twisted.internet.interfaces.IPullProducer.resumeProducing
  twisted.internet.interfaces.IPullProducer.html#resumeProducing
  Function
  Method
  PUBLIC
  Produce data for the consumer a single time.
- twisted.internet.interfaces.IProtocol
  twisted.internet.interfaces.IProtocol.html
  Class
  Interface
  PUBLIC
  No interface docstring; 4/4 methods documented
- twisted.internet.interfaces.IProtocol.dataReceived
  twisted.internet.interfaces.IProtocol.html#dataReceived
  Function
  Method
  PUBLIC
  Called whenever data is received.
- twisted.internet.interfaces.IProtocol.connectionLost
  twisted.internet.interfaces.IProtocol.html#connectionLost
  Function
  Method
  PUBLIC
  Called when the connection is shut down.
- twisted.internet.interfaces.IProtocol.makeConnection
  twisted.internet.interfaces.IProtocol.html#makeConnection
  Function
  Method
  PUBLIC
  Make a connection to a transport and a server.
- twisted.internet.interfaces.IProtocol.connectionMade
  twisted.internet.interfaces.IProtocol.html#connectionMade
  Function
  Method
  PUBLIC
  Called when a connection is made.
- twisted.internet.interfaces.IProcessProtocol
  twisted.internet.interfaces.IProcessProtocol.html
  Class
  Interface
  PUBLIC
  Interface for process-related event handlers.
- twisted.internet.interfaces.IProcessProtocol.makeConnection
  twisted.internet.interfaces.IProcessProtocol.html#makeConnection
  Function
  Method
  PUBLIC
  Called when the process has been created.
- twisted.internet.interfaces.IProcessProtocol.childDataReceived
  twisted.internet.interfaces.IProcessProtocol.html#childDataReceived
  Function
  Method
  PUBLIC
  Called when data arrives from the child process.
- twisted.internet.interfaces.IProcessProtocol.childConnectionLost
  twisted.internet.interfaces.IProcessProtocol.html#childConnectionLost
  Function
  Method
  PUBLIC
  Called when a file descriptor associated with the child process is closed.
- twisted.internet.interfaces.IProcessProtocol.processExited
  twisted.internet.interfaces.IProcessProtocol.html#processExited
  Function
  Method
  PUBLIC
  Called when the child process exits.
- twisted.internet.interfaces.IProcessProtocol.processEnded
  twisted.internet.interfaces.IProcessProtocol.html#processEnded
  Function
  Method
  PUBLIC
  Called when the child process exits and all file descriptors associated with it have been closed.
- twisted.internet.interfaces.IHalfCloseableProtocol
  twisted.internet.interfaces.IHalfCloseableProtocol.html
  Class
  Interface
  PUBLIC
  Implemented to indicate they want notification of half-closes.
- twisted.internet.interfaces.IHalfCloseableProtocol.readConnectionLost
  twisted.internet.interfaces.IHalfCloseableProtocol.html#readConnectionLost
  Function
  Method
  PUBLIC
  Notification of the read connection being closed.
- twisted.internet.interfaces.IHalfCloseableProtocol.writeConnectionLost
  twisted.internet.interfaces.IHalfCloseableProtocol.html#writeConnectionLost
  Function
  Method
  PUBLIC
  Notification of the write connection being closed.
- twisted.internet.interfaces.IHandshakeListener
  twisted.internet.interfaces.IHandshakeListener.html
  Class
  Interface
  PUBLIC
  An interface implemented by a `IProtocol` to indicate that it would like to be notified when TLS handshakes complete when run over a TLS-based transport.
- twisted.internet.interfaces.IHandshakeListener.handshakeCompleted
  twisted.internet.interfaces.IHandshakeListener.html#handshakeCompleted
  Function
  Method
  PUBLIC
  Notification of the TLS handshake being completed.
- twisted.internet.interfaces.IFileDescriptorReceiver
  twisted.internet.interfaces.IFileDescriptorReceiver.html
  Class
  Interface
  PUBLIC
  Protocols may implement `IFileDescriptorReceiver` to receive file descriptors sent to them. This is useful in conjunction with `IUNIXTransport`, which allows file descriptors to be sent between processes on a single host.
- twisted.internet.interfaces.IFileDescriptorReceiver.fileDescriptorReceived
  twisted.internet.interfaces.IFileDescriptorReceiver.html#fileDescriptorReceived
  Function
  Method
  PUBLIC
  Called when a file descriptor is received over the connection.
- twisted.internet.interfaces.IProtocolFactory
  twisted.internet.interfaces.IProtocolFactory.html
  Class
  Interface
  PUBLIC
  Interface for protocol factories.
- twisted.internet.interfaces.IProtocolFactory.buildProtocol
  twisted.internet.interfaces.IProtocolFactory.html#buildProtocol
  Function
  Method
  PUBLIC
  Called when a connection has been established to addr.
- twisted.internet.interfaces.IProtocolFactory.doStart
  twisted.internet.interfaces.IProtocolFactory.html#doStart
  Function
  Method
  PUBLIC
  Called every time this is connected to a Port or Connector.
- twisted.internet.interfaces.IProtocolFactory.doStop
  twisted.internet.interfaces.IProtocolFactory.html#doStop
  Function
  Method
  PUBLIC
  Called every time this is unconnected from a Port or Connector.
- twisted.internet.interfaces.ITransport
  twisted.internet.interfaces.ITransport.html
  Class
  Interface
  PUBLIC
  I am a transport for bytes.
- twisted.internet.interfaces.ITransport.write
  twisted.internet.interfaces.ITransport.html#write
  Function
  Method
  PUBLIC
  Write some data to the physical connection, in sequence, in a non-blocking fashion.
- twisted.internet.interfaces.ITransport.writeSequence
  twisted.internet.interfaces.ITransport.html#writeSequence
  Function
  Method
  PUBLIC
  Write an iterable of byte strings to the physical connection.
- twisted.internet.interfaces.ITransport.loseConnection
  twisted.internet.interfaces.ITransport.html#loseConnection
  Function
  Method
  PUBLIC
  Close my connection, after writing all pending data.
- twisted.internet.interfaces.ITransport.getPeer
  twisted.internet.interfaces.ITransport.html#getPeer
  Function
  Method
  PUBLIC
  Get the remote address of this connection.
- twisted.internet.interfaces.ITransport.getHost
  twisted.internet.interfaces.ITransport.html#getHost
  Function
  Method
  PUBLIC
  Similar to getPeer, but returns an address describing this side of the connection.
- twisted.internet.interfaces.ITCPTransport
  twisted.internet.interfaces.ITCPTransport.html
  Class
  Interface
  PUBLIC
  A TCP based transport.
- twisted.internet.interfaces.ITCPTransport.loseWriteConnection
  twisted.internet.interfaces.ITCPTransport.html#loseWriteConnection
  Function
  Method
  PUBLIC
  Half-close the write side of a TCP connection.
- twisted.internet.interfaces.ITCPTransport.abortConnection
  twisted.internet.interfaces.ITCPTransport.html#abortConnection
  Function
  Method
  PUBLIC
  Close the connection abruptly.
- twisted.internet.interfaces.ITCPTransport.getTcpNoDelay
  twisted.internet.interfaces.ITCPTransport.html#getTcpNoDelay
  Function
  Method
  PUBLIC
  Return if `TCP_NODELAY` is enabled.
- twisted.internet.interfaces.ITCPTransport.setTcpNoDelay
  twisted.internet.interfaces.ITCPTransport.html#setTcpNoDelay
  Function
  Method
  PUBLIC
  Enable/disable `TCP_NODELAY`.
- twisted.internet.interfaces.ITCPTransport.getTcpKeepAlive
  twisted.internet.interfaces.ITCPTransport.html#getTcpKeepAlive
  Function
  Method
  PUBLIC
  Return if `SO_KEEPALIVE` is enabled.
- twisted.internet.interfaces.ITCPTransport.setTcpKeepAlive
  twisted.internet.interfaces.ITCPTransport.html#setTcpKeepAlive
  Function
  Method
  PUBLIC
  Enable/disable `SO_KEEPALIVE`.
- twisted.internet.interfaces.ITCPTransport.getHost
  twisted.internet.interfaces.ITCPTransport.html#getHost
  Function
  Method
  PUBLIC
  Returns `IPv4Address` or `IPv6Address`.
- twisted.internet.interfaces.ITCPTransport.getPeer
  twisted.internet.interfaces.ITCPTransport.html#getPeer
  Function
  Method
  PUBLIC
  Returns `IPv4Address` or `IPv6Address`.
- twisted.internet.interfaces.IUNIXTransport
  twisted.internet.interfaces.IUNIXTransport.html
  Class
  Interface
  PUBLIC
  Transport for stream-oriented unix domain connections.
- twisted.internet.interfaces.IUNIXTransport.sendFileDescriptor
  twisted.internet.interfaces.IUNIXTransport.html#sendFileDescriptor
  Function
  Method
  PUBLIC
  Send a duplicate of this (file, socket, pipe, etc) descriptor to the other end of this connection.
- twisted.internet.interfaces.IOpenSSLServerConnectionCreator
  twisted.internet.interfaces.IOpenSSLServerConnectionCreator.html
  Class
  Interface
  PUBLIC
  A provider of `IOpenSSLServerConnectionCreator` can create `OpenSSL.SSL.Connection` objects for TLS servers.
- twisted.internet.interfaces.IOpenSSLServerConnectionCreator.serverConnectionForTLS
  twisted.internet.interfaces.IOpenSSLServerConnectionCreator.html#serverConnectionForTLS
  Function
  Method
  PUBLIC
  Create a connection for the given server protocol.
- twisted.internet.interfaces.IOpenSSLClientConnectionCreator
  twisted.internet.interfaces.IOpenSSLClientConnectionCreator.html
  Class
  Interface
  PUBLIC
  A provider of `IOpenSSLClientConnectionCreator` can create `OpenSSL.SSL.Connection` objects for TLS clients.
- twisted.internet.interfaces.IOpenSSLClientConnectionCreator.clientConnectionForTLS
  twisted.internet.interfaces.IOpenSSLClientConnectionCreator.html#clientConnectionForTLS
  Function
  Method
  PUBLIC
  Create a connection for the given client protocol.
- twisted.internet.interfaces.IProtocolNegotiationFactory
  twisted.internet.interfaces.IProtocolNegotiationFactory.html
  Class
  Interface
  PUBLIC
  A provider of `IProtocolNegotiationFactory` can provide information about the various protocols that the factory can create implementations of. This can be used, for example, to provide protocol names for Next Protocol Negotiation and Application Layer Protocol Negotiation.
- twisted.internet.interfaces.IProtocolNegotiationFactory.acceptableProtocols
  twisted.internet.interfaces.IProtocolNegotiationFactory.html#acceptableProtocols
  Function
  Method
  PUBLIC
  Returns a list of protocols that can be spoken by the connection factory in the form of ALPN tokens, as laid out in the IANA registry for ALPN tokens.
- twisted.internet.interfaces.IOpenSSLContextFactory
  twisted.internet.interfaces.IOpenSSLContextFactory.html
  Class
  Interface
  PUBLIC
  A provider of `IOpenSSLContextFactory` is capable of generating `OpenSSL.SSL.Context` classes suitable for configuring TLS on a connection. A provider will store enough state to be able to generate these contexts as needed for individual connections.
- twisted.internet.interfaces.IOpenSSLContextFactory.getContext
  twisted.internet.interfaces.IOpenSSLContextFactory.html#getContext
  Function
  Method
  PUBLIC
  Returns a TLS context object, suitable for securing a TLS connection. This context object will be appropriately customized for the connection based on the state in this object.
- twisted.internet.interfaces.ITLSTransport
  twisted.internet.interfaces.ITLSTransport.html
  Class
  Interface
  PUBLIC
  A TCP transport that supports switching to TLS midstream.
- twisted.internet.interfaces.ITLSTransport.startTLS
  twisted.internet.interfaces.ITLSTransport.html#startTLS
  Function
  Method
  PUBLIC
  Initiate TLS negotiation.
- twisted.internet.interfaces.ISSLTransport
  twisted.internet.interfaces.ISSLTransport.html
  Class
  Interface
  PUBLIC
  A SSL/TLS based transport.
- twisted.internet.interfaces.ISSLTransport.getPeerCertificate
  twisted.internet.interfaces.ISSLTransport.html#getPeerCertificate
  Function
  Method
  PUBLIC
  Return an object with the peer's certificate info.
- twisted.internet.interfaces.INegotiated
  twisted.internet.interfaces.INegotiated.html
  Class
  Interface
  PUBLIC
  A TLS based transport that supports using ALPN/NPN to negotiate the protocol to be used inside the encrypted tunnel.
- twisted.internet.interfaces.INegotiated.negotiatedProtocol
  twisted.internet.interfaces.INegotiated.html#negotiatedProtocol
  Attribute
  Attribute
  PUBLIC
  The protocol selected to be spoken using ALPN/NPN. The result from ALPN is preferred to the result from NPN if both were used. If the remote peer does not support ALPN or NPN, or neither NPN or ALPN are available on this machine, will be ...
- twisted.internet.interfaces.ICipher
  twisted.internet.interfaces.ICipher.html
  Class
  Interface
  PUBLIC
  A TLS cipher.
- twisted.internet.interfaces.ICipher.fullName
  twisted.internet.interfaces.ICipher.html#fullName
  Attribute
  Attribute
  PUBLIC
  The fully qualified name of the cipher in `unicode`.
- twisted.internet.interfaces.IAcceptableCiphers
  twisted.internet.interfaces.IAcceptableCiphers.html
  Class
  Interface
  PUBLIC
  A list of acceptable ciphers for a TLS context.
- twisted.internet.interfaces.IAcceptableCiphers.selectCiphers
  twisted.internet.interfaces.IAcceptableCiphers.html#selectCiphers
  Function
  Method
  PUBLIC
  Choose which ciphers to allow to be negotiated on a TLS connection.
- twisted.internet.interfaces.IProcessTransport
  twisted.internet.interfaces.IProcessTransport.html
  Class
  Interface
  PUBLIC
  A process transport.
- twisted.internet.interfaces.IProcessTransport.pid
  twisted.internet.interfaces.IProcessTransport.html#pid
  Attribute
  Attribute
  PUBLIC
  From before `IProcessProtocol.makeConnection` is called to before `IProcessProtocol.processEnded` is called, `pid` is an `int` giving the platform process ID of this process. `pid` is `None` at all other times.
- twisted.internet.interfaces.IProcessTransport.closeStdin
  twisted.internet.interfaces.IProcessTransport.html#closeStdin
  Function
  Method
  PUBLIC
  Close stdin after all data has been written out.
- twisted.internet.interfaces.IProcessTransport.closeStdout
  twisted.internet.interfaces.IProcessTransport.html#closeStdout
  Function
  Method
  PUBLIC
  Close stdout.
- twisted.internet.interfaces.IProcessTransport.closeStderr
  twisted.internet.interfaces.IProcessTransport.html#closeStderr
  Function
  Method
  PUBLIC
  Close stderr.
- twisted.internet.interfaces.IProcessTransport.closeChildFD
  twisted.internet.interfaces.IProcessTransport.html#closeChildFD
  Function
  Method
  PUBLIC
  Close a file descriptor which is connected to the child process, identified by its FD in the child process.
- twisted.internet.interfaces.IProcessTransport.writeToChild
  twisted.internet.interfaces.IProcessTransport.html#writeToChild
  Function
  Method
  PUBLIC
  Similar to `ITransport.write` but also allows the file descriptor in the child process which will receive the bytes to be specified.
- twisted.internet.interfaces.IProcessTransport.loseConnection
  twisted.internet.interfaces.IProcessTransport.html#loseConnection
  Function
  Method
  PUBLIC
  Close stdin, stderr and stdout.
- twisted.internet.interfaces.IProcessTransport.signalProcess
  twisted.internet.interfaces.IProcessTransport.html#signalProcess
  Function
  Method
  PUBLIC
  Send a signal to the process.
- twisted.internet.interfaces.IServiceCollection
  twisted.internet.interfaces.IServiceCollection.html
  Class
  Interface
  PUBLIC
  An object which provides access to a collection of services.
- twisted.internet.interfaces.IServiceCollection.getServiceNamed
  twisted.internet.interfaces.IServiceCollection.html#getServiceNamed
  Function
  Method
  PUBLIC
  Retrieve the named service from this application.
- twisted.internet.interfaces.IServiceCollection.addService
  twisted.internet.interfaces.IServiceCollection.html#addService
  Function
  Method
  PUBLIC
  Add a service to this collection.
- twisted.internet.interfaces.IServiceCollection.removeService
  twisted.internet.interfaces.IServiceCollection.html#removeService
  Function
  Method
  PUBLIC
  Remove a service from this collection.
- twisted.internet.interfaces.IUDPTransport
  twisted.internet.interfaces.IUDPTransport.html
  Class
  Interface
  PUBLIC
  Transport for UDP DatagramProtocols.
- twisted.internet.interfaces.IUDPTransport.write
  twisted.internet.interfaces.IUDPTransport.html#write
  Function
  Method
  PUBLIC
  Write packet to given address.
- twisted.internet.interfaces.IUDPTransport.connect
  twisted.internet.interfaces.IUDPTransport.html#connect
  Function
  Method
  PUBLIC
  Connect the transport to an address.
- twisted.internet.interfaces.IUDPTransport.getHost
  twisted.internet.interfaces.IUDPTransport.html#getHost
  Function
  Method
  PUBLIC
  Get this port's host address.
- twisted.internet.interfaces.IUDPTransport.stopListening
  twisted.internet.interfaces.IUDPTransport.html#stopListening
  Function
  Method
  PUBLIC
  Stop listening on this port.
- twisted.internet.interfaces.IUDPTransport.setBroadcastAllowed
  twisted.internet.interfaces.IUDPTransport.html#setBroadcastAllowed
  Function
  Method
  PUBLIC
  Set whether this port may broadcast.
- twisted.internet.interfaces.IUDPTransport.getBroadcastAllowed
  twisted.internet.interfaces.IUDPTransport.html#getBroadcastAllowed
  Function
  Method
  PUBLIC
  Checks if broadcast is currently allowed on this port.
- twisted.internet.interfaces.IUNIXDatagramTransport
  twisted.internet.interfaces.IUNIXDatagramTransport.html
  Class
  Interface
  PUBLIC
  Transport for UDP PacketProtocols.
- twisted.internet.interfaces.IUNIXDatagramTransport.write
  twisted.internet.interfaces.IUNIXDatagramTransport.html#write
  Function
  Method
  PUBLIC
  Write packet to given address.
- twisted.internet.interfaces.IUNIXDatagramTransport.getHost
  twisted.internet.interfaces.IUNIXDatagramTransport.html#getHost
  Function
  Method
  PUBLIC
  Returns `UNIXAddress`.
- twisted.internet.interfaces.IUNIXDatagramConnectedTransport
  twisted.internet.interfaces.IUNIXDatagramConnectedTransport.html
  Class
  Interface
  PUBLIC
  Transport for UDP ConnectedPacketProtocols.
- twisted.internet.interfaces.IUNIXDatagramConnectedTransport.write
  twisted.internet.interfaces.IUNIXDatagramConnectedTransport.html#write
  Function
  Method
  PUBLIC
  Write packet to address we are connected to.
- twisted.internet.interfaces.IUNIXDatagramConnectedTransport.getHost
  twisted.internet.interfaces.IUNIXDatagramConnectedTransport.html#getHost
  Function
  Method
  PUBLIC
  Returns `UNIXAddress`.
- twisted.internet.interfaces.IUNIXDatagramConnectedTransport.getPeer
  twisted.internet.interfaces.IUNIXDatagramConnectedTransport.html#getPeer
  Function
  Method
  PUBLIC
  Returns `UNIXAddress`.
- twisted.internet.interfaces.IMulticastTransport
  twisted.internet.interfaces.IMulticastTransport.html
  Class
  Interface
  PUBLIC
  Additional functionality for multicast UDP.
- twisted.internet.interfaces.IMulticastTransport.getOutgoingInterface
  twisted.internet.interfaces.IMulticastTransport.html#getOutgoingInterface
  Function
  Method
  PUBLIC
  Return interface of outgoing multicast packets.
- twisted.internet.interfaces.IMulticastTransport.setOutgoingInterface
  twisted.internet.interfaces.IMulticastTransport.html#setOutgoingInterface
  Function
  Method
  PUBLIC
  Set interface for outgoing multicast packets.
- twisted.internet.interfaces.IMulticastTransport.getLoopbackMode
  twisted.internet.interfaces.IMulticastTransport.html#getLoopbackMode
  Function
  Method
  PUBLIC
  Return if loopback mode is enabled.
- twisted.internet.interfaces.IMulticastTransport.setLoopbackMode
  twisted.internet.interfaces.IMulticastTransport.html#setLoopbackMode
  Function
  Method
  PUBLIC
  Set if loopback mode is enabled.
- twisted.internet.interfaces.IMulticastTransport.getTTL
  twisted.internet.interfaces.IMulticastTransport.html#getTTL
  Function
  Method
  PUBLIC
  Get time to live for multicast packets.
- twisted.internet.interfaces.IMulticastTransport.setTTL
  twisted.internet.interfaces.IMulticastTransport.html#setTTL
  Function
  Method
  PUBLIC
  Set time to live on multicast packets.
- twisted.internet.interfaces.IMulticastTransport.joinGroup
  twisted.internet.interfaces.IMulticastTransport.html#joinGroup
  Function
  Method
  PUBLIC
  Join a multicast group. Returns `Deferred` of success or failure.
- twisted.internet.interfaces.IMulticastTransport.leaveGroup
  twisted.internet.interfaces.IMulticastTransport.html#leaveGroup
  Function
  Method
  PUBLIC
  Leave multicast group, return `Deferred` of success.
- twisted.internet.interfaces.IStreamClientEndpoint
  twisted.internet.interfaces.IStreamClientEndpoint.html
  Class
  Interface
  PUBLIC
  A stream client endpoint is a place that `ClientFactory` can connect to. For example, a remote TCP host/port pair would be a TCP client endpoint.
- twisted.internet.interfaces.IStreamClientEndpoint.connect
  twisted.internet.interfaces.IStreamClientEndpoint.html#connect
  Function
  Method
  PUBLIC
  Connect the `protocolFactory` to the location specified by this `IStreamClientEndpoint` provider.
- twisted.internet.interfaces.IStreamServerEndpoint
  twisted.internet.interfaces.IStreamServerEndpoint.html
  Class
  Interface
  PUBLIC
  A stream server endpoint is a place that a `Factory` can listen for incoming connections.
- twisted.internet.interfaces.IStreamServerEndpoint.listen
  twisted.internet.interfaces.IStreamServerEndpoint.html#listen
  Function
  Method
  PUBLIC
  Listen with `protocolFactory` at the location specified by this `IStreamServerEndpoint` provider.
- twisted.internet.interfaces.IStreamServerEndpointStringParser
  twisted.internet.interfaces.IStreamServerEndpointStringParser.html
  Class
  Interface
  PUBLIC
  An `IStreamServerEndpointStringParser` is like an `IStreamClientEndpointStringParserWithReactor`, except for `IStreamServerEndpoint`s instead of clients. It integrates with `endpoints.serverFromString` in much the same way.
- twisted.internet.interfaces.IStreamServerEndpointStringParser.prefix
  twisted.internet.interfaces.IStreamServerEndpointStringParser.html#prefix
  Attribute
  Attribute
  PUBLIC
  A `str`, the description prefix to respond to. For example, an `IStreamServerEndpointStringParser` plugin which had `"foo"` for its `prefix` attribute would be called for endpoint descriptions like `"foo:bar:baz"`...
- twisted.internet.interfaces.IStreamServerEndpointStringParser.parseStreamServer
  twisted.internet.interfaces.IStreamServerEndpointStringParser.html#parseStreamServer
  Function
  Method
  PUBLIC
  Parse a stream server endpoint from a reactor and string-only arguments and keyword arguments.
- twisted.internet.interfaces.IStreamClientEndpointStringParserWithReactor
  twisted.internet.interfaces.IStreamClientEndpointStringParserWithReactor.html
  Class
  Interface
  PUBLIC
  An `IStreamClientEndpointStringParserWithReactor` is a parser which can convert a set of string `*args` and `**kwargs` into an `IStreamClientEndpoint` provider.
- twisted.internet.interfaces.IStreamClientEndpointStringParserWithReactor.prefix
  twisted.internet.interfaces.IStreamClientEndpointStringParserWithReactor.html#prefix
  Attribute
  Attribute
  PUBLIC
  `bytes`, the description prefix to respond to. For example, an `IStreamClientEndpointStringParserWithReactor` plugin which had `b"foo"` for its `prefix` attribute would be called for endpoint descriptions like ...
- twisted.internet.interfaces.IStreamClientEndpointStringParserWithReactor.parseStreamClient
  twisted.internet.interfaces.IStreamClientEndpointStringParserWithReactor.html#parseStreamClient
  Function
  Method
  PUBLIC
  This method is invoked by `endpoints.clientFromString`, if the type of endpoint matches the return value from this `IStreamClientEndpointStringParserWithReactor`'s `prefix` method.
- twisted.internet.interfaces._ISupportsExitSignalCapturing
  twisted.internet.interfaces._ISupportsExitSignalCapturing.html
  Class
  Interface
  PRIVATE
  An implementor of `_ISupportsExitSignalCapturing` will capture the value of any delivered exit signal (SIGINT, SIGTERM, SIGBREAK) for which it has installed a handler. The caught signal number is made available in the _exitSignal attribute.
- twisted.internet.interfaces._ISupportsExitSignalCapturing._exitSignal
  twisted.internet.interfaces._ISupportsExitSignalCapturing.html#_exitSignal
  Attribute
  Attribute
  PRIVATE
  `int` or `None`, the integer exit signal delivered to the application, or None if no signal was delivered.
- twisted.internet.utils._callProtocolWithDeferred
  twisted.internet.utils.html#_callProtocolWithDeferred
  Function
  Function
  PRIVATE
  Undocumented
- twisted.internet.utils._UnexpectedErrorOutput
  twisted.internet.utils._UnexpectedErrorOutput.html
  Class
  Exception
  PRIVATE
  Standard error data was received where it was not expected. This is a subclass of `IOError` to preserve backward compatibility with the previous error behavior of `getProcessOutput`.
- twisted.internet.utils._UnexpectedErrorOutput.processEnded
  twisted.internet.utils._UnexpectedErrorOutput.html#processEnded
  Attribute
  Instance Variable
  PUBLIC
  A `Deferred` which will fire when the process which produced the data on stderr has ended (exited and all file descriptors closed).
- twisted.internet.utils._UnexpectedErrorOutput.__init__
  twisted.internet.utils._UnexpectedErrorOutput.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.utils._BackRelay
  twisted.internet.utils._BackRelay.html
  Class
  Class
  PRIVATE
  Trivial protocol for communicating with a process and turning its output into the result of a `Deferred`.
- twisted.internet.utils._BackRelay.deferred
  twisted.internet.utils._BackRelay.html#deferred
  Attribute
  Instance Variable
  PUBLIC
  A `Deferred` which will be called back with all of stdout and, if `errortoo` is true, all of stderr as well (mixed together in one string). If `errortoo` is false and any bytes are received over stderr, this will fire with an ...
- twisted.internet.utils._BackRelay.onProcessEnded
  twisted.internet.utils._BackRelay.html#onProcessEnded
  Attribute
  Instance Variable
  PUBLIC
  If `errortoo` is false and bytes are received over stderr, this attribute will refer to a `Deferred` which will be called back when the process ends. This `Deferred` is also associated with the `_UnexpectedErrorOutput`...
- twisted.internet.utils._BackRelay.__init__
  twisted.internet.utils._BackRelay.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.utils._BackRelay.s
  twisted.internet.utils._BackRelay.html#s
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.utils._BackRelay.errReceivedIsBad
  twisted.internet.utils._BackRelay.html#errReceivedIsBad
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.utils._BackRelay.errReceivedIsGood
  twisted.internet.utils._BackRelay.html#errReceivedIsGood
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.utils._BackRelay.outReceived
  twisted.internet.utils._BackRelay.html#outReceived
  Function
  Method
  PUBLIC
  Some data was received from stdout.
- twisted.internet.utils._BackRelay.processEnded
  twisted.internet.utils._BackRelay.html#processEnded
  Function
  Method
  PUBLIC
  Called when the child process exits and all file descriptors associated with it have been closed.
- twisted.internet.utils.getProcessOutput
  twisted.internet.utils.html#getProcessOutput
  Function
  Function
  PUBLIC
  Spawn a process and return its output as a deferred returning a `bytes`.
- twisted.internet.utils._ValueGetter
  twisted.internet.utils._ValueGetter.html
  Class
  Class
  PRIVATE
  Undocumented
- twisted.internet.utils._ValueGetter.__init__
  twisted.internet.utils._ValueGetter.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.utils._ValueGetter.deferred
  twisted.internet.utils._ValueGetter.html#deferred
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.utils._ValueGetter.processEnded
  twisted.internet.utils._ValueGetter.html#processEnded
  Function
  Method
  PUBLIC
  Called when the child process exits and all file descriptors associated with it have been closed.
- twisted.internet.utils.getProcessValue
  twisted.internet.utils.html#getProcessValue
  Function
  Function
  PUBLIC
  Spawn a process and return its exit code as a Deferred.
- twisted.internet.utils._EverythingGetter
  twisted.internet.utils._EverythingGetter.html
  Class
  Class
  PRIVATE
  Undocumented
- twisted.internet.utils._EverythingGetter.__init__
  twisted.internet.utils._EverythingGetter.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.utils._EverythingGetter.deferred
  twisted.internet.utils._EverythingGetter.html#deferred
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.utils._EverythingGetter.outBuf
  twisted.internet.utils._EverythingGetter.html#outBuf
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.utils._EverythingGetter.errBuf
  twisted.internet.utils._EverythingGetter.html#errBuf
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.utils._EverythingGetter.stdinBytes
  twisted.internet.utils._EverythingGetter.html#stdinBytes
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.utils._EverythingGetter.connectionMade
  twisted.internet.utils._EverythingGetter.html#connectionMade
  Function
  Method
  PUBLIC
  Called when a connection is made.
- twisted.internet.utils._EverythingGetter.processEnded
  twisted.internet.utils._EverythingGetter.html#processEnded
  Function
  Method
  PUBLIC
  Called when the child process exits and all file descriptors associated with it have been closed.
- twisted.internet.utils.getProcessOutputAndValue
  twisted.internet.utils.html#getProcessOutputAndValue
  Function
  Function
  PUBLIC
  Spawn a process and returns a Deferred that will be called back with its output (from stdout and stderr) and it's exit code as (out, err, code) If a signal is raised, the Deferred will errback with the stdout and stderr up to that point, along with the signal, as (out, err, signalNum)...
- twisted.internet.utils._resetWarningFilters
  twisted.internet.utils.html#_resetWarningFilters
  Function
  Function
  PRIVATE
  Undocumented
- twisted.internet.utils.runWithWarningsSuppressed
  twisted.internet.utils.html#runWithWarningsSuppressed
  Function
  Function
  PUBLIC
  Run the function f, but with some warnings suppressed.
- twisted.internet.utils.suppressWarnings
  twisted.internet.utils.html#suppressWarnings
  Function
  Function
  PUBLIC
  Wrap `f` in a callable which suppresses the indicated warnings before invoking `f` and unsuppresses them afterwards. If f returns a Deferred, warnings will remain suppressed until the Deferred fires.
- twisted.trial.util.DEFAULT_TIMEOUT
  twisted.trial.util.html#DEFAULT_TIMEOUT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.trial.util.DirtyReactorAggregateError
  twisted.trial.util.DirtyReactorAggregateError.html
  Class
  Exception
  PUBLIC
  Passed to `twisted.trial.itrial.IReporter.addError` when the reactor is left in an unclean state after a test.
- twisted.trial.util.DirtyReactorAggregateError.delayedCalls
  twisted.trial.util.DirtyReactorAggregateError.html#delayedCalls
  Attribute
  Instance Variable
  PUBLIC
  The `DelayedCall` objects which weren't cleaned up.
- twisted.trial.util.DirtyReactorAggregateError.selectables
  twisted.trial.util.DirtyReactorAggregateError.html#selectables
  Attribute
  Instance Variable
  PUBLIC
  The selectables which weren't cleaned up.
- twisted.trial.util.DirtyReactorAggregateError.__init__
  twisted.trial.util.DirtyReactorAggregateError.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.trial.util.DirtyReactorAggregateError.__str__
  twisted.trial.util.DirtyReactorAggregateError.html#__str__
  Function
  Method
  PUBLIC
  Return a multi-line message describing all of the unclean state.
- twisted.trial.util._Janitor
  twisted.trial.util._Janitor.html
  Class
  Class
  PRIVATE
  The guy that cleans up after you.
- twisted.trial.util._Janitor.test
  twisted.trial.util._Janitor.html#test
  Attribute
  Instance Variable
  PUBLIC
  The `TestCase` to report errors about.
- twisted.trial.util._Janitor.result
  twisted.trial.util._Janitor.html#result
  Attribute
  Instance Variable
  PUBLIC
  The `IReporter` to report errors to.
- twisted.trial.util._Janitor.reactor
  twisted.trial.util._Janitor.html#reactor
  Attribute
  Instance Variable
  PUBLIC
  The reactor to use. If None, the global reactor will be used.
- twisted.trial.util._Janitor.__init__
  twisted.trial.util._Janitor.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.trial.util._Janitor.postCaseCleanup
  twisted.trial.util._Janitor.html#postCaseCleanup
  Function
  Method
  PUBLIC
  Called by `unittest.TestCase` after a test to catch any logged errors or pending `DelayedCall`s.
- twisted.trial.util._Janitor.postClassCleanup
  twisted.trial.util._Janitor.html#postClassCleanup
  Function
  Method
  PUBLIC
  Called by `unittest.TestCase` after the last test in a `TestCase` subclass. Ensures the reactor is clean by murdering the threadpool, catching any pending `DelayedCall`s, open sockets etc.
- twisted.trial.util._Janitor._getReactor
  twisted.trial.util._Janitor.html#_getReactor
  Function
  Method
  PRIVATE
  Get either the passed-in reactor or the global reactor.
- twisted.trial.util._Janitor._cleanPending
  twisted.trial.util._Janitor.html#_cleanPending
  Function
  Method
  PRIVATE
  Cancel all pending calls and return their string representations.
- twisted.trial.util._Janitor._cleanThreads
  twisted.trial.util._Janitor.html#_cleanThreads
  Function
  Method
  PRIVATE
  Undocumented
- twisted.trial.util._Janitor._cleanReactor
  twisted.trial.util._Janitor.html#_cleanReactor
  Function
  Method
  PRIVATE
  Remove all selectables from the reactor, kill any of them that were processes, and return their string representation.
- twisted.trial.util._DEFAULT
  twisted.trial.util.html#_DEFAULT
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.trial.util.acquireAttribute
  twisted.trial.util.html#acquireAttribute
  Function
  Function
  PUBLIC
  Go through the list 'objects' sequentially until we find one which has attribute 'attr', then return the value of that attribute. If not found, return 'default' if set, otherwise, raise AttributeError.
- twisted.trial.util.excInfoOrFailureToExcInfo
  twisted.trial.util.html#excInfoOrFailureToExcInfo
  Function
  Function
  PUBLIC
  Coerce a Failure to an _exc_info, if err is a Failure.
- twisted.trial.util.suppress
  twisted.trial.util.html#suppress
  Function
  Function
  PUBLIC
  Sets up the .suppress tuple properly, pass options to this method as you would the stdlib warnings.filterwarnings()
- twisted.trial.util.profiled
  twisted.trial.util.html#profiled
  Function
  Function
  PUBLIC
  Undocumented
- twisted.trial.util._NoTrialMarker
  twisted.trial.util._NoTrialMarker.html
  Class
  Exception
  PRIVATE
  No trial marker file could be found.
- twisted.trial.util._removeSafely
  twisted.trial.util.html#_removeSafely
  Function
  Function
  PRIVATE
  Safely remove a path, recursively.
- twisted.trial.util._WorkingDirectoryBusy
  twisted.trial.util._WorkingDirectoryBusy.html
  Class
  Exception
  PRIVATE
  A working directory was specified to the runner, but another test run is currently using that directory.
- twisted.trial.util._unusedTestDirectory
  twisted.trial.util.html#_unusedTestDirectory
  Function
  Function
  PRIVATE
  Find an unused directory named similarly to `base`.
- twisted.trial.util._listToPhrase
  twisted.trial.util.html#_listToPhrase
  Function
  Function
  PRIVATE
  Produce a string containing each thing in `things`, separated by a `delimiter`, with the last couple being separated by `finalDelimiter`
- twisted.trial.util.openTestLog
  twisted.trial.util.html#openTestLog
  Function
  Function
  PUBLIC
  Open the given path such that test log messages can be written to it.
- twisted.trial.reporter._makeTodo
  twisted.trial.reporter.html#_makeTodo
  Function
  Function
  PRIVATE
  Return a `Todo` object built from `value`.
- twisted.trial.reporter.BrokenTestCaseWarning
  twisted.trial.reporter.BrokenTestCaseWarning.html
  Class
  Exception
  PUBLIC
  Emitted as a warning when an exception occurs in one of setUp or tearDown.
- twisted.trial.reporter.SafeStream
  twisted.trial.reporter.SafeStream.html
  Class
  Class
  PUBLIC
  Wraps a stream object so that all `write` calls are wrapped in `untilConcludes`.
- twisted.trial.reporter.SafeStream.__init__
  twisted.trial.reporter.SafeStream.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.trial.reporter.SafeStream.original
  twisted.trial.reporter.SafeStream.html#original
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.trial.reporter.SafeStream.__getattr__
  twisted.trial.reporter.SafeStream.html#__getattr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.trial.reporter.SafeStream.write
  twisted.trial.reporter.SafeStream.html#write
  Function
  Method
  PUBLIC
  Undocumented
- twisted.trial.reporter.TestResult
  twisted.trial.reporter.TestResult.html
  Class
  Class
  PUBLIC
  Accumulates the results of several `twisted.trial.unittest.TestCase`s.
- twisted.trial.reporter.TestResult.successes
  twisted.trial.reporter.TestResult.html#successes
  Attribute
  Instance Variable
  PUBLIC
  count the number of successes achieved by the test run.
- twisted.trial.reporter.TestResult._DEFAULT_TODO
  twisted.trial.reporter.TestResult.html#_DEFAULT_TODO
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.trial.reporter.TestResult.__init__
  twisted.trial.reporter.TestResult.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.trial.reporter.TestResult.skips
  twisted.trial.reporter.TestResult.html#skips
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.trial.reporter.TestResult.expectedFailures
  twisted.trial.reporter.TestResult.html#expectedFailures
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.trial.reporter.TestResult.unexpectedSuccesses
  twisted.trial.reporter.TestResult.html#unexpectedSuccesses
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.trial.reporter.TestResult._timings
  twisted.trial.reporter.TestResult.html#_timings
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.trial.reporter.TestResult.__repr__
  twisted.trial.reporter.TestResult.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.trial.reporter.TestResult._getTime
  twisted.trial.reporter.TestResult.html#_getTime
  Function
  Method
  PRIVATE
  Undocumented
- twisted.trial.reporter.TestResult._getFailure
  twisted.trial.reporter.TestResult.html#_getFailure
  Function
  Method
  PRIVATE
  Convert a `sys.exc_info()`-style tuple to a `Failure`, if necessary.
- twisted.trial.reporter.TestResult.startTest
  twisted.trial.reporter.TestResult.html#startTest
  Function
  Method
  PUBLIC
  This must be called before the given test is commenced.
- twisted.trial.reporter.TestResult._testStarted
  twisted.trial.reporter.TestResult.html#_testStarted
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.trial.reporter.TestResult.stopTest
  twisted.trial.reporter.TestResult.html#stopTest
  Function
  Method
  PUBLIC
  This must be called after the given test is completed.
- twisted.trial.reporter.TestResult._lastTime
  twisted.trial.reporter.TestResult.html#_lastTime
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.trial.reporter.TestResult.addFailure
  twisted.trial.reporter.TestResult.html#addFailure
  Function
  Method
  PUBLIC
  Report a failed assertion for the given test.
- twisted.trial.reporter.TestResult.addError
  twisted.trial.reporter.TestResult.html#addError
  Function
  Method
  PUBLIC
  Report an error that occurred while running the given test.
- twisted.trial.reporter.TestResult.addSkip
  twisted.trial.reporter.TestResult.html#addSkip
  Function
  Method
  PUBLIC
  Report that the given test was skipped.
- twisted.trial.reporter.TestResult.addUnexpectedSuccess
  twisted.trial.reporter.TestResult.html#addUnexpectedSuccess
  Function
  Method
  PUBLIC
  Report that the given test succeeded against expectations.
- twisted.trial.reporter.TestResult.addExpectedFailure
  twisted.trial.reporter.TestResult.html#addExpectedFailure
  Function
  Method
  PUBLIC
  Report that the given test failed, and was expected to do so.
- twisted.trial.reporter.TestResult.addSuccess
  twisted.trial.reporter.TestResult.html#addSuccess
  Function
  Method
  PUBLIC
  Report that the given test succeeded.
- twisted.trial.reporter.TestResult.wasSuccessful
  twisted.trial.reporter.TestResult.html#wasSuccessful
  Function
  Method
  PUBLIC
  Report whether or not this test suite was successful or not.
- twisted.trial.reporter.TestResult.done
  twisted.trial.reporter.TestResult.html#done
  Function
  Method
  PUBLIC
  The test suite has finished running.
- twisted.trial.reporter.TestResultDecorator
  twisted.trial.reporter.TestResultDecorator.html
  Class
  Class
  PUBLIC
  Base class for TestResult decorators.
- twisted.trial.reporter.TestResultDecorator._originalReporter
  twisted.trial.reporter.TestResultDecorator.html#_originalReporter
  Attribute
  Instance Variable
  PRIVATE
  The wrapped instance of reporter.
- twisted.trial.reporter.UncleanWarningsReporterWrapper
  twisted.trial.reporter.UncleanWarningsReporterWrapper.html
  Class
  Class
  PUBLIC
  A wrapper for a reporter that converts `util.DirtyReactorAggregateError`s to warnings.
- twisted.trial.reporter.UncleanWarningsReporterWrapper.addError
  twisted.trial.reporter.UncleanWarningsReporterWrapper.html#addError
  Function
  Method
  PUBLIC
  If the error is a `util.DirtyReactorAggregateError`, instead of reporting it as a normal error, throw a warning.
- twisted.trial.reporter._ExitWrapper
  twisted.trial.reporter._ExitWrapper.html
  Class
  Class
  PRIVATE
  A wrapper for a reporter that causes the reporter to stop after unsuccessful tests.
- twisted.trial.reporter._ExitWrapper.addError
  twisted.trial.reporter._ExitWrapper.html#addError
  Function
  Method
  PUBLIC
  Record that a test has raised an unexpected exception.
- twisted.trial.reporter._ExitWrapper.shouldStop
  twisted.trial.reporter._ExitWrapper.html#shouldStop
  Attribute
  Instance Variable
  PUBLIC
  A boolean indicating that this reporter would like the test run to stop.
- twisted.trial.reporter._ExitWrapper.addFailure
  twisted.trial.reporter._ExitWrapper.html#addFailure
  Function
  Method
  PUBLIC
  Record that a test has failed with the given failure.
- twisted.trial.reporter._AdaptedReporter
  twisted.trial.reporter._AdaptedReporter.html
  Class
  Class
  PRIVATE
  TestResult decorator that makes sure that addError only gets tests that have been adapted with a particular test adapter.
- twisted.trial.reporter._AdaptedReporter.__init__
  twisted.trial.reporter._AdaptedReporter.html#__init__
  Function
  Method
  PUBLIC
  Construct an `_AdaptedReporter`.
- twisted.trial.reporter._AdaptedReporter.testAdapter
  twisted.trial.reporter._AdaptedReporter.html#testAdapter
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.trial.reporter._AdaptedReporter.addError
  twisted.trial.reporter._AdaptedReporter.html#addError
  Function
  Method
  PUBLIC
  See `itrial.IReporter`.
- twisted.trial.reporter._AdaptedReporter.addExpectedFailure
  twisted.trial.reporter._AdaptedReporter.html#addExpectedFailure
  Function
  Method
  PUBLIC
  See `itrial.IReporter`.
- twisted.trial.reporter._AdaptedReporter.addFailure
  twisted.trial.reporter._AdaptedReporter.html#addFailure
  Function
  Method
  PUBLIC
  See `itrial.IReporter`.
- twisted.trial.reporter._AdaptedReporter.addSkip
  twisted.trial.reporter._AdaptedReporter.html#addSkip
  Function
  Method
  PUBLIC
  See `itrial.IReporter`.
- twisted.trial.reporter._AdaptedReporter.addUnexpectedSuccess
  twisted.trial.reporter._AdaptedReporter.html#addUnexpectedSuccess
  Function
  Method
  PUBLIC
  See `itrial.IReporter`.
- twisted.trial.reporter._AdaptedReporter.startTest
  twisted.trial.reporter._AdaptedReporter.html#startTest
  Function
  Method
  PUBLIC
  See `itrial.IReporter`.
- twisted.trial.reporter._AdaptedReporter.stopTest
  twisted.trial.reporter._AdaptedReporter.html#stopTest
  Function
  Method
  PUBLIC
  See `itrial.IReporter`.
- twisted.trial.reporter.Reporter
  twisted.trial.reporter.Reporter.html
  Class
  Class
  PUBLIC
  A basic `TestResult` with support for writing to a stream.
- twisted.trial.reporter.Reporter._startTime
  twisted.trial.reporter.Reporter.html#_startTime
  Attribute
  Instance Variable
  PRIVATE
  The time when the first test was started. It defaults to `None`, which means that no test was actually launched.
- twisted.trial.reporter.Reporter._warningCache
  twisted.trial.reporter.Reporter.html#_warningCache
  Attribute
  Instance Variable
  PRIVATE
  A `set` of tuples of warning message (file, line, text, category) which have already been written to the output stream during the currently executing test. This is used to avoid writing duplicates of the same warning to the output stream.
- twisted.trial.reporter.Reporter._publisher
  twisted.trial.reporter.Reporter.html#_publisher
  Attribute
  Instance Variable
  PRIVATE
  The log publisher which will be observed for warning events.
- twisted.trial.reporter.Reporter._separator
  twisted.trial.reporter.Reporter.html#_separator
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.trial.reporter.Reporter._doubleSeparator
  twisted.trial.reporter.Reporter.html#_doubleSeparator
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.trial.reporter.Reporter.__init__
  twisted.trial.reporter.Reporter.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.trial.reporter.Reporter._stream
  twisted.trial.reporter.Reporter.html#_stream
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.trial.reporter.Reporter.tbformat
  twisted.trial.reporter.Reporter.html#tbformat
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.trial.reporter.Reporter.realtime
  twisted.trial.reporter.Reporter.html#realtime
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.trial.reporter.Reporter._observeWarnings
  twisted.trial.reporter.Reporter.html#_observeWarnings
  Function
  Method
  PRIVATE
  Observe warning events and write them to `self._stream`.
- twisted.trial.reporter.Reporter.startTest
  twisted.trial.reporter.Reporter.html#startTest
  Function
  Method
  PUBLIC
  Called when a test begins to run. Records the time when it was first called and resets the warning cache.
- twisted.trial.reporter.Reporter.addFailure
  twisted.trial.reporter.Reporter.html#addFailure
  Function
  Method
  PUBLIC
  Called when a test fails. If `realtime` is set, then it prints the error to the stream.
- twisted.trial.reporter.Reporter.addError
  twisted.trial.reporter.Reporter.html#addError
  Function
  Method
  PUBLIC
  Called when a test raises an error. If `realtime` is set, then it prints the error to the stream.
- twisted.trial.reporter.Reporter._write
  twisted.trial.reporter.Reporter.html#_write
  Function
  Method
  PRIVATE
  Safely write to the reporter's stream.
- twisted.trial.reporter.Reporter._writeln
  twisted.trial.reporter.Reporter.html#_writeln
  Function
  Method
  PRIVATE
  Safely write a line to the reporter's stream. Newline is appended to the format string.
- twisted.trial.reporter.Reporter.upDownError
  twisted.trial.reporter.Reporter.html#upDownError
  Function
  Method
  PUBLIC
  Undocumented
- twisted.trial.reporter.Reporter.cleanupErrors
  twisted.trial.reporter.Reporter.html#cleanupErrors
  Function
  Method
  PUBLIC
  Undocumented
- twisted.trial.reporter.Reporter._trimFrames
  twisted.trial.reporter.Reporter.html#_trimFrames
  Function
  Method
  PRIVATE
  Trim frames to remove internal paths.
- twisted.trial.reporter.Reporter._formatFailureTraceback
  twisted.trial.reporter.Reporter.html#_formatFailureTraceback
  Function
  Method
  PRIVATE
  Undocumented
- twisted.trial.reporter.Reporter._groupResults
  twisted.trial.reporter.Reporter.html#_groupResults
  Function
  Method
  PRIVATE
  Group tests together based on their results.
- twisted.trial.reporter.Reporter._printResults
  twisted.trial.reporter.Reporter.html#_printResults
  Function
  Method
  PRIVATE
  Print a group of errors to the stream.
- twisted.trial.reporter.Reporter._printExpectedFailure
  twisted.trial.reporter.Reporter.html#_printExpectedFailure
  Function
  Method
  PRIVATE
  Undocumented
- twisted.trial.reporter.Reporter._printUnexpectedSuccess
  twisted.trial.reporter.Reporter.html#_printUnexpectedSuccess
  Function
  Method
  PRIVATE
  Undocumented
- twisted.trial.reporter.Reporter._printErrors
  twisted.trial.reporter.Reporter.html#_printErrors
  Function
  Method
  PRIVATE
  Print all of the non-success results to the stream in full.
- twisted.trial.reporter.Reporter._getSummary
  twisted.trial.reporter.Reporter.html#_getSummary
  Function
  Method
  PRIVATE
  Return a formatted count of tests status results.
- twisted.trial.reporter.Reporter._printSummary
  twisted.trial.reporter.Reporter.html#_printSummary
  Function
  Method
  PRIVATE
  Print a line summarising the test results to the stream.
- twisted.trial.reporter.Reporter.done
  twisted.trial.reporter.Reporter.html#done
  Function
  Method
  PUBLIC
  Summarize the result of the test run.
- twisted.trial.reporter.MinimalReporter
  twisted.trial.reporter.MinimalReporter.html
  Class
  Class
  PUBLIC
  A minimalist reporter that prints only a summary of the test result, in the form of (timeTaken, #tests, #tests, #errors, #failures, #skips).
- twisted.trial.reporter.MinimalReporter._printErrors
  twisted.trial.reporter.MinimalReporter.html#_printErrors
  Function
  Method
  PRIVATE
  Don't print a detailed summary of errors. We only care about the counts.
- twisted.trial.reporter.MinimalReporter._printSummary
  twisted.trial.reporter.MinimalReporter.html#_printSummary
  Function
  Method
  PRIVATE
  Print out a one-line summary of the form: '%(runtime) %(number_of_tests) %(number_of_tests) %(num_errors) %(num_failures) %(num_skips)'
- twisted.trial.reporter.TextReporter
  twisted.trial.reporter.TextReporter.html
  Class
  Class
  PUBLIC
  Simple reporter that prints a single character for each test as it runs, along with the standard Trial summary text.
- twisted.trial.reporter.TextReporter.addSuccess
  twisted.trial.reporter.TextReporter.html#addSuccess
  Function
  Method
  PUBLIC
  Report that the given test succeeded.
- twisted.trial.reporter.TextReporter.addError
  twisted.trial.reporter.TextReporter.html#addError
  Function
  Method
  PUBLIC
  Called when a test raises an error. If `realtime` is set, then it prints the error to the stream.
- twisted.trial.reporter.TextReporter.addFailure
  twisted.trial.reporter.TextReporter.html#addFailure
  Function
  Method
  PUBLIC
  Called when a test fails. If `realtime` is set, then it prints the error to the stream.
- twisted.trial.reporter.TextReporter.addSkip
  twisted.trial.reporter.TextReporter.html#addSkip
  Function
  Method
  PUBLIC
  Report that the given test was skipped.
- twisted.trial.reporter.TextReporter.addExpectedFailure
  twisted.trial.reporter.TextReporter.html#addExpectedFailure
  Function
  Method
  PUBLIC
  Report that the given test failed, and was expected to do so.
- twisted.trial.reporter.TextReporter.addUnexpectedSuccess
  twisted.trial.reporter.TextReporter.html#addUnexpectedSuccess
  Function
  Method
  PUBLIC
  Report that the given test succeeded against expectations.
- twisted.trial.reporter.VerboseTextReporter
  twisted.trial.reporter.VerboseTextReporter.html
  Class
  Class
  PUBLIC
  A verbose reporter that prints the name of each test as it is running.
- twisted.trial.reporter.VerboseTextReporter.startTest
  twisted.trial.reporter.VerboseTextReporter.html#startTest
  Function
  Method
  PUBLIC
  Called when a test begins to run. Records the time when it was first called and resets the warning cache.
- twisted.trial.reporter.VerboseTextReporter.addSuccess
  twisted.trial.reporter.VerboseTextReporter.html#addSuccess
  Function
  Method
  PUBLIC
  Report that the given test succeeded.
- twisted.trial.reporter.VerboseTextReporter.addError
  twisted.trial.reporter.VerboseTextReporter.html#addError
  Function
  Method
  PUBLIC
  Called when a test raises an error. If `realtime` is set, then it prints the error to the stream.
- twisted.trial.reporter.VerboseTextReporter.addFailure
  twisted.trial.reporter.VerboseTextReporter.html#addFailure
  Function
  Method
  PUBLIC
  Called when a test fails. If `realtime` is set, then it prints the error to the stream.
- twisted.trial.reporter.VerboseTextReporter.addSkip
  twisted.trial.reporter.VerboseTextReporter.html#addSkip
  Function
  Method
  PUBLIC
  Report that the given test was skipped.
- twisted.trial.reporter.VerboseTextReporter.addExpectedFailure
  twisted.trial.reporter.VerboseTextReporter.html#addExpectedFailure
  Function
  Method
  PUBLIC
  Report that the given test failed, and was expected to do so.
- twisted.trial.reporter.VerboseTextReporter.addUnexpectedSuccess
  twisted.trial.reporter.VerboseTextReporter.html#addUnexpectedSuccess
  Function
  Method
  PUBLIC
  Report that the given test succeeded against expectations.
- twisted.trial.reporter.VerboseTextReporter.stopTest
  twisted.trial.reporter.VerboseTextReporter.html#stopTest
  Function
  Method
  PUBLIC
  This must be called after the given test is completed.
- twisted.trial.reporter.TimingTextReporter
  twisted.trial.reporter.TimingTextReporter.html
  Class
  Class
  PUBLIC
  Prints out each test as it is running, followed by the time taken for each test to run.
- twisted.trial.reporter.TimingTextReporter.stopTest
  twisted.trial.reporter.TimingTextReporter.html#stopTest
  Function
  Method
  PUBLIC
  Mark the test as stopped, and write the time it took to run the test to the stream.
- twisted.trial.reporter._AnsiColorizer
  twisted.trial.reporter._AnsiColorizer.html
  Class
  Class
  PRIVATE
  A colorizer is an object that loosely wraps around a stream, allowing callers to write text to the stream in a particular color.
- twisted.trial.reporter._AnsiColorizer._colors
  twisted.trial.reporter._AnsiColorizer.html#_colors
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.trial.reporter._AnsiColorizer.__init__
  twisted.trial.reporter._AnsiColorizer.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.trial.reporter._AnsiColorizer.stream
  twisted.trial.reporter._AnsiColorizer.html#stream
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.trial.reporter._AnsiColorizer.supported
  twisted.trial.reporter._AnsiColorizer.html#supported
  Function
  Class Method
  PUBLIC
  A class method that returns True if the current platform supports coloring terminal output using this method. Returns False otherwise.
- twisted.trial.reporter._AnsiColorizer.write
  twisted.trial.reporter._AnsiColorizer.html#write
  Function
  Method
  PUBLIC
  Write the given text to the stream in the given color.
- twisted.trial.reporter._Win32Colorizer
  twisted.trial.reporter._Win32Colorizer.html
  Class
  Class
  PRIVATE
  See _AnsiColorizer docstring.
- twisted.trial.reporter._Win32Colorizer.__init__
  twisted.trial.reporter._Win32Colorizer.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.trial.reporter._Win32Colorizer.stream
  twisted.trial.reporter._Win32Colorizer.html#stream
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.trial.reporter._Win32Colorizer.screenBuffer
  twisted.trial.reporter._Win32Colorizer.html#screenBuffer
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.trial.reporter._Win32Colorizer._colors
  twisted.trial.reporter._Win32Colorizer.html#_colors
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.trial.reporter._Win32Colorizer.supported
  twisted.trial.reporter._Win32Colorizer.html#supported
  Function
  Class Method
  PUBLIC
  Undocumented
- twisted.trial.reporter._Win32Colorizer.write
  twisted.trial.reporter._Win32Colorizer.html#write
  Function
  Method
  PUBLIC
  Undocumented
- twisted.trial.reporter._NullColorizer
  twisted.trial.reporter._NullColorizer.html
  Class
  Class
  PRIVATE
  See _AnsiColorizer docstring.
- twisted.trial.reporter._NullColorizer.__init__
  twisted.trial.reporter._NullColorizer.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.trial.reporter._NullColorizer.stream
  twisted.trial.reporter._NullColorizer.html#stream
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.trial.reporter._NullColorizer.supported
  twisted.trial.reporter._NullColorizer.html#supported
  Function
  Class Method
  PUBLIC
  Undocumented
- twisted.trial.reporter._NullColorizer.write
  twisted.trial.reporter._NullColorizer.html#write
  Function
  Method
  PUBLIC
  Undocumented
- twisted.trial.reporter.SubunitReporter
  twisted.trial.reporter.SubunitReporter.html
  Class
  Class
  PUBLIC
  Reports test output via Subunit.
- twisted.trial.reporter.SubunitReporter._subunit
  twisted.trial.reporter.SubunitReporter.html#_subunit
  Attribute
  Instance Variable
  PRIVATE
  The subunit protocol client that we are wrapping.
- twisted.trial.reporter.SubunitReporter._successful
  twisted.trial.reporter.SubunitReporter.html#_successful
  Attribute
  Instance Variable
  PRIVATE
  An internal variable, used to track whether we have received only successful results.
- twisted.trial.reporter.SubunitReporter.testsRun
  twisted.trial.reporter.SubunitReporter.html#testsRun
  Attribute
  Class Variable
  PUBLIC
  The number of tests that seem to have been run according to this reporter.
- twisted.trial.reporter.SubunitReporter.__init__
  twisted.trial.reporter.SubunitReporter.html#__init__
  Function
  Method
  PUBLIC
  Construct a `SubunitReporter`.
- twisted.trial.reporter.SubunitReporter.done
  twisted.trial.reporter.SubunitReporter.html#done
  Function
  Method
  PUBLIC
  Record that the entire test suite run is finished.
- twisted.trial.reporter.SubunitReporter.shouldStop
  twisted.trial.reporter.SubunitReporter.html#shouldStop
  Attribute
  Property
  PUBLIC
  Whether or not the test runner should stop running tests.
- twisted.trial.reporter.SubunitReporter.stop
  twisted.trial.reporter.SubunitReporter.html#stop
  Function
  Method
  PUBLIC
  Signal that the test runner should stop running tests.
- twisted.trial.reporter.SubunitReporter.wasSuccessful
  twisted.trial.reporter.SubunitReporter.html#wasSuccessful
  Function
  Method
  PUBLIC
  Has the test run been successful so far?
- twisted.trial.reporter.SubunitReporter.startTest
  twisted.trial.reporter.SubunitReporter.html#startTest
  Function
  Method
  PUBLIC
  Record that `test` has started.
- twisted.trial.reporter.SubunitReporter.stopTest
  twisted.trial.reporter.SubunitReporter.html#stopTest
  Function
  Method
  PUBLIC
  Record that `test` has completed.
- twisted.trial.reporter.SubunitReporter.addSuccess
  twisted.trial.reporter.SubunitReporter.html#addSuccess
  Function
  Method
  PUBLIC
  Record that `test` was successful.
- twisted.trial.reporter.SubunitReporter.addSkip
  twisted.trial.reporter.SubunitReporter.html#addSkip
  Function
  Method
  PUBLIC
  Record that `test` was skipped for `reason`.
- twisted.trial.reporter.SubunitReporter.addError
  twisted.trial.reporter.SubunitReporter.html#addError
  Function
  Method
  PUBLIC
  Record that `test` failed with an unexpected error `err`.
- twisted.trial.reporter.SubunitReporter.addFailure
  twisted.trial.reporter.SubunitReporter.html#addFailure
  Function
  Method
  PUBLIC
  Record that `test` failed an assertion with the error `err`.
- twisted.trial.reporter.SubunitReporter.addExpectedFailure
  twisted.trial.reporter.SubunitReporter.html#addExpectedFailure
  Function
  Method
  PUBLIC
  Record an expected failure from a test.
- twisted.trial.reporter.SubunitReporter.addUnexpectedSuccess
  twisted.trial.reporter.SubunitReporter.html#addUnexpectedSuccess
  Function
  Method
  PUBLIC
  Record an unexpected success.
- twisted.trial.reporter.TreeReporter
  twisted.trial.reporter.TreeReporter.html
  Class
  Class
  PUBLIC
  Print out the tests in the form a tree.
- twisted.trial.reporter.TreeReporter.currentLine
  twisted.trial.reporter.TreeReporter.html#currentLine
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.trial.reporter.TreeReporter.indent
  twisted.trial.reporter.TreeReporter.html#indent
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.trial.reporter.TreeReporter.columns
  twisted.trial.reporter.TreeReporter.html#columns
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.trial.reporter.TreeReporter.FAILURE
  twisted.trial.reporter.TreeReporter.html#FAILURE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.trial.reporter.TreeReporter.ERROR
  twisted.trial.reporter.TreeReporter.html#ERROR
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.trial.reporter.TreeReporter.TODO
  twisted.trial.reporter.TreeReporter.html#TODO
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.trial.reporter.TreeReporter.SKIP
  twisted.trial.reporter.TreeReporter.html#SKIP
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.trial.reporter.TreeReporter.TODONE
  twisted.trial.reporter.TreeReporter.html#TODONE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.trial.reporter.TreeReporter.SUCCESS
  twisted.trial.reporter.TreeReporter.html#SUCCESS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.trial.reporter.TreeReporter.__init__
  twisted.trial.reporter.TreeReporter.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.trial.reporter.TreeReporter._lastTest
  twisted.trial.reporter.TreeReporter.html#_lastTest
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.trial.reporter.TreeReporter._colorizer
  twisted.trial.reporter.TreeReporter.html#_colorizer
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.trial.reporter.TreeReporter.getDescription
  twisted.trial.reporter.TreeReporter.html#getDescription
  Function
  Method
  PUBLIC
  Return the name of the method which 'test' represents. This is what gets displayed in the leaves of the tree.
- twisted.trial.reporter.TreeReporter.addSuccess
  twisted.trial.reporter.TreeReporter.html#addSuccess
  Function
  Method
  PUBLIC
  Report that the given test succeeded.
- twisted.trial.reporter.TreeReporter.addError
  twisted.trial.reporter.TreeReporter.html#addError
  Function
  Method
  PUBLIC
  Called when a test raises an error. If `realtime` is set, then it prints the error to the stream.
- twisted.trial.reporter.TreeReporter.addFailure
  twisted.trial.reporter.TreeReporter.html#addFailure
  Function
  Method
  PUBLIC
  Called when a test fails. If `realtime` is set, then it prints the error to the stream.
- twisted.trial.reporter.TreeReporter.addSkip
  twisted.trial.reporter.TreeReporter.html#addSkip
  Function
  Method
  PUBLIC
  Report that the given test was skipped.
- twisted.trial.reporter.TreeReporter.addExpectedFailure
  twisted.trial.reporter.TreeReporter.html#addExpectedFailure
  Function
  Method
  PUBLIC
  Report that the given test failed, and was expected to do so.
- twisted.trial.reporter.TreeReporter.addUnexpectedSuccess
  twisted.trial.reporter.TreeReporter.html#addUnexpectedSuccess
  Function
  Method
  PUBLIC
  Report that the given test succeeded against expectations.
- twisted.trial.reporter.TreeReporter._write
  twisted.trial.reporter.TreeReporter.html#_write
  Function
  Method
  PRIVATE
  Safely write to the reporter's stream.
- twisted.trial.reporter.TreeReporter._getPreludeSegments
  twisted.trial.reporter.TreeReporter.html#_getPreludeSegments
  Function
  Method
  PRIVATE
  Return a list of all non-leaf segments to display in the tree.
- twisted.trial.reporter.TreeReporter._testPrelude
  twisted.trial.reporter.TreeReporter.html#_testPrelude
  Function
  Method
  PRIVATE
  Write the name of the test to the stream, indenting it appropriately.
- twisted.trial.reporter.TreeReporter.cleanupErrors
  twisted.trial.reporter.TreeReporter.html#cleanupErrors
  Function
  Method
  PUBLIC
  Undocumented
- twisted.trial.reporter.TreeReporter.upDownError
  twisted.trial.reporter.TreeReporter.html#upDownError
  Function
  Method
  PUBLIC
  Undocumented
- twisted.trial.reporter.TreeReporter.startTest
  twisted.trial.reporter.TreeReporter.html#startTest
  Function
  Method
  PUBLIC
  Called when `test` starts. Writes the tests name to the stream using a tree format.
- twisted.trial.reporter.TreeReporter.endLine
  twisted.trial.reporter.TreeReporter.html#endLine
  Function
  Method
  PUBLIC
  Print 'message' in the given color.
- twisted.trial.reporter.TreeReporter._printSummary
  twisted.trial.reporter.TreeReporter.html#_printSummary
  Function
  Method
  PRIVATE
  Print a line summarising the test results to the stream, and color the status result.
- twisted.python.monkey.MonkeyPatcher
  twisted.python.monkey.MonkeyPatcher.html
  Class
  Class
  PUBLIC
  Cover up attributes with new objects. Neat for monkey-patching things for unit-testing purposes.
- twisted.python.monkey.MonkeyPatcher.__init__
  twisted.python.monkey.MonkeyPatcher.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.monkey.MonkeyPatcher._patchesToApply
  twisted.python.monkey.MonkeyPatcher.html#_patchesToApply
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.python.monkey.MonkeyPatcher._originals
  twisted.python.monkey.MonkeyPatcher.html#_originals
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.python.monkey.MonkeyPatcher.addPatch
  twisted.python.monkey.MonkeyPatcher.html#addPatch
  Function
  Method
  PUBLIC
  Add a patch so that the attribute `name` on `obj` will be assigned to `value` when `patch` is called or during `runWithPatches`.
- twisted.python.monkey.MonkeyPatcher._alreadyPatched
  twisted.python.monkey.MonkeyPatcher.html#_alreadyPatched
  Function
  Method
  PRIVATE
  Has the `name` attribute of `obj` already been patched by this patcher?
- twisted.python.monkey.MonkeyPatcher.patch
  twisted.python.monkey.MonkeyPatcher.html#patch
  Function
  Method
  PUBLIC
  Apply all of the patches that have been specified with `addPatch`. Reverse this operation using `restore`.
- twisted.python.monkey.MonkeyPatcher.restore
  twisted.python.monkey.MonkeyPatcher.html#restore
  Function
  Method
  PUBLIC
  Restore all original values to any patched objects.
- twisted.python.monkey.MonkeyPatcher.runWithPatches
  twisted.python.monkey.MonkeyPatcher.html#runWithPatches
  Function
  Method
  PUBLIC
  Apply each patch already specified. Then run the function f with the given args and kwargs. Restore everything when done.
- twisted.trial._synctest._Warning
  twisted.trial._synctest._Warning.html
  Class
  Class
  PRIVATE
  A `_Warning` instance represents one warning emitted through the Python warning system (`warnings`). This is used to insulate callers of `_collectWarnings` from changes to the Python warnings system which might otherwise require changes to the warning objects that function passes to the observer object it accepts.
- twisted.trial._synctest._Warning.message
  twisted.trial._synctest._Warning.html#message
  Attribute
  Instance Variable
  PUBLIC
  The string which was passed as the message parameter to `warnings.warn`.
- twisted.trial._synctest._Warning.category
  twisted.trial._synctest._Warning.html#category
  Attribute
  Instance Variable
  PUBLIC
  The `Warning` subclass which was passed as the category parameter to `warnings.warn`.
- twisted.trial._synctest._Warning.filename
  twisted.trial._synctest._Warning.html#filename
  Attribute
  Instance Variable
  PUBLIC
  The name of the file containing the definition of the code object which was `stacklevel` frames above the call to `warnings.warn`, where `stacklevel` is the value of the `stacklevel` parameter passed to `warnings.warn`...
- twisted.trial._synctest._Warning.lineno
  twisted.trial._synctest._Warning.html#lineno
  Attribute
  Instance Variable
  PUBLIC
  The source line associated with the active instruction of the code object object which was `stacklevel` frames above the call to `warnings.warn`, where `stacklevel` is the value of the `stacklevel` parameter passed to ...
- twisted.trial._synctest._Warning.__init__
  twisted.trial._synctest._Warning.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.trial._synctest._setWarningRegistryToNone
  twisted.trial._synctest.html#_setWarningRegistryToNone
  Function
  Function
  PRIVATE
  Disable the per-module cache for every module found in `modules`, typically `sys.modules`.
- twisted.trial._synctest._collectWarnings
  twisted.trial._synctest.html#_collectWarnings
  Function
  Function
  PRIVATE
  Call `f` with `args` positional arguments and `kwargs` keyword arguments and collect all warnings which are emitted as a result in a list.
- twisted.trial._synctest.UnsupportedTrialFeature
  twisted.trial._synctest.UnsupportedTrialFeature.html
  Class
  Exception
  PUBLIC
  A feature of twisted.trial was used that pyunit cannot support.
- twisted.trial._synctest._AssertRaisesContext
  twisted.trial._synctest._AssertRaisesContext.html
  Class
  Class
  PRIVATE
  A helper for implementing `assertRaises`. This is a context manager and a helper method to support the non-context manager version of `assertRaises`.
- twisted.trial._synctest._AssertRaisesContext._testCase
  twisted.trial._synctest._AssertRaisesContext.html#_testCase
  Attribute
  Instance Variable
  PRIVATE
  See `testCase` parameter of `__init__`
- twisted.trial._synctest._AssertRaisesContext._expected
  twisted.trial._synctest._AssertRaisesContext.html#_expected
  Attribute
  Instance Variable
  PRIVATE
  See `expected` parameter of `__init__`
- twisted.trial._synctest._AssertRaisesContext._returnValue
  twisted.trial._synctest._AssertRaisesContext.html#_returnValue
  Attribute
  Instance Variable
  PRIVATE
  The value returned by the callable being tested (only when not being used as a context manager).
- twisted.trial._synctest._AssertRaisesContext._expectedName
  twisted.trial._synctest._AssertRaisesContext.html#_expectedName
  Attribute
  Instance Variable
  PRIVATE
  A short string describing the expected exception (usually the name of the exception class).
- twisted.trial._synctest._AssertRaisesContext.exception
  twisted.trial._synctest._AssertRaisesContext.html#exception
  Attribute
  Instance Variable
  PUBLIC
  The exception which was raised by the function being tested (if it raised one).
- twisted.trial._synctest._AssertRaisesContext.__init__
  twisted.trial._synctest._AssertRaisesContext.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.trial._synctest._AssertRaisesContext._handle
  twisted.trial._synctest._AssertRaisesContext.html#_handle
  Function
  Method
  PRIVATE
  Call the given object using this object as a context manager.
- twisted.trial._synctest._AssertRaisesContext.__enter__
  twisted.trial._synctest._AssertRaisesContext.html#__enter__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.trial._synctest._AssertRaisesContext.__exit__
  twisted.trial._synctest._AssertRaisesContext.html#__exit__
  Function
  Method
  PUBLIC
  Check exit exception against expected exception.
- twisted.trial._synctest._Assertions
  twisted.trial._synctest._Assertions.html
  Class
  Class
  PRIVATE
  Replaces many of the built-in TestCase assertions. In general, these assertions provide better error messages and are easier to use in callbacks.
- twisted.trial._synctest._Assertions.fail
  twisted.trial._synctest._Assertions.html#fail
  Function
  Method
  PUBLIC
  Absolutely fail the test. Do not pass go, do not collect $200.
- twisted.trial._synctest._Assertions.assertFalse
  twisted.trial._synctest._Assertions.html#assertFalse
  Function
  Method
  PUBLIC
  Fail the test if `condition` evaluates to True.
- twisted.trial._synctest._Assertions.assertTrue
  twisted.trial._synctest._Assertions.html#assertTrue
  Function
  Method
  PUBLIC
  Fail the test if `condition` evaluates to False.
- twisted.trial._synctest._Assertions.assertRaises
  twisted.trial._synctest._Assertions.html#assertRaises
  Function
  Method
  PUBLIC
  Fail the test unless calling the function `f` with the given `args` and `kwargs` raises `exception`. The failure will report the traceback and call stack of the unexpected exception.
- twisted.trial._synctest._Assertions.assertEqual
  twisted.trial._synctest._Assertions.html#assertEqual
  Function
  Method
  PUBLIC
  Fail the test if `first` and `second` are not equal.
- twisted.trial._synctest._Assertions.assertIs
  twisted.trial._synctest._Assertions.html#assertIs
  Function
  Method
  PUBLIC
  Fail the test if `first` is not `second`. This is an obect-identity-equality test, not an object equality (i.e. `__eq__`) test.
- twisted.trial._synctest._Assertions.assertIsNot
  twisted.trial._synctest._Assertions.html#assertIsNot
  Function
  Method
  PUBLIC
  Fail the test if `first` is `second`. This is an obect-identity-equality test, not an object equality (i.e. `__eq__`) test.
- twisted.trial._synctest._Assertions.assertNotEqual
  twisted.trial._synctest._Assertions.html#assertNotEqual
  Function
  Method
  PUBLIC
  Fail the test if `first` == `second`.
- twisted.trial._synctest._Assertions.assertIn
  twisted.trial._synctest._Assertions.html#assertIn
  Function
  Method
  PUBLIC
  Fail the test if `containee` is not found in `container`.
- twisted.trial._synctest._Assertions.assertNotIn
  twisted.trial._synctest._Assertions.html#assertNotIn
  Function
  Method
  PUBLIC
  Fail the test if `containee` is found in `container`.
- twisted.trial._synctest._Assertions.assertNotAlmostEqual
  twisted.trial._synctest._Assertions.html#assertNotAlmostEqual
  Function
  Method
  PUBLIC
  Fail if the two objects are equal as determined by their difference rounded to the given number of decimal places (default 7) and comparing to zero.
- twisted.trial._synctest._Assertions.assertAlmostEqual
  twisted.trial._synctest._Assertions.html#assertAlmostEqual
  Function
  Method
  PUBLIC
  Fail if the two objects are unequal as determined by their difference rounded to the given number of decimal places (default 7) and comparing to zero.
- twisted.trial._synctest._Assertions.assertApproximates
  twisted.trial._synctest._Assertions.html#assertApproximates
  Function
  Method
  PUBLIC
  Fail if `first` - `second` > `tolerance`
- twisted.trial._synctest._Assertions.assertSubstring
  twisted.trial._synctest._Assertions.html#assertSubstring
  Function
  Method
  PUBLIC
  Fail if `substring` does not exist within `astring`.
- twisted.trial._synctest._Assertions.assertNotSubstring
  twisted.trial._synctest._Assertions.html#assertNotSubstring
  Function
  Method
  PUBLIC
  Fail if `astring` contains `substring`.
- twisted.trial._synctest._Assertions.assertWarns
  twisted.trial._synctest._Assertions.html#assertWarns
  Function
  Method
  PUBLIC
  Fail if the given function doesn't generate the specified warning when called. It calls the function, checks the warning, and forwards the result of the function if everything is fine.
- twisted.trial._synctest._Assertions.assertIsInstance
  twisted.trial._synctest._Assertions.html#assertIsInstance
  Function
  Method
  PUBLIC
  Fail if `instance` is not an instance of the given class or of one of the given classes.
- twisted.trial._synctest._Assertions.assertNotIsInstance
  twisted.trial._synctest._Assertions.html#assertNotIsInstance
  Function
  Method
  PUBLIC
  Fail if `instance` is an instance of the given class or of one of the given classes.
- twisted.trial._synctest._Assertions.successResultOf
  twisted.trial._synctest._Assertions.html#successResultOf
  Function
  Method
  PUBLIC
  Return the current success result of `deferred` or raise `self.failureException`.
- twisted.trial._synctest._Assertions.failureResultOf
  twisted.trial._synctest._Assertions.html#failureResultOf
  Function
  Method
  PUBLIC
  Return the current failure result of `deferred` or raise `self.failureException`.
- twisted.trial._synctest._Assertions.assertNoResult
  twisted.trial._synctest._Assertions.html#assertNoResult
  Function
  Method
  PUBLIC
  Assert that `deferred` does not have a result at this point.
- twisted.trial._synctest._LogObserver
  twisted.trial._synctest._LogObserver.html
  Class
  Class
  PRIVATE
  Observes the Twisted logs and catches any errors.
- twisted.trial._synctest._LogObserver._errors
  twisted.trial._synctest._LogObserver.html#_errors
  Attribute
  Instance Variable
  PRIVATE
  A `list` of `Failure` instances which were received as error events from the Twisted logging system.
- twisted.trial._synctest._LogObserver._added
  twisted.trial._synctest._LogObserver.html#_added
  Attribute
  Instance Variable
  PRIVATE
  A `int` giving the number of times `_add` has been called less the number of times `_remove` has been called; used to only add this observer to the Twisted logging since once, regardless of the number of calls to the add method.
- twisted.trial._synctest._LogObserver._ignored
  twisted.trial._synctest._LogObserver.html#_ignored
  Attribute
  Instance Variable
  PRIVATE
  A `list` of exception types which will not be recorded.
- twisted.trial._synctest._LogObserver.__init__
  twisted.trial._synctest._LogObserver.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.trial._synctest._LogObserver._add
  twisted.trial._synctest._LogObserver.html#_add
  Function
  Method
  PRIVATE
  Undocumented
- twisted.trial._synctest._LogObserver._remove
  twisted.trial._synctest._LogObserver.html#_remove
  Function
  Method
  PRIVATE
  Undocumented
- twisted.trial._synctest._LogObserver._ignoreErrors
  twisted.trial._synctest._LogObserver.html#_ignoreErrors
  Function
  Method
  PRIVATE
  Do not store any errors with any of the given types.
- twisted.trial._synctest._LogObserver._clearIgnores
  twisted.trial._synctest._LogObserver.html#_clearIgnores
  Function
  Method
  PRIVATE
  Stop ignoring any errors we might currently be ignoring.
- twisted.trial._synctest._LogObserver.flushErrors
  twisted.trial._synctest._LogObserver.html#flushErrors
  Function
  Method
  PUBLIC
  Flush errors from the list of caught errors. If no arguments are specified, remove all errors. If arguments are specified, only remove errors of those types from the stored list.
- twisted.trial._synctest._LogObserver.getErrors
  twisted.trial._synctest._LogObserver.html#getErrors
  Function
  Method
  PUBLIC
  Return a list of errors caught by this observer.
- twisted.trial._synctest._LogObserver.gotEvent
  twisted.trial._synctest._LogObserver.html#gotEvent
  Function
  Method
  PUBLIC
  The actual observer method. Called whenever a message is logged.
- twisted.trial._synctest._logObserver
  twisted.trial._synctest.html#_logObserver
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.trial._asyncrunner._clearSuite
  twisted.trial._asyncrunner.html#_clearSuite
  Function
  Function
  PRIVATE
  Clear all tests from `suite`.
- twisted.trial._asyncrunner._PyUnitTestCaseAdapter
  twisted.trial._asyncrunner._PyUnitTestCaseAdapter.html
  Class
  Class
  PRIVATE
  Adapt from pyunit.TestCase to ITestCase.
- twisted.trial._asyncrunner._BrokenIDTestCaseAdapter
  twisted.trial._asyncrunner._BrokenIDTestCaseAdapter.html
  Class
  Class
  PRIVATE
  Adapter for pyunit-style `TestCase` subclasses that have undesirable id() methods. That is `unittest.FunctionTestCase` and `unittest.DocTestCase`.
- twisted.trial._asyncrunner._BrokenIDTestCaseAdapter.id
  twisted.trial._asyncrunner._BrokenIDTestCaseAdapter.html#id
  Function
  Method
  PUBLIC
  Return the fully-qualified Python name of the doctest.
- twisted.trial._asyncrunner._ForceGarbageCollectionDecorator
  twisted.trial._asyncrunner._ForceGarbageCollectionDecorator.html
  Class
  Class
  PRIVATE
  Forces garbage collection to be run before and after the test. Any errors logged during the post-test collection are added to the test result as errors.
- twisted.trial._asyncrunner._ForceGarbageCollectionDecorator.run
  twisted.trial._asyncrunner._ForceGarbageCollectionDecorator.html#run
  Function
  Method
  PUBLIC
  Run the unit test.
- twisted.trial._asyncrunner._docTestCase
  twisted.trial._asyncrunner.html#_docTestCase
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.trial._asyncrunner._iterateTests
  twisted.trial._asyncrunner.html#_iterateTests
  Function
  Function
  PRIVATE
  Iterate through all of the test cases in `testSuiteOrCase`.
- twisted.trial.unittest.TestDecorator
  twisted.trial.unittest.TestDecorator.html
  Class
  Class
  PUBLIC
  Decorator for test cases.
- twisted.trial.unittest.TestDecorator.__call__
  twisted.trial.unittest.TestDecorator.html#__call__
  Function
  Method
  PUBLIC
  Run the unit test.
- twisted.trial.unittest.TestDecorator.run
  twisted.trial.unittest.TestDecorator.html#run
  Function
  Method
  PUBLIC
  Run the unit test.
- twisted.trial.unittest.TestSuite
  twisted.trial.unittest.TestSuite.html
  Class
  Class
  PUBLIC
  Extend the standard library's `TestSuite` with a consistently overrideable `run` method.
- twisted.trial.unittest.TestSuite.run
  twisted.trial.unittest.TestSuite.html#run
  Function
  Method
  PUBLIC
  Call `run` on every member of the suite.
- twisted.trial.unittest.decorate
  twisted.trial.unittest.html#decorate
  Function
  Function
  PUBLIC
  Decorate all test cases in `test` with `decorator`.
- twisted.trial._asynctest._wait_is_running
  twisted.trial._asynctest.html#_wait_is_running
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.trial.unittest.TestCase
  twisted.trial.unittest.TestCase.html
  Class
  Class
  PUBLIC
  A unit test. The atom of the unit testing universe.
- twisted.trial.unittest.TestCase.timeout
  twisted.trial.unittest.TestCase.html#timeout
  Attribute
  Instance Variable
  PUBLIC
  A real number of seconds. If set, the test will raise an error if it takes longer than `timeout` seconds. If not set, util.DEFAULT_TIMEOUT_DURATION is used.
- twisted.trial.unittest.TestCase.__init__
  twisted.trial.unittest.TestCase.html#__init__
  Function
  Method
  PUBLIC
  Construct an asynchronous test case for `methodName`.
- twisted.trial.unittest.TestCase.assertFailure
  twisted.trial.unittest.TestCase.html#assertFailure
  Function
  Method
  PUBLIC
  Fail if `deferred` does not errback with one of `expectedFailures`. Returns the original Deferred with callbacks added. You will need to return this Deferred from your test case.
- twisted.trial.unittest.TestCase._run
  twisted.trial.unittest.TestCase.html#_run
  Function
  Method
  PRIVATE
  Run a single method, either a test method or fixture.
- twisted.trial.unittest.TestCase.__call__
  twisted.trial.unittest.TestCase.html#__call__
  Function
  Method
  PUBLIC
  Run the test. Should always do exactly the same thing as run().
- twisted.trial.unittest.TestCase.deferSetUp
  twisted.trial.unittest.TestCase.html#deferSetUp
  Function
  Method
  PUBLIC
  Undocumented
- twisted.trial.unittest.TestCase._ebDeferSetUp
  twisted.trial.unittest.TestCase.html#_ebDeferSetUp
  Function
  Method
  PRIVATE
  Undocumented
- twisted.trial.unittest.TestCase.deferTestMethod
  twisted.trial.unittest.TestCase.html#deferTestMethod
  Function
  Method
  PUBLIC
  Undocumented
- twisted.trial.unittest.TestCase._cbDeferTestMethod
  twisted.trial.unittest.TestCase.html#_cbDeferTestMethod
  Function
  Method
  PRIVATE
  Undocumented
- twisted.trial.unittest.TestCase._ebDeferTestMethod
  twisted.trial.unittest.TestCase.html#_ebDeferTestMethod
  Function
  Method
  PRIVATE
  Undocumented
- twisted.trial.unittest.TestCase.deferTearDown
  twisted.trial.unittest.TestCase.html#deferTearDown
  Function
  Method
  PUBLIC
  Undocumented
- twisted.trial.unittest.TestCase._ebDeferTearDown
  twisted.trial.unittest.TestCase.html#_ebDeferTearDown
  Function
  Method
  PRIVATE
  Undocumented
- twisted.trial.unittest.TestCase._passed
  twisted.trial.unittest.TestCase.html#_passed
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.trial.unittest.TestCase.deferRunCleanups
  twisted.trial.unittest.TestCase.html#deferRunCleanups
  Function
  Method
  PUBLIC
  Run any scheduled cleanups and report errors (if any) to the result. object.
- twisted.trial.unittest.TestCase._cleanUp
  twisted.trial.unittest.TestCase.html#_cleanUp
  Function
  Method
  PRIVATE
  Undocumented
- twisted.trial.unittest.TestCase._classCleanUp
  twisted.trial.unittest.TestCase.html#_classCleanUp
  Function
  Method
  PRIVATE
  Undocumented
- twisted.trial.unittest.TestCase._makeReactorMethod
  twisted.trial.unittest.TestCase.html#_makeReactorMethod
  Function
  Method
  PRIVATE
  Create a method which wraps the reactor method `name`. The new method issues a deprecation warning and calls the original.
- twisted.trial.unittest.TestCase._deprecateReactor
  twisted.trial.unittest.TestCase.html#_deprecateReactor
  Function
  Method
  PRIVATE
  Deprecate `iterate`, `crash` and `stop` on `reactor`. That is, each method is wrapped in a function that issues a deprecation warning, then calls the original.
- twisted.trial.unittest.TestCase._reactorMethods
  twisted.trial.unittest.TestCase.html#_reactorMethods
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.trial.unittest.TestCase._undeprecateReactor
  twisted.trial.unittest.TestCase.html#_undeprecateReactor
  Function
  Method
  PRIVATE
  Restore the deprecated reactor methods. Undoes what `_deprecateReactor` did.
- twisted.trial.unittest.TestCase._runFixturesAndTest
  twisted.trial.unittest.TestCase.html#_runFixturesAndTest
  Function
  Method
  PRIVATE
  Really run `setUp`, the test method, and `tearDown`. Any of these may return `defer.Deferred`s. After they complete, do some reactor cleanup.
- twisted.trial.unittest.TestCase._timedOut
  twisted.trial.unittest.TestCase.html#_timedOut
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.trial.unittest.TestCase.addCleanup
  twisted.trial.unittest.TestCase.html#addCleanup
  Function
  Method
  PUBLIC
  Extend the base cleanup feature with support for cleanup functions which return Deferreds.
- twisted.trial.unittest.TestCase.getSuppress
  twisted.trial.unittest.TestCase.html#getSuppress
  Function
  Method
  PUBLIC
  Undocumented
- twisted.trial.unittest.TestCase.getTimeout
  twisted.trial.unittest.TestCase.html#getTimeout
  Function
  Method
  PUBLIC
  Returns the timeout value set on this test. Checks on the instance first, then the class, then the module, then packages. As soon as it finds something with a `timeout` attribute, returns that. Returns `util.DEFAULT_TIMEOUT_DURATION`...
- twisted.trial.unittest.TestCase._wait
  twisted.trial.unittest.TestCase.html#_wait
  Function
  Method
  PRIVATE
  Take a Deferred that only ever callbacks. Block until it happens.
- twisted.trial.unittest.FailTest
  twisted.trial.unittest.FailTest.html
  Class
  Exception
  PUBLIC
  Raised to indicate the current test has failed to pass.
- twisted.trial.unittest.PyUnitResultAdapter
  twisted.trial.unittest.PyUnitResultAdapter.html
  Class
  Class
  PUBLIC
  Wrap a `TestResult` from the standard library's `unittest` so that it supports the extended result types from Trial, and also supports `twisted.python.failure.Failure`s being passed to `addError` and `addFailure`...
- twisted.trial.unittest.PyUnitResultAdapter.__init__
  twisted.trial.unittest.PyUnitResultAdapter.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.trial.unittest.PyUnitResultAdapter.original
  twisted.trial.unittest.PyUnitResultAdapter.html#original
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.trial.unittest.PyUnitResultAdapter._exc_info
  twisted.trial.unittest.PyUnitResultAdapter.html#_exc_info
  Function
  Method
  PRIVATE
  Undocumented
- twisted.trial.unittest.PyUnitResultAdapter.startTest
  twisted.trial.unittest.PyUnitResultAdapter.html#startTest
  Function
  Method
  PUBLIC
  Undocumented
- twisted.trial.unittest.PyUnitResultAdapter.stopTest
  twisted.trial.unittest.PyUnitResultAdapter.html#stopTest
  Function
  Method
  PUBLIC
  Undocumented
- twisted.trial.unittest.PyUnitResultAdapter.addFailure
  twisted.trial.unittest.PyUnitResultAdapter.html#addFailure
  Function
  Method
  PUBLIC
  Undocumented
- twisted.trial.unittest.PyUnitResultAdapter.addError
  twisted.trial.unittest.PyUnitResultAdapter.html#addError
  Function
  Method
  PUBLIC
  Undocumented
- twisted.trial.unittest.PyUnitResultAdapter._unsupported
  twisted.trial.unittest.PyUnitResultAdapter.html#_unsupported
  Function
  Method
  PRIVATE
  Undocumented
- twisted.trial.unittest.PyUnitResultAdapter.addSkip
  twisted.trial.unittest.PyUnitResultAdapter.html#addSkip
  Function
  Method
  PUBLIC
  Report the skip as a failure.
- twisted.trial.unittest.PyUnitResultAdapter.addUnexpectedSuccess
  twisted.trial.unittest.PyUnitResultAdapter.html#addUnexpectedSuccess
  Function
  Method
  PUBLIC
  Report the unexpected success as a failure.
- twisted.trial.unittest.PyUnitResultAdapter.addExpectedFailure
  twisted.trial.unittest.PyUnitResultAdapter.html#addExpectedFailure
  Function
  Method
  PUBLIC
  Report the expected failure (i.e. todo) as a failure.
- twisted.trial.unittest.PyUnitResultAdapter.addSuccess
  twisted.trial.unittest.PyUnitResultAdapter.html#addSuccess
  Function
  Method
  PUBLIC
  Undocumented
- twisted.trial.unittest.PyUnitResultAdapter.upDownError
  twisted.trial.unittest.PyUnitResultAdapter.html#upDownError
  Function
  Method
  PUBLIC
  Undocumented
- twisted.trial.unittest.SynchronousTestCase
  twisted.trial.unittest.SynchronousTestCase.html
  Class
  Class
  PUBLIC
  A unit test. The atom of the unit testing universe.
- twisted.trial.unittest.SynchronousTestCase.failureException
  twisted.trial.unittest.SynchronousTestCase.html#failureException
  Attribute
  Instance Variable
  PUBLIC
  An exception class, defaulting to `FailTest`. If the test method raises this exception, it will be reported as a failure, rather than an exception. All of the assertion methods raise this if the assertion fails.
- twisted.trial.unittest.SynchronousTestCase.skip
  twisted.trial.unittest.SynchronousTestCase.html#skip
  Attribute
  Instance Variable
  PUBLIC
  `None` or a string explaining why this test is to be skipped. If defined, the test will not be run. Instead, it will be reported to the result object as 'skipped' (if the `TestResult` supports skipping).
- twisted.trial.unittest.SynchronousTestCase.todo
  twisted.trial.unittest.SynchronousTestCase.html#todo
  Attribute
  Instance Variable
  PUBLIC
  `None`, a string or a tuple of `(errors, reason)` where `errors` is either an exception class or an iterable of exception classes, and `reason` is a string. See `Todo` or `makeTodo` for more information.
- twisted.trial.unittest.SynchronousTestCase.suppress
  twisted.trial.unittest.SynchronousTestCase.html#suppress
  Attribute
  Instance Variable
  PUBLIC
  `None` or a list of tuples of `(args, kwargs)` to be passed to `warnings.filterwarnings`. Use these to suppress warnings raised in a test. Useful for testing deprecated code. See also `util.suppress`.
- twisted.trial.unittest.SynchronousTestCase.__init__
  twisted.trial.unittest.SynchronousTestCase.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.trial.unittest.SynchronousTestCase._passed
  twisted.trial.unittest.SynchronousTestCase.html#_passed
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.trial.unittest.SynchronousTestCase._cleanups
  twisted.trial.unittest.SynchronousTestCase.html#_cleanups
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.trial.unittest.SynchronousTestCase._testMethodName
  twisted.trial.unittest.SynchronousTestCase.html#_testMethodName
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.trial.unittest.SynchronousTestCase._parents
  twisted.trial.unittest.SynchronousTestCase.html#_parents
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.trial.unittest.SynchronousTestCase.__eq__
  twisted.trial.unittest.SynchronousTestCase.html#__eq__
  Function
  Method
  PUBLIC
  Override the comparison defined by the base TestCase which considers instances of the same class with the same _testMethodName to be equal. Since trial puts TestCase instances into a set, that definition of comparison makes it impossible to run the same test method twice...
- twisted.trial.unittest.SynchronousTestCase.__hash__
  twisted.trial.unittest.SynchronousTestCase.html#__hash__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.trial.unittest.SynchronousTestCase.shortDescription
  twisted.trial.unittest.SynchronousTestCase.html#shortDescription
  Function
  Method
  PUBLIC
  Undocumented
- twisted.trial.unittest.SynchronousTestCase.getSkip
  twisted.trial.unittest.SynchronousTestCase.html#getSkip
  Function
  Method
  PUBLIC
  Return the skip reason set on this test, if any is set. Checks on the instance first, then the class, then the module, then packages. As soon as it finds something with a `skip` attribute, returns that in a tuple (...
- twisted.trial.unittest.SynchronousTestCase.getTodo
  twisted.trial.unittest.SynchronousTestCase.html#getTodo
  Function
  Method
  PUBLIC
  Return a `Todo` object if the test is marked todo. Checks on the instance first, then the class, then the module, then packages. As soon as it finds something with a `todo` attribute, returns that. Returns ...
- twisted.trial.unittest.SynchronousTestCase.runTest
  twisted.trial.unittest.SynchronousTestCase.html#runTest
  Function
  Method
  PUBLIC
  If no `methodName` argument is passed to the constructor, `run` will treat this method as the thing with the actual test inside.
- twisted.trial.unittest.SynchronousTestCase.run
  twisted.trial.unittest.SynchronousTestCase.html#run
  Function
  Method
  PUBLIC
  Run the test case, storing the results in `result`.
- twisted.trial.unittest.SynchronousTestCase._warnings
  twisted.trial.unittest.SynchronousTestCase.html#_warnings
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.trial.unittest.SynchronousTestCase.addCleanup
  twisted.trial.unittest.SynchronousTestCase.html#addCleanup
  Function
  Method
  PUBLIC
  Add the given function to a list of functions to be called after the test has run, but before `tearDown`.
- twisted.trial.unittest.SynchronousTestCase.patch
  twisted.trial.unittest.SynchronousTestCase.html#patch
  Function
  Method
  PUBLIC
  Monkey patch an object for the duration of the test.
- twisted.trial.unittest.SynchronousTestCase.flushLoggedErrors
  twisted.trial.unittest.SynchronousTestCase.html#flushLoggedErrors
  Function
  Method
  PUBLIC
  Remove stored errors received from the log.
- twisted.trial.unittest.SynchronousTestCase.flushWarnings
  twisted.trial.unittest.SynchronousTestCase.html#flushWarnings
  Function
  Method
  PUBLIC
  Remove stored warnings from the list of captured warnings and return them.
- twisted.trial.unittest.SynchronousTestCase.getDeprecatedModuleAttribute
  twisted.trial.unittest.SynchronousTestCase.html#getDeprecatedModuleAttribute
  Function
  Method
  PUBLIC
  Retrieve a module attribute which should have been deprecated, and assert that we saw the appropriate deprecation warning.
- twisted.trial.unittest.SynchronousTestCase.callDeprecated
  twisted.trial.unittest.SynchronousTestCase.html#callDeprecated
  Function
  Method
  PUBLIC
  Call a function that should have been deprecated at a specific version and in favor of a specific alternative, and assert that it was thusly deprecated.
- twisted.trial.unittest.SynchronousTestCase.mktemp
  twisted.trial.unittest.SynchronousTestCase.html#mktemp
  Function
  Method
  PUBLIC
  Create a new path name which can be used for a new file or directory.
- twisted.trial.unittest.SynchronousTestCase._getSuppress
  twisted.trial.unittest.SynchronousTestCase.html#_getSuppress
  Function
  Method
  PRIVATE
  Returns any warning suppressions set for this test. Checks on the instance first, then the class, then the module, then packages. As soon as it finds something with a `suppress` attribute, returns that. ...
- twisted.trial.unittest.SynchronousTestCase._getSkipReason
  twisted.trial.unittest.SynchronousTestCase.html#_getSkipReason
  Function
  Method
  PRIVATE
  Return the reason to use for skipping a test method.
- twisted.trial.unittest.SynchronousTestCase._run
  twisted.trial.unittest.SynchronousTestCase.html#_run
  Function
  Method
  PRIVATE
  Run a single method, either a test method or fixture.
- twisted.trial.unittest.SynchronousTestCase._runFixturesAndTest
  twisted.trial.unittest.SynchronousTestCase.html#_runFixturesAndTest
  Function
  Method
  PRIVATE
  Run `setUp`, a test method, test cleanups, and `tearDown`.
- twisted.trial.unittest.SynchronousTestCase._runCleanups
  twisted.trial.unittest.SynchronousTestCase.html#_runCleanups
  Function
  Method
  PRIVATE
  Synchronously run any cleanups which have been added.
- twisted.trial.unittest.SynchronousTestCase._installObserver
  twisted.trial.unittest.SynchronousTestCase.html#_installObserver
  Function
  Method
  PRIVATE
  Undocumented
- twisted.trial.unittest.SynchronousTestCase._observer
  twisted.trial.unittest.SynchronousTestCase.html#_observer
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.trial.unittest.SynchronousTestCase._removeObserver
  twisted.trial.unittest.SynchronousTestCase.html#_removeObserver
  Function
  Method
  PRIVATE
  Undocumented
- twisted.trial.unittest.Todo
  twisted.trial.unittest.Todo.html
  Class
  Class
  PUBLIC
  Internal object used to mark a `TestCase` as 'todo'. Tests marked 'todo' are reported differently in Trial `TestResult`s. If todo'd tests fail, they do not fail the suite and the errors are reported in a separate category...
- twisted.trial.unittest.Todo.__init__
  twisted.trial.unittest.Todo.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.trial.unittest.Todo.reason
  twisted.trial.unittest.Todo.html#reason
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.trial.unittest.Todo.errors
  twisted.trial.unittest.Todo.html#errors
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.trial.unittest.Todo.__repr__
  twisted.trial.unittest.Todo.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.trial.unittest.Todo.expected
  twisted.trial.unittest.Todo.html#expected
  Function
  Method
  PUBLIC
  No summary
- twisted.trial.unittest.makeTodo
  twisted.trial.unittest.html#makeTodo
  Function
  Function
  PUBLIC
  Return a `Todo` object built from `value`.
- twisted.copyright.version
  twisted.copyright.html#version
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.copyright.longversion
  twisted.copyright.html#longversion
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.copyright.copyright
  twisted.copyright.html#copyright
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.copyright.disclaimer
  twisted.copyright.html#disclaimer
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.python.modules.theSystemPath
  twisted.python.modules.html#theSystemPath
  Attribute
  Variable
  PUBLIC
  The very top of the Python object space.
- twisted.python.zippath.ZIP_PATH_SEP
  twisted.python.zippath.html#ZIP_PATH_SEP
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.python.zippath.ZipPath
  twisted.python.zippath.ZipPath.html
  Class
  Class
  PUBLIC
  I represent a file or directory contained within a zip file.
- twisted.python.zippath.ZipPath.__init__
  twisted.python.zippath.ZipPath.html#__init__
  Function
  Method
  PUBLIC
  Don't construct me directly. Use `ZipArchive.child()`.
- twisted.python.zippath.ZipPath.archive
  twisted.python.zippath.ZipPath.html#archive
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.zippath.ZipPath.pathInArchive
  twisted.python.zippath.ZipPath.html#pathInArchive
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.zippath.ZipPath.path
  twisted.python.zippath.ZipPath.html#path
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.zippath.ZipPath.__cmp__
  twisted.python.zippath.ZipPath.html#__cmp__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.zippath.ZipPath.__repr__
  twisted.python.zippath.ZipPath.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.zippath.ZipPath.sep
  twisted.python.zippath.ZipPath.html#sep
  Attribute
  Property
  PUBLIC
  Return a zip directory separator.
- twisted.python.zippath.ZipPath.parent
  twisted.python.zippath.ZipPath.html#parent
  Function
  Method
  PUBLIC
  A file path for the directory containing the file at this file path.
- twisted.python.zippath.ZipPath.child
  twisted.python.zippath.ZipPath.html#child
  Function
  Method
  PUBLIC
  Return a new ZipPath representing a path in `self.archive` which is a child of this path.
- twisted.python.zippath.ZipPath.sibling
  twisted.python.zippath.ZipPath.html#sibling
  Function
  Method
  PUBLIC
  Return a `FilePath` with the same directory as this instance but with a basename of `path`.
- twisted.python.zippath.ZipPath.exists
  twisted.python.zippath.ZipPath.html#exists
  Function
  Method
  PUBLIC
  Check if this file path exists.
- twisted.python.zippath.ZipPath.isdir
  twisted.python.zippath.ZipPath.html#isdir
  Function
  Method
  PUBLIC
  Check if this file path refers to a directory.
- twisted.python.zippath.ZipPath.isfile
  twisted.python.zippath.ZipPath.html#isfile
  Function
  Method
  PUBLIC
  Check if this file path refers to a regular file.
- twisted.python.zippath.ZipPath.islink
  twisted.python.zippath.ZipPath.html#islink
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.zippath.ZipPath.listdir
  twisted.python.zippath.ZipPath.html#listdir
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.zippath.ZipPath.splitext
  twisted.python.zippath.ZipPath.html#splitext
  Function
  Method
  PUBLIC
  Return a value similar to that returned by `os.path.splitext`.
- twisted.python.zippath.ZipPath.basename
  twisted.python.zippath.ZipPath.html#basename
  Function
  Method
  PUBLIC
  Retrieve the final component of the file path's path (everything after the final path separator).
- twisted.python.zippath.ZipPath.dirname
  twisted.python.zippath.ZipPath.html#dirname
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.zippath.ZipPath.open
  twisted.python.zippath.ZipPath.html#open
  Function
  Method
  PUBLIC
  Opens this file path with the given mode.
- twisted.python.zippath.ZipPath.changed
  twisted.python.zippath.ZipPath.html#changed
  Function
  Method
  PUBLIC
  Clear any cached information about the state of this path on disk.
- twisted.python.zippath.ZipPath.getsize
  twisted.python.zippath.ZipPath.html#getsize
  Function
  Method
  PUBLIC
  Retrieve this file's size.
- twisted.python.zippath.ZipPath.getAccessTime
  twisted.python.zippath.ZipPath.html#getAccessTime
  Function
  Method
  PUBLIC
  Retrieve this file's last access-time. This is the same as the last access time for the archive.
- twisted.python.zippath.ZipPath.getModificationTime
  twisted.python.zippath.ZipPath.html#getModificationTime
  Function
  Method
  PUBLIC
  Retrieve this file's last modification time. This is the time of modification recorded in the zipfile.
- twisted.python.zippath.ZipPath.getStatusChangeTime
  twisted.python.zippath.ZipPath.html#getStatusChangeTime
  Function
  Method
  PUBLIC
  Retrieve this file's last modification time. This name is provided for compatibility, and returns the same value as getmtime.
- twisted.python.zippath.ZipArchive
  twisted.python.zippath.ZipArchive.html
  Class
  Class
  PUBLIC
  I am a `FilePath`-like object which can wrap a zip archive as if it were a directory.
- twisted.python.zippath.ZipArchive.archive
  twisted.python.zippath.ZipArchive.html#archive
  Attribute
  Property
  PUBLIC
  Undocumented
- twisted.python.zippath.ZipArchive.__init__
  twisted.python.zippath.ZipArchive.html#__init__
  Function
  Method
  PUBLIC
  Create a ZipArchive, treating the archive at archivePathname as a zip file.
- twisted.python.zippath.ZipArchive.path
  twisted.python.zippath.ZipArchive.html#path
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.zippath.ZipArchive.zipfile
  twisted.python.zippath.ZipArchive.html#zipfile
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.zippath.ZipArchive.pathInArchive
  twisted.python.zippath.ZipArchive.html#pathInArchive
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.zippath.ZipArchive.childmap
  twisted.python.zippath.ZipArchive.html#childmap
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.zippath.ZipArchive.child
  twisted.python.zippath.ZipArchive.html#child
  Function
  Method
  PUBLIC
  Create a ZipPath pointing at a path within the archive.
- twisted.python.zippath.ZipArchive.exists
  twisted.python.zippath.ZipArchive.html#exists
  Function
  Method
  PUBLIC
  Returns `True` if the underlying archive exists.
- twisted.python.zippath.ZipArchive.getAccessTime
  twisted.python.zippath.ZipArchive.html#getAccessTime
  Function
  Method
  PUBLIC
  Return the archive file's last access time.
- twisted.python.zippath.ZipArchive.getModificationTime
  twisted.python.zippath.ZipArchive.html#getModificationTime
  Function
  Method
  PUBLIC
  Return the archive file's modification time.
- twisted.python.zippath.ZipArchive.getStatusChangeTime
  twisted.python.zippath.ZipArchive.html#getStatusChangeTime
  Function
  Method
  PUBLIC
  Return the archive file's status change time.
- twisted.python.zippath.ZipArchive.__repr__
  twisted.python.zippath.ZipArchive.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.modules._nothing
  twisted.python.modules.html#_nothing
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.python.modules.PYTHON_EXTENSIONS
  twisted.python.modules.html#PYTHON_EXTENSIONS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.python.modules.OPTIMIZED_MODE
  twisted.python.modules.html#OPTIMIZED_MODE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.python.modules._isPythonIdentifier
  twisted.python.modules.html#_isPythonIdentifier
  Function
  Function
  PRIVATE
  cheezy fake test for proper identifier-ness.
- twisted.python.modules._isPackagePath
  twisted.python.modules.html#_isPackagePath
  Function
  Function
  PRIVATE
  Undocumented
- twisted.python.modules._ModuleIteratorHelper
  twisted.python.modules._ModuleIteratorHelper.html
  Class
  Class
  PRIVATE
  This mixin provides common behavior between python module and path entries, since the mechanism for searching sys.path and __path__ attributes is remarkably similar.
- twisted.python.modules._ModuleIteratorHelper.iterModules
  twisted.python.modules._ModuleIteratorHelper.html#iterModules
  Function
  Method
  PUBLIC
  Loop over the modules present below this entry or package on PYTHONPATH.
- twisted.python.modules._ModuleIteratorHelper.walkModules
  twisted.python.modules._ModuleIteratorHelper.html#walkModules
  Function
  Method
  PUBLIC
  Similar to `iterModules`, this yields self, and then every module in my package or entry, and every submodule in each package or entry.
- twisted.python.modules._ModuleIteratorHelper._subModuleName
  twisted.python.modules._ModuleIteratorHelper.html#_subModuleName
  Function
  Method
  PRIVATE
  This is a hook to provide packages with the ability to specify their names as a prefix to submodules here.
- twisted.python.modules._ModuleIteratorHelper._packagePaths
  twisted.python.modules._ModuleIteratorHelper.html#_packagePaths
  Function
  Method
  PRIVATE
  Implement in subclasses to specify where to look for modules.
- twisted.python.modules._ModuleIteratorHelper._getEntry
  twisted.python.modules._ModuleIteratorHelper.html#_getEntry
  Function
  Method
  PRIVATE
  Implement in subclasses to specify what path entry submodules will come from.
- twisted.python.modules._ModuleIteratorHelper.__getitem__
  twisted.python.modules._ModuleIteratorHelper.html#__getitem__
  Function
  Method
  PUBLIC
  Retrieve a module from below this path or package.
- twisted.python.modules._ModuleIteratorHelper.__iter__
  twisted.python.modules._ModuleIteratorHelper.html#__iter__
  Function
  Method
  PUBLIC
  Implemented to raise NotImplementedError for clarity, so that attempting to loop over this object won't call __getitem__.
- twisted.python.modules.PythonAttribute
  twisted.python.modules.PythonAttribute.html
  Class
  Class
  PUBLIC
  I represent a function, class, or other object that is present.
- twisted.python.modules.PythonAttribute.name
  twisted.python.modules.PythonAttribute.html#name
  Attribute
  Instance Variable
  PUBLIC
  the fully qualified python name of the attribute represented by this class.
- twisted.python.modules.PythonAttribute.onObject
  twisted.python.modules.PythonAttribute.html#onObject
  Attribute
  Instance Variable
  PUBLIC
  a reference to a PythonModule or other PythonAttribute that is this attribute's logical parent.
- twisted.python.modules.PythonAttribute.__init__
  twisted.python.modules.PythonAttribute.html#__init__
  Function
  Method
  PUBLIC
  Create a PythonAttribute. This is a private constructor. Do not construct me directly, use PythonModule.iterAttributes.
- twisted.python.modules.PythonAttribute._loaded
  twisted.python.modules.PythonAttribute.html#_loaded
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.python.modules.PythonAttribute.pythonValue
  twisted.python.modules.PythonAttribute.html#pythonValue
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.modules.PythonAttribute.__repr__
  twisted.python.modules.PythonAttribute.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.modules.PythonAttribute.isLoaded
  twisted.python.modules.PythonAttribute.html#isLoaded
  Function
  Method
  PUBLIC
  Return a boolean describing whether the attribute this describes has actually been loaded into memory by importing its module.
- twisted.python.modules.PythonAttribute.load
  twisted.python.modules.PythonAttribute.html#load
  Function
  Method
  PUBLIC
  Load the value associated with this attribute.
- twisted.python.modules.PythonAttribute.iterAttributes
  twisted.python.modules.PythonAttribute.html#iterAttributes
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.modules.PythonModule
  twisted.python.modules.PythonModule.html
  Class
  Class
  PUBLIC
  Representation of a module which could be imported from sys.path.
- twisted.python.modules.PythonModule.name
  twisted.python.modules.PythonModule.html#name
  Attribute
  Instance Variable
  PUBLIC
  the fully qualified python name of this module.
- twisted.python.modules.PythonModule.filePath
  twisted.python.modules.PythonModule.html#filePath
  Attribute
  Instance Variable
  PUBLIC
  a FilePath-like object which points to the location of this module.
- twisted.python.modules.PythonModule.pathEntry
  twisted.python.modules.PythonModule.html#pathEntry
  Attribute
  Instance Variable
  PUBLIC
  a `PathEntry` instance which this module was located from.
- twisted.python.modules.PythonModule.__init__
  twisted.python.modules.PythonModule.html#__init__
  Function
  Method
  PUBLIC
  Create a PythonModule. Do not construct this directly, instead inspect a PythonPath or other PythonModule instances.
- twisted.python.modules.PythonModule.parentPath
  twisted.python.modules.PythonModule.html#parentPath
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.modules.PythonModule._getEntry
  twisted.python.modules.PythonModule.html#_getEntry
  Function
  Method
  PRIVATE
  Implement in subclasses to specify what path entry submodules will come from.
- twisted.python.modules.PythonModule.__repr__
  twisted.python.modules.PythonModule.html#__repr__
  Function
  Method
  PUBLIC
  Return a string representation including the module name.
- twisted.python.modules.PythonModule.isLoaded
  twisted.python.modules.PythonModule.html#isLoaded
  Function
  Method
  PUBLIC
  Determine if the module is loaded into sys.modules.
- twisted.python.modules.PythonModule.iterAttributes
  twisted.python.modules.PythonModule.html#iterAttributes
  Function
  Method
  PUBLIC
  List all the attributes defined in this module.
- twisted.python.modules.PythonModule.isPackage
  twisted.python.modules.PythonModule.html#isPackage
  Function
  Method
  PUBLIC
  Returns true if this module is also a package, and might yield something from iterModules.
- twisted.python.modules.PythonModule.load
  twisted.python.modules.PythonModule.html#load
  Function
  Method
  PUBLIC
  Load this module.
- twisted.python.modules.PythonModule.__eq__
  twisted.python.modules.PythonModule.html#__eq__
  Function
  Method
  PUBLIC
  PythonModules with the same name are equal.
- twisted.python.modules.PythonModule.walkModules
  twisted.python.modules.PythonModule.html#walkModules
  Function
  Method
  PUBLIC
  Similar to `iterModules`, this yields self, and then every module in my package or entry, and every submodule in each package or entry.
- twisted.python.modules.PythonModule._subModuleName
  twisted.python.modules.PythonModule.html#_subModuleName
  Function
  Method
  PRIVATE
  submodules of this module are prefixed with our name.
- twisted.python.modules.PythonModule._packagePaths
  twisted.python.modules.PythonModule.html#_packagePaths
  Function
  Method
  PRIVATE
  Yield a sequence of FilePath-like objects which represent path segments.
- twisted.python.modules.PathEntry
  twisted.python.modules.PathEntry.html
  Class
  Class
  PUBLIC
  I am a proxy for a single entry on sys.path.
- twisted.python.modules.PathEntry.filePath
  twisted.python.modules.PathEntry.html#filePath
  Attribute
  Instance Variable
  PUBLIC
  a FilePath-like object pointing at the filesystem location or archive file where this path entry is stored.
- twisted.python.modules.PathEntry.pythonPath
  twisted.python.modules.PathEntry.html#pythonPath
  Attribute
  Instance Variable
  PUBLIC
  a PythonPath instance.
- twisted.python.modules.PathEntry.__init__
  twisted.python.modules.PathEntry.html#__init__
  Function
  Method
  PUBLIC
  Create a PathEntry. This is a private constructor.
- twisted.python.modules.PathEntry._getEntry
  twisted.python.modules.PathEntry.html#_getEntry
  Function
  Method
  PRIVATE
  Implement in subclasses to specify what path entry submodules will come from.
- twisted.python.modules.PathEntry.__repr__
  twisted.python.modules.PathEntry.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.modules.PathEntry._packagePaths
  twisted.python.modules.PathEntry.html#_packagePaths
  Function
  Method
  PRIVATE
  Implement in subclasses to specify where to look for modules.
- twisted.python.modules.IPathImportMapper
  twisted.python.modules.IPathImportMapper.html
  Class
  Interface
  PUBLIC
  This is an internal interface, used to map importers to factories for FilePath-like objects.
- twisted.python.modules.IPathImportMapper.mapPath
  twisted.python.modules.IPathImportMapper.html#mapPath
  Function
  Method
  PUBLIC
  Return a FilePath-like object.
- twisted.python.modules._DefaultMapImpl
  twisted.python.modules._DefaultMapImpl.html
  Class
  Class
  PRIVATE
  Wrapper for the default importer, i.e. None.
- twisted.python.modules._DefaultMapImpl.mapPath
  twisted.python.modules._DefaultMapImpl.html#mapPath
  Function
  Method
  PUBLIC
  Return a FilePath-like object.
- twisted.python.modules._theDefaultMapper
  twisted.python.modules.html#_theDefaultMapper
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.python.modules._ZipMapImpl
  twisted.python.modules._ZipMapImpl.html
  Class
  Class
  PRIVATE
  IPathImportMapper implementation for zipimport.ZipImporter.
- twisted.python.modules._ZipMapImpl.__init__
  twisted.python.modules._ZipMapImpl.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.modules._ZipMapImpl.importer
  twisted.python.modules._ZipMapImpl.html#importer
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.modules._ZipMapImpl.mapPath
  twisted.python.modules._ZipMapImpl.html#mapPath
  Function
  Method
  PUBLIC
  Map the given FS path to a ZipPath, by looking at the ZipImporter's "archive" attribute and using it as our ZipArchive root, then walking down into the archive from there.
- twisted.python.modules._defaultSysPathFactory
  twisted.python.modules.html#_defaultSysPathFactory
  Function
  Function
  PRIVATE
  Provide the default behavior of PythonPath's sys.path factory, which is to return the current value of sys.path.
- twisted.python.modules.PythonPath
  twisted.python.modules.PythonPath.html
  Class
  Class
  PUBLIC
  I represent the very top of the Python object-space, the module list in `sys.path` and the modules list in `sys.modules`.
- twisted.python.modules.PythonPath._sysPath
  twisted.python.modules.PythonPath.html#_sysPath
  Attribute
  Instance Variable
  PRIVATE
  A sequence of strings like `sys.path`. This attribute is read-only.
- twisted.python.modules.PythonPath.moduleDict
  twisted.python.modules.PythonPath.html#moduleDict
  Attribute
  Instance Variable
  PUBLIC
  A dictionary mapping string module names to module objects, like `sys.modules`.
- twisted.python.modules.PythonPath.sysPathHooks
  twisted.python.modules.PythonPath.html#sysPathHooks
  Attribute
  Instance Variable
  PUBLIC
  A list of PEP-302 path hooks, like `sys.path_hooks`.
- twisted.python.modules.PythonPath.moduleLoader
  twisted.python.modules.PythonPath.html#moduleLoader
  Attribute
  Instance Variable
  PUBLIC
  A function that takes a fully-qualified python name and returns a module, like `twisted.python.reflect.namedAny`.
- twisted.python.modules.PythonPath.__init__
  twisted.python.modules.PythonPath.html#__init__
  Function
  Method
  PUBLIC
  Create a PythonPath. You almost certainly want to use modules.theSystemPath, or its aliased methods, rather than creating a new instance yourself, though.
- twisted.python.modules.PythonPath._sysPathFactory
  twisted.python.modules.PythonPath.html#_sysPathFactory
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.python.modules.PythonPath.importerCache
  twisted.python.modules.PythonPath.html#importerCache
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.modules.PythonPath.sysPath 0
  twisted.python.modules.PythonPath.html#sysPath%200
  Attribute
  Instance Variable
  PUBLIC
  The current value of the module search path list.
- twisted.python.modules.PythonPath.sysPath
  twisted.python.modules.PythonPath.html#sysPath
  Attribute
  Property
  PUBLIC
  Retrieve the current value of the module search path list.
- twisted.python.modules.PythonPath._findEntryPathString
  twisted.python.modules.PythonPath.html#_findEntryPathString
  Function
  Method
  PRIVATE
  Determine where a given Python module object came from by looking at path entries.
- twisted.python.modules.PythonPath._smartPath
  twisted.python.modules.PythonPath.html#_smartPath
  Function
  Method
  PRIVATE
  Given a path entry from sys.path which may refer to an importer, return the appropriate FilePath-like instance.
- twisted.python.modules.PythonPath.iterEntries
  twisted.python.modules.PythonPath.html#iterEntries
  Function
  Method
  PUBLIC
  Iterate the entries on my sysPath.
- twisted.python.modules.PythonPath.__getitem__
  twisted.python.modules.PythonPath.html#__getitem__
  Function
  Method
  PUBLIC
  Get a python module by its given fully-qualified name.
- twisted.python.modules.PythonPath.__contains__
  twisted.python.modules.PythonPath.html#__contains__
  Function
  Method
  PUBLIC
  Check to see whether or not a module exists on my import path.
- twisted.python.modules.PythonPath.__repr__
  twisted.python.modules.PythonPath.html#__repr__
  Function
  Method
  PUBLIC
  Display my sysPath and moduleDict in a string representation.
- twisted.python.modules.PythonPath.iterModules
  twisted.python.modules.PythonPath.html#iterModules
  Function
  Method
  PUBLIC
  Yield all top-level modules on my sysPath.
- twisted.python.modules.PythonPath.walkModules
  twisted.python.modules.PythonPath.html#walkModules
  Function
  Method
  PUBLIC
  Similar to `iterModules`, this yields every module on the path, then every submodule in each package or entry.
- twisted.python.modules.walkModules
  twisted.python.modules.html#walkModules
  Function
  Function
  PUBLIC
  Deeply iterate all modules on the global python path.
- twisted.python.modules.iterModules
  twisted.python.modules.html#iterModules
  Function
  Function
  PUBLIC
  Iterate all modules and top-level packages on the global Python path, but do not descend into packages.
- twisted.python.modules.getModule
  twisted.python.modules.html#getModule
  Function
  Function
  PUBLIC
  Retrieve a module from the system path.
- twisted.plugin.IPlugin
  twisted.plugin.IPlugin.html
  Class
  Interface
  PUBLIC
  Interface that must be implemented by all plugins.
- twisted.plugin.CachedPlugin
  twisted.plugin.CachedPlugin.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.plugin.CachedPlugin.__init__
  twisted.plugin.CachedPlugin.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.plugin.CachedPlugin.dropin
  twisted.plugin.CachedPlugin.html#dropin
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.plugin.CachedPlugin.name
  twisted.plugin.CachedPlugin.html#name
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.plugin.CachedPlugin.description
  twisted.plugin.CachedPlugin.html#description
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.plugin.CachedPlugin.provided
  twisted.plugin.CachedPlugin.html#provided
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.plugin.CachedPlugin.__repr__
  twisted.plugin.CachedPlugin.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.plugin.CachedPlugin.load
  twisted.plugin.CachedPlugin.html#load
  Function
  Method
  PUBLIC
  Undocumented
- twisted.plugin.CachedPlugin.__conform__
  twisted.plugin.CachedPlugin.html#__conform__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.plugin.CachedDropin
  twisted.plugin.CachedDropin.html
  Class
  Class
  PUBLIC
  A collection of `CachedPlugin` instances from a particular module in a plugin package.
- twisted.plugin.CachedDropin.moduleName
  twisted.plugin.CachedDropin.html#moduleName
  Attribute
  Instance Variable
  PUBLIC
  The fully qualified name of the plugin module this represents.
- twisted.plugin.CachedDropin.description
  twisted.plugin.CachedDropin.html#description
  Attribute
  Instance Variable
  PUBLIC
  A brief explanation of this collection of plugins (probably the plugin module's docstring).
- twisted.plugin.CachedDropin.plugins
  twisted.plugin.CachedDropin.html#plugins
  Attribute
  Instance Variable
  PUBLIC
  The `CachedPlugin` instances which were loaded from this dropin.
- twisted.plugin.CachedDropin.__init__
  twisted.plugin.CachedDropin.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.plugin._generateCacheEntry
  twisted.plugin.html#_generateCacheEntry
  Function
  Function
  PRIVATE
  Undocumented
- twisted.plugin.getCache
  twisted.plugin.html#getCache
  Function
  Function
  PUBLIC
  Compute all the possible loadable plugins, while loading as few as possible and hitting the filesystem as little as possible.
- twisted.plugin._pluginsPackage
  twisted.plugin.html#_pluginsPackage
  Function
  Function
  PRIVATE
  Undocumented
- twisted.plugin._TInterface
  twisted.plugin.html#_TInterface
  Attribute
  Type Variable
  PRIVATE
  Undocumented
- twisted.plugin.getPlugins
  twisted.plugin.html#getPlugins
  Function
  Function
  PUBLIC
  Retrieve all plugins implementing the given interface beneath the given module.
- twisted.plugin.pluginPackagePaths
  twisted.plugin.html#pluginPackagePaths
  Function
  Function
  PUBLIC
  Return a list of additional directories which should be searched for modules to be included as part of the named plugin package.
- twisted.application.reactors.IReactorInstaller
  twisted.application.reactors.IReactorInstaller.html
  Class
  Interface
  PUBLIC
  Definition of a reactor which can probably be installed.
- twisted.application.reactors.IReactorInstaller.shortName
  twisted.application.reactors.IReactorInstaller.html#shortName
  Attribute
  Attribute
  PUBLIC
  A brief string giving the user-facing name of this reactor.
- twisted.application.reactors.IReactorInstaller.description
  twisted.application.reactors.IReactorInstaller.html#description
  Attribute
  Attribute
  PUBLIC
  A longer string giving a user-facing description of this reactor.
- twisted.application.reactors.IReactorInstaller.install
  twisted.application.reactors.IReactorInstaller.html#install
  Function
  Method
  PUBLIC
  Install this reactor.
- twisted.application.reactors.NoSuchReactor
  twisted.application.reactors.NoSuchReactor.html
  Class
  Exception
  PUBLIC
  Raised when an attempt is made to install a reactor which cannot be found.
- twisted.application.reactors.Reactor
  twisted.application.reactors.Reactor.html
  Class
  Class
  PUBLIC
  No summary
- twisted.application.reactors.Reactor.moduleName
  twisted.application.reactors.Reactor.html#moduleName
  Attribute
  Instance Variable
  PUBLIC
  The fully-qualified Python name of the module of which the install callable is an attribute.
- twisted.application.reactors.Reactor.__init__
  twisted.application.reactors.Reactor.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.application.reactors.Reactor.shortName
  twisted.application.reactors.Reactor.html#shortName
  Attribute
  Instance Variable
  PUBLIC
  A brief string giving the user-facing name of this reactor.
- twisted.application.reactors.Reactor.description
  twisted.application.reactors.Reactor.html#description
  Attribute
  Instance Variable
  PUBLIC
  A longer string giving a user-facing description of this reactor.
- twisted.application.reactors.Reactor.install
  twisted.application.reactors.Reactor.html#install
  Function
  Method
  PUBLIC
  Install this reactor.
- twisted.application.reactors.getReactorTypes
  twisted.application.reactors.html#getReactorTypes
  Function
  Function
  PUBLIC
  Return an iterator of `IReactorInstaller` plugins.
- twisted.application.reactors.installReactor
  twisted.application.reactors.html#installReactor
  Function
  Function
  PUBLIC
  Install the reactor with the given `shortName` attribute.
- twisted.persisted.styles.oldModules
  twisted.persisted.styles.html#oldModules
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.persisted.styles.pickleMethod
  twisted.persisted.styles.html#pickleMethod
  Function
  Function
  PUBLIC
  support function for copy_reg to pickle method refs
- twisted.persisted.styles._methodFunction
  twisted.persisted.styles.html#_methodFunction
  Function
  Function
  PRIVATE
  Retrieve the function object implementing a method name given the class it's on and a method name.
- twisted.persisted.styles.unpickleMethod
  twisted.persisted.styles.html#unpickleMethod
  Function
  Function
  PUBLIC
  Support function for copy_reg to unpickle method refs.
- twisted.persisted.styles._pickleFunction
  twisted.persisted.styles.html#_pickleFunction
  Function
  Function
  PRIVATE
  Reduce, in the sense of `pickle`'s `object.__reduce__` special method, a function object into its constituent parts.
- twisted.persisted.styles._unpickleFunction
  twisted.persisted.styles.html#_unpickleFunction
  Function
  Function
  PRIVATE
  Convert a function name into a function by importing it.
- twisted.persisted.styles.pickleModule
  twisted.persisted.styles.html#pickleModule
  Function
  Function
  PUBLIC
  support function for copy_reg to pickle module refs
- twisted.persisted.styles.unpickleModule
  twisted.persisted.styles.html#unpickleModule
  Function
  Function
  PUBLIC
  support function for copy_reg to unpickle module refs
- twisted.persisted.styles.pickleStringO
  twisted.persisted.styles.html#pickleStringO
  Function
  Function
  PUBLIC
  Reduce the given cStringO.
- twisted.persisted.styles.unpickleStringO
  twisted.persisted.styles.html#unpickleStringO
  Function
  Function
  PUBLIC
  Convert the output of `pickleStringO` into an appropriate type for the current python version. This may be called on Python 3 and will convert a cStringIO into an `io.StringIO`.
- twisted.persisted.styles.pickleStringI
  twisted.persisted.styles.html#pickleStringI
  Function
  Function
  PUBLIC
  Reduce the given cStringI.
- twisted.persisted.styles.unpickleStringI
  twisted.persisted.styles.html#unpickleStringI
  Function
  Function
  PUBLIC
  Convert the output of `pickleStringI` into an appropriate type for the current Python version.
- twisted.persisted.styles.Ephemeral
  twisted.persisted.styles.Ephemeral.html
  Class
  Class
  PUBLIC
  This type of object is never persisted; if possible, even references to it are eliminated.
- twisted.persisted.styles.Ephemeral.__reduce__
  twisted.persisted.styles.Ephemeral.html#__reduce__
  Function
  Method
  PUBLIC
  Serialize any subclass of `Ephemeral` in a way which replaces it with `Ephemeral` itself.
- twisted.persisted.styles.Ephemeral.__getstate__
  twisted.persisted.styles.Ephemeral.html#__getstate__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.persisted.styles.Ephemeral.__setstate__
  twisted.persisted.styles.Ephemeral.html#__setstate__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.persisted.styles.Ephemeral.__class__
  twisted.persisted.styles.Ephemeral.html#__class__
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.persisted.styles.versionedsToUpgrade
  twisted.persisted.styles.html#versionedsToUpgrade
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.persisted.styles.upgraded
  twisted.persisted.styles.html#upgraded
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.persisted.styles.doUpgrade
  twisted.persisted.styles.html#doUpgrade
  Function
  Function
  PUBLIC
  Undocumented
- twisted.persisted.styles.requireUpgrade
  twisted.persisted.styles.html#requireUpgrade
  Function
  Function
  PUBLIC
  Require that a Versioned instance be upgraded completely first.
- twisted.persisted.styles._aybabtu
  twisted.persisted.styles.html#_aybabtu
  Function
  Function
  PRIVATE
  Get all of the parent classes of `c`, not including `c` itself, which are strict subclasses of `Versioned`.
- twisted.persisted.styles.Versioned
  twisted.persisted.styles.Versioned.html
  Class
  Class
  PUBLIC
  This type of object is persisted with versioning information.
- twisted.persisted.styles.Versioned.persistenceVersion
  twisted.persisted.styles.Versioned.html#persistenceVersion
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.persisted.styles.Versioned.persistenceForgets
  twisted.persisted.styles.Versioned.html#persistenceForgets
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.persisted.styles.Versioned.__setstate__
  twisted.persisted.styles.Versioned.html#__setstate__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.persisted.styles.Versioned.__dict__
  twisted.persisted.styles.Versioned.html#__dict__
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.persisted.styles.Versioned.__getstate__
  twisted.persisted.styles.Versioned.html#__getstate__
  Function
  Method
  PUBLIC
  Get state, adding a version number to it on its way out.
- twisted.persisted.styles.Versioned.versionUpgrade
  twisted.persisted.styles.Versioned.html#versionUpgrade
  Function
  Method
  PUBLIC
  (internal) Do a version upgrade.
- twisted.persisted.sob.IPersistable
  twisted.persisted.sob.IPersistable.html
  Class
  Interface
  PUBLIC
  An object which can be saved in several formats to a file
- twisted.persisted.sob.IPersistable.setStyle
  twisted.persisted.sob.IPersistable.html#setStyle
  Function
  Method
  PUBLIC
  Set desired format.
- twisted.persisted.sob.IPersistable.save
  twisted.persisted.sob.IPersistable.html#save
  Function
  Method
  PUBLIC
  Save object to file.
- twisted.persisted.sob.Persistent
  twisted.persisted.sob.Persistent.html
  Class
  Class
  PUBLIC
  No class docstring; 0/3 instance variable, 2/6 methods documented
- twisted.persisted.sob.Persistent.style
  twisted.persisted.sob.Persistent.html#style
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.persisted.sob.Persistent.__init__
  twisted.persisted.sob.Persistent.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.persisted.sob.Persistent.original
  twisted.persisted.sob.Persistent.html#original
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.persisted.sob.Persistent.name
  twisted.persisted.sob.Persistent.html#name
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.persisted.sob.Persistent.setStyle
  twisted.persisted.sob.Persistent.html#setStyle
  Function
  Method
  PUBLIC
  Set desired format.
- twisted.persisted.sob.Persistent._getFilename
  twisted.persisted.sob.Persistent.html#_getFilename
  Function
  Method
  PRIVATE
  Undocumented
- twisted.persisted.sob.Persistent._saveTemp
  twisted.persisted.sob.Persistent.html#_saveTemp
  Function
  Method
  PRIVATE
  Undocumented
- twisted.persisted.sob.Persistent._getStyle
  twisted.persisted.sob.Persistent.html#_getStyle
  Function
  Method
  PRIVATE
  Undocumented
- twisted.persisted.sob.Persistent.save
  twisted.persisted.sob.Persistent.html#save
  Function
  Method
  PUBLIC
  Save object to file.
- twisted.persisted.sob._EverythingEphemeral
  twisted.persisted.sob._EverythingEphemeral.html
  Class
  Class
  PRIVATE
  No class docstring; 0/1 instance variable, 0/1 class variable, 1/2 method documented
- twisted.persisted.sob._EverythingEphemeral.initRun
  twisted.persisted.sob._EverythingEphemeral.html#initRun
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.persisted.sob._EverythingEphemeral.__init__
  twisted.persisted.sob._EverythingEphemeral.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.persisted.sob._EverythingEphemeral.mainMod
  twisted.persisted.sob._EverythingEphemeral.html#mainMod
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.persisted.sob._EverythingEphemeral.__getattr__
  twisted.persisted.sob._EverythingEphemeral.html#__getattr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.persisted.sob.load
  twisted.persisted.sob.html#load
  Function
  Function
  PUBLIC
  Load an object from a file.
- twisted.persisted.sob.loadValueFromFile
  twisted.persisted.sob.html#loadValueFromFile
  Function
  Function
  PUBLIC
  Load the value of a variable in a Python file.
- twisted.persisted.sob.guessType
  twisted.persisted.sob.html#guessType
  Function
  Function
  PUBLIC
  Undocumented
- twisted.application.service.IServiceMaker
  twisted.application.service.IServiceMaker.html
  Class
  Interface
  PUBLIC
  An object which can be used to construct services in a flexible way.
- twisted.application.service.IServiceMaker.tapname
  twisted.application.service.IServiceMaker.html#tapname
  Attribute
  Attribute
  PUBLIC
  A short string naming this Twisted plugin, for example 'web' or 'pencil'. This name will be used as the subcommand of 'twistd'.
- twisted.application.service.IServiceMaker.description
  twisted.application.service.IServiceMaker.html#description
  Attribute
  Attribute
  PUBLIC
  A brief summary of the features provided by this Twisted application plugin.
- twisted.application.service.IServiceMaker.options
  twisted.application.service.IServiceMaker.html#options
  Attribute
  Attribute
  PUBLIC
  A `twisted.python.usage.Options` subclass defining the configuration options for this application.
- twisted.application.service.IServiceMaker.makeService
  twisted.application.service.IServiceMaker.html#makeService
  Function
  Method
  PUBLIC
  Create and return an object providing `twisted.application.service.IService`.
- twisted.application.service.ServiceMaker
  twisted.application.service.ServiceMaker.html
  Class
  Class
  PUBLIC
  Utility class to simplify the definition of `IServiceMaker` plugins.
- twisted.application.service.ServiceMaker.__init__
  twisted.application.service.ServiceMaker.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.application.service.ServiceMaker.name
  twisted.application.service.ServiceMaker.html#name
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.application.service.ServiceMaker.module
  twisted.application.service.ServiceMaker.html#module
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.application.service.ServiceMaker.description
  twisted.application.service.ServiceMaker.html#description
  Attribute
  Instance Variable
  PUBLIC
  A brief summary of the features provided by this Twisted application plugin.
- twisted.application.service.ServiceMaker.tapname
  twisted.application.service.ServiceMaker.html#tapname
  Attribute
  Instance Variable
  PUBLIC
  A short string naming this Twisted plugin, for example 'web' or 'pencil'. This name will be used as the subcommand of 'twistd'.
- twisted.application.service.ServiceMaker.options
  twisted.application.service.ServiceMaker.html#options
  Attribute
  Property
  PUBLIC
  A `twisted.python.usage.Options` subclass defining the configuration options for this application.
- twisted.application.service.ServiceMaker.makeService
  twisted.application.service.ServiceMaker.html#makeService
  Attribute
  Property
  PUBLIC
  Create and return an object providing `twisted.application.service.IService`.
- twisted.application.service.IService
  twisted.application.service.IService.html
  Class
  Interface
  PUBLIC
  A service.
- twisted.application.service.IService.name
  twisted.application.service.IService.html#name
  Attribute
  Attribute
  PUBLIC
  A `str` which is the name of the service or `None`.
- twisted.application.service.IService.running
  twisted.application.service.IService.html#running
  Attribute
  Attribute
  PUBLIC
  A `boolean` which indicates whether the service is running.
- twisted.application.service.IService.parent
  twisted.application.service.IService.html#parent
  Attribute
  Attribute
  PUBLIC
  An `IServiceCollection` which is the parent or `None`.
- twisted.application.service.IService.setName
  twisted.application.service.IService.html#setName
  Function
  Method
  PUBLIC
  Set the name of the service.
- twisted.application.service.IService.setServiceParent
  twisted.application.service.IService.html#setServiceParent
  Function
  Method
  PUBLIC
  Set the parent of the service. This method is responsible for setting the `parent` attribute on this service (the child service).
- twisted.application.service.IService.disownServiceParent
  twisted.application.service.IService.html#disownServiceParent
  Function
  Method
  PUBLIC
  Use this API to remove an `IService` from an `IServiceCollection`.
- twisted.application.service.IService.startService
  twisted.application.service.IService.html#startService
  Function
  Method
  PUBLIC
  Start the service.
- twisted.application.service.IService.stopService
  twisted.application.service.IService.html#stopService
  Function
  Method
  PUBLIC
  Stop the service.
- twisted.application.service.IService.privilegedStartService
  twisted.application.service.IService.html#privilegedStartService
  Function
  Method
  PUBLIC
  Do preparation work for starting the service.
- twisted.application.service.Service
  twisted.application.service.Service.html
  Class
  Class
  PUBLIC
  Base class for services.
- twisted.application.service.Service.running
  twisted.application.service.Service.html#running
  Attribute
  Instance Variable
  PUBLIC
  A `boolean` which indicates whether the service is running.
- twisted.application.service.Service.name
  twisted.application.service.Service.html#name
  Attribute
  Instance Variable
  PUBLIC
  A `str` which is the name of the service or `None`.
- twisted.application.service.Service.parent
  twisted.application.service.Service.html#parent
  Attribute
  Instance Variable
  PUBLIC
  An `IServiceCollection` which is the parent or `None`.
- twisted.application.service.Service.__getstate__
  twisted.application.service.Service.html#__getstate__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.application.service.Service.setName
  twisted.application.service.Service.html#setName
  Function
  Method
  PUBLIC
  Set the name of the service.
- twisted.application.service.Service.setServiceParent
  twisted.application.service.Service.html#setServiceParent
  Function
  Method
  PUBLIC
  Set the parent of the service. This method is responsible for setting the `parent` attribute on this service (the child service).
- twisted.application.service.Service.disownServiceParent
  twisted.application.service.Service.html#disownServiceParent
  Function
  Method
  PUBLIC
  Use this API to remove an `IService` from an `IServiceCollection`.
- twisted.application.service.Service.privilegedStartService
  twisted.application.service.Service.html#privilegedStartService
  Function
  Method
  PUBLIC
  Do preparation work for starting the service.
- twisted.application.service.Service.startService
  twisted.application.service.Service.html#startService
  Function
  Method
  PUBLIC
  Start the service.
- twisted.application.service.Service.stopService
  twisted.application.service.Service.html#stopService
  Function
  Method
  PUBLIC
  Stop the service.
- twisted.application.service.IServiceCollection
  twisted.application.service.IServiceCollection.html
  Class
  Interface
  PUBLIC
  Collection of services.
- twisted.application.service.IServiceCollection.getServiceNamed
  twisted.application.service.IServiceCollection.html#getServiceNamed
  Function
  Method
  PUBLIC
  Get the child service with a given name.
- twisted.application.service.IServiceCollection.__iter__
  twisted.application.service.IServiceCollection.html#__iter__
  Function
  Method
  PUBLIC
  Get an iterator over all child services.
- twisted.application.service.IServiceCollection.addService
  twisted.application.service.IServiceCollection.html#addService
  Function
  Method
  PUBLIC
  Add a child service.
- twisted.application.service.IServiceCollection.removeService
  twisted.application.service.IServiceCollection.html#removeService
  Function
  Method
  PUBLIC
  Remove a child service.
- twisted.application.service.MultiService
  twisted.application.service.MultiService.html
  Class
  Class
  PUBLIC
  Straightforward Service Container.
- twisted.application.service.MultiService.__init__
  twisted.application.service.MultiService.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.application.service.MultiService.services
  twisted.application.service.MultiService.html#services
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.application.service.MultiService.namedServices
  twisted.application.service.MultiService.html#namedServices
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.application.service.MultiService.parent
  twisted.application.service.MultiService.html#parent
  Attribute
  Instance Variable
  PUBLIC
  An `IServiceCollection` which is the parent or `None`.
- twisted.application.service.MultiService.privilegedStartService
  twisted.application.service.MultiService.html#privilegedStartService
  Function
  Method
  PUBLIC
  Do preparation work for starting the service.
- twisted.application.service.MultiService.startService
  twisted.application.service.MultiService.html#startService
  Function
  Method
  PUBLIC
  Start the service.
- twisted.application.service.MultiService.stopService
  twisted.application.service.MultiService.html#stopService
  Function
  Method
  PUBLIC
  Stop the service.
- twisted.application.service.MultiService.getServiceNamed
  twisted.application.service.MultiService.html#getServiceNamed
  Function
  Method
  PUBLIC
  Get the child service with a given name.
- twisted.application.service.MultiService.__iter__
  twisted.application.service.MultiService.html#__iter__
  Function
  Method
  PUBLIC
  Get an iterator over all child services.
- twisted.application.service.MultiService.addService
  twisted.application.service.MultiService.html#addService
  Function
  Method
  PUBLIC
  Add a child service.
- twisted.application.service.MultiService.removeService
  twisted.application.service.MultiService.html#removeService
  Function
  Method
  PUBLIC
  Remove a child service.
- twisted.application.service.IProcess
  twisted.application.service.IProcess.html
  Class
  Interface
  PUBLIC
  Process running parameters.
- twisted.application.service.IProcess.processName
  twisted.application.service.IProcess.html#processName
  Attribute
  Attribute
  PUBLIC
  A `str` giving the name the process should have in ps (or `None` to leave the name alone).
- twisted.application.service.IProcess.uid
  twisted.application.service.IProcess.html#uid
  Attribute
  Attribute
  PUBLIC
  An `int` giving the user id as which the process should run (or `None` to leave the UID alone).
- twisted.application.service.IProcess.gid
  twisted.application.service.IProcess.html#gid
  Attribute
  Attribute
  PUBLIC
  An `int` giving the group id as which the process should run (or `None` to leave the GID alone).
- twisted.application.service.Process
  twisted.application.service.Process.html
  Class
  Class
  PUBLIC
  Process running parameters.
- twisted.application.service.Process.processName
  twisted.application.service.Process.html#processName
  Attribute
  Class Variable
  PUBLIC
  A `str` giving the name the process should have in ps (or `None` to leave the name alone).
- twisted.application.service.Process.__init__
  twisted.application.service.Process.html#__init__
  Function
  Method
  PUBLIC
  Set uid and gid.
- twisted.application.service.Process.uid
  twisted.application.service.Process.html#uid
  Attribute
  Instance Variable
  PUBLIC
  An `int` giving the user id as which the process should run (or `None` to leave the UID alone).
- twisted.application.service.Process.gid
  twisted.application.service.Process.html#gid
  Attribute
  Instance Variable
  PUBLIC
  An `int` giving the group id as which the process should run (or `None` to leave the GID alone).
- twisted.application.service.Application
  twisted.application.service.html#Application
  Function
  Function
  PUBLIC
  Return a compound class.
- twisted.application.service.loadApplication
  twisted.application.service.html#loadApplication
  Function
  Function
  PUBLIC
  Load Application from a given file.
- twisted.python.logfile.BaseLogFile
  twisted.python.logfile.BaseLogFile.html
  Class
  Class
  PUBLIC
  The base class for a log file that can be rotated.
- twisted.python.logfile.BaseLogFile.synchronized
  twisted.python.logfile.BaseLogFile.html#synchronized
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.python.logfile.BaseLogFile.__init__
  twisted.python.logfile.BaseLogFile.html#__init__
  Function
  Method
  PUBLIC
  Create a log file.
- twisted.python.logfile.BaseLogFile.directory
  twisted.python.logfile.BaseLogFile.html#directory
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.logfile.BaseLogFile.name
  twisted.python.logfile.BaseLogFile.html#name
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.logfile.BaseLogFile.path
  twisted.python.logfile.BaseLogFile.html#path
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.logfile.BaseLogFile.defaultMode
  twisted.python.logfile.BaseLogFile.html#defaultMode
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.logfile.BaseLogFile.fromFullPath
  twisted.python.logfile.BaseLogFile.html#fromFullPath
  Function
  Class Method
  PUBLIC
  Construct a log file from a full file path.
- twisted.python.logfile.BaseLogFile.shouldRotate
  twisted.python.logfile.BaseLogFile.html#shouldRotate
  Function
  Method
  PUBLIC
  Override with a method to that returns true if the log should be rotated.
- twisted.python.logfile.BaseLogFile._openFile
  twisted.python.logfile.BaseLogFile.html#_openFile
  Function
  Method
  PRIVATE
  Open the log file.
- twisted.python.logfile.BaseLogFile.closed
  twisted.python.logfile.BaseLogFile.html#closed
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.logfile.BaseLogFile._file
  twisted.python.logfile.BaseLogFile.html#_file
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.python.logfile.BaseLogFile.write
  twisted.python.logfile.BaseLogFile.html#write
  Function
  Method
  PUBLIC
  Write some data to the file.
- twisted.python.logfile.BaseLogFile.flush
  twisted.python.logfile.BaseLogFile.html#flush
  Function
  Method
  PUBLIC
  Flush the file.
- twisted.python.logfile.BaseLogFile.close
  twisted.python.logfile.BaseLogFile.html#close
  Function
  Method
  PUBLIC
  Close the file.
- twisted.python.logfile.BaseLogFile.reopen
  twisted.python.logfile.BaseLogFile.html#reopen
  Function
  Method
  PUBLIC
  Reopen the log file. This is mainly useful if you use an external log rotation tool, which moves under your feet.
- twisted.python.logfile.BaseLogFile.getCurrentLog
  twisted.python.logfile.BaseLogFile.html#getCurrentLog
  Function
  Method
  PUBLIC
  Return a LogReader for the current log file.
- twisted.python.logfile.LogFile
  twisted.python.logfile.LogFile.html
  Class
  Class
  PUBLIC
  A log file that can be rotated.
- twisted.python.logfile.LogFile.__init__
  twisted.python.logfile.LogFile.html#__init__
  Function
  Method
  PUBLIC
  Create a log file rotating on length.
- twisted.python.logfile.LogFile.rotateLength
  twisted.python.logfile.LogFile.html#rotateLength
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.logfile.LogFile.maxRotatedFiles
  twisted.python.logfile.LogFile.html#maxRotatedFiles
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.logfile.LogFile._openFile
  twisted.python.logfile.LogFile.html#_openFile
  Function
  Method
  PRIVATE
  Open the log file.
- twisted.python.logfile.LogFile.size
  twisted.python.logfile.LogFile.html#size
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.logfile.LogFile.shouldRotate
  twisted.python.logfile.LogFile.html#shouldRotate
  Function
  Method
  PUBLIC
  Rotate when the log file size is larger than rotateLength.
- twisted.python.logfile.LogFile.getLog
  twisted.python.logfile.LogFile.html#getLog
  Function
  Method
  PUBLIC
  Given an integer, return a LogReader for an old log file.
- twisted.python.logfile.LogFile.write
  twisted.python.logfile.LogFile.html#write
  Function
  Method
  PUBLIC
  Write some data to the file.
- twisted.python.logfile.LogFile.rotate
  twisted.python.logfile.LogFile.html#rotate
  Function
  Method
  PUBLIC
  Rotate the file and create a new one.
- twisted.python.logfile.LogFile.listLogs
  twisted.python.logfile.LogFile.html#listLogs
  Function
  Method
  PUBLIC
  Return sorted list of integers - the old logs' identifiers.
- twisted.python.logfile.LogFile.__getstate__
  twisted.python.logfile.LogFile.html#__getstate__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.logfile.DailyLogFile
  twisted.python.logfile.DailyLogFile.html
  Class
  Class
  PUBLIC
  A log file that is rotated daily (at or after midnight localtime)
- twisted.python.logfile.DailyLogFile._openFile
  twisted.python.logfile.DailyLogFile.html#_openFile
  Function
  Method
  PRIVATE
  Open the log file.
- twisted.python.logfile.DailyLogFile.lastDate
  twisted.python.logfile.DailyLogFile.html#lastDate
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.logfile.DailyLogFile.shouldRotate
  twisted.python.logfile.DailyLogFile.html#shouldRotate
  Function
  Method
  PUBLIC
  Rotate when the date has changed since last write
- twisted.python.logfile.DailyLogFile.toDate
  twisted.python.logfile.DailyLogFile.html#toDate
  Function
  Method
  PUBLIC
  Convert a unixtime to (year, month, day) localtime tuple, or return the current (year, month, day) localtime tuple.
- twisted.python.logfile.DailyLogFile.suffix
  twisted.python.logfile.DailyLogFile.html#suffix
  Function
  Method
  PUBLIC
  Return the suffix given a (year, month, day) tuple or unixtime
- twisted.python.logfile.DailyLogFile.getLog
  twisted.python.logfile.DailyLogFile.html#getLog
  Function
  Method
  PUBLIC
  Given a unix time, return a LogReader for an old log file.
- twisted.python.logfile.DailyLogFile.write
  twisted.python.logfile.DailyLogFile.html#write
  Function
  Method
  PUBLIC
  Write some data to the log file
- twisted.python.logfile.DailyLogFile.rotate
  twisted.python.logfile.DailyLogFile.html#rotate
  Function
  Method
  PUBLIC
  Rotate the file and create a new one.
- twisted.python.logfile.DailyLogFile.__getstate__
  twisted.python.logfile.DailyLogFile.html#__getstate__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.logfile.LogReader
  twisted.python.logfile.LogReader.html
  Class
  Class
  PUBLIC
  Read from a log file.
- twisted.python.logfile.LogReader.__init__
  twisted.python.logfile.LogReader.html#__init__
  Function
  Method
  PUBLIC
  Open the log file for reading.
- twisted.python.logfile.LogReader._file
  twisted.python.logfile.LogReader.html#_file
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.python.logfile.LogReader.readLines
  twisted.python.logfile.LogReader.html#readLines
  Function
  Method
  PUBLIC
  Read a list of lines from the log file.
- twisted.python.logfile.LogReader.close
  twisted.python.logfile.LogReader.html#close
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.usage.UsageError
  twisted.python.usage.UsageError.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.python.usage.CoerceParameter
  twisted.python.usage.CoerceParameter.html
  Class
  Class
  PUBLIC
  Utility class that can corce a parameter before storing it.
- twisted.python.usage.CoerceParameter.__init__
  twisted.python.usage.CoerceParameter.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.python.usage.CoerceParameter.options
  twisted.python.usage.CoerceParameter.html#options
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.usage.CoerceParameter.coerce
  twisted.python.usage.CoerceParameter.html#coerce
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.usage.CoerceParameter.doc
  twisted.python.usage.CoerceParameter.html#doc
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.usage.CoerceParameter.dispatch
  twisted.python.usage.CoerceParameter.html#dispatch
  Function
  Method
  PUBLIC
  When called in dispatch, do the coerce for `value` and save the returned value.
- twisted.python.usage.Options
  twisted.python.usage.Options.html
  Class
  Class
  PUBLIC
  An option list parser class
- twisted.python.usage.Options.subCommand
  twisted.python.usage.Options.html#subCommand
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.usage.Options.defaultSubCommand
  twisted.python.usage.Options.html#defaultSubCommand
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.python.usage.Options.parent
  twisted.python.usage.Options.html#parent
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.python.usage.Options.completionData
  twisted.python.usage.Options.html#completionData
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.python.usage.Options.__init__
  twisted.python.usage.Options.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.usage.Options.opts
  twisted.python.usage.Options.html#opts
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.usage.Options.defaults
  twisted.python.usage.Options.html#defaults
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.usage.Options.longOpt
  twisted.python.usage.Options.html#longOpt
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.usage.Options.shortOpt
  twisted.python.usage.Options.html#shortOpt
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.usage.Options.docs
  twisted.python.usage.Options.html#docs
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.usage.Options.synonyms
  twisted.python.usage.Options.html#synonyms
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.usage.Options._dispatch
  twisted.python.usage.Options.html#_dispatch
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.python.usage.Options.opt_help
  twisted.python.usage.Options.html#opt_help
  Function
  Method
  PUBLIC
  Display this help and exit.
- twisted.python.usage.Options.opt_version
  twisted.python.usage.Options.html#opt_version
  Function
  Method
  PUBLIC
  Display Twisted version and exit.
- twisted.python.usage.Options.parseOptions
  twisted.python.usage.Options.html#parseOptions
  Function
  Method
  PUBLIC
  The guts of the command-line parser.
- twisted.python.usage.Options.subOptions
  twisted.python.usage.Options.html#subOptions
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.usage.Options.postOptions
  twisted.python.usage.Options.html#postOptions
  Function
  Method
  PUBLIC
  I am called after the options are parsed.
- twisted.python.usage.Options.parseArgs
  twisted.python.usage.Options.html#parseArgs
  Function
  Method
  PUBLIC
  I am called with any leftover arguments which were not options.
- twisted.python.usage.Options._generic_flag
  twisted.python.usage.Options.html#_generic_flag
  Function
  Method
  PRIVATE
  Undocumented
- twisted.python.usage.Options._gather_flags
  twisted.python.usage.Options.html#_gather_flags
  Function
  Method
  PRIVATE
  Gather up boolean (flag) options.
- twisted.python.usage.Options._gather_parameters
  twisted.python.usage.Options.html#_gather_parameters
  Function
  Method
  PRIVATE
  Gather options which take a value.
- twisted.python.usage.Options._gather_handlers
  twisted.python.usage.Options.html#_gather_handlers
  Function
  Method
  PRIVATE
  Gather up options with their own handler methods.
- twisted.python.usage.Options.__str__
  twisted.python.usage.Options.html#__str__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.usage.Options.getSynopsis
  twisted.python.usage.Options.html#getSynopsis
  Function
  Method
  PUBLIC
  Returns a string containing a description of these options and how to pass them to the executed file.
- twisted.python.usage.Options.getUsage
  twisted.python.usage.Options.html#getUsage
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.usage._ZSH
  twisted.python.usage.html#_ZSH
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.python.usage._BASH
  twisted.python.usage.html#_BASH
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.python.usage.Completer
  twisted.python.usage.Completer.html
  Class
  Class
  PUBLIC
  A completion "action" - provides completion possibilities for a particular command-line option. For example we might provide the user a fixed list of choices, or files/dirs according to a glob.
- twisted.python.usage.Completer._descr
  twisted.python.usage.Completer.html#_descr
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.python.usage.Completer.__init__
  twisted.python.usage.Completer.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.python.usage.Completer._repeat
  twisted.python.usage.Completer.html#_repeat
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.python.usage.Completer._repeatFlag
  twisted.python.usage.Completer.html#_repeatFlag
  Attribute
  Property
  PRIVATE
  Undocumented
- twisted.python.usage.Completer._description
  twisted.python.usage.Completer.html#_description
  Function
  Method
  PRIVATE
  Undocumented
- twisted.python.usage.Completer._shellCode
  twisted.python.usage.Completer.html#_shellCode
  Function
  Method
  PRIVATE
  Fetch a fragment of shell code representing this action which is suitable for use by the completion system in _shellcomp.py
- twisted.python.usage.CompleteFiles
  twisted.python.usage.CompleteFiles.html
  Class
  Class
  PUBLIC
  Completes file names based on a glob pattern
- twisted.python.usage.CompleteFiles.__init__
  twisted.python.usage.CompleteFiles.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.python.usage.CompleteFiles._globPattern
  twisted.python.usage.CompleteFiles.html#_globPattern
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.python.usage.CompleteFiles._description
  twisted.python.usage.CompleteFiles.html#_description
  Function
  Method
  PRIVATE
  Undocumented
- twisted.python.usage.CompleteFiles._shellCode
  twisted.python.usage.CompleteFiles.html#_shellCode
  Function
  Method
  PRIVATE
  Fetch a fragment of shell code representing this action which is suitable for use by the completion system in _shellcomp.py
- twisted.python.usage.CompleteDirs
  twisted.python.usage.CompleteDirs.html
  Class
  Class
  PUBLIC
  Completes directory names
- twisted.python.usage.CompleteDirs._shellCode
  twisted.python.usage.CompleteDirs.html#_shellCode
  Function
  Method
  PRIVATE
  Fetch a fragment of shell code representing this action which is suitable for use by the completion system in _shellcomp.py
- twisted.python.usage.CompleteList
  twisted.python.usage.CompleteList.html
  Class
  Class
  PUBLIC
  Completes based on a fixed list of words
- twisted.python.usage.CompleteList.__init__
  twisted.python.usage.CompleteList.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.python.usage.CompleteList._items
  twisted.python.usage.CompleteList.html#_items
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.python.usage.CompleteList._shellCode
  twisted.python.usage.CompleteList.html#_shellCode
  Function
  Method
  PRIVATE
  Fetch a fragment of shell code representing this action which is suitable for use by the completion system in _shellcomp.py
- twisted.python.usage.CompleteMultiList
  twisted.python.usage.CompleteMultiList.html
  Class
  Class
  PUBLIC
  Completes multiple comma-separated items based on a fixed list of words
- twisted.python.usage.CompleteMultiList.__init__
  twisted.python.usage.CompleteMultiList.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.python.usage.CompleteMultiList._items
  twisted.python.usage.CompleteMultiList.html#_items
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.python.usage.CompleteMultiList._shellCode
  twisted.python.usage.CompleteMultiList.html#_shellCode
  Function
  Method
  PRIVATE
  Fetch a fragment of shell code representing this action which is suitable for use by the completion system in _shellcomp.py
- twisted.python.usage.CompleteUsernames
  twisted.python.usage.CompleteUsernames.html
  Class
  Class
  PUBLIC
  Complete usernames
- twisted.python.usage.CompleteUsernames._shellCode
  twisted.python.usage.CompleteUsernames.html#_shellCode
  Function
  Method
  PRIVATE
  Fetch a fragment of shell code representing this action which is suitable for use by the completion system in _shellcomp.py
- twisted.python.usage.CompleteGroups
  twisted.python.usage.CompleteGroups.html
  Class
  Class
  PUBLIC
  Complete system group names
- twisted.python.usage.CompleteGroups._descr
  twisted.python.usage.CompleteGroups.html#_descr
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.python.usage.CompleteGroups._shellCode
  twisted.python.usage.CompleteGroups.html#_shellCode
  Function
  Method
  PRIVATE
  Fetch a fragment of shell code representing this action which is suitable for use by the completion system in _shellcomp.py
- twisted.python.usage.CompleteHostnames
  twisted.python.usage.CompleteHostnames.html
  Class
  Class
  PUBLIC
  Complete hostnames
- twisted.python.usage.CompleteHostnames._shellCode
  twisted.python.usage.CompleteHostnames.html#_shellCode
  Function
  Method
  PRIVATE
  Fetch a fragment of shell code representing this action which is suitable for use by the completion system in _shellcomp.py
- twisted.python.usage.CompleteUserAtHost
  twisted.python.usage.CompleteUserAtHost.html
  Class
  Class
  PUBLIC
  A completion action which produces matches in any of these forms:
- twisted.python.usage.CompleteUserAtHost._descr
  twisted.python.usage.CompleteUserAtHost.html#_descr
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.python.usage.CompleteUserAtHost._shellCode
  twisted.python.usage.CompleteUserAtHost.html#_shellCode
  Function
  Method
  PRIVATE
  Fetch a fragment of shell code representing this action which is suitable for use by the completion system in _shellcomp.py
- twisted.python.usage.CompleteNetInterfaces
  twisted.python.usage.CompleteNetInterfaces.html
  Class
  Class
  PUBLIC
  Complete network interface names
- twisted.python.usage.CompleteNetInterfaces._shellCode
  twisted.python.usage.CompleteNetInterfaces.html#_shellCode
  Function
  Method
  PRIVATE
  Fetch a fragment of shell code representing this action which is suitable for use by the completion system in _shellcomp.py
- twisted.python.usage.Completions
  twisted.python.usage.Completions.html
  Class
  Class
  PUBLIC
  Extra metadata for the shell tab-completion system.
- twisted.python.usage.Completions.descriptions
  twisted.python.usage.Completions.html#descriptions
  Attribute
  Instance Variable
  PUBLIC
  ex. `{"foo" : "use this description for foo instead"}` A dict mapping long option names to alternate descriptions. When this variable is defined, the descriptions contained here will override those descriptions provided in the optFlags and optParameters variables.
- twisted.python.usage.Completions.multiUse
  twisted.python.usage.Completions.html#multiUse
  Attribute
  Instance Variable
  PUBLIC
  ex. `["foo", "bar"]` An iterable containing those long option names which may appear on the command line more than once. By default, options will only be completed one time.
- twisted.python.usage.Completions.mutuallyExclusive
  twisted.python.usage.Completions.html#mutuallyExclusive
  Attribute
  Instance Variable
  PUBLIC
  ex. `[("foo", "bar"), ("bar", "baz")]` A sequence of sequences, with each sub-sequence containing those long option names that are mutually exclusive. That is, those options that cannot appear on the command line together.
- twisted.python.usage.Completions.optActions
  twisted.python.usage.Completions.html#optActions
  Attribute
  Instance Variable
  PUBLIC
  A dict mapping long option names to shell "actions". These actions define what may be completed as the argument to the given option. By default, all files/dirs will be completed if no action is given. ...
- twisted.python.usage.Completions.extraActions
  twisted.python.usage.Completions.html#extraActions
  Attribute
  Instance Variable
  PUBLIC
  Extra arguments are those arguments typically appearing at the end of the command-line, which are not associated with any particular named option. That is, the arguments that are given to the parseArgs() method of your usage...
- twisted.python.usage.Completions.__init__
  twisted.python.usage.Completions.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.usage.docMakeChunks
  twisted.python.usage.html#docMakeChunks
  Function
  Function
  PUBLIC
  Makes doc chunks for option declarations.
- twisted.python.usage.flagFunction
  twisted.python.usage.html#flagFunction
  Function
  Function
  PUBLIC
  Determine whether a function is an optional handler for a flag or an option.
- twisted.python.usage.portCoerce
  twisted.python.usage.html#portCoerce
  Function
  Function
  PUBLIC
  Coerce a string value to an int port number, and checks the validity.
- twisted.application.app._BasicProfiler
  twisted.application.app._BasicProfiler.html
  Class
  Class
  PRIVATE
  No summary
- twisted.application.app._BasicProfiler.saveStats
  twisted.application.app._BasicProfiler.html#saveStats
  Attribute
  Instance Variable
  PUBLIC
  if `True`, save the stats information instead of the human readable format
- twisted.application.app._BasicProfiler.profileOutput
  twisted.application.app._BasicProfiler.html#profileOutput
  Attribute
  Instance Variable
  PUBLIC
  the name of the file use to print profile data.
- twisted.application.app._BasicProfiler.__init__
  twisted.application.app._BasicProfiler.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.application.app._BasicProfiler._reportImportError
  twisted.application.app._BasicProfiler.html#_reportImportError
  Function
  Method
  PRIVATE
  Helper method to report an import error with a profile module. This has to be explicit because some of these modules are removed by distributions due to them being non-free.
- twisted.application.app.ProfileRunner
  twisted.application.app.ProfileRunner.html
  Class
  Class
  PUBLIC
  Runner for the standard profile module.
- twisted.application.app.ProfileRunner.run
  twisted.application.app.ProfileRunner.html#run
  Function
  Method
  PUBLIC
  Run reactor under the standard profiler.
- twisted.application.app.CProfileRunner
  twisted.application.app.CProfileRunner.html
  Class
  Class
  PUBLIC
  Runner for the cProfile module.
- twisted.application.app.CProfileRunner.run
  twisted.application.app.CProfileRunner.html#run
  Function
  Method
  PUBLIC
  Run reactor under the cProfile profiler.
- twisted.application.app.AppProfiler
  twisted.application.app.AppProfiler.html
  Class
  Class
  PUBLIC
  Class which selects a specific profile runner based on configuration options.
- twisted.application.app.AppProfiler.profiler
  twisted.application.app.AppProfiler.html#profiler
  Attribute
  Instance Variable
  PUBLIC
  the name of the selected profiler.
- twisted.application.app.AppProfiler.profilers
  twisted.application.app.AppProfiler.html#profilers
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.application.app.AppProfiler.__init__
  twisted.application.app.AppProfiler.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.application.app.AppProfiler.run
  twisted.application.app.AppProfiler.html#run
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.application.app.AppLogger
  twisted.application.app.AppLogger.html
  Class
  Class
  PUBLIC
  An `AppLogger` attaches the configured log observer specified on the commandline to a `ServerOptions` object, a custom `logger.ILogObserver`, or a legacy custom {log.ILogObserver}.
- twisted.application.app.AppLogger._logfilename
  twisted.application.app.AppLogger.html#_logfilename
  Attribute
  Instance Variable
  PRIVATE
  The name of the file to which to log, if other than the default.
- twisted.application.app.AppLogger._observerFactory
  twisted.application.app.AppLogger.html#_observerFactory
  Attribute
  Instance Variable
  PRIVATE
  Callable object that will create a log observer, or None.
- twisted.application.app.AppLogger._observer
  twisted.application.app.AppLogger.html#_observer
  Attribute
  Instance Variable
  PRIVATE
  log observer added at `start` and removed at `stop`.
- twisted.application.app.AppLogger.__init__
  twisted.application.app.AppLogger.html#__init__
  Function
  Method
  PUBLIC
  Initialize an `AppLogger` with a `ServerOptions`.
- twisted.application.app.AppLogger.start
  twisted.application.app.AppLogger.html#start
  Function
  Method
  PUBLIC
  Initialize the global logging system for the given application.
- twisted.application.app.AppLogger._initialLog
  twisted.application.app.AppLogger.html#_initialLog
  Function
  Method
  PRIVATE
  Print twistd start log message.
- twisted.application.app.AppLogger._getLogObserver
  twisted.application.app.AppLogger.html#_getLogObserver
  Function
  Method
  PRIVATE
  Create a log observer to be added to the logging system before running this application.
- twisted.application.app.AppLogger.stop
  twisted.application.app.AppLogger.html#stop
  Function
  Method
  PUBLIC
  Remove all log observers previously set up by `AppLogger.start`.
- twisted.application.app.fixPdb
  twisted.application.app.html#fixPdb
  Function
  Function
  PUBLIC
  Undocumented
- twisted.application.app.runReactorWithLogging
  twisted.application.app.html#runReactorWithLogging
  Function
  Function
  PUBLIC
  Start the reactor, using profiling if specified by the configuration, and log any error happening in the process.
- twisted.application.app.getPassphrase
  twisted.application.app.html#getPassphrase
  Function
  Function
  PUBLIC
  Undocumented
- twisted.application.app.getSavePassphrase
  twisted.application.app.html#getSavePassphrase
  Function
  Function
  PUBLIC
  Undocumented
- twisted.application.app.ApplicationRunner
  twisted.application.app.ApplicationRunner.html
  Class
  Class
  PUBLIC
  An object which helps running an application based on a config object.
- twisted.application.app.ApplicationRunner.config
  twisted.application.app.ApplicationRunner.html#config
  Attribute
  Instance Variable
  PUBLIC
  The config object, which provides a dict-like interface.
- twisted.application.app.ApplicationRunner.application
  twisted.application.app.ApplicationRunner.html#application
  Attribute
  Instance Variable
  PUBLIC
  Available in postApplication, but not preApplication. This is the application object.
- twisted.application.app.ApplicationRunner.profilerFactory
  twisted.application.app.ApplicationRunner.html#profilerFactory
  Attribute
  Instance Variable
  PUBLIC
  Factory for creating a profiler object, able to profile the application if options are set accordingly.
- twisted.application.app.ApplicationRunner.profiler
  twisted.application.app.ApplicationRunner.html#profiler
  Attribute
  Instance Variable
  PUBLIC
  Instance provided by `profilerFactory`.
- twisted.application.app.ApplicationRunner.loggerFactory
  twisted.application.app.ApplicationRunner.html#loggerFactory
  Attribute
  Instance Variable
  PUBLIC
  Factory for creating object responsible for logging.
- twisted.application.app.ApplicationRunner.logger
  twisted.application.app.ApplicationRunner.html#logger
  Attribute
  Instance Variable
  PUBLIC
  Instance provided by `loggerFactory`.
- twisted.application.app.ApplicationRunner.__init__
  twisted.application.app.ApplicationRunner.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.application.app.ApplicationRunner.run
  twisted.application.app.ApplicationRunner.html#run
  Function
  Method
  PUBLIC
  Run the application.
- twisted.application.app.ApplicationRunner.startReactor
  twisted.application.app.ApplicationRunner.html#startReactor
  Function
  Method
  PUBLIC
  Run the reactor with the given configuration. Subclasses should probably call this from `postApplication`.
- twisted.application.app.ApplicationRunner._exitSignal
  twisted.application.app.ApplicationRunner.html#_exitSignal
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.application.app.ApplicationRunner.preApplication
  twisted.application.app.ApplicationRunner.html#preApplication
  Function
  Method
  PUBLIC
  Override in subclass.
- twisted.application.app.ApplicationRunner.postApplication
  twisted.application.app.ApplicationRunner.html#postApplication
  Function
  Method
  PUBLIC
  Override in subclass.
- twisted.application.app.ApplicationRunner.createOrGetApplication
  twisted.application.app.ApplicationRunner.html#createOrGetApplication
  Function
  Method
  PUBLIC
  Create or load an Application based on the parameters found in the given `ServerOptions` instance.
- twisted.application.app.getApplication
  twisted.application.app.html#getApplication
  Function
  Function
  PUBLIC
  Undocumented
- twisted.application.app._reactorAction
  twisted.application.app.html#_reactorAction
  Function
  Function
  PRIVATE
  Undocumented
- twisted.application.app.ReactorSelectionMixin
  twisted.application.app.ReactorSelectionMixin.html
  Class
  Class
  PUBLIC
  Provides options for selecting a reactor to install.
- twisted.application.app.ReactorSelectionMixin.compData
  twisted.application.app.ReactorSelectionMixin.html#compData
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.application.app.ReactorSelectionMixin._getReactorTypes
  twisted.application.app.ReactorSelectionMixin.html#_getReactorTypes
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.application.app.ReactorSelectionMixin.opt_help_reactors
  twisted.application.app.ReactorSelectionMixin.html#opt_help_reactors
  Function
  Method
  PUBLIC
  Display a list of possibly available reactor names.
- twisted.application.app.ReactorSelectionMixin.opt_reactor
  twisted.application.app.ReactorSelectionMixin.html#opt_reactor
  Function
  Method
  PUBLIC
  Which reactor to use (see --help-reactors for a list of possibilities)
- twisted.application.app.ServerOptions
  twisted.application.app.ServerOptions.html
  Class
  Class
  PUBLIC
  No class docstring; 0/1 property, 0/1 instance variable, 0/5 class variable, 2/5 methods documented
- twisted.application.app.ServerOptions.longdesc
  twisted.application.app.ServerOptions.html#longdesc
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.application.app.ServerOptions.optFlags
  twisted.application.app.ServerOptions.html#optFlags
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.application.app.ServerOptions.optParameters
  twisted.application.app.ServerOptions.html#optParameters
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.application.app.ServerOptions.compData
  twisted.application.app.ServerOptions.html#compData
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.application.app.ServerOptions._getPlugins
  twisted.application.app.ServerOptions.html#_getPlugins
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.application.app.ServerOptions.__init__
  twisted.application.app.ServerOptions.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.application.app.ServerOptions.stdout
  twisted.application.app.ServerOptions.html#stdout
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.application.app.ServerOptions.opt_debug
  twisted.application.app.ServerOptions.html#opt_debug
  Function
  Method
  PUBLIC
  Run the application in the Python Debugger (implies nodaemon), sending SIGUSR2 will drop into debugger
- twisted.application.app.ServerOptions.opt_spew
  twisted.application.app.ServerOptions.html#opt_spew
  Function
  Method
  PUBLIC
  Print an insanely verbose log of everything that happens. Useful when debugging freezes or locks in complex code.
- twisted.application.app.ServerOptions.parseOptions
  twisted.application.app.ServerOptions.html#parseOptions
  Function
  Method
  PUBLIC
  The guts of the command-line parser.
- twisted.application.app.ServerOptions.postOptions
  twisted.application.app.ServerOptions.html#postOptions
  Function
  Method
  PUBLIC
  I am called after the options are parsed.
- twisted.application.app.ServerOptions.subCommands
  twisted.application.app.ServerOptions.html#subCommands
  Attribute
  Property
  PUBLIC
  Undocumented
- twisted.application.app.run
  twisted.application.app.html#run
  Function
  Function
  PUBLIC
  Undocumented
- twisted.application.app.convertStyle
  twisted.application.app.html#convertStyle
  Function
  Function
  PUBLIC
  Undocumented
- twisted.application.app.startApplication
  twisted.application.app.html#startApplication
  Function
  Function
  PUBLIC
  Undocumented
- twisted.application.app._exitWithSignal
  twisted.application.app.html#_exitWithSignal
  Function
  Function
  PRIVATE
  Force the application to terminate with the specified signal by replacing the signal handler with the default and sending the signal to ourselves.
- twisted.application.internet._maybeGlobalReactor
  twisted.application.internet.html#_maybeGlobalReactor
  Function
  Function
  PRIVATE
  No summary
- twisted.application.internet._VolatileDataService
  twisted.application.internet._VolatileDataService.html
  Class
  Class
  PRIVATE
  Undocumented
- twisted.application.internet._VolatileDataService.volatile
  twisted.application.internet._VolatileDataService.html#volatile
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.application.internet._VolatileDataService.__getstate__
  twisted.application.internet._VolatileDataService.html#__getstate__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.application.internet._AbstractServer
  twisted.application.internet._AbstractServer.html
  Class
  Class
  PRIVATE
  No summary
- twisted.application.internet._AbstractServer.volatile
  twisted.application.internet._AbstractServer.html#volatile
  Attribute
  Class Variable
  PUBLIC
  list of attribute to remove from pickling.
- twisted.application.internet._AbstractServer.method
  twisted.application.internet._AbstractServer.html#method
  Attribute
  Instance Variable
  PUBLIC
  the type of method to call on the reactor, one of TCP, UDP, SSL or UNIX.
- twisted.application.internet._AbstractServer.reactor
  twisted.application.internet._AbstractServer.html#reactor
  Attribute
  Instance Variable
  PUBLIC
  the current running reactor.
- twisted.application.internet._AbstractServer._port
  twisted.application.internet._AbstractServer.html#_port
  Attribute
  Instance Variable
  PRIVATE
  instance of port set when the service is started.
- twisted.application.internet._AbstractServer.__init__
  twisted.application.internet._AbstractServer.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.application.internet._AbstractServer.args
  twisted.application.internet._AbstractServer.html#args
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.application.internet._AbstractServer.kwargs
  twisted.application.internet._AbstractServer.html#kwargs
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.application.internet._AbstractServer.privilegedStartService
  twisted.application.internet._AbstractServer.html#privilegedStartService
  Function
  Method
  PUBLIC
  Do preparation work for starting the service.
- twisted.application.internet._AbstractServer.startService
  twisted.application.internet._AbstractServer.html#startService
  Function
  Method
  PUBLIC
  Start the service.
- twisted.application.internet._AbstractServer.stopService
  twisted.application.internet._AbstractServer.html#stopService
  Function
  Method
  PUBLIC
  Stop the service.
- twisted.application.internet._AbstractServer._getPort
  twisted.application.internet._AbstractServer.html#_getPort
  Function
  Method
  PRIVATE
  Wrapper around the appropriate listen method of the reactor.
- twisted.application.internet._AbstractClient
  twisted.application.internet._AbstractClient.html
  Class
  Class
  PRIVATE
  No summary
- twisted.application.internet._AbstractClient.volatile
  twisted.application.internet._AbstractClient.html#volatile
  Attribute
  Class Variable
  PUBLIC
  list of attribute to remove from pickling.
- twisted.application.internet._AbstractClient.method
  twisted.application.internet._AbstractClient.html#method
  Attribute
  Instance Variable
  PUBLIC
  the type of method to call on the reactor, one of TCP, UDP, SSL or UNIX.
- twisted.application.internet._AbstractClient.reactor
  twisted.application.internet._AbstractClient.html#reactor
  Attribute
  Instance Variable
  PUBLIC
  the current running reactor.
- twisted.application.internet._AbstractClient._connection
  twisted.application.internet._AbstractClient.html#_connection
  Attribute
  Instance Variable
  PRIVATE
  instance of connection set when the service is started.
- twisted.application.internet._AbstractClient.__init__
  twisted.application.internet._AbstractClient.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.application.internet._AbstractClient.args
  twisted.application.internet._AbstractClient.html#args
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.application.internet._AbstractClient.kwargs
  twisted.application.internet._AbstractClient.html#kwargs
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.application.internet._AbstractClient.startService
  twisted.application.internet._AbstractClient.html#startService
  Function
  Method
  PUBLIC
  Start the service.
- twisted.application.internet._AbstractClient.stopService
  twisted.application.internet._AbstractClient.html#stopService
  Function
  Method
  PUBLIC
  Stop the service.
- twisted.application.internet._AbstractClient._getConnection
  twisted.application.internet._AbstractClient.html#_getConnection
  Function
  Method
  PRIVATE
  Wrapper around the appropriate connect method of the reactor.
- twisted.application.internet._clientDoc
  twisted.application.internet.html#_clientDoc
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.application.internet._serverDoc
  twisted.application.internet.html#_serverDoc
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.application.internet.TCPServer
  twisted.application.internet.TCPServer.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.application.internet.TCPServer.__doc__
  twisted.application.internet.TCPServer.html#__doc__
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.application.internet.TCPServer.method
  twisted.application.internet.TCPServer.html#method
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.application.internet.TCPClient
  twisted.application.internet.TCPClient.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.application.internet.TCPClient.__doc__
  twisted.application.internet.TCPClient.html#__doc__
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.application.internet.TCPClient.method
  twisted.application.internet.TCPClient.html#method
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.application.internet.UNIXServer
  twisted.application.internet.UNIXServer.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.application.internet.UNIXServer.__doc__
  twisted.application.internet.UNIXServer.html#__doc__
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.application.internet.UNIXServer.method
  twisted.application.internet.UNIXServer.html#method
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.application.internet.UNIXClient
  twisted.application.internet.UNIXClient.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.application.internet.UNIXClient.__doc__
  twisted.application.internet.UNIXClient.html#__doc__
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.application.internet.UNIXClient.method
  twisted.application.internet.UNIXClient.html#method
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.application.internet.SSLServer
  twisted.application.internet.SSLServer.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.application.internet.SSLServer.__doc__
  twisted.application.internet.SSLServer.html#__doc__
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.application.internet.SSLServer.method
  twisted.application.internet.SSLServer.html#method
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.application.internet.SSLClient
  twisted.application.internet.SSLClient.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.application.internet.SSLClient.__doc__
  twisted.application.internet.SSLClient.html#__doc__
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.application.internet.SSLClient.method
  twisted.application.internet.SSLClient.html#method
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.application.internet.UDPServer
  twisted.application.internet.UDPServer.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.application.internet.UDPServer.__doc__
  twisted.application.internet.UDPServer.html#__doc__
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.application.internet.UDPServer.method
  twisted.application.internet.UDPServer.html#method
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.application.internet.UNIXDatagramServer
  twisted.application.internet.UNIXDatagramServer.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.application.internet.UNIXDatagramServer.__doc__
  twisted.application.internet.UNIXDatagramServer.html#__doc__
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.application.internet.UNIXDatagramServer.method
  twisted.application.internet.UNIXDatagramServer.html#method
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.application.internet.UNIXDatagramClient
  twisted.application.internet.UNIXDatagramClient.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.application.internet.UNIXDatagramClient.__doc__
  twisted.application.internet.UNIXDatagramClient.html#__doc__
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.application.internet.UNIXDatagramClient.method
  twisted.application.internet.UNIXDatagramClient.html#method
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.application.internet.MulticastServer
  twisted.application.internet.MulticastServer.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.application.internet.MulticastServer.__doc__
  twisted.application.internet.MulticastServer.html#__doc__
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.application.internet.MulticastServer.method
  twisted.application.internet.MulticastServer.html#method
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.application.internet.TimerService
  twisted.application.internet.TimerService.html
  Class
  Class
  PUBLIC
  Service to periodically call a function
- twisted.application.internet.TimerService.clock
  twisted.application.internet.TimerService.html#clock
  Attribute
  Instance Variable
  PUBLIC
  Source of time. This defaults to `None` which is causes `twisted.internet.reactor` to be used. Feel free to set this to something else, but it probably ought to be set *before* calling `startService`.
- twisted.application.internet.TimerService.call
  twisted.application.internet.TimerService.html#call
  Attribute
  Instance Variable
  PUBLIC
  Function and arguments to call periodically.
- twisted.application.internet.TimerService.volatile
  twisted.application.internet.TimerService.html#volatile
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.application.internet.TimerService.__init__
  twisted.application.internet.TimerService.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.application.internet.TimerService.step
  twisted.application.internet.TimerService.html#step
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.application.internet.TimerService.startService
  twisted.application.internet.TimerService.html#startService
  Function
  Method
  PUBLIC
  Start the service.
- twisted.application.internet.TimerService._loop
  twisted.application.internet.TimerService.html#_loop
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.application.internet.TimerService._loopFinished
  twisted.application.internet.TimerService.html#_loopFinished
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.application.internet.TimerService._failed
  twisted.application.internet.TimerService.html#_failed
  Function
  Method
  PRIVATE
  Undocumented
- twisted.application.internet.TimerService.stopService
  twisted.application.internet.TimerService.html#stopService
  Function
  Method
  PUBLIC
  Stop the service.
- twisted.application.internet.CooperatorService
  twisted.application.internet.CooperatorService.html
  Class
  Class
  PUBLIC
  Simple `service.IService` which starts and stops a `twisted.internet.task.Cooperator`.
- twisted.application.internet.CooperatorService.__init__
  twisted.application.internet.CooperatorService.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.application.internet.CooperatorService.coop
  twisted.application.internet.CooperatorService.html#coop
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.application.internet.CooperatorService.coiterate
  twisted.application.internet.CooperatorService.html#coiterate
  Function
  Method
  PUBLIC
  Undocumented
- twisted.application.internet.CooperatorService.startService
  twisted.application.internet.CooperatorService.html#startService
  Function
  Method
  PUBLIC
  Start the service.
- twisted.application.internet.CooperatorService.stopService
  twisted.application.internet.CooperatorService.html#stopService
  Function
  Method
  PUBLIC
  Stop the service.
- twisted.application.internet.StreamServerEndpointService
  twisted.application.internet.StreamServerEndpointService.html
  Class
  Class
  PUBLIC
  A `StreamServerEndpointService` is an `IService` which runs a server on a listening port described by an `IStreamServerEndpoint`.
- twisted.application.internet.StreamServerEndpointService.factory
  twisted.application.internet.StreamServerEndpointService.html#factory
  Attribute
  Instance Variable
  PUBLIC
  A server factory which will be used to listen on the endpoint.
- twisted.application.internet.StreamServerEndpointService.endpoint
  twisted.application.internet.StreamServerEndpointService.html#endpoint
  Attribute
  Instance Variable
  PUBLIC
  An `IStreamServerEndpoint` provider which will be used to listen when the service starts.
- twisted.application.internet.StreamServerEndpointService._waitingForPort
  twisted.application.internet.StreamServerEndpointService.html#_waitingForPort
  Attribute
  Instance Variable
  PRIVATE
  a Deferred, if `listen` has yet been invoked on the endpoint, otherwise None.
- twisted.application.internet.StreamServerEndpointService._raiseSynchronously
  twisted.application.internet.StreamServerEndpointService.html#_raiseSynchronously
  Attribute
  Instance Variable
  PRIVATE
  Defines error-handling behavior for the case where `listen(...)` raises an exception before `startService` or `privilegedStartService` have completed.
- twisted.application.internet.StreamServerEndpointService.__init__
  twisted.application.internet.StreamServerEndpointService.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.application.internet.StreamServerEndpointService.privilegedStartService
  twisted.application.internet.StreamServerEndpointService.html#privilegedStartService
  Function
  Method
  PUBLIC
  Start listening on the endpoint.
- twisted.application.internet.StreamServerEndpointService.startService
  twisted.application.internet.StreamServerEndpointService.html#startService
  Function
  Method
  PUBLIC
  Start listening on the endpoint, unless `privilegedStartService` got around to it already.
- twisted.application.internet.StreamServerEndpointService.stopService
  twisted.application.internet.StreamServerEndpointService.html#stopService
  Function
  Method
  PUBLIC
  Stop listening on the port if it is already listening, otherwise, cancel the attempt to listen.
- twisted.application.internet._ReconnectingProtocolProxy
  twisted.application.internet._ReconnectingProtocolProxy.html
  Class
  Class
  PRIVATE
  A proxy for a Protocol to provide connectionLost notification to a client connection service, in support of reconnecting when connections are lost.
- twisted.application.internet._ReconnectingProtocolProxy.__init__
  twisted.application.internet._ReconnectingProtocolProxy.html#__init__
  Function
  Method
  PUBLIC
  Create a `_ReconnectingProtocolProxy`.
- twisted.application.internet._ReconnectingProtocolProxy._protocol
  twisted.application.internet._ReconnectingProtocolProxy.html#_protocol
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.application.internet._ReconnectingProtocolProxy._lostNotification
  twisted.application.internet._ReconnectingProtocolProxy.html#_lostNotification
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.application.internet._ReconnectingProtocolProxy.connectionLost
  twisted.application.internet._ReconnectingProtocolProxy.html#connectionLost
  Function
  Method
  PUBLIC
  The connection was lost. Relay this information.
- twisted.application.internet._ReconnectingProtocolProxy.__getattr__
  twisted.application.internet._ReconnectingProtocolProxy.html#__getattr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.application.internet._ReconnectingProtocolProxy.__repr__
  twisted.application.internet._ReconnectingProtocolProxy.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.application.internet._DisconnectFactory
  twisted.application.internet._DisconnectFactory.html
  Class
  Class
  PRIVATE
  A `_DisconnectFactory` is a proxy for `IProtocolFactory` that catches `connectionLost` notifications and relays them.
- twisted.application.internet._DisconnectFactory.__init__
  twisted.application.internet._DisconnectFactory.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.application.internet._DisconnectFactory._protocolFactory
  twisted.application.internet._DisconnectFactory.html#_protocolFactory
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.application.internet._DisconnectFactory._protocolDisconnected
  twisted.application.internet._DisconnectFactory.html#_protocolDisconnected
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.application.internet._DisconnectFactory.buildProtocol
  twisted.application.internet._DisconnectFactory.html#buildProtocol
  Function
  Method
  PUBLIC
  Create a `_ReconnectingProtocolProxy` with the disconnect-notification callback we were called with.
- twisted.application.internet._DisconnectFactory.__getattr__
  twisted.application.internet._DisconnectFactory.html#__getattr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.application.internet._DisconnectFactory.__repr__
  twisted.application.internet._DisconnectFactory.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.application.internet.backoffPolicy
  twisted.application.internet.html#backoffPolicy
  Function
  Function
  PUBLIC
  A timeout policy for `ClientService` which computes an exponential backoff interval with configurable parameters.
- twisted.application.internet._defaultPolicy
  twisted.application.internet.html#_defaultPolicy
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.application.internet._firstResult
  twisted.application.internet.html#_firstResult
  Function
  Function
  PRIVATE
  Return the first element of a generator and exhaust it.
- twisted.application.internet._ClientMachine
  twisted.application.internet._ClientMachine.html
  Class
  Class
  PRIVATE
  State machine for maintaining a single outgoing connection to an endpoint.
- twisted.application.internet._ClientMachine._awaitingConnected
  twisted.application.internet._ClientMachine.html#_awaitingConnected
  Attribute
  Instance Variable
  PRIVATE
  notifications to make when connection succeeds, fails, or is cancelled
- twisted.application.internet._ClientMachine._machine
  twisted.application.internet._ClientMachine.html#_machine
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.application.internet._ClientMachine.__init__
  twisted.application.internet._ClientMachine.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.application.internet._ClientMachine._endpoint
  twisted.application.internet._ClientMachine.html#_endpoint
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.application.internet._ClientMachine._failedAttempts
  twisted.application.internet._ClientMachine.html#_failedAttempts
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.application.internet._ClientMachine._factory
  twisted.application.internet._ClientMachine.html#_factory
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.application.internet._ClientMachine._timeoutForAttempt
  twisted.application.internet._ClientMachine.html#_timeoutForAttempt
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.application.internet._ClientMachine._clock
  twisted.application.internet._ClientMachine.html#_clock
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.application.internet._ClientMachine._prepareConnection
  twisted.application.internet._ClientMachine.html#_prepareConnection
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.application.internet._ClientMachine._connectionInProgress
  twisted.application.internet._ClientMachine.html#_connectionInProgress
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.application.internet._ClientMachine._stopWaiters
  twisted.application.internet._ClientMachine.html#_stopWaiters
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.application.internet._ClientMachine._log
  twisted.application.internet._ClientMachine.html#_log
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.application.internet._ClientMachine._init
  twisted.application.internet._ClientMachine.html#_init
  Function
  Method
  PRIVATE
  The service has not been started.
- twisted.application.internet._ClientMachine._connecting
  twisted.application.internet._ClientMachine.html#_connecting
  Function
  Method
  PRIVATE
  The service has started connecting.
- twisted.application.internet._ClientMachine._waiting
  twisted.application.internet._ClientMachine.html#_waiting
  Function
  Method
  PRIVATE
  The service is waiting for the reconnection period before reconnecting.
- twisted.application.internet._ClientMachine._connected
  twisted.application.internet._ClientMachine.html#_connected
  Function
  Method
  PRIVATE
  The service is connected.
- twisted.application.internet._ClientMachine._disconnecting
  twisted.application.internet._ClientMachine.html#_disconnecting
  Function
  Method
  PRIVATE
  The service is disconnecting after being asked to shutdown.
- twisted.application.internet._ClientMachine._restarting
  twisted.application.internet._ClientMachine.html#_restarting
  Function
  Method
  PRIVATE
  The service is disconnecting and has been asked to restart.
- twisted.application.internet._ClientMachine._stopped 0
  twisted.application.internet._ClientMachine.html#_stopped%200
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.application.internet._ClientMachine._stopped
  twisted.application.internet._ClientMachine.html#_stopped
  Function
  Method
  PRIVATE
  The service has been stopped and is disconnected.
- twisted.application.internet._ClientMachine.start
  twisted.application.internet._ClientMachine.html#start
  Function
  Method
  PUBLIC
  Start this `ClientService`, initiating the connection retry loop.
- twisted.application.internet._ClientMachine._connect
  twisted.application.internet._ClientMachine.html#_connect
  Function
  Method
  PRIVATE
  Start a connection attempt.
- twisted.application.internet._ClientMachine._runPrepareConnection
  twisted.application.internet._ClientMachine.html#_runPrepareConnection
  Function
  Method
  PRIVATE
  Run any `prepareConnection` callback with the connected protocol, ignoring its return value but propagating any failure.
- twisted.application.internet._ClientMachine._resetFailedAttempts
  twisted.application.internet._ClientMachine.html#_resetFailedAttempts
  Function
  Method
  PRIVATE
  Reset the number of failed attempts.
- twisted.application.internet._ClientMachine.stop
  twisted.application.internet._ClientMachine.html#stop
  Function
  Method
  PUBLIC
  Stop trying to connect and disconnect any current connection.
- twisted.application.internet._ClientMachine._waitForStop
  twisted.application.internet._ClientMachine.html#_waitForStop
  Function
  Method
  PRIVATE
  Return a deferred that will fire when the service has finished disconnecting.
- twisted.application.internet._ClientMachine._stopConnecting
  twisted.application.internet._ClientMachine.html#_stopConnecting
  Function
  Method
  PRIVATE
  Stop pending connection attempt.
- twisted.application.internet._ClientMachine._stopRetrying
  twisted.application.internet._ClientMachine.html#_stopRetrying
  Function
  Method
  PRIVATE
  Stop pending attempt to reconnect.
- twisted.application.internet._ClientMachine._disconnect
  twisted.application.internet._ClientMachine.html#_disconnect
  Function
  Method
  PRIVATE
  Disconnect the current connection.
- twisted.application.internet._ClientMachine._connectionMade
  twisted.application.internet._ClientMachine.html#_connectionMade
  Function
  Method
  PRIVATE
  A connection has been made.
- twisted.application.internet._ClientMachine._notifyWaiters
  twisted.application.internet._ClientMachine.html#_notifyWaiters
  Function
  Method
  PRIVATE
  Notify all pending requests for a connection that a connection has been made.
- twisted.application.internet._ClientMachine._connectionFailed
  twisted.application.internet._ClientMachine.html#_connectionFailed
  Function
  Method
  PRIVATE
  The current connection attempt failed.
- twisted.application.internet._ClientMachine._wait
  twisted.application.internet._ClientMachine.html#_wait
  Function
  Method
  PRIVATE
  Schedule a retry attempt.
- twisted.application.internet._ClientMachine._ignoreAndWait
  twisted.application.internet._ClientMachine.html#_ignoreAndWait
  Function
  Method
  PRIVATE
  Schedule a retry attempt, and ignore the Failure passed in.
- twisted.application.internet._ClientMachine._doWait
  twisted.application.internet._ClientMachine.html#_doWait
  Function
  Method
  PRIVATE
  Undocumented
- twisted.application.internet._ClientMachine._retryCall
  twisted.application.internet._ClientMachine.html#_retryCall
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.application.internet._ClientMachine._reconnect
  twisted.application.internet._ClientMachine.html#_reconnect
  Function
  Method
  PRIVATE
  The wait between connection attempts is done.
- twisted.application.internet._ClientMachine._clientDisconnected
  twisted.application.internet._ClientMachine.html#_clientDisconnected
  Function
  Method
  PRIVATE
  The current connection has been disconnected.
- twisted.application.internet._ClientMachine._forgetConnection
  twisted.application.internet._ClientMachine.html#_forgetConnection
  Function
  Method
  PRIVATE
  Forget the current connection.
- twisted.application.internet._ClientMachine._cancelConnectWaiters
  twisted.application.internet._ClientMachine.html#_cancelConnectWaiters
  Function
  Method
  PRIVATE
  Notify all pending requests for a connection that no more connections are expected.
- twisted.application.internet._ClientMachine._ignoreAndCancelConnectWaiters
  twisted.application.internet._ClientMachine.html#_ignoreAndCancelConnectWaiters
  Function
  Method
  PRIVATE
  Notify all pending requests for a connection that no more connections are expected, after ignoring the Failure passed in.
- twisted.application.internet._ClientMachine._finishStopping
  twisted.application.internet._ClientMachine.html#_finishStopping
  Function
  Method
  PRIVATE
  Notify all deferreds waiting on the service stopping.
- twisted.application.internet._ClientMachine._ignoreAndFinishStopping
  twisted.application.internet._ClientMachine.html#_ignoreAndFinishStopping
  Function
  Method
  PRIVATE
  Notify all deferreds waiting on the service stopping, and ignore the Failure passed in.
- twisted.application.internet._ClientMachine._doFinishStopping
  twisted.application.internet._ClientMachine.html#_doFinishStopping
  Function
  Method
  PRIVATE
  Undocumented
- twisted.application.internet._ClientMachine.whenConnected
  twisted.application.internet._ClientMachine.html#whenConnected
  Function
  Method
  PUBLIC
  Retrieve the currently-connected `Protocol`, or the next one to connect.
- twisted.application.internet._ClientMachine._currentConnection 0
  twisted.application.internet._ClientMachine.html#_currentConnection%200
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.application.internet._ClientMachine._currentConnection
  twisted.application.internet._ClientMachine.html#_currentConnection
  Function
  Method
  PRIVATE
  Return the currently connected protocol.
- twisted.application.internet._ClientMachine._noConnection
  twisted.application.internet._ClientMachine.html#_noConnection
  Function
  Method
  PRIVATE
  Notify the caller that no connection is expected.
- twisted.application.internet._ClientMachine._awaitingConnection
  twisted.application.internet._ClientMachine.html#_awaitingConnection
  Function
  Method
  PRIVATE
  Return a deferred that will fire with the next connected protocol.
- twisted.application.internet._ClientMachine._deferredSucceededWithNone
  twisted.application.internet._ClientMachine.html#_deferredSucceededWithNone
  Function
  Method
  PRIVATE
  Return a deferred that has already fired with `None`.
- twisted.application.internet._ClientMachine._unawait
  twisted.application.internet._ClientMachine.html#_unawait
  Function
  Method
  PRIVATE
  Fire all outstanding `ClientService.whenConnected` `Deferred`s.
- twisted.application.internet._ClientMachine._deliverConnectionFailure
  twisted.application.internet._ClientMachine.html#_deliverConnectionFailure
  Function
  Method
  PRIVATE
  Deliver connection failures to any `ClientService.whenConnected` `Deferred`s that have met their failAfterFailures threshold.
- twisted.application.internet.ClientService
  twisted.application.internet.ClientService.html
  Class
  Class
  PUBLIC
  A `ClientService` maintains a single outgoing connection to a client endpoint, reconnecting after a configurable timeout when a connection fails, either before or after connecting.
- twisted.application.internet.ClientService._log
  twisted.application.internet.ClientService.html#_log
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.application.internet.ClientService.__init__
  twisted.application.internet.ClientService.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.application.internet.ClientService._machine
  twisted.application.internet.ClientService.html#_machine
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.application.internet.ClientService.whenConnected
  twisted.application.internet.ClientService.html#whenConnected
  Function
  Method
  PUBLIC
  Retrieve the currently-connected `Protocol`, or the next one to connect.
- twisted.application.internet.ClientService.startService
  twisted.application.internet.ClientService.html#startService
  Function
  Method
  PUBLIC
  Start this `ClientService`, initiating the connection retry loop.
- twisted.application.internet.ClientService.stopService
  twisted.application.internet.ClientService.html#stopService
  Function
  Method
  PUBLIC
  Stop attempting to reconnect and close any existing connections.
- twisted.application.runner._exit.ExitStatus
  twisted.application.runner._exit.ExitStatus.html
  Class
  Class
  PUBLIC
  Standard exit status codes for system programs.
- twisted.application.runner._exit.ExitStatus.EX_OK
  twisted.application.runner._exit.ExitStatus.html#EX_OK
  Attribute
  Constant
  PUBLIC
  Successful termination.
- twisted.application.runner._exit.ExitStatus.EX_USAGE
  twisted.application.runner._exit.ExitStatus.html#EX_USAGE
  Attribute
  Constant
  PUBLIC
  Command line usage error.
- twisted.application.runner._exit.ExitStatus.EX_DATAERR
  twisted.application.runner._exit.ExitStatus.html#EX_DATAERR
  Attribute
  Constant
  PUBLIC
  Data format error.
- twisted.application.runner._exit.ExitStatus.EX_NOINPUT
  twisted.application.runner._exit.ExitStatus.html#EX_NOINPUT
  Attribute
  Constant
  PUBLIC
  Cannot open input.
- twisted.application.runner._exit.ExitStatus.EX_NOUSER
  twisted.application.runner._exit.ExitStatus.html#EX_NOUSER
  Attribute
  Constant
  PUBLIC
  Addressee unknown.
- twisted.application.runner._exit.ExitStatus.EX_NOHOST
  twisted.application.runner._exit.ExitStatus.html#EX_NOHOST
  Attribute
  Constant
  PUBLIC
  Host name unknown.
- twisted.application.runner._exit.ExitStatus.EX_UNAVAILABLE
  twisted.application.runner._exit.ExitStatus.html#EX_UNAVAILABLE
  Attribute
  Constant
  PUBLIC
  Service unavailable.
- twisted.application.runner._exit.ExitStatus.EX_SOFTWARE
  twisted.application.runner._exit.ExitStatus.html#EX_SOFTWARE
  Attribute
  Constant
  PUBLIC
  Internal software error.
- twisted.application.runner._exit.ExitStatus.EX_OSERR
  twisted.application.runner._exit.ExitStatus.html#EX_OSERR
  Attribute
  Constant
  PUBLIC
  System error (e.g., can't fork).
- twisted.application.runner._exit.ExitStatus.EX_OSFILE
  twisted.application.runner._exit.ExitStatus.html#EX_OSFILE
  Attribute
  Constant
  PUBLIC
  Critical OS file missing.
- twisted.application.runner._exit.ExitStatus.EX_CANTCREAT
  twisted.application.runner._exit.ExitStatus.html#EX_CANTCREAT
  Attribute
  Constant
  PUBLIC
  Can't create (user) output file.
- twisted.application.runner._exit.ExitStatus.EX_IOERR
  twisted.application.runner._exit.ExitStatus.html#EX_IOERR
  Attribute
  Constant
  PUBLIC
  Input/output error.
- twisted.application.runner._exit.ExitStatus.EX_TEMPFAIL
  twisted.application.runner._exit.ExitStatus.html#EX_TEMPFAIL
  Attribute
  Constant
  PUBLIC
  Temporary failure; the user is invited to retry.
- twisted.application.runner._exit.ExitStatus.EX_PROTOCOL
  twisted.application.runner._exit.ExitStatus.html#EX_PROTOCOL
  Attribute
  Constant
  PUBLIC
  Remote error in protocol.
- twisted.application.runner._exit.ExitStatus.EX_NOPERM
  twisted.application.runner._exit.ExitStatus.html#EX_NOPERM
  Attribute
  Constant
  PUBLIC
  Permission denied.
- twisted.application.runner._exit.ExitStatus.EX_CONFIG
  twisted.application.runner._exit.ExitStatus.html#EX_CONFIG
  Attribute
  Constant
  PUBLIC
  Configuration error.
- twisted.application.runner._exit.exit
  twisted.application.runner._exit.html#exit
  Function
  Function
  PUBLIC
  Exit the python interpreter with the given status and an optional message.
- twisted.application.runner._pidfile.IPIDFile
  twisted.application.runner._pidfile.IPIDFile.html
  Class
  Interface
  PUBLIC
  Manages a file that remembers a process ID.
- twisted.application.runner._pidfile.IPIDFile.read
  twisted.application.runner._pidfile.IPIDFile.html#read
  Function
  Method
  PUBLIC
  Read the process ID stored in this PID file.
- twisted.application.runner._pidfile.IPIDFile.writeRunningPID
  twisted.application.runner._pidfile.IPIDFile.html#writeRunningPID
  Function
  Method
  PUBLIC
  Store the PID of the current process in this PID file.
- twisted.application.runner._pidfile.IPIDFile.remove
  twisted.application.runner._pidfile.IPIDFile.html#remove
  Function
  Method
  PUBLIC
  Remove this PID file.
- twisted.application.runner._pidfile.IPIDFile.isRunning
  twisted.application.runner._pidfile.IPIDFile.html#isRunning
  Function
  Method
  PUBLIC
  Determine whether there is a running process corresponding to the PID in this PID file.
- twisted.application.runner._pidfile.IPIDFile.__enter__
  twisted.application.runner._pidfile.IPIDFile.html#__enter__
  Function
  Method
  PUBLIC
  Enter a context using this PIDFile.
- twisted.application.runner._pidfile.IPIDFile.__exit__
  twisted.application.runner._pidfile.IPIDFile.html#__exit__
  Function
  Method
  PUBLIC
  Exit a context using this PIDFile.
- twisted.application.runner._pidfile.PIDFile
  twisted.application.runner._pidfile.PIDFile.html
  Class
  Class
  PUBLIC
  Concrete implementation of `IPIDFile`.
- twisted.application.runner._pidfile.PIDFile._log
  twisted.application.runner._pidfile.PIDFile.html#_log
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.application.runner._pidfile.PIDFile._format
  twisted.application.runner._pidfile.PIDFile.html#_format
  Function
  Static Method
  PRIVATE
  Format a PID file's content.
- twisted.application.runner._pidfile.PIDFile.__init__
  twisted.application.runner._pidfile.PIDFile.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.application.runner._pidfile.PIDFile.filePath
  twisted.application.runner._pidfile.PIDFile.html#filePath
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.application.runner._pidfile.PIDFile.read
  twisted.application.runner._pidfile.PIDFile.html#read
  Function
  Method
  PUBLIC
  Read the process ID stored in this PID file.
- twisted.application.runner._pidfile.PIDFile._write
  twisted.application.runner._pidfile.PIDFile.html#_write
  Function
  Method
  PRIVATE
  Store a PID in this PID file.
- twisted.application.runner._pidfile.PIDFile.writeRunningPID
  twisted.application.runner._pidfile.PIDFile.html#writeRunningPID
  Function
  Method
  PUBLIC
  Store the PID of the current process in this PID file.
- twisted.application.runner._pidfile.PIDFile.remove
  twisted.application.runner._pidfile.PIDFile.html#remove
  Function
  Method
  PUBLIC
  Remove this PID file.
- twisted.application.runner._pidfile.PIDFile.isRunning
  twisted.application.runner._pidfile.PIDFile.html#isRunning
  Function
  Method
  PUBLIC
  Determine whether there is a running process corresponding to the PID in this PID file.
- twisted.application.runner._pidfile.PIDFile._pidIsRunningPOSIX
  twisted.application.runner._pidfile.PIDFile.html#_pidIsRunningPOSIX
  Function
  Static Method
  PRIVATE
  POSIX implementation for running process check.
- twisted.application.runner._pidfile.PIDFile.__enter__
  twisted.application.runner._pidfile.PIDFile.html#__enter__
  Function
  Method
  PUBLIC
  Enter a context using this PIDFile.
- twisted.application.runner._pidfile.PIDFile.__exit__
  twisted.application.runner._pidfile.PIDFile.html#__exit__
  Function
  Method
  PUBLIC
  Exit a context using this PIDFile.
- twisted.application.runner._pidfile.NonePIDFile
  twisted.application.runner._pidfile.NonePIDFile.html
  Class
  Class
  PUBLIC
  PID file implementation that does nothing.
- twisted.application.runner._pidfile.NonePIDFile.__init__
  twisted.application.runner._pidfile.NonePIDFile.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.application.runner._pidfile.NonePIDFile.read
  twisted.application.runner._pidfile.NonePIDFile.html#read
  Function
  Method
  PUBLIC
  Read the process ID stored in this PID file.
- twisted.application.runner._pidfile.NonePIDFile._write
  twisted.application.runner._pidfile.NonePIDFile.html#_write
  Function
  Method
  PRIVATE
  Store a PID in this PID file.
- twisted.application.runner._pidfile.NonePIDFile.writeRunningPID
  twisted.application.runner._pidfile.NonePIDFile.html#writeRunningPID
  Function
  Method
  PUBLIC
  Store the PID of the current process in this PID file.
- twisted.application.runner._pidfile.NonePIDFile.remove
  twisted.application.runner._pidfile.NonePIDFile.html#remove
  Function
  Method
  PUBLIC
  Remove this PID file.
- twisted.application.runner._pidfile.NonePIDFile.isRunning
  twisted.application.runner._pidfile.NonePIDFile.html#isRunning
  Function
  Method
  PUBLIC
  Determine whether there is a running process corresponding to the PID in this PID file.
- twisted.application.runner._pidfile.NonePIDFile.__enter__
  twisted.application.runner._pidfile.NonePIDFile.html#__enter__
  Function
  Method
  PUBLIC
  Enter a context using this PIDFile.
- twisted.application.runner._pidfile.NonePIDFile.__exit__
  twisted.application.runner._pidfile.NonePIDFile.html#__exit__
  Function
  Method
  PUBLIC
  Exit a context using this PIDFile.
- twisted.application.runner._pidfile.nonePIDFile
  twisted.application.runner._pidfile.html#nonePIDFile
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.application.runner._pidfile.AlreadyRunningError
  twisted.application.runner._pidfile.AlreadyRunningError.html
  Class
  Exception
  PUBLIC
  Process is already running.
- twisted.application.runner._pidfile.InvalidPIDFileError
  twisted.application.runner._pidfile.InvalidPIDFileError.html
  Class
  Exception
  PUBLIC
  PID file contents are invalid.
- twisted.application.runner._pidfile.StalePIDFileError
  twisted.application.runner._pidfile.StalePIDFileError.html
  Class
  Exception
  PUBLIC
  PID file contents are valid, but there is no process with the referenced PID.
- twisted.application.runner._pidfile.NoPIDFound
  twisted.application.runner._pidfile.NoPIDFound.html
  Class
  Exception
  PUBLIC
  No PID found in PID file.
- twisted.application.runner._runner.Runner
  twisted.application.runner._runner.Runner.html
  Class
  Class
  PUBLIC
  Twisted application runner.
- twisted.application.runner._runner.Runner._log
  twisted.application.runner._runner.Runner.html#_log
  Attribute
  Class Variable
  PRIVATE
  The logger attached to this class.
- twisted.application.runner._runner.Runner._reactor
  twisted.application.runner._runner.Runner.html#_reactor
  Attribute
  Instance Variable
  PRIVATE
  The reactor to start and run the application in.
- twisted.application.runner._runner.Runner._pidFile
  twisted.application.runner._runner.Runner.html#_pidFile
  Attribute
  Instance Variable
  PRIVATE
  The file to store the running process ID in.
- twisted.application.runner._runner.Runner._kill
  twisted.application.runner._runner.Runner.html#_kill
  Attribute
  Instance Variable
  PRIVATE
  Whether this runner should kill an existing running instance of the application.
- twisted.application.runner._runner.Runner._defaultLogLevel
  twisted.application.runner._runner.Runner.html#_defaultLogLevel
  Attribute
  Instance Variable
  PRIVATE
  The default log level to start the logging system with.
- twisted.application.runner._runner.Runner._logFile
  twisted.application.runner._runner.Runner.html#_logFile
  Attribute
  Instance Variable
  PRIVATE
  A file stream to write logging output to.
- twisted.application.runner._runner.Runner._fileLogObserverFactory
  twisted.application.runner._runner.Runner.html#_fileLogObserverFactory
  Attribute
  Instance Variable
  PRIVATE
  A factory for the file log observer to use when starting the logging system.
- twisted.application.runner._runner.Runner._whenRunning
  twisted.application.runner._runner.Runner.html#_whenRunning
  Attribute
  Instance Variable
  PRIVATE
  Hook to call after the reactor is running; this is where the application code that relies on the reactor gets called.
- twisted.application.runner._runner.Runner._whenRunningArguments
  twisted.application.runner._runner.Runner.html#_whenRunningArguments
  Attribute
  Instance Variable
  PRIVATE
  Keyword arguments to pass to `whenRunning` when it is called.
- twisted.application.runner._runner.Runner._reactorExited
  twisted.application.runner._runner.Runner.html#_reactorExited
  Attribute
  Instance Variable
  PRIVATE
  Hook to call after the reactor exits.
- twisted.application.runner._runner.Runner._reactorExitedArguments
  twisted.application.runner._runner.Runner.html#_reactorExitedArguments
  Attribute
  Instance Variable
  PRIVATE
  Keyword arguments to pass to `reactorExited` when it is called.
- twisted.application.runner._runner.Runner.run
  twisted.application.runner._runner.Runner.html#run
  Function
  Method
  PUBLIC
  Run this command.
- twisted.application.runner._runner.Runner.killIfRequested
  twisted.application.runner._runner.Runner.html#killIfRequested
  Function
  Method
  PUBLIC
  If `self._kill` is true, attempt to kill a running instance of the application.
- twisted.application.runner._runner.Runner.startLogging
  twisted.application.runner._runner.Runner.html#startLogging
  Function
  Method
  PUBLIC
  Start the `twisted.logger` logging system.
- twisted.application.runner._runner.Runner.startReactor
  twisted.application.runner._runner.Runner.html#startReactor
  Function
  Method
  PUBLIC
  Register `self._whenRunning` with the reactor so that it is called once the reactor is running, then start the reactor.
- twisted.application.runner._runner.Runner.whenRunning
  twisted.application.runner._runner.Runner.html#whenRunning
  Function
  Method
  PUBLIC
  Call `self._whenRunning` with `self._whenRunningArguments`.
- twisted.application.runner._runner.Runner.reactorExited
  twisted.application.runner._runner.Runner.html#reactorExited
  Function
  Method
  PUBLIC
  Call `self._reactorExited` with `self._reactorExitedArguments`.
- twisted.protocols.basic._formatNetstring
  twisted.protocols.basic.html#_formatNetstring
  Function
  Function
  PRIVATE
  Convert some `bytes` into netstring format.
- twisted.protocols.basic.DEBUG
  twisted.protocols.basic.html#DEBUG
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.basic.NetstringParseError
  twisted.protocols.basic.NetstringParseError.html
  Class
  Exception
  PUBLIC
  The incoming data is not in valid Netstring format.
- twisted.protocols.basic.IncompleteNetstring
  twisted.protocols.basic.IncompleteNetstring.html
  Class
  Exception
  PUBLIC
  Not enough data to complete a netstring.
- twisted.protocols.basic.NetstringReceiver
  twisted.protocols.basic.NetstringReceiver.html
  Class
  Class
  PUBLIC
  A protocol that sends and receives netstrings.
- twisted.protocols.basic.NetstringReceiver.MAX_LENGTH
  twisted.protocols.basic.NetstringReceiver.html#MAX_LENGTH
  Attribute
  Constant
  PUBLIC
  Defines the maximum length of netstrings that can be received.
- twisted.protocols.basic.NetstringReceiver._LENGTH
  twisted.protocols.basic.NetstringReceiver.html#_LENGTH
  Attribute
  Constant
  PRIVATE
  A pattern describing all strings that contain a netstring length specification. Examples for length specifications are `b'0:'`, `b'12:'`, and `b'179:'`. `b'007:'` is not a valid length specification, since leading zeros are not allowed.
- twisted.protocols.basic.NetstringReceiver._LENGTH_PREFIX
  twisted.protocols.basic.NetstringReceiver.html#_LENGTH_PREFIX
  Attribute
  Constant
  PRIVATE
  A pattern describing all strings that contain the first part of a netstring length specification (without the trailing comma). Examples are '0', '12', and '179'. '007' does not start a netstring length specification, since leading zeros are not allowed.
- twisted.protocols.basic.NetstringReceiver._PARSING_LENGTH
  twisted.protocols.basic.NetstringReceiver.html#_PARSING_LENGTH
  Attribute
  Constant
  PRIVATE
  Indicates that the `NetstringReceiver` is in the state of parsing the length portion of a netstring.
- twisted.protocols.basic.NetstringReceiver._PARSING_PAYLOAD
  twisted.protocols.basic.NetstringReceiver.html#_PARSING_PAYLOAD
  Attribute
  Constant
  PRIVATE
  Indicates that the `NetstringReceiver` is in the state of parsing the payload portion (data and trailing comma) of a netstring.
- twisted.protocols.basic.NetstringReceiver.brokenPeer
  twisted.protocols.basic.NetstringReceiver.html#brokenPeer
  Attribute
  Instance Variable
  PUBLIC
  Indicates if the connection is still functional
- twisted.protocols.basic.NetstringReceiver._state
  twisted.protocols.basic.NetstringReceiver.html#_state
  Attribute
  Instance Variable
  PRIVATE
  Indicates if the protocol is consuming the length portion (`PARSING_LENGTH`) or the payload (`PARSING_PAYLOAD`) of a netstring
- twisted.protocols.basic.NetstringReceiver._remainingData
  twisted.protocols.basic.NetstringReceiver.html#_remainingData
  Attribute
  Instance Variable
  PRIVATE
  Holds the chunk of data that has not yet been consumed
- twisted.protocols.basic.NetstringReceiver._payload
  twisted.protocols.basic.NetstringReceiver.html#_payload
  Attribute
  Instance Variable
  PRIVATE
  Holds the payload portion of a netstring including the trailing comma
- twisted.protocols.basic.NetstringReceiver._expectedPayloadSize
  twisted.protocols.basic.NetstringReceiver.html#_expectedPayloadSize
  Attribute
  Instance Variable
  PRIVATE
  Holds the payload size plus one for the trailing comma.
- twisted.protocols.basic.NetstringReceiver._MISSING_LENGTH
  twisted.protocols.basic.NetstringReceiver.html#_MISSING_LENGTH
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.protocols.basic.NetstringReceiver._OVERFLOW
  twisted.protocols.basic.NetstringReceiver.html#_OVERFLOW
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.protocols.basic.NetstringReceiver._TOO_LONG
  twisted.protocols.basic.NetstringReceiver.html#_TOO_LONG
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.protocols.basic.NetstringReceiver._MISSING_COMMA
  twisted.protocols.basic.NetstringReceiver.html#_MISSING_COMMA
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.protocols.basic.NetstringReceiver.makeConnection
  twisted.protocols.basic.NetstringReceiver.html#makeConnection
  Function
  Method
  PUBLIC
  Initializes the protocol.
- twisted.protocols.basic.NetstringReceiver._currentPayloadSize
  twisted.protocols.basic.NetstringReceiver.html#_currentPayloadSize
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.protocols.basic.NetstringReceiver.sendString
  twisted.protocols.basic.NetstringReceiver.html#sendString
  Function
  Method
  PUBLIC
  Sends a netstring.
- twisted.protocols.basic.NetstringReceiver.dataReceived
  twisted.protocols.basic.NetstringReceiver.html#dataReceived
  Function
  Method
  PUBLIC
  Receives some characters of a netstring.
- twisted.protocols.basic.NetstringReceiver.stringReceived
  twisted.protocols.basic.NetstringReceiver.html#stringReceived
  Function
  Method
  PUBLIC
  Override this for notification when each complete string is received.
- twisted.protocols.basic.NetstringReceiver._maxLengthSize
  twisted.protocols.basic.NetstringReceiver.html#_maxLengthSize
  Function
  Method
  PRIVATE
  Calculate and return the string size of `self.MAX_LENGTH`.
- twisted.protocols.basic.NetstringReceiver._consumeData
  twisted.protocols.basic.NetstringReceiver.html#_consumeData
  Function
  Method
  PRIVATE
  Consumes the content of `self._remainingData`.
- twisted.protocols.basic.NetstringReceiver._consumeLength
  twisted.protocols.basic.NetstringReceiver.html#_consumeLength
  Function
  Method
  PRIVATE
  Consumes the length portion of `self._remainingData`.
- twisted.protocols.basic.NetstringReceiver._checkPartialLengthSpecification
  twisted.protocols.basic.NetstringReceiver.html#_checkPartialLengthSpecification
  Function
  Method
  PRIVATE
  Makes sure that the received data represents a valid number.
- twisted.protocols.basic.NetstringReceiver._processLength
  twisted.protocols.basic.NetstringReceiver.html#_processLength
  Function
  Method
  PRIVATE
  Processes the length definition of a netstring.
- twisted.protocols.basic.NetstringReceiver._extractLength
  twisted.protocols.basic.NetstringReceiver.html#_extractLength
  Function
  Method
  PRIVATE
  Attempts to extract the length information of a netstring.
- twisted.protocols.basic.NetstringReceiver._checkStringSize
  twisted.protocols.basic.NetstringReceiver.html#_checkStringSize
  Function
  Method
  PRIVATE
  Checks the sanity of lengthAsString.
- twisted.protocols.basic.NetstringReceiver._prepareForPayloadConsumption
  twisted.protocols.basic.NetstringReceiver.html#_prepareForPayloadConsumption
  Function
  Method
  PRIVATE
  Sets up variables necessary for consuming the payload of a netstring.
- twisted.protocols.basic.NetstringReceiver._consumePayload
  twisted.protocols.basic.NetstringReceiver.html#_consumePayload
  Function
  Method
  PRIVATE
  Consumes the payload portion of `self._remainingData`.
- twisted.protocols.basic.NetstringReceiver._extractPayload
  twisted.protocols.basic.NetstringReceiver.html#_extractPayload
  Function
  Method
  PRIVATE
  Extracts payload information from `self._remainingData`.
- twisted.protocols.basic.NetstringReceiver._payloadComplete
  twisted.protocols.basic.NetstringReceiver.html#_payloadComplete
  Function
  Method
  PRIVATE
  Checks if enough data have been received to complete the netstring.
- twisted.protocols.basic.NetstringReceiver._processPayload
  twisted.protocols.basic.NetstringReceiver.html#_processPayload
  Function
  Method
  PRIVATE
  Processes the actual payload with `stringReceived`.
- twisted.protocols.basic.NetstringReceiver._checkForTrailingComma
  twisted.protocols.basic.NetstringReceiver.html#_checkForTrailingComma
  Function
  Method
  PRIVATE
  Checks if the netstring has a trailing comma at the expected position.
- twisted.protocols.basic.NetstringReceiver._handleParseError
  twisted.protocols.basic.NetstringReceiver.html#_handleParseError
  Function
  Method
  PRIVATE
  Terminates the connection and sets the flag `self.brokenPeer`.
- twisted.protocols.basic.LineOnlyReceiver
  twisted.protocols.basic.LineOnlyReceiver.html
  Class
  Class
  PUBLIC
  A protocol that receives only lines.
- twisted.protocols.basic.LineOnlyReceiver.delimiter
  twisted.protocols.basic.LineOnlyReceiver.html#delimiter
  Attribute
  Class Variable
  PUBLIC
  The line-ending delimiter to use. By default this is `b'\r\n'`.
- twisted.protocols.basic.LineOnlyReceiver.MAX_LENGTH
  twisted.protocols.basic.LineOnlyReceiver.html#MAX_LENGTH
  Attribute
  Constant
  PUBLIC
  The maximum length of a line to allow (If a sent line is longer than this, the connection is dropped). Default is 16384.
- twisted.protocols.basic.LineOnlyReceiver._buffer
  twisted.protocols.basic.LineOnlyReceiver.html#_buffer
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.protocols.basic.LineOnlyReceiver.dataReceived
  twisted.protocols.basic.LineOnlyReceiver.html#dataReceived
  Function
  Method
  PUBLIC
  Translates bytes into lines, and calls lineReceived.
- twisted.protocols.basic.LineOnlyReceiver.lineReceived
  twisted.protocols.basic.LineOnlyReceiver.html#lineReceived
  Function
  Method
  PUBLIC
  Override this for when each line is received.
- twisted.protocols.basic.LineOnlyReceiver.sendLine
  twisted.protocols.basic.LineOnlyReceiver.html#sendLine
  Function
  Method
  PUBLIC
  Sends a line to the other end of the connection.
- twisted.protocols.basic.LineOnlyReceiver.lineLengthExceeded
  twisted.protocols.basic.LineOnlyReceiver.html#lineLengthExceeded
  Function
  Method
  PUBLIC
  Called when the maximum line length has been reached. Override if it needs to be dealt with in some special way.
- twisted.protocols.basic._PauseableMixin
  twisted.protocols.basic._PauseableMixin.html
  Class
  Class
  PRIVATE
  Undocumented
- twisted.protocols.basic._PauseableMixin.paused
  twisted.protocols.basic._PauseableMixin.html#paused
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.basic._PauseableMixin.pauseProducing
  twisted.protocols.basic._PauseableMixin.html#pauseProducing
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.basic._PauseableMixin.resumeProducing
  twisted.protocols.basic._PauseableMixin.html#resumeProducing
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.basic._PauseableMixin.stopProducing
  twisted.protocols.basic._PauseableMixin.html#stopProducing
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.basic.LineReceiver
  twisted.protocols.basic.LineReceiver.html
  Class
  Class
  PUBLIC
  A protocol that receives lines and/or raw data, depending on mode.
- twisted.protocols.basic.LineReceiver.delimiter
  twisted.protocols.basic.LineReceiver.html#delimiter
  Attribute
  Class Variable
  PUBLIC
  The line-ending delimiter to use. By default this is `b'\r\n'`.
- twisted.protocols.basic.LineReceiver.MAX_LENGTH
  twisted.protocols.basic.LineReceiver.html#MAX_LENGTH
  Attribute
  Constant
  PUBLIC
  The maximum length of a line to allow (If a sent line is longer than this, the connection is dropped). Default is 16384.
- twisted.protocols.basic.LineReceiver.line_mode
  twisted.protocols.basic.LineReceiver.html#line_mode
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.basic.LineReceiver._buffer
  twisted.protocols.basic.LineReceiver.html#_buffer
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.protocols.basic.LineReceiver._busyReceiving
  twisted.protocols.basic.LineReceiver.html#_busyReceiving
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.protocols.basic.LineReceiver.clearLineBuffer
  twisted.protocols.basic.LineReceiver.html#clearLineBuffer
  Function
  Method
  PUBLIC
  Clear buffered data.
- twisted.protocols.basic.LineReceiver.dataReceived
  twisted.protocols.basic.LineReceiver.html#dataReceived
  Function
  Method
  PUBLIC
  Protocol.dataReceived. Translates bytes into lines, and calls lineReceived (or rawDataReceived, depending on mode.)
- twisted.protocols.basic.LineReceiver.setLineMode
  twisted.protocols.basic.LineReceiver.html#setLineMode
  Function
  Method
  PUBLIC
  Sets the line-mode of this receiver.
- twisted.protocols.basic.LineReceiver.setRawMode
  twisted.protocols.basic.LineReceiver.html#setRawMode
  Function
  Method
  PUBLIC
  Sets the raw mode of this receiver. Further data received will be sent to rawDataReceived rather than lineReceived.
- twisted.protocols.basic.LineReceiver.rawDataReceived
  twisted.protocols.basic.LineReceiver.html#rawDataReceived
  Function
  Method
  PUBLIC
  Override this for when raw data is received.
- twisted.protocols.basic.LineReceiver.lineReceived
  twisted.protocols.basic.LineReceiver.html#lineReceived
  Function
  Method
  PUBLIC
  Override this for when each line is received.
- twisted.protocols.basic.LineReceiver.sendLine
  twisted.protocols.basic.LineReceiver.html#sendLine
  Function
  Method
  PUBLIC
  Sends a line to the other end of the connection.
- twisted.protocols.basic.LineReceiver.lineLengthExceeded
  twisted.protocols.basic.LineReceiver.html#lineLengthExceeded
  Function
  Method
  PUBLIC
  Called when the maximum line length has been reached. Override if it needs to be dealt with in some special way.
- twisted.protocols.basic.StringTooLongError
  twisted.protocols.basic.StringTooLongError.html
  Class
  Exception
  PUBLIC
  Raised when trying to send a string too long for a length prefixed protocol.
- twisted.protocols.basic._RecvdCompatHack
  twisted.protocols.basic._RecvdCompatHack.html
  Class
  Class
  PRIVATE
  Emulates the to-be-deprecated `IntNStringReceiver.recvd` attribute.
- twisted.protocols.basic._RecvdCompatHack.__get__
  twisted.protocols.basic._RecvdCompatHack.html#__get__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.basic.IntNStringReceiver
  twisted.protocols.basic.IntNStringReceiver.html
  Class
  Class
  PUBLIC
  Generic class for length prefixed protocols.
- twisted.protocols.basic.IntNStringReceiver._unprocessed
  twisted.protocols.basic.IntNStringReceiver.html#_unprocessed
  Attribute
  Instance Variable
  PRIVATE
  bytes received, but not yet broken up into messages / sent to stringReceived. _compatibilityOffset must be updated when this value is updated so that the `recvd` attribute can be generated correctly.
- twisted.protocols.basic.IntNStringReceiver.structFormat
  twisted.protocols.basic.IntNStringReceiver.html#structFormat
  Attribute
  Instance Variable
  PUBLIC
  format used for struct packing/unpacking. Define it in subclass.
- twisted.protocols.basic.IntNStringReceiver.prefixLength
  twisted.protocols.basic.IntNStringReceiver.html#prefixLength
  Attribute
  Instance Variable
  PUBLIC
  length of the prefix, in bytes. Define it in subclass, using `struct.calcsize(structFormat)`
- twisted.protocols.basic.IntNStringReceiver._compatibilityOffset
  twisted.protocols.basic.IntNStringReceiver.html#_compatibilityOffset
  Attribute
  Instance Variable
  PRIVATE
  the offset within `_unprocessed` to the next message to be parsed. (used to generate the recvd attribute)
- twisted.protocols.basic.IntNStringReceiver.MAX_LENGTH
  twisted.protocols.basic.IntNStringReceiver.html#MAX_LENGTH
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.basic.IntNStringReceiver.recvd
  twisted.protocols.basic.IntNStringReceiver.html#recvd
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.protocols.basic.IntNStringReceiver.stringReceived
  twisted.protocols.basic.IntNStringReceiver.html#stringReceived
  Function
  Method
  PUBLIC
  Override this for notification when each complete string is received.
- twisted.protocols.basic.IntNStringReceiver.lengthLimitExceeded
  twisted.protocols.basic.IntNStringReceiver.html#lengthLimitExceeded
  Function
  Method
  PUBLIC
  Callback invoked when a length prefix greater than `MAX_LENGTH` is received. The default implementation disconnects the transport. Override this.
- twisted.protocols.basic.IntNStringReceiver.dataReceived
  twisted.protocols.basic.IntNStringReceiver.html#dataReceived
  Function
  Method
  PUBLIC
  Convert int prefixed strings into calls to stringReceived.
- twisted.protocols.basic.IntNStringReceiver.sendString
  twisted.protocols.basic.IntNStringReceiver.html#sendString
  Function
  Method
  PUBLIC
  Send a prefixed string to the other end of the connection.
- twisted.protocols.basic.Int32StringReceiver
  twisted.protocols.basic.Int32StringReceiver.html
  Class
  Class
  PUBLIC
  A receiver for int32-prefixed strings.
- twisted.protocols.basic.Int32StringReceiver.structFormat
  twisted.protocols.basic.Int32StringReceiver.html#structFormat
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.protocols.basic.Int32StringReceiver.prefixLength
  twisted.protocols.basic.Int32StringReceiver.html#prefixLength
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.protocols.basic.Int16StringReceiver
  twisted.protocols.basic.Int16StringReceiver.html
  Class
  Class
  PUBLIC
  A receiver for int16-prefixed strings.
- twisted.protocols.basic.Int16StringReceiver.structFormat
  twisted.protocols.basic.Int16StringReceiver.html#structFormat
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.protocols.basic.Int16StringReceiver.prefixLength
  twisted.protocols.basic.Int16StringReceiver.html#prefixLength
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.protocols.basic.Int8StringReceiver
  twisted.protocols.basic.Int8StringReceiver.html
  Class
  Class
  PUBLIC
  A receiver for int8-prefixed strings.
- twisted.protocols.basic.Int8StringReceiver.structFormat
  twisted.protocols.basic.Int8StringReceiver.html#structFormat
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.protocols.basic.Int8StringReceiver.prefixLength
  twisted.protocols.basic.Int8StringReceiver.html#prefixLength
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.protocols.basic.StatefulStringProtocol
  twisted.protocols.basic.StatefulStringProtocol.html
  Class
  Class
  PUBLIC
  A stateful string protocol.
- twisted.protocols.basic.StatefulStringProtocol.state
  twisted.protocols.basic.StatefulStringProtocol.html#state
  Attribute
  Instance Variable
  PUBLIC
  Current state of the protocol. Defaults to `'init'`.
- twisted.protocols.basic.StatefulStringProtocol.stringReceived
  twisted.protocols.basic.StatefulStringProtocol.html#stringReceived
  Function
  Method
  PUBLIC
  Choose a protocol phase function and call it.
- twisted.protocols.basic.FileSender
  twisted.protocols.basic.FileSender.html
  Class
  Class
  PUBLIC
  A producer that sends the contents of a file to a consumer.
- twisted.protocols.basic.FileSender.CHUNK_SIZE
  twisted.protocols.basic.FileSender.html#CHUNK_SIZE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.basic.FileSender.lastSent
  twisted.protocols.basic.FileSender.html#lastSent
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.basic.FileSender.deferred
  twisted.protocols.basic.FileSender.html#deferred
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.basic.FileSender.beginFileTransfer
  twisted.protocols.basic.FileSender.html#beginFileTransfer
  Function
  Method
  PUBLIC
  Begin transferring a file
- twisted.protocols.basic.FileSender.file
  twisted.protocols.basic.FileSender.html#file
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.basic.FileSender.consumer
  twisted.protocols.basic.FileSender.html#consumer
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.basic.FileSender.transform
  twisted.protocols.basic.FileSender.html#transform
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.basic.FileSender.resumeProducing
  twisted.protocols.basic.FileSender.html#resumeProducing
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.basic.FileSender.pauseProducing
  twisted.protocols.basic.FileSender.html#pauseProducing
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.basic.FileSender.stopProducing
  twisted.protocols.basic.FileSender.html#stopProducing
  Function
  Method
  PUBLIC
  Stop producing data.
- twisted.internet.testing.AccumulatingProtocol
  twisted.internet.testing.AccumulatingProtocol.html
  Class
  Class
  PUBLIC
  `AccumulatingProtocol` is an `IProtocol` implementation which collects the data delivered to it and can fire a Deferred when it is connected or disconnected.
- twisted.internet.testing.AccumulatingProtocol.made
  twisted.internet.testing.AccumulatingProtocol.html#made
  Attribute
  Instance Variable
  PUBLIC
  A flag indicating whether `connectionMade` has been called.
- twisted.internet.testing.AccumulatingProtocol.data
  twisted.internet.testing.AccumulatingProtocol.html#data
  Attribute
  Instance Variable
  PUBLIC
  Bytes giving all the data passed to `dataReceived`.
- twisted.internet.testing.AccumulatingProtocol.closed
  twisted.internet.testing.AccumulatingProtocol.html#closed
  Attribute
  Instance Variable
  PUBLIC
  A flag indicated whether `connectionLost` has been called.
- twisted.internet.testing.AccumulatingProtocol.closedReason
  twisted.internet.testing.AccumulatingProtocol.html#closedReason
  Attribute
  Instance Variable
  PUBLIC
  The value of the reason parameter passed to `connectionLost`.
- twisted.internet.testing.AccumulatingProtocol.closedDeferred
  twisted.internet.testing.AccumulatingProtocol.html#closedDeferred
  Attribute
  Instance Variable
  PUBLIC
  If set to a `Deferred`, this will be fired when `connectionLost` is called.
- twisted.internet.testing.AccumulatingProtocol.factory
  twisted.internet.testing.AccumulatingProtocol.html#factory
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet.testing.AccumulatingProtocol.connectionMade
  twisted.internet.testing.AccumulatingProtocol.html#connectionMade
  Function
  Method
  PUBLIC
  Called when a connection is made.
- twisted.internet.testing.AccumulatingProtocol.dataReceived
  twisted.internet.testing.AccumulatingProtocol.html#dataReceived
  Function
  Method
  PUBLIC
  Called whenever data is received.
- twisted.internet.testing.AccumulatingProtocol.connectionLost
  twisted.internet.testing.AccumulatingProtocol.html#connectionLost
  Function
  Method
  PUBLIC
  Called when the connection is shut down.
- twisted.internet.testing.LineSendingProtocol
  twisted.internet.testing.LineSendingProtocol.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.internet.testing.LineSendingProtocol.lostConn
  twisted.internet.testing.LineSendingProtocol.html#lostConn
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.testing.LineSendingProtocol.__init__
  twisted.internet.testing.LineSendingProtocol.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.testing.LineSendingProtocol.lines
  twisted.internet.testing.LineSendingProtocol.html#lines
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.testing.LineSendingProtocol.response
  twisted.internet.testing.LineSendingProtocol.html#response
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.testing.LineSendingProtocol.start
  twisted.internet.testing.LineSendingProtocol.html#start
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.testing.LineSendingProtocol.connectionMade
  twisted.internet.testing.LineSendingProtocol.html#connectionMade
  Function
  Method
  PUBLIC
  Called when a connection is made.
- twisted.internet.testing.LineSendingProtocol.lineReceived
  twisted.internet.testing.LineSendingProtocol.html#lineReceived
  Function
  Method
  PUBLIC
  Override this for when each line is received.
- twisted.internet.testing.LineSendingProtocol.connectionLost
  twisted.internet.testing.LineSendingProtocol.html#connectionLost
  Function
  Method
  PUBLIC
  Called when the connection is shut down.
- twisted.internet.testing.FakeDatagramTransport
  twisted.internet.testing.FakeDatagramTransport.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.internet.testing.FakeDatagramTransport.noAddr
  twisted.internet.testing.FakeDatagramTransport.html#noAddr
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet.testing.FakeDatagramTransport.__init__
  twisted.internet.testing.FakeDatagramTransport.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.testing.FakeDatagramTransport.written
  twisted.internet.testing.FakeDatagramTransport.html#written
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.testing.FakeDatagramTransport.write
  twisted.internet.testing.FakeDatagramTransport.html#write
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.testing.StringTransport
  twisted.internet.testing.StringTransport.html
  Class
  Class
  PUBLIC
  A transport implementation which buffers data in memory and keeps track of its other state without providing any behavior.
- twisted.internet.testing.StringTransport.disconnecting
  twisted.internet.testing.StringTransport.html#disconnecting
  Attribute
  Instance Variable
  PUBLIC
  A `bool` which is `False` until `loseConnection` is called, then `True`.
- twisted.internet.testing.StringTransport.disconnected
  twisted.internet.testing.StringTransport.html#disconnected
  Attribute
  Instance Variable
  PUBLIC
  A `bool` which is `False` until `abortConnection` is called, then `True`.
- twisted.internet.testing.StringTransport.producer
  twisted.internet.testing.StringTransport.html#producer
  Attribute
  Instance Variable
  PUBLIC
  If a producer is currently registered, `producer` is a reference to it. Otherwise, `None`.
- twisted.internet.testing.StringTransport.streaming
  twisted.internet.testing.StringTransport.html#streaming
  Attribute
  Instance Variable
  PUBLIC
  If a producer is currently registered, `streaming` refers to the value of the second parameter passed to `registerProducer`.
- twisted.internet.testing.StringTransport.hostAddr
  twisted.internet.testing.StringTransport.html#hostAddr
  Attribute
  Instance Variable
  PUBLIC
  `None` or an object which will be returned as the host address of this transport. If `None`, a nasty tuple will be returned instead.
- twisted.internet.testing.StringTransport.peerAddr
  twisted.internet.testing.StringTransport.html#peerAddr
  Attribute
  Instance Variable
  PUBLIC
  `None` or an object which will be returned as the peer address of this transport. If `None`, a nasty tuple will be returned instead.
- twisted.internet.testing.StringTransport.producerState
  twisted.internet.testing.StringTransport.html#producerState
  Attribute
  Instance Variable
  PUBLIC
  The state of this `StringTransport` in its capacity as an `IPushProducer`. One of `'producing'`, `'paused'`, or `'stopped'`.
- twisted.internet.testing.StringTransport.io
  twisted.internet.testing.StringTransport.html#io
  Attribute
  Instance Variable
  PUBLIC
  A `io.BytesIO` which holds the data which has been written to this transport since the last call to `clear`. Use `value` instead of accessing this directly.
- twisted.internet.testing.StringTransport._lenient
  twisted.internet.testing.StringTransport.html#_lenient
  Attribute
  Instance Variable
  PRIVATE
  By default `StringTransport` enforces that `resumeProducing` is not called after the connection is lost. This is to ensure that any code that does call `resumeProducing` after the connection is lost is not blindly expecting ...
- twisted.internet.testing.StringTransport.__init__
  twisted.internet.testing.StringTransport.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.testing.StringTransport.connected
  twisted.internet.testing.StringTransport.html#connected
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.testing.StringTransport.clear
  twisted.internet.testing.StringTransport.html#clear
  Function
  Method
  PUBLIC
  Discard all data written to this transport so far.
- twisted.internet.testing.StringTransport.value
  twisted.internet.testing.StringTransport.html#value
  Function
  Method
  PUBLIC
  Retrieve all data which has been buffered by this transport.
- twisted.internet.testing.StringTransport.write
  twisted.internet.testing.StringTransport.html#write
  Function
  Method
  PUBLIC
  Write some data to the physical connection, in sequence, in a non-blocking fashion.
- twisted.internet.testing.StringTransport.writeSequence
  twisted.internet.testing.StringTransport.html#writeSequence
  Function
  Method
  PUBLIC
  Write an iterable of byte strings to the physical connection.
- twisted.internet.testing.StringTransport.loseConnection
  twisted.internet.testing.StringTransport.html#loseConnection
  Function
  Method
  PUBLIC
  Close the connection. Does nothing besides toggle the `disconnecting` instance variable to `True`.
- twisted.internet.testing.StringTransport.abortConnection
  twisted.internet.testing.StringTransport.html#abortConnection
  Function
  Method
  PUBLIC
  Abort the connection. Same as `loseConnection`, but also toggles the `aborted` instance variable to `True`.
- twisted.internet.testing.StringTransport.getPeer
  twisted.internet.testing.StringTransport.html#getPeer
  Function
  Method
  PUBLIC
  Get the remote address of this connection.
- twisted.internet.testing.StringTransport.getHost
  twisted.internet.testing.StringTransport.html#getHost
  Function
  Method
  PUBLIC
  Similar to getPeer, but returns an address describing this side of the connection.
- twisted.internet.testing.StringTransport.registerProducer
  twisted.internet.testing.StringTransport.html#registerProducer
  Function
  Method
  PUBLIC
  Register to receive data from a producer.
- twisted.internet.testing.StringTransport.unregisterProducer
  twisted.internet.testing.StringTransport.html#unregisterProducer
  Function
  Method
  PUBLIC
  Stop consuming data from a producer, without disconnecting.
- twisted.internet.testing.StringTransport._checkState
  twisted.internet.testing.StringTransport.html#_checkState
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet.testing.StringTransport.pauseProducing
  twisted.internet.testing.StringTransport.html#pauseProducing
  Function
  Method
  PUBLIC
  Pause producing data.
- twisted.internet.testing.StringTransport.stopProducing
  twisted.internet.testing.StringTransport.html#stopProducing
  Function
  Method
  PUBLIC
  Stop producing data.
- twisted.internet.testing.StringTransport.resumeProducing
  twisted.internet.testing.StringTransport.html#resumeProducing
  Function
  Method
  PUBLIC
  Resume producing data.
- twisted.internet.testing.StringTransportWithDisconnection
  twisted.internet.testing.StringTransportWithDisconnection.html
  Class
  Class
  PUBLIC
  A `StringTransport` which on disconnection will trigger the connection lost on the attached protocol.
- twisted.internet.testing.StringTransportWithDisconnection.protocol
  twisted.internet.testing.StringTransportWithDisconnection.html#protocol
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet.testing.StringTransportWithDisconnection.loseConnection
  twisted.internet.testing.StringTransportWithDisconnection.html#loseConnection
  Function
  Method
  PUBLIC
  Close the connection. Does nothing besides toggle the `disconnecting` instance variable to `True`.
- twisted.internet.testing.StringTransportWithDisconnection.connected
  twisted.internet.testing.StringTransportWithDisconnection.html#connected
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.testing.StringIOWithoutClosing
  twisted.internet.testing.StringIOWithoutClosing.html
  Class
  Class
  PUBLIC
  A BytesIO that can't be closed.
- twisted.internet.testing.StringIOWithoutClosing.close
  twisted.internet.testing.StringIOWithoutClosing.html#close
  Function
  Method
  PUBLIC
  Do nothing.
- twisted.internet.testing._FakePort
  twisted.internet.testing._FakePort.html
  Class
  Class
  PRIVATE
  A fake `IListeningPort` to be used in tests.
- twisted.internet.testing._FakePort._hostAddress
  twisted.internet.testing._FakePort.html#_hostAddress
  Attribute
  Instance Variable
  PRIVATE
  The `IAddress` this `IListeningPort` is pretending to be listening on.
- twisted.internet.testing._FakePort.__init__
  twisted.internet.testing._FakePort.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.internet.testing._FakePort.startListening
  twisted.internet.testing._FakePort.html#startListening
  Function
  Method
  PUBLIC
  Fake `IListeningPort.startListening` that doesn't do anything.
- twisted.internet.testing._FakePort.stopListening
  twisted.internet.testing._FakePort.html#stopListening
  Function
  Method
  PUBLIC
  Fake `IListeningPort.stopListening` that doesn't do anything.
- twisted.internet.testing._FakePort.getHost
  twisted.internet.testing._FakePort.html#getHost
  Function
  Method
  PUBLIC
  Fake `IListeningPort.getHost` that returns our `IAddress`.
- twisted.internet.testing._FakeConnector
  twisted.internet.testing._FakeConnector.html
  Class
  Class
  PRIVATE
  A fake `IConnector` that allows us to inspect if it has been told to stop connecting.
- twisted.internet.testing._FakeConnector.stoppedConnecting
  twisted.internet.testing._FakeConnector.html#stoppedConnecting
  Attribute
  Instance Variable
  PUBLIC
  has this connector's `_FakeConnector.stopConnecting` method been invoked yet?
- twisted.internet.testing._FakeConnector._address
  twisted.internet.testing._FakeConnector.html#_address
  Attribute
  Instance Variable
  PRIVATE
  An `IAddress` provider that represents our destination.
- twisted.internet.testing._FakeConnector._disconnected
  twisted.internet.testing._FakeConnector.html#_disconnected
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.testing._FakeConnector.__init__
  twisted.internet.testing._FakeConnector.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.internet.testing._FakeConnector.stopConnecting
  twisted.internet.testing._FakeConnector.html#stopConnecting
  Function
  Method
  PUBLIC
  Implement `IConnector.stopConnecting` and set `_FakeConnector.stoppedConnecting` to `True`
- twisted.internet.testing._FakeConnector.disconnect
  twisted.internet.testing._FakeConnector.html#disconnect
  Function
  Method
  PUBLIC
  Implement `IConnector.disconnect` as a no-op.
- twisted.internet.testing._FakeConnector.connect
  twisted.internet.testing._FakeConnector.html#connect
  Function
  Method
  PUBLIC
  Implement `IConnector.connect` as a no-op.
- twisted.internet.testing._FakeConnector.getDestination
  twisted.internet.testing._FakeConnector.html#getDestination
  Function
  Method
  PUBLIC
  Implement `IConnector.getDestination` to return the `address` passed to `__init__`.
- twisted.internet.testing.MemoryReactor
  twisted.internet.testing.MemoryReactor.html
  Class
  Class
  PUBLIC
  A fake reactor to be used in tests. This reactor doesn't actually do much that's useful yet. It accepts TCP connection setup attempts, but they will never succeed.
- twisted.internet.testing.MemoryReactor.hasInstalled
  twisted.internet.testing.MemoryReactor.html#hasInstalled
  Attribute
  Instance Variable
  PUBLIC
  Keeps track of whether this reactor has been installed.
- twisted.internet.testing.MemoryReactor.running
  twisted.internet.testing.MemoryReactor.html#running
  Attribute
  Instance Variable
  PUBLIC
  Keeps track of whether this reactor is running.
- twisted.internet.testing.MemoryReactor.hasStopped
  twisted.internet.testing.MemoryReactor.html#hasStopped
  Attribute
  Instance Variable
  PUBLIC
  Keeps track of whether this reactor has been stopped.
- twisted.internet.testing.MemoryReactor.hasCrashed
  twisted.internet.testing.MemoryReactor.html#hasCrashed
  Attribute
  Instance Variable
  PUBLIC
  Keeps track of whether this reactor has crashed.
- twisted.internet.testing.MemoryReactor.whenRunningHooks
  twisted.internet.testing.MemoryReactor.html#whenRunningHooks
  Attribute
  Instance Variable
  PUBLIC
  Keeps track of hooks registered with `callWhenRunning`.
- twisted.internet.testing.MemoryReactor.triggers
  twisted.internet.testing.MemoryReactor.html#triggers
  Attribute
  Instance Variable
  PUBLIC
  Keeps track of hooks registered with `addSystemEventTrigger`.
- twisted.internet.testing.MemoryReactor.tcpClients
  twisted.internet.testing.MemoryReactor.html#tcpClients
  Attribute
  Instance Variable
  PUBLIC
  Keeps track of connection attempts (ie, calls to `connectTCP`).
- twisted.internet.testing.MemoryReactor.tcpServers
  twisted.internet.testing.MemoryReactor.html#tcpServers
  Attribute
  Instance Variable
  PUBLIC
  Keeps track of server listen attempts (ie, calls to `listenTCP`).
- twisted.internet.testing.MemoryReactor.sslClients
  twisted.internet.testing.MemoryReactor.html#sslClients
  Attribute
  Instance Variable
  PUBLIC
  Keeps track of connection attempts (ie, calls to `connectSSL`).
- twisted.internet.testing.MemoryReactor.sslServers
  twisted.internet.testing.MemoryReactor.html#sslServers
  Attribute
  Instance Variable
  PUBLIC
  Keeps track of server listen attempts (ie, calls to `listenSSL`).
- twisted.internet.testing.MemoryReactor.unixClients
  twisted.internet.testing.MemoryReactor.html#unixClients
  Attribute
  Instance Variable
  PUBLIC
  Keeps track of connection attempts (ie, calls to `connectUNIX`).
- twisted.internet.testing.MemoryReactor.unixServers
  twisted.internet.testing.MemoryReactor.html#unixServers
  Attribute
  Instance Variable
  PUBLIC
  Keeps track of server listen attempts (ie, calls to `listenUNIX`).
- twisted.internet.testing.MemoryReactor.adoptedPorts
  twisted.internet.testing.MemoryReactor.html#adoptedPorts
  Attribute
  Instance Variable
  PUBLIC
  Keeps track of server listen attempts (ie, calls to `adoptStreamPort`).
- twisted.internet.testing.MemoryReactor.adoptedStreamConnections
  twisted.internet.testing.MemoryReactor.html#adoptedStreamConnections
  Attribute
  Instance Variable
  PUBLIC
  Keeps track of stream-oriented connections added using `adoptStreamConnection`.
- twisted.internet.testing.MemoryReactor.__init__
  twisted.internet.testing.MemoryReactor.html#__init__
  Function
  Method
  PUBLIC
  Initialize the tracking lists.
- twisted.internet.testing.MemoryReactor.hasRun
  twisted.internet.testing.MemoryReactor.html#hasRun
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.testing.MemoryReactor.connectors
  twisted.internet.testing.MemoryReactor.html#connectors
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.testing.MemoryReactor.readers
  twisted.internet.testing.MemoryReactor.html#readers
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.testing.MemoryReactor.writers
  twisted.internet.testing.MemoryReactor.html#writers
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.testing.MemoryReactor.install
  twisted.internet.testing.MemoryReactor.html#install
  Function
  Method
  PUBLIC
  Fake install callable to emulate reactor module installation.
- twisted.internet.testing.MemoryReactor.resolve
  twisted.internet.testing.MemoryReactor.html#resolve
  Function
  Method
  PUBLIC
  Not implemented; raises `NotImplementedError`.
- twisted.internet.testing.MemoryReactor.run
  twisted.internet.testing.MemoryReactor.html#run
  Function
  Method
  PUBLIC
  Fake `IReactorCore.run`. Sets `self.running` to `True`, runs all of the hooks passed to `self.callWhenRunning`, then calls `self.stop` to simulate a request to stop the reactor. Sets `self.hasRun` to `True`.
- twisted.internet.testing.MemoryReactor.stop
  twisted.internet.testing.MemoryReactor.html#stop
  Function
  Method
  PUBLIC
  Fake `IReactorCore.run`. Sets `self.running` to `False`. Sets `self.hasStopped` to `True`.
- twisted.internet.testing.MemoryReactor.crash
  twisted.internet.testing.MemoryReactor.html#crash
  Function
  Method
  PUBLIC
  Fake `IReactorCore.crash`. Sets `self.running` to `None`, because that feels crashy. Sets `self.hasCrashed` to `True`.
- twisted.internet.testing.MemoryReactor.iterate
  twisted.internet.testing.MemoryReactor.html#iterate
  Function
  Method
  PUBLIC
  Not implemented; raises `NotImplementedError`.
- twisted.internet.testing.MemoryReactor.fireSystemEvent
  twisted.internet.testing.MemoryReactor.html#fireSystemEvent
  Function
  Method
  PUBLIC
  Not implemented; raises `NotImplementedError`.
- twisted.internet.testing.MemoryReactor.addSystemEventTrigger
  twisted.internet.testing.MemoryReactor.html#addSystemEventTrigger
  Function
  Method
  PUBLIC
  Fake `IReactorCore.run`. Keep track of trigger by appending it to self.triggers[phase][eventType].
- twisted.internet.testing.MemoryReactor.removeSystemEventTrigger
  twisted.internet.testing.MemoryReactor.html#removeSystemEventTrigger
  Function
  Method
  PUBLIC
  Not implemented; raises `NotImplementedError`.
- twisted.internet.testing.MemoryReactor.callWhenRunning
  twisted.internet.testing.MemoryReactor.html#callWhenRunning
  Function
  Method
  PUBLIC
  Fake `IReactorCore.callWhenRunning`. Keeps a list of invocations to make in `self.whenRunningHooks`.
- twisted.internet.testing.MemoryReactor.adoptStreamPort
  twisted.internet.testing.MemoryReactor.html#adoptStreamPort
  Function
  Method
  PUBLIC
  Fake `IReactorSocket.adoptStreamPort`, that logs the call and returns an `IListeningPort`.
- twisted.internet.testing.MemoryReactor.adoptStreamConnection
  twisted.internet.testing.MemoryReactor.html#adoptStreamConnection
  Function
  Method
  PUBLIC
  Record the given stream connection in `adoptedStreamConnections`.
- twisted.internet.testing.MemoryReactor.adoptDatagramPort
  twisted.internet.testing.MemoryReactor.html#adoptDatagramPort
  Function
  Method
  PUBLIC
  Fake `IReactorSocket.adoptDatagramPort`, that logs the call and returns a fake `IListeningPort`.
- twisted.internet.testing.MemoryReactor.listenTCP
  twisted.internet.testing.MemoryReactor.html#listenTCP
  Function
  Method
  PUBLIC
  Fake `IReactorTCP.listenTCP`, that logs the call and returns an `IListeningPort`.
- twisted.internet.testing.MemoryReactor.connectTCP
  twisted.internet.testing.MemoryReactor.html#connectTCP
  Function
  Method
  PUBLIC
  Fake `IReactorTCP.connectTCP`, that logs the call and returns an `IConnector`.
- twisted.internet.testing.MemoryReactor.listenSSL
  twisted.internet.testing.MemoryReactor.html#listenSSL
  Function
  Method
  PUBLIC
  Fake `IReactorSSL.listenSSL`, that logs the call and returns an `IListeningPort`.
- twisted.internet.testing.MemoryReactor.connectSSL
  twisted.internet.testing.MemoryReactor.html#connectSSL
  Function
  Method
  PUBLIC
  Fake `IReactorSSL.connectSSL`, that logs the call and returns an `IConnector`.
- twisted.internet.testing.MemoryReactor.listenUNIX
  twisted.internet.testing.MemoryReactor.html#listenUNIX
  Function
  Method
  PUBLIC
  Fake `IReactorUNIX.listenUNIX`, that logs the call and returns an `IListeningPort`.
- twisted.internet.testing.MemoryReactor.connectUNIX
  twisted.internet.testing.MemoryReactor.html#connectUNIX
  Function
  Method
  PUBLIC
  Fake `IReactorUNIX.connectUNIX`, that logs the call and returns an `IConnector`.
- twisted.internet.testing.MemoryReactor.addReader
  twisted.internet.testing.MemoryReactor.html#addReader
  Function
  Method
  PUBLIC
  Fake `IReactorFDSet.addReader` which adds the reader to a local set.
- twisted.internet.testing.MemoryReactor.removeReader
  twisted.internet.testing.MemoryReactor.html#removeReader
  Function
  Method
  PUBLIC
  Fake `IReactorFDSet.removeReader` which removes the reader from a local set.
- twisted.internet.testing.MemoryReactor.addWriter
  twisted.internet.testing.MemoryReactor.html#addWriter
  Function
  Method
  PUBLIC
  Fake `IReactorFDSet.addWriter` which adds the writer to a local set.
- twisted.internet.testing.MemoryReactor.removeWriter
  twisted.internet.testing.MemoryReactor.html#removeWriter
  Function
  Method
  PUBLIC
  Fake `IReactorFDSet.removeWriter` which removes the writer from a local set.
- twisted.internet.testing.MemoryReactor.getReaders
  twisted.internet.testing.MemoryReactor.html#getReaders
  Function
  Method
  PUBLIC
  Fake `IReactorFDSet.getReaders` which returns a list of readers from the local set.
- twisted.internet.testing.MemoryReactor.getWriters
  twisted.internet.testing.MemoryReactor.html#getWriters
  Function
  Method
  PUBLIC
  Fake `IReactorFDSet.getWriters` which returns a list of writers from the local set.
- twisted.internet.testing.MemoryReactor.removeAll
  twisted.internet.testing.MemoryReactor.html#removeAll
  Function
  Method
  PUBLIC
  Fake `IReactorFDSet.removeAll` which removed all readers and writers from the local sets.
- twisted.internet.testing.MemoryReactorClock
  twisted.internet.testing.MemoryReactorClock.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.internet.testing.MemoryReactorClock.__init__
  twisted.internet.testing.MemoryReactorClock.html#__init__
  Function
  Method
  PUBLIC
  Initialize the tracking lists.
- twisted.internet.testing.RaisingMemoryReactor
  twisted.internet.testing.RaisingMemoryReactor.html
  Class
  Class
  PUBLIC
  A fake reactor to be used in tests. It accepts TCP connection setup attempts, but they will fail.
- twisted.internet.testing.RaisingMemoryReactor._listenException
  twisted.internet.testing.RaisingMemoryReactor.html#_listenException
  Attribute
  Instance Variable
  PRIVATE
  An instance of an `Exception`
- twisted.internet.testing.RaisingMemoryReactor._connectException
  twisted.internet.testing.RaisingMemoryReactor.html#_connectException
  Attribute
  Instance Variable
  PRIVATE
  An instance of an `Exception`
- twisted.internet.testing.RaisingMemoryReactor.__init__
  twisted.internet.testing.RaisingMemoryReactor.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.internet.testing.RaisingMemoryReactor.adoptStreamPort
  twisted.internet.testing.RaisingMemoryReactor.html#adoptStreamPort
  Function
  Method
  PUBLIC
  Fake `IReactorSocket.adoptStreamPort`, that raises `_listenException`.
- twisted.internet.testing.RaisingMemoryReactor.listenTCP
  twisted.internet.testing.RaisingMemoryReactor.html#listenTCP
  Function
  Method
  PUBLIC
  Fake `IReactorTCP.listenTCP`, that raises `_listenException`.
- twisted.internet.testing.RaisingMemoryReactor.connectTCP
  twisted.internet.testing.RaisingMemoryReactor.html#connectTCP
  Function
  Method
  PUBLIC
  Fake `IReactorTCP.connectTCP`, that raises `_connectException`.
- twisted.internet.testing.RaisingMemoryReactor.listenSSL
  twisted.internet.testing.RaisingMemoryReactor.html#listenSSL
  Function
  Method
  PUBLIC
  Fake `IReactorSSL.listenSSL`, that raises `_listenException`.
- twisted.internet.testing.RaisingMemoryReactor.connectSSL
  twisted.internet.testing.RaisingMemoryReactor.html#connectSSL
  Function
  Method
  PUBLIC
  Fake `IReactorSSL.connectSSL`, that raises `_connectException`.
- twisted.internet.testing.RaisingMemoryReactor.listenUNIX
  twisted.internet.testing.RaisingMemoryReactor.html#listenUNIX
  Function
  Method
  PUBLIC
  Fake `IReactorUNIX.listenUNIX`, that raises `_listenException`.
- twisted.internet.testing.RaisingMemoryReactor.connectUNIX
  twisted.internet.testing.RaisingMemoryReactor.html#connectUNIX
  Function
  Method
  PUBLIC
  Fake `IReactorUNIX.connectUNIX`, that raises `_connectException`.
- twisted.internet.testing.RaisingMemoryReactor.adoptDatagramPort
  twisted.internet.testing.RaisingMemoryReactor.html#adoptDatagramPort
  Function
  Method
  PUBLIC
  Fake `IReactorSocket.adoptDatagramPort`, that raises `_connectException`.
- twisted.internet.testing.RaisingMemoryReactor.adoptStreamConnection
  twisted.internet.testing.RaisingMemoryReactor.html#adoptStreamConnection
  Function
  Method
  PUBLIC
  Fake `IReactorSocket.adoptStreamConnection`, that raises `_connectException`.
- twisted.internet.testing.NonStreamingProducer
  twisted.internet.testing.NonStreamingProducer.html
  Class
  Class
  PUBLIC
  A pull producer which writes 10 times only.
- twisted.internet.testing.NonStreamingProducer.counter
  twisted.internet.testing.NonStreamingProducer.html#counter
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet.testing.NonStreamingProducer.stopped
  twisted.internet.testing.NonStreamingProducer.html#stopped
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.testing.NonStreamingProducer.__init__
  twisted.internet.testing.NonStreamingProducer.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.testing.NonStreamingProducer.consumer
  twisted.internet.testing.NonStreamingProducer.html#consumer
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.testing.NonStreamingProducer.result
  twisted.internet.testing.NonStreamingProducer.html#result
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.testing.NonStreamingProducer.resumeProducing
  twisted.internet.testing.NonStreamingProducer.html#resumeProducing
  Function
  Method
  PUBLIC
  Write the counter value once.
- twisted.internet.testing.NonStreamingProducer.pauseProducing
  twisted.internet.testing.NonStreamingProducer.html#pauseProducing
  Function
  Method
  PUBLIC
  An implementation of `IPushProducer.pauseProducing`. This should never be called on a pull producer, so this just raises an error.
- twisted.internet.testing.NonStreamingProducer._done
  twisted.internet.testing.NonStreamingProducer.html#_done
  Function
  Method
  PRIVATE
  Fire a `Deferred` so that users can wait for this to complete.
- twisted.internet.testing.NonStreamingProducer.stopProducing
  twisted.internet.testing.NonStreamingProducer.html#stopProducing
  Function
  Method
  PUBLIC
  Stop all production.
- twisted.internet.testing.waitUntilAllDisconnected
  twisted.internet.testing.html#waitUntilAllDisconnected
  Function
  Function
  PUBLIC
  Take a list of disconnecting protocols, callback a `Deferred` when they're all done.
- twisted.internet.testing.EventLoggingObserver
  twisted.internet.testing.EventLoggingObserver.html
  Class
  Class
  PUBLIC
  `ILogObserver` That stores its events in a list for later inspection. This class is similar to `LimitedHistoryLogObserver` save that the internal buffer is public and intended for external inspection. The observer implements the sequence protocol to ease iteration of the events.
- twisted.internet.testing.EventLoggingObserver._events
  twisted.internet.testing.EventLoggingObserver.html#_events
  Attribute
  Instance Variable
  PRIVATE
  The events captured by this observer
- twisted.internet.testing.EventLoggingObserver.__init__
  twisted.internet.testing.EventLoggingObserver.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.testing.EventLoggingObserver.__len__
  twisted.internet.testing.EventLoggingObserver.html#__len__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.testing.EventLoggingObserver.__getitem__
  twisted.internet.testing.EventLoggingObserver.html#__getitem__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.testing.EventLoggingObserver.__iter__
  twisted.internet.testing.EventLoggingObserver.html#__iter__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.testing.EventLoggingObserver.__call__
  twisted.internet.testing.EventLoggingObserver.html#__call__
  Function
  Method
  PUBLIC
  No summary
- twisted.internet.testing.EventLoggingObserver.createWithCleanup
  twisted.internet.testing.EventLoggingObserver.html#createWithCleanup
  Function
  Class Method
  PUBLIC
  Create an `EventLoggingObserver` instance that observes the provided publisher and will be cleaned up with addCleanup().
- twisted.internet._pollingfile.MIN_TIMEOUT
  twisted.internet._pollingfile.html#MIN_TIMEOUT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet._pollingfile.MAX_TIMEOUT
  twisted.internet._pollingfile.html#MAX_TIMEOUT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet._pollingfile._PollableResource
  twisted.internet._pollingfile._PollableResource.html
  Class
  Class
  PRIVATE
  Undocumented
- twisted.internet._pollingfile._PollableResource.active
  twisted.internet._pollingfile._PollableResource.html#active
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet._pollingfile._PollableResource.activate
  twisted.internet._pollingfile._PollableResource.html#activate
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet._pollingfile._PollableResource.deactivate
  twisted.internet._pollingfile._PollableResource.html#deactivate
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet._pollingfile._PollingTimer
  twisted.internet._pollingfile._PollingTimer.html
  Class
  Class
  PRIVATE
  Undocumented
- twisted.internet._pollingfile._PollingTimer.__init__
  twisted.internet._pollingfile._PollingTimer.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet._pollingfile._PollingTimer.reactor
  twisted.internet._pollingfile._PollingTimer.html#reactor
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet._pollingfile._PollingTimer._resources
  twisted.internet._pollingfile._PollingTimer.html#_resources
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet._pollingfile._PollingTimer._pollTimer
  twisted.internet._pollingfile._PollingTimer.html#_pollTimer
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet._pollingfile._PollingTimer._currentTimeout
  twisted.internet._pollingfile._PollingTimer.html#_currentTimeout
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet._pollingfile._PollingTimer._paused
  twisted.internet._pollingfile._PollingTimer.html#_paused
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet._pollingfile._PollingTimer._addPollableResource
  twisted.internet._pollingfile._PollingTimer.html#_addPollableResource
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet._pollingfile._PollingTimer._checkPollingState
  twisted.internet._pollingfile._PollingTimer.html#_checkPollingState
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet._pollingfile._PollingTimer._startPolling
  twisted.internet._pollingfile._PollingTimer.html#_startPolling
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet._pollingfile._PollingTimer._stopPolling
  twisted.internet._pollingfile._PollingTimer.html#_stopPolling
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet._pollingfile._PollingTimer._pause
  twisted.internet._pollingfile._PollingTimer.html#_pause
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet._pollingfile._PollingTimer._unpause
  twisted.internet._pollingfile._PollingTimer.html#_unpause
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet._pollingfile._PollingTimer._reschedule
  twisted.internet._pollingfile._PollingTimer.html#_reschedule
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet._pollingfile._PollingTimer._pollEvent
  twisted.internet._pollingfile._PollingTimer.html#_pollEvent
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet._pollingfile._PollableReadPipe
  twisted.internet._pollingfile._PollableReadPipe.html
  Class
  Class
  PRIVATE
  Undocumented
- twisted.internet._pollingfile._PollableReadPipe.__init__
  twisted.internet._pollingfile._PollableReadPipe.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet._pollingfile._PollableReadPipe.pipe
  twisted.internet._pollingfile._PollableReadPipe.html#pipe
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet._pollingfile._PollableReadPipe.receivedCallback
  twisted.internet._pollingfile._PollableReadPipe.html#receivedCallback
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet._pollingfile._PollableReadPipe.lostCallback
  twisted.internet._pollingfile._PollableReadPipe.html#lostCallback
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet._pollingfile._PollableReadPipe.checkWork
  twisted.internet._pollingfile._PollableReadPipe.html#checkWork
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet._pollingfile._PollableReadPipe.cleanup
  twisted.internet._pollingfile._PollableReadPipe.html#cleanup
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet._pollingfile._PollableReadPipe.close
  twisted.internet._pollingfile._PollableReadPipe.html#close
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet._pollingfile._PollableReadPipe.stopProducing
  twisted.internet._pollingfile._PollableReadPipe.html#stopProducing
  Function
  Method
  PUBLIC
  Stop producing data.
- twisted.internet._pollingfile._PollableReadPipe.pauseProducing
  twisted.internet._pollingfile._PollableReadPipe.html#pauseProducing
  Function
  Method
  PUBLIC
  Pause producing data.
- twisted.internet._pollingfile._PollableReadPipe.resumeProducing
  twisted.internet._pollingfile._PollableReadPipe.html#resumeProducing
  Function
  Method
  PUBLIC
  Resume producing data.
- twisted.internet._pollingfile.FULL_BUFFER_SIZE
  twisted.internet._pollingfile.html#FULL_BUFFER_SIZE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet._pollingfile._PollableWritePipe
  twisted.internet._pollingfile._PollableWritePipe.html
  Class
  Class
  PRIVATE
  No class docstring; 0/7 instance variable, 4/10 methods documented
- twisted.internet._pollingfile._PollableWritePipe.__init__
  twisted.internet._pollingfile._PollableWritePipe.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet._pollingfile._PollableWritePipe.disconnecting
  twisted.internet._pollingfile._PollableWritePipe.html#disconnecting
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet._pollingfile._PollableWritePipe.producer
  twisted.internet._pollingfile._PollableWritePipe.html#producer
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet._pollingfile._PollableWritePipe.producerPaused
  twisted.internet._pollingfile._PollableWritePipe.html#producerPaused
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet._pollingfile._PollableWritePipe.streamingProducer
  twisted.internet._pollingfile._PollableWritePipe.html#streamingProducer
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet._pollingfile._PollableWritePipe.outQueue
  twisted.internet._pollingfile._PollableWritePipe.html#outQueue
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet._pollingfile._PollableWritePipe.writePipe
  twisted.internet._pollingfile._PollableWritePipe.html#writePipe
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet._pollingfile._PollableWritePipe.lostCallback
  twisted.internet._pollingfile._PollableWritePipe.html#lostCallback
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet._pollingfile._PollableWritePipe.close
  twisted.internet._pollingfile._PollableWritePipe.html#close
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet._pollingfile._PollableWritePipe.bufferFull
  twisted.internet._pollingfile._PollableWritePipe.html#bufferFull
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet._pollingfile._PollableWritePipe.bufferEmpty
  twisted.internet._pollingfile._PollableWritePipe.html#bufferEmpty
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet._pollingfile._PollableWritePipe.registerProducer
  twisted.internet._pollingfile._PollableWritePipe.html#registerProducer
  Function
  Method
  PUBLIC
  Register to receive data from a producer.
- twisted.internet._pollingfile._PollableWritePipe.unregisterProducer
  twisted.internet._pollingfile._PollableWritePipe.html#unregisterProducer
  Function
  Method
  PUBLIC
  Stop consuming data from a producer, without disconnecting.
- twisted.internet._pollingfile._PollableWritePipe.writeConnectionLost
  twisted.internet._pollingfile._PollableWritePipe.html#writeConnectionLost
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet._pollingfile._PollableWritePipe.writeSequence
  twisted.internet._pollingfile._PollableWritePipe.html#writeSequence
  Function
  Method
  PUBLIC
  Append a `list` or `tuple` of bytes to the output buffer.
- twisted.internet._pollingfile._PollableWritePipe.write
  twisted.internet._pollingfile._PollableWritePipe.html#write
  Function
  Method
  PUBLIC
  Append some bytes to the output buffer.
- twisted.internet._pollingfile._PollableWritePipe.checkWork
  twisted.internet._pollingfile._PollableWritePipe.html#checkWork
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.stdio.StandardIO
  twisted.internet.stdio.StandardIO.html
  Class
  Class
  PUBLIC
  No class docstring; 0/5 instance variable, 0/1 class variable, 1/15 method documented
- twisted.internet.stdio.StandardIO.disconnecting
  twisted.internet.stdio.StandardIO.html#disconnecting
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.stdio.StandardIO.disconnected
  twisted.internet.stdio.StandardIO.html#disconnected
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.stdio.StandardIO.__init__
  twisted.internet.stdio.StandardIO.html#__init__
  Function
  Method
  PUBLIC
  Start talking to standard IO with the given protocol.
- twisted.internet.stdio.StandardIO.proto
  twisted.internet.stdio.StandardIO.html#proto
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.stdio.StandardIO.stdin
  twisted.internet.stdio.StandardIO.html#stdin
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.stdio.StandardIO.stdout
  twisted.internet.stdio.StandardIO.html#stdout
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.stdio.StandardIO.dataReceived
  twisted.internet.stdio.StandardIO.html#dataReceived
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.stdio.StandardIO.readConnectionLost
  twisted.internet.stdio.StandardIO.html#readConnectionLost
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.stdio.StandardIO.writeConnectionLost
  twisted.internet.stdio.StandardIO.html#writeConnectionLost
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.stdio.StandardIO.connsLost
  twisted.internet.stdio.StandardIO.html#connsLost
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet.stdio.StandardIO.checkConnLost
  twisted.internet.stdio.StandardIO.html#checkConnLost
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.stdio.StandardIO.write
  twisted.internet.stdio.StandardIO.html#write
  Function
  Method
  PUBLIC
  Write some data to the physical connection, in sequence, in a non-blocking fashion.
- twisted.internet.stdio.StandardIO.writeSequence
  twisted.internet.stdio.StandardIO.html#writeSequence
  Function
  Method
  PUBLIC
  Write an iterable of byte strings to the physical connection.
- twisted.internet.stdio.StandardIO.loseConnection
  twisted.internet.stdio.StandardIO.html#loseConnection
  Function
  Method
  PUBLIC
  Close my connection, after writing all pending data.
- twisted.internet.stdio.StandardIO.getPeer
  twisted.internet.stdio.StandardIO.html#getPeer
  Function
  Method
  PUBLIC
  Get the remote address of this connection.
- twisted.internet.stdio.StandardIO.getHost
  twisted.internet.stdio.StandardIO.html#getHost
  Function
  Method
  PUBLIC
  Similar to getPeer, but returns an address describing this side of the connection.
- twisted.internet.stdio.StandardIO.registerProducer
  twisted.internet.stdio.StandardIO.html#registerProducer
  Function
  Method
  PUBLIC
  Register to receive data from a producer.
- twisted.internet.stdio.StandardIO.unregisterProducer
  twisted.internet.stdio.StandardIO.html#unregisterProducer
  Function
  Method
  PUBLIC
  Stop consuming data from a producer, without disconnecting.
- twisted.internet.stdio.StandardIO.stopProducing
  twisted.internet.stdio.StandardIO.html#stopProducing
  Function
  Method
  PUBLIC
  Stop producing data.
- twisted.internet.stdio.StandardIO.pauseProducing
  twisted.internet.stdio.StandardIO.html#pauseProducing
  Function
  Method
  PUBLIC
  Pause producing data.
- twisted.internet.stdio.StandardIO.resumeProducing
  twisted.internet.stdio.StandardIO.html#resumeProducing
  Function
  Method
  PUBLIC
  Resume producing data.
- twisted.internet.stdio.PipeAddress
  twisted.internet.stdio.PipeAddress.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.python.systemd.ListenFDs
  twisted.python.systemd.ListenFDs.html
  Class
  Class
  PUBLIC
  `ListenFDs` provides access to file descriptors inherited from systemd.
- twisted.python.systemd.ListenFDs._START
  twisted.python.systemd.ListenFDs.html#_START
  Attribute
  Constant
  PRIVATE
  File descriptors inherited from systemd are always consecutively numbered, with a fixed lowest "starting" descriptor. This gives the default starting descriptor. Since this must agree with the value systemd is using, it typically should not be overridden.
- twisted.python.systemd.ListenFDs._descriptors
  twisted.python.systemd.ListenFDs.html#_descriptors
  Attribute
  Instance Variable
  PRIVATE
  A `list` of `int` giving the descriptors which were inherited.
- twisted.python.systemd.ListenFDs.__init__
  twisted.python.systemd.ListenFDs.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.python.systemd.ListenFDs.fromEnvironment
  twisted.python.systemd.ListenFDs.html#fromEnvironment
  Function
  Class Method
  PUBLIC
  No summary
- twisted.python.systemd.ListenFDs.inheritedDescriptors
  twisted.python.systemd.ListenFDs.html#inheritedDescriptors
  Function
  Method
  PUBLIC
  No summary
- twisted.internet.endpoints._WrappingProtocol
  twisted.internet.endpoints._WrappingProtocol.html
  Class
  Class
  PRIVATE
  Wrap another protocol in order to notify my user when a connection has been made.
- twisted.internet.endpoints._WrappingProtocol.__init__
  twisted.internet.endpoints._WrappingProtocol.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.internet.endpoints._WrappingProtocol._connectedDeferred
  twisted.internet.endpoints._WrappingProtocol.html#_connectedDeferred
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.endpoints._WrappingProtocol._wrappedProtocol
  twisted.internet.endpoints._WrappingProtocol.html#_wrappedProtocol
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.endpoints._WrappingProtocol.logPrefix
  twisted.internet.endpoints._WrappingProtocol.html#logPrefix
  Function
  Method
  PUBLIC
  Transparently pass through the wrapped protocol's log prefix.
- twisted.internet.endpoints._WrappingProtocol.connectionMade
  twisted.internet.endpoints._WrappingProtocol.html#connectionMade
  Function
  Method
  PUBLIC
  Connect the `self._wrappedProtocol` to our `self.transport` and callback `self._connectedDeferred` with the `self._wrappedProtocol`
- twisted.internet.endpoints._WrappingProtocol.dataReceived
  twisted.internet.endpoints._WrappingProtocol.html#dataReceived
  Function
  Method
  PUBLIC
  Proxy `dataReceived` calls to our `self._wrappedProtocol`
- twisted.internet.endpoints._WrappingProtocol.fileDescriptorReceived
  twisted.internet.endpoints._WrappingProtocol.html#fileDescriptorReceived
  Function
  Method
  PUBLIC
  Proxy `fileDescriptorReceived` calls to our `self._wrappedProtocol`
- twisted.internet.endpoints._WrappingProtocol.connectionLost
  twisted.internet.endpoints._WrappingProtocol.html#connectionLost
  Function
  Method
  PUBLIC
  Proxy `connectionLost` calls to our `self._wrappedProtocol`
- twisted.internet.endpoints._WrappingProtocol.readConnectionLost
  twisted.internet.endpoints._WrappingProtocol.html#readConnectionLost
  Function
  Method
  PUBLIC
  Proxy `IHalfCloseableProtocol.readConnectionLost` to our `self._wrappedProtocol`
- twisted.internet.endpoints._WrappingProtocol.writeConnectionLost
  twisted.internet.endpoints._WrappingProtocol.html#writeConnectionLost
  Function
  Method
  PUBLIC
  Proxy `IHalfCloseableProtocol.writeConnectionLost` to our `self._wrappedProtocol`
- twisted.internet.endpoints._WrappingProtocol.handshakeCompleted
  twisted.internet.endpoints._WrappingProtocol.html#handshakeCompleted
  Function
  Method
  PUBLIC
  Proxy `interfaces.IHandshakeListener` to our `self._wrappedProtocol`.
- twisted.internet.endpoints._WrappingFactory
  twisted.internet.endpoints._WrappingFactory.html
  Class
  Class
  PRIVATE
  Wrap a factory in order to wrap the protocols it builds.
- twisted.internet.endpoints._WrappingFactory._wrappedFactory
  twisted.internet.endpoints._WrappingFactory.html#_wrappedFactory
  Attribute
  Instance Variable
  PRIVATE
  A provider of IProtocolFactory whose buildProtocol method will be called and whose resulting protocol will be wrapped.
- twisted.internet.endpoints._WrappingFactory._onConnection
  twisted.internet.endpoints._WrappingFactory.html#_onConnection
  Attribute
  Instance Variable
  PRIVATE
  A `Deferred` that fires when the protocol is connected
- twisted.internet.endpoints._WrappingFactory._connector
  twisted.internet.endpoints._WrappingFactory.html#_connector
  Attribute
  Instance Variable
  PRIVATE
  A `connector` that is managing the current or previous connection attempt.
- twisted.internet.endpoints._WrappingFactory.__init__
  twisted.internet.endpoints._WrappingFactory.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.internet.endpoints._WrappingFactory.startedConnecting
  twisted.internet.endpoints._WrappingFactory.html#startedConnecting
  Function
  Method
  PUBLIC
  A connection attempt was started. Remember the connector which started said attempt, for use later.
- twisted.internet.endpoints._WrappingFactory._canceller
  twisted.internet.endpoints._WrappingFactory.html#_canceller
  Function
  Method
  PRIVATE
  The outgoing connection attempt was cancelled. Fail that `Deferred` with an `error.ConnectingCancelledError`.
- twisted.internet.endpoints._WrappingFactory.doStart
  twisted.internet.endpoints._WrappingFactory.html#doStart
  Function
  Method
  PUBLIC
  Start notifications are passed straight through to the wrapped factory.
- twisted.internet.endpoints._WrappingFactory.doStop
  twisted.internet.endpoints._WrappingFactory.html#doStop
  Function
  Method
  PUBLIC
  Stop notifications are passed straight through to the wrapped factory.
- twisted.internet.endpoints._WrappingFactory.buildProtocol
  twisted.internet.endpoints._WrappingFactory.html#buildProtocol
  Function
  Method
  PUBLIC
  Proxy `buildProtocol` to our `self._wrappedFactory` or errback the `self._onConnection` `Deferred` if the wrapped factory raises an exception or returns `None`.
- twisted.internet.endpoints._WrappingFactory.clientConnectionFailed
  twisted.internet.endpoints._WrappingFactory.html#clientConnectionFailed
  Function
  Method
  PUBLIC
  Errback the `self._onConnection` `Deferred` when the client connection fails.
- twisted.internet.endpoints.StandardIOEndpoint
  twisted.internet.endpoints.StandardIOEndpoint.html
  Class
  Class
  PUBLIC
  A Standard Input/Output endpoint
- twisted.internet.endpoints.StandardIOEndpoint._stdio
  twisted.internet.endpoints.StandardIOEndpoint.html#_stdio
  Attribute
  Instance Variable
  PRIVATE
  a callable, like `stdio.StandardIO`, which takes an `IProtocol` provider and a `reactor` keyword argument (interface dependent upon your platform).
- twisted.internet.endpoints.StandardIOEndpoint.__init__
  twisted.internet.endpoints.StandardIOEndpoint.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.internet.endpoints.StandardIOEndpoint._reactor
  twisted.internet.endpoints.StandardIOEndpoint.html#_reactor
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.endpoints.StandardIOEndpoint.listen
  twisted.internet.endpoints.StandardIOEndpoint.html#listen
  Function
  Method
  PUBLIC
  Implement `IStreamServerEndpoint.listen` to listen on stdin/stdout
- twisted.internet.endpoints._IProcessTransportWithConsumerAndProducer
  twisted.internet.endpoints._IProcessTransportWithConsumerAndProducer.html
  Class
  Interface
  PRIVATE
  An `_IProcessTransportWithConsumerAndProducer` combines various interfaces to work around the issue that `interfaces.IProcessTransport` is incompletely defined and doesn't specify flow-control interfaces, and that ...
- twisted.internet.endpoints._ProcessEndpointTransport
  twisted.internet.endpoints._ProcessEndpointTransport.html
  Class
  Class
  PRIVATE
  An `ITransport`, `IProcessTransport`, `IConsumer`, and `IPushProducer` provider for the `IProtocol` instance passed to the process endpoint.
- twisted.internet.endpoints._ProcessEndpointTransport._process
  twisted.internet.endpoints._ProcessEndpointTransport.html#_process
  Attribute
  Instance Variable
  PRIVATE
  An active process transport which will be used by write methods on this object to write data to a child process.
- twisted.internet.endpoints._WrapIProtocol
  twisted.internet.endpoints._WrapIProtocol.html
  Class
  Class
  PRIVATE
  An `IProcessProtocol` provider that wraps an `IProtocol`.
- twisted.internet.endpoints._WrapIProtocol.transport
  twisted.internet.endpoints._WrapIProtocol.html#transport
  Attribute
  Instance Variable
  PUBLIC
  A `_ProcessEndpointTransport` provider that is hooked to the wrapped `IProtocol` provider.
- twisted.internet.endpoints._WrapIProtocol.__init__
  twisted.internet.endpoints._WrapIProtocol.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.internet.endpoints._WrapIProtocol.protocol
  twisted.internet.endpoints._WrapIProtocol.html#protocol
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.endpoints._WrapIProtocol.errFlag
  twisted.internet.endpoints._WrapIProtocol.html#errFlag
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.endpoints._WrapIProtocol.executable
  twisted.internet.endpoints._WrapIProtocol.html#executable
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.endpoints._WrapIProtocol.makeConnection
  twisted.internet.endpoints._WrapIProtocol.html#makeConnection
  Function
  Method
  PUBLIC
  Call `IProtocol` provider's makeConnection method with an `ITransport` provider.
- twisted.internet.endpoints._WrapIProtocol.childDataReceived
  twisted.internet.endpoints._WrapIProtocol.html#childDataReceived
  Function
  Method
  PUBLIC
  This is called with data from the process's stdout or stderr pipes. It checks the status of the errFlag to setermine if stderr should be logged (default) or dropped.
- twisted.internet.endpoints._WrapIProtocol.processEnded
  twisted.internet.endpoints._WrapIProtocol.html#processEnded
  Function
  Method
  PUBLIC
  If the process ends with `error.ProcessDone`, this method calls the `IProtocol` provider's `connectionLost` with a `error.ConnectionDone`
- twisted.internet.endpoints.StandardErrorBehavior
  twisted.internet.endpoints.StandardErrorBehavior.html
  Class
  Class
  PUBLIC
  Constants used in ProcessEndpoint to decide what to do with stderr.
- twisted.internet.endpoints.StandardErrorBehavior.LOG
  twisted.internet.endpoints.StandardErrorBehavior.html#LOG
  Attribute
  Constant
  PUBLIC
  Indicates that stderr is to be logged.
- twisted.internet.endpoints.StandardErrorBehavior.DROP
  twisted.internet.endpoints.StandardErrorBehavior.html#DROP
  Attribute
  Constant
  PUBLIC
  Indicates that stderr is to be dropped (and not logged).
- twisted.internet.endpoints.ProcessEndpoint
  twisted.internet.endpoints.ProcessEndpoint.html
  Class
  Class
  PUBLIC
  An endpoint for child processes
- twisted.internet.endpoints.ProcessEndpoint._spawnProcess
  twisted.internet.endpoints.ProcessEndpoint.html#_spawnProcess
  Attribute
  Instance Variable
  PRIVATE
  A hook used for testing the spawning of child process.
- twisted.internet.endpoints.ProcessEndpoint.__init__
  twisted.internet.endpoints.ProcessEndpoint.html#__init__
  Function
  Method
  PUBLIC
  See `IReactorProcess.spawnProcess`.
- twisted.internet.endpoints.ProcessEndpoint._reactor
  twisted.internet.endpoints.ProcessEndpoint.html#_reactor
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.endpoints.ProcessEndpoint._executable
  twisted.internet.endpoints.ProcessEndpoint.html#_executable
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.endpoints.ProcessEndpoint._args
  twisted.internet.endpoints.ProcessEndpoint.html#_args
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.endpoints.ProcessEndpoint._env
  twisted.internet.endpoints.ProcessEndpoint.html#_env
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.endpoints.ProcessEndpoint._path
  twisted.internet.endpoints.ProcessEndpoint.html#_path
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.endpoints.ProcessEndpoint._uid
  twisted.internet.endpoints.ProcessEndpoint.html#_uid
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.endpoints.ProcessEndpoint._gid
  twisted.internet.endpoints.ProcessEndpoint.html#_gid
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.endpoints.ProcessEndpoint._usePTY
  twisted.internet.endpoints.ProcessEndpoint.html#_usePTY
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.endpoints.ProcessEndpoint._childFDs
  twisted.internet.endpoints.ProcessEndpoint.html#_childFDs
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.endpoints.ProcessEndpoint._errFlag
  twisted.internet.endpoints.ProcessEndpoint.html#_errFlag
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.endpoints.ProcessEndpoint.connect
  twisted.internet.endpoints.ProcessEndpoint.html#connect
  Function
  Method
  PUBLIC
  Implement `IStreamClientEndpoint.connect` to launch a child process and connect it to a protocol created by `protocolFactory`.
- twisted.internet.endpoints._TCPServerEndpoint
  twisted.internet.endpoints._TCPServerEndpoint.html
  Class
  Class
  PRIVATE
  A TCP server endpoint interface
- twisted.internet.endpoints._TCPServerEndpoint.__init__
  twisted.internet.endpoints._TCPServerEndpoint.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.internet.endpoints._TCPServerEndpoint._reactor
  twisted.internet.endpoints._TCPServerEndpoint.html#_reactor
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.endpoints._TCPServerEndpoint._port
  twisted.internet.endpoints._TCPServerEndpoint.html#_port
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.endpoints._TCPServerEndpoint._backlog
  twisted.internet.endpoints._TCPServerEndpoint.html#_backlog
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.endpoints._TCPServerEndpoint._interface
  twisted.internet.endpoints._TCPServerEndpoint.html#_interface
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.endpoints._TCPServerEndpoint.listen
  twisted.internet.endpoints._TCPServerEndpoint.html#listen
  Function
  Method
  PUBLIC
  Implement `IStreamServerEndpoint.listen` to listen on a TCP socket
- twisted.internet.endpoints.TCP4ServerEndpoint
  twisted.internet.endpoints.TCP4ServerEndpoint.html
  Class
  Class
  PUBLIC
  Implements TCP server endpoint with an IPv4 configuration
- twisted.internet.endpoints.TCP4ServerEndpoint.__init__
  twisted.internet.endpoints.TCP4ServerEndpoint.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.internet.endpoints.TCP6ServerEndpoint
  twisted.internet.endpoints.TCP6ServerEndpoint.html
  Class
  Class
  PUBLIC
  Implements TCP server endpoint with an IPv6 configuration
- twisted.internet.endpoints.TCP6ServerEndpoint.__init__
  twisted.internet.endpoints.TCP6ServerEndpoint.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.internet.endpoints.TCP4ClientEndpoint
  twisted.internet.endpoints.TCP4ClientEndpoint.html
  Class
  Class
  PUBLIC
  TCP client endpoint with an IPv4 configuration.
- twisted.internet.endpoints.TCP4ClientEndpoint.__init__
  twisted.internet.endpoints.TCP4ClientEndpoint.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.internet.endpoints.TCP4ClientEndpoint._reactor
  twisted.internet.endpoints.TCP4ClientEndpoint.html#_reactor
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.endpoints.TCP4ClientEndpoint._host
  twisted.internet.endpoints.TCP4ClientEndpoint.html#_host
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.endpoints.TCP4ClientEndpoint._port
  twisted.internet.endpoints.TCP4ClientEndpoint.html#_port
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.endpoints.TCP4ClientEndpoint._timeout
  twisted.internet.endpoints.TCP4ClientEndpoint.html#_timeout
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.endpoints.TCP4ClientEndpoint._bindAddress
  twisted.internet.endpoints.TCP4ClientEndpoint.html#_bindAddress
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.endpoints.TCP4ClientEndpoint.connect
  twisted.internet.endpoints.TCP4ClientEndpoint.html#connect
  Function
  Method
  PUBLIC
  Implement `IStreamClientEndpoint.connect` to connect via TCP.
- twisted.internet.endpoints.TCP6ClientEndpoint
  twisted.internet.endpoints.TCP6ClientEndpoint.html
  Class
  Class
  PUBLIC
  TCP client endpoint with an IPv6 configuration.
- twisted.internet.endpoints.TCP6ClientEndpoint._getaddrinfo
  twisted.internet.endpoints.TCP6ClientEndpoint.html#_getaddrinfo
  Attribute
  Instance Variable
  PRIVATE
  A hook used for testing name resolution.
- twisted.internet.endpoints.TCP6ClientEndpoint._deferToThread
  twisted.internet.endpoints.TCP6ClientEndpoint.html#_deferToThread
  Attribute
  Instance Variable
  PRIVATE
  A hook used for testing deferToThread.
- twisted.internet.endpoints.TCP6ClientEndpoint._GAI_ADDRESS
  twisted.internet.endpoints.TCP6ClientEndpoint.html#_GAI_ADDRESS
  Attribute
  Constant
  PRIVATE
  Index of the address portion in result of getaddrinfo to be used.
- twisted.internet.endpoints.TCP6ClientEndpoint._GAI_ADDRESS_HOST
  twisted.internet.endpoints.TCP6ClientEndpoint.html#_GAI_ADDRESS_HOST
  Attribute
  Constant
  PRIVATE
  Index of the actual host-address in the 5-tuple `_GAI_ADDRESS`.
- twisted.internet.endpoints.TCP6ClientEndpoint.__init__
  twisted.internet.endpoints.TCP6ClientEndpoint.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.internet.endpoints.TCP6ClientEndpoint._reactor
  twisted.internet.endpoints.TCP6ClientEndpoint.html#_reactor
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.endpoints.TCP6ClientEndpoint._host
  twisted.internet.endpoints.TCP6ClientEndpoint.html#_host
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.endpoints.TCP6ClientEndpoint._port
  twisted.internet.endpoints.TCP6ClientEndpoint.html#_port
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.endpoints.TCP6ClientEndpoint._timeout
  twisted.internet.endpoints.TCP6ClientEndpoint.html#_timeout
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.endpoints.TCP6ClientEndpoint._bindAddress
  twisted.internet.endpoints.TCP6ClientEndpoint.html#_bindAddress
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.endpoints.TCP6ClientEndpoint.connect
  twisted.internet.endpoints.TCP6ClientEndpoint.html#connect
  Function
  Method
  PUBLIC
  Implement `IStreamClientEndpoint.connect` to connect via TCP, once the hostname resolution is done.
- twisted.internet.endpoints.TCP6ClientEndpoint._nameResolution
  twisted.internet.endpoints.TCP6ClientEndpoint.html#_nameResolution
  Function
  Method
  PRIVATE
  Resolve the hostname string into a tuple containing the host IPv6 address.
- twisted.internet.endpoints.TCP6ClientEndpoint._resolvedHostConnect
  twisted.internet.endpoints.TCP6ClientEndpoint.html#_resolvedHostConnect
  Function
  Method
  PRIVATE
  Connect to the server using the resolved hostname.
- twisted.internet.endpoints._SimpleHostnameResolver
  twisted.internet.endpoints._SimpleHostnameResolver.html
  Class
  Class
  PRIVATE
  An `IHostnameResolver` provider that invokes a provided callable to resolve hostnames.
- twisted.internet.endpoints._SimpleHostnameResolver._nameResolution
  twisted.internet.endpoints._SimpleHostnameResolver.html#_nameResolution
  Attribute
  Instance Variable
  PRIVATE
  the callable `resolveHostName` invokes to resolve hostnames.
- twisted.internet.endpoints._SimpleHostnameResolver._log
  twisted.internet.endpoints._SimpleHostnameResolver.html#_log
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.internet.endpoints._SimpleHostnameResolver.__init__
  twisted.internet.endpoints._SimpleHostnameResolver.html#__init__
  Function
  Method
  PUBLIC
  Create a `_SimpleHostnameResolver` instance.
- twisted.internet.endpoints._SimpleHostnameResolver.resolveHostName
  twisted.internet.endpoints._SimpleHostnameResolver.html#resolveHostName
  Function
  Method
  PUBLIC
  Initiate a hostname resolution.
- twisted.internet.endpoints.HostnameEndpoint
  twisted.internet.endpoints.HostnameEndpoint.html
  Class
  Class
  PUBLIC
  A name-based endpoint that connects to the fastest amongst the resolved host addresses.
- twisted.internet.endpoints.HostnameEndpoint._DEFAULT_ATTEMPT_DELAY
  twisted.internet.endpoints.HostnameEndpoint.html#_DEFAULT_ATTEMPT_DELAY
  Attribute
  Constant
  PRIVATE
  The default time to use between attempts, in seconds, when no `attemptDelay` is given to `HostnameEndpoint.__init__`.
- twisted.internet.endpoints.HostnameEndpoint._hostText
  twisted.internet.endpoints.HostnameEndpoint.html#_hostText
  Attribute
  Instance Variable
  PRIVATE
  the textual representation of the hostname passed to the constructor. Used to pass to the reactor's hostname resolver.
- twisted.internet.endpoints.HostnameEndpoint._hostBytes
  twisted.internet.endpoints.HostnameEndpoint.html#_hostBytes
  Attribute
  Instance Variable
  PRIVATE
  the encoded bytes-representation of the hostname passed to the constructor. Used to construct the `HostnameAddress` associated with this endpoint.
- twisted.internet.endpoints.HostnameEndpoint._hostStr
  twisted.internet.endpoints.HostnameEndpoint.html#_hostStr
  Attribute
  Instance Variable
  PRIVATE
  the native-string representation of the hostname passed to the constructor, used for exception construction
- twisted.internet.endpoints.HostnameEndpoint._badHostname
  twisted.internet.endpoints.HostnameEndpoint.html#_badHostname
  Attribute
  Instance Variable
  PRIVATE
  a flag - hopefully false! - indicating that an invalid hostname was passed to the constructor. This might be a textual hostname that isn't valid IDNA, or non-ASCII bytes.
- twisted.internet.endpoints.HostnameEndpoint._getaddrinfo
  twisted.internet.endpoints.HostnameEndpoint.html#_getaddrinfo
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.internet.endpoints.HostnameEndpoint._deferToThread
  twisted.internet.endpoints.HostnameEndpoint.html#_deferToThread
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.internet.endpoints.HostnameEndpoint.__init__
  twisted.internet.endpoints.HostnameEndpoint.html#__init__
  Function
  Method
  PUBLIC
  Create a `HostnameEndpoint`.
- twisted.internet.endpoints.HostnameEndpoint._reactor
  twisted.internet.endpoints.HostnameEndpoint.html#_reactor
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.endpoints.HostnameEndpoint._nameResolver
  twisted.internet.endpoints.HostnameEndpoint.html#_nameResolver
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.endpoints.HostnameEndpoint._port
  twisted.internet.endpoints.HostnameEndpoint.html#_port
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.endpoints.HostnameEndpoint._timeout
  twisted.internet.endpoints.HostnameEndpoint.html#_timeout
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.endpoints.HostnameEndpoint._bindAddress
  twisted.internet.endpoints.HostnameEndpoint.html#_bindAddress
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.endpoints.HostnameEndpoint._attemptDelay
  twisted.internet.endpoints.HostnameEndpoint.html#_attemptDelay
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.endpoints.HostnameEndpoint.__repr__
  twisted.internet.endpoints.HostnameEndpoint.html#__repr__
  Function
  Method
  PUBLIC
  Produce a string representation of the `HostnameEndpoint`.
- twisted.internet.endpoints.HostnameEndpoint._getNameResolverAndMaybeWarn
  twisted.internet.endpoints.HostnameEndpoint.html#_getNameResolverAndMaybeWarn
  Function
  Method
  PRIVATE
  Retrieve a `nameResolver` callable and warn the caller's caller that using a reactor which doesn't provide `IReactorPluggableNameResolver` is deprecated.
- twisted.internet.endpoints.HostnameEndpoint._hostAsBytesAndText
  twisted.internet.endpoints.HostnameEndpoint.html#_hostAsBytesAndText
  Function
  Static Method
  PRIVATE
  For various reasons (documented in the `@ivar`'s in the class docstring) we need both a textual and a binary representation of the hostname given to the constructor. For compatibility and convenience, we accept both textual and binary representations of the hostname, save the form that was passed, and convert into the other form...
- twisted.internet.endpoints.HostnameEndpoint.connect
  twisted.internet.endpoints.HostnameEndpoint.html#connect
  Function
  Method
  PUBLIC
  Attempts a connection to each resolved address, and returns a connection which is established first.
- twisted.internet.endpoints.HostnameEndpoint._fallbackNameResolution
  twisted.internet.endpoints.HostnameEndpoint.html#_fallbackNameResolution
  Function
  Method
  PRIVATE
  Resolve the hostname string into a tuple containing the host address. This is method is only used when the reactor does not provide `IReactorPluggableNameResolver`.
- twisted.internet.endpoints.SSL4ServerEndpoint
  twisted.internet.endpoints.SSL4ServerEndpoint.html
  Class
  Class
  PUBLIC
  SSL secured TCP server endpoint with an IPv4 configuration.
- twisted.internet.endpoints.SSL4ServerEndpoint.__init__
  twisted.internet.endpoints.SSL4ServerEndpoint.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.internet.endpoints.SSL4ServerEndpoint._reactor
  twisted.internet.endpoints.SSL4ServerEndpoint.html#_reactor
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.endpoints.SSL4ServerEndpoint._port
  twisted.internet.endpoints.SSL4ServerEndpoint.html#_port
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.endpoints.SSL4ServerEndpoint._sslContextFactory
  twisted.internet.endpoints.SSL4ServerEndpoint.html#_sslContextFactory
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.endpoints.SSL4ServerEndpoint._backlog
  twisted.internet.endpoints.SSL4ServerEndpoint.html#_backlog
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.endpoints.SSL4ServerEndpoint._interface
  twisted.internet.endpoints.SSL4ServerEndpoint.html#_interface
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.endpoints.SSL4ServerEndpoint.listen
  twisted.internet.endpoints.SSL4ServerEndpoint.html#listen
  Function
  Method
  PUBLIC
  Implement `IStreamServerEndpoint.listen` to listen for SSL on a TCP socket.
- twisted.internet.endpoints.SSL4ClientEndpoint
  twisted.internet.endpoints.SSL4ClientEndpoint.html
  Class
  Class
  PUBLIC
  SSL secured TCP client endpoint with an IPv4 configuration
- twisted.internet.endpoints.SSL4ClientEndpoint.__init__
  twisted.internet.endpoints.SSL4ClientEndpoint.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.internet.endpoints.SSL4ClientEndpoint._reactor
  twisted.internet.endpoints.SSL4ClientEndpoint.html#_reactor
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.endpoints.SSL4ClientEndpoint._host
  twisted.internet.endpoints.SSL4ClientEndpoint.html#_host
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.endpoints.SSL4ClientEndpoint._port
  twisted.internet.endpoints.SSL4ClientEndpoint.html#_port
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.endpoints.SSL4ClientEndpoint._sslContextFactory
  twisted.internet.endpoints.SSL4ClientEndpoint.html#_sslContextFactory
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.endpoints.SSL4ClientEndpoint._timeout
  twisted.internet.endpoints.SSL4ClientEndpoint.html#_timeout
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.endpoints.SSL4ClientEndpoint._bindAddress
  twisted.internet.endpoints.SSL4ClientEndpoint.html#_bindAddress
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.endpoints.SSL4ClientEndpoint.connect
  twisted.internet.endpoints.SSL4ClientEndpoint.html#connect
  Function
  Method
  PUBLIC
  Implement `IStreamClientEndpoint.connect` to connect with SSL over TCP.
- twisted.internet.endpoints.UNIXServerEndpoint
  twisted.internet.endpoints.UNIXServerEndpoint.html
  Class
  Class
  PUBLIC
  UnixSocket server endpoint.
- twisted.internet.endpoints.UNIXServerEndpoint.__init__
  twisted.internet.endpoints.UNIXServerEndpoint.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.internet.endpoints.UNIXServerEndpoint._reactor
  twisted.internet.endpoints.UNIXServerEndpoint.html#_reactor
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.endpoints.UNIXServerEndpoint._address
  twisted.internet.endpoints.UNIXServerEndpoint.html#_address
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.endpoints.UNIXServerEndpoint._backlog
  twisted.internet.endpoints.UNIXServerEndpoint.html#_backlog
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.endpoints.UNIXServerEndpoint._mode
  twisted.internet.endpoints.UNIXServerEndpoint.html#_mode
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.endpoints.UNIXServerEndpoint._wantPID
  twisted.internet.endpoints.UNIXServerEndpoint.html#_wantPID
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.endpoints.UNIXServerEndpoint.listen
  twisted.internet.endpoints.UNIXServerEndpoint.html#listen
  Function
  Method
  PUBLIC
  Implement `IStreamServerEndpoint.listen` to listen on a UNIX socket.
- twisted.internet.endpoints.UNIXClientEndpoint
  twisted.internet.endpoints.UNIXClientEndpoint.html
  Class
  Class
  PUBLIC
  UnixSocket client endpoint.
- twisted.internet.endpoints.UNIXClientEndpoint.__init__
  twisted.internet.endpoints.UNIXClientEndpoint.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.internet.endpoints.UNIXClientEndpoint._reactor
  twisted.internet.endpoints.UNIXClientEndpoint.html#_reactor
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.endpoints.UNIXClientEndpoint._path
  twisted.internet.endpoints.UNIXClientEndpoint.html#_path
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.endpoints.UNIXClientEndpoint._timeout
  twisted.internet.endpoints.UNIXClientEndpoint.html#_timeout
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.endpoints.UNIXClientEndpoint._checkPID
  twisted.internet.endpoints.UNIXClientEndpoint.html#_checkPID
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.endpoints.UNIXClientEndpoint.connect
  twisted.internet.endpoints.UNIXClientEndpoint.html#connect
  Function
  Method
  PUBLIC
  Implement `IStreamClientEndpoint.connect` to connect via a UNIX Socket
- twisted.internet.endpoints.AdoptedStreamServerEndpoint
  twisted.internet.endpoints.AdoptedStreamServerEndpoint.html
  Class
  Class
  PUBLIC
  An endpoint for listening on a file descriptor initialized outside of Twisted.
- twisted.internet.endpoints.AdoptedStreamServerEndpoint._used
  twisted.internet.endpoints.AdoptedStreamServerEndpoint.html#_used
  Attribute
  Instance Variable
  PRIVATE
  A `bool` indicating whether this endpoint has been used to listen with a factory yet. `True` if so.
- twisted.internet.endpoints.AdoptedStreamServerEndpoint._setNonBlocking
  twisted.internet.endpoints.AdoptedStreamServerEndpoint.html#_setNonBlocking
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.internet.endpoints.AdoptedStreamServerEndpoint.__init__
  twisted.internet.endpoints.AdoptedStreamServerEndpoint.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.internet.endpoints.AdoptedStreamServerEndpoint.reactor
  twisted.internet.endpoints.AdoptedStreamServerEndpoint.html#reactor
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.endpoints.AdoptedStreamServerEndpoint.fileno
  twisted.internet.endpoints.AdoptedStreamServerEndpoint.html#fileno
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.endpoints.AdoptedStreamServerEndpoint.addressFamily
  twisted.internet.endpoints.AdoptedStreamServerEndpoint.html#addressFamily
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.endpoints.AdoptedStreamServerEndpoint.listen
  twisted.internet.endpoints.AdoptedStreamServerEndpoint.html#listen
  Function
  Method
  PUBLIC
  Implement `IStreamServerEndpoint.listen` to start listening on, and then close, `self._fileno`.
- twisted.internet.endpoints._parseTCP
  twisted.internet.endpoints.html#_parseTCP
  Function
  Function
  PRIVATE
  Internal parser function for `_parseServer` to convert the string arguments for a TCP(IPv4) stream endpoint into the structured arguments.
- twisted.internet.endpoints._parseUNIX
  twisted.internet.endpoints.html#_parseUNIX
  Function
  Function
  PRIVATE
  Internal parser function for `_parseServer` to convert the string arguments for a UNIX (AF_UNIX/SOCK_STREAM) stream endpoint into the structured arguments.
- twisted.internet.endpoints._parseSSL
  twisted.internet.endpoints.html#_parseSSL
  Function
  Function
  PRIVATE
  Internal parser function for `_parseServer` to convert the string arguments for an SSL (over TCP/IPv4) stream endpoint into the structured arguments.
- twisted.internet.endpoints._StandardIOParser
  twisted.internet.endpoints._StandardIOParser.html
  Class
  Class
  PRIVATE
  Stream server endpoint string parser for the Standard I/O type.
- twisted.internet.endpoints._StandardIOParser.prefix
  twisted.internet.endpoints._StandardIOParser.html#prefix
  Attribute
  Instance Variable
  PUBLIC
  See `IStreamServerEndpointStringParser.prefix`.
- twisted.internet.endpoints._StandardIOParser._parseServer
  twisted.internet.endpoints._StandardIOParser.html#_parseServer
  Function
  Method
  PRIVATE
  Internal parser function for `_parseServer` to convert the string arguments into structured arguments for the `StandardIOEndpoint`
- twisted.internet.endpoints._StandardIOParser.parseStreamServer
  twisted.internet.endpoints._StandardIOParser.html#parseStreamServer
  Function
  Method
  PUBLIC
  Parse a stream server endpoint from a reactor and string-only arguments and keyword arguments.
- twisted.internet.endpoints._SystemdParser
  twisted.internet.endpoints._SystemdParser.html
  Class
  Class
  PRIVATE
  Stream server endpoint string parser for the systemd endpoint type.
- twisted.internet.endpoints._SystemdParser.prefix
  twisted.internet.endpoints._SystemdParser.html#prefix
  Attribute
  Instance Variable
  PUBLIC
  See `IStreamServerEndpointStringParser.prefix`.
- twisted.internet.endpoints._SystemdParser._sddaemon
  twisted.internet.endpoints._SystemdParser.html#_sddaemon
  Attribute
  Instance Variable
  PRIVATE
  A `ListenFDs` instance used to translate an index into an actual file descriptor.
- twisted.internet.endpoints._SystemdParser._parseServer
  twisted.internet.endpoints._SystemdParser.html#_parseServer
  Function
  Method
  PRIVATE
  Internal parser function for `_parseServer` to convert the string arguments for a systemd server endpoint into structured arguments for `AdoptedStreamServerEndpoint`.
- twisted.internet.endpoints._SystemdParser.parseStreamServer
  twisted.internet.endpoints._SystemdParser.html#parseStreamServer
  Function
  Method
  PUBLIC
  Parse a stream server endpoint from a reactor and string-only arguments and keyword arguments.
- twisted.internet.endpoints._TCP6ServerParser
  twisted.internet.endpoints._TCP6ServerParser.html
  Class
  Class
  PRIVATE
  Stream server endpoint string parser for the TCP6ServerEndpoint type.
- twisted.internet.endpoints._TCP6ServerParser.prefix
  twisted.internet.endpoints._TCP6ServerParser.html#prefix
  Attribute
  Instance Variable
  PUBLIC
  See `IStreamServerEndpointStringParser.prefix`.
- twisted.internet.endpoints._TCP6ServerParser._parseServer
  twisted.internet.endpoints._TCP6ServerParser.html#_parseServer
  Function
  Method
  PRIVATE
  Internal parser function for `_parseServer` to convert the string arguments into structured arguments for the `TCP6ServerEndpoint`
- twisted.internet.endpoints._TCP6ServerParser.parseStreamServer
  twisted.internet.endpoints._TCP6ServerParser.html#parseStreamServer
  Function
  Method
  PUBLIC
  Parse a stream server endpoint from a reactor and string-only arguments and keyword arguments.
- twisted.internet.endpoints._serverParsers
  twisted.internet.endpoints.html#_serverParsers
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.internet.endpoints._OP
  twisted.internet.endpoints.html#_OP
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.internet.endpoints._STRING
  twisted.internet.endpoints.html#_STRING
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.internet.endpoints._tokenize
  twisted.internet.endpoints.html#_tokenize
  Function
  Function
  PRIVATE
  Tokenize a strports string and yield each token.
- twisted.internet.endpoints._parse
  twisted.internet.endpoints.html#_parse
  Function
  Function
  PRIVATE
  Convert a description string into a list of positional and keyword parameters, using logic vaguely like what Python does.
- twisted.internet.endpoints._endpointServerFactories
  twisted.internet.endpoints.html#_endpointServerFactories
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.internet.endpoints._endpointClientFactories
  twisted.internet.endpoints.html#_endpointClientFactories
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.internet.endpoints._parseServer
  twisted.internet.endpoints.html#_parseServer
  Function
  Function
  PRIVATE
  Parse a strports description into a 2-tuple of arguments and keyword values.
- twisted.internet.endpoints._matchPluginToPrefix
  twisted.internet.endpoints.html#_matchPluginToPrefix
  Function
  Function
  PRIVATE
  Match plugin to prefix.
- twisted.internet.endpoints.serverFromString
  twisted.internet.endpoints.html#serverFromString
  Function
  Function
  PUBLIC
  Construct a stream server endpoint from an endpoint description string.
- twisted.internet.endpoints.quoteStringArgument
  twisted.internet.endpoints.html#quoteStringArgument
  Function
  Function
  PUBLIC
  Quote an argument to `serverFromString` and `clientFromString`. Since arguments are separated with colons and colons are escaped with backslashes, some care is necessary if, for example, you have a pathname, you may be tempted to interpolate into a string like this:...
- twisted.internet.endpoints._parseClientTCP
  twisted.internet.endpoints.html#_parseClientTCP
  Function
  Function
  PRIVATE
  Perform any argument value coercion necessary for TCP client parameters.
- twisted.internet.endpoints._loadCAsFromDir
  twisted.internet.endpoints.html#_loadCAsFromDir
  Function
  Function
  PRIVATE
  Load certificate-authority certificate objects in a given directory.
- twisted.internet.endpoints._parseTrustRootPath
  twisted.internet.endpoints.html#_parseTrustRootPath
  Function
  Function
  PRIVATE
  Parse a string referring to a directory full of certificate authorities into a trust root.
- twisted.internet.endpoints._privateCertFromPaths
  twisted.internet.endpoints.html#_privateCertFromPaths
  Function
  Function
  PRIVATE
  Parse a certificate path and key path, either or both of which might be `None`, into a certificate object.
- twisted.internet.endpoints._parseClientSSLOptions
  twisted.internet.endpoints.html#_parseClientSSLOptions
  Function
  Function
  PRIVATE
  Parse common arguments for SSL endpoints, creating an `CertificateOptions` instance.
- twisted.internet.endpoints._parseClientSSL
  twisted.internet.endpoints.html#_parseClientSSL
  Function
  Function
  PRIVATE
  Perform any argument value coercion necessary for SSL client parameters.
- twisted.internet.endpoints._parseClientUNIX
  twisted.internet.endpoints.html#_parseClientUNIX
  Function
  Function
  PRIVATE
  Perform any argument value coercion necessary for UNIX client parameters.
- twisted.internet.endpoints._clientParsers
  twisted.internet.endpoints.html#_clientParsers
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.internet.endpoints.clientFromString
  twisted.internet.endpoints.html#clientFromString
  Function
  Function
  PUBLIC
  Construct a client endpoint from a description string.
- twisted.internet.endpoints.connectProtocol
  twisted.internet.endpoints.html#connectProtocol
  Function
  Function
  PUBLIC
  Connect a protocol instance to an endpoint.
- twisted.internet.endpoints._WrapperEndpoint
  twisted.internet.endpoints._WrapperEndpoint.html
  Class
  Class
  PRIVATE
  An endpoint that wraps another endpoint.
- twisted.internet.endpoints._WrapperEndpoint.__init__
  twisted.internet.endpoints._WrapperEndpoint.html#__init__
  Function
  Method
  PUBLIC
  Construct a `_WrapperEndpoint`.
- twisted.internet.endpoints._WrapperEndpoint._wrappedEndpoint
  twisted.internet.endpoints._WrapperEndpoint.html#_wrappedEndpoint
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.endpoints._WrapperEndpoint._wrapperFactory
  twisted.internet.endpoints._WrapperEndpoint.html#_wrapperFactory
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.endpoints._WrapperEndpoint.connect
  twisted.internet.endpoints._WrapperEndpoint.html#connect
  Function
  Method
  PUBLIC
  Connect the given protocol factory and unwrap its result.
- twisted.internet.endpoints._WrapperServerEndpoint
  twisted.internet.endpoints._WrapperServerEndpoint.html
  Class
  Class
  PRIVATE
  A server endpoint that wraps another server endpoint.
- twisted.internet.endpoints._WrapperServerEndpoint.__init__
  twisted.internet.endpoints._WrapperServerEndpoint.html#__init__
  Function
  Method
  PUBLIC
  Construct a `_WrapperServerEndpoint`.
- twisted.internet.endpoints._WrapperServerEndpoint._wrappedEndpoint
  twisted.internet.endpoints._WrapperServerEndpoint.html#_wrappedEndpoint
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.endpoints._WrapperServerEndpoint._wrapperFactory
  twisted.internet.endpoints._WrapperServerEndpoint.html#_wrapperFactory
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.endpoints._WrapperServerEndpoint.listen
  twisted.internet.endpoints._WrapperServerEndpoint.html#listen
  Function
  Method
  PUBLIC
  Connect the given protocol factory and unwrap its result.
- twisted.internet.endpoints.wrapClientTLS
  twisted.internet.endpoints.html#wrapClientTLS
  Function
  Function
  PUBLIC
  Wrap an endpoint which upgrades to TLS as soon as the connection is established.
- twisted.internet.endpoints._parseClientTLS
  twisted.internet.endpoints.html#_parseClientTLS
  Function
  Function
  PRIVATE
  Internal method to construct an endpoint from string parameters.
- twisted.internet.endpoints._TLSClientEndpointParser
  twisted.internet.endpoints._TLSClientEndpointParser.html
  Class
  Class
  PRIVATE
  Stream client endpoint string parser for `wrapClientTLS` with `HostnameEndpoint`.
- twisted.internet.endpoints._TLSClientEndpointParser.prefix
  twisted.internet.endpoints._TLSClientEndpointParser.html#prefix
  Attribute
  Instance Variable
  PUBLIC
  See `IStreamClientEndpointStringParserWithReactor.prefix`.
- twisted.internet.endpoints._TLSClientEndpointParser.parseStreamClient
  twisted.internet.endpoints._TLSClientEndpointParser.html#parseStreamClient
  Function
  Static Method
  PUBLIC
  Redirects to another function `_parseClientTLS`; tricks zope.interface into believing the interface is correctly implemented, since the signature is (`reactor`, `*args`, `**kwargs`). See `_parseClientTLS` for the specific signature description for this endpoint parser.
- twisted.application.strports._getReactor
  twisted.application.strports.html#_getReactor
  Function
  Function
  PRIVATE
  Undocumented
- twisted.application.strports.service
  twisted.application.strports.html#service
  Function
  Function
  PUBLIC
  Return the service corresponding to a description.
- twisted.application.strports.listen
  twisted.application.strports.html#listen
  Function
  Function
  PUBLIC
  Listen on a port corresponding to a description.
- twisted.application.twist._options._update_doc
  twisted.application.twist._options.html#_update_doc
  Function
  Function
  PRIVATE
  Update the docstring of a method that implements an option. The string is dedented and the given keyword arguments are substituted.
- twisted.application.twist._options.TwistOptions
  twisted.application.twist._options.TwistOptions.html
  Class
  Class
  PUBLIC
  Command line options for `twist`.
- twisted.application.twist._options.TwistOptions.defaultReactorName
  twisted.application.twist._options.TwistOptions.html#defaultReactorName
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.application.twist._options.TwistOptions.__init__
  twisted.application.twist._options.TwistOptions.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.application.twist._options.TwistOptions.longdesc
  twisted.application.twist._options.TwistOptions.html#longdesc
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.application.twist._options.TwistOptions.getSynopsis
  twisted.application.twist._options.TwistOptions.html#getSynopsis
  Function
  Method
  PUBLIC
  Returns a string containing a description of these options and how to pass them to the executed file.
- twisted.application.twist._options.TwistOptions.opt_version
  twisted.application.twist._options.TwistOptions.html#opt_version
  Function
  Method
  PUBLIC
  Print version and exit.
- twisted.application.twist._options.TwistOptions.opt_reactor
  twisted.application.twist._options.TwistOptions.html#opt_reactor
  Function
  Method
  PUBLIC
  The name of the reactor to use. (options: {options})
- twisted.application.twist._options.TwistOptions.installReactor
  twisted.application.twist._options.TwistOptions.html#installReactor
  Function
  Method
  PUBLIC
  Install the reactor.
- twisted.application.twist._options.TwistOptions.opt_log_level
  twisted.application.twist._options.TwistOptions.html#opt_log_level
  Function
  Method
  PUBLIC
  Set default log level. (options: {options}; default: "{default}")
- twisted.application.twist._options.TwistOptions.opt_log_file
  twisted.application.twist._options.TwistOptions.html#opt_log_file
  Function
  Method
  PUBLIC
  Log to file. ("-" for stdout, "+" for stderr; default: "-")
- twisted.application.twist._options.TwistOptions.opt_log_format
  twisted.application.twist._options.TwistOptions.html#opt_log_format
  Function
  Method
  PUBLIC
  Log file format. (options: "text", "json"; default: "text" if the log file is a tty, otherwise "json")
- twisted.application.twist._options.TwistOptions.selectDefaultLogObserver
  twisted.application.twist._options.TwistOptions.html#selectDefaultLogObserver
  Function
  Method
  PUBLIC
  Set `fileLogObserverFactory` to the default appropriate for the chosen `logFile`.
- twisted.application.twist._options.TwistOptions.parseOptions
  twisted.application.twist._options.TwistOptions.html#parseOptions
  Function
  Method
  PUBLIC
  The guts of the command-line parser.
- twisted.application.twist._options.TwistOptions.plugins
  twisted.application.twist._options.TwistOptions.html#plugins
  Attribute
  Property
  PUBLIC
  Undocumented
- twisted.application.twist._options.TwistOptions.subCommands
  twisted.application.twist._options.TwistOptions.html#subCommands
  Attribute
  Property
  PUBLIC
  Undocumented
- twisted.application.twist._options.TwistOptions.postOptions
  twisted.application.twist._options.TwistOptions.html#postOptions
  Function
  Method
  PUBLIC
  I am called after the options are parsed.
- twisted.application.twist._twist.Twist
  twisted.application.twist._twist.Twist.html
  Class
  Class
  PUBLIC
  Run a Twisted application.
- twisted.application.twist._twist.Twist.options
  twisted.application.twist._twist.Twist.html#options
  Function
  Static Method
  PUBLIC
  Parse command line options.
- twisted.application.twist._twist.Twist.service
  twisted.application.twist._twist.Twist.html#service
  Function
  Static Method
  PUBLIC
  Create the application service.
- twisted.application.twist._twist.Twist.startService
  twisted.application.twist._twist.Twist.html#startService
  Function
  Static Method
  PUBLIC
  Start the application service.
- twisted.application.twist._twist.Twist.run
  twisted.application.twist._twist.Twist.html#run
  Function
  Static Method
  PUBLIC
  Run the application service.
- twisted.application.twist._twist.Twist.main
  twisted.application.twist._twist.Twist.html#main
  Function
  Class Method
  PUBLIC
  Executable entry point for `Twist`. Processes options and run a twisted reactor with a service.
- twisted.internet.default._getInstallFunction
  twisted.internet.default.html#_getInstallFunction
  Function
  Function
  PRIVATE
  Return a function to install the reactor most suited for the given platform.
- twisted.internet.default.install
  twisted.internet.default.html#install
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.python.fakepwd._UserRecord
  twisted.python.fakepwd._UserRecord.html
  Class
  Class
  PRIVATE
  `_UserRecord` holds the user data for a single user in `UserDatabase`. It corresponds to the `passwd` structure from the `pwd` module. See that module for attribute documentation.
- twisted.python.fakepwd._UserRecord.__init__
  twisted.python.fakepwd._UserRecord.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.fakepwd._UserRecord.pw_name
  twisted.python.fakepwd._UserRecord.html#pw_name
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.fakepwd._UserRecord.pw_passwd
  twisted.python.fakepwd._UserRecord.html#pw_passwd
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.fakepwd._UserRecord.pw_uid
  twisted.python.fakepwd._UserRecord.html#pw_uid
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.fakepwd._UserRecord.pw_gid
  twisted.python.fakepwd._UserRecord.html#pw_gid
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.fakepwd._UserRecord.pw_gecos
  twisted.python.fakepwd._UserRecord.html#pw_gecos
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.fakepwd._UserRecord.pw_dir
  twisted.python.fakepwd._UserRecord.html#pw_dir
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.fakepwd._UserRecord.pw_shell
  twisted.python.fakepwd._UserRecord.html#pw_shell
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.fakepwd._UserRecord.__len__
  twisted.python.fakepwd._UserRecord.html#__len__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.fakepwd._UserRecord.__getitem__
  twisted.python.fakepwd._UserRecord.html#__getitem__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.fakepwd.UserDatabase
  twisted.python.fakepwd.UserDatabase.html
  Class
  Class
  PUBLIC
  `UserDatabase` holds a traditional POSIX user data in memory and makes it available via the same API as `pwd`.
- twisted.python.fakepwd.UserDatabase._users
  twisted.python.fakepwd.UserDatabase.html#_users
  Attribute
  Instance Variable
  PRIVATE
  A `list` of `_UserRecord` instances holding all user data added to this database.
- twisted.python.fakepwd.UserDatabase.__init__
  twisted.python.fakepwd.UserDatabase.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.fakepwd.UserDatabase.addUser
  twisted.python.fakepwd.UserDatabase.html#addUser
  Function
  Method
  PUBLIC
  Add a new user record to this database.
- twisted.python.fakepwd.UserDatabase.getpwuid
  twisted.python.fakepwd.UserDatabase.html#getpwuid
  Function
  Method
  PUBLIC
  Return the user record corresponding to the given uid.
- twisted.python.fakepwd.UserDatabase.getpwnam
  twisted.python.fakepwd.UserDatabase.html#getpwnam
  Function
  Method
  PUBLIC
  Return the user record corresponding to the given username.
- twisted.python.fakepwd.UserDatabase.getpwall
  twisted.python.fakepwd.UserDatabase.html#getpwall
  Function
  Method
  PUBLIC
  Return a list of all user records.
- twisted.python.fakepwd._ShadowRecord
  twisted.python.fakepwd._ShadowRecord.html
  Class
  Class
  PRIVATE
  `_ShadowRecord` holds the shadow user data for a single user in `ShadowDatabase`. It corresponds to `spwd.struct_spwd`. See that class for attribute documentation.
- twisted.python.fakepwd._ShadowRecord.__init__
  twisted.python.fakepwd._ShadowRecord.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.fakepwd._ShadowRecord.sp_nam
  twisted.python.fakepwd._ShadowRecord.html#sp_nam
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.fakepwd._ShadowRecord.sp_pwd
  twisted.python.fakepwd._ShadowRecord.html#sp_pwd
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.fakepwd._ShadowRecord.sp_lstchg
  twisted.python.fakepwd._ShadowRecord.html#sp_lstchg
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.fakepwd._ShadowRecord.sp_min
  twisted.python.fakepwd._ShadowRecord.html#sp_min
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.fakepwd._ShadowRecord.sp_max
  twisted.python.fakepwd._ShadowRecord.html#sp_max
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.fakepwd._ShadowRecord.sp_warn
  twisted.python.fakepwd._ShadowRecord.html#sp_warn
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.fakepwd._ShadowRecord.sp_inact
  twisted.python.fakepwd._ShadowRecord.html#sp_inact
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.fakepwd._ShadowRecord.sp_expire
  twisted.python.fakepwd._ShadowRecord.html#sp_expire
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.fakepwd._ShadowRecord.sp_flag
  twisted.python.fakepwd._ShadowRecord.html#sp_flag
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.fakepwd._ShadowRecord.__len__
  twisted.python.fakepwd._ShadowRecord.html#__len__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.fakepwd._ShadowRecord.__getitem__
  twisted.python.fakepwd._ShadowRecord.html#__getitem__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.fakepwd.ShadowDatabase
  twisted.python.fakepwd.ShadowDatabase.html
  Class
  Class
  PUBLIC
  `ShadowDatabase` holds a shadow user database in memory and makes it available via the same API as `spwd`.
- twisted.python.fakepwd.ShadowDatabase._users
  twisted.python.fakepwd.ShadowDatabase.html#_users
  Attribute
  Instance Variable
  PRIVATE
  A `list` of `_ShadowRecord` instances holding all user data added to this database.
- twisted.python.fakepwd.ShadowDatabase.__init__
  twisted.python.fakepwd.ShadowDatabase.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.fakepwd.ShadowDatabase.addUser
  twisted.python.fakepwd.ShadowDatabase.html#addUser
  Function
  Method
  PUBLIC
  Add a new user record to this database.
- twisted.python.fakepwd.ShadowDatabase.getspnam
  twisted.python.fakepwd.ShadowDatabase.html#getspnam
  Function
  Method
  PUBLIC
  Return the shadow user record corresponding to the given username.
- twisted.python.fakepwd.ShadowDatabase.getspall
  twisted.python.fakepwd.ShadowDatabase.html#getspall
  Function
  Method
  PUBLIC
  Return a list of all shadow user records.
- twisted.scripts._twistw.ServerOptions
  twisted.scripts._twistw.ServerOptions.html
  Class
  Class
  PUBLIC
  No class docstring; 0/2 class variable, 1/1 method documented
- twisted.scripts._twistw.ServerOptions.synopsis
  twisted.scripts._twistw.ServerOptions.html#synopsis
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.scripts._twistw.ServerOptions.optFlags
  twisted.scripts._twistw.ServerOptions.html#optFlags
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.scripts._twistw.ServerOptions.opt_version
  twisted.scripts._twistw.ServerOptions.html#opt_version
  Function
  Method
  PUBLIC
  Print version information and exit.
- twisted.scripts._twistw.WindowsApplicationRunner
  twisted.scripts._twistw.WindowsApplicationRunner.html
  Class
  Class
  PUBLIC
  An ApplicationRunner which avoids unix-specific things. No forking, no PID files, no privileges.
- twisted.scripts._twistw.WindowsApplicationRunner.preApplication
  twisted.scripts._twistw.WindowsApplicationRunner.html#preApplication
  Function
  Method
  PUBLIC
  Do pre-application-creation setup.
- twisted.scripts._twistw.WindowsApplicationRunner.oldstdout
  twisted.scripts._twistw.WindowsApplicationRunner.html#oldstdout
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.scripts._twistw.WindowsApplicationRunner.oldstderr
  twisted.scripts._twistw.WindowsApplicationRunner.html#oldstderr
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.scripts._twistw.WindowsApplicationRunner.postApplication
  twisted.scripts._twistw.WindowsApplicationRunner.html#postApplication
  Function
  Method
  PUBLIC
  Start the application and run the reactor.
- twisted.scripts.twistd.runApp
  twisted.scripts.twistd.html#runApp
  Function
  Function
  PUBLIC
  Undocumented
- twisted.scripts.twistd.run
  twisted.scripts.twistd.html#run
  Function
  Function
  PUBLIC
  Undocumented
- twisted.internet._baseprocess._missingProcessExited
  twisted.internet._baseprocess.html#_missingProcessExited
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.internet._baseprocess.BaseProcess
  twisted.internet._baseprocess.BaseProcess.html
  Class
  Class
  PUBLIC
  No class docstring; 0/3 instance variable, 0/1 class variable, 2/4 methods documented
- twisted.internet._baseprocess.BaseProcess.pid
  twisted.internet._baseprocess.BaseProcess.html#pid
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet._baseprocess.BaseProcess.status
  twisted.internet._baseprocess.BaseProcess.html#status
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet._baseprocess.BaseProcess.lostProcess
  twisted.internet._baseprocess.BaseProcess.html#lostProcess
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet._baseprocess.BaseProcess.proto
  twisted.internet._baseprocess.BaseProcess.html#proto
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet._baseprocess.BaseProcess.__init__
  twisted.internet._baseprocess.BaseProcess.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet._baseprocess.BaseProcess._callProcessExited
  twisted.internet._baseprocess.BaseProcess.html#_callProcessExited
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet._baseprocess.BaseProcess.processEnded
  twisted.internet._baseprocess.BaseProcess.html#processEnded
  Function
  Method
  PUBLIC
  This is called when the child terminates.
- twisted.internet._baseprocess.BaseProcess.maybeCallProcessEnded
  twisted.internet._baseprocess.BaseProcess.html#maybeCallProcessEnded
  Function
  Method
  PUBLIC
  Call processEnded on protocol after final cleanup.
- twisted.internet.process.reapProcessHandlers
  twisted.internet.process.html#reapProcessHandlers
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.internet.process.reapAllProcesses
  twisted.internet.process.html#reapAllProcesses
  Function
  Function
  PUBLIC
  Reap all registered processes.
- twisted.internet.process.registerReapProcessHandler
  twisted.internet.process.html#registerReapProcessHandler
  Function
  Function
  PUBLIC
  Register a process handler for the given pid, in case `reapAllProcesses` is called.
- twisted.internet.process.unregisterReapProcessHandler
  twisted.internet.process.html#unregisterReapProcessHandler
  Function
  Function
  PUBLIC
  Unregister a process handler previously registered with `registerReapProcessHandler`.
- twisted.internet.process.ProcessWriter
  twisted.internet.process.ProcessWriter.html
  Class
  Class
  PUBLIC
  (Internal) Helper class to write into a Process's input pipe.
- twisted.internet.process.ProcessWriter.enableReadHack
  twisted.internet.process.ProcessWriter.html#enableReadHack
  Attribute
  Instance Variable
  PUBLIC
  A flag which determines how readability on this write descriptor will be handled. If `True`, then readability may indicate the reader for this write descriptor has been closed (ie, the connection has been lost)...
- twisted.internet.process.ProcessWriter.connected
  twisted.internet.process.ProcessWriter.html#connected
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet.process.ProcessWriter.ic
  twisted.internet.process.ProcessWriter.html#ic
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet.process.ProcessWriter.__init__
  twisted.internet.process.ProcessWriter.html#__init__
  Function
  Method
  PUBLIC
  Initialize, specifying a Process instance to connect to.
- twisted.internet.process.ProcessWriter.proc
  twisted.internet.process.ProcessWriter.html#proc
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.process.ProcessWriter.name
  twisted.internet.process.ProcessWriter.html#name
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.process.ProcessWriter.fd
  twisted.internet.process.ProcessWriter.html#fd
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.process.ProcessWriter.fileno
  twisted.internet.process.ProcessWriter.html#fileno
  Function
  Method
  PUBLIC
  Return the fileno() of my process's stdin.
- twisted.internet.process.ProcessWriter.writeSomeData
  twisted.internet.process.ProcessWriter.html#writeSomeData
  Function
  Method
  PUBLIC
  Write some data to the open process.
- twisted.internet.process.ProcessWriter.write
  twisted.internet.process.ProcessWriter.html#write
  Function
  Method
  PUBLIC
  Reliably write some data.
- twisted.internet.process.ProcessWriter.doRead
  twisted.internet.process.ProcessWriter.html#doRead
  Function
  Method
  PUBLIC
  The only way a write pipe can become "readable" is at EOF, because the child has closed it, and we're using a reactor which doesn't distinguish between readable and closed (such as the select reactor).
- twisted.internet.process.ProcessWriter.connectionLost
  twisted.internet.process.ProcessWriter.html#connectionLost
  Function
  Method
  PUBLIC
  See abstract.FileDescriptor.connectionLost.
- twisted.internet.process.ProcessReader
  twisted.internet.process.ProcessReader.html
  Class
  Class
  PUBLIC
  ProcessReader
- twisted.internet.process.ProcessReader.connected
  twisted.internet.process.ProcessReader.html#connected
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet.process.ProcessReader.__init__
  twisted.internet.process.ProcessReader.html#__init__
  Function
  Method
  PUBLIC
  Initialize, specifying a process to connect to.
- twisted.internet.process.ProcessReader.proc
  twisted.internet.process.ProcessReader.html#proc
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.process.ProcessReader.name
  twisted.internet.process.ProcessReader.html#name
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.process.ProcessReader.fd
  twisted.internet.process.ProcessReader.html#fd
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.process.ProcessReader.fileno
  twisted.internet.process.ProcessReader.html#fileno
  Function
  Method
  PUBLIC
  Return the fileno() of my process's stderr.
- twisted.internet.process.ProcessReader.writeSomeData
  twisted.internet.process.ProcessReader.html#writeSomeData
  Function
  Method
  PUBLIC
  Write as much as possible of the given data, immediately.
- twisted.internet.process.ProcessReader.doRead
  twisted.internet.process.ProcessReader.html#doRead
  Function
  Method
  PUBLIC
  This is called when the pipe becomes readable.
- twisted.internet.process.ProcessReader.dataReceived
  twisted.internet.process.ProcessReader.html#dataReceived
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.process.ProcessReader.loseConnection
  twisted.internet.process.ProcessReader.html#loseConnection
  Function
  Method
  PUBLIC
  Close the connection at the next available opportunity.
- twisted.internet.process.ProcessReader.disconnecting
  twisted.internet.process.ProcessReader.html#disconnecting
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.process.ProcessReader.connectionLost
  twisted.internet.process.ProcessReader.html#connectionLost
  Function
  Method
  PUBLIC
  Close my end of the pipe, signal the Process (which signals the ProcessProtocol).
- twisted.internet.process._BaseProcess
  twisted.internet.process._BaseProcess.html
  Class
  Class
  PRIVATE
  Base class for Process and PTYProcess.
- twisted.internet.process._BaseProcess.status
  twisted.internet.process._BaseProcess.html#status
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.process._BaseProcess.pid
  twisted.internet.process._BaseProcess.html#pid
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.process._BaseProcess.reapProcess
  twisted.internet.process._BaseProcess.html#reapProcess
  Function
  Method
  PUBLIC
  Try to reap a process (without blocking) via waitpid.
- twisted.internet.process._BaseProcess._getReason
  twisted.internet.process._BaseProcess.html#_getReason
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet.process._BaseProcess.signalProcess
  twisted.internet.process._BaseProcess.html#signalProcess
  Function
  Method
  PUBLIC
  Send the given signal `signalID` to the process. It'll translate a few signals ('HUP', 'STOP', 'INT', 'KILL', 'TERM') from a string representation to its int value, otherwise it'll pass directly the value provided...
- twisted.internet.process._BaseProcess._resetSignalDisposition
  twisted.internet.process._BaseProcess.html#_resetSignalDisposition
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet.process._BaseProcess._fork
  twisted.internet.process._BaseProcess.html#_fork
  Function
  Method
  PRIVATE
  Fork and then exec sub-process.
- twisted.internet.process._BaseProcess._setupChild
  twisted.internet.process._BaseProcess.html#_setupChild
  Function
  Method
  PRIVATE
  Setup the child process. Override in subclasses.
- twisted.internet.process._BaseProcess._execChild
  twisted.internet.process._BaseProcess.html#_execChild
  Function
  Method
  PRIVATE
  The exec() which is done in the forked child.
- twisted.internet.process._BaseProcess.__repr__
  twisted.internet.process._BaseProcess.html#__repr__
  Function
  Method
  PUBLIC
  String representation of a process.
- twisted.internet.process._FDDetector
  twisted.internet.process._FDDetector.html
  Class
  Class
  PRIVATE
  This class contains the logic necessary to decide which of the available system techniques should be used to detect the open file descriptors for the current process. The chosen technique gets monkey-patched into the _listOpenFDs method of this class so that the detection only needs to occur once.
- twisted.internet.process._FDDetector.listdir
  twisted.internet.process._FDDetector.html#listdir
  Attribute
  Instance Variable
  PUBLIC
  The implementation of listdir to use. This gets overwritten by the test cases.
- twisted.internet.process._FDDetector.getpid
  twisted.internet.process._FDDetector.html#getpid
  Attribute
  Instance Variable
  PUBLIC
  The implementation of getpid to use, returns the PID of the running process.
- twisted.internet.process._FDDetector.openfile
  twisted.internet.process._FDDetector.html#openfile
  Attribute
  Instance Variable
  PUBLIC
  The implementation of open() to use, by default the Python builtin.
- twisted.internet.process._FDDetector.__init__
  twisted.internet.process._FDDetector.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.process._FDDetector._implementations
  twisted.internet.process._FDDetector.html#_implementations
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.process._FDDetector._listOpenFDs
  twisted.internet.process._FDDetector.html#_listOpenFDs
  Function
  Method
  PRIVATE
  Return an iterable of file descriptors which may be open in this process.
- twisted.internet.process._FDDetector._getImplementation
  twisted.internet.process._FDDetector.html#_getImplementation
  Function
  Method
  PRIVATE
  Pick a method which gives correct results for `_listOpenFDs` in this runtime environment.
- twisted.internet.process._FDDetector._devFDImplementation
  twisted.internet.process._FDDetector.html#_devFDImplementation
  Function
  Method
  PRIVATE
  Simple implementation for systems where /dev/fd actually works. See: http://www.freebsd.org/cgi/man.cgi?fdescfs
- twisted.internet.process._FDDetector._procFDImplementation
  twisted.internet.process._FDDetector.html#_procFDImplementation
  Function
  Method
  PRIVATE
  Simple implementation for systems where /proc/pid/fd exists (we assume it works).
- twisted.internet.process._FDDetector._fallbackFDImplementation
  twisted.internet.process._FDDetector.html#_fallbackFDImplementation
  Function
  Method
  PRIVATE
  Fallback implementation where either the resource module can inform us about the upper bound of how many FDs to expect, or where we just guess a constant maximum if there is no resource module.
- twisted.internet.process.detector
  twisted.internet.process.html#detector
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.internet.process._listOpenFDs
  twisted.internet.process.html#_listOpenFDs
  Function
  Function
  PRIVATE
  Use the global detector object to figure out which FD implementation to use.
- twisted.internet.process.Process
  twisted.internet.process.Process.html
  Class
  Class
  PUBLIC
  An operating-system Process.
- twisted.internet.process.Process.debug
  twisted.internet.process.Process.html#debug
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet.process.Process.debug_child
  twisted.internet.process.Process.html#debug_child
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet.process.Process.status
  twisted.internet.process.Process.html#status
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet.process.Process.pid
  twisted.internet.process.Process.html#pid
  Attribute
  Class Variable
  PUBLIC
  From before `IProcessProtocol.makeConnection` is called to before `IProcessProtocol.processEnded` is called, `pid` is an `int` giving the platform process ID of this process. `pid` is `None` at all other times.
- twisted.internet.process.Process.__init__
  twisted.internet.process.Process.html#__init__
  Function
  Method
  PUBLIC
  Spawn an operating-system process.
- twisted.internet.process.Process.pipes
  twisted.internet.process.Process.html#pipes
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.process.Process.proto
  twisted.internet.process.Process.html#proto
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.process.Process._setupChild
  twisted.internet.process.Process.html#_setupChild
  Function
  Method
  PRIVATE
  fdmap[childFD] = parentFD
- twisted.internet.process.Process.writeToChild
  twisted.internet.process.Process.html#writeToChild
  Function
  Method
  PUBLIC
  Similar to `ITransport.write` but also allows the file descriptor in the child process which will receive the bytes to be specified.
- twisted.internet.process.Process.closeChildFD
  twisted.internet.process.Process.html#closeChildFD
  Function
  Method
  PUBLIC
  Close a file descriptor which is connected to the child process, identified by its FD in the child process.
- twisted.internet.process.Process.pauseProducing
  twisted.internet.process.Process.html#pauseProducing
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.process.Process.resumeProducing
  twisted.internet.process.Process.html#resumeProducing
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.process.Process.closeStdin
  twisted.internet.process.Process.html#closeStdin
  Function
  Method
  PUBLIC
  Call this to close standard input on this process.
- twisted.internet.process.Process.closeStdout
  twisted.internet.process.Process.html#closeStdout
  Function
  Method
  PUBLIC
  Close stdout.
- twisted.internet.process.Process.closeStderr
  twisted.internet.process.Process.html#closeStderr
  Function
  Method
  PUBLIC
  Close stderr.
- twisted.internet.process.Process.loseConnection
  twisted.internet.process.Process.html#loseConnection
  Function
  Method
  PUBLIC
  Close stdin, stderr and stdout.
- twisted.internet.process.Process.write
  twisted.internet.process.Process.html#write
  Function
  Method
  PUBLIC
  Call this to write to standard input on this process.
- twisted.internet.process.Process.registerProducer
  twisted.internet.process.Process.html#registerProducer
  Function
  Method
  PUBLIC
  Call this to register producer for standard input.
- twisted.internet.process.Process.unregisterProducer
  twisted.internet.process.Process.html#unregisterProducer
  Function
  Method
  PUBLIC
  Call this to unregister producer for standard input.
- twisted.internet.process.Process.writeSequence
  twisted.internet.process.Process.html#writeSequence
  Function
  Method
  PUBLIC
  Call this to write to standard input on this process.
- twisted.internet.process.Process.childDataReceived
  twisted.internet.process.Process.html#childDataReceived
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.process.Process.childConnectionLost
  twisted.internet.process.Process.html#childConnectionLost
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.process.Process.maybeCallProcessEnded
  twisted.internet.process.Process.html#maybeCallProcessEnded
  Function
  Method
  PUBLIC
  Call processEnded on protocol after final cleanup.
- twisted.internet.process.Process.getHost
  twisted.internet.process.Process.html#getHost
  Function
  Method
  PUBLIC
  Similar to getPeer, but returns an address describing this side of the connection.
- twisted.internet.process.Process.getPeer
  twisted.internet.process.Process.html#getPeer
  Function
  Method
  PUBLIC
  Get the remote address of this connection.
- twisted.internet.process.PTYProcess
  twisted.internet.process.PTYProcess.html
  Class
  Class
  PUBLIC
  An operating-system Process that uses PTY support.
- twisted.internet.process.PTYProcess.status
  twisted.internet.process.PTYProcess.html#status
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.process.PTYProcess.pid
  twisted.internet.process.PTYProcess.html#pid
  Attribute
  Class Variable
  PUBLIC
  From before `IProcessProtocol.makeConnection` is called to before `IProcessProtocol.processEnded` is called, `pid` is an `int` giving the platform process ID of this process. `pid` is `None` at all other times.
- twisted.internet.process.PTYProcess.__init__
  twisted.internet.process.PTYProcess.html#__init__
  Function
  Method
  PUBLIC
  Spawn an operating-system process.
- twisted.internet.process.PTYProcess.fd
  twisted.internet.process.PTYProcess.html#fd
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.process.PTYProcess.connected
  twisted.internet.process.PTYProcess.html#connected
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.process.PTYProcess._setupChild
  twisted.internet.process.PTYProcess.html#_setupChild
  Function
  Method
  PRIVATE
  Set up child process after `fork()` but before `exec()`.
- twisted.internet.process.PTYProcess.closeStdin
  twisted.internet.process.PTYProcess.html#closeStdin
  Function
  Method
  PUBLIC
  Close stdin after all data has been written out.
- twisted.internet.process.PTYProcess.closeStdout
  twisted.internet.process.PTYProcess.html#closeStdout
  Function
  Method
  PUBLIC
  Close stdout.
- twisted.internet.process.PTYProcess.closeStderr
  twisted.internet.process.PTYProcess.html#closeStderr
  Function
  Method
  PUBLIC
  Close stderr.
- twisted.internet.process.PTYProcess.doRead
  twisted.internet.process.PTYProcess.html#doRead
  Function
  Method
  PUBLIC
  Called when my standard output stream is ready for reading.
- twisted.internet.process.PTYProcess.fileno
  twisted.internet.process.PTYProcess.html#fileno
  Function
  Method
  PUBLIC
  This returns the file number of standard output on this process.
- twisted.internet.process.PTYProcess.maybeCallProcessEnded
  twisted.internet.process.PTYProcess.html#maybeCallProcessEnded
  Function
  Method
  PUBLIC
  Call processEnded on protocol after final cleanup.
- twisted.internet.process.PTYProcess.connectionLost
  twisted.internet.process.PTYProcess.html#connectionLost
  Function
  Method
  PUBLIC
  I call this to clean up when one or all of my connections has died.
- twisted.internet.process.PTYProcess.writeSomeData
  twisted.internet.process.PTYProcess.html#writeSomeData
  Function
  Method
  PUBLIC
  Write some data to the open process.
- twisted.internet.process.PTYProcess.closeChildFD
  twisted.internet.process.PTYProcess.html#closeChildFD
  Function
  Method
  PUBLIC
  Close a file descriptor which is connected to the child process, identified by its FD in the child process.
- twisted.internet.process.PTYProcess.writeToChild
  twisted.internet.process.PTYProcess.html#writeToChild
  Function
  Method
  PUBLIC
  Similar to `ITransport.write` but also allows the file descriptor in the child process which will receive the bytes to be specified.
- twisted.python.procutils.which
  twisted.python.procutils.html#which
  Function
  Function
  PUBLIC
  Search PATH for executable files with the given name.
- twisted.scripts._twistd_unix._umask
  twisted.scripts._twistd_unix.html#_umask
  Function
  Function
  PRIVATE
  Undocumented
- twisted.scripts._twistd_unix.ServerOptions
  twisted.scripts._twistd_unix.ServerOptions.html
  Class
  Class
  PUBLIC
  No class docstring; 0/4 class variable, 1/2 method documented
- twisted.scripts._twistd_unix.ServerOptions.synopsis
  twisted.scripts._twistd_unix.ServerOptions.html#synopsis
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.scripts._twistd_unix.ServerOptions.optFlags
  twisted.scripts._twistd_unix.ServerOptions.html#optFlags
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.scripts._twistd_unix.ServerOptions.optParameters
  twisted.scripts._twistd_unix.ServerOptions.html#optParameters
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.scripts._twistd_unix.ServerOptions.compData
  twisted.scripts._twistd_unix.ServerOptions.html#compData
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.scripts._twistd_unix.ServerOptions.opt_version
  twisted.scripts._twistd_unix.ServerOptions.html#opt_version
  Function
  Method
  PUBLIC
  Print version information and exit.
- twisted.scripts._twistd_unix.ServerOptions.postOptions
  twisted.scripts._twistd_unix.ServerOptions.html#postOptions
  Function
  Method
  PUBLIC
  I am called after the options are parsed.
- twisted.scripts._twistd_unix.checkPID
  twisted.scripts._twistd_unix.html#checkPID
  Function
  Function
  PUBLIC
  Undocumented
- twisted.scripts._twistd_unix.UnixAppLogger
  twisted.scripts._twistd_unix.UnixAppLogger.html
  Class
  Class
  PUBLIC
  A logger able to log to syslog, to files, and to stdout.
- twisted.scripts._twistd_unix.UnixAppLogger._syslog
  twisted.scripts._twistd_unix.UnixAppLogger.html#_syslog
  Attribute
  Instance Variable
  PRIVATE
  A flag indicating whether to use syslog instead of file logging.
- twisted.scripts._twistd_unix.UnixAppLogger._syslogPrefix
  twisted.scripts._twistd_unix.UnixAppLogger.html#_syslogPrefix
  Attribute
  Instance Variable
  PRIVATE
  If `sysLog` is `True`, the string prefix to use for syslog messages.
- twisted.scripts._twistd_unix.UnixAppLogger._nodaemon
  twisted.scripts._twistd_unix.UnixAppLogger.html#_nodaemon
  Attribute
  Instance Variable
  PRIVATE
  A flag indicating the process will not be daemonizing.
- twisted.scripts._twistd_unix.UnixAppLogger.__init__
  twisted.scripts._twistd_unix.UnixAppLogger.html#__init__
  Function
  Method
  PUBLIC
  Initialize an `AppLogger` with a `ServerOptions`.
- twisted.scripts._twistd_unix.UnixAppLogger._getLogObserver
  twisted.scripts._twistd_unix.UnixAppLogger.html#_getLogObserver
  Function
  Method
  PRIVATE
  Create and return a suitable log observer for the given configuration.
- twisted.scripts._twistd_unix.launchWithName
  twisted.scripts._twistd_unix.html#launchWithName
  Function
  Function
  PUBLIC
  Undocumented
- twisted.scripts._twistd_unix.UnixApplicationRunner
  twisted.scripts._twistd_unix.UnixApplicationRunner.html
  Class
  Class
  PUBLIC
  An ApplicationRunner which does Unix-specific things, like fork, shed privileges, and maintain a PID file.
- twisted.scripts._twistd_unix.UnixApplicationRunner.preApplication
  twisted.scripts._twistd_unix.UnixApplicationRunner.html#preApplication
  Function
  Method
  PUBLIC
  Do pre-application-creation setup.
- twisted.scripts._twistd_unix.UnixApplicationRunner.oldstdout
  twisted.scripts._twistd_unix.UnixApplicationRunner.html#oldstdout
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.scripts._twistd_unix.UnixApplicationRunner.oldstderr
  twisted.scripts._twistd_unix.UnixApplicationRunner.html#oldstderr
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.scripts._twistd_unix.UnixApplicationRunner._formatChildException
  twisted.scripts._twistd_unix.UnixApplicationRunner.html#_formatChildException
  Function
  Method
  PRIVATE
  Format the `exception` in preparation for writing to the status pipe. This does the right thing on Python 2 if the exception's message is Unicode, and in all cases limits the length of the message afte* encoding to 100 bytes.
- twisted.scripts._twistd_unix.UnixApplicationRunner.postApplication
  twisted.scripts._twistd_unix.UnixApplicationRunner.html#postApplication
  Function
  Method
  PUBLIC
  To be called after the application is created: start the application and run the reactor. After the reactor stops, clean up PID files and such.
- twisted.scripts._twistd_unix.UnixApplicationRunner.removePID
  twisted.scripts._twistd_unix.UnixApplicationRunner.html#removePID
  Function
  Method
  PUBLIC
  Remove the specified PID file, if possible. Errors are logged, not raised.
- twisted.scripts._twistd_unix.UnixApplicationRunner.setupEnvironment
  twisted.scripts._twistd_unix.UnixApplicationRunner.html#setupEnvironment
  Function
  Method
  PUBLIC
  Set the filesystem root, the working directory, and daemonize.
- twisted.scripts._twistd_unix.UnixApplicationRunner.daemonize
  twisted.scripts._twistd_unix.UnixApplicationRunner.html#daemonize
  Function
  Method
  PUBLIC
  Daemonizes the application on Unix. This is done by the usual double forking approach.
- twisted.scripts._twistd_unix.UnixApplicationRunner._waitForStart
  twisted.scripts._twistd_unix.UnixApplicationRunner.html#_waitForStart
  Function
  Method
  PRIVATE
  Wait for the daemonization success.
- twisted.scripts._twistd_unix.UnixApplicationRunner.shedPrivileges
  twisted.scripts._twistd_unix.UnixApplicationRunner.html#shedPrivileges
  Function
  Method
  PUBLIC
  Change the UID and GID or the EUID and EGID of this process.
- twisted.scripts._twistd_unix.UnixApplicationRunner.startApplication
  twisted.scripts._twistd_unix.UnixApplicationRunner.html#startApplication
  Function
  Method
  PUBLIC
  Configure global process state based on the given application and run the application.
- twisted.cred.error.Unauthorized
  twisted.cred.error.Unauthorized.html
  Class
  Exception
  PUBLIC
  Standard unauthorized error.
- twisted.cred.error.LoginFailed
  twisted.cred.error.LoginFailed.html
  Class
  Exception
  PUBLIC
  The user's request to log in failed for some reason.
- twisted.cred.error.UnauthorizedLogin
  twisted.cred.error.UnauthorizedLogin.html
  Class
  Exception
  PUBLIC
  The user was not authorized to log in.
- twisted.cred.error.UnhandledCredentials
  twisted.cred.error.UnhandledCredentials.html
  Class
  Exception
  PUBLIC
  A type of credentials were passed in with no knowledge of how to check them. This is a server configuration error - it means that a protocol was connected to a Portal without a CredentialChecker that can check all of its potential authentication strategies.
- twisted.cred.error.LoginDenied
  twisted.cred.error.LoginDenied.html
  Class
  Exception
  PUBLIC
  The realm rejected this login for some reason.
- twisted.conch.error.ConchError
  twisted.conch.error.ConchError.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.conch.error.ConchError.__init__
  twisted.conch.error.ConchError.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.error.ConchError.value
  twisted.conch.error.ConchError.html#value
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.error.ConchError.data
  twisted.conch.error.ConchError.html#data
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.error.NotEnoughAuthentication
  twisted.conch.error.NotEnoughAuthentication.html
  Class
  Exception
  PUBLIC
  This is thrown if the authentication is valid, but is not enough to successfully verify the user. i.e. don't retry this type of authentication, try another one.
- twisted.conch.error.ValidPublicKey
  twisted.conch.error.ValidPublicKey.html
  Class
  Exception
  PUBLIC
  Raised by public key checkers when they receive public key credentials that don't contain a signature at all, but are valid in every other way. (e.g. the public key matches one in the user's authorized_keys file).
- twisted.conch.error.IgnoreAuthentication
  twisted.conch.error.IgnoreAuthentication.html
  Class
  Exception
  PUBLIC
  This is thrown to let the UserAuthServer know it doesn't need to handle the authentication anymore.
- twisted.conch.error.MissingKeyStoreError
  twisted.conch.error.MissingKeyStoreError.html
  Class
  Exception
  PUBLIC
  Raised if an SSHAgentServer starts receiving data without its factory providing a keys dict on which to read/write key data.
- twisted.conch.error.UserRejectedKey
  twisted.conch.error.UserRejectedKey.html
  Class
  Exception
  PUBLIC
  The user interactively rejected a key.
- twisted.conch.error.InvalidEntry
  twisted.conch.error.InvalidEntry.html
  Class
  Exception
  PUBLIC
  An entry in a known_hosts file could not be interpreted as a valid entry.
- twisted.conch.error.HostKeyChanged
  twisted.conch.error.HostKeyChanged.html
  Class
  Exception
  PUBLIC
  The host key of a remote host has changed.
- twisted.conch.error.HostKeyChanged.offendingEntry
  twisted.conch.error.HostKeyChanged.html#offendingEntry
  Attribute
  Instance Variable
  PUBLIC
  The entry which contains the persistent host key that disagrees with the given host key.
- twisted.conch.error.HostKeyChanged.path
  twisted.conch.error.HostKeyChanged.html#path
  Attribute
  Instance Variable
  PUBLIC
  a reference to the known_hosts file that the offending entry was loaded from
- twisted.conch.error.HostKeyChanged.lineno
  twisted.conch.error.HostKeyChanged.html#lineno
  Attribute
  Instance Variable
  PUBLIC
  The line number of the offending entry in the given path.
- twisted.conch.error.HostKeyChanged.__init__
  twisted.conch.error.HostKeyChanged.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.interfaces.IConchUser
  twisted.conch.interfaces.IConchUser.html
  Class
  Interface
  PUBLIC
  A user who has been authenticated to Cred through Conch. This is the interface between the SSH connection and the user.
- twisted.conch.interfaces.IConchUser.conn
  twisted.conch.interfaces.IConchUser.html#conn
  Attribute
  Attribute
  PUBLIC
  The SSHConnection object for this user.
- twisted.conch.interfaces.IConchUser.lookupChannel
  twisted.conch.interfaces.IConchUser.html#lookupChannel
  Function
  Method
  PUBLIC
  The other side requested a channel of some sort.
- twisted.conch.interfaces.IConchUser.lookupSubsystem
  twisted.conch.interfaces.IConchUser.html#lookupSubsystem
  Function
  Method
  PUBLIC
  The other side requested a subsystem.
- twisted.conch.interfaces.IConchUser.gotGlobalRequest
  twisted.conch.interfaces.IConchUser.html#gotGlobalRequest
  Function
  Method
  PUBLIC
  A global request was sent from the other side.
- twisted.conch.interfaces.ISession
  twisted.conch.interfaces.ISession.html
  Class
  Interface
  PUBLIC
  No interface docstring; 6/6 methods documented
- twisted.conch.interfaces.ISession.getPty
  twisted.conch.interfaces.ISession.html#getPty
  Function
  Method
  PUBLIC
  Get a pseudo-terminal for use by a shell or command.
- twisted.conch.interfaces.ISession.openShell
  twisted.conch.interfaces.ISession.html#openShell
  Function
  Method
  PUBLIC
  Open a shell and connect it to proto.
- twisted.conch.interfaces.ISession.execCommand
  twisted.conch.interfaces.ISession.html#execCommand
  Function
  Method
  PUBLIC
  Execute a command.
- twisted.conch.interfaces.ISession.windowChanged
  twisted.conch.interfaces.ISession.html#windowChanged
  Function
  Method
  PUBLIC
  Called when the size of the remote screen has changed.
- twisted.conch.interfaces.ISession.eofReceived
  twisted.conch.interfaces.ISession.html#eofReceived
  Function
  Method
  PUBLIC
  Called when the other side has indicated no more data will be sent.
- twisted.conch.interfaces.ISession.closed
  twisted.conch.interfaces.ISession.html#closed
  Function
  Method
  PUBLIC
  Called when the session is closed.
- twisted.conch.interfaces.EnvironmentVariableNotPermitted
  twisted.conch.interfaces.EnvironmentVariableNotPermitted.html
  Class
  Exception
  PUBLIC
  Setting this environment variable in this session is not permitted.
- twisted.conch.interfaces.ISessionSetEnv
  twisted.conch.interfaces.ISessionSetEnv.html
  Class
  Interface
  PUBLIC
  A session that can set environment variables.
- twisted.conch.interfaces.ISessionSetEnv.setEnv
  twisted.conch.interfaces.ISessionSetEnv.html#setEnv
  Function
  Method
  PUBLIC
  Set an environment variable for the shell or command to be started.
- twisted.conch.interfaces.ISFTPServer
  twisted.conch.interfaces.ISFTPServer.html
  Class
  Interface
  PUBLIC
  SFTP subsystem for server-side communication.
- twisted.conch.interfaces.ISFTPServer.avatar
  twisted.conch.interfaces.ISFTPServer.html#avatar
  Attribute
  Attribute
  PUBLIC
  The avatar returned by the Realm that we are authenticated with, and represents the logged-in user.
- twisted.conch.interfaces.ISFTPServer.gotVersion
  twisted.conch.interfaces.ISFTPServer.html#gotVersion
  Function
  Method
  PUBLIC
  Called when the client sends their version info.
- twisted.conch.interfaces.ISFTPServer.openFile
  twisted.conch.interfaces.ISFTPServer.html#openFile
  Function
  Method
  PUBLIC
  Called when the clients asks to open a file.
- twisted.conch.interfaces.ISFTPServer.removeFile
  twisted.conch.interfaces.ISFTPServer.html#removeFile
  Function
  Method
  PUBLIC
  Remove the given file.
- twisted.conch.interfaces.ISFTPServer.renameFile
  twisted.conch.interfaces.ISFTPServer.html#renameFile
  Function
  Method
  PUBLIC
  Rename the given file.
- twisted.conch.interfaces.ISFTPServer.makeDirectory
  twisted.conch.interfaces.ISFTPServer.html#makeDirectory
  Function
  Method
  PUBLIC
  Make a directory.
- twisted.conch.interfaces.ISFTPServer.removeDirectory
  twisted.conch.interfaces.ISFTPServer.html#removeDirectory
  Function
  Method
  PUBLIC
  Remove a directory (non-recursively)
- twisted.conch.interfaces.ISFTPServer.openDirectory
  twisted.conch.interfaces.ISFTPServer.html#openDirectory
  Function
  Method
  PUBLIC
  Open a directory for scanning.
- twisted.conch.interfaces.ISFTPServer.getAttrs
  twisted.conch.interfaces.ISFTPServer.html#getAttrs
  Function
  Method
  PUBLIC
  Return the attributes for the given path.
- twisted.conch.interfaces.ISFTPServer.setAttrs
  twisted.conch.interfaces.ISFTPServer.html#setAttrs
  Function
  Method
  PUBLIC
  Set the attributes for the path.
- twisted.conch.interfaces.ISFTPServer.readLink
  twisted.conch.interfaces.ISFTPServer.html#readLink
  Function
  Method
  PUBLIC
  Find the root of a set of symbolic links.
- twisted.conch.interfaces.ISFTPServer.makeLink
  twisted.conch.interfaces.ISFTPServer.html#makeLink
  Function
  Method
  PUBLIC
  Create a symbolic link.
- twisted.conch.interfaces.ISFTPServer.realPath
  twisted.conch.interfaces.ISFTPServer.html#realPath
  Function
  Method
  PUBLIC
  Convert any path to an absolute path.
- twisted.conch.interfaces.ISFTPServer.extendedRequest
  twisted.conch.interfaces.ISFTPServer.html#extendedRequest
  Function
  Method
  PUBLIC
  This is the extension mechanism for SFTP. The other side can send us arbitrary requests.
- twisted.conch.interfaces.IKnownHostEntry
  twisted.conch.interfaces.IKnownHostEntry.html
  Class
  Interface
  PUBLIC
  A `IKnownHostEntry` is an entry in an OpenSSH-formatted `known_hosts` file.
- twisted.conch.interfaces.IKnownHostEntry.matchesKey
  twisted.conch.interfaces.IKnownHostEntry.html#matchesKey
  Function
  Method
  PUBLIC
  Return True if this entry matches the given Key object, False otherwise.
- twisted.conch.interfaces.IKnownHostEntry.matchesHost
  twisted.conch.interfaces.IKnownHostEntry.html#matchesHost
  Function
  Method
  PUBLIC
  Return True if this entry matches the given hostname, False otherwise.
- twisted.conch.interfaces.IKnownHostEntry.toString
  twisted.conch.interfaces.IKnownHostEntry.html#toString
  Function
  Method
  PUBLIC
  No summary
- twisted.conch.interfaces.ISFTPFile
  twisted.conch.interfaces.ISFTPFile.html
  Class
  Interface
  PUBLIC
  This represents an open file on the server. An object adhering to this interface should be returned from `openFile`().
- twisted.conch.interfaces.ISFTPFile.close
  twisted.conch.interfaces.ISFTPFile.html#close
  Function
  Method
  PUBLIC
  Close the file.
- twisted.conch.interfaces.ISFTPFile.readChunk
  twisted.conch.interfaces.ISFTPFile.html#readChunk
  Function
  Method
  PUBLIC
  Read from the file.
- twisted.conch.interfaces.ISFTPFile.writeChunk
  twisted.conch.interfaces.ISFTPFile.html#writeChunk
  Function
  Method
  PUBLIC
  Write to the file.
- twisted.conch.interfaces.ISFTPFile.getAttrs
  twisted.conch.interfaces.ISFTPFile.html#getAttrs
  Function
  Method
  PUBLIC
  Return the attributes for the file.
- twisted.conch.interfaces.ISFTPFile.setAttrs
  twisted.conch.interfaces.ISFTPFile.html#setAttrs
  Function
  Method
  PUBLIC
  Set the attributes for the file.
- twisted.conch.ssh.common.NS
  twisted.conch.ssh.common.html#NS
  Function
  Function
  PUBLIC
  net string
- twisted.conch.ssh.common.getNS
  twisted.conch.ssh.common.html#getNS
  Function
  Function
  PUBLIC
  get net string
- twisted.conch.ssh.common.MP
  twisted.conch.ssh.common.html#MP
  Function
  Function
  PUBLIC
  Undocumented
- twisted.conch.ssh.common.getMP
  twisted.conch.ssh.common.html#getMP
  Function
  Function
  PUBLIC
  Get multiple precision integer out of the string. A multiple precision integer is stored as a 4-byte length followed by length bytes of the integer. If count is specified, get count integers out of the string...
- twisted.conch.ssh.common.ffs
  twisted.conch.ssh.common.html#ffs
  Function
  Function
  PUBLIC
  first from second goes through the first list, looking for items in the second, returns the first one
- twisted.conch.ssh.common.install
  twisted.conch.ssh.common.html#install
  Function
  Function
  PUBLIC
  Undocumented
- twisted.conch.ssh.service.SSHService
  twisted.conch.ssh.service.SSHService.html
  Class
  Class
  PUBLIC
  No class docstring; 0/4 class variable, 3/4 methods documented
- twisted.conch.ssh.service.SSHService.name
  twisted.conch.ssh.service.SSHService.html#name
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.ssh.service.SSHService.protocolMessages
  twisted.conch.ssh.service.SSHService.html#protocolMessages
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.ssh.service.SSHService.transport
  twisted.conch.ssh.service.SSHService.html#transport
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.ssh.service.SSHService._log
  twisted.conch.ssh.service.SSHService.html#_log
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.conch.ssh.service.SSHService.serviceStarted
  twisted.conch.ssh.service.SSHService.html#serviceStarted
  Function
  Method
  PUBLIC
  called when the service is active on the transport.
- twisted.conch.ssh.service.SSHService.serviceStopped
  twisted.conch.ssh.service.SSHService.html#serviceStopped
  Function
  Method
  PUBLIC
  called when the service is stopped, either by the connection ending or by another service being started
- twisted.conch.ssh.service.SSHService.logPrefix
  twisted.conch.ssh.service.SSHService.html#logPrefix
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh.service.SSHService.packetReceived
  twisted.conch.ssh.service.SSHService.html#packetReceived
  Function
  Method
  PUBLIC
  called when we receive a packet on the transport
- twisted.conch.ssh.connection.SSHConnection
  twisted.conch.ssh.connection.SSHConnection.html
  Class
  Class
  PUBLIC
  An implementation of the 'ssh-connection' service. It is used to multiplex multiple channels over the single SSH connection.
- twisted.conch.ssh.connection.SSHConnection.localChannelID
  twisted.conch.ssh.connection.SSHConnection.html#localChannelID
  Attribute
  Instance Variable
  PUBLIC
  the next number to use as a local channel ID.
- twisted.conch.ssh.connection.SSHConnection.channels
  twisted.conch.ssh.connection.SSHConnection.html#channels
  Attribute
  Instance Variable
  PUBLIC
  a `dict` mapping a local channel ID to `SSHChannel` subclasses.
- twisted.conch.ssh.connection.SSHConnection.localToRemoteChannel
  twisted.conch.ssh.connection.SSHConnection.html#localToRemoteChannel
  Attribute
  Instance Variable
  PUBLIC
  a `dict` mapping a local channel ID to a remote channel ID.
- twisted.conch.ssh.connection.SSHConnection.channelsToRemoteChannel
  twisted.conch.ssh.connection.SSHConnection.html#channelsToRemoteChannel
  Attribute
  Instance Variable
  PUBLIC
  a `dict` mapping a `SSHChannel` subclass to remote channel ID.
- twisted.conch.ssh.connection.SSHConnection.deferreds
  twisted.conch.ssh.connection.SSHConnection.html#deferreds
  Attribute
  Instance Variable
  PUBLIC
  a `dict` mapping a local channel ID to a `list` of `Deferreds` for outstanding channel requests. Also, the 'global' key stores the `list` of pending global request `Deferred`s.
- twisted.conch.ssh.connection.SSHConnection.name
  twisted.conch.ssh.connection.SSHConnection.html#name
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.ssh.connection.SSHConnection._log
  twisted.conch.ssh.connection.SSHConnection.html#_log
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.conch.ssh.connection.SSHConnection.__init__
  twisted.conch.ssh.connection.SSHConnection.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh.connection.SSHConnection.transport
  twisted.conch.ssh.connection.SSHConnection.html#transport
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ssh.connection.SSHConnection.serviceStarted
  twisted.conch.ssh.connection.SSHConnection.html#serviceStarted
  Function
  Method
  PUBLIC
  called when the service is active on the transport.
- twisted.conch.ssh.connection.SSHConnection.serviceStopped
  twisted.conch.ssh.connection.SSHConnection.html#serviceStopped
  Function
  Method
  PUBLIC
  Called when the connection is stopped.
- twisted.conch.ssh.connection.SSHConnection._cleanupGlobalDeferreds
  twisted.conch.ssh.connection.SSHConnection.html#_cleanupGlobalDeferreds
  Function
  Method
  PRIVATE
  All pending requests that have returned a deferred must be errbacked when this service is stopped, otherwise they might be left uncalled and uncallable.
- twisted.conch.ssh.connection.SSHConnection.ssh_GLOBAL_REQUEST
  twisted.conch.ssh.connection.SSHConnection.html#ssh_GLOBAL_REQUEST
  Function
  Method
  PUBLIC
  The other side has made a global request. Payload:
- twisted.conch.ssh.connection.SSHConnection.ssh_REQUEST_SUCCESS
  twisted.conch.ssh.connection.SSHConnection.html#ssh_REQUEST_SUCCESS
  Function
  Method
  PUBLIC
  Our global request succeeded. Get the appropriate Deferred and call it back with the packet we received.
- twisted.conch.ssh.connection.SSHConnection.ssh_REQUEST_FAILURE
  twisted.conch.ssh.connection.SSHConnection.html#ssh_REQUEST_FAILURE
  Function
  Method
  PUBLIC
  Our global request failed. Get the appropriate Deferred and errback it with the packet we received.
- twisted.conch.ssh.connection.SSHConnection.ssh_CHANNEL_OPEN
  twisted.conch.ssh.connection.SSHConnection.html#ssh_CHANNEL_OPEN
  Function
  Method
  PUBLIC
  The other side wants to get a channel. Payload:
- twisted.conch.ssh.connection.SSHConnection.ssh_CHANNEL_OPEN_CONFIRMATION
  twisted.conch.ssh.connection.SSHConnection.html#ssh_CHANNEL_OPEN_CONFIRMATION
  Function
  Method
  PUBLIC
  The other side accepted our MSG_CHANNEL_OPEN request. Payload:
- twisted.conch.ssh.connection.SSHConnection.ssh_CHANNEL_OPEN_FAILURE
  twisted.conch.ssh.connection.SSHConnection.html#ssh_CHANNEL_OPEN_FAILURE
  Function
  Method
  PUBLIC
  The other side did not accept our MSG_CHANNEL_OPEN request. Payload:
- twisted.conch.ssh.connection.SSHConnection.ssh_CHANNEL_WINDOW_ADJUST
  twisted.conch.ssh.connection.SSHConnection.html#ssh_CHANNEL_WINDOW_ADJUST
  Function
  Method
  PUBLIC
  The other side is adding bytes to its window. Payload:
- twisted.conch.ssh.connection.SSHConnection.ssh_CHANNEL_DATA
  twisted.conch.ssh.connection.SSHConnection.html#ssh_CHANNEL_DATA
  Function
  Method
  PUBLIC
  The other side is sending us data. Payload:
- twisted.conch.ssh.connection.SSHConnection.ssh_CHANNEL_EXTENDED_DATA
  twisted.conch.ssh.connection.SSHConnection.html#ssh_CHANNEL_EXTENDED_DATA
  Function
  Method
  PUBLIC
  The other side is sending us exteneded data. Payload:
- twisted.conch.ssh.connection.SSHConnection.ssh_CHANNEL_EOF
  twisted.conch.ssh.connection.SSHConnection.html#ssh_CHANNEL_EOF
  Function
  Method
  PUBLIC
  The other side is not sending any more data. Payload:
- twisted.conch.ssh.connection.SSHConnection.ssh_CHANNEL_CLOSE
  twisted.conch.ssh.connection.SSHConnection.html#ssh_CHANNEL_CLOSE
  Function
  Method
  PUBLIC
  The other side is closing its end; it does not want to receive any more data. Payload:
- twisted.conch.ssh.connection.SSHConnection.ssh_CHANNEL_REQUEST
  twisted.conch.ssh.connection.SSHConnection.html#ssh_CHANNEL_REQUEST
  Function
  Method
  PUBLIC
  The other side is sending a request to a channel. Payload:
- twisted.conch.ssh.connection.SSHConnection._cbChannelRequest
  twisted.conch.ssh.connection.SSHConnection.html#_cbChannelRequest
  Function
  Method
  PRIVATE
  Called back if the other side wanted a reply to a channel request. If the result is true, send a MSG_CHANNEL_SUCCESS. Otherwise, raise a `error.ConchError`
- twisted.conch.ssh.connection.SSHConnection._ebChannelRequest
  twisted.conch.ssh.connection.SSHConnection.html#_ebChannelRequest
  Function
  Method
  PRIVATE
  Called if the other wisde wanted a reply to the channel requeset and the channel request failed.
- twisted.conch.ssh.connection.SSHConnection.ssh_CHANNEL_SUCCESS
  twisted.conch.ssh.connection.SSHConnection.html#ssh_CHANNEL_SUCCESS
  Function
  Method
  PUBLIC
  Our channel request to the other side succeeded. Payload:
- twisted.conch.ssh.connection.SSHConnection.ssh_CHANNEL_FAILURE
  twisted.conch.ssh.connection.SSHConnection.html#ssh_CHANNEL_FAILURE
  Function
  Method
  PUBLIC
  Our channel request to the other side failed. Payload:
- twisted.conch.ssh.connection.SSHConnection.sendGlobalRequest
  twisted.conch.ssh.connection.SSHConnection.html#sendGlobalRequest
  Function
  Method
  PUBLIC
  Send a global request for this connection. Current this is only used for remote->local TCP forwarding.
- twisted.conch.ssh.connection.SSHConnection.openChannel
  twisted.conch.ssh.connection.SSHConnection.html#openChannel
  Function
  Method
  PUBLIC
  Open a new channel on this connection.
- twisted.conch.ssh.connection.SSHConnection.sendRequest
  twisted.conch.ssh.connection.SSHConnection.html#sendRequest
  Function
  Method
  PUBLIC
  Send a request to a channel.
- twisted.conch.ssh.connection.SSHConnection.adjustWindow
  twisted.conch.ssh.connection.SSHConnection.html#adjustWindow
  Function
  Method
  PUBLIC
  Tell the other side that we will receive more data. This should not normally need to be called as it is managed automatically.
- twisted.conch.ssh.connection.SSHConnection.sendData
  twisted.conch.ssh.connection.SSHConnection.html#sendData
  Function
  Method
  PUBLIC
  Send data to a channel. This should not normally be used: instead use channel.write(data) as it manages the window automatically.
- twisted.conch.ssh.connection.SSHConnection.sendExtendedData
  twisted.conch.ssh.connection.SSHConnection.html#sendExtendedData
  Function
  Method
  PUBLIC
  Send extended data to a channel. This should not normally be used: instead use channel.writeExtendedData(data, dataType) as it manages the window automatically.
- twisted.conch.ssh.connection.SSHConnection.sendEOF
  twisted.conch.ssh.connection.SSHConnection.html#sendEOF
  Function
  Method
  PUBLIC
  Send an EOF (End of File) for a channel.
- twisted.conch.ssh.connection.SSHConnection.sendClose
  twisted.conch.ssh.connection.SSHConnection.html#sendClose
  Function
  Method
  PUBLIC
  Close a channel.
- twisted.conch.ssh.connection.SSHConnection.getChannel
  twisted.conch.ssh.connection.SSHConnection.html#getChannel
  Function
  Method
  PUBLIC
  The other side requested a channel of some sort. channelType is the type of channel being requested, windowSize is the initial size of the remote window, maxPacket is the largest packet we should send, data is any other packet data (often nothing).
- twisted.conch.ssh.connection.SSHConnection.gotGlobalRequest
  twisted.conch.ssh.connection.SSHConnection.html#gotGlobalRequest
  Function
  Method
  PUBLIC
  We got a global request. pretty much, this is just used by the client to request that we forward a port from the server to the client. Returns either:
- twisted.conch.ssh.connection.SSHConnection.channelClosed
  twisted.conch.ssh.connection.SSHConnection.html#channelClosed
  Function
  Method
  PUBLIC
  Called when a channel is closed. It clears the local state related to the channel, and calls channel.closed(). MAKE SURE YOU CALL THIS METHOD, even if you subclass `SSHConnection`. If you don't, things will break mysteriously.
- twisted.conch.ssh.connection.MSG_GLOBAL_REQUEST
  twisted.conch.ssh.connection.html#MSG_GLOBAL_REQUEST
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.connection.MSG_REQUEST_SUCCESS
  twisted.conch.ssh.connection.html#MSG_REQUEST_SUCCESS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.connection.MSG_REQUEST_FAILURE
  twisted.conch.ssh.connection.html#MSG_REQUEST_FAILURE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.connection.MSG_CHANNEL_OPEN
  twisted.conch.ssh.connection.html#MSG_CHANNEL_OPEN
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.connection.MSG_CHANNEL_OPEN_CONFIRMATION
  twisted.conch.ssh.connection.html#MSG_CHANNEL_OPEN_CONFIRMATION
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.connection.MSG_CHANNEL_OPEN_FAILURE
  twisted.conch.ssh.connection.html#MSG_CHANNEL_OPEN_FAILURE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.connection.MSG_CHANNEL_WINDOW_ADJUST
  twisted.conch.ssh.connection.html#MSG_CHANNEL_WINDOW_ADJUST
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.connection.MSG_CHANNEL_DATA
  twisted.conch.ssh.connection.html#MSG_CHANNEL_DATA
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.connection.MSG_CHANNEL_EXTENDED_DATA
  twisted.conch.ssh.connection.html#MSG_CHANNEL_EXTENDED_DATA
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.connection.MSG_CHANNEL_EOF
  twisted.conch.ssh.connection.html#MSG_CHANNEL_EOF
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.connection.MSG_CHANNEL_CLOSE
  twisted.conch.ssh.connection.html#MSG_CHANNEL_CLOSE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.connection.MSG_CHANNEL_REQUEST
  twisted.conch.ssh.connection.html#MSG_CHANNEL_REQUEST
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.connection.MSG_CHANNEL_SUCCESS
  twisted.conch.ssh.connection.html#MSG_CHANNEL_SUCCESS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.connection.MSG_CHANNEL_FAILURE
  twisted.conch.ssh.connection.html#MSG_CHANNEL_FAILURE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.connection.OPEN_ADMINISTRATIVELY_PROHIBITED
  twisted.conch.ssh.connection.html#OPEN_ADMINISTRATIVELY_PROHIBITED
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.connection.OPEN_CONNECT_FAILED
  twisted.conch.ssh.connection.html#OPEN_CONNECT_FAILED
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.connection.OPEN_UNKNOWN_CHANNEL_TYPE
  twisted.conch.ssh.connection.html#OPEN_UNKNOWN_CHANNEL_TYPE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.connection.OPEN_RESOURCE_SHORTAGE
  twisted.conch.ssh.connection.html#OPEN_RESOURCE_SHORTAGE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.connection.EXTENDED_DATA_STDERR
  twisted.conch.ssh.connection.html#EXTENDED_DATA_STDERR
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.connection.messages
  twisted.conch.ssh.connection.html#messages
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.conch.ssh.connection.alphanums
  twisted.conch.ssh.connection.html#alphanums
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.conch.ssh.connection.TRANSLATE_TABLE
  twisted.conch.ssh.connection.html#TRANSLATE_TABLE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.avatar.ConchUser
  twisted.conch.avatar.ConchUser.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.conch.avatar.ConchUser._log
  twisted.conch.avatar.ConchUser.html#_log
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.conch.avatar.ConchUser.__init__
  twisted.conch.avatar.ConchUser.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.avatar.ConchUser.channelLookup
  twisted.conch.avatar.ConchUser.html#channelLookup
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.avatar.ConchUser.subsystemLookup
  twisted.conch.avatar.ConchUser.html#subsystemLookup
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.avatar.ConchUser.conn
  twisted.conch.avatar.ConchUser.html#conn
  Attribute
  Property
  PUBLIC
  The SSHConnection object for this user.
- twisted.conch.avatar.ConchUser.conn.setter
  twisted.conch.avatar.ConchUser.html#conn.setter
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.avatar.ConchUser._conn
  twisted.conch.avatar.ConchUser.html#_conn
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.conch.avatar.ConchUser.lookupChannel
  twisted.conch.avatar.ConchUser.html#lookupChannel
  Function
  Method
  PUBLIC
  The other side requested a channel of some sort.
- twisted.conch.avatar.ConchUser.lookupSubsystem
  twisted.conch.avatar.ConchUser.html#lookupSubsystem
  Function
  Method
  PUBLIC
  The other side requested a subsystem.
- twisted.conch.avatar.ConchUser.gotGlobalRequest
  twisted.conch.avatar.ConchUser.html#gotGlobalRequest
  Function
  Method
  PUBLIC
  A global request was sent from the other side.
- twisted.conch.ssh.sexpy.parse
  twisted.conch.ssh.sexpy.html#parse
  Function
  Function
  PUBLIC
  Undocumented
- twisted.conch.ssh.sexpy.pack
  twisted.conch.ssh.sexpy.html#pack
  Function
  Function
  PUBLIC
  Undocumented
- twisted.conch.ssh.keys._curveTable
  twisted.conch.ssh.keys.html#_curveTable
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.conch.ssh.keys._secToNist
  twisted.conch.ssh.keys.html#_secToNist
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.conch.ssh.keys.Ed25519PublicKey
  twisted.conch.ssh.keys.html#Ed25519PublicKey
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.conch.ssh.keys.Ed25519PrivateKey
  twisted.conch.ssh.keys.html#Ed25519PrivateKey
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.conch.ssh.keys.BadKeyError
  twisted.conch.ssh.keys.BadKeyError.html
  Class
  Exception
  PUBLIC
  Raised when a key isn't what we expected from it.
- twisted.conch.ssh.keys.BadSignatureAlgorithmError
  twisted.conch.ssh.keys.BadSignatureAlgorithmError.html
  Class
  Exception
  PUBLIC
  Raised when a public key signature algorithm name isn't defined for this public key format.
- twisted.conch.ssh.keys.EncryptedKeyError
  twisted.conch.ssh.keys.EncryptedKeyError.html
  Class
  Exception
  PUBLIC
  Raised when an encrypted key is presented to fromString/fromFile without a password.
- twisted.conch.ssh.keys.BadFingerPrintFormat
  twisted.conch.ssh.keys.BadFingerPrintFormat.html
  Class
  Exception
  PUBLIC
  Raises when unsupported fingerprint formats are presented to fingerprint.
- twisted.conch.ssh.keys.FingerprintFormats
  twisted.conch.ssh.keys.FingerprintFormats.html
  Class
  Class
  PUBLIC
  Constants representing the supported formats of key fingerprints.
- twisted.conch.ssh.keys.FingerprintFormats.MD5_HEX
  twisted.conch.ssh.keys.FingerprintFormats.html#MD5_HEX
  Attribute
  Constant
  PUBLIC
  Named constant representing fingerprint format generated using md5[RFC1321] algorithm in hexadecimal encoding.
- twisted.conch.ssh.keys.FingerprintFormats.SHA256_BASE64
  twisted.conch.ssh.keys.FingerprintFormats.html#SHA256_BASE64
  Attribute
  Constant
  PUBLIC
  Named constant representing fingerprint format generated using sha256[RFC4634] algorithm in base64 encoding
- twisted.conch.ssh.keys.PassphraseNormalizationError
  twisted.conch.ssh.keys.PassphraseNormalizationError.html
  Class
  Exception
  PUBLIC
  Raised when a passphrase contains Unicode characters that cannot be normalized using the available Unicode character database.
- twisted.conch.ssh.keys._normalizePassphrase
  twisted.conch.ssh.keys.html#_normalizePassphrase
  Function
  Function
  PRIVATE
  Normalize a passphrase, which may be Unicode.
- twisted.conch.ssh.keys.Key
  twisted.conch.ssh.keys.Key.html
  Class
  Class
  PUBLIC
  An object representing a key. A key can be either a public or private key. A public key can verify a signature; a private key can create or verify a signature. To generate a string that can be stored on disk, use the toString method...
- twisted.conch.ssh.keys.Key.fromFile
  twisted.conch.ssh.keys.Key.html#fromFile
  Function
  Class Method
  PUBLIC
  Load a key from a file.
- twisted.conch.ssh.keys.Key.fromString
  twisted.conch.ssh.keys.Key.html#fromString
  Function
  Class Method
  PUBLIC
  Return a Key object corresponding to the string data. type is optionally the type of string, matching a _fromString_* method. Otherwise, the _guessStringType() classmethod will be used to guess a type...
- twisted.conch.ssh.keys.Key._fromString_BLOB
  twisted.conch.ssh.keys.Key.html#_fromString_BLOB
  Function
  Class Method
  PRIVATE
  Return a public key object corresponding to this public key blob. The format of a RSA public key blob is:
- twisted.conch.ssh.keys.Key._fromString_PRIVATE_BLOB
  twisted.conch.ssh.keys.Key.html#_fromString_PRIVATE_BLOB
  Function
  Class Method
  PRIVATE
  Return a private key object corresponding to this private key blob. The blob formats are as follows:
- twisted.conch.ssh.keys.Key._fromString_PUBLIC_OPENSSH
  twisted.conch.ssh.keys.Key.html#_fromString_PUBLIC_OPENSSH
  Function
  Class Method
  PRIVATE
  Return a public key object corresponding to this OpenSSH public key string. The format of an OpenSSH public key string is:
- twisted.conch.ssh.keys.Key._fromPrivateOpenSSH_v1
  twisted.conch.ssh.keys.Key.html#_fromPrivateOpenSSH_v1
  Function
  Class Method
  PRIVATE
  Return a private key object corresponding to this OpenSSH private key string, in the "openssh-key-v1" format introduced in OpenSSH 6.5.
- twisted.conch.ssh.keys.Key._fromPrivateOpenSSH_PEM
  twisted.conch.ssh.keys.Key.html#_fromPrivateOpenSSH_PEM
  Function
  Class Method
  PRIVATE
  Return a private key object corresponding to this OpenSSH private key string, in the old PEM-based format.
- twisted.conch.ssh.keys.Key._fromString_PRIVATE_OPENSSH
  twisted.conch.ssh.keys.Key.html#_fromString_PRIVATE_OPENSSH
  Function
  Class Method
  PRIVATE
  Return a private key object corresponding to this OpenSSH private key string. If the key is encrypted, passphrase MUST be provided. Providing a passphrase for an unencrypted key is an error.
- twisted.conch.ssh.keys.Key._fromString_PUBLIC_LSH
  twisted.conch.ssh.keys.Key.html#_fromString_PUBLIC_LSH
  Function
  Class Method
  PRIVATE
  Return a public key corresponding to this LSH public key string. The LSH public key string format is:
- twisted.conch.ssh.keys.Key._fromString_PRIVATE_LSH
  twisted.conch.ssh.keys.Key.html#_fromString_PRIVATE_LSH
  Function
  Class Method
  PRIVATE
  Return a private key corresponding to this LSH private key string. The LSH private key string format is:
- twisted.conch.ssh.keys.Key._fromString_AGENTV3
  twisted.conch.ssh.keys.Key.html#_fromString_AGENTV3
  Function
  Class Method
  PRIVATE
  Return a private key object corresponsing to the Secure Shell Key Agent v3 format.
- twisted.conch.ssh.keys.Key._guessStringType
  twisted.conch.ssh.keys.Key.html#_guessStringType
  Function
  Class Method
  PRIVATE
  Guess the type of key in data. The types map to _fromString_* methods.
- twisted.conch.ssh.keys.Key._fromRSAComponents
  twisted.conch.ssh.keys.Key.html#_fromRSAComponents
  Function
  Class Method
  PRIVATE
  Build a key from RSA numerical components.
- twisted.conch.ssh.keys.Key._fromDSAComponents
  twisted.conch.ssh.keys.Key.html#_fromDSAComponents
  Function
  Class Method
  PRIVATE
  Build a key from DSA numerical components.
- twisted.conch.ssh.keys.Key._fromECComponents
  twisted.conch.ssh.keys.Key.html#_fromECComponents
  Function
  Class Method
  PRIVATE
  Build a key from EC components.
- twisted.conch.ssh.keys.Key._fromECEncodedPoint
  twisted.conch.ssh.keys.Key.html#_fromECEncodedPoint
  Function
  Class Method
  PRIVATE
  Build a key from an EC encoded point.
- twisted.conch.ssh.keys.Key._fromEd25519Components
  twisted.conch.ssh.keys.Key.html#_fromEd25519Components
  Function
  Class Method
  PRIVATE
  Build a key from Ed25519 components.
- twisted.conch.ssh.keys.Key.__init__
  twisted.conch.ssh.keys.Key.html#__init__
  Function
  Method
  PUBLIC
  Initialize with a private or public `cryptography.hazmat.primitives.asymmetric` key.
- twisted.conch.ssh.keys.Key._keyObject
  twisted.conch.ssh.keys.Key.html#_keyObject
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.conch.ssh.keys.Key.__eq__
  twisted.conch.ssh.keys.Key.html#__eq__
  Function
  Method
  PUBLIC
  Return True if other represents an object with the same key.
- twisted.conch.ssh.keys.Key.__repr__
  twisted.conch.ssh.keys.Key.html#__repr__
  Function
  Method
  PUBLIC
  Return a pretty representation of this object.
- twisted.conch.ssh.keys.Key.isPublic
  twisted.conch.ssh.keys.Key.html#isPublic
  Function
  Method
  PUBLIC
  Check if this instance is a public key.
- twisted.conch.ssh.keys.Key.public
  twisted.conch.ssh.keys.Key.html#public
  Function
  Method
  PUBLIC
  Returns a version of this key containing only the public key data. If this is a public key, this may or may not be the same object as self.
- twisted.conch.ssh.keys.Key.fingerprint
  twisted.conch.ssh.keys.Key.html#fingerprint
  Function
  Method
  PUBLIC
  The fingerprint of a public key consists of the output of the message-digest algorithm in the specified format. Supported formats include `FingerprintFormats.MD5_HEX` and `FingerprintFormats.SHA256_BASE64`...
- twisted.conch.ssh.keys.Key.type
  twisted.conch.ssh.keys.Key.html#type
  Function
  Method
  PUBLIC
  Return the type of the object we wrap. Currently this can only be 'RSA', 'DSA', 'EC', or 'Ed25519'.
- twisted.conch.ssh.keys.Key.sshType
  twisted.conch.ssh.keys.Key.html#sshType
  Function
  Method
  PUBLIC
  Get the type of the object we wrap as defined in the SSH protocol, defined in RFC 4253, Section 6.6 and RFC 8332, section 4 (this is a public key format name, not a public key algorithm name). Currently this can only be b'ssh-rsa', b'ssh-dss', b'ecdsa-sha2-[identifier]' or b'ssh-ed25519'.
- twisted.conch.ssh.keys.Key.supportedSignatureAlgorithms
  twisted.conch.ssh.keys.Key.html#supportedSignatureAlgorithms
  Function
  Method
  PUBLIC
  Get the public key signature algorithms supported by this key.
- twisted.conch.ssh.keys.Key._getHashAlgorithm
  twisted.conch.ssh.keys.Key.html#_getHashAlgorithm
  Function
  Method
  PRIVATE
  Return a hash algorithm for this key type given an SSH signature algorithm name, or `None` if no such hash algorithm is defined for this key type.
- twisted.conch.ssh.keys.Key.size
  twisted.conch.ssh.keys.Key.html#size
  Function
  Method
  PUBLIC
  Return the size of the object we wrap.
- twisted.conch.ssh.keys.Key.data
  twisted.conch.ssh.keys.Key.html#data
  Function
  Method
  PUBLIC
  Return the values of the public key as a dictionary.
- twisted.conch.ssh.keys.Key.blob
  twisted.conch.ssh.keys.Key.html#blob
  Function
  Method
  PUBLIC
  Return the public key blob for this key. The blob is the over-the-wire format for public keys.
- twisted.conch.ssh.keys.Key.privateBlob
  twisted.conch.ssh.keys.Key.html#privateBlob
  Function
  Method
  PUBLIC
  Return the private key blob for this key. The blob is the over-the-wire format for private keys:
- twisted.conch.ssh.keys.Key.toString
  twisted.conch.ssh.keys.Key.html#toString
  Function
  Method
  PUBLIC
  Create a string representation of this key. If the key is a private key and you want the representation of its public key, use `key.public().toString()`. type maps to a _toString_* method.
- twisted.conch.ssh.keys.Key._toPublicOpenSSH
  twisted.conch.ssh.keys.Key.html#_toPublicOpenSSH
  Function
  Method
  PRIVATE
  Return a public OpenSSH key string.
- twisted.conch.ssh.keys.Key._toPrivateOpenSSH_v1
  twisted.conch.ssh.keys.Key.html#_toPrivateOpenSSH_v1
  Function
  Method
  PRIVATE
  Return a private OpenSSH key string, in the "openssh-key-v1" format introduced in OpenSSH 6.5.
- twisted.conch.ssh.keys.Key._toPrivateOpenSSH_PEM
  twisted.conch.ssh.keys.Key.html#_toPrivateOpenSSH_PEM
  Function
  Method
  PRIVATE
  Return a private OpenSSH key string, in the old PEM-based format.
- twisted.conch.ssh.keys.Key._toString_OPENSSH
  twisted.conch.ssh.keys.Key.html#_toString_OPENSSH
  Function
  Method
  PRIVATE
  Return a public or private OpenSSH string. See `_fromString_PUBLIC_OPENSSH` and `_fromPrivateOpenSSH_PEM` for the string formats.
- twisted.conch.ssh.keys.Key._toString_LSH
  twisted.conch.ssh.keys.Key.html#_toString_LSH
  Function
  Method
  PRIVATE
  Return a public or private LSH key. See _fromString_PUBLIC_LSH and _fromString_PRIVATE_LSH for the key formats.
- twisted.conch.ssh.keys.Key._toString_AGENTV3
  twisted.conch.ssh.keys.Key.html#_toString_AGENTV3
  Function
  Method
  PRIVATE
  Return a private Secure Shell Agent v3 key. See _fromString_AGENTV3 for the key format.
- twisted.conch.ssh.keys.Key.sign
  twisted.conch.ssh.keys.Key.html#sign
  Function
  Method
  PUBLIC
  Sign some data with this key.
- twisted.conch.ssh.keys.Key.verify
  twisted.conch.ssh.keys.Key.html#verify
  Function
  Method
  PUBLIC
  Verify a signature using this key.
- twisted.conch.ssh.keys._getPersistentRSAKey
  twisted.conch.ssh.keys.html#_getPersistentRSAKey
  Function
  Function
  PRIVATE
  This function returns a persistent `Key`.
- twisted.cred.checkers.ANONYMOUS
  twisted.cred.checkers.html#ANONYMOUS
  Attribute
  Constant
  PUBLIC
  An empty tuple used to represent the anonymous avatar ID.
- twisted.cred._digest.algorithms
  twisted.cred._digest.html#algorithms
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.cred._digest.calcHA1
  twisted.cred._digest.html#calcHA1
  Function
  Function
  PUBLIC
  Compute H(A1) from RFC 2617.
- twisted.cred._digest.calcHA2
  twisted.cred._digest.html#calcHA2
  Function
  Function
  PUBLIC
  Compute H(A2) from RFC 2617.
- twisted.cred._digest.calcResponse
  twisted.cred._digest.html#calcResponse
  Function
  Function
  PUBLIC
  Compute the digest for the given parameters.
- twisted.cred.credentials.ICredentials
  twisted.cred.credentials.ICredentials.html
  Class
  Interface
  PUBLIC
  I check credentials.
- twisted.cred.credentials.IUsernameHashedPassword
  twisted.cred.credentials.IUsernameHashedPassword.html
  Class
  Interface
  PUBLIC
  I encapsulate a username and a hashed password.
- twisted.cred.credentials.IUsernameHashedPassword.username
  twisted.cred.credentials.IUsernameHashedPassword.html#username
  Attribute
  Instance Variable
  PUBLIC
  The username associated with these credentials.
- twisted.cred.credentials.IUsernameHashedPassword.checkPassword
  twisted.cred.credentials.IUsernameHashedPassword.html#checkPassword
  Function
  Method
  PUBLIC
  Validate these credentials against the correct password.
- twisted.cred.credentials.IUsernamePassword
  twisted.cred.credentials.IUsernamePassword.html
  Class
  Interface
  PUBLIC
  I encapsulate a username and a plaintext password.
- twisted.cred.credentials.IUsernamePassword.username
  twisted.cred.credentials.IUsernamePassword.html#username
  Attribute
  Instance Variable
  PUBLIC
  The username associated with these credentials.
- twisted.cred.credentials.IUsernamePassword.password
  twisted.cred.credentials.IUsernamePassword.html#password
  Attribute
  Instance Variable
  PUBLIC
  The password associated with these credentials.
- twisted.cred.credentials.IUsernamePassword.checkPassword
  twisted.cred.credentials.IUsernamePassword.html#checkPassword
  Function
  Method
  PUBLIC
  Validate these credentials against the correct password.
- twisted.cred.credentials.IAnonymous
  twisted.cred.credentials.IAnonymous.html
  Class
  Interface
  PUBLIC
  I am an explicitly anonymous request for access.
- twisted.cred.credentials.DigestedCredentials
  twisted.cred.credentials.DigestedCredentials.html
  Class
  Class
  PUBLIC
  Yet Another Simple HTTP Digest authentication scheme.
- twisted.cred.credentials.DigestedCredentials.__init__
  twisted.cred.credentials.DigestedCredentials.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.cred.credentials.DigestedCredentials.username
  twisted.cred.credentials.DigestedCredentials.html#username
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.cred.credentials.DigestedCredentials.method
  twisted.cred.credentials.DigestedCredentials.html#method
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.cred.credentials.DigestedCredentials.realm
  twisted.cred.credentials.DigestedCredentials.html#realm
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.cred.credentials.DigestedCredentials.fields
  twisted.cred.credentials.DigestedCredentials.html#fields
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.cred.credentials.DigestedCredentials.checkPassword
  twisted.cred.credentials.DigestedCredentials.html#checkPassword
  Function
  Method
  PUBLIC
  Verify that the credentials represented by this object agree with the given plaintext `password` by hashing `password` in the same way the response hash represented by this object was generated and comparing the results.
- twisted.cred.credentials.DigestedCredentials.checkHash
  twisted.cred.credentials.DigestedCredentials.html#checkHash
  Function
  Method
  PUBLIC
  Verify that the credentials represented by this object agree with the credentials represented by the H(A1) given in `digestHash`.
- twisted.cred.credentials.DigestCredentialFactory
  twisted.cred.credentials.DigestCredentialFactory.html
  Class
  Class
  PUBLIC
  Support for RFC2617 HTTP Digest Authentication
- twisted.cred.credentials.DigestCredentialFactory.CHALLENGE_LIFETIME_SECS
  twisted.cred.credentials.DigestCredentialFactory.html#CHALLENGE_LIFETIME_SECS
  Attribute
  Constant
  PUBLIC
  The number of seconds for which an opaque should be valid.
- twisted.cred.credentials.DigestCredentialFactory.privateKey
  twisted.cred.credentials.DigestCredentialFactory.html#privateKey
  Attribute
  Instance Variable
  PUBLIC
  A random string used for generating the secure opaque.
- twisted.cred.credentials.DigestCredentialFactory.algorithm
  twisted.cred.credentials.DigestCredentialFactory.html#algorithm
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.cred.credentials.DigestCredentialFactory.authenticationRealm
  twisted.cred.credentials.DigestCredentialFactory.html#authenticationRealm
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.cred.credentials.DigestCredentialFactory._parseparts
  twisted.cred.credentials.DigestCredentialFactory.html#_parseparts
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.cred.credentials.DigestCredentialFactory.scheme
  twisted.cred.credentials.DigestCredentialFactory.html#scheme
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.cred.credentials.DigestCredentialFactory.__init__
  twisted.cred.credentials.DigestCredentialFactory.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.cred.credentials.DigestCredentialFactory.getChallenge
  twisted.cred.credentials.DigestCredentialFactory.html#getChallenge
  Function
  Method
  PUBLIC
  Generate the challenge for use in the WWW-Authenticate header.
- twisted.cred.credentials.DigestCredentialFactory._generateNonce
  twisted.cred.credentials.DigestCredentialFactory.html#_generateNonce
  Function
  Method
  PRIVATE
  Create a random value suitable for use as the nonce parameter of a WWW-Authenticate challenge.
- twisted.cred.credentials.DigestCredentialFactory._getTime
  twisted.cred.credentials.DigestCredentialFactory.html#_getTime
  Function
  Method
  PRIVATE
  Parameterize the time based seed used in `_generateOpaque` so we can deterministically unittest it's behavior.
- twisted.cred.credentials.DigestCredentialFactory._generateOpaque
  twisted.cred.credentials.DigestCredentialFactory.html#_generateOpaque
  Function
  Method
  PRIVATE
  Generate an opaque to be returned to the client. This is a unique string that can be returned to us and verified.
- twisted.cred.credentials.DigestCredentialFactory._verifyOpaque
  twisted.cred.credentials.DigestCredentialFactory.html#_verifyOpaque
  Function
  Method
  PRIVATE
  Given the opaque and nonce from the request, as well as the client IP that made the request, verify that the opaque was generated by us. And that it's not too old.
- twisted.cred.credentials.DigestCredentialFactory.decode
  twisted.cred.credentials.DigestCredentialFactory.html#decode
  Function
  Method
  PUBLIC
  Decode the given response and attempt to generate a `DigestedCredentials` from it.
- twisted.cred.credentials.CramMD5Credentials
  twisted.cred.credentials.CramMD5Credentials.html
  Class
  Class
  PUBLIC
  An encapsulation of some CramMD5 hashed credentials.
- twisted.cred.credentials.CramMD5Credentials.challenge
  twisted.cred.credentials.CramMD5Credentials.html#challenge
  Attribute
  Instance Variable
  PUBLIC
  The challenge to be sent to the client.
- twisted.cred.credentials.CramMD5Credentials.response
  twisted.cred.credentials.CramMD5Credentials.html#response
  Attribute
  Instance Variable
  PUBLIC
  The hashed response from the client.
- twisted.cred.credentials.CramMD5Credentials.username
  twisted.cred.credentials.CramMD5Credentials.html#username
  Attribute
  Instance Variable
  PUBLIC
  The username from the response from the client.
- twisted.cred.credentials.CramMD5Credentials.__init__
  twisted.cred.credentials.CramMD5Credentials.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.cred.credentials.CramMD5Credentials.host
  twisted.cred.credentials.CramMD5Credentials.html#host
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.cred.credentials.CramMD5Credentials.getChallenge
  twisted.cred.credentials.CramMD5Credentials.html#getChallenge
  Function
  Method
  PUBLIC
  Undocumented
- twisted.cred.credentials.CramMD5Credentials.setResponse
  twisted.cred.credentials.CramMD5Credentials.html#setResponse
  Function
  Method
  PUBLIC
  Undocumented
- twisted.cred.credentials.CramMD5Credentials.moreChallenges
  twisted.cred.credentials.CramMD5Credentials.html#moreChallenges
  Function
  Method
  PUBLIC
  Undocumented
- twisted.cred.credentials.CramMD5Credentials.checkPassword
  twisted.cred.credentials.CramMD5Credentials.html#checkPassword
  Function
  Method
  PUBLIC
  Validate these credentials against the correct password.
- twisted.cred.credentials.UsernameHashedPassword
  twisted.cred.credentials.UsernameHashedPassword.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.cred.credentials.UsernameHashedPassword.__init__
  twisted.cred.credentials.UsernameHashedPassword.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.cred.credentials.UsernameHashedPassword.username
  twisted.cred.credentials.UsernameHashedPassword.html#username
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.cred.credentials.UsernameHashedPassword.hashed
  twisted.cred.credentials.UsernameHashedPassword.html#hashed
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.cred.credentials.UsernameHashedPassword.checkPassword
  twisted.cred.credentials.UsernameHashedPassword.html#checkPassword
  Function
  Method
  PUBLIC
  Validate these credentials against the correct password.
- twisted.cred.credentials.UsernamePassword
  twisted.cred.credentials.UsernamePassword.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.cred.credentials.UsernamePassword.__init__
  twisted.cred.credentials.UsernamePassword.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.cred.credentials.UsernamePassword.username
  twisted.cred.credentials.UsernamePassword.html#username
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.cred.credentials.UsernamePassword.password
  twisted.cred.credentials.UsernamePassword.html#password
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.cred.credentials.UsernamePassword.checkPassword
  twisted.cred.credentials.UsernamePassword.html#checkPassword
  Function
  Method
  PUBLIC
  Validate these credentials against the correct password.
- twisted.cred.credentials.Anonymous
  twisted.cred.credentials.Anonymous.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.cred.credentials.ISSHPrivateKey
  twisted.cred.credentials.ISSHPrivateKey.html
  Class
  Interface
  PUBLIC
  `ISSHPrivateKey` credentials encapsulate an SSH public key to be checked against a user's private key.
- twisted.cred.credentials.ISSHPrivateKey.username
  twisted.cred.credentials.ISSHPrivateKey.html#username
  Attribute
  Instance Variable
  PUBLIC
  The username associated with these credentials.
- twisted.cred.credentials.ISSHPrivateKey.algName
  twisted.cred.credentials.ISSHPrivateKey.html#algName
  Attribute
  Instance Variable
  PUBLIC
  The algorithm name for the blob.
- twisted.cred.credentials.ISSHPrivateKey.blob
  twisted.cred.credentials.ISSHPrivateKey.html#blob
  Attribute
  Instance Variable
  PUBLIC
  The public key blob as sent by the client.
- twisted.cred.credentials.ISSHPrivateKey.sigData
  twisted.cred.credentials.ISSHPrivateKey.html#sigData
  Attribute
  Instance Variable
  PUBLIC
  The data the signature was made from.
- twisted.cred.credentials.ISSHPrivateKey.signature
  twisted.cred.credentials.ISSHPrivateKey.html#signature
  Attribute
  Instance Variable
  PUBLIC
  The signed data. This is checked to verify that the user owns the private key.
- twisted.cred.credentials.SSHPrivateKey
  twisted.cred.credentials.SSHPrivateKey.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.cred.credentials.SSHPrivateKey.__init__
  twisted.cred.credentials.SSHPrivateKey.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.cred.credentials.SSHPrivateKey.username
  twisted.cred.credentials.SSHPrivateKey.html#username
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.cred.credentials.SSHPrivateKey.algName
  twisted.cred.credentials.SSHPrivateKey.html#algName
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.cred.credentials.SSHPrivateKey.blob
  twisted.cred.credentials.SSHPrivateKey.html#blob
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.cred.credentials.SSHPrivateKey.sigData
  twisted.cred.credentials.SSHPrivateKey.html#sigData
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.cred.credentials.SSHPrivateKey.signature
  twisted.cred.credentials.SSHPrivateKey.html#signature
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.cred.checkers.ICredentialsChecker
  twisted.cred.checkers.ICredentialsChecker.html
  Class
  Interface
  PUBLIC
  An object that can check sub-interfaces of `ICredentials`.
- twisted.cred.checkers.ICredentialsChecker.credentialInterfaces
  twisted.cred.checkers.ICredentialsChecker.html#credentialInterfaces
  Attribute
  Attribute
  PUBLIC
  A list of sub-interfaces of `ICredentials` which specifies which I may check.
- twisted.cred.checkers.ICredentialsChecker.requestAvatarId
  twisted.cred.checkers.ICredentialsChecker.html#requestAvatarId
  Function
  Method
  PUBLIC
  Validate credentials and produce an avatar ID.
- twisted.cred.checkers.AllowAnonymousAccess
  twisted.cred.checkers.AllowAnonymousAccess.html
  Class
  Class
  PUBLIC
  A credentials checker that unconditionally grants anonymous access.
- twisted.cred.checkers.AllowAnonymousAccess.credentialInterfaces
  twisted.cred.checkers.AllowAnonymousAccess.html#credentialInterfaces
  Attribute
  Class Variable
  PUBLIC
  Tuple containing `IAnonymous`.
- twisted.cred.checkers.AllowAnonymousAccess.requestAvatarId
  twisted.cred.checkers.AllowAnonymousAccess.html#requestAvatarId
  Function
  Method
  PUBLIC
  Succeed with the `ANONYMOUS` avatar ID.
- twisted.cred.checkers.InMemoryUsernamePasswordDatabaseDontUse
  twisted.cred.checkers.InMemoryUsernamePasswordDatabaseDontUse.html
  Class
  Class
  PUBLIC
  An extremely simple credentials checker.
- twisted.cred.checkers.InMemoryUsernamePasswordDatabaseDontUse.credentialInterfaces
  twisted.cred.checkers.InMemoryUsernamePasswordDatabaseDontUse.html#credentialInterfaces
  Attribute
  Class Variable
  PUBLIC
  Tuple of `IUsernamePassword` and `IUsernameHashedPassword`.
- twisted.cred.checkers.InMemoryUsernamePasswordDatabaseDontUse.users
  twisted.cred.checkers.InMemoryUsernamePasswordDatabaseDontUse.html#users
  Attribute
  Instance Variable
  PUBLIC
  Mapping of usernames to passwords.
- twisted.cred.checkers.InMemoryUsernamePasswordDatabaseDontUse.__init__
  twisted.cred.checkers.InMemoryUsernamePasswordDatabaseDontUse.html#__init__
  Function
  Method
  PUBLIC
  Initialize the in-memory database.
- twisted.cred.checkers.InMemoryUsernamePasswordDatabaseDontUse.addUser
  twisted.cred.checkers.InMemoryUsernamePasswordDatabaseDontUse.html#addUser
  Function
  Method
  PUBLIC
  Set a user's password.
- twisted.cred.checkers.InMemoryUsernamePasswordDatabaseDontUse._cbPasswordMatch
  twisted.cred.checkers.InMemoryUsernamePasswordDatabaseDontUse.html#_cbPasswordMatch
  Function
  Method
  PRIVATE
  Undocumented
- twisted.cred.checkers.InMemoryUsernamePasswordDatabaseDontUse.requestAvatarId
  twisted.cred.checkers.InMemoryUsernamePasswordDatabaseDontUse.html#requestAvatarId
  Function
  Method
  PUBLIC
  Validate credentials and produce an avatar ID.
- twisted.cred.checkers.FilePasswordDB
  twisted.cred.checkers.FilePasswordDB.html
  Class
  Class
  PUBLIC
  A file-based, text-based username/password database.
- twisted.cred.checkers.FilePasswordDB.cache
  twisted.cred.checkers.FilePasswordDB.html#cache
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.cred.checkers.FilePasswordDB._credCache
  twisted.cred.checkers.FilePasswordDB.html#_credCache
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.cred.checkers.FilePasswordDB._cacheTimestamp
  twisted.cred.checkers.FilePasswordDB.html#_cacheTimestamp
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.cred.checkers.FilePasswordDB._log
  twisted.cred.checkers.FilePasswordDB.html#_log
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.cred.checkers.FilePasswordDB.__init__
  twisted.cred.checkers.FilePasswordDB.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.cred.checkers.FilePasswordDB.filename
  twisted.cred.checkers.FilePasswordDB.html#filename
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.cred.checkers.FilePasswordDB.delim
  twisted.cred.checkers.FilePasswordDB.html#delim
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.cred.checkers.FilePasswordDB.ufield
  twisted.cred.checkers.FilePasswordDB.html#ufield
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.cred.checkers.FilePasswordDB.pfield
  twisted.cred.checkers.FilePasswordDB.html#pfield
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.cred.checkers.FilePasswordDB.caseSensitive
  twisted.cred.checkers.FilePasswordDB.html#caseSensitive
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.cred.checkers.FilePasswordDB.hash
  twisted.cred.checkers.FilePasswordDB.html#hash
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.cred.checkers.FilePasswordDB.credentialInterfaces
  twisted.cred.checkers.FilePasswordDB.html#credentialInterfaces
  Attribute
  Instance Variable
  PUBLIC
  A list of sub-interfaces of `ICredentials` which specifies which I may check.
- twisted.cred.checkers.FilePasswordDB.__getstate__
  twisted.cred.checkers.FilePasswordDB.html#__getstate__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.cred.checkers.FilePasswordDB._cbPasswordMatch
  twisted.cred.checkers.FilePasswordDB.html#_cbPasswordMatch
  Function
  Method
  PRIVATE
  Undocumented
- twisted.cred.checkers.FilePasswordDB._loadCredentials
  twisted.cred.checkers.FilePasswordDB.html#_loadCredentials
  Function
  Method
  PRIVATE
  Loads the credentials from the configured file.
- twisted.cred.checkers.FilePasswordDB.getUser
  twisted.cred.checkers.FilePasswordDB.html#getUser
  Function
  Method
  PUBLIC
  Look up the credentials for a username.
- twisted.cred.checkers.FilePasswordDB.requestAvatarId
  twisted.cred.checkers.FilePasswordDB.html#requestAvatarId
  Function
  Method
  PUBLIC
  Validate credentials and produce an avatar ID.
- twisted.cred.strcred.ICheckerFactory
  twisted.cred.strcred.ICheckerFactory.html
  Class
  Interface
  PUBLIC
  A factory for objects which provide `twisted.cred.checkers.ICredentialsChecker`.
- twisted.cred.strcred.ICheckerFactory.authType
  twisted.cred.strcred.ICheckerFactory.html#authType
  Attribute
  Attribute
  PUBLIC
  A tag that identifies the authentication method.
- twisted.cred.strcred.ICheckerFactory.authHelp
  twisted.cred.strcred.ICheckerFactory.html#authHelp
  Attribute
  Attribute
  PUBLIC
  A detailed (potentially multi-line) description of precisely what functionality this CheckerFactory provides.
- twisted.cred.strcred.ICheckerFactory.argStringFormat
  twisted.cred.strcred.ICheckerFactory.html#argStringFormat
  Attribute
  Attribute
  PUBLIC
  A short (one-line) description of the argument string format.
- twisted.cred.strcred.ICheckerFactory.credentialInterfaces
  twisted.cred.strcred.ICheckerFactory.html#credentialInterfaces
  Attribute
  Attribute
  PUBLIC
  A list of credentials interfaces that this factory will support.
- twisted.cred.strcred.ICheckerFactory.generateChecker
  twisted.cred.strcred.ICheckerFactory.html#generateChecker
  Function
  Method
  PUBLIC
  Return an `twisted.cred.checkers.ICredentialsChecker` provider using the supplied argument string.
- twisted.cred.strcred.StrcredException
  twisted.cred.strcred.StrcredException.html
  Class
  Exception
  PUBLIC
  Base exception class for strcred.
- twisted.cred.strcred.InvalidAuthType
  twisted.cred.strcred.InvalidAuthType.html
  Class
  Exception
  PUBLIC
  Raised when a user provides an invalid identifier for the authentication plugin (known as the authType).
- twisted.cred.strcred.InvalidAuthArgumentString
  twisted.cred.strcred.InvalidAuthArgumentString.html
  Class
  Exception
  PUBLIC
  Raised by an authentication plugin when the argument string provided is formatted incorrectly.
- twisted.cred.strcred.UnsupportedInterfaces
  twisted.cred.strcred.UnsupportedInterfaces.html
  Class
  Exception
  PUBLIC
  Raised when an application is given a checker to use that does not provide any of the application's supported credentials interfaces.
- twisted.cred.strcred.notSupportedWarning
  twisted.cred.strcred.html#notSupportedWarning
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.cred.strcred.findCheckerFactories
  twisted.cred.strcred.html#findCheckerFactories
  Function
  Function
  PUBLIC
  Find all objects that implement `ICheckerFactory`.
- twisted.cred.strcred.findCheckerFactory
  twisted.cred.strcred.html#findCheckerFactory
  Function
  Function
  PUBLIC
  Find the first checker factory that supports the given authType.
- twisted.cred.strcred.makeChecker
  twisted.cred.strcred.html#makeChecker
  Function
  Function
  PUBLIC
  Returns an `twisted.cred.checkers.ICredentialsChecker` based on the contents of a descriptive string. Similar to `twisted.application.strports`.
- twisted.cred.strcred.AuthOptionMixin
  twisted.cred.strcred.AuthOptionMixin.html
  Class
  Class
  PUBLIC
  Defines helper methods that can be added on to any `usage.Options` subclass that needs authentication.
- twisted.cred.strcred.AuthOptionMixin.supportedInterfaces
  twisted.cred.strcred.AuthOptionMixin.html#supportedInterfaces
  Attribute
  Class Variable
  PUBLIC
  An iterable object that returns credential interfaces which this application is able to support.
- twisted.cred.strcred.AuthOptionMixin.authOutput
  twisted.cred.strcred.AuthOptionMixin.html#authOutput
  Attribute
  Class Variable
  PUBLIC
  A writeable object to which this options class will send all help-related output. Default: `sys.stdout`
- twisted.cred.strcred.AuthOptionMixin.supportsInterface
  twisted.cred.strcred.AuthOptionMixin.html#supportsInterface
  Function
  Method
  PUBLIC
  Returns whether a particular credentials interface is supported.
- twisted.cred.strcred.AuthOptionMixin.supportsCheckerFactory
  twisted.cred.strcred.AuthOptionMixin.html#supportsCheckerFactory
  Function
  Method
  PUBLIC
  Returns whether a checker factory will provide at least one of the credentials interfaces that we care about.
- twisted.cred.strcred.AuthOptionMixin.addChecker
  twisted.cred.strcred.AuthOptionMixin.html#addChecker
  Function
  Method
  PUBLIC
  Supply a supplied credentials checker to the Options class.
- twisted.cred.strcred.AuthOptionMixin.opt_auth
  twisted.cred.strcred.AuthOptionMixin.html#opt_auth
  Function
  Method
  PUBLIC
  Specify an authentication method for the server.
- twisted.cred.strcred.AuthOptionMixin._checkerFactoriesForOptHelpAuth
  twisted.cred.strcred.AuthOptionMixin.html#_checkerFactoriesForOptHelpAuth
  Function
  Method
  PRIVATE
  Return a list of which authTypes will be displayed by --help-auth. This makes it a lot easier to test this module.
- twisted.cred.strcred.AuthOptionMixin.opt_help_auth
  twisted.cred.strcred.AuthOptionMixin.html#opt_help_auth
  Function
  Method
  PUBLIC
  Show all authentication methods available.
- twisted.cred.strcred.AuthOptionMixin.opt_help_auth_type
  twisted.cred.strcred.AuthOptionMixin.html#opt_help_auth_type
  Function
  Method
  PUBLIC
  Show help for a particular authentication type.
- twisted.plugins.cred_unix.verifyCryptedPassword
  twisted.plugins.cred_unix.html#verifyCryptedPassword
  Function
  Function
  PUBLIC
  Use `crypt.crypt` to Verify that an unencrypted password matches the encrypted password.
- twisted.plugins.cred_unix.UNIXChecker
  twisted.plugins.cred_unix.UNIXChecker.html
  Class
  Class
  PUBLIC
  A credentials checker for a UNIX server. This will check that an authenticating username/password is a valid user on the system.
- twisted.plugins.cred_unix.UNIXChecker.credentialInterfaces
  twisted.plugins.cred_unix.UNIXChecker.html#credentialInterfaces
  Attribute
  Class Variable
  PUBLIC
  A list of sub-interfaces of `ICredentials` which specifies which I may check.
- twisted.plugins.cred_unix.UNIXChecker.checkPwd
  twisted.plugins.cred_unix.UNIXChecker.html#checkPwd
  Function
  Method
  PUBLIC
  Obtain the encrypted password for `username` from the Unix password database using `pwd.getpwnam`, and see if it it matches it matches `password`.
- twisted.plugins.cred_unix.UNIXChecker.checkSpwd
  twisted.plugins.cred_unix.UNIXChecker.html#checkSpwd
  Function
  Method
  PUBLIC
  Obtain the encrypted password for `username` from the Unix shadow password database using `spwd.getspnam`, and see if it it matches it matches `password`.
- twisted.plugins.cred_unix.UNIXChecker.requestAvatarId
  twisted.plugins.cred_unix.UNIXChecker.html#requestAvatarId
  Function
  Method
  PUBLIC
  Validate credentials and produce an avatar ID.
- twisted.plugins.cred_unix.unixCheckerFactoryHelp
  twisted.plugins.cred_unix.html#unixCheckerFactoryHelp
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.plugins.cred_unix.UNIXCheckerFactory
  twisted.plugins.cred_unix.UNIXCheckerFactory.html
  Class
  Class
  PUBLIC
  A factory for `UNIXChecker`.
- twisted.plugins.cred_unix.UNIXCheckerFactory.authType
  twisted.plugins.cred_unix.UNIXCheckerFactory.html#authType
  Attribute
  Class Variable
  PUBLIC
  A tag that identifies the authentication method.
- twisted.plugins.cred_unix.UNIXCheckerFactory.argStringFormat
  twisted.plugins.cred_unix.UNIXCheckerFactory.html#argStringFormat
  Attribute
  Class Variable
  PUBLIC
  A short (one-line) description of the argument string format.
- twisted.plugins.cred_unix.UNIXCheckerFactory.generateChecker
  twisted.plugins.cred_unix.UNIXCheckerFactory.html#generateChecker
  Function
  Method
  PUBLIC
  This checker factory ignores the argument string. Everything needed to generate a user database is pulled out of the local UNIX environment.
- twisted.plugins.cred_unix.theUnixCheckerFactory
  twisted.plugins.cred_unix.html#theUnixCheckerFactory
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.conch.checkers._log
  twisted.conch.checkers.html#_log
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.conch.checkers._pwdGetByName
  twisted.conch.checkers.html#_pwdGetByName
  Function
  Function
  PRIVATE
  Look up a user in the /etc/passwd database using the pwd module. If the pwd module is not available, return None.
- twisted.conch.checkers._shadowGetByName
  twisted.conch.checkers.html#_shadowGetByName
  Function
  Function
  PRIVATE
  Look up a user in the /etc/shadow database using the spwd module. If it is not available, return `None`.
- twisted.conch.checkers.UNIXPasswordDatabase
  twisted.conch.checkers.UNIXPasswordDatabase.html
  Class
  Class
  PUBLIC
  A checker which validates users out of the UNIX password databases, or databases of a compatible format.
- twisted.conch.checkers.UNIXPasswordDatabase._getByNameFunctions
  twisted.conch.checkers.UNIXPasswordDatabase.html#_getByNameFunctions
  Attribute
  Instance Variable
  PRIVATE
  a `list` of functions which are called in order to valid a user. The default value is such that the `/etc/passwd` database will be tried first, followed by the `/etc/shadow` database.
- twisted.conch.checkers.UNIXPasswordDatabase.credentialInterfaces
  twisted.conch.checkers.UNIXPasswordDatabase.html#credentialInterfaces
  Attribute
  Class Variable
  PUBLIC
  A list of sub-interfaces of `ICredentials` which specifies which I may check.
- twisted.conch.checkers.UNIXPasswordDatabase.__init__
  twisted.conch.checkers.UNIXPasswordDatabase.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.checkers.UNIXPasswordDatabase.requestAvatarId
  twisted.conch.checkers.UNIXPasswordDatabase.html#requestAvatarId
  Function
  Method
  PUBLIC
  Validate credentials and produce an avatar ID.
- twisted.conch.checkers.SSHPublicKeyDatabase
  twisted.conch.checkers.SSHPublicKeyDatabase.html
  Class
  Class
  PUBLIC
  Checker that authenticates SSH public keys, based on public keys listed in authorized_keys and authorized_keys2 files in user .ssh/ directories.
- twisted.conch.checkers.SSHPublicKeyDatabase.credentialInterfaces
  twisted.conch.checkers.SSHPublicKeyDatabase.html#credentialInterfaces
  Attribute
  Class Variable
  PUBLIC
  A list of sub-interfaces of `ICredentials` which specifies which I may check.
- twisted.conch.checkers.SSHPublicKeyDatabase.requestAvatarId
  twisted.conch.checkers.SSHPublicKeyDatabase.html#requestAvatarId
  Function
  Method
  PUBLIC
  Validate credentials and produce an avatar ID.
- twisted.conch.checkers.SSHPublicKeyDatabase._cbRequestAvatarId
  twisted.conch.checkers.SSHPublicKeyDatabase.html#_cbRequestAvatarId
  Function
  Method
  PRIVATE
  Check whether the credentials themselves are valid, now that we know if the key matches the user.
- twisted.conch.checkers.SSHPublicKeyDatabase.getAuthorizedKeysFiles
  twisted.conch.checkers.SSHPublicKeyDatabase.html#getAuthorizedKeysFiles
  Function
  Method
  PUBLIC
  Return a list of `FilePath` instances for authorized_keys files which might contain information about authorized keys for the given credentials.
- twisted.conch.checkers.SSHPublicKeyDatabase.checkKey
  twisted.conch.checkers.SSHPublicKeyDatabase.html#checkKey
  Function
  Method
  PUBLIC
  Retrieve files containing authorized keys and check against user credentials.
- twisted.conch.checkers.SSHPublicKeyDatabase._ebRequestAvatarId
  twisted.conch.checkers.SSHPublicKeyDatabase.html#_ebRequestAvatarId
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.checkers.SSHProtocolChecker
  twisted.conch.checkers.SSHProtocolChecker.html
  Class
  Class
  PUBLIC
  SSHProtocolChecker is a checker that requires multiple authentications to succeed. To add a checker, call my registerChecker method with the checker and the interface.
- twisted.conch.checkers.SSHProtocolChecker.__init__
  twisted.conch.checkers.SSHProtocolChecker.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.checkers.SSHProtocolChecker.checkers
  twisted.conch.checkers.SSHProtocolChecker.html#checkers
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.checkers.SSHProtocolChecker.successfulCredentials
  twisted.conch.checkers.SSHProtocolChecker.html#successfulCredentials
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.checkers.SSHProtocolChecker.credentialInterfaces
  twisted.conch.checkers.SSHProtocolChecker.html#credentialInterfaces
  Attribute
  Property
  PUBLIC
  A list of sub-interfaces of `ICredentials` which specifies which I may check.
- twisted.conch.checkers.SSHProtocolChecker.registerChecker
  twisted.conch.checkers.SSHProtocolChecker.html#registerChecker
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.checkers.SSHProtocolChecker.requestAvatarId
  twisted.conch.checkers.SSHProtocolChecker.html#requestAvatarId
  Function
  Method
  PUBLIC
  Part of the `ICredentialsChecker` interface. Called by a portal with some credentials to check if they'll authenticate a user. We check the interfaces that the credentials provide against our list of acceptable checkers...
- twisted.conch.checkers.SSHProtocolChecker._cbGoodAuthentication
  twisted.conch.checkers.SSHProtocolChecker.html#_cbGoodAuthentication
  Function
  Method
  PRIVATE
  Called if a checker has verified the credentials. We call our `areDone` method to see if the whole of the successful authentications are enough. If they are, we return the avatar ID returned by the first checker.
- twisted.conch.checkers.SSHProtocolChecker.areDone
  twisted.conch.checkers.SSHProtocolChecker.html#areDone
  Function
  Method
  PUBLIC
  Override to determine if the authentication is finished for a given avatarId.
- twisted.conch.checkers.IAuthorizedKeysDB
  twisted.conch.checkers.IAuthorizedKeysDB.html
  Class
  Interface
  PUBLIC
  An object that provides valid authorized ssh keys mapped to usernames.
- twisted.conch.checkers.IAuthorizedKeysDB.getAuthorizedKeys
  twisted.conch.checkers.IAuthorizedKeysDB.html#getAuthorizedKeys
  Function
  Method
  PUBLIC
  Gets an iterable of authorized keys that are valid for the given `avatarId`.
- twisted.conch.checkers.readAuthorizedKeyFile
  twisted.conch.checkers.html#readAuthorizedKeyFile
  Function
  Function
  PUBLIC
  Reads keys from an authorized keys file. Any non-comment line that cannot be parsed as a key will be ignored, although that particular line will be logged.
- twisted.conch.checkers._keysFromFilepaths
  twisted.conch.checkers.html#_keysFromFilepaths
  Function
  Function
  PRIVATE
  Helper function that turns an iterable of filepaths into a generator of keys. If any file cannot be read, a message is logged but it is otherwise ignored.
- twisted.conch.checkers.InMemorySSHKeyDB
  twisted.conch.checkers.InMemorySSHKeyDB.html
  Class
  Class
  PUBLIC
  Object that provides SSH public keys based on a dictionary of usernames mapped to `twisted.conch.ssh.keys.Key`s.
- twisted.conch.checkers.InMemorySSHKeyDB.__init__
  twisted.conch.checkers.InMemorySSHKeyDB.html#__init__
  Function
  Method
  PUBLIC
  Initializes a new `InMemorySSHKeyDB`.
- twisted.conch.checkers.InMemorySSHKeyDB._mapping
  twisted.conch.checkers.InMemorySSHKeyDB.html#_mapping
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.conch.checkers.InMemorySSHKeyDB.getAuthorizedKeys
  twisted.conch.checkers.InMemorySSHKeyDB.html#getAuthorizedKeys
  Function
  Method
  PUBLIC
  Gets an iterable of authorized keys that are valid for the given `avatarId`.
- twisted.conch.checkers.UNIXAuthorizedKeysFiles
  twisted.conch.checkers.UNIXAuthorizedKeysFiles.html
  Class
  Class
  PUBLIC
  Object that provides SSH public keys based on public keys listed in authorized_keys and authorized_keys2 files in UNIX user .ssh/ directories. If any of the files cannot be read, a message is logged but that file is otherwise ignored.
- twisted.conch.checkers.UNIXAuthorizedKeysFiles.__init__
  twisted.conch.checkers.UNIXAuthorizedKeysFiles.html#__init__
  Function
  Method
  PUBLIC
  Initializes a new `UNIXAuthorizedKeysFiles`.
- twisted.conch.checkers.UNIXAuthorizedKeysFiles._userdb
  twisted.conch.checkers.UNIXAuthorizedKeysFiles.html#_userdb
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.conch.checkers.UNIXAuthorizedKeysFiles._parseKey
  twisted.conch.checkers.UNIXAuthorizedKeysFiles.html#_parseKey
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.conch.checkers.UNIXAuthorizedKeysFiles.getAuthorizedKeys
  twisted.conch.checkers.UNIXAuthorizedKeysFiles.html#getAuthorizedKeys
  Function
  Method
  PUBLIC
  Gets an iterable of authorized keys that are valid for the given `avatarId`.
- twisted.conch.checkers.SSHPublicKeyChecker
  twisted.conch.checkers.SSHPublicKeyChecker.html
  Class
  Class
  PUBLIC
  Checker that authenticates SSH public keys, based on public keys listed in authorized_keys and authorized_keys2 files in user .ssh/ directories.
- twisted.conch.checkers.SSHPublicKeyChecker.credentialInterfaces
  twisted.conch.checkers.SSHPublicKeyChecker.html#credentialInterfaces
  Attribute
  Class Variable
  PUBLIC
  A list of sub-interfaces of `ICredentials` which specifies which I may check.
- twisted.conch.checkers.SSHPublicKeyChecker.__init__
  twisted.conch.checkers.SSHPublicKeyChecker.html#__init__
  Function
  Method
  PUBLIC
  Initializes a `SSHPublicKeyChecker`.
- twisted.conch.checkers.SSHPublicKeyChecker._keydb
  twisted.conch.checkers.SSHPublicKeyChecker.html#_keydb
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.conch.checkers.SSHPublicKeyChecker.requestAvatarId
  twisted.conch.checkers.SSHPublicKeyChecker.html#requestAvatarId
  Function
  Method
  PUBLIC
  Validate credentials and produce an avatar ID.
- twisted.conch.checkers.SSHPublicKeyChecker._sanityCheckKey
  twisted.conch.checkers.SSHPublicKeyChecker.html#_sanityCheckKey
  Function
  Method
  PRIVATE
  Checks whether the provided credentials are a valid SSH key with a signature (does not actually verify the signature).
- twisted.conch.checkers.SSHPublicKeyChecker._checkKey
  twisted.conch.checkers.SSHPublicKeyChecker.html#_checkKey
  Function
  Method
  PRIVATE
  Checks the public key against all authorized keys (if any) for the user.
- twisted.conch.checkers.SSHPublicKeyChecker._verifyKey
  twisted.conch.checkers.SSHPublicKeyChecker.html#_verifyKey
  Function
  Method
  PRIVATE
  Checks whether the credentials themselves are valid, now that we know if the key matches the user.
- twisted.conch.ssh.agent.SSHAgentClient
  twisted.conch.ssh.agent.SSHAgentClient.html
  Class
  Class
  PUBLIC
  The client side of the SSH agent protocol. This is equivalent to ssh-add(1) and can be used with either ssh-agent(1) or the SSHAgentServer protocol, also in this package.
- twisted.conch.ssh.agent.SSHAgentClient.__init__
  twisted.conch.ssh.agent.SSHAgentClient.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh.agent.SSHAgentClient.buf
  twisted.conch.ssh.agent.SSHAgentClient.html#buf
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ssh.agent.SSHAgentClient.deferreds
  twisted.conch.ssh.agent.SSHAgentClient.html#deferreds
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ssh.agent.SSHAgentClient.dataReceived
  twisted.conch.ssh.agent.SSHAgentClient.html#dataReceived
  Function
  Method
  PUBLIC
  Called whenever data is received.
- twisted.conch.ssh.agent.SSHAgentClient.sendRequest
  twisted.conch.ssh.agent.SSHAgentClient.html#sendRequest
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh.agent.SSHAgentClient.requestIdentities
  twisted.conch.ssh.agent.SSHAgentClient.html#requestIdentities
  Function
  Method
  PUBLIC
  No summary
- twisted.conch.ssh.agent.SSHAgentClient._cbRequestIdentities
  twisted.conch.ssh.agent.SSHAgentClient.html#_cbRequestIdentities
  Function
  Method
  PRIVATE
  Unpack a collection of identities into a list of tuples comprised of public key blobs and comments.
- twisted.conch.ssh.agent.SSHAgentClient.addIdentity
  twisted.conch.ssh.agent.SSHAgentClient.html#addIdentity
  Function
  Method
  PUBLIC
  Add a private key blob to the agent's collection of keys.
- twisted.conch.ssh.agent.SSHAgentClient.signData
  twisted.conch.ssh.agent.SSHAgentClient.html#signData
  Function
  Method
  PUBLIC
  Request that the agent sign the given `data` with the private key which corresponds to the public key given by `blob`. The private key should have been added to the agent already.
- twisted.conch.ssh.agent.SSHAgentClient._cbSignData
  twisted.conch.ssh.agent.SSHAgentClient.html#_cbSignData
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.ssh.agent.SSHAgentClient.removeIdentity
  twisted.conch.ssh.agent.SSHAgentClient.html#removeIdentity
  Function
  Method
  PUBLIC
  Remove the private key corresponding to the public key in blob from the running agent.
- twisted.conch.ssh.agent.SSHAgentClient.removeAllIdentities
  twisted.conch.ssh.agent.SSHAgentClient.html#removeAllIdentities
  Function
  Method
  PUBLIC
  Remove all keys from the running agent.
- twisted.conch.ssh.agent.SSHAgentServer
  twisted.conch.ssh.agent.SSHAgentServer.html
  Class
  Class
  PUBLIC
  The server side of the SSH agent protocol. This is equivalent to ssh-agent(1) and can be used with either ssh-add(1) or the SSHAgentClient protocol, also in this package.
- twisted.conch.ssh.agent.SSHAgentServer.__init__
  twisted.conch.ssh.agent.SSHAgentServer.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh.agent.SSHAgentServer.buf
  twisted.conch.ssh.agent.SSHAgentServer.html#buf
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ssh.agent.SSHAgentServer.dataReceived
  twisted.conch.ssh.agent.SSHAgentServer.html#dataReceived
  Function
  Method
  PUBLIC
  Called whenever data is received.
- twisted.conch.ssh.agent.SSHAgentServer.sendResponse
  twisted.conch.ssh.agent.SSHAgentServer.html#sendResponse
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh.agent.SSHAgentServer.agentc_REQUEST_IDENTITIES
  twisted.conch.ssh.agent.SSHAgentServer.html#agentc_REQUEST_IDENTITIES
  Function
  Method
  PUBLIC
  Return all of the identities that have been added to the server
- twisted.conch.ssh.agent.SSHAgentServer.agentc_SIGN_REQUEST
  twisted.conch.ssh.agent.SSHAgentServer.html#agentc_SIGN_REQUEST
  Function
  Method
  PUBLIC
  Data is a structure with a reference to an already added key object and some data that the clients wants signed with that key. If the key object wasn't loaded, return AGENT_FAILURE, else return the signature.
- twisted.conch.ssh.agent.SSHAgentServer.agentc_ADD_IDENTITY
  twisted.conch.ssh.agent.SSHAgentServer.html#agentc_ADD_IDENTITY
  Function
  Method
  PUBLIC
  Adds a private key to the agent's collection of identities. On subsequent interactions, the private key can be accessed using only the corresponding public key.
- twisted.conch.ssh.agent.SSHAgentServer.agentc_REMOVE_IDENTITY
  twisted.conch.ssh.agent.SSHAgentServer.html#agentc_REMOVE_IDENTITY
  Function
  Method
  PUBLIC
  Remove a specific key from the agent's collection of identities.
- twisted.conch.ssh.agent.SSHAgentServer.agentc_REMOVE_ALL_IDENTITIES
  twisted.conch.ssh.agent.SSHAgentServer.html#agentc_REMOVE_ALL_IDENTITIES
  Function
  Method
  PUBLIC
  Remove all keys from the agent's collection of identities.
- twisted.conch.ssh.agent.SSHAgentServer.agentc_REQUEST_RSA_IDENTITIES
  twisted.conch.ssh.agent.SSHAgentServer.html#agentc_REQUEST_RSA_IDENTITIES
  Function
  Method
  PUBLIC
  v1 message for listing RSA1 keys; superseded by agentc_REQUEST_IDENTITIES, which handles different key types.
- twisted.conch.ssh.agent.SSHAgentServer.agentc_REMOVE_RSA_IDENTITY
  twisted.conch.ssh.agent.SSHAgentServer.html#agentc_REMOVE_RSA_IDENTITY
  Function
  Method
  PUBLIC
  v1 message for removing RSA1 keys; superseded by agentc_REMOVE_IDENTITY, which handles different key types.
- twisted.conch.ssh.agent.SSHAgentServer.agentc_REMOVE_ALL_RSA_IDENTITIES
  twisted.conch.ssh.agent.SSHAgentServer.html#agentc_REMOVE_ALL_RSA_IDENTITIES
  Function
  Method
  PUBLIC
  v1 message for removing all RSA1 keys; superseded by agentc_REMOVE_ALL_IDENTITIES, which handles different key types.
- twisted.conch.ssh.agent.AGENTC_REQUEST_RSA_IDENTITIES
  twisted.conch.ssh.agent.html#AGENTC_REQUEST_RSA_IDENTITIES
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.agent.AGENT_RSA_IDENTITIES_ANSWER
  twisted.conch.ssh.agent.html#AGENT_RSA_IDENTITIES_ANSWER
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.agent.AGENT_FAILURE
  twisted.conch.ssh.agent.html#AGENT_FAILURE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.agent.AGENT_SUCCESS
  twisted.conch.ssh.agent.html#AGENT_SUCCESS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.agent.AGENTC_REMOVE_RSA_IDENTITY
  twisted.conch.ssh.agent.html#AGENTC_REMOVE_RSA_IDENTITY
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.agent.AGENTC_REMOVE_ALL_RSA_IDENTITIES
  twisted.conch.ssh.agent.html#AGENTC_REMOVE_ALL_RSA_IDENTITIES
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.agent.AGENTC_REQUEST_IDENTITIES
  twisted.conch.ssh.agent.html#AGENTC_REQUEST_IDENTITIES
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.agent.AGENT_IDENTITIES_ANSWER
  twisted.conch.ssh.agent.html#AGENT_IDENTITIES_ANSWER
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.agent.AGENTC_SIGN_REQUEST
  twisted.conch.ssh.agent.html#AGENTC_SIGN_REQUEST
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.agent.AGENT_SIGN_RESPONSE
  twisted.conch.ssh.agent.html#AGENT_SIGN_RESPONSE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.agent.AGENTC_ADD_IDENTITY
  twisted.conch.ssh.agent.html#AGENTC_ADD_IDENTITY
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.agent.AGENTC_REMOVE_IDENTITY
  twisted.conch.ssh.agent.html#AGENTC_REMOVE_IDENTITY
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.agent.AGENTC_REMOVE_ALL_IDENTITIES
  twisted.conch.ssh.agent.html#AGENTC_REMOVE_ALL_IDENTITIES
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.agent.messages
  twisted.conch.ssh.agent.html#messages
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.conch.ssh.channel.SSHChannel
  twisted.conch.ssh.channel.SSHChannel.html
  Class
  Class
  PUBLIC
  A class that represents a multiplexed channel over an SSH connection. The channel has a local window which is the maximum amount of data it will receive, and a remote which is the maximum amount of data the remote side will accept...
- twisted.conch.ssh.channel.SSHChannel.name
  twisted.conch.ssh.channel.SSHChannel.html#name
  Attribute
  Instance Variable
  PUBLIC
  the name of the channel.
- twisted.conch.ssh.channel.SSHChannel.localWindowSize
  twisted.conch.ssh.channel.SSHChannel.html#localWindowSize
  Attribute
  Instance Variable
  PUBLIC
  the maximum size of the local window in bytes.
- twisted.conch.ssh.channel.SSHChannel.localWindowLeft
  twisted.conch.ssh.channel.SSHChannel.html#localWindowLeft
  Attribute
  Instance Variable
  PUBLIC
  how many bytes are left in the local window.
- twisted.conch.ssh.channel.SSHChannel.localMaxPacket
  twisted.conch.ssh.channel.SSHChannel.html#localMaxPacket
  Attribute
  Instance Variable
  PUBLIC
  the maximum size of packet we will accept in bytes.
- twisted.conch.ssh.channel.SSHChannel.remoteWindowLeft
  twisted.conch.ssh.channel.SSHChannel.html#remoteWindowLeft
  Attribute
  Instance Variable
  PUBLIC
  how many bytes are left in the remote window.
- twisted.conch.ssh.channel.SSHChannel.remoteMaxPacket
  twisted.conch.ssh.channel.SSHChannel.html#remoteMaxPacket
  Attribute
  Instance Variable
  PUBLIC
  the maximum size of a packet the remote side will accept in bytes.
- twisted.conch.ssh.channel.SSHChannel.conn
  twisted.conch.ssh.channel.SSHChannel.html#conn
  Attribute
  Instance Variable
  PUBLIC
  the connection this channel is multiplexed through.
- twisted.conch.ssh.channel.SSHChannel.data
  twisted.conch.ssh.channel.SSHChannel.html#data
  Attribute
  Instance Variable
  PUBLIC
  any data to send to the other side when the channel is requested.
- twisted.conch.ssh.channel.SSHChannel.avatar
  twisted.conch.ssh.channel.SSHChannel.html#avatar
  Attribute
  Instance Variable
  PUBLIC
  an avatar for the logged-in user (if a server channel)
- twisted.conch.ssh.channel.SSHChannel.localClosed
  twisted.conch.ssh.channel.SSHChannel.html#localClosed
  Attribute
  Instance Variable
  PUBLIC
  True if we aren't accepting more data.
- twisted.conch.ssh.channel.SSHChannel.remoteClosed
  twisted.conch.ssh.channel.SSHChannel.html#remoteClosed
  Attribute
  Instance Variable
  PUBLIC
  True if the other side isn't accepting more data.
- twisted.conch.ssh.channel.SSHChannel._log
  twisted.conch.ssh.channel.SSHChannel.html#_log
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.conch.ssh.channel.SSHChannel.__init__
  twisted.conch.ssh.channel.SSHChannel.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh.channel.SSHChannel.areWriting
  twisted.conch.ssh.channel.SSHChannel.html#areWriting
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ssh.channel.SSHChannel.specificData
  twisted.conch.ssh.channel.SSHChannel.html#specificData
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ssh.channel.SSHChannel.buf
  twisted.conch.ssh.channel.SSHChannel.html#buf
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ssh.channel.SSHChannel.extBuf
  twisted.conch.ssh.channel.SSHChannel.html#extBuf
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ssh.channel.SSHChannel.closing
  twisted.conch.ssh.channel.SSHChannel.html#closing
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ssh.channel.SSHChannel.id
  twisted.conch.ssh.channel.SSHChannel.html#id
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ssh.channel.SSHChannel.__str__
  twisted.conch.ssh.channel.SSHChannel.html#__str__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh.channel.SSHChannel.__bytes__
  twisted.conch.ssh.channel.SSHChannel.html#__bytes__
  Function
  Method
  PUBLIC
  Return a byte string representation of the channel
- twisted.conch.ssh.channel.SSHChannel.logPrefix
  twisted.conch.ssh.channel.SSHChannel.html#logPrefix
  Function
  Method
  PUBLIC
  Override this method to insert custom logging behavior. Its return value will be inserted in front of every line. It may be called more times than the number of output lines.
- twisted.conch.ssh.channel.SSHChannel.channelOpen
  twisted.conch.ssh.channel.SSHChannel.html#channelOpen
  Function
  Method
  PUBLIC
  Called when the channel is opened. specificData is any data that the other side sent us when opening the channel.
- twisted.conch.ssh.channel.SSHChannel.openFailed
  twisted.conch.ssh.channel.SSHChannel.html#openFailed
  Function
  Method
  PUBLIC
  Called when the open failed for some reason. reason.desc is a string descrption, reason.code the SSH error code.
- twisted.conch.ssh.channel.SSHChannel.addWindowBytes
  twisted.conch.ssh.channel.SSHChannel.html#addWindowBytes
  Function
  Method
  PUBLIC
  Called when bytes are added to the remote window. By default it clears the data buffers.
- twisted.conch.ssh.channel.SSHChannel.requestReceived
  twisted.conch.ssh.channel.SSHChannel.html#requestReceived
  Function
  Method
  PUBLIC
  Called when a request is sent to this channel. By default it delegates to self.request_<requestType>. If this function returns true, the request succeeded, otherwise it failed.
- twisted.conch.ssh.channel.SSHChannel.dataReceived
  twisted.conch.ssh.channel.SSHChannel.html#dataReceived
  Function
  Method
  PUBLIC
  Called when we receive data.
- twisted.conch.ssh.channel.SSHChannel.extReceived
  twisted.conch.ssh.channel.SSHChannel.html#extReceived
  Function
  Method
  PUBLIC
  Called when we receive extended data (usually standard error).
- twisted.conch.ssh.channel.SSHChannel.eofReceived
  twisted.conch.ssh.channel.SSHChannel.html#eofReceived
  Function
  Method
  PUBLIC
  Called when the other side will send no more data.
- twisted.conch.ssh.channel.SSHChannel.closeReceived
  twisted.conch.ssh.channel.SSHChannel.html#closeReceived
  Function
  Method
  PUBLIC
  Called when the other side has closed the channel.
- twisted.conch.ssh.channel.SSHChannel.closed
  twisted.conch.ssh.channel.SSHChannel.html#closed
  Function
  Method
  PUBLIC
  Called when the channel is closed. This means that both our side and the remote side have closed the channel.
- twisted.conch.ssh.channel.SSHChannel.write
  twisted.conch.ssh.channel.SSHChannel.html#write
  Function
  Method
  PUBLIC
  Write some data to the channel. If there is not enough remote window available, buffer until it is. Otherwise, split the data into packets of length remoteMaxPacket and send them.
- twisted.conch.ssh.channel.SSHChannel.writeExtended
  twisted.conch.ssh.channel.SSHChannel.html#writeExtended
  Function
  Method
  PUBLIC
  Send extended data to this channel. If there is not enough remote window available, buffer until there is. Otherwise, split the data into packets of length remoteMaxPacket and send them.
- twisted.conch.ssh.channel.SSHChannel.writeSequence
  twisted.conch.ssh.channel.SSHChannel.html#writeSequence
  Function
  Method
  PUBLIC
  Part of the Transport interface. Write a list of strings to the channel.
- twisted.conch.ssh.channel.SSHChannel.loseConnection
  twisted.conch.ssh.channel.SSHChannel.html#loseConnection
  Function
  Method
  PUBLIC
  Close the channel if there is no buferred data. Otherwise, note the request and return.
- twisted.conch.ssh.channel.SSHChannel.getPeer
  twisted.conch.ssh.channel.SSHChannel.html#getPeer
  Function
  Method
  PUBLIC
  See: `ITransport.getPeer`
- twisted.conch.ssh.channel.SSHChannel.getHost
  twisted.conch.ssh.channel.SSHChannel.html#getHost
  Function
  Method
  PUBLIC
  See: `ITransport.getHost`
- twisted.conch.ssh.channel.SSHChannel.stopWriting
  twisted.conch.ssh.channel.SSHChannel.html#stopWriting
  Function
  Method
  PUBLIC
  Called when the remote buffer is full, as a hint to stop writing. This can be ignored, but it can be helpful.
- twisted.conch.ssh.channel.SSHChannel.startWriting
  twisted.conch.ssh.channel.SSHChannel.html#startWriting
  Function
  Method
  PUBLIC
  Called when the remote buffer has more room, as a hint to continue writing.
- twisted.conch.client.agent.SSHAgentClient
  twisted.conch.client.agent.SSHAgentClient.html
  Class
  Class
  PUBLIC
  No class docstring; 0/1 instance variable, 0/1 class variable, 1/4 method documented
- twisted.conch.client.agent.SSHAgentClient._log
  twisted.conch.client.agent.SSHAgentClient.html#_log
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.conch.client.agent.SSHAgentClient.__init__
  twisted.conch.client.agent.SSHAgentClient.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.client.agent.SSHAgentClient.blobs
  twisted.conch.client.agent.SSHAgentClient.html#blobs
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.client.agent.SSHAgentClient.getPublicKeys
  twisted.conch.client.agent.SSHAgentClient.html#getPublicKeys
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.client.agent.SSHAgentClient._cbPublicKeys
  twisted.conch.client.agent.SSHAgentClient.html#_cbPublicKeys
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.client.agent.SSHAgentClient.getPublicKey
  twisted.conch.client.agent.SSHAgentClient.html#getPublicKey
  Function
  Method
  PUBLIC
  Return a `Key` from the first blob in `self.blobs`, if any, or return `None`.
- twisted.conch.client.agent.SSHAgentForwardingChannel
  twisted.conch.client.agent.SSHAgentForwardingChannel.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.conch.client.agent.SSHAgentForwardingChannel.channelOpen
  twisted.conch.client.agent.SSHAgentForwardingChannel.html#channelOpen
  Function
  Method
  PUBLIC
  Called when the channel is opened. specificData is any data that the other side sent us when opening the channel.
- twisted.conch.client.agent.SSHAgentForwardingChannel.buf
  twisted.conch.client.agent.SSHAgentForwardingChannel.html#buf
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.client.agent.SSHAgentForwardingChannel._cbGotLocal
  twisted.conch.client.agent.SSHAgentForwardingChannel.html#_cbGotLocal
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.client.agent.SSHAgentForwardingChannel.local
  twisted.conch.client.agent.SSHAgentForwardingChannel.html#local
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.client.agent.SSHAgentForwardingChannel.dataReceived
  twisted.conch.client.agent.SSHAgentForwardingChannel.html#dataReceived
  Function
  Method
  PUBLIC
  Called when we receive data.
- twisted.conch.client.agent.SSHAgentForwardingChannel.closed
  twisted.conch.client.agent.SSHAgentForwardingChannel.html#closed
  Function
  Method
  PUBLIC
  Called when the channel is closed. This means that both our side and the remote side have closed the channel.
- twisted.conch.client.agent.SSHAgentForwardingLocal
  twisted.conch.client.agent.SSHAgentForwardingLocal.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.conch.ssh._kex._IKexAlgorithm
  twisted.conch.ssh._kex._IKexAlgorithm.html
  Class
  Interface
  PRIVATE
  An `_IKexAlgorithm` describes a key exchange algorithm.
- twisted.conch.ssh._kex._IKexAlgorithm.preference
  twisted.conch.ssh._kex._IKexAlgorithm.html#preference
  Attribute
  Attribute
  PUBLIC
  An `int` giving the preference of the algorithm when negotiating key exchange. Algorithms with lower precedence values are more preferred.
- twisted.conch.ssh._kex._IKexAlgorithm.hashProcessor
  twisted.conch.ssh._kex._IKexAlgorithm.html#hashProcessor
  Attribute
  Attribute
  PUBLIC
  A callable hash algorithm constructor (e.g. `hashlib.sha256`) suitable for use with this key exchange algorithm.
- twisted.conch.ssh._kex._IFixedGroupKexAlgorithm
  twisted.conch.ssh._kex._IFixedGroupKexAlgorithm.html
  Class
  Interface
  PRIVATE
  An `_IFixedGroupKexAlgorithm` describes a key exchange algorithm with a fixed prime / generator group.
- twisted.conch.ssh._kex._IFixedGroupKexAlgorithm.prime
  twisted.conch.ssh._kex._IFixedGroupKexAlgorithm.html#prime
  Attribute
  Attribute
  PUBLIC
  An `int` giving the prime number used in Diffie-Hellman key exchange, or `None` if not applicable.
- twisted.conch.ssh._kex._IFixedGroupKexAlgorithm.generator
  twisted.conch.ssh._kex._IFixedGroupKexAlgorithm.html#generator
  Attribute
  Attribute
  PUBLIC
  An `int` giving the generator number used in Diffie-Hellman key exchange, or `None` if not applicable. (This is not related to Python generator functions.)
- twisted.conch.ssh._kex._IEllipticCurveExchangeKexAlgorithm
  twisted.conch.ssh._kex._IEllipticCurveExchangeKexAlgorithm.html
  Class
  Interface
  PRIVATE
  An `_IEllipticCurveExchangeKexAlgorithm` describes a key exchange algorithm that uses an elliptic curve exchange between the client and server.
- twisted.conch.ssh._kex._IGroupExchangeKexAlgorithm
  twisted.conch.ssh._kex._IGroupExchangeKexAlgorithm.html
  Class
  Interface
  PRIVATE
  An `_IGroupExchangeKexAlgorithm` describes a key exchange algorithm that uses group exchange between the client and server.
- twisted.conch.ssh._kex._Curve25519SHA256
  twisted.conch.ssh._kex._Curve25519SHA256.html
  Class
  Class
  PRIVATE
  Elliptic Curve Key Exchange using Curve25519 and SHA256. Defined in https://datatracker.ietf.org/doc/draft-ietf-curdle-ssh-curves/.
- twisted.conch.ssh._kex._Curve25519SHA256.preference
  twisted.conch.ssh._kex._Curve25519SHA256.html#preference
  Attribute
  Class Variable
  PUBLIC
  An `int` giving the preference of the algorithm when negotiating key exchange. Algorithms with lower precedence values are more preferred.
- twisted.conch.ssh._kex._Curve25519SHA256LibSSH
  twisted.conch.ssh._kex._Curve25519SHA256LibSSH.html
  Class
  Class
  PRIVATE
  As `_Curve25519SHA256`, but with a pre-standardized algorithm name.
- twisted.conch.ssh._kex._Curve25519SHA256LibSSH.preference
  twisted.conch.ssh._kex._Curve25519SHA256LibSSH.html#preference
  Attribute
  Class Variable
  PUBLIC
  An `int` giving the preference of the algorithm when negotiating key exchange. Algorithms with lower precedence values are more preferred.
- twisted.conch.ssh._kex._ECDH256
  twisted.conch.ssh._kex._ECDH256.html
  Class
  Class
  PRIVATE
  Elliptic Curve Key Exchange with SHA-256 as HASH. Defined in RFC 5656.
- twisted.conch.ssh._kex._ECDH256.preference
  twisted.conch.ssh._kex._ECDH256.html#preference
  Attribute
  Class Variable
  PUBLIC
  An `int` giving the preference of the algorithm when negotiating key exchange. Algorithms with lower precedence values are more preferred.
- twisted.conch.ssh._kex._ECDH384
  twisted.conch.ssh._kex._ECDH384.html
  Class
  Class
  PRIVATE
  Elliptic Curve Key Exchange with SHA-384 as HASH. Defined in RFC 5656.
- twisted.conch.ssh._kex._ECDH384.preference
  twisted.conch.ssh._kex._ECDH384.html#preference
  Attribute
  Class Variable
  PUBLIC
  An `int` giving the preference of the algorithm when negotiating key exchange. Algorithms with lower precedence values are more preferred.
- twisted.conch.ssh._kex._ECDH512
  twisted.conch.ssh._kex._ECDH512.html
  Class
  Class
  PRIVATE
  Elliptic Curve Key Exchange with SHA-512 as HASH. Defined in RFC 5656.
- twisted.conch.ssh._kex._ECDH512.preference
  twisted.conch.ssh._kex._ECDH512.html#preference
  Attribute
  Class Variable
  PUBLIC
  An `int` giving the preference of the algorithm when negotiating key exchange. Algorithms with lower precedence values are more preferred.
- twisted.conch.ssh._kex._DHGroupExchangeSHA256
  twisted.conch.ssh._kex._DHGroupExchangeSHA256.html
  Class
  Class
  PRIVATE
  Diffie-Hellman Group and Key Exchange with SHA-256 as HASH. Defined in RFC 4419, 4.2.
- twisted.conch.ssh._kex._DHGroupExchangeSHA256.preference
  twisted.conch.ssh._kex._DHGroupExchangeSHA256.html#preference
  Attribute
  Class Variable
  PUBLIC
  An `int` giving the preference of the algorithm when negotiating key exchange. Algorithms with lower precedence values are more preferred.
- twisted.conch.ssh._kex._DHGroupExchangeSHA1
  twisted.conch.ssh._kex._DHGroupExchangeSHA1.html
  Class
  Class
  PRIVATE
  Diffie-Hellman Group and Key Exchange with SHA-1 as HASH. Defined in RFC 4419, 4.1.
- twisted.conch.ssh._kex._DHGroupExchangeSHA1.preference
  twisted.conch.ssh._kex._DHGroupExchangeSHA1.html#preference
  Attribute
  Class Variable
  PUBLIC
  An `int` giving the preference of the algorithm when negotiating key exchange. Algorithms with lower precedence values are more preferred.
- twisted.conch.ssh._kex._DHGroup14SHA1
  twisted.conch.ssh._kex._DHGroup14SHA1.html
  Class
  Class
  PRIVATE
  Diffie-Hellman key exchange with SHA-1 as HASH and Oakley Group 14 (2048-bit MODP Group). Defined in RFC 4253, 8.2.
- twisted.conch.ssh._kex._DHGroup14SHA1.preference
  twisted.conch.ssh._kex._DHGroup14SHA1.html#preference
  Attribute
  Class Variable
  PUBLIC
  An `int` giving the preference of the algorithm when negotiating key exchange. Algorithms with lower precedence values are more preferred.
- twisted.conch.ssh._kex._DHGroup14SHA1.prime
  twisted.conch.ssh._kex._DHGroup14SHA1.html#prime
  Attribute
  Class Variable
  PUBLIC
  An `int` giving the prime number used in Diffie-Hellman key exchange, or `None` if not applicable.
- twisted.conch.ssh._kex._DHGroup14SHA1.generator
  twisted.conch.ssh._kex._DHGroup14SHA1.html#generator
  Attribute
  Class Variable
  PUBLIC
  An `int` giving the generator number used in Diffie-Hellman key exchange, or `None` if not applicable. (This is not related to Python generator functions.)
- twisted.conch.ssh._kex._kexAlgorithms
  twisted.conch.ssh._kex.html#_kexAlgorithms
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.conch.ssh._kex.getKex
  twisted.conch.ssh._kex.html#getKex
  Function
  Function
  PUBLIC
  Get a description of a named key exchange algorithm.
- twisted.conch.ssh._kex.isEllipticCurve
  twisted.conch.ssh._kex.html#isEllipticCurve
  Function
  Function
  PUBLIC
  Returns `True` if `kexAlgorithm` is an elliptic curve.
- twisted.conch.ssh._kex.isFixedGroup
  twisted.conch.ssh._kex.html#isFixedGroup
  Function
  Function
  PUBLIC
  Returns `True` if `kexAlgorithm` has a fixed prime / generator group.
- twisted.conch.ssh._kex.getHashProcessor
  twisted.conch.ssh._kex.html#getHashProcessor
  Function
  Function
  PUBLIC
  Get the hash algorithm callable to use in key exchange.
- twisted.conch.ssh._kex.getDHGeneratorAndPrime
  twisted.conch.ssh._kex.html#getDHGeneratorAndPrime
  Function
  Function
  PUBLIC
  Get the generator and the prime to use in key exchange.
- twisted.conch.ssh._kex.getSupportedKeyExchanges
  twisted.conch.ssh._kex.html#getSupportedKeyExchanges
  Function
  Function
  PUBLIC
  Get a list of supported key exchange algorithm names in order of preference.
- twisted.conch.ssh.address.SSHTransportAddress
  twisted.conch.ssh.address.SSHTransportAddress.html
  Class
  Class
  PUBLIC
  Object representing an SSH Transport endpoint.
- twisted.conch.ssh.address.SSHTransportAddress.address
  twisted.conch.ssh.address.SSHTransportAddress.html#address
  Attribute
  Instance Variable
  PUBLIC
  An instance of an object which implements IAddress to which this transport address is connected.
- twisted.conch.ssh.address.SSHTransportAddress.compareAttributes
  twisted.conch.ssh.address.SSHTransportAddress.html#compareAttributes
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.ssh.address.SSHTransportAddress.__init__
  twisted.conch.ssh.address.SSHTransportAddress.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh.address.SSHTransportAddress.__repr__
  twisted.conch.ssh.address.SSHTransportAddress.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh.address.SSHTransportAddress.__hash__
  twisted.conch.ssh.address.SSHTransportAddress.html#__hash__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh.transport._mpFromBytes
  twisted.conch.ssh.transport.html#_mpFromBytes
  Function
  Function
  PRIVATE
  Make an SSH multiple-precision integer from big-endian `bytes`.
- twisted.conch.ssh.transport._MACParams
  twisted.conch.ssh.transport._MACParams.html
  Class
  Class
  PRIVATE
  `_MACParams` represents the parameters necessary to compute SSH MAC (Message Authenticate Codes).
- twisted.conch.ssh.transport._MACParams.key
  twisted.conch.ssh.transport._MACParams.html#key
  Attribute
  Instance Variable
  PUBLIC
  The HMAC key which will be used.
- twisted.conch.ssh.transport.SSHCiphers
  twisted.conch.ssh.transport.SSHCiphers.html
  Class
  Class
  PUBLIC
  SSHCiphers represents all the encryption operations that need to occur to encrypt and authenticate the SSH connection.
- twisted.conch.ssh.transport.SSHCiphers.cipherMap
  twisted.conch.ssh.transport.SSHCiphers.html#cipherMap
  Attribute
  Class Variable
  PUBLIC
  A dictionary mapping SSH encryption names to 3-tuples of (<cryptography.hazmat.primitives.interfaces.CipherAlgorithm>, <block size>, <cryptography.hazmat.primitives.interfaces.Mode>)
- twisted.conch.ssh.transport.SSHCiphers.macMap
  twisted.conch.ssh.transport.SSHCiphers.html#macMap
  Attribute
  Class Variable
  PUBLIC
  A dictionary mapping SSH MAC names to hash modules.
- twisted.conch.ssh.transport.SSHCiphers.outCipType
  twisted.conch.ssh.transport.SSHCiphers.html#outCipType
  Attribute
  Instance Variable
  PUBLIC
  the string type of the outgoing cipher.
- twisted.conch.ssh.transport.SSHCiphers.inCipType
  twisted.conch.ssh.transport.SSHCiphers.html#inCipType
  Attribute
  Instance Variable
  PUBLIC
  the string type of the incoming cipher.
- twisted.conch.ssh.transport.SSHCiphers.outMACType
  twisted.conch.ssh.transport.SSHCiphers.html#outMACType
  Attribute
  Instance Variable
  PUBLIC
  the string type of the incoming MAC.
- twisted.conch.ssh.transport.SSHCiphers.inMACType
  twisted.conch.ssh.transport.SSHCiphers.html#inMACType
  Attribute
  Instance Variable
  PUBLIC
  the string type of the incoming MAC.
- twisted.conch.ssh.transport.SSHCiphers.encBlockSize
  twisted.conch.ssh.transport.SSHCiphers.html#encBlockSize
  Attribute
  Instance Variable
  PUBLIC
  the block size of the outgoing cipher.
- twisted.conch.ssh.transport.SSHCiphers.decBlockSize
  twisted.conch.ssh.transport.SSHCiphers.html#decBlockSize
  Attribute
  Instance Variable
  PUBLIC
  the block size of the incoming cipher.
- twisted.conch.ssh.transport.SSHCiphers.verifyDigestSize
  twisted.conch.ssh.transport.SSHCiphers.html#verifyDigestSize
  Attribute
  Instance Variable
  PUBLIC
  the size of the incoming MAC.
- twisted.conch.ssh.transport.SSHCiphers.outMAC
  twisted.conch.ssh.transport.SSHCiphers.html#outMAC
  Attribute
  Instance Variable
  PUBLIC
  a tuple of (<hash module>, <inner key>, <outer key>, <digest size>) representing the outgoing MAC.
- twisted.conch.ssh.transport.SSHCiphers.inMAc
  twisted.conch.ssh.transport.SSHCiphers.html#inMAc
  Attribute
  Instance Variable
  PUBLIC
  see outMAC, but for the incoming MAC.
- twisted.conch.ssh.transport.SSHCiphers.__init__
  twisted.conch.ssh.transport.SSHCiphers.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh.transport.SSHCiphers.inMAC
  twisted.conch.ssh.transport.SSHCiphers.html#inMAC
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ssh.transport.SSHCiphers.setKeys
  twisted.conch.ssh.transport.SSHCiphers.html#setKeys
  Function
  Method
  PUBLIC
  Set up the ciphers and hashes using the given keys,
- twisted.conch.ssh.transport.SSHCiphers.encryptor
  twisted.conch.ssh.transport.SSHCiphers.html#encryptor
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ssh.transport.SSHCiphers.decryptor
  twisted.conch.ssh.transport.SSHCiphers.html#decryptor
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ssh.transport.SSHCiphers._getCipher
  twisted.conch.ssh.transport.SSHCiphers.html#_getCipher
  Function
  Method
  PRIVATE
  Creates an initialized cipher object.
- twisted.conch.ssh.transport.SSHCiphers._getMAC
  twisted.conch.ssh.transport.SSHCiphers.html#_getMAC
  Function
  Method
  PRIVATE
  Gets a 4-tuple representing the message authentication code. (<hash module>, <inner hash value>, <outer hash value>, <digest size>)
- twisted.conch.ssh.transport.SSHCiphers.encrypt
  twisted.conch.ssh.transport.SSHCiphers.html#encrypt
  Function
  Method
  PUBLIC
  Encrypt some data.
- twisted.conch.ssh.transport.SSHCiphers.decrypt
  twisted.conch.ssh.transport.SSHCiphers.html#decrypt
  Function
  Method
  PUBLIC
  Decrypt some data.
- twisted.conch.ssh.transport.SSHCiphers.makeMAC
  twisted.conch.ssh.transport.SSHCiphers.html#makeMAC
  Function
  Method
  PUBLIC
  Create a message authentication code (MAC) for the given packet using the outgoing MAC values.
- twisted.conch.ssh.transport.SSHCiphers.verify
  twisted.conch.ssh.transport.SSHCiphers.html#verify
  Function
  Method
  PUBLIC
  Verify an incoming MAC using the incoming MAC values.
- twisted.conch.ssh.transport._getSupportedCiphers
  twisted.conch.ssh.transport.html#_getSupportedCiphers
  Function
  Function
  PRIVATE
  Build a list of ciphers that are supported by the backend in use.
- twisted.conch.ssh.transport.SSHTransportBase
  twisted.conch.ssh.transport.SSHTransportBase.html
  Class
  Class
  PUBLIC
  Protocol supporting basic SSH functionality: sending/receiving packets and message dispatch. To connect to or run a server, you must use SSHClientTransport or SSHServerTransport.
- twisted.conch.ssh.transport.SSHTransportBase.protocolVersion
  twisted.conch.ssh.transport.SSHTransportBase.html#protocolVersion
  Attribute
  Instance Variable
  PUBLIC
  A string representing the version of the SSH protocol we support. Currently defaults to '2.0'.
- twisted.conch.ssh.transport.SSHTransportBase.version
  twisted.conch.ssh.transport.SSHTransportBase.html#version
  Attribute
  Instance Variable
  PUBLIC
  A string representing the version of the server or client. Currently defaults to 'Twisted'.
- twisted.conch.ssh.transport.SSHTransportBase.comment
  twisted.conch.ssh.transport.SSHTransportBase.html#comment
  Attribute
  Instance Variable
  PUBLIC
  An optional string giving more information about the server or client.
- twisted.conch.ssh.transport.SSHTransportBase.supportedCiphers
  twisted.conch.ssh.transport.SSHTransportBase.html#supportedCiphers
  Attribute
  Instance Variable
  PUBLIC
  A list of strings representing the encryption algorithms supported, in order from most-preferred to least.
- twisted.conch.ssh.transport.SSHTransportBase.supportedMACs
  twisted.conch.ssh.transport.SSHTransportBase.html#supportedMACs
  Attribute
  Instance Variable
  PUBLIC
  A list of strings representing the message authentication codes (hashes) supported, in order from most-preferred to least. Both this and supportedCiphers can include 'none' to use no encryption or authentication, but that must be done manually,...
- twisted.conch.ssh.transport.SSHTransportBase.supportedKeyExchanges
  twisted.conch.ssh.transport.SSHTransportBase.html#supportedKeyExchanges
  Attribute
  Instance Variable
  PUBLIC
  A list of strings representing the key exchanges supported, in order from most-preferred to least.
- twisted.conch.ssh.transport.SSHTransportBase.supportedPublicKeys
  twisted.conch.ssh.transport.SSHTransportBase.html#supportedPublicKeys
  Attribute
  Instance Variable
  PUBLIC
  A list of strings representing the public key algorithms supported, in order from most-preferred to least.
- twisted.conch.ssh.transport.SSHTransportBase.supportedCompressions
  twisted.conch.ssh.transport.SSHTransportBase.html#supportedCompressions
  Attribute
  Instance Variable
  PUBLIC
  A list of strings representing compression types supported, from most-preferred to least.
- twisted.conch.ssh.transport.SSHTransportBase.supportedLanguages
  twisted.conch.ssh.transport.SSHTransportBase.html#supportedLanguages
  Attribute
  Instance Variable
  PUBLIC
  A list of strings representing languages supported, from most-preferred to least.
- twisted.conch.ssh.transport.SSHTransportBase.supportedVersions
  twisted.conch.ssh.transport.SSHTransportBase.html#supportedVersions
  Attribute
  Instance Variable
  PUBLIC
  A container of strings representing supported ssh protocol version numbers.
- twisted.conch.ssh.transport.SSHTransportBase.isClient
  twisted.conch.ssh.transport.SSHTransportBase.html#isClient
  Attribute
  Instance Variable
  PUBLIC
  A boolean indicating whether this is a client or server.
- twisted.conch.ssh.transport.SSHTransportBase.gotVersion
  twisted.conch.ssh.transport.SSHTransportBase.html#gotVersion
  Attribute
  Instance Variable
  PUBLIC
  A boolean indicating whether we have received the version string from the other side.
- twisted.conch.ssh.transport.SSHTransportBase.buf
  twisted.conch.ssh.transport.SSHTransportBase.html#buf
  Attribute
  Instance Variable
  PUBLIC
  Data we've received but hasn't been parsed into a packet.
- twisted.conch.ssh.transport.SSHTransportBase.outgoingPacketSequence
  twisted.conch.ssh.transport.SSHTransportBase.html#outgoingPacketSequence
  Attribute
  Instance Variable
  PUBLIC
  the sequence number of the next packet we will send.
- twisted.conch.ssh.transport.SSHTransportBase.incomingPacketSequence
  twisted.conch.ssh.transport.SSHTransportBase.html#incomingPacketSequence
  Attribute
  Instance Variable
  PUBLIC
  the sequence number of the next packet we are expecting from the other side.
- twisted.conch.ssh.transport.SSHTransportBase.outgoingCompression
  twisted.conch.ssh.transport.SSHTransportBase.html#outgoingCompression
  Attribute
  Instance Variable
  PUBLIC
  an object supporting the .compress(str) and .flush() methods, or None if there is no outgoing compression. Used to compress outgoing data.
- twisted.conch.ssh.transport.SSHTransportBase.outgoingCompressionType
  twisted.conch.ssh.transport.SSHTransportBase.html#outgoingCompressionType
  Attribute
  Instance Variable
  PUBLIC
  A string representing the outgoing compression type.
- twisted.conch.ssh.transport.SSHTransportBase.incomingCompression
  twisted.conch.ssh.transport.SSHTransportBase.html#incomingCompression
  Attribute
  Instance Variable
  PUBLIC
  an object supporting the .decompress(str) method, or None if there is no incoming compression. Used to decompress incoming data.
- twisted.conch.ssh.transport.SSHTransportBase.incomingCompressionType
  twisted.conch.ssh.transport.SSHTransportBase.html#incomingCompressionType
  Attribute
  Instance Variable
  PUBLIC
  A string representing the incoming compression type.
- twisted.conch.ssh.transport.SSHTransportBase.ourVersionString
  twisted.conch.ssh.transport.SSHTransportBase.html#ourVersionString
  Attribute
  Instance Variable
  PUBLIC
  the version string that we sent to the other side. Used in the key exchange.
- twisted.conch.ssh.transport.SSHTransportBase.otherVersionString
  twisted.conch.ssh.transport.SSHTransportBase.html#otherVersionString
  Attribute
  Instance Variable
  PUBLIC
  the version string sent by the other side. Used in the key exchange.
- twisted.conch.ssh.transport.SSHTransportBase.ourKexInitPayload
  twisted.conch.ssh.transport.SSHTransportBase.html#ourKexInitPayload
  Attribute
  Instance Variable
  PUBLIC
  the MSG_KEXINIT payload we sent. Used in the key exchange.
- twisted.conch.ssh.transport.SSHTransportBase.otherKexInitPayload
  twisted.conch.ssh.transport.SSHTransportBase.html#otherKexInitPayload
  Attribute
  Instance Variable
  PUBLIC
  the MSG_KEXINIT payload we received. Used in the key exchange
- twisted.conch.ssh.transport.SSHTransportBase.sessionID
  twisted.conch.ssh.transport.SSHTransportBase.html#sessionID
  Attribute
  Instance Variable
  PUBLIC
  a string that is unique to this SSH session. Created as part of the key exchange, sessionID is used to generate the various encryption and authentication keys.
- twisted.conch.ssh.transport.SSHTransportBase.service
  twisted.conch.ssh.transport.SSHTransportBase.html#service
  Attribute
  Instance Variable
  PUBLIC
  an SSHService instance, or None. If it's set to an object, it's the currently running service.
- twisted.conch.ssh.transport.SSHTransportBase.keyAlg
  twisted.conch.ssh.transport.SSHTransportBase.html#keyAlg
  Attribute
  Instance Variable
  PUBLIC
  the agreed-upon public key type for the key exchange.
- twisted.conch.ssh.transport.SSHTransportBase.currentEncryptions
  twisted.conch.ssh.transport.SSHTransportBase.html#currentEncryptions
  Attribute
  Instance Variable
  PUBLIC
  an SSHCiphers instance. It represents the current encryption and authentication options for the transport.
- twisted.conch.ssh.transport.SSHTransportBase.nextEncryptions
  twisted.conch.ssh.transport.SSHTransportBase.html#nextEncryptions
  Attribute
  Instance Variable
  PUBLIC
  an SSHCiphers instance. Held here until the MSG_NEWKEYS messages are exchanged, when nextEncryptions is transitioned to currentEncryptions.
- twisted.conch.ssh.transport.SSHTransportBase.first
  twisted.conch.ssh.transport.SSHTransportBase.html#first
  Attribute
  Instance Variable
  PUBLIC
  the first bytes of the next packet. In order to avoid decrypting data twice, the first bytes are decrypted and stored until the whole packet is available.
- twisted.conch.ssh.transport.SSHTransportBase._keyExchangeState
  twisted.conch.ssh.transport.SSHTransportBase.html#_keyExchangeState
  Attribute
  Instance Variable
  PRIVATE
  The current protocol state with respect to key exchange. This is either `_KEY_EXCHANGE_NONE` if no key exchange is in progress (and returns to this value after any key exchange completqes), `_KEY_EXCHANGE_REQUESTED`...
- twisted.conch.ssh.transport.SSHTransportBase._blockedByKeyExchange
  twisted.conch.ssh.transport.SSHTransportBase.html#_blockedByKeyExchange
  Attribute
  Instance Variable
  PRIVATE
  Whenever `_keyExchangeState` is not `_KEY_EXCHANGE_NONE`, this is a `list` of pending messages which were passed to `sendPacket` but could not be sent because it is not legal to send them while a key exchange is in progress...
- twisted.conch.ssh.transport.SSHTransportBase._peerSupportsExtensions
  twisted.conch.ssh.transport.SSHTransportBase.html#_peerSupportsExtensions
  Attribute
  Instance Variable
  PRIVATE
  a boolean indicating whether the other side of the connection supports RFC 8308 extension negotiation.
- twisted.conch.ssh.transport.SSHTransportBase.peerExtensions
  twisted.conch.ssh.transport.SSHTransportBase.html#peerExtensions
  Attribute
  Instance Variable
  PUBLIC
  a dict of extensions supported by the other side of the connection.
- twisted.conch.ssh.transport.SSHTransportBase._log
  twisted.conch.ssh.transport.SSHTransportBase.html#_log
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.conch.ssh.transport.SSHTransportBase._KEY_EXCHANGE_NONE
  twisted.conch.ssh.transport.SSHTransportBase.html#_KEY_EXCHANGE_NONE
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.conch.ssh.transport.SSHTransportBase._KEY_EXCHANGE_REQUESTED
  twisted.conch.ssh.transport.SSHTransportBase.html#_KEY_EXCHANGE_REQUESTED
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.conch.ssh.transport.SSHTransportBase._KEY_EXCHANGE_PROGRESSING
  twisted.conch.ssh.transport.SSHTransportBase.html#_KEY_EXCHANGE_PROGRESSING
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.conch.ssh.transport.SSHTransportBase._EXT_INFO_C
  twisted.conch.ssh.transport.SSHTransportBase.html#_EXT_INFO_C
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.conch.ssh.transport.SSHTransportBase._EXT_INFO_S
  twisted.conch.ssh.transport.SSHTransportBase.html#_EXT_INFO_S
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.conch.ssh.transport.SSHTransportBase.connectionLost
  twisted.conch.ssh.transport.SSHTransportBase.html#connectionLost
  Function
  Method
  PUBLIC
  When the underlying connection is closed, stop the running service (if any), and log out the avatar (if any).
- twisted.conch.ssh.transport.SSHTransportBase.connectionMade
  twisted.conch.ssh.transport.SSHTransportBase.html#connectionMade
  Function
  Method
  PUBLIC
  Called when the connection is made to the other side. We sent our version and the MSG_KEXINIT packet.
- twisted.conch.ssh.transport.SSHTransportBase.sendKexInit
  twisted.conch.ssh.transport.SSHTransportBase.html#sendKexInit
  Function
  Method
  PUBLIC
  Send a KEXINIT message to initiate key exchange or to respond to a key exchange initiated by the peer.
- twisted.conch.ssh.transport.SSHTransportBase._allowedKeyExchangeMessageType
  twisted.conch.ssh.transport.SSHTransportBase.html#_allowedKeyExchangeMessageType
  Function
  Method
  PRIVATE
  Determine if the given message type may be sent while key exchange is in progress.
- twisted.conch.ssh.transport.SSHTransportBase.sendPacket
  twisted.conch.ssh.transport.SSHTransportBase.html#sendPacket
  Function
  Method
  PUBLIC
  Sends a packet. If it's been set up, compress the data, encrypt it, and authenticate it before sending. If key exchange is in progress and the message is not part of key exchange, queue it to be sent later.
- twisted.conch.ssh.transport.SSHTransportBase.getPacket
  twisted.conch.ssh.transport.SSHTransportBase.html#getPacket
  Function
  Method
  PUBLIC
  Try to return a decrypted, authenticated, and decompressed packet out of the buffer. If there is not enough data, return None.
- twisted.conch.ssh.transport.SSHTransportBase._unsupportedVersionReceived
  twisted.conch.ssh.transport.SSHTransportBase.html#_unsupportedVersionReceived
  Function
  Method
  PRIVATE
  Called when an unsupported version of the ssh protocol is received from the remote endpoint.
- twisted.conch.ssh.transport.SSHTransportBase.dataReceived
  twisted.conch.ssh.transport.SSHTransportBase.html#dataReceived
  Function
  Method
  PUBLIC
  First, check for the version string (SSH-2.0-*). After that has been received, this method adds data to the buffer, and pulls out any packets.
- twisted.conch.ssh.transport.SSHTransportBase.dispatchMessage
  twisted.conch.ssh.transport.SSHTransportBase.html#dispatchMessage
  Function
  Method
  PUBLIC
  Send a received message to the appropriate method.
- twisted.conch.ssh.transport.SSHTransportBase.getPeer
  twisted.conch.ssh.transport.SSHTransportBase.html#getPeer
  Function
  Method
  PUBLIC
  Returns an `SSHTransportAddress` corresponding to the other (peer) side of this transport.
- twisted.conch.ssh.transport.SSHTransportBase.getHost
  twisted.conch.ssh.transport.SSHTransportBase.html#getHost
  Function
  Method
  PUBLIC
  Returns an `SSHTransportAddress` corresponding to the this side of transport.
- twisted.conch.ssh.transport.SSHTransportBase.kexAlg 0
  twisted.conch.ssh.transport.SSHTransportBase.html#kexAlg%200
  Attribute
  Instance Variable
  PUBLIC
  the agreed-upon key exchange algorithm.
- twisted.conch.ssh.transport.SSHTransportBase.kexAlg
  twisted.conch.ssh.transport.SSHTransportBase.html#kexAlg
  Attribute
  Instance Variable
  PUBLIC
  The key exchange algorithm name agreed between client and server.
- twisted.conch.ssh.transport.SSHTransportBase.kexAlg.setter
  twisted.conch.ssh.transport.SSHTransportBase.html#kexAlg.setter
  Function
  Method
  PUBLIC
  Set the key exchange algorithm name.
- twisted.conch.ssh.transport.SSHTransportBase._kexAlg
  twisted.conch.ssh.transport.SSHTransportBase.html#_kexAlg
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.conch.ssh.transport.SSHTransportBase.ssh_KEXINIT
  twisted.conch.ssh.transport.SSHTransportBase.html#ssh_KEXINIT
  Function
  Method
  PUBLIC
  Called when we receive a MSG_KEXINIT message. Payload:
- twisted.conch.ssh.transport.SSHTransportBase.ssh_DISCONNECT
  twisted.conch.ssh.transport.SSHTransportBase.html#ssh_DISCONNECT
  Function
  Method
  PUBLIC
  Called when we receive a MSG_DISCONNECT message. Payload:
- twisted.conch.ssh.transport.SSHTransportBase.ssh_IGNORE
  twisted.conch.ssh.transport.SSHTransportBase.html#ssh_IGNORE
  Function
  Method
  PUBLIC
  Called when we receive a MSG_IGNORE message. No payload. This means nothing; we simply return.
- twisted.conch.ssh.transport.SSHTransportBase.ssh_UNIMPLEMENTED
  twisted.conch.ssh.transport.SSHTransportBase.html#ssh_UNIMPLEMENTED
  Function
  Method
  PUBLIC
  Called when we receive a MSG_UNIMPLEMENTED message. Payload:
- twisted.conch.ssh.transport.SSHTransportBase.ssh_DEBUG
  twisted.conch.ssh.transport.SSHTransportBase.html#ssh_DEBUG
  Function
  Method
  PUBLIC
  Called when we receive a MSG_DEBUG message. Payload:
- twisted.conch.ssh.transport.SSHTransportBase.ssh_EXT_INFO
  twisted.conch.ssh.transport.SSHTransportBase.html#ssh_EXT_INFO
  Function
  Method
  PUBLIC
  Called when we get a MSG_EXT_INFO message. Payload:
- twisted.conch.ssh.transport.SSHTransportBase.setService
  twisted.conch.ssh.transport.SSHTransportBase.html#setService
  Function
  Method
  PUBLIC
  Set our service to service and start it running. If we were running a service previously, stop it first.
- twisted.conch.ssh.transport.SSHTransportBase.sendDebug
  twisted.conch.ssh.transport.SSHTransportBase.html#sendDebug
  Function
  Method
  PUBLIC
  Send a debug message to the other side.
- twisted.conch.ssh.transport.SSHTransportBase.sendIgnore
  twisted.conch.ssh.transport.SSHTransportBase.html#sendIgnore
  Function
  Method
  PUBLIC
  Send a message that will be ignored by the other side. This is useful to fool attacks based on guessing packet sizes in the encrypted stream.
- twisted.conch.ssh.transport.SSHTransportBase.sendUnimplemented
  twisted.conch.ssh.transport.SSHTransportBase.html#sendUnimplemented
  Function
  Method
  PUBLIC
  Send a message to the other side that the last packet was not understood.
- twisted.conch.ssh.transport.SSHTransportBase.sendDisconnect
  twisted.conch.ssh.transport.SSHTransportBase.html#sendDisconnect
  Function
  Method
  PUBLIC
  Send a disconnect message to the other side and then disconnect.
- twisted.conch.ssh.transport.SSHTransportBase.sendExtInfo
  twisted.conch.ssh.transport.SSHTransportBase.html#sendExtInfo
  Function
  Method
  PUBLIC
  Send an RFC 8308 extension advertisement to the remote peer.
- twisted.conch.ssh.transport.SSHTransportBase._startEphemeralDH
  twisted.conch.ssh.transport.SSHTransportBase.html#_startEphemeralDH
  Function
  Method
  PRIVATE
  Prepares for a Diffie-Hellman key agreement exchange.
- twisted.conch.ssh.transport.SSHTransportBase.dhSecretKey
  twisted.conch.ssh.transport.SSHTransportBase.html#dhSecretKey
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ssh.transport.SSHTransportBase.dhSecretKeyPublicMP
  twisted.conch.ssh.transport.SSHTransportBase.html#dhSecretKeyPublicMP
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ssh.transport.SSHTransportBase._finishEphemeralDH
  twisted.conch.ssh.transport.SSHTransportBase.html#_finishEphemeralDH
  Function
  Method
  PRIVATE
  Completes the Diffie-Hellman key agreement started by _startEphemeralDH, and forgets the ephemeral secret key.
- twisted.conch.ssh.transport.SSHTransportBase._getKey
  twisted.conch.ssh.transport.SSHTransportBase.html#_getKey
  Function
  Method
  PRIVATE
  Get one of the keys for authentication/encryption.
- twisted.conch.ssh.transport.SSHTransportBase._keySetup
  twisted.conch.ssh.transport.SSHTransportBase.html#_keySetup
  Function
  Method
  PRIVATE
  Set up the keys for the connection and sends MSG_NEWKEYS when finished,
- twisted.conch.ssh.transport.SSHTransportBase._newKeys
  twisted.conch.ssh.transport.SSHTransportBase.html#_newKeys
  Function
  Method
  PRIVATE
  Called back by a subclass once a MSG_NEWKEYS message has been received. This indicates key exchange has completed and new encryption and compression parameters should be adopted. Any messages which were queued during key exchange will also be flushed.
- twisted.conch.ssh.transport.SSHTransportBase.isEncrypted
  twisted.conch.ssh.transport.SSHTransportBase.html#isEncrypted
  Function
  Method
  PUBLIC
  Check if the connection is encrypted in the given direction.
- twisted.conch.ssh.transport.SSHTransportBase.isVerified
  twisted.conch.ssh.transport.SSHTransportBase.html#isVerified
  Function
  Method
  PUBLIC
  Check if the connection is verified/authentication in the given direction.
- twisted.conch.ssh.transport.SSHTransportBase.loseConnection
  twisted.conch.ssh.transport.SSHTransportBase.html#loseConnection
  Function
  Method
  PUBLIC
  Lose the connection to the other side, sending a DISCONNECT_CONNECTION_LOST message.
- twisted.conch.ssh.transport.SSHTransportBase.receiveError
  twisted.conch.ssh.transport.SSHTransportBase.html#receiveError
  Function
  Method
  PUBLIC
  Called when we receive a disconnect error message from the other side.
- twisted.conch.ssh.transport.SSHTransportBase.receiveUnimplemented
  twisted.conch.ssh.transport.SSHTransportBase.html#receiveUnimplemented
  Function
  Method
  PUBLIC
  Called when we receive an unimplemented packet message from the other side.
- twisted.conch.ssh.transport.SSHTransportBase.receiveDebug
  twisted.conch.ssh.transport.SSHTransportBase.html#receiveDebug
  Function
  Method
  PUBLIC
  Called when we receive a debug message from the other side.
- twisted.conch.ssh.transport.SSHTransportBase._generateECPrivateKey
  twisted.conch.ssh.transport.SSHTransportBase.html#_generateECPrivateKey
  Function
  Method
  PRIVATE
  Generate an private key for ECDH key exchange.
- twisted.conch.ssh.transport.SSHTransportBase._encodeECPublicKey
  twisted.conch.ssh.transport.SSHTransportBase.html#_encodeECPublicKey
  Function
  Method
  PRIVATE
  Encode an elliptic curve public key to bytes.
- twisted.conch.ssh.transport.SSHTransportBase._generateECSharedSecret
  twisted.conch.ssh.transport.SSHTransportBase.html#_generateECSharedSecret
  Function
  Method
  PRIVATE
  Generate a shared secret for ECDH key exchange.
- twisted.conch.ssh.transport.SSHServerTransport
  twisted.conch.ssh.transport.SSHServerTransport.html
  Class
  Class
  PUBLIC
  SSHServerTransport implements the server side of the SSH protocol.
- twisted.conch.ssh.transport.SSHServerTransport.isClient
  twisted.conch.ssh.transport.SSHServerTransport.html#isClient
  Attribute
  Instance Variable
  PUBLIC
  since we are never the client, this is always False.
- twisted.conch.ssh.transport.SSHServerTransport.ignoreNextPacket
  twisted.conch.ssh.transport.SSHServerTransport.html#ignoreNextPacket
  Attribute
  Instance Variable
  PUBLIC
  if True, ignore the next key exchange packet. This is set when the client sends a guessed key exchange packet but with an incorrect guess.
- twisted.conch.ssh.transport.SSHServerTransport.dhGexRequest
  twisted.conch.ssh.transport.SSHServerTransport.html#dhGexRequest
  Attribute
  Instance Variable
  PUBLIC
  the KEX_DH_GEX_REQUEST(_OLD) that the client sent. The key generation needs this to be stored.
- twisted.conch.ssh.transport.SSHServerTransport.g
  twisted.conch.ssh.transport.SSHServerTransport.html#g
  Attribute
  Instance Variable
  PUBLIC
  the Diffie-Hellman group generator.
- twisted.conch.ssh.transport.SSHServerTransport.p
  twisted.conch.ssh.transport.SSHServerTransport.html#p
  Attribute
  Instance Variable
  PUBLIC
  the Diffie-Hellman group prime.
- twisted.conch.ssh.transport.SSHServerTransport._getHostKeys
  twisted.conch.ssh.transport.SSHServerTransport.html#_getHostKeys
  Function
  Method
  PRIVATE
  Get the public and private host keys corresponding to the given public key signature algorithm.
- twisted.conch.ssh.transport.SSHServerTransport.ssh_KEXINIT
  twisted.conch.ssh.transport.SSHServerTransport.html#ssh_KEXINIT
  Function
  Method
  PUBLIC
  Called when we receive a MSG_KEXINIT message. For a description of the packet, see SSHTransportBase.ssh_KEXINIT(). Additionally, this method checks if a guessed key exchange packet was sent. If it was sent, and it guessed incorrectly, the next key exchange packet MUST be ignored.
- twisted.conch.ssh.transport.SSHServerTransport._ssh_KEX_ECDH_INIT
  twisted.conch.ssh.transport.SSHServerTransport.html#_ssh_KEX_ECDH_INIT
  Function
  Method
  PRIVATE
  Called from `ssh_KEX_DH_GEX_REQUEST_OLD` to handle elliptic curve key exchanges.
- twisted.conch.ssh.transport.SSHServerTransport.ecPub
  twisted.conch.ssh.transport.SSHServerTransport.html#ecPub
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ssh.transport.SSHServerTransport._ssh_KEXDH_INIT
  twisted.conch.ssh.transport.SSHServerTransport.html#_ssh_KEXDH_INIT
  Function
  Method
  PRIVATE
  Called to handle the beginning of a non-group key exchange.
- twisted.conch.ssh.transport.SSHServerTransport.ssh_KEX_DH_GEX_REQUEST_OLD
  twisted.conch.ssh.transport.SSHServerTransport.html#ssh_KEX_DH_GEX_REQUEST_OLD
  Function
  Method
  PUBLIC
  This represents different key exchange methods that share the same integer value. If the message is determined to be a KEXDH_INIT, `_ssh_KEXDH_INIT` is called to handle it. If it is a KEX_ECDH_INIT, `_ssh_KEX_ECDH_INIT`...
- twisted.conch.ssh.transport.SSHServerTransport.ssh_KEX_DH_GEX_REQUEST
  twisted.conch.ssh.transport.SSHServerTransport.html#ssh_KEX_DH_GEX_REQUEST
  Function
  Method
  PUBLIC
  Called when we receive a MSG_KEX_DH_GEX_REQUEST message. Payload:
- twisted.conch.ssh.transport.SSHServerTransport.ssh_KEX_DH_GEX_INIT
  twisted.conch.ssh.transport.SSHServerTransport.html#ssh_KEX_DH_GEX_INIT
  Function
  Method
  PUBLIC
  Called when we get a MSG_KEX_DH_GEX_INIT message. Payload:
- twisted.conch.ssh.transport.SSHServerTransport._keySetup
  twisted.conch.ssh.transport.SSHServerTransport.html#_keySetup
  Function
  Method
  PRIVATE
  See SSHTransportBase._keySetup().
- twisted.conch.ssh.transport.SSHServerTransport.ssh_NEWKEYS
  twisted.conch.ssh.transport.SSHServerTransport.html#ssh_NEWKEYS
  Function
  Method
  PUBLIC
  Called when we get a MSG_NEWKEYS message. No payload. When we get this, the keys have been set on both sides, and we start using them to encrypt and authenticate the connection.
- twisted.conch.ssh.transport.SSHServerTransport.ssh_SERVICE_REQUEST
  twisted.conch.ssh.transport.SSHServerTransport.html#ssh_SERVICE_REQUEST
  Function
  Method
  PUBLIC
  Called when we get a MSG_SERVICE_REQUEST message. Payload:
- twisted.conch.ssh.transport.SSHClientTransport
  twisted.conch.ssh.transport.SSHClientTransport.html
  Class
  Class
  PUBLIC
  SSHClientTransport implements the client side of the SSH protocol.
- twisted.conch.ssh.transport.SSHClientTransport.isClient
  twisted.conch.ssh.transport.SSHClientTransport.html#isClient
  Attribute
  Instance Variable
  PUBLIC
  since we are always the client, this is always True.
- twisted.conch.ssh.transport.SSHClientTransport._gotNewKeys
  twisted.conch.ssh.transport.SSHClientTransport.html#_gotNewKeys
  Attribute
  Instance Variable
  PRIVATE
  if we receive a MSG_NEWKEYS message before we are ready to transition to the new keys, this is set to True so we can transition when the keys are ready locally.
- twisted.conch.ssh.transport.SSHClientTransport.x
  twisted.conch.ssh.transport.SSHClientTransport.html#x
  Attribute
  Instance Variable
  PUBLIC
  our Diffie-Hellman private key.
- twisted.conch.ssh.transport.SSHClientTransport.e
  twisted.conch.ssh.transport.SSHClientTransport.html#e
  Attribute
  Instance Variable
  PUBLIC
  our Diffie-Hellman public key.
- twisted.conch.ssh.transport.SSHClientTransport.g
  twisted.conch.ssh.transport.SSHClientTransport.html#g
  Attribute
  Instance Variable
  PUBLIC
  the Diffie-Hellman group generator.
- twisted.conch.ssh.transport.SSHClientTransport.p
  twisted.conch.ssh.transport.SSHClientTransport.html#p
  Attribute
  Instance Variable
  PUBLIC
  the Diffie-Hellman group prime
- twisted.conch.ssh.transport.SSHClientTransport.instance
  twisted.conch.ssh.transport.SSHClientTransport.html#instance
  Attribute
  Instance Variable
  PUBLIC
  the SSHService object we are requesting.
- twisted.conch.ssh.transport.SSHClientTransport._dhMinimalGroupSize
  twisted.conch.ssh.transport.SSHClientTransport.html#_dhMinimalGroupSize
  Attribute
  Instance Variable
  PRIVATE
  Minimal acceptable group size advertised by the client in MSG_KEX_DH_GEX_REQUEST.
- twisted.conch.ssh.transport.SSHClientTransport._dhMaximalGroupSize
  twisted.conch.ssh.transport.SSHClientTransport.html#_dhMaximalGroupSize
  Attribute
  Instance Variable
  PRIVATE
  Maximal acceptable group size advertised by the client in MSG_KEX_DH_GEX_REQUEST.
- twisted.conch.ssh.transport.SSHClientTransport._dhPreferredGroupSize
  twisted.conch.ssh.transport.SSHClientTransport.html#_dhPreferredGroupSize
  Attribute
  Instance Variable
  PRIVATE
  Preferred group size advertised by the client in MSG_KEX_DH_GEX_REQUEST.
- twisted.conch.ssh.transport.SSHClientTransport.connectionMade
  twisted.conch.ssh.transport.SSHClientTransport.html#connectionMade
  Function
  Method
  PUBLIC
  Called when the connection is started with the server. Just sets up a private instance variable.
- twisted.conch.ssh.transport.SSHClientTransport.ssh_KEXINIT
  twisted.conch.ssh.transport.SSHClientTransport.html#ssh_KEXINIT
  Function
  Method
  PUBLIC
  Called when we receive a MSG_KEXINIT message. For a description of the packet, see SSHTransportBase.ssh_KEXINIT(). Additionally, this method sends the first key exchange packet.
- twisted.conch.ssh.transport.SSHClientTransport.ecPriv
  twisted.conch.ssh.transport.SSHClientTransport.html#ecPriv
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ssh.transport.SSHClientTransport.ecPub
  twisted.conch.ssh.transport.SSHClientTransport.html#ecPub
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ssh.transport.SSHClientTransport._ssh_KEX_ECDH_REPLY
  twisted.conch.ssh.transport.SSHClientTransport.html#_ssh_KEX_ECDH_REPLY
  Function
  Method
  PRIVATE
  Called to handle a reply to a ECDH exchange message(KEX_ECDH_INIT).
- twisted.conch.ssh.transport.SSHClientTransport._ssh_KEXDH_REPLY
  twisted.conch.ssh.transport.SSHClientTransport.html#_ssh_KEXDH_REPLY
  Function
  Method
  PRIVATE
  Called to handle a reply to a non-group key exchange message (KEXDH_INIT).
- twisted.conch.ssh.transport.SSHClientTransport.ssh_KEX_DH_GEX_GROUP
  twisted.conch.ssh.transport.SSHClientTransport.html#ssh_KEX_DH_GEX_GROUP
  Function
  Method
  PUBLIC
  This handles different messages which share an integer value.
- twisted.conch.ssh.transport.SSHClientTransport._continueKEXDH_REPLY
  twisted.conch.ssh.transport.SSHClientTransport.html#_continueKEXDH_REPLY
  Function
  Method
  PRIVATE
  The host key has been verified, so we generate the keys.
- twisted.conch.ssh.transport.SSHClientTransport.ssh_KEX_DH_GEX_REPLY
  twisted.conch.ssh.transport.SSHClientTransport.html#ssh_KEX_DH_GEX_REPLY
  Function
  Method
  PUBLIC
  Called when we receive a MSG_KEX_DH_GEX_REPLY message. Payload:
- twisted.conch.ssh.transport.SSHClientTransport._continueGEX_REPLY
  twisted.conch.ssh.transport.SSHClientTransport.html#_continueGEX_REPLY
  Function
  Method
  PRIVATE
  The host key has been verified, so we generate the keys.
- twisted.conch.ssh.transport.SSHClientTransport._keySetup
  twisted.conch.ssh.transport.SSHClientTransport.html#_keySetup
  Function
  Method
  PRIVATE
  See SSHTransportBase._keySetup().
- twisted.conch.ssh.transport.SSHClientTransport.ssh_NEWKEYS
  twisted.conch.ssh.transport.SSHClientTransport.html#ssh_NEWKEYS
  Function
  Method
  PUBLIC
  Called when we receive a MSG_NEWKEYS message. No payload. If we've finished setting up our own keys, start using them. Otherwise, remember that we've received this message.
- twisted.conch.ssh.transport.SSHClientTransport.ssh_SERVICE_ACCEPT
  twisted.conch.ssh.transport.SSHClientTransport.html#ssh_SERVICE_ACCEPT
  Function
  Method
  PUBLIC
  Called when we receive a MSG_SERVICE_ACCEPT message. Payload:
- twisted.conch.ssh.transport.SSHClientTransport.requestService
  twisted.conch.ssh.transport.SSHClientTransport.html#requestService
  Function
  Method
  PUBLIC
  Request that a service be run over this transport.
- twisted.conch.ssh.transport.SSHClientTransport.verifyHostKey
  twisted.conch.ssh.transport.SSHClientTransport.html#verifyHostKey
  Function
  Method
  PUBLIC
  Returns a Deferred that gets a callback if it is a valid key, or an errback if not.
- twisted.conch.ssh.transport.SSHClientTransport.connectionSecure
  twisted.conch.ssh.transport.SSHClientTransport.html#connectionSecure
  Function
  Method
  PUBLIC
  Called when the encryption has been set up. Generally, requestService() is called to run another service over the transport.
- twisted.conch.ssh.transport._NullEncryptionContext
  twisted.conch.ssh.transport._NullEncryptionContext.html
  Class
  Class
  PRIVATE
  An encryption context that does not actually encrypt anything.
- twisted.conch.ssh.transport._NullEncryptionContext.update
  twisted.conch.ssh.transport._NullEncryptionContext.html#update
  Function
  Method
  PUBLIC
  'Encrypt' new data by doing nothing.
- twisted.conch.ssh.transport._DummyAlgorithm
  twisted.conch.ssh.transport._DummyAlgorithm.html
  Class
  Class
  PRIVATE
  An encryption algorithm that does not actually encrypt anything.
- twisted.conch.ssh.transport._DummyAlgorithm.block_size
  twisted.conch.ssh.transport._DummyAlgorithm.html#block_size
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.ssh.transport._DummyCipher
  twisted.conch.ssh.transport._DummyCipher.html
  Class
  Class
  PRIVATE
  A cipher for the none encryption method.
- twisted.conch.ssh.transport._DummyCipher.block_size
  twisted.conch.ssh.transport._DummyCipher.html#block_size
  Attribute
  Instance Variable
  PUBLIC
  the block size of the encryption. In the case of the none cipher, this is 8 bytes.
- twisted.conch.ssh.transport._DummyCipher.algorithm
  twisted.conch.ssh.transport._DummyCipher.html#algorithm
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.ssh.transport._DummyCipher.encryptor
  twisted.conch.ssh.transport._DummyCipher.html#encryptor
  Function
  Method
  PUBLIC
  Construct a noop encryptor.
- twisted.conch.ssh.transport._DummyCipher.decryptor
  twisted.conch.ssh.transport._DummyCipher.html#decryptor
  Function
  Method
  PUBLIC
  Construct a noop decryptor.
- twisted.conch.ssh.transport.DH_GENERATOR
  twisted.conch.ssh.transport.html#DH_GENERATOR
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.transport.DH_PRIME
  twisted.conch.ssh.transport.html#DH_PRIME
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.transport.MSG_DISCONNECT
  twisted.conch.ssh.transport.html#MSG_DISCONNECT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.transport.MSG_IGNORE
  twisted.conch.ssh.transport.html#MSG_IGNORE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.transport.MSG_UNIMPLEMENTED
  twisted.conch.ssh.transport.html#MSG_UNIMPLEMENTED
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.transport.MSG_DEBUG
  twisted.conch.ssh.transport.html#MSG_DEBUG
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.transport.MSG_SERVICE_REQUEST
  twisted.conch.ssh.transport.html#MSG_SERVICE_REQUEST
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.transport.MSG_SERVICE_ACCEPT
  twisted.conch.ssh.transport.html#MSG_SERVICE_ACCEPT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.transport.MSG_EXT_INFO
  twisted.conch.ssh.transport.html#MSG_EXT_INFO
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.transport.MSG_KEXINIT
  twisted.conch.ssh.transport.html#MSG_KEXINIT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.transport.MSG_NEWKEYS
  twisted.conch.ssh.transport.html#MSG_NEWKEYS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.transport.MSG_KEXDH_INIT
  twisted.conch.ssh.transport.html#MSG_KEXDH_INIT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.transport.MSG_KEXDH_REPLY
  twisted.conch.ssh.transport.html#MSG_KEXDH_REPLY
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.transport.MSG_KEX_DH_GEX_REQUEST_OLD
  twisted.conch.ssh.transport.html#MSG_KEX_DH_GEX_REQUEST_OLD
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.transport.MSG_KEX_DH_GEX_REQUEST
  twisted.conch.ssh.transport.html#MSG_KEX_DH_GEX_REQUEST
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.transport.MSG_KEX_DH_GEX_GROUP
  twisted.conch.ssh.transport.html#MSG_KEX_DH_GEX_GROUP
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.transport.MSG_KEX_DH_GEX_INIT
  twisted.conch.ssh.transport.html#MSG_KEX_DH_GEX_INIT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.transport.MSG_KEX_DH_GEX_REPLY
  twisted.conch.ssh.transport.html#MSG_KEX_DH_GEX_REPLY
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.transport.DISCONNECT_HOST_NOT_ALLOWED_TO_CONNECT
  twisted.conch.ssh.transport.html#DISCONNECT_HOST_NOT_ALLOWED_TO_CONNECT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.transport.DISCONNECT_PROTOCOL_ERROR
  twisted.conch.ssh.transport.html#DISCONNECT_PROTOCOL_ERROR
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.transport.DISCONNECT_KEY_EXCHANGE_FAILED
  twisted.conch.ssh.transport.html#DISCONNECT_KEY_EXCHANGE_FAILED
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.transport.DISCONNECT_RESERVED
  twisted.conch.ssh.transport.html#DISCONNECT_RESERVED
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.transport.DISCONNECT_MAC_ERROR
  twisted.conch.ssh.transport.html#DISCONNECT_MAC_ERROR
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.transport.DISCONNECT_COMPRESSION_ERROR
  twisted.conch.ssh.transport.html#DISCONNECT_COMPRESSION_ERROR
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.transport.DISCONNECT_SERVICE_NOT_AVAILABLE
  twisted.conch.ssh.transport.html#DISCONNECT_SERVICE_NOT_AVAILABLE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.transport.DISCONNECT_PROTOCOL_VERSION_NOT_SUPPORTED
  twisted.conch.ssh.transport.html#DISCONNECT_PROTOCOL_VERSION_NOT_SUPPORTED
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.transport.DISCONNECT_HOST_KEY_NOT_VERIFIABLE
  twisted.conch.ssh.transport.html#DISCONNECT_HOST_KEY_NOT_VERIFIABLE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.transport.DISCONNECT_CONNECTION_LOST
  twisted.conch.ssh.transport.html#DISCONNECT_CONNECTION_LOST
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.transport.DISCONNECT_BY_APPLICATION
  twisted.conch.ssh.transport.html#DISCONNECT_BY_APPLICATION
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.transport.DISCONNECT_TOO_MANY_CONNECTIONS
  twisted.conch.ssh.transport.html#DISCONNECT_TOO_MANY_CONNECTIONS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.transport.DISCONNECT_AUTH_CANCELLED_BY_USER
  twisted.conch.ssh.transport.html#DISCONNECT_AUTH_CANCELLED_BY_USER
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.transport.DISCONNECT_NO_MORE_AUTH_METHODS_AVAILABLE
  twisted.conch.ssh.transport.html#DISCONNECT_NO_MORE_AUTH_METHODS_AVAILABLE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.transport.DISCONNECT_ILLEGAL_USER_NAME
  twisted.conch.ssh.transport.html#DISCONNECT_ILLEGAL_USER_NAME
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.transport.messages
  twisted.conch.ssh.transport.html#messages
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.conch.client.direct.SSHClientFactory
  twisted.conch.client.direct.SSHClientFactory.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.conch.client.direct.SSHClientFactory.__init__
  twisted.conch.client.direct.SSHClientFactory.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.client.direct.SSHClientFactory.d
  twisted.conch.client.direct.SSHClientFactory.html#d
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.client.direct.SSHClientFactory.options
  twisted.conch.client.direct.SSHClientFactory.html#options
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.client.direct.SSHClientFactory.verifyHostKey
  twisted.conch.client.direct.SSHClientFactory.html#verifyHostKey
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.client.direct.SSHClientFactory.userAuthObject
  twisted.conch.client.direct.SSHClientFactory.html#userAuthObject
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.client.direct.SSHClientFactory.clientConnectionLost
  twisted.conch.client.direct.SSHClientFactory.html#clientConnectionLost
  Function
  Method
  PUBLIC
  Called when an established connection is lost.
- twisted.conch.client.direct.SSHClientFactory.clientConnectionFailed
  twisted.conch.client.direct.SSHClientFactory.html#clientConnectionFailed
  Function
  Method
  PUBLIC
  Called when a connection has failed to connect.
- twisted.conch.client.direct.SSHClientFactory.buildProtocol
  twisted.conch.client.direct.SSHClientFactory.html#buildProtocol
  Function
  Method
  PUBLIC
  Create an instance of a subclass of Protocol.
- twisted.conch.client.direct.SSHClientTransport
  twisted.conch.client.direct.SSHClientTransport.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.conch.client.direct.SSHClientTransport.__init__
  twisted.conch.client.direct.SSHClientTransport.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.client.direct.SSHClientTransport.factory
  twisted.conch.client.direct.SSHClientTransport.html#factory
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.client.direct.SSHClientTransport.unixServer
  twisted.conch.client.direct.SSHClientTransport.html#unixServer
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.client.direct.SSHClientTransport.connectionLost
  twisted.conch.client.direct.SSHClientTransport.html#connectionLost
  Function
  Method
  PUBLIC
  When the underlying connection is closed, stop the running service (if any), and log out the avatar (if any).
- twisted.conch.client.direct.SSHClientTransport.receiveError
  twisted.conch.client.direct.SSHClientTransport.html#receiveError
  Function
  Method
  PUBLIC
  Called when we receive a disconnect error message from the other side.
- twisted.conch.client.direct.SSHClientTransport.sendDisconnect
  twisted.conch.client.direct.SSHClientTransport.html#sendDisconnect
  Function
  Method
  PUBLIC
  Send a disconnect message to the other side and then disconnect.
- twisted.conch.client.direct.SSHClientTransport.receiveDebug
  twisted.conch.client.direct.SSHClientTransport.html#receiveDebug
  Function
  Method
  PUBLIC
  Called when we receive a debug message from the other side.
- twisted.conch.client.direct.SSHClientTransport.verifyHostKey
  twisted.conch.client.direct.SSHClientTransport.html#verifyHostKey
  Function
  Method
  PUBLIC
  Returns a Deferred that gets a callback if it is a valid key, or an errback if not.
- twisted.conch.client.direct.SSHClientTransport.setService
  twisted.conch.client.direct.SSHClientTransport.html#setService
  Function
  Method
  PUBLIC
  Set our service to service and start it running. If we were running a service previously, stop it first.
- twisted.conch.client.direct.SSHClientTransport.connectionSecure
  twisted.conch.client.direct.SSHClientTransport.html#connectionSecure
  Function
  Method
  PUBLIC
  Called when the encryption has been set up. Generally, requestService() is called to run another service over the transport.
- twisted.conch.client.direct.connect
  twisted.conch.client.direct.html#connect
  Function
  Function
  PUBLIC
  Undocumented
- twisted.conch.client.connect.connectTypes
  twisted.conch.client.connect.html#connectTypes
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.conch.client.connect.connect
  twisted.conch.client.connect.html#connect
  Function
  Function
  PUBLIC
  Undocumented
- twisted.conch.client.connect._ebConnect
  twisted.conch.client.connect.html#_ebConnect
  Function
  Function
  PRIVATE
  Undocumented
- twisted.conch.client.knownhosts.log
  twisted.conch.client.knownhosts.html#log
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.conch.client.knownhosts._b64encode
  twisted.conch.client.knownhosts.html#_b64encode
  Function
  Function
  PRIVATE
  Encode a binary string as base64 with no trailing newline.
- twisted.conch.client.knownhosts._extractCommon
  twisted.conch.client.knownhosts.html#_extractCommon
  Function
  Function
  PRIVATE
  Extract common elements of base64 keys from an entry in a hosts file.
- twisted.conch.client.knownhosts._BaseEntry
  twisted.conch.client.knownhosts._BaseEntry.html
  Class
  Class
  PRIVATE
  Abstract base of both hashed and non-hashed entry objects, since they represent keys and key types the same way.
- twisted.conch.client.knownhosts._BaseEntry.keyType
  twisted.conch.client.knownhosts._BaseEntry.html#keyType
  Attribute
  Instance Variable
  PUBLIC
  The type of the key; either ssh-dss or ssh-rsa.
- twisted.conch.client.knownhosts._BaseEntry.publicKey
  twisted.conch.client.knownhosts._BaseEntry.html#publicKey
  Attribute
  Instance Variable
  PUBLIC
  The server public key indicated by this line.
- twisted.conch.client.knownhosts._BaseEntry.comment
  twisted.conch.client.knownhosts._BaseEntry.html#comment
  Attribute
  Instance Variable
  PUBLIC
  Trailing garbage after the key line.
- twisted.conch.client.knownhosts._BaseEntry.__init__
  twisted.conch.client.knownhosts._BaseEntry.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.client.knownhosts._BaseEntry.matchesKey
  twisted.conch.client.knownhosts._BaseEntry.html#matchesKey
  Function
  Method
  PUBLIC
  Check to see if this entry matches a given key object.
- twisted.conch.client.knownhosts.PlainEntry
  twisted.conch.client.knownhosts.PlainEntry.html
  Class
  Class
  PUBLIC
  A `PlainEntry` is a representation of a plain-text entry in a known_hosts file.
- twisted.conch.client.knownhosts.PlainEntry._hostnames
  twisted.conch.client.knownhosts.PlainEntry.html#_hostnames
  Attribute
  Instance Variable
  PRIVATE
  the list of all host-names associated with this entry.
- twisted.conch.client.knownhosts.PlainEntry.__init__
  twisted.conch.client.knownhosts.PlainEntry.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.client.knownhosts.PlainEntry.fromString
  twisted.conch.client.knownhosts.PlainEntry.html#fromString
  Function
  Class Method
  PUBLIC
  Parse a plain-text entry in a known_hosts file, and return a corresponding `PlainEntry`.
- twisted.conch.client.knownhosts.PlainEntry.matchesHost
  twisted.conch.client.knownhosts.PlainEntry.html#matchesHost
  Function
  Method
  PUBLIC
  Check to see if this entry matches a given hostname.
- twisted.conch.client.knownhosts.PlainEntry.toString
  twisted.conch.client.knownhosts.PlainEntry.html#toString
  Function
  Method
  PUBLIC
  Implement `IKnownHostEntry.toString` by recording the comma-separated hostnames, key type, and base-64 encoded key.
- twisted.conch.client.knownhosts.UnparsedEntry
  twisted.conch.client.knownhosts.UnparsedEntry.html
  Class
  Class
  PUBLIC
  `UnparsedEntry` is an entry in a `KnownHostsFile` which can't actually be parsed; therefore it matches no keys and no hosts.
- twisted.conch.client.knownhosts.UnparsedEntry.__init__
  twisted.conch.client.knownhosts.UnparsedEntry.html#__init__
  Function
  Method
  PUBLIC
  Create an unparsed entry from a line in a known_hosts file which cannot otherwise be parsed.
- twisted.conch.client.knownhosts.UnparsedEntry._string
  twisted.conch.client.knownhosts.UnparsedEntry.html#_string
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.conch.client.knownhosts.UnparsedEntry.matchesHost
  twisted.conch.client.knownhosts.UnparsedEntry.html#matchesHost
  Function
  Method
  PUBLIC
  Always returns False.
- twisted.conch.client.knownhosts.UnparsedEntry.matchesKey
  twisted.conch.client.knownhosts.UnparsedEntry.html#matchesKey
  Function
  Method
  PUBLIC
  Always returns False.
- twisted.conch.client.knownhosts.UnparsedEntry.toString
  twisted.conch.client.knownhosts.UnparsedEntry.html#toString
  Function
  Method
  PUBLIC
  Returns the input line, without its newline if one was given.
- twisted.conch.client.knownhosts._hmacedString
  twisted.conch.client.knownhosts.html#_hmacedString
  Function
  Function
  PRIVATE
  Return the SHA-1 HMAC hash of the given key and string.
- twisted.conch.client.knownhosts.HashedEntry
  twisted.conch.client.knownhosts.HashedEntry.html
  Class
  Class
  PUBLIC
  A `HashedEntry` is a representation of an entry in a known_hosts file where the hostname has been hashed and salted.
- twisted.conch.client.knownhosts.HashedEntry._hostSalt
  twisted.conch.client.knownhosts.HashedEntry.html#_hostSalt
  Attribute
  Instance Variable
  PRIVATE
  the salt to combine with a hostname for hashing.
- twisted.conch.client.knownhosts.HashedEntry._hostHash
  twisted.conch.client.knownhosts.HashedEntry.html#_hostHash
  Attribute
  Instance Variable
  PRIVATE
  the hashed representation of the hostname.
- twisted.conch.client.knownhosts.HashedEntry.MAGIC
  twisted.conch.client.knownhosts.HashedEntry.html#MAGIC
  Attribute
  Constant
  PUBLIC
  the 'hash magic' string used to identify a hashed line in a known_hosts file as opposed to a plaintext one.
- twisted.conch.client.knownhosts.HashedEntry.compareAttributes
  twisted.conch.client.knownhosts.HashedEntry.html#compareAttributes
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.client.knownhosts.HashedEntry.__init__
  twisted.conch.client.knownhosts.HashedEntry.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.client.knownhosts.HashedEntry.fromString
  twisted.conch.client.knownhosts.HashedEntry.html#fromString
  Function
  Class Method
  PUBLIC
  Load a hashed entry from a string representing a line in a known_hosts file.
- twisted.conch.client.knownhosts.HashedEntry.matchesHost
  twisted.conch.client.knownhosts.HashedEntry.html#matchesHost
  Function
  Method
  PUBLIC
  Implement `IKnownHostEntry.matchesHost` to compare the hash of the input to the stored hash.
- twisted.conch.client.knownhosts.HashedEntry.toString
  twisted.conch.client.knownhosts.HashedEntry.html#toString
  Function
  Method
  PUBLIC
  Implement `IKnownHostEntry.toString` by base64-encoding the salt, host hash, and key.
- twisted.conch.client.knownhosts.KnownHostsFile
  twisted.conch.client.knownhosts.KnownHostsFile.html
  Class
  Class
  PUBLIC
  A structured representation of an OpenSSH-format ~/.ssh/known_hosts file.
- twisted.conch.client.knownhosts.KnownHostsFile._added
  twisted.conch.client.knownhosts.KnownHostsFile.html#_added
  Attribute
  Instance Variable
  PRIVATE
  A list of `IKnownHostEntry` providers which have been added to this instance in memory but not yet saved.
- twisted.conch.client.knownhosts.KnownHostsFile._clobber
  twisted.conch.client.knownhosts.KnownHostsFile.html#_clobber
  Attribute
  Instance Variable
  PRIVATE
  A flag indicating whether the current contents of the save path will be disregarded and potentially overwritten or not. If `True`, this will be done. If `False`, entries in the save path will be read and new entries will be saved by appending rather than overwriting.
- twisted.conch.client.knownhosts.KnownHostsFile._savePath
  twisted.conch.client.knownhosts.KnownHostsFile.html#_savePath
  Attribute
  Instance Variable
  PRIVATE
  See `savePath` parameter of `__init__`.
- twisted.conch.client.knownhosts.KnownHostsFile.__init__
  twisted.conch.client.knownhosts.KnownHostsFile.html#__init__
  Function
  Method
  PUBLIC
  Create a new, empty KnownHostsFile.
- twisted.conch.client.knownhosts.KnownHostsFile.savePath
  twisted.conch.client.knownhosts.KnownHostsFile.html#savePath
  Attribute
  Property
  PUBLIC
  No summary
- twisted.conch.client.knownhosts.KnownHostsFile.iterentries
  twisted.conch.client.knownhosts.KnownHostsFile.html#iterentries
  Function
  Method
  PUBLIC
  Iterate over the host entries in this file.
- twisted.conch.client.knownhosts.KnownHostsFile.hasHostKey
  twisted.conch.client.knownhosts.KnownHostsFile.html#hasHostKey
  Function
  Method
  PUBLIC
  Check for an entry with matching hostname and key.
- twisted.conch.client.knownhosts.KnownHostsFile.verifyHostKey
  twisted.conch.client.knownhosts.KnownHostsFile.html#verifyHostKey
  Function
  Method
  PUBLIC
  Verify the given host key for the given IP and host, asking for confirmation from, and notifying, the given UI about changes to this file.
- twisted.conch.client.knownhosts.KnownHostsFile.addHostKey
  twisted.conch.client.knownhosts.KnownHostsFile.html#addHostKey
  Function
  Method
  PUBLIC
  Add a new `HashedEntry` to the key database.
- twisted.conch.client.knownhosts.KnownHostsFile.save
  twisted.conch.client.knownhosts.KnownHostsFile.html#save
  Function
  Method
  PUBLIC
  Save this `KnownHostsFile` to the path it was loaded from.
- twisted.conch.client.knownhosts.KnownHostsFile.fromPath
  twisted.conch.client.knownhosts.KnownHostsFile.html#fromPath
  Function
  Class Method
  PUBLIC
  Create a new `KnownHostsFile`, potentially reading existing known hosts information from the given file.
- twisted.conch.client.knownhosts.ConsoleUI
  twisted.conch.client.knownhosts.ConsoleUI.html
  Class
  Class
  PUBLIC
  A UI object that can ask true/false questions and post notifications on the console, to be used during key verification.
- twisted.conch.client.knownhosts.ConsoleUI.__init__
  twisted.conch.client.knownhosts.ConsoleUI.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.conch.client.knownhosts.ConsoleUI.opener
  twisted.conch.client.knownhosts.ConsoleUI.html#opener
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.client.knownhosts.ConsoleUI.prompt
  twisted.conch.client.knownhosts.ConsoleUI.html#prompt
  Function
  Method
  PUBLIC
  Write the given text as a prompt to the console output, then read a result from the console input.
- twisted.conch.client.knownhosts.ConsoleUI.warn
  twisted.conch.client.knownhosts.ConsoleUI.html#warn
  Function
  Method
  PUBLIC
  Notify the user (non-interactively) of the provided text, by writing it to the console.
- twisted.conch.ssh.userauth.SSHUserAuthServer
  twisted.conch.ssh.userauth.SSHUserAuthServer.html
  Class
  Class
  PUBLIC
  A service implementing the server side of the 'ssh-userauth' service. It is used to authenticate the user on the other side as being able to access this server.
- twisted.conch.ssh.userauth.SSHUserAuthServer.name
  twisted.conch.ssh.userauth.SSHUserAuthServer.html#name
  Attribute
  Instance Variable
  PUBLIC
  the name of this service: 'ssh-userauth'
- twisted.conch.ssh.userauth.SSHUserAuthServer.authenticatedWith
  twisted.conch.ssh.userauth.SSHUserAuthServer.html#authenticatedWith
  Attribute
  Instance Variable
  PUBLIC
  a list of authentication methods that have already been used.
- twisted.conch.ssh.userauth.SSHUserAuthServer.loginTimeout
  twisted.conch.ssh.userauth.SSHUserAuthServer.html#loginTimeout
  Attribute
  Instance Variable
  PUBLIC
  the number of seconds we wait before disconnecting the user for taking too long to authenticate
- twisted.conch.ssh.userauth.SSHUserAuthServer.attemptsBeforeDisconnect
  twisted.conch.ssh.userauth.SSHUserAuthServer.html#attemptsBeforeDisconnect
  Attribute
  Instance Variable
  PUBLIC
  the number of failed login attempts we allow before disconnecting.
- twisted.conch.ssh.userauth.SSHUserAuthServer.loginAttempts
  twisted.conch.ssh.userauth.SSHUserAuthServer.html#loginAttempts
  Attribute
  Instance Variable
  PUBLIC
  the number of login attempts that have been made
- twisted.conch.ssh.userauth.SSHUserAuthServer.passwordDelay
  twisted.conch.ssh.userauth.SSHUserAuthServer.html#passwordDelay
  Attribute
  Instance Variable
  PUBLIC
  the number of seconds to delay when the user gives an incorrect password
- twisted.conch.ssh.userauth.SSHUserAuthServer.interfaceToMethod
  twisted.conch.ssh.userauth.SSHUserAuthServer.html#interfaceToMethod
  Attribute
  Instance Variable
  PUBLIC
  a `dict` mapping credential interfaces to authentication methods. The server checks to see which of the cred interfaces have checkers and tells the client that those methods are valid for authentication.
- twisted.conch.ssh.userauth.SSHUserAuthServer.supportedAuthentications
  twisted.conch.ssh.userauth.SSHUserAuthServer.html#supportedAuthentications
  Attribute
  Instance Variable
  PUBLIC
  A list of the supported authentication methods.
- twisted.conch.ssh.userauth.SSHUserAuthServer.user
  twisted.conch.ssh.userauth.SSHUserAuthServer.html#user
  Attribute
  Instance Variable
  PUBLIC
  the last username the client tried to authenticate with
- twisted.conch.ssh.userauth.SSHUserAuthServer.method
  twisted.conch.ssh.userauth.SSHUserAuthServer.html#method
  Attribute
  Instance Variable
  PUBLIC
  the current authentication method
- twisted.conch.ssh.userauth.SSHUserAuthServer.nextService
  twisted.conch.ssh.userauth.SSHUserAuthServer.html#nextService
  Attribute
  Instance Variable
  PUBLIC
  the service the user wants started after authentication has been completed.
- twisted.conch.ssh.userauth.SSHUserAuthServer.portal
  twisted.conch.ssh.userauth.SSHUserAuthServer.html#portal
  Attribute
  Instance Variable
  PUBLIC
  the `twisted.cred.portal.Portal` we are using for authentication
- twisted.conch.ssh.userauth.SSHUserAuthServer.clock
  twisted.conch.ssh.userauth.SSHUserAuthServer.html#clock
  Attribute
  Instance Variable
  PUBLIC
  an object with a callLater method. Stubbed out for testing.
- twisted.conch.ssh.userauth.SSHUserAuthServer._log
  twisted.conch.ssh.userauth.SSHUserAuthServer.html#_log
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.conch.ssh.userauth.SSHUserAuthServer.serviceStarted
  twisted.conch.ssh.userauth.SSHUserAuthServer.html#serviceStarted
  Function
  Method
  PUBLIC
  Called when the userauth service is started. Set up instance variables, check if we should allow password authentication (only allow if the outgoing connection is encrypted) and set up a login timeout.
- twisted.conch.ssh.userauth.SSHUserAuthServer._cancelLoginTimeout
  twisted.conch.ssh.userauth.SSHUserAuthServer.html#_cancelLoginTimeout
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.conch.ssh.userauth.SSHUserAuthServer.serviceStopped
  twisted.conch.ssh.userauth.SSHUserAuthServer.html#serviceStopped
  Function
  Method
  PUBLIC
  Called when the userauth service is stopped. Cancel the login timeout if it's still going.
- twisted.conch.ssh.userauth.SSHUserAuthServer.timeoutAuthentication
  twisted.conch.ssh.userauth.SSHUserAuthServer.html#timeoutAuthentication
  Function
  Method
  PUBLIC
  Called when the user has timed out on authentication. Disconnect with a DISCONNECT_NO_MORE_AUTH_METHODS_AVAILABLE message.
- twisted.conch.ssh.userauth.SSHUserAuthServer.tryAuth
  twisted.conch.ssh.userauth.SSHUserAuthServer.html#tryAuth
  Function
  Method
  PUBLIC
  Try to authenticate the user with the given method. Dispatches to a auth_* method.
- twisted.conch.ssh.userauth.SSHUserAuthServer.ssh_USERAUTH_REQUEST
  twisted.conch.ssh.userauth.SSHUserAuthServer.html#ssh_USERAUTH_REQUEST
  Function
  Method
  PUBLIC
  The client has requested authentication. Payload:
- twisted.conch.ssh.userauth.SSHUserAuthServer._cbFinishedAuth
  twisted.conch.ssh.userauth.SSHUserAuthServer.html#_cbFinishedAuth
  Function
  Method
  PRIVATE
  The callback when user has successfully been authenticated. For a description of the arguments, see `twisted.cred.portal.Portal.login`. We start the service requested by the user.
- twisted.conch.ssh.userauth.SSHUserAuthServer._ebMaybeBadAuth
  twisted.conch.ssh.userauth.SSHUserAuthServer.html#_ebMaybeBadAuth
  Function
  Method
  PRIVATE
  An intermediate errback. If the reason is error.NotEnoughAuthentication, we send a MSG_USERAUTH_FAILURE, but with the partial success indicator set.
- twisted.conch.ssh.userauth.SSHUserAuthServer._ebBadAuth
  twisted.conch.ssh.userauth.SSHUserAuthServer.html#_ebBadAuth
  Function
  Method
  PRIVATE
  The final errback in the authentication chain. If the reason is error.IgnoreAuthentication, we simply return; the authentication method has sent its own response. Otherwise, send a failure message and (if the method is not 'none') increment the number of login attempts.
- twisted.conch.ssh.userauth.SSHUserAuthServer.auth_publickey
  twisted.conch.ssh.userauth.SSHUserAuthServer.html#auth_publickey
  Function
  Method
  PUBLIC
  Public key authentication. Payload:
- twisted.conch.ssh.userauth.SSHUserAuthServer._ebCheckKey
  twisted.conch.ssh.userauth.SSHUserAuthServer.html#_ebCheckKey
  Function
  Method
  PRIVATE
  Called back if the user did not sent a signature. If reason is error.ValidPublicKey then this key is valid for the user to authenticate with. Send MSG_USERAUTH_PK_OK.
- twisted.conch.ssh.userauth.SSHUserAuthServer.auth_password
  twisted.conch.ssh.userauth.SSHUserAuthServer.html#auth_password
  Function
  Method
  PUBLIC
  Password authentication. Payload:
- twisted.conch.ssh.userauth.SSHUserAuthServer._ebPassword
  twisted.conch.ssh.userauth.SSHUserAuthServer.html#_ebPassword
  Function
  Method
  PRIVATE
  If the password is invalid, wait before sending the failure in order to delay brute-force password guessing.
- twisted.conch.ssh.userauth.SSHUserAuthClient
  twisted.conch.ssh.userauth.SSHUserAuthClient.html
  Class
  Class
  PUBLIC
  A service implementing the client side of 'ssh-userauth'.
- twisted.conch.ssh.userauth.SSHUserAuthClient.name
  twisted.conch.ssh.userauth.SSHUserAuthClient.html#name
  Attribute
  Instance Variable
  PUBLIC
  the name of this service: 'ssh-userauth'
- twisted.conch.ssh.userauth.SSHUserAuthClient.preferredOrder
  twisted.conch.ssh.userauth.SSHUserAuthClient.html#preferredOrder
  Attribute
  Instance Variable
  PUBLIC
  a list of authentication methods that should be used first, in order of preference, if supported by the server
- twisted.conch.ssh.userauth.SSHUserAuthClient.user
  twisted.conch.ssh.userauth.SSHUserAuthClient.html#user
  Attribute
  Instance Variable
  PUBLIC
  the name of the user to authenticate as
- twisted.conch.ssh.userauth.SSHUserAuthClient.instance
  twisted.conch.ssh.userauth.SSHUserAuthClient.html#instance
  Attribute
  Instance Variable
  PUBLIC
  the service to start after authentication has finished
- twisted.conch.ssh.userauth.SSHUserAuthClient.authenticatedWith
  twisted.conch.ssh.userauth.SSHUserAuthClient.html#authenticatedWith
  Attribute
  Instance Variable
  PUBLIC
  a list of strings of authentication methods we've tried
- twisted.conch.ssh.userauth.SSHUserAuthClient.triedPublicKeys
  twisted.conch.ssh.userauth.SSHUserAuthClient.html#triedPublicKeys
  Attribute
  Instance Variable
  PUBLIC
  a list of public key objects that we've tried to authenticate with
- twisted.conch.ssh.userauth.SSHUserAuthClient.lastPublicKey
  twisted.conch.ssh.userauth.SSHUserAuthClient.html#lastPublicKey
  Attribute
  Instance Variable
  PUBLIC
  the last public key object we've tried to authenticate with
- twisted.conch.ssh.userauth.SSHUserAuthClient.__init__
  twisted.conch.ssh.userauth.SSHUserAuthClient.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh.userauth.SSHUserAuthClient.serviceStarted
  twisted.conch.ssh.userauth.SSHUserAuthClient.html#serviceStarted
  Function
  Method
  PUBLIC
  called when the service is active on the transport.
- twisted.conch.ssh.userauth.SSHUserAuthClient.askForAuth
  twisted.conch.ssh.userauth.SSHUserAuthClient.html#askForAuth
  Function
  Method
  PUBLIC
  Send a MSG_USERAUTH_REQUEST.
- twisted.conch.ssh.userauth.SSHUserAuthClient.lastAuth
  twisted.conch.ssh.userauth.SSHUserAuthClient.html#lastAuth
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ssh.userauth.SSHUserAuthClient.tryAuth
  twisted.conch.ssh.userauth.SSHUserAuthClient.html#tryAuth
  Function
  Method
  PUBLIC
  Dispatch to an authentication method.
- twisted.conch.ssh.userauth.SSHUserAuthClient._ebAuth
  twisted.conch.ssh.userauth.SSHUserAuthClient.html#_ebAuth
  Function
  Method
  PRIVATE
  Generic callback for a failed authentication attempt. Respond by asking for the list of accepted methods (the 'none' method)
- twisted.conch.ssh.userauth.SSHUserAuthClient.ssh_USERAUTH_SUCCESS
  twisted.conch.ssh.userauth.SSHUserAuthClient.html#ssh_USERAUTH_SUCCESS
  Function
  Method
  PUBLIC
  We received a MSG_USERAUTH_SUCCESS. The server has accepted our authentication, so start the next service.
- twisted.conch.ssh.userauth.SSHUserAuthClient.ssh_USERAUTH_FAILURE
  twisted.conch.ssh.userauth.SSHUserAuthClient.html#ssh_USERAUTH_FAILURE
  Function
  Method
  PUBLIC
  We received a MSG_USERAUTH_FAILURE. Payload:
- twisted.conch.ssh.userauth.SSHUserAuthClient._cbUserauthFailure
  twisted.conch.ssh.userauth.SSHUserAuthClient.html#_cbUserauthFailure
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.ssh.userauth.SSHUserAuthClient.ssh_USERAUTH_PK_OK
  twisted.conch.ssh.userauth.SSHUserAuthClient.html#ssh_USERAUTH_PK_OK
  Function
  Method
  PUBLIC
  This message (number 60) can mean several different messages depending on the current authentication type. We dispatch to individual methods in order to handle this request.
- twisted.conch.ssh.userauth.SSHUserAuthClient.ssh_USERAUTH_PK_OK_publickey
  twisted.conch.ssh.userauth.SSHUserAuthClient.html#ssh_USERAUTH_PK_OK_publickey
  Function
  Method
  PUBLIC
  This is MSG_USERAUTH_PK. Our public key is valid, so we create a signature and try to authenticate with it.
- twisted.conch.ssh.userauth.SSHUserAuthClient.ssh_USERAUTH_PK_OK_password
  twisted.conch.ssh.userauth.SSHUserAuthClient.html#ssh_USERAUTH_PK_OK_password
  Function
  Method
  PUBLIC
  This is MSG_USERAUTH_PASSWD_CHANGEREQ. The password given has expired. We ask for an old password and a new password, then send both back to the server.
- twisted.conch.ssh.userauth.SSHUserAuthClient._oldPass
  twisted.conch.ssh.userauth.SSHUserAuthClient.html#_oldPass
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.conch.ssh.userauth.SSHUserAuthClient._newPass
  twisted.conch.ssh.userauth.SSHUserAuthClient.html#_newPass
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.conch.ssh.userauth.SSHUserAuthClient.ssh_USERAUTH_PK_OK_keyboard_interactive
  twisted.conch.ssh.userauth.SSHUserAuthClient.html#ssh_USERAUTH_PK_OK_keyboard_interactive
  Function
  Method
  PUBLIC
  This is MSG_USERAUTH_INFO_RESPONSE. The server has sent us the questions it wants us to answer, so we ask the user and sent the responses.
- twisted.conch.ssh.userauth.SSHUserAuthClient._cbSignedData
  twisted.conch.ssh.userauth.SSHUserAuthClient.html#_cbSignedData
  Function
  Method
  PRIVATE
  Called back out of self.signData with the signed data. Send the authentication request with the signature.
- twisted.conch.ssh.userauth.SSHUserAuthClient._setOldPass
  twisted.conch.ssh.userauth.SSHUserAuthClient.html#_setOldPass
  Function
  Method
  PRIVATE
  Called back when we are choosing a new password. Simply store the old password for now.
- twisted.conch.ssh.userauth.SSHUserAuthClient._setNewPass
  twisted.conch.ssh.userauth.SSHUserAuthClient.html#_setNewPass
  Function
  Method
  PRIVATE
  Called back when we are choosing a new password. Get the old password and send the authentication message with both.
- twisted.conch.ssh.userauth.SSHUserAuthClient._cbGenericAnswers
  twisted.conch.ssh.userauth.SSHUserAuthClient.html#_cbGenericAnswers
  Function
  Method
  PRIVATE
  Called back when we are finished answering keyboard-interactive questions. Send the info back to the server in a MSG_USERAUTH_INFO_RESPONSE.
- twisted.conch.ssh.userauth.SSHUserAuthClient.auth_publickey
  twisted.conch.ssh.userauth.SSHUserAuthClient.html#auth_publickey
  Function
  Method
  PUBLIC
  Try to authenticate with a public key. Ask the user for a public key; if the user has one, send the request to the server and return True. Otherwise, return False.
- twisted.conch.ssh.userauth.SSHUserAuthClient._cbGetPublicKey
  twisted.conch.ssh.userauth.SSHUserAuthClient.html#_cbGetPublicKey
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.ssh.userauth.SSHUserAuthClient.auth_password
  twisted.conch.ssh.userauth.SSHUserAuthClient.html#auth_password
  Function
  Method
  PUBLIC
  Try to authenticate with a password. Ask the user for a password. If the user will return a password, return True. Otherwise, return False.
- twisted.conch.ssh.userauth.SSHUserAuthClient.auth_keyboard_interactive
  twisted.conch.ssh.userauth.SSHUserAuthClient.html#auth_keyboard_interactive
  Function
  Method
  PUBLIC
  Try to authenticate with keyboard-interactive authentication. Send the request to the server and return True.
- twisted.conch.ssh.userauth.SSHUserAuthClient._cbPassword
  twisted.conch.ssh.userauth.SSHUserAuthClient.html#_cbPassword
  Function
  Method
  PRIVATE
  Called back when the user gives a password. Send the request to the server.
- twisted.conch.ssh.userauth.SSHUserAuthClient.signData
  twisted.conch.ssh.userauth.SSHUserAuthClient.html#signData
  Function
  Method
  PUBLIC
  Sign the given data with the given public key.
- twisted.conch.ssh.userauth.SSHUserAuthClient._cbSignData
  twisted.conch.ssh.userauth.SSHUserAuthClient.html#_cbSignData
  Function
  Method
  PRIVATE
  Called back when the private key is returned. Sign the data and return the signature.
- twisted.conch.ssh.userauth.SSHUserAuthClient.getPublicKey
  twisted.conch.ssh.userauth.SSHUserAuthClient.html#getPublicKey
  Function
  Method
  PUBLIC
  Return a public key for the user. If no more public keys are available, return `None`.
- twisted.conch.ssh.userauth.SSHUserAuthClient.getPrivateKey
  twisted.conch.ssh.userauth.SSHUserAuthClient.html#getPrivateKey
  Function
  Method
  PUBLIC
  Return a `Deferred` that will be called back with the private key object corresponding to the last public key from getPublicKey(). If the private key is not available, errback on the Deferred.
- twisted.conch.ssh.userauth.SSHUserAuthClient.getPassword
  twisted.conch.ssh.userauth.SSHUserAuthClient.html#getPassword
  Function
  Method
  PUBLIC
  Return a `Deferred` that will be called back with a password. prompt is a string to display for the password, or None for a generic 'user@hostname's password: '.
- twisted.conch.ssh.userauth.SSHUserAuthClient.getGenericAnswers
  twisted.conch.ssh.userauth.SSHUserAuthClient.html#getGenericAnswers
  Function
  Method
  PUBLIC
  Returns a `Deferred` with the responses to the promopts.
- twisted.conch.ssh.userauth.MSG_USERAUTH_REQUEST
  twisted.conch.ssh.userauth.html#MSG_USERAUTH_REQUEST
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.userauth.MSG_USERAUTH_FAILURE
  twisted.conch.ssh.userauth.html#MSG_USERAUTH_FAILURE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.userauth.MSG_USERAUTH_SUCCESS
  twisted.conch.ssh.userauth.html#MSG_USERAUTH_SUCCESS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.userauth.MSG_USERAUTH_BANNER
  twisted.conch.ssh.userauth.html#MSG_USERAUTH_BANNER
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.userauth.MSG_USERAUTH_INFO_RESPONSE
  twisted.conch.ssh.userauth.html#MSG_USERAUTH_INFO_RESPONSE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.userauth.MSG_USERAUTH_PK_OK
  twisted.conch.ssh.userauth.html#MSG_USERAUTH_PK_OK
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.userauth.messages
  twisted.conch.ssh.userauth.html#messages
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.conch.ssh.userauth.MSG_USERAUTH_PASSWD_CHANGEREQ
  twisted.conch.ssh.userauth.html#MSG_USERAUTH_PASSWD_CHANGEREQ
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.userauth.MSG_USERAUTH_INFO_REQUEST
  twisted.conch.ssh.userauth.html#MSG_USERAUTH_INFO_REQUEST
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.client.default._KNOWN_HOSTS
  twisted.conch.client.default.html#_KNOWN_HOSTS
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.conch.client.default.verifyHostKey
  twisted.conch.client.default.html#verifyHostKey
  Function
  Function
  PUBLIC
  Verify a host's key.
- twisted.conch.client.default.isInKnownHosts
  twisted.conch.client.default.html#isInKnownHosts
  Function
  Function
  PUBLIC
  Checks to see if host is in the known_hosts file for the user.
- twisted.conch.client.default.getHostKeyAlgorithms
  twisted.conch.client.default.html#getHostKeyAlgorithms
  Function
  Function
  PUBLIC
  Look in known_hosts for a key corresponding to `host`. This can be used to change the order of supported key types in the KEXINIT packet.
- twisted.conch.client.default.SSHUserAuthClient
  twisted.conch.client.default.SSHUserAuthClient.html
  Class
  Class
  PUBLIC
  No class docstring; 0/3 instance variable, 4/11 methods, 2/2 class methods documented
- twisted.conch.client.default.SSHUserAuthClient.__init__
  twisted.conch.client.default.SSHUserAuthClient.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.client.default.SSHUserAuthClient.keyAgent
  twisted.conch.client.default.SSHUserAuthClient.html#keyAgent
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.client.default.SSHUserAuthClient.options
  twisted.conch.client.default.SSHUserAuthClient.html#options
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.client.default.SSHUserAuthClient.usedFiles
  twisted.conch.client.default.SSHUserAuthClient.html#usedFiles
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.client.default.SSHUserAuthClient.serviceStarted
  twisted.conch.client.default.SSHUserAuthClient.html#serviceStarted
  Function
  Method
  PUBLIC
  called when the service is active on the transport.
- twisted.conch.client.default.SSHUserAuthClient.serviceStopped
  twisted.conch.client.default.SSHUserAuthClient.html#serviceStopped
  Function
  Method
  PUBLIC
  called when the service is stopped, either by the connection ending or by another service being started
- twisted.conch.client.default.SSHUserAuthClient._setAgent
  twisted.conch.client.default.SSHUserAuthClient.html#_setAgent
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.client.default.SSHUserAuthClient._ebSetAgent
  twisted.conch.client.default.SSHUserAuthClient.html#_ebSetAgent
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.client.default.SSHUserAuthClient._getPassword
  twisted.conch.client.default.SSHUserAuthClient.html#_getPassword
  Function
  Method
  PRIVATE
  Prompt for a password using `getpass.getpass`.
- twisted.conch.client.default.SSHUserAuthClient.getPassword
  twisted.conch.client.default.SSHUserAuthClient.html#getPassword
  Function
  Method
  PUBLIC
  Return a `Deferred` that will be called back with a password. prompt is a string to display for the password, or None for a generic 'user@hostname's password: '.
- twisted.conch.client.default.SSHUserAuthClient.getPublicKey
  twisted.conch.client.default.SSHUserAuthClient.html#getPublicKey
  Function
  Method
  PUBLIC
  Get a public key from the key agent if possible, otherwise look in the next configured identity file for one.
- twisted.conch.client.default.SSHUserAuthClient.signData
  twisted.conch.client.default.SSHUserAuthClient.html#signData
  Function
  Method
  PUBLIC
  Extend the base signing behavior by using an SSH agent to sign the data, if one is available.
- twisted.conch.client.default.SSHUserAuthClient.getPrivateKey
  twisted.conch.client.default.SSHUserAuthClient.html#getPrivateKey
  Function
  Method
  PUBLIC
  Try to load the private key from the last used file identified by `getPublicKey`, potentially asking for the passphrase if the key is encrypted.
- twisted.conch.client.default.SSHUserAuthClient.getGenericAnswers
  twisted.conch.client.default.SSHUserAuthClient.html#getGenericAnswers
  Function
  Method
  PUBLIC
  Returns a `Deferred` with the responses to the promopts.
- twisted.conch.client.default.SSHUserAuthClient._openTty
  twisted.conch.client.default.SSHUserAuthClient.html#_openTty
  Function
  Class Method
  PRIVATE
  Open /dev/tty as two streams one in read, one in write mode, and return them.
- twisted.conch.client.default.SSHUserAuthClient._replaceStdoutStdin
  twisted.conch.client.default.SSHUserAuthClient.html#_replaceStdoutStdin
  Function
  Class Method
  PRIVATE
  Contextmanager that replaces stdout and stdin with /dev/tty and resets them when it is done.
- twisted.conch.client.options.ConchOptions
  twisted.conch.client.options.ConchOptions.html
  Class
  Class
  PUBLIC
  No class docstring; 0/2 instance variable, 0/3 class variable, 5/6 methods documented
- twisted.conch.client.options.ConchOptions.optParameters
  twisted.conch.client.options.ConchOptions.html#optParameters
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.client.options.ConchOptions.optFlags
  twisted.conch.client.options.ConchOptions.html#optFlags
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.client.options.ConchOptions.compData
  twisted.conch.client.options.ConchOptions.html#compData
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.client.options.ConchOptions.__init__
  twisted.conch.client.options.ConchOptions.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.client.options.ConchOptions.identitys
  twisted.conch.client.options.ConchOptions.html#identitys
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.client.options.ConchOptions.conns
  twisted.conch.client.options.ConchOptions.html#conns
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.client.options.ConchOptions.opt_identity
  twisted.conch.client.options.ConchOptions.html#opt_identity
  Function
  Method
  PUBLIC
  Identity for public-key authentication
- twisted.conch.client.options.ConchOptions.opt_ciphers
  twisted.conch.client.options.ConchOptions.html#opt_ciphers
  Function
  Method
  PUBLIC
  Select encryption algorithms
- twisted.conch.client.options.ConchOptions.opt_macs
  twisted.conch.client.options.ConchOptions.html#opt_macs
  Function
  Method
  PUBLIC
  Specify MAC algorithms
- twisted.conch.client.options.ConchOptions.opt_host_key_algorithms
  twisted.conch.client.options.ConchOptions.html#opt_host_key_algorithms
  Function
  Method
  PUBLIC
  Select host key algorithms
- twisted.conch.client.options.ConchOptions.opt_user_authentications
  twisted.conch.client.options.ConchOptions.html#opt_user_authentications
  Function
  Method
  PUBLIC
  Choose how to authenticate to the remote server
- twisted.conch.endpoints.AuthenticationFailed
  twisted.conch.endpoints.AuthenticationFailed.html
  Class
  Exception
  PUBLIC
  An SSH session could not be established because authentication was not successful.
- twisted.conch.endpoints._ISSHConnectionCreator
  twisted.conch.endpoints._ISSHConnectionCreator.html
  Class
  Interface
  PRIVATE
  An `_ISSHConnectionCreator` knows how to create SSH connections somehow.
- twisted.conch.endpoints._ISSHConnectionCreator.secureConnection
  twisted.conch.endpoints._ISSHConnectionCreator.html#secureConnection
  Function
  Method
  PUBLIC
  Return a new, connected, secured, but not yet authenticated instance of `twisted.conch.ssh.transport.SSHServerTransport` or `twisted.conch.ssh.transport.SSHClientTransport`.
- twisted.conch.endpoints._ISSHConnectionCreator.cleanupConnection
  twisted.conch.endpoints._ISSHConnectionCreator.html#cleanupConnection
  Function
  Method
  PUBLIC
  Perform cleanup necessary for a connection object previously returned from this creator's `secureConnection` method.
- twisted.conch.endpoints.SSHCommandAddress
  twisted.conch.endpoints.SSHCommandAddress.html
  Class
  Class
  PUBLIC
  An `SSHCommandAddress` instance represents the address of an SSH server, a username which was used to authenticate with that server, and a command which was run there.
- twisted.conch.endpoints.SSHCommandAddress.server
  twisted.conch.endpoints.SSHCommandAddress.html#server
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`
- twisted.conch.endpoints.SSHCommandAddress.username
  twisted.conch.endpoints.SSHCommandAddress.html#username
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`
- twisted.conch.endpoints.SSHCommandAddress.command
  twisted.conch.endpoints.SSHCommandAddress.html#command
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`
- twisted.conch.endpoints.SSHCommandAddress.__init__
  twisted.conch.endpoints.SSHCommandAddress.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.conch.endpoints._CommandChannel
  twisted.conch.endpoints._CommandChannel.html
  Class
  Class
  PRIVATE
  A `_CommandChannel` executes a command in a session channel and connects its input and output to an `IProtocol` provider.
- twisted.conch.endpoints._CommandChannel._creator
  twisted.conch.endpoints._CommandChannel.html#_creator
  Attribute
  Instance Variable
  PRIVATE
  See `__init__`
- twisted.conch.endpoints._CommandChannel._command
  twisted.conch.endpoints._CommandChannel.html#_command
  Attribute
  Instance Variable
  PRIVATE
  See `__init__`
- twisted.conch.endpoints._CommandChannel._protocolFactory
  twisted.conch.endpoints._CommandChannel.html#_protocolFactory
  Attribute
  Instance Variable
  PRIVATE
  See `__init__`
- twisted.conch.endpoints._CommandChannel._commandConnected
  twisted.conch.endpoints._CommandChannel.html#_commandConnected
  Attribute
  Instance Variable
  PRIVATE
  See `__init__`
- twisted.conch.endpoints._CommandChannel._protocol
  twisted.conch.endpoints._CommandChannel.html#_protocol
  Attribute
  Instance Variable
  PRIVATE
  An `IProtocol` provider created using `_protocolFactory` which is hooked up to the running command's input and output streams.
- twisted.conch.endpoints._CommandChannel.name
  twisted.conch.endpoints._CommandChannel.html#name
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.endpoints._CommandChannel._log
  twisted.conch.endpoints._CommandChannel.html#_log
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.conch.endpoints._CommandChannel.__init__
  twisted.conch.endpoints._CommandChannel.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.conch.endpoints._CommandChannel._reason
  twisted.conch.endpoints._CommandChannel.html#_reason
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.conch.endpoints._CommandChannel.openFailed
  twisted.conch.endpoints._CommandChannel.html#openFailed
  Function
  Method
  PUBLIC
  When the request to open a new channel to run this command in fails, fire the `commandConnected` deferred with a failure indicating that.
- twisted.conch.endpoints._CommandChannel.channelOpen
  twisted.conch.endpoints._CommandChannel.html#channelOpen
  Function
  Method
  PUBLIC
  When the request to open a new channel to run this command in succeeds, issue an `"exec"` request to run the command.
- twisted.conch.endpoints._CommandChannel._execFailure
  twisted.conch.endpoints._CommandChannel.html#_execFailure
  Function
  Method
  PRIVATE
  When the request to execute the command in this channel fails, fire the `commandConnected` deferred with a failure indicating this.
- twisted.conch.endpoints._CommandChannel._execSuccess
  twisted.conch.endpoints._CommandChannel.html#_execSuccess
  Function
  Method
  PRIVATE
  When the request to execute the command in this channel succeeds, use `protocolFactory` to build a protocol to handle the command's input and output and connect the protocol to a transport representing those streams.
- twisted.conch.endpoints._CommandChannel.dataReceived
  twisted.conch.endpoints._CommandChannel.html#dataReceived
  Function
  Method
  PUBLIC
  When the command's stdout data arrives over the channel, deliver it to the protocol instance.
- twisted.conch.endpoints._CommandChannel.request_exit_status
  twisted.conch.endpoints._CommandChannel.html#request_exit_status
  Function
  Method
  PUBLIC
  When the server sends the command's exit status, record it for later delivery to the protocol.
- twisted.conch.endpoints._CommandChannel.request_exit_signal
  twisted.conch.endpoints._CommandChannel.html#request_exit_signal
  Function
  Method
  PUBLIC
  When the server sends the command's exit status, record it for later delivery to the protocol.
- twisted.conch.endpoints._CommandChannel.closed
  twisted.conch.endpoints._CommandChannel.html#closed
  Function
  Method
  PUBLIC
  When the channel closes, deliver disconnection notification to the protocol.
- twisted.conch.endpoints._ConnectionReady
  twisted.conch.endpoints._ConnectionReady.html
  Class
  Class
  PRIVATE
  `_ConnectionReady` is an `SSHConnection` (an SSH service) which only propagates the serviceStarted event to a `Deferred` to be handled elsewhere.
- twisted.conch.endpoints._ConnectionReady.__init__
  twisted.conch.endpoints._ConnectionReady.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.conch.endpoints._ConnectionReady._ready
  twisted.conch.endpoints._ConnectionReady.html#_ready
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.conch.endpoints._ConnectionReady.serviceStarted
  twisted.conch.endpoints._ConnectionReady.html#serviceStarted
  Function
  Method
  PUBLIC
  When the SSH connection service this object represents is ready to be used, fire the `connectionReady` `Deferred` to publish that event to some other interested party.
- twisted.conch.endpoints._UserAuth
  twisted.conch.endpoints._UserAuth.html
  Class
  Class
  PRIVATE
  `_UserAuth` implements the client part of SSH user authentication in the convenient way a user might expect if they are familiar with the interactive ssh command line client.
- twisted.conch.endpoints._UserAuth.password
  twisted.conch.endpoints._UserAuth.html#password
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.endpoints._UserAuth.keys
  twisted.conch.endpoints._UserAuth.html#keys
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.endpoints._UserAuth.agent
  twisted.conch.endpoints._UserAuth.html#agent
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.endpoints._UserAuth.getPublicKey
  twisted.conch.endpoints._UserAuth.html#getPublicKey
  Function
  Method
  PUBLIC
  Retrieve the next public key object to offer to the server, possibly delegating to an authentication agent if there is one.
- twisted.conch.endpoints._UserAuth.key
  twisted.conch.endpoints._UserAuth.html#key
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.endpoints._UserAuth.signData
  twisted.conch.endpoints._UserAuth.html#signData
  Function
  Method
  PUBLIC
  Extend the base signing behavior by using an SSH agent to sign the data, if one is available.
- twisted.conch.endpoints._UserAuth.getPrivateKey
  twisted.conch.endpoints._UserAuth.html#getPrivateKey
  Function
  Method
  PUBLIC
  Get the private part of a key pair to use for authentication. The key corresponds to the public part most recently returned from `getPublicKey`.
- twisted.conch.endpoints._UserAuth.getPassword
  twisted.conch.endpoints._UserAuth.html#getPassword
  Function
  Method
  PUBLIC
  Get the password to use for authentication.
- twisted.conch.endpoints._UserAuth.ssh_USERAUTH_SUCCESS
  twisted.conch.endpoints._UserAuth.html#ssh_USERAUTH_SUCCESS
  Function
  Method
  PUBLIC
  Handle user authentication success in the normal way, but also make a note of the state change on the `_CommandTransport`.
- twisted.conch.endpoints._UserAuth.connectToAgent
  twisted.conch.endpoints._UserAuth.html#connectToAgent
  Function
  Method
  PUBLIC
  Set up a connection to the authentication agent and trigger its initialization.
- twisted.conch.endpoints._UserAuth.loseAgentConnection
  twisted.conch.endpoints._UserAuth.html#loseAgentConnection
  Function
  Method
  PUBLIC
  Disconnect the agent.
- twisted.conch.endpoints._CommandTransport
  twisted.conch.endpoints._CommandTransport.html
  Class
  Class
  PRIVATE
  `_CommandTransport` is an SSH client transport which includes a host key verification step before it will proceed to secure the connection.
- twisted.conch.endpoints._CommandTransport._userauth
  twisted.conch.endpoints._CommandTransport.html#_userauth
  Attribute
  Instance Variable
  PRIVATE
  The `_UserAuth` instance which is in charge of the overall authentication process or `None` if the SSH connection has not reach yet the `user-auth` service.
- twisted.conch.endpoints._CommandTransport._state
  twisted.conch.endpoints._CommandTransport.html#_state
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.conch.endpoints._CommandTransport._hostKeyFailure
  twisted.conch.endpoints._CommandTransport.html#_hostKeyFailure
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.conch.endpoints._CommandTransport.__init__
  twisted.conch.endpoints._CommandTransport.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.conch.endpoints._CommandTransport.connectionReady
  twisted.conch.endpoints._CommandTransport.html#connectionReady
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.endpoints._CommandTransport.creator
  twisted.conch.endpoints._CommandTransport.html#creator
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.endpoints._CommandTransport.verifyHostKey
  twisted.conch.endpoints._CommandTransport.html#verifyHostKey
  Function
  Method
  PUBLIC
  Ask the `KnownHostsFile` provider available on the factory which created this protocol this protocol to verify the given host key.
- twisted.conch.endpoints._CommandTransport._saveHostKeyFailure
  twisted.conch.endpoints._CommandTransport.html#_saveHostKeyFailure
  Function
  Method
  PRIVATE
  When host key verification fails, record the reason for the failure in order to fire a `Deferred` with it later.
- twisted.conch.endpoints._CommandTransport.connectionSecure
  twisted.conch.endpoints._CommandTransport.html#connectionSecure
  Function
  Method
  PUBLIC
  When the connection is secure, start the authentication process.
- twisted.conch.endpoints._CommandTransport.connectionLost
  twisted.conch.endpoints._CommandTransport.html#connectionLost
  Function
  Method
  PUBLIC
  When the underlying connection to the SSH server is lost, if there were any connection setup errors, propagate them. Also, clean up the connection to the ssh agent if one was created.
- twisted.conch.endpoints.SSHCommandClientEndpoint
  twisted.conch.endpoints.SSHCommandClientEndpoint.html
  Class
  Class
  PUBLIC
  `SSHCommandClientEndpoint` exposes the command-executing functionality of SSH servers.
- twisted.conch.endpoints.SSHCommandClientEndpoint.__init__
  twisted.conch.endpoints.SSHCommandClientEndpoint.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.conch.endpoints.SSHCommandClientEndpoint._creator
  twisted.conch.endpoints.SSHCommandClientEndpoint.html#_creator
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.conch.endpoints.SSHCommandClientEndpoint._command
  twisted.conch.endpoints.SSHCommandClientEndpoint.html#_command
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.conch.endpoints.SSHCommandClientEndpoint.newConnection
  twisted.conch.endpoints.SSHCommandClientEndpoint.html#newConnection
  Function
  Class Method
  PUBLIC
  Create and return a new endpoint which will try to create a new connection to an SSH server and run a command over it. It will also close the connection if there are problems leading up to the command being executed, after the command finishes, or if the connection ...
- twisted.conch.endpoints.SSHCommandClientEndpoint.existingConnection
  twisted.conch.endpoints.SSHCommandClientEndpoint.html#existingConnection
  Function
  Class Method
  PUBLIC
  Create and return a new endpoint which will try to open a new channel on an existing SSH connection and run a command over it. It will not close the connection if there is a problem executing the command or after the command finishes.
- twisted.conch.endpoints.SSHCommandClientEndpoint.connect
  twisted.conch.endpoints.SSHCommandClientEndpoint.html#connect
  Function
  Method
  PUBLIC
  Set up an SSH connection, use a channel from that connection to launch a command, and hook the stdin and stdout of that command up as a transport for a protocol created by the given factory.
- twisted.conch.endpoints.SSHCommandClientEndpoint._executeCommand
  twisted.conch.endpoints.SSHCommandClientEndpoint.html#_executeCommand
  Function
  Method
  PRIVATE
  Given a secured SSH connection, try to execute a command in a new channel created on it and associate the result with a protocol from the given factory.
- twisted.conch.endpoints._ReadFile
  twisted.conch.endpoints._ReadFile.html
  Class
  Class
  PRIVATE
  A weakly file-like object which can be used with `KnownHostsFile` to respond in the negative to all prompts for decisions.
- twisted.conch.endpoints._ReadFile.__init__
  twisted.conch.endpoints._ReadFile.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.conch.endpoints._ReadFile._contents
  twisted.conch.endpoints._ReadFile.html#_contents
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.conch.endpoints._ReadFile.write
  twisted.conch.endpoints._ReadFile.html#write
  Function
  Method
  PUBLIC
  No-op.
- twisted.conch.endpoints._ReadFile.readline
  twisted.conch.endpoints._ReadFile.html#readline
  Function
  Method
  PUBLIC
  Always give back the byte string that this `_ReadFile` was initialized with.
- twisted.conch.endpoints._ReadFile.close
  twisted.conch.endpoints._ReadFile.html#close
  Function
  Method
  PUBLIC
  No-op.
- twisted.conch.endpoints._NewConnectionHelper
  twisted.conch.endpoints._NewConnectionHelper.html
  Class
  Class
  PRIVATE
  `_NewConnectionHelper` implements `_ISSHConnectionCreator` by establishing a brand new SSH connection, securing it, and authenticating.
- twisted.conch.endpoints._NewConnectionHelper.port
  twisted.conch.endpoints._NewConnectionHelper.html#port
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.endpoints._NewConnectionHelper.__init__
  twisted.conch.endpoints._NewConnectionHelper.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.conch.endpoints._NewConnectionHelper.reactor
  twisted.conch.endpoints._NewConnectionHelper.html#reactor
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.endpoints._NewConnectionHelper.hostname
  twisted.conch.endpoints._NewConnectionHelper.html#hostname
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.endpoints._NewConnectionHelper.command
  twisted.conch.endpoints._NewConnectionHelper.html#command
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.endpoints._NewConnectionHelper.username
  twisted.conch.endpoints._NewConnectionHelper.html#username
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.endpoints._NewConnectionHelper.keys
  twisted.conch.endpoints._NewConnectionHelper.html#keys
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.endpoints._NewConnectionHelper.password
  twisted.conch.endpoints._NewConnectionHelper.html#password
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.endpoints._NewConnectionHelper.agentEndpoint
  twisted.conch.endpoints._NewConnectionHelper.html#agentEndpoint
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.endpoints._NewConnectionHelper.knownHosts
  twisted.conch.endpoints._NewConnectionHelper.html#knownHosts
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.endpoints._NewConnectionHelper.ui
  twisted.conch.endpoints._NewConnectionHelper.html#ui
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.endpoints._NewConnectionHelper.tty
  twisted.conch.endpoints._NewConnectionHelper.html#tty
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.endpoints._NewConnectionHelper._opener
  twisted.conch.endpoints._NewConnectionHelper.html#_opener
  Function
  Method
  PRIVATE
  Open the tty if possible, otherwise give back a file-like object from which `b"no"` can be read.
- twisted.conch.endpoints._NewConnectionHelper._knownHosts
  twisted.conch.endpoints._NewConnectionHelper.html#_knownHosts
  Function
  Class Method
  PRIVATE
  No summary
- twisted.conch.endpoints._NewConnectionHelper.secureConnection
  twisted.conch.endpoints._NewConnectionHelper.html#secureConnection
  Function
  Method
  PUBLIC
  Create and return a new SSH connection which has been secured and on which authentication has already happened.
- twisted.conch.endpoints._NewConnectionHelper.cleanupConnection
  twisted.conch.endpoints._NewConnectionHelper.html#cleanupConnection
  Function
  Method
  PUBLIC
  Clean up the connection by closing it. The command running on the endpoint has ended so the connection is no longer needed.
- twisted.conch.endpoints._ExistingConnectionHelper
  twisted.conch.endpoints._ExistingConnectionHelper.html
  Class
  Class
  PRIVATE
  `_ExistingConnectionHelper` implements `_ISSHConnectionCreator` by handing out an existing SSH connection which is supplied to its initializer.
- twisted.conch.endpoints._ExistingConnectionHelper.__init__
  twisted.conch.endpoints._ExistingConnectionHelper.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.conch.endpoints._ExistingConnectionHelper.connection
  twisted.conch.endpoints._ExistingConnectionHelper.html#connection
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.endpoints._ExistingConnectionHelper.secureConnection
  twisted.conch.endpoints._ExistingConnectionHelper.html#secureConnection
  Function
  Method
  PUBLIC
  No summary
- twisted.conch.endpoints._ExistingConnectionHelper.cleanupConnection
  twisted.conch.endpoints._ExistingConnectionHelper.html#cleanupConnection
  Function
  Method
  PUBLIC
  Do not do any cleanup on the connection. Leave that responsibility to whatever code created it in the first place.
- twisted.conch.insults.insults.ITerminalProtocol
  twisted.conch.insults.insults.ITerminalProtocol.html
  Class
  Interface
  PUBLIC
  No interface docstring; 5/5 methods documented
- twisted.conch.insults.insults.ITerminalProtocol.makeConnection
  twisted.conch.insults.insults.ITerminalProtocol.html#makeConnection
  Function
  Method
  PUBLIC
  Called with an `ITerminalTransport` when a connection is established.
- twisted.conch.insults.insults.ITerminalProtocol.keystrokeReceived
  twisted.conch.insults.insults.ITerminalProtocol.html#keystrokeReceived
  Function
  Method
  PUBLIC
  A keystroke was received.
- twisted.conch.insults.insults.ITerminalProtocol.terminalSize
  twisted.conch.insults.insults.ITerminalProtocol.html#terminalSize
  Function
  Method
  PUBLIC
  Called to indicate the size of the terminal.
- twisted.conch.insults.insults.ITerminalProtocol.unhandledControlSequence
  twisted.conch.insults.insults.ITerminalProtocol.html#unhandledControlSequence
  Function
  Method
  PUBLIC
  Called when an unsupported control sequence is received.
- twisted.conch.insults.insults.ITerminalProtocol.connectionLost
  twisted.conch.insults.insults.ITerminalProtocol.html#connectionLost
  Function
  Method
  PUBLIC
  Called when the connection has been lost.
- twisted.conch.insults.insults.TerminalProtocol
  twisted.conch.insults.insults.TerminalProtocol.html
  Class
  Class
  PUBLIC
  No class docstring; 0/1 instance variable, 1/6 method documented
- twisted.conch.insults.insults.TerminalProtocol.makeConnection
  twisted.conch.insults.insults.TerminalProtocol.html#makeConnection
  Function
  Method
  PUBLIC
  Called with an `ITerminalTransport` when a connection is established.
- twisted.conch.insults.insults.TerminalProtocol.terminal
  twisted.conch.insults.insults.TerminalProtocol.html#terminal
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.TerminalProtocol.connectionMade
  twisted.conch.insults.insults.TerminalProtocol.html#connectionMade
  Function
  Method
  PUBLIC
  Called after a connection has been established.
- twisted.conch.insults.insults.TerminalProtocol.keystrokeReceived
  twisted.conch.insults.insults.TerminalProtocol.html#keystrokeReceived
  Function
  Method
  PUBLIC
  A keystroke was received.
- twisted.conch.insults.insults.TerminalProtocol.terminalSize
  twisted.conch.insults.insults.TerminalProtocol.html#terminalSize
  Function
  Method
  PUBLIC
  Called to indicate the size of the terminal.
- twisted.conch.insults.insults.TerminalProtocol.unhandledControlSequence
  twisted.conch.insults.insults.TerminalProtocol.html#unhandledControlSequence
  Function
  Method
  PUBLIC
  Called when an unsupported control sequence is received.
- twisted.conch.insults.insults.TerminalProtocol.connectionLost
  twisted.conch.insults.insults.TerminalProtocol.html#connectionLost
  Function
  Method
  PUBLIC
  Called when the connection has been lost.
- twisted.conch.insults.insults.ITerminalTransport
  twisted.conch.insults.insults.ITerminalTransport.html
  Class
  Interface
  PUBLIC
  No interface docstring; 41/41 methods documented
- twisted.conch.insults.insults.ITerminalTransport.cursorUp
  twisted.conch.insults.insults.ITerminalTransport.html#cursorUp
  Function
  Method
  PUBLIC
  Move the cursor up n lines.
- twisted.conch.insults.insults.ITerminalTransport.cursorDown
  twisted.conch.insults.insults.ITerminalTransport.html#cursorDown
  Function
  Method
  PUBLIC
  Move the cursor down n lines.
- twisted.conch.insults.insults.ITerminalTransport.cursorForward
  twisted.conch.insults.insults.ITerminalTransport.html#cursorForward
  Function
  Method
  PUBLIC
  Move the cursor right n columns.
- twisted.conch.insults.insults.ITerminalTransport.cursorBackward
  twisted.conch.insults.insults.ITerminalTransport.html#cursorBackward
  Function
  Method
  PUBLIC
  Move the cursor left n columns.
- twisted.conch.insults.insults.ITerminalTransport.cursorPosition
  twisted.conch.insults.insults.ITerminalTransport.html#cursorPosition
  Function
  Method
  PUBLIC
  Move the cursor to the given line and column.
- twisted.conch.insults.insults.ITerminalTransport.cursorHome
  twisted.conch.insults.insults.ITerminalTransport.html#cursorHome
  Function
  Method
  PUBLIC
  Move the cursor home.
- twisted.conch.insults.insults.ITerminalTransport.index
  twisted.conch.insults.insults.ITerminalTransport.html#index
  Function
  Method
  PUBLIC
  Move the cursor down one line, performing scrolling if necessary.
- twisted.conch.insults.insults.ITerminalTransport.reverseIndex
  twisted.conch.insults.insults.ITerminalTransport.html#reverseIndex
  Function
  Method
  PUBLIC
  Move the cursor up one line, performing scrolling if necessary.
- twisted.conch.insults.insults.ITerminalTransport.nextLine
  twisted.conch.insults.insults.ITerminalTransport.html#nextLine
  Function
  Method
  PUBLIC
  Move the cursor to the first position on the next line, performing scrolling if necessary.
- twisted.conch.insults.insults.ITerminalTransport.saveCursor
  twisted.conch.insults.insults.ITerminalTransport.html#saveCursor
  Function
  Method
  PUBLIC
  Save the cursor position, character attribute, character set, and origin mode selection.
- twisted.conch.insults.insults.ITerminalTransport.restoreCursor
  twisted.conch.insults.insults.ITerminalTransport.html#restoreCursor
  Function
  Method
  PUBLIC
  Restore the previously saved cursor position, character attribute, character set, and origin mode selection.
- twisted.conch.insults.insults.ITerminalTransport.setModes
  twisted.conch.insults.insults.ITerminalTransport.html#setModes
  Function
  Method
  PUBLIC
  Set the given modes on the terminal.
- twisted.conch.insults.insults.ITerminalTransport.resetModes
  twisted.conch.insults.insults.ITerminalTransport.html#resetModes
  Function
  Method
  PUBLIC
  Reset the given modes on the terminal.
- twisted.conch.insults.insults.ITerminalTransport.setPrivateModes
  twisted.conch.insults.insults.ITerminalTransport.html#setPrivateModes
  Function
  Method
  PUBLIC
  Set the given DEC private modes on the terminal.
- twisted.conch.insults.insults.ITerminalTransport.resetPrivateModes
  twisted.conch.insults.insults.ITerminalTransport.html#resetPrivateModes
  Function
  Method
  PUBLIC
  Reset the given DEC private modes on the terminal.
- twisted.conch.insults.insults.ITerminalTransport.applicationKeypadMode
  twisted.conch.insults.insults.ITerminalTransport.html#applicationKeypadMode
  Function
  Method
  PUBLIC
  Cause keypad to generate control functions.
- twisted.conch.insults.insults.ITerminalTransport.numericKeypadMode
  twisted.conch.insults.insults.ITerminalTransport.html#numericKeypadMode
  Function
  Method
  PUBLIC
  Cause keypad to generate normal characters.
- twisted.conch.insults.insults.ITerminalTransport.selectCharacterSet
  twisted.conch.insults.insults.ITerminalTransport.html#selectCharacterSet
  Function
  Method
  PUBLIC
  Select a character set.
- twisted.conch.insults.insults.ITerminalTransport.shiftIn
  twisted.conch.insults.insults.ITerminalTransport.html#shiftIn
  Function
  Method
  PUBLIC
  Activate the G0 character set.
- twisted.conch.insults.insults.ITerminalTransport.shiftOut
  twisted.conch.insults.insults.ITerminalTransport.html#shiftOut
  Function
  Method
  PUBLIC
  Activate the G1 character set.
- twisted.conch.insults.insults.ITerminalTransport.singleShift2
  twisted.conch.insults.insults.ITerminalTransport.html#singleShift2
  Function
  Method
  PUBLIC
  Shift to the G2 character set for a single character.
- twisted.conch.insults.insults.ITerminalTransport.singleShift3
  twisted.conch.insults.insults.ITerminalTransport.html#singleShift3
  Function
  Method
  PUBLIC
  Shift to the G3 character set for a single character.
- twisted.conch.insults.insults.ITerminalTransport.selectGraphicRendition
  twisted.conch.insults.insults.ITerminalTransport.html#selectGraphicRendition
  Function
  Method
  PUBLIC
  Enabled one or more character attributes.
- twisted.conch.insults.insults.ITerminalTransport.horizontalTabulationSet
  twisted.conch.insults.insults.ITerminalTransport.html#horizontalTabulationSet
  Function
  Method
  PUBLIC
  Set a tab stop at the current cursor position.
- twisted.conch.insults.insults.ITerminalTransport.tabulationClear
  twisted.conch.insults.insults.ITerminalTransport.html#tabulationClear
  Function
  Method
  PUBLIC
  Clear the tab stop at the current cursor position.
- twisted.conch.insults.insults.ITerminalTransport.tabulationClearAll
  twisted.conch.insults.insults.ITerminalTransport.html#tabulationClearAll
  Function
  Method
  PUBLIC
  Clear all tab stops.
- twisted.conch.insults.insults.ITerminalTransport.doubleHeightLine
  twisted.conch.insults.insults.ITerminalTransport.html#doubleHeightLine
  Function
  Method
  PUBLIC
  Make the current line the top or bottom half of a double-height, double-width line.
- twisted.conch.insults.insults.ITerminalTransport.singleWidthLine
  twisted.conch.insults.insults.ITerminalTransport.html#singleWidthLine
  Function
  Method
  PUBLIC
  Make the current line a single-width, single-height line.
- twisted.conch.insults.insults.ITerminalTransport.doubleWidthLine
  twisted.conch.insults.insults.ITerminalTransport.html#doubleWidthLine
  Function
  Method
  PUBLIC
  Make the current line a double-width line.
- twisted.conch.insults.insults.ITerminalTransport.eraseToLineEnd
  twisted.conch.insults.insults.ITerminalTransport.html#eraseToLineEnd
  Function
  Method
  PUBLIC
  Erase from the cursor to the end of line, including cursor position.
- twisted.conch.insults.insults.ITerminalTransport.eraseToLineBeginning
  twisted.conch.insults.insults.ITerminalTransport.html#eraseToLineBeginning
  Function
  Method
  PUBLIC
  Erase from the cursor to the beginning of the line, including the cursor position.
- twisted.conch.insults.insults.ITerminalTransport.eraseLine
  twisted.conch.insults.insults.ITerminalTransport.html#eraseLine
  Function
  Method
  PUBLIC
  Erase the entire cursor line.
- twisted.conch.insults.insults.ITerminalTransport.eraseToDisplayEnd
  twisted.conch.insults.insults.ITerminalTransport.html#eraseToDisplayEnd
  Function
  Method
  PUBLIC
  Erase from the cursor to the end of the display, including the cursor position.
- twisted.conch.insults.insults.ITerminalTransport.eraseToDisplayBeginning
  twisted.conch.insults.insults.ITerminalTransport.html#eraseToDisplayBeginning
  Function
  Method
  PUBLIC
  Erase from the cursor to the beginning of the display, including the cursor position.
- twisted.conch.insults.insults.ITerminalTransport.eraseDisplay
  twisted.conch.insults.insults.ITerminalTransport.html#eraseDisplay
  Function
  Method
  PUBLIC
  Erase the entire display.
- twisted.conch.insults.insults.ITerminalTransport.deleteCharacter
  twisted.conch.insults.insults.ITerminalTransport.html#deleteCharacter
  Function
  Method
  PUBLIC
  Delete n characters starting at the cursor position.
- twisted.conch.insults.insults.ITerminalTransport.insertLine
  twisted.conch.insults.insults.ITerminalTransport.html#insertLine
  Function
  Method
  PUBLIC
  Insert n lines at the cursor position.
- twisted.conch.insults.insults.ITerminalTransport.deleteLine
  twisted.conch.insults.insults.ITerminalTransport.html#deleteLine
  Function
  Method
  PUBLIC
  Delete n lines starting at the cursor position.
- twisted.conch.insults.insults.ITerminalTransport.reportCursorPosition
  twisted.conch.insults.insults.ITerminalTransport.html#reportCursorPosition
  Function
  Method
  PUBLIC
  Return a Deferred that fires with a two-tuple of (x, y) indicating the cursor position.
- twisted.conch.insults.insults.ITerminalTransport.reset
  twisted.conch.insults.insults.ITerminalTransport.html#reset
  Function
  Method
  PUBLIC
  Reset the terminal to its initial state.
- twisted.conch.insults.insults.ITerminalTransport.unhandledControlSequence
  twisted.conch.insults.insults.ITerminalTransport.html#unhandledControlSequence
  Function
  Method
  PUBLIC
  Called when an unsupported control sequence is received.
- twisted.conch.insults.insults.CSI
  twisted.conch.insults.insults.html#CSI
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.CST
  twisted.conch.insults.insults.html#CST
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.modes
  twisted.conch.insults.insults.modes.html
  Class
  Class
  PUBLIC
  ECMA 48 standardized modes
- twisted.conch.insults.insults.modes.KEYBOARD_ACTION
  twisted.conch.insults.insults.modes.html#KEYBOARD_ACTION
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.modes.KAM
  twisted.conch.insults.insults.modes.html#KAM
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.modes.INSERTION_REPLACEMENT
  twisted.conch.insults.insults.modes.html#INSERTION_REPLACEMENT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.modes.IRM
  twisted.conch.insults.insults.modes.html#IRM
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.modes.LINEFEED_NEWLINE
  twisted.conch.insults.insults.modes.html#LINEFEED_NEWLINE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.modes.LNM
  twisted.conch.insults.insults.modes.html#LNM
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.privateModes
  twisted.conch.insults.insults.privateModes.html
  Class
  Class
  PUBLIC
  ANSI-Compatible Private Modes
- twisted.conch.insults.insults.privateModes.ERROR
  twisted.conch.insults.insults.privateModes.html#ERROR
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.privateModes.CURSOR_KEY
  twisted.conch.insults.insults.privateModes.html#CURSOR_KEY
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.privateModes.ANSI_VT52
  twisted.conch.insults.insults.privateModes.html#ANSI_VT52
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.privateModes.COLUMN
  twisted.conch.insults.insults.privateModes.html#COLUMN
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.privateModes.SCROLL
  twisted.conch.insults.insults.privateModes.html#SCROLL
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.privateModes.SCREEN
  twisted.conch.insults.insults.privateModes.html#SCREEN
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.privateModes.ORIGIN
  twisted.conch.insults.insults.privateModes.html#ORIGIN
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.privateModes.AUTO_WRAP
  twisted.conch.insults.insults.privateModes.html#AUTO_WRAP
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.privateModes.AUTO_REPEAT
  twisted.conch.insults.insults.privateModes.html#AUTO_REPEAT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.privateModes.PRINTER_FORM_FEED
  twisted.conch.insults.insults.privateModes.html#PRINTER_FORM_FEED
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.privateModes.PRINTER_EXTENT
  twisted.conch.insults.insults.privateModes.html#PRINTER_EXTENT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.privateModes.CURSOR_MODE
  twisted.conch.insults.insults.privateModes.html#CURSOR_MODE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.CS_US
  twisted.conch.insults.insults.html#CS_US
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.CS_UK
  twisted.conch.insults.insults.html#CS_UK
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.CS_DRAWING
  twisted.conch.insults.insults.html#CS_DRAWING
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.CS_ALTERNATE
  twisted.conch.insults.insults.html#CS_ALTERNATE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.CS_ALTERNATE_SPECIAL
  twisted.conch.insults.insults.html#CS_ALTERNATE_SPECIAL
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.G0
  twisted.conch.insults.insults.html#G0
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.G1
  twisted.conch.insults.insults.html#G1
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.G2
  twisted.conch.insults.insults.html#G2
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.G3
  twisted.conch.insults.insults.html#G3
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.NORMAL
  twisted.conch.insults.insults.html#NORMAL
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.BOLD
  twisted.conch.insults.insults.html#BOLD
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.UNDERLINE
  twisted.conch.insults.insults.html#UNDERLINE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.BLINK
  twisted.conch.insults.insults.html#BLINK
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.REVERSE_VIDEO
  twisted.conch.insults.insults.html#REVERSE_VIDEO
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.Vector
  twisted.conch.insults.insults.Vector.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.Vector.__init__
  twisted.conch.insults.insults.Vector.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.Vector.x
  twisted.conch.insults.insults.Vector.html#x
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.Vector.y
  twisted.conch.insults.insults.Vector.html#y
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.log
  twisted.conch.insults.insults.html#log
  Function
  Function
  PUBLIC
  Undocumented
- twisted.conch.insults.insults._KEY_NAMES
  twisted.conch.insults.insults.html#_KEY_NAMES
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.conch.insults.insults._const
  twisted.conch.insults.insults._const.html
  Class
  Class
  PRIVATE
  No summary
- twisted.conch.insults.insults._const.name
  twisted.conch.insults.insults._const.html#name
  Attribute
  Instance Variable
  PUBLIC
  A string naming this constant
- twisted.conch.insults.insults._const.__init__
  twisted.conch.insults.insults._const.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.insults._const.__repr__
  twisted.conch.insults.insults._const.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.insults._const.__bytes__
  twisted.conch.insults.insults._const.html#__bytes__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.FUNCTION_KEYS
  twisted.conch.insults.insults.html#FUNCTION_KEYS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.ServerProtocol
  twisted.conch.insults.insults.ServerProtocol.html
  Class
  Class
  PUBLIC
  No class docstring; 0/9 instance variable, 0/4 class variable, 0/2 constant, 1/55 method, 0/1 class documented
- twisted.conch.insults.insults.ServerProtocol.protocolFactory
  twisted.conch.insults.insults.ServerProtocol.html#protocolFactory
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.ServerProtocol.terminalProtocol
  twisted.conch.insults.insults.ServerProtocol.html#terminalProtocol
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.ServerProtocol.TAB
  twisted.conch.insults.insults.ServerProtocol.html#TAB
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.ServerProtocol.BACKSPACE
  twisted.conch.insults.insults.ServerProtocol.html#BACKSPACE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.ServerProtocol.lastWrite
  twisted.conch.insults.insults.ServerProtocol.html#lastWrite
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.ServerProtocol.state
  twisted.conch.insults.insults.ServerProtocol.html#state
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.ServerProtocol.termSize
  twisted.conch.insults.insults.ServerProtocol.html#termSize
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.ServerProtocol.cursorPos
  twisted.conch.insults.insults.ServerProtocol.html#cursorPos
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.ServerProtocol.scrollRegion
  twisted.conch.insults.insults.ServerProtocol.html#scrollRegion
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.ServerProtocol.factory
  twisted.conch.insults.insults.ServerProtocol.html#factory
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.ServerProtocol.__init__
  twisted.conch.insults.insults.ServerProtocol.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.conch.insults.insults.ServerProtocol.protocolArgs
  twisted.conch.insults.insults.ServerProtocol.html#protocolArgs
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.ServerProtocol.protocolKwArgs
  twisted.conch.insults.insults.ServerProtocol.html#protocolKwArgs
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.ServerProtocol._cursorReports
  twisted.conch.insults.insults.ServerProtocol.html#_cursorReports
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.conch.insults.insults.ServerProtocol.getHost
  twisted.conch.insults.insults.ServerProtocol.html#getHost
  Function
  Method
  PUBLIC
  Similar to getPeer, but returns an address describing this side of the connection.
- twisted.conch.insults.insults.ServerProtocol.getPeer
  twisted.conch.insults.insults.ServerProtocol.html#getPeer
  Function
  Method
  PUBLIC
  Get the remote address of this connection.
- twisted.conch.insults.insults.ServerProtocol.connectionMade
  twisted.conch.insults.insults.ServerProtocol.html#connectionMade
  Function
  Method
  PUBLIC
  Called when a connection is made.
- twisted.conch.insults.insults.ServerProtocol.dataReceived
  twisted.conch.insults.insults.ServerProtocol.html#dataReceived
  Function
  Method
  PUBLIC
  Called whenever data is received.
- twisted.conch.insults.insults.ServerProtocol._handleShortControlSequence
  twisted.conch.insults.insults.ServerProtocol.html#_handleShortControlSequence
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.insults.insults.ServerProtocol._handleControlSequence
  twisted.conch.insults.insults.ServerProtocol.html#_handleControlSequence
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.insults.insults.ServerProtocol.unhandledControlSequence
  twisted.conch.insults.insults.ServerProtocol.html#unhandledControlSequence
  Function
  Method
  PUBLIC
  Called when an unsupported control sequence is received.
- twisted.conch.insults.insults.ServerProtocol._handleLowFunctionControlSequence
  twisted.conch.insults.insults.ServerProtocol.html#_handleLowFunctionControlSequence
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.insults.insults.ServerProtocol.ControlSequenceParser
  twisted.conch.insults.insults.ServerProtocol.ControlSequenceParser.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.ServerProtocol.ControlSequenceParser.A
  twisted.conch.insults.insults.ServerProtocol.ControlSequenceParser.html#A
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.ServerProtocol.ControlSequenceParser.B
  twisted.conch.insults.insults.ServerProtocol.ControlSequenceParser.html#B
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.ServerProtocol.ControlSequenceParser.C
  twisted.conch.insults.insults.ServerProtocol.ControlSequenceParser.html#C
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.ServerProtocol.ControlSequenceParser.D
  twisted.conch.insults.insults.ServerProtocol.ControlSequenceParser.html#D
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.ServerProtocol.ControlSequenceParser.E
  twisted.conch.insults.insults.ServerProtocol.ControlSequenceParser.html#E
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.ServerProtocol.ControlSequenceParser.F
  twisted.conch.insults.insults.ServerProtocol.ControlSequenceParser.html#F
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.ServerProtocol.ControlSequenceParser.H
  twisted.conch.insults.insults.ServerProtocol.ControlSequenceParser.html#H
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.ServerProtocol.ControlSequenceParser.R
  twisted.conch.insults.insults.ServerProtocol.ControlSequenceParser.html#R
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.ServerProtocol.ControlSequenceParser.Z
  twisted.conch.insults.insults.ServerProtocol.ControlSequenceParser.html#Z
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.ServerProtocol.ControlSequenceParser.tilde
  twisted.conch.insults.insults.ServerProtocol.ControlSequenceParser.html#tilde
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.ServerProtocol.controlSequenceParser
  twisted.conch.insults.insults.ServerProtocol.html#controlSequenceParser
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.ServerProtocol.cursorUp
  twisted.conch.insults.insults.ServerProtocol.html#cursorUp
  Function
  Method
  PUBLIC
  Move the cursor up n lines.
- twisted.conch.insults.insults.ServerProtocol.cursorDown
  twisted.conch.insults.insults.ServerProtocol.html#cursorDown
  Function
  Method
  PUBLIC
  Move the cursor down n lines.
- twisted.conch.insults.insults.ServerProtocol.cursorForward
  twisted.conch.insults.insults.ServerProtocol.html#cursorForward
  Function
  Method
  PUBLIC
  Move the cursor right n columns.
- twisted.conch.insults.insults.ServerProtocol.cursorBackward
  twisted.conch.insults.insults.ServerProtocol.html#cursorBackward
  Function
  Method
  PUBLIC
  Move the cursor left n columns.
- twisted.conch.insults.insults.ServerProtocol.cursorPosition
  twisted.conch.insults.insults.ServerProtocol.html#cursorPosition
  Function
  Method
  PUBLIC
  Move the cursor to the given line and column.
- twisted.conch.insults.insults.ServerProtocol.cursorHome
  twisted.conch.insults.insults.ServerProtocol.html#cursorHome
  Function
  Method
  PUBLIC
  Move the cursor home.
- twisted.conch.insults.insults.ServerProtocol.index
  twisted.conch.insults.insults.ServerProtocol.html#index
  Function
  Method
  PUBLIC
  Move the cursor down one line, performing scrolling if necessary.
- twisted.conch.insults.insults.ServerProtocol.reverseIndex
  twisted.conch.insults.insults.ServerProtocol.html#reverseIndex
  Function
  Method
  PUBLIC
  Move the cursor up one line, performing scrolling if necessary.
- twisted.conch.insults.insults.ServerProtocol.nextLine
  twisted.conch.insults.insults.ServerProtocol.html#nextLine
  Function
  Method
  PUBLIC
  Move the cursor to the first position on the next line, performing scrolling if necessary.
- twisted.conch.insults.insults.ServerProtocol.saveCursor
  twisted.conch.insults.insults.ServerProtocol.html#saveCursor
  Function
  Method
  PUBLIC
  Save the cursor position, character attribute, character set, and origin mode selection.
- twisted.conch.insults.insults.ServerProtocol._savedCursorPos
  twisted.conch.insults.insults.ServerProtocol.html#_savedCursorPos
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.conch.insults.insults.ServerProtocol.restoreCursor
  twisted.conch.insults.insults.ServerProtocol.html#restoreCursor
  Function
  Method
  PUBLIC
  Restore the previously saved cursor position, character attribute, character set, and origin mode selection.
- twisted.conch.insults.insults.ServerProtocol.setModes
  twisted.conch.insults.insults.ServerProtocol.html#setModes
  Function
  Method
  PUBLIC
  Set the given modes on the terminal.
- twisted.conch.insults.insults.ServerProtocol.setPrivateModes
  twisted.conch.insults.insults.ServerProtocol.html#setPrivateModes
  Function
  Method
  PUBLIC
  Set the given DEC private modes on the terminal.
- twisted.conch.insults.insults.ServerProtocol.resetModes
  twisted.conch.insults.insults.ServerProtocol.html#resetModes
  Function
  Method
  PUBLIC
  Reset the given modes on the terminal.
- twisted.conch.insults.insults.ServerProtocol.resetPrivateModes
  twisted.conch.insults.insults.ServerProtocol.html#resetPrivateModes
  Function
  Method
  PUBLIC
  Reset the given DEC private modes on the terminal.
- twisted.conch.insults.insults.ServerProtocol.applicationKeypadMode
  twisted.conch.insults.insults.ServerProtocol.html#applicationKeypadMode
  Function
  Method
  PUBLIC
  Cause keypad to generate control functions.
- twisted.conch.insults.insults.ServerProtocol.numericKeypadMode
  twisted.conch.insults.insults.ServerProtocol.html#numericKeypadMode
  Function
  Method
  PUBLIC
  Cause keypad to generate normal characters.
- twisted.conch.insults.insults.ServerProtocol.selectCharacterSet
  twisted.conch.insults.insults.ServerProtocol.html#selectCharacterSet
  Function
  Method
  PUBLIC
  Select a character set.
- twisted.conch.insults.insults.ServerProtocol.shiftIn
  twisted.conch.insults.insults.ServerProtocol.html#shiftIn
  Function
  Method
  PUBLIC
  Activate the G0 character set.
- twisted.conch.insults.insults.ServerProtocol.shiftOut
  twisted.conch.insults.insults.ServerProtocol.html#shiftOut
  Function
  Method
  PUBLIC
  Activate the G1 character set.
- twisted.conch.insults.insults.ServerProtocol.singleShift2
  twisted.conch.insults.insults.ServerProtocol.html#singleShift2
  Function
  Method
  PUBLIC
  Shift to the G2 character set for a single character.
- twisted.conch.insults.insults.ServerProtocol.singleShift3
  twisted.conch.insults.insults.ServerProtocol.html#singleShift3
  Function
  Method
  PUBLIC
  Shift to the G3 character set for a single character.
- twisted.conch.insults.insults.ServerProtocol.selectGraphicRendition
  twisted.conch.insults.insults.ServerProtocol.html#selectGraphicRendition
  Function
  Method
  PUBLIC
  Enabled one or more character attributes.
- twisted.conch.insults.insults.ServerProtocol.horizontalTabulationSet
  twisted.conch.insults.insults.ServerProtocol.html#horizontalTabulationSet
  Function
  Method
  PUBLIC
  Set a tab stop at the current cursor position.
- twisted.conch.insults.insults.ServerProtocol.tabulationClear
  twisted.conch.insults.insults.ServerProtocol.html#tabulationClear
  Function
  Method
  PUBLIC
  Clear the tab stop at the current cursor position.
- twisted.conch.insults.insults.ServerProtocol.tabulationClearAll
  twisted.conch.insults.insults.ServerProtocol.html#tabulationClearAll
  Function
  Method
  PUBLIC
  Clear all tab stops.
- twisted.conch.insults.insults.ServerProtocol.doubleHeightLine
  twisted.conch.insults.insults.ServerProtocol.html#doubleHeightLine
  Function
  Method
  PUBLIC
  Make the current line the top or bottom half of a double-height, double-width line.
- twisted.conch.insults.insults.ServerProtocol.singleWidthLine
  twisted.conch.insults.insults.ServerProtocol.html#singleWidthLine
  Function
  Method
  PUBLIC
  Make the current line a single-width, single-height line.
- twisted.conch.insults.insults.ServerProtocol.doubleWidthLine
  twisted.conch.insults.insults.ServerProtocol.html#doubleWidthLine
  Function
  Method
  PUBLIC
  Make the current line a double-width line.
- twisted.conch.insults.insults.ServerProtocol.eraseToLineEnd
  twisted.conch.insults.insults.ServerProtocol.html#eraseToLineEnd
  Function
  Method
  PUBLIC
  Erase from the cursor to the end of line, including cursor position.
- twisted.conch.insults.insults.ServerProtocol.eraseToLineBeginning
  twisted.conch.insults.insults.ServerProtocol.html#eraseToLineBeginning
  Function
  Method
  PUBLIC
  Erase from the cursor to the beginning of the line, including the cursor position.
- twisted.conch.insults.insults.ServerProtocol.eraseLine
  twisted.conch.insults.insults.ServerProtocol.html#eraseLine
  Function
  Method
  PUBLIC
  Erase the entire cursor line.
- twisted.conch.insults.insults.ServerProtocol.eraseToDisplayEnd
  twisted.conch.insults.insults.ServerProtocol.html#eraseToDisplayEnd
  Function
  Method
  PUBLIC
  Erase from the cursor to the end of the display, including the cursor position.
- twisted.conch.insults.insults.ServerProtocol.eraseToDisplayBeginning
  twisted.conch.insults.insults.ServerProtocol.html#eraseToDisplayBeginning
  Function
  Method
  PUBLIC
  Erase from the cursor to the beginning of the display, including the cursor position.
- twisted.conch.insults.insults.ServerProtocol.eraseDisplay
  twisted.conch.insults.insults.ServerProtocol.html#eraseDisplay
  Function
  Method
  PUBLIC
  Erase the entire display.
- twisted.conch.insults.insults.ServerProtocol.deleteCharacter
  twisted.conch.insults.insults.ServerProtocol.html#deleteCharacter
  Function
  Method
  PUBLIC
  Delete n characters starting at the cursor position.
- twisted.conch.insults.insults.ServerProtocol.insertLine
  twisted.conch.insults.insults.ServerProtocol.html#insertLine
  Function
  Method
  PUBLIC
  Insert n lines at the cursor position.
- twisted.conch.insults.insults.ServerProtocol.deleteLine
  twisted.conch.insults.insults.ServerProtocol.html#deleteLine
  Function
  Method
  PUBLIC
  Delete n lines starting at the cursor position.
- twisted.conch.insults.insults.ServerProtocol.setScrollRegion
  twisted.conch.insults.insults.ServerProtocol.html#setScrollRegion
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.ServerProtocol.resetScrollRegion
  twisted.conch.insults.insults.ServerProtocol.html#resetScrollRegion
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.ServerProtocol.reportCursorPosition
  twisted.conch.insults.insults.ServerProtocol.html#reportCursorPosition
  Function
  Method
  PUBLIC
  Return a Deferred that fires with a two-tuple of (x, y) indicating the cursor position.
- twisted.conch.insults.insults.ServerProtocol.reset
  twisted.conch.insults.insults.ServerProtocol.html#reset
  Function
  Method
  PUBLIC
  Reset the terminal to its initial state.
- twisted.conch.insults.insults.ServerProtocol.write
  twisted.conch.insults.insults.ServerProtocol.html#write
  Function
  Method
  PUBLIC
  Write some data to the physical connection, in sequence, in a non-blocking fashion.
- twisted.conch.insults.insults.ServerProtocol.writeSequence
  twisted.conch.insults.insults.ServerProtocol.html#writeSequence
  Function
  Method
  PUBLIC
  Write an iterable of byte strings to the physical connection.
- twisted.conch.insults.insults.ServerProtocol.loseConnection
  twisted.conch.insults.insults.ServerProtocol.html#loseConnection
  Function
  Method
  PUBLIC
  Close my connection, after writing all pending data.
- twisted.conch.insults.insults.ServerProtocol.connectionLost
  twisted.conch.insults.insults.ServerProtocol.html#connectionLost
  Function
  Method
  PUBLIC
  Called when the connection is shut down.
- twisted.conch.insults.insults.ClientProtocol
  twisted.conch.insults.insults.ClientProtocol.html
  Class
  Class
  PUBLIC
  No class docstring; 0/5 instance variable, 0/6 class variable, 2/6 methods, 0/1 class documented
- twisted.conch.insults.insults.ClientProtocol.terminalFactory
  twisted.conch.insults.insults.ClientProtocol.html#terminalFactory
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.ClientProtocol.terminal
  twisted.conch.insults.insults.ClientProtocol.html#terminal
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.ClientProtocol.state
  twisted.conch.insults.insults.ClientProtocol.html#state
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.ClientProtocol._escBuf
  twisted.conch.insults.insults.ClientProtocol.html#_escBuf
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.conch.insults.insults.ClientProtocol._shorts
  twisted.conch.insults.insults.ClientProtocol.html#_shorts
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.conch.insults.insults.ClientProtocol._longs
  twisted.conch.insults.insults.ClientProtocol.html#_longs
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.conch.insults.insults.ClientProtocol._charsets
  twisted.conch.insults.insults.ClientProtocol.html#_charsets
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.conch.insults.insults.ClientProtocol.factory
  twisted.conch.insults.insults.ClientProtocol.html#factory
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.ClientProtocol.__init__
  twisted.conch.insults.insults.ClientProtocol.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.conch.insults.insults.ClientProtocol.terminalArgs
  twisted.conch.insults.insults.ClientProtocol.html#terminalArgs
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.ClientProtocol.terminalKwArgs
  twisted.conch.insults.insults.ClientProtocol.html#terminalKwArgs
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.ClientProtocol.connectionMade
  twisted.conch.insults.insults.ClientProtocol.html#connectionMade
  Function
  Method
  PUBLIC
  Called when a connection is made.
- twisted.conch.insults.insults.ClientProtocol.connectionLost
  twisted.conch.insults.insults.ClientProtocol.html#connectionLost
  Function
  Method
  PUBLIC
  Called when the connection is shut down.
- twisted.conch.insults.insults.ClientProtocol.dataReceived
  twisted.conch.insults.insults.ClientProtocol.html#dataReceived
  Function
  Method
  PUBLIC
  Parse the given data from a terminal server, dispatching to event handlers defined by `self.terminal`.
- twisted.conch.insults.insults.ClientProtocol._handleControlSequence
  twisted.conch.insults.insults.ClientProtocol.html#_handleControlSequence
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.insults.insults.ClientProtocol.ControlSequenceParser
  twisted.conch.insults.insults.ClientProtocol.ControlSequenceParser.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.ClientProtocol.ControlSequenceParser._makeSimple
  twisted.conch.insults.insults.ClientProtocol.ControlSequenceParser.html#_makeSimple
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.insults.insults.ClientProtocol.ControlSequenceParser.h
  twisted.conch.insults.insults.ClientProtocol.ControlSequenceParser.html#h
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.ClientProtocol.ControlSequenceParser.l
  twisted.conch.insults.insults.ClientProtocol.ControlSequenceParser.html#l
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.ClientProtocol.ControlSequenceParser.r
  twisted.conch.insults.insults.ClientProtocol.ControlSequenceParser.html#r
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.ClientProtocol.ControlSequenceParser.K
  twisted.conch.insults.insults.ClientProtocol.ControlSequenceParser.html#K
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.ClientProtocol.ControlSequenceParser.H
  twisted.conch.insults.insults.ClientProtocol.ControlSequenceParser.html#H
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.ClientProtocol.ControlSequenceParser.J
  twisted.conch.insults.insults.ClientProtocol.ControlSequenceParser.html#J
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.ClientProtocol.ControlSequenceParser.P
  twisted.conch.insults.insults.ClientProtocol.ControlSequenceParser.html#P
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.ClientProtocol.ControlSequenceParser.L
  twisted.conch.insults.insults.ClientProtocol.ControlSequenceParser.html#L
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.ClientProtocol.ControlSequenceParser.M
  twisted.conch.insults.insults.ClientProtocol.ControlSequenceParser.html#M
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.ClientProtocol.ControlSequenceParser.n
  twisted.conch.insults.insults.ClientProtocol.ControlSequenceParser.html#n
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.ClientProtocol.ControlSequenceParser.m
  twisted.conch.insults.insults.ClientProtocol.ControlSequenceParser.html#m
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.ClientProtocol.controlSequenceParser
  twisted.conch.insults.insults.ClientProtocol.html#controlSequenceParser
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.insults.ClientProtocol._handleHeightWidth
  twisted.conch.insults.insults.ClientProtocol.html#_handleHeightWidth
  Function
  Method
  PRIVATE
  Undocumented
- twisted.python._textattributes._Attribute
  twisted.python._textattributes._Attribute.html
  Class
  Class
  PRIVATE
  A text attribute.
- twisted.python._textattributes._Attribute.children
  twisted.python._textattributes._Attribute.html#children
  Attribute
  Instance Variable
  PUBLIC
  Child attributes.
- twisted.python._textattributes._Attribute.compareAttributes
  twisted.python._textattributes._Attribute.html#compareAttributes
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.python._textattributes._Attribute.__init__
  twisted.python._textattributes._Attribute.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python._textattributes._Attribute.__repr__
  twisted.python._textattributes._Attribute.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python._textattributes._Attribute.__getitem__
  twisted.python._textattributes._Attribute.html#__getitem__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python._textattributes._Attribute.serialize
  twisted.python._textattributes._Attribute.html#serialize
  Function
  Method
  PUBLIC
  Serialize the text attribute and its children.
- twisted.python._textattributes._NormalAttr
  twisted.python._textattributes._NormalAttr.html
  Class
  Class
  PRIVATE
  A text attribute for normal text.
- twisted.python._textattributes._NormalAttr.serialize
  twisted.python._textattributes._NormalAttr.html#serialize
  Function
  Method
  PUBLIC
  Serialize the text attribute and its children.
- twisted.python._textattributes._OtherAttr
  twisted.python._textattributes._OtherAttr.html
  Class
  Class
  PRIVATE
  A text attribute for text with formatting attributes.
- twisted.python._textattributes._OtherAttr.attrname
  twisted.python._textattributes._OtherAttr.html#attrname
  Attribute
  Instance Variable
  PUBLIC
  Text attribute name.
- twisted.python._textattributes._OtherAttr.attrvalue
  twisted.python._textattributes._OtherAttr.html#attrvalue
  Attribute
  Instance Variable
  PUBLIC
  Text attribute value.
- twisted.python._textattributes._OtherAttr.compareAttributes
  twisted.python._textattributes._OtherAttr.html#compareAttributes
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.python._textattributes._OtherAttr.__init__
  twisted.python._textattributes._OtherAttr.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python._textattributes._OtherAttr.__neg__
  twisted.python._textattributes._OtherAttr.html#__neg__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python._textattributes._OtherAttr.serialize
  twisted.python._textattributes._OtherAttr.html#serialize
  Function
  Method
  PUBLIC
  Serialize the text attribute and its children.
- twisted.python._textattributes._ColorAttr
  twisted.python._textattributes._ColorAttr.html
  Class
  Class
  PRIVATE
  Generic color attribute.
- twisted.python._textattributes._ColorAttr.compareAttributes
  twisted.python._textattributes._ColorAttr.html#compareAttributes
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.python._textattributes._ColorAttr.__init__
  twisted.python._textattributes._ColorAttr.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python._textattributes._ColorAttr.color
  twisted.python._textattributes._ColorAttr.html#color
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python._textattributes._ColorAttr.ground
  twisted.python._textattributes._ColorAttr.html#ground
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python._textattributes._ColorAttr.serialize
  twisted.python._textattributes._ColorAttr.html#serialize
  Function
  Method
  PUBLIC
  Serialize the text attribute and its children.
- twisted.python._textattributes._ForegroundColorAttr
  twisted.python._textattributes._ForegroundColorAttr.html
  Class
  Class
  PRIVATE
  Foreground color attribute.
- twisted.python._textattributes._ForegroundColorAttr.__init__
  twisted.python._textattributes._ForegroundColorAttr.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python._textattributes._BackgroundColorAttr
  twisted.python._textattributes._BackgroundColorAttr.html
  Class
  Class
  PRIVATE
  Background color attribute.
- twisted.python._textattributes._BackgroundColorAttr.__init__
  twisted.python._textattributes._BackgroundColorAttr.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python._textattributes._ColorAttribute
  twisted.python._textattributes._ColorAttribute.html
  Class
  Class
  PRIVATE
  A color text attribute.
- twisted.python._textattributes._ColorAttribute.ground
  twisted.python._textattributes._ColorAttribute.html#ground
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python._textattributes._ColorAttribute.attrs
  twisted.python._textattributes._ColorAttribute.html#attrs
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python._textattributes._ColorAttribute.__init__
  twisted.python._textattributes._ColorAttribute.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python._textattributes._ColorAttribute.__getattr__
  twisted.python._textattributes._ColorAttribute.html#__getattr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python._textattributes.CharacterAttributesMixin
  twisted.python._textattributes.CharacterAttributesMixin.html
  Class
  Class
  PUBLIC
  Mixin for character attributes that implements a `__getattr__` method returning a new `_NormalAttr` instance when attempting to access a `'normal'` attribute; otherwise a new `_OtherAttr` instance is returned for names that appears in the ...
- twisted.python._textattributes.CharacterAttributesMixin.__getattr__
  twisted.python._textattributes.CharacterAttributesMixin.html#__getattr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python._textattributes.DefaultFormattingState
  twisted.python._textattributes.DefaultFormattingState.html
  Class
  Class
  PUBLIC
  A character attribute that does nothing, thus applying no attributes to text.
- twisted.python._textattributes.DefaultFormattingState.compareAttributes
  twisted.python._textattributes.DefaultFormattingState.html#compareAttributes
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.python._textattributes.DefaultFormattingState._dummy
  twisted.python._textattributes.DefaultFormattingState.html#_dummy
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.python._textattributes.DefaultFormattingState.copy
  twisted.python._textattributes.DefaultFormattingState.html#copy
  Function
  Method
  PUBLIC
  Make a copy of this formatting state.
- twisted.python._textattributes.DefaultFormattingState._withAttribute
  twisted.python._textattributes.DefaultFormattingState.html#_withAttribute
  Function
  Method
  PRIVATE
  Add a character attribute to a copy of this formatting state.
- twisted.python._textattributes.DefaultFormattingState.toVT102
  twisted.python._textattributes.DefaultFormattingState.html#toVT102
  Function
  Method
  PUBLIC
  Emit a VT102 control sequence that will set up all the attributes this formatting state has set.
- twisted.python._textattributes._FormattingStateMixin
  twisted.python._textattributes._FormattingStateMixin.html
  Class
  Class
  PRIVATE
  Mixin for the formatting state/attributes of a single character.
- twisted.python._textattributes._FormattingStateMixin.copy
  twisted.python._textattributes._FormattingStateMixin.html#copy
  Function
  Method
  PUBLIC
  Make a copy of this formatting state.
- twisted.python._textattributes._FormattingStateMixin._withAttribute
  twisted.python._textattributes._FormattingStateMixin.html#_withAttribute
  Function
  Method
  PRIVATE
  Add a character attribute to a copy of this formatting state.
- twisted.python._textattributes.flatten
  twisted.python._textattributes.html#flatten
  Function
  Function
  PUBLIC
  Serialize a sequence of characters with attribute information
- twisted.conch.insults.helper.FOREGROUND
  twisted.conch.insults.helper.html#FOREGROUND
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.insults.helper.BACKGROUND
  twisted.conch.insults.helper.html#BACKGROUND
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.insults.helper.BLACK
  twisted.conch.insults.helper.html#BLACK
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.insults.helper.RED
  twisted.conch.insults.helper.html#RED
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.insults.helper.GREEN
  twisted.conch.insults.helper.html#GREEN
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.insults.helper.YELLOW
  twisted.conch.insults.helper.html#YELLOW
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.insults.helper.BLUE
  twisted.conch.insults.helper.html#BLUE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.insults.helper.MAGENTA
  twisted.conch.insults.helper.html#MAGENTA
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.insults.helper.CYAN
  twisted.conch.insults.helper.html#CYAN
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.insults.helper.WHITE
  twisted.conch.insults.helper.html#WHITE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.insults.helper.N_COLORS
  twisted.conch.insults.helper.html#N_COLORS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.insults.helper._FormattingState
  twisted.conch.insults.helper._FormattingState.html
  Class
  Class
  PRIVATE
  Represents the formatting state/attributes of a single character.
- twisted.conch.insults.helper._FormattingState.compareAttributes
  twisted.conch.insults.helper._FormattingState.html#compareAttributes
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.helper._FormattingState.__init__
  twisted.conch.insults.helper._FormattingState.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.helper._FormattingState.charset
  twisted.conch.insults.helper._FormattingState.html#charset
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.helper._FormattingState.bold
  twisted.conch.insults.helper._FormattingState.html#bold
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.helper._FormattingState.underline
  twisted.conch.insults.helper._FormattingState.html#underline
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.helper._FormattingState.blink
  twisted.conch.insults.helper._FormattingState.html#blink
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.helper._FormattingState.reverseVideo
  twisted.conch.insults.helper._FormattingState.html#reverseVideo
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.helper._FormattingState.foreground
  twisted.conch.insults.helper._FormattingState.html#foreground
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.helper._FormattingState.background
  twisted.conch.insults.helper._FormattingState.html#background
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.helper._FormattingState._subtracting
  twisted.conch.insults.helper._FormattingState.html#_subtracting
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.conch.insults.helper._FormattingState.wantOne
  twisted.conch.insults.helper._FormattingState.html#wantOne
  Function
  Method
  PUBLIC
  Add a character attribute to a copy of this formatting state.
- twisted.conch.insults.helper._FormattingState.toVT102
  twisted.conch.insults.helper._FormattingState.html#toVT102
  Function
  Method
  PUBLIC
  Emit a VT102 control sequence that will set up all the attributes this formatting state has set.
- twisted.conch.insults.helper.TerminalBuffer
  twisted.conch.insults.helper.TerminalBuffer.html
  Class
  Class
  PUBLIC
  An in-memory terminal emulator.
- twisted.conch.insults.helper.TerminalBuffer.execBytes
  twisted.conch.insults.helper.TerminalBuffer.html#execBytes
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.helper.TerminalBuffer.execStr
  twisted.conch.insults.helper.TerminalBuffer.html#execStr
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.helper.TerminalBuffer.TAB
  twisted.conch.insults.helper.TerminalBuffer.html#TAB
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.insults.helper.TerminalBuffer.BACKSPACE
  twisted.conch.insults.helper.TerminalBuffer.html#BACKSPACE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.insults.helper.TerminalBuffer.width
  twisted.conch.insults.helper.TerminalBuffer.html#width
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.helper.TerminalBuffer.height
  twisted.conch.insults.helper.TerminalBuffer.html#height
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.helper.TerminalBuffer.fill
  twisted.conch.insults.helper.TerminalBuffer.html#fill
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.helper.TerminalBuffer.void
  twisted.conch.insults.helper.TerminalBuffer.html#void
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.helper.TerminalBuffer._log
  twisted.conch.insults.helper.TerminalBuffer.html#_log
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.conch.insults.helper.TerminalBuffer.getCharacter
  twisted.conch.insults.helper.TerminalBuffer.html#getCharacter
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.helper.TerminalBuffer.connectionMade
  twisted.conch.insults.helper.TerminalBuffer.html#connectionMade
  Function
  Method
  PUBLIC
  Called when a connection is made.
- twisted.conch.insults.helper.TerminalBuffer.write
  twisted.conch.insults.helper.TerminalBuffer.html#write
  Function
  Method
  PUBLIC
  Add the given printable bytes to the terminal.
- twisted.conch.insults.helper.TerminalBuffer._currentFormattingState
  twisted.conch.insults.helper.TerminalBuffer.html#_currentFormattingState
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.insults.helper.TerminalBuffer.insertAtCursor
  twisted.conch.insults.helper.TerminalBuffer.html#insertAtCursor
  Function
  Method
  PUBLIC
  Add one byte to the terminal at the cursor and make consequent state updates.
- twisted.conch.insults.helper.TerminalBuffer.x
  twisted.conch.insults.helper.TerminalBuffer.html#x
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.helper.TerminalBuffer._emptyLine
  twisted.conch.insults.helper.TerminalBuffer.html#_emptyLine
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.insults.helper.TerminalBuffer._scrollDown
  twisted.conch.insults.helper.TerminalBuffer.html#_scrollDown
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.insults.helper.TerminalBuffer._scrollUp
  twisted.conch.insults.helper.TerminalBuffer.html#_scrollUp
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.insults.helper.TerminalBuffer.y
  twisted.conch.insults.helper.TerminalBuffer.html#y
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.helper.TerminalBuffer.cursorUp
  twisted.conch.insults.helper.TerminalBuffer.html#cursorUp
  Function
  Method
  PUBLIC
  Move the cursor up n lines.
- twisted.conch.insults.helper.TerminalBuffer.cursorDown
  twisted.conch.insults.helper.TerminalBuffer.html#cursorDown
  Function
  Method
  PUBLIC
  Move the cursor down n lines.
- twisted.conch.insults.helper.TerminalBuffer.cursorBackward
  twisted.conch.insults.helper.TerminalBuffer.html#cursorBackward
  Function
  Method
  PUBLIC
  Move the cursor left n columns.
- twisted.conch.insults.helper.TerminalBuffer.cursorForward
  twisted.conch.insults.helper.TerminalBuffer.html#cursorForward
  Function
  Method
  PUBLIC
  Move the cursor right n columns.
- twisted.conch.insults.helper.TerminalBuffer.cursorPosition
  twisted.conch.insults.helper.TerminalBuffer.html#cursorPosition
  Function
  Method
  PUBLIC
  Move the cursor to the given line and column.
- twisted.conch.insults.helper.TerminalBuffer.cursorHome
  twisted.conch.insults.helper.TerminalBuffer.html#cursorHome
  Function
  Method
  PUBLIC
  Move the cursor home.
- twisted.conch.insults.helper.TerminalBuffer.index
  twisted.conch.insults.helper.TerminalBuffer.html#index
  Function
  Method
  PUBLIC
  Move the cursor down one line, performing scrolling if necessary.
- twisted.conch.insults.helper.TerminalBuffer.reverseIndex
  twisted.conch.insults.helper.TerminalBuffer.html#reverseIndex
  Function
  Method
  PUBLIC
  Move the cursor up one line, performing scrolling if necessary.
- twisted.conch.insults.helper.TerminalBuffer.nextLine
  twisted.conch.insults.helper.TerminalBuffer.html#nextLine
  Function
  Method
  PUBLIC
  Update the cursor position attributes and scroll down if appropriate.
- twisted.conch.insults.helper.TerminalBuffer.saveCursor
  twisted.conch.insults.helper.TerminalBuffer.html#saveCursor
  Function
  Method
  PUBLIC
  Save the cursor position, character attribute, character set, and origin mode selection.
- twisted.conch.insults.helper.TerminalBuffer._savedCursor
  twisted.conch.insults.helper.TerminalBuffer.html#_savedCursor
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.conch.insults.helper.TerminalBuffer.restoreCursor
  twisted.conch.insults.helper.TerminalBuffer.html#restoreCursor
  Function
  Method
  PUBLIC
  Restore the previously saved cursor position, character attribute, character set, and origin mode selection.
- twisted.conch.insults.helper.TerminalBuffer.setModes
  twisted.conch.insults.helper.TerminalBuffer.html#setModes
  Function
  Method
  PUBLIC
  Set the given modes on the terminal.
- twisted.conch.insults.helper.TerminalBuffer.resetModes
  twisted.conch.insults.helper.TerminalBuffer.html#resetModes
  Function
  Method
  PUBLIC
  Reset the given modes on the terminal.
- twisted.conch.insults.helper.TerminalBuffer.setPrivateModes
  twisted.conch.insults.helper.TerminalBuffer.html#setPrivateModes
  Function
  Method
  PUBLIC
  Enable the given modes.
- twisted.conch.insults.helper.TerminalBuffer.resetPrivateModes
  twisted.conch.insults.helper.TerminalBuffer.html#resetPrivateModes
  Function
  Method
  PUBLIC
  Disable the given modes.
- twisted.conch.insults.helper.TerminalBuffer.applicationKeypadMode
  twisted.conch.insults.helper.TerminalBuffer.html#applicationKeypadMode
  Function
  Method
  PUBLIC
  Cause keypad to generate control functions.
- twisted.conch.insults.helper.TerminalBuffer.keypadMode
  twisted.conch.insults.helper.TerminalBuffer.html#keypadMode
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.helper.TerminalBuffer.numericKeypadMode
  twisted.conch.insults.helper.TerminalBuffer.html#numericKeypadMode
  Function
  Method
  PUBLIC
  Cause keypad to generate normal characters.
- twisted.conch.insults.helper.TerminalBuffer.selectCharacterSet
  twisted.conch.insults.helper.TerminalBuffer.html#selectCharacterSet
  Function
  Method
  PUBLIC
  Select a character set.
- twisted.conch.insults.helper.TerminalBuffer.shiftIn
  twisted.conch.insults.helper.TerminalBuffer.html#shiftIn
  Function
  Method
  PUBLIC
  Activate the G0 character set.
- twisted.conch.insults.helper.TerminalBuffer.activeCharset
  twisted.conch.insults.helper.TerminalBuffer.html#activeCharset
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.helper.TerminalBuffer.shiftOut
  twisted.conch.insults.helper.TerminalBuffer.html#shiftOut
  Function
  Method
  PUBLIC
  Activate the G1 character set.
- twisted.conch.insults.helper.TerminalBuffer.singleShift2
  twisted.conch.insults.helper.TerminalBuffer.html#singleShift2
  Function
  Method
  PUBLIC
  Shift to the G2 character set for a single character.
- twisted.conch.insults.helper.TerminalBuffer.singleShift3
  twisted.conch.insults.helper.TerminalBuffer.html#singleShift3
  Function
  Method
  PUBLIC
  Shift to the G3 character set for a single character.
- twisted.conch.insults.helper.TerminalBuffer.selectGraphicRendition
  twisted.conch.insults.helper.TerminalBuffer.html#selectGraphicRendition
  Function
  Method
  PUBLIC
  Enabled one or more character attributes.
- twisted.conch.insults.helper.TerminalBuffer.graphicRendition
  twisted.conch.insults.helper.TerminalBuffer.html#graphicRendition
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.helper.TerminalBuffer.eraseLine
  twisted.conch.insults.helper.TerminalBuffer.html#eraseLine
  Function
  Method
  PUBLIC
  Erase the entire cursor line.
- twisted.conch.insults.helper.TerminalBuffer.eraseToLineEnd
  twisted.conch.insults.helper.TerminalBuffer.html#eraseToLineEnd
  Function
  Method
  PUBLIC
  Erase from the cursor to the end of line, including cursor position.
- twisted.conch.insults.helper.TerminalBuffer.eraseToLineBeginning
  twisted.conch.insults.helper.TerminalBuffer.html#eraseToLineBeginning
  Function
  Method
  PUBLIC
  Erase from the cursor to the beginning of the line, including the cursor position.
- twisted.conch.insults.helper.TerminalBuffer.eraseDisplay
  twisted.conch.insults.helper.TerminalBuffer.html#eraseDisplay
  Function
  Method
  PUBLIC
  Erase the entire display.
- twisted.conch.insults.helper.TerminalBuffer.lines
  twisted.conch.insults.helper.TerminalBuffer.html#lines
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.helper.TerminalBuffer.eraseToDisplayEnd
  twisted.conch.insults.helper.TerminalBuffer.html#eraseToDisplayEnd
  Function
  Method
  PUBLIC
  Erase from the cursor to the end of the display, including the cursor position.
- twisted.conch.insults.helper.TerminalBuffer.eraseToDisplayBeginning
  twisted.conch.insults.helper.TerminalBuffer.html#eraseToDisplayBeginning
  Function
  Method
  PUBLIC
  Erase from the cursor to the beginning of the display, including the cursor position.
- twisted.conch.insults.helper.TerminalBuffer.deleteCharacter
  twisted.conch.insults.helper.TerminalBuffer.html#deleteCharacter
  Function
  Method
  PUBLIC
  Delete n characters starting at the cursor position.
- twisted.conch.insults.helper.TerminalBuffer.insertLine
  twisted.conch.insults.helper.TerminalBuffer.html#insertLine
  Function
  Method
  PUBLIC
  Insert n lines at the cursor position.
- twisted.conch.insults.helper.TerminalBuffer.deleteLine
  twisted.conch.insults.helper.TerminalBuffer.html#deleteLine
  Function
  Method
  PUBLIC
  Delete n lines starting at the cursor position.
- twisted.conch.insults.helper.TerminalBuffer.reportCursorPosition
  twisted.conch.insults.helper.TerminalBuffer.html#reportCursorPosition
  Function
  Method
  PUBLIC
  Return a Deferred that fires with a two-tuple of (x, y) indicating the cursor position.
- twisted.conch.insults.helper.TerminalBuffer.reset
  twisted.conch.insults.helper.TerminalBuffer.html#reset
  Function
  Method
  PUBLIC
  Reset the terminal to its initial state.
- twisted.conch.insults.helper.TerminalBuffer.home
  twisted.conch.insults.helper.TerminalBuffer.html#home
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.helper.TerminalBuffer.modes
  twisted.conch.insults.helper.TerminalBuffer.html#modes
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.helper.TerminalBuffer.privateModes
  twisted.conch.insults.helper.TerminalBuffer.html#privateModes
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.helper.TerminalBuffer.numericKeypad
  twisted.conch.insults.helper.TerminalBuffer.html#numericKeypad
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.helper.TerminalBuffer.charsets
  twisted.conch.insults.helper.TerminalBuffer.html#charsets
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.helper.TerminalBuffer.unhandledControlSequence
  twisted.conch.insults.helper.TerminalBuffer.html#unhandledControlSequence
  Function
  Method
  PUBLIC
  Called when an unsupported control sequence is received.
- twisted.conch.insults.helper.TerminalBuffer.__bytes__
  twisted.conch.insults.helper.TerminalBuffer.html#__bytes__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.helper.TerminalBuffer.getHost
  twisted.conch.insults.helper.TerminalBuffer.html#getHost
  Function
  Method
  PUBLIC
  Similar to getPeer, but returns an address describing this side of the connection.
- twisted.conch.insults.helper.TerminalBuffer.getPeer
  twisted.conch.insults.helper.TerminalBuffer.html#getPeer
  Function
  Method
  PUBLIC
  Get the remote address of this connection.
- twisted.conch.insults.helper.TerminalBuffer.loseConnection
  twisted.conch.insults.helper.TerminalBuffer.html#loseConnection
  Function
  Method
  PUBLIC
  Close my connection, after writing all pending data.
- twisted.conch.insults.helper.TerminalBuffer.writeSequence
  twisted.conch.insults.helper.TerminalBuffer.html#writeSequence
  Function
  Method
  PUBLIC
  Write an iterable of byte strings to the physical connection.
- twisted.conch.insults.helper.TerminalBuffer.horizontalTabulationSet
  twisted.conch.insults.helper.TerminalBuffer.html#horizontalTabulationSet
  Function
  Method
  PUBLIC
  Set a tab stop at the current cursor position.
- twisted.conch.insults.helper.TerminalBuffer.tabulationClear
  twisted.conch.insults.helper.TerminalBuffer.html#tabulationClear
  Function
  Method
  PUBLIC
  Clear the tab stop at the current cursor position.
- twisted.conch.insults.helper.TerminalBuffer.tabulationClearAll
  twisted.conch.insults.helper.TerminalBuffer.html#tabulationClearAll
  Function
  Method
  PUBLIC
  Clear all tab stops.
- twisted.conch.insults.helper.TerminalBuffer.doubleHeightLine
  twisted.conch.insults.helper.TerminalBuffer.html#doubleHeightLine
  Function
  Method
  PUBLIC
  Make the current line the top or bottom half of a double-height, double-width line.
- twisted.conch.insults.helper.TerminalBuffer.singleWidthLine
  twisted.conch.insults.helper.TerminalBuffer.html#singleWidthLine
  Function
  Method
  PUBLIC
  Make the current line a single-width, single-height line.
- twisted.conch.insults.helper.TerminalBuffer.doubleWidthLine
  twisted.conch.insults.helper.TerminalBuffer.html#doubleWidthLine
  Function
  Method
  PUBLIC
  Make the current line a double-width line.
- twisted.conch.insults.helper.ExpectationTimeout
  twisted.conch.insults.helper.ExpectationTimeout.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.conch.insults.helper.ExpectableBuffer
  twisted.conch.insults.helper.ExpectableBuffer.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.conch.insults.helper.ExpectableBuffer._mark
  twisted.conch.insults.helper.ExpectableBuffer.html#_mark
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.conch.insults.helper.ExpectableBuffer.connectionMade
  twisted.conch.insults.helper.ExpectableBuffer.html#connectionMade
  Function
  Method
  PUBLIC
  Called when a connection is made.
- twisted.conch.insults.helper.ExpectableBuffer._expecting
  twisted.conch.insults.helper.ExpectableBuffer.html#_expecting
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.conch.insults.helper.ExpectableBuffer.write
  twisted.conch.insults.helper.ExpectableBuffer.html#write
  Function
  Method
  PUBLIC
  Add the given printable bytes to the terminal.
- twisted.conch.insults.helper.ExpectableBuffer.cursorHome
  twisted.conch.insults.helper.ExpectableBuffer.html#cursorHome
  Function
  Method
  PUBLIC
  Move the cursor home.
- twisted.conch.insults.helper.ExpectableBuffer._timeoutExpected
  twisted.conch.insults.helper.ExpectableBuffer.html#_timeoutExpected
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.insults.helper.ExpectableBuffer._checkExpected
  twisted.conch.insults.helper.ExpectableBuffer.html#_checkExpected
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.insults.helper.ExpectableBuffer.expect
  twisted.conch.insults.helper.ExpectableBuffer.html#expect
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.text._TEXT_COLORS
  twisted.conch.insults.text.html#_TEXT_COLORS
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.conch.insults.text._CharacterAttributes
  twisted.conch.insults.text._CharacterAttributes.html
  Class
  Class
  PRIVATE
  Factory for character attributes, including foreground and background color and non-color attributes such as bold, reverse video and underline.
- twisted.conch.insults.text._CharacterAttributes.fg
  twisted.conch.insults.text._CharacterAttributes.html#fg
  Attribute
  Instance Variable
  PUBLIC
  Foreground colors accessed by attribute name, see above for possible names.
- twisted.conch.insults.text._CharacterAttributes.bg
  twisted.conch.insults.text._CharacterAttributes.html#bg
  Attribute
  Instance Variable
  PUBLIC
  Background colors accessed by attribute name, see above for possible names.
- twisted.conch.insults.text._CharacterAttributes.attrs
  twisted.conch.insults.text._CharacterAttributes.html#attrs
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.text.assembleFormattedText
  twisted.conch.insults.text.html#assembleFormattedText
  Function
  Function
  PUBLIC
  Assemble formatted text from structured information.
- twisted.conch.insults.text.attributes
  twisted.conch.insults.text.html#attributes
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.python.text.stringyString
  twisted.python.text.html#stringyString
  Function
  Function
  PUBLIC
  Expansive string formatting for sequence types.
- twisted.python.text.isMultiline
  twisted.python.text.html#isMultiline
  Function
  Function
  PUBLIC
  Returns `True` if this string has a newline in it.
- twisted.python.text.endsInNewline
  twisted.python.text.html#endsInNewline
  Function
  Function
  PUBLIC
  Returns `True` if this string ends in a newline.
- twisted.python.text.greedyWrap
  twisted.python.text.html#greedyWrap
  Function
  Function
  PUBLIC
  Given a string and a column width, return a list of lines.
- twisted.python.text.removeLeadingBlanks
  twisted.python.text.html#removeLeadingBlanks
  Function
  Function
  PUBLIC
  Undocumented
- twisted.python.text.removeLeadingTrailingBlanks
  twisted.python.text.html#removeLeadingTrailingBlanks
  Function
  Function
  PUBLIC
  Undocumented
- twisted.python.text.splitQuoted
  twisted.python.text.html#splitQuoted
  Function
  Function
  PUBLIC
  Like a string split, but don't break substrings inside quotes.
- twisted.python.text.strFile
  twisted.python.text.html#strFile
  Function
  Function
  PUBLIC
  Find whether string `p` occurs in a read()able object `f`.
- twisted.conch.insults.window.YieldFocus
  twisted.conch.insults.window.YieldFocus.html
  Class
  Exception
  PUBLIC
  Input focus manipulation exception
- twisted.conch.insults.window.BoundedTerminalWrapper
  twisted.conch.insults.window.BoundedTerminalWrapper.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.conch.insults.window.BoundedTerminalWrapper.__init__
  twisted.conch.insults.window.BoundedTerminalWrapper.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.BoundedTerminalWrapper.width
  twisted.conch.insults.window.BoundedTerminalWrapper.html#width
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.window.BoundedTerminalWrapper.height
  twisted.conch.insults.window.BoundedTerminalWrapper.html#height
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.window.BoundedTerminalWrapper.xoff
  twisted.conch.insults.window.BoundedTerminalWrapper.html#xoff
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.window.BoundedTerminalWrapper.yoff
  twisted.conch.insults.window.BoundedTerminalWrapper.html#yoff
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.window.BoundedTerminalWrapper.terminal
  twisted.conch.insults.window.BoundedTerminalWrapper.html#terminal
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.window.BoundedTerminalWrapper.cursorForward
  twisted.conch.insults.window.BoundedTerminalWrapper.html#cursorForward
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.window.BoundedTerminalWrapper.selectCharacterSet
  twisted.conch.insults.window.BoundedTerminalWrapper.html#selectCharacterSet
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.window.BoundedTerminalWrapper.selectGraphicRendition
  twisted.conch.insults.window.BoundedTerminalWrapper.html#selectGraphicRendition
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.window.BoundedTerminalWrapper.saveCursor
  twisted.conch.insults.window.BoundedTerminalWrapper.html#saveCursor
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.window.BoundedTerminalWrapper.restoreCursor
  twisted.conch.insults.window.BoundedTerminalWrapper.html#restoreCursor
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.window.BoundedTerminalWrapper.cursorPosition
  twisted.conch.insults.window.BoundedTerminalWrapper.html#cursorPosition
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.BoundedTerminalWrapper.cursorHome
  twisted.conch.insults.window.BoundedTerminalWrapper.html#cursorHome
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.BoundedTerminalWrapper.write
  twisted.conch.insults.window.BoundedTerminalWrapper.html#write
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.Widget
  twisted.conch.insults.window.Widget.html
  Class
  Class
  PUBLIC
  No class docstring; 0/4 instance variable, 0/1 class variable, 1/13 method documented
- twisted.conch.insults.window.Widget.focused
  twisted.conch.insults.window.Widget.html#focused
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.window.Widget.parent
  twisted.conch.insults.window.Widget.html#parent
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.window.Widget.dirty
  twisted.conch.insults.window.Widget.html#dirty
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.window.Widget.width
  twisted.conch.insults.window.Widget.html#width
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.window.Widget.height
  twisted.conch.insults.window.Widget.html#height
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.window.Widget.repaint
  twisted.conch.insults.window.Widget.html#repaint
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.Widget.filthy
  twisted.conch.insults.window.Widget.html#filthy
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.Widget.redraw
  twisted.conch.insults.window.Widget.html#redraw
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.Widget.draw
  twisted.conch.insults.window.Widget.html#draw
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.Widget.render
  twisted.conch.insults.window.Widget.html#render
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.Widget.sizeHint
  twisted.conch.insults.window.Widget.html#sizeHint
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.Widget.keystrokeReceived
  twisted.conch.insults.window.Widget.html#keystrokeReceived
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.Widget.tabReceived
  twisted.conch.insults.window.Widget.html#tabReceived
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.Widget.focusReceived
  twisted.conch.insults.window.Widget.html#focusReceived
  Function
  Method
  PUBLIC
  Called when focus is being given to this widget.
- twisted.conch.insults.window.Widget.focusLost
  twisted.conch.insults.window.Widget.html#focusLost
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.Widget.backspaceReceived
  twisted.conch.insults.window.Widget.html#backspaceReceived
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.Widget.functionKeyReceived
  twisted.conch.insults.window.Widget.html#functionKeyReceived
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.Widget.characterReceived
  twisted.conch.insults.window.Widget.html#characterReceived
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.ContainerWidget
  twisted.conch.insults.window.ContainerWidget.html
  Class
  Class
  PUBLIC
  No summary
- twisted.conch.insults.window.ContainerWidget.focusedChild
  twisted.conch.insults.window.ContainerWidget.html#focusedChild
  Attribute
  Instance Variable
  PUBLIC
  The contained widget which currently has focus, or None.
- twisted.conch.insults.window.ContainerWidget.focused
  twisted.conch.insults.window.ContainerWidget.html#focused
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.window.ContainerWidget.__init__
  twisted.conch.insults.window.ContainerWidget.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.ContainerWidget.children
  twisted.conch.insults.window.ContainerWidget.html#children
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.window.ContainerWidget.addChild
  twisted.conch.insults.window.ContainerWidget.html#addChild
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.ContainerWidget.remChild
  twisted.conch.insults.window.ContainerWidget.html#remChild
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.ContainerWidget.filthy
  twisted.conch.insults.window.ContainerWidget.html#filthy
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.ContainerWidget.render
  twisted.conch.insults.window.ContainerWidget.html#render
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.ContainerWidget.changeFocus
  twisted.conch.insults.window.ContainerWidget.html#changeFocus
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.ContainerWidget.focusReceived
  twisted.conch.insults.window.ContainerWidget.html#focusReceived
  Function
  Method
  PUBLIC
  Called when focus is being given to this widget.
- twisted.conch.insults.window.ContainerWidget.keystrokeReceived
  twisted.conch.insults.window.ContainerWidget.html#keystrokeReceived
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.TopWindow
  twisted.conch.insults.window.TopWindow.html
  Class
  Class
  PUBLIC
  A top-level container object which provides focus wrap-around and paint scheduling.
- twisted.conch.insults.window.TopWindow.painter
  twisted.conch.insults.window.TopWindow.html#painter
  Attribute
  Instance Variable
  PUBLIC
  A no-argument callable which will be invoked when this widget needs to be redrawn.
- twisted.conch.insults.window.TopWindow.scheduler
  twisted.conch.insults.window.TopWindow.html#scheduler
  Attribute
  Instance Variable
  PUBLIC
  A one-argument callable which will be invoked with a no-argument callable and should arrange for it to invoked at some point in the near future. The no-argument callable will cause this widget and all its children to be redrawn...
- twisted.conch.insults.window.TopWindow.focused
  twisted.conch.insults.window.TopWindow.html#focused
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.window.TopWindow.__init__
  twisted.conch.insults.window.TopWindow.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.TopWindow._paintCall
  twisted.conch.insults.window.TopWindow.html#_paintCall
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.conch.insults.window.TopWindow.repaint
  twisted.conch.insults.window.TopWindow.html#repaint
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.TopWindow._paint
  twisted.conch.insults.window.TopWindow.html#_paint
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.insults.window.TopWindow.changeFocus
  twisted.conch.insults.window.TopWindow.html#changeFocus
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.TopWindow.keystrokeReceived
  twisted.conch.insults.window.TopWindow.html#keystrokeReceived
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.AbsoluteBox
  twisted.conch.insults.window.AbsoluteBox.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.conch.insults.window.AbsoluteBox.moveChild
  twisted.conch.insults.window.AbsoluteBox.html#moveChild
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.AbsoluteBox.render
  twisted.conch.insults.window.AbsoluteBox.html#render
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window._Box
  twisted.conch.insults.window._Box.html
  Class
  Class
  PRIVATE
  Undocumented
- twisted.conch.insults.window._Box.TOP
  twisted.conch.insults.window._Box.html#TOP
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.insults.window._Box.CENTER
  twisted.conch.insults.window._Box.html#CENTER
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.insults.window._Box.BOTTOM
  twisted.conch.insults.window._Box.html#BOTTOM
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.insults.window._Box.__init__
  twisted.conch.insults.window._Box.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window._Box.gravity
  twisted.conch.insults.window._Box.html#gravity
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.window._Box.sizeHint
  twisted.conch.insults.window._Box.html#sizeHint
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window._Box.render
  twisted.conch.insults.window._Box.html#render
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.HBox
  twisted.conch.insults.window.HBox.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.conch.insults.window.HBox.variableDimension
  twisted.conch.insults.window.HBox.html#variableDimension
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.window.VBox
  twisted.conch.insults.window.VBox.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.conch.insults.window.VBox.variableDimension
  twisted.conch.insults.window.VBox.html#variableDimension
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.window.Packer
  twisted.conch.insults.window.Packer.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.conch.insults.window.Packer.render
  twisted.conch.insults.window.Packer.html#render
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.Canvas
  twisted.conch.insults.window.Canvas.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.conch.insults.window.Canvas.focused
  twisted.conch.insults.window.Canvas.html#focused
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.window.Canvas.contents
  twisted.conch.insults.window.Canvas.html#contents
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.window.Canvas.__init__
  twisted.conch.insults.window.Canvas.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.Canvas.resize
  twisted.conch.insults.window.Canvas.html#resize
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.Canvas._width
  twisted.conch.insults.window.Canvas.html#_width
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.conch.insults.window.Canvas._height
  twisted.conch.insults.window.Canvas.html#_height
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.conch.insults.window.Canvas.x
  twisted.conch.insults.window.Canvas.html#x
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.window.Canvas.y
  twisted.conch.insults.window.Canvas.html#y
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.window.Canvas.__getitem__
  twisted.conch.insults.window.Canvas.html#__getitem__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.Canvas.__setitem__
  twisted.conch.insults.window.Canvas.html#__setitem__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.Canvas.clear
  twisted.conch.insults.window.Canvas.html#clear
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.Canvas.render
  twisted.conch.insults.window.Canvas.html#render
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.horizontalLine
  twisted.conch.insults.window.html#horizontalLine
  Function
  Function
  PUBLIC
  Undocumented
- twisted.conch.insults.window.verticalLine
  twisted.conch.insults.window.html#verticalLine
  Function
  Function
  PUBLIC
  Undocumented
- twisted.conch.insults.window.rectangle
  twisted.conch.insults.window.html#rectangle
  Function
  Function
  PUBLIC
  Draw a rectangle
- twisted.conch.insults.window.Border
  twisted.conch.insults.window.Border.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.conch.insults.window.Border.__init__
  twisted.conch.insults.window.Border.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.Border.containee
  twisted.conch.insults.window.Border.html#containee
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.window.Border.focusReceived
  twisted.conch.insults.window.Border.html#focusReceived
  Function
  Method
  PUBLIC
  Called when focus is being given to this widget.
- twisted.conch.insults.window.Border.focusLost
  twisted.conch.insults.window.Border.html#focusLost
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.Border.keystrokeReceived
  twisted.conch.insults.window.Border.html#keystrokeReceived
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.Border.sizeHint
  twisted.conch.insults.window.Border.html#sizeHint
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.Border.filthy
  twisted.conch.insults.window.Border.html#filthy
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.Border.render
  twisted.conch.insults.window.Border.html#render
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.Button
  twisted.conch.insults.window.Button.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.conch.insults.window.Button.__init__
  twisted.conch.insults.window.Button.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.Button.label
  twisted.conch.insults.window.Button.html#label
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.window.Button.onPress
  twisted.conch.insults.window.Button.html#onPress
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.window.Button.sizeHint
  twisted.conch.insults.window.Button.html#sizeHint
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.Button.characterReceived
  twisted.conch.insults.window.Button.html#characterReceived
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.Button.render
  twisted.conch.insults.window.Button.html#render
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.TextInput
  twisted.conch.insults.window.TextInput.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.conch.insults.window.TextInput.__init__
  twisted.conch.insults.window.TextInput.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.TextInput.onSubmit
  twisted.conch.insults.window.TextInput.html#onSubmit
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.window.TextInput.maxwidth
  twisted.conch.insults.window.TextInput.html#maxwidth
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.window.TextInput.buffer
  twisted.conch.insults.window.TextInput.html#buffer
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.window.TextInput.cursor
  twisted.conch.insults.window.TextInput.html#cursor
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.window.TextInput.setText
  twisted.conch.insults.window.TextInput.html#setText
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.TextInput.func_LEFT_ARROW
  twisted.conch.insults.window.TextInput.html#func_LEFT_ARROW
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.TextInput.func_RIGHT_ARROW
  twisted.conch.insults.window.TextInput.html#func_RIGHT_ARROW
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.TextInput.backspaceReceived
  twisted.conch.insults.window.TextInput.html#backspaceReceived
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.TextInput.characterReceived
  twisted.conch.insults.window.TextInput.html#characterReceived
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.TextInput.sizeHint
  twisted.conch.insults.window.TextInput.html#sizeHint
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.TextInput.render
  twisted.conch.insults.window.TextInput.html#render
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.TextInput._renderText
  twisted.conch.insults.window.TextInput.html#_renderText
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.insults.window.PasswordInput
  twisted.conch.insults.window.PasswordInput.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.conch.insults.window.PasswordInput._renderText
  twisted.conch.insults.window.PasswordInput.html#_renderText
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.insults.window.TextOutput
  twisted.conch.insults.window.TextOutput.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.conch.insults.window.TextOutput.text
  twisted.conch.insults.window.TextOutput.html#text
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.window.TextOutput.__init__
  twisted.conch.insults.window.TextOutput.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.TextOutput.size
  twisted.conch.insults.window.TextOutput.html#size
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.window.TextOutput.sizeHint
  twisted.conch.insults.window.TextOutput.html#sizeHint
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.TextOutput.render
  twisted.conch.insults.window.TextOutput.html#render
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.TextOutput.setText
  twisted.conch.insults.window.TextOutput.html#setText
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.TextOutput.focusReceived
  twisted.conch.insults.window.TextOutput.html#focusReceived
  Function
  Method
  PUBLIC
  Called when focus is being given to this widget.
- twisted.conch.insults.window.TextOutputArea
  twisted.conch.insults.window.TextOutputArea.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.conch.insults.window.TextOutputArea.WRAP
  twisted.conch.insults.window.TextOutputArea.html#WRAP
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.insults.window.TextOutputArea.TRUNCATE
  twisted.conch.insults.window.TextOutputArea.html#TRUNCATE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.insults.window.TextOutputArea.__init__
  twisted.conch.insults.window.TextOutputArea.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.TextOutputArea.longLines
  twisted.conch.insults.window.TextOutputArea.html#longLines
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.window.TextOutputArea.render
  twisted.conch.insults.window.TextOutputArea.html#render
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.Viewport
  twisted.conch.insults.window.Viewport.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.conch.insults.window.Viewport._xOffset
  twisted.conch.insults.window.Viewport.html#_xOffset
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.conch.insults.window.Viewport._yOffset
  twisted.conch.insults.window.Viewport.html#_yOffset
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.conch.insults.window.Viewport.xOffset
  twisted.conch.insults.window.Viewport.html#xOffset
  Attribute
  Property
  PUBLIC
  Undocumented
- twisted.conch.insults.window.Viewport.xOffset.setter
  twisted.conch.insults.window.Viewport.html#xOffset.setter
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.Viewport.yOffset
  twisted.conch.insults.window.Viewport.html#yOffset
  Attribute
  Property
  PUBLIC
  Undocumented
- twisted.conch.insults.window.Viewport.yOffset.setter
  twisted.conch.insults.window.Viewport.html#yOffset.setter
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.Viewport._width
  twisted.conch.insults.window.Viewport.html#_width
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.conch.insults.window.Viewport._height
  twisted.conch.insults.window.Viewport.html#_height
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.conch.insults.window.Viewport.__init__
  twisted.conch.insults.window.Viewport.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.Viewport.containee
  twisted.conch.insults.window.Viewport.html#containee
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.window.Viewport._buf
  twisted.conch.insults.window.Viewport.html#_buf
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.conch.insults.window.Viewport.filthy
  twisted.conch.insults.window.Viewport.html#filthy
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.Viewport.render
  twisted.conch.insults.window.Viewport.html#render
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window._Scrollbar
  twisted.conch.insults.window._Scrollbar.html
  Class
  Class
  PRIVATE
  Undocumented
- twisted.conch.insults.window._Scrollbar.__init__
  twisted.conch.insults.window._Scrollbar.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window._Scrollbar.onScroll
  twisted.conch.insults.window._Scrollbar.html#onScroll
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.window._Scrollbar.percent
  twisted.conch.insults.window._Scrollbar.html#percent
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.window._Scrollbar.smaller
  twisted.conch.insults.window._Scrollbar.html#smaller
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window._Scrollbar.bigger
  twisted.conch.insults.window._Scrollbar.html#bigger
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.HorizontalScrollbar
  twisted.conch.insults.window.HorizontalScrollbar.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.conch.insults.window.HorizontalScrollbar.sizeHint
  twisted.conch.insults.window.HorizontalScrollbar.html#sizeHint
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.HorizontalScrollbar.func_LEFT_ARROW
  twisted.conch.insults.window.HorizontalScrollbar.html#func_LEFT_ARROW
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.HorizontalScrollbar.func_RIGHT_ARROW
  twisted.conch.insults.window.HorizontalScrollbar.html#func_RIGHT_ARROW
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.HorizontalScrollbar._left
  twisted.conch.insults.window.HorizontalScrollbar.html#_left
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.conch.insults.window.HorizontalScrollbar._right
  twisted.conch.insults.window.HorizontalScrollbar.html#_right
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.conch.insults.window.HorizontalScrollbar._bar
  twisted.conch.insults.window.HorizontalScrollbar.html#_bar
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.conch.insults.window.HorizontalScrollbar._slider
  twisted.conch.insults.window.HorizontalScrollbar.html#_slider
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.conch.insults.window.HorizontalScrollbar.render
  twisted.conch.insults.window.HorizontalScrollbar.html#render
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.VerticalScrollbar
  twisted.conch.insults.window.VerticalScrollbar.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.conch.insults.window.VerticalScrollbar.sizeHint
  twisted.conch.insults.window.VerticalScrollbar.html#sizeHint
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.VerticalScrollbar.func_UP_ARROW
  twisted.conch.insults.window.VerticalScrollbar.html#func_UP_ARROW
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.VerticalScrollbar.func_DOWN_ARROW
  twisted.conch.insults.window.VerticalScrollbar.html#func_DOWN_ARROW
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.VerticalScrollbar._up
  twisted.conch.insults.window.VerticalScrollbar.html#_up
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.conch.insults.window.VerticalScrollbar._down
  twisted.conch.insults.window.VerticalScrollbar.html#_down
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.conch.insults.window.VerticalScrollbar._bar
  twisted.conch.insults.window.VerticalScrollbar.html#_bar
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.conch.insults.window.VerticalScrollbar._slider
  twisted.conch.insults.window.VerticalScrollbar.html#_slider
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.conch.insults.window.VerticalScrollbar.render
  twisted.conch.insults.window.VerticalScrollbar.html#render
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.ScrolledArea
  twisted.conch.insults.window.ScrolledArea.html
  Class
  Class
  PUBLIC
  A `ScrolledArea` contains another widget wrapped in a viewport and vertical and horizontal scrollbars for moving the viewport around.
- twisted.conch.insults.window.ScrolledArea.__init__
  twisted.conch.insults.window.ScrolledArea.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.ScrolledArea._viewport
  twisted.conch.insults.window.ScrolledArea.html#_viewport
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.conch.insults.window.ScrolledArea._horiz
  twisted.conch.insults.window.ScrolledArea.html#_horiz
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.conch.insults.window.ScrolledArea._vert
  twisted.conch.insults.window.ScrolledArea.html#_vert
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.conch.insults.window.ScrolledArea._horizScroll
  twisted.conch.insults.window.ScrolledArea.html#_horizScroll
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.insults.window.ScrolledArea._vertScroll
  twisted.conch.insults.window.ScrolledArea.html#_vertScroll
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.insults.window.ScrolledArea.func_UP_ARROW
  twisted.conch.insults.window.ScrolledArea.html#func_UP_ARROW
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.ScrolledArea.func_DOWN_ARROW
  twisted.conch.insults.window.ScrolledArea.html#func_DOWN_ARROW
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.ScrolledArea.func_LEFT_ARROW
  twisted.conch.insults.window.ScrolledArea.html#func_LEFT_ARROW
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.ScrolledArea.func_RIGHT_ARROW
  twisted.conch.insults.window.ScrolledArea.html#func_RIGHT_ARROW
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.ScrolledArea.filthy
  twisted.conch.insults.window.ScrolledArea.html#filthy
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.ScrolledArea.render
  twisted.conch.insults.window.ScrolledArea.html#render
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.cursor
  twisted.conch.insults.window.html#cursor
  Function
  Function
  PUBLIC
  Undocumented
- twisted.conch.insults.window.Selection
  twisted.conch.insults.window.Selection.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.conch.insults.window.Selection.focusedIndex
  twisted.conch.insults.window.Selection.html#focusedIndex
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.window.Selection.renderOffset
  twisted.conch.insults.window.Selection.html#renderOffset
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.window.Selection.__init__
  twisted.conch.insults.window.Selection.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.Selection.sequence
  twisted.conch.insults.window.Selection.html#sequence
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.window.Selection.onSelect
  twisted.conch.insults.window.Selection.html#onSelect
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.window.Selection.minVisible
  twisted.conch.insults.window.Selection.html#minVisible
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.insults.window.Selection._width
  twisted.conch.insults.window.Selection.html#_width
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.conch.insults.window.Selection.sizeHint
  twisted.conch.insults.window.Selection.html#sizeHint
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.Selection.func_UP_ARROW
  twisted.conch.insults.window.Selection.html#func_UP_ARROW
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.Selection.func_PGUP
  twisted.conch.insults.window.Selection.html#func_PGUP
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.Selection.func_DOWN_ARROW
  twisted.conch.insults.window.Selection.html#func_DOWN_ARROW
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.Selection.func_PGDN
  twisted.conch.insults.window.Selection.html#func_PGDN
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.Selection.characterReceived
  twisted.conch.insults.window.Selection.html#characterReceived
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.Selection.render
  twisted.conch.insults.window.Selection.html#render
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.insults.window.Selection.height
  twisted.conch.insults.window.Selection.html#height
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ls._MONTH_NAMES
  twisted.conch.ls.html#_MONTH_NAMES
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.conch.ls.lsLine
  twisted.conch.ls.html#lsLine
  Function
  Function
  PUBLIC
  Build an 'ls' line for a file ('file' in its generic sense, it can be of any type).
- twisted.conch.recvline._counters
  twisted.conch.recvline.html#_counters
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.conch.recvline.Logging
  twisted.conch.recvline.Logging.html
  Class
  Class
  PUBLIC
  Wrapper which logs attribute lookups.
- twisted.conch.recvline.Logging.__init__
  twisted.conch.recvline.Logging.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.recvline.Logging.original
  twisted.conch.recvline.Logging.html#original
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.recvline.Logging._logFile
  twisted.conch.recvline.Logging.html#_logFile
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.conch.recvline.Logging.__str__
  twisted.conch.recvline.Logging.html#__str__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.recvline.Logging.__repr__
  twisted.conch.recvline.Logging.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.recvline.Logging.__getattribute__
  twisted.conch.recvline.Logging.html#__getattribute__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.recvline.TransportSequence
  twisted.conch.recvline.TransportSequence.html
  Class
  Class
  PUBLIC
  An `ITerminalTransport` implementation which forwards calls to one or more other `ITerminalTransport`s.
- twisted.conch.recvline.TransportSequence.execBytes
  twisted.conch.recvline.TransportSequence.html#execBytes
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.recvline.TransportSequence.execStr
  twisted.conch.recvline.TransportSequence.html#execStr
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.recvline.TransportSequence.TAB
  twisted.conch.recvline.TransportSequence.html#TAB
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.recvline.TransportSequence.BACKSPACE
  twisted.conch.recvline.TransportSequence.html#BACKSPACE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.recvline.TransportSequence.__init__
  twisted.conch.recvline.TransportSequence.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.recvline.TransportSequence.transports
  twisted.conch.recvline.TransportSequence.html#transports
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.recvline.TransportSequence.getHost
  twisted.conch.recvline.TransportSequence.html#getHost
  Function
  Method
  PUBLIC
  Similar to getPeer, but returns an address describing this side of the connection.
- twisted.conch.recvline.TransportSequence.getPeer
  twisted.conch.recvline.TransportSequence.html#getPeer
  Function
  Method
  PUBLIC
  Get the remote address of this connection.
- twisted.conch.recvline.TransportSequence.loseConnection
  twisted.conch.recvline.TransportSequence.html#loseConnection
  Function
  Method
  PUBLIC
  Close my connection, after writing all pending data.
- twisted.conch.recvline.TransportSequence.write
  twisted.conch.recvline.TransportSequence.html#write
  Function
  Method
  PUBLIC
  Write some data to the physical connection, in sequence, in a non-blocking fashion.
- twisted.conch.recvline.TransportSequence.writeSequence
  twisted.conch.recvline.TransportSequence.html#writeSequence
  Function
  Method
  PUBLIC
  Write an iterable of byte strings to the physical connection.
- twisted.conch.recvline.TransportSequence.cursorUp
  twisted.conch.recvline.TransportSequence.html#cursorUp
  Function
  Method
  PUBLIC
  Move the cursor up n lines.
- twisted.conch.recvline.TransportSequence.cursorDown
  twisted.conch.recvline.TransportSequence.html#cursorDown
  Function
  Method
  PUBLIC
  Move the cursor down n lines.
- twisted.conch.recvline.TransportSequence.cursorForward
  twisted.conch.recvline.TransportSequence.html#cursorForward
  Function
  Method
  PUBLIC
  Move the cursor right n columns.
- twisted.conch.recvline.TransportSequence.cursorBackward
  twisted.conch.recvline.TransportSequence.html#cursorBackward
  Function
  Method
  PUBLIC
  Move the cursor left n columns.
- twisted.conch.recvline.TransportSequence.cursorPosition
  twisted.conch.recvline.TransportSequence.html#cursorPosition
  Function
  Method
  PUBLIC
  Move the cursor to the given line and column.
- twisted.conch.recvline.TransportSequence.cursorHome
  twisted.conch.recvline.TransportSequence.html#cursorHome
  Function
  Method
  PUBLIC
  Move the cursor home.
- twisted.conch.recvline.TransportSequence.index
  twisted.conch.recvline.TransportSequence.html#index
  Function
  Method
  PUBLIC
  Move the cursor down one line, performing scrolling if necessary.
- twisted.conch.recvline.TransportSequence.reverseIndex
  twisted.conch.recvline.TransportSequence.html#reverseIndex
  Function
  Method
  PUBLIC
  Move the cursor up one line, performing scrolling if necessary.
- twisted.conch.recvline.TransportSequence.nextLine
  twisted.conch.recvline.TransportSequence.html#nextLine
  Function
  Method
  PUBLIC
  Move the cursor to the first position on the next line, performing scrolling if necessary.
- twisted.conch.recvline.TransportSequence.saveCursor
  twisted.conch.recvline.TransportSequence.html#saveCursor
  Function
  Method
  PUBLIC
  Save the cursor position, character attribute, character set, and origin mode selection.
- twisted.conch.recvline.TransportSequence.restoreCursor
  twisted.conch.recvline.TransportSequence.html#restoreCursor
  Function
  Method
  PUBLIC
  Restore the previously saved cursor position, character attribute, character set, and origin mode selection.
- twisted.conch.recvline.TransportSequence.setModes
  twisted.conch.recvline.TransportSequence.html#setModes
  Function
  Method
  PUBLIC
  Set the given modes on the terminal.
- twisted.conch.recvline.TransportSequence.resetModes
  twisted.conch.recvline.TransportSequence.html#resetModes
  Function
  Method
  PUBLIC
  Reset the given modes on the terminal.
- twisted.conch.recvline.TransportSequence.setPrivateModes
  twisted.conch.recvline.TransportSequence.html#setPrivateModes
  Function
  Method
  PUBLIC
  Set the given DEC private modes on the terminal.
- twisted.conch.recvline.TransportSequence.resetPrivateModes
  twisted.conch.recvline.TransportSequence.html#resetPrivateModes
  Function
  Method
  PUBLIC
  Reset the given DEC private modes on the terminal.
- twisted.conch.recvline.TransportSequence.applicationKeypadMode
  twisted.conch.recvline.TransportSequence.html#applicationKeypadMode
  Function
  Method
  PUBLIC
  Cause keypad to generate control functions.
- twisted.conch.recvline.TransportSequence.numericKeypadMode
  twisted.conch.recvline.TransportSequence.html#numericKeypadMode
  Function
  Method
  PUBLIC
  Cause keypad to generate normal characters.
- twisted.conch.recvline.TransportSequence.selectCharacterSet
  twisted.conch.recvline.TransportSequence.html#selectCharacterSet
  Function
  Method
  PUBLIC
  Select a character set.
- twisted.conch.recvline.TransportSequence.shiftIn
  twisted.conch.recvline.TransportSequence.html#shiftIn
  Function
  Method
  PUBLIC
  Activate the G0 character set.
- twisted.conch.recvline.TransportSequence.shiftOut
  twisted.conch.recvline.TransportSequence.html#shiftOut
  Function
  Method
  PUBLIC
  Activate the G1 character set.
- twisted.conch.recvline.TransportSequence.singleShift2
  twisted.conch.recvline.TransportSequence.html#singleShift2
  Function
  Method
  PUBLIC
  Shift to the G2 character set for a single character.
- twisted.conch.recvline.TransportSequence.singleShift3
  twisted.conch.recvline.TransportSequence.html#singleShift3
  Function
  Method
  PUBLIC
  Shift to the G3 character set for a single character.
- twisted.conch.recvline.TransportSequence.selectGraphicRendition
  twisted.conch.recvline.TransportSequence.html#selectGraphicRendition
  Function
  Method
  PUBLIC
  Enabled one or more character attributes.
- twisted.conch.recvline.TransportSequence.horizontalTabulationSet
  twisted.conch.recvline.TransportSequence.html#horizontalTabulationSet
  Function
  Method
  PUBLIC
  Set a tab stop at the current cursor position.
- twisted.conch.recvline.TransportSequence.tabulationClear
  twisted.conch.recvline.TransportSequence.html#tabulationClear
  Function
  Method
  PUBLIC
  Clear the tab stop at the current cursor position.
- twisted.conch.recvline.TransportSequence.tabulationClearAll
  twisted.conch.recvline.TransportSequence.html#tabulationClearAll
  Function
  Method
  PUBLIC
  Clear all tab stops.
- twisted.conch.recvline.TransportSequence.doubleHeightLine
  twisted.conch.recvline.TransportSequence.html#doubleHeightLine
  Function
  Method
  PUBLIC
  Make the current line the top or bottom half of a double-height, double-width line.
- twisted.conch.recvline.TransportSequence.singleWidthLine
  twisted.conch.recvline.TransportSequence.html#singleWidthLine
  Function
  Method
  PUBLIC
  Make the current line a single-width, single-height line.
- twisted.conch.recvline.TransportSequence.doubleWidthLine
  twisted.conch.recvline.TransportSequence.html#doubleWidthLine
  Function
  Method
  PUBLIC
  Make the current line a double-width line.
- twisted.conch.recvline.TransportSequence.eraseToLineEnd
  twisted.conch.recvline.TransportSequence.html#eraseToLineEnd
  Function
  Method
  PUBLIC
  Erase from the cursor to the end of line, including cursor position.
- twisted.conch.recvline.TransportSequence.eraseToLineBeginning
  twisted.conch.recvline.TransportSequence.html#eraseToLineBeginning
  Function
  Method
  PUBLIC
  Erase from the cursor to the beginning of the line, including the cursor position.
- twisted.conch.recvline.TransportSequence.eraseLine
  twisted.conch.recvline.TransportSequence.html#eraseLine
  Function
  Method
  PUBLIC
  Erase the entire cursor line.
- twisted.conch.recvline.TransportSequence.eraseToDisplayEnd
  twisted.conch.recvline.TransportSequence.html#eraseToDisplayEnd
  Function
  Method
  PUBLIC
  Erase from the cursor to the end of the display, including the cursor position.
- twisted.conch.recvline.TransportSequence.eraseToDisplayBeginning
  twisted.conch.recvline.TransportSequence.html#eraseToDisplayBeginning
  Function
  Method
  PUBLIC
  Erase from the cursor to the beginning of the display, including the cursor position.
- twisted.conch.recvline.TransportSequence.eraseDisplay
  twisted.conch.recvline.TransportSequence.html#eraseDisplay
  Function
  Method
  PUBLIC
  Erase the entire display.
- twisted.conch.recvline.TransportSequence.deleteCharacter
  twisted.conch.recvline.TransportSequence.html#deleteCharacter
  Function
  Method
  PUBLIC
  Delete n characters starting at the cursor position.
- twisted.conch.recvline.TransportSequence.insertLine
  twisted.conch.recvline.TransportSequence.html#insertLine
  Function
  Method
  PUBLIC
  Insert n lines at the cursor position.
- twisted.conch.recvline.TransportSequence.deleteLine
  twisted.conch.recvline.TransportSequence.html#deleteLine
  Function
  Method
  PUBLIC
  Delete n lines starting at the cursor position.
- twisted.conch.recvline.TransportSequence.reportCursorPosition
  twisted.conch.recvline.TransportSequence.html#reportCursorPosition
  Function
  Method
  PUBLIC
  Return a Deferred that fires with a two-tuple of (x, y) indicating the cursor position.
- twisted.conch.recvline.TransportSequence.reset
  twisted.conch.recvline.TransportSequence.html#reset
  Function
  Method
  PUBLIC
  Reset the terminal to its initial state.
- twisted.conch.recvline.TransportSequence.unhandledControlSequence
  twisted.conch.recvline.TransportSequence.html#unhandledControlSequence
  Function
  Method
  PUBLIC
  Called when an unsupported control sequence is received.
- twisted.conch.recvline.LocalTerminalBufferMixin
  twisted.conch.recvline.LocalTerminalBufferMixin.html
  Class
  Class
  PUBLIC
  A mixin for RecvLine subclasses which records the state of the terminal.
- twisted.conch.recvline.LocalTerminalBufferMixin.terminalCopy
  twisted.conch.recvline.LocalTerminalBufferMixin.html#terminalCopy
  Attribute
  Instance Variable
  PUBLIC
  A `helper.TerminalBuffer` instance which efforts will be made to keep up to date with the actual terminal associated with this protocol instance.
- twisted.conch.recvline.LocalTerminalBufferMixin.makeConnection
  twisted.conch.recvline.LocalTerminalBufferMixin.html#makeConnection
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.recvline.LocalTerminalBufferMixin.__str__
  twisted.conch.recvline.LocalTerminalBufferMixin.html#__str__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.recvline.RecvLine
  twisted.conch.recvline.RecvLine.html
  Class
  Class
  PUBLIC
  `TerminalProtocol` which adds line editing features.
- twisted.conch.recvline.RecvLine.width
  twisted.conch.recvline.RecvLine.html#width
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.recvline.RecvLine.height
  twisted.conch.recvline.RecvLine.html#height
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.recvline.RecvLine.TABSTOP
  twisted.conch.recvline.RecvLine.html#TABSTOP
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.recvline.RecvLine.ps
  twisted.conch.recvline.RecvLine.html#ps
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.recvline.RecvLine.pn
  twisted.conch.recvline.RecvLine.html#pn
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.recvline.RecvLine._printableChars
  twisted.conch.recvline.RecvLine.html#_printableChars
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.conch.recvline.RecvLine._log
  twisted.conch.recvline.RecvLine.html#_log
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.conch.recvline.RecvLine.connectionMade
  twisted.conch.recvline.RecvLine.html#connectionMade
  Function
  Method
  PUBLIC
  Called after a connection has been established.
- twisted.conch.recvline.RecvLine.lineBuffer
  twisted.conch.recvline.RecvLine.html#lineBuffer
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.recvline.RecvLine.lineBufferIndex
  twisted.conch.recvline.RecvLine.html#lineBufferIndex
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.recvline.RecvLine.keyHandlers
  twisted.conch.recvline.RecvLine.html#keyHandlers
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.recvline.RecvLine.initializeScreen
  twisted.conch.recvline.RecvLine.html#initializeScreen
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.recvline.RecvLine.currentLineBuffer
  twisted.conch.recvline.RecvLine.html#currentLineBuffer
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.recvline.RecvLine.setInsertMode
  twisted.conch.recvline.RecvLine.html#setInsertMode
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.recvline.RecvLine.mode
  twisted.conch.recvline.RecvLine.html#mode
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.recvline.RecvLine.setTypeoverMode
  twisted.conch.recvline.RecvLine.html#setTypeoverMode
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.recvline.RecvLine.drawInputLine
  twisted.conch.recvline.RecvLine.html#drawInputLine
  Function
  Method
  PUBLIC
  Write a line containing the current input prompt and the current line buffer at the current cursor position.
- twisted.conch.recvline.RecvLine.terminalSize
  twisted.conch.recvline.RecvLine.html#terminalSize
  Function
  Method
  PUBLIC
  Called to indicate the size of the terminal.
- twisted.conch.recvline.RecvLine.unhandledControlSequence
  twisted.conch.recvline.RecvLine.html#unhandledControlSequence
  Function
  Method
  PUBLIC
  Called when an unsupported control sequence is received.
- twisted.conch.recvline.RecvLine.keystrokeReceived
  twisted.conch.recvline.RecvLine.html#keystrokeReceived
  Function
  Method
  PUBLIC
  A keystroke was received.
- twisted.conch.recvline.RecvLine.characterReceived
  twisted.conch.recvline.RecvLine.html#characterReceived
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.recvline.RecvLine.handle_TAB
  twisted.conch.recvline.RecvLine.html#handle_TAB
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.recvline.RecvLine.handle_LEFT
  twisted.conch.recvline.RecvLine.html#handle_LEFT
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.recvline.RecvLine.handle_RIGHT
  twisted.conch.recvline.RecvLine.html#handle_RIGHT
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.recvline.RecvLine.handle_HOME
  twisted.conch.recvline.RecvLine.html#handle_HOME
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.recvline.RecvLine.handle_END
  twisted.conch.recvline.RecvLine.html#handle_END
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.recvline.RecvLine.handle_BACKSPACE
  twisted.conch.recvline.RecvLine.html#handle_BACKSPACE
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.recvline.RecvLine.handle_DELETE
  twisted.conch.recvline.RecvLine.html#handle_DELETE
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.recvline.RecvLine.handle_RETURN
  twisted.conch.recvline.RecvLine.html#handle_RETURN
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.recvline.RecvLine.handle_INSERT
  twisted.conch.recvline.RecvLine.html#handle_INSERT
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.recvline.RecvLine.lineReceived
  twisted.conch.recvline.RecvLine.html#lineReceived
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.recvline.HistoricRecvLine
  twisted.conch.recvline.HistoricRecvLine.html
  Class
  Class
  PUBLIC
  `TerminalProtocol` which adds both basic line-editing features and input history.
- twisted.conch.recvline.HistoricRecvLine.connectionMade
  twisted.conch.recvline.HistoricRecvLine.html#connectionMade
  Function
  Method
  PUBLIC
  Called after a connection has been established.
- twisted.conch.recvline.HistoricRecvLine.historyLines
  twisted.conch.recvline.HistoricRecvLine.html#historyLines
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.recvline.HistoricRecvLine.historyPosition
  twisted.conch.recvline.HistoricRecvLine.html#historyPosition
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.recvline.HistoricRecvLine.currentHistoryBuffer
  twisted.conch.recvline.HistoricRecvLine.html#currentHistoryBuffer
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.recvline.HistoricRecvLine._deliverBuffer
  twisted.conch.recvline.HistoricRecvLine.html#_deliverBuffer
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.recvline.HistoricRecvLine.handle_UP
  twisted.conch.recvline.HistoricRecvLine.html#handle_UP
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.recvline.HistoricRecvLine.lineBuffer
  twisted.conch.recvline.HistoricRecvLine.html#lineBuffer
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.recvline.HistoricRecvLine.handle_DOWN
  twisted.conch.recvline.HistoricRecvLine.html#handle_DOWN
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.recvline.HistoricRecvLine.handle_RETURN
  twisted.conch.recvline.HistoricRecvLine.html#handle_RETURN
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.htmlizer.TokenPrinter
  twisted.python.htmlizer.TokenPrinter.html
  Class
  Class
  PUBLIC
  Format a stream of tokens and intermediate whitespace, for pretty-printing.
- twisted.python.htmlizer.TokenPrinter.currentCol
  twisted.python.htmlizer.TokenPrinter.html#currentCol
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.htmlizer.TokenPrinter.currentLine
  twisted.python.htmlizer.TokenPrinter.html#currentLine
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.htmlizer.TokenPrinter.lastIdentifier
  twisted.python.htmlizer.TokenPrinter.html#lastIdentifier
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.htmlizer.TokenPrinter.parameters
  twisted.python.htmlizer.TokenPrinter.html#parameters
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.htmlizer.TokenPrinter.encoding
  twisted.python.htmlizer.TokenPrinter.html#encoding
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.htmlizer.TokenPrinter.__init__
  twisted.python.htmlizer.TokenPrinter.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.python.htmlizer.TokenPrinter.writer
  twisted.python.htmlizer.TokenPrinter.html#writer
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.htmlizer.TokenPrinter.printtoken
  twisted.python.htmlizer.TokenPrinter.html#printtoken
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.htmlizer.HTMLWriter
  twisted.python.htmlizer.HTMLWriter.html
  Class
  Class
  PUBLIC
  Write the stream of tokens and whitespace from `TokenPrinter`, formating tokens as HTML spans.
- twisted.python.htmlizer.HTMLWriter.noSpan
  twisted.python.htmlizer.HTMLWriter.html#noSpan
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.htmlizer.HTMLWriter.__init__
  twisted.python.htmlizer.HTMLWriter.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.htmlizer.HTMLWriter.writer
  twisted.python.htmlizer.HTMLWriter.html#writer
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.htmlizer.HTMLWriter.write
  twisted.python.htmlizer.HTMLWriter.html#write
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.htmlizer.SmallerHTMLWriter
  twisted.python.htmlizer.SmallerHTMLWriter.html
  Class
  Class
  PUBLIC
  HTMLWriter that doesn't generate spans for some junk.
- twisted.python.htmlizer.SmallerHTMLWriter.noSpan
  twisted.python.htmlizer.SmallerHTMLWriter.html#noSpan
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.python.htmlizer.filter
  twisted.python.htmlizer.html#filter
  Function
  Function
  PUBLIC
  Undocumented
- twisted.python.htmlizer.main
  twisted.python.htmlizer.html#main
  Function
  Function
  PUBLIC
  Undocumented
- twisted.conch.manhole.FileWrapper
  twisted.conch.manhole.FileWrapper.html
  Class
  Class
  PUBLIC
  Minimal write-file-like object.
- twisted.conch.manhole.FileWrapper.softspace
  twisted.conch.manhole.FileWrapper.html#softspace
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.manhole.FileWrapper.state
  twisted.conch.manhole.FileWrapper.html#state
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.manhole.FileWrapper.__init__
  twisted.conch.manhole.FileWrapper.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.manhole.FileWrapper.o
  twisted.conch.manhole.FileWrapper.html#o
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.manhole.FileWrapper.flush
  twisted.conch.manhole.FileWrapper.html#flush
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.manhole.FileWrapper.write
  twisted.conch.manhole.FileWrapper.html#write
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.manhole.FileWrapper.writelines
  twisted.conch.manhole.FileWrapper.html#writelines
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.manhole.ManholeInterpreter
  twisted.conch.manhole.ManholeInterpreter.html
  Class
  Class
  PUBLIC
  Interactive Interpreter with special output and Deferred support.
- twisted.conch.manhole.ManholeInterpreter.numDeferreds
  twisted.conch.manhole.ManholeInterpreter.html#numDeferreds
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.manhole.ManholeInterpreter.__init__
  twisted.conch.manhole.ManholeInterpreter.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.manhole.ManholeInterpreter._pendingDeferreds
  twisted.conch.manhole.ManholeInterpreter.html#_pendingDeferreds
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.conch.manhole.ManholeInterpreter.handler
  twisted.conch.manhole.ManholeInterpreter.html#handler
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.manhole.ManholeInterpreter.filename
  twisted.conch.manhole.ManholeInterpreter.html#filename
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.manhole.ManholeInterpreter.resetBuffer
  twisted.conch.manhole.ManholeInterpreter.html#resetBuffer
  Function
  Method
  PUBLIC
  Reset the input buffer.
- twisted.conch.manhole.ManholeInterpreter.buffer
  twisted.conch.manhole.ManholeInterpreter.html#buffer
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.manhole.ManholeInterpreter.push
  twisted.conch.manhole.ManholeInterpreter.html#push
  Function
  Method
  PUBLIC
  Push a line to the interpreter.
- twisted.conch.manhole.ManholeInterpreter.runcode
  twisted.conch.manhole.ManholeInterpreter.html#runcode
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.manhole.ManholeInterpreter.displayhook
  twisted.conch.manhole.ManholeInterpreter.html#displayhook
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.manhole.ManholeInterpreter._cbDisplayDeferred
  twisted.conch.manhole.ManholeInterpreter.html#_cbDisplayDeferred
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.manhole.ManholeInterpreter._ebDisplayDeferred
  twisted.conch.manhole.ManholeInterpreter.html#_ebDisplayDeferred
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.manhole.ManholeInterpreter.write
  twisted.conch.manhole.ManholeInterpreter.html#write
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.manhole.CTRL_C
  twisted.conch.manhole.html#CTRL_C
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.manhole.CTRL_D
  twisted.conch.manhole.html#CTRL_D
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.manhole.CTRL_BACKSLASH
  twisted.conch.manhole.html#CTRL_BACKSLASH
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.manhole.CTRL_L
  twisted.conch.manhole.html#CTRL_L
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.manhole.CTRL_A
  twisted.conch.manhole.html#CTRL_A
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.manhole.CTRL_E
  twisted.conch.manhole.html#CTRL_E
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.manhole.Manhole
  twisted.conch.manhole.Manhole.html
  Class
  Class
  PUBLIC
  Mediator between a fancy line source and an interactive interpreter.
- twisted.conch.manhole.Manhole.namespace
  twisted.conch.manhole.Manhole.html#namespace
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.manhole.Manhole.__init__
  twisted.conch.manhole.Manhole.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.manhole.Manhole.connectionMade
  twisted.conch.manhole.Manhole.html#connectionMade
  Function
  Method
  PUBLIC
  Called after a connection has been established.
- twisted.conch.manhole.Manhole.interpreter
  twisted.conch.manhole.Manhole.html#interpreter
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.manhole.Manhole.handle_INT
  twisted.conch.manhole.Manhole.html#handle_INT
  Function
  Method
  PUBLIC
  Handle ^C as an interrupt keystroke by resetting the current input variables to their initial state.
- twisted.conch.manhole.Manhole.pn
  twisted.conch.manhole.Manhole.html#pn
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.manhole.Manhole.lineBuffer
  twisted.conch.manhole.Manhole.html#lineBuffer
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.manhole.Manhole.lineBufferIndex
  twisted.conch.manhole.Manhole.html#lineBufferIndex
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.manhole.Manhole.handle_EOF
  twisted.conch.manhole.Manhole.html#handle_EOF
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.manhole.Manhole.handle_FF
  twisted.conch.manhole.Manhole.html#handle_FF
  Function
  Method
  PUBLIC
  Handle a 'form feed' byte - generally used to request a screen refresh/redraw.
- twisted.conch.manhole.Manhole.handle_QUIT
  twisted.conch.manhole.Manhole.html#handle_QUIT
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.manhole.Manhole._needsNewline
  twisted.conch.manhole.Manhole.html#_needsNewline
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.manhole.Manhole.addOutput
  twisted.conch.manhole.Manhole.html#addOutput
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.manhole.Manhole.lineReceived
  twisted.conch.manhole.Manhole.html#lineReceived
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.manhole.VT102Writer
  twisted.conch.manhole.VT102Writer.html
  Class
  Class
  PUBLIC
  Colorizer for Python tokens.
- twisted.conch.manhole.VT102Writer.typeToColor
  twisted.conch.manhole.VT102Writer.html#typeToColor
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.manhole.VT102Writer.normalColor
  twisted.conch.manhole.VT102Writer.html#normalColor
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.manhole.VT102Writer.__init__
  twisted.conch.manhole.VT102Writer.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.manhole.VT102Writer.written
  twisted.conch.manhole.VT102Writer.html#written
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.manhole.VT102Writer.color
  twisted.conch.manhole.VT102Writer.html#color
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.manhole.VT102Writer.write
  twisted.conch.manhole.VT102Writer.html#write
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.manhole.VT102Writer.__bytes__
  twisted.conch.manhole.VT102Writer.html#__bytes__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.manhole.lastColorizedLine
  twisted.conch.manhole.html#lastColorizedLine
  Function
  Function
  PUBLIC
  Tokenize and colorize the given Python source.
- twisted.conch.manhole.ColoredManhole
  twisted.conch.manhole.ColoredManhole.html
  Class
  Class
  PUBLIC
  A REPL which syntax colors input as users type it.
- twisted.conch.manhole.ColoredManhole.getSource
  twisted.conch.manhole.ColoredManhole.html#getSource
  Function
  Method
  PUBLIC
  Return a string containing the currently entered source.
- twisted.conch.manhole.ColoredManhole.characterReceived
  twisted.conch.manhole.ColoredManhole.html#characterReceived
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh.factory.SSHFactory
  twisted.conch.ssh.factory.SSHFactory.html
  Class
  Class
  PUBLIC
  A Factory for SSH servers.
- twisted.conch.ssh.factory.SSHFactory._log
  twisted.conch.ssh.factory.SSHFactory.html#_log
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.conch.ssh.factory.SSHFactory.services
  twisted.conch.ssh.factory.SSHFactory.html#services
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.ssh.factory.SSHFactory.startFactory
  twisted.conch.ssh.factory.SSHFactory.html#startFactory
  Function
  Method
  PUBLIC
  Check for public and private keys.
- twisted.conch.ssh.factory.SSHFactory.publicKeys
  twisted.conch.ssh.factory.SSHFactory.html#publicKeys
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ssh.factory.SSHFactory.privateKeys
  twisted.conch.ssh.factory.SSHFactory.html#privateKeys
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ssh.factory.SSHFactory.primes
  twisted.conch.ssh.factory.SSHFactory.html#primes
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ssh.factory.SSHFactory.buildProtocol
  twisted.conch.ssh.factory.SSHFactory.html#buildProtocol
  Function
  Method
  PUBLIC
  Create an instance of the server side of the SSH protocol.
- twisted.conch.ssh.factory.SSHFactory.getPublicKeys
  twisted.conch.ssh.factory.SSHFactory.html#getPublicKeys
  Function
  Method
  PUBLIC
  Called when the factory is started to get the public portions of the servers host keys. Returns a dictionary mapping SSH key types to public key strings.
- twisted.conch.ssh.factory.SSHFactory.getPrivateKeys
  twisted.conch.ssh.factory.SSHFactory.html#getPrivateKeys
  Function
  Method
  PUBLIC
  Called when the factory is started to get the private portions of the servers host keys. Returns a dictionary mapping SSH key types to `twisted.conch.ssh.keys.Key` objects.
- twisted.conch.ssh.factory.SSHFactory.getPrimes
  twisted.conch.ssh.factory.SSHFactory.html#getPrimes
  Function
  Method
  PUBLIC
  Called when the factory is started to get Diffie-Hellman generators and primes to use. Returns a dictionary mapping number of bits to lists of tuple of (generator, prime).
- twisted.conch.ssh.factory.SSHFactory.getDHPrime
  twisted.conch.ssh.factory.SSHFactory.html#getDHPrime
  Function
  Method
  PUBLIC
  Return a tuple of (g, p) for a Diffe-Hellman process, with p being as close to bits bits as possible.
- twisted.conch.ssh.factory.SSHFactory.getService
  twisted.conch.ssh.factory.SSHFactory.html#getService
  Function
  Method
  PUBLIC
  Return a class to use as a service for the given transport.
- twisted.conch.ssh.session.log
  twisted.conch.ssh.session.html#log
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.conch.ssh.session.SSHSession
  twisted.conch.ssh.session.SSHSession.html
  Class
  Class
  PUBLIC
  A generalized implementation of an SSH session.
- twisted.conch.ssh.session.SSHSession.buf
  twisted.conch.ssh.session.SSHSession.html#buf
  Attribute
  Instance Variable
  PUBLIC
  a buffer for data received before making a connection to a client.
- twisted.conch.ssh.session.SSHSession.client
  twisted.conch.ssh.session.SSHSession.html#client
  Attribute
  Instance Variable
  PUBLIC
  a protocol for communication with a shell, an application program, or a subsystem (see RFC 4254, section 6.5).
- twisted.conch.ssh.session.SSHSession.session
  twisted.conch.ssh.session.SSHSession.html#session
  Attribute
  Instance Variable
  PUBLIC
  an object providing concrete implementations of session operations.
- twisted.conch.ssh.session.SSHSession.name
  twisted.conch.ssh.session.SSHSession.html#name
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.ssh.session.SSHSession.__init__
  twisted.conch.ssh.session.SSHSession.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh.session.SSHSession.request_subsystem
  twisted.conch.ssh.session.SSHSession.html#request_subsystem
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh.session.SSHSession.request_shell
  twisted.conch.ssh.session.SSHSession.html#request_shell
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh.session.SSHSession.request_exec
  twisted.conch.ssh.session.SSHSession.html#request_exec
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh.session.SSHSession.request_pty_req
  twisted.conch.ssh.session.SSHSession.html#request_pty_req
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh.session.SSHSession.request_env
  twisted.conch.ssh.session.SSHSession.html#request_env
  Function
  Method
  PUBLIC
  Process a request to pass an environment variable.
- twisted.conch.ssh.session.SSHSession.request_window_change
  twisted.conch.ssh.session.SSHSession.html#request_window_change
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh.session.SSHSession.dataReceived
  twisted.conch.ssh.session.SSHSession.html#dataReceived
  Function
  Method
  PUBLIC
  Called when we receive data.
- twisted.conch.ssh.session.SSHSession.extReceived
  twisted.conch.ssh.session.SSHSession.html#extReceived
  Function
  Method
  PUBLIC
  Called when we receive extended data (usually standard error).
- twisted.conch.ssh.session.SSHSession.eofReceived
  twisted.conch.ssh.session.SSHSession.html#eofReceived
  Function
  Method
  PUBLIC
  Called when the other side will send no more data.
- twisted.conch.ssh.session.SSHSession.closed
  twisted.conch.ssh.session.SSHSession.html#closed
  Function
  Method
  PUBLIC
  Called when the channel is closed. This means that both our side and the remote side have closed the channel.
- twisted.conch.ssh.session.SSHSession.loseConnection
  twisted.conch.ssh.session.SSHSession.html#loseConnection
  Function
  Method
  PUBLIC
  Close the channel if there is no buferred data. Otherwise, note the request and return.
- twisted.conch.ssh.session._ProtocolWrapper
  twisted.conch.ssh.session._ProtocolWrapper.html
  Class
  Class
  PRIVATE
  This class wraps a `Protocol` instance in a `ProcessProtocol` instance.
- twisted.conch.ssh.session._ProtocolWrapper.__init__
  twisted.conch.ssh.session._ProtocolWrapper.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh.session._ProtocolWrapper.proto
  twisted.conch.ssh.session._ProtocolWrapper.html#proto
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ssh.session._ProtocolWrapper.connectionMade
  twisted.conch.ssh.session._ProtocolWrapper.html#connectionMade
  Function
  Method
  PUBLIC
  Called when a connection is made.
- twisted.conch.ssh.session._ProtocolWrapper.outReceived
  twisted.conch.ssh.session._ProtocolWrapper.html#outReceived
  Function
  Method
  PUBLIC
  Some data was received from stdout.
- twisted.conch.ssh.session._ProtocolWrapper.processEnded
  twisted.conch.ssh.session._ProtocolWrapper.html#processEnded
  Function
  Method
  PUBLIC
  Called when the child process exits and all file descriptors associated with it have been closed.
- twisted.conch.ssh.session._DummyTransport
  twisted.conch.ssh.session._DummyTransport.html
  Class
  Class
  PRIVATE
  Undocumented
- twisted.conch.ssh.session._DummyTransport.__init__
  twisted.conch.ssh.session._DummyTransport.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh.session._DummyTransport.proto
  twisted.conch.ssh.session._DummyTransport.html#proto
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ssh.session._DummyTransport.dataReceived
  twisted.conch.ssh.session._DummyTransport.html#dataReceived
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh.session._DummyTransport.write
  twisted.conch.ssh.session._DummyTransport.html#write
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh.session._DummyTransport.writeSequence
  twisted.conch.ssh.session._DummyTransport.html#writeSequence
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh.session._DummyTransport.loseConnection
  twisted.conch.ssh.session._DummyTransport.html#loseConnection
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh.session.wrapProcessProtocol
  twisted.conch.ssh.session.html#wrapProcessProtocol
  Function
  Function
  PUBLIC
  Undocumented
- twisted.conch.ssh.session.wrapProtocol
  twisted.conch.ssh.session.html#wrapProtocol
  Function
  Function
  PUBLIC
  Undocumented
- twisted.conch.ssh.session.SUPPORTED_SIGNALS
  twisted.conch.ssh.session.html#SUPPORTED_SIGNALS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.session.SSHSessionProcessProtocol
  twisted.conch.ssh.session.SSHSessionProcessProtocol.html
  Class
  Class
  PUBLIC
  I am both an `IProcessProtocol` and an `ITransport`.
- twisted.conch.ssh.session.SSHSessionProcessProtocol._signalValuesToNames
  twisted.conch.ssh.session.SSHSessionProcessProtocol.html#_signalValuesToNames
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.conch.ssh.session.SSHSessionProcessProtocol.__init__
  twisted.conch.ssh.session.SSHSessionProcessProtocol.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh.session.SSHSessionProcessProtocol.session
  twisted.conch.ssh.session.SSHSessionProcessProtocol.html#session
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ssh.session.SSHSessionProcessProtocol.lostOutOrErrFlag
  twisted.conch.ssh.session.SSHSessionProcessProtocol.html#lostOutOrErrFlag
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ssh.session.SSHSessionProcessProtocol.connectionMade
  twisted.conch.ssh.session.SSHSessionProcessProtocol.html#connectionMade
  Function
  Method
  PUBLIC
  Called when a connection is made.
- twisted.conch.ssh.session.SSHSessionProcessProtocol.outReceived
  twisted.conch.ssh.session.SSHSessionProcessProtocol.html#outReceived
  Function
  Method
  PUBLIC
  Some data was received from stdout.
- twisted.conch.ssh.session.SSHSessionProcessProtocol.errReceived
  twisted.conch.ssh.session.SSHSessionProcessProtocol.html#errReceived
  Function
  Method
  PUBLIC
  Some data was received from stderr.
- twisted.conch.ssh.session.SSHSessionProcessProtocol.outConnectionLost
  twisted.conch.ssh.session.SSHSessionProcessProtocol.html#outConnectionLost
  Function
  Method
  PUBLIC
  EOF should only be sent when both STDOUT and STDERR have been closed.
- twisted.conch.ssh.session.SSHSessionProcessProtocol.errConnectionLost
  twisted.conch.ssh.session.SSHSessionProcessProtocol.html#errConnectionLost
  Function
  Method
  PUBLIC
  See outConnectionLost().
- twisted.conch.ssh.session.SSHSessionProcessProtocol.connectionLost
  twisted.conch.ssh.session.SSHSessionProcessProtocol.html#connectionLost
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh.session.SSHSessionProcessProtocol._getSignalName
  twisted.conch.ssh.session.SSHSessionProcessProtocol.html#_getSignalName
  Function
  Method
  PRIVATE
  Get a signal name given a signal number.
- twisted.conch.ssh.session.SSHSessionProcessProtocol.processEnded
  twisted.conch.ssh.session.SSHSessionProcessProtocol.html#processEnded
  Function
  Method
  PUBLIC
  When we are told the process ended, try to notify the other side about how the process ended using the exit-signal or exit-status requests. Also, close the channel.
- twisted.conch.ssh.session.SSHSessionProcessProtocol.getHost
  twisted.conch.ssh.session.SSHSessionProcessProtocol.html#getHost
  Function
  Method
  PUBLIC
  Return the host from my session's transport.
- twisted.conch.ssh.session.SSHSessionProcessProtocol.getPeer
  twisted.conch.ssh.session.SSHSessionProcessProtocol.html#getPeer
  Function
  Method
  PUBLIC
  Return the peer from my session's transport.
- twisted.conch.ssh.session.SSHSessionProcessProtocol.write
  twisted.conch.ssh.session.SSHSessionProcessProtocol.html#write
  Function
  Method
  PUBLIC
  Write some data to the physical connection, in sequence, in a non-blocking fashion.
- twisted.conch.ssh.session.SSHSessionProcessProtocol.writeSequence
  twisted.conch.ssh.session.SSHSessionProcessProtocol.html#writeSequence
  Function
  Method
  PUBLIC
  Write an iterable of byte strings to the physical connection.
- twisted.conch.ssh.session.SSHSessionProcessProtocol.loseConnection
  twisted.conch.ssh.session.SSHSessionProcessProtocol.html#loseConnection
  Function
  Method
  PUBLIC
  Close my connection, after writing all pending data.
- twisted.conch.ssh.session.SSHSessionClient
  twisted.conch.ssh.session.SSHSessionClient.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.conch.ssh.session.SSHSessionClient.dataReceived
  twisted.conch.ssh.session.SSHSessionClient.html#dataReceived
  Function
  Method
  PUBLIC
  Called whenever data is received.
- twisted.conch.ssh.session.parseRequest_pty_req
  twisted.conch.ssh.session.html#parseRequest_pty_req
  Function
  Function
  PUBLIC
  Parse the data from a pty-req request into usable data.
- twisted.conch.ssh.session.packRequest_pty_req
  twisted.conch.ssh.session.html#packRequest_pty_req
  Function
  Function
  PUBLIC
  Pack a pty-req request so that it is suitable for sending.
- twisted.conch.ssh.session.parseRequest_window_change
  twisted.conch.ssh.session.html#parseRequest_window_change
  Function
  Function
  PUBLIC
  Parse the data from a window-change request into usuable data.
- twisted.conch.ssh.session.packRequest_window_change
  twisted.conch.ssh.session.html#packRequest_window_change
  Function
  Function
  PUBLIC
  Pack a window-change request so that it is suitable for sending.
- twisted.conch.manhole_ssh._Glue
  twisted.conch.manhole_ssh._Glue.html
  Class
  Class
  PRIVATE
  A feeble class for making one attribute look like another.
- twisted.conch.manhole_ssh._Glue.__init__
  twisted.conch.manhole_ssh._Glue.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.manhole_ssh._Glue.__getattr__
  twisted.conch.manhole_ssh._Glue.html#__getattr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.manhole_ssh.TerminalSessionTransport
  twisted.conch.manhole_ssh.TerminalSessionTransport.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.conch.manhole_ssh.TerminalSessionTransport.__init__
  twisted.conch.manhole_ssh.TerminalSessionTransport.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.manhole_ssh.TerminalSessionTransport.proto
  twisted.conch.manhole_ssh.TerminalSessionTransport.html#proto
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.manhole_ssh.TerminalSessionTransport.avatar
  twisted.conch.manhole_ssh.TerminalSessionTransport.html#avatar
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.manhole_ssh.TerminalSessionTransport.chainedProtocol
  twisted.conch.manhole_ssh.TerminalSessionTransport.html#chainedProtocol
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.manhole_ssh.TerminalSession
  twisted.conch.manhole_ssh.TerminalSession.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.conch.manhole_ssh.TerminalSession.getPty
  twisted.conch.manhole_ssh.TerminalSession.html#getPty
  Function
  Method
  PUBLIC
  Get a pseudo-terminal for use by a shell or command.
- twisted.conch.manhole_ssh.TerminalSession.height
  twisted.conch.manhole_ssh.TerminalSession.html#height
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.manhole_ssh.TerminalSession.width
  twisted.conch.manhole_ssh.TerminalSession.html#width
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.manhole_ssh.TerminalSession.openShell
  twisted.conch.manhole_ssh.TerminalSession.html#openShell
  Function
  Method
  PUBLIC
  Open a shell and connect it to proto.
- twisted.conch.manhole_ssh.TerminalSession.execCommand
  twisted.conch.manhole_ssh.TerminalSession.html#execCommand
  Function
  Method
  PUBLIC
  Execute a command.
- twisted.conch.manhole_ssh.TerminalSession.windowChanged
  twisted.conch.manhole_ssh.TerminalSession.html#windowChanged
  Function
  Method
  PUBLIC
  Called when the size of the remote screen has changed.
- twisted.conch.manhole_ssh.TerminalSession.eofReceived
  twisted.conch.manhole_ssh.TerminalSession.html#eofReceived
  Function
  Method
  PUBLIC
  Called when the other side has indicated no more data will be sent.
- twisted.conch.manhole_ssh.TerminalSession.closed
  twisted.conch.manhole_ssh.TerminalSession.html#closed
  Function
  Method
  PUBLIC
  Called when the session is closed.
- twisted.conch.manhole_ssh.TerminalUser
  twisted.conch.manhole_ssh.TerminalUser.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.conch.manhole_ssh.TerminalUser.__init__
  twisted.conch.manhole_ssh.TerminalUser.html#__init__
  Function
  Method
  PUBLIC
  Set my 'original' attribute to be the object I am adapting.
- twisted.conch.manhole_ssh.TerminalRealm
  twisted.conch.manhole_ssh.TerminalRealm.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.conch.manhole_ssh.TerminalRealm._getAvatar
  twisted.conch.manhole_ssh.TerminalRealm.html#_getAvatar
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.manhole_ssh.TerminalRealm.__init__
  twisted.conch.manhole_ssh.TerminalRealm.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.manhole_ssh.TerminalRealm.transportFactory
  twisted.conch.manhole_ssh.TerminalRealm.html#transportFactory
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.manhole_ssh.TerminalRealm.requestAvatar
  twisted.conch.manhole_ssh.TerminalRealm.html#requestAvatar
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.manhole_ssh.ConchFactory
  twisted.conch.manhole_ssh.ConchFactory.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.conch.manhole_ssh.ConchFactory.publicKeys
  twisted.conch.manhole_ssh.ConchFactory.html#publicKeys
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.manhole_ssh.ConchFactory.privateKeys
  twisted.conch.manhole_ssh.ConchFactory.html#privateKeys
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.manhole_ssh.ConchFactory.__init__
  twisted.conch.manhole_ssh.ConchFactory.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.manhole_ssh.ConchFactory.portal
  twisted.conch.manhole_ssh.ConchFactory.html#portal
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.telnet._chr
  twisted.conch.telnet.html#_chr
  Function
  Function
  PRIVATE
  Create a byte sequence of length 1.
- twisted.conch.telnet.MODE
  twisted.conch.telnet.html#MODE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.EDIT
  twisted.conch.telnet.html#EDIT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.TRAPSIG
  twisted.conch.telnet.html#TRAPSIG
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.MODE_ACK
  twisted.conch.telnet.html#MODE_ACK
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.SOFT_TAB
  twisted.conch.telnet.html#SOFT_TAB
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.LIT_ECHO
  twisted.conch.telnet.html#LIT_ECHO
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.NULL
  twisted.conch.telnet.html#NULL
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.BEL
  twisted.conch.telnet.html#BEL
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.BS
  twisted.conch.telnet.html#BS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.HT
  twisted.conch.telnet.html#HT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.LF
  twisted.conch.telnet.html#LF
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.VT
  twisted.conch.telnet.html#VT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.FF
  twisted.conch.telnet.html#FF
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.CR
  twisted.conch.telnet.html#CR
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.ECHO
  twisted.conch.telnet.html#ECHO
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.SGA
  twisted.conch.telnet.html#SGA
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.NAWS
  twisted.conch.telnet.html#NAWS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.LINEMODE
  twisted.conch.telnet.html#LINEMODE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.EOR
  twisted.conch.telnet.html#EOR
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.SE
  twisted.conch.telnet.html#SE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.NOP
  twisted.conch.telnet.html#NOP
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.DM
  twisted.conch.telnet.html#DM
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.BRK
  twisted.conch.telnet.html#BRK
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.IP
  twisted.conch.telnet.html#IP
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.AO
  twisted.conch.telnet.html#AO
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.AYT
  twisted.conch.telnet.html#AYT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.EC
  twisted.conch.telnet.html#EC
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.EL
  twisted.conch.telnet.html#EL
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.GA
  twisted.conch.telnet.html#GA
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.SB
  twisted.conch.telnet.html#SB
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.WILL
  twisted.conch.telnet.html#WILL
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.WONT
  twisted.conch.telnet.html#WONT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.DO
  twisted.conch.telnet.html#DO
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.DONT
  twisted.conch.telnet.html#DONT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.IAC
  twisted.conch.telnet.html#IAC
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.LINEMODE_MODE
  twisted.conch.telnet.html#LINEMODE_MODE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.LINEMODE_EDIT
  twisted.conch.telnet.html#LINEMODE_EDIT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.LINEMODE_TRAPSIG
  twisted.conch.telnet.html#LINEMODE_TRAPSIG
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.LINEMODE_MODE_ACK
  twisted.conch.telnet.html#LINEMODE_MODE_ACK
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.LINEMODE_SOFT_TAB
  twisted.conch.telnet.html#LINEMODE_SOFT_TAB
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.LINEMODE_LIT_ECHO
  twisted.conch.telnet.html#LINEMODE_LIT_ECHO
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.LINEMODE_FORWARDMASK
  twisted.conch.telnet.html#LINEMODE_FORWARDMASK
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.LINEMODE_SLC
  twisted.conch.telnet.html#LINEMODE_SLC
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.LINEMODE_SLC_SYNCH
  twisted.conch.telnet.html#LINEMODE_SLC_SYNCH
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.LINEMODE_SLC_BRK
  twisted.conch.telnet.html#LINEMODE_SLC_BRK
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.LINEMODE_SLC_IP
  twisted.conch.telnet.html#LINEMODE_SLC_IP
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.LINEMODE_SLC_AO
  twisted.conch.telnet.html#LINEMODE_SLC_AO
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.LINEMODE_SLC_AYT
  twisted.conch.telnet.html#LINEMODE_SLC_AYT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.LINEMODE_SLC_EOR
  twisted.conch.telnet.html#LINEMODE_SLC_EOR
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.LINEMODE_SLC_ABORT
  twisted.conch.telnet.html#LINEMODE_SLC_ABORT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.LINEMODE_SLC_EOF
  twisted.conch.telnet.html#LINEMODE_SLC_EOF
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.LINEMODE_SLC_SUSP
  twisted.conch.telnet.html#LINEMODE_SLC_SUSP
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.LINEMODE_SLC_EC
  twisted.conch.telnet.html#LINEMODE_SLC_EC
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.LINEMODE_SLC_EL
  twisted.conch.telnet.html#LINEMODE_SLC_EL
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.LINEMODE_SLC_EW
  twisted.conch.telnet.html#LINEMODE_SLC_EW
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.LINEMODE_SLC_RP
  twisted.conch.telnet.html#LINEMODE_SLC_RP
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.LINEMODE_SLC_LNEXT
  twisted.conch.telnet.html#LINEMODE_SLC_LNEXT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.LINEMODE_SLC_XON
  twisted.conch.telnet.html#LINEMODE_SLC_XON
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.LINEMODE_SLC_XOFF
  twisted.conch.telnet.html#LINEMODE_SLC_XOFF
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.LINEMODE_SLC_FORW1
  twisted.conch.telnet.html#LINEMODE_SLC_FORW1
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.LINEMODE_SLC_FORW2
  twisted.conch.telnet.html#LINEMODE_SLC_FORW2
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.LINEMODE_SLC_MCL
  twisted.conch.telnet.html#LINEMODE_SLC_MCL
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.LINEMODE_SLC_MCR
  twisted.conch.telnet.html#LINEMODE_SLC_MCR
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.LINEMODE_SLC_MCWL
  twisted.conch.telnet.html#LINEMODE_SLC_MCWL
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.LINEMODE_SLC_MCWR
  twisted.conch.telnet.html#LINEMODE_SLC_MCWR
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.LINEMODE_SLC_MCBOL
  twisted.conch.telnet.html#LINEMODE_SLC_MCBOL
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.LINEMODE_SLC_MCEOL
  twisted.conch.telnet.html#LINEMODE_SLC_MCEOL
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.LINEMODE_SLC_INSRT
  twisted.conch.telnet.html#LINEMODE_SLC_INSRT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.LINEMODE_SLC_OVER
  twisted.conch.telnet.html#LINEMODE_SLC_OVER
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.LINEMODE_SLC_ECR
  twisted.conch.telnet.html#LINEMODE_SLC_ECR
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.LINEMODE_SLC_EWR
  twisted.conch.telnet.html#LINEMODE_SLC_EWR
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.LINEMODE_SLC_EBOL
  twisted.conch.telnet.html#LINEMODE_SLC_EBOL
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.LINEMODE_SLC_EEOL
  twisted.conch.telnet.html#LINEMODE_SLC_EEOL
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.LINEMODE_SLC_DEFAULT
  twisted.conch.telnet.html#LINEMODE_SLC_DEFAULT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.LINEMODE_SLC_VALUE
  twisted.conch.telnet.html#LINEMODE_SLC_VALUE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.LINEMODE_SLC_CANTCHANGE
  twisted.conch.telnet.html#LINEMODE_SLC_CANTCHANGE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.LINEMODE_SLC_NOSUPPORT
  twisted.conch.telnet.html#LINEMODE_SLC_NOSUPPORT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.LINEMODE_SLC_LEVELBITS
  twisted.conch.telnet.html#LINEMODE_SLC_LEVELBITS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.LINEMODE_SLC_ACK
  twisted.conch.telnet.html#LINEMODE_SLC_ACK
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.LINEMODE_SLC_FLUSHIN
  twisted.conch.telnet.html#LINEMODE_SLC_FLUSHIN
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.LINEMODE_SLC_FLUSHOUT
  twisted.conch.telnet.html#LINEMODE_SLC_FLUSHOUT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.LINEMODE_EOF
  twisted.conch.telnet.html#LINEMODE_EOF
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.LINEMODE_SUSP
  twisted.conch.telnet.html#LINEMODE_SUSP
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.LINEMODE_ABORT
  twisted.conch.telnet.html#LINEMODE_ABORT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.telnet.ITelnetProtocol
  twisted.conch.telnet.ITelnetProtocol.html
  Class
  Interface
  PUBLIC
  No interface docstring; 6/6 methods documented
- twisted.conch.telnet.ITelnetProtocol.unhandledCommand
  twisted.conch.telnet.ITelnetProtocol.html#unhandledCommand
  Function
  Method
  PUBLIC
  A command was received but not understood.
- twisted.conch.telnet.ITelnetProtocol.unhandledSubnegotiation
  twisted.conch.telnet.ITelnetProtocol.html#unhandledSubnegotiation
  Function
  Method
  PUBLIC
  A subnegotiation command was received but not understood.
- twisted.conch.telnet.ITelnetProtocol.enableLocal
  twisted.conch.telnet.ITelnetProtocol.html#enableLocal
  Function
  Method
  PUBLIC
  Enable the given option locally.
- twisted.conch.telnet.ITelnetProtocol.enableRemote
  twisted.conch.telnet.ITelnetProtocol.html#enableRemote
  Function
  Method
  PUBLIC
  Indicate whether the peer should be allowed to enable this option.
- twisted.conch.telnet.ITelnetProtocol.disableLocal
  twisted.conch.telnet.ITelnetProtocol.html#disableLocal
  Function
  Method
  PUBLIC
  Disable the given option locally.
- twisted.conch.telnet.ITelnetProtocol.disableRemote
  twisted.conch.telnet.ITelnetProtocol.html#disableRemote
  Function
  Method
  PUBLIC
  Indicate that the peer has disabled this option.
- twisted.conch.telnet.ITelnetTransport
  twisted.conch.telnet.ITelnetTransport.html
  Class
  Interface
  PUBLIC
  No interface docstring; 5/5 methods documented
- twisted.conch.telnet.ITelnetTransport.do
  twisted.conch.telnet.ITelnetTransport.html#do
  Function
  Method
  PUBLIC
  Indicate a desire for the peer to begin performing the given option.
- twisted.conch.telnet.ITelnetTransport.dont
  twisted.conch.telnet.ITelnetTransport.html#dont
  Function
  Method
  PUBLIC
  Indicate a desire for the peer to cease performing the given option.
- twisted.conch.telnet.ITelnetTransport.will
  twisted.conch.telnet.ITelnetTransport.html#will
  Function
  Method
  PUBLIC
  Indicate our willingness to begin performing this option locally.
- twisted.conch.telnet.ITelnetTransport.wont
  twisted.conch.telnet.ITelnetTransport.html#wont
  Function
  Method
  PUBLIC
  Indicate that we will stop performing the given option.
- twisted.conch.telnet.ITelnetTransport.requestNegotiation
  twisted.conch.telnet.ITelnetTransport.html#requestNegotiation
  Function
  Method
  PUBLIC
  Send a subnegotiation request.
- twisted.conch.telnet.TelnetError
  twisted.conch.telnet.TelnetError.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.conch.telnet.NegotiationError
  twisted.conch.telnet.NegotiationError.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.conch.telnet.NegotiationError.__str__
  twisted.conch.telnet.NegotiationError.html#__str__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.telnet.OptionRefused
  twisted.conch.telnet.OptionRefused.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.conch.telnet.AlreadyEnabled
  twisted.conch.telnet.AlreadyEnabled.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.conch.telnet.AlreadyDisabled
  twisted.conch.telnet.AlreadyDisabled.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.conch.telnet.AlreadyNegotiating
  twisted.conch.telnet.AlreadyNegotiating.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.conch.telnet.TelnetProtocol
  twisted.conch.telnet.TelnetProtocol.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.conch.telnet.TelnetProtocol._log
  twisted.conch.telnet.TelnetProtocol.html#_log
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.conch.telnet.TelnetProtocol.unhandledCommand
  twisted.conch.telnet.TelnetProtocol.html#unhandledCommand
  Function
  Method
  PUBLIC
  A command was received but not understood.
- twisted.conch.telnet.TelnetProtocol.unhandledSubnegotiation
  twisted.conch.telnet.TelnetProtocol.html#unhandledSubnegotiation
  Function
  Method
  PUBLIC
  A subnegotiation command was received but not understood.
- twisted.conch.telnet.TelnetProtocol.enableLocal
  twisted.conch.telnet.TelnetProtocol.html#enableLocal
  Function
  Method
  PUBLIC
  Enable the given option locally.
- twisted.conch.telnet.TelnetProtocol.enableRemote
  twisted.conch.telnet.TelnetProtocol.html#enableRemote
  Function
  Method
  PUBLIC
  Indicate whether the peer should be allowed to enable this option.
- twisted.conch.telnet.TelnetProtocol.disableLocal
  twisted.conch.telnet.TelnetProtocol.html#disableLocal
  Function
  Method
  PUBLIC
  Disable the given option locally.
- twisted.conch.telnet.TelnetProtocol.disableRemote
  twisted.conch.telnet.TelnetProtocol.html#disableRemote
  Function
  Method
  PUBLIC
  Indicate that the peer has disabled this option.
- twisted.conch.telnet.Telnet
  twisted.conch.telnet.Telnet.html
  Class
  Class
  PUBLIC
  No summary
- twisted.conch.telnet.Telnet.commandMap
  twisted.conch.telnet.Telnet.html#commandMap
  Attribute
  Instance Variable
  PUBLIC
  A mapping of bytes to callables. When a telnet command is received, the command byte (the first byte after IAC) is looked up in this dictionary. If a callable is found, it is invoked with the argument of the command, or None if the command takes no argument...
- twisted.conch.telnet.Telnet.negotiationMap
  twisted.conch.telnet.Telnet.html#negotiationMap
  Attribute
  Instance Variable
  PUBLIC
  A mapping of bytes to callables. When a subnegotiation command is received, the command byte (the first byte after SB) is looked up in this dictionary. If a callable is found, it is invoked with the argument of the subnegotiation...
- twisted.conch.telnet.Telnet.options
  twisted.conch.telnet.Telnet.html#options
  Attribute
  Instance Variable
  PUBLIC
  A mapping of option bytes to their current state. This state is likely of little use to user code. Changes should not be made to it.
- twisted.conch.telnet.Telnet.state
  twisted.conch.telnet.Telnet.html#state
  Attribute
  Instance Variable
  PUBLIC
  A string indicating the current parse state. It can take on the values "data", "escaped", "command", "newline", "subnegotiation", and "subnegotiation-escaped". Changes should not be made to it.
- twisted.conch.telnet.Telnet.transport
  twisted.conch.telnet.Telnet.html#transport
  Attribute
  Instance Variable
  PUBLIC
  This protocol's transport object.
- twisted.conch.telnet.Telnet.__init__
  twisted.conch.telnet.Telnet.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.telnet.Telnet._write
  twisted.conch.telnet.Telnet.html#_write
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.telnet.Telnet._OptionState
  twisted.conch.telnet.Telnet._OptionState.html
  Class
  Class
  PRIVATE
  Represents the state of an option on both sides of a telnet connection.
- twisted.conch.telnet.Telnet._OptionState.us
  twisted.conch.telnet.Telnet._OptionState.html#us
  Attribute
  Instance Variable
  PUBLIC
  The state of the option on this side of the connection.
- twisted.conch.telnet.Telnet._OptionState.him
  twisted.conch.telnet.Telnet._OptionState.html#him
  Attribute
  Instance Variable
  PUBLIC
  The state of the option on the other side of the connection.
- twisted.conch.telnet.Telnet._OptionState._Perspective
  twisted.conch.telnet.Telnet._OptionState._Perspective.html
  Class
  Class
  PRIVATE
  Represents the state of an option on side of the telnet connection. Some options can be enabled on a particular side of the connection (RFC 1073 for example: only the client can have NAWS enabled). Other options can be enabled on either or both sides (such as RFC 1372: each side can have its own flow control state).
- twisted.conch.telnet.Telnet._OptionState._Perspective.state
  twisted.conch.telnet.Telnet._OptionState._Perspective.html#state
  Attribute
  Instance Variable
  PUBLIC
  `'yes'` or `'no'` indicating whether or not this option is enabled on one side of the connection.
- twisted.conch.telnet.Telnet._OptionState._Perspective.negotiating
  twisted.conch.telnet.Telnet._OptionState._Perspective.html#negotiating
  Attribute
  Instance Variable
  PUBLIC
  A boolean tracking whether negotiation about this option is in progress.
- twisted.conch.telnet.Telnet._OptionState._Perspective.onResult
  twisted.conch.telnet.Telnet._OptionState._Perspective.html#onResult
  Attribute
  Instance Variable
  PUBLIC
  When negotiation about this option has been initiated by this side of the connection, a `Deferred` which will fire with the result of the negotiation. `None` at other times.
- twisted.conch.telnet.Telnet._OptionState._Perspective.__str__
  twisted.conch.telnet.Telnet._OptionState._Perspective.html#__str__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.telnet.Telnet._OptionState.__init__
  twisted.conch.telnet.Telnet._OptionState.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.telnet.Telnet._OptionState.__repr__
  twisted.conch.telnet.Telnet._OptionState.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.telnet.Telnet.getOptionState
  twisted.conch.telnet.Telnet.html#getOptionState
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.telnet.Telnet._do
  twisted.conch.telnet.Telnet.html#_do
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.telnet.Telnet._dont
  twisted.conch.telnet.Telnet.html#_dont
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.telnet.Telnet._will
  twisted.conch.telnet.Telnet.html#_will
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.telnet.Telnet._wont
  twisted.conch.telnet.Telnet.html#_wont
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.telnet.Telnet.will
  twisted.conch.telnet.Telnet.html#will
  Function
  Method
  PUBLIC
  Indicate our willingness to enable an option.
- twisted.conch.telnet.Telnet.wont
  twisted.conch.telnet.Telnet.html#wont
  Function
  Method
  PUBLIC
  Indicate we are not willing to enable an option.
- twisted.conch.telnet.Telnet.do
  twisted.conch.telnet.Telnet.html#do
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.telnet.Telnet.dont
  twisted.conch.telnet.Telnet.html#dont
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.telnet.Telnet.requestNegotiation
  twisted.conch.telnet.Telnet.html#requestNegotiation
  Function
  Method
  PUBLIC
  Send a negotiation message for the option `about` with `data` as the payload.
- twisted.conch.telnet.Telnet.dataReceived
  twisted.conch.telnet.Telnet.html#dataReceived
  Function
  Method
  PUBLIC
  Called whenever data is received.
- twisted.conch.telnet.Telnet.connectionLost
  twisted.conch.telnet.Telnet.html#connectionLost
  Function
  Method
  PUBLIC
  Called when the connection is shut down.
- twisted.conch.telnet.Telnet.applicationDataReceived
  twisted.conch.telnet.Telnet.html#applicationDataReceived
  Function
  Method
  PUBLIC
  Called with application-level data.
- twisted.conch.telnet.Telnet.unhandledCommand
  twisted.conch.telnet.Telnet.html#unhandledCommand
  Function
  Method
  PUBLIC
  Called for commands for which no handler is installed.
- twisted.conch.telnet.Telnet.commandReceived
  twisted.conch.telnet.Telnet.html#commandReceived
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.telnet.Telnet.unhandledSubnegotiation
  twisted.conch.telnet.Telnet.html#unhandledSubnegotiation
  Function
  Method
  PUBLIC
  Called for subnegotiations for which no handler is installed.
- twisted.conch.telnet.Telnet.negotiate
  twisted.conch.telnet.Telnet.html#negotiate
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.telnet.Telnet.telnet_WILL
  twisted.conch.telnet.Telnet.html#telnet_WILL
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.telnet.Telnet.will_no_false
  twisted.conch.telnet.Telnet.html#will_no_false
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.telnet.Telnet.will_no_true
  twisted.conch.telnet.Telnet.html#will_no_true
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.telnet.Telnet.will_yes_false
  twisted.conch.telnet.Telnet.html#will_yes_false
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.telnet.Telnet.will_yes_true
  twisted.conch.telnet.Telnet.html#will_yes_true
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.telnet.Telnet.willMap
  twisted.conch.telnet.Telnet.html#willMap
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.telnet.Telnet.telnet_WONT
  twisted.conch.telnet.Telnet.html#telnet_WONT
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.telnet.Telnet.wont_no_false
  twisted.conch.telnet.Telnet.html#wont_no_false
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.telnet.Telnet.wont_no_true
  twisted.conch.telnet.Telnet.html#wont_no_true
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.telnet.Telnet.wont_yes_false
  twisted.conch.telnet.Telnet.html#wont_yes_false
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.telnet.Telnet.wont_yes_true
  twisted.conch.telnet.Telnet.html#wont_yes_true
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.telnet.Telnet.wontMap
  twisted.conch.telnet.Telnet.html#wontMap
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.telnet.Telnet.telnet_DO
  twisted.conch.telnet.Telnet.html#telnet_DO
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.telnet.Telnet.do_no_false
  twisted.conch.telnet.Telnet.html#do_no_false
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.telnet.Telnet.do_no_true
  twisted.conch.telnet.Telnet.html#do_no_true
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.telnet.Telnet.do_yes_false
  twisted.conch.telnet.Telnet.html#do_yes_false
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.telnet.Telnet.do_yes_true
  twisted.conch.telnet.Telnet.html#do_yes_true
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.telnet.Telnet.doMap
  twisted.conch.telnet.Telnet.html#doMap
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.telnet.Telnet.telnet_DONT
  twisted.conch.telnet.Telnet.html#telnet_DONT
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.telnet.Telnet.dont_no_false
  twisted.conch.telnet.Telnet.html#dont_no_false
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.telnet.Telnet.dont_no_true
  twisted.conch.telnet.Telnet.html#dont_no_true
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.telnet.Telnet.dont_yes_false
  twisted.conch.telnet.Telnet.html#dont_yes_false
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.telnet.Telnet.dont_yes_true
  twisted.conch.telnet.Telnet.html#dont_yes_true
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.telnet.Telnet.dontMap
  twisted.conch.telnet.Telnet.html#dontMap
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.telnet.Telnet.enableLocal
  twisted.conch.telnet.Telnet.html#enableLocal
  Function
  Method
  PUBLIC
  Reject all attempts to enable options.
- twisted.conch.telnet.Telnet.enableRemote
  twisted.conch.telnet.Telnet.html#enableRemote
  Function
  Method
  PUBLIC
  Reject all attempts to enable options.
- twisted.conch.telnet.Telnet.disableLocal
  twisted.conch.telnet.Telnet.html#disableLocal
  Function
  Method
  PUBLIC
  Signal a programming error by raising an exception.
- twisted.conch.telnet.Telnet.disableRemote
  twisted.conch.telnet.Telnet.html#disableRemote
  Function
  Method
  PUBLIC
  Signal a programming error by raising an exception.
- twisted.conch.telnet.ProtocolTransportMixin
  twisted.conch.telnet.ProtocolTransportMixin.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.conch.telnet.ProtocolTransportMixin.write
  twisted.conch.telnet.ProtocolTransportMixin.html#write
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.telnet.ProtocolTransportMixin.writeSequence
  twisted.conch.telnet.ProtocolTransportMixin.html#writeSequence
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.telnet.ProtocolTransportMixin.loseConnection
  twisted.conch.telnet.ProtocolTransportMixin.html#loseConnection
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.telnet.ProtocolTransportMixin.getHost
  twisted.conch.telnet.ProtocolTransportMixin.html#getHost
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.telnet.ProtocolTransportMixin.getPeer
  twisted.conch.telnet.ProtocolTransportMixin.html#getPeer
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.telnet.TelnetTransport
  twisted.conch.telnet.TelnetTransport.html
  Class
  Class
  PUBLIC
  No summary
- twisted.conch.telnet.TelnetTransport.protocol
  twisted.conch.telnet.TelnetTransport.html#protocol
  Attribute
  Instance Variable
  PUBLIC
  An instance of the protocol to which this transport is connected, or None before the connection is established and after it is lost.
- twisted.conch.telnet.TelnetTransport.protocolFactory
  twisted.conch.telnet.TelnetTransport.html#protocolFactory
  Attribute
  Instance Variable
  PUBLIC
  A callable which returns protocol instances which provide `ITelnetProtocol`. This will be invoked when a connection is established. It is passed *protocolArgs and **protocolKwArgs.
- twisted.conch.telnet.TelnetTransport.protocolArgs
  twisted.conch.telnet.TelnetTransport.html#protocolArgs
  Attribute
  Instance Variable
  PUBLIC
  A tuple of additional arguments to pass to protocolFactory.
- twisted.conch.telnet.TelnetTransport.protocolKwArgs
  twisted.conch.telnet.TelnetTransport.html#protocolKwArgs
  Attribute
  Instance Variable
  PUBLIC
  A dictionary of additional arguments to pass to protocolFactory.
- twisted.conch.telnet.TelnetTransport.disconnecting
  twisted.conch.telnet.TelnetTransport.html#disconnecting
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.telnet.TelnetTransport.__init__
  twisted.conch.telnet.TelnetTransport.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.telnet.TelnetTransport.connectionMade
  twisted.conch.telnet.TelnetTransport.html#connectionMade
  Function
  Method
  PUBLIC
  Called when a connection is made.
- twisted.conch.telnet.TelnetTransport.connectionLost
  twisted.conch.telnet.TelnetTransport.html#connectionLost
  Function
  Method
  PUBLIC
  Called when the connection is shut down.
- twisted.conch.telnet.TelnetTransport.enableLocal
  twisted.conch.telnet.TelnetTransport.html#enableLocal
  Function
  Method
  PUBLIC
  Reject all attempts to enable options.
- twisted.conch.telnet.TelnetTransport.enableRemote
  twisted.conch.telnet.TelnetTransport.html#enableRemote
  Function
  Method
  PUBLIC
  Reject all attempts to enable options.
- twisted.conch.telnet.TelnetTransport.disableLocal
  twisted.conch.telnet.TelnetTransport.html#disableLocal
  Function
  Method
  PUBLIC
  Signal a programming error by raising an exception.
- twisted.conch.telnet.TelnetTransport.disableRemote
  twisted.conch.telnet.TelnetTransport.html#disableRemote
  Function
  Method
  PUBLIC
  Signal a programming error by raising an exception.
- twisted.conch.telnet.TelnetTransport.unhandledSubnegotiation
  twisted.conch.telnet.TelnetTransport.html#unhandledSubnegotiation
  Function
  Method
  PUBLIC
  Called for subnegotiations for which no handler is installed.
- twisted.conch.telnet.TelnetTransport.unhandledCommand
  twisted.conch.telnet.TelnetTransport.html#unhandledCommand
  Function
  Method
  PUBLIC
  Called for commands for which no handler is installed.
- twisted.conch.telnet.TelnetTransport.applicationDataReceived
  twisted.conch.telnet.TelnetTransport.html#applicationDataReceived
  Function
  Method
  PUBLIC
  Called with application-level data.
- twisted.conch.telnet.TelnetTransport.write
  twisted.conch.telnet.TelnetTransport.html#write
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.telnet.TelnetBootstrapProtocol
  twisted.conch.telnet.TelnetBootstrapProtocol.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.conch.telnet.TelnetBootstrapProtocol.protocol
  twisted.conch.telnet.TelnetBootstrapProtocol.html#protocol
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.telnet.TelnetBootstrapProtocol.__init__
  twisted.conch.telnet.TelnetBootstrapProtocol.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.telnet.TelnetBootstrapProtocol.protocolFactory
  twisted.conch.telnet.TelnetBootstrapProtocol.html#protocolFactory
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.telnet.TelnetBootstrapProtocol.protocolArgs
  twisted.conch.telnet.TelnetBootstrapProtocol.html#protocolArgs
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.telnet.TelnetBootstrapProtocol.protocolKwArgs
  twisted.conch.telnet.TelnetBootstrapProtocol.html#protocolKwArgs
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.telnet.TelnetBootstrapProtocol.connectionMade
  twisted.conch.telnet.TelnetBootstrapProtocol.html#connectionMade
  Function
  Method
  PUBLIC
  Called when a connection is made.
- twisted.conch.telnet.TelnetBootstrapProtocol.connectionLost
  twisted.conch.telnet.TelnetBootstrapProtocol.html#connectionLost
  Function
  Method
  PUBLIC
  Called when the connection is shut down.
- twisted.conch.telnet.TelnetBootstrapProtocol.dataReceived
  twisted.conch.telnet.TelnetBootstrapProtocol.html#dataReceived
  Function
  Method
  PUBLIC
  Called whenever data is received.
- twisted.conch.telnet.TelnetBootstrapProtocol.enableLocal
  twisted.conch.telnet.TelnetBootstrapProtocol.html#enableLocal
  Function
  Method
  PUBLIC
  Enable the given option locally.
- twisted.conch.telnet.TelnetBootstrapProtocol.enableRemote
  twisted.conch.telnet.TelnetBootstrapProtocol.html#enableRemote
  Function
  Method
  PUBLIC
  Indicate whether the peer should be allowed to enable this option.
- twisted.conch.telnet.TelnetBootstrapProtocol.telnet_NAWS
  twisted.conch.telnet.TelnetBootstrapProtocol.html#telnet_NAWS
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.telnet.TelnetBootstrapProtocol.linemodeSubcommands
  twisted.conch.telnet.TelnetBootstrapProtocol.html#linemodeSubcommands
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.telnet.TelnetBootstrapProtocol.telnet_LINEMODE
  twisted.conch.telnet.TelnetBootstrapProtocol.html#telnet_LINEMODE
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.telnet.TelnetBootstrapProtocol.linemode_SLC
  twisted.conch.telnet.TelnetBootstrapProtocol.html#linemode_SLC
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.telnet.StatefulTelnetProtocol
  twisted.conch.telnet.StatefulTelnetProtocol.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.conch.telnet.StatefulTelnetProtocol.delimiter
  twisted.conch.telnet.StatefulTelnetProtocol.html#delimiter
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.telnet.StatefulTelnetProtocol.state
  twisted.conch.telnet.StatefulTelnetProtocol.html#state
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.telnet.StatefulTelnetProtocol.connectionLost
  twisted.conch.telnet.StatefulTelnetProtocol.html#connectionLost
  Function
  Method
  PUBLIC
  Called when the connection is shut down.
- twisted.conch.telnet.StatefulTelnetProtocol.lineReceived
  twisted.conch.telnet.StatefulTelnetProtocol.html#lineReceived
  Function
  Method
  PUBLIC
  Override this for when each line is received.
- twisted.conch.telnet.StatefulTelnetProtocol.telnet_Discard
  twisted.conch.telnet.StatefulTelnetProtocol.html#telnet_Discard
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.telnet.AuthenticatingTelnetProtocol
  twisted.conch.telnet.AuthenticatingTelnetProtocol.html
  Class
  Class
  PUBLIC
  A protocol which prompts for credentials and attempts to authenticate them.
- twisted.conch.telnet.AuthenticatingTelnetProtocol.state
  twisted.conch.telnet.AuthenticatingTelnetProtocol.html#state
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.telnet.AuthenticatingTelnetProtocol.protocol
  twisted.conch.telnet.AuthenticatingTelnetProtocol.html#protocol
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.telnet.AuthenticatingTelnetProtocol.__init__
  twisted.conch.telnet.AuthenticatingTelnetProtocol.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.telnet.AuthenticatingTelnetProtocol.portal
  twisted.conch.telnet.AuthenticatingTelnetProtocol.html#portal
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.telnet.AuthenticatingTelnetProtocol.connectionMade
  twisted.conch.telnet.AuthenticatingTelnetProtocol.html#connectionMade
  Function
  Method
  PUBLIC
  Called when a connection is made.
- twisted.conch.telnet.AuthenticatingTelnetProtocol.connectionLost
  twisted.conch.telnet.AuthenticatingTelnetProtocol.html#connectionLost
  Function
  Method
  PUBLIC
  Called when the connection is shut down.
- twisted.conch.telnet.AuthenticatingTelnetProtocol.telnet_User
  twisted.conch.telnet.AuthenticatingTelnetProtocol.html#telnet_User
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.telnet.AuthenticatingTelnetProtocol.username
  twisted.conch.telnet.AuthenticatingTelnetProtocol.html#username
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.telnet.AuthenticatingTelnetProtocol.telnet_Password
  twisted.conch.telnet.AuthenticatingTelnetProtocol.html#telnet_Password
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.telnet.AuthenticatingTelnetProtocol._cbLogin
  twisted.conch.telnet.AuthenticatingTelnetProtocol.html#_cbLogin
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.telnet.AuthenticatingTelnetProtocol.logout
  twisted.conch.telnet.AuthenticatingTelnetProtocol.html#logout
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.telnet.AuthenticatingTelnetProtocol._ebLogin
  twisted.conch.telnet.AuthenticatingTelnetProtocol.html#_ebLogin
  Function
  Method
  PRIVATE
  Undocumented
- twisted.cred.portal.IRealm
  twisted.cred.portal.IRealm.html
  Class
  Interface
  PUBLIC
  The realm connects application-specific objects to the authentication system.
- twisted.cred.portal.IRealm.requestAvatar
  twisted.cred.portal.IRealm.html#requestAvatar
  Function
  Method
  PUBLIC
  Return avatar which provides one of the given interfaces.
- twisted.cred.portal.Portal
  twisted.cred.portal.Portal.html
  Class
  Class
  PUBLIC
  A mediator between clients and a realm.
- twisted.cred.portal.Portal.__init__
  twisted.cred.portal.Portal.html#__init__
  Function
  Method
  PUBLIC
  Create a Portal to a `IRealm`.
- twisted.cred.portal.Portal.realm
  twisted.cred.portal.Portal.html#realm
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.cred.portal.Portal.checkers
  twisted.cred.portal.Portal.html#checkers
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.cred.portal.Portal.listCredentialsInterfaces
  twisted.cred.portal.Portal.html#listCredentialsInterfaces
  Function
  Method
  PUBLIC
  Return list of credentials interfaces that can be used to login.
- twisted.cred.portal.Portal.registerChecker
  twisted.cred.portal.Portal.html#registerChecker
  Function
  Method
  PUBLIC
  Undocumented
- twisted.cred.portal.Portal.login
  twisted.cred.portal.Portal.html#login
  Function
  Method
  PUBLIC
  No summary
- twisted.conch.manhole_tap.makeTelnetProtocol
  twisted.conch.manhole_tap.makeTelnetProtocol.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.conch.manhole_tap.makeTelnetProtocol.__init__
  twisted.conch.manhole_tap.makeTelnetProtocol.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.manhole_tap.makeTelnetProtocol.portal
  twisted.conch.manhole_tap.makeTelnetProtocol.html#portal
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.manhole_tap.makeTelnetProtocol.__call__
  twisted.conch.manhole_tap.makeTelnetProtocol.html#__call__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.manhole_tap.chainedProtocolFactory
  twisted.conch.manhole_tap.chainedProtocolFactory.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.conch.manhole_tap.chainedProtocolFactory.__init__
  twisted.conch.manhole_tap.chainedProtocolFactory.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.manhole_tap.chainedProtocolFactory.namespace
  twisted.conch.manhole_tap.chainedProtocolFactory.html#namespace
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.manhole_tap.chainedProtocolFactory.__call__
  twisted.conch.manhole_tap.chainedProtocolFactory.html#__call__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.manhole_tap._StupidRealm
  twisted.conch.manhole_tap._StupidRealm.html
  Class
  Class
  PRIVATE
  Undocumented
- twisted.conch.manhole_tap._StupidRealm.__init__
  twisted.conch.manhole_tap._StupidRealm.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.manhole_tap._StupidRealm.protocolFactory
  twisted.conch.manhole_tap._StupidRealm.html#protocolFactory
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.manhole_tap._StupidRealm.protocolArgs
  twisted.conch.manhole_tap._StupidRealm.html#protocolArgs
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.manhole_tap._StupidRealm.protocolKwArgs
  twisted.conch.manhole_tap._StupidRealm.html#protocolKwArgs
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.manhole_tap._StupidRealm.requestAvatar
  twisted.conch.manhole_tap._StupidRealm.html#requestAvatar
  Function
  Method
  PUBLIC
  Return avatar which provides one of the given interfaces.
- twisted.conch.manhole_tap.Options
  twisted.conch.manhole_tap.Options.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.conch.manhole_tap.Options.optParameters
  twisted.conch.manhole_tap.Options.html#optParameters
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.manhole_tap.Options.__init__
  twisted.conch.manhole_tap.Options.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.manhole_tap.Options.postOptions
  twisted.conch.manhole_tap.Options.html#postOptions
  Function
  Method
  PUBLIC
  I am called after the options are parsed.
- twisted.conch.manhole_tap.makeService
  twisted.conch.manhole_tap.html#makeService
  Function
  Function
  PUBLIC
  Create a manhole server service.
- twisted.conch.mixin.BufferingMixin
  twisted.conch.mixin.BufferingMixin.html
  Class
  Class
  PUBLIC
  Mixin which adds write buffering.
- twisted.conch.mixin.BufferingMixin._delayedWriteCall
  twisted.conch.mixin.BufferingMixin.html#_delayedWriteCall
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.conch.mixin.BufferingMixin.data
  twisted.conch.mixin.BufferingMixin.html#data
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.mixin.BufferingMixin.DELAY
  twisted.conch.mixin.BufferingMixin.html#DELAY
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.mixin.BufferingMixin.schedule
  twisted.conch.mixin.BufferingMixin.html#schedule
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.mixin.BufferingMixin.reschedule
  twisted.conch.mixin.BufferingMixin.html#reschedule
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.mixin.BufferingMixin.write
  twisted.conch.mixin.BufferingMixin.html#write
  Function
  Method
  PUBLIC
  Buffer some bytes to be written soon.
- twisted.conch.mixin.BufferingMixin.flush
  twisted.conch.mixin.BufferingMixin.html#flush
  Function
  Method
  PUBLIC
  Flush the buffer immediately.
- twisted.conch.openssh_compat.primes.parseModuliFile
  twisted.conch.openssh_compat.primes.html#parseModuliFile
  Function
  Function
  PUBLIC
  Undocumented
- twisted.conch.openssh_compat.factory.OpenSSHFactory
  twisted.conch.openssh_compat.factory.OpenSSHFactory.html
  Class
  Class
  PUBLIC
  No class docstring; 0/2 class variable, 2/3 methods documented
- twisted.conch.openssh_compat.factory.OpenSSHFactory.dataRoot
  twisted.conch.openssh_compat.factory.OpenSSHFactory.html#dataRoot
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.openssh_compat.factory.OpenSSHFactory.moduliRoot
  twisted.conch.openssh_compat.factory.OpenSSHFactory.html#moduliRoot
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.openssh_compat.factory.OpenSSHFactory.getPublicKeys
  twisted.conch.openssh_compat.factory.OpenSSHFactory.html#getPublicKeys
  Function
  Method
  PUBLIC
  Return the server public keys.
- twisted.conch.openssh_compat.factory.OpenSSHFactory.getPrivateKeys
  twisted.conch.openssh_compat.factory.OpenSSHFactory.html#getPrivateKeys
  Function
  Method
  PUBLIC
  Return the server private keys.
- twisted.conch.openssh_compat.factory.OpenSSHFactory.getPrimes
  twisted.conch.openssh_compat.factory.OpenSSHFactory.html#getPrimes
  Function
  Method
  PUBLIC
  Called when the factory is started to get Diffie-Hellman generators and primes to use. Returns a dictionary mapping number of bits to lists of tuple of (generator, prime).
- twisted.conch.ssh.filetransfer.FileTransferBase
  twisted.conch.ssh.filetransfer.FileTransferBase.html
  Class
  Class
  PUBLIC
  No class docstring; 0/3 instance variable, 0/3 class variable, 1/6 method documented
- twisted.conch.ssh.filetransfer.FileTransferBase._log
  twisted.conch.ssh.filetransfer.FileTransferBase.html#_log
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.conch.ssh.filetransfer.FileTransferBase.versions
  twisted.conch.ssh.filetransfer.FileTransferBase.html#versions
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FileTransferBase.packetTypes
  twisted.conch.ssh.filetransfer.FileTransferBase.html#packetTypes
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FileTransferBase.__init__
  twisted.conch.ssh.filetransfer.FileTransferBase.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FileTransferBase.buf
  twisted.conch.ssh.filetransfer.FileTransferBase.html#buf
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FileTransferBase.otherVersion
  twisted.conch.ssh.filetransfer.FileTransferBase.html#otherVersion
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FileTransferBase.sendPacket
  twisted.conch.ssh.filetransfer.FileTransferBase.html#sendPacket
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FileTransferBase.dataReceived
  twisted.conch.ssh.filetransfer.FileTransferBase.html#dataReceived
  Function
  Method
  PUBLIC
  Called whenever data is received.
- twisted.conch.ssh.filetransfer.FileTransferBase._parseAttributes
  twisted.conch.ssh.filetransfer.FileTransferBase.html#_parseAttributes
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.ssh.filetransfer.FileTransferBase._packAttributes
  twisted.conch.ssh.filetransfer.FileTransferBase.html#_packAttributes
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.ssh.filetransfer.FileTransferBase.connectionLost
  twisted.conch.ssh.filetransfer.FileTransferBase.html#connectionLost
  Function
  Method
  PUBLIC
  Called when connection to the remote subsystem was lost.
- twisted.conch.ssh.filetransfer.FileTransferBase.connected
  twisted.conch.ssh.filetransfer.FileTransferBase.html#connected
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FileTransferServer
  twisted.conch.ssh.filetransfer.FileTransferServer.html
  Class
  Class
  PUBLIC
  No class docstring; 0/4 instance variable, 2/35 methods documented
- twisted.conch.ssh.filetransfer.FileTransferServer.__init__
  twisted.conch.ssh.filetransfer.FileTransferServer.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FileTransferServer.client
  twisted.conch.ssh.filetransfer.FileTransferServer.html#client
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FileTransferServer.openFiles
  twisted.conch.ssh.filetransfer.FileTransferServer.html#openFiles
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FileTransferServer.openDirs
  twisted.conch.ssh.filetransfer.FileTransferServer.html#openDirs
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FileTransferServer.packet_INIT
  twisted.conch.ssh.filetransfer.FileTransferServer.html#packet_INIT
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FileTransferServer.version
  twisted.conch.ssh.filetransfer.FileTransferServer.html#version
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FileTransferServer.packet_OPEN
  twisted.conch.ssh.filetransfer.FileTransferServer.html#packet_OPEN
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FileTransferServer._cbOpenFile
  twisted.conch.ssh.filetransfer.FileTransferServer.html#_cbOpenFile
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.ssh.filetransfer.FileTransferServer.packet_CLOSE
  twisted.conch.ssh.filetransfer.FileTransferServer.html#packet_CLOSE
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FileTransferServer._cbClose
  twisted.conch.ssh.filetransfer.FileTransferServer.html#_cbClose
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.ssh.filetransfer.FileTransferServer.packet_READ
  twisted.conch.ssh.filetransfer.FileTransferServer.html#packet_READ
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FileTransferServer._cbRead
  twisted.conch.ssh.filetransfer.FileTransferServer.html#_cbRead
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.ssh.filetransfer.FileTransferServer.packet_WRITE
  twisted.conch.ssh.filetransfer.FileTransferServer.html#packet_WRITE
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FileTransferServer.packet_REMOVE
  twisted.conch.ssh.filetransfer.FileTransferServer.html#packet_REMOVE
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FileTransferServer.packet_RENAME
  twisted.conch.ssh.filetransfer.FileTransferServer.html#packet_RENAME
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FileTransferServer.packet_MKDIR
  twisted.conch.ssh.filetransfer.FileTransferServer.html#packet_MKDIR
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FileTransferServer.packet_RMDIR
  twisted.conch.ssh.filetransfer.FileTransferServer.html#packet_RMDIR
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FileTransferServer.packet_OPENDIR
  twisted.conch.ssh.filetransfer.FileTransferServer.html#packet_OPENDIR
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FileTransferServer._cbOpenDirectory
  twisted.conch.ssh.filetransfer.FileTransferServer.html#_cbOpenDirectory
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.ssh.filetransfer.FileTransferServer.packet_READDIR
  twisted.conch.ssh.filetransfer.FileTransferServer.html#packet_READDIR
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FileTransferServer._scanDirectory
  twisted.conch.ssh.filetransfer.FileTransferServer.html#_scanDirectory
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.ssh.filetransfer.FileTransferServer._cbScanDirectory
  twisted.conch.ssh.filetransfer.FileTransferServer.html#_cbScanDirectory
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.ssh.filetransfer.FileTransferServer._cbSendDirectory
  twisted.conch.ssh.filetransfer.FileTransferServer.html#_cbSendDirectory
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.ssh.filetransfer.FileTransferServer.packet_STAT
  twisted.conch.ssh.filetransfer.FileTransferServer.html#packet_STAT
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FileTransferServer.packet_LSTAT
  twisted.conch.ssh.filetransfer.FileTransferServer.html#packet_LSTAT
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FileTransferServer.packet_FSTAT
  twisted.conch.ssh.filetransfer.FileTransferServer.html#packet_FSTAT
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FileTransferServer._cbStat
  twisted.conch.ssh.filetransfer.FileTransferServer.html#_cbStat
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.ssh.filetransfer.FileTransferServer.packet_SETSTAT
  twisted.conch.ssh.filetransfer.FileTransferServer.html#packet_SETSTAT
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FileTransferServer.packet_FSETSTAT
  twisted.conch.ssh.filetransfer.FileTransferServer.html#packet_FSETSTAT
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FileTransferServer.packet_READLINK
  twisted.conch.ssh.filetransfer.FileTransferServer.html#packet_READLINK
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FileTransferServer._cbReadLink
  twisted.conch.ssh.filetransfer.FileTransferServer.html#_cbReadLink
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.ssh.filetransfer.FileTransferServer.packet_SYMLINK
  twisted.conch.ssh.filetransfer.FileTransferServer.html#packet_SYMLINK
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FileTransferServer.packet_REALPATH
  twisted.conch.ssh.filetransfer.FileTransferServer.html#packet_REALPATH
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FileTransferServer.packet_EXTENDED
  twisted.conch.ssh.filetransfer.FileTransferServer.html#packet_EXTENDED
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FileTransferServer._cbExtended
  twisted.conch.ssh.filetransfer.FileTransferServer.html#_cbExtended
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.ssh.filetransfer.FileTransferServer._cbStatus
  twisted.conch.ssh.filetransfer.FileTransferServer.html#_cbStatus
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.ssh.filetransfer.FileTransferServer._ebStatus
  twisted.conch.ssh.filetransfer.FileTransferServer.html#_ebStatus
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.ssh.filetransfer.FileTransferServer._sendStatus
  twisted.conch.ssh.filetransfer.FileTransferServer.html#_sendStatus
  Function
  Method
  PRIVATE
  Helper method to send a FXP_STATUS message.
- twisted.conch.ssh.filetransfer.FileTransferServer.connectionLost
  twisted.conch.ssh.filetransfer.FileTransferServer.html#connectionLost
  Function
  Method
  PUBLIC
  Called when connection to the remote subsystem was lost.
- twisted.conch.ssh.filetransfer.FileTransferClient
  twisted.conch.ssh.filetransfer.FileTransferClient.html
  Class
  Class
  PUBLIC
  No class docstring; 0/4 instance variable, 17/27 methods documented
- twisted.conch.ssh.filetransfer.FileTransferClient.__init__
  twisted.conch.ssh.filetransfer.FileTransferClient.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.conch.ssh.filetransfer.FileTransferClient.extData
  twisted.conch.ssh.filetransfer.FileTransferClient.html#extData
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FileTransferClient.counter
  twisted.conch.ssh.filetransfer.FileTransferClient.html#counter
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FileTransferClient.openRequests
  twisted.conch.ssh.filetransfer.FileTransferClient.html#openRequests
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FileTransferClient.connectionMade
  twisted.conch.ssh.filetransfer.FileTransferClient.html#connectionMade
  Function
  Method
  PUBLIC
  Called when a connection is made.
- twisted.conch.ssh.filetransfer.FileTransferClient.connectionLost
  twisted.conch.ssh.filetransfer.FileTransferClient.html#connectionLost
  Function
  Method
  PUBLIC
  Called when connection to the remote subsystem was lost.
- twisted.conch.ssh.filetransfer.FileTransferClient._sendRequest
  twisted.conch.ssh.filetransfer.FileTransferClient.html#_sendRequest
  Function
  Method
  PRIVATE
  Send a request and return a deferred which waits for the result.
- twisted.conch.ssh.filetransfer.FileTransferClient._parseRequest
  twisted.conch.ssh.filetransfer.FileTransferClient.html#_parseRequest
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.ssh.filetransfer.FileTransferClient.openFile
  twisted.conch.ssh.filetransfer.FileTransferClient.html#openFile
  Function
  Method
  PUBLIC
  Open a file.
- twisted.conch.ssh.filetransfer.FileTransferClient._cbOpenHandle
  twisted.conch.ssh.filetransfer.FileTransferClient.html#_cbOpenHandle
  Function
  Method
  PRIVATE
  Callback invoked when an OPEN or OPENDIR request succeeds.
- twisted.conch.ssh.filetransfer.FileTransferClient.removeFile
  twisted.conch.ssh.filetransfer.FileTransferClient.html#removeFile
  Function
  Method
  PUBLIC
  Remove the given file.
- twisted.conch.ssh.filetransfer.FileTransferClient.renameFile
  twisted.conch.ssh.filetransfer.FileTransferClient.html#renameFile
  Function
  Method
  PUBLIC
  Rename the given file.
- twisted.conch.ssh.filetransfer.FileTransferClient.makeDirectory
  twisted.conch.ssh.filetransfer.FileTransferClient.html#makeDirectory
  Function
  Method
  PUBLIC
  Make a directory.
- twisted.conch.ssh.filetransfer.FileTransferClient.removeDirectory
  twisted.conch.ssh.filetransfer.FileTransferClient.html#removeDirectory
  Function
  Method
  PUBLIC
  Remove a directory (non-recursively)
- twisted.conch.ssh.filetransfer.FileTransferClient.openDirectory
  twisted.conch.ssh.filetransfer.FileTransferClient.html#openDirectory
  Function
  Method
  PUBLIC
  Open a directory for scanning.
- twisted.conch.ssh.filetransfer.FileTransferClient.getAttrs
  twisted.conch.ssh.filetransfer.FileTransferClient.html#getAttrs
  Function
  Method
  PUBLIC
  Return the attributes for the given path.
- twisted.conch.ssh.filetransfer.FileTransferClient.setAttrs
  twisted.conch.ssh.filetransfer.FileTransferClient.html#setAttrs
  Function
  Method
  PUBLIC
  Set the attributes for the path.
- twisted.conch.ssh.filetransfer.FileTransferClient.readLink
  twisted.conch.ssh.filetransfer.FileTransferClient.html#readLink
  Function
  Method
  PUBLIC
  Find the root of a set of symbolic links.
- twisted.conch.ssh.filetransfer.FileTransferClient.makeLink
  twisted.conch.ssh.filetransfer.FileTransferClient.html#makeLink
  Function
  Method
  PUBLIC
  Create a symbolic link.
- twisted.conch.ssh.filetransfer.FileTransferClient.realPath
  twisted.conch.ssh.filetransfer.FileTransferClient.html#realPath
  Function
  Method
  PUBLIC
  Convert any path to an absolute path.
- twisted.conch.ssh.filetransfer.FileTransferClient._cbRealPath
  twisted.conch.ssh.filetransfer.FileTransferClient.html#_cbRealPath
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.ssh.filetransfer.FileTransferClient.extendedRequest
  twisted.conch.ssh.filetransfer.FileTransferClient.html#extendedRequest
  Function
  Method
  PUBLIC
  Make an extended request of the server.
- twisted.conch.ssh.filetransfer.FileTransferClient.packet_VERSION
  twisted.conch.ssh.filetransfer.FileTransferClient.html#packet_VERSION
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FileTransferClient.version
  twisted.conch.ssh.filetransfer.FileTransferClient.html#version
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FileTransferClient.packet_STATUS
  twisted.conch.ssh.filetransfer.FileTransferClient.html#packet_STATUS
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FileTransferClient.packet_HANDLE
  twisted.conch.ssh.filetransfer.FileTransferClient.html#packet_HANDLE
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FileTransferClient.packet_DATA
  twisted.conch.ssh.filetransfer.FileTransferClient.html#packet_DATA
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FileTransferClient.packet_NAME
  twisted.conch.ssh.filetransfer.FileTransferClient.html#packet_NAME
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FileTransferClient.packet_ATTRS
  twisted.conch.ssh.filetransfer.FileTransferClient.html#packet_ATTRS
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FileTransferClient.packet_EXTENDED_REPLY
  twisted.conch.ssh.filetransfer.FileTransferClient.html#packet_EXTENDED_REPLY
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FileTransferClient.gotServerVersion
  twisted.conch.ssh.filetransfer.FileTransferClient.html#gotServerVersion
  Function
  Method
  PUBLIC
  Called when the client sends their version info.
- twisted.conch.ssh.filetransfer.ClientFile
  twisted.conch.ssh.filetransfer.ClientFile.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.ClientFile.__init__
  twisted.conch.ssh.filetransfer.ClientFile.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.ClientFile.parent
  twisted.conch.ssh.filetransfer.ClientFile.html#parent
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.ClientFile.handle
  twisted.conch.ssh.filetransfer.ClientFile.html#handle
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.ClientFile.close
  twisted.conch.ssh.filetransfer.ClientFile.html#close
  Function
  Method
  PUBLIC
  Close the file.
- twisted.conch.ssh.filetransfer.ClientFile.readChunk
  twisted.conch.ssh.filetransfer.ClientFile.html#readChunk
  Function
  Method
  PUBLIC
  Read from the file.
- twisted.conch.ssh.filetransfer.ClientFile.writeChunk
  twisted.conch.ssh.filetransfer.ClientFile.html#writeChunk
  Function
  Method
  PUBLIC
  Write to the file.
- twisted.conch.ssh.filetransfer.ClientFile.getAttrs
  twisted.conch.ssh.filetransfer.ClientFile.html#getAttrs
  Function
  Method
  PUBLIC
  Return the attributes for the file.
- twisted.conch.ssh.filetransfer.ClientFile.setAttrs
  twisted.conch.ssh.filetransfer.ClientFile.html#setAttrs
  Function
  Method
  PUBLIC
  Set the attributes for the file.
- twisted.conch.ssh.filetransfer.ClientDirectory
  twisted.conch.ssh.filetransfer.ClientDirectory.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.ClientDirectory.__init__
  twisted.conch.ssh.filetransfer.ClientDirectory.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.ClientDirectory.parent
  twisted.conch.ssh.filetransfer.ClientDirectory.html#parent
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.ClientDirectory.handle
  twisted.conch.ssh.filetransfer.ClientDirectory.html#handle
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.ClientDirectory.filesCache
  twisted.conch.ssh.filetransfer.ClientDirectory.html#filesCache
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.ClientDirectory.read
  twisted.conch.ssh.filetransfer.ClientDirectory.html#read
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.ClientDirectory.close
  twisted.conch.ssh.filetransfer.ClientDirectory.html#close
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.ClientDirectory.__iter__
  twisted.conch.ssh.filetransfer.ClientDirectory.html#__iter__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.ClientDirectory.__next__
  twisted.conch.ssh.filetransfer.ClientDirectory.html#__next__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.ClientDirectory._cbReadDir
  twisted.conch.ssh.filetransfer.ClientDirectory.html#_cbReadDir
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.ssh.filetransfer.ClientDirectory._ebReadDir
  twisted.conch.ssh.filetransfer.ClientDirectory.html#_ebReadDir
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.ssh.filetransfer.SFTPError
  twisted.conch.ssh.filetransfer.SFTPError.html
  Class
  Exception
  PUBLIC
  No exception docstring; 1/1 property, 0/3 instance variable, 0/2 method documented
- twisted.conch.ssh.filetransfer.SFTPError.__init__
  twisted.conch.ssh.filetransfer.SFTPError.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.SFTPError.code
  twisted.conch.ssh.filetransfer.SFTPError.html#code
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.SFTPError._message
  twisted.conch.ssh.filetransfer.SFTPError.html#_message
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.conch.ssh.filetransfer.SFTPError.lang
  twisted.conch.ssh.filetransfer.SFTPError.html#lang
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.SFTPError.message
  twisted.conch.ssh.filetransfer.SFTPError.html#message
  Attribute
  Property
  PUBLIC
  A string received over the network that explains the error to a human.
- twisted.conch.ssh.filetransfer.SFTPError.__str__
  twisted.conch.ssh.filetransfer.SFTPError.html#__str__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FXP_INIT
  twisted.conch.ssh.filetransfer.html#FXP_INIT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FXP_VERSION
  twisted.conch.ssh.filetransfer.html#FXP_VERSION
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FXP_OPEN
  twisted.conch.ssh.filetransfer.html#FXP_OPEN
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FXP_CLOSE
  twisted.conch.ssh.filetransfer.html#FXP_CLOSE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FXP_READ
  twisted.conch.ssh.filetransfer.html#FXP_READ
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FXP_WRITE
  twisted.conch.ssh.filetransfer.html#FXP_WRITE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FXP_LSTAT
  twisted.conch.ssh.filetransfer.html#FXP_LSTAT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FXP_FSTAT
  twisted.conch.ssh.filetransfer.html#FXP_FSTAT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FXP_SETSTAT
  twisted.conch.ssh.filetransfer.html#FXP_SETSTAT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FXP_FSETSTAT
  twisted.conch.ssh.filetransfer.html#FXP_FSETSTAT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FXP_OPENDIR
  twisted.conch.ssh.filetransfer.html#FXP_OPENDIR
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FXP_READDIR
  twisted.conch.ssh.filetransfer.html#FXP_READDIR
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FXP_REMOVE
  twisted.conch.ssh.filetransfer.html#FXP_REMOVE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FXP_MKDIR
  twisted.conch.ssh.filetransfer.html#FXP_MKDIR
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FXP_RMDIR
  twisted.conch.ssh.filetransfer.html#FXP_RMDIR
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FXP_REALPATH
  twisted.conch.ssh.filetransfer.html#FXP_REALPATH
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FXP_STAT
  twisted.conch.ssh.filetransfer.html#FXP_STAT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FXP_RENAME
  twisted.conch.ssh.filetransfer.html#FXP_RENAME
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FXP_READLINK
  twisted.conch.ssh.filetransfer.html#FXP_READLINK
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FXP_SYMLINK
  twisted.conch.ssh.filetransfer.html#FXP_SYMLINK
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FXP_STATUS
  twisted.conch.ssh.filetransfer.html#FXP_STATUS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FXP_HANDLE
  twisted.conch.ssh.filetransfer.html#FXP_HANDLE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FXP_DATA
  twisted.conch.ssh.filetransfer.html#FXP_DATA
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FXP_NAME
  twisted.conch.ssh.filetransfer.html#FXP_NAME
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FXP_ATTRS
  twisted.conch.ssh.filetransfer.html#FXP_ATTRS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FXP_EXTENDED
  twisted.conch.ssh.filetransfer.html#FXP_EXTENDED
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FXP_EXTENDED_REPLY
  twisted.conch.ssh.filetransfer.html#FXP_EXTENDED_REPLY
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FILEXFER_ATTR_SIZE
  twisted.conch.ssh.filetransfer.html#FILEXFER_ATTR_SIZE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FILEXFER_ATTR_UIDGID
  twisted.conch.ssh.filetransfer.html#FILEXFER_ATTR_UIDGID
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FILEXFER_ATTR_PERMISSIONS
  twisted.conch.ssh.filetransfer.html#FILEXFER_ATTR_PERMISSIONS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FILEXFER_ATTR_ACMODTIME
  twisted.conch.ssh.filetransfer.html#FILEXFER_ATTR_ACMODTIME
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FILEXFER_ATTR_EXTENDED
  twisted.conch.ssh.filetransfer.html#FILEXFER_ATTR_EXTENDED
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FILEXFER_TYPE_REGULAR
  twisted.conch.ssh.filetransfer.html#FILEXFER_TYPE_REGULAR
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FILEXFER_TYPE_DIRECTORY
  twisted.conch.ssh.filetransfer.html#FILEXFER_TYPE_DIRECTORY
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FILEXFER_TYPE_SYMLINK
  twisted.conch.ssh.filetransfer.html#FILEXFER_TYPE_SYMLINK
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FILEXFER_TYPE_SPECIAL
  twisted.conch.ssh.filetransfer.html#FILEXFER_TYPE_SPECIAL
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FILEXFER_TYPE_UNKNOWN
  twisted.conch.ssh.filetransfer.html#FILEXFER_TYPE_UNKNOWN
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FXF_READ
  twisted.conch.ssh.filetransfer.html#FXF_READ
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FXF_WRITE
  twisted.conch.ssh.filetransfer.html#FXF_WRITE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FXF_APPEND
  twisted.conch.ssh.filetransfer.html#FXF_APPEND
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FXF_CREAT
  twisted.conch.ssh.filetransfer.html#FXF_CREAT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FXF_TRUNC
  twisted.conch.ssh.filetransfer.html#FXF_TRUNC
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FXF_EXCL
  twisted.conch.ssh.filetransfer.html#FXF_EXCL
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FXF_TEXT
  twisted.conch.ssh.filetransfer.html#FXF_TEXT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FX_OK
  twisted.conch.ssh.filetransfer.html#FX_OK
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FX_EOF
  twisted.conch.ssh.filetransfer.html#FX_EOF
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FX_NO_SUCH_FILE
  twisted.conch.ssh.filetransfer.html#FX_NO_SUCH_FILE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FX_PERMISSION_DENIED
  twisted.conch.ssh.filetransfer.html#FX_PERMISSION_DENIED
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FX_FAILURE
  twisted.conch.ssh.filetransfer.html#FX_FAILURE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FX_BAD_MESSAGE
  twisted.conch.ssh.filetransfer.html#FX_BAD_MESSAGE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FX_NO_CONNECTION
  twisted.conch.ssh.filetransfer.html#FX_NO_CONNECTION
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FX_CONNECTION_LOST
  twisted.conch.ssh.filetransfer.html#FX_CONNECTION_LOST
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FX_OP_UNSUPPORTED
  twisted.conch.ssh.filetransfer.html#FX_OP_UNSUPPORTED
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.FX_FILE_ALREADY_EXISTS
  twisted.conch.ssh.filetransfer.html#FX_FILE_ALREADY_EXISTS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.g
  twisted.conch.ssh.filetransfer.html#g
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.conch.ssh.filetransfer.value
  twisted.conch.ssh.filetransfer.html#value
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.conch.scripts.cftp.ClientOptions
  twisted.conch.scripts.cftp.ClientOptions.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.conch.scripts.cftp.ClientOptions.synopsis
  twisted.conch.scripts.cftp.ClientOptions.html#synopsis
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.scripts.cftp.ClientOptions.longdesc
  twisted.conch.scripts.cftp.ClientOptions.html#longdesc
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.scripts.cftp.ClientOptions.optParameters
  twisted.conch.scripts.cftp.ClientOptions.html#optParameters
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.scripts.cftp.ClientOptions.compData
  twisted.conch.scripts.cftp.ClientOptions.html#compData
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.scripts.cftp.ClientOptions.parseArgs
  twisted.conch.scripts.cftp.ClientOptions.html#parseArgs
  Function
  Method
  PUBLIC
  I am called with any leftover arguments which were not options.
- twisted.conch.scripts.cftp.run
  twisted.conch.scripts.cftp.html#run
  Function
  Function
  PUBLIC
  Undocumented
- twisted.conch.scripts.cftp.handleError
  twisted.conch.scripts.cftp.html#handleError
  Function
  Function
  PUBLIC
  Undocumented
- twisted.conch.scripts.cftp.doConnect
  twisted.conch.scripts.cftp.html#doConnect
  Function
  Function
  PUBLIC
  Undocumented
- twisted.conch.scripts.cftp._ebExit
  twisted.conch.scripts.cftp.html#_ebExit
  Function
  Function
  PRIVATE
  Undocumented
- twisted.conch.scripts.cftp._ignore
  twisted.conch.scripts.cftp.html#_ignore
  Function
  Function
  PRIVATE
  Undocumented
- twisted.conch.scripts.cftp.FileWrapper
  twisted.conch.scripts.cftp.FileWrapper.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.conch.scripts.cftp.FileWrapper.__init__
  twisted.conch.scripts.cftp.FileWrapper.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.scripts.cftp.FileWrapper.f
  twisted.conch.scripts.cftp.FileWrapper.html#f
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.scripts.cftp.FileWrapper.total
  twisted.conch.scripts.cftp.FileWrapper.html#total
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.scripts.cftp.FileWrapper.size
  twisted.conch.scripts.cftp.FileWrapper.html#size
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.scripts.cftp.FileWrapper.__getattr__
  twisted.conch.scripts.cftp.FileWrapper.html#__getattr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.scripts.cftp.StdioClient
  twisted.conch.scripts.cftp.StdioClient.html
  Class
  Class
  PUBLIC
  No class docstring; 0/5 instance variable, 0/2 class variable, 8/59 methods documented
- twisted.conch.scripts.cftp.StdioClient.ps
  twisted.conch.scripts.cftp.StdioClient.html#ps
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.scripts.cftp.StdioClient.delimiter
  twisted.conch.scripts.cftp.StdioClient.html#delimiter
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.scripts.cftp.StdioClient.__init__
  twisted.conch.scripts.cftp.StdioClient.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.scripts.cftp.StdioClient.client
  twisted.conch.scripts.cftp.StdioClient.html#client
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.scripts.cftp.StdioClient.currentDirectory
  twisted.conch.scripts.cftp.StdioClient.html#currentDirectory
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.scripts.cftp.StdioClient.file
  twisted.conch.scripts.cftp.StdioClient.html#file
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.scripts.cftp.StdioClient.useProgressBar
  twisted.conch.scripts.cftp.StdioClient.html#useProgressBar
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.scripts.cftp.StdioClient.connectionMade
  twisted.conch.scripts.cftp.StdioClient.html#connectionMade
  Function
  Method
  PUBLIC
  Called when a connection is made.
- twisted.conch.scripts.cftp.StdioClient._cbSetCurDir
  twisted.conch.scripts.cftp.StdioClient.html#_cbSetCurDir
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.scripts.cftp.StdioClient._writeToTransport
  twisted.conch.scripts.cftp.StdioClient.html#_writeToTransport
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.scripts.cftp.StdioClient.lineReceived
  twisted.conch.scripts.cftp.StdioClient.html#lineReceived
  Function
  Method
  PUBLIC
  Override this for when each line is received.
- twisted.conch.scripts.cftp.StdioClient.ignoreErrors
  twisted.conch.scripts.cftp.StdioClient.html#ignoreErrors
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.scripts.cftp.StdioClient._dispatchCommand
  twisted.conch.scripts.cftp.StdioClient.html#_dispatchCommand
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.scripts.cftp.StdioClient._printFailure
  twisted.conch.scripts.cftp.StdioClient.html#_printFailure
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.scripts.cftp.StdioClient._newLine
  twisted.conch.scripts.cftp.StdioClient.html#_newLine
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.scripts.cftp.StdioClient._cbCommand
  twisted.conch.scripts.cftp.StdioClient.html#_cbCommand
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.scripts.cftp.StdioClient._ebCommand
  twisted.conch.scripts.cftp.StdioClient.html#_ebCommand
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.scripts.cftp.StdioClient.cmd_CD
  twisted.conch.scripts.cftp.StdioClient.html#cmd_CD
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.scripts.cftp.StdioClient._cbCd
  twisted.conch.scripts.cftp.StdioClient.html#_cbCd
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.scripts.cftp.StdioClient._cbCurDir
  twisted.conch.scripts.cftp.StdioClient.html#_cbCurDir
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.scripts.cftp.StdioClient.cmd_CHGRP
  twisted.conch.scripts.cftp.StdioClient.html#cmd_CHGRP
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.scripts.cftp.StdioClient.cmd_CHMOD
  twisted.conch.scripts.cftp.StdioClient.html#cmd_CHMOD
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.scripts.cftp.StdioClient.cmd_CHOWN
  twisted.conch.scripts.cftp.StdioClient.html#cmd_CHOWN
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.scripts.cftp.StdioClient._cbSetUsrGrp
  twisted.conch.scripts.cftp.StdioClient.html#_cbSetUsrGrp
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.scripts.cftp.StdioClient.cmd_GET
  twisted.conch.scripts.cftp.StdioClient.html#cmd_GET
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.scripts.cftp.StdioClient._cbGetMultiple
  twisted.conch.scripts.cftp.StdioClient.html#_cbGetMultiple
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.scripts.cftp.StdioClient._cbGetMultipleNext
  twisted.conch.scripts.cftp.StdioClient.html#_cbGetMultipleNext
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.scripts.cftp.StdioClient._ebCloseLf
  twisted.conch.scripts.cftp.StdioClient.html#_ebCloseLf
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.scripts.cftp.StdioClient._cbGetOpenFile
  twisted.conch.scripts.cftp.StdioClient.html#_cbGetOpenFile
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.scripts.cftp.StdioClient._cbGetFileSize
  twisted.conch.scripts.cftp.StdioClient.html#_cbGetFileSize
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.scripts.cftp.StdioClient._getNextChunk
  twisted.conch.scripts.cftp.StdioClient.html#_getNextChunk
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.scripts.cftp.StdioClient._cbGetRead
  twisted.conch.scripts.cftp.StdioClient.html#_cbGetRead
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.scripts.cftp.StdioClient._cbGetDone
  twisted.conch.scripts.cftp.StdioClient.html#_cbGetDone
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.scripts.cftp.StdioClient.cmd_PUT
  twisted.conch.scripts.cftp.StdioClient.html#cmd_PUT
  Function
  Method
  PUBLIC
  Do an upload request for a single local file or a globing expression.
- twisted.conch.scripts.cftp.StdioClient._putSingleFile
  twisted.conch.scripts.cftp.StdioClient.html#_putSingleFile
  Function
  Method
  PRIVATE
  Perform an upload for a single file.
- twisted.conch.scripts.cftp.StdioClient._putMultipleFiles
  twisted.conch.scripts.cftp.StdioClient.html#_putMultipleFiles
  Function
  Method
  PRIVATE
  Perform an upload for a list of local files.
- twisted.conch.scripts.cftp.StdioClient._cbPutMultipleNext
  twisted.conch.scripts.cftp.StdioClient.html#_cbPutMultipleNext
  Function
  Method
  PRIVATE
  Perform an upload for the next file in the list of local files.
- twisted.conch.scripts.cftp.StdioClient._putRemoteFile
  twisted.conch.scripts.cftp.StdioClient.html#_putRemoteFile
  Function
  Method
  PRIVATE
  Do an upload request.
- twisted.conch.scripts.cftp.StdioClient._cbPutOpenFile
  twisted.conch.scripts.cftp.StdioClient.html#_cbPutOpenFile
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.scripts.cftp.StdioClient._cbPutWrite
  twisted.conch.scripts.cftp.StdioClient.html#_cbPutWrite
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.scripts.cftp.StdioClient._cbPutDone
  twisted.conch.scripts.cftp.StdioClient.html#_cbPutDone
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.scripts.cftp.StdioClient.cmd_LCD
  twisted.conch.scripts.cftp.StdioClient.html#cmd_LCD
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.scripts.cftp.StdioClient.cmd_LN
  twisted.conch.scripts.cftp.StdioClient.html#cmd_LN
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.scripts.cftp.StdioClient.cmd_LS
  twisted.conch.scripts.cftp.StdioClient.html#cmd_LS
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.scripts.cftp.StdioClient._cbDisplayFiles
  twisted.conch.scripts.cftp.StdioClient.html#_cbDisplayFiles
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.scripts.cftp.StdioClient.cmd_MKDIR
  twisted.conch.scripts.cftp.StdioClient.html#cmd_MKDIR
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.scripts.cftp.StdioClient.cmd_RMDIR
  twisted.conch.scripts.cftp.StdioClient.html#cmd_RMDIR
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.scripts.cftp.StdioClient.cmd_LMKDIR
  twisted.conch.scripts.cftp.StdioClient.html#cmd_LMKDIR
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.scripts.cftp.StdioClient.cmd_RM
  twisted.conch.scripts.cftp.StdioClient.html#cmd_RM
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.scripts.cftp.StdioClient.cmd_LLS
  twisted.conch.scripts.cftp.StdioClient.html#cmd_LLS
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.scripts.cftp.StdioClient.cmd_RENAME
  twisted.conch.scripts.cftp.StdioClient.html#cmd_RENAME
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.scripts.cftp.StdioClient.cmd_EXIT
  twisted.conch.scripts.cftp.StdioClient.html#cmd_EXIT
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.scripts.cftp.StdioClient.cmd_VERSION
  twisted.conch.scripts.cftp.StdioClient.html#cmd_VERSION
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.scripts.cftp.StdioClient.cmd_HELP
  twisted.conch.scripts.cftp.StdioClient.html#cmd_HELP
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.scripts.cftp.StdioClient.cmd_PWD
  twisted.conch.scripts.cftp.StdioClient.html#cmd_PWD
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.scripts.cftp.StdioClient.cmd_LPWD
  twisted.conch.scripts.cftp.StdioClient.html#cmd_LPWD
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.scripts.cftp.StdioClient.cmd_PROGRESS
  twisted.conch.scripts.cftp.StdioClient.html#cmd_PROGRESS
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.scripts.cftp.StdioClient.cmd_EXEC
  twisted.conch.scripts.cftp.StdioClient.html#cmd_EXEC
  Function
  Method
  PUBLIC
  Run `rest` using the user's shell (or /bin/sh if they do not have one).
- twisted.conch.scripts.cftp.StdioClient._remoteGlob
  twisted.conch.scripts.cftp.StdioClient.html#_remoteGlob
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.scripts.cftp.StdioClient._cbOpenList
  twisted.conch.scripts.cftp.StdioClient.html#_cbOpenList
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.scripts.cftp.StdioClient._ebNotADirectory
  twisted.conch.scripts.cftp.StdioClient.html#_ebNotADirectory
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.scripts.cftp.StdioClient._cbReadFile
  twisted.conch.scripts.cftp.StdioClient.html#_cbReadFile
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.scripts.cftp.StdioClient._abbrevSize
  twisted.conch.scripts.cftp.StdioClient.html#_abbrevSize
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.scripts.cftp.StdioClient._abbrevTime
  twisted.conch.scripts.cftp.StdioClient.html#_abbrevTime
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.scripts.cftp.StdioClient._printProgressBar
  twisted.conch.scripts.cftp.StdioClient.html#_printProgressBar
  Function
  Method
  PRIVATE
  Update a console progress bar on this `StdioClient`'s transport, based on the difference between the start time of the operation and the current time according to the reactor, and appropriate to the size of the console window.
- twisted.conch.scripts.cftp.StdioClient._getFilename
  twisted.conch.scripts.cftp.StdioClient.html#_getFilename
  Function
  Method
  PRIVATE
  Parse line received as command line input and return first filename together with the remaining line.
- twisted.conch.scripts.cftp.SSHConnection
  twisted.conch.scripts.cftp.SSHConnection.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.conch.scripts.cftp.SSHConnection.serviceStarted
  twisted.conch.scripts.cftp.SSHConnection.html#serviceStarted
  Function
  Method
  PUBLIC
  called when the service is active on the transport.
- twisted.conch.scripts.cftp.SSHSession
  twisted.conch.scripts.cftp.SSHSession.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.conch.scripts.cftp.SSHSession.name
  twisted.conch.scripts.cftp.SSHSession.html#name
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.scripts.cftp.SSHSession.channelOpen
  twisted.conch.scripts.cftp.SSHSession.html#channelOpen
  Function
  Method
  PUBLIC
  Called when the channel is opened. specificData is any data that the other side sent us when opening the channel.
- twisted.conch.scripts.cftp.SSHSession._cbSubsystem
  twisted.conch.scripts.cftp.SSHSession.html#_cbSubsystem
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.scripts.cftp.SSHSession.client
  twisted.conch.scripts.cftp.SSHSession.html#client
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.scripts.cftp.SSHSession.stdio
  twisted.conch.scripts.cftp.SSHSession.html#stdio
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.scripts.cftp.SSHSession.extReceived
  twisted.conch.scripts.cftp.SSHSession.html#extReceived
  Function
  Method
  PUBLIC
  Called when we receive extended data (usually standard error).
- twisted.conch.scripts.cftp.SSHSession.eofReceived
  twisted.conch.scripts.cftp.SSHSession.html#eofReceived
  Function
  Method
  PUBLIC
  Called when the other side will send no more data.
- twisted.conch.scripts.cftp.SSHSession.closeReceived
  twisted.conch.scripts.cftp.SSHSession.html#closeReceived
  Function
  Method
  PUBLIC
  Called when the other side has closed the channel.
- twisted.conch.scripts.cftp.SSHSession.closed
  twisted.conch.scripts.cftp.SSHSession.html#closed
  Function
  Method
  PUBLIC
  Called when the channel is closed. This means that both our side and the remote side have closed the channel.
- twisted.conch.scripts.cftp.SSHSession.stopWriting
  twisted.conch.scripts.cftp.SSHSession.html#stopWriting
  Function
  Method
  PUBLIC
  Called when the remote buffer is full, as a hint to stop writing. This can be ignored, but it can be helpful.
- twisted.conch.scripts.cftp.SSHSession.startWriting
  twisted.conch.scripts.cftp.SSHSession.html#startWriting
  Function
  Method
  PUBLIC
  Called when the remote buffer has more room, as a hint to continue writing.
- twisted.conch.scripts.ckeygen.supportedKeyTypes
  twisted.conch.scripts.ckeygen.html#supportedKeyTypes
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.conch.scripts.ckeygen._keyGenerator
  twisted.conch.scripts.ckeygen.html#_keyGenerator
  Function
  Function
  PRIVATE
  Undocumented
- twisted.conch.scripts.ckeygen.GeneralOptions
  twisted.conch.scripts.ckeygen.GeneralOptions.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.conch.scripts.ckeygen.GeneralOptions.synopsis
  twisted.conch.scripts.ckeygen.GeneralOptions.html#synopsis
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.scripts.ckeygen.GeneralOptions.longdesc
  twisted.conch.scripts.ckeygen.GeneralOptions.html#longdesc
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.scripts.ckeygen.GeneralOptions.optParameters
  twisted.conch.scripts.ckeygen.GeneralOptions.html#optParameters
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.scripts.ckeygen.GeneralOptions.optFlags
  twisted.conch.scripts.ckeygen.GeneralOptions.html#optFlags
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.scripts.ckeygen.GeneralOptions.compData
  twisted.conch.scripts.ckeygen.GeneralOptions.html#compData
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.scripts.ckeygen.run
  twisted.conch.scripts.ckeygen.html#run
  Function
  Function
  PUBLIC
  Undocumented
- twisted.conch.scripts.ckeygen.enumrepresentation
  twisted.conch.scripts.ckeygen.html#enumrepresentation
  Function
  Function
  PUBLIC
  Undocumented
- twisted.conch.scripts.ckeygen.handleError
  twisted.conch.scripts.ckeygen.html#handleError
  Function
  Function
  PUBLIC
  Undocumented
- twisted.conch.scripts.ckeygen.generateRSAkey
  twisted.conch.scripts.ckeygen.html#generateRSAkey
  Function
  Function
  PUBLIC
  Undocumented
- twisted.conch.scripts.ckeygen.generateDSAkey
  twisted.conch.scripts.ckeygen.html#generateDSAkey
  Function
  Function
  PUBLIC
  Undocumented
- twisted.conch.scripts.ckeygen.generateECDSAkey
  twisted.conch.scripts.ckeygen.html#generateECDSAkey
  Function
  Function
  PUBLIC
  Undocumented
- twisted.conch.scripts.ckeygen.generateEd25519key
  twisted.conch.scripts.ckeygen.html#generateEd25519key
  Function
  Function
  PUBLIC
  Undocumented
- twisted.conch.scripts.ckeygen._defaultPrivateKeySubtype
  twisted.conch.scripts.ckeygen.html#_defaultPrivateKeySubtype
  Function
  Function
  PRIVATE
  Return a reasonable default private key subtype for a given key type.
- twisted.conch.scripts.ckeygen.printFingerprint
  twisted.conch.scripts.ckeygen.html#printFingerprint
  Function
  Function
  PUBLIC
  Undocumented
- twisted.conch.scripts.ckeygen.changePassPhrase
  twisted.conch.scripts.ckeygen.html#changePassPhrase
  Function
  Function
  PUBLIC
  Undocumented
- twisted.conch.scripts.ckeygen.displayPublicKey
  twisted.conch.scripts.ckeygen.html#displayPublicKey
  Function
  Function
  PUBLIC
  Undocumented
- twisted.conch.scripts.ckeygen._inputSaveFile
  twisted.conch.scripts.ckeygen.html#_inputSaveFile
  Function
  Function
  PRIVATE
  Ask the user where to save the key.
- twisted.conch.scripts.ckeygen._saveKey
  twisted.conch.scripts.ckeygen.html#_saveKey
  Function
  Function
  PRIVATE
  Persist a SSH key on local filesystem.
- twisted.conch.ssh.forwarding.SSHListenForwardingFactory
  twisted.conch.ssh.forwarding.SSHListenForwardingFactory.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.conch.ssh.forwarding.SSHListenForwardingFactory.__init__
  twisted.conch.ssh.forwarding.SSHListenForwardingFactory.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh.forwarding.SSHListenForwardingFactory.conn
  twisted.conch.ssh.forwarding.SSHListenForwardingFactory.html#conn
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ssh.forwarding.SSHListenForwardingFactory.hostport
  twisted.conch.ssh.forwarding.SSHListenForwardingFactory.html#hostport
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ssh.forwarding.SSHListenForwardingFactory.klass
  twisted.conch.ssh.forwarding.SSHListenForwardingFactory.html#klass
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ssh.forwarding.SSHListenForwardingFactory.buildProtocol
  twisted.conch.ssh.forwarding.SSHListenForwardingFactory.html#buildProtocol
  Function
  Method
  PUBLIC
  Create an instance of a subclass of Protocol.
- twisted.conch.ssh.forwarding.SSHListenForwardingChannel
  twisted.conch.ssh.forwarding.SSHListenForwardingChannel.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.conch.ssh.forwarding.SSHListenForwardingChannel.channelOpen
  twisted.conch.ssh.forwarding.SSHListenForwardingChannel.html#channelOpen
  Function
  Method
  PUBLIC
  Called when the channel is opened. specificData is any data that the other side sent us when opening the channel.
- twisted.conch.ssh.forwarding.SSHListenForwardingChannel.openFailed
  twisted.conch.ssh.forwarding.SSHListenForwardingChannel.html#openFailed
  Function
  Method
  PUBLIC
  Called when the open failed for some reason. reason.desc is a string descrption, reason.code the SSH error code.
- twisted.conch.ssh.forwarding.SSHListenForwardingChannel.dataReceived
  twisted.conch.ssh.forwarding.SSHListenForwardingChannel.html#dataReceived
  Function
  Method
  PUBLIC
  Called when we receive data.
- twisted.conch.ssh.forwarding.SSHListenForwardingChannel.eofReceived
  twisted.conch.ssh.forwarding.SSHListenForwardingChannel.html#eofReceived
  Function
  Method
  PUBLIC
  Called when the other side will send no more data.
- twisted.conch.ssh.forwarding.SSHListenForwardingChannel.closed
  twisted.conch.ssh.forwarding.SSHListenForwardingChannel.html#closed
  Function
  Method
  PUBLIC
  Called when the channel is closed. This means that both our side and the remote side have closed the channel.
- twisted.conch.ssh.forwarding.SSHListenClientForwardingChannel
  twisted.conch.ssh.forwarding.SSHListenClientForwardingChannel.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.conch.ssh.forwarding.SSHListenClientForwardingChannel.name
  twisted.conch.ssh.forwarding.SSHListenClientForwardingChannel.html#name
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.ssh.forwarding.SSHListenServerForwardingChannel
  twisted.conch.ssh.forwarding.SSHListenServerForwardingChannel.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.conch.ssh.forwarding.SSHListenServerForwardingChannel.name
  twisted.conch.ssh.forwarding.SSHListenServerForwardingChannel.html#name
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.ssh.forwarding.SSHConnectForwardingChannel
  twisted.conch.ssh.forwarding.SSHConnectForwardingChannel.html
  Class
  Class
  PUBLIC
  Channel used for handling server side forwarding request. It acts as a client for the remote forwarding destination.
- twisted.conch.ssh.forwarding.SSHConnectForwardingChannel.hostport
  twisted.conch.ssh.forwarding.SSHConnectForwardingChannel.html#hostport
  Attribute
  Instance Variable
  PUBLIC
  `(host, port)` requested by client as forwarding destination.
- twisted.conch.ssh.forwarding.SSHConnectForwardingChannel.client
  twisted.conch.ssh.forwarding.SSHConnectForwardingChannel.html#client
  Attribute
  Instance Variable
  PUBLIC
  Protocol connected to the forwarding destination.
- twisted.conch.ssh.forwarding.SSHConnectForwardingChannel.clientBuf
  twisted.conch.ssh.forwarding.SSHConnectForwardingChannel.html#clientBuf
  Attribute
  Instance Variable
  PUBLIC
  Data received while forwarding channel is not yet connected.
- twisted.conch.ssh.forwarding.SSHConnectForwardingChannel._reactor
  twisted.conch.ssh.forwarding.SSHConnectForwardingChannel.html#_reactor
  Attribute
  Variable
  PRIVATE
  Reactor used for TCP connections.
- twisted.conch.ssh.forwarding.SSHConnectForwardingChannel._channelOpenDeferred
  twisted.conch.ssh.forwarding.SSHConnectForwardingChannel.html#_channelOpenDeferred
  Attribute
  Instance Variable
  PRIVATE
  Deferred used in testing to check the result of `channelOpen`.
- twisted.conch.ssh.forwarding.SSHConnectForwardingChannel.__init__
  twisted.conch.ssh.forwarding.SSHConnectForwardingChannel.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh.forwarding.SSHConnectForwardingChannel.channelOpen
  twisted.conch.ssh.forwarding.SSHConnectForwardingChannel.html#channelOpen
  Function
  Method
  PUBLIC
  See: `channel.SSHChannel`
- twisted.conch.ssh.forwarding.SSHConnectForwardingChannel._setClient
  twisted.conch.ssh.forwarding.SSHConnectForwardingChannel.html#_setClient
  Function
  Method
  PRIVATE
  Called when the connection was established to the forwarding destination.
- twisted.conch.ssh.forwarding.SSHConnectForwardingChannel._close
  twisted.conch.ssh.forwarding.SSHConnectForwardingChannel.html#_close
  Function
  Method
  PRIVATE
  Called when failed to connect to the forwarding destination.
- twisted.conch.ssh.forwarding.SSHConnectForwardingChannel.dataReceived
  twisted.conch.ssh.forwarding.SSHConnectForwardingChannel.html#dataReceived
  Function
  Method
  PUBLIC
  See: `channel.SSHChannel`
- twisted.conch.ssh.forwarding.SSHConnectForwardingChannel.closed
  twisted.conch.ssh.forwarding.SSHConnectForwardingChannel.html#closed
  Function
  Method
  PUBLIC
  See: `channel.SSHChannel`
- twisted.conch.ssh.forwarding.openConnectForwardingClient
  twisted.conch.ssh.forwarding.html#openConnectForwardingClient
  Function
  Function
  PUBLIC
  Undocumented
- twisted.conch.ssh.forwarding.SSHForwardingClient
  twisted.conch.ssh.forwarding.SSHForwardingClient.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.conch.ssh.forwarding.SSHForwardingClient.__init__
  twisted.conch.ssh.forwarding.SSHForwardingClient.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh.forwarding.SSHForwardingClient.channel
  twisted.conch.ssh.forwarding.SSHForwardingClient.html#channel
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ssh.forwarding.SSHForwardingClient.buf
  twisted.conch.ssh.forwarding.SSHForwardingClient.html#buf
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ssh.forwarding.SSHForwardingClient.dataReceived
  twisted.conch.ssh.forwarding.SSHForwardingClient.html#dataReceived
  Function
  Method
  PUBLIC
  Called whenever data is received.
- twisted.conch.ssh.forwarding.SSHForwardingClient.connectionLost
  twisted.conch.ssh.forwarding.SSHForwardingClient.html#connectionLost
  Function
  Method
  PUBLIC
  Called when the connection is shut down.
- twisted.conch.ssh.forwarding.packOpen_direct_tcpip
  twisted.conch.ssh.forwarding.html#packOpen_direct_tcpip
  Function
  Function
  PUBLIC
  Pack the data suitable for sending in a CHANNEL_OPEN packet.
- twisted.conch.ssh.forwarding.unpackOpen_direct_tcpip
  twisted.conch.ssh.forwarding.html#unpackOpen_direct_tcpip
  Function
  Function
  PUBLIC
  Unpack the data to a usable format.
- twisted.conch.ssh.forwarding.packGlobal_tcpip_forward
  twisted.conch.ssh.forwarding.html#packGlobal_tcpip_forward
  Function
  Function
  PUBLIC
  Pack the data for tcpip forwarding.
- twisted.conch.ssh.forwarding.unpackGlobal_tcpip_forward
  twisted.conch.ssh.forwarding.html#unpackGlobal_tcpip_forward
  Function
  Function
  PUBLIC
  Undocumented
- twisted.conch.scripts.conch.ClientOptions
  twisted.conch.scripts.conch.ClientOptions.html
  Class
  Class
  PUBLIC
  No class docstring; 0/7 class variable, 3/4 methods documented
- twisted.conch.scripts.conch.ClientOptions.synopsis
  twisted.conch.scripts.conch.ClientOptions.html#synopsis
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.scripts.conch.ClientOptions.longdesc
  twisted.conch.scripts.conch.ClientOptions.html#longdesc
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.scripts.conch.ClientOptions.optParameters
  twisted.conch.scripts.conch.ClientOptions.html#optParameters
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.scripts.conch.ClientOptions.optFlags
  twisted.conch.scripts.conch.ClientOptions.html#optFlags
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.scripts.conch.ClientOptions.compData
  twisted.conch.scripts.conch.ClientOptions.html#compData
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.scripts.conch.ClientOptions.localForwards
  twisted.conch.scripts.conch.ClientOptions.html#localForwards
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.scripts.conch.ClientOptions.remoteForwards
  twisted.conch.scripts.conch.ClientOptions.html#remoteForwards
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.scripts.conch.ClientOptions.opt_escape
  twisted.conch.scripts.conch.ClientOptions.html#opt_escape
  Function
  Method
  PUBLIC
  Set escape character; ``none'' = disable
- twisted.conch.scripts.conch.ClientOptions.opt_localforward
  twisted.conch.scripts.conch.ClientOptions.html#opt_localforward
  Function
  Method
  PUBLIC
  Forward local port to remote address (lport:host:port)
- twisted.conch.scripts.conch.ClientOptions.opt_remoteforward
  twisted.conch.scripts.conch.ClientOptions.html#opt_remoteforward
  Function
  Method
  PUBLIC
  Forward remote port to local address (rport:host:port)
- twisted.conch.scripts.conch.ClientOptions.parseArgs
  twisted.conch.scripts.conch.ClientOptions.html#parseArgs
  Function
  Method
  PUBLIC
  I am called with any leftover arguments which were not options.
- twisted.conch.scripts.conch.options
  twisted.conch.scripts.conch.html#options
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.conch.scripts.conch.conn
  twisted.conch.scripts.conch.html#conn
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.conch.scripts.conch.exitStatus
  twisted.conch.scripts.conch.html#exitStatus
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.conch.scripts.conch.old
  twisted.conch.scripts.conch.html#old
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.conch.scripts.conch._inRawMode
  twisted.conch.scripts.conch.html#_inRawMode
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.conch.scripts.conch._savedRawMode
  twisted.conch.scripts.conch.html#_savedRawMode
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.conch.scripts.conch.run
  twisted.conch.scripts.conch.html#run
  Function
  Function
  PUBLIC
  Undocumented
- twisted.conch.scripts.conch.handleError
  twisted.conch.scripts.conch.html#handleError
  Function
  Function
  PUBLIC
  Undocumented
- twisted.conch.scripts.conch._stopReactor
  twisted.conch.scripts.conch.html#_stopReactor
  Function
  Function
  PRIVATE
  Undocumented
- twisted.conch.scripts.conch.doConnect
  twisted.conch.scripts.conch.html#doConnect
  Function
  Function
  PUBLIC
  Undocumented
- twisted.conch.scripts.conch._ebExit
  twisted.conch.scripts.conch.html#_ebExit
  Function
  Function
  PRIVATE
  Undocumented
- twisted.conch.scripts.conch.onConnect
  twisted.conch.scripts.conch.html#onConnect
  Function
  Function
  PUBLIC
  Undocumented
- twisted.conch.scripts.conch.reConnect
  twisted.conch.scripts.conch.html#reConnect
  Function
  Function
  PUBLIC
  Undocumented
- twisted.conch.scripts.conch.beforeShutdown
  twisted.conch.scripts.conch.html#beforeShutdown
  Function
  Function
  PUBLIC
  Undocumented
- twisted.conch.scripts.conch.stopConnection
  twisted.conch.scripts.conch.html#stopConnection
  Function
  Function
  PUBLIC
  Undocumented
- twisted.conch.scripts.conch._KeepAlive
  twisted.conch.scripts.conch._KeepAlive.html
  Class
  Class
  PRIVATE
  Undocumented
- twisted.conch.scripts.conch._KeepAlive.__init__
  twisted.conch.scripts.conch._KeepAlive.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.scripts.conch._KeepAlive.conn
  twisted.conch.scripts.conch._KeepAlive.html#conn
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.scripts.conch._KeepAlive.globalTimeout
  twisted.conch.scripts.conch._KeepAlive.html#globalTimeout
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.scripts.conch._KeepAlive.lc
  twisted.conch.scripts.conch._KeepAlive.html#lc
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.scripts.conch._KeepAlive.sendGlobal
  twisted.conch.scripts.conch._KeepAlive.html#sendGlobal
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.scripts.conch._KeepAlive._cbGlobal
  twisted.conch.scripts.conch._KeepAlive.html#_cbGlobal
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.scripts.conch._KeepAlive._ebGlobal
  twisted.conch.scripts.conch._KeepAlive.html#_ebGlobal
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.scripts.conch.SSHConnection
  twisted.conch.scripts.conch.SSHConnection.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.conch.scripts.conch.SSHConnection.serviceStarted
  twisted.conch.scripts.conch.SSHConnection.html#serviceStarted
  Function
  Method
  PUBLIC
  called when the service is active on the transport.
- twisted.conch.scripts.conch.SSHConnection.localForwards
  twisted.conch.scripts.conch.SSHConnection.html#localForwards
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.scripts.conch.SSHConnection.remoteForwards
  twisted.conch.scripts.conch.SSHConnection.html#remoteForwards
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.scripts.conch.SSHConnection.serviceStopped
  twisted.conch.scripts.conch.SSHConnection.html#serviceStopped
  Function
  Method
  PUBLIC
  Called when the connection is stopped.
- twisted.conch.scripts.conch.SSHConnection.requestRemoteForwarding
  twisted.conch.scripts.conch.SSHConnection.html#requestRemoteForwarding
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.scripts.conch.SSHConnection._cbRemoteForwarding
  twisted.conch.scripts.conch.SSHConnection.html#_cbRemoteForwarding
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.scripts.conch.SSHConnection._ebRemoteForwarding
  twisted.conch.scripts.conch.SSHConnection.html#_ebRemoteForwarding
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.scripts.conch.SSHConnection.cancelRemoteForwarding
  twisted.conch.scripts.conch.SSHConnection.html#cancelRemoteForwarding
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.scripts.conch.SSHConnection.channel_forwarded_tcpip
  twisted.conch.scripts.conch.SSHConnection.html#channel_forwarded_tcpip
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.scripts.conch.SSHConnection.channelClosed
  twisted.conch.scripts.conch.SSHConnection.html#channelClosed
  Function
  Method
  PUBLIC
  Called when a channel is closed. It clears the local state related to the channel, and calls channel.closed(). MAKE SURE YOU CALL THIS METHOD, even if you subclass `SSHConnection`. If you don't, things will break mysteriously.
- twisted.conch.scripts.conch.SSHSession
  twisted.conch.scripts.conch.SSHSession.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.conch.scripts.conch.SSHSession.name
  twisted.conch.scripts.conch.SSHSession.html#name
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.scripts.conch.SSHSession.channelOpen
  twisted.conch.scripts.conch.SSHSession.html#channelOpen
  Function
  Method
  PUBLIC
  Called when the channel is opened. specificData is any data that the other side sent us when opening the channel.
- twisted.conch.scripts.conch.SSHSession.escapeMode
  twisted.conch.scripts.conch.SSHSession.html#escapeMode
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.scripts.conch.SSHSession.stdio
  twisted.conch.scripts.conch.SSHSession.html#stdio
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.scripts.conch.SSHSession.handleInput
  twisted.conch.scripts.conch.SSHSession.html#handleInput
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.scripts.conch.SSHSession.dataReceived
  twisted.conch.scripts.conch.SSHSession.html#dataReceived
  Function
  Method
  PUBLIC
  Called when we receive data.
- twisted.conch.scripts.conch.SSHSession.extReceived
  twisted.conch.scripts.conch.SSHSession.html#extReceived
  Function
  Method
  PUBLIC
  Called when we receive extended data (usually standard error).
- twisted.conch.scripts.conch.SSHSession.eofReceived
  twisted.conch.scripts.conch.SSHSession.html#eofReceived
  Function
  Method
  PUBLIC
  Called when the other side will send no more data.
- twisted.conch.scripts.conch.SSHSession.closeReceived
  twisted.conch.scripts.conch.SSHSession.html#closeReceived
  Function
  Method
  PUBLIC
  Called when the other side has closed the channel.
- twisted.conch.scripts.conch.SSHSession.closed
  twisted.conch.scripts.conch.SSHSession.html#closed
  Function
  Method
  PUBLIC
  Called when the channel is closed. This means that both our side and the remote side have closed the channel.
- twisted.conch.scripts.conch.SSHSession.request_exit_status
  twisted.conch.scripts.conch.SSHSession.html#request_exit_status
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.scripts.conch.SSHSession.sendEOF
  twisted.conch.scripts.conch.SSHSession.html#sendEOF
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.scripts.conch.SSHSession.stopWriting
  twisted.conch.scripts.conch.SSHSession.html#stopWriting
  Function
  Method
  PUBLIC
  Called when the remote buffer is full, as a hint to stop writing. This can be ignored, but it can be helpful.
- twisted.conch.scripts.conch.SSHSession.startWriting
  twisted.conch.scripts.conch.SSHSession.html#startWriting
  Function
  Method
  PUBLIC
  Called when the remote buffer has more room, as a hint to continue writing.
- twisted.conch.scripts.conch.SSHSession._windowResized
  twisted.conch.scripts.conch.SSHSession.html#_windowResized
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.scripts.conch.SSHListenClientForwardingChannel
  twisted.conch.scripts.conch.SSHListenClientForwardingChannel.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.conch.scripts.conch.SSHConnectForwardingChannel
  twisted.conch.scripts.conch.SSHConnectForwardingChannel.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.conch.scripts.conch._leaveRawMode
  twisted.conch.scripts.conch.html#_leaveRawMode
  Function
  Function
  PRIVATE
  Undocumented
- twisted.conch.scripts.conch._enterRawMode
  twisted.conch.scripts.conch.html#_enterRawMode
  Function
  Function
  PRIVATE
  Undocumented
- twisted.conch.ui.ansi._log
  twisted.conch.ui.ansi.html#_log
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.conch.ui.ansi.ColorText
  twisted.conch.ui.ansi.ColorText.html
  Class
  Class
  PUBLIC
  Represents an element of text along with the texts colors and additional attributes.
- twisted.conch.ui.ansi.ColorText.COLORS
  twisted.conch.ui.ansi.ColorText.html#COLORS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ui.ansi.ColorText.BOLD_COLORS
  twisted.conch.ui.ansi.ColorText.html#BOLD_COLORS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ui.ansi.ColorText.BLACK
  twisted.conch.ui.ansi.ColorText.html#BLACK
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ui.ansi.ColorText.RED
  twisted.conch.ui.ansi.ColorText.html#RED
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ui.ansi.ColorText.GREEN
  twisted.conch.ui.ansi.ColorText.html#GREEN
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ui.ansi.ColorText.YELLOW
  twisted.conch.ui.ansi.ColorText.html#YELLOW
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ui.ansi.ColorText.BLUE
  twisted.conch.ui.ansi.ColorText.html#BLUE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ui.ansi.ColorText.MAGENTA
  twisted.conch.ui.ansi.ColorText.html#MAGENTA
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ui.ansi.ColorText.CYAN
  twisted.conch.ui.ansi.ColorText.html#CYAN
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ui.ansi.ColorText.WHITE
  twisted.conch.ui.ansi.ColorText.html#WHITE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ui.ansi.ColorText.COLOR_NAMES
  twisted.conch.ui.ansi.ColorText.html#COLOR_NAMES
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ui.ansi.ColorText.__init__
  twisted.conch.ui.ansi.ColorText.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ui.ansi.ColorText.text
  twisted.conch.ui.ansi.ColorText.html#text
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ui.ansi.ColorText.fg
  twisted.conch.ui.ansi.ColorText.html#fg
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ui.ansi.ColorText.bg
  twisted.conch.ui.ansi.ColorText.html#bg
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ui.ansi.ColorText.display
  twisted.conch.ui.ansi.ColorText.html#display
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ui.ansi.ColorText.bold
  twisted.conch.ui.ansi.ColorText.html#bold
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ui.ansi.ColorText.underline
  twisted.conch.ui.ansi.ColorText.html#underline
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ui.ansi.ColorText.flash
  twisted.conch.ui.ansi.ColorText.html#flash
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ui.ansi.ColorText.reverse
  twisted.conch.ui.ansi.ColorText.html#reverse
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ui.ansi.AnsiParser
  twisted.conch.ui.ansi.AnsiParser.html
  Class
  Class
  PUBLIC
  Parser class for ANSI codes.
- twisted.conch.ui.ansi.AnsiParser.CURSOR_SET
  twisted.conch.ui.ansi.AnsiParser.html#CURSOR_SET
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ui.ansi.AnsiParser.ERASE_SET
  twisted.conch.ui.ansi.AnsiParser.html#ERASE_SET
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ui.ansi.AnsiParser.MODE_SET
  twisted.conch.ui.ansi.AnsiParser.html#MODE_SET
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ui.ansi.AnsiParser.ASSIGN_SET
  twisted.conch.ui.ansi.AnsiParser.html#ASSIGN_SET
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ui.ansi.AnsiParser.COLOR_SET
  twisted.conch.ui.ansi.AnsiParser.html#COLOR_SET
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ui.ansi.AnsiParser.SETS
  twisted.conch.ui.ansi.AnsiParser.html#SETS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ui.ansi.AnsiParser.__init__
  twisted.conch.ui.ansi.AnsiParser.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ui.ansi.AnsiParser.defaultFG
  twisted.conch.ui.ansi.AnsiParser.html#defaultFG
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ui.ansi.AnsiParser.defaultBG
  twisted.conch.ui.ansi.AnsiParser.html#defaultBG
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ui.ansi.AnsiParser.currentFG
  twisted.conch.ui.ansi.AnsiParser.html#currentFG
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ui.ansi.AnsiParser.currentBG
  twisted.conch.ui.ansi.AnsiParser.html#currentBG
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ui.ansi.AnsiParser.bold
  twisted.conch.ui.ansi.AnsiParser.html#bold
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ui.ansi.AnsiParser.flash
  twisted.conch.ui.ansi.AnsiParser.html#flash
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ui.ansi.AnsiParser.underline
  twisted.conch.ui.ansi.AnsiParser.html#underline
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ui.ansi.AnsiParser.reverse
  twisted.conch.ui.ansi.AnsiParser.html#reverse
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ui.ansi.AnsiParser.display
  twisted.conch.ui.ansi.AnsiParser.html#display
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ui.ansi.AnsiParser.prepend
  twisted.conch.ui.ansi.AnsiParser.html#prepend
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ui.ansi.AnsiParser.stripEscapes
  twisted.conch.ui.ansi.AnsiParser.html#stripEscapes
  Function
  Method
  PUBLIC
  Remove all ANSI color escapes from the given string.
- twisted.conch.ui.ansi.AnsiParser.writeString
  twisted.conch.ui.ansi.AnsiParser.html#writeString
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ui.ansi.AnsiParser.parseString
  twisted.conch.ui.ansi.AnsiParser.html#parseString
  Function
  Method
  PUBLIC
  Turn a string input into a list of `ColorText` elements.
- twisted.conch.ui.ansi.AnsiParser.parseColor
  twisted.conch.ui.ansi.AnsiParser.html#parseColor
  Function
  Method
  PUBLIC
  Handle a single ANSI color sequence
- twisted.conch.ui.ansi.AnsiParser.parseCursor
  twisted.conch.ui.ansi.AnsiParser.html#parseCursor
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ui.ansi.AnsiParser.parseErase
  twisted.conch.ui.ansi.AnsiParser.html#parseErase
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ui.ansi.AnsiParser.pickColor
  twisted.conch.ui.ansi.AnsiParser.html#pickColor
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ui.ansi.AnsiParser.formatText
  twisted.conch.ui.ansi.AnsiParser.html#formatText
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ui.ansi._sets
  twisted.conch.ui.ansi.html#_sets
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.conch.ui.ansi._setmap
  twisted.conch.ui.ansi.html#_setmap
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.conch.ui.tkvt100.ttyFont
  twisted.conch.ui.tkvt100.html#ttyFont
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.conch.ui.tkvt100.fontWidth
  twisted.conch.ui.tkvt100.html#fontWidth
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.conch.ui.tkvt100.fontHeight
  twisted.conch.ui.tkvt100.html#fontHeight
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.conch.ui.tkvt100.colorKeys
  twisted.conch.ui.tkvt100.html#colorKeys
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.conch.ui.tkvt100.colorMap
  twisted.conch.ui.tkvt100.html#colorMap
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.conch.ui.tkvt100.VT100Frame
  twisted.conch.ui.tkvt100.VT100Frame.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.conch.ui.tkvt100.VT100Frame.__init__
  twisted.conch.ui.tkvt100.VT100Frame.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ui.tkvt100.VT100Frame.width
  twisted.conch.ui.tkvt100.VT100Frame.html#width
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ui.tkvt100.VT100Frame.height
  twisted.conch.ui.tkvt100.VT100Frame.html#height
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ui.tkvt100.VT100Frame.callback
  twisted.conch.ui.tkvt100.VT100Frame.html#callback
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ui.tkvt100.VT100Frame.canvas
  twisted.conch.ui.tkvt100.VT100Frame.html#canvas
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ui.tkvt100.VT100Frame.ansiParser
  twisted.conch.ui.tkvt100.VT100Frame.html#ansiParser
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ui.tkvt100.VT100Frame.x
  twisted.conch.ui.tkvt100.VT100Frame.html#x
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ui.tkvt100.VT100Frame.y
  twisted.conch.ui.tkvt100.VT100Frame.html#y
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ui.tkvt100.VT100Frame.cursor
  twisted.conch.ui.tkvt100.VT100Frame.html#cursor
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.ui.tkvt100.VT100Frame._delete
  twisted.conch.ui.tkvt100.VT100Frame.html#_delete
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.ui.tkvt100.VT100Frame._write
  twisted.conch.ui.tkvt100.VT100Frame.html#_write
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.ui.tkvt100.VT100Frame.write
  twisted.conch.ui.tkvt100.VT100Frame.html#write
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ui.tkvt100.VT100Frame.writeString
  twisted.conch.ui.tkvt100.VT100Frame.html#writeString
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ui.tkvt100.VT100Frame.parseErase
  twisted.conch.ui.tkvt100.VT100Frame.html#parseErase
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ui.tkvt100.VT100Frame.parseCursor
  twisted.conch.ui.tkvt100.VT100Frame.html#parseCursor
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ui.tkvt100.VT100Frame.keyPressed
  twisted.conch.ui.tkvt100.VT100Frame.html#keyPressed
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ui.tkvt100.VT100Frame.upPressed
  twisted.conch.ui.tkvt100.VT100Frame.html#upPressed
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ui.tkvt100.VT100Frame.downPressed
  twisted.conch.ui.tkvt100.VT100Frame.html#downPressed
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ui.tkvt100.VT100Frame.rightPressed
  twisted.conch.ui.tkvt100.VT100Frame.html#rightPressed
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ui.tkvt100.VT100Frame.leftPressed
  twisted.conch.ui.tkvt100.VT100Frame.html#leftPressed
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.tksupport._task
  twisted.internet.tksupport.html#_task
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.internet.tksupport.install
  twisted.internet.tksupport.html#install
  Function
  Function
  PUBLIC
  Install a Tkinter.Tk() object into the reactor.
- twisted.internet.tksupport.uninstall
  twisted.internet.tksupport.html#uninstall
  Function
  Function
  PUBLIC
  Remove the root Tk widget from the reactor.
- twisted.internet.tksupport.installTkFunctions
  twisted.internet.tksupport.html#installTkFunctions
  Function
  Function
  PUBLIC
  Undocumented
- twisted.internet.tksupport.getPassword
  twisted.internet.tksupport.html#getPassword
  Function
  Function
  PUBLIC
  Undocumented
- twisted.conch.scripts.tkconch.TkConchMenu
  twisted.conch.scripts.tkconch.TkConchMenu.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.conch.scripts.tkconch.TkConchMenu.__init__
  twisted.conch.scripts.tkconch.TkConchMenu.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.scripts.tkconch.TkConchMenu.localRemoteVar
  twisted.conch.scripts.tkconch.TkConchMenu.html#localRemoteVar
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.scripts.tkconch.TkConchMenu.host
  twisted.conch.scripts.tkconch.TkConchMenu.html#host
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.scripts.tkconch.TkConchMenu.port
  twisted.conch.scripts.tkconch.TkConchMenu.html#port
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.scripts.tkconch.TkConchMenu.user
  twisted.conch.scripts.tkconch.TkConchMenu.html#user
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.scripts.tkconch.TkConchMenu.command
  twisted.conch.scripts.tkconch.TkConchMenu.html#command
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.scripts.tkconch.TkConchMenu.identity
  twisted.conch.scripts.tkconch.TkConchMenu.html#identity
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.scripts.tkconch.TkConchMenu.forwards
  twisted.conch.scripts.tkconch.TkConchMenu.html#forwards
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.scripts.tkconch.TkConchMenu.forwardPort
  twisted.conch.scripts.tkconch.TkConchMenu.html#forwardPort
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.scripts.tkconch.TkConchMenu.forwardHost
  twisted.conch.scripts.tkconch.TkConchMenu.html#forwardHost
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.scripts.tkconch.TkConchMenu.localForward
  twisted.conch.scripts.tkconch.TkConchMenu.html#localForward
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.scripts.tkconch.TkConchMenu.remoteForward
  twisted.conch.scripts.tkconch.TkConchMenu.html#remoteForward
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.scripts.tkconch.TkConchMenu.cipher
  twisted.conch.scripts.tkconch.TkConchMenu.html#cipher
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.scripts.tkconch.TkConchMenu.mac
  twisted.conch.scripts.tkconch.TkConchMenu.html#mac
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.scripts.tkconch.TkConchMenu.escape
  twisted.conch.scripts.tkconch.TkConchMenu.html#escape
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.scripts.tkconch.TkConchMenu.getIdentityFile
  twisted.conch.scripts.tkconch.TkConchMenu.html#getIdentityFile
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.scripts.tkconch.TkConchMenu.addForward
  twisted.conch.scripts.tkconch.TkConchMenu.html#addForward
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.scripts.tkconch.TkConchMenu.removeForward
  twisted.conch.scripts.tkconch.TkConchMenu.html#removeForward
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.scripts.tkconch.TkConchMenu.doConnect
  twisted.conch.scripts.tkconch.TkConchMenu.html#doConnect
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.scripts.tkconch.GeneralOptions
  twisted.conch.scripts.tkconch.GeneralOptions.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.conch.scripts.tkconch.GeneralOptions.synopsis
  twisted.conch.scripts.tkconch.GeneralOptions.html#synopsis
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.scripts.tkconch.GeneralOptions.optParameters
  twisted.conch.scripts.tkconch.GeneralOptions.html#optParameters
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.scripts.tkconch.GeneralOptions.optFlags
  twisted.conch.scripts.tkconch.GeneralOptions.html#optFlags
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.scripts.tkconch.GeneralOptions.compData
  twisted.conch.scripts.tkconch.GeneralOptions.html#compData
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.scripts.tkconch.GeneralOptions.identitys
  twisted.conch.scripts.tkconch.GeneralOptions.html#identitys
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.scripts.tkconch.GeneralOptions.localForwards
  twisted.conch.scripts.tkconch.GeneralOptions.html#localForwards
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.scripts.tkconch.GeneralOptions.remoteForwards
  twisted.conch.scripts.tkconch.GeneralOptions.html#remoteForwards
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.scripts.tkconch.GeneralOptions.opt_identity
  twisted.conch.scripts.tkconch.GeneralOptions.html#opt_identity
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.scripts.tkconch.GeneralOptions.opt_localforward
  twisted.conch.scripts.tkconch.GeneralOptions.html#opt_localforward
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.scripts.tkconch.GeneralOptions.opt_remoteforward
  twisted.conch.scripts.tkconch.GeneralOptions.html#opt_remoteforward
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.scripts.tkconch.GeneralOptions.opt_compress
  twisted.conch.scripts.tkconch.GeneralOptions.html#opt_compress
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.scripts.tkconch.GeneralOptions.parseArgs
  twisted.conch.scripts.tkconch.GeneralOptions.html#parseArgs
  Function
  Method
  PUBLIC
  I am called with any leftover arguments which were not options.
- twisted.conch.scripts.tkconch.options
  twisted.conch.scripts.tkconch.html#options
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.conch.scripts.tkconch.menu
  twisted.conch.scripts.tkconch.html#menu
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.conch.scripts.tkconch.exitStatus
  twisted.conch.scripts.tkconch.html#exitStatus
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.conch.scripts.tkconch.frame
  twisted.conch.scripts.tkconch.html#frame
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.conch.scripts.tkconch.deferredAskFrame
  twisted.conch.scripts.tkconch.html#deferredAskFrame
  Function
  Function
  PUBLIC
  Undocumented
- twisted.conch.scripts.tkconch.run
  twisted.conch.scripts.tkconch.html#run
  Function
  Function
  PUBLIC
  Undocumented
- twisted.conch.scripts.tkconch.handleError
  twisted.conch.scripts.tkconch.html#handleError
  Function
  Function
  PUBLIC
  Undocumented
- twisted.conch.scripts.tkconch.SSHClientFactory
  twisted.conch.scripts.tkconch.SSHClientFactory.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.conch.scripts.tkconch.SSHClientFactory.noisy
  twisted.conch.scripts.tkconch.SSHClientFactory.html#noisy
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.scripts.tkconch.SSHClientFactory.stopFactory
  twisted.conch.scripts.tkconch.SSHClientFactory.html#stopFactory
  Function
  Method
  PUBLIC
  This will be called before I stop listening on all Ports/Connectors.
- twisted.conch.scripts.tkconch.SSHClientFactory.buildProtocol
  twisted.conch.scripts.tkconch.SSHClientFactory.html#buildProtocol
  Function
  Method
  PUBLIC
  Create an instance of a subclass of Protocol.
- twisted.conch.scripts.tkconch.SSHClientFactory.clientConnectionFailed
  twisted.conch.scripts.tkconch.SSHClientFactory.html#clientConnectionFailed
  Function
  Method
  PUBLIC
  Called when a connection has failed to connect.
- twisted.conch.scripts.tkconch.SSHClientTransport
  twisted.conch.scripts.tkconch.SSHClientTransport.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.conch.scripts.tkconch.SSHClientTransport.receiveError
  twisted.conch.scripts.tkconch.SSHClientTransport.html#receiveError
  Function
  Method
  PUBLIC
  Called when we receive a disconnect error message from the other side.
- twisted.conch.scripts.tkconch.SSHClientTransport.sendDisconnect
  twisted.conch.scripts.tkconch.SSHClientTransport.html#sendDisconnect
  Function
  Method
  PUBLIC
  Send a disconnect message to the other side and then disconnect.
- twisted.conch.scripts.tkconch.SSHClientTransport.receiveDebug
  twisted.conch.scripts.tkconch.SSHClientTransport.html#receiveDebug
  Function
  Method
  PUBLIC
  Called when we receive a debug message from the other side.
- twisted.conch.scripts.tkconch.SSHClientTransport.verifyHostKey
  twisted.conch.scripts.tkconch.SSHClientTransport.html#verifyHostKey
  Function
  Method
  PUBLIC
  Returns a Deferred that gets a callback if it is a valid key, or an errback if not.
- twisted.conch.scripts.tkconch.SSHClientTransport._cbVerifyHostKey
  twisted.conch.scripts.tkconch.SSHClientTransport.html#_cbVerifyHostKey
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.scripts.tkconch.SSHClientTransport.connectionSecure
  twisted.conch.scripts.tkconch.SSHClientTransport.html#connectionSecure
  Function
  Method
  PUBLIC
  Called when the encryption has been set up. Generally, requestService() is called to run another service over the transport.
- twisted.conch.scripts.tkconch.SSHUserAuthClient
  twisted.conch.scripts.tkconch.SSHUserAuthClient.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.conch.scripts.tkconch.SSHUserAuthClient.usedFiles
  twisted.conch.scripts.tkconch.SSHUserAuthClient.html#usedFiles
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.scripts.tkconch.SSHUserAuthClient.getPassword
  twisted.conch.scripts.tkconch.SSHUserAuthClient.html#getPassword
  Function
  Method
  PUBLIC
  Return a `Deferred` that will be called back with a password. prompt is a string to display for the password, or None for a generic 'user@hostname's password: '.
- twisted.conch.scripts.tkconch.SSHUserAuthClient.getPublicKey
  twisted.conch.scripts.tkconch.SSHUserAuthClient.html#getPublicKey
  Function
  Method
  PUBLIC
  Return a public key for the user. If no more public keys are available, return `None`.
- twisted.conch.scripts.tkconch.SSHUserAuthClient.getPrivateKey
  twisted.conch.scripts.tkconch.SSHUserAuthClient.html#getPrivateKey
  Function
  Method
  PUBLIC
  Return a `Deferred` that will be called back with the private key object corresponding to the last public key from getPublicKey(). If the private key is not available, errback on the Deferred.
- twisted.conch.scripts.tkconch.SSHUserAuthClient._cbGetPrivateKey
  twisted.conch.scripts.tkconch.SSHUserAuthClient.html#_cbGetPrivateKey
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.scripts.tkconch.SSHConnection
  twisted.conch.scripts.tkconch.SSHConnection.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.conch.scripts.tkconch.SSHConnection.serviceStarted
  twisted.conch.scripts.tkconch.SSHConnection.html#serviceStarted
  Function
  Method
  PUBLIC
  called when the service is active on the transport.
- twisted.conch.scripts.tkconch.SSHSession
  twisted.conch.scripts.tkconch.SSHSession.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.conch.scripts.tkconch.SSHSession.name
  twisted.conch.scripts.tkconch.SSHSession.html#name
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.scripts.tkconch.SSHSession.channelOpen
  twisted.conch.scripts.tkconch.SSHSession.html#channelOpen
  Function
  Method
  PUBLIC
  Called when the channel is opened. specificData is any data that the other side sent us when opening the channel.
- twisted.conch.scripts.tkconch.SSHSession.escapeMode
  twisted.conch.scripts.tkconch.SSHSession.html#escapeMode
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.scripts.tkconch.SSHSession.handleInput
  twisted.conch.scripts.tkconch.SSHSession.html#handleInput
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.scripts.tkconch.SSHSession.dataReceived
  twisted.conch.scripts.tkconch.SSHSession.html#dataReceived
  Function
  Method
  PUBLIC
  Called when we receive data.
- twisted.conch.scripts.tkconch.SSHSession.extReceived
  twisted.conch.scripts.tkconch.SSHSession.html#extReceived
  Function
  Method
  PUBLIC
  Called when we receive extended data (usually standard error).
- twisted.conch.scripts.tkconch.SSHSession.eofReceived
  twisted.conch.scripts.tkconch.SSHSession.html#eofReceived
  Function
  Method
  PUBLIC
  Called when the other side will send no more data.
- twisted.conch.scripts.tkconch.SSHSession.closed
  twisted.conch.scripts.tkconch.SSHSession.html#closed
  Function
  Method
  PUBLIC
  Called when the channel is closed. This means that both our side and the remote side have closed the channel.
- twisted.conch.scripts.tkconch.SSHSession.request_exit_status
  twisted.conch.scripts.tkconch.SSHSession.html#request_exit_status
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.scripts.tkconch.SSHSession.sendEOF
  twisted.conch.scripts.tkconch.SSHSession.html#sendEOF
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh._keys_pynacl.Ed25519PublicKey
  twisted.conch.ssh._keys_pynacl.Ed25519PublicKey.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.conch.ssh._keys_pynacl.Ed25519PublicKey.__init__
  twisted.conch.ssh._keys_pynacl.Ed25519PublicKey.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh._keys_pynacl.Ed25519PublicKey._key
  twisted.conch.ssh._keys_pynacl.Ed25519PublicKey.html#_key
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.conch.ssh._keys_pynacl.Ed25519PublicKey.__bytes__
  twisted.conch.ssh._keys_pynacl.Ed25519PublicKey.html#__bytes__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh._keys_pynacl.Ed25519PublicKey.__hash__
  twisted.conch.ssh._keys_pynacl.Ed25519PublicKey.html#__hash__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh._keys_pynacl.Ed25519PublicKey.__eq__
  twisted.conch.ssh._keys_pynacl.Ed25519PublicKey.html#__eq__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh._keys_pynacl.Ed25519PublicKey.__ne__
  twisted.conch.ssh._keys_pynacl.Ed25519PublicKey.html#__ne__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh._keys_pynacl.Ed25519PublicKey.from_public_bytes
  twisted.conch.ssh._keys_pynacl.Ed25519PublicKey.html#from_public_bytes
  Function
  Class Method
  PUBLIC
  Undocumented
- twisted.conch.ssh._keys_pynacl.Ed25519PublicKey.public_bytes
  twisted.conch.ssh._keys_pynacl.Ed25519PublicKey.html#public_bytes
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh._keys_pynacl.Ed25519PublicKey.verify
  twisted.conch.ssh._keys_pynacl.Ed25519PublicKey.html#verify
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh._keys_pynacl.Ed25519PrivateKey
  twisted.conch.ssh._keys_pynacl.Ed25519PrivateKey.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.conch.ssh._keys_pynacl.Ed25519PrivateKey.__init__
  twisted.conch.ssh._keys_pynacl.Ed25519PrivateKey.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh._keys_pynacl.Ed25519PrivateKey._key
  twisted.conch.ssh._keys_pynacl.Ed25519PrivateKey.html#_key
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.conch.ssh._keys_pynacl.Ed25519PrivateKey.__bytes__
  twisted.conch.ssh._keys_pynacl.Ed25519PrivateKey.html#__bytes__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh._keys_pynacl.Ed25519PrivateKey.__hash__
  twisted.conch.ssh._keys_pynacl.Ed25519PrivateKey.html#__hash__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh._keys_pynacl.Ed25519PrivateKey.__eq__
  twisted.conch.ssh._keys_pynacl.Ed25519PrivateKey.html#__eq__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh._keys_pynacl.Ed25519PrivateKey.__ne__
  twisted.conch.ssh._keys_pynacl.Ed25519PrivateKey.html#__ne__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh._keys_pynacl.Ed25519PrivateKey.generate
  twisted.conch.ssh._keys_pynacl.Ed25519PrivateKey.html#generate
  Function
  Class Method
  PUBLIC
  Undocumented
- twisted.conch.ssh._keys_pynacl.Ed25519PrivateKey.from_private_bytes
  twisted.conch.ssh._keys_pynacl.Ed25519PrivateKey.html#from_private_bytes
  Function
  Class Method
  PUBLIC
  Undocumented
- twisted.conch.ssh._keys_pynacl.Ed25519PrivateKey.public_key
  twisted.conch.ssh._keys_pynacl.Ed25519PrivateKey.html#public_key
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh._keys_pynacl.Ed25519PrivateKey.private_bytes
  twisted.conch.ssh._keys_pynacl.Ed25519PrivateKey.html#private_bytes
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.ssh._keys_pynacl.Ed25519PrivateKey.sign
  twisted.conch.ssh._keys_pynacl.Ed25519PrivateKey.html#sign
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.stdio.UnexpectedOutputError
  twisted.conch.stdio.UnexpectedOutputError.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.conch.stdio.TerminalProcessProtocol
  twisted.conch.stdio.TerminalProcessProtocol.html
  Class
  Class
  PUBLIC
  No class docstring; 0/2 instance variable, 3/7 methods documented
- twisted.conch.stdio.TerminalProcessProtocol.__init__
  twisted.conch.stdio.TerminalProcessProtocol.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.stdio.TerminalProcessProtocol.proto
  twisted.conch.stdio.TerminalProcessProtocol.html#proto
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.stdio.TerminalProcessProtocol.onConnection
  twisted.conch.stdio.TerminalProcessProtocol.html#onConnection
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.stdio.TerminalProcessProtocol.connectionMade
  twisted.conch.stdio.TerminalProcessProtocol.html#connectionMade
  Function
  Method
  PUBLIC
  Called when a connection is made.
- twisted.conch.stdio.TerminalProcessProtocol.write
  twisted.conch.stdio.TerminalProcessProtocol.html#write
  Function
  Method
  PUBLIC
  Write to the terminal.
- twisted.conch.stdio.TerminalProcessProtocol.outReceived
  twisted.conch.stdio.TerminalProcessProtocol.html#outReceived
  Function
  Method
  PUBLIC
  Receive data from the terminal.
- twisted.conch.stdio.TerminalProcessProtocol.errReceived
  twisted.conch.stdio.TerminalProcessProtocol.html#errReceived
  Function
  Method
  PUBLIC
  Report an error.
- twisted.conch.stdio.TerminalProcessProtocol.childConnectionLost
  twisted.conch.stdio.TerminalProcessProtocol.html#childConnectionLost
  Function
  Method
  PUBLIC
  Called when a file descriptor associated with the child process is closed.
- twisted.conch.stdio.TerminalProcessProtocol.processEnded
  twisted.conch.stdio.TerminalProcessProtocol.html#processEnded
  Function
  Method
  PUBLIC
  Called when the child process exits and all file descriptors associated with it have been closed.
- twisted.conch.stdio.ConsoleManhole
  twisted.conch.stdio.ConsoleManhole.html
  Class
  Class
  PUBLIC
  A manhole protocol specifically for use with `stdio.StandardIO`.
- twisted.conch.stdio.ConsoleManhole.connectionLost
  twisted.conch.stdio.ConsoleManhole.html#connectionLost
  Function
  Method
  PUBLIC
  When the connection is lost, there is nothing more to do. Stop the reactor so that the process can exit.
- twisted.conch.stdio.runWithProtocol
  twisted.conch.stdio.html#runWithProtocol
  Function
  Function
  PUBLIC
  Undocumented
- twisted.conch.stdio.main
  twisted.conch.stdio.html#main
  Function
  Function
  PUBLIC
  Undocumented
- twisted.conch.ttymodes.VINTR
  twisted.conch.ttymodes.html#VINTR
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ttymodes.VQUIT
  twisted.conch.ttymodes.html#VQUIT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ttymodes.VERASE
  twisted.conch.ttymodes.html#VERASE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ttymodes.VKILL
  twisted.conch.ttymodes.html#VKILL
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ttymodes.VEOF
  twisted.conch.ttymodes.html#VEOF
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ttymodes.VEOL
  twisted.conch.ttymodes.html#VEOL
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ttymodes.VEOL2
  twisted.conch.ttymodes.html#VEOL2
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ttymodes.VSTART
  twisted.conch.ttymodes.html#VSTART
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ttymodes.VSTOP
  twisted.conch.ttymodes.html#VSTOP
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ttymodes.VSUSP
  twisted.conch.ttymodes.html#VSUSP
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ttymodes.VDSUSP
  twisted.conch.ttymodes.html#VDSUSP
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ttymodes.VREPRINT
  twisted.conch.ttymodes.html#VREPRINT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ttymodes.VWERASE
  twisted.conch.ttymodes.html#VWERASE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ttymodes.VLNEXT
  twisted.conch.ttymodes.html#VLNEXT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ttymodes.VFLUSH
  twisted.conch.ttymodes.html#VFLUSH
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ttymodes.VSWTCH
  twisted.conch.ttymodes.html#VSWTCH
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ttymodes.VSTATUS
  twisted.conch.ttymodes.html#VSTATUS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ttymodes.VDISCARD
  twisted.conch.ttymodes.html#VDISCARD
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ttymodes.IGNPAR
  twisted.conch.ttymodes.html#IGNPAR
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ttymodes.PARMRK
  twisted.conch.ttymodes.html#PARMRK
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ttymodes.INPCK
  twisted.conch.ttymodes.html#INPCK
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ttymodes.ISTRIP
  twisted.conch.ttymodes.html#ISTRIP
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ttymodes.INLCR
  twisted.conch.ttymodes.html#INLCR
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ttymodes.IGNCR
  twisted.conch.ttymodes.html#IGNCR
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ttymodes.ICRNL
  twisted.conch.ttymodes.html#ICRNL
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ttymodes.IUCLC
  twisted.conch.ttymodes.html#IUCLC
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ttymodes.IXON
  twisted.conch.ttymodes.html#IXON
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ttymodes.IXANY
  twisted.conch.ttymodes.html#IXANY
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ttymodes.IXOFF
  twisted.conch.ttymodes.html#IXOFF
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ttymodes.IMAXBEL
  twisted.conch.ttymodes.html#IMAXBEL
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ttymodes.ISIG
  twisted.conch.ttymodes.html#ISIG
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ttymodes.ICANON
  twisted.conch.ttymodes.html#ICANON
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ttymodes.XCASE
  twisted.conch.ttymodes.html#XCASE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ttymodes.ECHO
  twisted.conch.ttymodes.html#ECHO
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ttymodes.ECHOE
  twisted.conch.ttymodes.html#ECHOE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ttymodes.ECHOK
  twisted.conch.ttymodes.html#ECHOK
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ttymodes.ECHONL
  twisted.conch.ttymodes.html#ECHONL
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ttymodes.NOFLSH
  twisted.conch.ttymodes.html#NOFLSH
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ttymodes.TOSTOP
  twisted.conch.ttymodes.html#TOSTOP
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ttymodes.IEXTEN
  twisted.conch.ttymodes.html#IEXTEN
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ttymodes.ECHOCTL
  twisted.conch.ttymodes.html#ECHOCTL
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ttymodes.ECHOKE
  twisted.conch.ttymodes.html#ECHOKE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ttymodes.PENDIN
  twisted.conch.ttymodes.html#PENDIN
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ttymodes.OPOST
  twisted.conch.ttymodes.html#OPOST
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ttymodes.OLCUC
  twisted.conch.ttymodes.html#OLCUC
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ttymodes.ONLCR
  twisted.conch.ttymodes.html#ONLCR
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ttymodes.OCRNL
  twisted.conch.ttymodes.html#OCRNL
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ttymodes.ONOCR
  twisted.conch.ttymodes.html#ONOCR
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ttymodes.ONLRET
  twisted.conch.ttymodes.html#ONLRET
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ttymodes.CS7
  twisted.conch.ttymodes.html#CS7
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ttymodes.CS8
  twisted.conch.ttymodes.html#CS8
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ttymodes.PARENB
  twisted.conch.ttymodes.html#PARENB
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ttymodes.PARODD
  twisted.conch.ttymodes.html#PARODD
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ttymodes.TTY_OP_ISPEED
  twisted.conch.ttymodes.html#TTY_OP_ISPEED
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ttymodes.TTY_OP_OSPEED
  twisted.conch.ttymodes.html#TTY_OP_OSPEED
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.ttymodes.TTYMODES
  twisted.conch.ttymodes.html#TTYMODES
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.conch.unix.UnixSSHRealm
  twisted.conch.unix.UnixSSHRealm.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.conch.unix.UnixSSHRealm.requestAvatar
  twisted.conch.unix.UnixSSHRealm.html#requestAvatar
  Function
  Method
  PUBLIC
  Return avatar which provides one of the given interfaces.
- twisted.conch.unix.UnixConchUser
  twisted.conch.unix.UnixConchUser.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.conch.unix.UnixConchUser.__init__
  twisted.conch.unix.UnixConchUser.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.unix.UnixConchUser.username
  twisted.conch.unix.UnixConchUser.html#username
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.unix.UnixConchUser.pwdData
  twisted.conch.unix.UnixConchUser.html#pwdData
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.unix.UnixConchUser.otherGroups
  twisted.conch.unix.UnixConchUser.html#otherGroups
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.unix.UnixConchUser.listeners
  twisted.conch.unix.UnixConchUser.html#listeners
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.unix.UnixConchUser.getUserGroupId
  twisted.conch.unix.UnixConchUser.html#getUserGroupId
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.unix.UnixConchUser.getOtherGroups
  twisted.conch.unix.UnixConchUser.html#getOtherGroups
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.unix.UnixConchUser.getHomeDir
  twisted.conch.unix.UnixConchUser.html#getHomeDir
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.unix.UnixConchUser.getShell
  twisted.conch.unix.UnixConchUser.html#getShell
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.unix.UnixConchUser.global_tcpip_forward
  twisted.conch.unix.UnixConchUser.html#global_tcpip_forward
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.unix.UnixConchUser.global_cancel_tcpip_forward
  twisted.conch.unix.UnixConchUser.html#global_cancel_tcpip_forward
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.unix.UnixConchUser.logout
  twisted.conch.unix.UnixConchUser.html#logout
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.unix.UnixConchUser._runAsUser
  twisted.conch.unix.UnixConchUser.html#_runAsUser
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.unix.SSHSessionForUnixConchUser
  twisted.conch.unix.SSHSessionForUnixConchUser.html
  Class
  Class
  PUBLIC
  No class docstring; 0/8 instance variable, 0/1 class variable, 2/11 methods documented
- twisted.conch.unix.SSHSessionForUnixConchUser._log
  twisted.conch.unix.SSHSessionForUnixConchUser.html#_log
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.conch.unix.SSHSessionForUnixConchUser.__init__
  twisted.conch.unix.SSHSessionForUnixConchUser.html#__init__
  Function
  Method
  PUBLIC
  Construct an `SSHSessionForUnixConchUser`.
- twisted.conch.unix.SSHSessionForUnixConchUser._reactor
  twisted.conch.unix.SSHSessionForUnixConchUser.html#_reactor
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.conch.unix.SSHSessionForUnixConchUser.avatar
  twisted.conch.unix.SSHSessionForUnixConchUser.html#avatar
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.unix.SSHSessionForUnixConchUser.environ
  twisted.conch.unix.SSHSessionForUnixConchUser.html#environ
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.unix.SSHSessionForUnixConchUser.pty
  twisted.conch.unix.SSHSessionForUnixConchUser.html#pty
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.unix.SSHSessionForUnixConchUser.ptyTuple
  twisted.conch.unix.SSHSessionForUnixConchUser.html#ptyTuple
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.unix.SSHSessionForUnixConchUser.addUTMPEntry
  twisted.conch.unix.SSHSessionForUnixConchUser.html#addUTMPEntry
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.unix.SSHSessionForUnixConchUser.getPty
  twisted.conch.unix.SSHSessionForUnixConchUser.html#getPty
  Function
  Method
  PUBLIC
  Get a pseudo-terminal for use by a shell or command.
- twisted.conch.unix.SSHSessionForUnixConchUser.winSize
  twisted.conch.unix.SSHSessionForUnixConchUser.html#winSize
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.unix.SSHSessionForUnixConchUser.modes
  twisted.conch.unix.SSHSessionForUnixConchUser.html#modes
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.unix.SSHSessionForUnixConchUser.openShell
  twisted.conch.unix.SSHSessionForUnixConchUser.html#openShell
  Function
  Method
  PUBLIC
  Open a shell and connect it to proto.
- twisted.conch.unix.SSHSessionForUnixConchUser.oldWrite
  twisted.conch.unix.SSHSessionForUnixConchUser.html#oldWrite
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.unix.SSHSessionForUnixConchUser.execCommand
  twisted.conch.unix.SSHSessionForUnixConchUser.html#execCommand
  Function
  Method
  PUBLIC
  Execute a command.
- twisted.conch.unix.SSHSessionForUnixConchUser.getPtyOwnership
  twisted.conch.unix.SSHSessionForUnixConchUser.html#getPtyOwnership
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.unix.SSHSessionForUnixConchUser.setModes
  twisted.conch.unix.SSHSessionForUnixConchUser.html#setModes
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.unix.SSHSessionForUnixConchUser.eofReceived
  twisted.conch.unix.SSHSessionForUnixConchUser.html#eofReceived
  Function
  Method
  PUBLIC
  Called when the other side has indicated no more data will be sent.
- twisted.conch.unix.SSHSessionForUnixConchUser.closed
  twisted.conch.unix.SSHSessionForUnixConchUser.html#closed
  Function
  Method
  PUBLIC
  Called when the session is closed.
- twisted.conch.unix.SSHSessionForUnixConchUser.windowChanged
  twisted.conch.unix.SSHSessionForUnixConchUser.html#windowChanged
  Function
  Method
  PUBLIC
  Called when the size of the remote screen has changed.
- twisted.conch.unix.SSHSessionForUnixConchUser._writeHack
  twisted.conch.unix.SSHSessionForUnixConchUser.html#_writeHack
  Function
  Method
  PRIVATE
  Hack to send ignore messages when we aren't echoing.
- twisted.conch.unix.SFTPServerForUnixConchUser
  twisted.conch.unix.SFTPServerForUnixConchUser.html
  Class
  Class
  PUBLIC
  No class docstring; 0/1 instance variable, 1/17 method documented
- twisted.conch.unix.SFTPServerForUnixConchUser.__init__
  twisted.conch.unix.SFTPServerForUnixConchUser.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.unix.SFTPServerForUnixConchUser.avatar
  twisted.conch.unix.SFTPServerForUnixConchUser.html#avatar
  Attribute
  Instance Variable
  PUBLIC
  The avatar returned by the Realm that we are authenticated with, and represents the logged-in user.
- twisted.conch.unix.SFTPServerForUnixConchUser._setAttrs
  twisted.conch.unix.SFTPServerForUnixConchUser.html#_setAttrs
  Function
  Method
  PRIVATE
  NOTE: this function assumes it runs as the logged-in user: i.e. under _runAsUser()
- twisted.conch.unix.SFTPServerForUnixConchUser._getAttrs
  twisted.conch.unix.SFTPServerForUnixConchUser.html#_getAttrs
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.unix.SFTPServerForUnixConchUser._absPath
  twisted.conch.unix.SFTPServerForUnixConchUser.html#_absPath
  Function
  Method
  PRIVATE
  Undocumented
- twisted.conch.unix.SFTPServerForUnixConchUser.gotVersion
  twisted.conch.unix.SFTPServerForUnixConchUser.html#gotVersion
  Function
  Method
  PUBLIC
  Called when the client sends their version info.
- twisted.conch.unix.SFTPServerForUnixConchUser.openFile
  twisted.conch.unix.SFTPServerForUnixConchUser.html#openFile
  Function
  Method
  PUBLIC
  Called when the clients asks to open a file.
- twisted.conch.unix.SFTPServerForUnixConchUser.removeFile
  twisted.conch.unix.SFTPServerForUnixConchUser.html#removeFile
  Function
  Method
  PUBLIC
  Remove the given file.
- twisted.conch.unix.SFTPServerForUnixConchUser.renameFile
  twisted.conch.unix.SFTPServerForUnixConchUser.html#renameFile
  Function
  Method
  PUBLIC
  Rename the given file.
- twisted.conch.unix.SFTPServerForUnixConchUser.makeDirectory
  twisted.conch.unix.SFTPServerForUnixConchUser.html#makeDirectory
  Function
  Method
  PUBLIC
  Make a directory.
- twisted.conch.unix.SFTPServerForUnixConchUser.removeDirectory
  twisted.conch.unix.SFTPServerForUnixConchUser.html#removeDirectory
  Function
  Method
  PUBLIC
  Remove a directory (non-recursively)
- twisted.conch.unix.SFTPServerForUnixConchUser.openDirectory
  twisted.conch.unix.SFTPServerForUnixConchUser.html#openDirectory
  Function
  Method
  PUBLIC
  Open a directory for scanning.
- twisted.conch.unix.SFTPServerForUnixConchUser.getAttrs
  twisted.conch.unix.SFTPServerForUnixConchUser.html#getAttrs
  Function
  Method
  PUBLIC
  Return the attributes for the given path.
- twisted.conch.unix.SFTPServerForUnixConchUser.setAttrs
  twisted.conch.unix.SFTPServerForUnixConchUser.html#setAttrs
  Function
  Method
  PUBLIC
  Set the attributes for the path.
- twisted.conch.unix.SFTPServerForUnixConchUser.readLink
  twisted.conch.unix.SFTPServerForUnixConchUser.html#readLink
  Function
  Method
  PUBLIC
  Find the root of a set of symbolic links.
- twisted.conch.unix.SFTPServerForUnixConchUser.makeLink
  twisted.conch.unix.SFTPServerForUnixConchUser.html#makeLink
  Function
  Method
  PUBLIC
  Create a symbolic link.
- twisted.conch.unix.SFTPServerForUnixConchUser.realPath
  twisted.conch.unix.SFTPServerForUnixConchUser.html#realPath
  Function
  Method
  PUBLIC
  Convert any path to an absolute path.
- twisted.conch.unix.SFTPServerForUnixConchUser.extendedRequest
  twisted.conch.unix.SFTPServerForUnixConchUser.html#extendedRequest
  Function
  Method
  PUBLIC
  This is the extension mechanism for SFTP. The other side can send us arbitrary requests.
- twisted.conch.unix.UnixSFTPFile
  twisted.conch.unix.UnixSFTPFile.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.conch.unix.UnixSFTPFile.__init__
  twisted.conch.unix.UnixSFTPFile.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.unix.UnixSFTPFile.server
  twisted.conch.unix.UnixSFTPFile.html#server
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.unix.UnixSFTPFile.fd
  twisted.conch.unix.UnixSFTPFile.html#fd
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.unix.UnixSFTPFile.close
  twisted.conch.unix.UnixSFTPFile.html#close
  Function
  Method
  PUBLIC
  Close the file.
- twisted.conch.unix.UnixSFTPFile.readChunk
  twisted.conch.unix.UnixSFTPFile.html#readChunk
  Function
  Method
  PUBLIC
  Read from the file.
- twisted.conch.unix.UnixSFTPFile.writeChunk
  twisted.conch.unix.UnixSFTPFile.html#writeChunk
  Function
  Method
  PUBLIC
  Write to the file.
- twisted.conch.unix.UnixSFTPFile.getAttrs
  twisted.conch.unix.UnixSFTPFile.html#getAttrs
  Function
  Method
  PUBLIC
  Return the attributes for the file.
- twisted.conch.unix.UnixSFTPFile.setAttrs
  twisted.conch.unix.UnixSFTPFile.html#setAttrs
  Function
  Method
  PUBLIC
  Set the attributes for the file.
- twisted.conch.unix.UnixSFTPDirectory
  twisted.conch.unix.UnixSFTPDirectory.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.conch.unix.UnixSFTPDirectory.__init__
  twisted.conch.unix.UnixSFTPDirectory.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.unix.UnixSFTPDirectory.server
  twisted.conch.unix.UnixSFTPDirectory.html#server
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.unix.UnixSFTPDirectory.files
  twisted.conch.unix.UnixSFTPDirectory.html#files
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.unix.UnixSFTPDirectory.dir
  twisted.conch.unix.UnixSFTPDirectory.html#dir
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.conch.unix.UnixSFTPDirectory.__iter__
  twisted.conch.unix.UnixSFTPDirectory.html#__iter__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.unix.UnixSFTPDirectory.__next__
  twisted.conch.unix.UnixSFTPDirectory.html#__next__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.unix.UnixSFTPDirectory.close
  twisted.conch.unix.UnixSFTPDirectory.html#close
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.tap.Options
  twisted.conch.tap.Options.html
  Class
  Class
  PUBLIC
  No class docstring; 0/1 instance variable, 0/4 class variable, 1/2 method documented
- twisted.conch.tap.Options.synopsis
  twisted.conch.tap.Options.html#synopsis
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.tap.Options.longdesc
  twisted.conch.tap.Options.html#longdesc
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.tap.Options.optParameters
  twisted.conch.tap.Options.html#optParameters
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.tap.Options.compData
  twisted.conch.tap.Options.html#compData
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.conch.tap.Options.__init__
  twisted.conch.tap.Options.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.conch.tap.Options._usingDefaultAuth
  twisted.conch.tap.Options.html#_usingDefaultAuth
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.conch.tap.Options.addChecker
  twisted.conch.tap.Options.html#addChecker
  Function
  Method
  PUBLIC
  Add the checker specified. If any checkers are added, the default checkers are automatically cleared and the only checkers will be the specified one(s).
- twisted.conch.tap.makeService
  twisted.conch.tap.html#makeService
  Function
  Function
  PUBLIC
  Construct a service for operating a SSH server.
- twisted.protocols.loopback._LoopbackQueue
  twisted.protocols.loopback._LoopbackQueue.html
  Class
  Class
  PRIVATE
  Trivial wrapper around a list to give it an interface like a queue, which the addition of also sending notifications by way of a Deferred whenever the list has something added to it.
- twisted.protocols.loopback._LoopbackQueue._notificationDeferred
  twisted.protocols.loopback._LoopbackQueue.html#_notificationDeferred
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.protocols.loopback._LoopbackQueue.disconnect
  twisted.protocols.loopback._LoopbackQueue.html#disconnect
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.protocols.loopback._LoopbackQueue.__init__
  twisted.protocols.loopback._LoopbackQueue.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.loopback._LoopbackQueue._queue
  twisted.protocols.loopback._LoopbackQueue.html#_queue
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.protocols.loopback._LoopbackQueue.put
  twisted.protocols.loopback._LoopbackQueue.html#put
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.loopback._LoopbackQueue.__nonzero__
  twisted.protocols.loopback._LoopbackQueue.html#__nonzero__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.loopback._LoopbackQueue.get
  twisted.protocols.loopback._LoopbackQueue.html#get
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.loopback._LoopbackAddress
  twisted.protocols.loopback._LoopbackAddress.html
  Class
  Class
  PRIVATE
  Undocumented
- twisted.protocols.loopback._LoopbackTransport
  twisted.protocols.loopback._LoopbackTransport.html
  Class
  Class
  PRIVATE
  No class docstring; 0/3 instance variable, 0/1 class variable, 1/10 method documented
- twisted.protocols.loopback._LoopbackTransport.disconnecting
  twisted.protocols.loopback._LoopbackTransport.html#disconnecting
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.protocols.loopback._LoopbackTransport.producer
  twisted.protocols.loopback._LoopbackTransport.html#producer
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.loopback._LoopbackTransport.__init__
  twisted.protocols.loopback._LoopbackTransport.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.loopback._LoopbackTransport.q
  twisted.protocols.loopback._LoopbackTransport.html#q
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.loopback._LoopbackTransport.write
  twisted.protocols.loopback._LoopbackTransport.html#write
  Function
  Method
  PUBLIC
  Write some data to the physical connection, in sequence, in a non-blocking fashion.
- twisted.protocols.loopback._LoopbackTransport.writeSequence
  twisted.protocols.loopback._LoopbackTransport.html#writeSequence
  Function
  Method
  PUBLIC
  Write an iterable of byte strings to the physical connection.
- twisted.protocols.loopback._LoopbackTransport.loseConnection
  twisted.protocols.loopback._LoopbackTransport.html#loseConnection
  Function
  Method
  PUBLIC
  Close my connection, after writing all pending data.
- twisted.protocols.loopback._LoopbackTransport.abortConnection
  twisted.protocols.loopback._LoopbackTransport.html#abortConnection
  Function
  Method
  PUBLIC
  Abort the connection. Same as `loseConnection`.
- twisted.protocols.loopback._LoopbackTransport.getPeer
  twisted.protocols.loopback._LoopbackTransport.html#getPeer
  Function
  Method
  PUBLIC
  Get the remote address of this connection.
- twisted.protocols.loopback._LoopbackTransport.getHost
  twisted.protocols.loopback._LoopbackTransport.html#getHost
  Function
  Method
  PUBLIC
  Similar to getPeer, but returns an address describing this side of the connection.
- twisted.protocols.loopback._LoopbackTransport.registerProducer
  twisted.protocols.loopback._LoopbackTransport.html#registerProducer
  Function
  Method
  PUBLIC
  Register to receive data from a producer.
- twisted.protocols.loopback._LoopbackTransport.streamingProducer
  twisted.protocols.loopback._LoopbackTransport.html#streamingProducer
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.loopback._LoopbackTransport.unregisterProducer
  twisted.protocols.loopback._LoopbackTransport.html#unregisterProducer
  Function
  Method
  PUBLIC
  Stop consuming data from a producer, without disconnecting.
- twisted.protocols.loopback._LoopbackTransport._pollProducer
  twisted.protocols.loopback._LoopbackTransport.html#_pollProducer
  Function
  Method
  PRIVATE
  Undocumented
- twisted.protocols.loopback.identityPumpPolicy
  twisted.protocols.loopback.html#identityPumpPolicy
  Function
  Function
  PUBLIC
  `identityPumpPolicy` is a policy which delivers each chunk of data written to the given queue as-is to the target.
- twisted.protocols.loopback.collapsingPumpPolicy
  twisted.protocols.loopback.html#collapsingPumpPolicy
  Function
  Function
  PUBLIC
  `collapsingPumpPolicy` is a policy which collapses all outstanding chunks into a single string and delivers it to the target.
- twisted.protocols.loopback.loopbackAsync
  twisted.protocols.loopback.html#loopbackAsync
  Function
  Function
  PUBLIC
  Establish a connection between `server` and `client` then transfer data between them until the connection is closed. This is often useful for testing a protocol.
- twisted.protocols.loopback._loopbackAsyncBody
  twisted.protocols.loopback.html#_loopbackAsyncBody
  Function
  Function
  PRIVATE
  Transfer bytes from the output queue of each protocol to the input of the other.
- twisted.protocols.loopback._loopbackAsyncContinue
  twisted.protocols.loopback.html#_loopbackAsyncContinue
  Function
  Function
  PRIVATE
  Undocumented
- twisted.protocols.loopback.LoopbackRelay
  twisted.protocols.loopback.LoopbackRelay.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.protocols.loopback.LoopbackRelay.buffer
  twisted.protocols.loopback.LoopbackRelay.html#buffer
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.loopback.LoopbackRelay.shouldLose
  twisted.protocols.loopback.LoopbackRelay.html#shouldLose
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.loopback.LoopbackRelay.disconnecting
  twisted.protocols.loopback.LoopbackRelay.html#disconnecting
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.protocols.loopback.LoopbackRelay.producer
  twisted.protocols.loopback.LoopbackRelay.html#producer
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.loopback.LoopbackRelay.__init__
  twisted.protocols.loopback.LoopbackRelay.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.loopback.LoopbackRelay.target
  twisted.protocols.loopback.LoopbackRelay.html#target
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.loopback.LoopbackRelay.logFile
  twisted.protocols.loopback.LoopbackRelay.html#logFile
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.loopback.LoopbackRelay.write
  twisted.protocols.loopback.LoopbackRelay.html#write
  Function
  Method
  PUBLIC
  Write some data to the physical connection, in sequence, in a non-blocking fashion.
- twisted.protocols.loopback.LoopbackRelay.writeSequence
  twisted.protocols.loopback.LoopbackRelay.html#writeSequence
  Function
  Method
  PUBLIC
  Write an iterable of byte strings to the physical connection.
- twisted.protocols.loopback.LoopbackRelay.clearBuffer
  twisted.protocols.loopback.LoopbackRelay.html#clearBuffer
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.loopback.LoopbackRelay.loseConnection
  twisted.protocols.loopback.LoopbackRelay.html#loseConnection
  Function
  Method
  PUBLIC
  Close my connection, after writing all pending data.
- twisted.protocols.loopback.LoopbackRelay.getHost
  twisted.protocols.loopback.LoopbackRelay.html#getHost
  Function
  Method
  PUBLIC
  Similar to getPeer, but returns an address describing this side of the connection.
- twisted.protocols.loopback.LoopbackRelay.getPeer
  twisted.protocols.loopback.LoopbackRelay.html#getPeer
  Function
  Method
  PUBLIC
  Get the remote address of this connection.
- twisted.protocols.loopback.LoopbackRelay.registerProducer
  twisted.protocols.loopback.LoopbackRelay.html#registerProducer
  Function
  Method
  PUBLIC
  Register to receive data from a producer.
- twisted.protocols.loopback.LoopbackRelay.unregisterProducer
  twisted.protocols.loopback.LoopbackRelay.html#unregisterProducer
  Function
  Method
  PUBLIC
  Stop consuming data from a producer, without disconnecting.
- twisted.protocols.loopback.LoopbackRelay.logPrefix
  twisted.protocols.loopback.LoopbackRelay.html#logPrefix
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.loopback.LoopbackClientFactory
  twisted.protocols.loopback.LoopbackClientFactory.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.protocols.loopback.LoopbackClientFactory.__init__
  twisted.protocols.loopback.LoopbackClientFactory.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.loopback.LoopbackClientFactory.disconnected
  twisted.protocols.loopback.LoopbackClientFactory.html#disconnected
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.loopback.LoopbackClientFactory.deferred
  twisted.protocols.loopback.LoopbackClientFactory.html#deferred
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.loopback.LoopbackClientFactory.protocol
  twisted.protocols.loopback.LoopbackClientFactory.html#protocol
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.loopback.LoopbackClientFactory.buildProtocol
  twisted.protocols.loopback.LoopbackClientFactory.html#buildProtocol
  Function
  Method
  PUBLIC
  Create an instance of a subclass of Protocol.
- twisted.protocols.loopback.LoopbackClientFactory.clientConnectionLost
  twisted.protocols.loopback.LoopbackClientFactory.html#clientConnectionLost
  Function
  Method
  PUBLIC
  Called when an established connection is lost.
- twisted.protocols.loopback._FireOnClose
  twisted.protocols.loopback._FireOnClose.html
  Class
  Class
  PRIVATE
  Undocumented
- twisted.protocols.loopback._FireOnClose.__init__
  twisted.protocols.loopback._FireOnClose.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.loopback._FireOnClose.deferred
  twisted.protocols.loopback._FireOnClose.html#deferred
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.loopback._FireOnClose.connectionLost
  twisted.protocols.loopback._FireOnClose.html#connectionLost
  Function
  Method
  PUBLIC
  Called when the connection is shut down.
- twisted.protocols.loopback.loopbackTCP
  twisted.protocols.loopback.html#loopbackTCP
  Function
  Function
  PUBLIC
  Run session between server and client protocol instances over TCP.
- twisted.protocols.loopback.loopbackUNIX
  twisted.protocols.loopback.html#loopbackUNIX
  Function
  Function
  PUBLIC
  Run session between server and client protocol instances over UNIX socket.
- twisted.python._shellcomp.shellComplete
  twisted.python._shellcomp.html#shellComplete
  Function
  Function
  PUBLIC
  Perform shell completion.
- twisted.python._shellcomp.SubcommandAction
  twisted.python._shellcomp.SubcommandAction.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.python._shellcomp.SubcommandAction._shellCode
  twisted.python._shellcomp.SubcommandAction.html#_shellCode
  Function
  Method
  PRIVATE
  Fetch a fragment of shell code representing this action which is suitable for use by the completion system in _shellcomp.py
- twisted.python._shellcomp.ZshBuilder
  twisted.python._shellcomp.ZshBuilder.html
  Class
  Class
  PUBLIC
  Constructs zsh code that will complete options for a given usage.Options instance, possibly including a list of subcommand names.
- twisted.python._shellcomp.ZshBuilder.options
  twisted.python._shellcomp.ZshBuilder.html#options
  Attribute
  Instance Variable
  PUBLIC
  The `twisted.python.usage.Options` instance defined for this command.
- twisted.python._shellcomp.ZshBuilder.cmdName
  twisted.python._shellcomp.ZshBuilder.html#cmdName
  Attribute
  Instance Variable
  PUBLIC
  The name of the command we're generating completions for.
- twisted.python._shellcomp.ZshBuilder.file
  twisted.python._shellcomp.ZshBuilder.html#file
  Attribute
  Instance Variable
  PUBLIC
  The `file` to write the completion function to. The `file` must have `bytes` I/O semantics.
- twisted.python._shellcomp.ZshBuilder.__init__
  twisted.python._shellcomp.ZshBuilder.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python._shellcomp.ZshBuilder.write
  twisted.python._shellcomp.ZshBuilder.html#write
  Function
  Method
  PUBLIC
  Generate the completion function and write it to the output file
- twisted.python._shellcomp.ZshSubcommandBuilder
  twisted.python._shellcomp.ZshSubcommandBuilder.html
  Class
  Class
  PUBLIC
  Constructs zsh code that will complete options for a given usage.Options instance, and also for a single sub-command. This will only be used in the case where the user is completing options for a specific subcommand.
- twisted.python._shellcomp.ZshSubcommandBuilder.subOptions
  twisted.python._shellcomp.ZshSubcommandBuilder.html#subOptions
  Attribute
  Instance Variable
  PUBLIC
  The `twisted.python.usage.Options` instance defined for the sub command.
- twisted.python._shellcomp.ZshSubcommandBuilder.__init__
  twisted.python._shellcomp.ZshSubcommandBuilder.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python._shellcomp.ZshSubcommandBuilder.write
  twisted.python._shellcomp.ZshSubcommandBuilder.html#write
  Function
  Method
  PUBLIC
  Generate the completion function and write it to the output file
- twisted.python._shellcomp.ZshArgumentsGenerator
  twisted.python._shellcomp.ZshArgumentsGenerator.html
  Class
  Class
  PUBLIC
  Generate a call to the zsh _arguments completion function based on data in a usage.Options instance
- twisted.python._shellcomp.ZshArgumentsGenerator.options
  twisted.python._shellcomp.ZshArgumentsGenerator.html#options
  Attribute
  Instance Variable
  PUBLIC
  The `twisted.python.usage.Options` instance to generate for
- twisted.python._shellcomp.ZshArgumentsGenerator.cmdName
  twisted.python._shellcomp.ZshArgumentsGenerator.html#cmdName
  Attribute
  Instance Variable
  PUBLIC
  The name of the command we're generating completions for.
- twisted.python._shellcomp.ZshArgumentsGenerator.file
  twisted.python._shellcomp.ZshArgumentsGenerator.html#file
  Attribute
  Instance Variable
  PUBLIC
  The `file` to write the completion function to. The `file` must have `bytes` I/O semantics.
- twisted.python._shellcomp.ZshArgumentsGenerator.descriptions
  twisted.python._shellcomp.ZshArgumentsGenerator.html#descriptions
  Attribute
  Instance Variable
  PUBLIC
  A dict mapping long option names to alternate descriptions. When this variable is defined, the descriptions contained here will override those descriptions provided in the optFlags and optParameters variables.
- twisted.python._shellcomp.ZshArgumentsGenerator.multiUse
  twisted.python._shellcomp.ZshArgumentsGenerator.html#multiUse
  Attribute
  Instance Variable
  PUBLIC
  An iterable containing those long option names which may appear on the command line more than once. By default, options will only be completed one time.
- twisted.python._shellcomp.ZshArgumentsGenerator.mutuallyExclusive
  twisted.python._shellcomp.ZshArgumentsGenerator.html#mutuallyExclusive
  Attribute
  Instance Variable
  PUBLIC
  A sequence of sequences, with each sub-sequence containing those long option names that are mutually exclusive. That is, those options that cannot appear on the command line together.
- twisted.python._shellcomp.ZshArgumentsGenerator.optActions
  twisted.python._shellcomp.ZshArgumentsGenerator.html#optActions
  Attribute
  Instance Variable
  PUBLIC
  A dict mapping long option names to shell "actions". These actions define what may be completed as the argument to the given option, and should be given as instances of `twisted.python.usage.Completer`.
- twisted.python._shellcomp.ZshArgumentsGenerator.extraActions
  twisted.python._shellcomp.ZshArgumentsGenerator.html#extraActions
  Attribute
  Instance Variable
  PUBLIC
  Extra arguments are those arguments typically appearing at the end of the command-line, which are not associated with any particular named option. That is, the arguments that are given to the parseArgs() method of your usage...
- twisted.python._shellcomp.ZshArgumentsGenerator.__init__
  twisted.python._shellcomp.ZshArgumentsGenerator.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python._shellcomp.ZshArgumentsGenerator.optFlags
  twisted.python._shellcomp.ZshArgumentsGenerator.html#optFlags
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python._shellcomp.ZshArgumentsGenerator.optParams
  twisted.python._shellcomp.ZshArgumentsGenerator.html#optParams
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python._shellcomp.ZshArgumentsGenerator.paramNameToDefinition
  twisted.python._shellcomp.ZshArgumentsGenerator.html#paramNameToDefinition
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python._shellcomp.ZshArgumentsGenerator.flagNameToDefinition
  twisted.python._shellcomp.ZshArgumentsGenerator.html#flagNameToDefinition
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python._shellcomp.ZshArgumentsGenerator.allOptionsNameToDefinition
  twisted.python._shellcomp.ZshArgumentsGenerator.html#allOptionsNameToDefinition
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python._shellcomp.ZshArgumentsGenerator.excludes
  twisted.python._shellcomp.ZshArgumentsGenerator.html#excludes
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python._shellcomp.ZshArgumentsGenerator.write
  twisted.python._shellcomp.ZshArgumentsGenerator.html#write
  Function
  Method
  PUBLIC
  Write the zsh completion code to the file given to __init__
- twisted.python._shellcomp.ZshArgumentsGenerator.writeHeader
  twisted.python._shellcomp.ZshArgumentsGenerator.html#writeHeader
  Function
  Method
  PUBLIC
  This is the start of the code that calls _arguments
- twisted.python._shellcomp.ZshArgumentsGenerator.writeOptions
  twisted.python._shellcomp.ZshArgumentsGenerator.html#writeOptions
  Function
  Method
  PUBLIC
  Write out zsh code for each option in this command
- twisted.python._shellcomp.ZshArgumentsGenerator.writeExtras
  twisted.python._shellcomp.ZshArgumentsGenerator.html#writeExtras
  Function
  Method
  PUBLIC
  Write out completion information for extra arguments appearing on the command-line. These are extra positional arguments not associated with a named option. That is, the stuff that gets passed to Options...
- twisted.python._shellcomp.ZshArgumentsGenerator.writeFooter
  twisted.python._shellcomp.ZshArgumentsGenerator.html#writeFooter
  Function
  Method
  PUBLIC
  Write the last bit of code that finishes the call to _arguments
- twisted.python._shellcomp.ZshArgumentsGenerator.verifyZshNames
  twisted.python._shellcomp.ZshArgumentsGenerator.html#verifyZshNames
  Function
  Method
  PUBLIC
  Ensure that none of the option names given in the metadata are typoed
- twisted.python._shellcomp.ZshArgumentsGenerator.excludeStr
  twisted.python._shellcomp.ZshArgumentsGenerator.html#excludeStr
  Function
  Method
  PUBLIC
  Generate an "exclusion string" for the given option
- twisted.python._shellcomp.ZshArgumentsGenerator.makeExcludesDict
  twisted.python._shellcomp.ZshArgumentsGenerator.html#makeExcludesDict
  Function
  Method
  PUBLIC
  No summary
- twisted.python._shellcomp.ZshArgumentsGenerator.writeOpt
  twisted.python._shellcomp.ZshArgumentsGenerator.html#writeOpt
  Function
  Method
  PUBLIC
  Write out the zsh code for the given argument. This is just part of the one big call to _arguments
- twisted.python._shellcomp.ZshArgumentsGenerator.getAction
  twisted.python._shellcomp.ZshArgumentsGenerator.html#getAction
  Function
  Method
  PUBLIC
  Return a zsh "action" string for the given argument
- twisted.python._shellcomp.ZshArgumentsGenerator.getDescription
  twisted.python._shellcomp.ZshArgumentsGenerator.html#getDescription
  Function
  Method
  PUBLIC
  Return the description to be used for this argument
- twisted.python._shellcomp.ZshArgumentsGenerator.getShortOption
  twisted.python._shellcomp.ZshArgumentsGenerator.html#getShortOption
  Function
  Method
  PUBLIC
  Return the short option letter or None
- twisted.python._shellcomp.ZshArgumentsGenerator.addAdditionalOptions
  twisted.python._shellcomp.ZshArgumentsGenerator.html#addAdditionalOptions
  Function
  Method
  PUBLIC
  Add additional options to the optFlags and optParams lists. These will be defined by 'opt_foo' methods of the Options subclass
- twisted.python._shellcomp.descrFromDoc
  twisted.python._shellcomp.html#descrFromDoc
  Function
  Function
  PUBLIC
  Generate an appropriate description from docstring of the given object
- twisted.python._shellcomp.escape
  twisted.python._shellcomp.html#escape
  Function
  Function
  PUBLIC
  Shell escape the given string
- twisted.plugins.cred_anonymous.anonymousCheckerFactoryHelp
  twisted.plugins.cred_anonymous.html#anonymousCheckerFactoryHelp
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.plugins.cred_anonymous.AnonymousCheckerFactory
  twisted.plugins.cred_anonymous.AnonymousCheckerFactory.html
  Class
  Class
  PUBLIC
  Generates checkers that will authenticate an anonymous request.
- twisted.plugins.cred_anonymous.AnonymousCheckerFactory.authType
  twisted.plugins.cred_anonymous.AnonymousCheckerFactory.html#authType
  Attribute
  Class Variable
  PUBLIC
  A tag that identifies the authentication method.
- twisted.plugins.cred_anonymous.AnonymousCheckerFactory.argStringFormat
  twisted.plugins.cred_anonymous.AnonymousCheckerFactory.html#argStringFormat
  Attribute
  Class Variable
  PUBLIC
  A short (one-line) description of the argument string format.
- twisted.plugins.cred_anonymous.AnonymousCheckerFactory.credentialInterfaces
  twisted.plugins.cred_anonymous.AnonymousCheckerFactory.html#credentialInterfaces
  Attribute
  Class Variable
  PUBLIC
  A list of credentials interfaces that this factory will support.
- twisted.plugins.cred_anonymous.AnonymousCheckerFactory.generateChecker
  twisted.plugins.cred_anonymous.AnonymousCheckerFactory.html#generateChecker
  Function
  Method
  PUBLIC
  Return an `twisted.cred.checkers.ICredentialsChecker` provider using the supplied argument string.
- twisted.plugins.cred_anonymous.theAnonymousCheckerFactory
  twisted.plugins.cred_anonymous.html#theAnonymousCheckerFactory
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.plugins.cred_file.fileCheckerFactoryHelp
  twisted.plugins.cred_file.html#fileCheckerFactoryHelp
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.plugins.cred_file.invalidFileWarning
  twisted.plugins.cred_file.html#invalidFileWarning
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.plugins.cred_file.FileCheckerFactory
  twisted.plugins.cred_file.FileCheckerFactory.html
  Class
  Class
  PUBLIC
  A factory for instances of `FilePasswordDB`.
- twisted.plugins.cred_file.FileCheckerFactory.authType
  twisted.plugins.cred_file.FileCheckerFactory.html#authType
  Attribute
  Class Variable
  PUBLIC
  A tag that identifies the authentication method.
- twisted.plugins.cred_file.FileCheckerFactory.argStringFormat
  twisted.plugins.cred_file.FileCheckerFactory.html#argStringFormat
  Attribute
  Class Variable
  PUBLIC
  A short (one-line) description of the argument string format.
- twisted.plugins.cred_file.FileCheckerFactory.credentialInterfaces
  twisted.plugins.cred_file.FileCheckerFactory.html#credentialInterfaces
  Attribute
  Class Variable
  PUBLIC
  A list of credentials interfaces that this factory will support.
- twisted.plugins.cred_file.FileCheckerFactory.generateChecker
  twisted.plugins.cred_file.FileCheckerFactory.html#generateChecker
  Function
  Method
  PUBLIC
  This checker factory expects to get the location of a file. The file should conform to the format required by `FilePasswordDB` (using defaults for all initialization parameters).
- twisted.plugins.cred_file.theFileCheckerFactory
  twisted.plugins.cred_file.html#theFileCheckerFactory
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.enterprise.adbapi.ConnectionLost
  twisted.enterprise.adbapi.ConnectionLost.html
  Class
  Exception
  PUBLIC
  This exception means that a db connection has been lost. Client code may try again.
- twisted.enterprise.adbapi.Connection
  twisted.enterprise.adbapi.Connection.html
  Class
  Class
  PUBLIC
  A wrapper for a DB-API connection instance.
- twisted.enterprise.adbapi.Connection.__init__
  twisted.enterprise.adbapi.Connection.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.enterprise.adbapi.Connection._pool
  twisted.enterprise.adbapi.Connection.html#_pool
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.enterprise.adbapi.Connection._connection
  twisted.enterprise.adbapi.Connection.html#_connection
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.enterprise.adbapi.Connection.close
  twisted.enterprise.adbapi.Connection.html#close
  Function
  Method
  PUBLIC
  Undocumented
- twisted.enterprise.adbapi.Connection.rollback
  twisted.enterprise.adbapi.Connection.html#rollback
  Function
  Method
  PUBLIC
  Undocumented
- twisted.enterprise.adbapi.Connection.reconnect
  twisted.enterprise.adbapi.Connection.html#reconnect
  Function
  Method
  PUBLIC
  Undocumented
- twisted.enterprise.adbapi.Connection.__getattr__
  twisted.enterprise.adbapi.Connection.html#__getattr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.enterprise.adbapi.Transaction
  twisted.enterprise.adbapi.Transaction.html
  Class
  Class
  PUBLIC
  A lightweight wrapper for a DB-API 'cursor' object.
- twisted.enterprise.adbapi.Transaction._cursor
  twisted.enterprise.adbapi.Transaction.html#_cursor
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.enterprise.adbapi.Transaction.__init__
  twisted.enterprise.adbapi.Transaction.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.enterprise.adbapi.Transaction._pool
  twisted.enterprise.adbapi.Transaction.html#_pool
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.enterprise.adbapi.Transaction._connection
  twisted.enterprise.adbapi.Transaction.html#_connection
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.enterprise.adbapi.Transaction.close
  twisted.enterprise.adbapi.Transaction.html#close
  Function
  Method
  PUBLIC
  Undocumented
- twisted.enterprise.adbapi.Transaction.reopen
  twisted.enterprise.adbapi.Transaction.html#reopen
  Function
  Method
  PUBLIC
  Undocumented
- twisted.enterprise.adbapi.Transaction.reconnect
  twisted.enterprise.adbapi.Transaction.html#reconnect
  Function
  Method
  PUBLIC
  Undocumented
- twisted.enterprise.adbapi.Transaction.__getattr__
  twisted.enterprise.adbapi.Transaction.html#__getattr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.enterprise.adbapi.ConnectionPool
  twisted.enterprise.adbapi.ConnectionPool.html
  Class
  Class
  PUBLIC
  Represent a pool of connections to a DB-API 2.0 compliant database.
- twisted.enterprise.adbapi.ConnectionPool.connectionFactory
  twisted.enterprise.adbapi.ConnectionPool.html#connectionFactory
  Attribute
  Instance Variable
  PUBLIC
  factory for connections, default to `Connection`.
- twisted.enterprise.adbapi.ConnectionPool.transactionFactory
  twisted.enterprise.adbapi.ConnectionPool.html#transactionFactory
  Attribute
  Instance Variable
  PUBLIC
  factory for transactions, default to `Transaction`.
- twisted.enterprise.adbapi.ConnectionPool.shutdownID
  twisted.enterprise.adbapi.ConnectionPool.html#shutdownID
  Attribute
  Instance Variable
  PUBLIC
  `None` or a handle on the shutdown event trigger which will be used to stop the connection pool workers when the reactor stops.
- twisted.enterprise.adbapi.ConnectionPool._reactor
  twisted.enterprise.adbapi.ConnectionPool.html#_reactor
  Attribute
  Instance Variable
  PRIVATE
  The reactor which will be used to schedule startup and shutdown events.
- twisted.enterprise.adbapi.ConnectionPool.CP_ARGS
  twisted.enterprise.adbapi.ConnectionPool.html#CP_ARGS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.enterprise.adbapi.ConnectionPool.noisy
  twisted.enterprise.adbapi.ConnectionPool.html#noisy
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.enterprise.adbapi.ConnectionPool.min
  twisted.enterprise.adbapi.ConnectionPool.html#min
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.enterprise.adbapi.ConnectionPool.max
  twisted.enterprise.adbapi.ConnectionPool.html#max
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.enterprise.adbapi.ConnectionPool.name
  twisted.enterprise.adbapi.ConnectionPool.html#name
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.enterprise.adbapi.ConnectionPool.openfun
  twisted.enterprise.adbapi.ConnectionPool.html#openfun
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.enterprise.adbapi.ConnectionPool.reconnect
  twisted.enterprise.adbapi.ConnectionPool.html#reconnect
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.enterprise.adbapi.ConnectionPool.good_sql
  twisted.enterprise.adbapi.ConnectionPool.html#good_sql
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.enterprise.adbapi.ConnectionPool.running
  twisted.enterprise.adbapi.ConnectionPool.html#running
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.enterprise.adbapi.ConnectionPool.__init__
  twisted.enterprise.adbapi.ConnectionPool.html#__init__
  Function
  Method
  PUBLIC
  Create a new `ConnectionPool`.
- twisted.enterprise.adbapi.ConnectionPool.dbapiName
  twisted.enterprise.adbapi.ConnectionPool.html#dbapiName
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.enterprise.adbapi.ConnectionPool.dbapi
  twisted.enterprise.adbapi.ConnectionPool.html#dbapi
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.enterprise.adbapi.ConnectionPool.connargs
  twisted.enterprise.adbapi.ConnectionPool.html#connargs
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.enterprise.adbapi.ConnectionPool.connkw
  twisted.enterprise.adbapi.ConnectionPool.html#connkw
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.enterprise.adbapi.ConnectionPool.connections
  twisted.enterprise.adbapi.ConnectionPool.html#connections
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.enterprise.adbapi.ConnectionPool.threadID
  twisted.enterprise.adbapi.ConnectionPool.html#threadID
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.enterprise.adbapi.ConnectionPool.threadpool
  twisted.enterprise.adbapi.ConnectionPool.html#threadpool
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.enterprise.adbapi.ConnectionPool.startID
  twisted.enterprise.adbapi.ConnectionPool.html#startID
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.enterprise.adbapi.ConnectionPool._start
  twisted.enterprise.adbapi.ConnectionPool.html#_start
  Function
  Method
  PRIVATE
  Undocumented
- twisted.enterprise.adbapi.ConnectionPool.start
  twisted.enterprise.adbapi.ConnectionPool.html#start
  Function
  Method
  PUBLIC
  Start the connection pool.
- twisted.enterprise.adbapi.ConnectionPool.runWithConnection
  twisted.enterprise.adbapi.ConnectionPool.html#runWithConnection
  Function
  Method
  PUBLIC
  Execute a function with a database connection and return the result.
- twisted.enterprise.adbapi.ConnectionPool._runWithConnection
  twisted.enterprise.adbapi.ConnectionPool.html#_runWithConnection
  Function
  Method
  PRIVATE
  Undocumented
- twisted.enterprise.adbapi.ConnectionPool.runInteraction
  twisted.enterprise.adbapi.ConnectionPool.html#runInteraction
  Function
  Method
  PUBLIC
  Interact with the database and return the result.
- twisted.enterprise.adbapi.ConnectionPool.runQuery
  twisted.enterprise.adbapi.ConnectionPool.html#runQuery
  Function
  Method
  PUBLIC
  Execute an SQL query and return the result.
- twisted.enterprise.adbapi.ConnectionPool.runOperation
  twisted.enterprise.adbapi.ConnectionPool.html#runOperation
  Function
  Method
  PUBLIC
  Execute an SQL query and return `None`.
- twisted.enterprise.adbapi.ConnectionPool.close
  twisted.enterprise.adbapi.ConnectionPool.html#close
  Function
  Method
  PUBLIC
  Close all pool connections and shutdown the pool.
- twisted.enterprise.adbapi.ConnectionPool.finalClose
  twisted.enterprise.adbapi.ConnectionPool.html#finalClose
  Function
  Method
  PUBLIC
  This should only be called by the shutdown trigger.
- twisted.enterprise.adbapi.ConnectionPool.connect
  twisted.enterprise.adbapi.ConnectionPool.html#connect
  Function
  Method
  PUBLIC
  Return a database connection when one becomes available.
- twisted.enterprise.adbapi.ConnectionPool.disconnect
  twisted.enterprise.adbapi.ConnectionPool.html#disconnect
  Function
  Method
  PUBLIC
  Disconnect a database connection associated with this pool.
- twisted.enterprise.adbapi.ConnectionPool._close
  twisted.enterprise.adbapi.ConnectionPool.html#_close
  Function
  Method
  PRIVATE
  Undocumented
- twisted.enterprise.adbapi.ConnectionPool._runInteraction
  twisted.enterprise.adbapi.ConnectionPool.html#_runInteraction
  Function
  Method
  PRIVATE
  Undocumented
- twisted.enterprise.adbapi.ConnectionPool._runQuery
  twisted.enterprise.adbapi.ConnectionPool.html#_runQuery
  Function
  Method
  PRIVATE
  Undocumented
- twisted.enterprise.adbapi.ConnectionPool._runOperation
  twisted.enterprise.adbapi.ConnectionPool.html#_runOperation
  Function
  Method
  PRIVATE
  Undocumented
- twisted.enterprise.adbapi.ConnectionPool.__getstate__
  twisted.enterprise.adbapi.ConnectionPool.html#__getstate__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.enterprise.adbapi.ConnectionPool.__setstate__
  twisted.enterprise.adbapi.ConnectionPool.html#__setstate__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.enterprise.adbapi.ConnectionPool.__dict__
  twisted.enterprise.adbapi.ConnectionPool.html#__dict__
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet._dumbwin32proc.PIPE_ATTRS_INHERITABLE
  twisted.internet._dumbwin32proc.html#PIPE_ATTRS_INHERITABLE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet._dumbwin32proc.debug
  twisted.internet._dumbwin32proc.html#debug
  Function
  Function
  PUBLIC
  Undocumented
- twisted.internet._dumbwin32proc._Reaper
  twisted.internet._dumbwin32proc._Reaper.html
  Class
  Class
  PRIVATE
  Undocumented
- twisted.internet._dumbwin32proc._Reaper.__init__
  twisted.internet._dumbwin32proc._Reaper.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet._dumbwin32proc._Reaper.proc
  twisted.internet._dumbwin32proc._Reaper.html#proc
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet._dumbwin32proc._Reaper.checkWork
  twisted.internet._dumbwin32proc._Reaper.html#checkWork
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet._dumbwin32proc._findShebang
  twisted.internet._dumbwin32proc.html#_findShebang
  Function
  Function
  PRIVATE
  Look for a #! line, and return the value following the #! if one exists, or None if this file is not a script.
- twisted.internet._dumbwin32proc._invalidWin32App
  twisted.internet._dumbwin32proc.html#_invalidWin32App
  Function
  Function
  PRIVATE
  Determine if a pywintypes.error is telling us that the given process is 'not a valid win32 application', i.e. not a PE format executable.
- twisted.internet._dumbwin32proc.Process
  twisted.internet._dumbwin32proc.Process.html
  Class
  Class
  PUBLIC
  A process that integrates with the Twisted event loop.
- twisted.internet._dumbwin32proc.Process.closedNotifies
  twisted.internet._dumbwin32proc.Process.html#closedNotifies
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet._dumbwin32proc.Process.__init__
  twisted.internet._dumbwin32proc.Process.html#__init__
  Function
  Method
  PUBLIC
  Create a new child process.
- twisted.internet._dumbwin32proc.Process.hStdoutR
  twisted.internet._dumbwin32proc.Process.html#hStdoutR
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet._dumbwin32proc.Process.hStderrR
  twisted.internet._dumbwin32proc.Process.html#hStderrR
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet._dumbwin32proc.Process.hStdinW
  twisted.internet._dumbwin32proc.Process.html#hStdinW
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet._dumbwin32proc.Process.stdout
  twisted.internet._dumbwin32proc.Process.html#stdout
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet._dumbwin32proc.Process.stderr
  twisted.internet._dumbwin32proc.Process.html#stderr
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet._dumbwin32proc.Process.stdin
  twisted.internet._dumbwin32proc.Process.html#stdin
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet._dumbwin32proc.Process.signalProcess
  twisted.internet._dumbwin32proc.Process.html#signalProcess
  Function
  Method
  PUBLIC
  Send a signal to the process.
- twisted.internet._dumbwin32proc.Process._getReason
  twisted.internet._dumbwin32proc.Process.html#_getReason
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet._dumbwin32proc.Process.write
  twisted.internet._dumbwin32proc.Process.html#write
  Function
  Method
  PUBLIC
  Write data to the process' stdin.
- twisted.internet._dumbwin32proc.Process.writeSequence
  twisted.internet._dumbwin32proc.Process.html#writeSequence
  Function
  Method
  PUBLIC
  Write data to the process' stdin.
- twisted.internet._dumbwin32proc.Process.writeToChild
  twisted.internet._dumbwin32proc.Process.html#writeToChild
  Function
  Method
  PUBLIC
  Similar to `ITransport.write` but also allows the file descriptor in the child process which will receive the bytes to be specified.
- twisted.internet._dumbwin32proc.Process.closeChildFD
  twisted.internet._dumbwin32proc.Process.html#closeChildFD
  Function
  Method
  PUBLIC
  Close a file descriptor which is connected to the child process, identified by its FD in the child process.
- twisted.internet._dumbwin32proc.Process.closeStdin
  twisted.internet._dumbwin32proc.Process.html#closeStdin
  Function
  Method
  PUBLIC
  Close the process' stdin.
- twisted.internet._dumbwin32proc.Process.closeStderr
  twisted.internet._dumbwin32proc.Process.html#closeStderr
  Function
  Method
  PUBLIC
  Close stderr.
- twisted.internet._dumbwin32proc.Process.closeStdout
  twisted.internet._dumbwin32proc.Process.html#closeStdout
  Function
  Method
  PUBLIC
  Close stdout.
- twisted.internet._dumbwin32proc.Process.loseConnection
  twisted.internet._dumbwin32proc.Process.html#loseConnection
  Function
  Method
  PUBLIC
  Close the process' stdout, in and err.
- twisted.internet._dumbwin32proc.Process.outConnectionLost
  twisted.internet._dumbwin32proc.Process.html#outConnectionLost
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet._dumbwin32proc.Process.errConnectionLost
  twisted.internet._dumbwin32proc.Process.html#errConnectionLost
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet._dumbwin32proc.Process.inConnectionLost
  twisted.internet._dumbwin32proc.Process.html#inConnectionLost
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet._dumbwin32proc.Process.connectionLostNotify
  twisted.internet._dumbwin32proc.Process.html#connectionLostNotify
  Function
  Method
  PUBLIC
  Will be called 3 times, by stdout/err threads and process handle.
- twisted.internet._dumbwin32proc.Process.maybeCallProcessEnded
  twisted.internet._dumbwin32proc.Process.html#maybeCallProcessEnded
  Function
  Method
  PUBLIC
  Call processEnded on protocol after final cleanup.
- twisted.internet._dumbwin32proc.Process.hProcess
  twisted.internet._dumbwin32proc.Process.html#hProcess
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet._dumbwin32proc.Process.hThread
  twisted.internet._dumbwin32proc.Process.html#hThread
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet._dumbwin32proc.Process.registerProducer
  twisted.internet._dumbwin32proc.Process.html#registerProducer
  Function
  Method
  PUBLIC
  Register to receive data from a producer.
- twisted.internet._dumbwin32proc.Process.unregisterProducer
  twisted.internet._dumbwin32proc.Process.html#unregisterProducer
  Function
  Method
  PUBLIC
  Stop consuming data from a producer, without disconnecting.
- twisted.internet._dumbwin32proc.Process.pauseProducing
  twisted.internet._dumbwin32proc.Process.html#pauseProducing
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet._dumbwin32proc.Process.resumeProducing
  twisted.internet._dumbwin32proc.Process.html#resumeProducing
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet._dumbwin32proc.Process.stopProducing
  twisted.internet._dumbwin32proc.Process.html#stopProducing
  Function
  Method
  PUBLIC
  Stop producing data.
- twisted.internet._dumbwin32proc.Process.getHost
  twisted.internet._dumbwin32proc.Process.html#getHost
  Function
  Method
  PUBLIC
  Similar to getPeer, but returns an address describing this side of the connection.
- twisted.internet._dumbwin32proc.Process.getPeer
  twisted.internet._dumbwin32proc.Process.html#getPeer
  Function
  Method
  PUBLIC
  Get the remote address of this connection.
- twisted.internet._dumbwin32proc.Process.__repr__
  twisted.internet._dumbwin32proc.Process.html#__repr__
  Function
  Method
  PUBLIC
  Return a string representation of the process.
- twisted.internet.udp._sockErrReadIgnore
  twisted.internet.udp.html#_sockErrReadIgnore
  Attribute
  Variable
  PRIVATE
  list of symbolic error constants (from the `errno` module) representing socket errors where the error is temporary and can be ignored.
- twisted.internet.udp._sockErrReadRefuse
  twisted.internet.udp.html#_sockErrReadRefuse
  Attribute
  Variable
  PRIVATE
  list of symbolic error constants (from the `errno` module) representing socket errors that indicate connection refused.
- twisted.internet.udp.Port
  twisted.internet.udp.Port.html
  Class
  Class
  PUBLIC
  UDP port, listening for packets.
- twisted.internet.udp.Port.maxThroughput
  twisted.internet.udp.Port.html#maxThroughput
  Attribute
  Instance Variable
  PUBLIC
  Maximum number of bytes read in one event loop iteration.
- twisted.internet.udp.Port.addressFamily
  twisted.internet.udp.Port.html#addressFamily
  Attribute
  Instance Variable
  PUBLIC
  `socket.AF_INET` or `socket.AF_INET6`, depending on whether this port is listening on an IPv4 address or an IPv6 address.
- twisted.internet.udp.Port._realPortNumber
  twisted.internet.udp.Port.html#_realPortNumber
  Attribute
  Instance Variable
  PRIVATE
  Actual port number being listened on. The value will be `None` until this `Port` is listening.
- twisted.internet.udp.Port._preexistingSocket
  twisted.internet.udp.Port.html#_preexistingSocket
  Attribute
  Instance Variable
  PRIVATE
  If not `None`, a `socket.socket` instance which was created and initialized outside of the reactor and will be used to listen for connections (instead of a new socket being created by this `Port`).
- twisted.internet.udp.Port.__init__
  twisted.internet.udp.Port.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.internet.udp.Port.port
  twisted.internet.udp.Port.html#port
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.udp.Port.protocol
  twisted.internet.udp.Port.html#protocol
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.udp.Port.maxPacketSize
  twisted.internet.udp.Port.html#maxPacketSize
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.udp.Port.interface
  twisted.internet.udp.Port.html#interface
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.udp.Port._connectedAddr
  twisted.internet.udp.Port.html#_connectedAddr
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.udp.Port._fromListeningDescriptor
  twisted.internet.udp.Port.html#_fromListeningDescriptor
  Function
  Class Method
  PRIVATE
  Create a new `Port` based on an existing listening SOCK_DGRAM socket.
- twisted.internet.udp.Port.__repr__
  twisted.internet.udp.Port.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.udp.Port.getHandle
  twisted.internet.udp.Port.html#getHandle
  Function
  Method
  PUBLIC
  Return a socket object.
- twisted.internet.udp.Port.startListening
  twisted.internet.udp.Port.html#startListening
  Function
  Method
  PUBLIC
  Create and bind my socket, and begin listening on it.
- twisted.internet.udp.Port._bindSocket
  twisted.internet.udp.Port.html#_bindSocket
  Function
  Method
  PRIVATE
  Prepare and assign a `socket.socket` instance to `self.socket`.
- twisted.internet.udp.Port.connected
  twisted.internet.udp.Port.html#connected
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.udp.Port.socket
  twisted.internet.udp.Port.html#socket
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.udp.Port._connectToProtocol
  twisted.internet.udp.Port.html#_connectToProtocol
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet.udp.Port.doRead
  twisted.internet.udp.Port.html#doRead
  Function
  Method
  PUBLIC
  Called when my socket is ready for reading.
- twisted.internet.udp.Port.write
  twisted.internet.udp.Port.html#write
  Function
  Method
  PUBLIC
  Write a datagram.
- twisted.internet.udp.Port.writeSequence
  twisted.internet.udp.Port.html#writeSequence
  Function
  Method
  PUBLIC
  Write a datagram constructed from an iterable of `bytes`.
- twisted.internet.udp.Port.connect
  twisted.internet.udp.Port.html#connect
  Function
  Method
  PUBLIC
  'Connect' to remote server.
- twisted.internet.udp.Port._loseConnection
  twisted.internet.udp.Port.html#_loseConnection
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet.udp.Port.stopListening
  twisted.internet.udp.Port.html#stopListening
  Function
  Method
  PUBLIC
  Stop listening on this port.
- twisted.internet.udp.Port.d
  twisted.internet.udp.Port.html#d
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.udp.Port.loseConnection
  twisted.internet.udp.Port.html#loseConnection
  Function
  Method
  PUBLIC
  Close the connection at the next available opportunity.
- twisted.internet.udp.Port.connectionLost
  twisted.internet.udp.Port.html#connectionLost
  Function
  Method
  PUBLIC
  Cleans up my socket.
- twisted.internet.udp.Port.setLogStr
  twisted.internet.udp.Port.html#setLogStr
  Function
  Method
  PUBLIC
  Initialize the `logstr` attribute to be used by `logPrefix`.
- twisted.internet.udp.Port.logstr
  twisted.internet.udp.Port.html#logstr
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.udp.Port._setAddressFamily
  twisted.internet.udp.Port.html#_setAddressFamily
  Function
  Method
  PRIVATE
  Resolve address family for the socket.
- twisted.internet.udp.Port.logPrefix
  twisted.internet.udp.Port.html#logPrefix
  Function
  Method
  PUBLIC
  Return the prefix to log with.
- twisted.internet.udp.Port.getHost
  twisted.internet.udp.Port.html#getHost
  Function
  Method
  PUBLIC
  Return the local address of the UDP connection
- twisted.internet.udp.Port.setBroadcastAllowed
  twisted.internet.udp.Port.html#setBroadcastAllowed
  Function
  Method
  PUBLIC
  Set whether this port may broadcast. This is disabled by default.
- twisted.internet.udp.Port.getBroadcastAllowed
  twisted.internet.udp.Port.html#getBroadcastAllowed
  Function
  Method
  PUBLIC
  Checks if broadcast is currently allowed on this port.
- twisted.internet.udp.MulticastMixin
  twisted.internet.udp.MulticastMixin.html
  Class
  Class
  PUBLIC
  Implement multicast functionality.
- twisted.internet.udp.MulticastMixin.getOutgoingInterface
  twisted.internet.udp.MulticastMixin.html#getOutgoingInterface
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.udp.MulticastMixin.setOutgoingInterface
  twisted.internet.udp.MulticastMixin.html#setOutgoingInterface
  Function
  Method
  PUBLIC
  Returns Deferred of success.
- twisted.internet.udp.MulticastMixin._setInterface
  twisted.internet.udp.MulticastMixin.html#_setInterface
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet.udp.MulticastMixin.getLoopbackMode
  twisted.internet.udp.MulticastMixin.html#getLoopbackMode
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.udp.MulticastMixin.setLoopbackMode
  twisted.internet.udp.MulticastMixin.html#setLoopbackMode
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.udp.MulticastMixin.getTTL
  twisted.internet.udp.MulticastMixin.html#getTTL
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.udp.MulticastMixin.setTTL
  twisted.internet.udp.MulticastMixin.html#setTTL
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.udp.MulticastMixin.joinGroup
  twisted.internet.udp.MulticastMixin.html#joinGroup
  Function
  Method
  PUBLIC
  Join a multicast group. Returns Deferred of success.
- twisted.internet.udp.MulticastMixin._joinAddr1
  twisted.internet.udp.MulticastMixin.html#_joinAddr1
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet.udp.MulticastMixin._joinAddr2
  twisted.internet.udp.MulticastMixin.html#_joinAddr2
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet.udp.MulticastMixin.leaveGroup
  twisted.internet.udp.MulticastMixin.html#leaveGroup
  Function
  Method
  PUBLIC
  Leave multicast group, return Deferred of success.
- twisted.internet.udp.MulticastPort
  twisted.internet.udp.MulticastPort.html
  Class
  Class
  PUBLIC
  UDP Port that supports multicasting.
- twisted.internet.udp.MulticastPort.__init__
  twisted.internet.udp.MulticastPort.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.internet.udp.MulticastPort.listenMultiple
  twisted.internet.udp.MulticastPort.html#listenMultiple
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.udp.MulticastPort.createInternetSocket
  twisted.internet.udp.MulticastPort.html#createInternetSocket
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.posixbase._NO_FILENO
  twisted.internet.posixbase.html#_NO_FILENO
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.internet.posixbase._NO_FILEDESC
  twisted.internet.posixbase.html#_NO_FILEDESC
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.internet.posixbase.unixEnabled
  twisted.internet.posixbase.html#unixEnabled
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.internet.posixbase.processEnabled
  twisted.internet.posixbase.html#processEnabled
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.internet._signals.installHandler
  twisted.internet._signals.html#installHandler
  Function
  Function
  PUBLIC
  Install a signal handler which will write a byte to `fd` when SIGCHLD is received.
- twisted.internet._signals.isDefaultHandler
  twisted.internet._signals.html#isDefaultHandler
  Function
  Function
  PUBLIC
  Determine whether the SIGCHLD handler is the default or not.
- twisted.python.sendmsg.ReceivedMessage
  twisted.python.sendmsg.html#ReceivedMessage
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.python.sendmsg.sendmsg
  twisted.python.sendmsg.html#sendmsg
  Function
  Function
  PUBLIC
  Send a message on a socket.
- twisted.python.sendmsg.recvmsg
  twisted.python.sendmsg.html#recvmsg
  Function
  Function
  PUBLIC
  Receive a message on a socket.
- twisted.python.sendmsg.getSocketFamily
  twisted.python.sendmsg.html#getSocketFamily
  Function
  Function
  PUBLIC
  Return the family of the given socket.
- twisted.internet.unix._ancillaryDescriptor
  twisted.internet.unix.html#_ancillaryDescriptor
  Function
  Function
  PRIVATE
  Pack an integer into an ancillary data structure suitable for use with `sendmsg.sendmsg`.
- twisted.internet.unix._SendmsgMixin
  twisted.internet.unix._SendmsgMixin.html
  Class
  Class
  PRIVATE
  Mixin for stream-oriented UNIX transports which uses sendmsg and recvmsg to offer additional functionality, such as copying file descriptors into other processes.
- twisted.internet.unix._SendmsgMixin._writeSomeDataBase
  twisted.internet.unix._SendmsgMixin.html#_writeSomeDataBase
  Attribute
  Instance Variable
  PRIVATE
  The class which provides the basic implementation of `writeSomeData`. Ultimately this should be a subclass of `twisted.internet.abstract.FileDescriptor`. Subclasses which mix in `_SendmsgMixin` must define this.
- twisted.internet.unix._SendmsgMixin._sendmsgQueue
  twisted.internet.unix._SendmsgMixin.html#_sendmsgQueue
  Attribute
  Instance Variable
  PRIVATE
  A `list` of `int` holding file descriptors which are currently buffered before being sent.
- twisted.internet.unix._SendmsgMixin._fileDescriptorBufferSize
  twisted.internet.unix._SendmsgMixin.html#_fileDescriptorBufferSize
  Attribute
  Instance Variable
  PRIVATE
  An `int` giving the maximum number of file descriptors to accept and queue for sending before pausing the registered producer, if there is one.
- twisted.internet.unix._SendmsgMixin.__init__
  twisted.internet.unix._SendmsgMixin.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.unix._SendmsgMixin._isSendBufferFull
  twisted.internet.unix._SendmsgMixin.html#_isSendBufferFull
  Function
  Method
  PRIVATE
  Determine whether the user-space send buffer for this transport is full or not.
- twisted.internet.unix._SendmsgMixin.sendFileDescriptor
  twisted.internet.unix._SendmsgMixin.html#sendFileDescriptor
  Function
  Method
  PUBLIC
  Queue the given file descriptor to be sent and start trying to send it.
- twisted.internet.unix._SendmsgMixin.writeSomeData
  twisted.internet.unix._SendmsgMixin.html#writeSomeData
  Function
  Method
  PUBLIC
  Send as much of `data` as possible. Also send any pending file descriptors.
- twisted.internet.unix._SendmsgMixin.doRead
  twisted.internet.unix._SendmsgMixin.html#doRead
  Function
  Method
  PUBLIC
  Calls {IProtocol.dataReceived} with all available data and `IFileDescriptorReceiver.fileDescriptorReceived` once for each received file descriptor in ancillary data.
- twisted.internet.unix._SendmsgMixin._ancillaryLevelSOLSOCKETTypeSCMRIGHTS
  twisted.internet.unix._SendmsgMixin.html#_ancillaryLevelSOLSOCKETTypeSCMRIGHTS
  Function
  Method
  PRIVATE
  Processes ancillary data with level SOL_SOCKET and type SCM_RIGHTS, indicating that the ancillary data payload holds file descriptors.
- twisted.internet.unix._UnsupportedSendmsgMixin
  twisted.internet.unix._UnsupportedSendmsgMixin.html
  Class
  Class
  PRIVATE
  Behaviorless placeholder used when `twisted.python.sendmsg` is not available, preventing `IUNIXTransport` from being supported.
- twisted.internet.unix.Server
  twisted.internet.unix.Server.html
  Class
  Class
  PUBLIC
  No class docstring; 0/2 instance variable, 0/3 method, 1/1 class method documented
- twisted.internet.unix.Server.__init__
  twisted.internet.unix.Server.html#__init__
  Function
  Method
  PUBLIC
  Server(sock, protocol, client, server, sessionno)
- twisted.internet.unix.Server._fromConnectedSocket
  twisted.internet.unix.Server.html#_fromConnectedSocket
  Function
  Class Method
  PRIVATE
  Create a new `Server` based on an existing connected SOCK_STREAM socket.
- twisted.internet.unix.Server.repstr
  twisted.internet.unix.Server.html#repstr
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.unix.Server.logstr
  twisted.internet.unix.Server.html#logstr
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.unix.Server.getHost
  twisted.internet.unix.Server.html#getHost
  Function
  Method
  PUBLIC
  Returns an `IPv4Address` or `IPv6Address`.
- twisted.internet.unix.Server.getPeer
  twisted.internet.unix.Server.html#getPeer
  Function
  Method
  PUBLIC
  Returns an `IPv4Address` or `IPv6Address`.
- twisted.internet.unix._inFilesystemNamespace
  twisted.internet.unix.html#_inFilesystemNamespace
  Function
  Function
  PRIVATE
  Determine whether the given unix socket path is in a filesystem namespace.
- twisted.internet.unix._UNIXPort
  twisted.internet.unix._UNIXPort.html
  Class
  Class
  PRIVATE
  No class docstring; 1/1 method documented
- twisted.internet.unix._UNIXPort.getHost
  twisted.internet.unix._UNIXPort.html#getHost
  Function
  Method
  PUBLIC
  Returns a UNIXAddress.
- twisted.internet.unix.Port
  twisted.internet.unix.Port.html
  Class
  Class
  PUBLIC
  No class docstring; 0/4 instance variable, 2/6 methods, 1/1 class method documented
- twisted.internet.unix.Port.lockFile
  twisted.internet.unix.Port.html#lockFile
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.unix.Port.__init__
  twisted.internet.unix.Port.html#__init__
  Function
  Method
  PUBLIC
  Initialize with a numeric port to listen on.
- twisted.internet.unix.Port.mode
  twisted.internet.unix.Port.html#mode
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.unix.Port.wantPID
  twisted.internet.unix.Port.html#wantPID
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.unix.Port._preexistingSocket
  twisted.internet.unix.Port.html#_preexistingSocket
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.unix.Port._fromListeningDescriptor
  twisted.internet.unix.Port.html#_fromListeningDescriptor
  Function
  Class Method
  PRIVATE
  Create a new `Port` based on an existing listening SOCK_STREAM socket.
- twisted.internet.unix.Port.__repr__
  twisted.internet.unix.Port.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.unix.Port._buildAddr
  twisted.internet.unix.Port.html#_buildAddr
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet.unix.Port.startListening
  twisted.internet.unix.Port.html#startListening
  Function
  Method
  PUBLIC
  Create and bind my socket, and begin listening on it.
- twisted.internet.unix.Port._logConnectionLostMsg
  twisted.internet.unix.Port.html#_logConnectionLostMsg
  Function
  Method
  PRIVATE
  Log message for closing socket
- twisted.internet.unix.Port.connectionLost
  twisted.internet.unix.Port.html#connectionLost
  Function
  Method
  PUBLIC
  Cleans up the socket.
- twisted.internet.unix.Client
  twisted.internet.unix.Client.html
  Class
  Class
  PUBLIC
  A client for Unix sockets.
- twisted.internet.unix.Client.__init__
  twisted.internet.unix.Client.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.internet.unix.Client.connector
  twisted.internet.unix.Client.html#connector
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.unix.Client.realAddress
  twisted.internet.unix.Client.html#realAddress
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.unix.Client.addr
  twisted.internet.unix.Client.html#addr
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.unix.Client.getPeer
  twisted.internet.unix.Client.html#getPeer
  Function
  Method
  PUBLIC
  Get the remote address of this connection.
- twisted.internet.unix.Client.getHost
  twisted.internet.unix.Client.html#getHost
  Function
  Method
  PUBLIC
  Similar to getPeer, but returns an address describing this side of the connection.
- twisted.internet.unix.Connector
  twisted.internet.unix.Connector.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.internet.unix.Connector.__init__
  twisted.internet.unix.Connector.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.unix.Connector.address
  twisted.internet.unix.Connector.html#address
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.unix.Connector.checkPID
  twisted.internet.unix.Connector.html#checkPID
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.unix.Connector._makeTransport
  twisted.internet.unix.Connector.html#_makeTransport
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet.unix.Connector.getDestination
  twisted.internet.unix.Connector.html#getDestination
  Function
  Method
  PUBLIC
  Return destination this will try to connect to.
- twisted.internet.unix.DatagramPort
  twisted.internet.unix.DatagramPort.html
  Class
  Class
  PUBLIC
  Datagram UNIX port, listening for packets.
- twisted.internet.unix.DatagramPort.__init__
  twisted.internet.unix.DatagramPort.html#__init__
  Function
  Method
  PUBLIC
  Initialize with address to listen on.
- twisted.internet.unix.DatagramPort.mode
  twisted.internet.unix.DatagramPort.html#mode
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.unix.DatagramPort.__repr__
  twisted.internet.unix.DatagramPort.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.unix.DatagramPort._bindSocket
  twisted.internet.unix.DatagramPort.html#_bindSocket
  Function
  Method
  PRIVATE
  Prepare and assign a `socket.socket` instance to `self.socket`.
- twisted.internet.unix.DatagramPort.connected
  twisted.internet.unix.DatagramPort.html#connected
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.unix.DatagramPort.socket
  twisted.internet.unix.DatagramPort.html#socket
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.unix.DatagramPort.write
  twisted.internet.unix.DatagramPort.html#write
  Function
  Method
  PUBLIC
  Write a datagram.
- twisted.internet.unix.DatagramPort.connectionLost
  twisted.internet.unix.DatagramPort.html#connectionLost
  Function
  Method
  PUBLIC
  Cleans up my socket.
- twisted.internet.unix.DatagramPort.setLogStr
  twisted.internet.unix.DatagramPort.html#setLogStr
  Function
  Method
  PUBLIC
  Initialize the `logstr` attribute to be used by `logPrefix`.
- twisted.internet.unix.DatagramPort.logstr
  twisted.internet.unix.DatagramPort.html#logstr
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.unix.ConnectedDatagramPort
  twisted.internet.unix.ConnectedDatagramPort.html
  Class
  Class
  PUBLIC
  A connected datagram UNIX socket.
- twisted.internet.unix.ConnectedDatagramPort.__init__
  twisted.internet.unix.ConnectedDatagramPort.html#__init__
  Function
  Method
  PUBLIC
  Initialize with address to listen on.
- twisted.internet.unix.ConnectedDatagramPort.remoteaddr
  twisted.internet.unix.ConnectedDatagramPort.html#remoteaddr
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.unix.ConnectedDatagramPort.startListening
  twisted.internet.unix.ConnectedDatagramPort.html#startListening
  Function
  Method
  PUBLIC
  Create and bind my socket, and begin listening on it.
- twisted.internet.unix.ConnectedDatagramPort.connectionFailed
  twisted.internet.unix.ConnectedDatagramPort.html#connectionFailed
  Function
  Method
  PUBLIC
  Called when a connection fails. Stop listening on the socket.
- twisted.internet.unix.ConnectedDatagramPort.doRead
  twisted.internet.unix.ConnectedDatagramPort.html#doRead
  Function
  Method
  PUBLIC
  Called when my socket is ready for reading.
- twisted.internet.unix.ConnectedDatagramPort.write
  twisted.internet.unix.ConnectedDatagramPort.html#write
  Function
  Method
  PUBLIC
  Write a datagram.
- twisted.internet.unix.ConnectedDatagramPort.getPeer
  twisted.internet.unix.ConnectedDatagramPort.html#getPeer
  Function
  Method
  PUBLIC
  Get the remote address of this connection.
- twisted.internet.posixbase._IWaker
  twisted.internet.posixbase._IWaker.html
  Class
  Interface
  PRIVATE
  Interface to wake up the event loop based on the self-pipe trick.
- twisted.internet.posixbase._IWaker.disconnected
  twisted.internet.posixbase._IWaker.html#disconnected
  Attribute
  Attribute
  PUBLIC
  Undocumented
- twisted.internet.posixbase._IWaker.wakeUp
  twisted.internet.posixbase._IWaker.html#wakeUp
  Function
  Method
  PUBLIC
  Called when the event should be wake up.
- twisted.internet.posixbase._IWaker.doRead
  twisted.internet.posixbase._IWaker.html#doRead
  Function
  Method
  PUBLIC
  Read some data from my connection and discard it.
- twisted.internet.posixbase._IWaker.connectionLost
  twisted.internet.posixbase._IWaker.html#connectionLost
  Function
  Method
  PUBLIC
  Called when connection was closed and the pipes.
- twisted.internet.posixbase._SocketWaker
  twisted.internet.posixbase._SocketWaker.html
  Class
  Class
  PRIVATE
  The self-pipe trick<http://cr.yp.to/docs/selfpipe.html>, implemented using a pair of sockets rather than pipes (due to the lack of support in select() on Windows for pipes), used to wake up the main loop from another thread.
- twisted.internet.posixbase._SocketWaker.disconnected
  twisted.internet.posixbase._SocketWaker.html#disconnected
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet.posixbase._SocketWaker.__init__
  twisted.internet.posixbase._SocketWaker.html#__init__
  Function
  Method
  PUBLIC
  Initialize.
- twisted.internet.posixbase._SocketWaker.reactor
  twisted.internet.posixbase._SocketWaker.html#reactor
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.posixbase._SocketWaker.r
  twisted.internet.posixbase._SocketWaker.html#r
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.posixbase._SocketWaker.w
  twisted.internet.posixbase._SocketWaker.html#w
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.posixbase._SocketWaker.fileno
  twisted.internet.posixbase._SocketWaker.html#fileno
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.posixbase._SocketWaker.wakeUp
  twisted.internet.posixbase._SocketWaker.html#wakeUp
  Function
  Method
  PUBLIC
  Send a byte to my connection.
- twisted.internet.posixbase._SocketWaker.doRead
  twisted.internet.posixbase._SocketWaker.html#doRead
  Function
  Method
  PUBLIC
  Read some data from my connection.
- twisted.internet.posixbase._SocketWaker.connectionLost
  twisted.internet.posixbase._SocketWaker.html#connectionLost
  Function
  Method
  PUBLIC
  Called when connection was closed and the pipes.
- twisted.internet.posixbase._FDWaker
  twisted.internet.posixbase._FDWaker.html
  Class
  Class
  PRIVATE
  The self-pipe trick<http://cr.yp.to/docs/selfpipe.html>, used to wake up the main loop from another thread or a signal handler.
- twisted.internet.posixbase._FDWaker.o
  twisted.internet.posixbase._FDWaker.html#o
  Attribute
  Instance Variable
  PUBLIC
  The file descriptor for the end of the pipe which can be written to wake up a reactor monitoring this waker.
- twisted.internet.posixbase._FDWaker.i
  twisted.internet.posixbase._FDWaker.html#i
  Attribute
  Instance Variable
  PUBLIC
  The file descriptor which should be monitored in order to be awoken by this waker.
- twisted.internet.posixbase._FDWaker.disconnected
  twisted.internet.posixbase._FDWaker.html#disconnected
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet.posixbase._FDWaker.__init__
  twisted.internet.posixbase._FDWaker.html#__init__
  Function
  Method
  PUBLIC
  Initialize.
- twisted.internet.posixbase._FDWaker.reactor
  twisted.internet.posixbase._FDWaker.html#reactor
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.posixbase._FDWaker.fileno
  twisted.internet.posixbase._FDWaker.html#fileno
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.posixbase._FDWaker.doRead
  twisted.internet.posixbase._FDWaker.html#doRead
  Function
  Method
  PUBLIC
  Read some bytes from the pipe and discard them.
- twisted.internet.posixbase._FDWaker.connectionLost
  twisted.internet.posixbase._FDWaker.html#connectionLost
  Function
  Method
  PUBLIC
  Close both ends of my pipe.
- twisted.internet.posixbase._UnixWaker
  twisted.internet.posixbase._UnixWaker.html
  Class
  Class
  PRIVATE
  This class provides a simple interface to wake up the event loop.
- twisted.internet.posixbase._UnixWaker.wakeUp
  twisted.internet.posixbase._UnixWaker.html#wakeUp
  Function
  Method
  PUBLIC
  Write one byte to the pipe, and flush it.
- twisted.internet.posixbase._SIGCHLDWaker
  twisted.internet.posixbase._SIGCHLDWaker.html
  Class
  Class
  PRIVATE
  `_SIGCHLDWaker` can wake up a reactor whenever `SIGCHLD` is received.
- twisted.internet.posixbase._SIGCHLDWaker.__init__
  twisted.internet.posixbase._SIGCHLDWaker.html#__init__
  Function
  Method
  PUBLIC
  Initialize.
- twisted.internet.posixbase._SIGCHLDWaker.install
  twisted.internet.posixbase._SIGCHLDWaker.html#install
  Function
  Method
  PUBLIC
  Install the handler necessary to make this waker active.
- twisted.internet.posixbase._SIGCHLDWaker.uninstall
  twisted.internet.posixbase._SIGCHLDWaker.html#uninstall
  Function
  Method
  PUBLIC
  Remove the handler which makes this waker active.
- twisted.internet.posixbase._SIGCHLDWaker.doRead
  twisted.internet.posixbase._SIGCHLDWaker.html#doRead
  Function
  Method
  PUBLIC
  Having woken up the reactor in response to receipt of `SIGCHLD`, reap the process which exited.
- twisted.internet.posixbase._DisconnectSelectableMixin
  twisted.internet.posixbase._DisconnectSelectableMixin.html
  Class
  Class
  PRIVATE
  Mixin providing the `_disconnectSelectable` method.
- twisted.internet.posixbase._DisconnectSelectableMixin._disconnectSelectable
  twisted.internet.posixbase._DisconnectSelectableMixin.html#_disconnectSelectable
  Function
  Method
  PRIVATE
  Utility function for disconnecting a selectable.
- twisted.internet.posixbase.PosixReactorBase
  twisted.internet.posixbase.PosixReactorBase.html
  Class
  Class
  PUBLIC
  A basis for reactors that use file descriptors.
- twisted.internet.posixbase.PosixReactorBase._childWaker
  twisted.internet.posixbase.PosixReactorBase.html#_childWaker
  Attribute
  Instance Variable
  PRIVATE
  `None` or a reference to the `_SIGCHLDWaker` which is used to properly notice child process termination.
- twisted.internet.posixbase.PosixReactorBase.installWaker
  twisted.internet.posixbase.PosixReactorBase.html#installWaker
  Function
  Method
  PUBLIC
  Install a `waker' to allow threads and signals to wake up the IO thread.
- twisted.internet.posixbase.PosixReactorBase.waker
  twisted.internet.posixbase.PosixReactorBase.html#waker
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.posixbase.PosixReactorBase._handleSignals
  twisted.internet.posixbase.PosixReactorBase.html#_handleSignals
  Function
  Method
  PRIVATE
  Extend the basic signal handling logic to also support handling SIGCHLD to know when to try to reap child processes.
- twisted.internet.posixbase.PosixReactorBase._uninstallHandler
  twisted.internet.posixbase.PosixReactorBase.html#_uninstallHandler
  Function
  Method
  PRIVATE
  If a child waker was created and installed, uninstall it now.
- twisted.internet.posixbase.PosixReactorBase.spawnProcess
  twisted.internet.posixbase.PosixReactorBase.html#spawnProcess
  Function
  Method
  PUBLIC
  Spawn a process, with a process protocol.
- twisted.internet.posixbase.PosixReactorBase.listenUDP
  twisted.internet.posixbase.PosixReactorBase.html#listenUDP
  Function
  Method
  PUBLIC
  Connects a given `DatagramProtocol` to the given numeric UDP port.
- twisted.internet.posixbase.PosixReactorBase.listenMulticast
  twisted.internet.posixbase.PosixReactorBase.html#listenMulticast
  Function
  Method
  PUBLIC
  Connects a given DatagramProtocol to the given numeric UDP port.
- twisted.internet.posixbase.PosixReactorBase.connectUNIX
  twisted.internet.posixbase.PosixReactorBase.html#connectUNIX
  Function
  Method
  PUBLIC
  Connect a client protocol to a UNIX socket.
- twisted.internet.posixbase.PosixReactorBase.listenUNIX
  twisted.internet.posixbase.PosixReactorBase.html#listenUNIX
  Function
  Method
  PUBLIC
  Listen on a UNIX socket.
- twisted.internet.posixbase.PosixReactorBase.listenUNIXDatagram
  twisted.internet.posixbase.PosixReactorBase.html#listenUNIXDatagram
  Function
  Method
  PUBLIC
  Connects a given `DatagramProtocol` to the given path.
- twisted.internet.posixbase.PosixReactorBase.connectUNIXDatagram
  twisted.internet.posixbase.PosixReactorBase.html#connectUNIXDatagram
  Function
  Method
  PUBLIC
  Connects a `ConnectedDatagramProtocol` instance to a path.
- twisted.internet.posixbase.PosixReactorBase._supportedAddressFamilies
  twisted.internet.posixbase.PosixReactorBase.html#_supportedAddressFamilies
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.internet.posixbase.PosixReactorBase.adoptStreamPort
  twisted.internet.posixbase.PosixReactorBase.html#adoptStreamPort
  Function
  Method
  PUBLIC
  Create a new `IListeningPort` from an already-initialized socket.
- twisted.internet.posixbase.PosixReactorBase.adoptStreamConnection
  twisted.internet.posixbase.PosixReactorBase.html#adoptStreamConnection
  Function
  Method
  PUBLIC
  No summary
- twisted.internet.posixbase.PosixReactorBase.adoptDatagramPort
  twisted.internet.posixbase.PosixReactorBase.html#adoptDatagramPort
  Function
  Method
  PUBLIC
  Add an existing listening SOCK_DGRAM socket to the reactor to monitor for read and write readiness.
- twisted.internet.posixbase.PosixReactorBase.listenTCP
  twisted.internet.posixbase.PosixReactorBase.html#listenTCP
  Function
  Method
  PUBLIC
  Connects a given protocol factory to the given numeric TCP/IP port.
- twisted.internet.posixbase.PosixReactorBase.connectTCP
  twisted.internet.posixbase.PosixReactorBase.html#connectTCP
  Function
  Method
  PUBLIC
  Connect a TCP client.
- twisted.internet.posixbase.PosixReactorBase.connectSSL
  twisted.internet.posixbase.PosixReactorBase.html#connectSSL
  Function
  Method
  PUBLIC
  Connect a client Protocol to a remote SSL socket.
- twisted.internet.posixbase.PosixReactorBase.listenSSL
  twisted.internet.posixbase.PosixReactorBase.html#listenSSL
  Function
  Method
  PUBLIC
  Connects a given protocol factory to the given numeric TCP/IP port. The connection is a SSL one, using contexts created by the context factory.
- twisted.internet.posixbase.PosixReactorBase._removeAll
  twisted.internet.posixbase.PosixReactorBase.html#_removeAll
  Function
  Method
  PRIVATE
  Remove all readers and writers, and list of removed `IReadDescriptor`s and `IWriteDescriptor`s.
- twisted.internet.posixbase._PollLikeMixin
  twisted.internet.posixbase._PollLikeMixin.html
  Class
  Class
  PRIVATE
  Mixin for poll-like reactors.
- twisted.internet.posixbase._PollLikeMixin._doReadOrWrite
  twisted.internet.posixbase._PollLikeMixin.html#_doReadOrWrite
  Function
  Method
  PRIVATE
  fd is available for read or write, do the work and raise errors if necessary.
- twisted.internet.posixbase._ContinuousPolling
  twisted.internet.posixbase._ContinuousPolling.html
  Class
  Class
  PRIVATE
  Schedule reads and writes based on the passage of time, rather than notification.
- twisted.internet.posixbase._ContinuousPolling._reactor
  twisted.internet.posixbase._ContinuousPolling.html#_reactor
  Attribute
  Instance Variable
  PRIVATE
  The `EPollReactor` that is using this instance.
- twisted.internet.posixbase._ContinuousPolling._loop
  twisted.internet.posixbase._ContinuousPolling.html#_loop
  Attribute
  Instance Variable
  PRIVATE
  A `LoopingCall` that drives the polling, or `None`.
- twisted.internet.posixbase._ContinuousPolling._readers
  twisted.internet.posixbase._ContinuousPolling.html#_readers
  Attribute
  Instance Variable
  PRIVATE
  A `set` of `FileDescriptor` objects that should be read from.
- twisted.internet.posixbase._ContinuousPolling._writers
  twisted.internet.posixbase._ContinuousPolling.html#_writers
  Attribute
  Instance Variable
  PRIVATE
  A `set` of `FileDescriptor` objects that should be written to.
- twisted.internet.posixbase._ContinuousPolling._POLL_DISCONNECTED
  twisted.internet.posixbase._ContinuousPolling.html#_POLL_DISCONNECTED
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.internet.posixbase._ContinuousPolling._POLL_IN
  twisted.internet.posixbase._ContinuousPolling.html#_POLL_IN
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.internet.posixbase._ContinuousPolling._POLL_OUT
  twisted.internet.posixbase._ContinuousPolling.html#_POLL_OUT
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.internet.posixbase._ContinuousPolling.__init__
  twisted.internet.posixbase._ContinuousPolling.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.posixbase._ContinuousPolling._checkLoop
  twisted.internet.posixbase._ContinuousPolling.html#_checkLoop
  Function
  Method
  PRIVATE
  Start or stop a `LoopingCall` based on whether there are readers and writers.
- twisted.internet.posixbase._ContinuousPolling.iterate
  twisted.internet.posixbase._ContinuousPolling.html#iterate
  Function
  Method
  PUBLIC
  Call `doRead` and `doWrite` on all readers and writers respectively.
- twisted.internet.posixbase._ContinuousPolling.addReader
  twisted.internet.posixbase._ContinuousPolling.html#addReader
  Function
  Method
  PUBLIC
  Add a `FileDescriptor` for notification of data available to read.
- twisted.internet.posixbase._ContinuousPolling.addWriter
  twisted.internet.posixbase._ContinuousPolling.html#addWriter
  Function
  Method
  PUBLIC
  Add a `FileDescriptor` for notification of data available to write.
- twisted.internet.posixbase._ContinuousPolling.removeReader
  twisted.internet.posixbase._ContinuousPolling.html#removeReader
  Function
  Method
  PUBLIC
  Remove a `FileDescriptor` from notification of data available to read.
- twisted.internet.posixbase._ContinuousPolling.removeWriter
  twisted.internet.posixbase._ContinuousPolling.html#removeWriter
  Function
  Method
  PUBLIC
  Remove a `FileDescriptor` from notification of data available to write.
- twisted.internet.posixbase._ContinuousPolling.removeAll
  twisted.internet.posixbase._ContinuousPolling.html#removeAll
  Function
  Method
  PUBLIC
  Remove all readers and writers.
- twisted.internet.posixbase._ContinuousPolling.getReaders
  twisted.internet.posixbase._ContinuousPolling.html#getReaders
  Function
  Method
  PUBLIC
  Return a list of the readers.
- twisted.internet.posixbase._ContinuousPolling.getWriters
  twisted.internet.posixbase._ContinuousPolling.html#getWriters
  Function
  Method
  PUBLIC
  Return a list of the writers.
- twisted.internet.posixbase._ContinuousPolling.isReading
  twisted.internet.posixbase._ContinuousPolling.html#isReading
  Function
  Method
  PUBLIC
  Checks if the file descriptor is currently being observed for read readiness.
- twisted.internet.posixbase._ContinuousPolling.isWriting
  twisted.internet.posixbase._ContinuousPolling.html#isWriting
  Function
  Method
  PUBLIC
  Checks if the file descriptor is currently being observed for write readiness.
- twisted.internet.selectreactor.win32select
  twisted.internet.selectreactor.html#win32select
  Function
  Function
  PUBLIC
  Win32 select wrapper.
- twisted.internet.win32eventreactor.Win32Reactor
  twisted.internet.win32eventreactor.Win32Reactor.html
  Class
  Class
  PUBLIC
  Reactor that uses Win32 event APIs.
- twisted.internet.win32eventreactor.Win32Reactor._reads
  twisted.internet.win32eventreactor.Win32Reactor.html#_reads
  Attribute
  Instance Variable
  PRIVATE
  A dictionary mapping `FileDescriptor` instances to a win32 event object used to check for read events for that descriptor.
- twisted.internet.win32eventreactor.Win32Reactor._writes
  twisted.internet.win32eventreactor.Win32Reactor.html#_writes
  Attribute
  Instance Variable
  PRIVATE
  A dictionary mapping `FileDescriptor` instances to a arbitrary value. Keys in this dictionary will be given a chance to write out their data.
- twisted.internet.win32eventreactor.Win32Reactor._events
  twisted.internet.win32eventreactor.Win32Reactor.html#_events
  Attribute
  Instance Variable
  PRIVATE
  A dictionary mapping win32 event object to tuples of `FileDescriptor` instances and event masks.
- twisted.internet.win32eventreactor.Win32Reactor._closedAndReading
  twisted.internet.win32eventreactor.Win32Reactor.html#_closedAndReading
  Attribute
  Instance Variable
  PRIVATE
  Along with `_closedAndNotReading`, keeps track of descriptors which have had close notification delivered from the OS but which we have not finished reading data from. MsgWaitForMultipleObjects will only deliver close notification to us once, so we remember it in these two dictionaries until we're ready to act on it...
- twisted.internet.win32eventreactor.Win32Reactor._closedAndNotReading
  twisted.internet.win32eventreactor.Win32Reactor.html#_closedAndNotReading
  Attribute
  Instance Variable
  PRIVATE
  These descriptors have had close notification delivered from the OS, but are not marked as allowed to handle read events in the reactor. They are saved here to record their closed state, but not processed at all...
- twisted.internet.win32eventreactor.Win32Reactor.dummyEvent
  twisted.internet.win32eventreactor.Win32Reactor.html#dummyEvent
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet.win32eventreactor.Win32Reactor.__init__
  twisted.internet.win32eventreactor.Win32Reactor.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.win32eventreactor.Win32Reactor._makeSocketEvent
  twisted.internet.win32eventreactor.Win32Reactor.html#_makeSocketEvent
  Function
  Method
  PRIVATE
  Make a win32 event object for a socket.
- twisted.internet.win32eventreactor.Win32Reactor.addEvent
  twisted.internet.win32eventreactor.Win32Reactor.html#addEvent
  Function
  Method
  PUBLIC
  Add a new win32 event to the event loop.
- twisted.internet.win32eventreactor.Win32Reactor.removeEvent
  twisted.internet.win32eventreactor.Win32Reactor.html#removeEvent
  Function
  Method
  PUBLIC
  Remove an event.
- twisted.internet.win32eventreactor.Win32Reactor.addReader
  twisted.internet.win32eventreactor.Win32Reactor.html#addReader
  Function
  Method
  PUBLIC
  Add a socket FileDescriptor for notification of data available to read.
- twisted.internet.win32eventreactor.Win32Reactor.addWriter
  twisted.internet.win32eventreactor.Win32Reactor.html#addWriter
  Function
  Method
  PUBLIC
  Add a socket FileDescriptor for notification of data available to write.
- twisted.internet.win32eventreactor.Win32Reactor.removeReader
  twisted.internet.win32eventreactor.Win32Reactor.html#removeReader
  Function
  Method
  PUBLIC
  Remove a Selectable for notification of data available to read.
- twisted.internet.win32eventreactor.Win32Reactor.removeWriter
  twisted.internet.win32eventreactor.Win32Reactor.html#removeWriter
  Function
  Method
  PUBLIC
  Remove a Selectable for notification of data available to write.
- twisted.internet.win32eventreactor.Win32Reactor.removeAll
  twisted.internet.win32eventreactor.Win32Reactor.html#removeAll
  Function
  Method
  PUBLIC
  Remove all selectables, and return a list of them.
- twisted.internet.win32eventreactor.Win32Reactor.getReaders
  twisted.internet.win32eventreactor.Win32Reactor.html#getReaders
  Function
  Method
  PUBLIC
  Return the list of file descriptors currently monitored for input events by the reactor.
- twisted.internet.win32eventreactor.Win32Reactor.getWriters
  twisted.internet.win32eventreactor.Win32Reactor.html#getWriters
  Function
  Method
  PUBLIC
  Return the list file descriptors currently monitored for output events by the reactor.
- twisted.internet.win32eventreactor.Win32Reactor.doWaitForMultipleEvents
  twisted.internet.win32eventreactor.Win32Reactor.html#doWaitForMultipleEvents
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.win32eventreactor.Win32Reactor._runWrite
  twisted.internet.win32eventreactor.Win32Reactor.html#_runWrite
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet.win32eventreactor.Win32Reactor._runAction
  twisted.internet.win32eventreactor.Win32Reactor.html#_runAction
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet.win32eventreactor._ThreadFDWrapper
  twisted.internet.win32eventreactor._ThreadFDWrapper.html
  Class
  Class
  PRIVATE
  This wraps an event handler and translates notification in the helper `Win32Reactor` thread into a notification in the primary reactor thread.
- twisted.internet.win32eventreactor._ThreadFDWrapper._reactor
  twisted.internet.win32eventreactor._ThreadFDWrapper.html#_reactor
  Attribute
  Instance Variable
  PRIVATE
  The primary reactor, the one to which event notification will be sent.
- twisted.internet.win32eventreactor._ThreadFDWrapper._fd
  twisted.internet.win32eventreactor._ThreadFDWrapper.html#_fd
  Attribute
  Instance Variable
  PRIVATE
  The `FileDescriptor` to which the event will be dispatched.
- twisted.internet.win32eventreactor._ThreadFDWrapper._action
  twisted.internet.win32eventreactor._ThreadFDWrapper.html#_action
  Attribute
  Instance Variable
  PRIVATE
  A `str` giving the method of `_fd` which handles the event.
- twisted.internet.win32eventreactor._ThreadFDWrapper._logPrefix
  twisted.internet.win32eventreactor._ThreadFDWrapper.html#_logPrefix
  Attribute
  Instance Variable
  PRIVATE
  The pre-fetched log prefix string for `_fd`, so that `_fd.logPrefix` does not need to be called in a non-main thread.
- twisted.internet.win32eventreactor._ThreadFDWrapper.__init__
  twisted.internet.win32eventreactor._ThreadFDWrapper.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.win32eventreactor._ThreadFDWrapper.logPrefix
  twisted.internet.win32eventreactor._ThreadFDWrapper.html#logPrefix
  Function
  Method
  PUBLIC
  Return the original handler's log prefix, as it was given to `__init__`.
- twisted.internet.win32eventreactor._ThreadFDWrapper._execute
  twisted.internet.win32eventreactor._ThreadFDWrapper.html#_execute
  Function
  Method
  PRIVATE
  Callback fired when the associated event is set. Run the `action` callback on the wrapped descriptor in the main reactor thread and raise or return whatever it raises or returns to cause this event handler to be removed from ...
- twisted.internet.win32eventreactor._ThreadFDWrapper.connectionLost
  twisted.internet.win32eventreactor._ThreadFDWrapper.html#connectionLost
  Function
  Method
  PUBLIC
  Pass through to the wrapped descriptor, but in the main reactor thread instead of the helper `Win32Reactor` thread.
- twisted.internet.win32eventreactor._ThreadedWin32EventsMixin
  twisted.internet.win32eventreactor._ThreadedWin32EventsMixin.html
  Class
  Class
  PRIVATE
  This mixin implements `IReactorWin32Events` for another reactor by running a `Win32Reactor` in a separate thread and dispatching work to it.
- twisted.internet.win32eventreactor._ThreadedWin32EventsMixin._reactor
  twisted.internet.win32eventreactor._ThreadedWin32EventsMixin.html#_reactor
  Attribute
  Instance Variable
  PRIVATE
  The `Win32Reactor` running in the other thread. This is `None` until it is actually needed.
- twisted.internet.win32eventreactor._ThreadedWin32EventsMixin._reactorThread
  twisted.internet.win32eventreactor._ThreadedWin32EventsMixin.html#_reactorThread
  Attribute
  Instance Variable
  PRIVATE
  The `threading.Thread` which is running the `Win32Reactor`. This is `None` until it is actually needed.
- twisted.internet.win32eventreactor._ThreadedWin32EventsMixin._unmakeHelperReactor
  twisted.internet.win32eventreactor._ThreadedWin32EventsMixin.html#_unmakeHelperReactor
  Function
  Method
  PRIVATE
  Stop and discard the reactor started by `_makeHelperReactor`.
- twisted.internet.win32eventreactor._ThreadedWin32EventsMixin._makeHelperReactor
  twisted.internet.win32eventreactor._ThreadedWin32EventsMixin.html#_makeHelperReactor
  Function
  Method
  PRIVATE
  Create and (in a new thread) start a `Win32Reactor` instance to use for the implementation of `IReactorWin32Events`.
- twisted.internet.win32eventreactor._ThreadedWin32EventsMixin.addEvent
  twisted.internet.win32eventreactor._ThreadedWin32EventsMixin.html#addEvent
  Function
  Method
  PUBLIC
  No summary
- twisted.internet.win32eventreactor._ThreadedWin32EventsMixin.removeEvent
  twisted.internet.win32eventreactor._ThreadedWin32EventsMixin.html#removeEvent
  Function
  Method
  PUBLIC
  No summary
- twisted.internet.win32eventreactor.install
  twisted.internet.win32eventreactor.html#install
  Function
  Function
  PUBLIC
  Undocumented
- twisted.internet.selectreactor.SelectReactor
  twisted.internet.selectreactor.SelectReactor.html
  Class
  Class
  PUBLIC
  A select() based reactor - runs on all POSIX platforms and on Win32.
- twisted.internet.selectreactor.SelectReactor._reads
  twisted.internet.selectreactor.SelectReactor.html#_reads
  Attribute
  Instance Variable
  PRIVATE
  A set containing `FileDescriptor` instances which will be checked for read events.
- twisted.internet.selectreactor.SelectReactor._writes
  twisted.internet.selectreactor.SelectReactor.html#_writes
  Attribute
  Instance Variable
  PRIVATE
  A set containing `FileDescriptor` instances which will be checked for writability.
- twisted.internet.selectreactor.SelectReactor.__init__
  twisted.internet.selectreactor.SelectReactor.html#__init__
  Function
  Method
  PUBLIC
  Initialize file descriptor tracking dictionaries and the base class.
- twisted.internet.selectreactor.SelectReactor._preenDescriptors
  twisted.internet.selectreactor.SelectReactor.html#_preenDescriptors
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet.selectreactor.SelectReactor.doSelect
  twisted.internet.selectreactor.SelectReactor.html#doSelect
  Function
  Method
  PUBLIC
  Run one iteration of the I/O monitor loop.
- twisted.internet.selectreactor.SelectReactor._doReadOrWrite
  twisted.internet.selectreactor.SelectReactor.html#_doReadOrWrite
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet.selectreactor.SelectReactor.addReader
  twisted.internet.selectreactor.SelectReactor.html#addReader
  Function
  Method
  PUBLIC
  Add a FileDescriptor for notification of data available to read.
- twisted.internet.selectreactor.SelectReactor.addWriter
  twisted.internet.selectreactor.SelectReactor.html#addWriter
  Function
  Method
  PUBLIC
  Add a FileDescriptor for notification of data available to write.
- twisted.internet.selectreactor.SelectReactor.removeReader
  twisted.internet.selectreactor.SelectReactor.html#removeReader
  Function
  Method
  PUBLIC
  Remove a Selectable for notification of data available to read.
- twisted.internet.selectreactor.SelectReactor.removeWriter
  twisted.internet.selectreactor.SelectReactor.html#removeWriter
  Function
  Method
  PUBLIC
  Remove a Selectable for notification of data available to write.
- twisted.internet.selectreactor.SelectReactor.removeAll
  twisted.internet.selectreactor.SelectReactor.html#removeAll
  Function
  Method
  PUBLIC
  Remove all readers and writers.
- twisted.internet.selectreactor.SelectReactor.getReaders
  twisted.internet.selectreactor.SelectReactor.html#getReaders
  Function
  Method
  PUBLIC
  Return the list of file descriptors currently monitored for input events by the reactor.
- twisted.internet.selectreactor.SelectReactor.getWriters
  twisted.internet.selectreactor.SelectReactor.html#getWriters
  Function
  Method
  PUBLIC
  Return the list file descriptors currently monitored for output events by the reactor.
- twisted.internet.selectreactor.install
  twisted.internet.selectreactor.html#install
  Function
  Function
  PUBLIC
  Configure the twisted mainloop to be run using the select() reactor.
- twisted.internet._glibbase.ensureNotImported
  twisted.internet._glibbase.html#ensureNotImported
  Function
  Function
  PUBLIC
  Check whether the given modules were imported, and if requested, ensure they will not be importable in the future.
- twisted.internet._glibbase.GlibWaker
  twisted.internet._glibbase.GlibWaker.html
  Class
  Class
  PUBLIC
  Run scheduled events after waking up.
- twisted.internet._glibbase.GlibWaker.doRead
  twisted.internet._glibbase.GlibWaker.html#doRead
  Function
  Method
  PUBLIC
  Read some bytes from the pipe and discard them.
- twisted.internet._glibbase.GlibReactorBase
  twisted.internet._glibbase.GlibReactorBase.html
  Class
  Class
  PUBLIC
  Base class for GObject event loop reactors.
- twisted.internet._glibbase.GlibReactorBase._sources
  twisted.internet._glibbase.GlibReactorBase.html#_sources
  Attribute
  Instance Variable
  PRIVATE
  A dictionary mapping `FileDescriptor` instances to GSource handles.
- twisted.internet._glibbase.GlibReactorBase._reads
  twisted.internet._glibbase.GlibReactorBase.html#_reads
  Attribute
  Instance Variable
  PRIVATE
  A set of `FileDescriptor` instances currently monitored for reading.
- twisted.internet._glibbase.GlibReactorBase._writes
  twisted.internet._glibbase.GlibReactorBase.html#_writes
  Attribute
  Instance Variable
  PRIVATE
  A set of `FileDescriptor` instances currently monitored for writing.
- twisted.internet._glibbase.GlibReactorBase._simtag
  twisted.internet._glibbase.GlibReactorBase.html#_simtag
  Attribute
  Instance Variable
  PRIVATE
  A GSource handle for the next `simulate` call.
- twisted.internet._glibbase.GlibReactorBase.__init__
  twisted.internet._glibbase.GlibReactorBase.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet._glibbase.GlibReactorBase._glib
  twisted.internet._glibbase.GlibReactorBase.html#_glib
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet._glibbase.GlibReactorBase._gtk
  twisted.internet._glibbase.GlibReactorBase.html#_gtk
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet._glibbase.GlibReactorBase._source_remove
  twisted.internet._glibbase.GlibReactorBase.html#_source_remove
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet._glibbase.GlibReactorBase._timeout_add
  twisted.internet._glibbase.GlibReactorBase.html#_timeout_add
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet._glibbase.GlibReactorBase._pending
  twisted.internet._glibbase.GlibReactorBase.html#_pending
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet._glibbase.GlibReactorBase._iteration
  twisted.internet._glibbase.GlibReactorBase.html#_iteration
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet._glibbase.GlibReactorBase._crash
  twisted.internet._glibbase.GlibReactorBase.html#_crash
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet._glibbase.GlibReactorBase._run
  twisted.internet._glibbase.GlibReactorBase.html#_run
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet._glibbase.GlibReactorBase._handleSignals
  twisted.internet._glibbase.GlibReactorBase.html#_handleSignals
  Function
  Method
  PRIVATE
  Extend the basic signal handling logic to also support handling SIGCHLD to know when to try to reap child processes.
- twisted.internet._glibbase.GlibReactorBase.input_add
  twisted.internet._glibbase.GlibReactorBase.html#input_add
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet._glibbase.GlibReactorBase._ioEventCallback
  twisted.internet._glibbase.GlibReactorBase.html#_ioEventCallback
  Function
  Method
  PRIVATE
  Called by event loop when an I/O event occurs.
- twisted.internet._glibbase.GlibReactorBase._add
  twisted.internet._glibbase.GlibReactorBase.html#_add
  Function
  Method
  PRIVATE
  Add the given `FileDescriptor` for monitoring either for reading or writing. If the file is already monitored for the other operation, we delete the previous registration and re-register it for both reading and writing.
- twisted.internet._glibbase.GlibReactorBase.addReader
  twisted.internet._glibbase.GlibReactorBase.html#addReader
  Function
  Method
  PUBLIC
  Add a `FileDescriptor` for monitoring of data available to read.
- twisted.internet._glibbase.GlibReactorBase.addWriter
  twisted.internet._glibbase.GlibReactorBase.html#addWriter
  Function
  Method
  PUBLIC
  Add a `FileDescriptor` for monitoring ability to write data.
- twisted.internet._glibbase.GlibReactorBase.getReaders
  twisted.internet._glibbase.GlibReactorBase.html#getReaders
  Function
  Method
  PUBLIC
  Retrieve the list of current `FileDescriptor` monitored for reading.
- twisted.internet._glibbase.GlibReactorBase.getWriters
  twisted.internet._glibbase.GlibReactorBase.html#getWriters
  Function
  Method
  PUBLIC
  Retrieve the list of current `FileDescriptor` monitored for writing.
- twisted.internet._glibbase.GlibReactorBase.removeAll
  twisted.internet._glibbase.GlibReactorBase.html#removeAll
  Function
  Method
  PUBLIC
  Remove monitoring for all registered `FileDescriptor`s.
- twisted.internet._glibbase.GlibReactorBase._remove
  twisted.internet._glibbase.GlibReactorBase.html#_remove
  Function
  Method
  PRIVATE
  Remove monitoring the given `FileDescriptor` for either reading or writing. If it's still monitored for the other operation, we re-register the `FileDescriptor` for only that operation.
- twisted.internet._glibbase.GlibReactorBase.removeReader
  twisted.internet._glibbase.GlibReactorBase.html#removeReader
  Function
  Method
  PUBLIC
  Stop monitoring the given `FileDescriptor` for reading.
- twisted.internet._glibbase.GlibReactorBase.removeWriter
  twisted.internet._glibbase.GlibReactorBase.html#removeWriter
  Function
  Method
  PUBLIC
  Stop monitoring the given `FileDescriptor` for writing.
- twisted.internet._glibbase.GlibReactorBase.iterate
  twisted.internet._glibbase.GlibReactorBase.html#iterate
  Function
  Method
  PUBLIC
  One iteration of the event loop, for trial's use.
- twisted.internet._glibbase.GlibReactorBase.crash
  twisted.internet._glibbase.GlibReactorBase.html#crash
  Function
  Method
  PUBLIC
  Crash the reactor.
- twisted.internet._glibbase.GlibReactorBase.stop
  twisted.internet._glibbase.GlibReactorBase.html#stop
  Function
  Method
  PUBLIC
  Stop the reactor.
- twisted.internet._glibbase.GlibReactorBase.run
  twisted.internet._glibbase.GlibReactorBase.html#run
  Function
  Method
  PUBLIC
  Run the reactor.
- twisted.internet._glibbase.GlibReactorBase.callLater
  twisted.internet._glibbase.GlibReactorBase.html#callLater
  Function
  Method
  PUBLIC
  Schedule a `DelayedCall`.
- twisted.internet._glibbase.GlibReactorBase._reschedule
  twisted.internet._glibbase.GlibReactorBase.html#_reschedule
  Function
  Method
  PRIVATE
  Schedule a glib timeout for `_simulate`.
- twisted.internet._glibbase.GlibReactorBase._simulate
  twisted.internet._glibbase.GlibReactorBase.html#_simulate
  Function
  Method
  PRIVATE
  Run timers, and then reschedule glib timeout for next scheduled event.
- twisted.internet._glibbase.PortableGlibReactorBase
  twisted.internet._glibbase.PortableGlibReactorBase.html
  Class
  Class
  PUBLIC
  Base class for GObject event loop reactors that works on Windows.
- twisted.internet._glibbase.PortableGlibReactorBase.__init__
  twisted.internet._glibbase.PortableGlibReactorBase.html#__init__
  Function
  Method
  PUBLIC
  Initialize file descriptor tracking dictionaries and the base class.
- twisted.internet._glibbase.PortableGlibReactorBase._simtag
  twisted.internet._glibbase.PortableGlibReactorBase.html#_simtag
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet._glibbase.PortableGlibReactorBase._glib
  twisted.internet._glibbase.PortableGlibReactorBase.html#_glib
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet._glibbase.PortableGlibReactorBase._gtk
  twisted.internet._glibbase.PortableGlibReactorBase.html#_gtk
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet._glibbase.PortableGlibReactorBase._source_remove
  twisted.internet._glibbase.PortableGlibReactorBase.html#_source_remove
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet._glibbase.PortableGlibReactorBase._timeout_add
  twisted.internet._glibbase.PortableGlibReactorBase.html#_timeout_add
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet._glibbase.PortableGlibReactorBase._crash
  twisted.internet._glibbase.PortableGlibReactorBase.html#_crash
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet._glibbase.PortableGlibReactorBase._run
  twisted.internet._glibbase.PortableGlibReactorBase.html#_run
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet._glibbase.PortableGlibReactorBase.crash
  twisted.internet._glibbase.PortableGlibReactorBase.html#crash
  Function
  Method
  PUBLIC
  See twisted.internet.interfaces.IReactorCore.crash.
- twisted.internet._glibbase.PortableGlibReactorBase.run
  twisted.internet._glibbase.PortableGlibReactorBase.html#run
  Function
  Method
  PUBLIC
  Fire 'startup' System Events, move the reactor to the 'running' state, then run the main loop until it is stopped with `stop()` or `crash()`.
- twisted.internet._glibbase.PortableGlibReactorBase.simulate
  twisted.internet._glibbase.PortableGlibReactorBase.html#simulate
  Function
  Method
  PUBLIC
  Run simulation loops and reschedule callbacks.
- twisted.internet.serialport.BaseSerialPort
  twisted.internet.serialport.BaseSerialPort.html
  Class
  Class
  PUBLIC
  Base class for Windows and POSIX serial ports.
- twisted.internet.serialport.BaseSerialPort._serialFactory
  twisted.internet.serialport.BaseSerialPort.html#_serialFactory
  Attribute
  Instance Variable
  PRIVATE
  a pyserial `serial.Serial` factory, used to create the instance stored in `self._serial`. Overrideable to enable easier testing.
- twisted.internet.serialport.BaseSerialPort._serial
  twisted.internet.serialport.BaseSerialPort.html#_serial
  Attribute
  Instance Variable
  PRIVATE
  a pyserial `serial.Serial` instance used to manage the options on the serial port.
- twisted.internet.serialport.BaseSerialPort.setBaudRate
  twisted.internet.serialport.BaseSerialPort.html#setBaudRate
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.serialport.BaseSerialPort.inWaiting
  twisted.internet.serialport.BaseSerialPort.html#inWaiting
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.serialport.BaseSerialPort.flushInput
  twisted.internet.serialport.BaseSerialPort.html#flushInput
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.serialport.BaseSerialPort.flushOutput
  twisted.internet.serialport.BaseSerialPort.html#flushOutput
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.serialport.BaseSerialPort.sendBreak
  twisted.internet.serialport.BaseSerialPort.html#sendBreak
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.serialport.BaseSerialPort.getDSR
  twisted.internet.serialport.BaseSerialPort.html#getDSR
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.serialport.BaseSerialPort.getCD
  twisted.internet.serialport.BaseSerialPort.html#getCD
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.serialport.BaseSerialPort.getRI
  twisted.internet.serialport.BaseSerialPort.html#getRI
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.serialport.BaseSerialPort.getCTS
  twisted.internet.serialport.BaseSerialPort.html#getCTS
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.serialport.BaseSerialPort.setDTR
  twisted.internet.serialport.BaseSerialPort.html#setDTR
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.serialport.BaseSerialPort.setRTS
  twisted.internet.serialport.BaseSerialPort.html#setRTS
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.serialport.SerialPort
  twisted.internet.serialport.SerialPort.html
  Class
  Class
  PUBLIC
  A serial device, acting as a transport, that uses a win32 event.
- twisted.internet.serialport.SerialPort.connected
  twisted.internet.serialport.SerialPort.html#connected
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet.serialport.SerialPort.__init__
  twisted.internet.serialport.SerialPort.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.internet.serialport.SerialPort._serial
  twisted.internet.serialport.SerialPort.html#_serial
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.serialport.SerialPort.reactor
  twisted.internet.serialport.SerialPort.html#reactor
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.serialport.SerialPort.protocol
  twisted.internet.serialport.SerialPort.html#protocol
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.serialport.SerialPort.outQueue
  twisted.internet.serialport.SerialPort.html#outQueue
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.serialport.SerialPort.closed
  twisted.internet.serialport.SerialPort.html#closed
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.serialport.SerialPort.closedNotifies
  twisted.internet.serialport.SerialPort.html#closedNotifies
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.serialport.SerialPort.writeInProgress
  twisted.internet.serialport.SerialPort.html#writeInProgress
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.serialport.SerialPort._overlappedRead
  twisted.internet.serialport.SerialPort.html#_overlappedRead
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.serialport.SerialPort._overlappedWrite
  twisted.internet.serialport.SerialPort.html#_overlappedWrite
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.serialport.SerialPort._finishPortSetup
  twisted.internet.serialport.SerialPort.html#_finishPortSetup
  Function
  Method
  PRIVATE
  Finish setting up the serial port.
- twisted.internet.serialport.SerialPort.read_buf
  twisted.internet.serialport.SerialPort.html#read_buf
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.serialport.SerialPort._clearCommError
  twisted.internet.serialport.SerialPort.html#_clearCommError
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet.serialport.SerialPort.serialReadEvent
  twisted.internet.serialport.SerialPort.html#serialReadEvent
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.serialport.SerialPort.write
  twisted.internet.serialport.SerialPort.html#write
  Function
  Method
  PUBLIC
  Reliably write some data.
- twisted.internet.serialport.SerialPort.serialWriteEvent
  twisted.internet.serialport.SerialPort.html#serialWriteEvent
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.serialport.SerialPort.connectionLost
  twisted.internet.serialport.SerialPort.html#connectionLost
  Function
  Method
  PUBLIC
  Called when the serial port disconnects.
- twisted.internet._posixserialport.SerialPort
  twisted.internet._posixserialport.SerialPort.html
  Class
  Class
  PUBLIC
  A select()able serial device, acting as a transport.
- twisted.internet._posixserialport.SerialPort.connected
  twisted.internet._posixserialport.SerialPort.html#connected
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet._posixserialport.SerialPort.__init__
  twisted.internet._posixserialport.SerialPort.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.internet._posixserialport.SerialPort._serial
  twisted.internet._posixserialport.SerialPort.html#_serial
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet._posixserialport.SerialPort.reactor
  twisted.internet._posixserialport.SerialPort.html#reactor
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet._posixserialport.SerialPort.protocol
  twisted.internet._posixserialport.SerialPort.html#protocol
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet._posixserialport.SerialPort.fileno
  twisted.internet._posixserialport.SerialPort.html#fileno
  Function
  Method
  PUBLIC
  File Descriptor number for select().
- twisted.internet._posixserialport.SerialPort.writeSomeData
  twisted.internet._posixserialport.SerialPort.html#writeSomeData
  Function
  Method
  PUBLIC
  Write some data to the serial device.
- twisted.internet._posixserialport.SerialPort.doRead
  twisted.internet._posixserialport.SerialPort.html#doRead
  Function
  Method
  PUBLIC
  Some data's readable from serial device.
- twisted.internet._posixserialport.SerialPort.connectionLost
  twisted.internet._posixserialport.SerialPort.html#connectionLost
  Function
  Method
  PUBLIC
  Called when the serial port disconnects.
- twisted.internet._posixstdio.PipeAddress
  twisted.internet._posixstdio.PipeAddress.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.internet._posixstdio.StandardIO
  twisted.internet._posixstdio.StandardIO.html
  Class
  Class
  PUBLIC
  No class docstring; 0/5 instance variable, 2/21 methods documented
- twisted.internet._posixstdio.StandardIO._reader
  twisted.internet._posixstdio.StandardIO.html#_reader
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet._posixstdio.StandardIO._writer
  twisted.internet._posixstdio.StandardIO.html#_writer
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet._posixstdio.StandardIO.disconnected
  twisted.internet._posixstdio.StandardIO.html#disconnected
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet._posixstdio.StandardIO.disconnecting
  twisted.internet._posixstdio.StandardIO.html#disconnecting
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet._posixstdio.StandardIO.__init__
  twisted.internet._posixstdio.StandardIO.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet._posixstdio.StandardIO.protocol
  twisted.internet._posixstdio.StandardIO.html#protocol
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet._posixstdio.StandardIO.loseWriteConnection
  twisted.internet._posixstdio.StandardIO.html#loseWriteConnection
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet._posixstdio.StandardIO.write
  twisted.internet._posixstdio.StandardIO.html#write
  Function
  Method
  PUBLIC
  Write some data to the physical connection, in sequence, in a non-blocking fashion.
- twisted.internet._posixstdio.StandardIO.writeSequence
  twisted.internet._posixstdio.StandardIO.html#writeSequence
  Function
  Method
  PUBLIC
  Write an iterable of byte strings to the physical connection.
- twisted.internet._posixstdio.StandardIO.loseConnection
  twisted.internet._posixstdio.StandardIO.html#loseConnection
  Function
  Method
  PUBLIC
  Close my connection, after writing all pending data.
- twisted.internet._posixstdio.StandardIO.getPeer
  twisted.internet._posixstdio.StandardIO.html#getPeer
  Function
  Method
  PUBLIC
  Get the remote address of this connection.
- twisted.internet._posixstdio.StandardIO.getHost
  twisted.internet._posixstdio.StandardIO.html#getHost
  Function
  Method
  PUBLIC
  Similar to getPeer, but returns an address describing this side of the connection.
- twisted.internet._posixstdio.StandardIO.childDataReceived
  twisted.internet._posixstdio.StandardIO.html#childDataReceived
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet._posixstdio.StandardIO.childConnectionLost
  twisted.internet._posixstdio.StandardIO.html#childConnectionLost
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet._posixstdio.StandardIO.connectionLost
  twisted.internet._posixstdio.StandardIO.html#connectionLost
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet._posixstdio.StandardIO._writeConnectionLost
  twisted.internet._posixstdio.StandardIO.html#_writeConnectionLost
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet._posixstdio.StandardIO._readConnectionLost
  twisted.internet._posixstdio.StandardIO.html#_readConnectionLost
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet._posixstdio.StandardIO.registerProducer
  twisted.internet._posixstdio.StandardIO.html#registerProducer
  Function
  Method
  PUBLIC
  Register to receive data from a producer.
- twisted.internet._posixstdio.StandardIO.unregisterProducer
  twisted.internet._posixstdio.StandardIO.html#unregisterProducer
  Function
  Method
  PUBLIC
  Stop consuming data from a producer, without disconnecting.
- twisted.internet._posixstdio.StandardIO.stopProducing
  twisted.internet._posixstdio.StandardIO.html#stopProducing
  Function
  Method
  PUBLIC
  Stop producing data.
- twisted.internet._posixstdio.StandardIO.pauseProducing
  twisted.internet._posixstdio.StandardIO.html#pauseProducing
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet._posixstdio.StandardIO.resumeProducing
  twisted.internet._posixstdio.StandardIO.html#resumeProducing
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet._posixstdio.StandardIO.stopReading
  twisted.internet._posixstdio.StandardIO.html#stopReading
  Function
  Method
  PUBLIC
  Compatibility only, don't use. Call pauseProducing.
- twisted.internet._posixstdio.StandardIO.startReading
  twisted.internet._posixstdio.StandardIO.html#startReading
  Function
  Method
  PUBLIC
  Compatibility only, don't use. Call resumeProducing.
- twisted.internet._posixstdio.StandardIO.readConnectionLost
  twisted.internet._posixstdio.StandardIO.html#readConnectionLost
  Function
  Method
  PUBLIC
  Indicates read connection was lost.
- twisted.internet._posixstdio.StandardIO.writeConnectionLost
  twisted.internet._posixstdio.StandardIO.html#writeConnectionLost
  Function
  Method
  PUBLIC
  Indicates write connection was lost.
- twisted.internet._threadedselect.dictRemove
  twisted.internet._threadedselect.html#dictRemove
  Function
  Function
  PUBLIC
  Undocumented
- twisted.internet._threadedselect.raiseException
  twisted.internet._threadedselect.html#raiseException
  Function
  Function
  PUBLIC
  Undocumented
- twisted.internet._threadedselect.ThreadedSelectReactor
  twisted.internet._threadedselect.ThreadedSelectReactor.html
  Class
  Class
  PUBLIC
  A threaded select() based reactor - runs on all POSIX platforms and on Win32.
- twisted.internet._threadedselect.ThreadedSelectReactor.__init__
  twisted.internet._threadedselect.ThreadedSelectReactor.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet._threadedselect.ThreadedSelectReactor.reads
  twisted.internet._threadedselect.ThreadedSelectReactor.html#reads
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet._threadedselect.ThreadedSelectReactor.writes
  twisted.internet._threadedselect.ThreadedSelectReactor.html#writes
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet._threadedselect.ThreadedSelectReactor.toThreadQueue
  twisted.internet._threadedselect.ThreadedSelectReactor.html#toThreadQueue
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet._threadedselect.ThreadedSelectReactor.toMainThread
  twisted.internet._threadedselect.ThreadedSelectReactor.html#toMainThread
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet._threadedselect.ThreadedSelectReactor.workerThread
  twisted.internet._threadedselect.ThreadedSelectReactor.html#workerThread
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet._threadedselect.ThreadedSelectReactor.mainWaker
  twisted.internet._threadedselect.ThreadedSelectReactor.html#mainWaker
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet._threadedselect.ThreadedSelectReactor.wakeUp
  twisted.internet._threadedselect.ThreadedSelectReactor.html#wakeUp
  Function
  Method
  PUBLIC
  Wake up the event loop.
- twisted.internet._threadedselect.ThreadedSelectReactor.callLater
  twisted.internet._threadedselect.ThreadedSelectReactor.html#callLater
  Function
  Method
  PUBLIC
  See twisted.internet.interfaces.IReactorTime.callLater.
- twisted.internet._threadedselect.ThreadedSelectReactor._sendToMain
  twisted.internet._threadedselect.ThreadedSelectReactor.html#_sendToMain
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet._threadedselect.ThreadedSelectReactor._sendToThread
  twisted.internet._threadedselect.ThreadedSelectReactor.html#_sendToThread
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet._threadedselect.ThreadedSelectReactor._preenDescriptorsInThread
  twisted.internet._threadedselect.ThreadedSelectReactor.html#_preenDescriptorsInThread
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet._threadedselect.ThreadedSelectReactor._workerInThread
  twisted.internet._threadedselect.ThreadedSelectReactor.html#_workerInThread
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet._threadedselect.ThreadedSelectReactor._doSelectInThread
  twisted.internet._threadedselect.ThreadedSelectReactor.html#_doSelectInThread
  Function
  Method
  PRIVATE
  Run one iteration of the I/O monitor loop.
- twisted.internet._threadedselect.ThreadedSelectReactor._process_Notify
  twisted.internet._threadedselect.ThreadedSelectReactor.html#_process_Notify
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet._threadedselect.ThreadedSelectReactor._process_Failure
  twisted.internet._threadedselect.ThreadedSelectReactor.html#_process_Failure
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet._threadedselect.ThreadedSelectReactor.ensureWorkerThread
  twisted.internet._threadedselect.ThreadedSelectReactor.html#ensureWorkerThread
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet._threadedselect.ThreadedSelectReactor.doThreadIteration
  twisted.internet._threadedselect.ThreadedSelectReactor.html#doThreadIteration
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet._threadedselect.ThreadedSelectReactor._interleave
  twisted.internet._threadedselect.ThreadedSelectReactor.html#_interleave
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet._threadedselect.ThreadedSelectReactor.interleave
  twisted.internet._threadedselect.ThreadedSelectReactor.html#interleave
  Function
  Method
  PUBLIC
  interleave(waker) interleaves this reactor with the current application by moving the blocking parts of the reactor (select() in this case) to a separate thread. This is typically useful for integration with GUI applications which have their own event loop already running.
- twisted.internet._threadedselect.ThreadedSelectReactor._mainLoopShutdown
  twisted.internet._threadedselect.ThreadedSelectReactor.html#_mainLoopShutdown
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet._threadedselect.ThreadedSelectReactor._doReadOrWrite
  twisted.internet._threadedselect.ThreadedSelectReactor.html#_doReadOrWrite
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet._threadedselect.ThreadedSelectReactor.addReader
  twisted.internet._threadedselect.ThreadedSelectReactor.html#addReader
  Function
  Method
  PUBLIC
  Add a FileDescriptor for notification of data available to read.
- twisted.internet._threadedselect.ThreadedSelectReactor.addWriter
  twisted.internet._threadedselect.ThreadedSelectReactor.html#addWriter
  Function
  Method
  PUBLIC
  Add a FileDescriptor for notification of data available to write.
- twisted.internet._threadedselect.ThreadedSelectReactor.removeReader
  twisted.internet._threadedselect.ThreadedSelectReactor.html#removeReader
  Function
  Method
  PUBLIC
  Remove a Selectable for notification of data available to read.
- twisted.internet._threadedselect.ThreadedSelectReactor.removeWriter
  twisted.internet._threadedselect.ThreadedSelectReactor.html#removeWriter
  Function
  Method
  PUBLIC
  Remove a Selectable for notification of data available to write.
- twisted.internet._threadedselect.ThreadedSelectReactor.removeAll
  twisted.internet._threadedselect.ThreadedSelectReactor.html#removeAll
  Function
  Method
  PUBLIC
  Remove all readers and writers.
- twisted.internet._threadedselect.ThreadedSelectReactor.getReaders
  twisted.internet._threadedselect.ThreadedSelectReactor.html#getReaders
  Function
  Method
  PUBLIC
  Return the list of file descriptors currently monitored for input events by the reactor.
- twisted.internet._threadedselect.ThreadedSelectReactor.getWriters
  twisted.internet._threadedselect.ThreadedSelectReactor.html#getWriters
  Function
  Method
  PUBLIC
  Return the list file descriptors currently monitored for output events by the reactor.
- twisted.internet._threadedselect.ThreadedSelectReactor.stop
  twisted.internet._threadedselect.ThreadedSelectReactor.html#stop
  Function
  Method
  PUBLIC
  Extend the base stop implementation to also wake up the select thread so that `runUntilCurrent` notices the reactor should stop.
- twisted.internet._threadedselect.ThreadedSelectReactor.run
  twisted.internet._threadedselect.ThreadedSelectReactor.html#run
  Function
  Method
  PUBLIC
  Fire 'startup' System Events, move the reactor to the 'running' state, then run the main loop until it is stopped with `stop()` or `crash()`.
- twisted.internet._threadedselect.ThreadedSelectReactor.mainLoop
  twisted.internet._threadedselect.ThreadedSelectReactor.html#mainLoop
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet._threadedselect.install
  twisted.internet._threadedselect.html#install
  Function
  Function
  PUBLIC
  Configure the twisted mainloop to be run using the select() reactor.
- twisted.internet.asyncioreactor.AsyncioSelectorReactor
  twisted.internet.asyncioreactor.AsyncioSelectorReactor.html
  Class
  Class
  PUBLIC
  Reactor running on top of `asyncio.SelectorEventLoop`.
- twisted.internet.asyncioreactor.AsyncioSelectorReactor._asyncClosed
  twisted.internet.asyncioreactor.AsyncioSelectorReactor.html#_asyncClosed
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.internet.asyncioreactor.AsyncioSelectorReactor._log
  twisted.internet.asyncioreactor.AsyncioSelectorReactor.html#_log
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.internet.asyncioreactor.AsyncioSelectorReactor.__init__
  twisted.internet.asyncioreactor.AsyncioSelectorReactor.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.asyncioreactor.AsyncioSelectorReactor._asyncioEventloop
  twisted.internet.asyncioreactor.AsyncioSelectorReactor.html#_asyncioEventloop
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.asyncioreactor.AsyncioSelectorReactor._writers
  twisted.internet.asyncioreactor.AsyncioSelectorReactor.html#_writers
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.asyncioreactor.AsyncioSelectorReactor._readers
  twisted.internet.asyncioreactor.AsyncioSelectorReactor.html#_readers
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.asyncioreactor.AsyncioSelectorReactor._continuousPolling
  twisted.internet.asyncioreactor.AsyncioSelectorReactor.html#_continuousPolling
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.asyncioreactor.AsyncioSelectorReactor._scheduledAt
  twisted.internet.asyncioreactor.AsyncioSelectorReactor.html#_scheduledAt
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.asyncioreactor.AsyncioSelectorReactor._timerHandle
  twisted.internet.asyncioreactor.AsyncioSelectorReactor.html#_timerHandle
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.asyncioreactor.AsyncioSelectorReactor._unregisterFDInAsyncio
  twisted.internet.asyncioreactor.AsyncioSelectorReactor.html#_unregisterFDInAsyncio
  Function
  Method
  PRIVATE
  Compensate for a bug in asyncio where it will not unregister a FD that it cannot handle in the epoll loop. It touches internal asyncio code.
- twisted.internet.asyncioreactor.AsyncioSelectorReactor._readOrWrite
  twisted.internet.asyncioreactor.AsyncioSelectorReactor.html#_readOrWrite
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet.asyncioreactor.AsyncioSelectorReactor.addReader
  twisted.internet.asyncioreactor.AsyncioSelectorReactor.html#addReader
  Function
  Method
  PUBLIC
  I add reader to the set of file descriptors to get read events for.
- twisted.internet.asyncioreactor.AsyncioSelectorReactor.addWriter
  twisted.internet.asyncioreactor.AsyncioSelectorReactor.html#addWriter
  Function
  Method
  PUBLIC
  I add writer to the set of file descriptors to get write events for.
- twisted.internet.asyncioreactor.AsyncioSelectorReactor.removeReader
  twisted.internet.asyncioreactor.AsyncioSelectorReactor.html#removeReader
  Function
  Method
  PUBLIC
  Removes an object previously added with `addReader`.
- twisted.internet.asyncioreactor.AsyncioSelectorReactor.removeWriter
  twisted.internet.asyncioreactor.AsyncioSelectorReactor.html#removeWriter
  Function
  Method
  PUBLIC
  Removes an object previously added with `addWriter`.
- twisted.internet.asyncioreactor.AsyncioSelectorReactor.removeAll
  twisted.internet.asyncioreactor.AsyncioSelectorReactor.html#removeAll
  Function
  Method
  PUBLIC
  Remove all readers and writers.
- twisted.internet.asyncioreactor.AsyncioSelectorReactor.getReaders
  twisted.internet.asyncioreactor.AsyncioSelectorReactor.html#getReaders
  Function
  Method
  PUBLIC
  Return the list of file descriptors currently monitored for input events by the reactor.
- twisted.internet.asyncioreactor.AsyncioSelectorReactor.getWriters
  twisted.internet.asyncioreactor.AsyncioSelectorReactor.html#getWriters
  Function
  Method
  PUBLIC
  Return the list file descriptors currently monitored for output events by the reactor.
- twisted.internet.asyncioreactor.AsyncioSelectorReactor.iterate
  twisted.internet.asyncioreactor.AsyncioSelectorReactor.html#iterate
  Function
  Method
  PUBLIC
  See twisted.internet.interfaces.IReactorCore.iterate.
- twisted.internet.asyncioreactor.AsyncioSelectorReactor.run
  twisted.internet.asyncioreactor.AsyncioSelectorReactor.html#run
  Function
  Method
  PUBLIC
  Fire 'startup' System Events, move the reactor to the 'running' state, then run the main loop until it is stopped with `stop()` or `crash()`.
- twisted.internet.asyncioreactor.AsyncioSelectorReactor._justStopped
  twisted.internet.asyncioreactor.AsyncioSelectorReactor.html#_justStopped
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.asyncioreactor.AsyncioSelectorReactor.stop
  twisted.internet.asyncioreactor.AsyncioSelectorReactor.html#stop
  Function
  Method
  PUBLIC
  See twisted.internet.interfaces.IReactorCore.stop.
- twisted.internet.asyncioreactor.AsyncioSelectorReactor.crash
  twisted.internet.asyncioreactor.AsyncioSelectorReactor.html#crash
  Function
  Method
  PUBLIC
  See twisted.internet.interfaces.IReactorCore.crash.
- twisted.internet.asyncioreactor.AsyncioSelectorReactor._onTimer
  twisted.internet.asyncioreactor.AsyncioSelectorReactor.html#_onTimer
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet.asyncioreactor.AsyncioSelectorReactor._reschedule
  twisted.internet.asyncioreactor.AsyncioSelectorReactor.html#_reschedule
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet.asyncioreactor.AsyncioSelectorReactor._moveCallLaterSooner
  twisted.internet.asyncioreactor.AsyncioSelectorReactor.html#_moveCallLaterSooner
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet.asyncioreactor.AsyncioSelectorReactor.callLater
  twisted.internet.asyncioreactor.AsyncioSelectorReactor.html#callLater
  Function
  Method
  PUBLIC
  See twisted.internet.interfaces.IReactorTime.callLater.
- twisted.internet.asyncioreactor.AsyncioSelectorReactor.callFromThread
  twisted.internet.asyncioreactor.AsyncioSelectorReactor.html#callFromThread
  Function
  Method
  PUBLIC
  See `twisted.internet.interfaces.IReactorFromThreads.callFromThread`.
- twisted.internet.asyncioreactor.install
  twisted.internet.asyncioreactor.html#install
  Function
  Function
  PUBLIC
  Install an asyncio-based reactor.
- twisted.internet.cfreactor._READ
  twisted.internet.cfreactor.html#_READ
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.internet.cfreactor._WRITE
  twisted.internet.cfreactor.html#_WRITE
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.internet.cfreactor._preserveSOError
  twisted.internet.cfreactor.html#_preserveSOError
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.internet.cfreactor._WakerPlus
  twisted.internet.cfreactor._WakerPlus.html
  Class
  Class
  PRIVATE
  The normal Twisted waker will simply wake up the main loop, which causes an iteration to run, which in turn causes `ReactorBase.runUntilCurrent` to get invoked.
- twisted.internet.cfreactor._WakerPlus.doRead
  twisted.internet.cfreactor._WakerPlus.html#doRead
  Function
  Method
  PUBLIC
  Wake up the loop and force `runUntilCurrent` to run immediately in the next timed iteration.
- twisted.internet.cfreactor.CFReactor
  twisted.internet.cfreactor.CFReactor.html
  Class
  Class
  PUBLIC
  The CoreFoundation reactor.
- twisted.internet.cfreactor.CFReactor._fdmap
  twisted.internet.cfreactor.CFReactor.html#_fdmap
  Attribute
  Instance Variable
  PRIVATE
  a dictionary, mapping an integer (a file descriptor) to a 4-tuple of:
- twisted.internet.cfreactor.CFReactor._idmap
  twisted.internet.cfreactor.CFReactor.html#_idmap
  Attribute
  Instance Variable
  PRIVATE
  a dictionary, mapping the id() of an `IReadDescriptor` or `IWriteDescriptor` to a `fd` in `_fdmap`. Implemented in this manner so that we don't have to rely (even more) on the hashability of `IReadDescriptor` providers, and we know that they won't be collected since these are kept in sync with ...
- twisted.internet.cfreactor.CFReactor._cfrunloop
  twisted.internet.cfreactor.CFReactor.html#_cfrunloop
  Attribute
  Instance Variable
  PRIVATE
  the `CFRunLoop` pyobjc object wrapped by this reactor.
- twisted.internet.cfreactor.CFReactor._inCFLoop
  twisted.internet.cfreactor.CFReactor.html#_inCFLoop
  Attribute
  Instance Variable
  PRIVATE
  Is `CFRunLoopRun` currently running?
- twisted.internet.cfreactor.CFReactor._currentSimulator
  twisted.internet.cfreactor.CFReactor.html#_currentSimulator
  Attribute
  Instance Variable
  PRIVATE
  if a CFTimer is currently scheduled with the CF run loop to run Twisted callLater calls, this is a reference to it. Otherwise, it is `None`
- twisted.internet.cfreactor.CFReactor.__init__
  twisted.internet.cfreactor.CFReactor.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.cfreactor.CFReactor._runner
  twisted.internet.cfreactor.CFReactor.html#_runner
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.cfreactor.CFReactor.installWaker
  twisted.internet.cfreactor.CFReactor.html#installWaker
  Function
  Method
  PUBLIC
  Override `installWaker` in order to use `_WakerPlus`; otherwise this should be exactly the same as the parent implementation.
- twisted.internet.cfreactor.CFReactor.waker
  twisted.internet.cfreactor.CFReactor.html#waker
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.cfreactor.CFReactor._socketCallback
  twisted.internet.cfreactor.CFReactor.html#_socketCallback
  Function
  Method
  PRIVATE
  The socket callback issued by CFRunLoop. This will issue `doRead` or `doWrite` calls to the `IReadDescriptor` and `IWriteDescriptor` registered with the file descriptor that we are being notified of.
- twisted.internet.cfreactor.CFReactor._watchFD
  twisted.internet.cfreactor.CFReactor.html#_watchFD
  Function
  Method
  PRIVATE
  Register a file descriptor with the `CFRunLoop`, or modify its state so that it's listening for both notifications (read and write) rather than just one; used to implement `addReader` and `addWriter`.
- twisted.internet.cfreactor.CFReactor._flag2idx
  twisted.internet.cfreactor.CFReactor.html#_flag2idx
  Function
  Method
  PRIVATE
  Convert a `kCFSocket...` constant to an index into the read/write state list (`_READ` or `_WRITE`) (the 4th element of the value of `self._fdmap`).
- twisted.internet.cfreactor.CFReactor._unwatchFD
  twisted.internet.cfreactor.CFReactor.html#_unwatchFD
  Function
  Method
  PRIVATE
  Unregister a file descriptor with the `CFRunLoop`, or modify its state so that it's listening for only one notification (read or write) as opposed to both; used to implement `removeReader` and `removeWriter`...
- twisted.internet.cfreactor.CFReactor.addReader
  twisted.internet.cfreactor.CFReactor.html#addReader
  Function
  Method
  PUBLIC
  Implement `IReactorFDSet.addReader`.
- twisted.internet.cfreactor.CFReactor.addWriter
  twisted.internet.cfreactor.CFReactor.html#addWriter
  Function
  Method
  PUBLIC
  Implement `IReactorFDSet.addWriter`.
- twisted.internet.cfreactor.CFReactor.removeReader
  twisted.internet.cfreactor.CFReactor.html#removeReader
  Function
  Method
  PUBLIC
  Implement `IReactorFDSet.removeReader`.
- twisted.internet.cfreactor.CFReactor.removeWriter
  twisted.internet.cfreactor.CFReactor.html#removeWriter
  Function
  Method
  PUBLIC
  Implement `IReactorFDSet.removeWriter`.
- twisted.internet.cfreactor.CFReactor.removeAll
  twisted.internet.cfreactor.CFReactor.html#removeAll
  Function
  Method
  PUBLIC
  Implement `IReactorFDSet.removeAll`.
- twisted.internet.cfreactor.CFReactor.getReaders
  twisted.internet.cfreactor.CFReactor.html#getReaders
  Function
  Method
  PUBLIC
  Implement `IReactorFDSet.getReaders`.
- twisted.internet.cfreactor.CFReactor.getWriters
  twisted.internet.cfreactor.CFReactor.html#getWriters
  Function
  Method
  PUBLIC
  Implement `IReactorFDSet.getWriters`.
- twisted.internet.cfreactor.CFReactor._moveCallLaterSooner
  twisted.internet.cfreactor.CFReactor.html#_moveCallLaterSooner
  Function
  Method
  PRIVATE
  Override `PosixReactorBase`'s implementation of `IDelayedCall.reset` so that it will immediately reschedule. Normally `_moveCallLaterSooner` depends on the fact that `runUntilCurrent` is always run before the mainloop goes back to sleep, so this forces it to immediately recompute how long the loop needs to stay asleep.
- twisted.internet.cfreactor.CFReactor.mainLoop
  twisted.internet.cfreactor.CFReactor.html#mainLoop
  Function
  Method
  PUBLIC
  Run the runner (`CFRunLoopRun` or something that calls it), which runs the run loop until `crash()` is called.
- twisted.internet.cfreactor.CFReactor._scheduleSimulate
  twisted.internet.cfreactor.CFReactor.html#_scheduleSimulate
  Function
  Method
  PRIVATE
  Schedule a call to `self.runUntilCurrent`. This will cancel the currently scheduled call if it is already scheduled.
- twisted.internet.cfreactor.CFReactor.callLater
  twisted.internet.cfreactor.CFReactor.html#callLater
  Function
  Method
  PUBLIC
  Implement `IReactorTime.callLater`.
- twisted.internet.cfreactor.CFReactor.stop
  twisted.internet.cfreactor.CFReactor.html#stop
  Function
  Method
  PUBLIC
  Implement `IReactorCore.stop`.
- twisted.internet.cfreactor.CFReactor.crash
  twisted.internet.cfreactor.CFReactor.html#crash
  Function
  Method
  PUBLIC
  Implement `IReactorCore.crash`
- twisted.internet.cfreactor.CFReactor._stopNow
  twisted.internet.cfreactor.CFReactor.html#_stopNow
  Function
  Method
  PRIVATE
  Immediately stop the CFRunLoop (which must be running!).
- twisted.internet.cfreactor.CFReactor.iterate
  twisted.internet.cfreactor.CFReactor.html#iterate
  Function
  Method
  PUBLIC
  Emulate the behavior of `iterate()` for things that want to call it, by letting the loop run for a little while and then scheduling a timed call to exit it.
- twisted.internet.cfreactor.install
  twisted.internet.cfreactor.html#install
  Function
  Function
  PUBLIC
  Configure the twisted mainloop to be run inside CFRunLoop.
- twisted.internet.epollreactor.epoll
  twisted.internet.epollreactor.html#epoll
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.internet.epollreactor.EPOLLHUP
  twisted.internet.epollreactor.html#EPOLLHUP
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.epollreactor.EPOLLERR
  twisted.internet.epollreactor.html#EPOLLERR
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.epollreactor.EPOLLIN
  twisted.internet.epollreactor.html#EPOLLIN
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.epollreactor.EPOLLOUT
  twisted.internet.epollreactor.html#EPOLLOUT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.epollreactor.EPollReactor
  twisted.internet.epollreactor.EPollReactor.html
  Class
  Class
  PUBLIC
  A reactor that uses epoll(7).
- twisted.internet.epollreactor.EPollReactor._poller
  twisted.internet.epollreactor.EPollReactor.html#_poller
  Attribute
  Instance Variable
  PRIVATE
  A `epoll` which will be used to check for I/O readiness.
- twisted.internet.epollreactor.EPollReactor._selectables
  twisted.internet.epollreactor.EPollReactor.html#_selectables
  Attribute
  Instance Variable
  PRIVATE
  A dictionary mapping integer file descriptors to instances of `FileDescriptor` which have been registered with the reactor. All `FileDescriptors` which are currently receiving read or write readiness notifications will be present as values in this dictionary.
- twisted.internet.epollreactor.EPollReactor._reads
  twisted.internet.epollreactor.EPollReactor.html#_reads
  Attribute
  Instance Variable
  PRIVATE
  A set containing integer file descriptors. Values in this set will be registered with `_poller` for read readiness notifications which will be dispatched to the corresponding `FileDescriptor` instances in ...
- twisted.internet.epollreactor.EPollReactor._writes
  twisted.internet.epollreactor.EPollReactor.html#_writes
  Attribute
  Instance Variable
  PRIVATE
  A set containing integer file descriptors. Values in this set will be registered with `_poller` for write readiness notifications which will be dispatched to the corresponding `FileDescriptor` instances in ...
- twisted.internet.epollreactor.EPollReactor._continuousPolling
  twisted.internet.epollreactor.EPollReactor.html#_continuousPolling
  Attribute
  Instance Variable
  PRIVATE
  A `_ContinuousPolling` instance, used to handle file descriptors (e.g. filesystem files) that are not supported by `epoll(7)`.
- twisted.internet.epollreactor.EPollReactor._POLL_DISCONNECTED
  twisted.internet.epollreactor.EPollReactor.html#_POLL_DISCONNECTED
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.internet.epollreactor.EPollReactor.__init__
  twisted.internet.epollreactor.EPollReactor.html#__init__
  Function
  Method
  PUBLIC
  Initialize epoll object, file descriptor tracking dictionaries, and the base class.
- twisted.internet.epollreactor.EPollReactor._add
  twisted.internet.epollreactor.EPollReactor.html#_add
  Function
  Method
  PRIVATE
  Private method for adding a descriptor from the event loop.
- twisted.internet.epollreactor.EPollReactor.addReader
  twisted.internet.epollreactor.EPollReactor.html#addReader
  Function
  Method
  PUBLIC
  Add a FileDescriptor for notification of data available to read.
- twisted.internet.epollreactor.EPollReactor.addWriter
  twisted.internet.epollreactor.EPollReactor.html#addWriter
  Function
  Method
  PUBLIC
  Add a FileDescriptor for notification of data available to write.
- twisted.internet.epollreactor.EPollReactor._remove
  twisted.internet.epollreactor.EPollReactor.html#_remove
  Function
  Method
  PRIVATE
  Private method for removing a descriptor from the event loop.
- twisted.internet.epollreactor.EPollReactor.removeReader
  twisted.internet.epollreactor.EPollReactor.html#removeReader
  Function
  Method
  PUBLIC
  Remove a Selectable for notification of data available to read.
- twisted.internet.epollreactor.EPollReactor.removeWriter
  twisted.internet.epollreactor.EPollReactor.html#removeWriter
  Function
  Method
  PUBLIC
  Remove a Selectable for notification of data available to write.
- twisted.internet.epollreactor.EPollReactor.removeAll
  twisted.internet.epollreactor.EPollReactor.html#removeAll
  Function
  Method
  PUBLIC
  Remove all selectables, and return a list of them.
- twisted.internet.epollreactor.EPollReactor.getReaders
  twisted.internet.epollreactor.EPollReactor.html#getReaders
  Function
  Method
  PUBLIC
  Return the list of file descriptors currently monitored for input events by the reactor.
- twisted.internet.epollreactor.EPollReactor.getWriters
  twisted.internet.epollreactor.EPollReactor.html#getWriters
  Function
  Method
  PUBLIC
  Return the list file descriptors currently monitored for output events by the reactor.
- twisted.internet.epollreactor.EPollReactor.doPoll
  twisted.internet.epollreactor.EPollReactor.html#doPoll
  Function
  Method
  PUBLIC
  Poll the poller for new events.
- twisted.internet.epollreactor.install
  twisted.internet.epollreactor.html#install
  Function
  Function
  PUBLIC
  Install the epoll() reactor.
- twisted.internet.gireactor._pygtkcompatPresent
  twisted.internet.gireactor.html#_pygtkcompatPresent
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.internet.gireactor.GIReactor
  twisted.internet.gireactor.GIReactor.html
  Class
  Class
  PUBLIC
  GObject-introspection event loop reactor.
- twisted.internet.gireactor.GIReactor._gapplication
  twisted.internet.gireactor.GIReactor.html#_gapplication
  Attribute
  Instance Variable
  PRIVATE
  A `Gio.Application` instance that was registered with `registerGApplication`.
- twisted.internet.gireactor.GIReactor._POLL_DISCONNECTED
  twisted.internet.gireactor.GIReactor.html#_POLL_DISCONNECTED
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.internet.gireactor.GIReactor.INFLAGS
  twisted.internet.gireactor.GIReactor.html#INFLAGS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.gireactor.GIReactor.OUTFLAGS
  twisted.internet.gireactor.GIReactor.html#OUTFLAGS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.gireactor.GIReactor.__init__
  twisted.internet.gireactor.GIReactor.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.gireactor.GIReactor.registerGApplication
  twisted.internet.gireactor.GIReactor.html#registerGApplication
  Function
  Method
  PUBLIC
  Register a `Gio.Application` or `Gtk.Application`, whose main loop will be used instead of the default one.
- twisted.internet.gireactor.GIReactor._run
  twisted.internet.gireactor.GIReactor.html#_run
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.gireactor.GIReactor._crash
  twisted.internet.gireactor.GIReactor.html#_crash
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.gireactor.PortableGIReactor
  twisted.internet.gireactor.PortableGIReactor.html
  Class
  Class
  PUBLIC
  Portable GObject Introspection event loop reactor.
- twisted.internet.gireactor.PortableGIReactor.__init__
  twisted.internet.gireactor.PortableGIReactor.html#__init__
  Function
  Method
  PUBLIC
  Initialize file descriptor tracking dictionaries and the base class.
- twisted.internet.gireactor.PortableGIReactor.registerGApplication
  twisted.internet.gireactor.PortableGIReactor.html#registerGApplication
  Function
  Method
  PUBLIC
  Register a `Gio.Application` or `Gtk.Application`, whose main loop will be used instead of the default one.
- twisted.internet.gireactor.install
  twisted.internet.gireactor.html#install
  Function
  Function
  PUBLIC
  Configure the twisted mainloop to be run inside the glib mainloop.
- twisted.internet.gtk2reactor.Gtk2Reactor
  twisted.internet.gtk2reactor.Gtk2Reactor.html
  Class
  Class
  PUBLIC
  PyGTK+ 2 event loop reactor.
- twisted.internet.gtk2reactor.Gtk2Reactor._POLL_DISCONNECTED
  twisted.internet.gtk2reactor.Gtk2Reactor.html#_POLL_DISCONNECTED
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.internet.gtk2reactor.Gtk2Reactor.INFLAGS
  twisted.internet.gtk2reactor.Gtk2Reactor.html#INFLAGS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.gtk2reactor.Gtk2Reactor.OUTFLAGS
  twisted.internet.gtk2reactor.Gtk2Reactor.html#OUTFLAGS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.gtk2reactor.Gtk2Reactor.__init__
  twisted.internet.gtk2reactor.Gtk2Reactor.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.gtk2reactor.PortableGtkReactor
  twisted.internet.gtk2reactor.PortableGtkReactor.html
  Class
  Class
  PUBLIC
  Reactor that works on Windows.
- twisted.internet.gtk2reactor.PortableGtkReactor.__init__
  twisted.internet.gtk2reactor.PortableGtkReactor.html#__init__
  Function
  Method
  PUBLIC
  Initialize file descriptor tracking dictionaries and the base class.
- twisted.internet.gtk2reactor.install
  twisted.internet.gtk2reactor.html#install
  Function
  Function
  PUBLIC
  Configure the twisted mainloop to be run inside the gtk mainloop.
- twisted.internet.gtk2reactor.portableInstall
  twisted.internet.gtk2reactor.html#portableInstall
  Function
  Function
  PUBLIC
  Configure the twisted mainloop to be run inside the gtk mainloop.
- twisted.internet.glib2reactor.Glib2Reactor
  twisted.internet.glib2reactor.Glib2Reactor.html
  Class
  Class
  PUBLIC
  The reactor using the glib mainloop.
- twisted.internet.glib2reactor.Glib2Reactor.__init__
  twisted.internet.glib2reactor.Glib2Reactor.html#__init__
  Function
  Method
  PUBLIC
  Override init to set the `useGtk` flag.
- twisted.internet.glib2reactor.install
  twisted.internet.glib2reactor.html#install
  Function
  Function
  PUBLIC
  Configure the twisted mainloop to be run inside the glib mainloop.
- twisted.internet.gtk3reactor.Gtk3Reactor
  twisted.internet.gtk3reactor.Gtk3Reactor.html
  Class
  Class
  PUBLIC
  A reactor using the gtk3+ event loop.
- twisted.internet.gtk3reactor.Gtk3Reactor.__init__
  twisted.internet.gtk3reactor.Gtk3Reactor.html#__init__
  Function
  Method
  PUBLIC
  Override init to set the `useGtk` flag.
- twisted.internet.gtk3reactor.PortableGtk3Reactor
  twisted.internet.gtk3reactor.PortableGtk3Reactor.html
  Class
  Class
  PUBLIC
  Portable GTK+ 3.x reactor.
- twisted.internet.gtk3reactor.PortableGtk3Reactor.__init__
  twisted.internet.gtk3reactor.PortableGtk3Reactor.html#__init__
  Function
  Method
  PUBLIC
  Override init to set the `useGtk` flag.
- twisted.internet.gtk3reactor.install
  twisted.internet.gtk3reactor.html#install
  Function
  Function
  PUBLIC
  Configure the Twisted mainloop to be run inside the gtk3+ mainloop.
- twisted.python._inotify.INotifyError
  twisted.python._inotify.INotifyError.html
  Class
  Exception
  PUBLIC
  Unify all the possible exceptions that can be raised by the INotify API.
- twisted.python._inotify.init
  twisted.python._inotify.html#init
  Function
  Function
  PUBLIC
  Create an inotify instance and return the associated file descriptor.
- twisted.python._inotify.add
  twisted.python._inotify.html#add
  Function
  Function
  PUBLIC
  Add a watch for the given path to the inotify file descriptor, and return the watch descriptor.
- twisted.python._inotify.remove
  twisted.python._inotify.html#remove
  Function
  Function
  PUBLIC
  Remove the given watch descriptor from the inotify file descriptor.
- twisted.python._inotify.initializeModule
  twisted.python._inotify.html#initializeModule
  Function
  Function
  PUBLIC
  Initialize the module, checking if the expected APIs exist and setting the argtypes and restype for `inotify_init`, `inotify_add_watch`, and `inotify_rm_watch`.
- twisted.python._inotify.name
  twisted.python._inotify.html#name
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.python._inotify.libc
  twisted.python._inotify.html#libc
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.internet.inotify.IN_ACCESS
  twisted.internet.inotify.html#IN_ACCESS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.inotify.IN_MODIFY
  twisted.internet.inotify.html#IN_MODIFY
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.inotify.IN_ATTRIB
  twisted.internet.inotify.html#IN_ATTRIB
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.inotify.IN_CLOSE_WRITE
  twisted.internet.inotify.html#IN_CLOSE_WRITE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.inotify.IN_CLOSE_NOWRITE
  twisted.internet.inotify.html#IN_CLOSE_NOWRITE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.inotify.IN_OPEN
  twisted.internet.inotify.html#IN_OPEN
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.inotify.IN_MOVED_FROM
  twisted.internet.inotify.html#IN_MOVED_FROM
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.inotify.IN_MOVED_TO
  twisted.internet.inotify.html#IN_MOVED_TO
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.inotify.IN_CREATE
  twisted.internet.inotify.html#IN_CREATE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.inotify.IN_DELETE
  twisted.internet.inotify.html#IN_DELETE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.inotify.IN_DELETE_SELF
  twisted.internet.inotify.html#IN_DELETE_SELF
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.inotify.IN_MOVE_SELF
  twisted.internet.inotify.html#IN_MOVE_SELF
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.inotify.IN_UNMOUNT
  twisted.internet.inotify.html#IN_UNMOUNT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.inotify.IN_Q_OVERFLOW
  twisted.internet.inotify.html#IN_Q_OVERFLOW
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.inotify.IN_IGNORED
  twisted.internet.inotify.html#IN_IGNORED
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.inotify.IN_ONLYDIR
  twisted.internet.inotify.html#IN_ONLYDIR
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.inotify.IN_DONT_FOLLOW
  twisted.internet.inotify.html#IN_DONT_FOLLOW
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.inotify.IN_MASK_ADD
  twisted.internet.inotify.html#IN_MASK_ADD
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.inotify.IN_ISDIR
  twisted.internet.inotify.html#IN_ISDIR
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.inotify.IN_ONESHOT
  twisted.internet.inotify.html#IN_ONESHOT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.inotify.IN_CLOSE
  twisted.internet.inotify.html#IN_CLOSE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.inotify.IN_MOVED
  twisted.internet.inotify.html#IN_MOVED
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.inotify.IN_CHANGED
  twisted.internet.inotify.html#IN_CHANGED
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.inotify.IN_WATCH_MASK
  twisted.internet.inotify.html#IN_WATCH_MASK
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.inotify._FLAG_TO_HUMAN
  twisted.internet.inotify.html#_FLAG_TO_HUMAN
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.internet.inotify.humanReadableMask
  twisted.internet.inotify.html#humanReadableMask
  Function
  Function
  PUBLIC
  Auxiliary function that converts a hexadecimal mask into a series of human readable flags.
- twisted.internet.inotify._Watch
  twisted.internet.inotify._Watch.html
  Class
  Class
  PRIVATE
  Watch object that represents a Watch point in the filesystem. The user should let INotify to create these objects
- twisted.internet.inotify._Watch.path
  twisted.internet.inotify._Watch.html#path
  Attribute
  Instance Variable
  PUBLIC
  The path over which this watch point is monitoring
- twisted.internet.inotify._Watch.mask
  twisted.internet.inotify._Watch.html#mask
  Attribute
  Instance Variable
  PUBLIC
  The events monitored by this watchpoint
- twisted.internet.inotify._Watch.autoAdd
  twisted.internet.inotify._Watch.html#autoAdd
  Attribute
  Instance Variable
  PUBLIC
  Flag that determines whether this watch point should automatically add created subdirectories
- twisted.internet.inotify._Watch.callbacks
  twisted.internet.inotify._Watch.html#callbacks
  Attribute
  Instance Variable
  PUBLIC
  `list` of callback functions that will be called when an event occurs on this watch.
- twisted.internet.inotify._Watch.__init__
  twisted.internet.inotify._Watch.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.inotify._Watch._notify
  twisted.internet.inotify._Watch.html#_notify
  Function
  Method
  PRIVATE
  Callback function used by `INotify` to dispatch an event.
- twisted.internet.inotify.INotify
  twisted.internet.inotify.INotify.html
  Class
  Class
  PUBLIC
  The INotify file descriptor, it basically does everything related to INotify, from reading to notifying watch points.
- twisted.internet.inotify.INotify._buffer
  twisted.internet.inotify.INotify.html#_buffer
  Attribute
  Instance Variable
  PRIVATE
  a `bytes` containing the data read from the inotify fd.
- twisted.internet.inotify.INotify._watchpoints
  twisted.internet.inotify.INotify.html#_watchpoints
  Attribute
  Instance Variable
  PRIVATE
  a `dict` that maps from inotify watch ids to watchpoints objects
- twisted.internet.inotify.INotify._watchpaths
  twisted.internet.inotify.INotify.html#_watchpaths
  Attribute
  Instance Variable
  PRIVATE
  a `dict` that maps from watched paths to the inotify watch ids
- twisted.internet.inotify.INotify.__init__
  twisted.internet.inotify.INotify.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.internet.inotify.INotify._fd
  twisted.internet.inotify.INotify.html#_fd
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.inotify.INotify.connected
  twisted.internet.inotify.INotify.html#connected
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.inotify.INotify._writeDisconnected
  twisted.internet.inotify.INotify.html#_writeDisconnected
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.inotify.INotify._addWatch
  twisted.internet.inotify.INotify.html#_addWatch
  Function
  Method
  PRIVATE
  Private helper that abstracts the use of ctypes.
- twisted.internet.inotify.INotify._rmWatch
  twisted.internet.inotify.INotify.html#_rmWatch
  Function
  Method
  PRIVATE
  Private helper that abstracts the use of ctypes.
- twisted.internet.inotify.INotify.connectionLost
  twisted.internet.inotify.INotify.html#connectionLost
  Function
  Method
  PUBLIC
  Release the inotify file descriptor and do the necessary cleanup
- twisted.internet.inotify.INotify.fileno
  twisted.internet.inotify.INotify.html#fileno
  Function
  Method
  PUBLIC
  Get the underlying file descriptor from this inotify observer. Required by `abstract.FileDescriptor` subclasses.
- twisted.internet.inotify.INotify.doRead
  twisted.internet.inotify.INotify.html#doRead
  Function
  Method
  PUBLIC
  Read some data from the observed file descriptors
- twisted.internet.inotify.INotify._doRead
  twisted.internet.inotify.INotify.html#_doRead
  Function
  Method
  PRIVATE
  Work on the data just read from the file descriptor.
- twisted.internet.inotify.INotify._addChildren
  twisted.internet.inotify.INotify.html#_addChildren
  Function
  Method
  PRIVATE
  This is a very private method, please don't even think about using it.
- twisted.internet.inotify.INotify.watch
  twisted.internet.inotify.INotify.html#watch
  Function
  Method
  PUBLIC
  Watch the 'mask' events in given path. Can raise `INotifyError` when there's a problem while adding a directory.
- twisted.internet.inotify.INotify.ignore
  twisted.internet.inotify.INotify.html#ignore
  Function
  Method
  PUBLIC
  Remove the watch point monitoring the given path
- twisted.internet.inotify.INotify._isWatched
  twisted.internet.inotify.INotify.html#_isWatched
  Function
  Method
  PRIVATE
  Helper function that checks if the path is already monitored and returns its watchdescriptor if so or None otherwise.
- twisted.internet.iocpreactor.const.ERROR_PORT_UNREACHABLE
  twisted.internet.iocpreactor.const.html#ERROR_PORT_UNREACHABLE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.const.ERROR_NETWORK_UNREACHABLE
  twisted.internet.iocpreactor.const.html#ERROR_NETWORK_UNREACHABLE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.const.ERROR_CONNECTION_REFUSED
  twisted.internet.iocpreactor.const.html#ERROR_CONNECTION_REFUSED
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.const.ERROR_IO_PENDING
  twisted.internet.iocpreactor.const.html#ERROR_IO_PENDING
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.const.ERROR_OPERATION_ABORTED
  twisted.internet.iocpreactor.const.html#ERROR_OPERATION_ABORTED
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.const.WAIT_TIMEOUT
  twisted.internet.iocpreactor.const.html#WAIT_TIMEOUT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.const.ERROR_NETNAME_DELETED
  twisted.internet.iocpreactor.const.html#ERROR_NETNAME_DELETED
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.const.ERROR_HANDLE_EOF
  twisted.internet.iocpreactor.const.html#ERROR_HANDLE_EOF
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.const.INFINITE
  twisted.internet.iocpreactor.const.html#INFINITE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.const.SO_UPDATE_CONNECT_CONTEXT
  twisted.internet.iocpreactor.const.html#SO_UPDATE_CONNECT_CONTEXT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.const.SO_UPDATE_ACCEPT_CONTEXT
  twisted.internet.iocpreactor.const.html#SO_UPDATE_ACCEPT_CONTEXT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.abstract.FileHandle
  twisted.internet.iocpreactor.abstract.FileHandle.html
  Class
  Class
  PUBLIC
  File handle that can read and write asynchronously
- twisted.internet.iocpreactor.abstract.FileHandle.maxReadBuffers
  twisted.internet.iocpreactor.abstract.FileHandle.html#maxReadBuffers
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.abstract.FileHandle.readBufferSize
  twisted.internet.iocpreactor.abstract.FileHandle.html#readBufferSize
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.abstract.FileHandle.reading
  twisted.internet.iocpreactor.abstract.FileHandle.html#reading
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.abstract.FileHandle.dynamicReadBuffers
  twisted.internet.iocpreactor.abstract.FileHandle.html#dynamicReadBuffers
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.abstract.FileHandle._readNextBuffer
  twisted.internet.iocpreactor.abstract.FileHandle.html#_readNextBuffer
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.iocpreactor.abstract.FileHandle._readSize
  twisted.internet.iocpreactor.abstract.FileHandle.html#_readSize
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.iocpreactor.abstract.FileHandle._readScheduled
  twisted.internet.iocpreactor.abstract.FileHandle.html#_readScheduled
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.iocpreactor.abstract.FileHandle._readScheduledInOS
  twisted.internet.iocpreactor.abstract.FileHandle.html#_readScheduledInOS
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.iocpreactor.abstract.FileHandle.startReading
  twisted.internet.iocpreactor.abstract.FileHandle.html#startReading
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.abstract.FileHandle.stopReading
  twisted.internet.iocpreactor.abstract.FileHandle.html#stopReading
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.abstract.FileHandle._resumeReading
  twisted.internet.iocpreactor.abstract.FileHandle.html#_resumeReading
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet.iocpreactor.abstract.FileHandle._dispatchData
  twisted.internet.iocpreactor.abstract.FileHandle.html#_dispatchData
  Function
  Method
  PRIVATE
  Dispatch previously read data. Return True if self.reading and we don't have any more data
- twisted.internet.iocpreactor.abstract.FileHandle._cbRead
  twisted.internet.iocpreactor.abstract.FileHandle.html#_cbRead
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet.iocpreactor.abstract.FileHandle._handleRead
  twisted.internet.iocpreactor.abstract.FileHandle.html#_handleRead
  Function
  Method
  PRIVATE
  Returns False if we should stop reading for now
- twisted.internet.iocpreactor.abstract.FileHandle.doRead
  twisted.internet.iocpreactor.abstract.FileHandle.html#doRead
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.abstract.FileHandle.readFromHandle
  twisted.internet.iocpreactor.abstract.FileHandle.html#readFromHandle
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.abstract.FileHandle.dataReceived
  twisted.internet.iocpreactor.abstract.FileHandle.html#dataReceived
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.abstract.FileHandle.readConnectionLost
  twisted.internet.iocpreactor.abstract.FileHandle.html#readConnectionLost
  Function
  Method
  PUBLIC
  Indicates read connection was lost.
- twisted.internet.iocpreactor.abstract.FileHandle.dataBuffer
  twisted.internet.iocpreactor.abstract.FileHandle.html#dataBuffer
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.abstract.FileHandle.offset
  twisted.internet.iocpreactor.abstract.FileHandle.html#offset
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.abstract.FileHandle.writing
  twisted.internet.iocpreactor.abstract.FileHandle.html#writing
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.abstract.FileHandle._writeScheduled
  twisted.internet.iocpreactor.abstract.FileHandle.html#_writeScheduled
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.iocpreactor.abstract.FileHandle._writeDisconnecting
  twisted.internet.iocpreactor.abstract.FileHandle.html#_writeDisconnecting
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.iocpreactor.abstract.FileHandle._writeDisconnected
  twisted.internet.iocpreactor.abstract.FileHandle.html#_writeDisconnected
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.internet.iocpreactor.abstract.FileHandle.writeBufferSize
  twisted.internet.iocpreactor.abstract.FileHandle.html#writeBufferSize
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.abstract.FileHandle.loseWriteConnection
  twisted.internet.iocpreactor.abstract.FileHandle.html#loseWriteConnection
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.abstract.FileHandle._closeWriteConnection
  twisted.internet.iocpreactor.abstract.FileHandle.html#_closeWriteConnection
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet.iocpreactor.abstract.FileHandle.writeConnectionLost
  twisted.internet.iocpreactor.abstract.FileHandle.html#writeConnectionLost
  Function
  Method
  PUBLIC
  Indicates write connection was lost.
- twisted.internet.iocpreactor.abstract.FileHandle.startWriting
  twisted.internet.iocpreactor.abstract.FileHandle.html#startWriting
  Function
  Method
  PUBLIC
  Override in a subclass to cause the reactor to monitor this selectable for write events. This will be called once in `unregisterProducer` if `loseConnection` has previously been called, so that the connection can actually close.
- twisted.internet.iocpreactor.abstract.FileHandle.stopWriting
  twisted.internet.iocpreactor.abstract.FileHandle.html#stopWriting
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.abstract.FileHandle._resumeWriting
  twisted.internet.iocpreactor.abstract.FileHandle.html#_resumeWriting
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet.iocpreactor.abstract.FileHandle._cbWrite
  twisted.internet.iocpreactor.abstract.FileHandle.html#_cbWrite
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet.iocpreactor.abstract.FileHandle._handleWrite
  twisted.internet.iocpreactor.abstract.FileHandle.html#_handleWrite
  Function
  Method
  PRIVATE
  Returns false if we should stop writing for now
- twisted.internet.iocpreactor.abstract.FileHandle.doWrite
  twisted.internet.iocpreactor.abstract.FileHandle.html#doWrite
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.abstract.FileHandle._tempDataBuffer
  twisted.internet.iocpreactor.abstract.FileHandle.html#_tempDataBuffer
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.iocpreactor.abstract.FileHandle._tempDataLen
  twisted.internet.iocpreactor.abstract.FileHandle.html#_tempDataLen
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.iocpreactor.abstract.FileHandle.writeToHandle
  twisted.internet.iocpreactor.abstract.FileHandle.html#writeToHandle
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.abstract.FileHandle.write
  twisted.internet.iocpreactor.abstract.FileHandle.html#write
  Function
  Method
  PUBLIC
  Reliably write some data.
- twisted.internet.iocpreactor.abstract.FileHandle.producerPaused
  twisted.internet.iocpreactor.abstract.FileHandle.html#producerPaused
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.abstract.FileHandle.writeSequence
  twisted.internet.iocpreactor.abstract.FileHandle.html#writeSequence
  Function
  Method
  PUBLIC
  Write an iterable of byte strings to the physical connection.
- twisted.internet.iocpreactor.abstract.FileHandle.connected
  twisted.internet.iocpreactor.abstract.FileHandle.html#connected
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.abstract.FileHandle.disconnected
  twisted.internet.iocpreactor.abstract.FileHandle.html#disconnected
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.abstract.FileHandle.disconnecting
  twisted.internet.iocpreactor.abstract.FileHandle.html#disconnecting
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.abstract.FileHandle.logstr
  twisted.internet.iocpreactor.abstract.FileHandle.html#logstr
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.abstract.FileHandle.SEND_LIMIT
  twisted.internet.iocpreactor.abstract.FileHandle.html#SEND_LIMIT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.abstract.FileHandle.__init__
  twisted.internet.iocpreactor.abstract.FileHandle.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.abstract.FileHandle.reactor
  twisted.internet.iocpreactor.abstract.FileHandle.html#reactor
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.abstract.FileHandle._readBuffers
  twisted.internet.iocpreactor.abstract.FileHandle.html#_readBuffers
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.iocpreactor.abstract.FileHandle.connectionLost
  twisted.internet.iocpreactor.abstract.FileHandle.html#connectionLost
  Function
  Method
  PUBLIC
  The connection was lost.
- twisted.internet.iocpreactor.abstract.FileHandle.producer
  twisted.internet.iocpreactor.abstract.FileHandle.html#producer
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.abstract.FileHandle.getFileHandle
  twisted.internet.iocpreactor.abstract.FileHandle.html#getFileHandle
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.abstract.FileHandle.loseConnection
  twisted.internet.iocpreactor.abstract.FileHandle.html#loseConnection
  Function
  Method
  PUBLIC
  Close the connection at the next available opportunity.
- twisted.internet.iocpreactor.abstract.FileHandle.stopConsuming
  twisted.internet.iocpreactor.abstract.FileHandle.html#stopConsuming
  Function
  Method
  PUBLIC
  Stop consuming data.
- twisted.internet.iocpreactor.abstract.FileHandle.resumeProducing
  twisted.internet.iocpreactor.abstract.FileHandle.html#resumeProducing
  Function
  Method
  PUBLIC
  Resume producing data.
- twisted.internet.iocpreactor.abstract.FileHandle.pauseProducing
  twisted.internet.iocpreactor.abstract.FileHandle.html#pauseProducing
  Function
  Method
  PUBLIC
  Pause producing data.
- twisted.internet.iocpreactor.abstract.FileHandle.stopProducing
  twisted.internet.iocpreactor.abstract.FileHandle.html#stopProducing
  Function
  Method
  PUBLIC
  Stop producing data.
- twisted.internet.iocpreactor.abstract.FileHandle.getHost
  twisted.internet.iocpreactor.abstract.FileHandle.html#getHost
  Function
  Method
  PUBLIC
  Similar to getPeer, but returns an address describing this side of the connection.
- twisted.internet.iocpreactor.abstract.FileHandle.getPeer
  twisted.internet.iocpreactor.abstract.FileHandle.html#getPeer
  Function
  Method
  PUBLIC
  Get the remote address of this connection.
- twisted.internet.iocpreactor.interfaces.IReadHandle
  twisted.internet.iocpreactor.interfaces.IReadHandle.html
  Class
  Interface
  PUBLIC
  No interface docstring; 1/1 method documented
- twisted.internet.iocpreactor.interfaces.IReadHandle.readFromHandle
  twisted.internet.iocpreactor.interfaces.IReadHandle.html#readFromHandle
  Function
  Method
  PUBLIC
  Read into the given buffers from this handle.
- twisted.internet.iocpreactor.interfaces.IWriteHandle
  twisted.internet.iocpreactor.interfaces.IWriteHandle.html
  Class
  Interface
  PUBLIC
  No interface docstring; 1/1 method documented
- twisted.internet.iocpreactor.interfaces.IWriteHandle.writeToHandle
  twisted.internet.iocpreactor.interfaces.IWriteHandle.html#writeToHandle
  Function
  Method
  PUBLIC
  Write the given buffer to this handle.
- twisted.internet.iocpreactor.interfaces.IReadWriteHandle
  twisted.internet.iocpreactor.interfaces.IReadWriteHandle.html
  Class
  Interface
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.tcp.connectExErrors
  twisted.internet.iocpreactor.tcp.html#connectExErrors
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.tcp.Connection
  twisted.internet.iocpreactor.tcp.Connection.html
  Class
  Class
  PUBLIC
  No summary
- twisted.internet.iocpreactor.tcp.Connection.TLS
  twisted.internet.iocpreactor.tcp.Connection.html#TLS
  Attribute
  Constant
  PUBLIC
  `False` to indicate the connection is in normal TCP mode, `True` to indicate that TLS has been started and that operations must be routed through the `TLSMemoryBIOProtocol` instance.
- twisted.internet.iocpreactor.tcp.Connection.__init__
  twisted.internet.iocpreactor.tcp.Connection.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.tcp.Connection.socket
  twisted.internet.iocpreactor.tcp.Connection.html#socket
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.tcp.Connection.protocol
  twisted.internet.iocpreactor.tcp.Connection.html#protocol
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.tcp.Connection.getHandle
  twisted.internet.iocpreactor.tcp.Connection.html#getHandle
  Function
  Method
  PUBLIC
  Return a system- and reactor-specific handle.
- twisted.internet.iocpreactor.tcp.Connection.dataReceived
  twisted.internet.iocpreactor.tcp.Connection.html#dataReceived
  Function
  Method
  PUBLIC
  No summary
- twisted.internet.iocpreactor.tcp.Connection.readFromHandle
  twisted.internet.iocpreactor.tcp.Connection.html#readFromHandle
  Function
  Method
  PUBLIC
  Read into the given buffers from this handle.
- twisted.internet.iocpreactor.tcp.Connection.writeToHandle
  twisted.internet.iocpreactor.tcp.Connection.html#writeToHandle
  Function
  Method
  PUBLIC
  Send `buff` to current file handle using `_iocp.send`. The buffer sent is limited to a size of `self.SEND_LIMIT`.
- twisted.internet.iocpreactor.tcp.Connection._closeWriteConnection
  twisted.internet.iocpreactor.tcp.Connection.html#_closeWriteConnection
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet.iocpreactor.tcp.Connection.readConnectionLost
  twisted.internet.iocpreactor.tcp.Connection.html#readConnectionLost
  Function
  Method
  PUBLIC
  Indicates read connection was lost.
- twisted.internet.iocpreactor.tcp.Connection.connectionLost
  twisted.internet.iocpreactor.tcp.Connection.html#connectionLost
  Function
  Method
  PUBLIC
  The connection was lost.
- twisted.internet.iocpreactor.tcp.Connection.logPrefix
  twisted.internet.iocpreactor.tcp.Connection.html#logPrefix
  Function
  Method
  PUBLIC
  Return the prefix to log with when I own the logging thread.
- twisted.internet.iocpreactor.tcp.Connection.getTcpNoDelay
  twisted.internet.iocpreactor.tcp.Connection.html#getTcpNoDelay
  Function
  Method
  PUBLIC
  Return if `TCP_NODELAY` is enabled.
- twisted.internet.iocpreactor.tcp.Connection.setTcpNoDelay
  twisted.internet.iocpreactor.tcp.Connection.html#setTcpNoDelay
  Function
  Method
  PUBLIC
  Enable/disable `TCP_NODELAY`.
- twisted.internet.iocpreactor.tcp.Connection.getTcpKeepAlive
  twisted.internet.iocpreactor.tcp.Connection.html#getTcpKeepAlive
  Function
  Method
  PUBLIC
  Return if `SO_KEEPALIVE` is enabled.
- twisted.internet.iocpreactor.tcp.Connection.setTcpKeepAlive
  twisted.internet.iocpreactor.tcp.Connection.html#setTcpKeepAlive
  Function
  Method
  PUBLIC
  Enable/disable `SO_KEEPALIVE`.
- twisted.internet.iocpreactor.tcp.Connection.startTLS
  twisted.internet.iocpreactor.tcp.Connection.html#startTLS
  Function
  Method
  PUBLIC
  No summary
- twisted.internet.iocpreactor.tcp.Connection.write
  twisted.internet.iocpreactor.tcp.Connection.html#write
  Function
  Method
  PUBLIC
  Write some data, either directly to the underlying handle or, if TLS has been started, to the `TLSMemoryBIOProtocol` for it to encrypt and send.
- twisted.internet.iocpreactor.tcp.Connection.writeSequence
  twisted.internet.iocpreactor.tcp.Connection.html#writeSequence
  Function
  Method
  PUBLIC
  Write some data, either directly to the underlying handle or, if TLS has been started, to the `TLSMemoryBIOProtocol` for it to encrypt and send.
- twisted.internet.iocpreactor.tcp.Connection.loseConnection
  twisted.internet.iocpreactor.tcp.Connection.html#loseConnection
  Function
  Method
  PUBLIC
  Close the underlying handle or, if TLS has been started, first shut it down.
- twisted.internet.iocpreactor.tcp.Connection.registerProducer
  twisted.internet.iocpreactor.tcp.Connection.html#registerProducer
  Function
  Method
  PUBLIC
  Register a producer.
- twisted.internet.iocpreactor.tcp.Connection.unregisterProducer
  twisted.internet.iocpreactor.tcp.Connection.html#unregisterProducer
  Function
  Method
  PUBLIC
  Unregister a producer.
- twisted.internet.iocpreactor.tcp.Connection.getHost
  twisted.internet.iocpreactor.tcp.Connection.html#getHost
  Function
  Method
  PUBLIC
  Returns `IPv4Address` or `IPv6Address`.
- twisted.internet.iocpreactor.tcp.Connection.getPeer
  twisted.internet.iocpreactor.tcp.Connection.html#getPeer
  Function
  Method
  PUBLIC
  Returns `IPv4Address` or `IPv6Address`.
- twisted.internet.iocpreactor.tcp.Client
  twisted.internet.iocpreactor.tcp.Client.html
  Class
  Class
  PUBLIC
  No summary
- twisted.internet.iocpreactor.tcp.Client._tlsClientDefault
  twisted.internet.iocpreactor.tcp.Client.html#_tlsClientDefault
  Attribute
  Instance Variable
  PRIVATE
  Always `True`, indicating that this is a client connection, and by default when TLS is negotiated this class will act as a TLS client.
- twisted.internet.iocpreactor.tcp.Client.__init__
  twisted.internet.iocpreactor.tcp.Client.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.tcp.Client.reactor
  twisted.internet.iocpreactor.tcp.Client.html#reactor
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.tcp.Client.createInternetSocket
  twisted.internet.iocpreactor.tcp.Client.html#createInternetSocket
  Function
  Method
  PUBLIC
  Create a socket registered with the IOCP reactor.
- twisted.internet.iocpreactor.tcp.Client._collectSocketDetails
  twisted.internet.iocpreactor.tcp.Client.html#_collectSocketDetails
  Function
  Method
  PRIVATE
  Clean up potentially circular references to the socket and to its `getFileHandle` method.
- twisted.internet.iocpreactor.tcp.Client._stopReadingAndWriting
  twisted.internet.iocpreactor.tcp.Client.html#_stopReadingAndWriting
  Function
  Method
  PRIVATE
  Remove the active handle from the reactor.
- twisted.internet.iocpreactor.tcp.Client.cbConnect
  twisted.internet.iocpreactor.tcp.Client.html#cbConnect
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.tcp.Client.doConnect
  twisted.internet.iocpreactor.tcp.Client.html#doConnect
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.tcp.Server
  twisted.internet.iocpreactor.tcp.Server.html
  Class
  Class
  PUBLIC
  Serverside socket-stream connection class.
- twisted.internet.iocpreactor.tcp.Server._tlsClientDefault
  twisted.internet.iocpreactor.tcp.Server.html#_tlsClientDefault
  Attribute
  Instance Variable
  PRIVATE
  Always `False`, indicating that this is a server connection, and by default when TLS is negotiated this class will act as a TLS server.
- twisted.internet.iocpreactor.tcp.Server.__init__
  twisted.internet.iocpreactor.tcp.Server.html#__init__
  Function
  Method
  PUBLIC
  Server(sock, protocol, client, server, sessionno)
- twisted.internet.iocpreactor.tcp.Server.serverAddr
  twisted.internet.iocpreactor.tcp.Server.html#serverAddr
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.tcp.Server.clientAddr
  twisted.internet.iocpreactor.tcp.Server.html#clientAddr
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.tcp.Server.sessionno
  twisted.internet.iocpreactor.tcp.Server.html#sessionno
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.tcp.Server.logstr
  twisted.internet.iocpreactor.tcp.Server.html#logstr
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.tcp.Server.repstr
  twisted.internet.iocpreactor.tcp.Server.html#repstr
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.tcp.Server.connected
  twisted.internet.iocpreactor.tcp.Server.html#connected
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.tcp.Server.__repr__
  twisted.internet.iocpreactor.tcp.Server.html#__repr__
  Function
  Method
  PUBLIC
  A string representation of this connection.
- twisted.internet.iocpreactor.tcp.Server.getHost
  twisted.internet.iocpreactor.tcp.Server.html#getHost
  Function
  Method
  PUBLIC
  Returns an IPv4Address.
- twisted.internet.iocpreactor.tcp.Server.getPeer
  twisted.internet.iocpreactor.tcp.Server.html#getPeer
  Function
  Method
  PUBLIC
  Returns an IPv4Address.
- twisted.internet.iocpreactor.tcp.Connector
  twisted.internet.iocpreactor.tcp.Connector.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.tcp.Connector._makeTransport
  twisted.internet.iocpreactor.tcp.Connector.html#_makeTransport
  Function
  Method
  PRIVATE
  Create a `Client` bound to this `Connector`.
- twisted.internet.iocpreactor.tcp.Port
  twisted.internet.iocpreactor.tcp.Port.html
  Class
  Class
  PUBLIC
  No class docstring; 0/15 instance variable, 0/2 class variable, 5/11 methods documented
- twisted.internet.iocpreactor.tcp.Port.connected
  twisted.internet.iocpreactor.tcp.Port.html#connected
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.tcp.Port.disconnected
  twisted.internet.iocpreactor.tcp.Port.html#disconnected
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.tcp.Port.disconnecting
  twisted.internet.iocpreactor.tcp.Port.html#disconnecting
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.tcp.Port.sessionno
  twisted.internet.iocpreactor.tcp.Port.html#sessionno
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.tcp.Port._realPortNumber
  twisted.internet.iocpreactor.tcp.Port.html#_realPortNumber
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.iocpreactor.tcp.Port._type
  twisted.internet.iocpreactor.tcp.Port.html#_type
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.internet.iocpreactor.tcp.Port.__init__
  twisted.internet.iocpreactor.tcp.Port.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.tcp.Port.port
  twisted.internet.iocpreactor.tcp.Port.html#port
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.tcp.Port.factory
  twisted.internet.iocpreactor.tcp.Port.html#factory
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.tcp.Port.backlog
  twisted.internet.iocpreactor.tcp.Port.html#backlog
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.tcp.Port.interface
  twisted.internet.iocpreactor.tcp.Port.html#interface
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.tcp.Port.reactor
  twisted.internet.iocpreactor.tcp.Port.html#reactor
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.tcp.Port.addressFamily
  twisted.internet.iocpreactor.tcp.Port.html#addressFamily
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.tcp.Port._addressType
  twisted.internet.iocpreactor.tcp.Port.html#_addressType
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.iocpreactor.tcp.Port.__repr__
  twisted.internet.iocpreactor.tcp.Port.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.tcp.Port.startListening
  twisted.internet.iocpreactor.tcp.Port.html#startListening
  Function
  Method
  PUBLIC
  Start listening on this port.
- twisted.internet.iocpreactor.tcp.Port.addrLen
  twisted.internet.iocpreactor.tcp.Port.html#addrLen
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.tcp.Port.socket
  twisted.internet.iocpreactor.tcp.Port.html#socket
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.tcp.Port.getFileHandle
  twisted.internet.iocpreactor.tcp.Port.html#getFileHandle
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.tcp.Port.loseConnection
  twisted.internet.iocpreactor.tcp.Port.html#loseConnection
  Function
  Method
  PUBLIC
  Stop accepting connections on this port.
- twisted.internet.iocpreactor.tcp.Port.deferred
  twisted.internet.iocpreactor.tcp.Port.html#deferred
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.tcp.Port._logConnectionLostMsg
  twisted.internet.iocpreactor.tcp.Port.html#_logConnectionLostMsg
  Function
  Method
  PRIVATE
  Log message for closing port
- twisted.internet.iocpreactor.tcp.Port.connectionLost
  twisted.internet.iocpreactor.tcp.Port.html#connectionLost
  Function
  Method
  PUBLIC
  Cleans up the socket.
- twisted.internet.iocpreactor.tcp.Port.logPrefix
  twisted.internet.iocpreactor.tcp.Port.html#logPrefix
  Function
  Method
  PUBLIC
  Returns the name of my class, to prefix log entries with.
- twisted.internet.iocpreactor.tcp.Port.getHost
  twisted.internet.iocpreactor.tcp.Port.html#getHost
  Function
  Method
  PUBLIC
  Returns an IPv4Address or IPv6Address.
- twisted.internet.iocpreactor.tcp.Port.cbAccept
  twisted.internet.iocpreactor.tcp.Port.html#cbAccept
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.tcp.Port.handleAccept
  twisted.internet.iocpreactor.tcp.Port.html#handleAccept
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.tcp.Port.doAccept
  twisted.internet.iocpreactor.tcp.Port.html#doAccept
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.udp.Port
  twisted.internet.iocpreactor.udp.Port.html
  Class
  Class
  PUBLIC
  UDP port, listening for packets.
- twisted.internet.iocpreactor.udp.Port.addressFamily
  twisted.internet.iocpreactor.udp.Port.html#addressFamily
  Attribute
  Instance Variable
  PUBLIC
  `socket.AF_INET` or `socket.AF_INET6`, depending on whether this port is listening on an IPv4 address or an IPv6 address.
- twisted.internet.iocpreactor.udp.Port.dynamicReadBuffers
  twisted.internet.iocpreactor.udp.Port.html#dynamicReadBuffers
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.udp.Port._realPortNumber
  twisted.internet.iocpreactor.udp.Port.html#_realPortNumber
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.iocpreactor.udp.Port.__init__
  twisted.internet.iocpreactor.udp.Port.html#__init__
  Function
  Method
  PUBLIC
  Initialize with a numeric port to listen on.
- twisted.internet.iocpreactor.udp.Port.port
  twisted.internet.iocpreactor.udp.Port.html#port
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.udp.Port.protocol
  twisted.internet.iocpreactor.udp.Port.html#protocol
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.udp.Port.readBufferSize
  twisted.internet.iocpreactor.udp.Port.html#readBufferSize
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.udp.Port.interface
  twisted.internet.iocpreactor.udp.Port.html#interface
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.udp.Port._connectedAddr
  twisted.internet.iocpreactor.udp.Port.html#_connectedAddr
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.iocpreactor.udp.Port.addressBuffer
  twisted.internet.iocpreactor.udp.Port.html#addressBuffer
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.udp.Port.addressLengthBuffer
  twisted.internet.iocpreactor.udp.Port.html#addressLengthBuffer
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.udp.Port._setAddressFamily
  twisted.internet.iocpreactor.udp.Port.html#_setAddressFamily
  Function
  Method
  PRIVATE
  Resolve address family for the socket.
- twisted.internet.iocpreactor.udp.Port.__repr__
  twisted.internet.iocpreactor.udp.Port.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.udp.Port.getHandle
  twisted.internet.iocpreactor.udp.Port.html#getHandle
  Function
  Method
  PUBLIC
  Return a socket object.
- twisted.internet.iocpreactor.udp.Port.startListening
  twisted.internet.iocpreactor.udp.Port.html#startListening
  Function
  Method
  PUBLIC
  Create and bind my socket, and begin listening on it.
- twisted.internet.iocpreactor.udp.Port.createSocket
  twisted.internet.iocpreactor.udp.Port.html#createSocket
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.udp.Port._bindSocket
  twisted.internet.iocpreactor.udp.Port.html#_bindSocket
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet.iocpreactor.udp.Port.connected
  twisted.internet.iocpreactor.udp.Port.html#connected
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.udp.Port.socket
  twisted.internet.iocpreactor.udp.Port.html#socket
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.udp.Port._connectToProtocol
  twisted.internet.iocpreactor.udp.Port.html#_connectToProtocol
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet.iocpreactor.udp.Port.cbRead
  twisted.internet.iocpreactor.udp.Port.html#cbRead
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.udp.Port.handleRead
  twisted.internet.iocpreactor.udp.Port.html#handleRead
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.udp.Port.doRead
  twisted.internet.iocpreactor.udp.Port.html#doRead
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.udp.Port.write
  twisted.internet.iocpreactor.udp.Port.html#write
  Function
  Method
  PUBLIC
  Write a datagram.
- twisted.internet.iocpreactor.udp.Port.writeSequence
  twisted.internet.iocpreactor.udp.Port.html#writeSequence
  Function
  Method
  PUBLIC
  Write an iterable of byte strings to the physical connection.
- twisted.internet.iocpreactor.udp.Port.connect
  twisted.internet.iocpreactor.udp.Port.html#connect
  Function
  Method
  PUBLIC
  'Connect' to remote server.
- twisted.internet.iocpreactor.udp.Port._loseConnection
  twisted.internet.iocpreactor.udp.Port.html#_loseConnection
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet.iocpreactor.udp.Port.stopListening
  twisted.internet.iocpreactor.udp.Port.html#stopListening
  Function
  Method
  PUBLIC
  Stop listening on this port.
- twisted.internet.iocpreactor.udp.Port.d
  twisted.internet.iocpreactor.udp.Port.html#d
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.udp.Port.loseConnection
  twisted.internet.iocpreactor.udp.Port.html#loseConnection
  Function
  Method
  PUBLIC
  Close the connection at the next available opportunity.
- twisted.internet.iocpreactor.udp.Port.connectionLost
  twisted.internet.iocpreactor.udp.Port.html#connectionLost
  Function
  Method
  PUBLIC
  Cleans up my socket.
- twisted.internet.iocpreactor.udp.Port.setLogStr
  twisted.internet.iocpreactor.udp.Port.html#setLogStr
  Function
  Method
  PUBLIC
  Initialize the `logstr` attribute to be used by `logPrefix`.
- twisted.internet.iocpreactor.udp.Port.logstr
  twisted.internet.iocpreactor.udp.Port.html#logstr
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.udp.Port.logPrefix
  twisted.internet.iocpreactor.udp.Port.html#logPrefix
  Function
  Method
  PUBLIC
  Returns the name of my class, to prefix log entries with.
- twisted.internet.iocpreactor.udp.Port.getHost
  twisted.internet.iocpreactor.udp.Port.html#getHost
  Function
  Method
  PUBLIC
  Return the local address of the UDP connection
- twisted.internet.iocpreactor.udp.Port.setBroadcastAllowed
  twisted.internet.iocpreactor.udp.Port.html#setBroadcastAllowed
  Function
  Method
  PUBLIC
  Set whether this port may broadcast. This is disabled by default.
- twisted.internet.iocpreactor.udp.Port.getBroadcastAllowed
  twisted.internet.iocpreactor.udp.Port.html#getBroadcastAllowed
  Function
  Method
  PUBLIC
  Checks if broadcast is currently allowed on this port.
- twisted.internet.iocpreactor.udp.MulticastMixin
  twisted.internet.iocpreactor.udp.MulticastMixin.html
  Class
  Class
  PUBLIC
  Implement multicast functionality.
- twisted.internet.iocpreactor.udp.MulticastMixin.getOutgoingInterface
  twisted.internet.iocpreactor.udp.MulticastMixin.html#getOutgoingInterface
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.udp.MulticastMixin.setOutgoingInterface
  twisted.internet.iocpreactor.udp.MulticastMixin.html#setOutgoingInterface
  Function
  Method
  PUBLIC
  Returns Deferred of success.
- twisted.internet.iocpreactor.udp.MulticastMixin._setInterface
  twisted.internet.iocpreactor.udp.MulticastMixin.html#_setInterface
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet.iocpreactor.udp.MulticastMixin.getLoopbackMode
  twisted.internet.iocpreactor.udp.MulticastMixin.html#getLoopbackMode
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.udp.MulticastMixin.setLoopbackMode
  twisted.internet.iocpreactor.udp.MulticastMixin.html#setLoopbackMode
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.udp.MulticastMixin.getTTL
  twisted.internet.iocpreactor.udp.MulticastMixin.html#getTTL
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.udp.MulticastMixin.setTTL
  twisted.internet.iocpreactor.udp.MulticastMixin.html#setTTL
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.udp.MulticastMixin.joinGroup
  twisted.internet.iocpreactor.udp.MulticastMixin.html#joinGroup
  Function
  Method
  PUBLIC
  Join a multicast group. Returns Deferred of success.
- twisted.internet.iocpreactor.udp.MulticastMixin._joinAddr1
  twisted.internet.iocpreactor.udp.MulticastMixin.html#_joinAddr1
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet.iocpreactor.udp.MulticastMixin._joinAddr2
  twisted.internet.iocpreactor.udp.MulticastMixin.html#_joinAddr2
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet.iocpreactor.udp.MulticastMixin.leaveGroup
  twisted.internet.iocpreactor.udp.MulticastMixin.html#leaveGroup
  Function
  Method
  PUBLIC
  Leave multicast group, return Deferred of success.
- twisted.internet.iocpreactor.udp.MulticastPort
  twisted.internet.iocpreactor.udp.MulticastPort.html
  Class
  Class
  PUBLIC
  UDP Port that supports multicasting.
- twisted.internet.iocpreactor.udp.MulticastPort.__init__
  twisted.internet.iocpreactor.udp.MulticastPort.html#__init__
  Function
  Method
  PUBLIC
  Initialize with a numeric port to listen on.
- twisted.internet.iocpreactor.udp.MulticastPort.listenMultiple
  twisted.internet.iocpreactor.udp.MulticastPort.html#listenMultiple
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.udp.MulticastPort.createSocket
  twisted.internet.iocpreactor.udp.MulticastPort.html#createSocket
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.reactor.MAX_TIMEOUT
  twisted.internet.iocpreactor.reactor.html#MAX_TIMEOUT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.reactor.EVENTS_PER_LOOP
  twisted.internet.iocpreactor.reactor.html#EVENTS_PER_LOOP
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.reactor.KEY_NORMAL
  twisted.internet.iocpreactor.reactor.html#KEY_NORMAL
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.reactor.KEY_WAKEUP
  twisted.internet.iocpreactor.reactor.html#KEY_WAKEUP
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.reactor._NO_GETHANDLE
  twisted.internet.iocpreactor.reactor.html#_NO_GETHANDLE
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.internet.iocpreactor.reactor._NO_FILEDESC
  twisted.internet.iocpreactor.reactor.html#_NO_FILEDESC
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.internet.iocpreactor.reactor.IOCPReactor
  twisted.internet.iocpreactor.reactor.IOCPReactor.html
  Class
  Class
  PUBLIC
  No class docstring; 0/2 instance variable, 8/17 methods documented
- twisted.internet.iocpreactor.reactor.IOCPReactor.port
  twisted.internet.iocpreactor.reactor.IOCPReactor.html#port
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.reactor.IOCPReactor.__init__
  twisted.internet.iocpreactor.reactor.IOCPReactor.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.reactor.IOCPReactor.handles
  twisted.internet.iocpreactor.reactor.IOCPReactor.html#handles
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.reactor.IOCPReactor.addActiveHandle
  twisted.internet.iocpreactor.reactor.IOCPReactor.html#addActiveHandle
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.reactor.IOCPReactor.removeActiveHandle
  twisted.internet.iocpreactor.reactor.IOCPReactor.html#removeActiveHandle
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.reactor.IOCPReactor.doIteration
  twisted.internet.iocpreactor.reactor.IOCPReactor.html#doIteration
  Function
  Method
  PUBLIC
  Poll the IO completion port for new events.
- twisted.internet.iocpreactor.reactor.IOCPReactor._callEventCallback
  twisted.internet.iocpreactor.reactor.IOCPReactor.html#_callEventCallback
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet.iocpreactor.reactor.IOCPReactor.installWaker
  twisted.internet.iocpreactor.reactor.IOCPReactor.html#installWaker
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.reactor.IOCPReactor.wakeUp
  twisted.internet.iocpreactor.reactor.IOCPReactor.html#wakeUp
  Function
  Method
  PUBLIC
  Wake up the event loop.
- twisted.internet.iocpreactor.reactor.IOCPReactor.registerHandle
  twisted.internet.iocpreactor.reactor.IOCPReactor.html#registerHandle
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.reactor.IOCPReactor.createSocket
  twisted.internet.iocpreactor.reactor.IOCPReactor.html#createSocket
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.reactor.IOCPReactor.listenTCP
  twisted.internet.iocpreactor.reactor.IOCPReactor.html#listenTCP
  Function
  Method
  PUBLIC
  No summary
- twisted.internet.iocpreactor.reactor.IOCPReactor.connectTCP
  twisted.internet.iocpreactor.reactor.IOCPReactor.html#connectTCP
  Function
  Method
  PUBLIC
  No summary
- twisted.internet.iocpreactor.reactor.IOCPReactor.listenSSL
  twisted.internet.iocpreactor.reactor.IOCPReactor.html#listenSSL
  Function
  Method
  PUBLIC
  No summary
- twisted.internet.iocpreactor.reactor.IOCPReactor.connectSSL
  twisted.internet.iocpreactor.reactor.IOCPReactor.html#connectSSL
  Function
  Method
  PUBLIC
  No summary
- twisted.internet.iocpreactor.reactor.IOCPReactor.listenUDP
  twisted.internet.iocpreactor.reactor.IOCPReactor.html#listenUDP
  Function
  Method
  PUBLIC
  Connects a given `DatagramProtocol` to the given numeric UDP port.
- twisted.internet.iocpreactor.reactor.IOCPReactor.listenMulticast
  twisted.internet.iocpreactor.reactor.IOCPReactor.html#listenMulticast
  Function
  Method
  PUBLIC
  Connects a given DatagramProtocol to the given numeric UDP port.
- twisted.internet.iocpreactor.reactor.IOCPReactor.spawnProcess
  twisted.internet.iocpreactor.reactor.IOCPReactor.html#spawnProcess
  Function
  Method
  PUBLIC
  Spawn a process.
- twisted.internet.iocpreactor.reactor.IOCPReactor.removeAll
  twisted.internet.iocpreactor.reactor.IOCPReactor.html#removeAll
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.iocpreactor.reactor.install
  twisted.internet.iocpreactor.reactor.html#install
  Function
  Function
  PUBLIC
  Undocumented
- twisted.internet.kqreactor.KQ_EV_ADD
  twisted.internet.kqreactor.html#KQ_EV_ADD
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.kqreactor.KQ_EV_DELETE
  twisted.internet.kqreactor.html#KQ_EV_DELETE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.kqreactor.KQ_EV_EOF
  twisted.internet.kqreactor.html#KQ_EV_EOF
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.kqreactor.KQ_FILTER_READ
  twisted.internet.kqreactor.html#KQ_FILTER_READ
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.kqreactor.KQ_FILTER_WRITE
  twisted.internet.kqreactor.html#KQ_FILTER_WRITE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.internet.kqreactor._IKQueue
  twisted.internet.kqreactor._IKQueue.html
  Class
  Interface
  PRIVATE
  An interface for KQueue implementations.
- twisted.internet.kqreactor._IKQueue.kqueue
  twisted.internet.kqreactor._IKQueue.html#kqueue
  Attribute
  Attribute
  PUBLIC
  An implementation of kqueue(2).
- twisted.internet.kqreactor._IKQueue.kevent
  twisted.internet.kqreactor._IKQueue.html#kevent
  Attribute
  Attribute
  PUBLIC
  An implementation of kevent(2).
- twisted.internet.kqreactor.KQueueReactor
  twisted.internet.kqreactor.KQueueReactor.html
  Class
  Class
  PUBLIC
  A reactor that uses kqueue(2)/kevent(2) and relies on Python 2.6 or higher which has built in support for kqueue in the select module.
- twisted.internet.kqreactor.KQueueReactor._kq
  twisted.internet.kqreactor.KQueueReactor.html#_kq
  Attribute
  Instance Variable
  PRIVATE
  A `kqueue` which will be used to check for I/O readiness.
- twisted.internet.kqreactor.KQueueReactor._impl
  twisted.internet.kqreactor.KQueueReactor.html#_impl
  Attribute
  Instance Variable
  PRIVATE
  The implementation of `_IKQueue` to use.
- twisted.internet.kqreactor.KQueueReactor._selectables
  twisted.internet.kqreactor.KQueueReactor.html#_selectables
  Attribute
  Instance Variable
  PRIVATE
  A dictionary mapping integer file descriptors to instances of `FileDescriptor` which have been registered with the reactor. All `FileDescriptor`s which are currently receiving read or write readiness notifications will be present as values in this dictionary.
- twisted.internet.kqreactor.KQueueReactor._reads
  twisted.internet.kqreactor.KQueueReactor.html#_reads
  Attribute
  Instance Variable
  PRIVATE
  A set containing integer file descriptors. Values in this set will be registered with `_kq` for read readiness notifications which will be dispatched to the corresponding `FileDescriptor` instances in `_selectables`...
- twisted.internet.kqreactor.KQueueReactor._writes
  twisted.internet.kqreactor.KQueueReactor.html#_writes
  Attribute
  Instance Variable
  PRIVATE
  A set containing integer file descriptors. Values in this set will be registered with `_kq` for write readiness notifications which will be dispatched to the corresponding `FileDescriptor` instances in `_selectables`...
- twisted.internet.kqreactor.KQueueReactor.__init__
  twisted.internet.kqreactor.KQueueReactor.html#__init__
  Function
  Method
  PUBLIC
  Initialize kqueue object, file descriptor tracking dictionaries, and the base class.
- twisted.internet.kqreactor.KQueueReactor._updateRegistration
  twisted.internet.kqreactor.KQueueReactor.html#_updateRegistration
  Function
  Method
  PRIVATE
  Private method for changing kqueue registration on a given FD filtering for events given filter/op. This will never block and returns nothing.
- twisted.internet.kqreactor.KQueueReactor.beforeDaemonize
  twisted.internet.kqreactor.KQueueReactor.html#beforeDaemonize
  Function
  Method
  PUBLIC
  Implement `IReactorDaemonize.beforeDaemonize`.
- twisted.internet.kqreactor.KQueueReactor.afterDaemonize
  twisted.internet.kqreactor.KQueueReactor.html#afterDaemonize
  Function
  Method
  PUBLIC
  Implement `IReactorDaemonize.afterDaemonize`.
- twisted.internet.kqreactor.KQueueReactor.addReader
  twisted.internet.kqreactor.KQueueReactor.html#addReader
  Function
  Method
  PUBLIC
  Implement `IReactorFDSet.addReader`.
- twisted.internet.kqreactor.KQueueReactor.addWriter
  twisted.internet.kqreactor.KQueueReactor.html#addWriter
  Function
  Method
  PUBLIC
  Implement `IReactorFDSet.addWriter`.
- twisted.internet.kqreactor.KQueueReactor.removeReader
  twisted.internet.kqreactor.KQueueReactor.html#removeReader
  Function
  Method
  PUBLIC
  Implement `IReactorFDSet.removeReader`.
- twisted.internet.kqreactor.KQueueReactor.removeWriter
  twisted.internet.kqreactor.KQueueReactor.html#removeWriter
  Function
  Method
  PUBLIC
  Implement `IReactorFDSet.removeWriter`.
- twisted.internet.kqreactor.KQueueReactor.removeAll
  twisted.internet.kqreactor.KQueueReactor.html#removeAll
  Function
  Method
  PUBLIC
  Implement `IReactorFDSet.removeAll`.
- twisted.internet.kqreactor.KQueueReactor.getReaders
  twisted.internet.kqreactor.KQueueReactor.html#getReaders
  Function
  Method
  PUBLIC
  Implement `IReactorFDSet.getReaders`.
- twisted.internet.kqreactor.KQueueReactor.getWriters
  twisted.internet.kqreactor.KQueueReactor.html#getWriters
  Function
  Method
  PUBLIC
  Implement `IReactorFDSet.getWriters`.
- twisted.internet.kqreactor.KQueueReactor.doKEvent
  twisted.internet.kqreactor.KQueueReactor.html#doKEvent
  Function
  Method
  PUBLIC
  Poll the kqueue for new events.
- twisted.internet.kqreactor.KQueueReactor._doWriteOrRead
  twisted.internet.kqreactor.KQueueReactor.html#_doWriteOrRead
  Function
  Method
  PRIVATE
  Private method called when a FD is ready for reading, writing or was lost. Do the work and raise errors where necessary.
- twisted.internet.kqreactor.install
  twisted.internet.kqreactor.html#install
  Function
  Function
  PUBLIC
  Install the kqueue() reactor.
- twisted.internet.pollreactor.PollReactor
  twisted.internet.pollreactor.PollReactor.html
  Class
  Class
  PUBLIC
  A reactor that uses poll(2).
- twisted.internet.pollreactor.PollReactor._poller
  twisted.internet.pollreactor.PollReactor.html#_poller
  Attribute
  Instance Variable
  PRIVATE
  A `select.poll` which will be used to check for I/O readiness.
- twisted.internet.pollreactor.PollReactor._selectables
  twisted.internet.pollreactor.PollReactor.html#_selectables
  Attribute
  Instance Variable
  PRIVATE
  A dictionary mapping integer file descriptors to instances of `FileDescriptor` which have been registered with the reactor. All `FileDescriptor`s which are currently receiving read or write readiness notifications will be present as values in this dictionary.
- twisted.internet.pollreactor.PollReactor._reads
  twisted.internet.pollreactor.PollReactor.html#_reads
  Attribute
  Instance Variable
  PRIVATE
  A dictionary mapping integer file descriptors to arbitrary values (this is essentially a set). Keys in this dictionary will be registered with `_poller` for read readiness notifications which will be dispatched to the corresponding ...
- twisted.internet.pollreactor.PollReactor._writes
  twisted.internet.pollreactor.PollReactor.html#_writes
  Attribute
  Instance Variable
  PRIVATE
  A dictionary mapping integer file descriptors to arbitrary values (this is essentially a set). Keys in this dictionary will be registered with `_poller` for write readiness notifications which will be dispatched to the corresponding ...
- twisted.internet.pollreactor.PollReactor._POLL_DISCONNECTED
  twisted.internet.pollreactor.PollReactor.html#_POLL_DISCONNECTED
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.internet.pollreactor.PollReactor.__init__
  twisted.internet.pollreactor.PollReactor.html#__init__
  Function
  Method
  PUBLIC
  Initialize polling object, file descriptor tracking dictionaries, and the base class.
- twisted.internet.pollreactor.PollReactor._updateRegistration
  twisted.internet.pollreactor.PollReactor.html#_updateRegistration
  Function
  Method
  PRIVATE
  Register/unregister an fd with the poller.
- twisted.internet.pollreactor.PollReactor._dictRemove
  twisted.internet.pollreactor.PollReactor.html#_dictRemove
  Function
  Method
  PRIVATE
  Undocumented
- twisted.internet.pollreactor.PollReactor.addReader
  twisted.internet.pollreactor.PollReactor.html#addReader
  Function
  Method
  PUBLIC
  Add a FileDescriptor for notification of data available to read.
- twisted.internet.pollreactor.PollReactor.addWriter
  twisted.internet.pollreactor.PollReactor.html#addWriter
  Function
  Method
  PUBLIC
  Add a FileDescriptor for notification of data available to write.
- twisted.internet.pollreactor.PollReactor.removeReader
  twisted.internet.pollreactor.PollReactor.html#removeReader
  Function
  Method
  PUBLIC
  Remove a Selectable for notification of data available to read.
- twisted.internet.pollreactor.PollReactor.removeWriter
  twisted.internet.pollreactor.PollReactor.html#removeWriter
  Function
  Method
  PUBLIC
  Remove a Selectable for notification of data available to write.
- twisted.internet.pollreactor.PollReactor.removeAll
  twisted.internet.pollreactor.PollReactor.html#removeAll
  Function
  Method
  PUBLIC
  Remove all selectables, and return a list of them.
- twisted.internet.pollreactor.PollReactor.doPoll
  twisted.internet.pollreactor.PollReactor.html#doPoll
  Function
  Method
  PUBLIC
  Poll the poller for new events.
- twisted.internet.pollreactor.PollReactor.getReaders
  twisted.internet.pollreactor.PollReactor.html#getReaders
  Function
  Method
  PUBLIC
  Return the list of file descriptors currently monitored for input events by the reactor.
- twisted.internet.pollreactor.PollReactor.getWriters
  twisted.internet.pollreactor.PollReactor.html#getWriters
  Function
  Method
  PUBLIC
  Return the list file descriptors currently monitored for output events by the reactor.
- twisted.internet.pollreactor.install
  twisted.internet.pollreactor.html#install
  Function
  Function
  PUBLIC
  Install the poll() reactor.
- twisted.internet.pyuisupport._guiUpdate
  twisted.internet.pyuisupport.html#_guiUpdate
  Function
  Function
  PRIVATE
  Undocumented
- twisted.internet.pyuisupport.install
  twisted.internet.pyuisupport.html#install
  Function
  Function
  PUBLIC
  Schedule PyUI's display to be updated approximately every `ms` milliseconds, and initialize PyUI with the specified arguments.
- twisted.internet.wxreactor.ProcessEventsTimer
  twisted.internet.wxreactor.ProcessEventsTimer.html
  Class
  Class
  PUBLIC
  Timer that tells wx to process pending events.
- twisted.internet.wxreactor.ProcessEventsTimer.__init__
  twisted.internet.wxreactor.ProcessEventsTimer.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.wxreactor.ProcessEventsTimer.wxapp
  twisted.internet.wxreactor.ProcessEventsTimer.html#wxapp
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.wxreactor.ProcessEventsTimer.Notify
  twisted.internet.wxreactor.ProcessEventsTimer.html#Notify
  Function
  Method
  PUBLIC
  Called repeatedly by wx event loop.
- twisted.internet.wxreactor.WxReactor
  twisted.internet.wxreactor.WxReactor.html
  Class
  Class
  PUBLIC
  wxPython reactor.
- twisted.internet.wxreactor.WxReactor._stopping
  twisted.internet.wxreactor.WxReactor.html#_stopping
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.wxreactor.WxReactor.registerWxApp
  twisted.internet.wxreactor.WxReactor.html#registerWxApp
  Function
  Method
  PUBLIC
  Register wxApp instance with the reactor.
- twisted.internet.wxreactor.WxReactor.wxapp
  twisted.internet.wxreactor.WxReactor.html#wxapp
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.wxreactor.WxReactor._installSignalHandlersAgain
  twisted.internet.wxreactor.WxReactor.html#_installSignalHandlersAgain
  Function
  Method
  PRIVATE
  wx sometimes removes our own signal handlers, so re-add them.
- twisted.internet.wxreactor.WxReactor.stop
  twisted.internet.wxreactor.WxReactor.html#stop
  Function
  Method
  PUBLIC
  Stop the reactor.
- twisted.internet.wxreactor.WxReactor._runInMainThread
  twisted.internet.wxreactor.WxReactor.html#_runInMainThread
  Function
  Method
  PRIVATE
  Schedule function to run in main wx/Twisted thread.
- twisted.internet.wxreactor.WxReactor._stopWx
  twisted.internet.wxreactor.WxReactor.html#_stopWx
  Function
  Method
  PRIVATE
  Stop the wx event loop if it hasn't already been stopped.
- twisted.internet.wxreactor.WxReactor.run
  twisted.internet.wxreactor.WxReactor.html#run
  Function
  Method
  PUBLIC
  Start the reactor.
- twisted.internet.wxreactor.WxReactor._postQueue
  twisted.internet.wxreactor.WxReactor.html#_postQueue
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.internet.wxreactor.install
  twisted.internet.wxreactor.html#install
  Function
  Function
  PUBLIC
  Configure the twisted mainloop to be run inside the wxPython mainloop.
- twisted.internet.wxsupport.wxRunner
  twisted.internet.wxsupport.wxRunner.html
  Class
  Class
  PUBLIC
  Make sure GUI events are handled.
- twisted.internet.wxsupport.wxRunner.__init__
  twisted.internet.wxsupport.wxRunner.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.internet.wxsupport.wxRunner.app
  twisted.internet.wxsupport.wxRunner.html#app
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.internet.wxsupport.wxRunner.run
  twisted.internet.wxsupport.wxRunner.html#run
  Function
  Method
  PUBLIC
  Execute pending WX events followed by WX idle events and reschedule.
- twisted.internet.wxsupport.install
  twisted.internet.wxsupport.html#install
  Function
  Function
  PUBLIC
  Install the wxPython support, given a wxApp instance
- twisted.logger._util.formatTrace
  twisted.logger._util.html#formatTrace
  Function
  Function
  PUBLIC
  Format a trace (that is, the contents of the `log_trace` key of a log event) as a visual indication of the message's propagation through various observers.
- twisted.mail._except._POP3MessageDeleted
  twisted.mail._except._POP3MessageDeleted.html
  Class
  Exception
  PRIVATE
  An internal control-flow error which indicates that a deleted message was requested.
- twisted.mail.interfaces.IChallengeResponse
  twisted.mail.interfaces.IChallengeResponse.html
  Class
  Interface
  PUBLIC
  An `IMAPrev4` authorization challenge mechanism.
- twisted.mail.interfaces.IChallengeResponse.getChallenge
  twisted.mail.interfaces.IChallengeResponse.html#getChallenge
  Function
  Method
  PUBLIC
  Return a client challenge.
- twisted.mail.interfaces.IChallengeResponse.setResponse
  twisted.mail.interfaces.IChallengeResponse.html#setResponse
  Function
  Method
  PUBLIC
  Extract a username and possibly a password from a response and assign them to `username` and `password` instance variables.
- twisted.mail.interfaces.IChallengeResponse.moreChallenges
  twisted.mail.interfaces.IChallengeResponse.html#moreChallenges
  Function
  Method
  PUBLIC
  Are there more challenges than just the first? If so, callers should challenge clients with the result of `getChallenge`, and check their response with `setResponse` in a loop until this returns `False`
- twisted.mail.interfaces.IClientAuthentication
  twisted.mail.interfaces.IClientAuthentication.html
  Class
  Interface
  PUBLIC
  No interface docstring; 2/2 methods documented
- twisted.mail.interfaces.IClientAuthentication.getName
  twisted.mail.interfaces.IClientAuthentication.html#getName
  Function
  Method
  PUBLIC
  Return an identifier associated with this authentication scheme.
- twisted.mail.interfaces.IClientAuthentication.challengeResponse
  twisted.mail.interfaces.IClientAuthentication.html#challengeResponse
  Function
  Method
  PUBLIC
  Generate a challenge response string.
- twisted.mail.interfaces.IServerFactoryPOP3
  twisted.mail.interfaces.IServerFactoryPOP3.html
  Class
  Interface
  PUBLIC
  An interface for querying capabilities of a POP3 server.
- twisted.mail.interfaces.IServerFactoryPOP3.challengers
  twisted.mail.interfaces.IServerFactoryPOP3.html#challengers
  Attribute
  Instance Variable
  PUBLIC
  A mapping of challenger names to `IUsernameHashedPassword` provider.
- twisted.mail.interfaces.IServerFactoryPOP3.cap_IMPLEMENTATION
  twisted.mail.interfaces.IServerFactoryPOP3.html#cap_IMPLEMENTATION
  Function
  Method
  PUBLIC
  Return a string describing the POP3 server implementation.
- twisted.mail.interfaces.IServerFactoryPOP3.cap_EXPIRE
  twisted.mail.interfaces.IServerFactoryPOP3.html#cap_EXPIRE
  Function
  Method
  PUBLIC
  Return the minimum number of days messages are retained.
- twisted.mail.interfaces.IServerFactoryPOP3.perUserExpiration
  twisted.mail.interfaces.IServerFactoryPOP3.html#perUserExpiration
  Function
  Method
  PUBLIC
  Indicate whether the message expiration policy differs per user.
- twisted.mail.interfaces.IServerFactoryPOP3.cap_LOGIN_DELAY
  twisted.mail.interfaces.IServerFactoryPOP3.html#cap_LOGIN_DELAY
  Function
  Method
  PUBLIC
  Return the minimum number of seconds between client logins.
- twisted.mail.interfaces.IServerFactoryPOP3.perUserLoginDelay
  twisted.mail.interfaces.IServerFactoryPOP3.html#perUserLoginDelay
  Function
  Method
  PUBLIC
  Indicate whether the login delay period differs per user.
- twisted.mail.interfaces.IMailboxPOP3
  twisted.mail.interfaces.IMailboxPOP3.html
  Class
  Interface
  PUBLIC
  An interface for mailbox access.
- twisted.mail.interfaces.IMailboxPOP3.loginDelay
  twisted.mail.interfaces.IMailboxPOP3.html#loginDelay
  Attribute
  Instance Variable
  PUBLIC
  The number of seconds between allowed logins for the user associated with this mailbox.
- twisted.mail.interfaces.IMailboxPOP3.messageExpiration
  twisted.mail.interfaces.IMailboxPOP3.html#messageExpiration
  Attribute
  Instance Variable
  PUBLIC
  The number of days messages in this mailbox will remain on the server before being deleted.
- twisted.mail.interfaces.IMailboxPOP3.listMessages
  twisted.mail.interfaces.IMailboxPOP3.html#listMessages
  Function
  Method
  PUBLIC
  Retrieve the size of a message, or, if none is specified, the size of each message in the mailbox.
- twisted.mail.interfaces.IMailboxPOP3.getMessage
  twisted.mail.interfaces.IMailboxPOP3.html#getMessage
  Function
  Method
  PUBLIC
  Retrieve a file containing the contents of a message.
- twisted.mail.interfaces.IMailboxPOP3.getUidl
  twisted.mail.interfaces.IMailboxPOP3.html#getUidl
  Function
  Method
  PUBLIC
  Get a unique identifier for a message.
- twisted.mail.interfaces.IMailboxPOP3.deleteMessage
  twisted.mail.interfaces.IMailboxPOP3.html#deleteMessage
  Function
  Method
  PUBLIC
  Mark a message for deletion.
- twisted.mail.interfaces.IMailboxPOP3.undeleteMessages
  twisted.mail.interfaces.IMailboxPOP3.html#undeleteMessages
  Function
  Method
  PUBLIC
  Undelete all messages marked for deletion.
- twisted.mail.interfaces.IMailboxPOP3.sync
  twisted.mail.interfaces.IMailboxPOP3.html#sync
  Function
  Method
  PUBLIC
  Discard the contents of any message marked for deletion.
- twisted.mail.interfaces.IDomain
  twisted.mail.interfaces.IDomain.html
  Class
  Interface
  PUBLIC
  An interface for email domains.
- twisted.mail.interfaces.IDomain.exists
  twisted.mail.interfaces.IDomain.html#exists
  Function
  Method
  PUBLIC
  Check whether a user exists in this domain.
- twisted.mail.interfaces.IDomain.addUser
  twisted.mail.interfaces.IDomain.html#addUser
  Function
  Method
  PUBLIC
  Add a user to this domain.
- twisted.mail.interfaces.IDomain.getCredentialsCheckers
  twisted.mail.interfaces.IDomain.html#getCredentialsCheckers
  Function
  Method
  PUBLIC
  Return credentials checkers for this domain.
- twisted.mail.interfaces.IAlias
  twisted.mail.interfaces.IAlias.html
  Class
  Interface
  PUBLIC
  An interface for aliases.
- twisted.mail.interfaces.IAlias.createMessageReceiver
  twisted.mail.interfaces.IAlias.html#createMessageReceiver
  Function
  Method
  PUBLIC
  Create a message receiver.
- twisted.mail.interfaces.IAliasableDomain
  twisted.mail.interfaces.IAliasableDomain.html
  Class
  Interface
  PUBLIC
  An interface for email domains which can be aliased to other domains.
- twisted.mail.interfaces.IAliasableDomain.setAliasGroup
  twisted.mail.interfaces.IAliasableDomain.html#setAliasGroup
  Function
  Method
  PUBLIC
  Set the group of defined aliases for this domain.
- twisted.mail.interfaces.IAliasableDomain.exists
  twisted.mail.interfaces.IAliasableDomain.html#exists
  Function
  Method
  PUBLIC
  Check whether a user exists in this domain or an alias of it.
- twisted.mail.interfaces.IMessageDelivery
  twisted.mail.interfaces.IMessageDelivery.html
  Class
  Interface
  PUBLIC
  No interface docstring; 3/3 methods documented
- twisted.mail.interfaces.IMessageDelivery.receivedHeader
  twisted.mail.interfaces.IMessageDelivery.html#receivedHeader
  Function
  Method
  PUBLIC
  Generate the Received header for a message.
- twisted.mail.interfaces.IMessageDelivery.validateTo
  twisted.mail.interfaces.IMessageDelivery.html#validateTo
  Function
  Method
  PUBLIC
  Validate the address for which the message is destined.
- twisted.mail.interfaces.IMessageDelivery.validateFrom
  twisted.mail.interfaces.IMessageDelivery.html#validateFrom
  Function
  Method
  PUBLIC
  Validate the address from which the message originates.
- twisted.mail.interfaces.IMessageDeliveryFactory
  twisted.mail.interfaces.IMessageDeliveryFactory.html
  Class
  Interface
  PUBLIC
  An alternate interface to implement for handling message delivery.
- twisted.mail.interfaces.IMessageDeliveryFactory.getMessageDelivery
  twisted.mail.interfaces.IMessageDeliveryFactory.html#getMessageDelivery
  Function
  Method
  PUBLIC
  Return an `IMessageDelivery` object.
- twisted.mail.interfaces.IMessageSMTP
  twisted.mail.interfaces.IMessageSMTP.html
  Class
  Interface
  PUBLIC
  Interface definition for messages that can be sent via SMTP.
- twisted.mail.interfaces.IMessageSMTP.lineReceived
  twisted.mail.interfaces.IMessageSMTP.html#lineReceived
  Function
  Method
  PUBLIC
  Handle another line.
- twisted.mail.interfaces.IMessageSMTP.eomReceived
  twisted.mail.interfaces.IMessageSMTP.html#eomReceived
  Function
  Method
  PUBLIC
  Handle end of message.
- twisted.mail.interfaces.IMessageSMTP.connectionLost
  twisted.mail.interfaces.IMessageSMTP.html#connectionLost
  Function
  Method
  PUBLIC
  Handle message truncated.
- twisted.mail.interfaces.IMessageIMAPPart
  twisted.mail.interfaces.IMessageIMAPPart.html
  Class
  Interface
  PUBLIC
  No interface docstring; 5/5 methods documented
- twisted.mail.interfaces.IMessageIMAPPart.getHeaders
  twisted.mail.interfaces.IMessageIMAPPart.html#getHeaders
  Function
  Method
  PUBLIC
  Retrieve a group of message headers.
- twisted.mail.interfaces.IMessageIMAPPart.getBodyFile
  twisted.mail.interfaces.IMessageIMAPPart.html#getBodyFile
  Function
  Method
  PUBLIC
  Retrieve a file object containing only the body of this message.
- twisted.mail.interfaces.IMessageIMAPPart.getSize
  twisted.mail.interfaces.IMessageIMAPPart.html#getSize
  Function
  Method
  PUBLIC
  Retrieve the total size, in octets, of this message.
- twisted.mail.interfaces.IMessageIMAPPart.isMultipart
  twisted.mail.interfaces.IMessageIMAPPart.html#isMultipart
  Function
  Method
  PUBLIC
  Indicate whether this message has subparts.
- twisted.mail.interfaces.IMessageIMAPPart.getSubPart
  twisted.mail.interfaces.IMessageIMAPPart.html#getSubPart
  Function
  Method
  PUBLIC
  Retrieve a MIME sub-message
- twisted.mail.interfaces.IMessageIMAP
  twisted.mail.interfaces.IMessageIMAP.html
  Class
  Interface
  PUBLIC
  No interface docstring; 3/3 methods documented
- twisted.mail.interfaces.IMessageIMAP.getUID
  twisted.mail.interfaces.IMessageIMAP.html#getUID
  Function
  Method
  PUBLIC
  Retrieve the unique identifier associated with this message.
- twisted.mail.interfaces.IMessageIMAP.getFlags
  twisted.mail.interfaces.IMessageIMAP.html#getFlags
  Function
  Method
  PUBLIC
  Retrieve the flags associated with this message.
- twisted.mail.interfaces.IMessageIMAP.getInternalDate
  twisted.mail.interfaces.IMessageIMAP.html#getInternalDate
  Function
  Method
  PUBLIC
  Retrieve the date internally associated with this message.
- twisted.mail.interfaces.IMessageIMAPFile
  twisted.mail.interfaces.IMessageIMAPFile.html
  Class
  Interface
  PUBLIC
  Optional message interface for representing messages as files.
- twisted.mail.interfaces.IMessageIMAPFile.open
  twisted.mail.interfaces.IMessageIMAPFile.html#open
  Function
  Method
  PUBLIC
  Return a file-like object opened for reading.
- twisted.mail.interfaces.ISearchableIMAPMailbox
  twisted.mail.interfaces.ISearchableIMAPMailbox.html
  Class
  Interface
  PUBLIC
  No interface docstring; 1/1 method documented
- twisted.mail.interfaces.ISearchableIMAPMailbox.search
  twisted.mail.interfaces.ISearchableIMAPMailbox.html#search
  Function
  Method
  PUBLIC
  Search for messages that meet the given query criteria.
- twisted.mail.interfaces.IMailboxIMAPListener
  twisted.mail.interfaces.IMailboxIMAPListener.html
  Class
  Interface
  PUBLIC
  Interface for objects interested in mailbox events
- twisted.mail.interfaces.IMailboxIMAPListener.modeChanged
  twisted.mail.interfaces.IMailboxIMAPListener.html#modeChanged
  Function
  Method
  PUBLIC
  Indicates that the write status of a mailbox has changed.
- twisted.mail.interfaces.IMailboxIMAPListener.flagsChanged
  twisted.mail.interfaces.IMailboxIMAPListener.html#flagsChanged
  Function
  Method
  PUBLIC
  Indicates that the flags of one or more messages have changed.
- twisted.mail.interfaces.IMailboxIMAPListener.newMessages
  twisted.mail.interfaces.IMailboxIMAPListener.html#newMessages
  Function
  Method
  PUBLIC
  Indicates that the number of messages in a mailbox has changed.
- twisted.mail.interfaces.IMessageIMAPCopier
  twisted.mail.interfaces.IMessageIMAPCopier.html
  Class
  Interface
  PUBLIC
  No interface docstring; 1/1 method documented
- twisted.mail.interfaces.IMessageIMAPCopier.copy
  twisted.mail.interfaces.IMessageIMAPCopier.html#copy
  Function
  Method
  PUBLIC
  Copy the given message object into this mailbox.
- twisted.mail.interfaces.IMailboxIMAPInfo
  twisted.mail.interfaces.IMailboxIMAPInfo.html
  Class
  Interface
  PUBLIC
  Interface specifying only the methods required for `listMailboxes`.
- twisted.mail.interfaces.IMailboxIMAPInfo.getFlags
  twisted.mail.interfaces.IMailboxIMAPInfo.html#getFlags
  Function
  Method
  PUBLIC
  Return the flags defined in this mailbox
- twisted.mail.interfaces.IMailboxIMAPInfo.getHierarchicalDelimiter
  twisted.mail.interfaces.IMailboxIMAPInfo.html#getHierarchicalDelimiter
  Function
  Method
  PUBLIC
  Get the character which delimits namespaces for in this mailbox.
- twisted.mail.interfaces.IMailboxIMAP
  twisted.mail.interfaces.IMailboxIMAP.html
  Class
  Interface
  PUBLIC
  No interface docstring; 15/15 methods documented
- twisted.mail.interfaces.IMailboxIMAP.getUIDValidity
  twisted.mail.interfaces.IMailboxIMAP.html#getUIDValidity
  Function
  Method
  PUBLIC
  Return the unique validity identifier for this mailbox.
- twisted.mail.interfaces.IMailboxIMAP.getUIDNext
  twisted.mail.interfaces.IMailboxIMAP.html#getUIDNext
  Function
  Method
  PUBLIC
  Return the likely UID for the next message added to this mailbox.
- twisted.mail.interfaces.IMailboxIMAP.getUID
  twisted.mail.interfaces.IMailboxIMAP.html#getUID
  Function
  Method
  PUBLIC
  Return the UID of a message in the mailbox
- twisted.mail.interfaces.IMailboxIMAP.getMessageCount
  twisted.mail.interfaces.IMailboxIMAP.html#getMessageCount
  Function
  Method
  PUBLIC
  Return the number of messages in this mailbox.
- twisted.mail.interfaces.IMailboxIMAP.getRecentCount
  twisted.mail.interfaces.IMailboxIMAP.html#getRecentCount
  Function
  Method
  PUBLIC
  Return the number of messages with the 'Recent' flag.
- twisted.mail.interfaces.IMailboxIMAP.getUnseenCount
  twisted.mail.interfaces.IMailboxIMAP.html#getUnseenCount
  Function
  Method
  PUBLIC
  Return the number of messages with the 'Unseen' flag.
- twisted.mail.interfaces.IMailboxIMAP.isWriteable
  twisted.mail.interfaces.IMailboxIMAP.html#isWriteable
  Function
  Method
  PUBLIC
  Get the read/write status of the mailbox.
- twisted.mail.interfaces.IMailboxIMAP.destroy
  twisted.mail.interfaces.IMailboxIMAP.html#destroy
  Function
  Method
  PUBLIC
  Called before this mailbox is deleted, permanently.
- twisted.mail.interfaces.IMailboxIMAP.requestStatus
  twisted.mail.interfaces.IMailboxIMAP.html#requestStatus
  Function
  Method
  PUBLIC
  Return status information about this mailbox.
- twisted.mail.interfaces.IMailboxIMAP.addListener
  twisted.mail.interfaces.IMailboxIMAP.html#addListener
  Function
  Method
  PUBLIC
  Add a mailbox change listener
- twisted.mail.interfaces.IMailboxIMAP.removeListener
  twisted.mail.interfaces.IMailboxIMAP.html#removeListener
  Function
  Method
  PUBLIC
  Remove a mailbox change listener
- twisted.mail.interfaces.IMailboxIMAP.addMessage
  twisted.mail.interfaces.IMailboxIMAP.html#addMessage
  Function
  Method
  PUBLIC
  Add the given message to this mailbox.
- twisted.mail.interfaces.IMailboxIMAP.expunge
  twisted.mail.interfaces.IMailboxIMAP.html#expunge
  Function
  Method
  PUBLIC
  Remove all messages flagged \Deleted.
- twisted.mail.interfaces.IMailboxIMAP.fetch
  twisted.mail.interfaces.IMailboxIMAP.html#fetch
  Function
  Method
  PUBLIC
  Retrieve one or more messages.
- twisted.mail.interfaces.IMailboxIMAP.store
  twisted.mail.interfaces.IMailboxIMAP.html#store
  Function
  Method
  PUBLIC
  Set the flags of one or more messages.
- twisted.mail.interfaces.ICloseableMailboxIMAP
  twisted.mail.interfaces.ICloseableMailboxIMAP.html
  Class
  Interface
  PUBLIC
  A supplementary interface for mailboxes which require cleanup on close.
- twisted.mail.interfaces.ICloseableMailboxIMAP.close
  twisted.mail.interfaces.ICloseableMailboxIMAP.html#close
  Function
  Method
  PUBLIC
  Close this mailbox.
- twisted.mail.interfaces.IAccountIMAP
  twisted.mail.interfaces.IAccountIMAP.html
  Class
  Interface
  PUBLIC
  Interface for Account classes
- twisted.mail.interfaces.IAccountIMAP.addMailbox
  twisted.mail.interfaces.IAccountIMAP.html#addMailbox
  Function
  Method
  PUBLIC
  Add a new mailbox to this account
- twisted.mail.interfaces.IAccountIMAP.create
  twisted.mail.interfaces.IAccountIMAP.html#create
  Function
  Method
  PUBLIC
  Create a new mailbox from the given hierarchical name.
- twisted.mail.interfaces.IAccountIMAP.select
  twisted.mail.interfaces.IAccountIMAP.html#select
  Function
  Method
  PUBLIC
  Acquire a mailbox, given its name.
- twisted.mail.interfaces.IAccountIMAP.delete
  twisted.mail.interfaces.IAccountIMAP.html#delete
  Function
  Method
  PUBLIC
  Delete the mailbox with the specified name.
- twisted.mail.interfaces.IAccountIMAP.rename
  twisted.mail.interfaces.IAccountIMAP.html#rename
  Function
  Method
  PUBLIC
  Rename a mailbox
- twisted.mail.interfaces.IAccountIMAP.isSubscribed
  twisted.mail.interfaces.IAccountIMAP.html#isSubscribed
  Function
  Method
  PUBLIC
  Check the subscription status of a mailbox
- twisted.mail.interfaces.IAccountIMAP.subscribe
  twisted.mail.interfaces.IAccountIMAP.html#subscribe
  Function
  Method
  PUBLIC
  Subscribe to a mailbox
- twisted.mail.interfaces.IAccountIMAP.unsubscribe
  twisted.mail.interfaces.IAccountIMAP.html#unsubscribe
  Function
  Method
  PUBLIC
  Unsubscribe from a mailbox
- twisted.mail.interfaces.IAccountIMAP.listMailboxes
  twisted.mail.interfaces.IAccountIMAP.html#listMailboxes
  Function
  Method
  PUBLIC
  List all the mailboxes that meet a certain criteria
- twisted.mail.interfaces.INamespacePresenter
  twisted.mail.interfaces.INamespacePresenter.html
  Class
  Interface
  PUBLIC
  No interface docstring; 3/3 methods documented
- twisted.mail.interfaces.INamespacePresenter.getPersonalNamespaces
  twisted.mail.interfaces.INamespacePresenter.html#getPersonalNamespaces
  Function
  Method
  PUBLIC
  Report the available personal namespaces.
- twisted.mail.interfaces.INamespacePresenter.getSharedNamespaces
  twisted.mail.interfaces.INamespacePresenter.html#getSharedNamespaces
  Function
  Method
  PUBLIC
  Report the available shared namespaces.
- twisted.mail.interfaces.INamespacePresenter.getUserNamespaces
  twisted.mail.interfaces.INamespacePresenter.html#getUserNamespaces
  Function
  Method
  PUBLIC
  Report the available user namespaces.
- twisted.mail._cred.CramMD5ClientAuthenticator
  twisted.mail._cred.CramMD5ClientAuthenticator.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.mail._cred.CramMD5ClientAuthenticator.__init__
  twisted.mail._cred.CramMD5ClientAuthenticator.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail._cred.CramMD5ClientAuthenticator.user
  twisted.mail._cred.CramMD5ClientAuthenticator.html#user
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail._cred.CramMD5ClientAuthenticator.getName
  twisted.mail._cred.CramMD5ClientAuthenticator.html#getName
  Function
  Method
  PUBLIC
  Return an identifier associated with this authentication scheme.
- twisted.mail._cred.CramMD5ClientAuthenticator.challengeResponse
  twisted.mail._cred.CramMD5ClientAuthenticator.html#challengeResponse
  Function
  Method
  PUBLIC
  Generate a challenge response string.
- twisted.mail._cred.LOGINAuthenticator
  twisted.mail._cred.LOGINAuthenticator.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.mail._cred.LOGINAuthenticator.__init__
  twisted.mail._cred.LOGINAuthenticator.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail._cred.LOGINAuthenticator.user
  twisted.mail._cred.LOGINAuthenticator.html#user
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail._cred.LOGINAuthenticator.challengeResponse
  twisted.mail._cred.LOGINAuthenticator.html#challengeResponse
  Attribute
  Instance Variable
  PUBLIC
  Generate a challenge response string.
- twisted.mail._cred.LOGINAuthenticator.getName
  twisted.mail._cred.LOGINAuthenticator.html#getName
  Function
  Method
  PUBLIC
  Return an identifier associated with this authentication scheme.
- twisted.mail._cred.LOGINAuthenticator.challengeUsername
  twisted.mail._cred.LOGINAuthenticator.html#challengeUsername
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail._cred.LOGINAuthenticator.challengeSecret
  twisted.mail._cred.LOGINAuthenticator.html#challengeSecret
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail._cred.PLAINAuthenticator
  twisted.mail._cred.PLAINAuthenticator.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.mail._cred.PLAINAuthenticator.__init__
  twisted.mail._cred.PLAINAuthenticator.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail._cred.PLAINAuthenticator.user
  twisted.mail._cred.PLAINAuthenticator.html#user
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail._cred.PLAINAuthenticator.getName
  twisted.mail._cred.PLAINAuthenticator.html#getName
  Function
  Method
  PUBLIC
  Return an identifier associated with this authentication scheme.
- twisted.mail._cred.PLAINAuthenticator.challengeResponse
  twisted.mail._cred.PLAINAuthenticator.html#challengeResponse
  Function
  Method
  PUBLIC
  Generate a challenge response string.
- twisted.mail._cred.LOGINCredentials
  twisted.mail._cred.LOGINCredentials.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.mail._cred.LOGINCredentials.__init__
  twisted.mail._cred.LOGINCredentials.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail._cred.LOGINCredentials.challenges
  twisted.mail._cred.LOGINCredentials.html#challenges
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail._cred.LOGINCredentials.responses
  twisted.mail._cred.LOGINCredentials.html#responses
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail._cred.LOGINCredentials.getChallenge
  twisted.mail._cred.LOGINCredentials.html#getChallenge
  Function
  Method
  PUBLIC
  Return a client challenge.
- twisted.mail._cred.LOGINCredentials.setResponse
  twisted.mail._cred.LOGINCredentials.html#setResponse
  Function
  Method
  PUBLIC
  Extract a username and possibly a password from a response and assign them to `username` and `password` instance variables.
- twisted.mail._cred.LOGINCredentials.moreChallenges
  twisted.mail._cred.LOGINCredentials.html#moreChallenges
  Function
  Method
  PUBLIC
  Are there more challenges than just the first? If so, callers should challenge clients with the result of `getChallenge`, and check their response with `setResponse` in a loop until this returns `False`
- twisted.mail._cred.PLAINCredentials
  twisted.mail._cred.PLAINCredentials.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.mail._cred.PLAINCredentials.__init__
  twisted.mail._cred.PLAINCredentials.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail._cred.PLAINCredentials.getChallenge
  twisted.mail._cred.PLAINCredentials.html#getChallenge
  Function
  Method
  PUBLIC
  Return a client challenge.
- twisted.mail._cred.PLAINCredentials.setResponse
  twisted.mail._cred.PLAINCredentials.html#setResponse
  Function
  Method
  PUBLIC
  Extract a username and possibly a password from a response and assign them to `username` and `password` instance variables.
- twisted.mail._cred.PLAINCredentials.username
  twisted.mail._cred.PLAINCredentials.html#username
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail._cred.PLAINCredentials.password
  twisted.mail._cred.PLAINCredentials.html#password
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail._cred.PLAINCredentials.moreChallenges
  twisted.mail._cred.PLAINCredentials.html#moreChallenges
  Function
  Method
  PUBLIC
  Are there more challenges than just the first? If so, callers should challenge clients with the result of `getChallenge`, and check their response with `setResponse` in a loop until this returns `False`
- twisted.mail._pop3client.OK
  twisted.mail._pop3client.html#OK
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.mail._pop3client.ERR
  twisted.mail._pop3client.html#ERR
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.mail._pop3client._ListSetter
  twisted.mail._pop3client._ListSetter.html
  Class
  Class
  PRIVATE
  A utility class to construct a list from a multi-line response accounting for deleted messages.
- twisted.mail._pop3client._ListSetter.L
  twisted.mail._pop3client._ListSetter.html#L
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`
- twisted.mail._pop3client._ListSetter.__init__
  twisted.mail._pop3client._ListSetter.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.mail._pop3client._ListSetter.setitem
  twisted.mail._pop3client._ListSetter.html#setitem
  Function
  Method
  PUBLIC
  Add the value at the specified position, padding out missing entries.
- twisted.mail._pop3client._statXform
  twisted.mail._pop3client.html#_statXform
  Function
  Function
  PRIVATE
  Parse the response to a STAT command.
- twisted.mail._pop3client._listXform
  twisted.mail._pop3client.html#_listXform
  Function
  Function
  PRIVATE
  Parse a line of the response to a LIST command.
- twisted.mail._pop3client._uidXform
  twisted.mail._pop3client.html#_uidXform
  Function
  Function
  PRIVATE
  Parse a line of the response to a UIDL command.
- twisted.mail._pop3client._codeStatusSplit
  twisted.mail._pop3client.html#_codeStatusSplit
  Function
  Function
  PRIVATE
  Parse the first line of a multi-line server response.
- twisted.mail._pop3client._dotUnquoter
  twisted.mail._pop3client.html#_dotUnquoter
  Function
  Function
  PRIVATE
  Remove a byte-stuffed termination character at the beginning of a line if present.
- twisted.mail.smtp.AddressError
  twisted.mail.smtp.AddressError.html
  Class
  Exception
  PUBLIC
  Parse error in address
- twisted.mail.smtp.AUTHDeclinedError
  twisted.mail.smtp.AUTHDeclinedError.html
  Class
  Exception
  PUBLIC
  The server rejected our credentials.
- twisted.mail.smtp.AuthenticationError
  twisted.mail.smtp.AuthenticationError.html
  Class
  Exception
  PUBLIC
  An error occurred while authenticating.
- twisted.mail.smtp.AUTHRequiredError
  twisted.mail.smtp.AUTHRequiredError.html
  Class
  Exception
  PUBLIC
  Authentication was required but the server does not support it.
- twisted.mail.smtp.EHLORequiredError
  twisted.mail.smtp.EHLORequiredError.html
  Class
  Exception
  PUBLIC
  The server does not support EHLO.
- twisted.mail.smtp.ESMTPClientError
  twisted.mail.smtp.ESMTPClientError.html
  Class
  Exception
  PUBLIC
  Base class for ESMTP client errors.
- twisted.mail.smtp.SMTPAddressError
  twisted.mail.smtp.SMTPAddressError.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTPAddressError.__init__
  twisted.mail.smtp.SMTPAddressError.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTPAddressError.addr
  twisted.mail.smtp.SMTPAddressError.html#addr
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTPAddressError.__str__
  twisted.mail.smtp.SMTPAddressError.html#__str__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTPBadRcpt
  twisted.mail.smtp.SMTPBadRcpt.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTPBadRcpt.__init__
  twisted.mail.smtp.SMTPBadRcpt.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTPBadSender
  twisted.mail.smtp.SMTPBadSender.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTPBadSender.__init__
  twisted.mail.smtp.SMTPBadSender.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTPClientError
  twisted.mail.smtp.SMTPClientError.html
  Class
  Exception
  PUBLIC
  Base class for SMTP client errors.
- twisted.mail.smtp.SMTPClientError.__init__
  twisted.mail.smtp.SMTPClientError.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.mail.smtp.SMTPClientError.code
  twisted.mail.smtp.SMTPClientError.html#code
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTPClientError.resp
  twisted.mail.smtp.SMTPClientError.html#resp
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTPClientError.log
  twisted.mail.smtp.SMTPClientError.html#log
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTPClientError.addresses
  twisted.mail.smtp.SMTPClientError.html#addresses
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTPClientError.isFatal
  twisted.mail.smtp.SMTPClientError.html#isFatal
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTPClientError.retry
  twisted.mail.smtp.SMTPClientError.html#retry
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTPClientError.__str__
  twisted.mail.smtp.SMTPClientError.html#__str__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTPClientError.__bytes__
  twisted.mail.smtp.SMTPClientError.html#__bytes__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTPConnectError
  twisted.mail.smtp.SMTPConnectError.html
  Class
  Exception
  PUBLIC
  Failed to connect to the mail exchange host.
- twisted.mail.smtp.SMTPConnectError.__init__
  twisted.mail.smtp.SMTPConnectError.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.mail.smtp.SMTPDeliveryError
  twisted.mail.smtp.SMTPDeliveryError.html
  Class
  Exception
  PUBLIC
  Indicates that a delivery attempt has had an error.
- twisted.mail.smtp.SMTPError
  twisted.mail.smtp.SMTPError.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTPProtocolError
  twisted.mail.smtp.SMTPProtocolError.html
  Class
  Exception
  PUBLIC
  The server sent a mangled response.
- twisted.mail.smtp.SMTPProtocolError.__init__
  twisted.mail.smtp.SMTPProtocolError.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.mail.smtp.SMTPServerError
  twisted.mail.smtp.SMTPServerError.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTPServerError.__init__
  twisted.mail.smtp.SMTPServerError.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTPServerError.code
  twisted.mail.smtp.SMTPServerError.html#code
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTPServerError.resp
  twisted.mail.smtp.SMTPServerError.html#resp
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTPServerError.__str__
  twisted.mail.smtp.SMTPServerError.html#__str__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTPTimeoutError
  twisted.mail.smtp.SMTPTimeoutError.html
  Class
  Exception
  PUBLIC
  Failed to receive a response from the server in the expected time period.
- twisted.mail.smtp.SMTPTimeoutError.__init__
  twisted.mail.smtp.SMTPTimeoutError.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.mail.smtp.TLSError
  twisted.mail.smtp.TLSError.html
  Class
  Exception
  PUBLIC
  An error occurred while negiotiating for transport security.
- twisted.mail.smtp.TLSRequiredError
  twisted.mail.smtp.TLSRequiredError.html
  Class
  Exception
  PUBLIC
  Transport security was required but the server does not support it.
- twisted.mail.smtp.DNSNAME
  twisted.mail.smtp.html#DNSNAME
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.mail.smtp.SUCCESS
  twisted.mail.smtp.html#SUCCESS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.mail.smtp.rfc822date
  twisted.mail.smtp.html#rfc822date
  Function
  Function
  PUBLIC
  Format an RFC-2822 compliant date string.
- twisted.mail.smtp.idGenerator
  twisted.mail.smtp.html#idGenerator
  Function
  Function
  PUBLIC
  Undocumented
- twisted.mail.smtp._gen
  twisted.mail.smtp.html#_gen
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.mail.smtp.messageid
  twisted.mail.smtp.html#messageid
  Function
  Function
  PUBLIC
  Return a globally unique random string in RFC 2822 Message-ID format
- twisted.mail.smtp.quoteaddr
  twisted.mail.smtp.html#quoteaddr
  Function
  Function
  PUBLIC
  Turn an email address, possibly with realname part etc, into a form suitable for and SMTP envelope.
- twisted.mail.smtp.COMMAND
  twisted.mail.smtp.html#COMMAND
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.mail.smtp.DATA
  twisted.mail.smtp.html#DATA
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.mail.smtp.AUTH
  twisted.mail.smtp.html#AUTH
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.mail.smtp.atom
  twisted.mail.smtp.html#atom
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.mail.smtp.Address
  twisted.mail.smtp.Address.html
  Class
  Class
  PUBLIC
  Parse and hold an RFC 2821 address.
- twisted.mail.smtp.Address.domain
  twisted.mail.smtp.Address.html#domain
  Attribute
  Instance Variable
  PUBLIC
  The domain within which this address resides.
- twisted.mail.smtp.Address.local
  twisted.mail.smtp.Address.html#local
  Attribute
  Instance Variable
  PUBLIC
  The local ("user") portion of this address.
- twisted.mail.smtp.Address.tstring
  twisted.mail.smtp.Address.html#tstring
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.smtp.Address.atomre
  twisted.mail.smtp.Address.html#atomre
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.smtp.Address.__init__
  twisted.mail.smtp.Address.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.smtp.Address.__dict__
  twisted.mail.smtp.Address.html#__dict__
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.smtp.Address.addrstr
  twisted.mail.smtp.Address.html#addrstr
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.smtp.Address.dequotebs
  twisted.mail.smtp.Address.html#dequotebs
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.smtp.Address.dequote
  twisted.mail.smtp.Address.html#dequote
  Function
  Method
  PUBLIC
  Remove RFC-2821 quotes from address.
- twisted.mail.smtp.Address.__str__
  twisted.mail.smtp.Address.html#__str__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.smtp.Address.__bytes__
  twisted.mail.smtp.Address.html#__bytes__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.smtp.Address.__repr__
  twisted.mail.smtp.Address.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.smtp.User
  twisted.mail.smtp.User.html
  Class
  Class
  PUBLIC
  Hold information about and SMTP message recipient, including information on where the message came from
- twisted.mail.smtp.User.__init__
  twisted.mail.smtp.User.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.smtp.User.dest
  twisted.mail.smtp.User.html#dest
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.smtp.User.helo
  twisted.mail.smtp.User.html#helo
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.smtp.User.protocol
  twisted.mail.smtp.User.html#protocol
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.smtp.User.orig
  twisted.mail.smtp.User.html#orig
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.smtp.User.__getstate__
  twisted.mail.smtp.User.html#__getstate__
  Function
  Method
  PUBLIC
  Helper for pickle.
- twisted.mail.smtp.User.__str__
  twisted.mail.smtp.User.html#__str__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.smtp.User.__bytes__
  twisted.mail.smtp.User.html#__bytes__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTP
  twisted.mail.smtp.SMTP.html
  Class
  Class
  PUBLIC
  SMTP server-side protocol.
- twisted.mail.smtp.SMTP.timeout
  twisted.mail.smtp.SMTP.html#timeout
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTP.portal
  twisted.mail.smtp.SMTP.html#portal
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTP.noisy
  twisted.mail.smtp.SMTP.html#noisy
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTP.deliveryFactory
  twisted.mail.smtp.SMTP.html#deliveryFactory
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTP.delivery
  twisted.mail.smtp.SMTP.html#delivery
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTP._onLogout
  twisted.mail.smtp.SMTP.html#_onLogout
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.mail.smtp.SMTP.__init__
  twisted.mail.smtp.SMTP.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTP.mode
  twisted.mail.smtp.SMTP.html#mode
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTP._from
  twisted.mail.smtp.SMTP.html#_from
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.mail.smtp.SMTP._helo
  twisted.mail.smtp.SMTP.html#_helo
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.mail.smtp.SMTP._to
  twisted.mail.smtp.SMTP.html#_to
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.mail.smtp.SMTP.host 0
  twisted.mail.smtp.SMTP.html#host%200
  Attribute
  Instance Variable
  PUBLIC
  The hostname of this mail server.
- twisted.mail.smtp.SMTP.host
  twisted.mail.smtp.SMTP.html#host
  Attribute
  Property
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTP.host.setter
  twisted.mail.smtp.SMTP.html#host.setter
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTP._host
  twisted.mail.smtp.SMTP.html#_host
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.mail.smtp.SMTP.timeoutConnection
  twisted.mail.smtp.SMTP.html#timeoutConnection
  Function
  Method
  PUBLIC
  Called when the connection times out.
- twisted.mail.smtp.SMTP.greeting
  twisted.mail.smtp.SMTP.html#greeting
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTP.connectionMade
  twisted.mail.smtp.SMTP.html#connectionMade
  Function
  Method
  PUBLIC
  Called when a connection is made.
- twisted.mail.smtp.SMTP.sendCode
  twisted.mail.smtp.SMTP.html#sendCode
  Function
  Method
  PUBLIC
  Send an SMTP code with a message.
- twisted.mail.smtp.SMTP.lineReceived
  twisted.mail.smtp.SMTP.html#lineReceived
  Function
  Method
  PUBLIC
  Override this for when each line is received.
- twisted.mail.smtp.SMTP.state_COMMAND
  twisted.mail.smtp.SMTP.html#state_COMMAND
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTP.sendSyntaxError
  twisted.mail.smtp.SMTP.html#sendSyntaxError
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTP.lookupMethod
  twisted.mail.smtp.SMTP.html#lookupMethod
  Function
  Method
  PUBLIC
  No summary
- twisted.mail.smtp.SMTP.lineLengthExceeded
  twisted.mail.smtp.SMTP.html#lineLengthExceeded
  Function
  Method
  PUBLIC
  Called when the maximum line length has been reached. Override if it needs to be dealt with in some special way.
- twisted.mail.smtp.SMTP.do_UNKNOWN
  twisted.mail.smtp.SMTP.html#do_UNKNOWN
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTP.do_HELO
  twisted.mail.smtp.SMTP.html#do_HELO
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTP.do_QUIT
  twisted.mail.smtp.SMTP.html#do_QUIT
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTP.qstring
  twisted.mail.smtp.SMTP.html#qstring
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTP.mail_re
  twisted.mail.smtp.SMTP.html#mail_re
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTP.rcpt_re
  twisted.mail.smtp.SMTP.html#rcpt_re
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTP.do_MAIL
  twisted.mail.smtp.SMTP.html#do_MAIL
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTP._cbFromValidate
  twisted.mail.smtp.SMTP.html#_cbFromValidate
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.smtp.SMTP._ebFromValidate
  twisted.mail.smtp.SMTP.html#_ebFromValidate
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.smtp.SMTP.do_RCPT
  twisted.mail.smtp.SMTP.html#do_RCPT
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTP._cbToValidate
  twisted.mail.smtp.SMTP.html#_cbToValidate
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.smtp.SMTP._ebToValidate
  twisted.mail.smtp.SMTP.html#_ebToValidate
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.smtp.SMTP._disconnect
  twisted.mail.smtp.SMTP.html#_disconnect
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.smtp.SMTP.do_DATA
  twisted.mail.smtp.SMTP.html#do_DATA
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTP.datafailed
  twisted.mail.smtp.SMTP.html#datafailed
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTP.__messages
  twisted.mail.smtp.SMTP.html#__messages
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.mail.smtp.SMTP.__inheader
  twisted.mail.smtp.SMTP.html#__inheader
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.mail.smtp.SMTP.__inbody
  twisted.mail.smtp.SMTP.html#__inbody
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.mail.smtp.SMTP.connectionLost
  twisted.mail.smtp.SMTP.html#connectionLost
  Function
  Method
  PUBLIC
  Called when the connection is shut down.
- twisted.mail.smtp.SMTP.do_RSET
  twisted.mail.smtp.SMTP.html#do_RSET
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTP.dataLineReceived
  twisted.mail.smtp.SMTP.html#dataLineReceived
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTP._messageHandled
  twisted.mail.smtp.SMTP.html#_messageHandled
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.smtp.SMTP._cbAnonymousAuthentication
  twisted.mail.smtp.SMTP.html#_cbAnonymousAuthentication
  Function
  Method
  PRIVATE
  Save the state resulting from a successful anonymous cred login.
- twisted.mail.smtp.SMTP.challenger
  twisted.mail.smtp.SMTP.html#challenger
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTP.validateFrom
  twisted.mail.smtp.SMTP.html#validateFrom
  Function
  Method
  PUBLIC
  Validate the address from which the message originates.
- twisted.mail.smtp.SMTP.validateTo
  twisted.mail.smtp.SMTP.html#validateTo
  Function
  Method
  PUBLIC
  Validate the address for which the message is destined.
- twisted.mail.smtp.SMTP.receivedHeader
  twisted.mail.smtp.SMTP.html#receivedHeader
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTPFactory
  twisted.mail.smtp.SMTPFactory.html
  Class
  Class
  PUBLIC
  Factory for SMTP.
- twisted.mail.smtp.SMTPFactory.timeout
  twisted.mail.smtp.SMTPFactory.html#timeout
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTPFactory.portal
  twisted.mail.smtp.SMTPFactory.html#portal
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTPFactory.__init__
  twisted.mail.smtp.SMTPFactory.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTPFactory.buildProtocol
  twisted.mail.smtp.SMTPFactory.html#buildProtocol
  Function
  Method
  PUBLIC
  Create an instance of a subclass of Protocol.
- twisted.mail.smtp.SMTPClient
  twisted.mail.smtp.SMTPClient.html
  Class
  Class
  PUBLIC
  SMTP client for sending emails.
- twisted.mail.smtp.SMTPClient.debug
  twisted.mail.smtp.SMTPClient.html#debug
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTPClient.timeout
  twisted.mail.smtp.SMTPClient.html#timeout
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTPClient.__init__
  twisted.mail.smtp.SMTPClient.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTPClient.identity
  twisted.mail.smtp.SMTPClient.html#identity
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTPClient.toAddressesResult
  twisted.mail.smtp.SMTPClient.html#toAddressesResult
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTPClient.successAddresses
  twisted.mail.smtp.SMTPClient.html#successAddresses
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTPClient._from
  twisted.mail.smtp.SMTPClient.html#_from
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.mail.smtp.SMTPClient.resp
  twisted.mail.smtp.SMTPClient.html#resp
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTPClient.code
  twisted.mail.smtp.SMTPClient.html#code
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTPClient.log
  twisted.mail.smtp.SMTPClient.html#log
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTPClient.sendLine
  twisted.mail.smtp.SMTPClient.html#sendLine
  Function
  Method
  PUBLIC
  Sends a line to the other end of the connection.
- twisted.mail.smtp.SMTPClient.connectionMade
  twisted.mail.smtp.SMTPClient.html#connectionMade
  Function
  Method
  PUBLIC
  Called when a connection is made.
- twisted.mail.smtp.SMTPClient._expected
  twisted.mail.smtp.SMTPClient.html#_expected
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.mail.smtp.SMTPClient._okresponse
  twisted.mail.smtp.SMTPClient.html#_okresponse
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.mail.smtp.SMTPClient._failresponse
  twisted.mail.smtp.SMTPClient.html#_failresponse
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.mail.smtp.SMTPClient.connectionLost
  twisted.mail.smtp.SMTPClient.html#connectionLost
  Function
  Method
  PUBLIC
  We are no longer connected
- twisted.mail.smtp.SMTPClient.mailFile
  twisted.mail.smtp.SMTPClient.html#mailFile
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTPClient.timeoutConnection
  twisted.mail.smtp.SMTPClient.html#timeoutConnection
  Function
  Method
  PUBLIC
  Called when the connection times out.
- twisted.mail.smtp.SMTPClient.lineReceived
  twisted.mail.smtp.SMTPClient.html#lineReceived
  Function
  Method
  PUBLIC
  Override this for when each line is received.
- twisted.mail.smtp.SMTPClient.smtpConnectionFailed
  twisted.mail.smtp.SMTPClient.html#smtpConnectionFailed
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTPClient.smtpTransferFailed
  twisted.mail.smtp.SMTPClient.html#smtpTransferFailed
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTPClient.smtpState_helo
  twisted.mail.smtp.SMTPClient.html#smtpState_helo
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTPClient.smtpState_from
  twisted.mail.smtp.SMTPClient.html#smtpState_from
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTPClient.smtpState_disconnect
  twisted.mail.smtp.SMTPClient.html#smtpState_disconnect
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTPClient.smtpState_to
  twisted.mail.smtp.SMTPClient.html#smtpState_to
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTPClient.toAddresses
  twisted.mail.smtp.SMTPClient.html#toAddresses
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTPClient.lastAddress
  twisted.mail.smtp.SMTPClient.html#lastAddress
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTPClient.smtpState_toOrData
  twisted.mail.smtp.SMTPClient.html#smtpState_toOrData
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTPClient.smtpState_data
  twisted.mail.smtp.SMTPClient.html#smtpState_data
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTPClient.smtpState_msgSent
  twisted.mail.smtp.SMTPClient.html#smtpState_msgSent
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTPClient.transformChunk
  twisted.mail.smtp.SMTPClient.html#transformChunk
  Function
  Method
  PUBLIC
  Perform the necessary local to network newline conversion and escape leading periods.
- twisted.mail.smtp.SMTPClient.finishedFileTransfer
  twisted.mail.smtp.SMTPClient.html#finishedFileTransfer
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTPClient.getMailFrom
  twisted.mail.smtp.SMTPClient.html#getMailFrom
  Function
  Method
  PUBLIC
  Return the email address the mail is from.
- twisted.mail.smtp.SMTPClient.getMailTo
  twisted.mail.smtp.SMTPClient.html#getMailTo
  Function
  Method
  PUBLIC
  Return a list of emails to send to.
- twisted.mail.smtp.SMTPClient.getMailData
  twisted.mail.smtp.SMTPClient.html#getMailData
  Function
  Method
  PUBLIC
  Return file-like object containing data of message to be sent.
- twisted.mail.smtp.SMTPClient.sendError
  twisted.mail.smtp.SMTPClient.html#sendError
  Function
  Method
  PUBLIC
  If an error occurs before a mail message is sent sendError will be called. This base class method sends a QUIT if the error is non-fatal and disconnects the connection.
- twisted.mail.smtp.SMTPClient.sentMail
  twisted.mail.smtp.SMTPClient.html#sentMail
  Function
  Method
  PUBLIC
  Called when an attempt to send an email is completed.
- twisted.mail.smtp.SMTPClient._disconnectFromServer
  twisted.mail.smtp.SMTPClient.html#_disconnectFromServer
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.smtp.ESMTPClient
  twisted.mail.smtp.ESMTPClient.html
  Class
  Class
  PUBLIC
  A client for sending emails over ESMTP.
- twisted.mail.smtp.ESMTPClient.heloFallback
  twisted.mail.smtp.ESMTPClient.html#heloFallback
  Attribute
  Instance Variable
  PUBLIC
  Whether or not to fall back to plain SMTP if the `EHLO` command is not recognised by the server. If `requireAuthentication` is `True`, or `requireTransportSecurity` is `True` and the connection is not over TLS, this fallback flag will not be honored.
- twisted.mail.smtp.ESMTPClient.requireAuthentication
  twisted.mail.smtp.ESMTPClient.html#requireAuthentication
  Attribute
  Instance Variable
  PUBLIC
  If `True`, refuse to proceed if authentication cannot be performed. Overrides `heloFallback`.
- twisted.mail.smtp.ESMTPClient.requireTransportSecurity
  twisted.mail.smtp.ESMTPClient.html#requireTransportSecurity
  Attribute
  Instance Variable
  PUBLIC
  If `True`, refuse to proceed if the transport cannot be secured. If the transport layer is not already secured via TLS, this will override `heloFallback`.
- twisted.mail.smtp.ESMTPClient.context
  twisted.mail.smtp.ESMTPClient.html#context
  Attribute
  Instance Variable
  PUBLIC
  The context factory to use for STARTTLS, if desired.
- twisted.mail.smtp.ESMTPClient._tlsMode
  twisted.mail.smtp.ESMTPClient.html#_tlsMode
  Attribute
  Instance Variable
  PRIVATE
  Whether or not the connection is over TLS.
- twisted.mail.smtp.ESMTPClient.__init__
  twisted.mail.smtp.ESMTPClient.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.smtp.ESMTPClient.authenticators
  twisted.mail.smtp.ESMTPClient.html#authenticators
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.smtp.ESMTPClient.secret
  twisted.mail.smtp.ESMTPClient.html#secret
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.smtp.ESMTPClient.__getattr__
  twisted.mail.smtp.ESMTPClient.html#__getattr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.smtp.ESMTPClient.__setattr__
  twisted.mail.smtp.ESMTPClient.html#__setattr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.smtp.ESMTPClient.esmtpEHLORequired
  twisted.mail.smtp.ESMTPClient.html#esmtpEHLORequired
  Function
  Method
  PUBLIC
  Fail because authentication is required, but the server does not support ESMTP, which is required for authentication.
- twisted.mail.smtp.ESMTPClient.esmtpAUTHRequired
  twisted.mail.smtp.ESMTPClient.html#esmtpAUTHRequired
  Function
  Method
  PUBLIC
  Fail because authentication is required, but the server does not support any schemes we support.
- twisted.mail.smtp.ESMTPClient.esmtpTLSRequired
  twisted.mail.smtp.ESMTPClient.html#esmtpTLSRequired
  Function
  Method
  PUBLIC
  Fail because TLS is required and the server does not support it.
- twisted.mail.smtp.ESMTPClient.esmtpTLSFailed
  twisted.mail.smtp.ESMTPClient.html#esmtpTLSFailed
  Function
  Method
  PUBLIC
  Fail because the TLS handshake wasn't able to be completed.
- twisted.mail.smtp.ESMTPClient.esmtpAUTHDeclined
  twisted.mail.smtp.ESMTPClient.html#esmtpAUTHDeclined
  Function
  Method
  PUBLIC
  Fail because the authentication was rejected.
- twisted.mail.smtp.ESMTPClient.esmtpAUTHMalformedChallenge
  twisted.mail.smtp.ESMTPClient.html#esmtpAUTHMalformedChallenge
  Function
  Method
  PUBLIC
  Fail because the server sent a malformed authentication challenge.
- twisted.mail.smtp.ESMTPClient.esmtpAUTHServerError
  twisted.mail.smtp.ESMTPClient.html#esmtpAUTHServerError
  Function
  Method
  PUBLIC
  Fail because of some other authentication error.
- twisted.mail.smtp.ESMTPClient.registerAuthenticator
  twisted.mail.smtp.ESMTPClient.html#registerAuthenticator
  Function
  Method
  PUBLIC
  Registers an Authenticator with the ESMTPClient. The ESMTPClient will attempt to login to the SMTP Server in the order the Authenticators are registered. The most secure Authentication mechanism should be registered first.
- twisted.mail.smtp.ESMTPClient.connectionMade
  twisted.mail.smtp.ESMTPClient.html#connectionMade
  Function
  Method
  PUBLIC
  Called when a connection has been made, and triggers sending an `EHLO` to the server.
- twisted.mail.smtp.ESMTPClient._okresponse
  twisted.mail.smtp.ESMTPClient.html#_okresponse
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.mail.smtp.ESMTPClient.esmtpState_ehlo
  twisted.mail.smtp.ESMTPClient.html#esmtpState_ehlo
  Function
  Method
  PUBLIC
  Send an `EHLO` to the server.
- twisted.mail.smtp.ESMTPClient._expected
  twisted.mail.smtp.ESMTPClient.html#_expected
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.mail.smtp.ESMTPClient._failresponse
  twisted.mail.smtp.ESMTPClient.html#_failresponse
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.mail.smtp.ESMTPClient.esmtpState_serverConfig
  twisted.mail.smtp.ESMTPClient.html#esmtpState_serverConfig
  Function
  Method
  PUBLIC
  Handle a positive response to the EHLO command by parsing the capabilities in the server's response and then taking the most appropriate next step towards entering a mail transaction.
- twisted.mail.smtp.ESMTPClient.tryTLS
  twisted.mail.smtp.ESMTPClient.html#tryTLS
  Function
  Method
  PUBLIC
  Take a necessary step towards being able to begin a mail transaction.
- twisted.mail.smtp.ESMTPClient.esmtpState_starttls
  twisted.mail.smtp.ESMTPClient.html#esmtpState_starttls
  Function
  Method
  PUBLIC
  Handle a positive response to the STARTTLS command by starting a new TLS session on `self.transport`.
- twisted.mail.smtp.ESMTPClient.authenticate
  twisted.mail.smtp.ESMTPClient.html#authenticate
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.smtp.ESMTPClient._authinfo
  twisted.mail.smtp.ESMTPClient.html#_authinfo
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.mail.smtp.ESMTPClient._esmtpState_plainAuth
  twisted.mail.smtp.ESMTPClient.html#_esmtpState_plainAuth
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.smtp.ESMTPClient.esmtpState_challenge
  twisted.mail.smtp.ESMTPClient.html#esmtpState_challenge
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.smtp.ESMTPClient._authResponse
  twisted.mail.smtp.ESMTPClient.html#_authResponse
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.smtp.ESMTPClient.smtpState_maybeAuthenticated
  twisted.mail.smtp.ESMTPClient.html#smtpState_maybeAuthenticated
  Function
  Method
  PUBLIC
  Called to handle the next message from the server after sending a response to a SASL challenge. The server response might be another challenge or it might indicate authentication has succeeded.
- twisted.mail.smtp.ESMTP
  twisted.mail.smtp.ESMTP.html
  Class
  Class
  PUBLIC
  No class docstring; 0/10 instance variable, 0/1 class variable, 4/12 methods documented
- twisted.mail.smtp.ESMTP.ctx
  twisted.mail.smtp.ESMTP.html#ctx
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.smtp.ESMTP.canStartTLS
  twisted.mail.smtp.ESMTP.html#canStartTLS
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.smtp.ESMTP.startedTLS
  twisted.mail.smtp.ESMTP.html#startedTLS
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.smtp.ESMTP.authenticated
  twisted.mail.smtp.ESMTP.html#authenticated
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.smtp.ESMTP.__init__
  twisted.mail.smtp.ESMTP.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.smtp.ESMTP.challengers
  twisted.mail.smtp.ESMTP.html#challengers
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.smtp.ESMTP.connectionMade
  twisted.mail.smtp.ESMTP.html#connectionMade
  Function
  Method
  PUBLIC
  Called when a connection is made.
- twisted.mail.smtp.ESMTP.greeting
  twisted.mail.smtp.ESMTP.html#greeting
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.smtp.ESMTP.extensions
  twisted.mail.smtp.ESMTP.html#extensions
  Function
  Method
  PUBLIC
  SMTP service extensions
- twisted.mail.smtp.ESMTP.lookupMethod
  twisted.mail.smtp.ESMTP.html#lookupMethod
  Function
  Method
  PUBLIC
  No summary
- twisted.mail.smtp.ESMTP.listExtensions
  twisted.mail.smtp.ESMTP.html#listExtensions
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.smtp.ESMTP.do_EHLO
  twisted.mail.smtp.ESMTP.html#do_EHLO
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.smtp.ESMTP._helo
  twisted.mail.smtp.ESMTP.html#_helo
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.mail.smtp.ESMTP._from
  twisted.mail.smtp.ESMTP.html#_from
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.mail.smtp.ESMTP._to
  twisted.mail.smtp.ESMTP.html#_to
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.mail.smtp.ESMTP.ext_STARTTLS
  twisted.mail.smtp.ESMTP.html#ext_STARTTLS
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.smtp.ESMTP.ext_AUTH
  twisted.mail.smtp.ESMTP.html#ext_AUTH
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.smtp.ESMTP.mode
  twisted.mail.smtp.ESMTP.html#mode
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.smtp.ESMTP.challenger
  twisted.mail.smtp.ESMTP.html#challenger
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.smtp.ESMTP._cbAuthenticated
  twisted.mail.smtp.ESMTP.html#_cbAuthenticated
  Function
  Method
  PRIVATE
  Save the state resulting from a successful cred login and mark this connection as authenticated.
- twisted.mail.smtp.ESMTP._ebAuthenticated
  twisted.mail.smtp.ESMTP.html#_ebAuthenticated
  Function
  Method
  PRIVATE
  Handle cred login errors by translating them to the SMTP authenticate failed. Translate all other errors into a generic SMTP error code and log the failure for inspection. Stop all errors from propagating.
- twisted.mail.smtp.ESMTP.challenge
  twisted.mail.smtp.ESMTP.html#challenge
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.smtp.ESMTP.state_AUTH
  twisted.mail.smtp.ESMTP.html#state_AUTH
  Function
  Method
  PUBLIC
  Handle one step of challenge/response authentication.
- twisted.mail.smtp.SenderMixin
  twisted.mail.smtp.SenderMixin.html
  Class
  Class
  PUBLIC
  Utility class for sending emails easily.
- twisted.mail.smtp.SenderMixin.done
  twisted.mail.smtp.SenderMixin.html#done
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.smtp.SenderMixin.getMailFrom
  twisted.mail.smtp.SenderMixin.html#getMailFrom
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.smtp.SenderMixin.getMailTo
  twisted.mail.smtp.SenderMixin.html#getMailTo
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.smtp.SenderMixin.getMailData
  twisted.mail.smtp.SenderMixin.html#getMailData
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.smtp.SenderMixin.sendError
  twisted.mail.smtp.SenderMixin.html#sendError
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.smtp.SenderMixin.sentMail
  twisted.mail.smtp.SenderMixin.html#sentMail
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTPSender
  twisted.mail.smtp.SMTPSender.html
  Class
  Class
  PUBLIC
  SMTP protocol that sends a single email based on information it gets from its factory, a `SMTPSenderFactory`.
- twisted.mail.smtp.SMTPSenderFactory
  twisted.mail.smtp.SMTPSenderFactory.html
  Class
  Class
  PUBLIC
  Utility factory for sending emails easily.
- twisted.mail.smtp.SMTPSenderFactory.currentProtocol
  twisted.mail.smtp.SMTPSenderFactory.html#currentProtocol
  Attribute
  Instance Variable
  PUBLIC
  The current running protocol returned by `buildProtocol`.
- twisted.mail.smtp.SMTPSenderFactory.sendFinished
  twisted.mail.smtp.SMTPSenderFactory.html#sendFinished
  Attribute
  Instance Variable
  PUBLIC
  When the value is set to True, it means the message has been sent or there has been an unrecoverable error or the sending has been cancelled. The default value is False.
- twisted.mail.smtp.SMTPSenderFactory.__init__
  twisted.mail.smtp.SMTPSenderFactory.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.mail.smtp.SMTPSenderFactory.fromEmail
  twisted.mail.smtp.SMTPSenderFactory.html#fromEmail
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTPSenderFactory.nEmails
  twisted.mail.smtp.SMTPSenderFactory.html#nEmails
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTPSenderFactory.toEmail
  twisted.mail.smtp.SMTPSenderFactory.html#toEmail
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTPSenderFactory.file
  twisted.mail.smtp.SMTPSenderFactory.html#file
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTPSenderFactory.result
  twisted.mail.smtp.SMTPSenderFactory.html#result
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTPSenderFactory.retries
  twisted.mail.smtp.SMTPSenderFactory.html#retries
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTPSenderFactory.timeout
  twisted.mail.smtp.SMTPSenderFactory.html#timeout
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.smtp.SMTPSenderFactory._removeDeferred
  twisted.mail.smtp.SMTPSenderFactory.html#_removeDeferred
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.smtp.SMTPSenderFactory.clientConnectionFailed
  twisted.mail.smtp.SMTPSenderFactory.html#clientConnectionFailed
  Function
  Method
  PUBLIC
  Called when a connection has failed to connect.
- twisted.mail.smtp.SMTPSenderFactory.clientConnectionLost
  twisted.mail.smtp.SMTPSenderFactory.html#clientConnectionLost
  Function
  Method
  PUBLIC
  Called when an established connection is lost.
- twisted.mail.smtp.SMTPSenderFactory._processConnectionError
  twisted.mail.smtp.SMTPSenderFactory.html#_processConnectionError
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.smtp.SMTPSenderFactory.buildProtocol
  twisted.mail.smtp.SMTPSenderFactory.html#buildProtocol
  Function
  Method
  PUBLIC
  Create an instance of a subclass of Protocol.
- twisted.mail.smtp.SMTPSenderFactory._removeProtocol
  twisted.mail.smtp.SMTPSenderFactory.html#_removeProtocol
  Function
  Method
  PRIVATE
  Remove the protocol created in `buildProtocol`.
- twisted.mail.smtp.LOGINCredentials
  twisted.mail.smtp.LOGINCredentials.html
  Class
  Class
  PUBLIC
  `LOGINCredentials` generates challenges for LOGIN authentication.
- twisted.mail.smtp.LOGINCredentials.__init__
  twisted.mail.smtp.LOGINCredentials.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.smtp.LOGINCredentials.challenges
  twisted.mail.smtp.LOGINCredentials.html#challenges
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.smtp.PLAINAuthenticator
  twisted.mail.smtp.PLAINAuthenticator.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.mail.smtp.PLAINAuthenticator.__init__
  twisted.mail.smtp.PLAINAuthenticator.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.smtp.PLAINAuthenticator.user
  twisted.mail.smtp.PLAINAuthenticator.html#user
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.smtp.PLAINAuthenticator.getName
  twisted.mail.smtp.PLAINAuthenticator.html#getName
  Function
  Method
  PUBLIC
  Return an identifier associated with this authentication scheme.
- twisted.mail.smtp.PLAINAuthenticator.challengeResponse
  twisted.mail.smtp.PLAINAuthenticator.html#challengeResponse
  Function
  Method
  PUBLIC
  Generate a challenge response string.
- twisted.mail.smtp.ESMTPSender
  twisted.mail.smtp.ESMTPSender.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.mail.smtp.ESMTPSender.requireAuthentication
  twisted.mail.smtp.ESMTPSender.html#requireAuthentication
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.smtp.ESMTPSender.requireTransportSecurity
  twisted.mail.smtp.ESMTPSender.html#requireTransportSecurity
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.smtp.ESMTPSender.__init__
  twisted.mail.smtp.ESMTPSender.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.smtp.ESMTPSender.heloFallback
  twisted.mail.smtp.ESMTPSender.html#heloFallback
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.smtp.ESMTPSender.username
  twisted.mail.smtp.ESMTPSender.html#username
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.smtp.ESMTPSender._hostname
  twisted.mail.smtp.ESMTPSender.html#_hostname
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.mail.smtp.ESMTPSender._registerAuthenticators
  twisted.mail.smtp.ESMTPSender.html#_registerAuthenticators
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.smtp.ESMTPSender._getContextFactory
  twisted.mail.smtp.ESMTPSender.html#_getContextFactory
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.smtp.ESMTPSenderFactory
  twisted.mail.smtp.ESMTPSenderFactory.html
  Class
  Class
  PUBLIC
  Utility factory for sending emails easily.
- twisted.mail.smtp.ESMTPSenderFactory.currentProtocol
  twisted.mail.smtp.ESMTPSenderFactory.html#currentProtocol
  Attribute
  Instance Variable
  PUBLIC
  The current running protocol as made by `buildProtocol`.
- twisted.mail.smtp.ESMTPSenderFactory.__init__
  twisted.mail.smtp.ESMTPSenderFactory.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.mail.smtp.ESMTPSenderFactory.username
  twisted.mail.smtp.ESMTPSenderFactory.html#username
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.smtp.ESMTPSenderFactory.password
  twisted.mail.smtp.ESMTPSenderFactory.html#password
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.smtp.ESMTPSenderFactory._contextFactory
  twisted.mail.smtp.ESMTPSenderFactory.html#_contextFactory
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.mail.smtp.ESMTPSenderFactory._heloFallback
  twisted.mail.smtp.ESMTPSenderFactory.html#_heloFallback
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.mail.smtp.ESMTPSenderFactory._requireAuthentication
  twisted.mail.smtp.ESMTPSenderFactory.html#_requireAuthentication
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.mail.smtp.ESMTPSenderFactory._requireTransportSecurity
  twisted.mail.smtp.ESMTPSenderFactory.html#_requireTransportSecurity
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.mail.smtp.ESMTPSenderFactory._hostname
  twisted.mail.smtp.ESMTPSenderFactory.html#_hostname
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.mail.smtp.ESMTPSenderFactory.buildProtocol
  twisted.mail.smtp.ESMTPSenderFactory.html#buildProtocol
  Function
  Method
  PUBLIC
  Build an `ESMTPSender` protocol configured with `heloFallback`, `requireAuthentication`, and `requireTransportSecurity` as specified in `__init__`.
- twisted.mail.smtp.sendmail
  twisted.mail.smtp.html#sendmail
  Function
  Function
  PUBLIC
  Send an email.
- twisted.mail.smtp.xtext_encode
  twisted.mail.smtp.html#xtext_encode
  Function
  Function
  PUBLIC
  Undocumented
- twisted.mail.smtp.xtext_decode
  twisted.mail.smtp.html#xtext_decode
  Function
  Function
  PUBLIC
  Decode the xtext-encoded string `s`.
- twisted.mail.smtp.xtextStreamReader
  twisted.mail.smtp.xtextStreamReader.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.mail.smtp.xtextStreamReader.decode
  twisted.mail.smtp.xtextStreamReader.html#decode
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.smtp.xtextStreamWriter
  twisted.mail.smtp.xtextStreamWriter.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.mail.smtp.xtextStreamWriter.decode
  twisted.mail.smtp.xtextStreamWriter.html#decode
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.smtp.xtext_codec
  twisted.mail.smtp.html#xtext_codec
  Function
  Function
  PUBLIC
  Undocumented
- twisted.mail.alias.handle
  twisted.mail.alias.html#handle
  Function
  Function
  PUBLIC
  Parse a line from an aliases file.
- twisted.mail.alias.loadAliasFile
  twisted.mail.alias.html#loadAliasFile
  Function
  Function
  PUBLIC
  Load a file containing email aliases.
- twisted.mail.alias.AliasBase
  twisted.mail.alias.AliasBase.html
  Class
  Class
  PUBLIC
  The default base class for aliases.
- twisted.mail.alias.AliasBase.domains
  twisted.mail.alias.AliasBase.html#domains
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`.
- twisted.mail.alias.AliasBase.original
  twisted.mail.alias.AliasBase.html#original
  Attribute
  Instance Variable
  PUBLIC
  The original address being aliased.
- twisted.mail.alias.AliasBase.__init__
  twisted.mail.alias.AliasBase.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.mail.alias.AliasBase.domain
  twisted.mail.alias.AliasBase.html#domain
  Function
  Method
  PUBLIC
  Return the domain associated with original address.
- twisted.mail.alias.AliasBase.resolve
  twisted.mail.alias.AliasBase.html#resolve
  Function
  Method
  PUBLIC
  Map this alias to its ultimate destination.
- twisted.mail.alias.AddressAlias
  twisted.mail.alias.AddressAlias.html
  Class
  Class
  PUBLIC
  An alias which translates one email address into another.
- twisted.mail.alias.AddressAlias.alias
  twisted.mail.alias.AddressAlias.html#alias
  Attribute
  Instance Variable
  PUBLIC
  The destination address.
- twisted.mail.alias.AddressAlias.__init__
  twisted.mail.alias.AddressAlias.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.mail.alias.AddressAlias.__str__
  twisted.mail.alias.AddressAlias.html#__str__
  Function
  Method
  PUBLIC
  Build a string representation of this `AddressAlias` instance.
- twisted.mail.alias.AddressAlias.createMessageReceiver
  twisted.mail.alias.AddressAlias.html#createMessageReceiver
  Function
  Method
  PUBLIC
  Create a message receiver which delivers a message to the destination address.
- twisted.mail.alias.AddressAlias.resolve
  twisted.mail.alias.AddressAlias.html#resolve
  Function
  Method
  PUBLIC
  Map this alias to its ultimate destination.
- twisted.mail.alias.FileWrapper
  twisted.mail.alias.FileWrapper.html
  Class
  Class
  PUBLIC
  A message receiver which delivers a message to a file.
- twisted.mail.alias.FileWrapper.fp
  twisted.mail.alias.FileWrapper.html#fp
  Attribute
  Instance Variable
  PUBLIC
  A file used for temporary storage of the message.
- twisted.mail.alias.FileWrapper.finalname
  twisted.mail.alias.FileWrapper.html#finalname
  Attribute
  Instance Variable
  PUBLIC
  The name of the file in which the message should be stored.
- twisted.mail.alias.FileWrapper.__init__
  twisted.mail.alias.FileWrapper.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.mail.alias.FileWrapper.lineReceived
  twisted.mail.alias.FileWrapper.html#lineReceived
  Function
  Method
  PUBLIC
  Write a received line to the temporary file.
- twisted.mail.alias.FileWrapper.eomReceived
  twisted.mail.alias.FileWrapper.html#eomReceived
  Function
  Method
  PUBLIC
  Handle end of message by writing the message to the file.
- twisted.mail.alias.FileWrapper.connectionLost
  twisted.mail.alias.FileWrapper.html#connectionLost
  Function
  Method
  PUBLIC
  Close the temporary file when the connection is lost.
- twisted.mail.alias.FileWrapper.__str__
  twisted.mail.alias.FileWrapper.html#__str__
  Function
  Method
  PUBLIC
  Build a string representation of this `FileWrapper` instance.
- twisted.mail.alias.FileAlias
  twisted.mail.alias.FileAlias.html
  Class
  Class
  PUBLIC
  An alias which translates an address to a file.
- twisted.mail.alias.FileAlias.filename
  twisted.mail.alias.FileAlias.html#filename
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`.
- twisted.mail.alias.FileAlias.__init__
  twisted.mail.alias.FileAlias.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.mail.alias.FileAlias.__str__
  twisted.mail.alias.FileAlias.html#__str__
  Function
  Method
  PUBLIC
  Build a string representation of this `FileAlias` instance.
- twisted.mail.alias.FileAlias.createMessageReceiver
  twisted.mail.alias.FileAlias.html#createMessageReceiver
  Function
  Method
  PUBLIC
  Create a message receiver which delivers a message to the file.
- twisted.mail.alias.ProcessAliasTimeout
  twisted.mail.alias.ProcessAliasTimeout.html
  Class
  Exception
  PUBLIC
  An error indicating that a timeout occurred while waiting for a process to complete.
- twisted.mail.alias.MessageWrapper
  twisted.mail.alias.MessageWrapper.html
  Class
  Class
  PUBLIC
  A message receiver which delivers a message to a child process.
- twisted.mail.alias.MessageWrapper.completionTimeout
  twisted.mail.alias.MessageWrapper.html#completionTimeout
  Attribute
  Instance Variable
  PUBLIC
  The number of seconds to wait for the child process to exit before reporting the delivery as a failure.
- twisted.mail.alias.MessageWrapper._timeoutCallID
  twisted.mail.alias.MessageWrapper.html#_timeoutCallID
  Attribute
  Instance Variable
  PRIVATE
  The call used to time out delivery, started when the connection to the child process is closed.
- twisted.mail.alias.MessageWrapper.done
  twisted.mail.alias.MessageWrapper.html#done
  Attribute
  Instance Variable
  PUBLIC
  A flag indicating whether the child process has exited (`True`) or not (`False`).
- twisted.mail.alias.MessageWrapper.reactor
  twisted.mail.alias.MessageWrapper.html#reactor
  Attribute
  Instance Variable
  PUBLIC
  A reactor which will be used to schedule timeouts.
- twisted.mail.alias.MessageWrapper.protocol
  twisted.mail.alias.MessageWrapper.html#protocol
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`.
- twisted.mail.alias.MessageWrapper.processName
  twisted.mail.alias.MessageWrapper.html#processName
  Attribute
  Instance Variable
  PUBLIC
  The process name.
- twisted.mail.alias.MessageWrapper.completion
  twisted.mail.alias.MessageWrapper.html#completion
  Attribute
  Instance Variable
  PUBLIC
  The deferred which will be triggered by the protocol when the child process exits.
- twisted.mail.alias.MessageWrapper.__init__
  twisted.mail.alias.MessageWrapper.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.mail.alias.MessageWrapper._processEnded
  twisted.mail.alias.MessageWrapper.html#_processEnded
  Function
  Method
  PRIVATE
  Record process termination and cancel the timeout call if it is active.
- twisted.mail.alias.MessageWrapper.lineReceived
  twisted.mail.alias.MessageWrapper.html#lineReceived
  Function
  Method
  PUBLIC
  Write a received line to the child process.
- twisted.mail.alias.MessageWrapper.eomReceived
  twisted.mail.alias.MessageWrapper.html#eomReceived
  Function
  Method
  PUBLIC
  Disconnect from the child process and set up a timeout to wait for it to exit.
- twisted.mail.alias.MessageWrapper._completionCancel
  twisted.mail.alias.MessageWrapper.html#_completionCancel
  Function
  Method
  PRIVATE
  Handle the expiration of the timeout for the child process to exit by terminating the child process forcefully and issuing a failure to the `completion` deferred.
- twisted.mail.alias.MessageWrapper.connectionLost
  twisted.mail.alias.MessageWrapper.html#connectionLost
  Function
  Method
  PUBLIC
  Ignore notification of lost connection.
- twisted.mail.alias.MessageWrapper.__str__
  twisted.mail.alias.MessageWrapper.html#__str__
  Function
  Method
  PUBLIC
  Build a string representation of this `MessageWrapper` instance.
- twisted.mail.alias.ProcessAliasProtocol
  twisted.mail.alias.ProcessAliasProtocol.html
  Class
  Class
  PUBLIC
  A process protocol which errbacks a deferred when the associated process ends.
- twisted.mail.alias.ProcessAliasProtocol.onEnd
  twisted.mail.alias.ProcessAliasProtocol.html#onEnd
  Attribute
  Instance Variable
  PUBLIC
  If set, a deferred on which to errback when the process ends.
- twisted.mail.alias.ProcessAliasProtocol.processEnded
  twisted.mail.alias.ProcessAliasProtocol.html#processEnded
  Function
  Method
  PUBLIC
  Call an errback.
- twisted.mail.alias.ProcessAlias
  twisted.mail.alias.ProcessAlias.html
  Class
  Class
  PUBLIC
  An alias which is handled by the execution of a program.
- twisted.mail.alias.ProcessAlias.path
  twisted.mail.alias.ProcessAlias.html#path
  Attribute
  Instance Variable
  PUBLIC
  The arguments to pass to the process. The first string is the executable's name.
- twisted.mail.alias.ProcessAlias.program
  twisted.mail.alias.ProcessAlias.html#program
  Attribute
  Instance Variable
  PUBLIC
  The path of the program to be executed.
- twisted.mail.alias.ProcessAlias.reactor
  twisted.mail.alias.ProcessAlias.html#reactor
  Attribute
  Instance Variable
  PUBLIC
  A reactor which will be used to create and timeout the child process.
- twisted.mail.alias.ProcessAlias.__init__
  twisted.mail.alias.ProcessAlias.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.mail.alias.ProcessAlias.__str__
  twisted.mail.alias.ProcessAlias.html#__str__
  Function
  Method
  PUBLIC
  Build a string representation of this `ProcessAlias` instance.
- twisted.mail.alias.ProcessAlias.spawnProcess
  twisted.mail.alias.ProcessAlias.html#spawnProcess
  Function
  Method
  PUBLIC
  Spawn a process.
- twisted.mail.alias.ProcessAlias.createMessageReceiver
  twisted.mail.alias.ProcessAlias.html#createMessageReceiver
  Function
  Method
  PUBLIC
  Launch a process and create a message receiver to pass a message to the process.
- twisted.mail.alias.MultiWrapper
  twisted.mail.alias.MultiWrapper.html
  Class
  Class
  PUBLIC
  A message receiver which delivers a single message to multiple other message receivers.
- twisted.mail.alias.MultiWrapper.objs
  twisted.mail.alias.MultiWrapper.html#objs
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`.
- twisted.mail.alias.MultiWrapper.__init__
  twisted.mail.alias.MultiWrapper.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.mail.alias.MultiWrapper.lineReceived
  twisted.mail.alias.MultiWrapper.html#lineReceived
  Function
  Method
  PUBLIC
  Pass a received line to the message receivers.
- twisted.mail.alias.MultiWrapper.eomReceived
  twisted.mail.alias.MultiWrapper.html#eomReceived
  Function
  Method
  PUBLIC
  Pass the end of message along to the message receivers.
- twisted.mail.alias.MultiWrapper.connectionLost
  twisted.mail.alias.MultiWrapper.html#connectionLost
  Function
  Method
  PUBLIC
  Inform the message receivers that the connection has been lost.
- twisted.mail.alias.MultiWrapper.__str__
  twisted.mail.alias.MultiWrapper.html#__str__
  Function
  Method
  PUBLIC
  Build a string representation of this `MultiWrapper` instance.
- twisted.mail.alias.AliasGroup
  twisted.mail.alias.AliasGroup.html
  Class
  Class
  PUBLIC
  An alias which points to multiple destination aliases.
- twisted.mail.alias.AliasGroup.processAliasFactory
  twisted.mail.alias.AliasGroup.html#processAliasFactory
  Attribute
  Instance Variable
  PUBLIC
  A factory for process aliases.
- twisted.mail.alias.AliasGroup.aliases
  twisted.mail.alias.AliasGroup.html#aliases
  Attribute
  Instance Variable
  PUBLIC
  The destination aliases.
- twisted.mail.alias.AliasGroup.__init__
  twisted.mail.alias.AliasGroup.html#__init__
  Function
  Method
  PUBLIC
  Create a group of aliases.
- twisted.mail.alias.AliasGroup.__len__
  twisted.mail.alias.AliasGroup.html#__len__
  Function
  Method
  PUBLIC
  Return the number of aliases in the group.
- twisted.mail.alias.AliasGroup.__str__
  twisted.mail.alias.AliasGroup.html#__str__
  Function
  Method
  PUBLIC
  Build a string representation of this `AliasGroup` instance.
- twisted.mail.alias.AliasGroup.createMessageReceiver
  twisted.mail.alias.AliasGroup.html#createMessageReceiver
  Function
  Method
  PUBLIC
  Create a message receiver for each alias and return a message receiver which will pass on a message to each of those.
- twisted.mail.alias.AliasGroup.resolve
  twisted.mail.alias.AliasGroup.html#resolve
  Function
  Method
  PUBLIC
  Map each of the aliases in the group to its ultimate destination.
- twisted.mail.bounce.BOUNCE_FORMAT
  twisted.mail.bounce.html#BOUNCE_FORMAT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.mail.bounce.generateBounce
  twisted.mail.bounce.html#generateBounce
  Function
  Function
  PUBLIC
  Generate a bounce message for an undeliverable email message.
- twisted.mail.imap4.IllegalClientResponse
  twisted.mail.imap4.IllegalClientResponse.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.mail.imap4.IllegalIdentifierError
  twisted.mail.imap4.IllegalIdentifierError.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.mail.imap4.IllegalMailboxEncoding
  twisted.mail.imap4.IllegalMailboxEncoding.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.mail.imap4.IllegalOperation
  twisted.mail.imap4.IllegalOperation.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.mail.imap4.IllegalQueryError
  twisted.mail.imap4.IllegalQueryError.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.mail.imap4.IllegalServerResponse
  twisted.mail.imap4.IllegalServerResponse.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Exception
  twisted.mail.imap4.IMAP4Exception.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.mail.imap4.MailboxCollision
  twisted.mail.imap4.MailboxCollision.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.mail.imap4.MailboxCollision.__str__
  twisted.mail.imap4.MailboxCollision.html#__str__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.MailboxException
  twisted.mail.imap4.MailboxException.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.mail.imap4.MismatchedNesting
  twisted.mail.imap4.MismatchedNesting.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.mail.imap4.MismatchedQuoting
  twisted.mail.imap4.MismatchedQuoting.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.mail.imap4.NegativeResponse
  twisted.mail.imap4.NegativeResponse.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.mail.imap4.NoSuchMailbox
  twisted.mail.imap4.NoSuchMailbox.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.mail.imap4.NoSuchMailbox.__str__
  twisted.mail.imap4.NoSuchMailbox.html#__str__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.NoSupportedAuthentication
  twisted.mail.imap4.NoSupportedAuthentication.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.mail.imap4.NoSupportedAuthentication.__init__
  twisted.mail.imap4.NoSupportedAuthentication.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.NoSupportedAuthentication.serverSupports
  twisted.mail.imap4.NoSupportedAuthentication.html#serverSupports
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.NoSupportedAuthentication.clientSupports
  twisted.mail.imap4.NoSupportedAuthentication.html#clientSupports
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.NoSupportedAuthentication.__str__
  twisted.mail.imap4.NoSupportedAuthentication.html#__str__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.ReadOnlyMailbox
  twisted.mail.imap4.ReadOnlyMailbox.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.mail.imap4.ReadOnlyMailbox.__str__
  twisted.mail.imap4.ReadOnlyMailbox.html#__str__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.UnhandledResponse
  twisted.mail.imap4.UnhandledResponse.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.mail.imap4._MONTH_NAMES
  twisted.mail.imap4.html#_MONTH_NAMES
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.mail.imap4._swap
  twisted.mail.imap4.html#_swap
  Function
  Function
  PRIVATE
  Swap `this` with `that` if `this` is `ifIs`.
- twisted.mail.imap4._swapAllPairs
  twisted.mail.imap4.html#_swapAllPairs
  Function
  Function
  PRIVATE
  Swap each element in each pair in `of` with `that` it is `ifIs`.
- twisted.mail.imap4.MessageSet
  twisted.mail.imap4.MessageSet.html
  Class
  Class
  PUBLIC
  A set of message identifiers usable by both `IMAP4Client` and `IMAP4Server` via `IMailboxIMAP.store` and `IMailboxIMAP.fetch`.
- twisted.mail.imap4.MessageSet.getnext
  twisted.mail.imap4.MessageSet.html#getnext
  Attribute
  Instance Variable
  PUBLIC
  A function that returns the next message number, used when iterating through the `MessageSet`. By default, a function returning the next integer is supplied, but as this can be rather inefficient for sparse UID iterations, it is recommended to supply one when messages are requested by UID...
- twisted.mail.imap4.MessageSet._empty
  twisted.mail.imap4.MessageSet.html#_empty
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.mail.imap4.MessageSet._infinity
  twisted.mail.imap4.MessageSet.html#_infinity
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.mail.imap4.MessageSet.__init__
  twisted.mail.imap4.MessageSet.html#__init__
  Function
  Method
  PUBLIC
  Create a new MessageSet()
- twisted.mail.imap4.MessageSet._last
  twisted.mail.imap4.MessageSet.html#_last
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.mail.imap4.MessageSet.ranges
  twisted.mail.imap4.MessageSet.html#ranges
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.MessageSet.last
  twisted.mail.imap4.MessageSet.html#last
  Attribute
  Property
  PUBLIC
  The largest number in use. This is undefined until it has been set by assigning to this property.
- twisted.mail.imap4.MessageSet.last.setter
  twisted.mail.imap4.MessageSet.html#last.setter
  Function
  Method
  PUBLIC
  Replaces all occurrences of "*". This should be the largest number in use. Must be set before attempting to use the MessageSet as a container.
- twisted.mail.imap4.MessageSet.add
  twisted.mail.imap4.MessageSet.html#add
  Function
  Method
  PUBLIC
  Add another range
- twisted.mail.imap4.MessageSet.__add__
  twisted.mail.imap4.MessageSet.html#__add__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.MessageSet.extend
  twisted.mail.imap4.MessageSet.html#extend
  Function
  Method
  PUBLIC
  Extend our messages with another message or set of messages.
- twisted.mail.imap4.MessageSet.clean
  twisted.mail.imap4.MessageSet.html#clean
  Function
  Method
  PUBLIC
  Clean ranges list, combining adjacent ranges
- twisted.mail.imap4.MessageSet._noneInRanges
  twisted.mail.imap4.MessageSet.html#_noneInRanges
  Function
  Method
  PRIVATE
  Is there a `None` in our ranges?
- twisted.mail.imap4.MessageSet.__contains__
  twisted.mail.imap4.MessageSet.html#__contains__
  Function
  Method
  PUBLIC
  May raise TypeError if we encounter an open-ended range
- twisted.mail.imap4.MessageSet._iterator
  twisted.mail.imap4.MessageSet.html#_iterator
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.MessageSet.__iter__
  twisted.mail.imap4.MessageSet.html#__iter__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.MessageSet.__len__
  twisted.mail.imap4.MessageSet.html#__len__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.MessageSet.__str__
  twisted.mail.imap4.MessageSet.html#__str__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.MessageSet.__repr__
  twisted.mail.imap4.MessageSet.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.MessageSet.__eq__
  twisted.mail.imap4.MessageSet.html#__eq__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.LiteralString
  twisted.mail.imap4.LiteralString.html
  Class
  Class
  PUBLIC
  No class docstring; 0/3 instance variable, 1/3 method documented
- twisted.mail.imap4.LiteralString.__init__
  twisted.mail.imap4.LiteralString.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.LiteralString.size
  twisted.mail.imap4.LiteralString.html#size
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.LiteralString.data
  twisted.mail.imap4.LiteralString.html#data
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.LiteralString.defer
  twisted.mail.imap4.LiteralString.html#defer
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.LiteralString.write
  twisted.mail.imap4.LiteralString.html#write
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.LiteralString.callback
  twisted.mail.imap4.LiteralString.html#callback
  Function
  Method
  PUBLIC
  Call deferred with data and rest of line
- twisted.mail.imap4.LiteralFile
  twisted.mail.imap4.LiteralFile.html
  Class
  Class
  PUBLIC
  No class docstring; 0/3 instance variable, 0/1 class variable, 1/3 method documented
- twisted.mail.imap4.LiteralFile._memoryFileLimit
  twisted.mail.imap4.LiteralFile.html#_memoryFileLimit
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.mail.imap4.LiteralFile.__init__
  twisted.mail.imap4.LiteralFile.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.LiteralFile.size
  twisted.mail.imap4.LiteralFile.html#size
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.LiteralFile.defer
  twisted.mail.imap4.LiteralFile.html#defer
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.LiteralFile.data
  twisted.mail.imap4.LiteralFile.html#data
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.LiteralFile.write
  twisted.mail.imap4.LiteralFile.html#write
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.LiteralFile.callback
  twisted.mail.imap4.LiteralFile.html#callback
  Function
  Method
  PUBLIC
  Call deferred with data and rest of line
- twisted.mail.imap4.WriteBuffer
  twisted.mail.imap4.WriteBuffer.html
  Class
  Class
  PUBLIC
  Buffer up a bunch of writes before sending them all to a transport at once.
- twisted.mail.imap4.WriteBuffer.__init__
  twisted.mail.imap4.WriteBuffer.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.WriteBuffer.bufferSize
  twisted.mail.imap4.WriteBuffer.html#bufferSize
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.WriteBuffer.transport
  twisted.mail.imap4.WriteBuffer.html#transport
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.WriteBuffer._length
  twisted.mail.imap4.WriteBuffer.html#_length
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.mail.imap4.WriteBuffer._writes
  twisted.mail.imap4.WriteBuffer.html#_writes
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.mail.imap4.WriteBuffer.write
  twisted.mail.imap4.WriteBuffer.html#write
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.WriteBuffer.flush
  twisted.mail.imap4.WriteBuffer.html#flush
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.Command
  twisted.mail.imap4.Command.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.mail.imap4.Command._1_RESPONSES
  twisted.mail.imap4.Command.html#_1_RESPONSES
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.mail.imap4.Command._2_RESPONSES
  twisted.mail.imap4.Command.html#_2_RESPONSES
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.mail.imap4.Command._OK_RESPONSES
  twisted.mail.imap4.Command.html#_OK_RESPONSES
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.mail.imap4.Command.defer
  twisted.mail.imap4.Command.html#defer
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.Command.__init__
  twisted.mail.imap4.Command.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.Command.command
  twisted.mail.imap4.Command.html#command
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.Command.args
  twisted.mail.imap4.Command.html#args
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.Command.wantResponse
  twisted.mail.imap4.Command.html#wantResponse
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.Command.continuation
  twisted.mail.imap4.Command.html#continuation
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.Command.lines
  twisted.mail.imap4.Command.html#lines
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.Command.__repr__
  twisted.mail.imap4.Command.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.Command.format
  twisted.mail.imap4.Command.html#format
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.Command.finish
  twisted.mail.imap4.Command.html#finish
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4._SP
  twisted.mail.imap4.html#_SP
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.mail.imap4._CTL
  twisted.mail.imap4.html#_CTL
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.mail.imap4._nonAtomChars
  twisted.mail.imap4.html#_nonAtomChars
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.mail.imap4._nativeNonAtomChars
  twisted.mail.imap4.html#_nativeNonAtomChars
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.mail.imap4._nonAtomRE
  twisted.mail.imap4.html#_nonAtomRE
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.mail.imap4._atomChars
  twisted.mail.imap4.html#_atomChars
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Server
  twisted.mail.imap4.IMAP4Server.html
  Class
  Class
  PUBLIC
  Protocol implementation for an IMAP4rev1 server.
- twisted.mail.imap4.IMAP4Server.IDENT
  twisted.mail.imap4.IMAP4Server.html#IDENT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.timeOut
  twisted.mail.imap4.IMAP4Server.html#timeOut
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.POSTAUTH_TIMEOUT
  twisted.mail.imap4.IMAP4Server.html#POSTAUTH_TIMEOUT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.startedTLS
  twisted.mail.imap4.IMAP4Server.html#startedTLS
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.canStartTLS
  twisted.mail.imap4.IMAP4Server.html#canStartTLS
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.tags
  twisted.mail.imap4.IMAP4Server.html#tags
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.portal
  twisted.mail.imap4.IMAP4Server.html#portal
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.account
  twisted.mail.imap4.IMAP4Server.html#account
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server._onLogout
  twisted.mail.imap4.IMAP4Server.html#_onLogout
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Server.mbox
  twisted.mail.imap4.IMAP4Server.html#mbox
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server._pendingLiteral
  twisted.mail.imap4.IMAP4Server.html#_pendingLiteral
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Server._literalStringLimit
  twisted.mail.imap4.IMAP4Server.html#_literalStringLimit
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Server.challengers
  twisted.mail.imap4.IMAP4Server.html#challengers
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server._requiresLastMessageInfo
  twisted.mail.imap4.IMAP4Server.html#_requiresLastMessageInfo
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Server.state
  twisted.mail.imap4.IMAP4Server.html#state
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.parseState
  twisted.mail.imap4.IMAP4Server.html#parseState
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.__init__
  twisted.mail.imap4.IMAP4Server.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.ctx
  twisted.mail.imap4.IMAP4Server.html#ctx
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server._scheduler
  twisted.mail.imap4.IMAP4Server.html#_scheduler
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Server._queuedAsync
  twisted.mail.imap4.IMAP4Server.html#_queuedAsync
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Server.capabilities
  twisted.mail.imap4.IMAP4Server.html#capabilities
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.connectionMade
  twisted.mail.imap4.IMAP4Server.html#connectionMade
  Function
  Method
  PUBLIC
  Called when a connection is made.
- twisted.mail.imap4.IMAP4Server.connectionLost
  twisted.mail.imap4.IMAP4Server.html#connectionLost
  Function
  Method
  PUBLIC
  Called when the connection is shut down.
- twisted.mail.imap4.IMAP4Server.timeoutConnection
  twisted.mail.imap4.IMAP4Server.html#timeoutConnection
  Function
  Method
  PUBLIC
  Called when the connection times out.
- twisted.mail.imap4.IMAP4Server.rawDataReceived
  twisted.mail.imap4.IMAP4Server.html#rawDataReceived
  Function
  Method
  PUBLIC
  Override this for when raw data is received.
- twisted.mail.imap4.IMAP4Server.blocked
  twisted.mail.imap4.IMAP4Server.html#blocked
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server._unblock
  twisted.mail.imap4.IMAP4Server.html#_unblock
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Server.lineReceived
  twisted.mail.imap4.IMAP4Server.html#lineReceived
  Function
  Method
  PUBLIC
  Override this for when each line is received.
- twisted.mail.imap4.IMAP4Server.parse_command
  twisted.mail.imap4.IMAP4Server.html#parse_command
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.parse_pending
  twisted.mail.imap4.IMAP4Server.html#parse_pending
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.dispatchCommand
  twisted.mail.imap4.IMAP4Server.html#dispatchCommand
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.lookupCommand
  twisted.mail.imap4.IMAP4Server.html#lookupCommand
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.__doCommand
  twisted.mail.imap4.IMAP4Server.html#__doCommand
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Server.__cbDispatch
  twisted.mail.imap4.IMAP4Server.html#__cbDispatch
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Server.__ebDispatch
  twisted.mail.imap4.IMAP4Server.html#__ebDispatch
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Server._stringLiteral
  twisted.mail.imap4.IMAP4Server.html#_stringLiteral
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Server._fileLiteral
  twisted.mail.imap4.IMAP4Server.html#_fileLiteral
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Server.arg_finalastring
  twisted.mail.imap4.IMAP4Server.html#arg_finalastring
  Function
  Method
  PUBLIC
  Parse an astring from line that represents a command's final argument. This special case exists to enable parsing empty string literals.
- twisted.mail.imap4.IMAP4Server.arg_astring
  twisted.mail.imap4.IMAP4Server.html#arg_astring
  Function
  Method
  PUBLIC
  Parse an astring from the line, return (arg, rest), possibly via a deferred (to handle literals)
- twisted.mail.imap4.IMAP4Server.atomre
  twisted.mail.imap4.IMAP4Server.html#atomre
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.arg_atom
  twisted.mail.imap4.IMAP4Server.html#arg_atom
  Function
  Method
  PUBLIC
  Parse an atom from the line
- twisted.mail.imap4.IMAP4Server.arg_plist
  twisted.mail.imap4.IMAP4Server.html#arg_plist
  Function
  Method
  PUBLIC
  Parse a (non-nested) parenthesised list from the line
- twisted.mail.imap4.IMAP4Server.arg_literal
  twisted.mail.imap4.IMAP4Server.html#arg_literal
  Function
  Method
  PUBLIC
  Parse a literal from the line
- twisted.mail.imap4.IMAP4Server.arg_searchkeys
  twisted.mail.imap4.IMAP4Server.html#arg_searchkeys
  Function
  Method
  PUBLIC
  searchkeys
- twisted.mail.imap4.IMAP4Server.arg_seqset
  twisted.mail.imap4.IMAP4Server.html#arg_seqset
  Function
  Method
  PUBLIC
  sequence-set
- twisted.mail.imap4.IMAP4Server.arg_fetchatt
  twisted.mail.imap4.IMAP4Server.html#arg_fetchatt
  Function
  Method
  PUBLIC
  fetch-att
- twisted.mail.imap4.IMAP4Server.arg_flaglist
  twisted.mail.imap4.IMAP4Server.html#arg_flaglist
  Function
  Method
  PUBLIC
  Flag part of store-att-flag
- twisted.mail.imap4.IMAP4Server.arg_line
  twisted.mail.imap4.IMAP4Server.html#arg_line
  Function
  Method
  PUBLIC
  Command line of UID command
- twisted.mail.imap4.IMAP4Server.opt_plist
  twisted.mail.imap4.IMAP4Server.html#opt_plist
  Function
  Method
  PUBLIC
  Optional parenthesised list
- twisted.mail.imap4.IMAP4Server.opt_datetime
  twisted.mail.imap4.IMAP4Server.html#opt_datetime
  Function
  Method
  PUBLIC
  Optional date-time string
- twisted.mail.imap4.IMAP4Server.opt_charset
  twisted.mail.imap4.IMAP4Server.html#opt_charset
  Function
  Method
  PUBLIC
  Optional charset of SEARCH command
- twisted.mail.imap4.IMAP4Server.sendServerGreeting
  twisted.mail.imap4.IMAP4Server.html#sendServerGreeting
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.sendBadResponse
  twisted.mail.imap4.IMAP4Server.html#sendBadResponse
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.sendPositiveResponse
  twisted.mail.imap4.IMAP4Server.html#sendPositiveResponse
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.sendNegativeResponse
  twisted.mail.imap4.IMAP4Server.html#sendNegativeResponse
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.sendUntaggedResponse
  twisted.mail.imap4.IMAP4Server.html#sendUntaggedResponse
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.sendContinuationRequest
  twisted.mail.imap4.IMAP4Server.html#sendContinuationRequest
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server._respond
  twisted.mail.imap4.IMAP4Server.html#_respond
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Server.listCapabilities
  twisted.mail.imap4.IMAP4Server.html#listCapabilities
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.do_CAPABILITY
  twisted.mail.imap4.IMAP4Server.html#do_CAPABILITY
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.unauth_CAPABILITY
  twisted.mail.imap4.IMAP4Server.html#unauth_CAPABILITY
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.do_LOGOUT
  twisted.mail.imap4.IMAP4Server.html#do_LOGOUT
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.unauth_LOGOUT
  twisted.mail.imap4.IMAP4Server.html#unauth_LOGOUT
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.do_NOOP
  twisted.mail.imap4.IMAP4Server.html#do_NOOP
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.unauth_NOOP
  twisted.mail.imap4.IMAP4Server.html#unauth_NOOP
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.do_AUTHENTICATE
  twisted.mail.imap4.IMAP4Server.html#do_AUTHENTICATE
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.unauth_AUTHENTICATE
  twisted.mail.imap4.IMAP4Server.html#unauth_AUTHENTICATE
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.authenticate
  twisted.mail.imap4.IMAP4Server.html#authenticate
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server._setupChallenge
  twisted.mail.imap4.IMAP4Server.html#_setupChallenge
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Server.__cbAuthChunk
  twisted.mail.imap4.IMAP4Server.html#__cbAuthChunk
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Server.__cbAuthResp
  twisted.mail.imap4.IMAP4Server.html#__cbAuthResp
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Server.__ebAuthResp
  twisted.mail.imap4.IMAP4Server.html#__ebAuthResp
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Server.__ebAuthChunk
  twisted.mail.imap4.IMAP4Server.html#__ebAuthChunk
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Server.do_STARTTLS
  twisted.mail.imap4.IMAP4Server.html#do_STARTTLS
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.unauth_STARTTLS
  twisted.mail.imap4.IMAP4Server.html#unauth_STARTTLS
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.do_LOGIN
  twisted.mail.imap4.IMAP4Server.html#do_LOGIN
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.unauth_LOGIN
  twisted.mail.imap4.IMAP4Server.html#unauth_LOGIN
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.authenticateLogin
  twisted.mail.imap4.IMAP4Server.html#authenticateLogin
  Function
  Method
  PUBLIC
  Lookup the account associated with the given parameters
- twisted.mail.imap4.IMAP4Server.__cbLogin
  twisted.mail.imap4.IMAP4Server.html#__cbLogin
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Server.__ebLogin
  twisted.mail.imap4.IMAP4Server.html#__ebLogin
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Server.do_NAMESPACE
  twisted.mail.imap4.IMAP4Server.html#do_NAMESPACE
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.auth_NAMESPACE
  twisted.mail.imap4.IMAP4Server.html#auth_NAMESPACE
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server._selectWork
  twisted.mail.imap4.IMAP4Server.html#_selectWork
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Server._ebSelectWork
  twisted.mail.imap4.IMAP4Server.html#_ebSelectWork
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Server._cbSelectWork
  twisted.mail.imap4.IMAP4Server.html#_cbSelectWork
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Server.auth_SELECT
  twisted.mail.imap4.IMAP4Server.html#auth_SELECT
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.auth_EXAMINE
  twisted.mail.imap4.IMAP4Server.html#auth_EXAMINE
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.do_IDLE
  twisted.mail.imap4.IMAP4Server.html#do_IDLE
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.parseTag
  twisted.mail.imap4.IMAP4Server.html#parseTag
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.lastState
  twisted.mail.imap4.IMAP4Server.html#lastState
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.parse_idle
  twisted.mail.imap4.IMAP4Server.html#parse_idle
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.select_IDLE
  twisted.mail.imap4.IMAP4Server.html#select_IDLE
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.do_CREATE
  twisted.mail.imap4.IMAP4Server.html#do_CREATE
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.auth_CREATE
  twisted.mail.imap4.IMAP4Server.html#auth_CREATE
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.do_DELETE
  twisted.mail.imap4.IMAP4Server.html#do_DELETE
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.auth_DELETE
  twisted.mail.imap4.IMAP4Server.html#auth_DELETE
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.do_RENAME
  twisted.mail.imap4.IMAP4Server.html#do_RENAME
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.auth_RENAME
  twisted.mail.imap4.IMAP4Server.html#auth_RENAME
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.do_SUBSCRIBE
  twisted.mail.imap4.IMAP4Server.html#do_SUBSCRIBE
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.auth_SUBSCRIBE
  twisted.mail.imap4.IMAP4Server.html#auth_SUBSCRIBE
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.do_UNSUBSCRIBE
  twisted.mail.imap4.IMAP4Server.html#do_UNSUBSCRIBE
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.auth_UNSUBSCRIBE
  twisted.mail.imap4.IMAP4Server.html#auth_UNSUBSCRIBE
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server._listWork
  twisted.mail.imap4.IMAP4Server.html#_listWork
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Server._cbListWork
  twisted.mail.imap4.IMAP4Server.html#_cbListWork
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Server._ebListWork
  twisted.mail.imap4.IMAP4Server.html#_ebListWork
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Server.auth_LIST
  twisted.mail.imap4.IMAP4Server.html#auth_LIST
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.auth_LSUB
  twisted.mail.imap4.IMAP4Server.html#auth_LSUB
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.do_STATUS
  twisted.mail.imap4.IMAP4Server.html#do_STATUS
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server._cbStatusGotMailbox
  twisted.mail.imap4.IMAP4Server.html#_cbStatusGotMailbox
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Server._ebStatusGotMailbox
  twisted.mail.imap4.IMAP4Server.html#_ebStatusGotMailbox
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Server.auth_STATUS
  twisted.mail.imap4.IMAP4Server.html#auth_STATUS
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.__cbStatus
  twisted.mail.imap4.IMAP4Server.html#__cbStatus
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Server.__ebStatus
  twisted.mail.imap4.IMAP4Server.html#__ebStatus
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Server.do_APPEND
  twisted.mail.imap4.IMAP4Server.html#do_APPEND
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server._cbAppendGotMailbox
  twisted.mail.imap4.IMAP4Server.html#_cbAppendGotMailbox
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Server._ebAppendGotMailbox
  twisted.mail.imap4.IMAP4Server.html#_ebAppendGotMailbox
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Server.auth_APPEND
  twisted.mail.imap4.IMAP4Server.html#auth_APPEND
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.__cbAppend
  twisted.mail.imap4.IMAP4Server.html#__cbAppend
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Server.__ebAppend
  twisted.mail.imap4.IMAP4Server.html#__ebAppend
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Server.do_CHECK
  twisted.mail.imap4.IMAP4Server.html#do_CHECK
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.select_CHECK
  twisted.mail.imap4.IMAP4Server.html#select_CHECK
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.__cbCheck
  twisted.mail.imap4.IMAP4Server.html#__cbCheck
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Server.__ebCheck
  twisted.mail.imap4.IMAP4Server.html#__ebCheck
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Server.checkpoint
  twisted.mail.imap4.IMAP4Server.html#checkpoint
  Function
  Method
  PUBLIC
  Called when the client issues a CHECK command.
- twisted.mail.imap4.IMAP4Server.do_CLOSE
  twisted.mail.imap4.IMAP4Server.html#do_CLOSE
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.select_CLOSE
  twisted.mail.imap4.IMAP4Server.html#select_CLOSE
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.__cbClose
  twisted.mail.imap4.IMAP4Server.html#__cbClose
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Server.__ebClose
  twisted.mail.imap4.IMAP4Server.html#__ebClose
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Server.do_EXPUNGE
  twisted.mail.imap4.IMAP4Server.html#do_EXPUNGE
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.select_EXPUNGE
  twisted.mail.imap4.IMAP4Server.html#select_EXPUNGE
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.__cbExpunge
  twisted.mail.imap4.IMAP4Server.html#__cbExpunge
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Server.__ebExpunge
  twisted.mail.imap4.IMAP4Server.html#__ebExpunge
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Server.do_SEARCH
  twisted.mail.imap4.IMAP4Server.html#do_SEARCH
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.select_SEARCH
  twisted.mail.imap4.IMAP4Server.html#select_SEARCH
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.__cbSearch
  twisted.mail.imap4.IMAP4Server.html#__cbSearch
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Server.__cbManualSearch
  twisted.mail.imap4.IMAP4Server.html#__cbManualSearch
  Function
  Method
  PRIVATE
  Apply the search filter to a set of messages. Send the response to the client.
- twisted.mail.imap4.IMAP4Server._searchFilter
  twisted.mail.imap4.IMAP4Server.html#_searchFilter
  Function
  Method
  PRIVATE
  Pop search terms from the beginning of `query` until there are none left and apply them to the given message.
- twisted.mail.imap4.IMAP4Server._singleSearchStep
  twisted.mail.imap4.IMAP4Server.html#_singleSearchStep
  Function
  Method
  PRIVATE
  Pop one search term from the beginning of `query` (possibly more than one element) and return whether it matches the given message.
- twisted.mail.imap4.IMAP4Server.search_ALL
  twisted.mail.imap4.IMAP4Server.html#search_ALL
  Function
  Method
  PUBLIC
  Returns `True` if the message matches the ALL search key (always).
- twisted.mail.imap4.IMAP4Server.search_ANSWERED
  twisted.mail.imap4.IMAP4Server.html#search_ANSWERED
  Function
  Method
  PUBLIC
  Returns `True` if the message has been answered.
- twisted.mail.imap4.IMAP4Server.search_BCC
  twisted.mail.imap4.IMAP4Server.html#search_BCC
  Function
  Method
  PUBLIC
  Returns `True` if the message has a BCC address matching the query.
- twisted.mail.imap4.IMAP4Server.search_BEFORE
  twisted.mail.imap4.IMAP4Server.html#search_BEFORE
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.search_BODY
  twisted.mail.imap4.IMAP4Server.html#search_BODY
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.search_CC
  twisted.mail.imap4.IMAP4Server.html#search_CC
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.search_DELETED
  twisted.mail.imap4.IMAP4Server.html#search_DELETED
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.search_DRAFT
  twisted.mail.imap4.IMAP4Server.html#search_DRAFT
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.search_FLAGGED
  twisted.mail.imap4.IMAP4Server.html#search_FLAGGED
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.search_FROM
  twisted.mail.imap4.IMAP4Server.html#search_FROM
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.search_HEADER
  twisted.mail.imap4.IMAP4Server.html#search_HEADER
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.search_KEYWORD
  twisted.mail.imap4.IMAP4Server.html#search_KEYWORD
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.search_LARGER
  twisted.mail.imap4.IMAP4Server.html#search_LARGER
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.search_NEW
  twisted.mail.imap4.IMAP4Server.html#search_NEW
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.search_NOT
  twisted.mail.imap4.IMAP4Server.html#search_NOT
  Function
  Method
  PUBLIC
  Returns `True` if the message does not match the query.
- twisted.mail.imap4.IMAP4Server.search_OLD
  twisted.mail.imap4.IMAP4Server.html#search_OLD
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.search_ON
  twisted.mail.imap4.IMAP4Server.html#search_ON
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.search_OR
  twisted.mail.imap4.IMAP4Server.html#search_OR
  Function
  Method
  PUBLIC
  Returns `True` if the message matches any of the first two query items.
- twisted.mail.imap4.IMAP4Server.search_RECENT
  twisted.mail.imap4.IMAP4Server.html#search_RECENT
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.search_SEEN
  twisted.mail.imap4.IMAP4Server.html#search_SEEN
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.search_SENTBEFORE
  twisted.mail.imap4.IMAP4Server.html#search_SENTBEFORE
  Function
  Method
  PUBLIC
  Returns `True` if the message date is earlier than the query date.
- twisted.mail.imap4.IMAP4Server.search_SENTON
  twisted.mail.imap4.IMAP4Server.html#search_SENTON
  Function
  Method
  PUBLIC
  Returns `True` if the message date is the same as the query date.
- twisted.mail.imap4.IMAP4Server.search_SENTSINCE
  twisted.mail.imap4.IMAP4Server.html#search_SENTSINCE
  Function
  Method
  PUBLIC
  Returns `True` if the message date is later than the query date.
- twisted.mail.imap4.IMAP4Server.search_SINCE
  twisted.mail.imap4.IMAP4Server.html#search_SINCE
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.search_SMALLER
  twisted.mail.imap4.IMAP4Server.html#search_SMALLER
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.search_SUBJECT
  twisted.mail.imap4.IMAP4Server.html#search_SUBJECT
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.search_TEXT
  twisted.mail.imap4.IMAP4Server.html#search_TEXT
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.search_TO
  twisted.mail.imap4.IMAP4Server.html#search_TO
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.search_UID
  twisted.mail.imap4.IMAP4Server.html#search_UID
  Function
  Method
  PUBLIC
  Returns `True` if the message UID is in the range defined by the search query.
- twisted.mail.imap4.IMAP4Server.search_UNANSWERED
  twisted.mail.imap4.IMAP4Server.html#search_UNANSWERED
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.search_UNDELETED
  twisted.mail.imap4.IMAP4Server.html#search_UNDELETED
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.search_UNDRAFT
  twisted.mail.imap4.IMAP4Server.html#search_UNDRAFT
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.search_UNFLAGGED
  twisted.mail.imap4.IMAP4Server.html#search_UNFLAGGED
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.search_UNKEYWORD
  twisted.mail.imap4.IMAP4Server.html#search_UNKEYWORD
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.search_UNSEEN
  twisted.mail.imap4.IMAP4Server.html#search_UNSEEN
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.__ebSearch
  twisted.mail.imap4.IMAP4Server.html#__ebSearch
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Server.do_FETCH
  twisted.mail.imap4.IMAP4Server.html#do_FETCH
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server._oldTimeout
  twisted.mail.imap4.IMAP4Server.html#_oldTimeout
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Server.select_FETCH
  twisted.mail.imap4.IMAP4Server.html#select_FETCH
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.__cbFetch
  twisted.mail.imap4.IMAP4Server.html#__cbFetch
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Server.__ebSpewMessage
  twisted.mail.imap4.IMAP4Server.html#__ebSpewMessage
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Server.spew_envelope
  twisted.mail.imap4.IMAP4Server.html#spew_envelope
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.spew_flags
  twisted.mail.imap4.IMAP4Server.html#spew_flags
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.spew_internaldate
  twisted.mail.imap4.IMAP4Server.html#spew_internaldate
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.spew_rfc822header
  twisted.mail.imap4.IMAP4Server.html#spew_rfc822header
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.spew_rfc822text
  twisted.mail.imap4.IMAP4Server.html#spew_rfc822text
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.spew_rfc822size
  twisted.mail.imap4.IMAP4Server.html#spew_rfc822size
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.spew_rfc822
  twisted.mail.imap4.IMAP4Server.html#spew_rfc822
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.spew_uid
  twisted.mail.imap4.IMAP4Server.html#spew_uid
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.spew_bodystructure
  twisted.mail.imap4.IMAP4Server.html#spew_bodystructure
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.spew_body
  twisted.mail.imap4.IMAP4Server.html#spew_body
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.spewMessage
  twisted.mail.imap4.IMAP4Server.html#spewMessage
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.__ebFetch
  twisted.mail.imap4.IMAP4Server.html#__ebFetch
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Server.do_STORE
  twisted.mail.imap4.IMAP4Server.html#do_STORE
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.select_STORE
  twisted.mail.imap4.IMAP4Server.html#select_STORE
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.__cbStore
  twisted.mail.imap4.IMAP4Server.html#__cbStore
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Server.__ebStore
  twisted.mail.imap4.IMAP4Server.html#__ebStore
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Server.do_COPY
  twisted.mail.imap4.IMAP4Server.html#do_COPY
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.select_COPY
  twisted.mail.imap4.IMAP4Server.html#select_COPY
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server._cbCopySelectedMailbox
  twisted.mail.imap4.IMAP4Server.html#_cbCopySelectedMailbox
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Server._ebCopySelectedMailbox
  twisted.mail.imap4.IMAP4Server.html#_ebCopySelectedMailbox
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Server.__cbCopy
  twisted.mail.imap4.IMAP4Server.html#__cbCopy
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Server.__cbCopied
  twisted.mail.imap4.IMAP4Server.html#__cbCopied
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Server.__ebCopy
  twisted.mail.imap4.IMAP4Server.html#__ebCopy
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Server.do_UID
  twisted.mail.imap4.IMAP4Server.html#do_UID
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.select_UID
  twisted.mail.imap4.IMAP4Server.html#select_UID
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Server.modeChanged
  twisted.mail.imap4.IMAP4Server.html#modeChanged
  Function
  Method
  PUBLIC
  Indicates that the write status of a mailbox has changed.
- twisted.mail.imap4.IMAP4Server.flagsChanged
  twisted.mail.imap4.IMAP4Server.html#flagsChanged
  Function
  Method
  PUBLIC
  Indicates that the flags of one or more messages have changed.
- twisted.mail.imap4.IMAP4Server.newMessages
  twisted.mail.imap4.IMAP4Server.html#newMessages
  Function
  Method
  PUBLIC
  Indicates that the number of messages in a mailbox has changed.
- twisted.mail.imap4.TIMEOUT_ERROR
  twisted.mail.imap4.html#TIMEOUT_ERROR
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Client
  twisted.mail.imap4.IMAP4Client.html
  Class
  Class
  PUBLIC
  IMAP4 client protocol implementation
- twisted.mail.imap4.IMAP4Client.state
  twisted.mail.imap4.IMAP4Client.html#state
  Attribute
  Instance Variable
  PUBLIC
  A string representing the state the connection is currently in.
- twisted.mail.imap4.IMAP4Client.tags
  twisted.mail.imap4.IMAP4Client.html#tags
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Client.waiting
  twisted.mail.imap4.IMAP4Client.html#waiting
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Client.queued
  twisted.mail.imap4.IMAP4Client.html#queued
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Client.tagID
  twisted.mail.imap4.IMAP4Client.html#tagID
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Client.startedTLS
  twisted.mail.imap4.IMAP4Client.html#startedTLS
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Client.timeout
  twisted.mail.imap4.IMAP4Client.html#timeout
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Client._capCache
  twisted.mail.imap4.IMAP4Client.html#_capCache
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Client._memoryFileLimit
  twisted.mail.imap4.IMAP4Client.html#_memoryFileLimit
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Client.authenticators
  twisted.mail.imap4.IMAP4Client.html#authenticators
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Client.STATUS_CODES
  twisted.mail.imap4.IMAP4Client.html#STATUS_CODES
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Client.STATUS_TRANSFORMATIONS
  twisted.mail.imap4.IMAP4Client.html#STATUS_TRANSFORMATIONS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Client.context
  twisted.mail.imap4.IMAP4Client.html#context
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Client.__init__
  twisted.mail.imap4.IMAP4Client.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Client._tag
  twisted.mail.imap4.IMAP4Client.html#_tag
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Client._parts
  twisted.mail.imap4.IMAP4Client.html#_parts
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Client._lastCmd
  twisted.mail.imap4.IMAP4Client.html#_lastCmd
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Client.registerAuthenticator
  twisted.mail.imap4.IMAP4Client.html#registerAuthenticator
  Function
  Method
  PUBLIC
  Register a new form of authentication
- twisted.mail.imap4.IMAP4Client.rawDataReceived
  twisted.mail.imap4.IMAP4Client.html#rawDataReceived
  Function
  Method
  PUBLIC
  Override this for when raw data is received.
- twisted.mail.imap4.IMAP4Client._setupForLiteral
  twisted.mail.imap4.IMAP4Client.html#_setupForLiteral
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Client._pendingBuffer
  twisted.mail.imap4.IMAP4Client.html#_pendingBuffer
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Client._pendingSize
  twisted.mail.imap4.IMAP4Client.html#_pendingSize
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Client.connectionMade
  twisted.mail.imap4.IMAP4Client.html#connectionMade
  Function
  Method
  PUBLIC
  Called when a connection is made.
- twisted.mail.imap4.IMAP4Client.connectionLost
  twisted.mail.imap4.IMAP4Client.html#connectionLost
  Function
  Method
  PUBLIC
  We are no longer connected
- twisted.mail.imap4.IMAP4Client.lineReceived
  twisted.mail.imap4.IMAP4Client.html#lineReceived
  Function
  Method
  PUBLIC
  Attempt to parse a single line from the server.
- twisted.mail.imap4.IMAP4Client.timeoutConnection
  twisted.mail.imap4.IMAP4Client.html#timeoutConnection
  Function
  Method
  PUBLIC
  Called when the connection times out.
- twisted.mail.imap4.IMAP4Client._regularDispatch
  twisted.mail.imap4.IMAP4Client.html#_regularDispatch
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Client.messageFile
  twisted.mail.imap4.IMAP4Client.html#messageFile
  Function
  Method
  PUBLIC
  Create a file to which an incoming message may be written.
- twisted.mail.imap4.IMAP4Client.makeTag
  twisted.mail.imap4.IMAP4Client.html#makeTag
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Client.dispatchCommand
  twisted.mail.imap4.IMAP4Client.html#dispatchCommand
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Client.response_UNAUTH
  twisted.mail.imap4.IMAP4Client.html#response_UNAUTH
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Client.response_AUTH
  twisted.mail.imap4.IMAP4Client.html#response_AUTH
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Client._defaultHandler
  twisted.mail.imap4.IMAP4Client.html#_defaultHandler
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Client._flushQueue
  twisted.mail.imap4.IMAP4Client.html#_flushQueue
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Client._extraInfo
  twisted.mail.imap4.IMAP4Client.html#_extraInfo
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Client.sendCommand
  twisted.mail.imap4.IMAP4Client.html#sendCommand
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.IMAP4Client.getCapabilities
  twisted.mail.imap4.IMAP4Client.html#getCapabilities
  Function
  Method
  PUBLIC
  Request the capabilities available on this server.
- twisted.mail.imap4.IMAP4Client.__cbCapabilities
  twisted.mail.imap4.IMAP4Client.html#__cbCapabilities
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Client.logout
  twisted.mail.imap4.IMAP4Client.html#logout
  Function
  Method
  PUBLIC
  Inform the server that we are done with the connection.
- twisted.mail.imap4.IMAP4Client.__cbLogout
  twisted.mail.imap4.IMAP4Client.html#__cbLogout
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Client.noop
  twisted.mail.imap4.IMAP4Client.html#noop
  Function
  Method
  PUBLIC
  Perform no operation.
- twisted.mail.imap4.IMAP4Client.__cbNoop
  twisted.mail.imap4.IMAP4Client.html#__cbNoop
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Client.startTLS
  twisted.mail.imap4.IMAP4Client.html#startTLS
  Function
  Method
  PUBLIC
  Initiates a 'STARTTLS' request and negotiates the TLS / SSL Handshake.
- twisted.mail.imap4.IMAP4Client.authenticate
  twisted.mail.imap4.IMAP4Client.html#authenticate
  Function
  Method
  PUBLIC
  Attempt to enter the authenticated state with the server
- twisted.mail.imap4.IMAP4Client.__cbAuthenticate
  twisted.mail.imap4.IMAP4Client.html#__cbAuthenticate
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Client.__cbContinueAuth
  twisted.mail.imap4.IMAP4Client.html#__cbContinueAuth
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Client.__cbAuthTLS
  twisted.mail.imap4.IMAP4Client.html#__cbAuthTLS
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Client.login
  twisted.mail.imap4.IMAP4Client.html#login
  Function
  Method
  PUBLIC
  Authenticate with the server using a username and password
- twisted.mail.imap4.IMAP4Client.serverGreeting
  twisted.mail.imap4.IMAP4Client.html#serverGreeting
  Function
  Method
  PUBLIC
  Called when the server has sent us a greeting.
- twisted.mail.imap4.IMAP4Client._getContextFactory
  twisted.mail.imap4.IMAP4Client.html#_getContextFactory
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Client.__cbLoginCaps
  twisted.mail.imap4.IMAP4Client.html#__cbLoginCaps
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Client._startedTLS
  twisted.mail.imap4.IMAP4Client.html#_startedTLS
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Client.__cbLoginTLS
  twisted.mail.imap4.IMAP4Client.html#__cbLoginTLS
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Client.__ebLoginTLS
  twisted.mail.imap4.IMAP4Client.html#__ebLoginTLS
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Client.namespace
  twisted.mail.imap4.IMAP4Client.html#namespace
  Function
  Method
  PUBLIC
  Retrieve information about the namespaces available to this account
- twisted.mail.imap4.IMAP4Client.__cbNamespace
  twisted.mail.imap4.IMAP4Client.html#__cbNamespace
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Client.select
  twisted.mail.imap4.IMAP4Client.html#select
  Function
  Method
  PUBLIC
  Select a mailbox
- twisted.mail.imap4.IMAP4Client.examine
  twisted.mail.imap4.IMAP4Client.html#examine
  Function
  Method
  PUBLIC
  Select a mailbox in read-only mode
- twisted.mail.imap4.IMAP4Client._intOrRaise
  twisted.mail.imap4.IMAP4Client.html#_intOrRaise
  Function
  Method
  PRIVATE
  Parse `value` as an integer and return the result or raise `IllegalServerResponse` with `phrase` as an argument if `value` cannot be parsed as an integer.
- twisted.mail.imap4.IMAP4Client.__cbSelect
  twisted.mail.imap4.IMAP4Client.html#__cbSelect
  Function
  Method
  PRIVATE
  Handle lines received in response to a SELECT or EXAMINE command.
- twisted.mail.imap4.IMAP4Client.create
  twisted.mail.imap4.IMAP4Client.html#create
  Function
  Method
  PUBLIC
  Create a new mailbox on the server
- twisted.mail.imap4.IMAP4Client.delete
  twisted.mail.imap4.IMAP4Client.html#delete
  Function
  Method
  PUBLIC
  Delete a mailbox
- twisted.mail.imap4.IMAP4Client.rename
  twisted.mail.imap4.IMAP4Client.html#rename
  Function
  Method
  PUBLIC
  Rename a mailbox
- twisted.mail.imap4.IMAP4Client.subscribe
  twisted.mail.imap4.IMAP4Client.html#subscribe
  Function
  Method
  PUBLIC
  Add a mailbox to the subscription list
- twisted.mail.imap4.IMAP4Client.unsubscribe
  twisted.mail.imap4.IMAP4Client.html#unsubscribe
  Function
  Method
  PUBLIC
  Remove a mailbox from the subscription list
- twisted.mail.imap4.IMAP4Client.list
  twisted.mail.imap4.IMAP4Client.html#list
  Function
  Method
  PUBLIC
  List a subset of the available mailboxes
- twisted.mail.imap4.IMAP4Client.lsub
  twisted.mail.imap4.IMAP4Client.html#lsub
  Function
  Method
  PUBLIC
  List a subset of the subscribed available mailboxes
- twisted.mail.imap4.IMAP4Client.__cbList
  twisted.mail.imap4.IMAP4Client.html#__cbList
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Client._statusNames
  twisted.mail.imap4.IMAP4Client.html#_statusNames
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Client.status
  twisted.mail.imap4.IMAP4Client.html#status
  Function
  Method
  PUBLIC
  Retrieve the status of the given mailbox
- twisted.mail.imap4.IMAP4Client.__cbStatus
  twisted.mail.imap4.IMAP4Client.html#__cbStatus
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Client.append
  twisted.mail.imap4.IMAP4Client.html#append
  Function
  Method
  PUBLIC
  Add the given message to the given mailbox.
- twisted.mail.imap4.IMAP4Client.__cbContinueAppend
  twisted.mail.imap4.IMAP4Client.html#__cbContinueAppend
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Client.__cbFinishAppend
  twisted.mail.imap4.IMAP4Client.html#__cbFinishAppend
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Client.check
  twisted.mail.imap4.IMAP4Client.html#check
  Function
  Method
  PUBLIC
  Tell the server to perform a checkpoint
- twisted.mail.imap4.IMAP4Client.close
  twisted.mail.imap4.IMAP4Client.html#close
  Function
  Method
  PUBLIC
  Return the connection to the Authenticated state.
- twisted.mail.imap4.IMAP4Client.expunge
  twisted.mail.imap4.IMAP4Client.html#expunge
  Function
  Method
  PUBLIC
  Return the connection to the Authenticate state.
- twisted.mail.imap4.IMAP4Client.__cbExpunge
  twisted.mail.imap4.IMAP4Client.html#__cbExpunge
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Client.search
  twisted.mail.imap4.IMAP4Client.html#search
  Function
  Method
  PUBLIC
  Search messages in the currently selected mailbox
- twisted.mail.imap4.IMAP4Client.__cbSearch
  twisted.mail.imap4.IMAP4Client.html#__cbSearch
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Client.fetchUID
  twisted.mail.imap4.IMAP4Client.html#fetchUID
  Function
  Method
  PUBLIC
  Retrieve the unique identifier for one or more messages
- twisted.mail.imap4.IMAP4Client.fetchFlags
  twisted.mail.imap4.IMAP4Client.html#fetchFlags
  Function
  Method
  PUBLIC
  Retrieve the flags for one or more messages
- twisted.mail.imap4.IMAP4Client.fetchInternalDate
  twisted.mail.imap4.IMAP4Client.html#fetchInternalDate
  Function
  Method
  PUBLIC
  Retrieve the internal date associated with one or more messages
- twisted.mail.imap4.IMAP4Client.fetchEnvelope
  twisted.mail.imap4.IMAP4Client.html#fetchEnvelope
  Function
  Method
  PUBLIC
  Retrieve the envelope data for one or more messages
- twisted.mail.imap4.IMAP4Client.fetchBodyStructure
  twisted.mail.imap4.IMAP4Client.html#fetchBodyStructure
  Function
  Method
  PUBLIC
  Retrieve the structure of the body of one or more messages
- twisted.mail.imap4.IMAP4Client.fetchSimplifiedBody
  twisted.mail.imap4.IMAP4Client.html#fetchSimplifiedBody
  Function
  Method
  PUBLIC
  Retrieve the simplified body structure of one or more messages
- twisted.mail.imap4.IMAP4Client.fetchMessage
  twisted.mail.imap4.IMAP4Client.html#fetchMessage
  Function
  Method
  PUBLIC
  Retrieve one or more entire messages
- twisted.mail.imap4.IMAP4Client.fetchHeaders
  twisted.mail.imap4.IMAP4Client.html#fetchHeaders
  Function
  Method
  PUBLIC
  Retrieve headers of one or more messages
- twisted.mail.imap4.IMAP4Client.fetchBody
  twisted.mail.imap4.IMAP4Client.html#fetchBody
  Function
  Method
  PUBLIC
  Retrieve body text of one or more messages
- twisted.mail.imap4.IMAP4Client.fetchSize
  twisted.mail.imap4.IMAP4Client.html#fetchSize
  Function
  Method
  PUBLIC
  Retrieve the size, in octets, of one or more messages
- twisted.mail.imap4.IMAP4Client.fetchFull
  twisted.mail.imap4.IMAP4Client.html#fetchFull
  Function
  Method
  PUBLIC
  Retrieve several different fields of one or more messages
- twisted.mail.imap4.IMAP4Client.fetchAll
  twisted.mail.imap4.IMAP4Client.html#fetchAll
  Function
  Method
  PUBLIC
  Retrieve several different fields of one or more messages
- twisted.mail.imap4.IMAP4Client.fetchFast
  twisted.mail.imap4.IMAP4Client.html#fetchFast
  Function
  Method
  PUBLIC
  Retrieve several different fields of one or more messages
- twisted.mail.imap4.IMAP4Client._parseFetchPairs
  twisted.mail.imap4.IMAP4Client.html#_parseFetchPairs
  Function
  Method
  PRIVATE
  Given the result of parsing a single FETCH response, construct a `dict` mapping response keys to response values.
- twisted.mail.imap4.IMAP4Client._cbFetch
  twisted.mail.imap4.IMAP4Client.html#_cbFetch
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Client.fetchSpecific
  twisted.mail.imap4.IMAP4Client.html#fetchSpecific
  Function
  Method
  PUBLIC
  Retrieve a specific section of one or more messages
- twisted.mail.imap4.IMAP4Client._fetch
  twisted.mail.imap4.IMAP4Client.html#_fetch
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Client.setFlags
  twisted.mail.imap4.IMAP4Client.html#setFlags
  Function
  Method
  PUBLIC
  Set the flags for one or more messages.
- twisted.mail.imap4.IMAP4Client.addFlags
  twisted.mail.imap4.IMAP4Client.html#addFlags
  Function
  Method
  PUBLIC
  Add to the set flags for one or more messages.
- twisted.mail.imap4.IMAP4Client.removeFlags
  twisted.mail.imap4.IMAP4Client.html#removeFlags
  Function
  Method
  PUBLIC
  Remove from the set flags for one or more messages.
- twisted.mail.imap4.IMAP4Client._store
  twisted.mail.imap4.IMAP4Client.html#_store
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.IMAP4Client.copy
  twisted.mail.imap4.IMAP4Client.html#copy
  Function
  Method
  PUBLIC
  Copy the specified messages to the specified mailbox.
- twisted.mail.imap4.IMAP4Client.modeChanged
  twisted.mail.imap4.IMAP4Client.html#modeChanged
  Function
  Method
  PUBLIC
  Override me
- twisted.mail.imap4.IMAP4Client.flagsChanged
  twisted.mail.imap4.IMAP4Client.html#flagsChanged
  Function
  Method
  PUBLIC
  Override me
- twisted.mail.imap4.IMAP4Client.newMessages
  twisted.mail.imap4.IMAP4Client.html#newMessages
  Function
  Method
  PUBLIC
  Override me
- twisted.mail.imap4.parseIdList
  twisted.mail.imap4.html#parseIdList
  Function
  Function
  PUBLIC
  Parse a message set search key into a `MessageSet`.
- twisted.mail.imap4._SIMPLE_BOOL
  twisted.mail.imap4.html#_SIMPLE_BOOL
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.mail.imap4._NO_QUOTES
  twisted.mail.imap4.html#_NO_QUOTES
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.mail.imap4.Query
  twisted.mail.imap4.html#Query
  Function
  Function
  PUBLIC
  Create a query string
- twisted.mail.imap4.Or
  twisted.mail.imap4.html#Or
  Function
  Function
  PUBLIC
  The disjunction of two or more queries
- twisted.mail.imap4.Not
  twisted.mail.imap4.html#Not
  Function
  Function
  PUBLIC
  The negation of a query
- twisted.mail.imap4.wildcardToRegexp
  twisted.mail.imap4.html#wildcardToRegexp
  Function
  Function
  PUBLIC
  Undocumented
- twisted.mail.imap4.splitQuoted
  twisted.mail.imap4.html#splitQuoted
  Function
  Function
  PUBLIC
  Split a string into whitespace delimited tokens
- twisted.mail.imap4.splitOn
  twisted.mail.imap4.html#splitOn
  Function
  Function
  PUBLIC
  Undocumented
- twisted.mail.imap4.collapseStrings
  twisted.mail.imap4.html#collapseStrings
  Function
  Function
  PUBLIC
  Turns a list of length-one strings and lists into a list of longer strings and lists. For example,
- twisted.mail.imap4.parseNestedParens
  twisted.mail.imap4.html#parseNestedParens
  Function
  Function
  PUBLIC
  Parse an s-exp-like string into a more useful data structure.
- twisted.mail.imap4._quote
  twisted.mail.imap4.html#_quote
  Function
  Function
  PRIVATE
  Undocumented
- twisted.mail.imap4._literal
  twisted.mail.imap4.html#_literal
  Function
  Function
  PRIVATE
  Undocumented
- twisted.mail.imap4.DontQuoteMe
  twisted.mail.imap4.DontQuoteMe.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.mail.imap4.DontQuoteMe.__init__
  twisted.mail.imap4.DontQuoteMe.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.DontQuoteMe.value
  twisted.mail.imap4.DontQuoteMe.html#value
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.DontQuoteMe.__str__
  twisted.mail.imap4.DontQuoteMe.html#__str__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4._ATOM_SPECIALS
  twisted.mail.imap4.html#_ATOM_SPECIALS
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.mail.imap4._needsQuote
  twisted.mail.imap4.html#_needsQuote
  Function
  Function
  PRIVATE
  Undocumented
- twisted.mail.imap4._parseMbox
  twisted.mail.imap4.html#_parseMbox
  Function
  Function
  PRIVATE
  Undocumented
- twisted.mail.imap4._prepareMailboxName
  twisted.mail.imap4.html#_prepareMailboxName
  Function
  Function
  PRIVATE
  Undocumented
- twisted.mail.imap4._needsLiteral
  twisted.mail.imap4.html#_needsLiteral
  Function
  Function
  PRIVATE
  Undocumented
- twisted.mail.imap4.collapseNestedLists
  twisted.mail.imap4.html#collapseNestedLists
  Function
  Function
  PUBLIC
  Turn a nested list structure into an s-exp-like string.
- twisted.mail.imap4.MemoryAccountWithoutNamespaces
  twisted.mail.imap4.MemoryAccountWithoutNamespaces.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.mail.imap4.MemoryAccountWithoutNamespaces.mailboxes
  twisted.mail.imap4.MemoryAccountWithoutNamespaces.html#mailboxes
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.MemoryAccountWithoutNamespaces.subscriptions
  twisted.mail.imap4.MemoryAccountWithoutNamespaces.html#subscriptions
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.MemoryAccountWithoutNamespaces.top_id
  twisted.mail.imap4.MemoryAccountWithoutNamespaces.html#top_id
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.MemoryAccountWithoutNamespaces.__init__
  twisted.mail.imap4.MemoryAccountWithoutNamespaces.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.MemoryAccountWithoutNamespaces.name
  twisted.mail.imap4.MemoryAccountWithoutNamespaces.html#name
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.MemoryAccountWithoutNamespaces.allocateID
  twisted.mail.imap4.MemoryAccountWithoutNamespaces.html#allocateID
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.MemoryAccountWithoutNamespaces.addMailbox
  twisted.mail.imap4.MemoryAccountWithoutNamespaces.html#addMailbox
  Function
  Method
  PUBLIC
  Add a new mailbox to this account
- twisted.mail.imap4.MemoryAccountWithoutNamespaces.create
  twisted.mail.imap4.MemoryAccountWithoutNamespaces.html#create
  Function
  Method
  PUBLIC
  Create a new mailbox from the given hierarchical name.
- twisted.mail.imap4.MemoryAccountWithoutNamespaces._emptyMailbox
  twisted.mail.imap4.MemoryAccountWithoutNamespaces.html#_emptyMailbox
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.MemoryAccountWithoutNamespaces.select
  twisted.mail.imap4.MemoryAccountWithoutNamespaces.html#select
  Function
  Method
  PUBLIC
  Acquire a mailbox, given its name.
- twisted.mail.imap4.MemoryAccountWithoutNamespaces.delete
  twisted.mail.imap4.MemoryAccountWithoutNamespaces.html#delete
  Function
  Method
  PUBLIC
  Delete the mailbox with the specified name.
- twisted.mail.imap4.MemoryAccountWithoutNamespaces.rename
  twisted.mail.imap4.MemoryAccountWithoutNamespaces.html#rename
  Function
  Method
  PUBLIC
  Rename a mailbox
- twisted.mail.imap4.MemoryAccountWithoutNamespaces._inferiorNames
  twisted.mail.imap4.MemoryAccountWithoutNamespaces.html#_inferiorNames
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.MemoryAccountWithoutNamespaces.isSubscribed
  twisted.mail.imap4.MemoryAccountWithoutNamespaces.html#isSubscribed
  Function
  Method
  PUBLIC
  Check the subscription status of a mailbox
- twisted.mail.imap4.MemoryAccountWithoutNamespaces.subscribe
  twisted.mail.imap4.MemoryAccountWithoutNamespaces.html#subscribe
  Function
  Method
  PUBLIC
  Subscribe to a mailbox
- twisted.mail.imap4.MemoryAccountWithoutNamespaces.unsubscribe
  twisted.mail.imap4.MemoryAccountWithoutNamespaces.html#unsubscribe
  Function
  Method
  PUBLIC
  Unsubscribe from a mailbox
- twisted.mail.imap4.MemoryAccountWithoutNamespaces.listMailboxes
  twisted.mail.imap4.MemoryAccountWithoutNamespaces.html#listMailboxes
  Function
  Method
  PUBLIC
  List all the mailboxes that meet a certain criteria
- twisted.mail.imap4.MemoryAccount
  twisted.mail.imap4.MemoryAccount.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.mail.imap4.MemoryAccount.getPersonalNamespaces
  twisted.mail.imap4.MemoryAccount.html#getPersonalNamespaces
  Function
  Method
  PUBLIC
  Report the available personal namespaces.
- twisted.mail.imap4.MemoryAccount.getSharedNamespaces
  twisted.mail.imap4.MemoryAccount.html#getSharedNamespaces
  Function
  Method
  PUBLIC
  Report the available shared namespaces.
- twisted.mail.imap4.MemoryAccount.getOtherNamespaces
  twisted.mail.imap4.MemoryAccount.html#getOtherNamespaces
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.MemoryAccount.getUserNamespaces
  twisted.mail.imap4.MemoryAccount.html#getUserNamespaces
  Function
  Method
  PUBLIC
  Report the available user namespaces.
- twisted.mail.imap4._statusRequestDict
  twisted.mail.imap4.html#_statusRequestDict
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.mail.imap4.statusRequestHelper
  twisted.mail.imap4.html#statusRequestHelper
  Function
  Function
  PUBLIC
  Undocumented
- twisted.mail.imap4.parseAddr
  twisted.mail.imap4.html#parseAddr
  Function
  Function
  PUBLIC
  Undocumented
- twisted.mail.imap4.getEnvelope
  twisted.mail.imap4.html#getEnvelope
  Function
  Function
  PUBLIC
  Undocumented
- twisted.mail.imap4.getLineCount
  twisted.mail.imap4.html#getLineCount
  Function
  Function
  PUBLIC
  Undocumented
- twisted.mail.imap4.unquote
  twisted.mail.imap4.html#unquote
  Function
  Function
  PUBLIC
  Undocumented
- twisted.mail.imap4._getContentType
  twisted.mail.imap4.html#_getContentType
  Function
  Function
  PRIVATE
  Return a two-tuple of the main and subtype of the given message.
- twisted.mail.imap4._getMessageStructure
  twisted.mail.imap4.html#_getMessageStructure
  Function
  Function
  PRIVATE
  Construct an appropriate type of message structure object for the given message object.
- twisted.mail.imap4._MessageStructure
  twisted.mail.imap4._MessageStructure.html
  Class
  Class
  PRIVATE
  `_MessageStructure` is a helper base class for message structure classes representing the structure of particular kinds of messages, as defined by their MIME type.
- twisted.mail.imap4._MessageStructure.__init__
  twisted.mail.imap4._MessageStructure.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.mail.imap4._MessageStructure.message
  twisted.mail.imap4._MessageStructure.html#message
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4._MessageStructure.attrs
  twisted.mail.imap4._MessageStructure.html#attrs
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4._MessageStructure._disposition
  twisted.mail.imap4._MessageStructure.html#_disposition
  Function
  Method
  PRIVATE
  Parse a Content-Disposition header into a two-sequence of the disposition and a flattened list of its parameters.
- twisted.mail.imap4._MessageStructure._unquotedAttrs
  twisted.mail.imap4._MessageStructure.html#_unquotedAttrs
  Function
  Method
  PRIVATE
  No summary
- twisted.mail.imap4._SinglepartMessageStructure
  twisted.mail.imap4._SinglepartMessageStructure.html
  Class
  Class
  PRIVATE
  `_SinglepartMessageStructure` represents the message structure of a non-multipart/* message.
- twisted.mail.imap4._SinglepartMessageStructure._HEADERS
  twisted.mail.imap4._SinglepartMessageStructure.html#_HEADERS
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.mail.imap4._SinglepartMessageStructure.__init__
  twisted.mail.imap4._SinglepartMessageStructure.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.mail.imap4._SinglepartMessageStructure.main
  twisted.mail.imap4._SinglepartMessageStructure.html#main
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4._SinglepartMessageStructure.subtype
  twisted.mail.imap4._SinglepartMessageStructure.html#subtype
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4._SinglepartMessageStructure.attrs
  twisted.mail.imap4._SinglepartMessageStructure.html#attrs
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4._SinglepartMessageStructure._basicFields
  twisted.mail.imap4._SinglepartMessageStructure.html#_basicFields
  Function
  Method
  PRIVATE
  Return a list of the basic fields for a single-part message.
- twisted.mail.imap4._SinglepartMessageStructure.encode
  twisted.mail.imap4._SinglepartMessageStructure.html#encode
  Function
  Method
  PUBLIC
  Construct and return a list of the basic and extended fields for a single-part message. The list suitable to be encoded into a BODY or BODYSTRUCTURE response.
- twisted.mail.imap4._SinglepartMessageStructure._extended
  twisted.mail.imap4._SinglepartMessageStructure.html#_extended
  Function
  Method
  PRIVATE
  The extension data of a non-multipart body part are in the following order:
- twisted.mail.imap4._TextMessageStructure
  twisted.mail.imap4._TextMessageStructure.html
  Class
  Class
  PRIVATE
  `_TextMessageStructure` represents the message structure of a text/* message.
- twisted.mail.imap4._TextMessageStructure.encode
  twisted.mail.imap4._TextMessageStructure.html#encode
  Function
  Method
  PUBLIC
  A body type of type TEXT contains, immediately after the basic fields, the size of the body in text lines. Note that this size is the size in its content transfer encoding and not the resulting size after any decoding.
- twisted.mail.imap4._RFC822MessageStructure
  twisted.mail.imap4._RFC822MessageStructure.html
  Class
  Class
  PRIVATE
  `_RFC822MessageStructure` represents the message structure of a message/rfc822 message.
- twisted.mail.imap4._RFC822MessageStructure.encode
  twisted.mail.imap4._RFC822MessageStructure.html#encode
  Function
  Method
  PUBLIC
  A body type of type MESSAGE and subtype RFC822 contains, immediately after the basic fields, the envelope structure, body structure, and size in text lines of the encapsulated message.
- twisted.mail.imap4._MultipartMessageStructure
  twisted.mail.imap4._MultipartMessageStructure.html
  Class
  Class
  PRIVATE
  `_MultipartMessageStructure` represents the message structure of a multipart/* message.
- twisted.mail.imap4._MultipartMessageStructure.__init__
  twisted.mail.imap4._MultipartMessageStructure.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.mail.imap4._MultipartMessageStructure.subtype
  twisted.mail.imap4._MultipartMessageStructure.html#subtype
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4._MultipartMessageStructure._getParts
  twisted.mail.imap4._MultipartMessageStructure.html#_getParts
  Function
  Method
  PRIVATE
  Return an iterator over all of the sub-messages of this message.
- twisted.mail.imap4._MultipartMessageStructure.encode
  twisted.mail.imap4._MultipartMessageStructure.html#encode
  Function
  Method
  PUBLIC
  Encode each sub-message and added the additional multipart fields.
- twisted.mail.imap4._MultipartMessageStructure._extended
  twisted.mail.imap4._MultipartMessageStructure.html#_extended
  Function
  Method
  PRIVATE
  The extension data of a multipart body part are in the following order:
- twisted.mail.imap4.getBodyStructure
  twisted.mail.imap4.html#getBodyStructure
  Function
  Function
  PUBLIC
  RFC 3501, 7.4.2, BODYSTRUCTURE:
- twisted.mail.imap4._formatHeaders
  twisted.mail.imap4.html#_formatHeaders
  Function
  Function
  PRIVATE
  Undocumented
- twisted.mail.imap4.subparts
  twisted.mail.imap4.html#subparts
  Function
  Function
  PUBLIC
  Undocumented
- twisted.mail.imap4.iterateInReactor
  twisted.mail.imap4.html#iterateInReactor
  Function
  Function
  PUBLIC
  Consume an interator at most a single iteration per reactor iteration.
- twisted.mail.imap4.MessageProducer
  twisted.mail.imap4.MessageProducer.html
  Class
  Class
  PUBLIC
  No class docstring; 0/5 instance variable, 0/1 class variable, 0/1 constant, 1/3 method documented
- twisted.mail.imap4.MessageProducer.CHUNK_SIZE
  twisted.mail.imap4.MessageProducer.html#CHUNK_SIZE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.mail.imap4.MessageProducer._uuid4
  twisted.mail.imap4.MessageProducer.html#_uuid4
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.mail.imap4.MessageProducer.__init__
  twisted.mail.imap4.MessageProducer.html#__init__
  Function
  Method
  PUBLIC
  Produce this message.
- twisted.mail.imap4.MessageProducer.msg
  twisted.mail.imap4.MessageProducer.html#msg
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.MessageProducer.buffer
  twisted.mail.imap4.MessageProducer.html#buffer
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.MessageProducer.scheduler
  twisted.mail.imap4.MessageProducer.html#scheduler
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.MessageProducer.write
  twisted.mail.imap4.MessageProducer.html#write
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.MessageProducer.beginProducing
  twisted.mail.imap4.MessageProducer.html#beginProducing
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.MessageProducer.consumer
  twisted.mail.imap4.MessageProducer.html#consumer
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.MessageProducer._produce
  twisted.mail.imap4.MessageProducer.html#_produce
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4._FetchParser
  twisted.mail.imap4._FetchParser.html
  Class
  Class
  PRIVATE
  Undocumented
- twisted.mail.imap4._FetchParser.Envelope
  twisted.mail.imap4._FetchParser.Envelope.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.mail.imap4._FetchParser.Envelope.type
  twisted.mail.imap4._FetchParser.Envelope.html#type
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4._FetchParser.Envelope.__str__
  twisted.mail.imap4._FetchParser.Envelope.html#__str__
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4._FetchParser.Flags
  twisted.mail.imap4._FetchParser.Flags.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.mail.imap4._FetchParser.Flags.type
  twisted.mail.imap4._FetchParser.Flags.html#type
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4._FetchParser.Flags.__str__
  twisted.mail.imap4._FetchParser.Flags.html#__str__
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4._FetchParser.InternalDate
  twisted.mail.imap4._FetchParser.InternalDate.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.mail.imap4._FetchParser.InternalDate.type
  twisted.mail.imap4._FetchParser.InternalDate.html#type
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4._FetchParser.InternalDate.__str__
  twisted.mail.imap4._FetchParser.InternalDate.html#__str__
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4._FetchParser.RFC822Header
  twisted.mail.imap4._FetchParser.RFC822Header.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.mail.imap4._FetchParser.RFC822Header.type
  twisted.mail.imap4._FetchParser.RFC822Header.html#type
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4._FetchParser.RFC822Header.__str__
  twisted.mail.imap4._FetchParser.RFC822Header.html#__str__
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4._FetchParser.RFC822Text
  twisted.mail.imap4._FetchParser.RFC822Text.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.mail.imap4._FetchParser.RFC822Text.type
  twisted.mail.imap4._FetchParser.RFC822Text.html#type
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4._FetchParser.RFC822Text.__str__
  twisted.mail.imap4._FetchParser.RFC822Text.html#__str__
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4._FetchParser.RFC822Size
  twisted.mail.imap4._FetchParser.RFC822Size.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.mail.imap4._FetchParser.RFC822Size.type
  twisted.mail.imap4._FetchParser.RFC822Size.html#type
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4._FetchParser.RFC822Size.__str__
  twisted.mail.imap4._FetchParser.RFC822Size.html#__str__
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4._FetchParser.RFC822
  twisted.mail.imap4._FetchParser.RFC822.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.mail.imap4._FetchParser.RFC822.type
  twisted.mail.imap4._FetchParser.RFC822.html#type
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4._FetchParser.RFC822.__str__
  twisted.mail.imap4._FetchParser.RFC822.html#__str__
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4._FetchParser.UID
  twisted.mail.imap4._FetchParser.UID.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.mail.imap4._FetchParser.UID.type
  twisted.mail.imap4._FetchParser.UID.html#type
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4._FetchParser.UID.__str__
  twisted.mail.imap4._FetchParser.UID.html#__str__
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4._FetchParser.Body
  twisted.mail.imap4._FetchParser.Body.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.mail.imap4._FetchParser.Body.type
  twisted.mail.imap4._FetchParser.Body.html#type
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4._FetchParser.Body.peek
  twisted.mail.imap4._FetchParser.Body.html#peek
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4._FetchParser.Body.header
  twisted.mail.imap4._FetchParser.Body.html#header
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4._FetchParser.Body.mime
  twisted.mail.imap4._FetchParser.Body.html#mime
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4._FetchParser.Body.text
  twisted.mail.imap4._FetchParser.Body.html#text
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4._FetchParser.Body.part
  twisted.mail.imap4._FetchParser.Body.html#part
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4._FetchParser.Body.empty
  twisted.mail.imap4._FetchParser.Body.html#empty
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4._FetchParser.Body.partialBegin
  twisted.mail.imap4._FetchParser.Body.html#partialBegin
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4._FetchParser.Body.partialLength
  twisted.mail.imap4._FetchParser.Body.html#partialLength
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4._FetchParser.Body.__str__
  twisted.mail.imap4._FetchParser.Body.html#__str__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4._FetchParser.Body.__bytes__
  twisted.mail.imap4._FetchParser.Body.html#__bytes__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4._FetchParser.BodyStructure
  twisted.mail.imap4._FetchParser.BodyStructure.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.mail.imap4._FetchParser.BodyStructure.type
  twisted.mail.imap4._FetchParser.BodyStructure.html#type
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4._FetchParser.BodyStructure.__str__
  twisted.mail.imap4._FetchParser.BodyStructure.html#__str__
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4._FetchParser.Header
  twisted.mail.imap4._FetchParser.Header.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.mail.imap4._FetchParser.Header.negate
  twisted.mail.imap4._FetchParser.Header.html#negate
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4._FetchParser.Header.fields
  twisted.mail.imap4._FetchParser.Header.html#fields
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4._FetchParser.Header.part
  twisted.mail.imap4._FetchParser.Header.html#part
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4._FetchParser.Header.__str__
  twisted.mail.imap4._FetchParser.Header.html#__str__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4._FetchParser.Header.__bytes__
  twisted.mail.imap4._FetchParser.Header.html#__bytes__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4._FetchParser.Text
  twisted.mail.imap4._FetchParser.Text.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.mail.imap4._FetchParser.MIME
  twisted.mail.imap4._FetchParser.MIME.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.mail.imap4._FetchParser.parts
  twisted.mail.imap4._FetchParser.html#parts
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4._FetchParser._simple_fetch_att
  twisted.mail.imap4._FetchParser.html#_simple_fetch_att
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.mail.imap4._FetchParser.__init__
  twisted.mail.imap4._FetchParser.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4._FetchParser.state
  twisted.mail.imap4._FetchParser.html#state
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4._FetchParser.result
  twisted.mail.imap4._FetchParser.html#result
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4._FetchParser.remaining
  twisted.mail.imap4._FetchParser.html#remaining
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4._FetchParser.parseString
  twisted.mail.imap4._FetchParser.html#parseString
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4._FetchParser.state_initial
  twisted.mail.imap4._FetchParser.html#state_initial
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4._FetchParser.state_close_paren
  twisted.mail.imap4._FetchParser.html#state_close_paren
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4._FetchParser.state_whitespace
  twisted.mail.imap4._FetchParser.html#state_whitespace
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4._FetchParser.state_maybe_fetch_att
  twisted.mail.imap4._FetchParser.html#state_maybe_fetch_att
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4._FetchParser.state_fetch_att
  twisted.mail.imap4._FetchParser.html#state_fetch_att
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4._FetchParser.pending_body
  twisted.mail.imap4._FetchParser.html#pending_body
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4._FetchParser.state_got_body
  twisted.mail.imap4._FetchParser.html#state_got_body
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4._FetchParser.state_maybe_section
  twisted.mail.imap4._FetchParser.html#state_maybe_section
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4._FetchParser._partExpr
  twisted.mail.imap4._FetchParser.html#_partExpr
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.mail.imap4._FetchParser.state_part_number
  twisted.mail.imap4._FetchParser.html#state_part_number
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4._FetchParser.state_section
  twisted.mail.imap4._FetchParser.html#state_section
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4._FetchParser.state_finish_section
  twisted.mail.imap4._FetchParser.html#state_finish_section
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4._FetchParser.state_header_list
  twisted.mail.imap4._FetchParser.html#state_header_list
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4._FetchParser.state_maybe_partial
  twisted.mail.imap4._FetchParser.html#state_maybe_partial
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.FileProducer
  twisted.mail.imap4.FileProducer.html
  Class
  Class
  PUBLIC
  No class docstring; 0/5 instance variable, 0/1 constant, 2/6 methods documented
- twisted.mail.imap4.FileProducer.CHUNK_SIZE
  twisted.mail.imap4.FileProducer.html#CHUNK_SIZE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.mail.imap4.FileProducer.firstWrite
  twisted.mail.imap4.FileProducer.html#firstWrite
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.FileProducer.__init__
  twisted.mail.imap4.FileProducer.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.FileProducer.f
  twisted.mail.imap4.FileProducer.html#f
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.FileProducer.beginProducing
  twisted.mail.imap4.FileProducer.html#beginProducing
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.FileProducer.consumer
  twisted.mail.imap4.FileProducer.html#consumer
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.FileProducer.produce
  twisted.mail.imap4.FileProducer.html#produce
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.FileProducer._onDone
  twisted.mail.imap4.FileProducer.html#_onDone
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.mail.imap4.FileProducer.resumeProducing
  twisted.mail.imap4.FileProducer.html#resumeProducing
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.FileProducer.pauseProducing
  twisted.mail.imap4.FileProducer.html#pauseProducing
  Function
  Method
  PUBLIC
  Pause the producer. This does nothing.
- twisted.mail.imap4.FileProducer.stopProducing
  twisted.mail.imap4.FileProducer.html#stopProducing
  Function
  Method
  PUBLIC
  Stop the producer. This does nothing.
- twisted.mail.imap4.FileProducer._size
  twisted.mail.imap4.FileProducer.html#_size
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.imap4.parseTime
  twisted.mail.imap4.html#parseTime
  Function
  Function
  PUBLIC
  Undocumented
- twisted.mail.imap4.memory_cast
  twisted.mail.imap4.html#memory_cast
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.mail.imap4.modified_base64
  twisted.mail.imap4.html#modified_base64
  Function
  Function
  PUBLIC
  Undocumented
- twisted.mail.imap4.modified_unbase64
  twisted.mail.imap4.html#modified_unbase64
  Function
  Function
  PUBLIC
  Undocumented
- twisted.mail.imap4.encoder
  twisted.mail.imap4.html#encoder
  Function
  Function
  PUBLIC
  Encode the given `unicode` string using the IMAP4 specific variation of UTF-7.
- twisted.mail.imap4.decoder
  twisted.mail.imap4.html#decoder
  Function
  Function
  PUBLIC
  Decode the given `str` using the IMAP4 specific variation of UTF-7.
- twisted.mail.imap4.StreamReader
  twisted.mail.imap4.StreamReader.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.mail.imap4.StreamReader.decode
  twisted.mail.imap4.StreamReader.html#decode
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4.StreamWriter
  twisted.mail.imap4.StreamWriter.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.mail.imap4.StreamWriter.encode
  twisted.mail.imap4.StreamWriter.html#encode
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.imap4._codecInfo
  twisted.mail.imap4.html#_codecInfo
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.mail.imap4.imap4_utf_7
  twisted.mail.imap4.html#imap4_utf_7
  Function
  Function
  PUBLIC
  Undocumented
- twisted.mail.pop3.POP3ClientError
  twisted.mail.pop3.POP3ClientError.html
  Class
  Exception
  PUBLIC
  The base class for all exceptions raised by POP3Client.
- twisted.mail.pop3.POP3Error
  twisted.mail.pop3.POP3Error.html
  Class
  Exception
  PUBLIC
  The base class for POP3 errors.
- twisted.mail.pop3.APOPCredentials
  twisted.mail.pop3.APOPCredentials.html
  Class
  Class
  PUBLIC
  Credentials for use in APOP authentication.
- twisted.mail.pop3.APOPCredentials.magic
  twisted.mail.pop3.APOPCredentials.html#magic
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`
- twisted.mail.pop3.APOPCredentials.username
  twisted.mail.pop3.APOPCredentials.html#username
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`
- twisted.mail.pop3.APOPCredentials.digest
  twisted.mail.pop3.APOPCredentials.html#digest
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`
- twisted.mail.pop3.APOPCredentials.__init__
  twisted.mail.pop3.APOPCredentials.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.mail.pop3.APOPCredentials.checkPassword
  twisted.mail.pop3.APOPCredentials.html#checkPassword
  Function
  Method
  PUBLIC
  Validate a plaintext password against the credentials.
- twisted.mail.pop3._HeadersPlusNLines
  twisted.mail.pop3._HeadersPlusNLines.html
  Class
  Class
  PRIVATE
  A utility class to retrieve the header and some lines of the body of a mail message.
- twisted.mail.pop3._HeadersPlusNLines._file
  twisted.mail.pop3._HeadersPlusNLines.html#_file
  Attribute
  Instance Variable
  PRIVATE
  See `__init__`
- twisted.mail.pop3._HeadersPlusNLines._extraLines
  twisted.mail.pop3._HeadersPlusNLines.html#_extraLines
  Attribute
  Instance Variable
  PRIVATE
  See `__init__`
- twisted.mail.pop3._HeadersPlusNLines.linecount
  twisted.mail.pop3._HeadersPlusNLines.html#linecount
  Attribute
  Instance Variable
  PUBLIC
  The number of full lines of the message body scanned.
- twisted.mail.pop3._HeadersPlusNLines.headers
  twisted.mail.pop3._HeadersPlusNLines.html#headers
  Attribute
  Instance Variable
  PUBLIC
  An indication of which part of the message is being scanned. `True` for the header and `False` for the body.
- twisted.mail.pop3._HeadersPlusNLines.done
  twisted.mail.pop3._HeadersPlusNLines.html#done
  Attribute
  Instance Variable
  PUBLIC
  A flag indicating when the desired part of the message has been scanned.
- twisted.mail.pop3._HeadersPlusNLines.buf
  twisted.mail.pop3._HeadersPlusNLines.html#buf
  Attribute
  Instance Variable
  PUBLIC
  The portion of the message body that has been scanned, up to `n` lines.
- twisted.mail.pop3._HeadersPlusNLines.__init__
  twisted.mail.pop3._HeadersPlusNLines.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.mail.pop3._HeadersPlusNLines.read
  twisted.mail.pop3._HeadersPlusNLines.html#read
  Function
  Method
  PUBLIC
  Scan bytes from the file.
- twisted.mail.pop3._IteratorBuffer
  twisted.mail.pop3._IteratorBuffer.html
  Class
  Class
  PRIVATE
  An iterator which buffers the elements of a container and periodically passes them as input to a writer.
- twisted.mail.pop3._IteratorBuffer.write
  twisted.mail.pop3._IteratorBuffer.html#write
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`.
- twisted.mail.pop3._IteratorBuffer.memoryBufferSize
  twisted.mail.pop3._IteratorBuffer.html#memoryBufferSize
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`.
- twisted.mail.pop3._IteratorBuffer.bufSize
  twisted.mail.pop3._IteratorBuffer.html#bufSize
  Attribute
  Instance Variable
  PUBLIC
  The number of bytes currently in the buffer.
- twisted.mail.pop3._IteratorBuffer.lines
  twisted.mail.pop3._IteratorBuffer.html#lines
  Attribute
  Instance Variable
  PUBLIC
  The buffer, which is a list of strings.
- twisted.mail.pop3._IteratorBuffer.iterator
  twisted.mail.pop3._IteratorBuffer.html#iterator
  Attribute
  Instance Variable
  PUBLIC
  An iterator over a container of strings.
- twisted.mail.pop3._IteratorBuffer.__init__
  twisted.mail.pop3._IteratorBuffer.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.mail.pop3._IteratorBuffer.__iter__
  twisted.mail.pop3._IteratorBuffer.html#__iter__
  Function
  Method
  PUBLIC
  Return an iterator.
- twisted.mail.pop3._IteratorBuffer.__next__
  twisted.mail.pop3._IteratorBuffer.html#__next__
  Function
  Method
  PUBLIC
  Get the next string from the container, buffer it, and possibly send the buffer to the writer.
- twisted.mail.pop3.iterateLineGenerator
  twisted.mail.pop3.html#iterateLineGenerator
  Function
  Function
  PUBLIC
  Direct the output of an iterator to the transport of a protocol and arrange for iteration to take place.
- twisted.mail.pop3.successResponse
  twisted.mail.pop3.html#successResponse
  Function
  Function
  PUBLIC
  Format an object as a positive response.
- twisted.mail.pop3.formatStatResponse
  twisted.mail.pop3.html#formatStatResponse
  Function
  Function
  PUBLIC
  Format a list of message sizes into a STAT response.
- twisted.mail.pop3.formatListLines
  twisted.mail.pop3.html#formatListLines
  Function
  Function
  PUBLIC
  Format a list of message sizes for use in a LIST response.
- twisted.mail.pop3.formatListResponse
  twisted.mail.pop3.html#formatListResponse
  Function
  Function
  PUBLIC
  Format a list of message sizes into a complete LIST response.
- twisted.mail.pop3.formatUIDListLines
  twisted.mail.pop3.html#formatUIDListLines
  Function
  Function
  PUBLIC
  Format a list of message sizes for use in a UIDL response.
- twisted.mail.pop3.formatUIDListResponse
  twisted.mail.pop3.html#formatUIDListResponse
  Function
  Function
  PUBLIC
  Format a list of message sizes into a complete UIDL response.
- twisted.mail.pop3.POP3
  twisted.mail.pop3.POP3.html
  Class
  Class
  PUBLIC
  A POP3 server protocol.
- twisted.mail.pop3.POP3.portal
  twisted.mail.pop3.POP3.html#portal
  Attribute
  Instance Variable
  PUBLIC
  A portal for authentication.
- twisted.mail.pop3.POP3.factory
  twisted.mail.pop3.POP3.html#factory
  Attribute
  Instance Variable
  PUBLIC
  A server factory which provides an interface for querying capabilities of the server.
- twisted.mail.pop3.POP3.timeOut
  twisted.mail.pop3.POP3.html#timeOut
  Attribute
  Instance Variable
  PUBLIC
  The number of seconds to wait for a command from the client before disconnecting.
- twisted.mail.pop3.POP3.schedule
  twisted.mail.pop3.POP3.html#schedule
  Attribute
  Instance Variable
  PUBLIC
  A callable that arranges for an iterator to be cooperatively iterated over along with all other iterators which have been passed to it such that runtime is divided between all of them. It returns a deferred which fires when the iterator finishes.
- twisted.mail.pop3.POP3.magic
  twisted.mail.pop3.POP3.html#magic
  Attribute
  Instance Variable
  PUBLIC
  An APOP challenge. If not set, an APOP challenge string will be generated when a connection is made.
- twisted.mail.pop3.POP3._userIs
  twisted.mail.pop3.POP3.html#_userIs
  Attribute
  Instance Variable
  PRIVATE
  The username sent with the USER command.
- twisted.mail.pop3.POP3._onLogout
  twisted.mail.pop3.POP3.html#_onLogout
  Attribute
  Instance Variable
  PRIVATE
  The function to be executed when the connection is lost.
- twisted.mail.pop3.POP3.mbox
  twisted.mail.pop3.POP3.html#mbox
  Attribute
  Instance Variable
  PUBLIC
  The mailbox for the authenticated user.
- twisted.mail.pop3.POP3.state
  twisted.mail.pop3.POP3.html#state
  Attribute
  Instance Variable
  PUBLIC
  The state which indicates what type of messages are expected from the client. Valid states are 'COMMAND' and 'AUTH'
- twisted.mail.pop3.POP3.blocked
  twisted.mail.pop3.POP3.html#blocked
  Attribute
  Instance Variable
  PUBLIC
  A list of blocked commands. While a response to a command is being generated by the server, other commands are blocked. When no command is outstanding, `blocked` is set to none. Otherwise, it contains a list of information about blocked commands...
- twisted.mail.pop3.POP3._highest
  twisted.mail.pop3.POP3.html#_highest
  Attribute
  Instance Variable
  PRIVATE
  The 1-based index of the highest message retrieved.
- twisted.mail.pop3.POP3._auth
  twisted.mail.pop3.POP3.html#_auth
  Attribute
  Instance Variable
  PRIVATE
  Authorization credentials.
- twisted.mail.pop3.POP3.AUTH_CMDS
  twisted.mail.pop3.POP3.html#AUTH_CMDS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.mail.pop3.POP3.connectionMade
  twisted.mail.pop3.POP3.html#connectionMade
  Function
  Method
  PUBLIC
  Send a greeting to the client after the connection has been made.
- twisted.mail.pop3.POP3.connectionLost
  twisted.mail.pop3.POP3.html#connectionLost
  Function
  Method
  PUBLIC
  Clean up when the connection has been lost.
- twisted.mail.pop3.POP3.generateMagic
  twisted.mail.pop3.POP3.html#generateMagic
  Function
  Method
  PUBLIC
  Generate an APOP challenge.
- twisted.mail.pop3.POP3.successResponse
  twisted.mail.pop3.POP3.html#successResponse
  Function
  Method
  PUBLIC
  Send a response indicating success.
- twisted.mail.pop3.POP3.failResponse
  twisted.mail.pop3.POP3.html#failResponse
  Function
  Method
  PUBLIC
  Send a response indicating failure.
- twisted.mail.pop3.POP3.lineReceived
  twisted.mail.pop3.POP3.html#lineReceived
  Function
  Method
  PUBLIC
  Pass a received line to a state machine function.
- twisted.mail.pop3.POP3._unblock
  twisted.mail.pop3.POP3.html#_unblock
  Function
  Method
  PRIVATE
  Process as many blocked commands as possible.
- twisted.mail.pop3.POP3.state_COMMAND
  twisted.mail.pop3.POP3.html#state_COMMAND
  Function
  Method
  PUBLIC
  Handle received lines for the COMMAND state in which commands from the client are expected.
- twisted.mail.pop3.POP3.processCommand
  twisted.mail.pop3.POP3.html#processCommand
  Function
  Method
  PUBLIC
  Dispatch a command from the client for handling.
- twisted.mail.pop3.POP3.listCapabilities
  twisted.mail.pop3.POP3.html#listCapabilities
  Function
  Method
  PUBLIC
  Return a list of server capabilities suitable for use in a CAPA response.
- twisted.mail.pop3.POP3.do_CAPA
  twisted.mail.pop3.POP3.html#do_CAPA
  Function
  Method
  PUBLIC
  Handle a CAPA command.
- twisted.mail.pop3.POP3.do_AUTH
  twisted.mail.pop3.POP3.html#do_AUTH
  Function
  Method
  PUBLIC
  Handle an AUTH command.
- twisted.mail.pop3.POP3.state_AUTH
  twisted.mail.pop3.POP3.html#state_AUTH
  Function
  Method
  PUBLIC
  Handle received lines for the AUTH state in which an authentication challenge response from the client is expected.
- twisted.mail.pop3.POP3.do_APOP
  twisted.mail.pop3.POP3.html#do_APOP
  Function
  Method
  PUBLIC
  Handle an APOP command.
- twisted.mail.pop3.POP3._cbMailbox
  twisted.mail.pop3.POP3.html#_cbMailbox
  Function
  Method
  PRIVATE
  Complete successful authentication.
- twisted.mail.pop3.POP3._ebMailbox
  twisted.mail.pop3.POP3.html#_ebMailbox
  Function
  Method
  PRIVATE
  Handle an expected authentication failure.
- twisted.mail.pop3.POP3._ebUnexpected
  twisted.mail.pop3.POP3.html#_ebUnexpected
  Function
  Method
  PRIVATE
  Handle an unexpected authentication failure.
- twisted.mail.pop3.POP3.do_USER
  twisted.mail.pop3.POP3.html#do_USER
  Function
  Method
  PUBLIC
  Handle a USER command.
- twisted.mail.pop3.POP3.do_PASS
  twisted.mail.pop3.POP3.html#do_PASS
  Function
  Method
  PUBLIC
  Handle a PASS command.
- twisted.mail.pop3.POP3._longOperation
  twisted.mail.pop3.POP3.html#_longOperation
  Function
  Method
  PRIVATE
  Stop timeouts and block further command processing while a long operation completes.
- twisted.mail.pop3.POP3._coiterate
  twisted.mail.pop3.POP3.html#_coiterate
  Function
  Method
  PRIVATE
  Direct the output of an iterator to the transport and arrange for iteration to take place.
- twisted.mail.pop3.POP3.do_STAT
  twisted.mail.pop3.POP3.html#do_STAT
  Function
  Method
  PUBLIC
  Handle a STAT command.
- twisted.mail.pop3.POP3.do_LIST
  twisted.mail.pop3.POP3.html#do_LIST
  Function
  Method
  PUBLIC
  Handle a LIST command.
- twisted.mail.pop3.POP3.do_UIDL
  twisted.mail.pop3.POP3.html#do_UIDL
  Function
  Method
  PUBLIC
  Handle a UIDL command.
- twisted.mail.pop3.POP3._getMessageFile
  twisted.mail.pop3.POP3.html#_getMessageFile
  Function
  Method
  PRIVATE
  Retrieve the size and contents of a message.
- twisted.mail.pop3.POP3._sendMessageContent
  twisted.mail.pop3.POP3.html#_sendMessageContent
  Function
  Method
  PRIVATE
  Send the contents of a message.
- twisted.mail.pop3.POP3.do_TOP
  twisted.mail.pop3.POP3.html#do_TOP
  Function
  Method
  PUBLIC
  Handle a TOP command.
- twisted.mail.pop3.POP3.do_RETR
  twisted.mail.pop3.POP3.html#do_RETR
  Function
  Method
  PUBLIC
  Handle a RETR command.
- twisted.mail.pop3.POP3.transformChunk
  twisted.mail.pop3.POP3.html#transformChunk
  Function
  Method
  PUBLIC
  Transform a chunk of a message to POP3 message format.
- twisted.mail.pop3.POP3.finishedFileTransfer
  twisted.mail.pop3.POP3.html#finishedFileTransfer
  Function
  Method
  PUBLIC
  Send the termination sequence.
- twisted.mail.pop3.POP3.do_DELE
  twisted.mail.pop3.POP3.html#do_DELE
  Function
  Method
  PUBLIC
  Handle a DELE command.
- twisted.mail.pop3.POP3.do_NOOP
  twisted.mail.pop3.POP3.html#do_NOOP
  Function
  Method
  PUBLIC
  Handle a NOOP command.
- twisted.mail.pop3.POP3.do_RSET
  twisted.mail.pop3.POP3.html#do_RSET
  Function
  Method
  PUBLIC
  Handle a RSET command.
- twisted.mail.pop3.POP3.do_LAST
  twisted.mail.pop3.POP3.html#do_LAST
  Function
  Method
  PUBLIC
  Handle a LAST command.
- twisted.mail.pop3.POP3.do_RPOP
  twisted.mail.pop3.POP3.html#do_RPOP
  Function
  Method
  PUBLIC
  Handle an RPOP command.
- twisted.mail.pop3.POP3.do_QUIT
  twisted.mail.pop3.POP3.html#do_QUIT
  Function
  Method
  PUBLIC
  Handle a QUIT command.
- twisted.mail.pop3.POP3.authenticateUserAPOP
  twisted.mail.pop3.POP3.html#authenticateUserAPOP
  Function
  Method
  PUBLIC
  Perform APOP authentication.
- twisted.mail.pop3.POP3.authenticateUserPASS
  twisted.mail.pop3.POP3.html#authenticateUserPASS
  Function
  Method
  PUBLIC
  Perform authentication for a username/password login.
- twisted.mail.pop3.POP3.stopProducing
  twisted.mail.pop3.POP3.html#stopProducing
  Function
  Method
  PUBLIC
  Stop producing data.
- twisted.mail.pop3.Mailbox
  twisted.mail.pop3.Mailbox.html
  Class
  Class
  PUBLIC
  A base class for mailboxes.
- twisted.mail.pop3.Mailbox.listMessages
  twisted.mail.pop3.Mailbox.html#listMessages
  Function
  Method
  PUBLIC
  Retrieve the size of a message, or, if none is specified, the size of each message in the mailbox.
- twisted.mail.pop3.Mailbox.getMessage
  twisted.mail.pop3.Mailbox.html#getMessage
  Function
  Method
  PUBLIC
  Retrieve a file containing the contents of a message.
- twisted.mail.pop3.Mailbox.getUidl
  twisted.mail.pop3.Mailbox.html#getUidl
  Function
  Method
  PUBLIC
  Get a unique identifier for a message.
- twisted.mail.pop3.Mailbox.deleteMessage
  twisted.mail.pop3.Mailbox.html#deleteMessage
  Function
  Method
  PUBLIC
  Mark a message for deletion.
- twisted.mail.pop3.Mailbox.undeleteMessages
  twisted.mail.pop3.Mailbox.html#undeleteMessages
  Function
  Method
  PUBLIC
  Undelete all messages marked for deletion.
- twisted.mail.pop3.Mailbox.sync
  twisted.mail.pop3.Mailbox.html#sync
  Function
  Method
  PUBLIC
  Discard the contents of any message marked for deletion.
- twisted.mail.pop3.NONE
  twisted.mail.pop3.html#NONE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.mail.pop3.SHORT
  twisted.mail.pop3.html#SHORT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.mail.pop3.FIRST_LONG
  twisted.mail.pop3.html#FIRST_LONG
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.mail.pop3.LONG
  twisted.mail.pop3.html#LONG
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.mail.pop3.NEXT
  twisted.mail.pop3.html#NEXT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.mail.pop3.POP3Client
  twisted.mail.pop3.POP3Client.html
  Class
  Class
  PUBLIC
  A POP3 client protocol.
- twisted.mail.pop3.POP3Client.mode
  twisted.mail.pop3.POP3Client.html#mode
  Attribute
  Instance Variable
  PUBLIC
  The type of response expected from the server. Choices include none (0), a one line response (1), the first line of a multi-line response (2), and subsequent lines of a multi-line response (3).
- twisted.mail.pop3.POP3Client.command
  twisted.mail.pop3.POP3Client.html#command
  Attribute
  Instance Variable
  PUBLIC
  The command most recently sent to the server.
- twisted.mail.pop3.POP3Client.welcomeRe
  twisted.mail.pop3.POP3Client.html#welcomeRe
  Attribute
  Instance Variable
  PUBLIC
  A regular expression which matches the APOP challenge in the server greeting.
- twisted.mail.pop3.POP3Client.welcomeCode
  twisted.mail.pop3.POP3Client.html#welcomeCode
  Attribute
  Instance Variable
  PUBLIC
  The APOP challenge passed in the server greeting.
- twisted.mail.pop3.POP3Client.__init__
  twisted.mail.pop3.POP3Client.html#__init__
  Function
  Method
  PUBLIC
  Issue deprecation warning.
- twisted.mail.pop3.POP3Client.sendShort
  twisted.mail.pop3.POP3Client.html#sendShort
  Function
  Method
  PUBLIC
  Send a POP3 command to which a short response is expected.
- twisted.mail.pop3.POP3Client.sendLong
  twisted.mail.pop3.POP3Client.html#sendLong
  Function
  Method
  PUBLIC
  Send a POP3 command to which a long response is expected.
- twisted.mail.pop3.POP3Client.handle_default
  twisted.mail.pop3.POP3Client.html#handle_default
  Function
  Method
  PUBLIC
  Handle responses from the server for which no other handler exists.
- twisted.mail.pop3.POP3Client.handle_WELCOME
  twisted.mail.pop3.POP3Client.html#handle_WELCOME
  Function
  Method
  PUBLIC
  Handle a server response which is expected to be a server greeting.
- twisted.mail.pop3.POP3Client._dispatch
  twisted.mail.pop3.POP3Client.html#_dispatch
  Function
  Method
  PRIVATE
  Dispatch a response from the server for handling.
- twisted.mail.pop3.POP3Client.lineReceived
  twisted.mail.pop3.POP3Client.html#lineReceived
  Function
  Method
  PUBLIC
  Dispatch a received line for processing.
- twisted.mail.pop3.POP3Client.apopAuthenticate
  twisted.mail.pop3.POP3Client.html#apopAuthenticate
  Function
  Method
  PUBLIC
  Perform an authenticated login.
- twisted.mail.pop3.POP3Client.apop
  twisted.mail.pop3.POP3Client.html#apop
  Function
  Method
  PUBLIC
  Send an APOP command to perform authenticated login.
- twisted.mail.pop3.POP3Client.retr
  twisted.mail.pop3.POP3Client.html#retr
  Function
  Method
  PUBLIC
  Send a RETR command to retrieve a message from the server.
- twisted.mail.pop3.POP3Client.dele
  twisted.mail.pop3.POP3Client.html#dele
  Function
  Method
  PUBLIC
  Send a DELE command to delete a message from the server.
- twisted.mail.pop3.POP3Client.list
  twisted.mail.pop3.POP3Client.html#list
  Function
  Method
  PUBLIC
  Send a LIST command to retrieve the size of a message or, if no message is specified, the sizes of all messages.
- twisted.mail.pop3.POP3Client.uidl
  twisted.mail.pop3.POP3Client.html#uidl
  Function
  Method
  PUBLIC
  Send a UIDL command to retrieve the unique identifier of a message or, if no message is specified, the unique identifiers of all messages.
- twisted.mail.pop3.POP3Client.user
  twisted.mail.pop3.POP3Client.html#user
  Function
  Method
  PUBLIC
  Send a USER command to perform the first half of a plaintext login.
- twisted.mail.pop3.POP3Client.password
  twisted.mail.pop3.POP3Client.html#password
  Function
  Method
  PUBLIC
  Perform the second half of a plaintext login.
- twisted.mail.pop3.POP3Client.quit
  twisted.mail.pop3.POP3Client.html#quit
  Function
  Method
  PUBLIC
  Send a QUIT command to disconnect from the server.
- twisted.mail.pop3.InsecureAuthenticationDisallowed
  twisted.mail.pop3.InsecureAuthenticationDisallowed.html
  Class
  Exception
  PUBLIC
  An error indicating secure authentication was required but no mechanism could be found.
- twisted.mail.pop3.LineTooLong
  twisted.mail.pop3.LineTooLong.html
  Class
  Exception
  PUBLIC
  An error indicating that the server sent a line which exceeded the maximum line length (`LineOnlyReceiver.MAX_LENGTH`).
- twisted.mail.pop3.ServerErrorResponse
  twisted.mail.pop3.ServerErrorResponse.html
  Class
  Exception
  PUBLIC
  An error indicating that the server returned an error response to a request.
- twisted.mail.pop3.ServerErrorResponse.consumer
  twisted.mail.pop3.ServerErrorResponse.html#consumer
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`
- twisted.mail.pop3.ServerErrorResponse.__init__
  twisted.mail.pop3.ServerErrorResponse.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.mail.pop3.TLSError
  twisted.mail.pop3.TLSError.html
  Class
  Exception
  PUBLIC
  An error indicating secure authentication was required but either the transport does not support TLS or no TLS context factory was supplied.
- twisted.mail.pop3.TLSNotSupportedError
  twisted.mail.pop3.TLSNotSupportedError.html
  Class
  Exception
  PUBLIC
  An error indicating secure authentication was required but the server does not support TLS.
- twisted.mail.pop3.AdvancedPOP3Client
  twisted.mail.pop3.AdvancedPOP3Client.html
  Class
  Class
  PUBLIC
  A POP3 client protocol.
- twisted.mail.pop3.AdvancedPOP3Client.startedTLS
  twisted.mail.pop3.AdvancedPOP3Client.html#startedTLS
  Attribute
  Instance Variable
  PUBLIC
  An indication of whether TLS has been negotiated successfully.
- twisted.mail.pop3.AdvancedPOP3Client.allowInsecureLogin
  twisted.mail.pop3.AdvancedPOP3Client.html#allowInsecureLogin
  Attribute
  Instance Variable
  PUBLIC
  An indication of whether plaintext login should be allowed when the server offers no authentication challenge and the transport does not offer any protection via encryption.
- twisted.mail.pop3.AdvancedPOP3Client.serverChallenge
  twisted.mail.pop3.AdvancedPOP3Client.html#serverChallenge
  Attribute
  Instance Variable
  PUBLIC
  The challenge received in the server greeting.
- twisted.mail.pop3.AdvancedPOP3Client.timeout
  twisted.mail.pop3.AdvancedPOP3Client.html#timeout
  Attribute
  Instance Variable
  PUBLIC
  The number of seconds to wait on a response from the server before timing out a connection. If the number is <= 0, no timeout checking will be performed.
- twisted.mail.pop3.AdvancedPOP3Client._capCache
  twisted.mail.pop3.AdvancedPOP3Client.html#_capCache
  Attribute
  Instance Variable
  PRIVATE
  The cached server capabilities. Capabilities are not allowed to change during the session (except when TLS is negotiated), so the first response to a capabilities command can be used for later lookups.
- twisted.mail.pop3.AdvancedPOP3Client._challengeMagicRe
  twisted.mail.pop3.AdvancedPOP3Client.html#_challengeMagicRe
  Attribute
  Instance Variable
  PRIVATE
  A regular expression which matches the challenge in the server greeting.
- twisted.mail.pop3.AdvancedPOP3Client._blockedQueue
  twisted.mail.pop3.AdvancedPOP3Client.html#_blockedQueue
  Attribute
  Instance Variable
  PRIVATE
  A list of blocked commands. While a command is awaiting a response from the server, other commands are blocked. When no command is outstanding, `_blockedQueue` is set to `None`. Otherwise, it contains a list of information about blocked commands...
- twisted.mail.pop3.AdvancedPOP3Client._waiting
  twisted.mail.pop3.AdvancedPOP3Client.html#_waiting
  Attribute
  Instance Variable
  PRIVATE
  A deferred which fires when the response to the outstanding command is received from the server.
- twisted.mail.pop3.AdvancedPOP3Client._timedOut
  twisted.mail.pop3.AdvancedPOP3Client.html#_timedOut
  Attribute
  Instance Variable
  PRIVATE
  An indication of whether the connection was dropped because of a timeout.
- twisted.mail.pop3.AdvancedPOP3Client._greetingError
  twisted.mail.pop3.AdvancedPOP3Client.html#_greetingError
  Attribute
  Instance Variable
  PRIVATE
  The server greeting minus the status indicator, when the connection was dropped because of an error in the server greeting. Otherwise, `None`.
- twisted.mail.pop3.AdvancedPOP3Client.state
  twisted.mail.pop3.AdvancedPOP3Client.html#state
  Attribute
  Instance Variable
  PUBLIC
  The state which indicates what type of response is expected from the server. Valid states are: 'WELCOME', 'WAITING', 'SHORT', 'LONG_INITIAL', 'LONG'.
- twisted.mail.pop3.AdvancedPOP3Client._xform
  twisted.mail.pop3.AdvancedPOP3Client.html#_xform
  Attribute
  Instance Variable
  PRIVATE
  The transform function which is used to convert each line of a multi-line response into usable values for use by the consumer function. If `None`, each line of the multi-line response is sent directly to the consumer function.
- twisted.mail.pop3.AdvancedPOP3Client._consumer
  twisted.mail.pop3.AdvancedPOP3Client.html#_consumer
  Attribute
  Instance Variable
  PRIVATE
  The consumer function which is used to store the values derived by the transform function from each line of a multi-line response into a list.
- twisted.mail.pop3.AdvancedPOP3Client._blocked
  twisted.mail.pop3.AdvancedPOP3Client.html#_blocked
  Function
  Method
  PRIVATE
  Block a command, if necessary.
- twisted.mail.pop3.AdvancedPOP3Client._unblock
  twisted.mail.pop3.AdvancedPOP3Client.html#_unblock
  Function
  Method
  PRIVATE
  Send the next blocked command.
- twisted.mail.pop3.AdvancedPOP3Client.sendShort
  twisted.mail.pop3.AdvancedPOP3Client.html#sendShort
  Function
  Method
  PUBLIC
  Send a POP3 command to which a short response is expected.
- twisted.mail.pop3.AdvancedPOP3Client.sendLong
  twisted.mail.pop3.AdvancedPOP3Client.html#sendLong
  Function
  Method
  PUBLIC
  Send a POP3 command to which a multi-line response is expected.
- twisted.mail.pop3.AdvancedPOP3Client.connectionMade
  twisted.mail.pop3.AdvancedPOP3Client.html#connectionMade
  Function
  Method
  PUBLIC
  Wait for a greeting from the server after the connection has been made.
- twisted.mail.pop3.AdvancedPOP3Client.timeoutConnection
  twisted.mail.pop3.AdvancedPOP3Client.html#timeoutConnection
  Function
  Method
  PUBLIC
  Drop the connection when the server does not respond in time.
- twisted.mail.pop3.AdvancedPOP3Client.connectionLost
  twisted.mail.pop3.AdvancedPOP3Client.html#connectionLost
  Function
  Method
  PUBLIC
  Clean up when the connection has been lost.
- twisted.mail.pop3.AdvancedPOP3Client.lineReceived
  twisted.mail.pop3.AdvancedPOP3Client.html#lineReceived
  Function
  Method
  PUBLIC
  Pass a received line to a state machine function and transition to the next state.
- twisted.mail.pop3.AdvancedPOP3Client.lineLengthExceeded
  twisted.mail.pop3.AdvancedPOP3Client.html#lineLengthExceeded
  Function
  Method
  PUBLIC
  Drop the connection when a server response exceeds the maximum line length (`LineOnlyReceiver.MAX_LENGTH`).
- twisted.mail.pop3.AdvancedPOP3Client.state_WELCOME
  twisted.mail.pop3.AdvancedPOP3Client.html#state_WELCOME
  Function
  Method
  PUBLIC
  Handle server responses for the WELCOME state in which the server greeting is expected.
- twisted.mail.pop3.AdvancedPOP3Client.state_WAITING
  twisted.mail.pop3.AdvancedPOP3Client.html#state_WAITING
  Function
  Method
  PUBLIC
  Log an error for server responses received in the WAITING state during which the server is not expected to send anything.
- twisted.mail.pop3.AdvancedPOP3Client.state_SHORT
  twisted.mail.pop3.AdvancedPOP3Client.html#state_SHORT
  Function
  Method
  PUBLIC
  Handle server responses for the SHORT state in which the server is expected to send a single line response.
- twisted.mail.pop3.AdvancedPOP3Client.state_LONG_INITIAL
  twisted.mail.pop3.AdvancedPOP3Client.html#state_LONG_INITIAL
  Function
  Method
  PUBLIC
  Handle server responses for the LONG_INITIAL state in which the server is expected to send the first line of a multi-line response.
- twisted.mail.pop3.AdvancedPOP3Client.state_LONG
  twisted.mail.pop3.AdvancedPOP3Client.html#state_LONG
  Function
  Method
  PUBLIC
  Handle server responses for the LONG state in which the server is expected to send a non-initial line of a multi-line response.
- twisted.mail.pop3.AdvancedPOP3Client.serverGreeting
  twisted.mail.pop3.AdvancedPOP3Client.html#serverGreeting
  Function
  Method
  PUBLIC
  Handle the server greeting.
- twisted.mail.pop3.AdvancedPOP3Client.startTLS
  twisted.mail.pop3.AdvancedPOP3Client.html#startTLS
  Function
  Method
  PUBLIC
  Switch to encrypted communication using TLS.
- twisted.mail.pop3.AdvancedPOP3Client._startTLS
  twisted.mail.pop3.AdvancedPOP3Client.html#_startTLS
  Function
  Method
  PRIVATE
  Continue the process of switching to encrypted communication.
- twisted.mail.pop3.AdvancedPOP3Client._startedTLS
  twisted.mail.pop3.AdvancedPOP3Client.html#_startedTLS
  Function
  Method
  PRIVATE
  Complete the process of switching to encrypted communication.
- twisted.mail.pop3.AdvancedPOP3Client.transport
  twisted.mail.pop3.AdvancedPOP3Client.html#transport
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.pop3.AdvancedPOP3Client._getContextFactory
  twisted.mail.pop3.AdvancedPOP3Client.html#_getContextFactory
  Function
  Method
  PRIVATE
  Get a context factory with which to negotiate TLS.
- twisted.mail.pop3.AdvancedPOP3Client.login
  twisted.mail.pop3.AdvancedPOP3Client.html#login
  Function
  Method
  PUBLIC
  Log in to the server.
- twisted.mail.pop3.AdvancedPOP3Client._login
  twisted.mail.pop3.AdvancedPOP3Client.html#_login
  Function
  Method
  PRIVATE
  Continue the process of logging in to the server.
- twisted.mail.pop3.AdvancedPOP3Client._loginTLS
  twisted.mail.pop3.AdvancedPOP3Client.html#_loginTLS
  Function
  Method
  PRIVATE
  Do a plaintext login over an encrypted transport.
- twisted.mail.pop3.AdvancedPOP3Client._plaintext
  twisted.mail.pop3.AdvancedPOP3Client.html#_plaintext
  Function
  Method
  PRIVATE
  Perform a plaintext login.
- twisted.mail.pop3.AdvancedPOP3Client._apop
  twisted.mail.pop3.AdvancedPOP3Client.html#_apop
  Function
  Method
  PRIVATE
  Perform an APOP login.
- twisted.mail.pop3.AdvancedPOP3Client.apop
  twisted.mail.pop3.AdvancedPOP3Client.html#apop
  Function
  Method
  PUBLIC
  Send an APOP command to perform authenticated login.
- twisted.mail.pop3.AdvancedPOP3Client.user
  twisted.mail.pop3.AdvancedPOP3Client.html#user
  Function
  Method
  PUBLIC
  Send a USER command to perform the first half of plaintext login.
- twisted.mail.pop3.AdvancedPOP3Client.password
  twisted.mail.pop3.AdvancedPOP3Client.html#password
  Function
  Method
  PUBLIC
  Send a PASS command to perform the second half of plaintext login.
- twisted.mail.pop3.AdvancedPOP3Client.delete
  twisted.mail.pop3.AdvancedPOP3Client.html#delete
  Function
  Method
  PUBLIC
  Send a DELE command to delete a message from the server.
- twisted.mail.pop3.AdvancedPOP3Client._consumeOrSetItem
  twisted.mail.pop3.AdvancedPOP3Client.html#_consumeOrSetItem
  Function
  Method
  PRIVATE
  Send a command to which a long response is expected and process the multi-line response into a list accounting for deleted messages.
- twisted.mail.pop3.AdvancedPOP3Client._consumeOrAppend
  twisted.mail.pop3.AdvancedPOP3Client.html#_consumeOrAppend
  Function
  Method
  PRIVATE
  Send a command to which a long response is expected and process the multi-line response into a list.
- twisted.mail.pop3.AdvancedPOP3Client.capabilities
  twisted.mail.pop3.AdvancedPOP3Client.html#capabilities
  Function
  Method
  PUBLIC
  Send a CAPA command to retrieve the capabilities supported by the server.
- twisted.mail.pop3.AdvancedPOP3Client.noop
  twisted.mail.pop3.AdvancedPOP3Client.html#noop
  Function
  Method
  PUBLIC
  Send a NOOP command asking the server to do nothing but respond.
- twisted.mail.pop3.AdvancedPOP3Client.reset
  twisted.mail.pop3.AdvancedPOP3Client.html#reset
  Function
  Method
  PUBLIC
  Send a RSET command to unmark any messages that have been flagged for deletion on the server.
- twisted.mail.pop3.AdvancedPOP3Client.retrieve
  twisted.mail.pop3.AdvancedPOP3Client.html#retrieve
  Function
  Method
  PUBLIC
  Send a RETR or TOP command to retrieve all or part of a message from the server.
- twisted.mail.pop3.AdvancedPOP3Client.stat
  twisted.mail.pop3.AdvancedPOP3Client.html#stat
  Function
  Method
  PUBLIC
  Send a STAT command to get information about the size of the mailbox.
- twisted.mail.pop3.AdvancedPOP3Client.listSize
  twisted.mail.pop3.AdvancedPOP3Client.html#listSize
  Function
  Method
  PUBLIC
  Send a LIST command to retrieve the sizes of all messages on the server.
- twisted.mail.pop3.AdvancedPOP3Client.listUID
  twisted.mail.pop3.AdvancedPOP3Client.html#listUID
  Function
  Method
  PUBLIC
  Send a UIDL command to retrieve the UIDs of all messages on the server.
- twisted.mail.pop3.AdvancedPOP3Client.quit
  twisted.mail.pop3.AdvancedPOP3Client.html#quit
  Function
  Method
  PUBLIC
  Send a QUIT command to disconnect from the server.
- twisted.mail.relay.DomainQueuer
  twisted.mail.relay.DomainQueuer.html
  Class
  Class
  PUBLIC
  An SMTP domain which add messages to a queue intended for relaying.
- twisted.mail.relay.DomainQueuer.__init__
  twisted.mail.relay.DomainQueuer.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.relay.DomainQueuer.service
  twisted.mail.relay.DomainQueuer.html#service
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.relay.DomainQueuer.authed
  twisted.mail.relay.DomainQueuer.html#authed
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.relay.DomainQueuer.exists
  twisted.mail.relay.DomainQueuer.html#exists
  Function
  Method
  PUBLIC
  Check whether mail can be relayed to a user.
- twisted.mail.relay.DomainQueuer.willRelay
  twisted.mail.relay.DomainQueuer.html#willRelay
  Function
  Method
  PUBLIC
  Check whether we agree to relay.
- twisted.mail.relay.DomainQueuer.startMessage
  twisted.mail.relay.DomainQueuer.html#startMessage
  Function
  Method
  PUBLIC
  Create an envelope and a message receiver for the relay queue.
- twisted.mail.relay.RelayerMixin
  twisted.mail.relay.RelayerMixin.html
  Class
  Class
  PUBLIC
  No class docstring; 0/2 instance variable, 1/5 method documented
- twisted.mail.relay.RelayerMixin.loadMessages
  twisted.mail.relay.RelayerMixin.html#loadMessages
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.relay.RelayerMixin.messages
  twisted.mail.relay.RelayerMixin.html#messages
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.relay.RelayerMixin.names
  twisted.mail.relay.RelayerMixin.html#names
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.relay.RelayerMixin.getMailFrom
  twisted.mail.relay.RelayerMixin.html#getMailFrom
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.relay.RelayerMixin.getMailTo
  twisted.mail.relay.RelayerMixin.html#getMailTo
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.relay.RelayerMixin.getMailData
  twisted.mail.relay.RelayerMixin.html#getMailData
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.relay.RelayerMixin.sentMail
  twisted.mail.relay.RelayerMixin.html#sentMail
  Function
  Method
  PUBLIC
  Since we only use one recipient per envelope, this will be called with 0 or 1 addresses. We probably want to do something with the error message if we failed.
- twisted.mail.relay.SMTPRelayer
  twisted.mail.relay.SMTPRelayer.html
  Class
  Class
  PUBLIC
  A base class for SMTP relayers.
- twisted.mail.relay.SMTPRelayer.__init__
  twisted.mail.relay.SMTPRelayer.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.mail.relay.ESMTPRelayer
  twisted.mail.relay.ESMTPRelayer.html
  Class
  Class
  PUBLIC
  A base class for ESMTP relayers.
- twisted.mail.relay.ESMTPRelayer.__init__
  twisted.mail.relay.ESMTPRelayer.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.mail.protocols.DomainDeliveryBase
  twisted.mail.protocols.DomainDeliveryBase.html
  Class
  Class
  PUBLIC
  A base class for message delivery using the domains of a mail service.
- twisted.mail.protocols.DomainDeliveryBase.service
  twisted.mail.protocols.DomainDeliveryBase.html#service
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`
- twisted.mail.protocols.DomainDeliveryBase.user
  twisted.mail.protocols.DomainDeliveryBase.html#user
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`
- twisted.mail.protocols.DomainDeliveryBase.host
  twisted.mail.protocols.DomainDeliveryBase.html#host
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`
- twisted.mail.protocols.DomainDeliveryBase.protocolName
  twisted.mail.protocols.DomainDeliveryBase.html#protocolName
  Attribute
  Instance Variable
  PUBLIC
  The protocol being used to deliver the mail. Sub-classes should set this appropriately.
- twisted.mail.protocols.DomainDeliveryBase.__init__
  twisted.mail.protocols.DomainDeliveryBase.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.mail.protocols.DomainDeliveryBase.receivedHeader
  twisted.mail.protocols.DomainDeliveryBase.html#receivedHeader
  Function
  Method
  PUBLIC
  Generate a received header string for a message.
- twisted.mail.protocols.DomainDeliveryBase.validateTo
  twisted.mail.protocols.DomainDeliveryBase.html#validateTo
  Function
  Method
  PUBLIC
  Validate the address for which a message is destined.
- twisted.mail.protocols.DomainDeliveryBase.validateFrom
  twisted.mail.protocols.DomainDeliveryBase.html#validateFrom
  Function
  Method
  PUBLIC
  Validate the address from which a message originates.
- twisted.mail.protocols.SMTPDomainDelivery
  twisted.mail.protocols.SMTPDomainDelivery.html
  Class
  Class
  PUBLIC
  A domain delivery base class for use in an SMTP server.
- twisted.mail.protocols.SMTPDomainDelivery.protocolName
  twisted.mail.protocols.SMTPDomainDelivery.html#protocolName
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.protocols.ESMTPDomainDelivery
  twisted.mail.protocols.ESMTPDomainDelivery.html
  Class
  Class
  PUBLIC
  A domain delivery base class for use in an ESMTP server.
- twisted.mail.protocols.ESMTPDomainDelivery.protocolName
  twisted.mail.protocols.ESMTPDomainDelivery.html#protocolName
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.protocols.SMTPFactory
  twisted.mail.protocols.SMTPFactory.html
  Class
  Class
  PUBLIC
  An SMTP server protocol factory.
- twisted.mail.protocols.SMTPFactory.service
  twisted.mail.protocols.SMTPFactory.html#service
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`
- twisted.mail.protocols.SMTPFactory.portal
  twisted.mail.protocols.SMTPFactory.html#portal
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`
- twisted.mail.protocols.SMTPFactory.protocol
  twisted.mail.protocols.SMTPFactory.html#protocol
  Attribute
  Instance Variable
  PUBLIC
  A callable which creates a protocol. The default value is `SMTP`.
- twisted.mail.protocols.SMTPFactory.__init__
  twisted.mail.protocols.SMTPFactory.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.mail.protocols.SMTPFactory.buildProtocol
  twisted.mail.protocols.SMTPFactory.html#buildProtocol
  Function
  Method
  PUBLIC
  Create an instance of an SMTP server protocol.
- twisted.mail.protocols.ESMTPFactory
  twisted.mail.protocols.ESMTPFactory.html
  Class
  Class
  PUBLIC
  An ESMTP server protocol factory.
- twisted.mail.protocols.ESMTPFactory.protocol
  twisted.mail.protocols.ESMTPFactory.html#protocol
  Attribute
  Instance Variable
  PUBLIC
  A callable which creates a protocol. The default value is `ESMTP`.
- twisted.mail.protocols.ESMTPFactory.context
  twisted.mail.protocols.ESMTPFactory.html#context
  Attribute
  Instance Variable
  PUBLIC
  A factory to generate contexts to be used in negotiating encrypted communication.
- twisted.mail.protocols.ESMTPFactory.challengers
  twisted.mail.protocols.ESMTPFactory.html#challengers
  Attribute
  Instance Variable
  PUBLIC
  A mapping of acceptable authorization mechanism to callable which creates credentials to use for authentication.
- twisted.mail.protocols.ESMTPFactory.__init__
  twisted.mail.protocols.ESMTPFactory.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.mail.protocols.ESMTPFactory.buildProtocol
  twisted.mail.protocols.ESMTPFactory.html#buildProtocol
  Function
  Method
  PUBLIC
  Create an instance of an ESMTP server protocol.
- twisted.mail.protocols.VirtualPOP3
  twisted.mail.protocols.VirtualPOP3.html
  Class
  Class
  PUBLIC
  A virtual hosting POP3 server.
- twisted.mail.protocols.VirtualPOP3.service
  twisted.mail.protocols.VirtualPOP3.html#service
  Attribute
  Instance Variable
  PUBLIC
  The email service that created this server. This must be set by the service.
- twisted.mail.protocols.VirtualPOP3.domainSpecifier
  twisted.mail.protocols.VirtualPOP3.html#domainSpecifier
  Attribute
  Instance Variable
  PUBLIC
  The character to use to split an email address into local-part and domain. The default is '@'.
- twisted.mail.protocols.VirtualPOP3.authenticateUserAPOP
  twisted.mail.protocols.VirtualPOP3.html#authenticateUserAPOP
  Function
  Method
  PUBLIC
  Perform APOP authentication.
- twisted.mail.protocols.VirtualPOP3.authenticateUserPASS
  twisted.mail.protocols.VirtualPOP3.html#authenticateUserPASS
  Function
  Method
  PUBLIC
  Perform authentication for a username/password login.
- twisted.mail.protocols.VirtualPOP3.lookupDomain
  twisted.mail.protocols.VirtualPOP3.html#lookupDomain
  Function
  Method
  PUBLIC
  Check whether a domain is among the virtual domains supported by the mail service.
- twisted.mail.protocols.POP3Factory
  twisted.mail.protocols.POP3Factory.html
  Class
  Class
  PUBLIC
  A POP3 server protocol factory.
- twisted.mail.protocols.POP3Factory.service
  twisted.mail.protocols.POP3Factory.html#service
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`
- twisted.mail.protocols.POP3Factory.protocol
  twisted.mail.protocols.POP3Factory.html#protocol
  Attribute
  Instance Variable
  PUBLIC
  A callable which creates a protocol. The default value is `VirtualPOP3`.
- twisted.mail.protocols.POP3Factory.__init__
  twisted.mail.protocols.POP3Factory.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.mail.protocols.POP3Factory.buildProtocol
  twisted.mail.protocols.POP3Factory.html#buildProtocol
  Function
  Method
  PUBLIC
  Create an instance of a POP3 server protocol.
- twisted.mail.mail.DomainWithDefaultDict
  twisted.mail.mail.DomainWithDefaultDict.html
  Class
  Class
  PUBLIC
  A simulated dictionary for mapping domain names to domain objects with a default value for non-existing keys.
- twisted.mail.mail.DomainWithDefaultDict.domains
  twisted.mail.mail.DomainWithDefaultDict.html#domains
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`
- twisted.mail.mail.DomainWithDefaultDict.default
  twisted.mail.mail.DomainWithDefaultDict.html#default
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`
- twisted.mail.mail.DomainWithDefaultDict.__init__
  twisted.mail.mail.DomainWithDefaultDict.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.mail.mail.DomainWithDefaultDict.setDefaultDomain
  twisted.mail.mail.DomainWithDefaultDict.html#setDefaultDomain
  Function
  Method
  PUBLIC
  Set the default domain.
- twisted.mail.mail.DomainWithDefaultDict.has_key
  twisted.mail.mail.DomainWithDefaultDict.html#has_key
  Function
  Method
  PUBLIC
  Test for the presence of a domain name in this dictionary.
- twisted.mail.mail.DomainWithDefaultDict.fromkeys
  twisted.mail.mail.DomainWithDefaultDict.html#fromkeys
  Function
  Class Method
  PUBLIC
  Create a new `DomainWithDefaultDict` with the specified keys.
- twisted.mail.mail.DomainWithDefaultDict.__contains__
  twisted.mail.mail.DomainWithDefaultDict.html#__contains__
  Function
  Method
  PUBLIC
  Test for the presence of a domain name in this dictionary.
- twisted.mail.mail.DomainWithDefaultDict.__getitem__
  twisted.mail.mail.DomainWithDefaultDict.html#__getitem__
  Function
  Method
  PUBLIC
  Look up a domain name and, if it is present, return the domain object associated with it. Otherwise return the default domain.
- twisted.mail.mail.DomainWithDefaultDict.__setitem__
  twisted.mail.mail.DomainWithDefaultDict.html#__setitem__
  Function
  Method
  PUBLIC
  Associate a domain object with a domain name in this dictionary.
- twisted.mail.mail.DomainWithDefaultDict.__delitem__
  twisted.mail.mail.DomainWithDefaultDict.html#__delitem__
  Function
  Method
  PUBLIC
  Delete the entry for a domain name in this dictionary.
- twisted.mail.mail.DomainWithDefaultDict.__iter__
  twisted.mail.mail.DomainWithDefaultDict.html#__iter__
  Function
  Method
  PUBLIC
  Return an iterator over the domain names in this dictionary.
- twisted.mail.mail.DomainWithDefaultDict.__len__
  twisted.mail.mail.DomainWithDefaultDict.html#__len__
  Function
  Method
  PUBLIC
  Return the number of domains in this dictionary.
- twisted.mail.mail.DomainWithDefaultDict.__str__
  twisted.mail.mail.DomainWithDefaultDict.html#__str__
  Function
  Method
  PUBLIC
  Build an informal string representation of this dictionary.
- twisted.mail.mail.DomainWithDefaultDict.__repr__
  twisted.mail.mail.DomainWithDefaultDict.html#__repr__
  Function
  Method
  PUBLIC
  Build an "official" string representation of this dictionary.
- twisted.mail.mail.DomainWithDefaultDict.get
  twisted.mail.mail.DomainWithDefaultDict.html#get
  Function
  Method
  PUBLIC
  Look up a domain name in this dictionary.
- twisted.mail.mail.DomainWithDefaultDict.copy
  twisted.mail.mail.DomainWithDefaultDict.html#copy
  Function
  Method
  PUBLIC
  Make a copy of this dictionary.
- twisted.mail.mail.DomainWithDefaultDict.iteritems
  twisted.mail.mail.DomainWithDefaultDict.html#iteritems
  Function
  Method
  PUBLIC
  Return an iterator over the domain name/domain object pairs in the dictionary.
- twisted.mail.mail.DomainWithDefaultDict.iterkeys
  twisted.mail.mail.DomainWithDefaultDict.html#iterkeys
  Function
  Method
  PUBLIC
  Return an iterator over the domain names in this dictionary.
- twisted.mail.mail.DomainWithDefaultDict.itervalues
  twisted.mail.mail.DomainWithDefaultDict.html#itervalues
  Function
  Method
  PUBLIC
  Return an iterator over the domain objects in this dictionary.
- twisted.mail.mail.DomainWithDefaultDict.keys
  twisted.mail.mail.DomainWithDefaultDict.html#keys
  Function
  Method
  PUBLIC
  Return a list of all domain names in this dictionary.
- twisted.mail.mail.DomainWithDefaultDict.values
  twisted.mail.mail.DomainWithDefaultDict.html#values
  Function
  Method
  PUBLIC
  Return a list of all domain objects in this dictionary.
- twisted.mail.mail.DomainWithDefaultDict.items
  twisted.mail.mail.DomainWithDefaultDict.html#items
  Function
  Method
  PUBLIC
  Return a list of all domain name/domain object pairs in this dictionary.
- twisted.mail.mail.DomainWithDefaultDict.popitem
  twisted.mail.mail.DomainWithDefaultDict.html#popitem
  Function
  Method
  PUBLIC
  Remove a random domain name/domain object pair from this dictionary and return it as a tuple.
- twisted.mail.mail.DomainWithDefaultDict.update
  twisted.mail.mail.DomainWithDefaultDict.html#update
  Function
  Method
  PUBLIC
  Update this dictionary with domain name/domain object pairs from another dictionary.
- twisted.mail.mail.DomainWithDefaultDict.clear
  twisted.mail.mail.DomainWithDefaultDict.html#clear
  Function
  Method
  PUBLIC
  Remove all items from this dictionary.
- twisted.mail.mail.DomainWithDefaultDict.setdefault
  twisted.mail.mail.DomainWithDefaultDict.html#setdefault
  Function
  Method
  PUBLIC
  Return the domain object associated with the domain name if it is present in this dictionary. Otherwise, set the value for the domain name to the default and return that value.
- twisted.mail.mail.BounceDomain
  twisted.mail.mail.BounceDomain.html
  Class
  Class
  PUBLIC
  A domain with no users.
- twisted.mail.mail.BounceDomain.exists
  twisted.mail.mail.BounceDomain.html#exists
  Function
  Method
  PUBLIC
  Raise an exception to indicate that the user does not exist in this domain.
- twisted.mail.mail.BounceDomain.willRelay
  twisted.mail.mail.BounceDomain.html#willRelay
  Function
  Method
  PUBLIC
  Indicate that this domain will not relay.
- twisted.mail.mail.BounceDomain.addUser
  twisted.mail.mail.BounceDomain.html#addUser
  Function
  Method
  PUBLIC
  Ignore attempts to add a user to this domain.
- twisted.mail.mail.BounceDomain.getCredentialsCheckers
  twisted.mail.mail.BounceDomain.html#getCredentialsCheckers
  Function
  Method
  PUBLIC
  Return no credentials checkers for this domain.
- twisted.mail.mail.FileMessage
  twisted.mail.mail.FileMessage.html
  Class
  Class
  PUBLIC
  A message receiver which delivers a message to a file.
- twisted.mail.mail.FileMessage.fp
  twisted.mail.mail.FileMessage.html#fp
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`.
- twisted.mail.mail.FileMessage.name
  twisted.mail.mail.FileMessage.html#name
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`.
- twisted.mail.mail.FileMessage.finalName
  twisted.mail.mail.FileMessage.html#finalName
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`.
- twisted.mail.mail.FileMessage.__init__
  twisted.mail.mail.FileMessage.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.mail.mail.FileMessage.lineReceived
  twisted.mail.mail.FileMessage.html#lineReceived
  Function
  Method
  PUBLIC
  Write a received line to the file.
- twisted.mail.mail.FileMessage.eomReceived
  twisted.mail.mail.FileMessage.html#eomReceived
  Function
  Method
  PUBLIC
  At the end of message, rename the file holding the message to its final name.
- twisted.mail.mail.FileMessage.connectionLost
  twisted.mail.mail.FileMessage.html#connectionLost
  Function
  Method
  PUBLIC
  Delete the file holding the partially received message.
- twisted.mail.mail.MailService
  twisted.mail.mail.MailService.html
  Class
  Class
  PUBLIC
  An email service.
- twisted.mail.mail.MailService.queue
  twisted.mail.mail.MailService.html#queue
  Attribute
  Instance Variable
  PUBLIC
  A queue for outgoing messages.
- twisted.mail.mail.MailService.domains
  twisted.mail.mail.MailService.html#domains
  Attribute
  Instance Variable
  PUBLIC
  A mapping of supported domain name to domain object.
- twisted.mail.mail.MailService.portals
  twisted.mail.mail.MailService.html#portals
  Attribute
  Instance Variable
  PUBLIC
  A mapping of domain name to authentication portal.
- twisted.mail.mail.MailService.aliases
  twisted.mail.mail.MailService.html#aliases
  Attribute
  Instance Variable
  PUBLIC
  A mapping of domain name to alias.
- twisted.mail.mail.MailService.smtpPortal
  twisted.mail.mail.MailService.html#smtpPortal
  Attribute
  Instance Variable
  PUBLIC
  A portal for authentication for the SMTP server.
- twisted.mail.mail.MailService.monitor
  twisted.mail.mail.MailService.html#monitor
  Attribute
  Instance Variable
  PUBLIC
  A service to monitor changes to files.
- twisted.mail.mail.MailService.__init__
  twisted.mail.mail.MailService.html#__init__
  Function
  Method
  PUBLIC
  Initialize the mail service.
- twisted.mail.mail.MailService.getPOP3Factory
  twisted.mail.mail.MailService.html#getPOP3Factory
  Function
  Method
  PUBLIC
  Create a POP3 protocol factory.
- twisted.mail.mail.MailService.getSMTPFactory
  twisted.mail.mail.MailService.html#getSMTPFactory
  Function
  Method
  PUBLIC
  Create an SMTP protocol factory.
- twisted.mail.mail.MailService.getESMTPFactory
  twisted.mail.mail.MailService.html#getESMTPFactory
  Function
  Method
  PUBLIC
  Create an ESMTP protocol factory.
- twisted.mail.mail.MailService.addDomain
  twisted.mail.mail.MailService.html#addDomain
  Function
  Method
  PUBLIC
  Add a domain for which the service will accept email.
- twisted.mail.mail.MailService.setQueue
  twisted.mail.mail.MailService.html#setQueue
  Function
  Method
  PUBLIC
  Set the queue for outgoing emails.
- twisted.mail.mail.MailService.requestAvatar
  twisted.mail.mail.MailService.html#requestAvatar
  Function
  Method
  PUBLIC
  Return a message delivery for an authenticated SMTP user.
- twisted.mail.mail.MailService.lookupPortal
  twisted.mail.mail.MailService.html#lookupPortal
  Function
  Method
  PUBLIC
  Find the portal for a domain.
- twisted.mail.mail.MailService.defaultPortal
  twisted.mail.mail.MailService.html#defaultPortal
  Function
  Method
  PUBLIC
  Return the portal for the default domain.
- twisted.mail.mail.FileMonitoringService
  twisted.mail.mail.FileMonitoringService.html
  Class
  Class
  PUBLIC
  A service for monitoring changes to files.
- twisted.mail.mail.FileMonitoringService.files
  twisted.mail.mail.FileMonitoringService.html#files
  Attribute
  Instance Variable
  PUBLIC
  Information about files to be monitored. Each list entry provides the following information for a file: interval in seconds between checks, filename, callback function, time of last modification to the file.
- twisted.mail.mail.FileMonitoringService.intervals
  twisted.mail.mail.FileMonitoringService.html#intervals
  Attribute
  Instance Variable
  PUBLIC
  Intervals between successive file checks.
- twisted.mail.mail.FileMonitoringService._call
  twisted.mail.mail.FileMonitoringService.html#_call
  Attribute
  Instance Variable
  PRIVATE
  The next scheduled call to check a file.
- twisted.mail.mail.FileMonitoringService.index
  twisted.mail.mail.FileMonitoringService.html#index
  Attribute
  Instance Variable
  PUBLIC
  The index of the next file to be checked.
- twisted.mail.mail.FileMonitoringService.__init__
  twisted.mail.mail.FileMonitoringService.html#__init__
  Function
  Method
  PUBLIC
  Initialize the file monitoring service.
- twisted.mail.mail.FileMonitoringService.startService
  twisted.mail.mail.FileMonitoringService.html#startService
  Function
  Method
  PUBLIC
  Start the file monitoring service.
- twisted.mail.mail.FileMonitoringService._setupMonitor
  twisted.mail.mail.FileMonitoringService.html#_setupMonitor
  Function
  Method
  PRIVATE
  Schedule the next monitoring call.
- twisted.mail.mail.FileMonitoringService.stopService
  twisted.mail.mail.FileMonitoringService.html#stopService
  Function
  Method
  PUBLIC
  Stop the file monitoring service.
- twisted.mail.mail.FileMonitoringService.monitorFile
  twisted.mail.mail.FileMonitoringService.html#monitorFile
  Function
  Method
  PUBLIC
  Start monitoring a file for changes.
- twisted.mail.mail.FileMonitoringService.unmonitorFile
  twisted.mail.mail.FileMonitoringService.html#unmonitorFile
  Function
  Method
  PUBLIC
  Stop monitoring a file.
- twisted.mail.mail.FileMonitoringService._monitor
  twisted.mail.mail.FileMonitoringService.html#_monitor
  Function
  Method
  PRIVATE
  Monitor a file and make a callback if it has changed.
- twisted.persisted.dirdbm.DirDBM
  twisted.persisted.dirdbm.DirDBM.html
  Class
  Class
  PUBLIC
  A directory with a DBM interface.
- twisted.persisted.dirdbm.DirDBM.__init__
  twisted.persisted.dirdbm.DirDBM.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.persisted.dirdbm.DirDBM.dname
  twisted.persisted.dirdbm.DirDBM.html#dname
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.persisted.dirdbm.DirDBM._dnamePath
  twisted.persisted.dirdbm.DirDBM.html#_dnamePath
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.persisted.dirdbm.DirDBM._encode
  twisted.persisted.dirdbm.DirDBM.html#_encode
  Function
  Method
  PRIVATE
  Encode a key so it can be used as a filename.
- twisted.persisted.dirdbm.DirDBM._decode
  twisted.persisted.dirdbm.DirDBM.html#_decode
  Function
  Method
  PRIVATE
  Decode a filename to get the key.
- twisted.persisted.dirdbm.DirDBM._readFile
  twisted.persisted.dirdbm.DirDBM.html#_readFile
  Function
  Method
  PRIVATE
  Read in the contents of a file.
- twisted.persisted.dirdbm.DirDBM._writeFile
  twisted.persisted.dirdbm.DirDBM.html#_writeFile
  Function
  Method
  PRIVATE
  Write data to a file.
- twisted.persisted.dirdbm.DirDBM.__len__
  twisted.persisted.dirdbm.DirDBM.html#__len__
  Function
  Method
  PUBLIC
  No summary
- twisted.persisted.dirdbm.DirDBM.__setitem__
  twisted.persisted.dirdbm.DirDBM.html#__setitem__
  Function
  Method
  PUBLIC
  `dirdbm[k] = v` Create or modify a textfile in this directory
- twisted.persisted.dirdbm.DirDBM.__getitem__
  twisted.persisted.dirdbm.DirDBM.html#__getitem__
  Function
  Method
  PUBLIC
  `dirdbm[k]` Get the contents of a file in this directory as a string.
- twisted.persisted.dirdbm.DirDBM.__delitem__
  twisted.persisted.dirdbm.DirDBM.html#__delitem__
  Function
  Method
  PUBLIC
  `del dirdbm[foo]` Delete a file in this directory.
- twisted.persisted.dirdbm.DirDBM.keys
  twisted.persisted.dirdbm.DirDBM.html#keys
  Function
  Method
  PUBLIC
  No summary
- twisted.persisted.dirdbm.DirDBM.values
  twisted.persisted.dirdbm.DirDBM.html#values
  Function
  Method
  PUBLIC
  No summary
- twisted.persisted.dirdbm.DirDBM.items
  twisted.persisted.dirdbm.DirDBM.html#items
  Function
  Method
  PUBLIC
  No summary
- twisted.persisted.dirdbm.DirDBM.has_key
  twisted.persisted.dirdbm.DirDBM.html#has_key
  Function
  Method
  PUBLIC
  No summary
- twisted.persisted.dirdbm.DirDBM.setdefault
  twisted.persisted.dirdbm.DirDBM.html#setdefault
  Function
  Method
  PUBLIC
  No summary
- twisted.persisted.dirdbm.DirDBM.get
  twisted.persisted.dirdbm.DirDBM.html#get
  Function
  Method
  PUBLIC
  No summary
- twisted.persisted.dirdbm.DirDBM.__contains__
  twisted.persisted.dirdbm.DirDBM.html#__contains__
  Function
  Method
  PUBLIC
  No summary
- twisted.persisted.dirdbm.DirDBM.update
  twisted.persisted.dirdbm.DirDBM.html#update
  Function
  Method
  PUBLIC
  Add all the key/value pairs in `dict` to this dirdbm. Any conflicting keys will be overwritten with the values from `dict`.
- twisted.persisted.dirdbm.DirDBM.copyTo
  twisted.persisted.dirdbm.DirDBM.html#copyTo
  Function
  Method
  PUBLIC
  Copy the contents of this dirdbm to the dirdbm at `path`.
- twisted.persisted.dirdbm.DirDBM.clear
  twisted.persisted.dirdbm.DirDBM.html#clear
  Function
  Method
  PUBLIC
  Delete all key/value pairs in this dirdbm.
- twisted.persisted.dirdbm.DirDBM.close
  twisted.persisted.dirdbm.DirDBM.html#close
  Function
  Method
  PUBLIC
  Close this dbm: no-op, for dbm-style interface compliance.
- twisted.persisted.dirdbm.DirDBM.getModificationTime
  twisted.persisted.dirdbm.DirDBM.html#getModificationTime
  Function
  Method
  PUBLIC
  Returns modification time of an entry.
- twisted.persisted.dirdbm.Shelf
  twisted.persisted.dirdbm.Shelf.html
  Class
  Class
  PUBLIC
  A directory with a DBM shelf interface.
- twisted.persisted.dirdbm.Shelf.__setitem__
  twisted.persisted.dirdbm.Shelf.html#__setitem__
  Function
  Method
  PUBLIC
  `shelf[foo] = bar` Create or modify a textfile in this directory.
- twisted.persisted.dirdbm.Shelf.__getitem__
  twisted.persisted.dirdbm.Shelf.html#__getitem__
  Function
  Method
  PUBLIC
  `dirdbm[foo]` Get and unpickle the contents of a file in this directory.
- twisted.persisted.dirdbm.open
  twisted.persisted.dirdbm.html#open
  Function
  Function
  PUBLIC
  This is for 'anydbm' compatibility.
- twisted.mail.maildir.INTERNAL_ERROR
  twisted.mail.maildir.html#INTERNAL_ERROR
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.mail.maildir._MaildirNameGenerator
  twisted.mail.maildir._MaildirNameGenerator.html
  Class
  Class
  PRIVATE
  A utility class to generate a unique maildir name.
- twisted.mail.maildir._MaildirNameGenerator.n
  twisted.mail.maildir._MaildirNameGenerator.html#n
  Attribute
  Instance Variable
  PUBLIC
  A counter used to generate unique integers.
- twisted.mail.maildir._MaildirNameGenerator.p
  twisted.mail.maildir._MaildirNameGenerator.html#p
  Attribute
  Instance Variable
  PUBLIC
  The ID of the current process.
- twisted.mail.maildir._MaildirNameGenerator.s
  twisted.mail.maildir._MaildirNameGenerator.html#s
  Attribute
  Instance Variable
  PUBLIC
  A representation of the hostname.
- twisted.mail.maildir._MaildirNameGenerator._clock
  twisted.mail.maildir._MaildirNameGenerator.html#_clock
  Attribute
  Instance Variable
  PRIVATE
  See `clock` parameter of `__init__`.
- twisted.mail.maildir._MaildirNameGenerator.__init__
  twisted.mail.maildir._MaildirNameGenerator.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.mail.maildir._MaildirNameGenerator.generate
  twisted.mail.maildir._MaildirNameGenerator.html#generate
  Function
  Method
  PUBLIC
  Generate a string which is intended to be unique across all calls to this function (across all processes, reboots, etc).
- twisted.mail.maildir._generateMaildirName
  twisted.mail.maildir.html#_generateMaildirName
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.mail.maildir.initializeMaildir
  twisted.mail.maildir.html#initializeMaildir
  Function
  Function
  PUBLIC
  Create a maildir user directory if it doesn't already exist.
- twisted.mail.maildir.MaildirMessage
  twisted.mail.maildir.MaildirMessage.html
  Class
  Class
  PUBLIC
  A message receiver which adds a header and delivers a message to a file whose name includes the size of the message.
- twisted.mail.maildir.MaildirMessage.size
  twisted.mail.maildir.MaildirMessage.html#size
  Attribute
  Instance Variable
  PUBLIC
  The number of octets in the message.
- twisted.mail.maildir.MaildirMessage.__init__
  twisted.mail.maildir.MaildirMessage.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.mail.maildir.MaildirMessage.lineReceived
  twisted.mail.maildir.MaildirMessage.html#lineReceived
  Function
  Method
  PUBLIC
  Write a line to the file.
- twisted.mail.maildir.MaildirMessage.eomReceived
  twisted.mail.maildir.MaildirMessage.html#eomReceived
  Function
  Method
  PUBLIC
  At the end of message, rename the file holding the message to its final name concatenated with the size of the file.
- twisted.mail.maildir.MaildirMessage.finalName
  twisted.mail.maildir.MaildirMessage.html#finalName
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.maildir.AbstractMaildirDomain
  twisted.mail.maildir.AbstractMaildirDomain.html
  Class
  Class
  PUBLIC
  An abstract maildir-backed domain.
- twisted.mail.maildir.AbstractMaildirDomain.alias
  twisted.mail.maildir.AbstractMaildirDomain.html#alias
  Attribute
  Instance Variable
  PUBLIC
  A mapping of username to alias.
- twisted.mail.maildir.AbstractMaildirDomain.root
  twisted.mail.maildir.AbstractMaildirDomain.html#root
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`.
- twisted.mail.maildir.AbstractMaildirDomain.__init__
  twisted.mail.maildir.AbstractMaildirDomain.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.mail.maildir.AbstractMaildirDomain.userDirectory
  twisted.mail.maildir.AbstractMaildirDomain.html#userDirectory
  Function
  Method
  PUBLIC
  Return the maildir directory for a user.
- twisted.mail.maildir.AbstractMaildirDomain.setAliasGroup
  twisted.mail.maildir.AbstractMaildirDomain.html#setAliasGroup
  Function
  Method
  PUBLIC
  Set the group of defined aliases for this domain.
- twisted.mail.maildir.AbstractMaildirDomain.exists
  twisted.mail.maildir.AbstractMaildirDomain.html#exists
  Function
  Method
  PUBLIC
  Check whether a user exists in this domain or an alias of it.
- twisted.mail.maildir.AbstractMaildirDomain.startMessage
  twisted.mail.maildir.AbstractMaildirDomain.html#startMessage
  Function
  Method
  PUBLIC
  Create a maildir message for a user.
- twisted.mail.maildir.AbstractMaildirDomain.willRelay
  twisted.mail.maildir.AbstractMaildirDomain.html#willRelay
  Function
  Method
  PUBLIC
  Check whether this domain will relay.
- twisted.mail.maildir.AbstractMaildirDomain.addUser
  twisted.mail.maildir.AbstractMaildirDomain.html#addUser
  Function
  Method
  PUBLIC
  Add a user to this domain.
- twisted.mail.maildir.AbstractMaildirDomain.getCredentialsCheckers
  twisted.mail.maildir.AbstractMaildirDomain.html#getCredentialsCheckers
  Function
  Method
  PUBLIC
  Return credentials checkers for this domain.
- twisted.mail.maildir._MaildirMailboxAppendMessageTask
  twisted.mail.maildir._MaildirMailboxAppendMessageTask.html
  Class
  Class
  PRIVATE
  A task which adds a message to a maildir mailbox.
- twisted.mail.maildir._MaildirMailboxAppendMessageTask.mbox
  twisted.mail.maildir._MaildirMailboxAppendMessageTask.html#mbox
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`.
- twisted.mail.maildir._MaildirMailboxAppendMessageTask.defer
  twisted.mail.maildir._MaildirMailboxAppendMessageTask.html#defer
  Attribute
  Instance Variable
  PUBLIC
  A deferred which fires when the task has completed.
- twisted.mail.maildir._MaildirMailboxAppendMessageTask.opencall
  twisted.mail.maildir._MaildirMailboxAppendMessageTask.html#opencall
  Attribute
  Instance Variable
  PUBLIC
  A scheduled call to `prodProducer`.
- twisted.mail.maildir._MaildirMailboxAppendMessageTask.msg
  twisted.mail.maildir._MaildirMailboxAppendMessageTask.html#msg
  Attribute
  Instance Variable
  PUBLIC
  The message to add.
- twisted.mail.maildir._MaildirMailboxAppendMessageTask.tmpname
  twisted.mail.maildir._MaildirMailboxAppendMessageTask.html#tmpname
  Attribute
  Instance Variable
  PUBLIC
  The pathname of the temporary file holding the message while it is being transferred.
- twisted.mail.maildir._MaildirMailboxAppendMessageTask.fh
  twisted.mail.maildir._MaildirMailboxAppendMessageTask.html#fh
  Attribute
  Instance Variable
  PUBLIC
  The new maildir file.
- twisted.mail.maildir._MaildirMailboxAppendMessageTask.filesender
  twisted.mail.maildir._MaildirMailboxAppendMessageTask.html#filesender
  Attribute
  Instance Variable
  PUBLIC
  A file sender which sends the message.
- twisted.mail.maildir._MaildirMailboxAppendMessageTask.myproducer
  twisted.mail.maildir._MaildirMailboxAppendMessageTask.html#myproducer
  Attribute
  Instance Variable
  PUBLIC
  The registered producer.
- twisted.mail.maildir._MaildirMailboxAppendMessageTask.streaming
  twisted.mail.maildir._MaildirMailboxAppendMessageTask.html#streaming
  Attribute
  Instance Variable
  PUBLIC
  Indicates whether the registered producer provides a streaming interface.
- twisted.mail.maildir._MaildirMailboxAppendMessageTask.osopen
  twisted.mail.maildir._MaildirMailboxAppendMessageTask.html#osopen
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.maildir._MaildirMailboxAppendMessageTask.oswrite
  twisted.mail.maildir._MaildirMailboxAppendMessageTask.html#oswrite
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.maildir._MaildirMailboxAppendMessageTask.osclose
  twisted.mail.maildir._MaildirMailboxAppendMessageTask.html#osclose
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.maildir._MaildirMailboxAppendMessageTask.osrename
  twisted.mail.maildir._MaildirMailboxAppendMessageTask.html#osrename
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.maildir._MaildirMailboxAppendMessageTask.__init__
  twisted.mail.maildir._MaildirMailboxAppendMessageTask.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.mail.maildir._MaildirMailboxAppendMessageTask.openCall
  twisted.mail.maildir._MaildirMailboxAppendMessageTask.html#openCall
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.maildir._MaildirMailboxAppendMessageTask.startUp
  twisted.mail.maildir._MaildirMailboxAppendMessageTask.html#startUp
  Function
  Method
  PUBLIC
  Start transferring the message to the mailbox.
- twisted.mail.maildir._MaildirMailboxAppendMessageTask.registerProducer
  twisted.mail.maildir._MaildirMailboxAppendMessageTask.html#registerProducer
  Function
  Method
  PUBLIC
  Register a producer and start asking it for data if it is non-streaming.
- twisted.mail.maildir._MaildirMailboxAppendMessageTask.prodProducer
  twisted.mail.maildir._MaildirMailboxAppendMessageTask.html#prodProducer
  Function
  Method
  PUBLIC
  Repeatedly prod a non-streaming producer to produce data.
- twisted.mail.maildir._MaildirMailboxAppendMessageTask.unregisterProducer
  twisted.mail.maildir._MaildirMailboxAppendMessageTask.html#unregisterProducer
  Function
  Method
  PUBLIC
  Finish transferring the message to the mailbox.
- twisted.mail.maildir._MaildirMailboxAppendMessageTask.write
  twisted.mail.maildir._MaildirMailboxAppendMessageTask.html#write
  Function
  Method
  PUBLIC
  Write data to the maildir file.
- twisted.mail.maildir._MaildirMailboxAppendMessageTask.fail
  twisted.mail.maildir._MaildirMailboxAppendMessageTask.html#fail
  Function
  Method
  PUBLIC
  Fire the deferred to indicate the task completed with a failure.
- twisted.mail.maildir._MaildirMailboxAppendMessageTask.moveFileToNew
  twisted.mail.maildir._MaildirMailboxAppendMessageTask.html#moveFileToNew
  Function
  Method
  PUBLIC
  Place the message in the new/ directory, add it to the mailbox and fire the deferred to indicate that the task has completed successfully.
- twisted.mail.maildir._MaildirMailboxAppendMessageTask.createTempFile
  twisted.mail.maildir._MaildirMailboxAppendMessageTask.html#createTempFile
  Function
  Method
  PUBLIC
  Create a temporary file to hold the message as it is being transferred.
- twisted.mail.maildir.MaildirMailbox
  twisted.mail.maildir.MaildirMailbox.html
  Class
  Class
  PUBLIC
  A maildir-backed mailbox.
- twisted.mail.maildir.MaildirMailbox.path
  twisted.mail.maildir.MaildirMailbox.html#path
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`.
- twisted.mail.maildir.MaildirMailbox.list
  twisted.mail.maildir.MaildirMailbox.html#list
  Attribute
  Instance Variable
  PUBLIC
  Information about the messages in the mailbox. For undeleted messages, the file containing the message and the full path name of the file are stored. Deleted messages are indicated by 0.
- twisted.mail.maildir.MaildirMailbox.deleted
  twisted.mail.maildir.MaildirMailbox.html#deleted
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.maildir.MaildirMailbox.__init__
  twisted.mail.maildir.MaildirMailbox.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.mail.maildir.MaildirMailbox.listMessages
  twisted.mail.maildir.MaildirMailbox.html#listMessages
  Function
  Method
  PUBLIC
  Retrieve the size of a message, or, if none is specified, the size of each message in the mailbox.
- twisted.mail.maildir.MaildirMailbox.getMessage
  twisted.mail.maildir.MaildirMailbox.html#getMessage
  Function
  Method
  PUBLIC
  Retrieve a file-like object with the contents of a message.
- twisted.mail.maildir.MaildirMailbox.getUidl
  twisted.mail.maildir.MaildirMailbox.html#getUidl
  Function
  Method
  PUBLIC
  Get a unique identifier for a message.
- twisted.mail.maildir.MaildirMailbox.deleteMessage
  twisted.mail.maildir.MaildirMailbox.html#deleteMessage
  Function
  Method
  PUBLIC
  Mark a message for deletion.
- twisted.mail.maildir.MaildirMailbox.undeleteMessages
  twisted.mail.maildir.MaildirMailbox.html#undeleteMessages
  Function
  Method
  PUBLIC
  Undelete all messages marked for deletion.
- twisted.mail.maildir.MaildirMailbox.appendMessage
  twisted.mail.maildir.MaildirMailbox.html#appendMessage
  Function
  Method
  PUBLIC
  Add a message to the mailbox.
- twisted.mail.maildir.StringListMailbox
  twisted.mail.maildir.StringListMailbox.html
  Class
  Class
  PUBLIC
  An in-memory mailbox.
- twisted.mail.maildir.StringListMailbox.msgs
  twisted.mail.maildir.StringListMailbox.html#msgs
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`.
- twisted.mail.maildir.StringListMailbox._delete
  twisted.mail.maildir.StringListMailbox.html#_delete
  Attribute
  Instance Variable
  PRIVATE
  The indices of messages which have been marked for deletion.
- twisted.mail.maildir.StringListMailbox.__init__
  twisted.mail.maildir.StringListMailbox.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.mail.maildir.StringListMailbox.listMessages
  twisted.mail.maildir.StringListMailbox.html#listMessages
  Function
  Method
  PUBLIC
  Retrieve the size of a message, or, if none is specified, the size of each message in the mailbox.
- twisted.mail.maildir.StringListMailbox.getMessage
  twisted.mail.maildir.StringListMailbox.html#getMessage
  Function
  Method
  PUBLIC
  Return an in-memory file-like object with the contents of a message.
- twisted.mail.maildir.StringListMailbox.getUidl
  twisted.mail.maildir.StringListMailbox.html#getUidl
  Function
  Method
  PUBLIC
  Get a unique identifier for a message.
- twisted.mail.maildir.StringListMailbox.deleteMessage
  twisted.mail.maildir.StringListMailbox.html#deleteMessage
  Function
  Method
  PUBLIC
  Mark a message for deletion.
- twisted.mail.maildir.StringListMailbox.undeleteMessages
  twisted.mail.maildir.StringListMailbox.html#undeleteMessages
  Function
  Method
  PUBLIC
  Undelete any messages which have been marked for deletion.
- twisted.mail.maildir.StringListMailbox.sync
  twisted.mail.maildir.StringListMailbox.html#sync
  Function
  Method
  PUBLIC
  Discard the contents of any messages marked for deletion.
- twisted.mail.maildir.MaildirDirdbmDomain
  twisted.mail.maildir.MaildirDirdbmDomain.html
  Class
  Class
  PUBLIC
  A maildir-backed domain where membership is checked with a `DirDBM` database.
- twisted.mail.maildir.MaildirDirdbmDomain.postmaster
  twisted.mail.maildir.MaildirDirdbmDomain.html#postmaster
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`.
- twisted.mail.maildir.MaildirDirdbmDomain.dbm
  twisted.mail.maildir.MaildirDirdbmDomain.html#dbm
  Attribute
  Instance Variable
  PUBLIC
  The authentication database for the domain.
- twisted.mail.maildir.MaildirDirdbmDomain.portal
  twisted.mail.maildir.MaildirDirdbmDomain.html#portal
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.mail.maildir.MaildirDirdbmDomain._credcheckers
  twisted.mail.maildir.MaildirDirdbmDomain.html#_credcheckers
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.mail.maildir.MaildirDirdbmDomain.__init__
  twisted.mail.maildir.MaildirDirdbmDomain.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.mail.maildir.MaildirDirdbmDomain.userDirectory
  twisted.mail.maildir.MaildirDirdbmDomain.html#userDirectory
  Function
  Method
  PUBLIC
  Return the path to a user's mail directory.
- twisted.mail.maildir.MaildirDirdbmDomain.addUser
  twisted.mail.maildir.MaildirDirdbmDomain.html#addUser
  Function
  Method
  PUBLIC
  Add a user to this domain by adding an entry in the authentication database and initializing the user's mail directory.
- twisted.mail.maildir.MaildirDirdbmDomain.getCredentialsCheckers
  twisted.mail.maildir.MaildirDirdbmDomain.html#getCredentialsCheckers
  Function
  Method
  PUBLIC
  Return credentials checkers for this domain.
- twisted.mail.maildir.MaildirDirdbmDomain.requestAvatar
  twisted.mail.maildir.MaildirDirdbmDomain.html#requestAvatar
  Function
  Method
  PUBLIC
  Get the mailbox for an authenticated user.
- twisted.mail.maildir.DirdbmDatabase
  twisted.mail.maildir.DirdbmDatabase.html
  Class
  Class
  PUBLIC
  A credentials checker which authenticates users out of a `DirDBM` database.
- twisted.mail.maildir.DirdbmDatabase.dirdbm
  twisted.mail.maildir.DirdbmDatabase.html#dirdbm
  Attribute
  Instance Variable
  PUBLIC
  An authentication database.
- twisted.mail.maildir.DirdbmDatabase.credentialInterfaces
  twisted.mail.maildir.DirdbmDatabase.html#credentialInterfaces
  Attribute
  Class Variable
  PUBLIC
  A list of sub-interfaces of `ICredentials` which specifies which I may check.
- twisted.mail.maildir.DirdbmDatabase.__init__
  twisted.mail.maildir.DirdbmDatabase.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.mail.maildir.DirdbmDatabase.requestAvatarId
  twisted.mail.maildir.DirdbmDatabase.html#requestAvatarId
  Function
  Method
  PUBLIC
  Authenticate a user and, if successful, return their username.
- twisted.spread.banana.BananaError
  twisted.spread.banana.BananaError.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.spread.banana.int2b128
  twisted.spread.banana.html#int2b128
  Function
  Function
  PUBLIC
  Undocumented
- twisted.spread.banana.b1282int
  twisted.spread.banana.html#b1282int
  Function
  Function
  PUBLIC
  Convert an integer represented as a base 128 string into an `int`.
- twisted.spread.banana.LIST
  twisted.spread.banana.html#LIST
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.spread.banana.INT
  twisted.spread.banana.html#INT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.spread.banana.STRING
  twisted.spread.banana.html#STRING
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.spread.banana.NEG
  twisted.spread.banana.html#NEG
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.spread.banana.FLOAT
  twisted.spread.banana.html#FLOAT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.spread.banana.LONGINT
  twisted.spread.banana.html#LONGINT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.spread.banana.LONGNEG
  twisted.spread.banana.html#LONGNEG
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.spread.banana.VOCAB
  twisted.spread.banana.html#VOCAB
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.spread.banana.HIGH_BIT_SET
  twisted.spread.banana.html#HIGH_BIT_SET
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.spread.banana.setPrefixLimit
  twisted.spread.banana.html#setPrefixLimit
  Function
  Function
  PUBLIC
  Set the limit on the prefix length for all Banana connections established after this call.
- twisted.spread.banana._PREFIX_LIMIT
  twisted.spread.banana.html#_PREFIX_LIMIT
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.spread.banana.SIZE_LIMIT
  twisted.spread.banana.html#SIZE_LIMIT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.spread.banana.Banana
  twisted.spread.banana.Banana.html
  Class
  Class
  PUBLIC
  `Banana` implements the Banana s-expression protocol, client and server.
- twisted.spread.banana.Banana.knownDialects
  twisted.spread.banana.Banana.html#knownDialects
  Attribute
  Instance Variable
  PUBLIC
  These are the profiles supported by this Banana implementation.
- twisted.spread.banana.Banana.prefixLimit
  twisted.spread.banana.Banana.html#prefixLimit
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.banana.Banana.setPrefixLimit
  twisted.spread.banana.Banana.html#setPrefixLimit
  Function
  Method
  PUBLIC
  Set the prefix limit for decoding done by this protocol instance.
- twisted.spread.banana.Banana._smallestLongInt
  twisted.spread.banana.Banana.html#_smallestLongInt
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.spread.banana.Banana._smallestInt
  twisted.spread.banana.Banana.html#_smallestInt
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.spread.banana.Banana._largestInt
  twisted.spread.banana.Banana.html#_largestInt
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.spread.banana.Banana._largestLongInt
  twisted.spread.banana.Banana.html#_largestLongInt
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.spread.banana.Banana.connectionReady
  twisted.spread.banana.Banana.html#connectionReady
  Function
  Method
  PUBLIC
  Surrogate for connectionMade Called after protocol negotiation.
- twisted.spread.banana.Banana._selectDialect
  twisted.spread.banana.Banana.html#_selectDialect
  Function
  Method
  PRIVATE
  Undocumented
- twisted.spread.banana.Banana.currentDialect
  twisted.spread.banana.Banana.html#currentDialect
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.banana.Banana.callExpressionReceived
  twisted.spread.banana.Banana.html#callExpressionReceived
  Function
  Method
  PUBLIC
  Undocumented
- twisted.spread.banana.Banana.connectionMade
  twisted.spread.banana.Banana.html#connectionMade
  Function
  Method
  PUBLIC
  Called when a connection is made.
- twisted.spread.banana.Banana.gotItem
  twisted.spread.banana.Banana.html#gotItem
  Function
  Method
  PUBLIC
  Undocumented
- twisted.spread.banana.Banana.buffer
  twisted.spread.banana.Banana.html#buffer
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.banana.Banana.dataReceived
  twisted.spread.banana.Banana.html#dataReceived
  Function
  Method
  PUBLIC
  Called whenever data is received.
- twisted.spread.banana.Banana.expressionReceived
  twisted.spread.banana.Banana.html#expressionReceived
  Function
  Method
  PUBLIC
  Called when an expression (list, string, or int) is received.
- twisted.spread.banana.Banana.outgoingVocabulary
  twisted.spread.banana.Banana.html#outgoingVocabulary
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.spread.banana.Banana.incomingVocabulary
  twisted.spread.banana.Banana.html#incomingVocabulary
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.spread.banana.Banana.__init__
  twisted.spread.banana.Banana.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.spread.banana.Banana.listStack
  twisted.spread.banana.Banana.html#listStack
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.banana.Banana.outgoingSymbols
  twisted.spread.banana.Banana.html#outgoingSymbols
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.banana.Banana.outgoingSymbolCount
  twisted.spread.banana.Banana.html#outgoingSymbolCount
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.banana.Banana.isClient
  twisted.spread.banana.Banana.html#isClient
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.banana.Banana.sendEncoded
  twisted.spread.banana.Banana.html#sendEncoded
  Function
  Method
  PUBLIC
  Send the encoded representation of the given object:
- twisted.spread.banana.Banana._encode
  twisted.spread.banana.Banana.html#_encode
  Function
  Method
  PRIVATE
  Undocumented
- twisted.spread.banana._i
  twisted.spread.banana.html#_i
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.spread.banana.encode
  twisted.spread.banana.html#encode
  Function
  Function
  PUBLIC
  Encode a list s-expression.
- twisted.spread.banana.decode
  twisted.spread.banana.html#decode
  Function
  Function
  PUBLIC
  Decode a banana-encoded string.
- twisted.persisted.crefutil.NotKnown
  twisted.persisted.crefutil.NotKnown.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.persisted.crefutil.NotKnown.__init__
  twisted.persisted.crefutil.NotKnown.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.persisted.crefutil.NotKnown.dependants
  twisted.persisted.crefutil.NotKnown.html#dependants
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.persisted.crefutil.NotKnown.resolved
  twisted.persisted.crefutil.NotKnown.html#resolved
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.persisted.crefutil.NotKnown.addDependant
  twisted.persisted.crefutil.NotKnown.html#addDependant
  Function
  Method
  PUBLIC
  Undocumented
- twisted.persisted.crefutil.NotKnown.resolvedObject
  twisted.persisted.crefutil.NotKnown.html#resolvedObject
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.persisted.crefutil.NotKnown.resolveDependants
  twisted.persisted.crefutil.NotKnown.html#resolveDependants
  Function
  Method
  PUBLIC
  Undocumented
- twisted.persisted.crefutil.NotKnown.__hash__
  twisted.persisted.crefutil.NotKnown.html#__hash__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.persisted.crefutil._Container
  twisted.persisted.crefutil._Container.html
  Class
  Class
  PRIVATE
  Helper class to resolve circular references on container objects.
- twisted.persisted.crefutil._Container.__init__
  twisted.persisted.crefutil._Container.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.persisted.crefutil._Container.containerType
  twisted.persisted.crefutil._Container.html#containerType
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.persisted.crefutil._Container.l
  twisted.persisted.crefutil._Container.html#l
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.persisted.crefutil._Container.locs
  twisted.persisted.crefutil._Container.html#locs
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.persisted.crefutil._Container.__setitem__
  twisted.persisted.crefutil._Container.html#__setitem__
  Function
  Method
  PUBLIC
  Change the value of one contained objects, and resolve references if all objects have been referenced.
- twisted.persisted.crefutil._Tuple
  twisted.persisted.crefutil._Tuple.html
  Class
  Class
  PRIVATE
  Manage tuple containing circular references. Deprecated: use `_Container` instead.
- twisted.persisted.crefutil._Tuple.__init__
  twisted.persisted.crefutil._Tuple.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.persisted.crefutil._InstanceMethod
  twisted.persisted.crefutil._InstanceMethod.html
  Class
  Class
  PRIVATE
  Undocumented
- twisted.persisted.crefutil._InstanceMethod.__init__
  twisted.persisted.crefutil._InstanceMethod.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.persisted.crefutil._InstanceMethod.my_class
  twisted.persisted.crefutil._InstanceMethod.html#my_class
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.persisted.crefutil._InstanceMethod.name
  twisted.persisted.crefutil._InstanceMethod.html#name
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.persisted.crefutil._InstanceMethod.__call__
  twisted.persisted.crefutil._InstanceMethod.html#__call__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.persisted.crefutil._InstanceMethod.__setitem__
  twisted.persisted.crefutil._InstanceMethod.html#__setitem__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.persisted.crefutil._DictKeyAndValue
  twisted.persisted.crefutil._DictKeyAndValue.html
  Class
  Class
  PRIVATE
  Undocumented
- twisted.persisted.crefutil._DictKeyAndValue.__init__
  twisted.persisted.crefutil._DictKeyAndValue.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.persisted.crefutil._DictKeyAndValue.dict
  twisted.persisted.crefutil._DictKeyAndValue.html#dict
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.persisted.crefutil._DictKeyAndValue.__setitem__
  twisted.persisted.crefutil._DictKeyAndValue.html#__setitem__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.persisted.crefutil._DictKeyAndValue.value
  twisted.persisted.crefutil._DictKeyAndValue.html#value
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.persisted.crefutil._Dereference
  twisted.persisted.crefutil._Dereference.html
  Class
  Class
  PRIVATE
  Undocumented
- twisted.persisted.crefutil._Dereference.__init__
  twisted.persisted.crefutil._Dereference.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.persisted.crefutil._Dereference.id
  twisted.persisted.crefutil._Dereference.html#id
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.persisted.crefutil._Defer
  twisted.persisted.crefutil._Defer.html
  Class
  Class
  PRIVATE
  Undocumented
- twisted.persisted.crefutil._Defer.__init__
  twisted.persisted.crefutil._Defer.html#__init__
  Function
  Method
  PUBLIC
  Initialize a `Deferred`.
- twisted.persisted.crefutil._Defer.wasset
  twisted.persisted.crefutil._Defer.html#wasset
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.persisted.crefutil._Defer.__setitem__
  twisted.persisted.crefutil._Defer.html#__setitem__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.persisted.crefutil._Defer.addDependant
  twisted.persisted.crefutil._Defer.html#addDependant
  Function
  Method
  PUBLIC
  Undocumented
- twisted.spread.interfaces.IJellyable
  twisted.spread.interfaces.IJellyable.html
  Class
  Interface
  PUBLIC
  No interface docstring; 1/1 method documented
- twisted.spread.interfaces.IJellyable.jellyFor
  twisted.spread.interfaces.IJellyable.html#jellyFor
  Function
  Method
  PUBLIC
  Jelly myself for jellier.
- twisted.spread.interfaces.IUnjellyable
  twisted.spread.interfaces.IUnjellyable.html
  Class
  Interface
  PUBLIC
  No interface docstring; 1/1 method documented
- twisted.spread.interfaces.IUnjellyable.unjellyFor
  twisted.spread.interfaces.IUnjellyable.html#unjellyFor
  Function
  Method
  PUBLIC
  Unjelly myself for the jellier.
- twisted.spread.jelly.DictTypes
  twisted.spread.jelly.html#DictTypes
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.spread.jelly.None_atom
  twisted.spread.jelly.html#None_atom
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.spread.jelly.class_atom
  twisted.spread.jelly.html#class_atom
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.spread.jelly.module_atom
  twisted.spread.jelly.html#module_atom
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.spread.jelly.function_atom
  twisted.spread.jelly.html#function_atom
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.spread.jelly.dereference_atom
  twisted.spread.jelly.html#dereference_atom
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.spread.jelly.persistent_atom
  twisted.spread.jelly.html#persistent_atom
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.spread.jelly.reference_atom
  twisted.spread.jelly.html#reference_atom
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.spread.jelly.dictionary_atom
  twisted.spread.jelly.html#dictionary_atom
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.spread.jelly.list_atom
  twisted.spread.jelly.html#list_atom
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.spread.jelly.set_atom
  twisted.spread.jelly.html#set_atom
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.spread.jelly.tuple_atom
  twisted.spread.jelly.html#tuple_atom
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.spread.jelly.instance_atom
  twisted.spread.jelly.html#instance_atom
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.spread.jelly.frozenset_atom
  twisted.spread.jelly.html#frozenset_atom
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.spread.jelly.unpersistable_atom
  twisted.spread.jelly.html#unpersistable_atom
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.spread.jelly.unjellyableFactoryRegistry
  twisted.spread.jelly.html#unjellyableFactoryRegistry
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.spread.jelly._createBlank
  twisted.spread.jelly.html#_createBlank
  Function
  Function
  PRIVATE
  Given an object, if that object is a type, return a new, blank instance of that type which has not had `__init__` called on it. If the object is not a type, return `None`.
- twisted.spread.jelly._newInstance
  twisted.spread.jelly.html#_newInstance
  Function
  Function
  PRIVATE
  Make a new instance of a class without calling its __init__ method.
- twisted.spread.jelly._maybeClass
  twisted.spread.jelly.html#_maybeClass
  Function
  Function
  PRIVATE
  Undocumented
- twisted.spread.jelly.getInstanceState
  twisted.spread.jelly.html#getInstanceState
  Function
  Function
  PUBLIC
  Utility method to default to 'normal' state rules in serialization.
- twisted.spread.jelly.setInstanceState
  twisted.spread.jelly.html#setInstanceState
  Function
  Function
  PUBLIC
  Utility method to default to 'normal' state rules in unserialization.
- twisted.spread.jelly.Unpersistable
  twisted.spread.jelly.Unpersistable.html
  Class
  Class
  PUBLIC
  This is an instance of a class that comes back when something couldn't be unpersisted.
- twisted.spread.jelly.Unpersistable.__init__
  twisted.spread.jelly.Unpersistable.html#__init__
  Function
  Method
  PUBLIC
  Initialize an unpersistable object with a descriptive `reason` string.
- twisted.spread.jelly.Unpersistable.reason
  twisted.spread.jelly.Unpersistable.html#reason
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.jelly.Unpersistable.__repr__
  twisted.spread.jelly.Unpersistable.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.spread.jelly.Unjellyable
  twisted.spread.jelly.Unjellyable.html
  Class
  Class
  PUBLIC
  Inherit from me to Unjelly yourself directly with the `setStateFor` convenience method.
- twisted.spread.jelly.Unjellyable.setStateFor
  twisted.spread.jelly.Unjellyable.html#setStateFor
  Function
  Method
  PUBLIC
  Undocumented
- twisted.spread.jelly.Unjellyable.__dict__
  twisted.spread.jelly.Unjellyable.html#__dict__
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.jelly.Unjellyable.unjellyFor
  twisted.spread.jelly.Unjellyable.html#unjellyFor
  Function
  Method
  PUBLIC
  Perform the inverse operation of `Jellyable.jellyFor`.
- twisted.spread.jelly._Jellier
  twisted.spread.jelly._Jellier.html
  Class
  Class
  PRIVATE
  (Internal) This class manages state for a call to jelly()
- twisted.spread.jelly._Jellier.__init__
  twisted.spread.jelly._Jellier.html#__init__
  Function
  Method
  PUBLIC
  Initialize.
- twisted.spread.jelly._Jellier.taster
  twisted.spread.jelly._Jellier.html#taster
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.jelly._Jellier.preserved
  twisted.spread.jelly._Jellier.html#preserved
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.jelly._Jellier.cooked
  twisted.spread.jelly._Jellier.html#cooked
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.jelly._Jellier.cooker
  twisted.spread.jelly._Jellier.html#cooker
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.jelly._Jellier._ref_id
  twisted.spread.jelly._Jellier.html#_ref_id
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.spread.jelly._Jellier.persistentStore
  twisted.spread.jelly._Jellier.html#persistentStore
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.jelly._Jellier.invoker
  twisted.spread.jelly._Jellier.html#invoker
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.jelly._Jellier._cook
  twisted.spread.jelly._Jellier.html#_cook
  Function
  Method
  PRIVATE
  (internal) Backreference an object.
- twisted.spread.jelly._Jellier.prepare
  twisted.spread.jelly._Jellier.html#prepare
  Function
  Method
  PUBLIC
  (internal) Create a list for persisting an object to. This will allow backreferences to be made internal to the object. (circular references).
- twisted.spread.jelly._Jellier.preserve
  twisted.spread.jelly._Jellier.html#preserve
  Function
  Method
  PUBLIC
  (internal) Mark an object's persistent list for later referral.
- twisted.spread.jelly._Jellier._checkMutable
  twisted.spread.jelly._Jellier.html#_checkMutable
  Function
  Method
  PRIVATE
  Undocumented
- twisted.spread.jelly._Jellier.jelly
  twisted.spread.jelly._Jellier.html#jelly
  Function
  Method
  PUBLIC
  Undocumented
- twisted.spread.jelly._Jellier._jellyIterable
  twisted.spread.jelly._Jellier.html#_jellyIterable
  Function
  Method
  PRIVATE
  Jelly an iterable object.
- twisted.spread.jelly._Jellier.jelly_decimal
  twisted.spread.jelly._Jellier.html#jelly_decimal
  Function
  Method
  PUBLIC
  Jelly a decimal object.
- twisted.spread.jelly._Jellier.unpersistable
  twisted.spread.jelly._Jellier.html#unpersistable
  Function
  Method
  PUBLIC
  (internal) Returns an sexp: (unpersistable "reason"). Utility method for making note that a particular object could not be serialized.
- twisted.spread.jelly._Unjellier
  twisted.spread.jelly._Unjellier.html
  Class
  Class
  PRIVATE
  No class docstring; 0/5 instance variable, 8/29 methods documented
- twisted.spread.jelly._Unjellier.__init__
  twisted.spread.jelly._Unjellier.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.spread.jelly._Unjellier.taster
  twisted.spread.jelly._Unjellier.html#taster
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.jelly._Unjellier.persistentLoad
  twisted.spread.jelly._Unjellier.html#persistentLoad
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.jelly._Unjellier.references
  twisted.spread.jelly._Unjellier.html#references
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.jelly._Unjellier.postCallbacks
  twisted.spread.jelly._Unjellier.html#postCallbacks
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.jelly._Unjellier.invoker
  twisted.spread.jelly._Unjellier.html#invoker
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.jelly._Unjellier.unjellyFull
  twisted.spread.jelly._Unjellier.html#unjellyFull
  Function
  Method
  PUBLIC
  Undocumented
- twisted.spread.jelly._Unjellier._maybePostUnjelly
  twisted.spread.jelly._Unjellier.html#_maybePostUnjelly
  Function
  Method
  PRIVATE
  If the given object has support for the `postUnjelly` hook, set it up to be called at the end of deserialization.
- twisted.spread.jelly._Unjellier.unjelly
  twisted.spread.jelly._Unjellier.html#unjelly
  Function
  Method
  PUBLIC
  Undocumented
- twisted.spread.jelly._Unjellier._genericUnjelly
  twisted.spread.jelly._Unjellier.html#_genericUnjelly
  Function
  Method
  PRIVATE
  Unjelly a type for which no specific unjellier is registered, but which is nonetheless allowed.
- twisted.spread.jelly._Unjellier._unjelly_None
  twisted.spread.jelly._Unjellier.html#_unjelly_None
  Function
  Method
  PRIVATE
  Undocumented
- twisted.spread.jelly._Unjellier._unjelly_unicode
  twisted.spread.jelly._Unjellier.html#_unjelly_unicode
  Function
  Method
  PRIVATE
  Undocumented
- twisted.spread.jelly._Unjellier._unjelly_decimal
  twisted.spread.jelly._Unjellier.html#_unjelly_decimal
  Function
  Method
  PRIVATE
  Unjelly decimal objects.
- twisted.spread.jelly._Unjellier._unjelly_boolean
  twisted.spread.jelly._Unjellier.html#_unjelly_boolean
  Function
  Method
  PRIVATE
  Undocumented
- twisted.spread.jelly._Unjellier._unjelly_datetime
  twisted.spread.jelly._Unjellier.html#_unjelly_datetime
  Function
  Method
  PRIVATE
  Undocumented
- twisted.spread.jelly._Unjellier._unjelly_date
  twisted.spread.jelly._Unjellier.html#_unjelly_date
  Function
  Method
  PRIVATE
  Undocumented
- twisted.spread.jelly._Unjellier._unjelly_time
  twisted.spread.jelly._Unjellier.html#_unjelly_time
  Function
  Method
  PRIVATE
  Undocumented
- twisted.spread.jelly._Unjellier._unjelly_timedelta
  twisted.spread.jelly._Unjellier.html#_unjelly_timedelta
  Function
  Method
  PRIVATE
  Undocumented
- twisted.spread.jelly._Unjellier.unjellyInto
  twisted.spread.jelly._Unjellier.html#unjellyInto
  Function
  Method
  PUBLIC
  Undocumented
- twisted.spread.jelly._Unjellier._unjelly_dereference
  twisted.spread.jelly._Unjellier.html#_unjelly_dereference
  Function
  Method
  PRIVATE
  Undocumented
- twisted.spread.jelly._Unjellier._unjelly_reference
  twisted.spread.jelly._Unjellier.html#_unjelly_reference
  Function
  Method
  PRIVATE
  Undocumented
- twisted.spread.jelly._Unjellier._unjelly_tuple
  twisted.spread.jelly._Unjellier.html#_unjelly_tuple
  Function
  Method
  PRIVATE
  Undocumented
- twisted.spread.jelly._Unjellier._unjelly_list
  twisted.spread.jelly._Unjellier.html#_unjelly_list
  Function
  Method
  PRIVATE
  Undocumented
- twisted.spread.jelly._Unjellier._unjellySetOrFrozenset
  twisted.spread.jelly._Unjellier.html#_unjellySetOrFrozenset
  Function
  Method
  PRIVATE
  Helper method to unjelly set or frozenset.
- twisted.spread.jelly._Unjellier._unjelly_set
  twisted.spread.jelly._Unjellier.html#_unjelly_set
  Function
  Method
  PRIVATE
  Unjelly set using the `set` builtin.
- twisted.spread.jelly._Unjellier._unjelly_frozenset
  twisted.spread.jelly._Unjellier.html#_unjelly_frozenset
  Function
  Method
  PRIVATE
  Unjelly frozenset using the `frozenset` builtin.
- twisted.spread.jelly._Unjellier._unjelly_dictionary
  twisted.spread.jelly._Unjellier.html#_unjelly_dictionary
  Function
  Method
  PRIVATE
  Undocumented
- twisted.spread.jelly._Unjellier._unjelly_module
  twisted.spread.jelly._Unjellier.html#_unjelly_module
  Function
  Method
  PRIVATE
  Undocumented
- twisted.spread.jelly._Unjellier._unjelly_class
  twisted.spread.jelly._Unjellier.html#_unjelly_class
  Function
  Method
  PRIVATE
  Undocumented
- twisted.spread.jelly._Unjellier._unjelly_function
  twisted.spread.jelly._Unjellier.html#_unjelly_function
  Function
  Method
  PRIVATE
  Undocumented
- twisted.spread.jelly._Unjellier._unjelly_persistent
  twisted.spread.jelly._Unjellier.html#_unjelly_persistent
  Function
  Method
  PRIVATE
  Undocumented
- twisted.spread.jelly._Unjellier._unjelly_instance
  twisted.spread.jelly._Unjellier.html#_unjelly_instance
  Function
  Method
  PRIVATE
  (internal) Unjelly an instance.
- twisted.spread.jelly._Unjellier._unjelly_unpersistable
  twisted.spread.jelly._Unjellier.html#_unjelly_unpersistable
  Function
  Method
  PRIVATE
  Undocumented
- twisted.spread.jelly._Unjellier._unjelly_method
  twisted.spread.jelly._Unjellier.html#_unjelly_method
  Function
  Method
  PRIVATE
  (internal) Unjelly a method.
- twisted.spread.jelly.InsecureJelly
  twisted.spread.jelly.InsecureJelly.html
  Class
  Exception
  PUBLIC
  This exception will be raised when a jelly is deemed `insecure'; e.g. it contains a type, class, or module disallowed by the specified `taster'
- twisted.spread.jelly.DummySecurityOptions
  twisted.spread.jelly.DummySecurityOptions.html
  Class
  Class
  PUBLIC
  DummySecurityOptions() -> insecure security options Dummy security options -- this class will allow anything.
- twisted.spread.jelly.DummySecurityOptions.isModuleAllowed
  twisted.spread.jelly.DummySecurityOptions.html#isModuleAllowed
  Function
  Method
  PUBLIC
  DummySecurityOptions.isModuleAllowed(moduleName) -> boolean returns 1 if a module by that name is allowed, 0 otherwise
- twisted.spread.jelly.DummySecurityOptions.isClassAllowed
  twisted.spread.jelly.DummySecurityOptions.html#isClassAllowed
  Function
  Method
  PUBLIC
  DummySecurityOptions.isClassAllowed(class) -> boolean Assumes the module has already been allowed. Returns 1 if the given class is allowed, 0 otherwise.
- twisted.spread.jelly.DummySecurityOptions.isTypeAllowed
  twisted.spread.jelly.DummySecurityOptions.html#isTypeAllowed
  Function
  Method
  PUBLIC
  DummySecurityOptions.isTypeAllowed(typeName) -> boolean Returns 1 if the given type is allowed, 0 otherwise.
- twisted.spread.jelly.SecurityOptions
  twisted.spread.jelly.SecurityOptions.html
  Class
  Class
  PUBLIC
  This will by default disallow everything, except for 'none'.
- twisted.spread.jelly.SecurityOptions.basicTypes
  twisted.spread.jelly.SecurityOptions.html#basicTypes
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.spread.jelly.SecurityOptions.__init__
  twisted.spread.jelly.SecurityOptions.html#__init__
  Function
  Method
  PUBLIC
  SecurityOptions() initialize.
- twisted.spread.jelly.SecurityOptions.allowedTypes
  twisted.spread.jelly.SecurityOptions.html#allowedTypes
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.jelly.SecurityOptions.allowedModules
  twisted.spread.jelly.SecurityOptions.html#allowedModules
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.jelly.SecurityOptions.allowedClasses
  twisted.spread.jelly.SecurityOptions.html#allowedClasses
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.jelly.SecurityOptions.allowBasicTypes
  twisted.spread.jelly.SecurityOptions.html#allowBasicTypes
  Function
  Method
  PUBLIC
  Allow all `basic' types. (Dictionary and list. Int, string, and float are implicitly allowed.)
- twisted.spread.jelly.SecurityOptions.allowTypes
  twisted.spread.jelly.SecurityOptions.html#allowTypes
  Function
  Method
  PUBLIC
  SecurityOptions.allowTypes(typeString): Allow a particular type, by its name.
- twisted.spread.jelly.SecurityOptions.allowInstancesOf
  twisted.spread.jelly.SecurityOptions.html#allowInstancesOf
  Function
  Method
  PUBLIC
  SecurityOptions.allowInstances(klass, klass, ...): allow instances of the specified classes
- twisted.spread.jelly.SecurityOptions.allowModules
  twisted.spread.jelly.SecurityOptions.html#allowModules
  Function
  Method
  PUBLIC
  SecurityOptions.allowModules(module, module, ...): allow modules by name. This will also allow the 'module' type.
- twisted.spread.jelly.SecurityOptions.isModuleAllowed
  twisted.spread.jelly.SecurityOptions.html#isModuleAllowed
  Function
  Method
  PUBLIC
  SecurityOptions.isModuleAllowed(moduleName) -> boolean returns 1 if a module by that name is allowed, 0 otherwise
- twisted.spread.jelly.SecurityOptions.isClassAllowed
  twisted.spread.jelly.SecurityOptions.html#isClassAllowed
  Function
  Method
  PUBLIC
  SecurityOptions.isClassAllowed(class) -> boolean Assumes the module has already been allowed. Returns 1 if the given class is allowed, 0 otherwise.
- twisted.spread.jelly.SecurityOptions.isTypeAllowed
  twisted.spread.jelly.SecurityOptions.html#isTypeAllowed
  Function
  Method
  PUBLIC
  SecurityOptions.isTypeAllowed(typeName) -> boolean Returns 1 if the given type is allowed, 0 otherwise.
- twisted.spread.jelly.globalSecurity
  twisted.spread.jelly.html#globalSecurity
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.spread.jelly.jelly
  twisted.spread.jelly.html#jelly
  Function
  Function
  PUBLIC
  Serialize to s-expression.
- twisted.spread.jelly.unjelly
  twisted.spread.jelly.html#unjelly
  Function
  Function
  PUBLIC
  Unserialize from s-expression.
- twisted.spread.flavors.copy_atom
  twisted.spread.flavors.html#copy_atom
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.spread.flavors.cache_atom
  twisted.spread.flavors.html#cache_atom
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.spread.flavors.cached_atom
  twisted.spread.flavors.html#cached_atom
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.spread.flavors.remote_atom
  twisted.spread.flavors.html#remote_atom
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.spread.flavors.unjellyCached
  twisted.spread.flavors.html#unjellyCached
  Function
  Function
  PUBLIC
  Undocumented
- twisted.spread.flavors.unjellyLCache
  twisted.spread.flavors.html#unjellyLCache
  Function
  Function
  PUBLIC
  Undocumented
- twisted.spread.flavors.unjellyLocal
  twisted.spread.flavors.html#unjellyLocal
  Function
  Function
  PUBLIC
  Undocumented
- twisted.spread.flavors.RemoteCacheMethod
  twisted.spread.flavors.RemoteCacheMethod.html
  Class
  Class
  PUBLIC
  A method on a reference to a `RemoteCache`.
- twisted.spread.flavors.RemoteCacheMethod.__init__
  twisted.spread.flavors.RemoteCacheMethod.html#__init__
  Function
  Method
  PUBLIC
  (internal) initialize.
- twisted.spread.flavors.RemoteCacheMethod.name
  twisted.spread.flavors.RemoteCacheMethod.html#name
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.flavors.RemoteCacheMethod.broker
  twisted.spread.flavors.RemoteCacheMethod.html#broker
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.flavors.RemoteCacheMethod.perspective
  twisted.spread.flavors.RemoteCacheMethod.html#perspective
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.flavors.RemoteCacheMethod.cached
  twisted.spread.flavors.RemoteCacheMethod.html#cached
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.flavors.RemoteCacheMethod.__cmp__
  twisted.spread.flavors.RemoteCacheMethod.html#__cmp__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.spread.flavors.RemoteCacheMethod.__hash__
  twisted.spread.flavors.RemoteCacheMethod.html#__hash__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.spread.flavors.RemoteCacheMethod.__call__
  twisted.spread.flavors.RemoteCacheMethod.html#__call__
  Function
  Method
  PUBLIC
  (internal) action method.
- twisted.spread.pb.Cacheable
  twisted.spread.pb.Cacheable.html
  Class
  Class
  PUBLIC
  A cached instance.
- twisted.spread.pb.Cacheable.getStateToCacheAndObserveFor
  twisted.spread.pb.Cacheable.html#getStateToCacheAndObserveFor
  Function
  Method
  PUBLIC
  Get state to cache on the client and client-cache reference to observe locally.
- twisted.spread.pb.Cacheable.jellyFor
  twisted.spread.pb.Cacheable.html#jellyFor
  Function
  Method
  PUBLIC
  Return an appropriate tuple to serialize me.
- twisted.spread.pb.Cacheable.stoppedObserving
  twisted.spread.pb.Cacheable.html#stoppedObserving
  Function
  Method
  PUBLIC
  This method is called when a client has stopped observing me.
- twisted.spread.pb.Copyable
  twisted.spread.pb.Copyable.html
  Class
  Class
  PUBLIC
  Subclass me to get copied each time you are returned from or passed to a remote method.
- twisted.spread.pb.Copyable.getStateToCopy
  twisted.spread.pb.Copyable.html#getStateToCopy
  Function
  Method
  PUBLIC
  Gather state to send when I am serialized for a peer.
- twisted.spread.pb.Copyable.getStateToCopyFor
  twisted.spread.pb.Copyable.html#getStateToCopyFor
  Function
  Method
  PUBLIC
  Gather state to send when I am serialized for a particular perspective.
- twisted.spread.pb.Copyable.getTypeToCopy
  twisted.spread.pb.Copyable.html#getTypeToCopy
  Function
  Method
  PUBLIC
  Determine what type tag to send for me.
- twisted.spread.pb.Copyable.getTypeToCopyFor
  twisted.spread.pb.Copyable.html#getTypeToCopyFor
  Function
  Method
  PUBLIC
  Determine what type tag to send for me.
- twisted.spread.pb.Copyable.jellyFor
  twisted.spread.pb.Copyable.html#jellyFor
  Function
  Method
  PUBLIC
  Assemble type tag and state to copy for this broker.
- twisted.spread.pb.IPBRoot
  twisted.spread.pb.IPBRoot.html
  Class
  Interface
  PUBLIC
  Factory for root Referenceable objects for PB servers.
- twisted.spread.pb.IPBRoot.rootObject
  twisted.spread.pb.IPBRoot.html#rootObject
  Function
  Method
  PUBLIC
  Return root Referenceable for broker.
- twisted.spread.pb.Jellyable
  twisted.spread.pb.Jellyable.html
  Class
  Class
  PUBLIC
  Inherit from me to Jelly yourself directly with the `getStateFor' convenience method.
- twisted.spread.pb.Jellyable.getStateFor
  twisted.spread.pb.Jellyable.html#getStateFor
  Function
  Method
  PUBLIC
  Undocumented
- twisted.spread.pb.Jellyable.jellyFor
  twisted.spread.pb.Jellyable.html#jellyFor
  Function
  Method
  PUBLIC
  No summary
- twisted.spread.pb.NoSuchMethod
  twisted.spread.pb.NoSuchMethod.html
  Class
  Exception
  PUBLIC
  Raised if there is no such remote method
- twisted.spread.pb.Referenceable
  twisted.spread.pb.Referenceable.html
  Class
  Class
  PUBLIC
  No class docstring; 1/1 class variable, 2/2 methods documented
- twisted.spread.pb.Referenceable.perspective
  twisted.spread.pb.Referenceable.html#perspective
  Attribute
  Class Variable
  PUBLIC
  I am an object sent remotely as a direct reference.
- twisted.spread.pb.Referenceable.remoteMessageReceived
  twisted.spread.pb.Referenceable.html#remoteMessageReceived
  Function
  Method
  PUBLIC
  A remote message has been received. Dispatch it appropriately.
- twisted.spread.pb.Referenceable.jellyFor
  twisted.spread.pb.Referenceable.html#jellyFor
  Function
  Method
  PUBLIC
  (internal)
- twisted.spread.pb.RemoteCache
  twisted.spread.pb.RemoteCache.html
  Class
  Class
  PUBLIC
  A cache is a local representation of a remote `Cacheable` object.
- twisted.spread.pb.RemoteCache.remoteMessageReceived
  twisted.spread.pb.RemoteCache.html#remoteMessageReceived
  Function
  Method
  PUBLIC
  A remote message has been received. Dispatch it appropriately.
- twisted.spread.pb.RemoteCache.jellyFor
  twisted.spread.pb.RemoteCache.html#jellyFor
  Function
  Method
  PUBLIC
  serialize me (only for the broker I'm for) as the original cached reference
- twisted.spread.pb.RemoteCache.unjellyFor
  twisted.spread.pb.RemoteCache.html#unjellyFor
  Function
  Method
  PUBLIC
  Perform the inverse operation of `Jellyable.jellyFor`.
- twisted.spread.pb.RemoteCache.broker
  twisted.spread.pb.RemoteCache.html#broker
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.pb.RemoteCache.luid
  twisted.spread.pb.RemoteCache.html#luid
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.pb.RemoteCache.__dict__
  twisted.spread.pb.RemoteCache.html#__dict__
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.pb.RemoteCache.__cmp__
  twisted.spread.pb.RemoteCache.html#__cmp__
  Function
  Method
  PUBLIC
  Compare me [to another RemoteCache.
- twisted.spread.pb.RemoteCache.__hash__
  twisted.spread.pb.RemoteCache.html#__hash__
  Function
  Method
  PUBLIC
  Hash me.
- twisted.spread.pb.RemoteCache.__del__
  twisted.spread.pb.RemoteCache.html#__del__
  Function
  Method
  PUBLIC
  Do distributed reference counting on finalize.
- twisted.spread.pb.RemoteCache._borgify
  twisted.spread.pb.RemoteCache.html#_borgify
  Function
  Method
  PRIVATE
  Create a new object that shares its state (i.e. its `__dict__`) and type with this object, but does not share its identity.
- twisted.spread.pb.RemoteCacheObserver
  twisted.spread.pb.RemoteCacheObserver.html
  Class
  Class
  PUBLIC
  I am a reverse-reference to the peer's `RemoteCache`.
- twisted.spread.pb.RemoteCacheObserver.__init__
  twisted.spread.pb.RemoteCacheObserver.html#__init__
  Function
  Method
  PUBLIC
  (internal) Initialize me.
- twisted.spread.pb.RemoteCacheObserver.broker
  twisted.spread.pb.RemoteCacheObserver.html#broker
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.pb.RemoteCacheObserver.cached
  twisted.spread.pb.RemoteCacheObserver.html#cached
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.pb.RemoteCacheObserver.perspective
  twisted.spread.pb.RemoteCacheObserver.html#perspective
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.pb.RemoteCacheObserver.__repr__
  twisted.spread.pb.RemoteCacheObserver.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.spread.pb.RemoteCacheObserver.__hash__
  twisted.spread.pb.RemoteCacheObserver.html#__hash__
  Function
  Method
  PUBLIC
  Generate a hash unique to all `RemoteCacheObserver`s for this broker/perspective/cached triplet
- twisted.spread.pb.RemoteCacheObserver.__cmp__
  twisted.spread.pb.RemoteCacheObserver.html#__cmp__
  Function
  Method
  PUBLIC
  Compare me to another `RemoteCacheObserver`.
- twisted.spread.pb.RemoteCacheObserver.callRemote
  twisted.spread.pb.RemoteCacheObserver.html#callRemote
  Function
  Method
  PUBLIC
  (internal) action method.
- twisted.spread.pb.RemoteCacheObserver.remoteMethod
  twisted.spread.pb.RemoteCacheObserver.html#remoteMethod
  Function
  Method
  PUBLIC
  Get a `pb.RemoteMethod` for this key.
- twisted.spread.pb.RemoteCopy
  twisted.spread.pb.RemoteCopy.html
  Class
  Class
  PUBLIC
  I am a remote copy of a Copyable object.
- twisted.spread.pb.RemoteCopy.setCopyableState
  twisted.spread.pb.RemoteCopy.html#setCopyableState
  Function
  Method
  PUBLIC
  I will be invoked with the state to copy locally.
- twisted.spread.pb.RemoteCopy.__dict__
  twisted.spread.pb.RemoteCopy.html#__dict__
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.pb.RemoteCopy.unjellyFor
  twisted.spread.pb.RemoteCopy.html#unjellyFor
  Function
  Method
  PUBLIC
  Perform the inverse operation of `Jellyable.jellyFor`.
- twisted.spread.pb.Root
  twisted.spread.pb.Root.html
  Class
  Class
  PUBLIC
  I provide a root object to `pb.Broker`s for a `pb.PBClientFactory` or `pb.PBServerFactory`.
- twisted.spread.pb.Root.rootObject
  twisted.spread.pb.Root.html#rootObject
  Function
  Method
  PUBLIC
  A factory is requesting to publish me as a root object.
- twisted.spread.pb.Serializable
  twisted.spread.pb.Serializable.html
  Class
  Class
  PUBLIC
  An object that can be passed remotely.
- twisted.spread.pb.Serializable.processUniqueID
  twisted.spread.pb.Serializable.html#processUniqueID
  Function
  Method
  PUBLIC
  Return an ID which uniquely represents this object for this process.
- twisted.spread.pb.Viewable
  twisted.spread.pb.Viewable.html
  Class
  Class
  PUBLIC
  I will be converted to a `ViewPoint` when passed to or returned from a remote method.
- twisted.spread.pb.Viewable.jellyFor
  twisted.spread.pb.Viewable.html#jellyFor
  Function
  Method
  PUBLIC
  Serialize a `ViewPoint` for me and the perspective of the given broker.
- twisted.spread.pb.ViewPoint
  twisted.spread.pb.ViewPoint.html
  Class
  Class
  PUBLIC
  I act as an indirect reference to an object accessed through a `pb.IPerspective`.
- twisted.spread.pb.ViewPoint.__init__
  twisted.spread.pb.ViewPoint.html#__init__
  Function
  Method
  PUBLIC
  Initialize me with a Perspective and an Object.
- twisted.spread.pb.ViewPoint.perspective
  twisted.spread.pb.ViewPoint.html#perspective
  Attribute
  Instance Variable
  PUBLIC
  I am an object sent remotely as a direct reference.
- twisted.spread.pb.ViewPoint.object
  twisted.spread.pb.ViewPoint.html#object
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.pb.ViewPoint.processUniqueID
  twisted.spread.pb.ViewPoint.html#processUniqueID
  Function
  Method
  PUBLIC
  Return an ID unique to a proxy for this perspective+object combination.
- twisted.spread.pb.ViewPoint.remoteMessageReceived
  twisted.spread.pb.ViewPoint.html#remoteMessageReceived
  Function
  Method
  PUBLIC
  A remote message has been received. Dispatch it appropriately.
- twisted.spread.pb.copyTags
  twisted.spread.pb.html#copyTags
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.spread.pb.setCopierForClass
  twisted.spread.pb.html#setCopierForClass
  Function
  Function
  PUBLIC
  Set which local class will represent a remote type.
- twisted.spread.pb.setCopierForClassTree
  twisted.spread.pb.html#setCopierForClassTree
  Function
  Function
  PUBLIC
  Set all classes in a module derived from `baseClass` as copiers for a corresponding remote class.
- twisted.spread.pb.setFactoryForClass
  twisted.spread.pb.html#setFactoryForClass
  Function
  Function
  PUBLIC
  Set the factory to construct a remote instance of a type:
- twisted.spread.pb.MAX_BROKER_REFS
  twisted.spread.pb.html#MAX_BROKER_REFS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.spread.pb.portno
  twisted.spread.pb.html#portno
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.spread.pb.ProtocolError
  twisted.spread.pb.ProtocolError.html
  Class
  Exception
  PUBLIC
  This error is raised when an invalid protocol statement is received.
- twisted.spread.pb.DeadReferenceError
  twisted.spread.pb.DeadReferenceError.html
  Class
  Exception
  PUBLIC
  This error is raised when a method is called on a dead reference (one whose broker has been disconnected).
- twisted.spread.pb.Error
  twisted.spread.pb.Error.html
  Class
  Exception
  PUBLIC
  This error can be raised to generate known error conditions.
- twisted.spread.pb.RemoteError
  twisted.spread.pb.RemoteError.html
  Class
  Exception
  PUBLIC
  This class is used to wrap a string-ified exception from the remote side to be able to reraise it. (Raising string exceptions is no longer possible in Python 2.6+)
- twisted.spread.pb.RemoteError.remoteType
  twisted.spread.pb.RemoteError.html#remoteType
  Attribute
  Instance Variable
  PUBLIC
  The full import path of the exception class which was raised on the remote end.
- twisted.spread.pb.RemoteError.remoteTraceback
  twisted.spread.pb.RemoteError.html#remoteTraceback
  Attribute
  Instance Variable
  PUBLIC
  The remote traceback.
- twisted.spread.pb.RemoteError.__init__
  twisted.spread.pb.RemoteError.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.spread.pb.RemoteMethod
  twisted.spread.pb.RemoteMethod.html
  Class
  Class
  PUBLIC
  This is a translucent reference to a remote message.
- twisted.spread.pb.RemoteMethod.__init__
  twisted.spread.pb.RemoteMethod.html#__init__
  Function
  Method
  PUBLIC
  Initialize with a `RemoteReference` and the name of this message.
- twisted.spread.pb.RemoteMethod.obj
  twisted.spread.pb.RemoteMethod.html#obj
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.pb.RemoteMethod.name
  twisted.spread.pb.RemoteMethod.html#name
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.pb.RemoteMethod.__cmp__
  twisted.spread.pb.RemoteMethod.html#__cmp__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.spread.pb.RemoteMethod.__hash__
  twisted.spread.pb.RemoteMethod.html#__hash__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.spread.pb.RemoteMethod.__call__
  twisted.spread.pb.RemoteMethod.html#__call__
  Function
  Method
  PUBLIC
  Asynchronously invoke a remote method.
- twisted.spread.pb.PBConnectionLost
  twisted.spread.pb.PBConnectionLost.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.spread.pb.IPerspective
  twisted.spread.pb.IPerspective.html
  Class
  Interface
  PUBLIC
  per*spec*tive, n. : The relationship of aspects of a subject to each other and to a whole: 'a perspective of history'; 'a need to view the problem in the proper perspective'.
- twisted.spread.pb.IPerspective.perspectiveMessageReceived
  twisted.spread.pb.IPerspective.html#perspectiveMessageReceived
  Function
  Method
  PUBLIC
  This method is called when a network message is received.
- twisted.spread.pb.Avatar
  twisted.spread.pb.Avatar.html
  Class
  Class
  PUBLIC
  A default IPerspective implementor.
- twisted.spread.pb.Avatar.perspectiveMessageReceived
  twisted.spread.pb.Avatar.html#perspectiveMessageReceived
  Function
  Method
  PUBLIC
  This method is called when a network message is received.
- twisted.spread.pb.AsReferenceable
  twisted.spread.pb.AsReferenceable.html
  Class
  Class
  PUBLIC
  A reference directed towards another object.
- twisted.spread.pb.AsReferenceable.__init__
  twisted.spread.pb.AsReferenceable.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.spread.pb.RemoteReference
  twisted.spread.pb.RemoteReference.html
  Class
  Class
  PUBLIC
  A translucent reference to a remote object.
- twisted.spread.pb.RemoteReference.broker
  twisted.spread.pb.RemoteReference.html#broker
  Attribute
  Instance Variable
  PUBLIC
  The broker I am obtained through.
- twisted.spread.pb.RemoteReference.__init__
  twisted.spread.pb.RemoteReference.html#__init__
  Function
  Method
  PUBLIC
  (internal) Initialize me with a broker and a locally-unique ID.
- twisted.spread.pb.RemoteReference.luid
  twisted.spread.pb.RemoteReference.html#luid
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.pb.RemoteReference.doRefCount
  twisted.spread.pb.RemoteReference.html#doRefCount
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.pb.RemoteReference.perspective
  twisted.spread.pb.RemoteReference.html#perspective
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.pb.RemoteReference.disconnectCallbacks
  twisted.spread.pb.RemoteReference.html#disconnectCallbacks
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.pb.RemoteReference.notifyOnDisconnect
  twisted.spread.pb.RemoteReference.html#notifyOnDisconnect
  Function
  Method
  PUBLIC
  Register a callback to be called if our broker gets disconnected.
- twisted.spread.pb.RemoteReference.dontNotifyOnDisconnect
  twisted.spread.pb.RemoteReference.html#dontNotifyOnDisconnect
  Function
  Method
  PUBLIC
  Remove a callback that was registered with notifyOnDisconnect.
- twisted.spread.pb.RemoteReference._disconnected
  twisted.spread.pb.RemoteReference.html#_disconnected
  Function
  Method
  PRIVATE
  Called if we are disconnected and have callbacks registered.
- twisted.spread.pb.RemoteReference.jellyFor
  twisted.spread.pb.RemoteReference.html#jellyFor
  Function
  Method
  PUBLIC
  If I am being sent back to where I came from, serialize as a local backreference.
- twisted.spread.pb.RemoteReference.unjellyFor
  twisted.spread.pb.RemoteReference.html#unjellyFor
  Function
  Method
  PUBLIC
  Unjelly myself for the jellier.
- twisted.spread.pb.RemoteReference.callRemote
  twisted.spread.pb.RemoteReference.html#callRemote
  Function
  Method
  PUBLIC
  Asynchronously invoke a remote method.
- twisted.spread.pb.RemoteReference.remoteMethod
  twisted.spread.pb.RemoteReference.html#remoteMethod
  Function
  Method
  PUBLIC
  No summary
- twisted.spread.pb.RemoteReference.__cmp__
  twisted.spread.pb.RemoteReference.html#__cmp__
  Function
  Method
  PUBLIC
  No summary
- twisted.spread.pb.RemoteReference.__hash__
  twisted.spread.pb.RemoteReference.html#__hash__
  Function
  Method
  PUBLIC
  Hash me.
- twisted.spread.pb.RemoteReference.__del__
  twisted.spread.pb.RemoteReference.html#__del__
  Function
  Method
  PUBLIC
  Do distributed reference counting on finalization.
- twisted.spread.pb.Local
  twisted.spread.pb.Local.html
  Class
  Class
  PUBLIC
  (internal) A reference to a local object.
- twisted.spread.pb.Local.__init__
  twisted.spread.pb.Local.html#__init__
  Function
  Method
  PUBLIC
  Initialize.
- twisted.spread.pb.Local.object
  twisted.spread.pb.Local.html#object
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.pb.Local.perspective
  twisted.spread.pb.Local.html#perspective
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.pb.Local.refcount
  twisted.spread.pb.Local.html#refcount
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.pb.Local.__repr__
  twisted.spread.pb.Local.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.spread.pb.Local.incref
  twisted.spread.pb.Local.html#incref
  Function
  Method
  PUBLIC
  Increment the reference count.
- twisted.spread.pb.Local.decref
  twisted.spread.pb.Local.html#decref
  Function
  Method
  PUBLIC
  Decrement the reference count.
- twisted.spread.pb.CopyableFailure
  twisted.spread.pb.CopyableFailure.html
  Class
  Exception
  PUBLIC
  A `flavors.RemoteCopy` and `flavors.Copyable` version of `twisted.python.failure.Failure` for serialization.
- twisted.spread.pb.CopyableFailure.unsafeTracebacks
  twisted.spread.pb.CopyableFailure.html#unsafeTracebacks
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.spread.pb.CopyableFailure.getStateToCopy
  twisted.spread.pb.CopyableFailure.html#getStateToCopy
  Function
  Method
  PUBLIC
  Collect state related to the exception which occurred, discarding state which cannot reasonably be serialized.
- twisted.spread.pb.CopiedFailure
  twisted.spread.pb.CopiedFailure.html
  Class
  Exception
  PUBLIC
  A `CopiedFailure` is a `pb.RemoteCopy` of a `failure.Failure` transferred via PB.
- twisted.spread.pb.CopiedFailure.type
  twisted.spread.pb.CopiedFailure.html#type
  Attribute
  Instance Variable
  PUBLIC
  The full import path of the exception class which was raised on the remote end.
- twisted.spread.pb.CopiedFailure.value
  twisted.spread.pb.CopiedFailure.html#value
  Attribute
  Instance Variable
  PUBLIC
  A str() representation of the remote value.
- twisted.spread.pb.CopiedFailure.traceback
  twisted.spread.pb.CopiedFailure.html#traceback
  Attribute
  Instance Variable
  PUBLIC
  The remote traceback.
- twisted.spread.pb.CopiedFailure.printTraceback
  twisted.spread.pb.CopiedFailure.html#printTraceback
  Function
  Method
  PUBLIC
  Emulate Python's standard error reporting mechanism.
- twisted.spread.pb.CopiedFailure.throwExceptionIntoGenerator
  twisted.spread.pb.CopiedFailure.html#throwExceptionIntoGenerator
  Function
  Method
  PUBLIC
  Throw the original exception into the given generator, preserving traceback information if available. In the case of a `CopiedFailure` where the exception type is a string, a `pb.RemoteError` is thrown instead.
- twisted.spread.pb.failure2Copyable
  twisted.spread.pb.html#failure2Copyable
  Function
  Function
  PUBLIC
  Undocumented
- twisted.spread.pb.Broker
  twisted.spread.pb.Broker.html
  Class
  Class
  PUBLIC
  I am a broker for objects.
- twisted.spread.pb.Broker.version
  twisted.spread.pb.Broker.html#version
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.spread.pb.Broker.username
  twisted.spread.pb.Broker.html#username
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.spread.pb.Broker.factory
  twisted.spread.pb.Broker.html#factory
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.spread.pb.Broker.__init__
  twisted.spread.pb.Broker.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.spread.pb.Broker.disconnected
  twisted.spread.pb.Broker.html#disconnected
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.pb.Broker.disconnects
  twisted.spread.pb.Broker.html#disconnects
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.pb.Broker.failures
  twisted.spread.pb.Broker.html#failures
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.pb.Broker.connects
  twisted.spread.pb.Broker.html#connects
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.pb.Broker.localObjects
  twisted.spread.pb.Broker.html#localObjects
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.pb.Broker.security
  twisted.spread.pb.Broker.html#security
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.pb.Broker.pageProducers
  twisted.spread.pb.Broker.html#pageProducers
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.pb.Broker.currentRequestID
  twisted.spread.pb.Broker.html#currentRequestID
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.pb.Broker.currentLocalID
  twisted.spread.pb.Broker.html#currentLocalID
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.pb.Broker.unserializingPerspective
  twisted.spread.pb.Broker.html#unserializingPerspective
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.pb.Broker.luids
  twisted.spread.pb.Broker.html#luids
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.pb.Broker.remotelyCachedObjects
  twisted.spread.pb.Broker.html#remotelyCachedObjects
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.pb.Broker.remotelyCachedLUIDs
  twisted.spread.pb.Broker.html#remotelyCachedLUIDs
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.pb.Broker.locallyCachedObjects
  twisted.spread.pb.Broker.html#locallyCachedObjects
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.pb.Broker.waitingForAnswers
  twisted.spread.pb.Broker.html#waitingForAnswers
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.pb.Broker._localCleanup
  twisted.spread.pb.Broker.html#_localCleanup
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.spread.pb.Broker.resumeProducing
  twisted.spread.pb.Broker.html#resumeProducing
  Function
  Method
  PUBLIC
  Called when the consumer attached to me runs out of buffer.
- twisted.spread.pb.Broker.pauseProducing
  twisted.spread.pb.Broker.html#pauseProducing
  Function
  Method
  PUBLIC
  Undocumented
- twisted.spread.pb.Broker.stopProducing
  twisted.spread.pb.Broker.html#stopProducing
  Function
  Method
  PUBLIC
  Undocumented
- twisted.spread.pb.Broker.registerPageProducer
  twisted.spread.pb.Broker.html#registerPageProducer
  Function
  Method
  PUBLIC
  Undocumented
- twisted.spread.pb.Broker.expressionReceived
  twisted.spread.pb.Broker.html#expressionReceived
  Function
  Method
  PUBLIC
  Evaluate an expression as it's received.
- twisted.spread.pb.Broker.proto_version
  twisted.spread.pb.Broker.html#proto_version
  Function
  Method
  PUBLIC
  Protocol message: (version version-number)
- twisted.spread.pb.Broker.sendCall
  twisted.spread.pb.Broker.html#sendCall
  Function
  Method
  PUBLIC
  Utility method to send an expression to the other side of the connection.
- twisted.spread.pb.Broker.proto_didNotUnderstand
  twisted.spread.pb.Broker.html#proto_didNotUnderstand
  Function
  Method
  PUBLIC
  Respond to stock '`didNotUnderstand`' message.
- twisted.spread.pb.Broker.connectionReady
  twisted.spread.pb.Broker.html#connectionReady
  Function
  Method
  PUBLIC
  Initialize. Called after Banana negotiation is done.
- twisted.spread.pb.Broker.connectionFailed
  twisted.spread.pb.Broker.html#connectionFailed
  Function
  Method
  PUBLIC
  Undocumented
- twisted.spread.pb.Broker.connectionLost
  twisted.spread.pb.Broker.html#connectionLost
  Function
  Method
  PUBLIC
  The connection was lost.
- twisted.spread.pb.Broker.localSecurity
  twisted.spread.pb.Broker.html#localSecurity
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.pb.Broker.remoteSecurity
  twisted.spread.pb.Broker.html#remoteSecurity
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.pb.Broker.notifyOnDisconnect
  twisted.spread.pb.Broker.html#notifyOnDisconnect
  Function
  Method
  PUBLIC
  No summary
- twisted.spread.pb.Broker.notifyOnFail
  twisted.spread.pb.Broker.html#notifyOnFail
  Function
  Method
  PUBLIC
  No summary
- twisted.spread.pb.Broker.notifyOnConnect
  twisted.spread.pb.Broker.html#notifyOnConnect
  Function
  Method
  PUBLIC
  No summary
- twisted.spread.pb.Broker.dontNotifyOnDisconnect
  twisted.spread.pb.Broker.html#dontNotifyOnDisconnect
  Function
  Method
  PUBLIC
  No summary
- twisted.spread.pb.Broker.localObjectForID
  twisted.spread.pb.Broker.html#localObjectForID
  Function
  Method
  PUBLIC
  Get a local object for a locally unique ID.
- twisted.spread.pb.Broker.maxBrokerRefsViolations
  twisted.spread.pb.Broker.html#maxBrokerRefsViolations
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.pb.Broker.registerReference
  twisted.spread.pb.Broker.html#registerReference
  Function
  Method
  PUBLIC
  Store a persistent reference to a local object and map its id() to a generated, session-unique ID.
- twisted.spread.pb.Broker.setNameForLocal
  twisted.spread.pb.Broker.html#setNameForLocal
  Function
  Method
  PUBLIC
  Store a special (string) ID for this object.
- twisted.spread.pb.Broker.remoteForName
  twisted.spread.pb.Broker.html#remoteForName
  Function
  Method
  PUBLIC
  Returns an object from the remote name mapping.
- twisted.spread.pb.Broker.cachedRemotelyAs
  twisted.spread.pb.Broker.html#cachedRemotelyAs
  Function
  Method
  PUBLIC
  No summary
- twisted.spread.pb.Broker.remotelyCachedForLUID
  twisted.spread.pb.Broker.html#remotelyCachedForLUID
  Function
  Method
  PUBLIC
  No summary
- twisted.spread.pb.Broker.cacheRemotely
  twisted.spread.pb.Broker.html#cacheRemotely
  Function
  Method
  PUBLIC
  XXX
- twisted.spread.pb.Broker.cacheLocally
  twisted.spread.pb.Broker.html#cacheLocally
  Function
  Method
  PUBLIC
  (internal)
- twisted.spread.pb.Broker.cachedLocallyAs
  twisted.spread.pb.Broker.html#cachedLocallyAs
  Function
  Method
  PUBLIC
  Undocumented
- twisted.spread.pb.Broker.serialize
  twisted.spread.pb.Broker.html#serialize
  Function
  Method
  PUBLIC
  Jelly an object according to the remote security rules for this broker.
- twisted.spread.pb.Broker.serializingPerspective
  twisted.spread.pb.Broker.html#serializingPerspective
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.pb.Broker.jellyMethod
  twisted.spread.pb.Broker.html#jellyMethod
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.pb.Broker.jellyArgs
  twisted.spread.pb.Broker.html#jellyArgs
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.pb.Broker.jellyKw
  twisted.spread.pb.Broker.html#jellyKw
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.pb.Broker.unserialize
  twisted.spread.pb.Broker.html#unserialize
  Function
  Method
  PUBLIC
  Unjelly an sexp according to the local security rules for this broker.
- twisted.spread.pb.Broker.newLocalID
  twisted.spread.pb.Broker.html#newLocalID
  Function
  Method
  PUBLIC
  No summary
- twisted.spread.pb.Broker.newRequestID
  twisted.spread.pb.Broker.html#newRequestID
  Function
  Method
  PUBLIC
  No summary
- twisted.spread.pb.Broker._sendMessage
  twisted.spread.pb.Broker.html#_sendMessage
  Function
  Method
  PRIVATE
  Undocumented
- twisted.spread.pb.Broker.proto_message
  twisted.spread.pb.Broker.html#proto_message
  Function
  Method
  PUBLIC
  Undocumented
- twisted.spread.pb.Broker.proto_cachemessage
  twisted.spread.pb.Broker.html#proto_cachemessage
  Function
  Method
  PUBLIC
  Undocumented
- twisted.spread.pb.Broker._recvMessage
  twisted.spread.pb.Broker.html#_recvMessage
  Function
  Method
  PRIVATE
  Received a message-send.
- twisted.spread.pb.Broker._sendAnswer
  twisted.spread.pb.Broker.html#_sendAnswer
  Function
  Method
  PRIVATE
  (internal) Send an answer to a previously sent message.
- twisted.spread.pb.Broker.proto_answer
  twisted.spread.pb.Broker.html#proto_answer
  Function
  Method
  PUBLIC
  (internal) Got an answer to a previously sent message.
- twisted.spread.pb.Broker._sendFailureOrError
  twisted.spread.pb.Broker.html#_sendFailureOrError
  Function
  Method
  PRIVATE
  Call `_sendError` or `_sendFailure`, depending on whether `fail` represents an `Error` subclass or not.
- twisted.spread.pb.Broker._sendFailure
  twisted.spread.pb.Broker.html#_sendFailure
  Function
  Method
  PRIVATE
  Log error and then send it.
- twisted.spread.pb.Broker._sendError
  twisted.spread.pb.Broker.html#_sendError
  Function
  Method
  PRIVATE
  (internal) Send an error for a previously sent message.
- twisted.spread.pb.Broker.proto_error
  twisted.spread.pb.Broker.html#proto_error
  Function
  Method
  PUBLIC
  (internal) Deal with an error.
- twisted.spread.pb.Broker.sendDecRef
  twisted.spread.pb.Broker.html#sendDecRef
  Function
  Method
  PUBLIC
  (internal) Send a DECREF directive.
- twisted.spread.pb.Broker.proto_decref
  twisted.spread.pb.Broker.html#proto_decref
  Function
  Method
  PUBLIC
  (internal) Decrement the reference count of an object.
- twisted.spread.pb.Broker.decCacheRef
  twisted.spread.pb.Broker.html#decCacheRef
  Function
  Method
  PUBLIC
  (internal) Send a DECACHE directive.
- twisted.spread.pb.Broker.proto_decache
  twisted.spread.pb.Broker.html#proto_decache
  Function
  Method
  PUBLIC
  (internal) Decrement the reference count of a cached object.
- twisted.spread.pb.Broker.proto_uncache
  twisted.spread.pb.Broker.html#proto_uncache
  Function
  Method
  PUBLIC
  (internal) Tell the client it is now OK to uncache an object.
- twisted.spread.pb.respond
  twisted.spread.pb.html#respond
  Function
  Function
  PUBLIC
  Respond to a challenge.
- twisted.spread.pb.challenge
  twisted.spread.pb.html#challenge
  Function
  Function
  PUBLIC
  No summary
- twisted.spread.pb.PBClientFactory
  twisted.spread.pb.PBClientFactory.html
  Class
  Class
  PUBLIC
  Client factory for PB brokers.
- twisted.spread.pb.PBClientFactory.unsafeTracebacks
  twisted.spread.pb.PBClientFactory.html#unsafeTracebacks
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.pb.PBClientFactory.__init__
  twisted.spread.pb.PBClientFactory.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.spread.pb.PBClientFactory.security
  twisted.spread.pb.PBClientFactory.html#security
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.pb.PBClientFactory.buildProtocol
  twisted.spread.pb.PBClientFactory.html#buildProtocol
  Function
  Method
  PUBLIC
  Build the broker instance, passing the security options to it.
- twisted.spread.pb.PBClientFactory._reset
  twisted.spread.pb.PBClientFactory.html#_reset
  Function
  Method
  PRIVATE
  Undocumented
- twisted.spread.pb.PBClientFactory.rootObjectRequests
  twisted.spread.pb.PBClientFactory.html#rootObjectRequests
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.pb.PBClientFactory._broker
  twisted.spread.pb.PBClientFactory.html#_broker
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.spread.pb.PBClientFactory._root
  twisted.spread.pb.PBClientFactory.html#_root
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.spread.pb.PBClientFactory._failAll
  twisted.spread.pb.PBClientFactory.html#_failAll
  Function
  Method
  PRIVATE
  Undocumented
- twisted.spread.pb.PBClientFactory.clientConnectionFailed
  twisted.spread.pb.PBClientFactory.html#clientConnectionFailed
  Function
  Method
  PUBLIC
  Called when a connection has failed to connect.
- twisted.spread.pb.PBClientFactory.clientConnectionLost
  twisted.spread.pb.PBClientFactory.html#clientConnectionLost
  Function
  Method
  PUBLIC
  Reconnecting subclasses should call with reconnecting=1.
- twisted.spread.pb.PBClientFactory.clientConnectionMade
  twisted.spread.pb.PBClientFactory.html#clientConnectionMade
  Function
  Method
  PUBLIC
  Undocumented
- twisted.spread.pb.PBClientFactory.getRootObject
  twisted.spread.pb.PBClientFactory.html#getRootObject
  Function
  Method
  PUBLIC
  Get root object of remote PB server.
- twisted.spread.pb.PBClientFactory.disconnect
  twisted.spread.pb.PBClientFactory.html#disconnect
  Function
  Method
  PUBLIC
  If the factory is connected, close the connection.
- twisted.spread.pb.PBClientFactory._cbSendUsername
  twisted.spread.pb.PBClientFactory.html#_cbSendUsername
  Function
  Method
  PRIVATE
  Undocumented
- twisted.spread.pb.PBClientFactory._cbResponse
  twisted.spread.pb.PBClientFactory.html#_cbResponse
  Function
  Method
  PRIVATE
  Undocumented
- twisted.spread.pb.PBClientFactory._cbLoginAnonymous
  twisted.spread.pb.PBClientFactory.html#_cbLoginAnonymous
  Function
  Method
  PRIVATE
  Attempt an anonymous login on the given remote root object.
- twisted.spread.pb.PBClientFactory.login
  twisted.spread.pb.PBClientFactory.html#login
  Function
  Method
  PUBLIC
  Login and get perspective from remote PB server.
- twisted.spread.pb.PBServerFactory
  twisted.spread.pb.PBServerFactory.html
  Class
  Class
  PUBLIC
  Server factory for perspective broker.
- twisted.spread.pb.PBServerFactory.unsafeTracebacks
  twisted.spread.pb.PBServerFactory.html#unsafeTracebacks
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.pb.PBServerFactory.__init__
  twisted.spread.pb.PBServerFactory.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.spread.pb.PBServerFactory.root
  twisted.spread.pb.PBServerFactory.html#root
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.pb.PBServerFactory.security
  twisted.spread.pb.PBServerFactory.html#security
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.pb.PBServerFactory.buildProtocol
  twisted.spread.pb.PBServerFactory.html#buildProtocol
  Function
  Method
  PUBLIC
  Return a Broker attached to the factory (as the service provider).
- twisted.spread.pb.PBServerFactory.clientConnectionMade
  twisted.spread.pb.PBServerFactory.html#clientConnectionMade
  Function
  Method
  PUBLIC
  Undocumented
- twisted.spread.pb.IUsernameMD5Password
  twisted.spread.pb.IUsernameMD5Password.html
  Class
  Interface
  PUBLIC
  I encapsulate a username and a hashed password.
- twisted.spread.pb.IUsernameMD5Password.username
  twisted.spread.pb.IUsernameMD5Password.html#username
  Attribute
  Instance Variable
  PUBLIC
  The username associated with these credentials.
- twisted.spread.pb.IUsernameMD5Password.checkPassword
  twisted.spread.pb.IUsernameMD5Password.html#checkPassword
  Function
  Method
  PUBLIC
  Validate these credentials against the correct password.
- twisted.spread.pb.IUsernameMD5Password.checkMD5Password
  twisted.spread.pb.IUsernameMD5Password.html#checkMD5Password
  Function
  Method
  PUBLIC
  Validate these credentials against the correct MD5 digest of the password.
- twisted.spread.pb._PortalRoot
  twisted.spread.pb._PortalRoot.html
  Class
  Class
  PRIVATE
  Root object, used to login to portal.
- twisted.spread.pb._PortalRoot.__init__
  twisted.spread.pb._PortalRoot.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.spread.pb._PortalRoot.portal
  twisted.spread.pb._PortalRoot.html#portal
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.pb._PortalRoot.rootObject
  twisted.spread.pb._PortalRoot.html#rootObject
  Function
  Method
  PUBLIC
  Return root Referenceable for broker.
- twisted.spread.pb._JellyableAvatarMixin
  twisted.spread.pb._JellyableAvatarMixin.html
  Class
  Class
  PRIVATE
  Helper class for code which deals with avatars which PB must be capable of sending to a peer.
- twisted.spread.pb._JellyableAvatarMixin._cbLogin
  twisted.spread.pb._JellyableAvatarMixin.html#_cbLogin
  Function
  Method
  PRIVATE
  Ensure that the avatar to be returned to the client is jellyable and set up disconnection notification to call the realm's logout object.
- twisted.spread.pb._PortalWrapper
  twisted.spread.pb._PortalWrapper.html
  Class
  Class
  PRIVATE
  Root Referenceable object, used to login to portal.
- twisted.spread.pb._PortalWrapper.__init__
  twisted.spread.pb._PortalWrapper.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.spread.pb._PortalWrapper.portal
  twisted.spread.pb._PortalWrapper.html#portal
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.pb._PortalWrapper.broker
  twisted.spread.pb._PortalWrapper.html#broker
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.pb._PortalWrapper.remote_login
  twisted.spread.pb._PortalWrapper.html#remote_login
  Function
  Method
  PUBLIC
  Start of username/password login.
- twisted.spread.pb._PortalWrapper.remote_loginAnonymous
  twisted.spread.pb._PortalWrapper.html#remote_loginAnonymous
  Function
  Method
  PUBLIC
  Attempt an anonymous login.
- twisted.spread.pb._PortalAuthChallenger
  twisted.spread.pb._PortalAuthChallenger.html
  Class
  Class
  PRIVATE
  Called with response to password challenge.
- twisted.spread.pb._PortalAuthChallenger.__init__
  twisted.spread.pb._PortalAuthChallenger.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.spread.pb._PortalAuthChallenger.portal
  twisted.spread.pb._PortalAuthChallenger.html#portal
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.pb._PortalAuthChallenger.broker
  twisted.spread.pb._PortalAuthChallenger.html#broker
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.pb._PortalAuthChallenger.username
  twisted.spread.pb._PortalAuthChallenger.html#username
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.pb._PortalAuthChallenger.challenge
  twisted.spread.pb._PortalAuthChallenger.html#challenge
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.pb._PortalAuthChallenger.remote_respond
  twisted.spread.pb._PortalAuthChallenger.html#remote_respond
  Function
  Method
  PUBLIC
  Undocumented
- twisted.spread.pb._PortalAuthChallenger.response
  twisted.spread.pb._PortalAuthChallenger.html#response
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.pb._PortalAuthChallenger.checkPassword
  twisted.spread.pb._PortalAuthChallenger.html#checkPassword
  Function
  Method
  PUBLIC
  `IUsernameHashedPassword`
- twisted.spread.pb._PortalAuthChallenger.checkMD5Password
  twisted.spread.pb._PortalAuthChallenger.html#checkMD5Password
  Function
  Method
  PUBLIC
  `IUsernameMD5Password`
- twisted.mail.pb.Maildir
  twisted.mail.pb.Maildir.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.mail.pb.Maildir.__init__
  twisted.mail.pb.Maildir.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.pb.Maildir.virtualDirectory
  twisted.mail.pb.Maildir.html#virtualDirectory
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.pb.Maildir.rootDirectory
  twisted.mail.pb.Maildir.html#rootDirectory
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.pb.Maildir.directory
  twisted.mail.pb.Maildir.html#directory
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.pb.Maildir.getFolderMessage
  twisted.mail.pb.Maildir.html#getFolderMessage
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.pb.Maildir.deleteFolderMessage
  twisted.mail.pb.Maildir.html#deleteFolderMessage
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.pb.Maildir.deleteNewMessage
  twisted.mail.pb.Maildir.html#deleteNewMessage
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.pb.Maildir.deleteCurMessage
  twisted.mail.pb.Maildir.html#deleteCurMessage
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.pb.Maildir.getNewMessages
  twisted.mail.pb.Maildir.html#getNewMessages
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.pb.Maildir.getCurMessages
  twisted.mail.pb.Maildir.html#getCurMessages
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.pb.Maildir.getNewMessage
  twisted.mail.pb.Maildir.html#getNewMessage
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.pb.Maildir.getCurMessage
  twisted.mail.pb.Maildir.html#getCurMessage
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.pb.Maildir.getSubFolder
  twisted.mail.pb.Maildir.html#getSubFolder
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.pb.Maildir._isSubFolder
  twisted.mail.pb.Maildir.html#_isSubFolder
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.pb.MaildirCollection
  twisted.mail.pb.MaildirCollection.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.mail.pb.MaildirCollection.__init__
  twisted.mail.pb.MaildirCollection.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.pb.MaildirCollection.root
  twisted.mail.pb.MaildirCollection.html#root
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.pb.MaildirCollection.getSubFolders
  twisted.mail.pb.MaildirCollection.html#getSubFolders
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.pb.MaildirCollection.getSubFolder
  twisted.mail.pb.MaildirCollection.html#getSubFolder
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.pb.MaildirBroker
  twisted.mail.pb.MaildirBroker.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.mail.pb.MaildirBroker.proto_getCollection
  twisted.mail.pb.MaildirBroker.html#proto_getCollection
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.pb.MaildirBroker.getCollection
  twisted.mail.pb.MaildirBroker.html#getCollection
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.pb.MaildirClient
  twisted.mail.pb.MaildirClient.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.mail.pb.MaildirClient.getCollection
  twisted.mail.pb.MaildirClient.html#getCollection
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.relaymanager.ManagedRelayerMixin
  twisted.mail.relaymanager.ManagedRelayerMixin.html
  Class
  Class
  PUBLIC
  SMTP Relayer which notifies a manager
- twisted.mail.relaymanager.ManagedRelayerMixin.__init__
  twisted.mail.relaymanager.ManagedRelayerMixin.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.relaymanager.ManagedRelayerMixin.manager
  twisted.mail.relaymanager.ManagedRelayerMixin.html#manager
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.relaymanager.ManagedRelayerMixin.factory
  twisted.mail.relaymanager.ManagedRelayerMixin.html#factory
  Attribute
  Property
  PUBLIC
  Undocumented
- twisted.mail.relaymanager.ManagedRelayerMixin.factory.setter
  twisted.mail.relaymanager.ManagedRelayerMixin.html#factory.setter
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.relaymanager.ManagedRelayerMixin._factory
  twisted.mail.relaymanager.ManagedRelayerMixin.html#_factory
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.mail.relaymanager.ManagedRelayerMixin.sentMail
  twisted.mail.relaymanager.ManagedRelayerMixin.html#sentMail
  Function
  Method
  PUBLIC
  called when e-mail has been sent
- twisted.mail.relaymanager.ManagedRelayerMixin.connectionLost
  twisted.mail.relaymanager.ManagedRelayerMixin.html#connectionLost
  Function
  Method
  PUBLIC
  called when connection is broken
- twisted.mail.relaymanager.SMTPManagedRelayer
  twisted.mail.relaymanager.SMTPManagedRelayer.html
  Class
  Class
  PUBLIC
  An SMTP managed relayer.
- twisted.mail.relaymanager.SMTPManagedRelayer.factory
  twisted.mail.relaymanager.SMTPManagedRelayer.html#factory
  Attribute
  Instance Variable
  PUBLIC
  The factory that created this relayer. This must be set by the factory.
- twisted.mail.relaymanager.SMTPManagedRelayer.__init__
  twisted.mail.relaymanager.SMTPManagedRelayer.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.mail.relaymanager.ESMTPManagedRelayer
  twisted.mail.relaymanager.ESMTPManagedRelayer.html
  Class
  Class
  PUBLIC
  An ESMTP managed relayer.
- twisted.mail.relaymanager.ESMTPManagedRelayer.__init__
  twisted.mail.relaymanager.ESMTPManagedRelayer.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.mail.relaymanager.SMTPManagedRelayerFactory
  twisted.mail.relaymanager.SMTPManagedRelayerFactory.html
  Class
  Class
  PUBLIC
  A factory to create an `SMTPManagedRelayer`.
- twisted.mail.relaymanager.SMTPManagedRelayerFactory.messages
  twisted.mail.relaymanager.SMTPManagedRelayerFactory.html#messages
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`
- twisted.mail.relaymanager.SMTPManagedRelayerFactory.manager
  twisted.mail.relaymanager.SMTPManagedRelayerFactory.html#manager
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`
- twisted.mail.relaymanager.SMTPManagedRelayerFactory.protocol
  twisted.mail.relaymanager.SMTPManagedRelayerFactory.html#protocol
  Attribute
  Instance Variable
  PUBLIC
  A callable which returns a managed relayer for SMTP. See `SMTPManagedRelayer.__init__` for parameters to the callable.
- twisted.mail.relaymanager.SMTPManagedRelayerFactory.pArgs
  twisted.mail.relaymanager.SMTPManagedRelayerFactory.html#pArgs
  Attribute
  Instance Variable
  PUBLIC
  Positional arguments for `SMTPClient.__init__`
- twisted.mail.relaymanager.SMTPManagedRelayerFactory.pKwArgs
  twisted.mail.relaymanager.SMTPManagedRelayerFactory.html#pKwArgs
  Attribute
  Instance Variable
  PUBLIC
  Keyword arguments for `SMTPClient.__init__`
- twisted.mail.relaymanager.SMTPManagedRelayerFactory.__init__
  twisted.mail.relaymanager.SMTPManagedRelayerFactory.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.mail.relaymanager.SMTPManagedRelayerFactory.buildProtocol
  twisted.mail.relaymanager.SMTPManagedRelayerFactory.html#buildProtocol
  Function
  Method
  PUBLIC
  Create an `SMTPManagedRelayer`.
- twisted.mail.relaymanager.SMTPManagedRelayerFactory.clientConnectionFailed
  twisted.mail.relaymanager.SMTPManagedRelayerFactory.html#clientConnectionFailed
  Function
  Method
  PUBLIC
  Notify the attempt manager that a connection could not be established.
- twisted.mail.relaymanager.ESMTPManagedRelayerFactory
  twisted.mail.relaymanager.ESMTPManagedRelayerFactory.html
  Class
  Class
  PUBLIC
  A factory to create an `ESMTPManagedRelayer`.
- twisted.mail.relaymanager.ESMTPManagedRelayerFactory.protocol
  twisted.mail.relaymanager.ESMTPManagedRelayerFactory.html#protocol
  Attribute
  Instance Variable
  PUBLIC
  A callable which returns a managed relayer for ESMTP. See `ESMTPManagedRelayer.__init__` for parameters to the callable.
- twisted.mail.relaymanager.ESMTPManagedRelayerFactory.secret
  twisted.mail.relaymanager.ESMTPManagedRelayerFactory.html#secret
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`
- twisted.mail.relaymanager.ESMTPManagedRelayerFactory.contextFactory
  twisted.mail.relaymanager.ESMTPManagedRelayerFactory.html#contextFactory
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`
- twisted.mail.relaymanager.ESMTPManagedRelayerFactory.__init__
  twisted.mail.relaymanager.ESMTPManagedRelayerFactory.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.mail.relaymanager.ESMTPManagedRelayerFactory.buildProtocol
  twisted.mail.relaymanager.ESMTPManagedRelayerFactory.html#buildProtocol
  Function
  Method
  PUBLIC
  Create an `ESMTPManagedRelayer`.
- twisted.mail.relaymanager.Queue
  twisted.mail.relaymanager.Queue.html
  Class
  Class
  PUBLIC
  A queue for messages to be relayed.
- twisted.mail.relaymanager.Queue.directory
  twisted.mail.relaymanager.Queue.html#directory
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`
- twisted.mail.relaymanager.Queue.n
  twisted.mail.relaymanager.Queue.html#n
  Attribute
  Instance Variable
  PUBLIC
  A number used to form unique filenames.
- twisted.mail.relaymanager.Queue.waiting
  twisted.mail.relaymanager.Queue.html#waiting
  Attribute
  Instance Variable
  PUBLIC
  The base filenames of messages waiting to be relayed.
- twisted.mail.relaymanager.Queue.relayed
  twisted.mail.relaymanager.Queue.html#relayed
  Attribute
  Instance Variable
  PUBLIC
  The base filenames of messages in the process of being relayed.
- twisted.mail.relaymanager.Queue.noisy
  twisted.mail.relaymanager.Queue.html#noisy
  Attribute
  Instance Variable
  PUBLIC
  A flag which determines whether informational log messages will be generated (`True`) or not (`False`).
- twisted.mail.relaymanager.Queue.__init__
  twisted.mail.relaymanager.Queue.html#__init__
  Function
  Method
  PUBLIC
  Initialize non-volatile state.
- twisted.mail.relaymanager.Queue._init
  twisted.mail.relaymanager.Queue.html#_init
  Function
  Method
  PRIVATE
  Initialize volatile state.
- twisted.mail.relaymanager.Queue.__getstate__
  twisted.mail.relaymanager.Queue.html#__getstate__
  Function
  Method
  PUBLIC
  Create a representation of the non-volatile state of the queue.
- twisted.mail.relaymanager.Queue.__setstate__
  twisted.mail.relaymanager.Queue.html#__setstate__
  Function
  Method
  PUBLIC
  Restore the non-volatile state of the queue and recreate the volatile state.
- twisted.mail.relaymanager.Queue.readDirectory
  twisted.mail.relaymanager.Queue.html#readDirectory
  Function
  Method
  PUBLIC
  Scan the message directory for new messages.
- twisted.mail.relaymanager.Queue.getWaiting
  twisted.mail.relaymanager.Queue.html#getWaiting
  Function
  Method
  PUBLIC
  Return the base filenames of messages waiting to be relayed.
- twisted.mail.relaymanager.Queue.hasWaiting
  twisted.mail.relaymanager.Queue.html#hasWaiting
  Function
  Method
  PUBLIC
  Return an indication of whether the queue has messages waiting to be relayed.
- twisted.mail.relaymanager.Queue.getRelayed
  twisted.mail.relaymanager.Queue.html#getRelayed
  Function
  Method
  PUBLIC
  Return the base filenames of messages in the process of being relayed.
- twisted.mail.relaymanager.Queue.setRelaying
  twisted.mail.relaymanager.Queue.html#setRelaying
  Function
  Method
  PUBLIC
  Mark a message as being relayed.
- twisted.mail.relaymanager.Queue.setWaiting
  twisted.mail.relaymanager.Queue.html#setWaiting
  Function
  Method
  PUBLIC
  Mark a message as waiting to be relayed.
- twisted.mail.relaymanager.Queue.addMessage
  twisted.mail.relaymanager.Queue.html#addMessage
  Function
  Method
  PUBLIC
  Mark a message as waiting to be relayed unless it is in the process of being relayed.
- twisted.mail.relaymanager.Queue.done
  twisted.mail.relaymanager.Queue.html#done
  Function
  Method
  PUBLIC
  Remove a message from the queue.
- twisted.mail.relaymanager.Queue.getPath
  twisted.mail.relaymanager.Queue.html#getPath
  Function
  Method
  PUBLIC
  Return the full base pathname of a message in the queue.
- twisted.mail.relaymanager.Queue.getEnvelope
  twisted.mail.relaymanager.Queue.html#getEnvelope
  Function
  Method
  PUBLIC
  Get the envelope for a message.
- twisted.mail.relaymanager.Queue.getEnvelopeFile
  twisted.mail.relaymanager.Queue.html#getEnvelopeFile
  Function
  Method
  PUBLIC
  Return the envelope file for a message in the queue.
- twisted.mail.relaymanager.Queue.createNewMessage
  twisted.mail.relaymanager.Queue.html#createNewMessage
  Function
  Method
  PUBLIC
  Create a new message in the queue.
- twisted.mail.relaymanager._AttemptManager
  twisted.mail.relaymanager._AttemptManager.html
  Class
  Class
  PRIVATE
  A manager for an attempt to relay a set of messages to a mail exchange server.
- twisted.mail.relaymanager._AttemptManager.manager
  twisted.mail.relaymanager._AttemptManager.html#manager
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`
- twisted.mail.relaymanager._AttemptManager._completionDeferreds
  twisted.mail.relaymanager._AttemptManager.html#_completionDeferreds
  Attribute
  Instance Variable
  PRIVATE
  Deferreds which are to be notified when the attempt to relay is finished.
- twisted.mail.relaymanager._AttemptManager.__init__
  twisted.mail.relaymanager._AttemptManager.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.mail.relaymanager._AttemptManager.noisy
  twisted.mail.relaymanager._AttemptManager.html#noisy
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.relaymanager._AttemptManager.reactor
  twisted.mail.relaymanager._AttemptManager.html#reactor
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.mail.relaymanager._AttemptManager.getCompletionDeferred
  twisted.mail.relaymanager._AttemptManager.html#getCompletionDeferred
  Function
  Method
  PUBLIC
  Return a deferred which will fire when the attempt to relay is finished.
- twisted.mail.relaymanager._AttemptManager._finish
  twisted.mail.relaymanager._AttemptManager.html#_finish
  Function
  Method
  PRIVATE
  Remove a message from the relay queue and from the smart host's list of messages being relayed.
- twisted.mail.relaymanager._AttemptManager.notifySuccess
  twisted.mail.relaymanager._AttemptManager.html#notifySuccess
  Function
  Method
  PUBLIC
  Remove a message from the relay queue after it has been successfully sent.
- twisted.mail.relaymanager._AttemptManager.notifyFailure
  twisted.mail.relaymanager._AttemptManager.html#notifyFailure
  Function
  Method
  PUBLIC
  Generate a bounce message for a message which cannot be relayed.
- twisted.mail.relaymanager._AttemptManager.notifyDone
  twisted.mail.relaymanager._AttemptManager.html#notifyDone
  Function
  Method
  PUBLIC
  When the connection is lost or cannot be established, prepare to resend unsent messages and fire all deferred which are waiting for the completion of the attempt to relay.
- twisted.mail.relaymanager._AttemptManager.notifyNoConnection
  twisted.mail.relaymanager._AttemptManager.html#notifyNoConnection
  Function
  Method
  PUBLIC
  When a connection to the mail exchange server cannot be established, prepare to resend messages later.
- twisted.mail.relaymanager.SmartHostSMTPRelayingManager
  twisted.mail.relaymanager.SmartHostSMTPRelayingManager.html
  Class
  Class
  PUBLIC
  A smart host which uses SMTP managed relayers to send messages from the relay queue.
- twisted.mail.relaymanager.SmartHostSMTPRelayingManager.queue
  twisted.mail.relaymanager.SmartHostSMTPRelayingManager.html#queue
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`.
- twisted.mail.relaymanager.SmartHostSMTPRelayingManager.maxConnections
  twisted.mail.relaymanager.SmartHostSMTPRelayingManager.html#maxConnections
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`.
- twisted.mail.relaymanager.SmartHostSMTPRelayingManager.maxMessagesPerConnection
  twisted.mail.relaymanager.SmartHostSMTPRelayingManager.html#maxMessagesPerConnection
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`.
- twisted.mail.relaymanager.SmartHostSMTPRelayingManager.fArgs
  twisted.mail.relaymanager.SmartHostSMTPRelayingManager.html#fArgs
  Attribute
  Instance Variable
  PUBLIC
  Positional arguments for `SMTPManagedRelayerFactory.__init__`.
- twisted.mail.relaymanager.SmartHostSMTPRelayingManager.fKwArgs
  twisted.mail.relaymanager.SmartHostSMTPRelayingManager.html#fKwArgs
  Attribute
  Instance Variable
  PUBLIC
  Keyword arguments for `SMTPManagedRelayerFactory.__init__`.
- twisted.mail.relaymanager.SmartHostSMTPRelayingManager.factory
  twisted.mail.relaymanager.SmartHostSMTPRelayingManager.html#factory
  Attribute
  Instance Variable
  PUBLIC
  A callable which creates a factory for creating a managed relayer. See `SMTPManagedRelayerFactory.__init__` for parameters to the callable.
- twisted.mail.relaymanager.SmartHostSMTPRelayingManager.PORT
  twisted.mail.relaymanager.SmartHostSMTPRelayingManager.html#PORT
  Attribute
  Constant
  PUBLIC
  The port over which to connect to the SMTP server.
- twisted.mail.relaymanager.SmartHostSMTPRelayingManager.mxcalc
  twisted.mail.relaymanager.SmartHostSMTPRelayingManager.html#mxcalc
  Attribute
  Instance Variable
  PUBLIC
  A resource for mail exchange host lookups.
- twisted.mail.relaymanager.SmartHostSMTPRelayingManager.managed
  twisted.mail.relaymanager.SmartHostSMTPRelayingManager.html#managed
  Attribute
  Instance Variable
  PUBLIC
  A mapping of factory for a managed relayer to filenames of messages the managed relayer is responsible for.
- twisted.mail.relaymanager.SmartHostSMTPRelayingManager.__init__
  twisted.mail.relaymanager.SmartHostSMTPRelayingManager.html#__init__
  Function
  Method
  PUBLIC
  Initialize a smart host.
- twisted.mail.relaymanager.SmartHostSMTPRelayingManager.__getstate__
  twisted.mail.relaymanager.SmartHostSMTPRelayingManager.html#__getstate__
  Function
  Method
  PUBLIC
  Create a representation of the non-volatile state of this object.
- twisted.mail.relaymanager.SmartHostSMTPRelayingManager.__setstate__
  twisted.mail.relaymanager.SmartHostSMTPRelayingManager.html#__setstate__
  Function
  Method
  PUBLIC
  Restore the non-volatile state of this object and recreate the volatile state.
- twisted.mail.relaymanager.SmartHostSMTPRelayingManager.checkState
  twisted.mail.relaymanager.SmartHostSMTPRelayingManager.html#checkState
  Function
  Method
  PUBLIC
  Check the state of the relay queue and, if possible, launch relayers to handle waiting messages.
- twisted.mail.relaymanager.SmartHostSMTPRelayingManager._checkStateMX
  twisted.mail.relaymanager.SmartHostSMTPRelayingManager.html#_checkStateMX
  Function
  Method
  PRIVATE
  Undocumented
- twisted.mail.relaymanager.SmartHostSMTPRelayingManager._cbExchange
  twisted.mail.relaymanager.SmartHostSMTPRelayingManager.html#_cbExchange
  Function
  Method
  PRIVATE
  Initiate a connection with a mail exchange server.
- twisted.mail.relaymanager.SmartHostSMTPRelayingManager._ebExchange
  twisted.mail.relaymanager.SmartHostSMTPRelayingManager.html#_ebExchange
  Function
  Method
  PRIVATE
  Prepare to resend messages later.
- twisted.mail.relaymanager.SmartHostESMTPRelayingManager
  twisted.mail.relaymanager.SmartHostESMTPRelayingManager.html
  Class
  Class
  PUBLIC
  A smart host which uses ESMTP managed relayers to send messages from the relay queue.
- twisted.mail.relaymanager.SmartHostESMTPRelayingManager.factory
  twisted.mail.relaymanager.SmartHostESMTPRelayingManager.html#factory
  Attribute
  Instance Variable
  PUBLIC
  A callable which creates a factory for creating a managed relayer. See `ESMTPManagedRelayerFactory.__init__` for parameters to the callable.
- twisted.mail.relaymanager._checkState
  twisted.mail.relaymanager.html#_checkState
  Function
  Function
  PRIVATE
  Prompt a relaying manager to check state.
- twisted.mail.relaymanager.RelayStateHelper
  twisted.mail.relaymanager.html#RelayStateHelper
  Function
  Function
  PUBLIC
  Set up a periodic call to prompt a relaying manager to check state.
- twisted.mail.relaymanager.CanonicalNameLoop
  twisted.mail.relaymanager.CanonicalNameLoop.html
  Class
  Exception
  PUBLIC
  An error indicating that when trying to look up a mail exchange host, a set of canonical name records was found which form a cycle and resolution was abandoned.
- twisted.mail.relaymanager.CanonicalNameChainTooLong
  twisted.mail.relaymanager.CanonicalNameChainTooLong.html
  Class
  Exception
  PUBLIC
  An error indicating that when trying to look up a mail exchange host, too many canonical name records which point to other canonical name records were encountered and resolution was abandoned.
- twisted.mail.relaymanager.MXCalculator
  twisted.mail.relaymanager.MXCalculator.html
  Class
  Class
  PUBLIC
  A utility for looking up mail exchange hosts and tracking whether they are working or not.
- twisted.mail.relaymanager.MXCalculator.clock
  twisted.mail.relaymanager.MXCalculator.html#clock
  Attribute
  Instance Variable
  PUBLIC
  A reactor which will be used to schedule timeouts.
- twisted.mail.relaymanager.MXCalculator.resolver
  twisted.mail.relaymanager.MXCalculator.html#resolver
  Attribute
  Instance Variable
  PUBLIC
  A resolver.
- twisted.mail.relaymanager.MXCalculator.badMXs
  twisted.mail.relaymanager.MXCalculator.html#badMXs
  Attribute
  Instance Variable
  PUBLIC
  A mapping of non-functioning mail exchange hostname to time at which another attempt at contacting it may be made.
- twisted.mail.relaymanager.MXCalculator.timeOutBadMX
  twisted.mail.relaymanager.MXCalculator.html#timeOutBadMX
  Attribute
  Instance Variable
  PUBLIC
  Period in seconds between attempts to contact a non-functioning mail exchange host.
- twisted.mail.relaymanager.MXCalculator.fallbackToDomain
  twisted.mail.relaymanager.MXCalculator.html#fallbackToDomain
  Attribute
  Instance Variable
  PUBLIC
  A flag indicating whether to attempt to use the hostname directly when no mail exchange can be found (`True`) or not (`False`).
- twisted.mail.relaymanager.MXCalculator.__init__
  twisted.mail.relaymanager.MXCalculator.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.mail.relaymanager.MXCalculator.markBad
  twisted.mail.relaymanager.MXCalculator.html#markBad
  Function
  Method
  PUBLIC
  Record that a mail exchange host is not currently functioning.
- twisted.mail.relaymanager.MXCalculator.markGood
  twisted.mail.relaymanager.MXCalculator.html#markGood
  Function
  Method
  PUBLIC
  Record that a mail exchange host is functioning.
- twisted.mail.relaymanager.MXCalculator.getMX
  twisted.mail.relaymanager.MXCalculator.html#getMX
  Function
  Method
  PUBLIC
  Find the name of a host that acts as a mail exchange server for a domain.
- twisted.mail.relaymanager.MXCalculator._filterRecords
  twisted.mail.relaymanager.MXCalculator.html#_filterRecords
  Function
  Method
  PRIVATE
  Organize the records of a DNS response by record name.
- twisted.mail.relaymanager.MXCalculator._cbMX
  twisted.mail.relaymanager.MXCalculator.html#_cbMX
  Function
  Method
  PRIVATE
  Try to find the mail exchange host for a domain from the given DNS records.
- twisted.mail.relaymanager.MXCalculator._ebMX
  twisted.mail.relaymanager.MXCalculator.html#_ebMX
  Function
  Method
  PRIVATE
  Attempt to use the name of the domain directly when mail exchange lookup fails.
- twisted.mail.scripts.mailmail.GLOBAL_CFG
  twisted.mail.scripts.mailmail.html#GLOBAL_CFG
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.mail.scripts.mailmail.LOCAL_CFG
  twisted.mail.scripts.mailmail.html#LOCAL_CFG
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.mail.scripts.mailmail.SMARTHOST
  twisted.mail.scripts.mailmail.html#SMARTHOST
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.mail.scripts.mailmail.ERROR_FMT
  twisted.mail.scripts.mailmail.html#ERROR_FMT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.mail.scripts.mailmail._logObserver
  twisted.mail.scripts.mailmail.html#_logObserver
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.mail.scripts.mailmail._log
  twisted.mail.scripts.mailmail.html#_log
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.mail.scripts.mailmail.Options
  twisted.mail.scripts.mailmail.Options.html
  Class
  Class
  PUBLIC
  Store the values of the parsed command-line options to the mailmail script.
- twisted.mail.scripts.mailmail.Options.to
  twisted.mail.scripts.mailmail.Options.html#to
  Attribute
  Instance Variable
  PUBLIC
  The addresses to which to deliver this message.
- twisted.mail.scripts.mailmail.Options.sender
  twisted.mail.scripts.mailmail.Options.html#sender
  Attribute
  Instance Variable
  PUBLIC
  The address from which this message is being sent.
- twisted.mail.scripts.mailmail.Options.body
  twisted.mail.scripts.mailmail.Options.html#body
  Attribute
  Instance Variable
  PUBLIC
  The object from which the message is to be read.
- twisted.mail.scripts.mailmail.getlogin
  twisted.mail.scripts.mailmail.html#getlogin
  Function
  Function
  PUBLIC
  Undocumented
- twisted.mail.scripts.mailmail._unsupportedOption
  twisted.mail.scripts.mailmail.html#_unsupportedOption
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.mail.scripts.mailmail.parseOptions
  twisted.mail.scripts.mailmail.html#parseOptions
  Function
  Function
  PUBLIC
  Undocumented
- twisted.mail.scripts.mailmail.Configuration
  twisted.mail.scripts.mailmail.Configuration.html
  Class
  Class
  PUBLIC
  No summary
- twisted.mail.scripts.mailmail.Configuration.allowUIDs
  twisted.mail.scripts.mailmail.Configuration.html#allowUIDs
  Attribute
  Instance Variable
  PUBLIC
  A list of UIDs which are allowed to send mail.
- twisted.mail.scripts.mailmail.Configuration.allowGIDs
  twisted.mail.scripts.mailmail.Configuration.html#allowGIDs
  Attribute
  Instance Variable
  PUBLIC
  A list of GIDs which are allowed to send mail.
- twisted.mail.scripts.mailmail.Configuration.denyUIDs
  twisted.mail.scripts.mailmail.Configuration.html#denyUIDs
  Attribute
  Instance Variable
  PUBLIC
  A list of UIDs which are not allowed to send mail.
- twisted.mail.scripts.mailmail.Configuration.denyGIDs
  twisted.mail.scripts.mailmail.Configuration.html#denyGIDs
  Attribute
  Instance Variable
  PUBLIC
  A list of GIDs which are not allowed to send mail.
- twisted.mail.scripts.mailmail.Configuration.defaultAccess
  twisted.mail.scripts.mailmail.Configuration.html#defaultAccess
  Attribute
  Instance Variable
  PUBLIC
  `True` if access will be allowed when no other access control rule matches or `False` if it will be denied in that case.
- twisted.mail.scripts.mailmail.Configuration.useraccess
  twisted.mail.scripts.mailmail.Configuration.html#useraccess
  Attribute
  Instance Variable
  PUBLIC
  Either `'allow'` to check `allowUID` first or `'deny'` to check `denyUID` first.
- twisted.mail.scripts.mailmail.Configuration.groupaccess
  twisted.mail.scripts.mailmail.Configuration.html#groupaccess
  Attribute
  Instance Variable
  PUBLIC
  Either `'allow'` to check `allowGID` first or `'deny'` to check `denyGID` first.
- twisted.mail.scripts.mailmail.Configuration.identities
  twisted.mail.scripts.mailmail.Configuration.html#identities
  Attribute
  Instance Variable
  PUBLIC
  A `dict` mapping hostnames to credentials to use when sending mail to that host.
- twisted.mail.scripts.mailmail.Configuration.smarthost
  twisted.mail.scripts.mailmail.Configuration.html#smarthost
  Attribute
  Instance Variable
  PUBLIC
  `None` or a hostname through which all outgoing mail will be sent.
- twisted.mail.scripts.mailmail.Configuration.domain
  twisted.mail.scripts.mailmail.Configuration.html#domain
  Attribute
  Instance Variable
  PUBLIC
  `None` or the hostname with which to identify ourselves when connecting to an MTA.
- twisted.mail.scripts.mailmail.Configuration.__init__
  twisted.mail.scripts.mailmail.Configuration.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.mail.scripts.mailmail.loadConfig
  twisted.mail.scripts.mailmail.html#loadConfig
  Function
  Function
  PUBLIC
  Undocumented
- twisted.mail.scripts.mailmail.success
  twisted.mail.scripts.mailmail.html#success
  Function
  Function
  PUBLIC
  Undocumented
- twisted.mail.scripts.mailmail.failed
  twisted.mail.scripts.mailmail.html#failed
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.mail.scripts.mailmail.failure
  twisted.mail.scripts.mailmail.html#failure
  Function
  Function
  PUBLIC
  Undocumented
- twisted.mail.scripts.mailmail.sendmail
  twisted.mail.scripts.mailmail.html#sendmail
  Function
  Function
  PUBLIC
  Undocumented
- twisted.mail.scripts.mailmail.senderror
  twisted.mail.scripts.mailmail.html#senderror
  Function
  Function
  PUBLIC
  Undocumented
- twisted.mail.scripts.mailmail.deny
  twisted.mail.scripts.mailmail.html#deny
  Function
  Function
  PUBLIC
  Undocumented
- twisted.mail.scripts.mailmail.run
  twisted.mail.scripts.mailmail.html#run
  Function
  Function
  PUBLIC
  Undocumented
- twisted.mail.tap.Options
  twisted.mail.tap.Options.html
  Class
  Class
  PUBLIC
  An options list parser for twistd mail.
- twisted.mail.tap.Options.synopsis
  twisted.mail.tap.Options.html#synopsis
  Attribute
  Instance Variable
  PUBLIC
  A description of options for use in the usage message.
- twisted.mail.tap.Options.optParameters
  twisted.mail.tap.Options.html#optParameters
  Attribute
  Instance Variable
  PUBLIC
  Information about supported parameters. See `Options` for details.
- twisted.mail.tap.Options.optFlags
  twisted.mail.tap.Options.html#optFlags
  Attribute
  Instance Variable
  PUBLIC
  Information about supported flags. See `Options` for details.
- twisted.mail.tap.Options._protoDefaults
  twisted.mail.tap.Options.html#_protoDefaults
  Attribute
  Instance Variable
  PRIVATE
  A mapping of default service to port.
- twisted.mail.tap.Options.compData
  twisted.mail.tap.Options.html#compData
  Attribute
  Instance Variable
  PUBLIC
  Metadata for the shell tab completion system.
- twisted.mail.tap.Options.longdesc
  twisted.mail.tap.Options.html#longdesc
  Attribute
  Instance Variable
  PUBLIC
  A long description of the plugin for use in the usage message.
- twisted.mail.tap.Options.service
  twisted.mail.tap.Options.html#service
  Attribute
  Instance Variable
  PUBLIC
  The email service.
- twisted.mail.tap.Options.last_domain
  twisted.mail.tap.Options.html#last_domain
  Attribute
  Instance Variable
  PUBLIC
  The most recently specified domain.
- twisted.mail.tap.Options.__init__
  twisted.mail.tap.Options.html#__init__
  Function
  Method
  PUBLIC
  Parse options and create a mail service.
- twisted.mail.tap.Options.addEndpoint
  twisted.mail.tap.Options.html#addEndpoint
  Function
  Method
  PUBLIC
  Add an endpoint to a service.
- twisted.mail.tap.Options.opt_pop3
  twisted.mail.tap.Options.html#opt_pop3
  Function
  Method
  PUBLIC
  Add a POP3 port listener on the specified endpoint.
- twisted.mail.tap.Options.opt_smtp
  twisted.mail.tap.Options.html#opt_smtp
  Function
  Method
  PUBLIC
  Add an SMTP port listener on the specified endpoint.
- twisted.mail.tap.Options.opt_default
  twisted.mail.tap.Options.html#opt_default
  Function
  Method
  PUBLIC
  Make the most recently specified domain the default domain.
- twisted.mail.tap.Options.opt_maildirdbmdomain
  twisted.mail.tap.Options.html#opt_maildirdbmdomain
  Function
  Method
  PUBLIC
  Generate an SMTP/POP3 virtual domain.
- twisted.mail.tap.Options.opt_user
  twisted.mail.tap.Options.html#opt_user
  Function
  Method
  PUBLIC
  Add a user and password to the last specified domain.
- twisted.mail.tap.Options.opt_bounce_to_postmaster
  twisted.mail.tap.Options.html#opt_bounce_to_postmaster
  Function
  Method
  PUBLIC
  Send undeliverable messages to the postmaster.
- twisted.mail.tap.Options.opt_aliases
  twisted.mail.tap.Options.html#opt_aliases
  Function
  Method
  PUBLIC
  Specify an aliases(5) file to use for the last specified domain.
- twisted.mail.tap.Options._getEndpoints
  twisted.mail.tap.Options.html#_getEndpoints
  Function
  Method
  PRIVATE
  Return a list of endpoints for the specified service, constructing defaults if necessary.
- twisted.mail.tap.Options.postOptions
  twisted.mail.tap.Options.html#postOptions
  Function
  Method
  PUBLIC
  Check the validity of the specified set of options and configure authentication.
- twisted.mail.tap.AliasUpdater
  twisted.mail.tap.AliasUpdater.html
  Class
  Class
  PUBLIC
  A callable object which updates the aliases for a domain from an aliases(5) file.
- twisted.mail.tap.AliasUpdater.domains
  twisted.mail.tap.AliasUpdater.html#domains
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`.
- twisted.mail.tap.AliasUpdater.domain
  twisted.mail.tap.AliasUpdater.html#domain
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`.
- twisted.mail.tap.AliasUpdater.__init__
  twisted.mail.tap.AliasUpdater.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.mail.tap.AliasUpdater.__call__
  twisted.mail.tap.AliasUpdater.html#__call__
  Function
  Method
  PUBLIC
  Update the aliases for a domain from an aliases(5) file.
- twisted.mail.tap.makeService
  twisted.mail.tap.html#makeService
  Function
  Function
  PUBLIC
  Configure a service for operating a mail server.
- twisted.names.common._ANS
  twisted.names.common.html#_ANS
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.names.common._AUTH
  twisted.names.common.html#_AUTH
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.names.common._ADD
  twisted.names.common.html#_ADD
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.names.common.EMPTY_RESULT
  twisted.names.common.html#EMPTY_RESULT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.names.common.ResolverBase
  twisted.names.common.ResolverBase.html
  Class
  Class
  PUBLIC
  `ResolverBase` is a base class for implementations of `interfaces.IResolver` which deals with a lot of the boilerplate of implementing all of the lookup methods.
- twisted.names.common.ResolverBase._errormap
  twisted.names.common.ResolverBase.html#_errormap
  Attribute
  Class Variable
  PRIVATE
  A `dict` mapping DNS protocol failure response codes to exception classes which will be used to represent those failures.
- twisted.names.common.ResolverBase._log
  twisted.names.common.ResolverBase.html#_log
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.names.common.ResolverBase.typeToMethod
  twisted.names.common.ResolverBase.html#typeToMethod
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.common.ResolverBase.__init__
  twisted.names.common.ResolverBase.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.common.ResolverBase.exceptionForCode
  twisted.names.common.ResolverBase.html#exceptionForCode
  Function
  Method
  PUBLIC
  Convert a response code (one of the possible values of `dns.Message.rCode` to an exception instance representing it.
- twisted.names.common.ResolverBase.query
  twisted.names.common.ResolverBase.html#query
  Function
  Method
  PUBLIC
  Dispatch `query` to the method which can handle its type.
- twisted.names.common.ResolverBase._lookup
  twisted.names.common.ResolverBase.html#_lookup
  Function
  Method
  PRIVATE
  Undocumented
- twisted.names.common.ResolverBase.lookupAddress
  twisted.names.common.ResolverBase.html#lookupAddress
  Function
  Method
  PUBLIC
  Perform an A record lookup.
- twisted.names.common.ResolverBase.lookupIPV6Address
  twisted.names.common.ResolverBase.html#lookupIPV6Address
  Function
  Method
  PUBLIC
  Perform an AAAA record lookup.
- twisted.names.common.ResolverBase.lookupAddress6
  twisted.names.common.ResolverBase.html#lookupAddress6
  Function
  Method
  PUBLIC
  Perform an A6 record lookup.
- twisted.names.common.ResolverBase.lookupMailExchange
  twisted.names.common.ResolverBase.html#lookupMailExchange
  Function
  Method
  PUBLIC
  Perform an MX record lookup.
- twisted.names.common.ResolverBase.lookupNameservers
  twisted.names.common.ResolverBase.html#lookupNameservers
  Function
  Method
  PUBLIC
  Perform an NS record lookup.
- twisted.names.common.ResolverBase.lookupCanonicalName
  twisted.names.common.ResolverBase.html#lookupCanonicalName
  Function
  Method
  PUBLIC
  Perform a CNAME record lookup.
- twisted.names.common.ResolverBase.lookupMailBox
  twisted.names.common.ResolverBase.html#lookupMailBox
  Function
  Method
  PUBLIC
  Perform an MB record lookup.
- twisted.names.common.ResolverBase.lookupMailGroup
  twisted.names.common.ResolverBase.html#lookupMailGroup
  Function
  Method
  PUBLIC
  Perform an MG record lookup.
- twisted.names.common.ResolverBase.lookupMailRename
  twisted.names.common.ResolverBase.html#lookupMailRename
  Function
  Method
  PUBLIC
  Perform an MR record lookup.
- twisted.names.common.ResolverBase.lookupPointer
  twisted.names.common.ResolverBase.html#lookupPointer
  Function
  Method
  PUBLIC
  Perform a PTR record lookup.
- twisted.names.common.ResolverBase.lookupAuthority
  twisted.names.common.ResolverBase.html#lookupAuthority
  Function
  Method
  PUBLIC
  Perform an SOA record lookup.
- twisted.names.common.ResolverBase.lookupNull
  twisted.names.common.ResolverBase.html#lookupNull
  Function
  Method
  PUBLIC
  Perform a NULL record lookup.
- twisted.names.common.ResolverBase.lookupWellKnownServices
  twisted.names.common.ResolverBase.html#lookupWellKnownServices
  Function
  Method
  PUBLIC
  Perform a WKS record lookup.
- twisted.names.common.ResolverBase.lookupService
  twisted.names.common.ResolverBase.html#lookupService
  Function
  Method
  PUBLIC
  Perform an SRV record lookup.
- twisted.names.common.ResolverBase.lookupHostInfo
  twisted.names.common.ResolverBase.html#lookupHostInfo
  Function
  Method
  PUBLIC
  Perform a HINFO record lookup.
- twisted.names.common.ResolverBase.lookupMailboxInfo
  twisted.names.common.ResolverBase.html#lookupMailboxInfo
  Function
  Method
  PUBLIC
  Perform an MINFO record lookup.
- twisted.names.common.ResolverBase.lookupText
  twisted.names.common.ResolverBase.html#lookupText
  Function
  Method
  PUBLIC
  Perform a TXT record lookup.
- twisted.names.common.ResolverBase.lookupSenderPolicy
  twisted.names.common.ResolverBase.html#lookupSenderPolicy
  Function
  Method
  PUBLIC
  Perform a SPF record lookup.
- twisted.names.common.ResolverBase.lookupResponsibility
  twisted.names.common.ResolverBase.html#lookupResponsibility
  Function
  Method
  PUBLIC
  Perform an RP record lookup.
- twisted.names.common.ResolverBase.lookupAFSDatabase
  twisted.names.common.ResolverBase.html#lookupAFSDatabase
  Function
  Method
  PUBLIC
  Perform an AFSDB record lookup.
- twisted.names.common.ResolverBase.lookupZone
  twisted.names.common.ResolverBase.html#lookupZone
  Function
  Method
  PUBLIC
  Perform an AXFR record lookup.
- twisted.names.common.ResolverBase.lookupNamingAuthorityPointer
  twisted.names.common.ResolverBase.html#lookupNamingAuthorityPointer
  Function
  Method
  PUBLIC
  Perform a NAPTR record lookup.
- twisted.names.common.ResolverBase.lookupAllRecords
  twisted.names.common.ResolverBase.html#lookupAllRecords
  Function
  Method
  PUBLIC
  Perform an ALL_RECORD lookup.
- twisted.names.common.ResolverBase.getHostByName
  twisted.names.common.ResolverBase.html#getHostByName
  Function
  Method
  PUBLIC
  Resolve the domain name `name` into an IP address.
- twisted.names.common.ResolverBase._cbRecords
  twisted.names.common.ResolverBase.html#_cbRecords
  Function
  Method
  PRIVATE
  Undocumented
- twisted.names.common.extractRecord
  twisted.names.common.html#extractRecord
  Function
  Function
  PUBLIC
  Resolve a name to an IP address, following CNAME records and NS referrals recursively.
- twisted.names.common.typeToMethod
  twisted.names.common.html#typeToMethod
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.names.cache.CacheResolver
  twisted.names.cache.CacheResolver.html
  Class
  Class
  PUBLIC
  A resolver that serves records from a local, memory cache.
- twisted.names.cache.CacheResolver._reactor
  twisted.names.cache.CacheResolver.html#_reactor
  Attribute
  Instance Variable
  PRIVATE
  A provider of `interfaces.IReactorTime`.
- twisted.names.cache.CacheResolver.cache
  twisted.names.cache.CacheResolver.html#cache
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.cache.CacheResolver.__init__
  twisted.names.cache.CacheResolver.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.cache.CacheResolver.verbose
  twisted.names.cache.CacheResolver.html#verbose
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.cache.CacheResolver.cancel
  twisted.names.cache.CacheResolver.html#cancel
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.cache.CacheResolver.__setstate__
  twisted.names.cache.CacheResolver.html#__setstate__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.cache.CacheResolver.__dict__
  twisted.names.cache.CacheResolver.html#__dict__
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.cache.CacheResolver.__getstate__
  twisted.names.cache.CacheResolver.html#__getstate__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.cache.CacheResolver._lookup
  twisted.names.cache.CacheResolver.html#_lookup
  Function
  Method
  PRIVATE
  Undocumented
- twisted.names.cache.CacheResolver.lookupAllRecords
  twisted.names.cache.CacheResolver.html#lookupAllRecords
  Function
  Method
  PUBLIC
  Perform an ALL_RECORD lookup.
- twisted.names.cache.CacheResolver.cacheResult
  twisted.names.cache.CacheResolver.html#cacheResult
  Function
  Method
  PUBLIC
  Cache a DNS entry.
- twisted.names.cache.CacheResolver.clearEntry
  twisted.names.cache.CacheResolver.html#clearEntry
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.hosts.searchFileForAll
  twisted.names.hosts.html#searchFileForAll
  Function
  Function
  PUBLIC
  Search the given file, which is in hosts(5) standard format, for addresses associated with a given name.
- twisted.names.hosts.searchFileFor
  twisted.names.hosts.html#searchFileFor
  Function
  Function
  PUBLIC
  Grep given file, which is in hosts(5) standard format, for an address entry with a given name.
- twisted.names.hosts.Resolver
  twisted.names.hosts.Resolver.html
  Class
  Class
  PUBLIC
  A resolver that services hosts(5) format files.
- twisted.names.hosts.Resolver.__init__
  twisted.names.hosts.Resolver.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.hosts.Resolver.file
  twisted.names.hosts.Resolver.html#file
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.hosts.Resolver.ttl
  twisted.names.hosts.Resolver.html#ttl
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.hosts.Resolver._aRecords
  twisted.names.hosts.Resolver.html#_aRecords
  Function
  Method
  PRIVATE
  Return a tuple of `dns.RRHeader` instances for all of the IPv4 addresses in the hosts file.
- twisted.names.hosts.Resolver._aaaaRecords
  twisted.names.hosts.Resolver.html#_aaaaRecords
  Function
  Method
  PRIVATE
  Return a tuple of `dns.RRHeader` instances for all of the IPv6 addresses in the hosts file.
- twisted.names.hosts.Resolver._respond
  twisted.names.hosts.Resolver.html#_respond
  Function
  Method
  PRIVATE
  Generate a response for the given name containing the given result records, or a failure if there are no result records.
- twisted.names.hosts.Resolver.lookupAddress
  twisted.names.hosts.Resolver.html#lookupAddress
  Function
  Method
  PUBLIC
  Read any IPv4 addresses from `self.file` and return them as `Record_A` instances.
- twisted.names.hosts.Resolver.lookupIPV6Address
  twisted.names.hosts.Resolver.html#lookupIPV6Address
  Function
  Method
  PUBLIC
  Read any IPv6 addresses from `self.file` and return them as `Record_AAAA` instances.
- twisted.names.resolve.FailureHandler
  twisted.names.resolve.FailureHandler.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.names.resolve.FailureHandler.__init__
  twisted.names.resolve.FailureHandler.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.resolve.FailureHandler.resolver
  twisted.names.resolve.FailureHandler.html#resolver
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.resolve.FailureHandler.query
  twisted.names.resolve.FailureHandler.html#query
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.resolve.FailureHandler.timeout
  twisted.names.resolve.FailureHandler.html#timeout
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.resolve.FailureHandler.__call__
  twisted.names.resolve.FailureHandler.html#__call__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.resolve.ResolverChain
  twisted.names.resolve.ResolverChain.html
  Class
  Class
  PUBLIC
  Lookup an address using multiple `IResolver`s
- twisted.names.resolve.ResolverChain.__init__
  twisted.names.resolve.ResolverChain.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.names.resolve.ResolverChain.resolvers
  twisted.names.resolve.ResolverChain.html#resolvers
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.resolve.ResolverChain._lookup
  twisted.names.resolve.ResolverChain.html#_lookup
  Function
  Method
  PRIVATE
  Build a `dns.Query` for the given parameters and dispatch it to each `IResolver` in `self.resolvers` until an answer or `error.AuthoritativeDomainError` is returned.
- twisted.names.resolve.ResolverChain.lookupAllRecords
  twisted.names.resolve.ResolverChain.html#lookupAllRecords
  Function
  Method
  PUBLIC
  Perform an ALL_RECORD lookup.
- twisted.names.root._DummyController
  twisted.names.root._DummyController.html
  Class
  Class
  PRIVATE
  A do-nothing DNS controller. This is useful when all messages received will be responses to previously issued queries. Anything else received will be ignored.
- twisted.names.root._DummyController.messageReceived
  twisted.names.root._DummyController.html#messageReceived
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.root.Resolver
  twisted.names.root.Resolver.html
  Class
  Class
  PUBLIC
  `Resolver` implements recursive lookup starting from a specified list of root servers.
- twisted.names.root.Resolver.hints
  twisted.names.root.Resolver.html#hints
  Attribute
  Instance Variable
  PUBLIC
  See `hints` parameter of `__init__`
- twisted.names.root.Resolver._maximumQueries
  twisted.names.root.Resolver.html#_maximumQueries
  Attribute
  Instance Variable
  PRIVATE
  See `maximumQueries` parameter of `__init__`
- twisted.names.root.Resolver._reactor
  twisted.names.root.Resolver.html#_reactor
  Attribute
  Instance Variable
  PRIVATE
  See `reactor` parameter of `__init__`
- twisted.names.root.Resolver._resolverFactory
  twisted.names.root.Resolver.html#_resolverFactory
  Attribute
  Instance Variable
  PRIVATE
  See `resolverFactory` parameter of `__init__`
- twisted.names.root.Resolver.__init__
  twisted.names.root.Resolver.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.names.root.Resolver._roots
  twisted.names.root.Resolver.html#_roots
  Function
  Method
  PRIVATE
  Return a list of two-tuples representing the addresses of the root servers, as defined by `self.hints`.
- twisted.names.root.Resolver._query
  twisted.names.root.Resolver.html#_query
  Function
  Method
  PRIVATE
  Issue one query and return a `Deferred` which fires with its response.
- twisted.names.root.Resolver._lookup
  twisted.names.root.Resolver.html#_lookup
  Function
  Method
  PRIVATE
  Implement name lookup by recursively discovering the authoritative server for the name and then asking it, starting at one of the servers in `self.hints`.
- twisted.names.root.Resolver._discoverAuthority
  twisted.names.root.Resolver.html#_discoverAuthority
  Function
  Method
  PRIVATE
  Issue a query to a server and follow a delegation if necessary.
- twisted.names.root.Resolver._discoveredAuthority
  twisted.names.root.Resolver.html#_discoveredAuthority
  Function
  Method
  PRIVATE
  Interpret the response to a query, checking for error codes and following delegations if necessary.
- twisted.names.root.makePlaceholder
  twisted.names.root.html#makePlaceholder
  Function
  Function
  PUBLIC
  Undocumented
- twisted.names.root.DeferredResolver
  twisted.names.root.DeferredResolver.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.names.root.DeferredResolver.__init__
  twisted.names.root.DeferredResolver.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.root.DeferredResolver.waiting
  twisted.names.root.DeferredResolver.html#waiting
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.root.DeferredResolver.gotRealResolver
  twisted.names.root.DeferredResolver.html#gotRealResolver
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.root.DeferredResolver.__dict__
  twisted.names.root.DeferredResolver.html#__dict__
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.root.DeferredResolver.__class__
  twisted.names.root.DeferredResolver.html#__class__
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.root.DeferredResolver.__getattr__
  twisted.names.root.DeferredResolver.html#__getattr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.root.bootstrap
  twisted.names.root.html#bootstrap
  Function
  Function
  PUBLIC
  Lookup the root nameserver addresses using the given resolver
- twisted.names.client.Resolver
  twisted.names.client.Resolver.html
  Class
  Class
  PUBLIC
  No summary
- twisted.names.client.Resolver._waiting
  twisted.names.client.Resolver.html#_waiting
  Attribute
  Instance Variable
  PRIVATE
  A `dict` mapping tuple keys of query name/type/class to Deferreds which will be called back with the result of those queries. This is used to avoid issuing the same query more than once in parallel. This is more efficient on the network and helps avoid a "birthday paradox" attack by keeping the number of outstanding requests for a particular query fixed at one instead of allowing the attacker to raise it to an arbitrary number.
- twisted.names.client.Resolver._reactor
  twisted.names.client.Resolver.html#_reactor
  Attribute
  Instance Variable
  PRIVATE
  A provider of `IReactorTCP`, `IReactorUDP`, and `IReactorTime` which will be used to set up network resources and track timeouts.
- twisted.names.client.Resolver.index
  twisted.names.client.Resolver.html#index
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.client.Resolver.timeout
  twisted.names.client.Resolver.html#timeout
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.client.Resolver.factory
  twisted.names.client.Resolver.html#factory
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.client.Resolver.servers
  twisted.names.client.Resolver.html#servers
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.client.Resolver.dynServers
  twisted.names.client.Resolver.html#dynServers
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.client.Resolver.pending
  twisted.names.client.Resolver.html#pending
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.client.Resolver.connections
  twisted.names.client.Resolver.html#connections
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.client.Resolver.resolv
  twisted.names.client.Resolver.html#resolv
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.client.Resolver._lastResolvTime
  twisted.names.client.Resolver.html#_lastResolvTime
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.names.client.Resolver._resolvReadInterval
  twisted.names.client.Resolver.html#_resolvReadInterval
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.names.client.Resolver.__init__
  twisted.names.client.Resolver.html#__init__
  Function
  Method
  PUBLIC
  Construct a resolver which will query domain name servers listed in the `resolv.conf(5)`-format file given by `resolv` as well as those in the given `servers` list. Servers are queried in a round-robin fashion...
- twisted.names.client.Resolver.__getstate__
  twisted.names.client.Resolver.html#__getstate__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.client.Resolver.__setstate__
  twisted.names.client.Resolver.html#__setstate__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.client.Resolver._openFile
  twisted.names.client.Resolver.html#_openFile
  Function
  Method
  PRIVATE
  Wrapper used for opening files in the class, exists primarily for unit testing purposes.
- twisted.names.client.Resolver.maybeParseConfig
  twisted.names.client.Resolver.html#maybeParseConfig
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.client.Resolver._parseCall
  twisted.names.client.Resolver.html#_parseCall
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.names.client.Resolver.parseConfig
  twisted.names.client.Resolver.html#parseConfig
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.client.Resolver.pickServer
  twisted.names.client.Resolver.html#pickServer
  Function
  Method
  PUBLIC
  Return the address of a nameserver.
- twisted.names.client.Resolver._connectedProtocol
  twisted.names.client.Resolver.html#_connectedProtocol
  Function
  Method
  PRIVATE
  Return a new `DNSDatagramProtocol` bound to a randomly selected port number.
- twisted.names.client.Resolver.connectionMade
  twisted.names.client.Resolver.html#connectionMade
  Function
  Method
  PUBLIC
  Called by associated `dns.DNSProtocol` instances when they connect.
- twisted.names.client.Resolver.connectionLost
  twisted.names.client.Resolver.html#connectionLost
  Function
  Method
  PUBLIC
  Called by associated `dns.DNSProtocol` instances when they disconnect.
- twisted.names.client.Resolver.messageReceived
  twisted.names.client.Resolver.html#messageReceived
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.client.Resolver._query
  twisted.names.client.Resolver.html#_query
  Function
  Method
  PRIVATE
  Get a new `DNSDatagramProtocol` instance from `_connectedProtocol`, issue a query to it using `*args`, and arrange for it to be disconnected from its transport after the query completes.
- twisted.names.client.Resolver.queryUDP
  twisted.names.client.Resolver.html#queryUDP
  Function
  Method
  PUBLIC
  Make a number of DNS queries via UDP.
- twisted.names.client.Resolver._reissue
  twisted.names.client.Resolver.html#_reissue
  Function
  Method
  PRIVATE
  Undocumented
- twisted.names.client.Resolver.queryTCP
  twisted.names.client.Resolver.html#queryTCP
  Function
  Method
  PUBLIC
  Make a number of DNS queries via TCP.
- twisted.names.client.Resolver.filterAnswers
  twisted.names.client.Resolver.html#filterAnswers
  Function
  Method
  PUBLIC
  Extract results from the given message.
- twisted.names.client.Resolver._lookup
  twisted.names.client.Resolver.html#_lookup
  Function
  Method
  PRIVATE
  Build a `dns.Query` for the given parameters and dispatch it via UDP.
- twisted.names.client.Resolver.lookupZone
  twisted.names.client.Resolver.html#lookupZone
  Function
  Method
  PUBLIC
  Perform an AXFR record lookup.
- twisted.names.client.Resolver._timeoutZone
  twisted.names.client.Resolver.html#_timeoutZone
  Function
  Method
  PRIVATE
  Undocumented
- twisted.names.client.Resolver._cbLookupZone
  twisted.names.client.Resolver.html#_cbLookupZone
  Function
  Method
  PRIVATE
  Undocumented
- twisted.names.client.AXFRController
  twisted.names.client.AXFRController.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.names.client.AXFRController.timeoutCall
  twisted.names.client.AXFRController.html#timeoutCall
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.client.AXFRController.__init__
  twisted.names.client.AXFRController.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.client.AXFRController.name
  twisted.names.client.AXFRController.html#name
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.client.AXFRController.deferred
  twisted.names.client.AXFRController.html#deferred
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.client.AXFRController.soa
  twisted.names.client.AXFRController.html#soa
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.client.AXFRController.records
  twisted.names.client.AXFRController.html#records
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.client.AXFRController.pending
  twisted.names.client.AXFRController.html#pending
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.client.AXFRController.connectionMade
  twisted.names.client.AXFRController.html#connectionMade
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.client.AXFRController.connectionLost
  twisted.names.client.AXFRController.html#connectionLost
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.client.AXFRController.messageReceived
  twisted.names.client.AXFRController.html#messageReceived
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.client.ThreadedResolver
  twisted.names.client.ThreadedResolver.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.names.client.ThreadedResolver.__init__
  twisted.names.client.ThreadedResolver.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.client.DNSClientFactory
  twisted.names.client.DNSClientFactory.html
  Class
  Class
  PUBLIC
  No class docstring; 0/2 instance variable, 1/4 method documented
- twisted.names.client.DNSClientFactory.__init__
  twisted.names.client.DNSClientFactory.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.client.DNSClientFactory.controller
  twisted.names.client.DNSClientFactory.html#controller
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.client.DNSClientFactory.timeout
  twisted.names.client.DNSClientFactory.html#timeout
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.client.DNSClientFactory.clientConnectionLost
  twisted.names.client.DNSClientFactory.html#clientConnectionLost
  Function
  Method
  PUBLIC
  Called when an established connection is lost.
- twisted.names.client.DNSClientFactory.clientConnectionFailed
  twisted.names.client.DNSClientFactory.html#clientConnectionFailed
  Function
  Method
  PUBLIC
  Fail all pending TCP DNS queries if the TCP connection attempt fails.
- twisted.names.client.DNSClientFactory.buildProtocol
  twisted.names.client.DNSClientFactory.html#buildProtocol
  Function
  Method
  PUBLIC
  Create an instance of a subclass of Protocol.
- twisted.names.client.createResolver
  twisted.names.client.html#createResolver
  Function
  Function
  PUBLIC
  Create and return a Resolver.
- twisted.names.client.theResolver
  twisted.names.client.html#theResolver
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.names.client.getResolver
  twisted.names.client.html#getResolver
  Function
  Function
  PUBLIC
  Get a Resolver instance.
- twisted.names.client.getHostByName
  twisted.names.client.html#getHostByName
  Function
  Function
  PUBLIC
  Resolve a name to a valid ipv4 or ipv6 address.
- twisted.names.client.query
  twisted.names.client.html#query
  Function
  Function
  PUBLIC
  Dispatch `query` to the method which can handle its type.
- twisted.names.client.lookupAddress
  twisted.names.client.html#lookupAddress
  Function
  Function
  PUBLIC
  Perform an A record lookup.
- twisted.names.client.lookupIPV6Address
  twisted.names.client.html#lookupIPV6Address
  Function
  Function
  PUBLIC
  Perform an AAAA record lookup.
- twisted.names.client.lookupAddress6
  twisted.names.client.html#lookupAddress6
  Function
  Function
  PUBLIC
  Perform an A6 record lookup.
- twisted.names.client.lookupMailExchange
  twisted.names.client.html#lookupMailExchange
  Function
  Function
  PUBLIC
  Perform an MX record lookup.
- twisted.names.client.lookupNameservers
  twisted.names.client.html#lookupNameservers
  Function
  Function
  PUBLIC
  Perform an NS record lookup.
- twisted.names.client.lookupCanonicalName
  twisted.names.client.html#lookupCanonicalName
  Function
  Function
  PUBLIC
  Perform a CNAME record lookup.
- twisted.names.client.lookupMailBox
  twisted.names.client.html#lookupMailBox
  Function
  Function
  PUBLIC
  Perform an MB record lookup.
- twisted.names.client.lookupMailGroup
  twisted.names.client.html#lookupMailGroup
  Function
  Function
  PUBLIC
  Perform an MG record lookup.
- twisted.names.client.lookupMailRename
  twisted.names.client.html#lookupMailRename
  Function
  Function
  PUBLIC
  Perform an MR record lookup.
- twisted.names.client.lookupPointer
  twisted.names.client.html#lookupPointer
  Function
  Function
  PUBLIC
  Perform a PTR record lookup.
- twisted.names.client.lookupAuthority
  twisted.names.client.html#lookupAuthority
  Function
  Function
  PUBLIC
  Perform an SOA record lookup.
- twisted.names.client.lookupNull
  twisted.names.client.html#lookupNull
  Function
  Function
  PUBLIC
  Perform a NULL record lookup.
- twisted.names.client.lookupWellKnownServices
  twisted.names.client.html#lookupWellKnownServices
  Function
  Function
  PUBLIC
  Perform a WKS record lookup.
- twisted.names.client.lookupService
  twisted.names.client.html#lookupService
  Function
  Function
  PUBLIC
  Perform an SRV record lookup.
- twisted.names.client.lookupHostInfo
  twisted.names.client.html#lookupHostInfo
  Function
  Function
  PUBLIC
  Perform a HINFO record lookup.
- twisted.names.client.lookupMailboxInfo
  twisted.names.client.html#lookupMailboxInfo
  Function
  Function
  PUBLIC
  Perform an MINFO record lookup.
- twisted.names.client.lookupText
  twisted.names.client.html#lookupText
  Function
  Function
  PUBLIC
  Perform a TXT record lookup.
- twisted.names.client.lookupSenderPolicy
  twisted.names.client.html#lookupSenderPolicy
  Function
  Function
  PUBLIC
  Perform a SPF record lookup.
- twisted.names.client.lookupResponsibility
  twisted.names.client.html#lookupResponsibility
  Function
  Function
  PUBLIC
  Perform an RP record lookup.
- twisted.names.client.lookupAFSDatabase
  twisted.names.client.html#lookupAFSDatabase
  Function
  Function
  PUBLIC
  Perform an AFSDB record lookup.
- twisted.names.client.lookupZone
  twisted.names.client.html#lookupZone
  Function
  Function
  PUBLIC
  Perform an AXFR record lookup.
- twisted.names.client.lookupAllRecords
  twisted.names.client.html#lookupAllRecords
  Function
  Function
  PUBLIC
  Perform an ALL_RECORD lookup.
- twisted.names.client.lookupNamingAuthorityPointer
  twisted.names.client.html#lookupNamingAuthorityPointer
  Function
  Function
  PUBLIC
  Perform a NAPTR record lookup.
- twisted.names.server.DNSServerFactory
  twisted.names.server.DNSServerFactory.html
  Class
  Class
  PUBLIC
  Server factory and tracker for `DNSProtocol` connections. This class also provides records for responses to DNS queries.
- twisted.names.server.DNSServerFactory.cache
  twisted.names.server.DNSServerFactory.html#cache
  Attribute
  Instance Variable
  PUBLIC
  A `Cache` instance whose `cacheResult` method is called when a response is received from one of `clients`. Defaults to `None` if no caches are specified. See `caches` of `__init__` for more details.
- twisted.names.server.DNSServerFactory.canRecurse
  twisted.names.server.DNSServerFactory.html#canRecurse
  Attribute
  Instance Variable
  PUBLIC
  A flag indicating whether this server is capable of performing recursive DNS resolution.
- twisted.names.server.DNSServerFactory.resolver
  twisted.names.server.DNSServerFactory.html#resolver
  Attribute
  Instance Variable
  PUBLIC
  A `resolve.ResolverChain` containing an ordered list of `authorities`, `caches` and `clients` to which queries will be dispatched.
- twisted.names.server.DNSServerFactory.verbose
  twisted.names.server.DNSServerFactory.html#verbose
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`
- twisted.names.server.DNSServerFactory.connections
  twisted.names.server.DNSServerFactory.html#connections
  Attribute
  Instance Variable
  PUBLIC
  A list of all the connected `DNSProtocol` instances using this object as their controller.
- twisted.names.server.DNSServerFactory.protocol
  twisted.names.server.DNSServerFactory.html#protocol
  Attribute
  Instance Variable
  PUBLIC
  A callable used for building a DNS stream protocol. Called by `DNSServerFactory.buildProtocol` and passed the `DNSServerFactory` instance as the one and only positional argument. Defaults to `dns.DNSProtocol`...
- twisted.names.server.DNSServerFactory._messageFactory
  twisted.names.server.DNSServerFactory.html#_messageFactory
  Attribute
  Instance Variable
  PRIVATE
  A response message constructor with an initializer signature matching `dns.Message.__init__`.
- twisted.names.server.DNSServerFactory.__init__
  twisted.names.server.DNSServerFactory.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.names.server.DNSServerFactory._verboseLog
  twisted.names.server.DNSServerFactory.html#_verboseLog
  Function
  Method
  PRIVATE
  Log a message only if verbose logging is enabled.
- twisted.names.server.DNSServerFactory.buildProtocol
  twisted.names.server.DNSServerFactory.html#buildProtocol
  Function
  Method
  PUBLIC
  Create an instance of a subclass of Protocol.
- twisted.names.server.DNSServerFactory.connectionMade
  twisted.names.server.DNSServerFactory.html#connectionMade
  Function
  Method
  PUBLIC
  Track a newly connected `DNSProtocol`.
- twisted.names.server.DNSServerFactory.connectionLost
  twisted.names.server.DNSServerFactory.html#connectionLost
  Function
  Method
  PUBLIC
  Stop tracking a no-longer connected `DNSProtocol`.
- twisted.names.server.DNSServerFactory.sendReply
  twisted.names.server.DNSServerFactory.html#sendReply
  Function
  Method
  PUBLIC
  Send a response `message` to a given `address` via the supplied `protocol`.
- twisted.names.server.DNSServerFactory._responseFromMessage
  twisted.names.server.DNSServerFactory.html#_responseFromMessage
  Function
  Method
  PRIVATE
  Generate a `Message` instance suitable for use as the response to `message`.
- twisted.names.server.DNSServerFactory.gotResolverResponse
  twisted.names.server.DNSServerFactory.html#gotResolverResponse
  Function
  Method
  PUBLIC
  A callback used by `DNSServerFactory.handleQuery` for handling the deferred response from `self.resolver.query`.
- twisted.names.server.DNSServerFactory.gotResolverError
  twisted.names.server.DNSServerFactory.html#gotResolverError
  Function
  Method
  PUBLIC
  A callback used by `DNSServerFactory.handleQuery` for handling deferred errors from `self.resolver.query`.
- twisted.names.server.DNSServerFactory.handleQuery
  twisted.names.server.DNSServerFactory.html#handleQuery
  Function
  Method
  PUBLIC
  Called by `DNSServerFactory.messageReceived` when a query message is received.
- twisted.names.server.DNSServerFactory.handleInverseQuery
  twisted.names.server.DNSServerFactory.html#handleInverseQuery
  Function
  Method
  PUBLIC
  Called by `DNSServerFactory.messageReceived` when an inverse query message is received.
- twisted.names.server.DNSServerFactory.handleStatus
  twisted.names.server.DNSServerFactory.html#handleStatus
  Function
  Method
  PUBLIC
  Called by `DNSServerFactory.messageReceived` when a status message is received.
- twisted.names.server.DNSServerFactory.handleNotify
  twisted.names.server.DNSServerFactory.html#handleNotify
  Function
  Method
  PUBLIC
  Called by `DNSServerFactory.messageReceived` when a notify message is received.
- twisted.names.server.DNSServerFactory.handleOther
  twisted.names.server.DNSServerFactory.html#handleOther
  Function
  Method
  PUBLIC
  Called by `DNSServerFactory.messageReceived` when a message with unrecognised OPCODE is received.
- twisted.names.server.DNSServerFactory.messageReceived
  twisted.names.server.DNSServerFactory.html#messageReceived
  Function
  Method
  PUBLIC
  `DNSServerFactory.messageReceived` is called by protocols which are under the control of this `DNSServerFactory` whenever they receive a DNS query message or an unexpected / duplicate / late DNS response message.
- twisted.names.server.DNSServerFactory.allowQuery
  twisted.names.server.DNSServerFactory.html#allowQuery
  Function
  Method
  PUBLIC
  Called by `DNSServerFactory.messageReceived` to decide whether to process a received message or to reply with `dns.EREFUSED`.
- twisted.names._rfc1982.RFC4034_TIME_FORMAT
  twisted.names._rfc1982.html#RFC4034_TIME_FORMAT
  Attribute
  Constant
  PUBLIC
  RRSIG Time field presentation format. The Signature Expiration Time and Inception Time field values MUST be represented either as an unsigned decimal integer indicating seconds since 1 January 1970 00:00:00 UTC, or in the form YYYYMMDDHHmmSS in UTC...
- twisted.names._rfc1982.SerialNumber
  twisted.names._rfc1982.SerialNumber.html
  Class
  Class
  PUBLIC
  An RFC1982 Serial Number.
- twisted.names._rfc1982.SerialNumber._serialBits
  twisted.names._rfc1982.SerialNumber.html#_serialBits
  Attribute
  Instance Variable
  PRIVATE
  See `serialBits` of `__init__`.
- twisted.names._rfc1982.SerialNumber._number
  twisted.names._rfc1982.SerialNumber.html#_number
  Attribute
  Instance Variable
  PRIVATE
  See `number` of `__init__`.
- twisted.names._rfc1982.SerialNumber._modulo
  twisted.names._rfc1982.SerialNumber.html#_modulo
  Attribute
  Instance Variable
  PRIVATE
  The value at which wrapping will occur.
- twisted.names._rfc1982.SerialNumber._halfRing
  twisted.names._rfc1982.SerialNumber.html#_halfRing
  Attribute
  Instance Variable
  PRIVATE
  Half `_modulo`. If another `SerialNumber` value is larger than this, it would lead to a wrapped value which is larger than the first and comparisons are therefore ambiguous.
- twisted.names._rfc1982.SerialNumber._maxAdd
  twisted.names._rfc1982.SerialNumber.html#_maxAdd
  Attribute
  Instance Variable
  PRIVATE
  Half `_modulo` plus 1. If another `SerialNumber` value is larger than this, it would lead to a wrapped value which is larger than the first. Comparisons with the original value would therefore be ambiguous.
- twisted.names._rfc1982.SerialNumber.showAttributes
  twisted.names._rfc1982.SerialNumber.html#showAttributes
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names._rfc1982.SerialNumber.__init__
  twisted.names._rfc1982.SerialNumber.html#__init__
  Function
  Method
  PUBLIC
  Construct an `SerialNumber` instance.
- twisted.names._rfc1982.SerialNumber._convertOther
  twisted.names._rfc1982.SerialNumber.html#_convertOther
  Function
  Method
  PRIVATE
  Check that a foreign object is suitable for use in the comparison or arithmetic magic methods of this `SerialNumber` instance. Raise `TypeError` if not.
- twisted.names._rfc1982.SerialNumber.__str__
  twisted.names._rfc1982.SerialNumber.html#__str__
  Function
  Method
  PUBLIC
  Return a string representation of this `SerialNumber` instance.
- twisted.names._rfc1982.SerialNumber.__int__
  twisted.names._rfc1982.SerialNumber.html#__int__
  Function
  Method
  PUBLIC
  No summary
- twisted.names._rfc1982.SerialNumber.__eq__
  twisted.names._rfc1982.SerialNumber.html#__eq__
  Function
  Method
  PUBLIC
  Allow rich equality comparison with another `SerialNumber` instance.
- twisted.names._rfc1982.SerialNumber.__lt__
  twisted.names._rfc1982.SerialNumber.html#__lt__
  Function
  Method
  PUBLIC
  Allow less than comparison with another `SerialNumber` instance.
- twisted.names._rfc1982.SerialNumber.__gt__
  twisted.names._rfc1982.SerialNumber.html#__gt__
  Function
  Method
  PUBLIC
  Allow greater than comparison with another `SerialNumber` instance.
- twisted.names._rfc1982.SerialNumber.__le__
  twisted.names._rfc1982.SerialNumber.html#__le__
  Function
  Method
  PUBLIC
  Allow less than or equal comparison with another `SerialNumber` instance.
- twisted.names._rfc1982.SerialNumber.__ge__
  twisted.names._rfc1982.SerialNumber.html#__ge__
  Function
  Method
  PUBLIC
  Allow greater than or equal comparison with another `SerialNumber` instance.
- twisted.names._rfc1982.SerialNumber.__add__
  twisted.names._rfc1982.SerialNumber.html#__add__
  Function
  Method
  PUBLIC
  Allow addition with another `SerialNumber` instance.
- twisted.names._rfc1982.SerialNumber.__hash__
  twisted.names._rfc1982.SerialNumber.html#__hash__
  Function
  Method
  PUBLIC
  Allow `SerialNumber` instances to be hashed for use as `dict` keys.
- twisted.names._rfc1982.SerialNumber.fromRFC4034DateString
  twisted.names._rfc1982.SerialNumber.html#fromRFC4034DateString
  Function
  Class Method
  PUBLIC
  Create an `SerialNumber` instance from a date string in format 'YYYYMMDDHHMMSS' described in RFC4034 3.2.
- twisted.names._rfc1982.SerialNumber.toRFC4034DateString
  twisted.names._rfc1982.SerialNumber.html#toRFC4034DateString
  Function
  Method
  PUBLIC
  Calculate a date by treating the current `SerialNumber` value as a UNIX timestamp and return a date string in the format described in RFC4034 3.2.
- twisted.names.authority.getSerial
  twisted.names.authority.html#getSerial
  Function
  Function
  PUBLIC
  Return a monotonically increasing (across program runs) integer.
- twisted.names.authority.FileAuthority
  twisted.names.authority.FileAuthority.html
  Class
  Class
  PUBLIC
  An Authority that is loaded from a file.
- twisted.names.authority.FileAuthority._ADDITIONAL_PROCESSING_TYPES
  twisted.names.authority.FileAuthority.html#_ADDITIONAL_PROCESSING_TYPES
  Attribute
  Constant
  PRIVATE
  Record types for which additional processing will be done.
- twisted.names.authority.FileAuthority._ADDRESS_TYPES
  twisted.names.authority.FileAuthority.html#_ADDRESS_TYPES
  Attribute
  Constant
  PRIVATE
  Record types which are useful for inclusion in the additional section generated during additional processing.
- twisted.names.authority.FileAuthority.soa
  twisted.names.authority.FileAuthority.html#soa
  Attribute
  Instance Variable
  PUBLIC
  A 2-tuple containing the SOA domain name as a `bytes` and a `dns.Record_SOA`.
- twisted.names.authority.FileAuthority.records
  twisted.names.authority.FileAuthority.html#records
  Attribute
  Instance Variable
  PUBLIC
  A mapping of domains (as lowercased `bytes`) to records.
- twisted.names.authority.FileAuthority.__init__
  twisted.names.authority.FileAuthority.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.authority.FileAuthority._cache
  twisted.names.authority.FileAuthority.html#_cache
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.names.authority.FileAuthority.__setstate__
  twisted.names.authority.FileAuthority.html#__setstate__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.authority.FileAuthority.__dict__
  twisted.names.authority.FileAuthority.html#__dict__
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.authority.FileAuthority.loadFile
  twisted.names.authority.FileAuthority.html#loadFile
  Function
  Method
  PUBLIC
  Load DNS records from a file.
- twisted.names.authority.FileAuthority._additionalRecords
  twisted.names.authority.FileAuthority.html#_additionalRecords
  Function
  Method
  PRIVATE
  Find locally known information that could be useful to the consumer of the response and construct appropriate records to include in the additional section of that response.
- twisted.names.authority.FileAuthority._lookup
  twisted.names.authority.FileAuthority.html#_lookup
  Function
  Method
  PRIVATE
  Determine a response to a particular DNS query.
- twisted.names.authority.FileAuthority.lookupZone
  twisted.names.authority.FileAuthority.html#lookupZone
  Function
  Method
  PUBLIC
  Perform an AXFR record lookup.
- twisted.names.authority.FileAuthority._cbAllRecords
  twisted.names.authority.FileAuthority.html#_cbAllRecords
  Function
  Method
  PRIVATE
  Undocumented
- twisted.names.authority.PySourceAuthority
  twisted.names.authority.PySourceAuthority.html
  Class
  Class
  PUBLIC
  A FileAuthority that is built up from Python source code.
- twisted.names.authority.PySourceAuthority.loadFile
  twisted.names.authority.PySourceAuthority.html#loadFile
  Function
  Method
  PUBLIC
  Load DNS records from a file.
- twisted.names.authority.PySourceAuthority.records
  twisted.names.authority.PySourceAuthority.html#records
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.authority.PySourceAuthority.soa
  twisted.names.authority.PySourceAuthority.html#soa
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.authority.PySourceAuthority.wrapRecord
  twisted.names.authority.PySourceAuthority.html#wrapRecord
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.authority.PySourceAuthority.setupConfigNamespace
  twisted.names.authority.PySourceAuthority.html#setupConfigNamespace
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.authority.BindAuthority
  twisted.names.authority.BindAuthority.html
  Class
  Class
  PUBLIC
  An Authority that loads BIND zone files.
- twisted.names.authority.BindAuthority.loadFile
  twisted.names.authority.BindAuthority.html#loadFile
  Function
  Method
  PUBLIC
  Load records from `filename`.
- twisted.names.authority.BindAuthority.origin
  twisted.names.authority.BindAuthority.html#origin
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.authority.BindAuthority.stripComments
  twisted.names.authority.BindAuthority.html#stripComments
  Function
  Method
  PUBLIC
  Strip comments from `lines`.
- twisted.names.authority.BindAuthority.collapseContinuations
  twisted.names.authority.BindAuthority.html#collapseContinuations
  Function
  Method
  PUBLIC
  Transform multiline statements into single lines.
- twisted.names.authority.BindAuthority.parseLines
  twisted.names.authority.BindAuthority.html#parseLines
  Function
  Method
  PUBLIC
  Parse `lines`.
- twisted.names.authority.BindAuthority.records
  twisted.names.authority.BindAuthority.html#records
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.authority.BindAuthority.addRecord
  twisted.names.authority.BindAuthority.html#addRecord
  Function
  Method
  PUBLIC
  Add a record to our authority. Expand domain with origin if necessary.
- twisted.names.authority.BindAuthority.class_IN
  twisted.names.authority.BindAuthority.html#class_IN
  Function
  Method
  PUBLIC
  Simulate a class IN and recurse into the actual class.
- twisted.names.authority.BindAuthority.soa
  twisted.names.authority.BindAuthority.html#soa
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.authority.BindAuthority.parseRecordLine
  twisted.names.authority.BindAuthority.html#parseRecordLine
  Function
  Method
  PUBLIC
  Parse a `line` from a zone file respecting `origin` and `ttl`.
- twisted.names.secondary.SecondaryAuthorityService
  twisted.names.secondary.SecondaryAuthorityService.html
  Class
  Class
  PUBLIC
  A service that keeps one or more authorities up to date by doing hourly zone transfers from a master.
- twisted.names.secondary.SecondaryAuthorityService.primary
  twisted.names.secondary.SecondaryAuthorityService.html#primary
  Attribute
  Instance Variable
  PUBLIC
  IP address of the master.
- twisted.names.secondary.SecondaryAuthorityService.domains
  twisted.names.secondary.SecondaryAuthorityService.html#domains
  Attribute
  Instance Variable
  PUBLIC
  An authority for each domain mirrored from the master.
- twisted.names.secondary.SecondaryAuthorityService.calls
  twisted.names.secondary.SecondaryAuthorityService.html#calls
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.secondary.SecondaryAuthorityService._port
  twisted.names.secondary.SecondaryAuthorityService.html#_port
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.names.secondary.SecondaryAuthorityService.__init__
  twisted.names.secondary.SecondaryAuthorityService.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.names.secondary.SecondaryAuthorityService.fromServerAddressAndDomains
  twisted.names.secondary.SecondaryAuthorityService.html#fromServerAddressAndDomains
  Function
  Class Method
  PUBLIC
  Construct a new `SecondaryAuthorityService` from a tuple giving a server address and a `str` giving the name of a domain for which this is an authority.
- twisted.names.secondary.SecondaryAuthorityService.getAuthority
  twisted.names.secondary.SecondaryAuthorityService.html#getAuthority
  Function
  Method
  PUBLIC
  Get a resolver for the transferred domains.
- twisted.names.secondary.SecondaryAuthorityService.startService
  twisted.names.secondary.SecondaryAuthorityService.html#startService
  Function
  Method
  PUBLIC
  Start the service.
- twisted.names.secondary.SecondaryAuthorityService.stopService
  twisted.names.secondary.SecondaryAuthorityService.html#stopService
  Function
  Method
  PUBLIC
  Stop the service.
- twisted.names.secondary.SecondaryAuthority
  twisted.names.secondary.SecondaryAuthority.html
  Class
  Class
  PUBLIC
  An Authority that keeps itself updated by performing zone transfers.
- twisted.names.secondary.SecondaryAuthority.primary
  twisted.names.secondary.SecondaryAuthority.html#primary
  Attribute
  Instance Variable
  PUBLIC
  The IP address of the server from which zone transfers will be attempted.
- twisted.names.secondary.SecondaryAuthority._port
  twisted.names.secondary.SecondaryAuthority.html#_port
  Attribute
  Instance Variable
  PRIVATE
  The port number of the server from which zone transfers will be attempted.
- twisted.names.secondary.SecondaryAuthority.domain
  twisted.names.secondary.SecondaryAuthority.html#domain
  Attribute
  Instance Variable
  PUBLIC
  The domain for which this is the secondary authority.
- twisted.names.secondary.SecondaryAuthority._reactor
  twisted.names.secondary.SecondaryAuthority.html#_reactor
  Attribute
  Instance Variable
  PRIVATE
  The reactor to use to perform the zone transfers, or `None` to use the global reactor.
- twisted.names.secondary.SecondaryAuthority.transferring
  twisted.names.secondary.SecondaryAuthority.html#transferring
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.secondary.SecondaryAuthority.soa
  twisted.names.secondary.SecondaryAuthority.html#soa
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.secondary.SecondaryAuthority.records
  twisted.names.secondary.SecondaryAuthority.html#records
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.secondary.SecondaryAuthority.__init__
  twisted.names.secondary.SecondaryAuthority.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.names.secondary.SecondaryAuthority.fromServerAddressAndDomain
  twisted.names.secondary.SecondaryAuthority.html#fromServerAddressAndDomain
  Function
  Class Method
  PUBLIC
  Construct a new `SecondaryAuthority` from a tuple giving a server address and a `bytes` giving the name of a domain for which this is an authority.
- twisted.names.secondary.SecondaryAuthority.transfer
  twisted.names.secondary.SecondaryAuthority.html#transfer
  Function
  Method
  PUBLIC
  Attempt a zone transfer.
- twisted.names.secondary.SecondaryAuthority.transfering
  twisted.names.secondary.SecondaryAuthority.html#transfering
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.secondary.SecondaryAuthority._lookup
  twisted.names.secondary.SecondaryAuthority.html#_lookup
  Function
  Method
  PRIVATE
  Determine a response to a particular DNS query.
- twisted.names.secondary.SecondaryAuthority._cbZone
  twisted.names.secondary.SecondaryAuthority.html#_cbZone
  Function
  Method
  PRIVATE
  Undocumented
- twisted.names.secondary.SecondaryAuthority._ebZone
  twisted.names.secondary.SecondaryAuthority.html#_ebZone
  Function
  Method
  PRIVATE
  Undocumented
- twisted.names.secondary.SecondaryAuthority.update
  twisted.names.secondary.SecondaryAuthority.html#update
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.secondary.SecondaryAuthority._cbTransferred
  twisted.names.secondary.SecondaryAuthority.html#_cbTransferred
  Function
  Method
  PRIVATE
  Undocumented
- twisted.names.secondary.SecondaryAuthority._ebTransferred
  twisted.names.secondary.SecondaryAuthority.html#_ebTransferred
  Function
  Method
  PRIVATE
  Undocumented
- twisted.names.secondary.SecondaryAuthority.transferred
  twisted.names.secondary.SecondaryAuthority.html#transferred
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.srvconnect._SRVConnector_ClientFactoryWrapper
  twisted.names.srvconnect._SRVConnector_ClientFactoryWrapper.html
  Class
  Class
  PRIVATE
  Undocumented
- twisted.names.srvconnect._SRVConnector_ClientFactoryWrapper.__init__
  twisted.names.srvconnect._SRVConnector_ClientFactoryWrapper.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.srvconnect._SRVConnector_ClientFactoryWrapper.__connector
  twisted.names.srvconnect._SRVConnector_ClientFactoryWrapper.html#__connector
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.names.srvconnect._SRVConnector_ClientFactoryWrapper.__wrappedFactory
  twisted.names.srvconnect._SRVConnector_ClientFactoryWrapper.html#__wrappedFactory
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.names.srvconnect._SRVConnector_ClientFactoryWrapper.startedConnecting
  twisted.names.srvconnect._SRVConnector_ClientFactoryWrapper.html#startedConnecting
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.srvconnect._SRVConnector_ClientFactoryWrapper.clientConnectionFailed
  twisted.names.srvconnect._SRVConnector_ClientFactoryWrapper.html#clientConnectionFailed
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.srvconnect._SRVConnector_ClientFactoryWrapper.clientConnectionLost
  twisted.names.srvconnect._SRVConnector_ClientFactoryWrapper.html#clientConnectionLost
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.srvconnect._SRVConnector_ClientFactoryWrapper.__getattr__
  twisted.names.srvconnect._SRVConnector_ClientFactoryWrapper.html#__getattr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.srvconnect.SRVConnector
  twisted.names.srvconnect.SRVConnector.html
  Class
  Class
  PUBLIC
  A connector that looks up DNS SRV records.
- twisted.names.srvconnect.SRVConnector.servers
  twisted.names.srvconnect.SRVConnector.html#servers
  Attribute
  Instance Variable
  PUBLIC
  List of candidate server records for future connection attempts.
- twisted.names.srvconnect.SRVConnector.orderedServers
  twisted.names.srvconnect.SRVConnector.html#orderedServers
  Attribute
  Instance Variable
  PUBLIC
  List of server records that have already been tried in this round of connection attempts.
- twisted.names.srvconnect.SRVConnector.stopAfterDNS
  twisted.names.srvconnect.SRVConnector.html#stopAfterDNS
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.srvconnect.SRVConnector.__init__
  twisted.names.srvconnect.SRVConnector.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.names.srvconnect.SRVConnector.reactor
  twisted.names.srvconnect.SRVConnector.html#reactor
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.srvconnect.SRVConnector.service
  twisted.names.srvconnect.SRVConnector.html#service
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.srvconnect.SRVConnector.domain
  twisted.names.srvconnect.SRVConnector.html#domain
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.srvconnect.SRVConnector.factory
  twisted.names.srvconnect.SRVConnector.html#factory
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.srvconnect.SRVConnector.protocol
  twisted.names.srvconnect.SRVConnector.html#protocol
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.srvconnect.SRVConnector.connectFuncName
  twisted.names.srvconnect.SRVConnector.html#connectFuncName
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.srvconnect.SRVConnector.connectFuncArgs
  twisted.names.srvconnect.SRVConnector.html#connectFuncArgs
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.srvconnect.SRVConnector.connectFuncKwArgs
  twisted.names.srvconnect.SRVConnector.html#connectFuncKwArgs
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.srvconnect.SRVConnector._defaultPort
  twisted.names.srvconnect.SRVConnector.html#_defaultPort
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.names.srvconnect.SRVConnector.connector
  twisted.names.srvconnect.SRVConnector.html#connector
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.srvconnect.SRVConnector.connect
  twisted.names.srvconnect.SRVConnector.html#connect
  Function
  Method
  PUBLIC
  Start connection to remote server.
- twisted.names.srvconnect.SRVConnector._ebGotServers
  twisted.names.srvconnect.SRVConnector.html#_ebGotServers
  Function
  Method
  PRIVATE
  Undocumented
- twisted.names.srvconnect.SRVConnector._cbGotServers
  twisted.names.srvconnect.SRVConnector.html#_cbGotServers
  Function
  Method
  PRIVATE
  Undocumented
- twisted.names.srvconnect.SRVConnector._ebServiceUnknown
  twisted.names.srvconnect.SRVConnector.html#_ebServiceUnknown
  Function
  Method
  PRIVATE
  Connect to the default port when the service name is unknown.
- twisted.names.srvconnect.SRVConnector.pickServer
  twisted.names.srvconnect.SRVConnector.html#pickServer
  Function
  Method
  PUBLIC
  Pick the next server.
- twisted.names.srvconnect.SRVConnector._reallyConnect
  twisted.names.srvconnect.SRVConnector.html#_reallyConnect
  Function
  Method
  PRIVATE
  Undocumented
- twisted.names.srvconnect.SRVConnector.host
  twisted.names.srvconnect.SRVConnector.html#host
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.srvconnect.SRVConnector.port
  twisted.names.srvconnect.SRVConnector.html#port
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.srvconnect.SRVConnector.stopConnecting
  twisted.names.srvconnect.SRVConnector.html#stopConnecting
  Function
  Method
  PUBLIC
  Stop attempting to connect.
- twisted.names.srvconnect.SRVConnector.disconnect
  twisted.names.srvconnect.SRVConnector.html#disconnect
  Function
  Method
  PUBLIC
  Disconnect whatever our are state is.
- twisted.names.srvconnect.SRVConnector.getDestination
  twisted.names.srvconnect.SRVConnector.html#getDestination
  Function
  Method
  PUBLIC
  Return destination this will try to connect to.
- twisted.names.srvconnect.SRVConnector.connectionFailed
  twisted.names.srvconnect.SRVConnector.html#connectionFailed
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.srvconnect.SRVConnector.connectionLost
  twisted.names.srvconnect.SRVConnector.html#connectionLost
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.tap.Options
  twisted.names.tap.Options.html
  Class
  Class
  PUBLIC
  No class docstring; 0/5 instance variable, 0/3 class variable, 4/6 methods documented
- twisted.names.tap.Options.optParameters
  twisted.names.tap.Options.html#optParameters
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.tap.Options.optFlags
  twisted.names.tap.Options.html#optFlags
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.tap.Options.compData
  twisted.names.tap.Options.html#compData
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.names.tap.Options.zones
  twisted.names.tap.Options.html#zones
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.tap.Options.zonefiles
  twisted.names.tap.Options.html#zonefiles
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.tap.Options.__init__
  twisted.names.tap.Options.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.names.tap.Options.bindfiles
  twisted.names.tap.Options.html#bindfiles
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.tap.Options.secondaries
  twisted.names.tap.Options.html#secondaries
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.tap.Options.opt_pyzone
  twisted.names.tap.Options.html#opt_pyzone
  Function
  Method
  PUBLIC
  Specify the filename of a Python syntax zone definition
- twisted.names.tap.Options.opt_bindzone
  twisted.names.tap.Options.html#opt_bindzone
  Function
  Method
  PUBLIC
  Specify the filename of a BIND9 syntax zone definition
- twisted.names.tap.Options.opt_secondary
  twisted.names.tap.Options.html#opt_secondary
  Function
  Method
  PUBLIC
  Act as secondary for the specified domain, performing zone transfers from the specified IP (IP/domain)
- twisted.names.tap.Options.opt_verbose
  twisted.names.tap.Options.html#opt_verbose
  Function
  Method
  PUBLIC
  Increment verbosity level
- twisted.names.tap.Options.postOptions
  twisted.names.tap.Options.html#postOptions
  Function
  Method
  PUBLIC
  I am called after the options are parsed.
- twisted.names.tap.Options.svcs
  twisted.names.tap.Options.html#svcs
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.names.tap._buildResolvers
  twisted.names.tap.html#_buildResolvers
  Function
  Function
  PRIVATE
  Build DNS resolver instances in an order which leaves recursive resolving as a last resort.
- twisted.names.tap.makeService
  twisted.names.tap.html#makeService
  Function
  Function
  PUBLIC
  Undocumented
- twisted.pair.raw.IRawDatagramProtocol
  twisted.pair.raw.IRawDatagramProtocol.html
  Class
  Interface
  PUBLIC
  An interface for protocols such as UDP, ICMP and TCP.
- twisted.pair.raw.IRawDatagramProtocol.addProto
  twisted.pair.raw.IRawDatagramProtocol.html#addProto
  Function
  Method
  PUBLIC
  Add a protocol on top of this one.
- twisted.pair.raw.IRawDatagramProtocol.datagramReceived
  twisted.pair.raw.IRawDatagramProtocol.html#datagramReceived
  Function
  Method
  PUBLIC
  An IP datagram has been received. Parse and process it.
- twisted.pair.raw.IRawPacketProtocol
  twisted.pair.raw.IRawPacketProtocol.html
  Class
  Interface
  PUBLIC
  An interface for low-level protocols such as IP and ARP.
- twisted.pair.raw.IRawPacketProtocol.addProto
  twisted.pair.raw.IRawPacketProtocol.html#addProto
  Function
  Method
  PUBLIC
  Add a protocol on top of this one.
- twisted.pair.raw.IRawPacketProtocol.datagramReceived
  twisted.pair.raw.IRawPacketProtocol.html#datagramReceived
  Function
  Method
  PUBLIC
  An IP datagram has been received. Parse and process it.
- twisted.pair.ethernet.IEthernetProtocol
  twisted.pair.ethernet.IEthernetProtocol.html
  Class
  Interface
  PUBLIC
  An interface for protocols that handle Ethernet frames
- twisted.pair.ethernet.IEthernetProtocol.addProto
  twisted.pair.ethernet.IEthernetProtocol.html#addProto
  Function
  Method
  PUBLIC
  Add an IRawPacketProtocol protocol
- twisted.pair.ethernet.IEthernetProtocol.datagramReceived
  twisted.pair.ethernet.IEthernetProtocol.html#datagramReceived
  Function
  Method
  PUBLIC
  An Ethernet frame has been received
- twisted.pair.ethernet.EthernetHeader
  twisted.pair.ethernet.EthernetHeader.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.pair.ethernet.EthernetHeader.__init__
  twisted.pair.ethernet.EthernetHeader.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.pair.ethernet.EthernetHeader.dest
  twisted.pair.ethernet.EthernetHeader.html#dest
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.pair.ethernet.EthernetHeader.source
  twisted.pair.ethernet.EthernetHeader.html#source
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.pair.ethernet.EthernetHeader.proto
  twisted.pair.ethernet.EthernetHeader.html#proto
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.pair.ethernet.EthernetProtocol
  twisted.pair.ethernet.EthernetProtocol.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.pair.ethernet.EthernetProtocol.__init__
  twisted.pair.ethernet.EthernetProtocol.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.pair.ethernet.EthernetProtocol.etherProtos
  twisted.pair.ethernet.EthernetProtocol.html#etherProtos
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.pair.ethernet.EthernetProtocol.addProto
  twisted.pair.ethernet.EthernetProtocol.html#addProto
  Function
  Method
  PUBLIC
  Add an IRawPacketProtocol protocol
- twisted.pair.ethernet.EthernetProtocol.datagramReceived
  twisted.pair.ethernet.EthernetProtocol.html#datagramReceived
  Function
  Method
  PUBLIC
  Called when a datagram is received.
- twisted.pair.ip.IPHeader
  twisted.pair.ip.IPHeader.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.pair.ip.IPHeader.__init__
  twisted.pair.ip.IPHeader.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.pair.ip.IPHeader.tos
  twisted.pair.ip.IPHeader.html#tos
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.pair.ip.IPHeader.tot_len
  twisted.pair.ip.IPHeader.html#tot_len
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.pair.ip.IPHeader.fragment_id
  twisted.pair.ip.IPHeader.html#fragment_id
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.pair.ip.IPHeader.ttl
  twisted.pair.ip.IPHeader.html#ttl
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.pair.ip.IPHeader.protocol
  twisted.pair.ip.IPHeader.html#protocol
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.pair.ip.IPHeader.check
  twisted.pair.ip.IPHeader.html#check
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.pair.ip.IPHeader.saddr
  twisted.pair.ip.IPHeader.html#saddr
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.pair.ip.IPHeader.daddr
  twisted.pair.ip.IPHeader.html#daddr
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.pair.ip.IPHeader.version
  twisted.pair.ip.IPHeader.html#version
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.pair.ip.IPHeader.ihl
  twisted.pair.ip.IPHeader.html#ihl
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.pair.ip.IPHeader.fragment_offset
  twisted.pair.ip.IPHeader.html#fragment_offset
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.pair.ip.IPHeader.dont_fragment
  twisted.pair.ip.IPHeader.html#dont_fragment
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.pair.ip.IPHeader.more_fragments
  twisted.pair.ip.IPHeader.html#more_fragments
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.pair.ip.MAX_SIZE
  twisted.pair.ip.html#MAX_SIZE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.pair.ip.IPProtocol
  twisted.pair.ip.IPProtocol.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.pair.ip.IPProtocol.__init__
  twisted.pair.ip.IPProtocol.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.pair.ip.IPProtocol.ipProtos
  twisted.pair.ip.IPProtocol.html#ipProtos
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.pair.ip.IPProtocol.addProto
  twisted.pair.ip.IPProtocol.html#addProto
  Function
  Method
  PUBLIC
  Add a protocol on top of this one.
- twisted.pair.ip.IPProtocol.datagramReceived
  twisted.pair.ip.IPProtocol.html#datagramReceived
  Function
  Method
  PUBLIC
  Called when a datagram is received.
- twisted.pair.rawudp.UDPHeader
  twisted.pair.rawudp.UDPHeader.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.pair.rawudp.UDPHeader.__init__
  twisted.pair.rawudp.UDPHeader.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.pair.rawudp.UDPHeader.source
  twisted.pair.rawudp.UDPHeader.html#source
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.pair.rawudp.UDPHeader.dest
  twisted.pair.rawudp.UDPHeader.html#dest
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.pair.rawudp.UDPHeader.len
  twisted.pair.rawudp.UDPHeader.html#len
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.pair.rawudp.UDPHeader.check
  twisted.pair.rawudp.UDPHeader.html#check
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.pair.rawudp.RawUDPProtocol
  twisted.pair.rawudp.RawUDPProtocol.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.pair.rawudp.RawUDPProtocol.__init__
  twisted.pair.rawudp.RawUDPProtocol.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.pair.rawudp.RawUDPProtocol.udpProtos
  twisted.pair.rawudp.RawUDPProtocol.html#udpProtos
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.pair.rawudp.RawUDPProtocol.addProto
  twisted.pair.rawudp.RawUDPProtocol.html#addProto
  Function
  Method
  PUBLIC
  Add a protocol on top of this one.
- twisted.pair.rawudp.RawUDPProtocol.datagramReceived
  twisted.pair.rawudp.RawUDPProtocol.html#datagramReceived
  Function
  Method
  PUBLIC
  Called when a datagram is received.
- twisted.pair.tuntap._IFNAMSIZ
  twisted.pair.tuntap.html#_IFNAMSIZ
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.pair.tuntap._TUNSETIFF
  twisted.pair.tuntap.html#_TUNSETIFF
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.pair.tuntap._TUNGETIFF
  twisted.pair.tuntap.html#_TUNGETIFF
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.pair.tuntap._TUN_KO_PATH
  twisted.pair.tuntap.html#_TUN_KO_PATH
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.pair.tuntap.TunnelFlags
  twisted.pair.tuntap.TunnelFlags.html
  Class
  Class
  PUBLIC
  `TunnelFlags` defines more flags which are used to configure the behavior of a tunnel device.
- twisted.pair.tuntap.TunnelFlags.IFF_TUN
  twisted.pair.tuntap.TunnelFlags.html#IFF_TUN
  Attribute
  Constant
  PUBLIC
  This indicates a tun-type device. This type of tunnel carries IP datagrams. This flag is mutually exclusive with `IFF_TAP`.
- twisted.pair.tuntap.TunnelFlags.IFF_TAP
  twisted.pair.tuntap.TunnelFlags.html#IFF_TAP
  Attribute
  Constant
  PUBLIC
  This indicates a tap-type device. This type of tunnel carries ethernet frames. This flag is mutually exclusive with `IFF_TUN`.
- twisted.pair.tuntap.TunnelFlags.IFF_NO_PI
  twisted.pair.tuntap.TunnelFlags.html#IFF_NO_PI
  Attribute
  Constant
  PUBLIC
  This indicates the protocol information header will not be included in data read from the tunnel.
- twisted.pair.tuntap.TunnelFlags.TUN_FASYNC
  twisted.pair.tuntap.TunnelFlags.html#TUN_FASYNC
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.pair.tuntap.TunnelFlags.TUN_NOCHECKSUM
  twisted.pair.tuntap.TunnelFlags.html#TUN_NOCHECKSUM
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.pair.tuntap.TunnelFlags.TUN_NO_PI
  twisted.pair.tuntap.TunnelFlags.html#TUN_NO_PI
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.pair.tuntap.TunnelFlags.TUN_ONE_QUEUE
  twisted.pair.tuntap.TunnelFlags.html#TUN_ONE_QUEUE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.pair.tuntap.TunnelFlags.TUN_PERSIST
  twisted.pair.tuntap.TunnelFlags.html#TUN_PERSIST
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.pair.tuntap.TunnelFlags.TUN_VNET_HDR
  twisted.pair.tuntap.TunnelFlags.html#TUN_VNET_HDR
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.pair.tuntap.TunnelFlags.IFF_ONE_QUEUE
  twisted.pair.tuntap.TunnelFlags.html#IFF_ONE_QUEUE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.pair.tuntap.TunnelFlags.IFF_VNET_HDR
  twisted.pair.tuntap.TunnelFlags.html#IFF_VNET_HDR
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.pair.tuntap.TunnelFlags.IFF_TUN_EXCL
  twisted.pair.tuntap.TunnelFlags.html#IFF_TUN_EXCL
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.pair.tuntap.TunnelAddress
  twisted.pair.tuntap.TunnelAddress.html
  Class
  Class
  PUBLIC
  A `TunnelAddress` represents the tunnel to which a `TuntapPort` is bound.
- twisted.pair.tuntap.TunnelAddress.compareAttributes
  twisted.pair.tuntap.TunnelAddress.html#compareAttributes
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.pair.tuntap.TunnelAddress.showAttributes
  twisted.pair.tuntap.TunnelAddress.html#showAttributes
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.pair.tuntap.TunnelAddress._typeValue
  twisted.pair.tuntap.TunnelAddress.html#_typeValue
  Attribute
  Property
  PRIVATE
  Return the integer value of the `type` attribute. Used to produce correct results in the equality implementation.
- twisted.pair.tuntap.TunnelAddress.__init__
  twisted.pair.tuntap.TunnelAddress.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.pair.tuntap.TunnelAddress.type
  twisted.pair.tuntap.TunnelAddress.html#type
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.pair.tuntap.TunnelAddress.name
  twisted.pair.tuntap.TunnelAddress.html#name
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.pair.tuntap.TunnelAddress.__getitem__
  twisted.pair.tuntap.TunnelAddress.html#__getitem__
  Function
  Method
  PUBLIC
  Deprecated accessor for the tunnel name. Use attributes instead.
- twisted.pair.tuntap._TunnelDescription
  twisted.pair.tuntap._TunnelDescription.html
  Class
  Class
  PRIVATE
  Describe an existing tunnel.
- twisted.pair.tuntap._TunnelDescription.fileno
  twisted.pair.tuntap._TunnelDescription.html#fileno
  Attribute
  Instance Variable
  PUBLIC
  the file descriptor associated with the tunnel
- twisted.pair.tuntap._TunnelDescription.name
  twisted.pair.tuntap._TunnelDescription.html#name
  Attribute
  Instance Variable
  PUBLIC
  the name of the tunnel
- twisted.pair.tuntap._IInputOutputSystem
  twisted.pair.tuntap._IInputOutputSystem.html
  Class
  Interface
  PRIVATE
  An interface for performing some basic kinds of I/O (particularly that I/O which might be useful for `twisted.pair.tuntap`-using code).
- twisted.pair.tuntap._IInputOutputSystem.O_RDWR
  twisted.pair.tuntap._IInputOutputSystem.html#O_RDWR
  Attribute
  Attribute
  PUBLIC
  No summary
- twisted.pair.tuntap._IInputOutputSystem.O_NONBLOCK
  twisted.pair.tuntap._IInputOutputSystem.html#O_NONBLOCK
  Attribute
  Attribute
  PUBLIC
  No summary
- twisted.pair.tuntap._IInputOutputSystem.O_CLOEXEC
  twisted.pair.tuntap._IInputOutputSystem.html#O_CLOEXEC
  Attribute
  Attribute
  PUBLIC
  No summary
- twisted.pair.tuntap._IInputOutputSystem.open
  twisted.pair.tuntap._IInputOutputSystem.html#open
  Function
  Method
  PUBLIC
  No summary
- twisted.pair.tuntap._IInputOutputSystem.ioctl
  twisted.pair.tuntap._IInputOutputSystem.html#ioctl
  Function
  Method
  PUBLIC
  No summary
- twisted.pair.tuntap._IInputOutputSystem.read
  twisted.pair.tuntap._IInputOutputSystem.html#read
  Function
  Method
  PUBLIC
  No summary
- twisted.pair.tuntap._IInputOutputSystem.write
  twisted.pair.tuntap._IInputOutputSystem.html#write
  Function
  Method
  PUBLIC
  No summary
- twisted.pair.tuntap._IInputOutputSystem.close
  twisted.pair.tuntap._IInputOutputSystem.html#close
  Function
  Method
  PUBLIC
  No summary
- twisted.pair.tuntap._IInputOutputSystem.sendUDP
  twisted.pair.tuntap._IInputOutputSystem.html#sendUDP
  Function
  Method
  PUBLIC
  Send a datagram to a certain address.
- twisted.pair.tuntap._IInputOutputSystem.receiveUDP
  twisted.pair.tuntap._IInputOutputSystem.html#receiveUDP
  Function
  Method
  PUBLIC
  Return a socket which can be used to receive datagrams sent to the given address.
- twisted.pair.tuntap._RealSystem
  twisted.pair.tuntap._RealSystem.html
  Class
  Class
  PRIVATE
  An interface to the parts of the operating system which `TuntapPort` relies on. This is most of an implementation of `_IInputOutputSystem`.
- twisted.pair.tuntap._RealSystem.open
  twisted.pair.tuntap._RealSystem.html#open
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.pair.tuntap._RealSystem.read
  twisted.pair.tuntap._RealSystem.html#read
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.pair.tuntap._RealSystem.write
  twisted.pair.tuntap._RealSystem.html#write
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.pair.tuntap._RealSystem.close
  twisted.pair.tuntap._RealSystem.html#close
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.pair.tuntap._RealSystem.ioctl
  twisted.pair.tuntap._RealSystem.html#ioctl
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.pair.tuntap._RealSystem.O_CLOEXEC
  twisted.pair.tuntap._RealSystem.html#O_CLOEXEC
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.pair.tuntap.TuntapPort
  twisted.pair.tuntap.TuntapPort.html
  Class
  Class
  PUBLIC
  A Port that reads and writes packets from/to a TUN/TAP-device.
- twisted.pair.tuntap.TuntapPort.maxThroughput
  twisted.pair.tuntap.TuntapPort.html#maxThroughput
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.pair.tuntap.TuntapPort.__init__
  twisted.pair.tuntap.TuntapPort.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.pair.tuntap.TuntapPort.ethernet
  twisted.pair.tuntap.TuntapPort.html#ethernet
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.pair.tuntap.TuntapPort._mode
  twisted.pair.tuntap.TuntapPort.html#_mode
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.pair.tuntap.TuntapPort._system
  twisted.pair.tuntap.TuntapPort.html#_system
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.pair.tuntap.TuntapPort.interface
  twisted.pair.tuntap.TuntapPort.html#interface
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.pair.tuntap.TuntapPort.protocol
  twisted.pair.tuntap.TuntapPort.html#protocol
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.pair.tuntap.TuntapPort.maxPacketSize
  twisted.pair.tuntap.TuntapPort.html#maxPacketSize
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.pair.tuntap.TuntapPort.logstr
  twisted.pair.tuntap.TuntapPort.html#logstr
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.pair.tuntap.TuntapPort.__repr__
  twisted.pair.tuntap.TuntapPort.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.pair.tuntap.TuntapPort.startListening
  twisted.pair.tuntap.TuntapPort.html#startListening
  Function
  Method
  PUBLIC
  Create and bind my socket, and begin listening on it.
- twisted.pair.tuntap.TuntapPort._openTunnel
  twisted.pair.tuntap.TuntapPort.html#_openTunnel
  Function
  Method
  PRIVATE
  Open the named tunnel using the given mode.
- twisted.pair.tuntap.TuntapPort._bindSocket
  twisted.pair.tuntap.TuntapPort.html#_bindSocket
  Function
  Method
  PRIVATE
  Open the tunnel.
- twisted.pair.tuntap.TuntapPort._fileno
  twisted.pair.tuntap.TuntapPort.html#_fileno
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.pair.tuntap.TuntapPort.connected
  twisted.pair.tuntap.TuntapPort.html#connected
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.pair.tuntap.TuntapPort.fileno
  twisted.pair.tuntap.TuntapPort.html#fileno
  Function
  Method
  PUBLIC
  File Descriptor number for select().
- twisted.pair.tuntap.TuntapPort.doRead
  twisted.pair.tuntap.TuntapPort.html#doRead
  Function
  Method
  PUBLIC
  Called when my socket is ready for reading.
- twisted.pair.tuntap.TuntapPort.write
  twisted.pair.tuntap.TuntapPort.html#write
  Function
  Method
  PUBLIC
  Write the given data as a single datagram.
- twisted.pair.tuntap.TuntapPort.writeSequence
  twisted.pair.tuntap.TuntapPort.html#writeSequence
  Function
  Method
  PUBLIC
  Write a datagram constructed from a `list` of `bytes`.
- twisted.pair.tuntap.TuntapPort.stopListening
  twisted.pair.tuntap.TuntapPort.html#stopListening
  Function
  Method
  PUBLIC
  Stop accepting connections on this port.
- twisted.pair.tuntap.TuntapPort.loseConnection
  twisted.pair.tuntap.TuntapPort.html#loseConnection
  Function
  Method
  PUBLIC
  Close this tunnel. Use `TuntapPort.stopListening` instead.
- twisted.pair.tuntap.TuntapPort.connectionLost
  twisted.pair.tuntap.TuntapPort.html#connectionLost
  Function
  Method
  PUBLIC
  Cleans up my socket.
- twisted.pair.tuntap.TuntapPort.logPrefix
  twisted.pair.tuntap.TuntapPort.html#logPrefix
  Function
  Method
  PUBLIC
  Returns the name of my class, to prefix log entries with.
- twisted.pair.tuntap.TuntapPort.getHost
  twisted.pair.tuntap.TuntapPort.html#getHost
  Function
  Method
  PUBLIC
  Get the local address of this `TuntapPort`.
- twisted.pair.testing._PI_SIZE
  twisted.pair.testing.html#_PI_SIZE
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.pair.testing._H
  twisted.pair.testing.html#_H
  Function
  Function
  PRIVATE
  Pack an integer into a network-order two-byte string.
- twisted.pair.testing._IPv4
  twisted.pair.testing.html#_IPv4
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.pair.testing._ethernet
  twisted.pair.testing.html#_ethernet
  Function
  Function
  PRIVATE
  Construct an ethernet frame.
- twisted.pair.testing._ip
  twisted.pair.testing.html#_ip
  Function
  Function
  PRIVATE
  Construct an IP datagram with the given source, destination, and application payload.
- twisted.pair.testing._udp
  twisted.pair.testing.html#_udp
  Function
  Function
  PRIVATE
  Construct a UDP datagram with the given source, destination, and application payload.
- twisted.pair.testing.Tunnel
  twisted.pair.testing.Tunnel.html
  Class
  Class
  PUBLIC
  An in-memory implementation of a tun or tap device.
- twisted.pair.testing.Tunnel._DEVICE_NAME
  twisted.pair.testing.Tunnel.html#_DEVICE_NAME
  Attribute
  Constant
  PRIVATE
  A string representing the conventional filesystem entry for the tunnel factory character special device.
- twisted.pair.testing.Tunnel.EAGAIN_STYLE
  twisted.pair.testing.Tunnel.html#EAGAIN_STYLE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.pair.testing.Tunnel.EWOULDBLOCK_STYLE
  twisted.pair.testing.Tunnel.html#EWOULDBLOCK_STYLE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.pair.testing.Tunnel.EINTR_STYLE
  twisted.pair.testing.Tunnel.html#EINTR_STYLE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.pair.testing.Tunnel.SEND_BUFFER_SIZE
  twisted.pair.testing.Tunnel.html#SEND_BUFFER_SIZE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.pair.testing.Tunnel.__init__
  twisted.pair.testing.Tunnel.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.pair.testing.Tunnel.system
  twisted.pair.testing.Tunnel.html#system
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.pair.testing.Tunnel.openFlags
  twisted.pair.testing.Tunnel.html#openFlags
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.pair.testing.Tunnel.tunnelMode
  twisted.pair.testing.Tunnel.html#tunnelMode
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.pair.testing.Tunnel.requestedName
  twisted.pair.testing.Tunnel.html#requestedName
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.pair.testing.Tunnel.name
  twisted.pair.testing.Tunnel.html#name
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.pair.testing.Tunnel.readBuffer
  twisted.pair.testing.Tunnel.html#readBuffer
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.pair.testing.Tunnel.writeBuffer
  twisted.pair.testing.Tunnel.html#writeBuffer
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.pair.testing.Tunnel.pendingSignals
  twisted.pair.testing.Tunnel.html#pendingSignals
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.pair.testing.Tunnel.blocking
  twisted.pair.testing.Tunnel.html#blocking
  Attribute
  Property
  PUBLIC
  If the file descriptor for this tunnel is open in blocking mode, `True`. `False` otherwise.
- twisted.pair.testing.Tunnel.closeOnExec
  twisted.pair.testing.Tunnel.html#closeOnExec
  Attribute
  Property
  PUBLIC
  If the file descriptor for this tunnel is marked as close-on-exec, `True`. `False` otherwise.
- twisted.pair.testing.Tunnel.addToReadBuffer
  twisted.pair.testing.Tunnel.html#addToReadBuffer
  Function
  Method
  PUBLIC
  Deliver a datagram to this tunnel's read buffer. This makes it available to be read later using the `read` method.
- twisted.pair.testing.Tunnel.read
  twisted.pair.testing.Tunnel.html#read
  Function
  Method
  PUBLIC
  Read a datagram out of this tunnel.
- twisted.pair.testing.Tunnel.write
  twisted.pair.testing.Tunnel.html#write
  Function
  Method
  PUBLIC
  Write a datagram into this tunnel.
- twisted.pair.testing._privileged
  twisted.pair.testing.html#_privileged
  Function
  Function
  PRIVATE
  Wrap a `MemoryIOSystem` method with permission-checking logic. The returned function will check `self.permissions` and raise `IOError` with `errno.EPERM` if the function name is not listed as an available permission.
- twisted.pair.testing.MemoryIOSystem
  twisted.pair.testing.MemoryIOSystem.html
  Class
  Class
  PUBLIC
  An in-memory implementation of basic I/O primitives, useful in the context of unit testing as a drop-in replacement for parts of the `os` module.
- twisted.pair.testing.MemoryIOSystem._devices
  twisted.pair.testing.MemoryIOSystem.html#_devices
  Attribute
  Instance Variable
  PRIVATE
  No summary
- twisted.pair.testing.MemoryIOSystem._openFiles
  twisted.pair.testing.MemoryIOSystem.html#_openFiles
  Attribute
  Instance Variable
  PRIVATE
  No summary
- twisted.pair.testing.MemoryIOSystem.permissions
  twisted.pair.testing.MemoryIOSystem.html#permissions
  Attribute
  Instance Variable
  PUBLIC
  No summary
- twisted.pair.testing.MemoryIOSystem._counter
  twisted.pair.testing.MemoryIOSystem.html#_counter
  Attribute
  Instance Variable
  PRIVATE
  No summary
- twisted.pair.testing.MemoryIOSystem.O_RDWR
  twisted.pair.testing.MemoryIOSystem.html#O_RDWR
  Attribute
  Constant
  PUBLIC
  No summary
- twisted.pair.testing.MemoryIOSystem.O_NONBLOCK
  twisted.pair.testing.MemoryIOSystem.html#O_NONBLOCK
  Attribute
  Constant
  PUBLIC
  No summary
- twisted.pair.testing.MemoryIOSystem.O_CLOEXEC
  twisted.pair.testing.MemoryIOSystem.html#O_CLOEXEC
  Attribute
  Constant
  PUBLIC
  No summary
- twisted.pair.testing.MemoryIOSystem.__init__
  twisted.pair.testing.MemoryIOSystem.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.pair.testing.MemoryIOSystem.getTunnel
  twisted.pair.testing.MemoryIOSystem.html#getTunnel
  Function
  Method
  PUBLIC
  Get the `Tunnel` object associated with the given `TuntapPort`.
- twisted.pair.testing.MemoryIOSystem.registerSpecialDevice
  twisted.pair.testing.MemoryIOSystem.html#registerSpecialDevice
  Function
  Method
  PUBLIC
  Specify a class which will be used to handle I/O to a device of a particular name.
- twisted.pair.testing.MemoryIOSystem.open
  twisted.pair.testing.MemoryIOSystem.html#open
  Function
  Method
  PUBLIC
  A replacement for `os.open`. This initializes state in this `MemoryIOSystem` which will be reflected in the behavior of the other file descriptor-related methods (eg `MemoryIOSystem.read`, `MemoryIOSystem.write`...
- twisted.pair.testing.MemoryIOSystem.read
  twisted.pair.testing.MemoryIOSystem.html#read
  Function
  Method
  PUBLIC
  Try to read some bytes out of one of the in-memory buffers which may previously have been populated by `write`.
- twisted.pair.testing.MemoryIOSystem.write
  twisted.pair.testing.MemoryIOSystem.html#write
  Function
  Method
  PUBLIC
  Try to add some bytes to one of the in-memory buffers to be accessed by a later `read` call.
- twisted.pair.testing.MemoryIOSystem.close
  twisted.pair.testing.MemoryIOSystem.html#close
  Function
  Method
  PUBLIC
  Discard the in-memory buffer and other in-memory state for the given file descriptor.
- twisted.pair.testing.MemoryIOSystem.ioctl
  twisted.pair.testing.MemoryIOSystem.html#ioctl
  Function
  Method
  PUBLIC
  Perform some configuration change to the in-memory state for the given file descriptor.
- twisted.pair.testing.MemoryIOSystem.sendUDP
  twisted.pair.testing.MemoryIOSystem.html#sendUDP
  Function
  Method
  PUBLIC
  Write an ethernet frame containing an ip datagram containing a udp datagram containing the given payload, addressed to the given address, to a tunnel device previously opened on this I/O system.
- twisted.pair.testing.MemoryIOSystem.receiveUDP
  twisted.pair.testing.MemoryIOSystem.html#receiveUDP
  Function
  Method
  PUBLIC
  Get a socket-like object which can be used to receive a datagram sent from the given address.
- twisted.pair.testing._FakePort
  twisted.pair.testing._FakePort.html
  Class
  Class
  PRIVATE
  A socket-like object which can be used to read UDP datagrams from tunnel-like file descriptors managed by a `MemoryIOSystem`.
- twisted.pair.testing._FakePort.__init__
  twisted.pair.testing._FakePort.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.pair.testing._FakePort._system
  twisted.pair.testing._FakePort.html#_system
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.pair.testing._FakePort._fileno
  twisted.pair.testing._FakePort.html#_fileno
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.pair.testing._FakePort.recv
  twisted.pair.testing._FakePort.html#recv
  Function
  Method
  PUBLIC
  Receive a datagram sent to this port using the `MemoryIOSystem` which created this object.
- twisted.persisted.aot.Named
  twisted.persisted.aot.Named.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.persisted.aot.Named.__init__
  twisted.persisted.aot.Named.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.persisted.aot.Named.name
  twisted.persisted.aot.Named.html#name
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.persisted.aot.Class
  twisted.persisted.aot.Class.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.persisted.aot.Class.getSource
  twisted.persisted.aot.Class.html#getSource
  Function
  Method
  PUBLIC
  Undocumented
- twisted.persisted.aot.Function
  twisted.persisted.aot.Function.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.persisted.aot.Function.getSource
  twisted.persisted.aot.Function.html#getSource
  Function
  Method
  PUBLIC
  Undocumented
- twisted.persisted.aot.Module
  twisted.persisted.aot.Module.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.persisted.aot.Module.getSource
  twisted.persisted.aot.Module.html#getSource
  Function
  Method
  PUBLIC
  Undocumented
- twisted.persisted.aot.InstanceMethod
  twisted.persisted.aot.InstanceMethod.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.persisted.aot.InstanceMethod.__init__
  twisted.persisted.aot.InstanceMethod.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.persisted.aot.InstanceMethod.name
  twisted.persisted.aot.InstanceMethod.html#name
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.persisted.aot.InstanceMethod.klass
  twisted.persisted.aot.InstanceMethod.html#klass
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.persisted.aot.InstanceMethod.instance
  twisted.persisted.aot.InstanceMethod.html#instance
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.persisted.aot.InstanceMethod.getSource
  twisted.persisted.aot.InstanceMethod.html#getSource
  Function
  Method
  PUBLIC
  Undocumented
- twisted.persisted.aot._NoStateObj
  twisted.persisted.aot._NoStateObj.html
  Class
  Class
  PRIVATE
  Undocumented
- twisted.persisted.aot.NoStateObj
  twisted.persisted.aot.html#NoStateObj
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.persisted.aot._SIMPLE_BUILTINS
  twisted.persisted.aot.html#_SIMPLE_BUILTINS
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.persisted.aot.Instance
  twisted.persisted.aot.Instance.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.persisted.aot.Instance.__init__
  twisted.persisted.aot.Instance.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.persisted.aot.Instance.klass
  twisted.persisted.aot.Instance.html#klass
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.persisted.aot.Instance.state
  twisted.persisted.aot.Instance.html#state
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.persisted.aot.Instance.stateIsDict
  twisted.persisted.aot.Instance.html#stateIsDict
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.persisted.aot.Instance.getSource
  twisted.persisted.aot.Instance.html#getSource
  Function
  Method
  PUBLIC
  Undocumented
- twisted.persisted.aot.Ref
  twisted.persisted.aot.Ref.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.persisted.aot.Ref.__init__
  twisted.persisted.aot.Ref.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.persisted.aot.Ref.refnum
  twisted.persisted.aot.Ref.html#refnum
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.persisted.aot.Ref.obj
  twisted.persisted.aot.Ref.html#obj
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.persisted.aot.Ref.setRef
  twisted.persisted.aot.Ref.html#setRef
  Function
  Method
  PUBLIC
  Undocumented
- twisted.persisted.aot.Ref.setObj
  twisted.persisted.aot.Ref.html#setObj
  Function
  Method
  PUBLIC
  Undocumented
- twisted.persisted.aot.Ref.getSource
  twisted.persisted.aot.Ref.html#getSource
  Function
  Method
  PUBLIC
  Undocumented
- twisted.persisted.aot.Deref
  twisted.persisted.aot.Deref.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.persisted.aot.Deref.__init__
  twisted.persisted.aot.Deref.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.persisted.aot.Deref.refnum
  twisted.persisted.aot.Deref.html#refnum
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.persisted.aot.Deref.getSource
  twisted.persisted.aot.Deref.html#getSource
  Function
  Method
  PUBLIC
  Undocumented
- twisted.persisted.aot.Copyreg
  twisted.persisted.aot.Copyreg.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.persisted.aot.Copyreg.__init__
  twisted.persisted.aot.Copyreg.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.persisted.aot.Copyreg.loadfunc
  twisted.persisted.aot.Copyreg.html#loadfunc
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.persisted.aot.Copyreg.state
  twisted.persisted.aot.Copyreg.html#state
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.persisted.aot.Copyreg.getSource
  twisted.persisted.aot.Copyreg.html#getSource
  Function
  Method
  PUBLIC
  Undocumented
- twisted.persisted.aot.getSource
  twisted.persisted.aot.html#getSource
  Function
  Function
  PUBLIC
  Pass me an AO, I'll return a nicely-formatted source representation.
- twisted.persisted.aot.NonFormattableDict
  twisted.persisted.aot.NonFormattableDict.html
  Class
  Exception
  PUBLIC
  A dictionary was not formattable.
- twisted.persisted.aot.r
  twisted.persisted.aot.html#r
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.persisted.aot.dictToKW
  twisted.persisted.aot.html#dictToKW
  Function
  Function
  PUBLIC
  Undocumented
- twisted.persisted.aot.prettify
  twisted.persisted.aot.html#prettify
  Function
  Function
  PUBLIC
  Undocumented
- twisted.persisted.aot.indentify
  twisted.persisted.aot.html#indentify
  Function
  Function
  PUBLIC
  Undocumented
- twisted.persisted.aot.unjellyFromAOT
  twisted.persisted.aot.html#unjellyFromAOT
  Function
  Function
  PUBLIC
  Pass me an Abstract Object Tree, and I'll unjelly it for you.
- twisted.persisted.aot.unjellyFromSource
  twisted.persisted.aot.html#unjellyFromSource
  Function
  Function
  PUBLIC
  Pass me a string of code or a filename that defines an 'app' variable (in terms of Abstract Objects!), and I'll execute it and unjelly the resulting AOT for you, returning a newly unpersisted Application object!...
- twisted.persisted.aot.AOTUnjellier
  twisted.persisted.aot.AOTUnjellier.html
  Class
  Class
  PUBLIC
  I handle the unjellying of an Abstract Object Tree. See AOTUnjellier.unjellyAO
- twisted.persisted.aot.AOTUnjellier.__init__
  twisted.persisted.aot.AOTUnjellier.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.persisted.aot.AOTUnjellier.references
  twisted.persisted.aot.AOTUnjellier.html#references
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.persisted.aot.AOTUnjellier.stack
  twisted.persisted.aot.AOTUnjellier.html#stack
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.persisted.aot.AOTUnjellier.afterUnjelly
  twisted.persisted.aot.AOTUnjellier.html#afterUnjelly
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.persisted.aot.AOTUnjellier.unjellyLater
  twisted.persisted.aot.AOTUnjellier.html#unjellyLater
  Function
  Method
  PUBLIC
  Unjelly a node, later.
- twisted.persisted.aot.AOTUnjellier.unjellyInto
  twisted.persisted.aot.AOTUnjellier.html#unjellyInto
  Function
  Method
  PUBLIC
  Utility method for unjellying one object into another. This automates the handling of backreferences.
- twisted.persisted.aot.AOTUnjellier.callAfter
  twisted.persisted.aot.AOTUnjellier.html#callAfter
  Function
  Method
  PUBLIC
  Undocumented
- twisted.persisted.aot.AOTUnjellier.unjellyAttribute
  twisted.persisted.aot.AOTUnjellier.html#unjellyAttribute
  Function
  Method
  PUBLIC
  Utility method for unjellying into instances of attributes.
- twisted.persisted.aot.AOTUnjellier.unjellyAO
  twisted.persisted.aot.AOTUnjellier.html#unjellyAO
  Function
  Method
  PUBLIC
  Unjelly an Abstract Object and everything it contains. I return the real object.
- twisted.persisted.aot.AOTUnjellier.unjelly
  twisted.persisted.aot.AOTUnjellier.html#unjelly
  Function
  Method
  PUBLIC
  Undocumented
- twisted.persisted.aot.jellyToAOT
  twisted.persisted.aot.html#jellyToAOT
  Function
  Function
  PUBLIC
  Convert an object to an Abstract Object Tree.
- twisted.persisted.aot.jellyToSource
  twisted.persisted.aot.html#jellyToSource
  Function
  Function
  PUBLIC
  Pass me an object and, optionally, a file object. I'll convert the object to an AOT either return it (if no file was specified) or write it to the file.
- twisted.persisted.aot._classOfMethod
  twisted.persisted.aot.html#_classOfMethod
  Function
  Function
  PRIVATE
  Get the associated class of the given method object.
- twisted.persisted.aot._funcOfMethod
  twisted.persisted.aot.html#_funcOfMethod
  Function
  Function
  PRIVATE
  Get the associated function of the given method object.
- twisted.persisted.aot._selfOfMethod
  twisted.persisted.aot.html#_selfOfMethod
  Function
  Function
  PRIVATE
  Get the object that a bound method is bound to.
- twisted.persisted.aot.AOTJellier
  twisted.persisted.aot.AOTJellier.html
  Class
  Class
  PUBLIC
  No class docstring; 0/3 instance variable, 2/4 methods documented
- twisted.persisted.aot.AOTJellier.__init__
  twisted.persisted.aot.AOTJellier.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.persisted.aot.AOTJellier.prepared
  twisted.persisted.aot.AOTJellier.html#prepared
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.persisted.aot.AOTJellier._ref_id
  twisted.persisted.aot.AOTJellier.html#_ref_id
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.persisted.aot.AOTJellier.stack
  twisted.persisted.aot.AOTJellier.html#stack
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.persisted.aot.AOTJellier.prepareForRef
  twisted.persisted.aot.AOTJellier.html#prepareForRef
  Function
  Method
  PUBLIC
  I prepare an object for later referencing, by storing its id() and its _AORef in a cache.
- twisted.persisted.aot.AOTJellier.jellyToAO
  twisted.persisted.aot.AOTJellier.html#jellyToAO
  Function
  Method
  PUBLIC
  I turn an object into an AOT and return it.
- twisted.persisted.aot.AOTJellier.jelly
  twisted.persisted.aot.AOTJellier.html#jelly
  Function
  Method
  PUBLIC
  Undocumented
- twisted.plugins.cred_memory.inMemoryCheckerFactoryHelp
  twisted.plugins.cred_memory.html#inMemoryCheckerFactoryHelp
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.plugins.cred_memory.InMemoryCheckerFactory
  twisted.plugins.cred_memory.InMemoryCheckerFactory.html
  Class
  Class
  PUBLIC
  A factory for in-memory credentials checkers.
- twisted.plugins.cred_memory.InMemoryCheckerFactory.authType
  twisted.plugins.cred_memory.InMemoryCheckerFactory.html#authType
  Attribute
  Class Variable
  PUBLIC
  A tag that identifies the authentication method.
- twisted.plugins.cred_memory.InMemoryCheckerFactory.argStringFormat
  twisted.plugins.cred_memory.InMemoryCheckerFactory.html#argStringFormat
  Attribute
  Class Variable
  PUBLIC
  A short (one-line) description of the argument string format.
- twisted.plugins.cred_memory.InMemoryCheckerFactory.credentialInterfaces
  twisted.plugins.cred_memory.InMemoryCheckerFactory.html#credentialInterfaces
  Attribute
  Class Variable
  PUBLIC
  A list of credentials interfaces that this factory will support.
- twisted.plugins.cred_memory.InMemoryCheckerFactory.generateChecker
  twisted.plugins.cred_memory.InMemoryCheckerFactory.html#generateChecker
  Function
  Method
  PUBLIC
  This checker factory expects to get a list of username:password pairs, with each pair also separated by a colon. For example, the string 'alice:f:bob:g' would generate two users, one named 'alice' and one named 'bob'.
- twisted.plugins.cred_memory.theInMemoryCheckerFactory
  twisted.plugins.cred_memory.html#theInMemoryCheckerFactory
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.plugins.cred_sshkeys.sshKeyCheckerFactoryHelp
  twisted.plugins.cred_sshkeys.html#sshKeyCheckerFactoryHelp
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.plugins.cred_sshkeys.SSHKeyCheckerFactory
  twisted.plugins.cred_sshkeys.SSHKeyCheckerFactory.html
  Class
  Class
  PUBLIC
  Generates checkers that will authenticate a SSH public key
- twisted.plugins.cred_sshkeys.SSHKeyCheckerFactory.authType
  twisted.plugins.cred_sshkeys.SSHKeyCheckerFactory.html#authType
  Attribute
  Class Variable
  PUBLIC
  A tag that identifies the authentication method.
- twisted.plugins.cred_sshkeys.SSHKeyCheckerFactory.argStringFormat
  twisted.plugins.cred_sshkeys.SSHKeyCheckerFactory.html#argStringFormat
  Attribute
  Class Variable
  PUBLIC
  A short (one-line) description of the argument string format.
- twisted.plugins.cred_sshkeys.SSHKeyCheckerFactory.generateChecker
  twisted.plugins.cred_sshkeys.SSHKeyCheckerFactory.html#generateChecker
  Function
  Method
  PUBLIC
  This checker factory ignores the argument string. Everything needed to authenticate users is pulled out of the public keys listed in user .ssh/ directories.
- twisted.plugins.cred_sshkeys.theSSHKeyCheckerFactory
  twisted.plugins.cred_sshkeys.html#theSSHKeyCheckerFactory
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.plugins.twisted_conch.TwistedSSH
  twisted.plugins.twisted_conch.html#TwistedSSH
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.plugins.twisted_conch.TwistedManhole
  twisted.plugins.twisted_conch.html#TwistedManhole
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.protocols.haproxy._interfaces.IProxyInfo
  twisted.protocols.haproxy._interfaces.IProxyInfo.html
  Class
  Interface
  PUBLIC
  Data container for PROXY protocol header data.
- twisted.protocols.haproxy._interfaces.IProxyInfo.header
  twisted.protocols.haproxy._interfaces.IProxyInfo.html#header
  Attribute
  Attribute
  PUBLIC
  The raw byestring that represents the PROXY protocol header.
- twisted.protocols.haproxy._interfaces.IProxyInfo.source
  twisted.protocols.haproxy._interfaces.IProxyInfo.html#source
  Attribute
  Attribute
  PUBLIC
  An `twisted.internet.interfaces.IAddress` representing the connection source.
- twisted.protocols.haproxy._interfaces.IProxyInfo.destination
  twisted.protocols.haproxy._interfaces.IProxyInfo.html#destination
  Attribute
  Attribute
  PUBLIC
  An `twisted.internet.interfaces.IAddress` representing the connection destination.
- twisted.protocols.haproxy._interfaces.IProxyParser
  twisted.protocols.haproxy._interfaces.IProxyParser.html
  Class
  Interface
  PUBLIC
  Streaming parser that handles PROXY protocol headers.
- twisted.protocols.haproxy._interfaces.IProxyParser.feed
  twisted.protocols.haproxy._interfaces.IProxyParser.html#feed
  Function
  Method
  PUBLIC
  Consume a chunk of data and attempt to parse it.
- twisted.protocols.haproxy._interfaces.IProxyParser.parse
  twisted.protocols.haproxy._interfaces.IProxyParser.html#parse
  Function
  Method
  PUBLIC
  Parse a bytestring as a full PROXY protocol header line.
- twisted.protocols.haproxy._info.ProxyInfo
  twisted.protocols.haproxy._info.ProxyInfo.html
  Class
  Class
  PUBLIC
  A data container for parsed PROXY protocol information.
- twisted.protocols.haproxy._info.ProxyInfo.header
  twisted.protocols.haproxy._info.ProxyInfo.html#header
  Attribute
  Instance Variable
  PUBLIC
  The raw header bytes extracted from the connection.
- twisted.protocols.haproxy._info.ProxyInfo.source
  twisted.protocols.haproxy._info.ProxyInfo.html#source
  Attribute
  Instance Variable
  PUBLIC
  The connection source address.
- twisted.protocols.haproxy._info.ProxyInfo.destination
  twisted.protocols.haproxy._info.ProxyInfo.html#destination
  Attribute
  Instance Variable
  PUBLIC
  The connection destination address.
- twisted.protocols.haproxy._exceptions.InvalidProxyHeader
  twisted.protocols.haproxy._exceptions.InvalidProxyHeader.html
  Class
  Exception
  PUBLIC
  The provided PROXY protocol header is invalid.
- twisted.protocols.haproxy._exceptions.InvalidNetworkProtocol
  twisted.protocols.haproxy._exceptions.InvalidNetworkProtocol.html
  Class
  Exception
  PUBLIC
  The network protocol was not one of TCP4 TCP6 or UNKNOWN.
- twisted.protocols.haproxy._exceptions.MissingAddressData
  twisted.protocols.haproxy._exceptions.MissingAddressData.html
  Class
  Exception
  PUBLIC
  The address data is missing or incomplete.
- twisted.protocols.haproxy._exceptions.convertError
  twisted.protocols.haproxy._exceptions.html#convertError
  Function
  Function
  PUBLIC
  Convert an error into a different error type.
- twisted.protocols.haproxy._v1parser.V1Parser
  twisted.protocols.haproxy._v1parser.V1Parser.html
  Class
  Class
  PUBLIC
  PROXY protocol version one header parser.
- twisted.protocols.haproxy._v1parser.V1Parser.PROXYSTR
  twisted.protocols.haproxy._v1parser.V1Parser.html#PROXYSTR
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.haproxy._v1parser.V1Parser.UNKNOWN_PROTO
  twisted.protocols.haproxy._v1parser.V1Parser.html#UNKNOWN_PROTO
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.haproxy._v1parser.V1Parser.TCP4_PROTO
  twisted.protocols.haproxy._v1parser.V1Parser.html#TCP4_PROTO
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.haproxy._v1parser.V1Parser.TCP6_PROTO
  twisted.protocols.haproxy._v1parser.V1Parser.html#TCP6_PROTO
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.haproxy._v1parser.V1Parser.ALLOWED_NET_PROTOS
  twisted.protocols.haproxy._v1parser.V1Parser.html#ALLOWED_NET_PROTOS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.haproxy._v1parser.V1Parser.NEWLINE
  twisted.protocols.haproxy._v1parser.V1Parser.html#NEWLINE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.haproxy._v1parser.V1Parser.__init__
  twisted.protocols.haproxy._v1parser.V1Parser.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.haproxy._v1parser.V1Parser.buffer
  twisted.protocols.haproxy._v1parser.V1Parser.html#buffer
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.haproxy._v1parser.V1Parser.feed
  twisted.protocols.haproxy._v1parser.V1Parser.html#feed
  Function
  Method
  PUBLIC
  Consume a chunk of data and attempt to parse it.
- twisted.protocols.haproxy._v1parser.V1Parser.parse
  twisted.protocols.haproxy._v1parser.V1Parser.html#parse
  Function
  Class Method
  PUBLIC
  Parse a bytestring as a full PROXY protocol header line.
- twisted.protocols.haproxy._v2parser.NetFamily
  twisted.protocols.haproxy._v2parser.NetFamily.html
  Class
  Class
  PUBLIC
  Values for the 'family' field.
- twisted.protocols.haproxy._v2parser.NetFamily.UNSPEC
  twisted.protocols.haproxy._v2parser.NetFamily.html#UNSPEC
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.haproxy._v2parser.NetFamily.INET
  twisted.protocols.haproxy._v2parser.NetFamily.html#INET
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.haproxy._v2parser.NetFamily.INET6
  twisted.protocols.haproxy._v2parser.NetFamily.html#INET6
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.haproxy._v2parser.NetFamily.UNIX
  twisted.protocols.haproxy._v2parser.NetFamily.html#UNIX
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.haproxy._v2parser.NetProtocol
  twisted.protocols.haproxy._v2parser.NetProtocol.html
  Class
  Class
  PUBLIC
  Values for 'protocol' field.
- twisted.protocols.haproxy._v2parser.NetProtocol.UNSPEC
  twisted.protocols.haproxy._v2parser.NetProtocol.html#UNSPEC
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.haproxy._v2parser.NetProtocol.STREAM
  twisted.protocols.haproxy._v2parser.NetProtocol.html#STREAM
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.haproxy._v2parser.NetProtocol.DGRAM
  twisted.protocols.haproxy._v2parser.NetProtocol.html#DGRAM
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.haproxy._v2parser._HIGH
  twisted.protocols.haproxy._v2parser.html#_HIGH
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.protocols.haproxy._v2parser._LOW
  twisted.protocols.haproxy._v2parser.html#_LOW
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.protocols.haproxy._v2parser._LOCALCOMMAND
  twisted.protocols.haproxy._v2parser.html#_LOCALCOMMAND
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.protocols.haproxy._v2parser._PROXYCOMMAND
  twisted.protocols.haproxy._v2parser.html#_PROXYCOMMAND
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.protocols.haproxy._v2parser.V2Parser
  twisted.protocols.haproxy._v2parser.V2Parser.html
  Class
  Class
  PUBLIC
  PROXY protocol version two header parser.
- twisted.protocols.haproxy._v2parser.V2Parser.PREFIX
  twisted.protocols.haproxy._v2parser.V2Parser.html#PREFIX
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.haproxy._v2parser.V2Parser.VERSIONS
  twisted.protocols.haproxy._v2parser.V2Parser.html#VERSIONS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.haproxy._v2parser.V2Parser.COMMANDS
  twisted.protocols.haproxy._v2parser.V2Parser.html#COMMANDS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.haproxy._v2parser.V2Parser.ADDRESSFORMATS
  twisted.protocols.haproxy._v2parser.V2Parser.html#ADDRESSFORMATS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.haproxy._v2parser.V2Parser.__init__
  twisted.protocols.haproxy._v2parser.V2Parser.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.haproxy._v2parser.V2Parser.buffer
  twisted.protocols.haproxy._v2parser.V2Parser.html#buffer
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.haproxy._v2parser.V2Parser.feed
  twisted.protocols.haproxy._v2parser.V2Parser.html#feed
  Function
  Method
  PUBLIC
  Consume a chunk of data and attempt to parse it.
- twisted.protocols.haproxy._v2parser.V2Parser._bytesToIPv4
  twisted.protocols.haproxy._v2parser.V2Parser.html#_bytesToIPv4
  Function
  Static Method
  PRIVATE
  Convert packed 32-bit IPv4 address bytes into a dotted-quad ASCII bytes representation of that address.
- twisted.protocols.haproxy._v2parser.V2Parser._bytesToIPv6
  twisted.protocols.haproxy._v2parser.V2Parser.html#_bytesToIPv6
  Function
  Static Method
  PRIVATE
  Convert packed 128-bit IPv6 address bytes into a colon-separated ASCII bytes representation of that address.
- twisted.protocols.haproxy._v2parser.V2Parser.parse
  twisted.protocols.haproxy._v2parser.V2Parser.html#parse
  Function
  Class Method
  PUBLIC
  Parse a bytestring as a full PROXY protocol header.
- twisted.protocols.haproxy._wrapper.HAProxyProtocolWrapper
  twisted.protocols.haproxy._wrapper.HAProxyProtocolWrapper.html
  Class
  Class
  PUBLIC
  A Protocol wrapper that provides HAProxy support.
- twisted.protocols.haproxy._wrapper.HAProxyProtocolWrapper.__init__
  twisted.protocols.haproxy._wrapper.HAProxyProtocolWrapper.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.haproxy._wrapper.HAProxyProtocolWrapper._proxyInfo
  twisted.protocols.haproxy._wrapper.HAProxyProtocolWrapper.html#_proxyInfo
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.protocols.haproxy._wrapper.HAProxyProtocolWrapper._parser
  twisted.protocols.haproxy._wrapper.HAProxyProtocolWrapper.html#_parser
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.protocols.haproxy._wrapper.HAProxyProtocolWrapper.dataReceived
  twisted.protocols.haproxy._wrapper.HAProxyProtocolWrapper.html#dataReceived
  Function
  Method
  PUBLIC
  Called whenever data is received.
- twisted.protocols.haproxy._wrapper.HAProxyProtocolWrapper.getPeer
  twisted.protocols.haproxy._wrapper.HAProxyProtocolWrapper.html#getPeer
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.haproxy._wrapper.HAProxyProtocolWrapper.getHost
  twisted.protocols.haproxy._wrapper.HAProxyProtocolWrapper.html#getHost
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.haproxy._wrapper.HAProxyWrappingFactory
  twisted.protocols.haproxy._wrapper.HAProxyWrappingFactory.html
  Class
  Class
  PUBLIC
  A Factory wrapper that adds PROXY protocol support to connections.
- twisted.protocols.haproxy._wrapper.HAProxyWrappingFactory.logPrefix
  twisted.protocols.haproxy._wrapper.HAProxyWrappingFactory.html#logPrefix
  Function
  Method
  PUBLIC
  Annotate the wrapped factory's log prefix with some text indicating the PROXY protocol is in use.
- twisted.protocols.haproxy.proxyEndpoint
  twisted.protocols.haproxy.html#proxyEndpoint
  Function
  Function
  PUBLIC
  Wrap an endpoint with PROXY protocol support, so that the transport's `getHost` and `getPeer` methods reflect the attributes of the proxied connection rather than the underlying connection.
- twisted.protocols.haproxy._parser.unparseEndpoint
  twisted.protocols.haproxy._parser.html#unparseEndpoint
  Function
  Function
  PUBLIC
  Un-parse the already-parsed args and kwargs back into endpoint syntax.
- twisted.protocols.haproxy._parser.HAProxyServerParser
  twisted.protocols.haproxy._parser.HAProxyServerParser.html
  Class
  Class
  PUBLIC
  Stream server endpoint string parser for the HAProxyServerEndpoint type.
- twisted.protocols.haproxy._parser.HAProxyServerParser.prefix
  twisted.protocols.haproxy._parser.HAProxyServerParser.html#prefix
  Attribute
  Instance Variable
  PUBLIC
  See `IStreamServerEndpointStringParser.prefix`.
- twisted.protocols.haproxy._parser.HAProxyServerParser.parseStreamServer
  twisted.protocols.haproxy._parser.HAProxyServerParser.html#parseStreamServer
  Function
  Method
  PUBLIC
  Parse a stream server endpoint from a reactor and string-only arguments and keyword arguments.
- twisted.plugins.twisted_core.systemdEndpointParser
  twisted.plugins.twisted_core.html#systemdEndpointParser
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.plugins.twisted_core.tcp6ServerEndpointParser
  twisted.plugins.twisted_core.html#tcp6ServerEndpointParser
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.plugins.twisted_core.stdioEndpointParser
  twisted.plugins.twisted_core.html#stdioEndpointParser
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.plugins.twisted_core.tlsClientEndpointParser
  twisted.plugins.twisted_core.html#tlsClientEndpointParser
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.plugins.twisted_core._haProxyServerEndpointParser
  twisted.plugins.twisted_core.html#_haProxyServerEndpointParser
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.plugins.twisted_ftp.TwistedFTP
  twisted.plugins.twisted_ftp.html#TwistedFTP
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.plugins.twisted_inet.TwistedINETD
  twisted.plugins.twisted_inet.html#TwistedINETD
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.plugins.twisted_mail.TwistedMail
  twisted.plugins.twisted_mail.html#TwistedMail
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.plugins.twisted_names.TwistedNames
  twisted.plugins.twisted_names.html#TwistedNames
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.plugins.twisted_portforward.TwistedPortForward
  twisted.plugins.twisted_portforward.html#TwistedPortForward
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.plugins.twisted_reactors.default
  twisted.plugins.twisted_reactors.html#default
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.plugins.twisted_reactors.select
  twisted.plugins.twisted_reactors.html#select
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.plugins.twisted_reactors.poll
  twisted.plugins.twisted_reactors.html#poll
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.plugins.twisted_reactors.epoll
  twisted.plugins.twisted_reactors.html#epoll
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.plugins.twisted_reactors.kqueue
  twisted.plugins.twisted_reactors.html#kqueue
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.plugins.twisted_reactors.cf
  twisted.plugins.twisted_reactors.html#cf
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.plugins.twisted_reactors.asyncio
  twisted.plugins.twisted_reactors.html#asyncio
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.plugins.twisted_reactors.wx
  twisted.plugins.twisted_reactors.html#wx
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.plugins.twisted_reactors.gi
  twisted.plugins.twisted_reactors.html#gi
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.plugins.twisted_reactors.gtk3
  twisted.plugins.twisted_reactors.html#gtk3
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.plugins.twisted_reactors.gtk2
  twisted.plugins.twisted_reactors.html#gtk2
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.plugins.twisted_reactors.glib2
  twisted.plugins.twisted_reactors.html#glib2
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.plugins.twisted_reactors.win32er
  twisted.plugins.twisted_reactors.html#win32er
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.plugins.twisted_reactors.iocp
  twisted.plugins.twisted_reactors.html#iocp
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.plugins.twisted_runner.TwistedProcmon
  twisted.plugins.twisted_runner.html#TwistedProcmon
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.plugins.twisted_socks.TwistedSOCKS
  twisted.plugins.twisted_socks.html#TwistedSOCKS
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.plugins.twisted_trial._Reporter
  twisted.plugins.twisted_trial._Reporter.html
  Class
  Class
  PRIVATE
  Undocumented
- twisted.plugins.twisted_trial._Reporter.__init__
  twisted.plugins.twisted_trial._Reporter.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.plugins.twisted_trial._Reporter.name
  twisted.plugins.twisted_trial._Reporter.html#name
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.plugins.twisted_trial._Reporter.module
  twisted.plugins.twisted_trial._Reporter.html#module
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.plugins.twisted_trial._Reporter.description
  twisted.plugins.twisted_trial._Reporter.html#description
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.plugins.twisted_trial._Reporter.longOpt
  twisted.plugins.twisted_trial._Reporter.html#longOpt
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.plugins.twisted_trial._Reporter.shortOpt
  twisted.plugins.twisted_trial._Reporter.html#shortOpt
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.plugins.twisted_trial._Reporter.klass
  twisted.plugins.twisted_trial._Reporter.html#klass
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.plugins.twisted_trial._Reporter.stream
  twisted.plugins.twisted_trial._Reporter.html#stream
  Attribute
  Property
  PUBLIC
  Undocumented
- twisted.plugins.twisted_trial._Reporter.tbformat
  twisted.plugins.twisted_trial._Reporter.html#tbformat
  Attribute
  Property
  PUBLIC
  Undocumented
- twisted.plugins.twisted_trial._Reporter.args
  twisted.plugins.twisted_trial._Reporter.html#args
  Attribute
  Property
  PUBLIC
  Undocumented
- twisted.plugins.twisted_trial._Reporter.shouldStop
  twisted.plugins.twisted_trial._Reporter.html#shouldStop
  Attribute
  Property
  PUBLIC
  A boolean indicating that this reporter would like the test run to stop.
- twisted.plugins.twisted_trial._Reporter.separator
  twisted.plugins.twisted_trial._Reporter.html#separator
  Attribute
  Property
  PUBLIC
  Undocumented
- twisted.plugins.twisted_trial._Reporter.testsRun
  twisted.plugins.twisted_trial._Reporter.html#testsRun
  Attribute
  Property
  PUBLIC
  The number of tests that seem to have been run according to this reporter.
- twisted.plugins.twisted_trial._Reporter.addError
  twisted.plugins.twisted_trial._Reporter.html#addError
  Function
  Method
  PUBLIC
  Record that a test has raised an unexpected exception.
- twisted.plugins.twisted_trial._Reporter.addExpectedFailure
  twisted.plugins.twisted_trial._Reporter.html#addExpectedFailure
  Function
  Method
  PUBLIC
  Record that the given test failed, and was expected to do so.
- twisted.plugins.twisted_trial._Reporter.addFailure
  twisted.plugins.twisted_trial._Reporter.html#addFailure
  Function
  Method
  PUBLIC
  Record that a test has failed with the given failure.
- twisted.plugins.twisted_trial._Reporter.addSkip
  twisted.plugins.twisted_trial._Reporter.html#addSkip
  Function
  Method
  PUBLIC
  Record that a test has been skipped for the given reason.
- twisted.plugins.twisted_trial._Reporter.addSuccess
  twisted.plugins.twisted_trial._Reporter.html#addSuccess
  Function
  Method
  PUBLIC
  Record that test passed.
- twisted.plugins.twisted_trial._Reporter.addUnexpectedSuccess
  twisted.plugins.twisted_trial._Reporter.html#addUnexpectedSuccess
  Function
  Method
  PUBLIC
  Record that the given test failed, and was expected to do so.
- twisted.plugins.twisted_trial._Reporter.cleanupErrors
  twisted.plugins.twisted_trial._Reporter.html#cleanupErrors
  Function
  Method
  PUBLIC
  Undocumented
- twisted.plugins.twisted_trial._Reporter.done
  twisted.plugins.twisted_trial._Reporter.html#done
  Function
  Method
  PUBLIC
  Called when the test run is complete.
- twisted.plugins.twisted_trial._Reporter.endSuite
  twisted.plugins.twisted_trial._Reporter.html#endSuite
  Function
  Method
  PUBLIC
  Undocumented
- twisted.plugins.twisted_trial._Reporter.printErrors
  twisted.plugins.twisted_trial._Reporter.html#printErrors
  Function
  Method
  PUBLIC
  Undocumented
- twisted.plugins.twisted_trial._Reporter.printSummary
  twisted.plugins.twisted_trial._Reporter.html#printSummary
  Function
  Method
  PUBLIC
  Undocumented
- twisted.plugins.twisted_trial._Reporter.startSuite
  twisted.plugins.twisted_trial._Reporter.html#startSuite
  Function
  Method
  PUBLIC
  Undocumented
- twisted.plugins.twisted_trial._Reporter.startTest
  twisted.plugins.twisted_trial._Reporter.html#startTest
  Function
  Method
  PUBLIC
  Report the beginning of a run of a single test method.
- twisted.plugins.twisted_trial._Reporter.stopTest
  twisted.plugins.twisted_trial._Reporter.html#stopTest
  Function
  Method
  PUBLIC
  Report the status of a single test method
- twisted.plugins.twisted_trial._Reporter.upDownError
  twisted.plugins.twisted_trial._Reporter.html#upDownError
  Function
  Method
  PUBLIC
  Undocumented
- twisted.plugins.twisted_trial._Reporter.wasSuccessful
  twisted.plugins.twisted_trial._Reporter.html#wasSuccessful
  Function
  Method
  PUBLIC
  Return a boolean indicating whether all test results that were reported to this reporter were successful or not.
- twisted.plugins.twisted_trial._Reporter.write
  twisted.plugins.twisted_trial._Reporter.html#write
  Function
  Method
  PUBLIC
  Undocumented
- twisted.plugins.twisted_trial._Reporter.writeln
  twisted.plugins.twisted_trial._Reporter.html#writeln
  Function
  Method
  PUBLIC
  Undocumented
- twisted.plugins.twisted_trial.Tree
  twisted.plugins.twisted_trial.html#Tree
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.plugins.twisted_trial.BlackAndWhite
  twisted.plugins.twisted_trial.html#BlackAndWhite
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.plugins.twisted_trial.Minimal
  twisted.plugins.twisted_trial.html#Minimal
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.plugins.twisted_trial.Classic
  twisted.plugins.twisted_trial.html#Classic
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.plugins.twisted_trial.Timing
  twisted.plugins.twisted_trial.html#Timing
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.plugins.twisted_trial.Subunit
  twisted.plugins.twisted_trial.html#Subunit
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.plugins.twisted_web.TwistedWeb
  twisted.plugins.twisted_web.html#TwistedWeb
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.words.iwords.IProtocolPlugin
  twisted.words.iwords.IProtocolPlugin.html
  Class
  Interface
  PUBLIC
  Interface for plugins providing an interface to a Words service
- twisted.words.iwords.IProtocolPlugin.name
  twisted.words.iwords.IProtocolPlugin.html#name
  Attribute
  Attribute
  PUBLIC
  A single word describing what kind of interface this is (eg, irc or web)
- twisted.words.iwords.IProtocolPlugin.getFactory
  twisted.words.iwords.IProtocolPlugin.html#getFactory
  Function
  Method
  PUBLIC
  Retrieve a `twisted.internet.interfaces.IServerFactory` provider
- twisted.words.iwords.IGroup
  twisted.words.iwords.IGroup.html
  Class
  Interface
  PUBLIC
  No interface docstring; 1/1 attribute, 6/6 methods documented
- twisted.words.iwords.IGroup.name
  twisted.words.iwords.IGroup.html#name
  Attribute
  Attribute
  PUBLIC
  A short string, unique among groups.
- twisted.words.iwords.IGroup.add
  twisted.words.iwords.IGroup.html#add
  Function
  Method
  PUBLIC
  Include the given user in this group.
- twisted.words.iwords.IGroup.remove
  twisted.words.iwords.IGroup.html#remove
  Function
  Method
  PUBLIC
  Remove the given user from this group.
- twisted.words.iwords.IGroup.size
  twisted.words.iwords.IGroup.html#size
  Function
  Method
  PUBLIC
  Return the number of participants in this group.
- twisted.words.iwords.IGroup.receive
  twisted.words.iwords.IGroup.html#receive
  Function
  Method
  PUBLIC
  Broadcast the given message from the given sender to other users in group.
- twisted.words.iwords.IGroup.setMetadata
  twisted.words.iwords.IGroup.html#setMetadata
  Function
  Method
  PUBLIC
  Change the metadata associated with this group.
- twisted.words.iwords.IGroup.iterusers
  twisted.words.iwords.IGroup.html#iterusers
  Function
  Method
  PUBLIC
  Return an iterator of all users in this group.
- twisted.words.iwords.IChatClient
  twisted.words.iwords.IChatClient.html
  Class
  Interface
  PUBLIC
  Interface through which IChatService interacts with clients.
- twisted.words.iwords.IChatClient.name
  twisted.words.iwords.IChatClient.html#name
  Attribute
  Attribute
  PUBLIC
  A short string, unique among users. This will be set by the `IChatService` at login time.
- twisted.words.iwords.IChatClient.receive
  twisted.words.iwords.IChatClient.html#receive
  Function
  Method
  PUBLIC
  Callback notifying this user of the given message sent by the given user.
- twisted.words.iwords.IChatClient.groupMetaUpdate
  twisted.words.iwords.IChatClient.html#groupMetaUpdate
  Function
  Method
  PUBLIC
  Callback notifying this user that the metadata for the given group has changed.
- twisted.words.iwords.IChatClient.userJoined
  twisted.words.iwords.IChatClient.html#userJoined
  Function
  Method
  PUBLIC
  Callback notifying this user that the given user has joined the given group.
- twisted.words.iwords.IChatClient.userLeft
  twisted.words.iwords.IChatClient.html#userLeft
  Function
  Method
  PUBLIC
  Callback notifying this user that the given user has left the given group for the given reason.
- twisted.words.iwords.IUser
  twisted.words.iwords.IUser.html
  Class
  Interface
  PUBLIC
  Interface through which clients interact with IChatService.
- twisted.words.iwords.IUser.realm
  twisted.words.iwords.IUser.html#realm
  Attribute
  Attribute
  PUBLIC
  A reference to the Realm to which this user belongs. Set if and only if the user is logged in.
- twisted.words.iwords.IUser.mind
  twisted.words.iwords.IUser.html#mind
  Attribute
  Attribute
  PUBLIC
  A reference to the mind which logged in to this user. Set if and only if the user is logged in.
- twisted.words.iwords.IUser.name
  twisted.words.iwords.IUser.html#name
  Attribute
  Attribute
  PUBLIC
  A short string, unique among users.
- twisted.words.iwords.IUser.lastMessage
  twisted.words.iwords.IUser.html#lastMessage
  Attribute
  Attribute
  PUBLIC
  A POSIX timestamp indicating the time of the last message received from this user.
- twisted.words.iwords.IUser.signOn
  twisted.words.iwords.IUser.html#signOn
  Attribute
  Attribute
  PUBLIC
  A POSIX timestamp indicating this user's most recent sign on time.
- twisted.words.iwords.IUser.loggedIn
  twisted.words.iwords.IUser.html#loggedIn
  Function
  Method
  PUBLIC
  Invoked by the associated `IChatService` when login occurs.
- twisted.words.iwords.IUser.send
  twisted.words.iwords.IUser.html#send
  Function
  Method
  PUBLIC
  Send the given message to the given user or group.
- twisted.words.iwords.IUser.join
  twisted.words.iwords.IUser.html#join
  Function
  Method
  PUBLIC
  Attempt to join the given group.
- twisted.words.iwords.IUser.leave
  twisted.words.iwords.IUser.html#leave
  Function
  Method
  PUBLIC
  Discontinue participation in the given group.
- twisted.words.iwords.IUser.itergroups
  twisted.words.iwords.IUser.html#itergroups
  Function
  Method
  PUBLIC
  Return an iterator of all groups of which this user is a member.
- twisted.words.iwords.IChatService
  twisted.words.iwords.IChatService.html
  Class
  Interface
  PUBLIC
  No interface docstring; 3/3 attributes, 6/6 methods documented
- twisted.words.iwords.IChatService.name
  twisted.words.iwords.IChatService.html#name
  Attribute
  Attribute
  PUBLIC
  A short string identifying this chat service (eg, a hostname)
- twisted.words.iwords.IChatService.createGroupOnRequest
  twisted.words.iwords.IChatService.html#createGroupOnRequest
  Attribute
  Attribute
  PUBLIC
  A boolean indicating whether `getGroup` should implicitly create groups which are requested but which do not yet exist.
- twisted.words.iwords.IChatService.createUserOnRequest
  twisted.words.iwords.IChatService.html#createUserOnRequest
  Attribute
  Attribute
  PUBLIC
  A boolean indicating whether `getUser` should implicitly create users which are requested but which do not yet exist.
- twisted.words.iwords.IChatService.itergroups
  twisted.words.iwords.IChatService.html#itergroups
  Function
  Method
  PUBLIC
  Return all groups available on this service.
- twisted.words.iwords.IChatService.getGroup
  twisted.words.iwords.IChatService.html#getGroup
  Function
  Method
  PUBLIC
  Retrieve the group by the given name.
- twisted.words.iwords.IChatService.createGroup
  twisted.words.iwords.IChatService.html#createGroup
  Function
  Method
  PUBLIC
  Create a new group with the given name.
- twisted.words.iwords.IChatService.lookupGroup
  twisted.words.iwords.IChatService.html#lookupGroup
  Function
  Method
  PUBLIC
  Retrieve a group by name.
- twisted.words.iwords.IChatService.getUser
  twisted.words.iwords.IChatService.html#getUser
  Function
  Method
  PUBLIC
  Retrieve the user by the given name.
- twisted.words.iwords.IChatService.createUser
  twisted.words.iwords.IChatService.html#createUser
  Function
  Method
  PUBLIC
  Create a new user with the given name.
- twisted.plugins.twisted_words.NewTwistedWords
  twisted.plugins.twisted_words.html#NewTwistedWords
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.plugins.twisted_words.TwistedXMPPRouter
  twisted.plugins.twisted_words.html#TwistedXMPPRouter
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.plugins.twisted_words.RelayChatInterface
  twisted.plugins.twisted_words.RelayChatInterface.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.plugins.twisted_words.RelayChatInterface.name
  twisted.plugins.twisted_words.RelayChatInterface.html#name
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.plugins.twisted_words.RelayChatInterface.getFactory
  twisted.plugins.twisted_words.RelayChatInterface.html#getFactory
  Function
  Class Method
  PUBLIC
  Undocumented
- twisted.plugins.twisted_words.PBChatInterface
  twisted.plugins.twisted_words.PBChatInterface.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.plugins.twisted_words.PBChatInterface.name
  twisted.plugins.twisted_words.PBChatInterface.html#name
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.plugins.twisted_words.PBChatInterface.getFactory
  twisted.plugins.twisted_words.PBChatInterface.html#getFactory
  Function
  Class Method
  PUBLIC
  Undocumented
- twisted.positioning._sentence._BaseSentence
  twisted.positioning._sentence._BaseSentence.html
  Class
  Class
  PRIVATE
  A base sentence class for a particular protocol.
- twisted.positioning._sentence._BaseSentence.ALLOWED_ATTRIBUTES
  twisted.positioning._sentence._BaseSentence.html#ALLOWED_ATTRIBUTES
  Attribute
  Constant
  PUBLIC
  A set of attributes that are allowed in this sentence.
- twisted.positioning._sentence._BaseSentence.__init__
  twisted.positioning._sentence._BaseSentence.html#__init__
  Function
  Method
  PUBLIC
  Initializes a sentence with parsed sentence data.
- twisted.positioning._sentence._BaseSentence._sentenceData
  twisted.positioning._sentence._BaseSentence.html#_sentenceData
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.positioning._sentence._BaseSentence.presentAttributes 0
  twisted.positioning._sentence._BaseSentence.html#presentAttributes%200
  Attribute
  Instance Variable
  PUBLIC
  An iterable containing the names of the attributes that are present in this sentence.
- twisted.positioning._sentence._BaseSentence.presentAttributes
  twisted.positioning._sentence._BaseSentence.html#presentAttributes
  Attribute
  Property
  PUBLIC
  An iterable containing the names of the attributes that are present in this sentence.
- twisted.positioning._sentence._BaseSentence.__getattr__
  twisted.positioning._sentence._BaseSentence.html#__getattr__
  Function
  Method
  PUBLIC
  Gets an attribute of this sentence.
- twisted.positioning._sentence._BaseSentence.__repr__
  twisted.positioning._sentence._BaseSentence.html#__repr__
  Function
  Method
  PUBLIC
  Returns a textual representation of this sentence.
- twisted.positioning._sentence._PositioningSentenceProducerMixin
  twisted.positioning._sentence._PositioningSentenceProducerMixin.html
  Class
  Class
  PRIVATE
  A mixin for certain protocols that produce positioning sentences.
- twisted.positioning._sentence._PositioningSentenceProducerMixin.getSentenceAttributes
  twisted.positioning._sentence._PositioningSentenceProducerMixin.html#getSentenceAttributes
  Function
  Class Method
  PUBLIC
  Returns a set of all attributes that might be found in the sentences produced by this protocol.
- twisted.positioning.ipositioning.IPositioningReceiver
  twisted.positioning.ipositioning.IPositioningReceiver.html
  Class
  Interface
  PUBLIC
  An interface for positioning providers.
- twisted.positioning.ipositioning.IPositioningReceiver.positionReceived
  twisted.positioning.ipositioning.IPositioningReceiver.html#positionReceived
  Function
  Method
  PUBLIC
  Method called when a position is received.
- twisted.positioning.ipositioning.IPositioningReceiver.positionErrorReceived
  twisted.positioning.ipositioning.IPositioningReceiver.html#positionErrorReceived
  Function
  Method
  PUBLIC
  Method called when position error is received.
- twisted.positioning.ipositioning.IPositioningReceiver.timeReceived
  twisted.positioning.ipositioning.IPositioningReceiver.html#timeReceived
  Function
  Method
  PUBLIC
  Method called when time and date information arrives.
- twisted.positioning.ipositioning.IPositioningReceiver.headingReceived
  twisted.positioning.ipositioning.IPositioningReceiver.html#headingReceived
  Function
  Method
  PUBLIC
  Method called when a true heading is received.
- twisted.positioning.ipositioning.IPositioningReceiver.altitudeReceived
  twisted.positioning.ipositioning.IPositioningReceiver.html#altitudeReceived
  Function
  Method
  PUBLIC
  Method called when an altitude is received.
- twisted.positioning.ipositioning.IPositioningReceiver.speedReceived
  twisted.positioning.ipositioning.IPositioningReceiver.html#speedReceived
  Function
  Method
  PUBLIC
  Method called when the speed is received.
- twisted.positioning.ipositioning.IPositioningReceiver.climbReceived
  twisted.positioning.ipositioning.IPositioningReceiver.html#climbReceived
  Function
  Method
  PUBLIC
  Method called when the climb is received.
- twisted.positioning.ipositioning.IPositioningReceiver.beaconInformationReceived
  twisted.positioning.ipositioning.IPositioningReceiver.html#beaconInformationReceived
  Function
  Method
  PUBLIC
  Method called when positioning beacon information is received.
- twisted.positioning.ipositioning.IPositioningBeacon
  twisted.positioning.ipositioning.IPositioningBeacon.html
  Class
  Interface
  PUBLIC
  A positioning beacon.
- twisted.positioning.ipositioning.IPositioningBeacon.identifier
  twisted.positioning.ipositioning.IPositioningBeacon.html#identifier
  Attribute
  Attribute
  PUBLIC
  A unique identifier for this beacon. The type is dependent on the implementation, but must be immutable.
- twisted.positioning.ipositioning.INMEAReceiver
  twisted.positioning.ipositioning.INMEAReceiver.html
  Class
  Interface
  PUBLIC
  An object that can receive NMEA data.
- twisted.positioning.ipositioning.INMEAReceiver.sentenceReceived
  twisted.positioning.ipositioning.INMEAReceiver.html#sentenceReceived
  Function
  Method
  PUBLIC
  Method called when a sentence is received.
- twisted.positioning.base.MPS_PER_KNOT
  twisted.positioning.base.html#MPS_PER_KNOT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.positioning.base.MPS_PER_KPH
  twisted.positioning.base.html#MPS_PER_KPH
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.positioning.base.METERS_PER_FOOT
  twisted.positioning.base.html#METERS_PER_FOOT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.positioning.base.Angles
  twisted.positioning.base.Angles.html
  Class
  Class
  PUBLIC
  The types of angles.
- twisted.positioning.base.Angles.LATITUDE
  twisted.positioning.base.Angles.html#LATITUDE
  Attribute
  Constant
  PUBLIC
  Angle representing a latitude of an object.
- twisted.positioning.base.Angles.LONGITUDE
  twisted.positioning.base.Angles.html#LONGITUDE
  Attribute
  Constant
  PUBLIC
  Angle representing the longitude of an object.
- twisted.positioning.base.Angles.HEADING
  twisted.positioning.base.Angles.html#HEADING
  Attribute
  Constant
  PUBLIC
  Angle representing the heading of an object.
- twisted.positioning.base.Angles.VARIATION
  twisted.positioning.base.Angles.html#VARIATION
  Attribute
  Constant
  PUBLIC
  Angle representing a magnetic variation.
- twisted.positioning.base.Directions
  twisted.positioning.base.Directions.html
  Class
  Class
  PUBLIC
  The four cardinal directions (north, east, south, west).
- twisted.positioning.base.Directions.NORTH
  twisted.positioning.base.Directions.html#NORTH
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.positioning.base.Directions.EAST
  twisted.positioning.base.Directions.html#EAST
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.positioning.base.Directions.SOUTH
  twisted.positioning.base.Directions.html#SOUTH
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.positioning.base.Directions.WEST
  twisted.positioning.base.Directions.html#WEST
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.positioning.base.BasePositioningReceiver
  twisted.positioning.base.BasePositioningReceiver.html
  Class
  Class
  PUBLIC
  A base positioning receiver.
- twisted.positioning.base.BasePositioningReceiver.timeReceived
  twisted.positioning.base.BasePositioningReceiver.html#timeReceived
  Function
  Method
  PUBLIC
  Implements `IPositioningReceiver.timeReceived` stub.
- twisted.positioning.base.BasePositioningReceiver.headingReceived
  twisted.positioning.base.BasePositioningReceiver.html#headingReceived
  Function
  Method
  PUBLIC
  Implements `IPositioningReceiver.headingReceived` stub.
- twisted.positioning.base.BasePositioningReceiver.speedReceived
  twisted.positioning.base.BasePositioningReceiver.html#speedReceived
  Function
  Method
  PUBLIC
  Implements `IPositioningReceiver.speedReceived` stub.
- twisted.positioning.base.BasePositioningReceiver.climbReceived
  twisted.positioning.base.BasePositioningReceiver.html#climbReceived
  Function
  Method
  PUBLIC
  Implements `IPositioningReceiver.climbReceived` stub.
- twisted.positioning.base.BasePositioningReceiver.positionReceived
  twisted.positioning.base.BasePositioningReceiver.html#positionReceived
  Function
  Method
  PUBLIC
  Implements `IPositioningReceiver.positionReceived` stub.
- twisted.positioning.base.BasePositioningReceiver.positionErrorReceived
  twisted.positioning.base.BasePositioningReceiver.html#positionErrorReceived
  Function
  Method
  PUBLIC
  Implements `IPositioningReceiver.positionErrorReceived` stub.
- twisted.positioning.base.BasePositioningReceiver.altitudeReceived
  twisted.positioning.base.BasePositioningReceiver.html#altitudeReceived
  Function
  Method
  PUBLIC
  Implements `IPositioningReceiver.altitudeReceived` stub.
- twisted.positioning.base.BasePositioningReceiver.beaconInformationReceived
  twisted.positioning.base.BasePositioningReceiver.html#beaconInformationReceived
  Function
  Method
  PUBLIC
  Implements `IPositioningReceiver.beaconInformationReceived` stub.
- twisted.positioning.base.InvalidSentence
  twisted.positioning.base.InvalidSentence.html
  Class
  Exception
  PUBLIC
  An exception raised when a sentence is invalid.
- twisted.positioning.base.InvalidChecksum
  twisted.positioning.base.InvalidChecksum.html
  Class
  Exception
  PUBLIC
  An exception raised when the checksum of a sentence is invalid.
- twisted.positioning.base.Angle
  twisted.positioning.base.Angle.html
  Class
  Class
  PUBLIC
  An object representing an angle.
- twisted.positioning.base.Angle._RANGE_EXPRESSIONS
  twisted.positioning.base.Angle.html#_RANGE_EXPRESSIONS
  Attribute
  Constant
  PRIVATE
  A collection of expressions for the allowable range for the angular value of a particular coordinate value.
- twisted.positioning.base.Angle._ANGLE_TYPE_NAMES
  twisted.positioning.base.Angle.html#_ANGLE_TYPE_NAMES
  Attribute
  Constant
  PRIVATE
  English names for angle types.
- twisted.positioning.base.Angle.compareAttributes
  twisted.positioning.base.Angle.html#compareAttributes
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.positioning.base.Angle.__init__
  twisted.positioning.base.Angle.html#__init__
  Function
  Method
  PUBLIC
  Initializes an angle.
- twisted.positioning.base.Angle.angleType
  twisted.positioning.base.Angle.html#angleType
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.positioning.base.Angle._angle
  twisted.positioning.base.Angle.html#_angle
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.positioning.base.Angle.inDecimalDegrees
  twisted.positioning.base.Angle.html#inDecimalDegrees
  Attribute
  Property
  PUBLIC
  The value of this angle in decimal degrees. This value is immutable.
- twisted.positioning.base.Angle.inDegreesMinutesSeconds
  twisted.positioning.base.Angle.html#inDegreesMinutesSeconds
  Attribute
  Property
  PUBLIC
  The value of this angle as a degrees, minutes, seconds tuple. This value is immutable.
- twisted.positioning.base.Angle.setSign
  twisted.positioning.base.Angle.html#setSign
  Function
  Method
  PUBLIC
  Sets the sign of this angle.
- twisted.positioning.base.Angle.__float__
  twisted.positioning.base.Angle.html#__float__
  Function
  Method
  PUBLIC
  Returns this angle as a float.
- twisted.positioning.base.Angle.__repr__
  twisted.positioning.base.Angle.html#__repr__
  Function
  Method
  PUBLIC
  Returns a string representation of this angle.
- twisted.positioning.base.Angle._angleValueRepr
  twisted.positioning.base.Angle.html#_angleValueRepr
  Attribute
  Property
  PRIVATE
  Returns a string representation of the angular value of this angle.
- twisted.positioning.base.Angle._angleTypeNameRepr
  twisted.positioning.base.Angle.html#_angleTypeNameRepr
  Attribute
  Property
  PRIVATE
  Returns a string representation of the type of this angle.
- twisted.positioning.base.Heading
  twisted.positioning.base.Heading.html
  Class
  Class
  PUBLIC
  The heading of a mobile object.
- twisted.positioning.base.Heading.variation
  twisted.positioning.base.Heading.html#variation
  Attribute
  Instance Variable
  PUBLIC
  The (optional) magnetic variation. The sign of the variation is positive for variations towards the east (clockwise from north), and negative for variations towards the west (counterclockwise from north)...
- twisted.positioning.base.Heading.__init__
  twisted.positioning.base.Heading.html#__init__
  Function
  Method
  PUBLIC
  Initializes an angle with an optional variation.
- twisted.positioning.base.Heading.fromFloats
  twisted.positioning.base.Heading.html#fromFloats
  Function
  Class Method
  PUBLIC
  Constructs a Heading from the float values of the angle and variation.
- twisted.positioning.base.Heading.correctedHeading 0
  twisted.positioning.base.Heading.html#correctedHeading%200
  Attribute
  Instance Variable
  PUBLIC
  The heading, corrected for variation. If the variation is unknown (`None`), is None. This attribute is read-only (its value is determined by the angle and variation attributes). The value is coerced to being between 0 (inclusive) and 360 (exclusive).
- twisted.positioning.base.Heading.correctedHeading
  twisted.positioning.base.Heading.html#correctedHeading
  Attribute
  Property
  PUBLIC
  Corrects the heading by the given variation. This is sometimes known as the true heading.
- twisted.positioning.base.Heading.setSign
  twisted.positioning.base.Heading.html#setSign
  Function
  Method
  PUBLIC
  Sets the sign of the variation of this heading.
- twisted.positioning.base.Heading.compareAttributes
  twisted.positioning.base.Heading.html#compareAttributes
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.positioning.base.Heading.__repr__
  twisted.positioning.base.Heading.html#__repr__
  Function
  Method
  PUBLIC
  Returns a string representation of this angle.
- twisted.positioning.base.Coordinate
  twisted.positioning.base.Coordinate.html
  Class
  Class
  PUBLIC
  A coordinate.
- twisted.positioning.base.Coordinate.angle
  twisted.positioning.base.Coordinate.html#angle
  Attribute
  Instance Variable
  PUBLIC
  The value of the coordinate in decimal degrees, with the usual rules for sign (northern and eastern hemispheres are positive, southern and western hemispheres are negative).
- twisted.positioning.base.Coordinate.__init__
  twisted.positioning.base.Coordinate.html#__init__
  Function
  Method
  PUBLIC
  Initializes a coordinate.
- twisted.positioning.base.Coordinate.hemisphere
  twisted.positioning.base.Coordinate.html#hemisphere
  Attribute
  Property
  PUBLIC
  Gets the hemisphere of this coordinate.
- twisted.positioning.base.Altitude
  twisted.positioning.base.Altitude.html
  Class
  Class
  PUBLIC
  An altitude.
- twisted.positioning.base.Altitude.compareAttributes
  twisted.positioning.base.Altitude.html#compareAttributes
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.positioning.base.Altitude.__init__
  twisted.positioning.base.Altitude.html#__init__
  Function
  Method
  PUBLIC
  Initializes an altitude.
- twisted.positioning.base.Altitude._altitude
  twisted.positioning.base.Altitude.html#_altitude
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.positioning.base.Altitude.inFeet 0
  twisted.positioning.base.Altitude.html#inFeet%200
  Attribute
  Instance Variable
  PUBLIC
  As above, but expressed in feet.
- twisted.positioning.base.Altitude.inFeet
  twisted.positioning.base.Altitude.html#inFeet
  Attribute
  Property
  PUBLIC
  Gets the altitude this object represents, in feet.
- twisted.positioning.base.Altitude.inMeters 0
  twisted.positioning.base.Altitude.html#inMeters%200
  Attribute
  Instance Variable
  PUBLIC
  The altitude represented by this object, in meters. This attribute is read-only.
- twisted.positioning.base.Altitude.inMeters
  twisted.positioning.base.Altitude.html#inMeters
  Attribute
  Property
  PUBLIC
  Returns the altitude this object represents, in meters.
- twisted.positioning.base.Altitude.__float__
  twisted.positioning.base.Altitude.html#__float__
  Function
  Method
  PUBLIC
  Returns the altitude represented by this object expressed in meters.
- twisted.positioning.base.Altitude.__repr__
  twisted.positioning.base.Altitude.html#__repr__
  Function
  Method
  PUBLIC
  Returns a string representation of this altitude.
- twisted.positioning.base._BaseSpeed
  twisted.positioning.base._BaseSpeed.html
  Class
  Class
  PRIVATE
  An object representing the abstract concept of the speed (rate of movement) of a mobile object.
- twisted.positioning.base._BaseSpeed.compareAttributes
  twisted.positioning.base._BaseSpeed.html#compareAttributes
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.positioning.base._BaseSpeed.__init__
  twisted.positioning.base._BaseSpeed.html#__init__
  Function
  Method
  PUBLIC
  Initializes a speed.
- twisted.positioning.base._BaseSpeed._speed
  twisted.positioning.base._BaseSpeed.html#_speed
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.positioning.base._BaseSpeed.inMetersPerSecond
  twisted.positioning.base._BaseSpeed.html#inMetersPerSecond
  Attribute
  Property
  PUBLIC
  The speed that this object represents, expressed in meters per second. This attribute is immutable.
- twisted.positioning.base._BaseSpeed.inKnots
  twisted.positioning.base._BaseSpeed.html#inKnots
  Attribute
  Property
  PUBLIC
  Returns the speed represented by this object, expressed in knots. This attribute is immutable.
- twisted.positioning.base._BaseSpeed.__float__
  twisted.positioning.base._BaseSpeed.html#__float__
  Function
  Method
  PUBLIC
  Returns the speed represented by this object expressed in meters per second.
- twisted.positioning.base._BaseSpeed.__repr__
  twisted.positioning.base._BaseSpeed.html#__repr__
  Function
  Method
  PUBLIC
  Returns a string representation of this speed object.
- twisted.positioning.base.Speed
  twisted.positioning.base.Speed.html
  Class
  Class
  PUBLIC
  The speed (rate of movement) of a mobile object.
- twisted.positioning.base.Speed.__init__
  twisted.positioning.base.Speed.html#__init__
  Function
  Method
  PUBLIC
  Initializes a `Speed` object.
- twisted.positioning.base.Climb
  twisted.positioning.base.Climb.html
  Class
  Class
  PUBLIC
  The climb ("vertical speed") of an object.
- twisted.positioning.base.Climb.__init__
  twisted.positioning.base.Climb.html#__init__
  Function
  Method
  PUBLIC
  Initializes a `Climb` object.
- twisted.positioning.base.PositionError
  twisted.positioning.base.PositionError.html
  Class
  Class
  PUBLIC
  Position error information.
- twisted.positioning.base.PositionError._ALLOWABLE_THRESHOLD
  twisted.positioning.base.PositionError.html#_ALLOWABLE_THRESHOLD
  Attribute
  Class Variable
  PRIVATE
  The maximum allowable difference between PDOP and the geometric mean of VDOP and HDOP. That difference is supposed to be zero, but can be non-zero because of rounding error and limited reporting precision...
- twisted.positioning.base.PositionError._DOP_EXPRESSIONS
  twisted.positioning.base.PositionError.html#_DOP_EXPRESSIONS
  Attribute
  Constant
  PRIVATE
  A mapping of DOP types (C[hvp]dop) to a list of callables that take self and return that DOP type, or raise `TypeError`. This allows a DOP value to either be returned directly if it's know, or computed from other DOP types if it isn't.
- twisted.positioning.base.PositionError.compareAttributes
  twisted.positioning.base.PositionError.html#compareAttributes
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.positioning.base.PositionError.__init__
  twisted.positioning.base.PositionError.html#__init__
  Function
  Method
  PUBLIC
  Initializes a positioning error object.
- twisted.positioning.base.PositionError._pdop
  twisted.positioning.base.PositionError.html#_pdop
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.positioning.base.PositionError._hdop
  twisted.positioning.base.PositionError.html#_hdop
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.positioning.base.PositionError._vdop
  twisted.positioning.base.PositionError.html#_vdop
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.positioning.base.PositionError._testInvariant
  twisted.positioning.base.PositionError.html#_testInvariant
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.positioning.base.PositionError._ALLOWABLE_TRESHOLD
  twisted.positioning.base.PositionError.html#_ALLOWABLE_TRESHOLD
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.positioning.base.PositionError._testDilutionOfPositionInvariant
  twisted.positioning.base.PositionError.html#_testDilutionOfPositionInvariant
  Function
  Method
  PRIVATE
  Tests if this positioning error object satisfies the dilution of position invariant (PDOP = (HDOP**2 + VDOP**2)*.5), unless the `self._testInvariant` instance variable is `False`.
- twisted.positioning.base.PositionError._getDOP
  twisted.positioning.base.PositionError.html#_getDOP
  Function
  Method
  PRIVATE
  Gets a particular dilution of position value.
- twisted.positioning.base.PositionError._setDOP
  twisted.positioning.base.PositionError.html#_setDOP
  Function
  Method
  PRIVATE
  Sets a particular dilution of position value.
- twisted.positioning.base.PositionError.pdop 0
  twisted.positioning.base.PositionError.html#pdop%200
  Attribute
  Instance Variable
  PUBLIC
  The position dilution of precision. `None` if unknown.
- twisted.positioning.base.PositionError.pdop
  twisted.positioning.base.PositionError.html#pdop
  Attribute
  Property
  PUBLIC
  Undocumented
- twisted.positioning.base.PositionError.pdop.setter
  twisted.positioning.base.PositionError.html#pdop.setter
  Function
  Method
  PUBLIC
  Undocumented
- twisted.positioning.base.PositionError.hdop 0
  twisted.positioning.base.PositionError.html#hdop%200
  Attribute
  Instance Variable
  PUBLIC
  The horizontal dilution of precision. `None` if unknown.
- twisted.positioning.base.PositionError.hdop
  twisted.positioning.base.PositionError.html#hdop
  Attribute
  Property
  PUBLIC
  Undocumented
- twisted.positioning.base.PositionError.hdop.setter
  twisted.positioning.base.PositionError.html#hdop.setter
  Function
  Method
  PUBLIC
  Undocumented
- twisted.positioning.base.PositionError.vdop 0
  twisted.positioning.base.PositionError.html#vdop%200
  Attribute
  Instance Variable
  PUBLIC
  The vertical dilution of precision. `None` if unknown.
- twisted.positioning.base.PositionError.vdop
  twisted.positioning.base.PositionError.html#vdop
  Attribute
  Property
  PUBLIC
  Undocumented
- twisted.positioning.base.PositionError.vdop.setter
  twisted.positioning.base.PositionError.html#vdop.setter
  Function
  Method
  PUBLIC
  Undocumented
- twisted.positioning.base.PositionError._REPR_TEMPLATE
  twisted.positioning.base.PositionError.html#_REPR_TEMPLATE
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.positioning.base.PositionError.__repr__
  twisted.positioning.base.PositionError.html#__repr__
  Function
  Method
  PUBLIC
  Returns a string representation of positioning information object.
- twisted.positioning.base.BeaconInformation
  twisted.positioning.base.BeaconInformation.html
  Class
  Class
  PUBLIC
  Information about positioning beacons (a generalized term for the reference objects that help you determine your position, such as satellites or cell towers).
- twisted.positioning.base.BeaconInformation.seenBeacons
  twisted.positioning.base.BeaconInformation.html#seenBeacons
  Attribute
  Instance Variable
  PUBLIC
  A set of visible beacons. Note that visible beacons are not necessarily used in acquiring a positioning fix.
- twisted.positioning.base.BeaconInformation.usedBeacons
  twisted.positioning.base.BeaconInformation.html#usedBeacons
  Attribute
  Instance Variable
  PUBLIC
  A set of the beacons that were used in obtaining a positioning fix. This only contains beacons that are actually used, not beacons for which it is unknown if they are used or not.
- twisted.positioning.base.BeaconInformation.__init__
  twisted.positioning.base.BeaconInformation.html#__init__
  Function
  Method
  PUBLIC
  Initializes a beacon information object.
- twisted.positioning.base.BeaconInformation.__repr__
  twisted.positioning.base.BeaconInformation.html#__repr__
  Function
  Method
  PUBLIC
  Returns a string representation of this beacon information object.
- twisted.positioning.base.PositioningBeacon
  twisted.positioning.base.PositioningBeacon.html
  Class
  Class
  PUBLIC
  A positioning beacon.
- twisted.positioning.base.PositioningBeacon.identifier
  twisted.positioning.base.PositioningBeacon.html#identifier
  Attribute
  Instance Variable
  PUBLIC
  The unique identifier for this beacon. This is usually an integer. For GPS, this is also known as the PRN.
- twisted.positioning.base.PositioningBeacon.__init__
  twisted.positioning.base.PositioningBeacon.html#__init__
  Function
  Method
  PUBLIC
  Initializes a positioning beacon.
- twisted.positioning.base.PositioningBeacon.__hash__
  twisted.positioning.base.PositioningBeacon.html#__hash__
  Function
  Method
  PUBLIC
  Returns the hash of the identifier for this beacon.
- twisted.positioning.base.PositioningBeacon.__repr__
  twisted.positioning.base.PositioningBeacon.html#__repr__
  Function
  Method
  PUBLIC
  Returns a string representation of this beacon.
- twisted.positioning.base.Satellite
  twisted.positioning.base.Satellite.html
  Class
  Class
  PUBLIC
  A satellite.
- twisted.positioning.base.Satellite.azimuth
  twisted.positioning.base.Satellite.html#azimuth
  Attribute
  Instance Variable
  PUBLIC
  The azimuth of the satellite. This is the heading (positive angle relative to true north) where the satellite appears to be to the device.
- twisted.positioning.base.Satellite.elevation
  twisted.positioning.base.Satellite.html#elevation
  Attribute
  Instance Variable
  PUBLIC
  The (positive) angle above the horizon where this satellite appears to be to the device.
- twisted.positioning.base.Satellite.signalToNoiseRatio
  twisted.positioning.base.Satellite.html#signalToNoiseRatio
  Attribute
  Instance Variable
  PUBLIC
  The signal to noise ratio of the signal coming from this satellite.
- twisted.positioning.base.Satellite.__init__
  twisted.positioning.base.Satellite.html#__init__
  Function
  Method
  PUBLIC
  Initializes a satellite object.
- twisted.positioning.base.Satellite.__repr__
  twisted.positioning.base.Satellite.html#__repr__
  Function
  Method
  PUBLIC
  Returns a string representation of this Satellite.
- twisted.positioning.nmea.GPGGAFixQualities
  twisted.positioning.nmea.GPGGAFixQualities.html
  Class
  Class
  PUBLIC
  The possible fix quality indications for GPGGA sentences.
- twisted.positioning.nmea.GPGGAFixQualities.INVALID_FIX
  twisted.positioning.nmea.GPGGAFixQualities.html#INVALID_FIX
  Attribute
  Constant
  PUBLIC
  The fix is invalid.
- twisted.positioning.nmea.GPGGAFixQualities.GPS_FIX
  twisted.positioning.nmea.GPGGAFixQualities.html#GPS_FIX
  Attribute
  Constant
  PUBLIC
  There is a fix, acquired using GPS.
- twisted.positioning.nmea.GPGGAFixQualities.DGPS_FIX
  twisted.positioning.nmea.GPGGAFixQualities.html#DGPS_FIX
  Attribute
  Constant
  PUBLIC
  There is a fix, acquired using differential GPS (DGPS).
- twisted.positioning.nmea.GPGGAFixQualities.PPS_FIX
  twisted.positioning.nmea.GPGGAFixQualities.html#PPS_FIX
  Attribute
  Constant
  PUBLIC
  There is a fix, acquired using the precise positioning service (PPS).
- twisted.positioning.nmea.GPGGAFixQualities.RTK_FIX
  twisted.positioning.nmea.GPGGAFixQualities.html#RTK_FIX
  Attribute
  Constant
  PUBLIC
  There is a fix, acquired using fixed real-time kinematics. This means that there was a sufficient number of shared satellites with the base station, usually yielding a resolution in the centimeter range...
- twisted.positioning.nmea.GPGGAFixQualities.FLOAT_RTK_FIX
  twisted.positioning.nmea.GPGGAFixQualities.html#FLOAT_RTK_FIX
  Attribute
  Constant
  PUBLIC
  There is a fix, acquired using floating real-time kinematics. The same comments apply as for a fixed real-time kinematics fix, except that there were insufficient shared satellites to acquire it, so instead you got a slightly less good floating fix...
- twisted.positioning.nmea.GPGGAFixQualities.DEAD_RECKONING
  twisted.positioning.nmea.GPGGAFixQualities.html#DEAD_RECKONING
  Attribute
  Constant
  PUBLIC
  There is currently no more fix, but this data was computed using a previous fix and some information about motion (either from that fix or from other sources) using simple dead reckoning. Not particularly reliable, but better-than-nonsense data.
- twisted.positioning.nmea.GPGGAFixQualities.MANUAL
  twisted.positioning.nmea.GPGGAFixQualities.html#MANUAL
  Attribute
  Constant
  PUBLIC
  There is no real fix from this device, but the location has been manually entered, presumably with data obtained from some other positioning method.
- twisted.positioning.nmea.GPGGAFixQualities.SIMULATED
  twisted.positioning.nmea.GPGGAFixQualities.html#SIMULATED
  Attribute
  Constant
  PUBLIC
  There is no real fix, but instead it is being simulated.
- twisted.positioning.nmea.GPGLLGPRMCFixQualities
  twisted.positioning.nmea.GPGLLGPRMCFixQualities.html
  Class
  Class
  PUBLIC
  The possible fix quality indications in GPGLL and GPRMC sentences.
- twisted.positioning.nmea.GPGLLGPRMCFixQualities.ACTIVE
  twisted.positioning.nmea.GPGLLGPRMCFixQualities.html#ACTIVE
  Attribute
  Constant
  PUBLIC
  The data is okay.
- twisted.positioning.nmea.GPGLLGPRMCFixQualities.VOID
  twisted.positioning.nmea.GPGLLGPRMCFixQualities.html#VOID
  Attribute
  Constant
  PUBLIC
  The data is void, and should not be used.
- twisted.positioning.nmea.GPGSAFixTypes
  twisted.positioning.nmea.GPGSAFixTypes.html
  Class
  Class
  PUBLIC
  The possible fix types of a GPGSA sentence.
- twisted.positioning.nmea.GPGSAFixTypes.GSA_NO_FIX
  twisted.positioning.nmea.GPGSAFixTypes.html#GSA_NO_FIX
  Attribute
  Constant
  PUBLIC
  The sentence reports no fix at all.
- twisted.positioning.nmea.GPGSAFixTypes.GSA_2D_FIX
  twisted.positioning.nmea.GPGSAFixTypes.html#GSA_2D_FIX
  Attribute
  Constant
  PUBLIC
  The sentence reports a 2D fix: position but no altitude.
- twisted.positioning.nmea.GPGSAFixTypes.GSA_3D_FIX
  twisted.positioning.nmea.GPGSAFixTypes.html#GSA_3D_FIX
  Attribute
  Constant
  PUBLIC
  The sentence reports a 3D fix: position with altitude.
- twisted.positioning.nmea._split
  twisted.positioning.nmea.html#_split
  Function
  Function
  PRIVATE
  Returns the split version of an NMEA sentence, minus header and checksum.
- twisted.positioning.nmea._validateChecksum
  twisted.positioning.nmea.html#_validateChecksum
  Function
  Function
  PRIVATE
  Validates the checksum of an NMEA sentence.
- twisted.positioning.nmea.NMEAProtocol
  twisted.positioning.nmea.NMEAProtocol.html
  Class
  Class
  PUBLIC
  A protocol that parses and verifies the checksum of an NMEA sentence (in string form, not `NMEASentence`), and delegates to a receiver.
- twisted.positioning.nmea.NMEAProtocol._SENTENCE_CONTENTS
  twisted.positioning.nmea.NMEAProtocol.html#_SENTENCE_CONTENTS
  Attribute
  Constant
  PRIVATE
  Has the field names in an NMEA sentence for each sentence type (in order, obviously).
- twisted.positioning.nmea.NMEAProtocol.__init__
  twisted.positioning.nmea.NMEAProtocol.html#__init__
  Function
  Method
  PUBLIC
  Initializes an NMEAProtocol.
- twisted.positioning.nmea.NMEAProtocol._receiver
  twisted.positioning.nmea.NMEAProtocol.html#_receiver
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.positioning.nmea.NMEAProtocol._sentenceCallback
  twisted.positioning.nmea.NMEAProtocol.html#_sentenceCallback
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.positioning.nmea.NMEAProtocol.lineReceived
  twisted.positioning.nmea.NMEAProtocol.html#lineReceived
  Function
  Method
  PUBLIC
  Parses the data from the sentence and validates the checksum.
- twisted.positioning.nmea.NMEASentence
  twisted.positioning.nmea.NMEASentence.html
  Class
  Class
  PUBLIC
  An object representing an NMEA sentence.
- twisted.positioning.nmea.NMEASentence.type
  twisted.positioning.nmea.NMEASentence.html#type
  Attribute
  Instance Variable
  PUBLIC
  The sentence type (`"GPGGA"`, `"GPGSV"`...).
- twisted.positioning.nmea.NMEASentence.numberOfGSVSentences
  twisted.positioning.nmea.NMEASentence.html#numberOfGSVSentences
  Attribute
  Instance Variable
  PUBLIC
  The total number of GSV sentences in a sequence.
- twisted.positioning.nmea.NMEASentence.GSVSentenceIndex
  twisted.positioning.nmea.NMEASentence.html#GSVSentenceIndex
  Attribute
  Instance Variable
  PUBLIC
  The index of this GSV sentence in the GSV sequence.
- twisted.positioning.nmea.NMEASentence.timestamp
  twisted.positioning.nmea.NMEASentence.html#timestamp
  Attribute
  Instance Variable
  PUBLIC
  A timestamp. (`"123456"` -> 12:34:56Z)
- twisted.positioning.nmea.NMEASentence.datestamp
  twisted.positioning.nmea.NMEASentence.html#datestamp
  Attribute
  Instance Variable
  PUBLIC
  A datestamp. (`"230394"` -> 23 Mar 1994)
- twisted.positioning.nmea.NMEASentence.latitudeFloat
  twisted.positioning.nmea.NMEASentence.html#latitudeFloat
  Attribute
  Instance Variable
  PUBLIC
  Latitude value. (for example: `"1234.567"` -> 12 degrees, 34.567 minutes).
- twisted.positioning.nmea.NMEASentence.latitudeHemisphere
  twisted.positioning.nmea.NMEASentence.html#latitudeHemisphere
  Attribute
  Instance Variable
  PUBLIC
  Latitudinal hemisphere (`"N"` or `"S"`).
- twisted.positioning.nmea.NMEASentence.longitudeFloat
  twisted.positioning.nmea.NMEASentence.html#longitudeFloat
  Attribute
  Instance Variable
  PUBLIC
  Longitude value. See `latitudeFloat` for an example.
- twisted.positioning.nmea.NMEASentence.longitudeHemisphere
  twisted.positioning.nmea.NMEASentence.html#longitudeHemisphere
  Attribute
  Instance Variable
  PUBLIC
  Longitudinal hemisphere (`"E"` or `"W"`).
- twisted.positioning.nmea.NMEASentence.altitude
  twisted.positioning.nmea.NMEASentence.html#altitude
  Attribute
  Instance Variable
  PUBLIC
  The altitude above mean sea level.
- twisted.positioning.nmea.NMEASentence.altitudeUnits
  twisted.positioning.nmea.NMEASentence.html#altitudeUnits
  Attribute
  Instance Variable
  PUBLIC
  Units in which altitude is expressed. (Always `"M"` for meters.)
- twisted.positioning.nmea.NMEASentence.heightOfGeoidAboveWGS84
  twisted.positioning.nmea.NMEASentence.html#heightOfGeoidAboveWGS84
  Attribute
  Instance Variable
  PUBLIC
  The local height of the geoid above the WGS84 ellipsoid model.
- twisted.positioning.nmea.NMEASentence.heightOfGeoidAboveWGS84Units
  twisted.positioning.nmea.NMEASentence.html#heightOfGeoidAboveWGS84Units
  Attribute
  Instance Variable
  PUBLIC
  The units in which the height above the geoid is expressed. (Always `"M"` for meters.)
- twisted.positioning.nmea.NMEASentence.trueHeading
  twisted.positioning.nmea.NMEASentence.html#trueHeading
  Attribute
  Instance Variable
  PUBLIC
  The true heading.
- twisted.positioning.nmea.NMEASentence.magneticVariation
  twisted.positioning.nmea.NMEASentence.html#magneticVariation
  Attribute
  Instance Variable
  PUBLIC
  The magnetic variation.
- twisted.positioning.nmea.NMEASentence.magneticVariationDirection
  twisted.positioning.nmea.NMEASentence.html#magneticVariationDirection
  Attribute
  Instance Variable
  PUBLIC
  The direction of the magnetic variation. One of `"E"` or `"W"`.
- twisted.positioning.nmea.NMEASentence.speedInKnots
  twisted.positioning.nmea.NMEASentence.html#speedInKnots
  Attribute
  Instance Variable
  PUBLIC
  The ground speed, expressed in knots.
- twisted.positioning.nmea.NMEASentence.fixQuality
  twisted.positioning.nmea.NMEASentence.html#fixQuality
  Attribute
  Instance Variable
  PUBLIC
  The quality of the fix.
- twisted.positioning.nmea.NMEASentence.dataMode
  twisted.positioning.nmea.NMEASentence.html#dataMode
  Attribute
  Instance Variable
  PUBLIC
  Signals if the data is usable or not.
- twisted.positioning.nmea.NMEASentence.numberOfSatellitesSeen
  twisted.positioning.nmea.NMEASentence.html#numberOfSatellitesSeen
  Attribute
  Instance Variable
  PUBLIC
  The number of satellites seen by the receiver.
- twisted.positioning.nmea.NMEASentence.numberOfSatellitesUsed
  twisted.positioning.nmea.NMEASentence.html#numberOfSatellitesUsed
  Attribute
  Instance Variable
  PUBLIC
  The number of satellites used in computing the fix.
- twisted.positioning.nmea.NMEASentence.horizontalDilutionOfPrecision
  twisted.positioning.nmea.NMEASentence.html#horizontalDilutionOfPrecision
  Attribute
  Instance Variable
  PUBLIC
  The dilution of the precision of the position on a plane tangential to the geoid. (HDOP)
- twisted.positioning.nmea.NMEASentence.verticalDilutionOfPrecision
  twisted.positioning.nmea.NMEASentence.html#verticalDilutionOfPrecision
  Attribute
  Instance Variable
  PUBLIC
  As `horizontalDilutionOfPrecision`, but for a position on a plane perpendicular to the geoid. (VDOP)
- twisted.positioning.nmea.NMEASentence.positionDilutionOfPrecision
  twisted.positioning.nmea.NMEASentence.html#positionDilutionOfPrecision
  Attribute
  Instance Variable
  PUBLIC
  Euclidean norm of HDOP and VDOP.
- twisted.positioning.nmea.NMEASentence.satellitePRN
  twisted.positioning.nmea.NMEASentence.html#satellitePRN
  Attribute
  Instance Variable
  PUBLIC
  The unique identifcation number of a particular satellite. Optionally suffixed with `_N` if multiple satellites are referenced in a sentence, where `N in range(4)`.
- twisted.positioning.nmea.NMEASentence.elevation
  twisted.positioning.nmea.NMEASentence.html#elevation
  Attribute
  Instance Variable
  PUBLIC
  The elevation of a satellite in decimal degrees. Optionally suffixed with `_N`, as with `satellitePRN`.
- twisted.positioning.nmea.NMEASentence.azimuth
  twisted.positioning.nmea.NMEASentence.html#azimuth
  Attribute
  Instance Variable
  PUBLIC
  The azimuth of a satellite in decimal degrees. Optionally suffixed with `_N`, as with `satellitePRN`.
- twisted.positioning.nmea.NMEASentence.signalToNoiseRatio
  twisted.positioning.nmea.NMEASentence.html#signalToNoiseRatio
  Attribute
  Instance Variable
  PUBLIC
  The SNR of a satellite signal, in decibels. Optionally suffixed with `_N`, as with `satellitePRN`.
- twisted.positioning.nmea.NMEASentence.usedSatellitePRN_N
  twisted.positioning.nmea.NMEASentence.html#usedSatellitePRN_N
  Attribute
  Instance Variable
  PUBLIC
  Where `int(N) in range(12)`. The PRN of a satellite used in computing the fix.
- twisted.positioning.nmea.NMEASentence.ALLOWED_ATTRIBUTES
  twisted.positioning.nmea.NMEASentence.html#ALLOWED_ATTRIBUTES
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.positioning.nmea.NMEASentence._isFirstGSVSentence
  twisted.positioning.nmea.NMEASentence.html#_isFirstGSVSentence
  Function
  Method
  PRIVATE
  Tests if this current GSV sentence is the first one in a sequence.
- twisted.positioning.nmea.NMEASentence._isLastGSVSentence
  twisted.positioning.nmea.NMEASentence.html#_isLastGSVSentence
  Function
  Method
  PRIVATE
  Tests if this current GSV sentence is the final one in a sequence.
- twisted.positioning.nmea.NMEAAdapter
  twisted.positioning.nmea.NMEAAdapter.html
  Class
  Class
  PUBLIC
  An adapter from NMEAProtocol receivers to positioning receivers.
- twisted.positioning.nmea.NMEAAdapter._STATEFUL_UPDATE
  twisted.positioning.nmea.NMEAAdapter.html#_STATEFUL_UPDATE
  Attribute
  Constant
  PRIVATE
  Information on how to update partial information in the sentence data or internal adapter state. For more information, see `_statefulUpdate`'s docstring.
- twisted.positioning.nmea.NMEAAdapter._ACCEPTABLE_UNITS
  twisted.positioning.nmea.NMEAAdapter.html#_ACCEPTABLE_UNITS
  Attribute
  Constant
  PRIVATE
  A set of NMEA notations of units that are already acceptable (metric), and therefore don't need to be converted.
- twisted.positioning.nmea.NMEAAdapter._UNIT_CONVERTERS
  twisted.positioning.nmea.NMEAAdapter.html#_UNIT_CONVERTERS
  Attribute
  Constant
  PRIVATE
  Mapping of NMEA notations of units that are not acceptable (not metric) to converters that take a quantity in that unit and produce a metric quantity.
- twisted.positioning.nmea.NMEAAdapter._SPECIFIC_SENTENCE_FIXES
  twisted.positioning.nmea.NMEAAdapter.html#_SPECIFIC_SENTENCE_FIXES
  Attribute
  Constant
  PRIVATE
  A mapping of sentece types to specific fixes that are required to extract useful information from data from those sentences.
- twisted.positioning.nmea.NMEAAdapter._FIXERS
  twisted.positioning.nmea.NMEAAdapter.html#_FIXERS
  Attribute
  Constant
  PRIVATE
  Set of unary callables that take an NMEAAdapter instance and extract useful data from the sentence data, usually modifying the adapter's sentence data in-place.
- twisted.positioning.nmea.NMEAAdapter.yearThreshold
  twisted.positioning.nmea.NMEAAdapter.html#yearThreshold
  Attribute
  Instance Variable
  PUBLIC
  The earliest possible year that data will be interpreted as. For example, if this value is `1990`, an NMEA 0183 two-digit year of "96" will be interpreted as 1996, and a two-digit year of "13" will be interpreted as 2013.
- twisted.positioning.nmea.NMEAAdapter._state
  twisted.positioning.nmea.NMEAAdapter.html#_state
  Attribute
  Instance Variable
  PRIVATE
  The current internal state of the receiver.
- twisted.positioning.nmea.NMEAAdapter._sentenceData
  twisted.positioning.nmea.NMEAAdapter.html#_sentenceData
  Attribute
  Instance Variable
  PRIVATE
  The data present in the sentence currently being processed. Starts empty, is filled as the sentence is parsed.
- twisted.positioning.nmea.NMEAAdapter._receiver
  twisted.positioning.nmea.NMEAAdapter.html#_receiver
  Attribute
  Instance Variable
  PRIVATE
  The positioning receiver that will receive parsed data.
- twisted.positioning.nmea.NMEAAdapter.__init__
  twisted.positioning.nmea.NMEAAdapter.html#__init__
  Function
  Method
  PUBLIC
  Initializes a new NMEA adapter.
- twisted.positioning.nmea.NMEAAdapter._fixTimestamp
  twisted.positioning.nmea.NMEAAdapter.html#_fixTimestamp
  Function
  Method
  PRIVATE
  Turns the NMEAProtocol timestamp notation into a datetime.time object. The time in this object is expressed as Zulu time.
- twisted.positioning.nmea.NMEAAdapter._fixDatestamp
  twisted.positioning.nmea.NMEAAdapter.html#_fixDatestamp
  Function
  Method
  PRIVATE
  Turns an NMEA datestamp format into a `datetime.date` object.
- twisted.positioning.nmea.NMEAAdapter._fixCoordinateFloat
  twisted.positioning.nmea.NMEAAdapter.html#_fixCoordinateFloat
  Function
  Method
  PRIVATE
  Turns the NMEAProtocol coordinate format into Python float.
- twisted.positioning.nmea.NMEAAdapter._fixHemisphereSign
  twisted.positioning.nmea.NMEAAdapter.html#_fixHemisphereSign
  Function
  Method
  PRIVATE
  Fixes the sign for a hemisphere.
- twisted.positioning.nmea.NMEAAdapter._getHemisphereSign
  twisted.positioning.nmea.NMEAAdapter.html#_getHemisphereSign
  Function
  Method
  PRIVATE
  Returns the hemisphere sign for a given coordinate type.
- twisted.positioning.nmea.NMEAAdapter._convert
  twisted.positioning.nmea.NMEAAdapter.html#_convert
  Function
  Method
  PRIVATE
  A simple conversion fix.
- twisted.positioning.nmea.NMEAAdapter._statefulUpdate
  twisted.positioning.nmea.NMEAAdapter.html#_statefulUpdate
  Function
  Method
  PRIVATE
  Does a stateful update of a particular positioning attribute. Specifically, this will mutate an object in the current sentence data.
- twisted.positioning.nmea.NMEAAdapter._fixUnits
  twisted.positioning.nmea.NMEAAdapter.html#_fixUnits
  Function
  Method
  PRIVATE
  Fixes the units of a certain value. If the units are already acceptable (metric), does nothing.
- twisted.positioning.nmea.NMEAAdapter._fixGSV
  twisted.positioning.nmea.NMEAAdapter.html#_fixGSV
  Function
  Method
  PRIVATE
  Parses partial visible satellite information from a GSV sentence.
- twisted.positioning.nmea.NMEAAdapter._fixGSA
  twisted.positioning.nmea.NMEAAdapter.html#_fixGSA
  Function
  Method
  PRIVATE
  Extracts the information regarding which satellites were used in obtaining the GPS fix from a GSA sentence.
- twisted.positioning.nmea.NMEAAdapter._sentenceSpecificFix
  twisted.positioning.nmea.NMEAAdapter.html#_sentenceSpecificFix
  Function
  Method
  PRIVATE
  Executes a fix for a specific type of sentence.
- twisted.positioning.nmea.NMEAAdapter.clear
  twisted.positioning.nmea.NMEAAdapter.html#clear
  Function
  Method
  PUBLIC
  Resets this adapter.
- twisted.positioning.nmea.NMEAAdapter.sentenceReceived
  twisted.positioning.nmea.NMEAAdapter.html#sentenceReceived
  Function
  Method
  PUBLIC
  Called when a sentence is received.
- twisted.positioning.nmea.NMEAAdapter.currentSentence
  twisted.positioning.nmea.NMEAAdapter.html#currentSentence
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.positioning.nmea.NMEAAdapter._validateCurrentSentence
  twisted.positioning.nmea.NMEAAdapter.html#_validateCurrentSentence
  Function
  Method
  PRIVATE
  Tests if a sentence contains a valid fix.
- twisted.positioning.nmea.NMEAAdapter._cleanCurrentSentence
  twisted.positioning.nmea.NMEAAdapter.html#_cleanCurrentSentence
  Function
  Method
  PRIVATE
  Cleans the current sentence.
- twisted.positioning.nmea.NMEAAdapter._updateState
  twisted.positioning.nmea.NMEAAdapter.html#_updateState
  Function
  Method
  PRIVATE
  Updates the current state with the new information from the sentence.
- twisted.positioning.nmea.NMEAAdapter._updateBeaconInformation
  twisted.positioning.nmea.NMEAAdapter.html#_updateBeaconInformation
  Function
  Method
  PRIVATE
  Updates existing beacon information state with new data.
- twisted.positioning.nmea.NMEAAdapter._updateUsedBeacons
  twisted.positioning.nmea.NMEAAdapter.html#_updateUsedBeacons
  Function
  Method
  PRIVATE
  Searches the adapter state and sentence data for information about which beacons where used, then adds it to the provided beacon information object.
- twisted.positioning.nmea.NMEAAdapter._mergeBeaconInformation
  twisted.positioning.nmea.NMEAAdapter.html#_mergeBeaconInformation
  Function
  Method
  PRIVATE
  Merges beacon information in the adapter state (if it exists) into the provided beacon information. Specifically, this merges used and seen beacons.
- twisted.positioning.nmea.NMEAAdapter._combineDateAndTime
  twisted.positioning.nmea.NMEAAdapter.html#_combineDateAndTime
  Function
  Method
  PRIVATE
  Combines a `datetime.date` object and a `datetime.time` object, collected from one or more NMEA sentences, into a single `datetime.datetime` object suitable for sending to the `IPositioningReceiver`.
- twisted.positioning.nmea.NMEAAdapter._fireSentenceCallbacks
  twisted.positioning.nmea.NMEAAdapter.html#_fireSentenceCallbacks
  Function
  Method
  PRIVATE
  Fires sentence callbacks for the current sentence.
- twisted.protocols.amp.MAX_VALUE_LENGTH
  twisted.protocols.amp.html#MAX_VALUE_LENGTH
  Attribute
  Constant
  PUBLIC
  The maximum length of a message.
- twisted.protocols.amp.ASK
  twisted.protocols.amp.html#ASK
  Attribute
  Constant
  PUBLIC
  Marker for an Ask packet.
- twisted.protocols.amp.ANSWER
  twisted.protocols.amp.html#ANSWER
  Attribute
  Constant
  PUBLIC
  Marker for an Answer packet.
- twisted.protocols.amp.COMMAND
  twisted.protocols.amp.html#COMMAND
  Attribute
  Constant
  PUBLIC
  Marker for a Command packet.
- twisted.protocols.amp.ERROR
  twisted.protocols.amp.html#ERROR
  Attribute
  Constant
  PUBLIC
  Marker for an AMP box of error type.
- twisted.protocols.amp.ERROR_CODE
  twisted.protocols.amp.html#ERROR_CODE
  Attribute
  Constant
  PUBLIC
  Marker for an AMP box containing the code of an error.
- twisted.protocols.amp.ERROR_DESCRIPTION
  twisted.protocols.amp.html#ERROR_DESCRIPTION
  Attribute
  Constant
  PUBLIC
  Marker for an AMP box containing the description of the error.
- twisted.protocols.amp.UNKNOWN_ERROR_CODE
  twisted.protocols.amp.html#UNKNOWN_ERROR_CODE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.amp.UNHANDLED_ERROR_CODE
  twisted.protocols.amp.html#UNHANDLED_ERROR_CODE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.amp.MAX_KEY_LENGTH
  twisted.protocols.amp.html#MAX_KEY_LENGTH
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.amp.IArgumentType
  twisted.protocols.amp.IArgumentType.html
  Class
  Interface
  PUBLIC
  An `IArgumentType` can serialize a Python object into an AMP box and deserialize information from an AMP box back into a Python object.
- twisted.protocols.amp.IArgumentType.fromBox
  twisted.protocols.amp.IArgumentType.html#fromBox
  Function
  Method
  PUBLIC
  Given an argument name and an AMP box containing serialized values, extract one or more Python objects and add them to the `objects` dictionary.
- twisted.protocols.amp.IArgumentType.toBox
  twisted.protocols.amp.IArgumentType.html#toBox
  Function
  Method
  PUBLIC
  Given an argument name and a dictionary containing structured Python objects, serialize values into one or more strings and add them to the `strings` dictionary.
- twisted.protocols.amp.IBoxSender
  twisted.protocols.amp.IBoxSender.html
  Class
  Interface
  PUBLIC
  A transport which can send `AmpBox` objects.
- twisted.protocols.amp.IBoxSender.sendBox
  twisted.protocols.amp.IBoxSender.html#sendBox
  Function
  Method
  PUBLIC
  Send an `AmpBox`.
- twisted.protocols.amp.IBoxSender.unhandledError
  twisted.protocols.amp.IBoxSender.html#unhandledError
  Function
  Method
  PUBLIC
  An unhandled error occurred in response to a box. Log it appropriately.
- twisted.protocols.amp.IBoxReceiver
  twisted.protocols.amp.IBoxReceiver.html
  Class
  Interface
  PUBLIC
  An application object which can receive `AmpBox` objects and dispatch them appropriately.
- twisted.protocols.amp.IBoxReceiver.startReceivingBoxes
  twisted.protocols.amp.IBoxReceiver.html#startReceivingBoxes
  Function
  Method
  PUBLIC
  The `IBoxReceiver.ampBoxReceived` method will start being called; boxes may be responded to by responding to the given `IBoxSender`.
- twisted.protocols.amp.IBoxReceiver.ampBoxReceived
  twisted.protocols.amp.IBoxReceiver.html#ampBoxReceived
  Function
  Method
  PUBLIC
  A box was received from the transport; dispatch it appropriately.
- twisted.protocols.amp.IBoxReceiver.stopReceivingBoxes
  twisted.protocols.amp.IBoxReceiver.html#stopReceivingBoxes
  Function
  Method
  PUBLIC
  No further boxes will be received on this connection.
- twisted.protocols.amp.IResponderLocator
  twisted.protocols.amp.IResponderLocator.html
  Class
  Interface
  PUBLIC
  An application object which can look up appropriate responder methods for AMP commands.
- twisted.protocols.amp.IResponderLocator.locateResponder
  twisted.protocols.amp.IResponderLocator.html#locateResponder
  Function
  Method
  PUBLIC
  Locate a responder method appropriate for the named command.
- twisted.protocols.amp.AmpError
  twisted.protocols.amp.AmpError.html
  Class
  Exception
  PUBLIC
  Base class of all Amp-related exceptions.
- twisted.protocols.amp.ProtocolSwitched
  twisted.protocols.amp.ProtocolSwitched.html
  Class
  Exception
  PUBLIC
  Connections which have been switched to other protocols can no longer accept traffic at the AMP level. This is raised when you try to send it.
- twisted.protocols.amp.OnlyOneTLS
  twisted.protocols.amp.OnlyOneTLS.html
  Class
  Exception
  PUBLIC
  This is an implementation limitation; TLS may only be started once per connection.
- twisted.protocols.amp.NoEmptyBoxes
  twisted.protocols.amp.NoEmptyBoxes.html
  Class
  Exception
  PUBLIC
  You can't have empty boxes on the connection. This is raised when you receive or attempt to send one.
- twisted.protocols.amp.InvalidSignature
  twisted.protocols.amp.InvalidSignature.html
  Class
  Exception
  PUBLIC
  You didn't pass all the required arguments.
- twisted.protocols.amp.TooLong
  twisted.protocols.amp.TooLong.html
  Class
  Exception
  PUBLIC
  One of the protocol's length limitations was violated.
- twisted.protocols.amp.TooLong.isKey
  twisted.protocols.amp.TooLong.html#isKey
  Attribute
  Instance Variable
  PUBLIC
  true if the string being encoded in a key position, false if it was in a value position.
- twisted.protocols.amp.TooLong.isLocal
  twisted.protocols.amp.TooLong.html#isLocal
  Attribute
  Instance Variable
  PUBLIC
  Was the string encoded locally, or received too long from the network? (It's only physically possible to encode "too long" values on the network for keys.)
- twisted.protocols.amp.TooLong.value
  twisted.protocols.amp.TooLong.html#value
  Attribute
  Instance Variable
  PUBLIC
  The string that was too long.
- twisted.protocols.amp.TooLong.keyName
  twisted.protocols.amp.TooLong.html#keyName
  Attribute
  Instance Variable
  PUBLIC
  If the string being encoded was in a value position, what key was it being encoded for?
- twisted.protocols.amp.TooLong.__init__
  twisted.protocols.amp.TooLong.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.amp.TooLong.__repr__
  twisted.protocols.amp.TooLong.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.amp.BadLocalReturn
  twisted.protocols.amp.BadLocalReturn.html
  Class
  Exception
  PUBLIC
  A bad value was returned from a local command; we were unable to coerce it.
- twisted.protocols.amp.BadLocalReturn.__init__
  twisted.protocols.amp.BadLocalReturn.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.amp.BadLocalReturn.message
  twisted.protocols.amp.BadLocalReturn.html#message
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.amp.BadLocalReturn.enclosed
  twisted.protocols.amp.BadLocalReturn.html#enclosed
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.amp.BadLocalReturn.__repr__
  twisted.protocols.amp.BadLocalReturn.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.amp.RemoteAmpError
  twisted.protocols.amp.RemoteAmpError.html
  Class
  Exception
  PUBLIC
  This error indicates that something went wrong on the remote end of the connection, and the error was serialized and transmitted to you.
- twisted.protocols.amp.RemoteAmpError.__init__
  twisted.protocols.amp.RemoteAmpError.html#__init__
  Function
  Method
  PUBLIC
  Create a remote error with an error code and description.
- twisted.protocols.amp.RemoteAmpError.local
  twisted.protocols.amp.RemoteAmpError.html#local
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.amp.RemoteAmpError.errorCode
  twisted.protocols.amp.RemoteAmpError.html#errorCode
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.amp.RemoteAmpError.description
  twisted.protocols.amp.RemoteAmpError.html#description
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.amp.RemoteAmpError.fatal
  twisted.protocols.amp.RemoteAmpError.html#fatal
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.amp.UnknownRemoteError
  twisted.protocols.amp.UnknownRemoteError.html
  Class
  Exception
  PUBLIC
  This means that an error whose type we can't identify was raised from the other side.
- twisted.protocols.amp.UnknownRemoteError.__init__
  twisted.protocols.amp.UnknownRemoteError.html#__init__
  Function
  Method
  PUBLIC
  Create a remote error with an error code and description.
- twisted.protocols.amp.MalformedAmpBox
  twisted.protocols.amp.MalformedAmpBox.html
  Class
  Exception
  PUBLIC
  This error indicates that the wire-level protocol was malformed.
- twisted.protocols.amp.UnhandledCommand
  twisted.protocols.amp.UnhandledCommand.html
  Class
  Exception
  PUBLIC
  A command received via amp could not be dispatched.
- twisted.protocols.amp.IncompatibleVersions
  twisted.protocols.amp.IncompatibleVersions.html
  Class
  Exception
  PUBLIC
  It was impossible to negotiate a compatible version of the protocol with the other end of the connection.
- twisted.protocols.amp.PROTOCOL_ERRORS
  twisted.protocols.amp.html#PROTOCOL_ERRORS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.amp.AmpBox
  twisted.protocols.amp.AmpBox.html
  Class
  Class
  PUBLIC
  I am a packet in the AMP protocol, much like a regular bytes:bytes dictionary.
- twisted.protocols.amp.AmpBox.__slots__
  twisted.protocols.amp.AmpBox.html#__slots__
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.protocols.amp.AmpBox.__init__
  twisted.protocols.amp.AmpBox.html#__init__
  Function
  Method
  PUBLIC
  Initialize a new `AmpBox`.
- twisted.protocols.amp.AmpBox.copy
  twisted.protocols.amp.AmpBox.html#copy
  Function
  Method
  PUBLIC
  Return another AmpBox just like me.
- twisted.protocols.amp.AmpBox.serialize
  twisted.protocols.amp.AmpBox.html#serialize
  Function
  Method
  PUBLIC
  Convert me into a wire-encoded string.
- twisted.protocols.amp.AmpBox._sendTo
  twisted.protocols.amp.AmpBox.html#_sendTo
  Function
  Method
  PRIVATE
  Serialize and send this box to an Amp instance. By the time it is being sent, several keys are required. I must have exactly ONE of:
- twisted.protocols.amp.AmpBox.__repr__
  twisted.protocols.amp.AmpBox.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.amp.QuitBox
  twisted.protocols.amp.QuitBox.html
  Class
  Class
  PUBLIC
  I am an AmpBox that, upon being sent, terminates the connection.
- twisted.protocols.amp.QuitBox.__slots__
  twisted.protocols.amp.QuitBox.html#__slots__
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.protocols.amp.QuitBox.__repr__
  twisted.protocols.amp.QuitBox.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.amp.QuitBox._sendTo
  twisted.protocols.amp.QuitBox.html#_sendTo
  Function
  Method
  PRIVATE
  Immediately call loseConnection after sending.
- twisted.protocols.amp._SwitchBox
  twisted.protocols.amp._SwitchBox.html
  Class
  Class
  PRIVATE
  Implementation detail of ProtocolSwitchCommand: I am an AmpBox which sets up state for the protocol to switch.
- twisted.protocols.amp._SwitchBox.__init__
  twisted.protocols.amp._SwitchBox.html#__init__
  Function
  Method
  PUBLIC
  Create a _SwitchBox with the protocol to switch to after being sent.
- twisted.protocols.amp._SwitchBox.innerProto
  twisted.protocols.amp._SwitchBox.html#innerProto
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.amp._SwitchBox.__repr__
  twisted.protocols.amp._SwitchBox.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.amp._SwitchBox._sendTo
  twisted.protocols.amp._SwitchBox.html#_sendTo
  Function
  Method
  PRIVATE
  Send me; I am the last box on the connection. All further traffic will be over the new protocol.
- twisted.protocols.amp.BoxDispatcher
  twisted.protocols.amp.BoxDispatcher.html
  Class
  Class
  PUBLIC
  A `BoxDispatcher` dispatches '_ask', '_answer', and '_error' `AmpBox`es, both incoming and outgoing, to their appropriate destinations.
- twisted.protocols.amp.BoxDispatcher._outstandingRequests
  twisted.protocols.amp.BoxDispatcher.html#_outstandingRequests
  Attribute
  Instance Variable
  PRIVATE
  a dictionary mapping request IDs to `Deferred`s which were returned for those requests.
- twisted.protocols.amp.BoxDispatcher.locator
  twisted.protocols.amp.BoxDispatcher.html#locator
  Attribute
  Instance Variable
  PUBLIC
  an object with a `CommandLocator.locateResponder` method that locates a responder function that takes a Box and returns a result (either a Box or a Deferred which fires one).
- twisted.protocols.amp.BoxDispatcher.boxSender
  twisted.protocols.amp.BoxDispatcher.html#boxSender
  Attribute
  Instance Variable
  PUBLIC
  an object which can send boxes, via the `_sendBoxCommand` method, such as an `AMP` instance.
- twisted.protocols.amp.BoxDispatcher._failAllReason
  twisted.protocols.amp.BoxDispatcher.html#_failAllReason
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.protocols.amp.BoxDispatcher._counter
  twisted.protocols.amp.BoxDispatcher.html#_counter
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.protocols.amp.BoxDispatcher.__init__
  twisted.protocols.amp.BoxDispatcher.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.amp.BoxDispatcher.startReceivingBoxes
  twisted.protocols.amp.BoxDispatcher.html#startReceivingBoxes
  Function
  Method
  PUBLIC
  The given boxSender is going to start calling boxReceived on this `BoxDispatcher`.
- twisted.protocols.amp.BoxDispatcher.stopReceivingBoxes
  twisted.protocols.amp.BoxDispatcher.html#stopReceivingBoxes
  Function
  Method
  PUBLIC
  No further boxes will be received here. Terminate all currently outstanding command deferreds with the given reason.
- twisted.protocols.amp.BoxDispatcher.failAllOutgoing
  twisted.protocols.amp.BoxDispatcher.html#failAllOutgoing
  Function
  Method
  PUBLIC
  Call the errback on all outstanding requests awaiting responses.
- twisted.protocols.amp.BoxDispatcher._nextTag
  twisted.protocols.amp.BoxDispatcher.html#_nextTag
  Function
  Method
  PRIVATE
  Generate protocol-local serial numbers for _ask keys.
- twisted.protocols.amp.BoxDispatcher._sendBoxCommand
  twisted.protocols.amp.BoxDispatcher.html#_sendBoxCommand
  Function
  Method
  PRIVATE
  Send a command across the wire with the given `amp.Box`.
- twisted.protocols.amp.BoxDispatcher.callRemoteString
  twisted.protocols.amp.BoxDispatcher.html#callRemoteString
  Function
  Method
  PUBLIC
  This is a low-level API, designed only for optimizing simple messages for which the overhead of parsing is too great.
- twisted.protocols.amp.BoxDispatcher.callRemote
  twisted.protocols.amp.BoxDispatcher.html#callRemote
  Function
  Method
  PUBLIC
  This is the primary high-level API for sending messages via AMP. Invoke it with a command and appropriate arguments to send a message to this connection's peer.
- twisted.protocols.amp.BoxDispatcher.unhandledError
  twisted.protocols.amp.BoxDispatcher.html#unhandledError
  Function
  Method
  PUBLIC
  This is a terminal callback called after application code has had a chance to quash any errors.
- twisted.protocols.amp.BoxDispatcher._answerReceived
  twisted.protocols.amp.BoxDispatcher.html#_answerReceived
  Function
  Method
  PRIVATE
  An AMP box was received that answered a command previously sent with `callRemote`.
- twisted.protocols.amp.BoxDispatcher._errorReceived
  twisted.protocols.amp.BoxDispatcher.html#_errorReceived
  Function
  Method
  PRIVATE
  An AMP box was received that answered a command previously sent with `callRemote`, with an error.
- twisted.protocols.amp.BoxDispatcher._commandReceived
  twisted.protocols.amp.BoxDispatcher.html#_commandReceived
  Function
  Method
  PRIVATE
  No summary
- twisted.protocols.amp.BoxDispatcher.ampBoxReceived
  twisted.protocols.amp.BoxDispatcher.html#ampBoxReceived
  Function
  Method
  PUBLIC
  An AmpBox was received, representing a command, or an answer to a previously issued command (either successful or erroneous). Respond to it according to its contents.
- twisted.protocols.amp.BoxDispatcher._safeEmit
  twisted.protocols.amp.BoxDispatcher.html#_safeEmit
  Function
  Method
  PRIVATE
  Emit a box, ignoring `ProtocolSwitched` and `ConnectionLost` errors which cannot be usefully handled.
- twisted.protocols.amp.BoxDispatcher.dispatchCommand
  twisted.protocols.amp.BoxDispatcher.html#dispatchCommand
  Function
  Method
  PUBLIC
  A box with a _command key was received.
- twisted.protocols.amp._CommandLocatorMeta
  twisted.protocols.amp._CommandLocatorMeta.html
  Class
  Class
  PRIVATE
  This metaclass keeps track of all of the Command.responder-decorated methods defined since the last CommandLocator subclass was defined. It assumes (usually correctly, but unfortunately not necessarily so) that those commands responders were all declared as methods of the class being defined...
- twisted.protocols.amp._CommandLocatorMeta._currentClassCommands
  twisted.protocols.amp._CommandLocatorMeta.html#_currentClassCommands
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.protocols.amp._CommandLocatorMeta.__new__
  twisted.protocols.amp._CommandLocatorMeta.html#__new__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.amp.CommandLocator
  twisted.protocols.amp.CommandLocator.html
  Class
  Class
  PUBLIC
  A `CommandLocator` is a collection of responders to AMP `Command`s, with the help of the `Command.responder` decorator.
- twisted.protocols.amp.CommandLocator._wrapWithSerialization
  twisted.protocols.amp.CommandLocator.html#_wrapWithSerialization
  Function
  Method
  PRIVATE
  Wrap aCallable with its command's argument de-serialization and result serialization logic.
- twisted.protocols.amp.CommandLocator.lookupFunction
  twisted.protocols.amp.CommandLocator.html#lookupFunction
  Function
  Method
  PUBLIC
  Deprecated synonym for `CommandLocator.locateResponder`
- twisted.protocols.amp.CommandLocator.locateResponder
  twisted.protocols.amp.CommandLocator.html#locateResponder
  Function
  Method
  PUBLIC
  Locate a callable to invoke when executing the named command.
- twisted.protocols.amp.SimpleStringLocator
  twisted.protocols.amp.SimpleStringLocator.html
  Class
  Class
  PUBLIC
  Implement the `AMP.locateResponder` method to do simple, string-based dispatch.
- twisted.protocols.amp.SimpleStringLocator.baseDispatchPrefix
  twisted.protocols.amp.SimpleStringLocator.html#baseDispatchPrefix
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.protocols.amp.SimpleStringLocator.locateResponder
  twisted.protocols.amp.SimpleStringLocator.html#locateResponder
  Function
  Method
  PUBLIC
  Locate a callable to invoke when executing the named command.
- twisted.protocols.amp.PYTHON_KEYWORDS
  twisted.protocols.amp.html#PYTHON_KEYWORDS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.amp._wireNameToPythonIdentifier
  twisted.protocols.amp.html#_wireNameToPythonIdentifier
  Function
  Function
  PRIVATE
  (Private) Normalize an argument name from the wire for use with Python code. If the return value is going to be a python keyword it will be capitalized. If it contains any dashes they will be replaced with underscores.
- twisted.protocols.amp.Argument
  twisted.protocols.amp.Argument.html
  Class
  Class
  PUBLIC
  Base-class of all objects that take values from Amp packets and convert them into objects for Python functions.
- twisted.protocols.amp.Argument.optional
  twisted.protocols.amp.Argument.html#optional
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.amp.Argument.__init__
  twisted.protocols.amp.Argument.html#__init__
  Function
  Method
  PUBLIC
  Create an Argument.
- twisted.protocols.amp.Argument.retrieve
  twisted.protocols.amp.Argument.html#retrieve
  Function
  Method
  PUBLIC
  Retrieve the given key from the given dictionary, removing it if found.
- twisted.protocols.amp.Argument.fromBox
  twisted.protocols.amp.Argument.html#fromBox
  Function
  Method
  PUBLIC
  Populate an 'out' dictionary with mapping names to Python values decoded from an 'in' AmpBox mapping strings to string values.
- twisted.protocols.amp.Argument.toBox
  twisted.protocols.amp.Argument.html#toBox
  Function
  Method
  PUBLIC
  Populate an 'out' AmpBox with strings encoded from an 'in' dictionary mapping names to Python values.
- twisted.protocols.amp.Argument.fromStringProto
  twisted.protocols.amp.Argument.html#fromStringProto
  Function
  Method
  PUBLIC
  Convert a string to a Python value.
- twisted.protocols.amp.Argument.toStringProto
  twisted.protocols.amp.Argument.html#toStringProto
  Function
  Method
  PUBLIC
  Convert a Python object to a string.
- twisted.protocols.amp.Argument.fromString
  twisted.protocols.amp.Argument.html#fromString
  Function
  Method
  PUBLIC
  Convert a string to a Python object. Subclasses must implement this.
- twisted.protocols.amp.Argument.toString
  twisted.protocols.amp.Argument.html#toString
  Function
  Method
  PUBLIC
  Convert a Python object into a string for passing over the network.
- twisted.protocols.amp.Integer
  twisted.protocols.amp.Integer.html
  Class
  Class
  PUBLIC
  Encode any integer values of any size on the wire as the string representation.
- twisted.protocols.amp.Integer.toString
  twisted.protocols.amp.Integer.html#toString
  Function
  Method
  PUBLIC
  Convert a Python object into a string for passing over the network.
- twisted.protocols.amp.String
  twisted.protocols.amp.String.html
  Class
  Class
  PUBLIC
  Don't do any conversion at all; just pass through 'str'.
- twisted.protocols.amp.String.toString
  twisted.protocols.amp.String.html#toString
  Function
  Method
  PUBLIC
  Convert a Python object into a string for passing over the network.
- twisted.protocols.amp.String.fromString
  twisted.protocols.amp.String.html#fromString
  Function
  Method
  PUBLIC
  Convert a string to a Python object. Subclasses must implement this.
- twisted.protocols.amp.Float
  twisted.protocols.amp.Float.html
  Class
  Class
  PUBLIC
  Encode floating-point values on the wire as their repr.
- twisted.protocols.amp.Float.toString
  twisted.protocols.amp.Float.html#toString
  Function
  Method
  PUBLIC
  Convert a Python object into a string for passing over the network.
- twisted.protocols.amp.Boolean
  twisted.protocols.amp.Boolean.html
  Class
  Class
  PUBLIC
  Encode True or False as "True" or "False" on the wire.
- twisted.protocols.amp.Boolean.fromString
  twisted.protocols.amp.Boolean.html#fromString
  Function
  Method
  PUBLIC
  Convert a string to a Python object. Subclasses must implement this.
- twisted.protocols.amp.Boolean.toString
  twisted.protocols.amp.Boolean.html#toString
  Function
  Method
  PUBLIC
  Convert a Python object into a string for passing over the network.
- twisted.protocols.amp.Unicode
  twisted.protocols.amp.Unicode.html
  Class
  Class
  PUBLIC
  Encode a unicode string on the wire as UTF-8.
- twisted.protocols.amp.Unicode.toString
  twisted.protocols.amp.Unicode.html#toString
  Function
  Method
  PUBLIC
  Convert a Python object into a string for passing over the network.
- twisted.protocols.amp.Unicode.fromString
  twisted.protocols.amp.Unicode.html#fromString
  Function
  Method
  PUBLIC
  Convert a string to a Python object. Subclasses must implement this.
- twisted.protocols.amp.Path
  twisted.protocols.amp.Path.html
  Class
  Class
  PUBLIC
  Encode and decode `filepath.FilePath` instances as paths on the wire.
- twisted.protocols.amp.Path.fromString
  twisted.protocols.amp.Path.html#fromString
  Function
  Method
  PUBLIC
  Convert a string to a Python object. Subclasses must implement this.
- twisted.protocols.amp.Path.toString
  twisted.protocols.amp.Path.html#toString
  Function
  Method
  PUBLIC
  Convert a Python object into a string for passing over the network.
- twisted.protocols.amp.ListOf
  twisted.protocols.amp.ListOf.html
  Class
  Class
  PUBLIC
  Encode and decode lists of instances of a single other argument type.
- twisted.protocols.amp.ListOf.elementType
  twisted.protocols.amp.ListOf.html#elementType
  Attribute
  Instance Variable
  PUBLIC
  The `Argument` instance used to encode and decode list elements (note, not an arbitrary `IArgumentType` implementation: arguments must be implemented using only the `fromString` and `toString` methods, not the ...
- twisted.protocols.amp.ListOf.__init__
  twisted.protocols.amp.ListOf.html#__init__
  Function
  Method
  PUBLIC
  Create an Argument.
- twisted.protocols.amp.ListOf.fromString
  twisted.protocols.amp.ListOf.html#fromString
  Function
  Method
  PUBLIC
  Convert the serialized form of a list of instances of some type back into that list.
- twisted.protocols.amp.ListOf.toString
  twisted.protocols.amp.ListOf.html#toString
  Function
  Method
  PUBLIC
  Serialize the given list of objects to a single string.
- twisted.protocols.amp.AmpList
  twisted.protocols.amp.AmpList.html
  Class
  Class
  PUBLIC
  Convert a list of dictionaries into a list of AMP boxes on the wire.
- twisted.protocols.amp.AmpList.__init__
  twisted.protocols.amp.AmpList.html#__init__
  Function
  Method
  PUBLIC
  Create an AmpList.
- twisted.protocols.amp.AmpList.subargs
  twisted.protocols.amp.AmpList.html#subargs
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.amp.AmpList.fromStringProto
  twisted.protocols.amp.AmpList.html#fromStringProto
  Function
  Method
  PUBLIC
  Convert a string to a Python value.
- twisted.protocols.amp.AmpList.toStringProto
  twisted.protocols.amp.AmpList.html#toStringProto
  Function
  Method
  PUBLIC
  Convert a Python object to a string.
- twisted.protocols.amp.Descriptor
  twisted.protocols.amp.Descriptor.html
  Class
  Class
  PUBLIC
  Encode and decode file descriptors for exchange over a UNIX domain socket.
- twisted.protocols.amp.Descriptor.fromStringProto
  twisted.protocols.amp.Descriptor.html#fromStringProto
  Function
  Method
  PUBLIC
  Take a unique identifier associated with a file descriptor which must have been received by now and use it to look up that descriptor in a dictionary where they are kept.
- twisted.protocols.amp.Descriptor.toStringProto
  twisted.protocols.amp.Descriptor.html#toStringProto
  Function
  Method
  PUBLIC
  Send `inObject`, an integer file descriptor, over `proto`'s connection and return a unique identifier which will allow the receiver to associate the file descriptor with this argument.
- twisted.protocols.amp._CommandMeta
  twisted.protocols.amp._CommandMeta.html
  Class
  Class
  PRIVATE
  Metaclass hack to establish reverse-mappings for 'errors' and 'fatalErrors' as class vars.
- twisted.protocols.amp._CommandMeta.__new__
  twisted.protocols.amp._CommandMeta.html#__new__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.amp.Command
  twisted.protocols.amp.Command.html
  Class
  Class
  PUBLIC
  Subclass me to specify an AMP Command.
- twisted.protocols.amp.Command.arguments
  twisted.protocols.amp.Command.html#arguments
  Attribute
  Class Variable
  PUBLIC
  A list of 2-tuples of (name, Argument-subclass-instance), specifying the names and values of the parameters which are required for this command.
- twisted.protocols.amp.Command.response
  twisted.protocols.amp.Command.html#response
  Attribute
  Class Variable
  PUBLIC
  A list like `arguments`, but instead used for the return value.
- twisted.protocols.amp.Command.errors
  twisted.protocols.amp.Command.html#errors
  Attribute
  Class Variable
  PUBLIC
  A mapping of subclasses of `Exception` to wire-protocol tags for errors represented as `str`s. Responders which raise keys from this dictionary will have the error translated to the corresponding tag on the wire...
- twisted.protocols.amp.Command.fatalErrors
  twisted.protocols.amp.Command.html#fatalErrors
  Attribute
  Class Variable
  PUBLIC
  like 'errors', but errors in this list will always terminate the connection, despite being of a recognizable error type.
- twisted.protocols.amp.Command.commandType
  twisted.protocols.amp.Command.html#commandType
  Attribute
  Class Variable
  PUBLIC
  The type of Box used to issue commands; useful only for protocol-modifying behavior like startTLS or protocol switching. Defaults to a plain vanilla `Box`.
- twisted.protocols.amp.Command.responseType
  twisted.protocols.amp.Command.html#responseType
  Attribute
  Class Variable
  PUBLIC
  The type of Box used to respond to this command; only useful for protocol-modifying behavior like startTLS or protocol switching. Defaults to a plain vanilla `Box`.
- twisted.protocols.amp.Command.requiresAnswer
  twisted.protocols.amp.Command.html#requiresAnswer
  Attribute
  Instance Variable
  PUBLIC
  a boolean; defaults to True. Set it to False on your subclass if you want callRemote to return None. Note: this is a hint only to the client side of the protocol. The return-type of a command responder method must always be a dictionary adhering to the contract specified by ...
- twisted.protocols.amp.Command.extra
  twisted.protocols.amp.Command.html#extra
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.protocols.amp.Command.__init__
  twisted.protocols.amp.Command.html#__init__
  Function
  Method
  PUBLIC
  Create an instance of this command with specified values for its parameters.
- twisted.protocols.amp.Command.structured
  twisted.protocols.amp.Command.html#structured
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.amp.Command.makeResponse
  twisted.protocols.amp.Command.html#makeResponse
  Function
  Class Method
  PUBLIC
  Serialize a mapping of arguments using this `Command`'s response schema.
- twisted.protocols.amp.Command.makeArguments
  twisted.protocols.amp.Command.html#makeArguments
  Function
  Class Method
  PUBLIC
  Serialize a mapping of arguments using this `Command`'s argument schema.
- twisted.protocols.amp.Command.parseResponse
  twisted.protocols.amp.Command.html#parseResponse
  Function
  Class Method
  PUBLIC
  Parse a mapping of serialized arguments using this `Command`'s response schema.
- twisted.protocols.amp.Command.parseArguments
  twisted.protocols.amp.Command.html#parseArguments
  Function
  Class Method
  PUBLIC
  Parse a mapping of serialized arguments using this `Command`'s argument schema.
- twisted.protocols.amp.Command.responder
  twisted.protocols.amp.Command.html#responder
  Function
  Class Method
  PUBLIC
  Declare a method to be a responder for a particular command.
- twisted.protocols.amp.Command._doCommand
  twisted.protocols.amp.Command.html#_doCommand
  Function
  Method
  PRIVATE
  Encode and send this Command to the given protocol.
- twisted.protocols.amp._NoCertificate
  twisted.protocols.amp._NoCertificate.html
  Class
  Class
  PRIVATE
  This is for peers which don't want to use a local certificate. Used by AMP because AMP's internal language is all about certificates and this duck-types in the appropriate place; this API isn't really stable though, so it's not exposed anywhere public.
- twisted.protocols.amp._NoCertificate.__init__
  twisted.protocols.amp._NoCertificate.html#__init__
  Function
  Method
  PUBLIC
  Create a _NoCertificate which either is or isn't for the client side of the connection.
- twisted.protocols.amp._NoCertificate.client
  twisted.protocols.amp._NoCertificate.html#client
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.amp._NoCertificate.options
  twisted.protocols.amp._NoCertificate.html#options
  Function
  Method
  PUBLIC
  Behaves like `twisted.internet.ssl.PrivateCertificate.options`().
- twisted.protocols.amp._TLSBox
  twisted.protocols.amp._TLSBox.html
  Class
  Class
  PRIVATE
  I am an AmpBox that, upon being sent, initiates a TLS connection.
- twisted.protocols.amp._TLSBox.__slots__
  twisted.protocols.amp._TLSBox.html#__slots__
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.protocols.amp._TLSBox.__init__
  twisted.protocols.amp._TLSBox.html#__init__
  Function
  Method
  PUBLIC
  Initialize a new `AmpBox`.
- twisted.protocols.amp._TLSBox.certificate
  twisted.protocols.amp._TLSBox.html#certificate
  Attribute
  Property
  PUBLIC
  Undocumented
- twisted.protocols.amp._TLSBox.verify
  twisted.protocols.amp._TLSBox.html#verify
  Attribute
  Property
  PUBLIC
  Undocumented
- twisted.protocols.amp._TLSBox._sendTo
  twisted.protocols.amp._TLSBox.html#_sendTo
  Function
  Method
  PRIVATE
  Send my encoded value to the protocol, then initiate TLS.
- twisted.protocols.amp._LocalArgument
  twisted.protocols.amp._LocalArgument.html
  Class
  Class
  PRIVATE
  Local arguments are never actually relayed across the wire. This is just a shim so that StartTLS can pretend to have some arguments: if arguments acquire documentation properties, replace this with something nicer later.
- twisted.protocols.amp._LocalArgument.fromBox
  twisted.protocols.amp._LocalArgument.html#fromBox
  Function
  Method
  PUBLIC
  Populate an 'out' dictionary with mapping names to Python values decoded from an 'in' AmpBox mapping strings to string values.
- twisted.protocols.amp.StartTLS
  twisted.protocols.amp.StartTLS.html
  Class
  Class
  PUBLIC
  Use, or subclass, me to implement a command that starts TLS.
- twisted.protocols.amp.StartTLS.arguments
  twisted.protocols.amp.StartTLS.html#arguments
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.protocols.amp.StartTLS.response
  twisted.protocols.amp.StartTLS.html#response
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.protocols.amp.StartTLS.__init__
  twisted.protocols.amp.StartTLS.html#__init__
  Function
  Method
  PUBLIC
  Create a StartTLS command. (This is private. Use AMP.callRemote.)
- twisted.protocols.amp.StartTLS.certificate
  twisted.protocols.amp.StartTLS.html#certificate
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.amp.StartTLS.authorities
  twisted.protocols.amp.StartTLS.html#authorities
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.amp.StartTLS._doCommand
  twisted.protocols.amp.StartTLS.html#_doCommand
  Function
  Method
  PRIVATE
  When a StartTLS command is sent, prepare to start TLS, but don't actually do it; wait for the acknowledgement, then initiate the TLS handshake.
- twisted.protocols.amp.ProtocolSwitchCommand
  twisted.protocols.amp.ProtocolSwitchCommand.html
  Class
  Class
  PUBLIC
  Use this command to switch from something Amp-derived to a different protocol mid-connection. This can be useful to use amp as the connection-startup negotiation phase. Since TLS is a different layer entirely, you can use Amp to negotiate the security parameters of your connection, then switch to a different protocol, and the connection will remain secured.
- twisted.protocols.amp.ProtocolSwitchCommand.__init__
  twisted.protocols.amp.ProtocolSwitchCommand.html#__init__
  Function
  Method
  PUBLIC
  Create a ProtocolSwitchCommand.
- twisted.protocols.amp.ProtocolSwitchCommand.protoToSwitchToFactory
  twisted.protocols.amp.ProtocolSwitchCommand.html#protoToSwitchToFactory
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.amp.ProtocolSwitchCommand.makeResponse
  twisted.protocols.amp.ProtocolSwitchCommand.html#makeResponse
  Function
  Class Method
  PUBLIC
  Serialize a mapping of arguments using this `Command`'s response schema.
- twisted.protocols.amp.ProtocolSwitchCommand._doCommand
  twisted.protocols.amp.ProtocolSwitchCommand.html#_doCommand
  Function
  Method
  PRIVATE
  When we emit a ProtocolSwitchCommand, lock the protocol, but don't actually switch to the new protocol unless an acknowledgement is received. If an error is received, switch back.
- twisted.protocols.amp._DescriptorExchanger
  twisted.protocols.amp._DescriptorExchanger.html
  Class
  Class
  PRIVATE
  `_DescriptorExchanger` is a mixin for `BinaryBoxProtocol` which adds support for receiving file descriptors, a feature offered by `IUNIXTransport`.
- twisted.protocols.amp._DescriptorExchanger._descriptors
  twisted.protocols.amp._DescriptorExchanger.html#_descriptors
  Attribute
  Instance Variable
  PRIVATE
  Temporary storage for all file descriptors received. Values in this dictionary are the file descriptors (as integers). Keys in this dictionary are ordinals giving the order in which each descriptor was received...
- twisted.protocols.amp._DescriptorExchanger._sendingDescriptorCounter
  twisted.protocols.amp._DescriptorExchanger.html#_sendingDescriptorCounter
  Attribute
  Instance Variable
  PRIVATE
  A no-argument callable which returns the ordinals, starting from 0. This is used to construct values for `_sendFileDescriptor`.
- twisted.protocols.amp._DescriptorExchanger._receivingDescriptorCounter
  twisted.protocols.amp._DescriptorExchanger.html#_receivingDescriptorCounter
  Attribute
  Instance Variable
  PRIVATE
  A no-argument callable which returns the ordinals, starting from 0. This is used to construct values for `fileDescriptorReceived`.
- twisted.protocols.amp._DescriptorExchanger.__init__
  twisted.protocols.amp._DescriptorExchanger.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.amp._DescriptorExchanger._getDescriptor
  twisted.protocols.amp._DescriptorExchanger.html#_getDescriptor
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.protocols.amp._DescriptorExchanger._sendFileDescriptor
  twisted.protocols.amp._DescriptorExchanger.html#_sendFileDescriptor
  Function
  Method
  PRIVATE
  Assign and return the next ordinal to the given descriptor after sending the descriptor over this protocol's transport.
- twisted.protocols.amp._DescriptorExchanger.fileDescriptorReceived
  twisted.protocols.amp._DescriptorExchanger.html#fileDescriptorReceived
  Function
  Method
  PUBLIC
  Collect received file descriptors to be claimed later by `Descriptor`.
- twisted.protocols.amp.BinaryBoxProtocol
  twisted.protocols.amp.BinaryBoxProtocol.html
  Class
  Class
  PUBLIC
  A protocol for receiving `AmpBox`es - key/value pairs - via length-prefixed strings. A box is composed of:
- twisted.protocols.amp.BinaryBoxProtocol._keyLengthLimitExceeded
  twisted.protocols.amp.BinaryBoxProtocol.html#_keyLengthLimitExceeded
  Attribute
  Instance Variable
  PRIVATE
  A flag which is only true when the connection is being closed because a key length prefix which was longer than allowed by the protocol was received.
- twisted.protocols.amp.BinaryBoxProtocol.boxReceiver
  twisted.protocols.amp.BinaryBoxProtocol.html#boxReceiver
  Attribute
  Instance Variable
  PUBLIC
  an `IBoxReceiver` provider, whose `IBoxReceiver.ampBoxReceived` method will be invoked for each `AmpBox` that is received.
- twisted.protocols.amp.BinaryBoxProtocol._justStartedTLS
  twisted.protocols.amp.BinaryBoxProtocol.html#_justStartedTLS
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.protocols.amp.BinaryBoxProtocol._startingTLSBuffer
  twisted.protocols.amp.BinaryBoxProtocol.html#_startingTLSBuffer
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.protocols.amp.BinaryBoxProtocol._locked
  twisted.protocols.amp.BinaryBoxProtocol.html#_locked
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.protocols.amp.BinaryBoxProtocol._currentKey
  twisted.protocols.amp.BinaryBoxProtocol.html#_currentKey
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.protocols.amp.BinaryBoxProtocol._currentBox
  twisted.protocols.amp.BinaryBoxProtocol.html#_currentBox
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.protocols.amp.BinaryBoxProtocol.hostCertificate
  twisted.protocols.amp.BinaryBoxProtocol.html#hostCertificate
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.amp.BinaryBoxProtocol.noPeerCertificate
  twisted.protocols.amp.BinaryBoxProtocol.html#noPeerCertificate
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.protocols.amp.BinaryBoxProtocol.innerProtocol
  twisted.protocols.amp.BinaryBoxProtocol.html#innerProtocol
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.amp.BinaryBoxProtocol.innerProtocolClientFactory
  twisted.protocols.amp.BinaryBoxProtocol.html#innerProtocolClientFactory
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.amp.BinaryBoxProtocol.__init__
  twisted.protocols.amp.BinaryBoxProtocol.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.amp.BinaryBoxProtocol._switchTo
  twisted.protocols.amp.BinaryBoxProtocol.html#_switchTo
  Function
  Method
  PRIVATE
  Switch this BinaryBoxProtocol's transport to a new protocol. You need to do this 'simultaneously' on both ends of a connection; the easiest way to do this is to use a subclass of ProtocolSwitchCommand.
- twisted.protocols.amp.BinaryBoxProtocol.recvd
  twisted.protocols.amp.BinaryBoxProtocol.html#recvd
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.amp.BinaryBoxProtocol.sendBox
  twisted.protocols.amp.BinaryBoxProtocol.html#sendBox
  Function
  Method
  PUBLIC
  Send a amp.Box to my peer.
- twisted.protocols.amp.BinaryBoxProtocol.makeConnection
  twisted.protocols.amp.BinaryBoxProtocol.html#makeConnection
  Function
  Method
  PUBLIC
  Notify `boxReceiver` that it is about to receive boxes from this protocol by invoking `IBoxReceiver.startReceivingBoxes`.
- twisted.protocols.amp.BinaryBoxProtocol.transport
  twisted.protocols.amp.BinaryBoxProtocol.html#transport
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.amp.BinaryBoxProtocol.dataReceived
  twisted.protocols.amp.BinaryBoxProtocol.html#dataReceived
  Function
  Method
  PUBLIC
  Either parse incoming data as `AmpBox`es or relay it to our nested protocol.
- twisted.protocols.amp.BinaryBoxProtocol.connectionLost
  twisted.protocols.amp.BinaryBoxProtocol.html#connectionLost
  Function
  Method
  PUBLIC
  The connection was lost; notify any nested protocol.
- twisted.protocols.amp.BinaryBoxProtocol._MAX_KEY_LENGTH
  twisted.protocols.amp.BinaryBoxProtocol.html#_MAX_KEY_LENGTH
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.protocols.amp.BinaryBoxProtocol._MAX_VALUE_LENGTH
  twisted.protocols.amp.BinaryBoxProtocol.html#_MAX_VALUE_LENGTH
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.protocols.amp.BinaryBoxProtocol.proto_init
  twisted.protocols.amp.BinaryBoxProtocol.html#proto_init
  Function
  Method
  PUBLIC
  String received in the 'init' state.
- twisted.protocols.amp.BinaryBoxProtocol.proto_key
  twisted.protocols.amp.BinaryBoxProtocol.html#proto_key
  Function
  Method
  PUBLIC
  String received in the 'key' state. If the key is empty, a complete box has been received.
- twisted.protocols.amp.BinaryBoxProtocol.MAX_LENGTH
  twisted.protocols.amp.BinaryBoxProtocol.html#MAX_LENGTH
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.amp.BinaryBoxProtocol.proto_value
  twisted.protocols.amp.BinaryBoxProtocol.html#proto_value
  Function
  Method
  PUBLIC
  String received in the 'value' state.
- twisted.protocols.amp.BinaryBoxProtocol.lengthLimitExceeded
  twisted.protocols.amp.BinaryBoxProtocol.html#lengthLimitExceeded
  Function
  Method
  PUBLIC
  The key length limit was exceeded. Disconnect the transport and make sure a meaningful exception is reported.
- twisted.protocols.amp.BinaryBoxProtocol._lockForSwitch
  twisted.protocols.amp.BinaryBoxProtocol.html#_lockForSwitch
  Function
  Method
  PRIVATE
  Lock this binary protocol so that no further boxes may be sent. This is used when sending a request to switch underlying protocols. You probably want to subclass ProtocolSwitchCommand rather than calling this directly.
- twisted.protocols.amp.BinaryBoxProtocol._unlockFromSwitch
  twisted.protocols.amp.BinaryBoxProtocol.html#_unlockFromSwitch
  Function
  Method
  PRIVATE
  Unlock this locked binary protocol so that further boxes may be sent again. This is used after an attempt to switch protocols has failed for some reason.
- twisted.protocols.amp.BinaryBoxProtocol._prepareTLS
  twisted.protocols.amp.BinaryBoxProtocol.html#_prepareTLS
  Function
  Method
  PRIVATE
  Used by StartTLSCommand to put us into the state where we don't actually send things that get sent, instead we buffer them. see `_sendBoxCommand`.
- twisted.protocols.amp.BinaryBoxProtocol._startTLS
  twisted.protocols.amp.BinaryBoxProtocol.html#_startTLS
  Function
  Method
  PRIVATE
  Used by TLSBox to initiate the SSL handshake.
- twisted.protocols.amp.BinaryBoxProtocol.peerCertificate
  twisted.protocols.amp.BinaryBoxProtocol.html#peerCertificate
  Attribute
  Property
  PUBLIC
  Undocumented
- twisted.protocols.amp.BinaryBoxProtocol.unhandledError
  twisted.protocols.amp.BinaryBoxProtocol.html#unhandledError
  Function
  Method
  PUBLIC
  The buck stops here. This error was completely unhandled, time to terminate the connection.
- twisted.protocols.amp.BinaryBoxProtocol._defaultStartTLSResponder
  twisted.protocols.amp.BinaryBoxProtocol.html#_defaultStartTLSResponder
  Function
  Method
  PRIVATE
  The default TLS responder doesn't specify any certificate or anything.
- twisted.protocols.amp.AMP
  twisted.protocols.amp.AMP.html
  Class
  Class
  PUBLIC
  This protocol is an AMP connection. See the module docstring for protocol details.
- twisted.protocols.amp.AMP._ampInitialized
  twisted.protocols.amp.AMP.html#_ampInitialized
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.protocols.amp.AMP.__init__
  twisted.protocols.amp.AMP.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.amp.AMP.locateResponder
  twisted.protocols.amp.AMP.html#locateResponder
  Function
  Method
  PUBLIC
  Unify the implementations of `CommandLocator` and `SimpleStringLocator` to perform both kinds of dispatch, preferring `CommandLocator`.
- twisted.protocols.amp.AMP.__repr__
  twisted.protocols.amp.AMP.html#__repr__
  Function
  Method
  PUBLIC
  A verbose string representation which gives us information about this AMP connection.
- twisted.protocols.amp.AMP.makeConnection
  twisted.protocols.amp.AMP.html#makeConnection
  Function
  Method
  PUBLIC
  Emit a helpful log message when the connection is made.
- twisted.protocols.amp.AMP._transportPeer
  twisted.protocols.amp.AMP.html#_transportPeer
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.protocols.amp.AMP._transportHost
  twisted.protocols.amp.AMP.html#_transportHost
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.protocols.amp.AMP.connectionLost
  twisted.protocols.amp.AMP.html#connectionLost
  Function
  Method
  PUBLIC
  Emit a helpful log message when the connection is lost.
- twisted.protocols.amp.AMP.transport
  twisted.protocols.amp.AMP.html#transport
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.amp._ParserHelper
  twisted.protocols.amp._ParserHelper.html
  Class
  Class
  PRIVATE
  A box receiver which records all boxes received.
- twisted.protocols.amp._ParserHelper.__init__
  twisted.protocols.amp._ParserHelper.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.amp._ParserHelper.boxes
  twisted.protocols.amp._ParserHelper.html#boxes
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.amp._ParserHelper.getPeer
  twisted.protocols.amp._ParserHelper.html#getPeer
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.amp._ParserHelper.getHost
  twisted.protocols.amp._ParserHelper.html#getHost
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.amp._ParserHelper.disconnecting
  twisted.protocols.amp._ParserHelper.html#disconnecting
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.protocols.amp._ParserHelper.startReceivingBoxes
  twisted.protocols.amp._ParserHelper.html#startReceivingBoxes
  Function
  Method
  PUBLIC
  No initialization is required.
- twisted.protocols.amp._ParserHelper.ampBoxReceived
  twisted.protocols.amp._ParserHelper.html#ampBoxReceived
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.amp._ParserHelper.parse
  twisted.protocols.amp._ParserHelper.html#parse
  Function
  Class Method
  PUBLIC
  Parse some amp data stored in a file.
- twisted.protocols.amp._ParserHelper.parseString
  twisted.protocols.amp._ParserHelper.html#parseString
  Function
  Class Method
  PUBLIC
  Parse some amp data stored in a string.
- twisted.protocols.amp._stringsToObjects
  twisted.protocols.amp.html#_stringsToObjects
  Function
  Function
  PRIVATE
  Convert an AmpBox to a dictionary of python objects, converting through a given arglist.
- twisted.protocols.amp._objectsToStrings
  twisted.protocols.amp.html#_objectsToStrings
  Function
  Function
  PRIVATE
  Convert a dictionary of python objects to an AmpBox, converting through a given arglist.
- twisted.protocols.amp.Decimal
  twisted.protocols.amp.Decimal.html
  Class
  Class
  PUBLIC
  Encodes `decimal.Decimal` instances.
- twisted.protocols.amp.Decimal.fromString
  twisted.protocols.amp.Decimal.html#fromString
  Function
  Method
  PUBLIC
  Convert a string to a Python object. Subclasses must implement this.
- twisted.protocols.amp.Decimal.toString
  twisted.protocols.amp.Decimal.html#toString
  Function
  Method
  PUBLIC
  Serialize a `decimal.Decimal` instance to the specified wire format.
- twisted.protocols.amp.DateTime
  twisted.protocols.amp.DateTime.html
  Class
  Class
  PUBLIC
  Encodes `datetime.datetime` instances.
- twisted.protocols.amp.DateTime._positions
  twisted.protocols.amp.DateTime.html#_positions
  Attribute
  Instance Variable
  PRIVATE
  A sequence of slices giving the positions of various interesting parts of the wire format.
- twisted.protocols.amp.DateTime.fromString
  twisted.protocols.amp.DateTime.html#fromString
  Function
  Method
  PUBLIC
  Parse a string containing a date and time in the wire format into a `datetime.datetime` instance.
- twisted.protocols.amp.DateTime.toString
  twisted.protocols.amp.DateTime.html#toString
  Function
  Method
  PUBLIC
  Serialize a `datetime.datetime` instance to a string in the specified wire format.
- twisted.protocols.dict.parseParam
  twisted.protocols.dict.html#parseParam
  Function
  Function
  PUBLIC
  Chew one dqstring or atom from beginning of line and return (param, remaningline)
- twisted.protocols.dict.makeAtom
  twisted.protocols.dict.html#makeAtom
  Function
  Function
  PUBLIC
  Munch a string into an 'atom'
- twisted.protocols.dict.makeWord
  twisted.protocols.dict.html#makeWord
  Function
  Function
  PUBLIC
  Undocumented
- twisted.protocols.dict.parseText
  twisted.protocols.dict.html#parseText
  Function
  Function
  PUBLIC
  Undocumented
- twisted.protocols.dict.Definition
  twisted.protocols.dict.Definition.html
  Class
  Class
  PUBLIC
  A word definition
- twisted.protocols.dict.Definition.__init__
  twisted.protocols.dict.Definition.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.dict.Definition.name
  twisted.protocols.dict.Definition.html#name
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.dict.Definition.db
  twisted.protocols.dict.Definition.html#db
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.dict.Definition.dbdesc
  twisted.protocols.dict.Definition.html#dbdesc
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.dict.Definition.text
  twisted.protocols.dict.Definition.html#text
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.dict.DictClient
  twisted.protocols.dict.DictClient.html
  Class
  Class
  PUBLIC
  dict (RFC2229) client
- twisted.protocols.dict.DictClient.data
  twisted.protocols.dict.DictClient.html#data
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.dict.DictClient.MAX_LENGTH
  twisted.protocols.dict.DictClient.html#MAX_LENGTH
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.dict.DictClient.state
  twisted.protocols.dict.DictClient.html#state
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.dict.DictClient.mode
  twisted.protocols.dict.DictClient.html#mode
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.dict.DictClient.result
  twisted.protocols.dict.DictClient.html#result
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.dict.DictClient.factory
  twisted.protocols.dict.DictClient.html#factory
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.protocols.dict.DictClient.__init__
  twisted.protocols.dict.DictClient.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.dict.DictClient.connectionMade
  twisted.protocols.dict.DictClient.html#connectionMade
  Function
  Method
  PUBLIC
  Called when a connection is made.
- twisted.protocols.dict.DictClient.sendLine
  twisted.protocols.dict.DictClient.html#sendLine
  Function
  Method
  PUBLIC
  Throw up if the line is longer than 1022 characters
- twisted.protocols.dict.DictClient.lineReceived
  twisted.protocols.dict.DictClient.html#lineReceived
  Function
  Method
  PUBLIC
  Override this for when each line is received.
- twisted.protocols.dict.DictClient.dictCode_default
  twisted.protocols.dict.DictClient.html#dictCode_default
  Function
  Method
  PUBLIC
  Unknown message
- twisted.protocols.dict.DictClient.dictCode_221_ready
  twisted.protocols.dict.DictClient.html#dictCode_221_ready
  Function
  Method
  PUBLIC
  We are about to get kicked off, do nothing
- twisted.protocols.dict.DictClient.dictCode_220_conn
  twisted.protocols.dict.DictClient.html#dictCode_220_conn
  Function
  Method
  PUBLIC
  Greeting message
- twisted.protocols.dict.DictClient.dictCode_530_conn
  twisted.protocols.dict.DictClient.html#dictCode_530_conn
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.dict.DictClient.dictCode_420_conn
  twisted.protocols.dict.DictClient.html#dictCode_420_conn
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.dict.DictClient.dictCode_421_conn
  twisted.protocols.dict.DictClient.html#dictCode_421_conn
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.dict.DictClient.sendDefine
  twisted.protocols.dict.DictClient.html#sendDefine
  Function
  Method
  PUBLIC
  Send a dict DEFINE command
- twisted.protocols.dict.DictClient.sendMatch
  twisted.protocols.dict.DictClient.html#sendMatch
  Function
  Method
  PUBLIC
  Send a dict MATCH command
- twisted.protocols.dict.DictClient.dictCode_550_define
  twisted.protocols.dict.DictClient.html#dictCode_550_define
  Function
  Method
  PUBLIC
  Invalid database
- twisted.protocols.dict.DictClient.dictCode_550_match
  twisted.protocols.dict.DictClient.html#dictCode_550_match
  Function
  Method
  PUBLIC
  Invalid database
- twisted.protocols.dict.DictClient.dictCode_551_match
  twisted.protocols.dict.DictClient.html#dictCode_551_match
  Function
  Method
  PUBLIC
  Invalid strategy
- twisted.protocols.dict.DictClient.dictCode_552_define
  twisted.protocols.dict.DictClient.html#dictCode_552_define
  Function
  Method
  PUBLIC
  No match
- twisted.protocols.dict.DictClient.dictCode_552_match
  twisted.protocols.dict.DictClient.html#dictCode_552_match
  Function
  Method
  PUBLIC
  No match
- twisted.protocols.dict.DictClient.dictCode_150_define
  twisted.protocols.dict.DictClient.html#dictCode_150_define
  Function
  Method
  PUBLIC
  n definitions retrieved
- twisted.protocols.dict.DictClient.dictCode_151_define
  twisted.protocols.dict.DictClient.html#dictCode_151_define
  Function
  Method
  PUBLIC
  Definition text follows
- twisted.protocols.dict.DictClient.dictCode_152_match
  twisted.protocols.dict.DictClient.html#dictCode_152_match
  Function
  Method
  PUBLIC
  n matches found, text follows
- twisted.protocols.dict.DictClient.dictCode_text_define
  twisted.protocols.dict.DictClient.html#dictCode_text_define
  Function
  Method
  PUBLIC
  A line of definition text received
- twisted.protocols.dict.DictClient.dictCode_text_match
  twisted.protocols.dict.DictClient.html#dictCode_text_match
  Function
  Method
  PUBLIC
  One line of match text received
- twisted.protocols.dict.DictClient.dictCode_250_define
  twisted.protocols.dict.DictClient.html#dictCode_250_define
  Function
  Method
  PUBLIC
  ok
- twisted.protocols.dict.DictClient.dictCode_250_match
  twisted.protocols.dict.DictClient.html#dictCode_250_match
  Function
  Method
  PUBLIC
  ok
- twisted.protocols.dict.DictClient.protocolError
  twisted.protocols.dict.DictClient.html#protocolError
  Function
  Method
  PUBLIC
  override to catch unexpected dict protocol conditions
- twisted.protocols.dict.DictClient.dictConnected
  twisted.protocols.dict.DictClient.html#dictConnected
  Function
  Method
  PUBLIC
  override to be notified when the server is ready to accept commands
- twisted.protocols.dict.DictClient.defineFailed
  twisted.protocols.dict.DictClient.html#defineFailed
  Function
  Method
  PUBLIC
  override to catch reasonable failure responses to DEFINE
- twisted.protocols.dict.DictClient.defineDone
  twisted.protocols.dict.DictClient.html#defineDone
  Function
  Method
  PUBLIC
  override to catch successful DEFINE
- twisted.protocols.dict.DictClient.matchFailed
  twisted.protocols.dict.DictClient.html#matchFailed
  Function
  Method
  PUBLIC
  override to catch reasonable failure responses to MATCH
- twisted.protocols.dict.DictClient.matchDone
  twisted.protocols.dict.DictClient.html#matchDone
  Function
  Method
  PUBLIC
  override to catch successful MATCH
- twisted.protocols.dict.InvalidResponse
  twisted.protocols.dict.InvalidResponse.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.protocols.dict.DictLookup
  twisted.protocols.dict.DictLookup.html
  Class
  Class
  PUBLIC
  Utility class for a single dict transaction. To be used with DictLookupFactory
- twisted.protocols.dict.DictLookup.protocolError
  twisted.protocols.dict.DictLookup.html#protocolError
  Function
  Method
  PUBLIC
  override to catch unexpected dict protocol conditions
- twisted.protocols.dict.DictLookup.dictConnected
  twisted.protocols.dict.DictLookup.html#dictConnected
  Function
  Method
  PUBLIC
  override to be notified when the server is ready to accept commands
- twisted.protocols.dict.DictLookup.defineFailed
  twisted.protocols.dict.DictLookup.html#defineFailed
  Function
  Method
  PUBLIC
  override to catch reasonable failure responses to DEFINE
- twisted.protocols.dict.DictLookup.defineDone
  twisted.protocols.dict.DictLookup.html#defineDone
  Function
  Method
  PUBLIC
  override to catch successful DEFINE
- twisted.protocols.dict.DictLookup.matchFailed
  twisted.protocols.dict.DictLookup.html#matchFailed
  Function
  Method
  PUBLIC
  override to catch reasonable failure responses to MATCH
- twisted.protocols.dict.DictLookup.matchDone
  twisted.protocols.dict.DictLookup.html#matchDone
  Function
  Method
  PUBLIC
  override to catch successful MATCH
- twisted.protocols.dict.DictLookupFactory
  twisted.protocols.dict.DictLookupFactory.html
  Class
  Class
  PUBLIC
  Utility factory for a single dict transaction
- twisted.protocols.dict.DictLookupFactory.done
  twisted.protocols.dict.DictLookupFactory.html#done
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.dict.DictLookupFactory.__init__
  twisted.protocols.dict.DictLookupFactory.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.dict.DictLookupFactory.queryType
  twisted.protocols.dict.DictLookupFactory.html#queryType
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.dict.DictLookupFactory.param
  twisted.protocols.dict.DictLookupFactory.html#param
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.dict.DictLookupFactory.d
  twisted.protocols.dict.DictLookupFactory.html#d
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.dict.DictLookupFactory.clientDone
  twisted.protocols.dict.DictLookupFactory.html#clientDone
  Function
  Method
  PUBLIC
  Called by client when done.
- twisted.protocols.dict.DictLookupFactory.clientConnectionFailed
  twisted.protocols.dict.DictLookupFactory.html#clientConnectionFailed
  Function
  Method
  PUBLIC
  Called when a connection has failed to connect.
- twisted.protocols.dict.DictLookupFactory.clientConnectionLost
  twisted.protocols.dict.DictLookupFactory.html#clientConnectionLost
  Function
  Method
  PUBLIC
  Called when an established connection is lost.
- twisted.protocols.dict.DictLookupFactory.buildProtocol
  twisted.protocols.dict.DictLookupFactory.html#buildProtocol
  Function
  Method
  PUBLIC
  Create an instance of a subclass of Protocol.
- twisted.protocols.dict.define
  twisted.protocols.dict.html#define
  Function
  Function
  PUBLIC
  Look up a word using a dict server
- twisted.protocols.dict.match
  twisted.protocols.dict.html#match
  Function
  Function
  PUBLIC
  Match a word using a dict server
- twisted.protocols.finger.Finger
  twisted.protocols.finger.Finger.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.protocols.finger.Finger.lineReceived
  twisted.protocols.finger.Finger.html#lineReceived
  Function
  Method
  PUBLIC
  Override this for when each line is received.
- twisted.protocols.finger.Finger._refuseMessage
  twisted.protocols.finger.Finger.html#_refuseMessage
  Function
  Method
  PRIVATE
  Undocumented
- twisted.protocols.finger.Finger.forwardQuery
  twisted.protocols.finger.Finger.html#forwardQuery
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.finger.Finger.getDomain
  twisted.protocols.finger.Finger.html#getDomain
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.finger.Finger.getUser
  twisted.protocols.finger.Finger.html#getUser
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.ftp.RESTART_MARKER_REPLY
  twisted.protocols.ftp.html#RESTART_MARKER_REPLY
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.ftp.SERVICE_READY_IN_N_MINUTES
  twisted.protocols.ftp.html#SERVICE_READY_IN_N_MINUTES
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.ftp.DATA_CNX_ALREADY_OPEN_START_XFR
  twisted.protocols.ftp.html#DATA_CNX_ALREADY_OPEN_START_XFR
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.ftp.FILE_STATUS_OK_OPEN_DATA_CNX
  twisted.protocols.ftp.html#FILE_STATUS_OK_OPEN_DATA_CNX
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.ftp.CMD_OK
  twisted.protocols.ftp.html#CMD_OK
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.ftp.TYPE_SET_OK
  twisted.protocols.ftp.html#TYPE_SET_OK
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.ftp.ENTERING_PORT_MODE
  twisted.protocols.ftp.html#ENTERING_PORT_MODE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.ftp.CMD_NOT_IMPLMNTD_SUPERFLUOUS
  twisted.protocols.ftp.html#CMD_NOT_IMPLMNTD_SUPERFLUOUS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.ftp.SYS_STATUS_OR_HELP_REPLY
  twisted.protocols.ftp.html#SYS_STATUS_OR_HELP_REPLY
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.ftp.FEAT_OK
  twisted.protocols.ftp.html#FEAT_OK
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.ftp.DIR_STATUS
  twisted.protocols.ftp.html#DIR_STATUS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.ftp.FILE_STATUS
  twisted.protocols.ftp.html#FILE_STATUS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.ftp.HELP_MSG
  twisted.protocols.ftp.html#HELP_MSG
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.ftp.NAME_SYS_TYPE
  twisted.protocols.ftp.html#NAME_SYS_TYPE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.ftp.SVC_READY_FOR_NEW_USER
  twisted.protocols.ftp.html#SVC_READY_FOR_NEW_USER
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.ftp.WELCOME_MSG
  twisted.protocols.ftp.html#WELCOME_MSG
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.ftp.SVC_CLOSING_CTRL_CNX
  twisted.protocols.ftp.html#SVC_CLOSING_CTRL_CNX
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.ftp.GOODBYE_MSG
  twisted.protocols.ftp.html#GOODBYE_MSG
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.ftp.DATA_CNX_OPEN_NO_XFR_IN_PROGRESS
  twisted.protocols.ftp.html#DATA_CNX_OPEN_NO_XFR_IN_PROGRESS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.ftp.CLOSING_DATA_CNX
  twisted.protocols.ftp.html#CLOSING_DATA_CNX
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.ftp.TXFR_COMPLETE_OK
  twisted.protocols.ftp.html#TXFR_COMPLETE_OK
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.ftp.ENTERING_PASV_MODE
  twisted.protocols.ftp.html#ENTERING_PASV_MODE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.ftp.ENTERING_EPSV_MODE
  twisted.protocols.ftp.html#ENTERING_EPSV_MODE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.ftp.USR_LOGGED_IN_PROCEED
  twisted.protocols.ftp.html#USR_LOGGED_IN_PROCEED
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.ftp.GUEST_LOGGED_IN_PROCEED
  twisted.protocols.ftp.html#GUEST_LOGGED_IN_PROCEED
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.ftp.REQ_FILE_ACTN_COMPLETED_OK
  twisted.protocols.ftp.html#REQ_FILE_ACTN_COMPLETED_OK
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.ftp.PWD_REPLY
  twisted.protocols.ftp.html#PWD_REPLY
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.ftp.MKD_REPLY
  twisted.protocols.ftp.html#MKD_REPLY
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.ftp.USR_NAME_OK_NEED_PASS
  twisted.protocols.ftp.html#USR_NAME_OK_NEED_PASS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.ftp.GUEST_NAME_OK_NEED_EMAIL
  twisted.protocols.ftp.html#GUEST_NAME_OK_NEED_EMAIL
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.ftp.NEED_ACCT_FOR_LOGIN
  twisted.protocols.ftp.html#NEED_ACCT_FOR_LOGIN
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.ftp.REQ_FILE_ACTN_PENDING_FURTHER_INFO
  twisted.protocols.ftp.html#REQ_FILE_ACTN_PENDING_FURTHER_INFO
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.ftp.SVC_NOT_AVAIL_CLOSING_CTRL_CNX
  twisted.protocols.ftp.html#SVC_NOT_AVAIL_CLOSING_CTRL_CNX
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.ftp.TOO_MANY_CONNECTIONS
  twisted.protocols.ftp.html#TOO_MANY_CONNECTIONS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.ftp.CANT_OPEN_DATA_CNX
  twisted.protocols.ftp.html#CANT_OPEN_DATA_CNX
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.ftp.CNX_CLOSED_TXFR_ABORTED
  twisted.protocols.ftp.html#CNX_CLOSED_TXFR_ABORTED
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.ftp.REQ_ACTN_ABRTD_FILE_UNAVAIL
  twisted.protocols.ftp.html#REQ_ACTN_ABRTD_FILE_UNAVAIL
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.ftp.REQ_ACTN_ABRTD_LOCAL_ERR
  twisted.protocols.ftp.html#REQ_ACTN_ABRTD_LOCAL_ERR
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.ftp.REQ_ACTN_ABRTD_INSUFF_STORAGE
  twisted.protocols.ftp.html#REQ_ACTN_ABRTD_INSUFF_STORAGE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.ftp.SYNTAX_ERR
  twisted.protocols.ftp.html#SYNTAX_ERR
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.ftp.SYNTAX_ERR_IN_ARGS
  twisted.protocols.ftp.html#SYNTAX_ERR_IN_ARGS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.ftp.CMD_NOT_IMPLMNTD
  twisted.protocols.ftp.html#CMD_NOT_IMPLMNTD
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.ftp.OPTS_NOT_IMPLEMENTED
  twisted.protocols.ftp.html#OPTS_NOT_IMPLEMENTED
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.ftp.BAD_CMD_SEQ
  twisted.protocols.ftp.html#BAD_CMD_SEQ
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.ftp.CMD_NOT_IMPLMNTD_FOR_PARAM
  twisted.protocols.ftp.html#CMD_NOT_IMPLMNTD_FOR_PARAM
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.ftp.NOT_LOGGED_IN
  twisted.protocols.ftp.html#NOT_LOGGED_IN
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.ftp.AUTH_FAILURE
  twisted.protocols.ftp.html#AUTH_FAILURE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.ftp.NEED_ACCT_FOR_STOR
  twisted.protocols.ftp.html#NEED_ACCT_FOR_STOR
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.ftp.FILE_NOT_FOUND
  twisted.protocols.ftp.html#FILE_NOT_FOUND
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.ftp.PERMISSION_DENIED
  twisted.protocols.ftp.html#PERMISSION_DENIED
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.ftp.ANON_USER_DENIED
  twisted.protocols.ftp.html#ANON_USER_DENIED
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.ftp.IS_NOT_A_DIR
  twisted.protocols.ftp.html#IS_NOT_A_DIR
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.ftp.REQ_ACTN_NOT_TAKEN
  twisted.protocols.ftp.html#REQ_ACTN_NOT_TAKEN
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.ftp.FILE_EXISTS
  twisted.protocols.ftp.html#FILE_EXISTS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.ftp.IS_A_DIR
  twisted.protocols.ftp.html#IS_A_DIR
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.ftp.PAGE_TYPE_UNK
  twisted.protocols.ftp.html#PAGE_TYPE_UNK
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.ftp.EXCEEDED_STORAGE_ALLOC
  twisted.protocols.ftp.html#EXCEEDED_STORAGE_ALLOC
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.ftp.FILENAME_NOT_ALLOWED
  twisted.protocols.ftp.html#FILENAME_NOT_ALLOWED
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.ftp.RESPONSE
  twisted.protocols.ftp.html#RESPONSE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.ftp.InvalidPath
  twisted.protocols.ftp.InvalidPath.html
  Class
  Exception
  PUBLIC
  Internal exception used to signify an error during parsing a path.
- twisted.protocols.ftp.toSegments
  twisted.protocols.ftp.html#toSegments
  Function
  Function
  PUBLIC
  Normalize a path, as represented by a list of strings each representing one segment of the path.
- twisted.protocols.ftp.errnoToFailure
  twisted.protocols.ftp.html#errnoToFailure
  Function
  Function
  PUBLIC
  Map `OSError` and `IOError` to standard FTP errors.
- twisted.protocols.ftp._testTranslation
  twisted.protocols.ftp.html#_testTranslation
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.protocols.ftp._isGlobbingExpression
  twisted.protocols.ftp.html#_isGlobbingExpression
  Function
  Function
  PRIVATE
  Helper for checking if a FTPShell `segments` contains a wildcard Unix expression.
- twisted.protocols.ftp.FTPCmdError
  twisted.protocols.ftp.FTPCmdError.html
  Class
  Exception
  PUBLIC
  Generic exception for FTP commands.
- twisted.protocols.ftp.FTPCmdError.__init__
  twisted.protocols.ftp.FTPCmdError.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.ftp.FTPCmdError.errorMessage
  twisted.protocols.ftp.FTPCmdError.html#errorMessage
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.ftp.FTPCmdError.response
  twisted.protocols.ftp.FTPCmdError.html#response
  Function
  Method
  PUBLIC
  Generate a FTP response message for this error.
- twisted.protocols.ftp.FileNotFoundError
  twisted.protocols.ftp.FileNotFoundError.html
  Class
  Exception
  PUBLIC
  Raised when trying to access a non existent file or directory.
- twisted.protocols.ftp.AnonUserDeniedError
  twisted.protocols.ftp.AnonUserDeniedError.html
  Class
  Exception
  PUBLIC
  Raised when an anonymous user issues a command that will alter the filesystem
- twisted.protocols.ftp.PermissionDeniedError
  twisted.protocols.ftp.PermissionDeniedError.html
  Class
  Exception
  PUBLIC
  Raised when access is attempted to a resource to which access is not allowed.
- twisted.protocols.ftp.IsNotADirectoryError
  twisted.protocols.ftp.IsNotADirectoryError.html
  Class
  Exception
  PUBLIC
  Raised when RMD is called on a path that isn't a directory.
- twisted.protocols.ftp.FileExistsError
  twisted.protocols.ftp.FileExistsError.html
  Class
  Exception
  PUBLIC
  Raised when attempted to override an existing resource.
- twisted.protocols.ftp.IsADirectoryError
  twisted.protocols.ftp.IsADirectoryError.html
  Class
  Exception
  PUBLIC
  Raised when DELE is called on a path that is a directory.
- twisted.protocols.ftp.CmdSyntaxError
  twisted.protocols.ftp.CmdSyntaxError.html
  Class
  Exception
  PUBLIC
  Raised when a command syntax is wrong.
- twisted.protocols.ftp.CmdArgSyntaxError
  twisted.protocols.ftp.CmdArgSyntaxError.html
  Class
  Exception
  PUBLIC
  Raised when a command is called with wrong value or a wrong number of arguments.
- twisted.protocols.ftp.CmdNotImplementedError
  twisted.protocols.ftp.CmdNotImplementedError.html
  Class
  Exception
  PUBLIC
  Raised when an unimplemented command is given to the server.
- twisted.protocols.ftp.CmdNotImplementedForArgError
  twisted.protocols.ftp.CmdNotImplementedForArgError.html
  Class
  Exception
  PUBLIC
  Raised when the handling of a parameter for a command is not implemented by the server.
- twisted.protocols.ftp.FTPError
  twisted.protocols.ftp.FTPError.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.protocols.ftp.PortConnectionError
  twisted.protocols.ftp.PortConnectionError.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.protocols.ftp.BadCmdSequenceError
  twisted.protocols.ftp.BadCmdSequenceError.html
  Class
  Exception
  PUBLIC
  Raised when a client sends a series of commands in an illogical sequence.
- twisted.protocols.ftp.AuthorizationError
  twisted.protocols.ftp.AuthorizationError.html
  Class
  Exception
  PUBLIC
  Raised when client authentication fails.
- twisted.protocols.ftp.debugDeferred
  twisted.protocols.ftp.html#debugDeferred
  Function
  Function
  PUBLIC
  Undocumented
- twisted.protocols.ftp._months
  twisted.protocols.ftp.html#_months
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.protocols.ftp.DTP
  twisted.protocols.ftp.DTP.html
  Class
  Class
  PUBLIC
  No class docstring; 0/4 instance variable, 0/1 class variable, 2/15 methods documented
- twisted.protocols.ftp.DTP.isConnected
  twisted.protocols.ftp.DTP.html#isConnected
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.ftp.DTP._cons
  twisted.protocols.ftp.DTP.html#_cons
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.protocols.ftp.DTP._onConnLost
  twisted.protocols.ftp.DTP.html#_onConnLost
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.protocols.ftp.DTP._buffer
  twisted.protocols.ftp.DTP.html#_buffer
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.protocols.ftp.DTP._encoding
  twisted.protocols.ftp.DTP.html#_encoding
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.protocols.ftp.DTP.connectionMade
  twisted.protocols.ftp.DTP.html#connectionMade
  Function
  Method
  PUBLIC
  Called when a connection is made.
- twisted.protocols.ftp.DTP.connectionLost
  twisted.protocols.ftp.DTP.html#connectionLost
  Function
  Method
  PUBLIC
  Called when the connection is shut down.
- twisted.protocols.ftp.DTP.sendLine
  twisted.protocols.ftp.DTP.html#sendLine
  Function
  Method
  PUBLIC
  Send a line to data channel.
- twisted.protocols.ftp.DTP._formatOneListResponse
  twisted.protocols.ftp.DTP.html#_formatOneListResponse
  Function
  Method
  PRIVATE
  Helper method to format one entry's info into a text entry like: 'drwxrwxrwx 0 user group 0 Jan 01 1970 filename.txt'
- twisted.protocols.ftp.DTP.sendListResponse
  twisted.protocols.ftp.DTP.html#sendListResponse
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.ftp.DTP.registerProducer
  twisted.protocols.ftp.DTP.html#registerProducer
  Function
  Method
  PUBLIC
  Register to receive data from a producer.
- twisted.protocols.ftp.DTP.unregisterProducer
  twisted.protocols.ftp.DTP.html#unregisterProducer
  Function
  Method
  PUBLIC
  Stop consuming data from a producer, without disconnecting.
- twisted.protocols.ftp.DTP.write
  twisted.protocols.ftp.DTP.html#write
  Function
  Method
  PUBLIC
  The producer will write data by calling this method.
- twisted.protocols.ftp.DTP._conswrite
  twisted.protocols.ftp.DTP.html#_conswrite
  Function
  Method
  PRIVATE
  Undocumented
- twisted.protocols.ftp.DTP.dataReceived
  twisted.protocols.ftp.DTP.html#dataReceived
  Function
  Method
  PUBLIC
  Called whenever data is received.
- twisted.protocols.ftp.DTP._unregConsumer
  twisted.protocols.ftp.DTP.html#_unregConsumer
  Function
  Method
  PRIVATE
  Undocumented
- twisted.protocols.ftp.DTP.registerConsumer
  twisted.protocols.ftp.DTP.html#registerConsumer
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.ftp.DTP.resumeProducing
  twisted.protocols.ftp.DTP.html#resumeProducing
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.ftp.DTP.pauseProducing
  twisted.protocols.ftp.DTP.html#pauseProducing
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.ftp.DTP.stopProducing
  twisted.protocols.ftp.DTP.html#stopProducing
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.ftp.DTPFactory
  twisted.protocols.ftp.DTPFactory.html
  Class
  Class
  PUBLIC
  Client factory for data transfer process protocols.
- twisted.protocols.ftp.DTPFactory.peerCheck
  twisted.protocols.ftp.DTPFactory.html#peerCheck
  Attribute
  Instance Variable
  PUBLIC
  perform checks to make sure the ftp-pi's peer is the same as the dtp's
- twisted.protocols.ftp.DTPFactory.pi
  twisted.protocols.ftp.DTPFactory.html#pi
  Attribute
  Instance Variable
  PUBLIC
  a reference to this factory's protocol interpreter
- twisted.protocols.ftp.DTPFactory._state
  twisted.protocols.ftp.DTPFactory.html#_state
  Attribute
  Instance Variable
  PRIVATE
  Indicates the current state of the DTPFactory. Initially, this is `_IN_PROGRESS`. If the connection fails or times out, it is `_FAILED`. If the connection succeeds before the timeout, it is `_FINISHED`.
- twisted.protocols.ftp.DTPFactory._IN_PROGRESS
  twisted.protocols.ftp.DTPFactory.html#_IN_PROGRESS
  Attribute
  Constant
  PRIVATE
  Token to signal that connection is active.
- twisted.protocols.ftp.DTPFactory._FAILED
  twisted.protocols.ftp.DTPFactory.html#_FAILED
  Attribute
  Constant
  PRIVATE
  Token to signal that connection has failed.
- twisted.protocols.ftp.DTPFactory._FINISHED
  twisted.protocols.ftp.DTPFactory.html#_FINISHED
  Attribute
  Constant
  PRIVATE
  Token to signal that connection was successfully closed.
- twisted.protocols.ftp.DTPFactory.__init__
  twisted.protocols.ftp.DTPFactory.html#__init__
  Function
  Method
  PUBLIC
  Constructor
- twisted.protocols.ftp.DTPFactory.peerHost
  twisted.protocols.ftp.DTPFactory.html#peerHost
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.ftp.DTPFactory.deferred
  twisted.protocols.ftp.DTPFactory.html#deferred
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.ftp.DTPFactory.delayedCall
  twisted.protocols.ftp.DTPFactory.html#delayedCall
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.ftp.DTPFactory._reactor
  twisted.protocols.ftp.DTPFactory.html#_reactor
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.protocols.ftp.DTPFactory.buildProtocol
  twisted.protocols.ftp.DTPFactory.html#buildProtocol
  Function
  Method
  PUBLIC
  Create an instance of a subclass of Protocol.
- twisted.protocols.ftp.DTPFactory.stopFactory
  twisted.protocols.ftp.DTPFactory.html#stopFactory
  Function
  Method
  PUBLIC
  This will be called before I stop listening on all Ports/Connectors.
- twisted.protocols.ftp.DTPFactory.timeoutFactory
  twisted.protocols.ftp.DTPFactory.html#timeoutFactory
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.ftp.DTPFactory.cancelTimeout
  twisted.protocols.ftp.DTPFactory.html#cancelTimeout
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.ftp.DTPFactory.setTimeout
  twisted.protocols.ftp.DTPFactory.html#setTimeout
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.ftp.DTPFactory.clientConnectionFailed
  twisted.protocols.ftp.DTPFactory.html#clientConnectionFailed
  Function
  Method
  PUBLIC
  Called when a connection has failed to connect.
- twisted.protocols.ftp.ASCIIConsumerWrapper
  twisted.protocols.ftp.ASCIIConsumerWrapper.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.protocols.ftp.ASCIIConsumerWrapper.__init__
  twisted.protocols.ftp.ASCIIConsumerWrapper.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.ftp.ASCIIConsumerWrapper.cons
  twisted.protocols.ftp.ASCIIConsumerWrapper.html#cons
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.ftp.ASCIIConsumerWrapper.registerProducer
  twisted.protocols.ftp.ASCIIConsumerWrapper.html#registerProducer
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.ftp.ASCIIConsumerWrapper.unregisterProducer
  twisted.protocols.ftp.ASCIIConsumerWrapper.html#unregisterProducer
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.ftp.ASCIIConsumerWrapper.write 0
  twisted.protocols.ftp.ASCIIConsumerWrapper.html#write%200
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.ftp.ASCIIConsumerWrapper.write
  twisted.protocols.ftp.ASCIIConsumerWrapper.html#write
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.ftp.FileConsumer
  twisted.protocols.ftp.FileConsumer.html
  Class
  Class
  PUBLIC
  A consumer for FTP input that writes data to a file.
- twisted.protocols.ftp.FileConsumer.fObj
  twisted.protocols.ftp.FileConsumer.html#fObj
  Attribute
  Instance Variable
  PUBLIC
  a file object opened for writing, used to write data received.
- twisted.protocols.ftp.FileConsumer.__init__
  twisted.protocols.ftp.FileConsumer.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.ftp.FileConsumer.registerProducer
  twisted.protocols.ftp.FileConsumer.html#registerProducer
  Function
  Method
  PUBLIC
  Register to receive data from a producer.
- twisted.protocols.ftp.FileConsumer.producer
  twisted.protocols.ftp.FileConsumer.html#producer
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.ftp.FileConsumer.unregisterProducer
  twisted.protocols.ftp.FileConsumer.html#unregisterProducer
  Function
  Method
  PUBLIC
  Stop consuming data from a producer, without disconnecting.
- twisted.protocols.ftp.FileConsumer.write
  twisted.protocols.ftp.FileConsumer.html#write
  Function
  Method
  PUBLIC
  The producer will write data by calling this method.
- twisted.protocols.ftp.FTPOverflowProtocol
  twisted.protocols.ftp.FTPOverflowProtocol.html
  Class
  Class
  PUBLIC
  FTP mini-protocol for when there are too many connections.
- twisted.protocols.ftp.FTPOverflowProtocol._encoding
  twisted.protocols.ftp.FTPOverflowProtocol.html#_encoding
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.protocols.ftp.FTPOverflowProtocol.connectionMade
  twisted.protocols.ftp.FTPOverflowProtocol.html#connectionMade
  Function
  Method
  PUBLIC
  Called when a connection is made.
- twisted.protocols.ftp.FTP
  twisted.protocols.ftp.FTP.html
  Class
  Class
  PUBLIC
  Protocol Interpreter for the File Transfer Protocol
- twisted.protocols.ftp.FTP.state
  twisted.protocols.ftp.FTP.html#state
  Attribute
  Instance Variable
  PUBLIC
  The current server state. One of `UNAUTH`, `INAUTH`, `AUTHED`, `RENAMING`.
- twisted.protocols.ftp.FTP.shell
  twisted.protocols.ftp.FTP.html#shell
  Attribute
  Instance Variable
  PUBLIC
  The connected avatar
- twisted.protocols.ftp.FTP.binary
  twisted.protocols.ftp.FTP.html#binary
  Attribute
  Instance Variable
  PUBLIC
  The transfer mode. If false, ASCII.
- twisted.protocols.ftp.FTP.dtpFactory
  twisted.protocols.ftp.FTP.html#dtpFactory
  Attribute
  Instance Variable
  PUBLIC
  Generates a single DTP for this session
- twisted.protocols.ftp.FTP.dtpPort
  twisted.protocols.ftp.FTP.html#dtpPort
  Attribute
  Instance Variable
  PUBLIC
  Port returned from listenTCP
- twisted.protocols.ftp.FTP.listenFactory
  twisted.protocols.ftp.FTP.html#listenFactory
  Attribute
  Instance Variable
  PUBLIC
  A callable with the signature of `twisted.internet.interfaces.IReactorTCP.listenTCP` which will be used to create Ports for passive connections (mainly for testing).
- twisted.protocols.ftp.FTP.passivePortRange
  twisted.protocols.ftp.FTP.html#passivePortRange
  Attribute
  Instance Variable
  PUBLIC
  iterator used as source of passive port numbers.
- twisted.protocols.ftp.FTP.UNAUTH
  twisted.protocols.ftp.FTP.html#UNAUTH
  Attribute
  Constant
  PUBLIC
  Command channel is not yet authenticated.
- twisted.protocols.ftp.FTP.INAUTH
  twisted.protocols.ftp.FTP.html#INAUTH
  Attribute
  Constant
  PUBLIC
  Command channel is in the process of being authenticated.
- twisted.protocols.ftp.FTP.AUTHED
  twisted.protocols.ftp.FTP.html#AUTHED
  Attribute
  Constant
  PUBLIC
  Command channel was successfully authenticated.
- twisted.protocols.ftp.FTP.RENAMING
  twisted.protocols.ftp.FTP.html#RENAMING
  Attribute
  Constant
  PUBLIC
  Command channel is between the renaming command sequence.
- twisted.protocols.ftp.FTP.disconnected
  twisted.protocols.ftp.FTP.html#disconnected
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.ftp.FTP.dtpTimeout
  twisted.protocols.ftp.FTP.html#dtpTimeout
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.protocols.ftp.FTP.portal
  twisted.protocols.ftp.FTP.html#portal
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.protocols.ftp.FTP.dtpInstance
  twisted.protocols.ftp.FTP.html#dtpInstance
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.ftp.FTP.PUBLIC_COMMANDS
  twisted.protocols.ftp.FTP.html#PUBLIC_COMMANDS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.ftp.FTP.FEATURES
  twisted.protocols.ftp.FTP.html#FEATURES
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.ftp.FTP._encoding
  twisted.protocols.ftp.FTP.html#_encoding
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.protocols.ftp.FTP.reply
  twisted.protocols.ftp.FTP.html#reply
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.ftp.FTP.sendLine
  twisted.protocols.ftp.FTP.html#sendLine
  Function
  Method
  PUBLIC
  (Private) Encodes and sends a line
- twisted.protocols.ftp.FTP.connectionMade
  twisted.protocols.ftp.FTP.html#connectionMade
  Function
  Method
  PUBLIC
  Called when a connection is made.
- twisted.protocols.ftp.FTP.connectionLost
  twisted.protocols.ftp.FTP.html#connectionLost
  Function
  Method
  PUBLIC
  Called when the connection is shut down.
- twisted.protocols.ftp.FTP.transport
  twisted.protocols.ftp.FTP.html#transport
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.ftp.FTP.timeoutConnection
  twisted.protocols.ftp.FTP.html#timeoutConnection
  Function
  Method
  PUBLIC
  Called when the connection times out.
- twisted.protocols.ftp.FTP.lineReceived
  twisted.protocols.ftp.FTP.html#lineReceived
  Function
  Method
  PUBLIC
  Override this for when each line is received.
- twisted.protocols.ftp.FTP.processCommand
  twisted.protocols.ftp.FTP.html#processCommand
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.ftp.FTP.getDTPPort
  twisted.protocols.ftp.FTP.html#getDTPPort
  Function
  Method
  PUBLIC
  Return a port for passive access, using `self.passivePortRange` attribute.
- twisted.protocols.ftp.FTP.ftp_USER
  twisted.protocols.ftp.FTP.html#ftp_USER
  Function
  Method
  PUBLIC
  First part of login. Get the username the peer wants to authenticate as.
- twisted.protocols.ftp.FTP._user
  twisted.protocols.ftp.FTP.html#_user
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.protocols.ftp.FTP.ftp_PASS
  twisted.protocols.ftp.FTP.html#ftp_PASS
  Function
  Method
  PUBLIC
  Second part of login. Get the password the peer wants to authenticate with.
- twisted.protocols.ftp.FTP.ftp_PASV
  twisted.protocols.ftp.FTP.html#ftp_PASV
  Function
  Method
  PUBLIC
  Request for a passive connection
- twisted.protocols.ftp.FTP.ftp_PORT
  twisted.protocols.ftp.FTP.html#ftp_PORT
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.ftp.FTP._encodeName
  twisted.protocols.ftp.FTP.html#_encodeName
  Function
  Method
  PRIVATE
  Encode `name` to be sent over the wire.
- twisted.protocols.ftp.FTP.ftp_LIST
  twisted.protocols.ftp.FTP.html#ftp_LIST
  Function
  Method
  PUBLIC
  This command causes a list to be sent from the server to the passive DTP. If the pathname specifies a directory or other group of files, the server should transfer a list of files in the specified directory...
- twisted.protocols.ftp.FTP.ftp_NLST
  twisted.protocols.ftp.FTP.html#ftp_NLST
  Function
  Method
  PUBLIC
  This command causes a directory listing to be sent from the server to the client. The pathname should specify a directory or other system-specific file group descriptor. An empty path implies the current working directory...
- twisted.protocols.ftp.FTP.ftp_CWD
  twisted.protocols.ftp.FTP.html#ftp_CWD
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.ftp.FTP.ftp_CDUP
  twisted.protocols.ftp.FTP.html#ftp_CDUP
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.ftp.FTP.ftp_PWD
  twisted.protocols.ftp.FTP.html#ftp_PWD
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.ftp.FTP.ftp_RETR
  twisted.protocols.ftp.FTP.html#ftp_RETR
  Function
  Method
  PUBLIC
  This command causes the content of a file to be sent over the data transfer channel. If the path is to a folder, an error will be raised.
- twisted.protocols.ftp.FTP.ftp_STOR
  twisted.protocols.ftp.FTP.html#ftp_STOR
  Function
  Method
  PUBLIC
  STORE (STOR)
- twisted.protocols.ftp.FTP.ftp_SIZE
  twisted.protocols.ftp.FTP.html#ftp_SIZE
  Function
  Method
  PUBLIC
  File SIZE
- twisted.protocols.ftp.FTP.ftp_MDTM
  twisted.protocols.ftp.FTP.html#ftp_MDTM
  Function
  Method
  PUBLIC
  File Modification Time (MDTM)
- twisted.protocols.ftp.FTP.ftp_TYPE
  twisted.protocols.ftp.FTP.html#ftp_TYPE
  Function
  Method
  PUBLIC
  REPRESENTATION TYPE (TYPE)
- twisted.protocols.ftp.FTP.type_A
  twisted.protocols.ftp.FTP.html#type_A
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.ftp.FTP.type_I
  twisted.protocols.ftp.FTP.html#type_I
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.ftp.FTP.type_UNKNOWN
  twisted.protocols.ftp.FTP.html#type_UNKNOWN
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.ftp.FTP.ftp_SYST
  twisted.protocols.ftp.FTP.html#ftp_SYST
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.ftp.FTP.ftp_STRU
  twisted.protocols.ftp.FTP.html#ftp_STRU
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.ftp.FTP.ftp_MODE
  twisted.protocols.ftp.FTP.html#ftp_MODE
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.ftp.FTP.ftp_MKD
  twisted.protocols.ftp.FTP.html#ftp_MKD
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.ftp.FTP.ftp_RMD
  twisted.protocols.ftp.FTP.html#ftp_RMD
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.ftp.FTP.ftp_DELE
  twisted.protocols.ftp.FTP.html#ftp_DELE
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.ftp.FTP.ftp_NOOP
  twisted.protocols.ftp.FTP.html#ftp_NOOP
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.ftp.FTP.ftp_RNFR
  twisted.protocols.ftp.FTP.html#ftp_RNFR
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.ftp.FTP._fromName
  twisted.protocols.ftp.FTP.html#_fromName
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.protocols.ftp.FTP.ftp_RNTO
  twisted.protocols.ftp.FTP.html#ftp_RNTO
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.ftp.FTP.ftp_FEAT
  twisted.protocols.ftp.FTP.html#ftp_FEAT
  Function
  Method
  PUBLIC
  Advertise the features supported by the server.
- twisted.protocols.ftp.FTP.ftp_OPTS
  twisted.protocols.ftp.FTP.html#ftp_OPTS
  Function
  Method
  PUBLIC
  Handle OPTS command.
- twisted.protocols.ftp.FTP.ftp_QUIT
  twisted.protocols.ftp.FTP.html#ftp_QUIT
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.ftp.FTP.cleanupDTP
  twisted.protocols.ftp.FTP.html#cleanupDTP
  Function
  Method
  PUBLIC
  Call when DTP connection exits
- twisted.protocols.ftp.FTPFactory
  twisted.protocols.ftp.FTPFactory.html
  Class
  Class
  PUBLIC
  A factory for producing ftp protocol instances
- twisted.protocols.ftp.FTPFactory.timeOut
  twisted.protocols.ftp.FTPFactory.html#timeOut
  Attribute
  Instance Variable
  PUBLIC
  the protocol interpreter's idle timeout time in seconds, default is 600 seconds.
- twisted.protocols.ftp.FTPFactory.passivePortRange
  twisted.protocols.ftp.FTPFactory.html#passivePortRange
  Attribute
  Instance Variable
  PUBLIC
  value forwarded to `protocol.passivePortRange`.
- twisted.protocols.ftp.FTPFactory.allowAnonymous
  twisted.protocols.ftp.FTPFactory.html#allowAnonymous
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.protocols.ftp.FTPFactory.userAnonymous
  twisted.protocols.ftp.FTPFactory.html#userAnonymous
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.ftp.FTPFactory.welcomeMessage
  twisted.protocols.ftp.FTPFactory.html#welcomeMessage
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.protocols.ftp.FTPFactory.__init__
  twisted.protocols.ftp.FTPFactory.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.ftp.FTPFactory.portal
  twisted.protocols.ftp.FTPFactory.html#portal
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.ftp.FTPFactory.instances
  twisted.protocols.ftp.FTPFactory.html#instances
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.ftp.FTPFactory.buildProtocol
  twisted.protocols.ftp.FTPFactory.html#buildProtocol
  Function
  Method
  PUBLIC
  Create an instance of a subclass of Protocol.
- twisted.protocols.ftp.FTPFactory.stopFactory
  twisted.protocols.ftp.FTPFactory.html#stopFactory
  Function
  Method
  PUBLIC
  This will be called before I stop listening on all Ports/Connectors.
- twisted.protocols.ftp.IFTPShell
  twisted.protocols.ftp.IFTPShell.html
  Class
  Interface
  PUBLIC
  An abstraction of the shell commands used by the FTP protocol for a given user account.
- twisted.protocols.ftp.IFTPShell.makeDirectory
  twisted.protocols.ftp.IFTPShell.html#makeDirectory
  Function
  Method
  PUBLIC
  Create a directory.
- twisted.protocols.ftp.IFTPShell.removeDirectory
  twisted.protocols.ftp.IFTPShell.html#removeDirectory
  Function
  Method
  PUBLIC
  Remove a directory.
- twisted.protocols.ftp.IFTPShell.removeFile
  twisted.protocols.ftp.IFTPShell.html#removeFile
  Function
  Method
  PUBLIC
  Remove a file.
- twisted.protocols.ftp.IFTPShell.rename
  twisted.protocols.ftp.IFTPShell.html#rename
  Function
  Method
  PUBLIC
  Rename a file or directory.
- twisted.protocols.ftp.IFTPShell.access
  twisted.protocols.ftp.IFTPShell.html#access
  Function
  Method
  PUBLIC
  Determine whether access to the given path is allowed.
- twisted.protocols.ftp.IFTPShell.stat
  twisted.protocols.ftp.IFTPShell.html#stat
  Function
  Method
  PUBLIC
  Retrieve information about the given path.
- twisted.protocols.ftp.IFTPShell.list
  twisted.protocols.ftp.IFTPShell.html#list
  Function
  Method
  PUBLIC
  Retrieve information about the given path.
- twisted.protocols.ftp.IFTPShell.openForReading
  twisted.protocols.ftp.IFTPShell.html#openForReading
  Function
  Method
  PUBLIC
  No summary
- twisted.protocols.ftp.IFTPShell.openForWriting
  twisted.protocols.ftp.IFTPShell.html#openForWriting
  Function
  Method
  PUBLIC
  No summary
- twisted.protocols.ftp.IReadFile
  twisted.protocols.ftp.IReadFile.html
  Class
  Interface
  PUBLIC
  A file out of which bytes may be read.
- twisted.protocols.ftp.IReadFile.send
  twisted.protocols.ftp.IReadFile.html#send
  Function
  Method
  PUBLIC
  Produce the contents of the given path to the given consumer. This method may only be invoked once on each provider.
- twisted.protocols.ftp.IWriteFile
  twisted.protocols.ftp.IWriteFile.html
  Class
  Interface
  PUBLIC
  A file into which bytes may be written.
- twisted.protocols.ftp.IWriteFile.receive
  twisted.protocols.ftp.IWriteFile.html#receive
  Function
  Method
  PUBLIC
  Create a consumer which will write to this file. This method may only be invoked once on each provider.
- twisted.protocols.ftp.IWriteFile.close
  twisted.protocols.ftp.IWriteFile.html#close
  Function
  Method
  PUBLIC
  Perform any post-write work that needs to be done. This method may only be invoked once on each provider, and will always be invoked after receive().
- twisted.protocols.ftp._getgroups
  twisted.protocols.ftp.html#_getgroups
  Function
  Function
  PRIVATE
  Return the primary and supplementary groups for the given UID.
- twisted.protocols.ftp._testPermissions
  twisted.protocols.ftp.html#_testPermissions
  Function
  Function
  PRIVATE
  checks to see if uid has proper permissions to access path with mode
- twisted.protocols.ftp.FTPAnonymousShell
  twisted.protocols.ftp.FTPAnonymousShell.html
  Class
  Class
  PUBLIC
  An anonymous implementation of IFTPShell
- twisted.protocols.ftp.FTPAnonymousShell.filesystemRoot
  twisted.protocols.ftp.FTPAnonymousShell.html#filesystemRoot
  Attribute
  Instance Variable
  PUBLIC
  The path which is considered the root of this shell.
- twisted.protocols.ftp.FTPAnonymousShell.__init__
  twisted.protocols.ftp.FTPAnonymousShell.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.ftp.FTPAnonymousShell._path
  twisted.protocols.ftp.FTPAnonymousShell.html#_path
  Function
  Method
  PRIVATE
  Undocumented
- twisted.protocols.ftp.FTPAnonymousShell.makeDirectory
  twisted.protocols.ftp.FTPAnonymousShell.html#makeDirectory
  Function
  Method
  PUBLIC
  Create a directory.
- twisted.protocols.ftp.FTPAnonymousShell.removeDirectory
  twisted.protocols.ftp.FTPAnonymousShell.html#removeDirectory
  Function
  Method
  PUBLIC
  Remove a directory.
- twisted.protocols.ftp.FTPAnonymousShell.removeFile
  twisted.protocols.ftp.FTPAnonymousShell.html#removeFile
  Function
  Method
  PUBLIC
  Remove a file.
- twisted.protocols.ftp.FTPAnonymousShell.rename
  twisted.protocols.ftp.FTPAnonymousShell.html#rename
  Function
  Method
  PUBLIC
  Rename a file or directory.
- twisted.protocols.ftp.FTPAnonymousShell.receive
  twisted.protocols.ftp.FTPAnonymousShell.html#receive
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.ftp.FTPAnonymousShell.openForReading
  twisted.protocols.ftp.FTPAnonymousShell.html#openForReading
  Function
  Method
  PUBLIC
  Open `path` for reading.
- twisted.protocols.ftp.FTPAnonymousShell.openForWriting
  twisted.protocols.ftp.FTPAnonymousShell.html#openForWriting
  Function
  Method
  PUBLIC
  Reject write attempts by anonymous users with `PermissionDeniedError`.
- twisted.protocols.ftp.FTPAnonymousShell.access
  twisted.protocols.ftp.FTPAnonymousShell.html#access
  Function
  Method
  PUBLIC
  Determine whether access to the given path is allowed.
- twisted.protocols.ftp.FTPAnonymousShell.stat
  twisted.protocols.ftp.FTPAnonymousShell.html#stat
  Function
  Method
  PUBLIC
  Retrieve information about the given path.
- twisted.protocols.ftp.FTPAnonymousShell.list
  twisted.protocols.ftp.FTPAnonymousShell.html#list
  Function
  Method
  PUBLIC
  Return the list of files at given `path`, adding `keys` stat informations if specified.
- twisted.protocols.ftp.FTPAnonymousShell._statNode
  twisted.protocols.ftp.FTPAnonymousShell.html#_statNode
  Function
  Method
  PRIVATE
  Shortcut method to get stat info on a node.
- twisted.protocols.ftp.FTPAnonymousShell._stat_size
  twisted.protocols.ftp.FTPAnonymousShell.html#_stat_size
  Function
  Method
  PRIVATE
  Get the filepath's size as an int
- twisted.protocols.ftp.FTPAnonymousShell._stat_permissions
  twisted.protocols.ftp.FTPAnonymousShell.html#_stat_permissions
  Function
  Method
  PRIVATE
  Get the filepath's permissions object
- twisted.protocols.ftp.FTPAnonymousShell._stat_hardlinks
  twisted.protocols.ftp.FTPAnonymousShell.html#_stat_hardlinks
  Function
  Method
  PRIVATE
  Get the number of hardlinks for the filepath - if the number of hardlinks is not yet implemented (say in Windows), just return 0 since stat-ing a file in Windows seems to return `st_nlink=0`.
- twisted.protocols.ftp.FTPAnonymousShell._stat_modified
  twisted.protocols.ftp.FTPAnonymousShell.html#_stat_modified
  Function
  Method
  PRIVATE
  Get the filepath's last modified date
- twisted.protocols.ftp.FTPAnonymousShell._stat_owner
  twisted.protocols.ftp.FTPAnonymousShell.html#_stat_owner
  Function
  Method
  PRIVATE
  Get the filepath's owner's username. If this is not implemented (say in Windows) return the string "0" since stat-ing a file in Windows seems to return `st_uid=0`.
- twisted.protocols.ftp.FTPAnonymousShell._stat_group
  twisted.protocols.ftp.FTPAnonymousShell.html#_stat_group
  Function
  Method
  PRIVATE
  Get the filepath's owner's group. If this is not implemented (say in Windows) return the string "0" since stat-ing a file in Windows seems to return `st_gid=0`.
- twisted.protocols.ftp.FTPAnonymousShell._stat_directory
  twisted.protocols.ftp.FTPAnonymousShell.html#_stat_directory
  Function
  Method
  PRIVATE
  Get whether the filepath is a directory
- twisted.protocols.ftp._FileReader
  twisted.protocols.ftp._FileReader.html
  Class
  Class
  PRIVATE
  Undocumented
- twisted.protocols.ftp._FileReader.__init__
  twisted.protocols.ftp._FileReader.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.ftp._FileReader.fObj
  twisted.protocols.ftp._FileReader.html#fObj
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.ftp._FileReader._send
  twisted.protocols.ftp._FileReader.html#_send
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.protocols.ftp._FileReader._close
  twisted.protocols.ftp._FileReader.html#_close
  Function
  Method
  PRIVATE
  Undocumented
- twisted.protocols.ftp._FileReader.send
  twisted.protocols.ftp._FileReader.html#send
  Function
  Method
  PUBLIC
  Produce the contents of the given path to the given consumer. This method may only be invoked once on each provider.
- twisted.protocols.ftp.FTPShell
  twisted.protocols.ftp.FTPShell.html
  Class
  Class
  PUBLIC
  An authenticated implementation of `IFTPShell`.
- twisted.protocols.ftp.FTPShell.makeDirectory
  twisted.protocols.ftp.FTPShell.html#makeDirectory
  Function
  Method
  PUBLIC
  Create a directory.
- twisted.protocols.ftp.FTPShell.removeDirectory
  twisted.protocols.ftp.FTPShell.html#removeDirectory
  Function
  Method
  PUBLIC
  Remove a directory.
- twisted.protocols.ftp.FTPShell.removeFile
  twisted.protocols.ftp.FTPShell.html#removeFile
  Function
  Method
  PUBLIC
  Remove a file.
- twisted.protocols.ftp.FTPShell.rename
  twisted.protocols.ftp.FTPShell.html#rename
  Function
  Method
  PUBLIC
  Rename a file or directory.
- twisted.protocols.ftp.FTPShell.openForWriting
  twisted.protocols.ftp.FTPShell.html#openForWriting
  Function
  Method
  PUBLIC
  Open `path` for writing.
- twisted.protocols.ftp._FileWriter
  twisted.protocols.ftp._FileWriter.html
  Class
  Class
  PRIVATE
  Undocumented
- twisted.protocols.ftp._FileWriter.__init__
  twisted.protocols.ftp._FileWriter.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.ftp._FileWriter.fObj
  twisted.protocols.ftp._FileWriter.html#fObj
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.ftp._FileWriter._receive
  twisted.protocols.ftp._FileWriter.html#_receive
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.protocols.ftp._FileWriter.receive
  twisted.protocols.ftp._FileWriter.html#receive
  Function
  Method
  PUBLIC
  Create a consumer which will write to this file. This method may only be invoked once on each provider.
- twisted.protocols.ftp._FileWriter.close
  twisted.protocols.ftp._FileWriter.html#close
  Function
  Method
  PUBLIC
  Perform any post-write work that needs to be done. This method may only be invoked once on each provider, and will always be invoked after receive().
- twisted.protocols.ftp.BaseFTPRealm
  twisted.protocols.ftp.BaseFTPRealm.html
  Class
  Class
  PUBLIC
  Base class for simple FTP realms which provides an easy hook for specifying the home directory for each user.
- twisted.protocols.ftp.BaseFTPRealm.__init__
  twisted.protocols.ftp.BaseFTPRealm.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.ftp.BaseFTPRealm.anonymousRoot
  twisted.protocols.ftp.BaseFTPRealm.html#anonymousRoot
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.ftp.BaseFTPRealm.getHomeDirectory
  twisted.protocols.ftp.BaseFTPRealm.html#getHomeDirectory
  Function
  Method
  PUBLIC
  Return a `FilePath` representing the home directory of the given avatar. Override this in a subclass.
- twisted.protocols.ftp.BaseFTPRealm.requestAvatar
  twisted.protocols.ftp.BaseFTPRealm.html#requestAvatar
  Function
  Method
  PUBLIC
  Return avatar which provides one of the given interfaces.
- twisted.protocols.ftp.FTPRealm
  twisted.protocols.ftp.FTPRealm.html
  Class
  Class
  PUBLIC
  No summary
- twisted.protocols.ftp.FTPRealm.anonymousRoot
  twisted.protocols.ftp.FTPRealm.html#anonymousRoot
  Attribute
  Instance Variable
  PUBLIC
  Root of the filesystem to which anonymous users will be granted access.
- twisted.protocols.ftp.FTPRealm.userHome
  twisted.protocols.ftp.FTPRealm.html#userHome
  Attribute
  Instance Variable
  PUBLIC
  Root of the filesystem containing user home directories.
- twisted.protocols.ftp.FTPRealm.__init__
  twisted.protocols.ftp.FTPRealm.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.ftp.FTPRealm.getHomeDirectory
  twisted.protocols.ftp.FTPRealm.html#getHomeDirectory
  Function
  Method
  PUBLIC
  Use `avatarId` as a single path segment to construct a child of `self.userHome` and return that child.
- twisted.protocols.ftp.SystemFTPRealm
  twisted.protocols.ftp.SystemFTPRealm.html
  Class
  Class
  PUBLIC
  `SystemFTPRealm` uses system user account information to decide what the home directory for a particular avatarId is.
- twisted.protocols.ftp.SystemFTPRealm.getHomeDirectory
  twisted.protocols.ftp.SystemFTPRealm.html#getHomeDirectory
  Function
  Method
  PUBLIC
  Return the system-defined home directory of the system user account with the name `avatarId`.
- twisted.protocols.ftp.ConnectionLost
  twisted.protocols.ftp.ConnectionLost.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.protocols.ftp.CommandFailed
  twisted.protocols.ftp.CommandFailed.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.protocols.ftp.BadResponse
  twisted.protocols.ftp.BadResponse.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.protocols.ftp.UnexpectedResponse
  twisted.protocols.ftp.UnexpectedResponse.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.protocols.ftp.UnexpectedData
  twisted.protocols.ftp.UnexpectedData.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.protocols.ftp.FTPCommand
  twisted.protocols.ftp.FTPCommand.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.protocols.ftp.FTPCommand.__init__
  twisted.protocols.ftp.FTPCommand.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.ftp.FTPCommand.text
  twisted.protocols.ftp.FTPCommand.html#text
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.ftp.FTPCommand.deferred
  twisted.protocols.ftp.FTPCommand.html#deferred
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.ftp.FTPCommand.ready
  twisted.protocols.ftp.FTPCommand.html#ready
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.ftp.FTPCommand.public
  twisted.protocols.ftp.FTPCommand.html#public
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.ftp.FTPCommand.transferDeferred
  twisted.protocols.ftp.FTPCommand.html#transferDeferred
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.ftp.FTPCommand.fail
  twisted.protocols.ftp.FTPCommand.html#fail
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.ftp.ProtocolWrapper
  twisted.protocols.ftp.ProtocolWrapper.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.protocols.ftp.ProtocolWrapper.__init__
  twisted.protocols.ftp.ProtocolWrapper.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.ftp.ProtocolWrapper.original
  twisted.protocols.ftp.ProtocolWrapper.html#original
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.ftp.ProtocolWrapper.deferred
  twisted.protocols.ftp.ProtocolWrapper.html#deferred
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.ftp.ProtocolWrapper.makeConnection
  twisted.protocols.ftp.ProtocolWrapper.html#makeConnection
  Function
  Method
  PUBLIC
  Make a connection to a transport and a server.
- twisted.protocols.ftp.ProtocolWrapper.dataReceived
  twisted.protocols.ftp.ProtocolWrapper.html#dataReceived
  Function
  Method
  PUBLIC
  Called whenever data is received.
- twisted.protocols.ftp.ProtocolWrapper.connectionLost
  twisted.protocols.ftp.ProtocolWrapper.html#connectionLost
  Function
  Method
  PUBLIC
  Called when the connection is shut down.
- twisted.protocols.ftp.IFinishableConsumer
  twisted.protocols.ftp.IFinishableConsumer.html
  Class
  Interface
  PUBLIC
  A Consumer for producers that finish.
- twisted.protocols.ftp.IFinishableConsumer.finish
  twisted.protocols.ftp.IFinishableConsumer.html#finish
  Function
  Method
  PUBLIC
  The producer has finished producing.
- twisted.protocols.ftp.SenderProtocol
  twisted.protocols.ftp.SenderProtocol.html
  Class
  Class
  PUBLIC
  No class docstring; 0/2 instance variable, 2/8 methods documented
- twisted.protocols.ftp.SenderProtocol.__init__
  twisted.protocols.ftp.SenderProtocol.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.ftp.SenderProtocol.connectedDeferred
  twisted.protocols.ftp.SenderProtocol.html#connectedDeferred
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.ftp.SenderProtocol.deferred
  twisted.protocols.ftp.SenderProtocol.html#deferred
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.ftp.SenderProtocol.dataReceived
  twisted.protocols.ftp.SenderProtocol.html#dataReceived
  Function
  Method
  PUBLIC
  Called whenever data is received.
- twisted.protocols.ftp.SenderProtocol.makeConnection
  twisted.protocols.ftp.SenderProtocol.html#makeConnection
  Function
  Method
  PUBLIC
  Make a connection to a transport and a server.
- twisted.protocols.ftp.SenderProtocol.connectionLost
  twisted.protocols.ftp.SenderProtocol.html#connectionLost
  Function
  Method
  PUBLIC
  Called when the connection is shut down.
- twisted.protocols.ftp.SenderProtocol.write
  twisted.protocols.ftp.SenderProtocol.html#write
  Function
  Method
  PUBLIC
  The producer will write data by calling this method.
- twisted.protocols.ftp.SenderProtocol.registerProducer
  twisted.protocols.ftp.SenderProtocol.html#registerProducer
  Function
  Method
  PUBLIC
  Register the given producer with our transport.
- twisted.protocols.ftp.SenderProtocol.unregisterProducer
  twisted.protocols.ftp.SenderProtocol.html#unregisterProducer
  Function
  Method
  PUBLIC
  Unregister the previously registered producer.
- twisted.protocols.ftp.SenderProtocol.finish
  twisted.protocols.ftp.SenderProtocol.html#finish
  Function
  Method
  PUBLIC
  The producer has finished producing.
- twisted.protocols.ftp.decodeHostPort
  twisted.protocols.ftp.html#decodeHostPort
  Function
  Function
  PUBLIC
  Decode an FTP response specifying a host and port.
- twisted.protocols.ftp.encodeHostPort
  twisted.protocols.ftp.html#encodeHostPort
  Function
  Function
  PUBLIC
  Undocumented
- twisted.protocols.ftp._unwrapFirstError
  twisted.protocols.ftp.html#_unwrapFirstError
  Function
  Function
  PRIVATE
  Undocumented
- twisted.protocols.ftp.FTPDataPortFactory
  twisted.protocols.ftp.FTPDataPortFactory.html
  Class
  Class
  PUBLIC
  Factory for data connections that use the PORT command
- twisted.protocols.ftp.FTPDataPortFactory.noisy
  twisted.protocols.ftp.FTPDataPortFactory.html#noisy
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.protocols.ftp.FTPDataPortFactory.buildProtocol
  twisted.protocols.ftp.FTPDataPortFactory.html#buildProtocol
  Function
  Method
  PUBLIC
  Create an instance of a subclass of Protocol.
- twisted.protocols.ftp.FTPClientBasic
  twisted.protocols.ftp.FTPClientBasic.html
  Class
  Class
  PUBLIC
  Foundations of an FTP client.
- twisted.protocols.ftp.FTPClientBasic.debug
  twisted.protocols.ftp.FTPClientBasic.html#debug
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.protocols.ftp.FTPClientBasic._encoding
  twisted.protocols.ftp.FTPClientBasic.html#_encoding
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.protocols.ftp.FTPClientBasic.__init__
  twisted.protocols.ftp.FTPClientBasic.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.ftp.FTPClientBasic.actionQueue
  twisted.protocols.ftp.FTPClientBasic.html#actionQueue
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.ftp.FTPClientBasic.greeting
  twisted.protocols.ftp.FTPClientBasic.html#greeting
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.ftp.FTPClientBasic.nextDeferred
  twisted.protocols.ftp.FTPClientBasic.html#nextDeferred
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.ftp.FTPClientBasic.response
  twisted.protocols.ftp.FTPClientBasic.html#response
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.ftp.FTPClientBasic._failed
  twisted.protocols.ftp.FTPClientBasic.html#_failed
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.protocols.ftp.FTPClientBasic.fail
  twisted.protocols.ftp.FTPClientBasic.html#fail
  Function
  Method
  PUBLIC
  Give an error to any queued deferreds.
- twisted.protocols.ftp.FTPClientBasic._fail
  twisted.protocols.ftp.FTPClientBasic.html#_fail
  Function
  Method
  PRIVATE
  Errback all queued deferreds.
- twisted.protocols.ftp.FTPClientBasic._cb_greeting
  twisted.protocols.ftp.FTPClientBasic.html#_cb_greeting
  Function
  Method
  PRIVATE
  Undocumented
- twisted.protocols.ftp.FTPClientBasic.sendLine
  twisted.protocols.ftp.FTPClientBasic.html#sendLine
  Function
  Method
  PUBLIC
  Sends a line, unless line is None.
- twisted.protocols.ftp.FTPClientBasic.sendNextCommand
  twisted.protocols.ftp.FTPClientBasic.html#sendNextCommand
  Function
  Method
  PUBLIC
  (Private) Processes the next command in the queue.
- twisted.protocols.ftp.FTPClientBasic.queueCommand
  twisted.protocols.ftp.FTPClientBasic.html#queueCommand
  Function
  Method
  PUBLIC
  Add an FTPCommand object to the queue.
- twisted.protocols.ftp.FTPClientBasic.queueStringCommand
  twisted.protocols.ftp.FTPClientBasic.html#queueStringCommand
  Function
  Method
  PUBLIC
  Queues a string to be issued as an FTP command
- twisted.protocols.ftp.FTPClientBasic.popCommandQueue
  twisted.protocols.ftp.FTPClientBasic.html#popCommandQueue
  Function
  Method
  PUBLIC
  Return the front element of the command queue, or None if empty.
- twisted.protocols.ftp.FTPClientBasic.queueLogin
  twisted.protocols.ftp.FTPClientBasic.html#queueLogin
  Function
  Method
  PUBLIC
  Login: send the username, send the password.
- twisted.protocols.ftp.FTPClientBasic.lineReceived
  twisted.protocols.ftp.FTPClientBasic.html#lineReceived
  Function
  Method
  PUBLIC
  (Private) Parses the response messages from the FTP server.
- twisted.protocols.ftp.FTPClientBasic.connectionLost
  twisted.protocols.ftp.FTPClientBasic.html#connectionLost
  Function
  Method
  PUBLIC
  Called when the connection is shut down.
- twisted.protocols.ftp._PassiveConnectionFactory
  twisted.protocols.ftp._PassiveConnectionFactory.html
  Class
  Class
  PRIVATE
  Undocumented
- twisted.protocols.ftp._PassiveConnectionFactory.noisy
  twisted.protocols.ftp._PassiveConnectionFactory.html#noisy
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.protocols.ftp._PassiveConnectionFactory.__init__
  twisted.protocols.ftp._PassiveConnectionFactory.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.ftp._PassiveConnectionFactory.protoInstance
  twisted.protocols.ftp._PassiveConnectionFactory.html#protoInstance
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.ftp._PassiveConnectionFactory.buildProtocol
  twisted.protocols.ftp._PassiveConnectionFactory.html#buildProtocol
  Function
  Method
  PUBLIC
  Create an instance of a subclass of Protocol.
- twisted.protocols.ftp._PassiveConnectionFactory.clientConnectionFailed
  twisted.protocols.ftp._PassiveConnectionFactory.html#clientConnectionFailed
  Function
  Method
  PUBLIC
  Called when a connection has failed to connect.
- twisted.protocols.ftp.FTPClient
  twisted.protocols.ftp.FTPClient.html
  Class
  Class
  PUBLIC
  `FTPClient` is a client implementation of the FTP protocol which exposes FTP commands as methods which return `Deferred`s.
- twisted.protocols.ftp.FTPClient.passive
  twisted.protocols.ftp.FTPClient.html#passive
  Attribute
  Instance Variable
  PUBLIC
  See description in __init__.
- twisted.protocols.ftp.FTPClient.__init__
  twisted.protocols.ftp.FTPClient.html#__init__
  Function
  Method
  PUBLIC
  Constructor.
- twisted.protocols.ftp.FTPClient.fail
  twisted.protocols.ftp.FTPClient.html#fail
  Function
  Method
  PUBLIC
  Disconnect, and also give an error to any queued deferreds.
- twisted.protocols.ftp.FTPClient.receiveFromConnection
  twisted.protocols.ftp.FTPClient.html#receiveFromConnection
  Function
  Method
  PUBLIC
  Retrieves a file or listing generated by the given command, feeding it to the given protocol.
- twisted.protocols.ftp.FTPClient.queueLogin
  twisted.protocols.ftp.FTPClient.html#queueLogin
  Function
  Method
  PUBLIC
  Login: send the username, send the password, and set retrieval mode to binary
- twisted.protocols.ftp.FTPClient.sendToConnection
  twisted.protocols.ftp.FTPClient.html#sendToConnection
  Function
  Method
  PUBLIC
  XXX
- twisted.protocols.ftp.FTPClient._openDataConnection
  twisted.protocols.ftp.FTPClient.html#_openDataConnection
  Function
  Method
  PRIVATE
  This method returns a DeferredList.
- twisted.protocols.ftp.FTPClient.generatePortCommand
  twisted.protocols.ftp.FTPClient.html#generatePortCommand
  Function
  Method
  PUBLIC
  (Private) Generates the text of a given PORT command.
- twisted.protocols.ftp.FTPClient.escapePath
  twisted.protocols.ftp.FTPClient.html#escapePath
  Function
  Method
  PUBLIC
  Returns a FTP escaped path (replace newlines with nulls).
- twisted.protocols.ftp.FTPClient.retrieveFile
  twisted.protocols.ftp.FTPClient.html#retrieveFile
  Function
  Method
  PUBLIC
  Retrieve a file from the given path
- twisted.protocols.ftp.FTPClient.storeFile
  twisted.protocols.ftp.FTPClient.html#storeFile
  Function
  Method
  PUBLIC
  Store a file at the given path.
- twisted.protocols.ftp.FTPClient.rename
  twisted.protocols.ftp.FTPClient.html#rename
  Function
  Method
  PUBLIC
  Rename a file.
- twisted.protocols.ftp.FTPClient.list
  twisted.protocols.ftp.FTPClient.html#list
  Function
  Method
  PUBLIC
  Retrieve a file listing into the given protocol instance.
- twisted.protocols.ftp.FTPClient.nlst
  twisted.protocols.ftp.FTPClient.html#nlst
  Function
  Method
  PUBLIC
  Retrieve a short file listing into the given protocol instance.
- twisted.protocols.ftp.FTPClient.cwd
  twisted.protocols.ftp.FTPClient.html#cwd
  Function
  Method
  PUBLIC
  Issues the CWD (Change Working Directory) command.
- twisted.protocols.ftp.FTPClient.makeDirectory
  twisted.protocols.ftp.FTPClient.html#makeDirectory
  Function
  Method
  PUBLIC
  Make a directory
- twisted.protocols.ftp.FTPClient.removeFile
  twisted.protocols.ftp.FTPClient.html#removeFile
  Function
  Method
  PUBLIC
  Delete a file on the server.
- twisted.protocols.ftp.FTPClient.removeDirectory
  twisted.protocols.ftp.FTPClient.html#removeDirectory
  Function
  Method
  PUBLIC
  Delete a directory on the server.
- twisted.protocols.ftp.FTPClient.cdup
  twisted.protocols.ftp.FTPClient.html#cdup
  Function
  Method
  PUBLIC
  Issues the CDUP (Change Directory UP) command.
- twisted.protocols.ftp.FTPClient.pwd
  twisted.protocols.ftp.FTPClient.html#pwd
  Function
  Method
  PUBLIC
  Issues the PWD (Print Working Directory) command.
- twisted.protocols.ftp.FTPClient.getDirectory
  twisted.protocols.ftp.FTPClient.html#getDirectory
  Function
  Method
  PUBLIC
  Returns the current remote directory.
- twisted.protocols.ftp.FTPClient.quit
  twisted.protocols.ftp.FTPClient.html#quit
  Function
  Method
  PUBLIC
  Issues the QUIT command.
- twisted.protocols.ftp.FTPFileListProtocol
  twisted.protocols.ftp.FTPFileListProtocol.html
  Class
  Class
  PUBLIC
  Parser for standard FTP file listings
- twisted.protocols.ftp.FTPFileListProtocol.files
  twisted.protocols.ftp.FTPFileListProtocol.html#files
  Attribute
  Instance Variable
  PUBLIC
  list of dicts describing the files in this listing
- twisted.protocols.ftp.FTPFileListProtocol.fileLinePattern
  twisted.protocols.ftp.FTPFileListProtocol.html#fileLinePattern
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.protocols.ftp.FTPFileListProtocol.delimiter
  twisted.protocols.ftp.FTPFileListProtocol.html#delimiter
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.protocols.ftp.FTPFileListProtocol._encoding
  twisted.protocols.ftp.FTPFileListProtocol.html#_encoding
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.protocols.ftp.FTPFileListProtocol.__init__
  twisted.protocols.ftp.FTPFileListProtocol.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.ftp.FTPFileListProtocol.lineReceived
  twisted.protocols.ftp.FTPFileListProtocol.html#lineReceived
  Function
  Method
  PUBLIC
  Override this for when each line is received.
- twisted.protocols.ftp.FTPFileListProtocol.parseDirectoryLine
  twisted.protocols.ftp.FTPFileListProtocol.html#parseDirectoryLine
  Function
  Method
  PUBLIC
  Return a dictionary of fields, or None if line cannot be parsed.
- twisted.protocols.ftp.FTPFileListProtocol.addFile
  twisted.protocols.ftp.FTPFileListProtocol.html#addFile
  Function
  Method
  PUBLIC
  Append file information dictionary to the list of known files.
- twisted.protocols.ftp.FTPFileListProtocol.unknownLine
  twisted.protocols.ftp.FTPFileListProtocol.html#unknownLine
  Function
  Method
  PUBLIC
  Deal with received lines which could not be parsed as file information.
- twisted.protocols.ftp.parsePWDResponse
  twisted.protocols.ftp.html#parsePWDResponse
  Function
  Function
  PUBLIC
  Returns the path from a response to a PWD command.
- twisted.protocols.pcp.BasicProducerConsumerProxy
  twisted.protocols.pcp.BasicProducerConsumerProxy.html
  Class
  Class
  PUBLIC
  I can act as a man in the middle between any Producer and Consumer.
- twisted.protocols.pcp.BasicProducerConsumerProxy.producer
  twisted.protocols.pcp.BasicProducerConsumerProxy.html#producer
  Attribute
  Instance Variable
  PUBLIC
  the Producer I subscribe to.
- twisted.protocols.pcp.BasicProducerConsumerProxy.consumer
  twisted.protocols.pcp.BasicProducerConsumerProxy.html#consumer
  Attribute
  Instance Variable
  PUBLIC
  the Consumer I publish to.
- twisted.protocols.pcp.BasicProducerConsumerProxy.paused
  twisted.protocols.pcp.BasicProducerConsumerProxy.html#paused
  Attribute
  Instance Variable
  PUBLIC
  As a Producer, am I paused?
- twisted.protocols.pcp.BasicProducerConsumerProxy.producerIsStreaming
  twisted.protocols.pcp.BasicProducerConsumerProxy.html#producerIsStreaming
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.pcp.BasicProducerConsumerProxy.iAmStreaming
  twisted.protocols.pcp.BasicProducerConsumerProxy.html#iAmStreaming
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.protocols.pcp.BasicProducerConsumerProxy.outstandingPull
  twisted.protocols.pcp.BasicProducerConsumerProxy.html#outstandingPull
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.protocols.pcp.BasicProducerConsumerProxy.stopped
  twisted.protocols.pcp.BasicProducerConsumerProxy.html#stopped
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.protocols.pcp.BasicProducerConsumerProxy.__init__
  twisted.protocols.pcp.BasicProducerConsumerProxy.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.pcp.BasicProducerConsumerProxy._buffer
  twisted.protocols.pcp.BasicProducerConsumerProxy.html#_buffer
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.protocols.pcp.BasicProducerConsumerProxy.pauseProducing
  twisted.protocols.pcp.BasicProducerConsumerProxy.html#pauseProducing
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.pcp.BasicProducerConsumerProxy.resumeProducing
  twisted.protocols.pcp.BasicProducerConsumerProxy.html#resumeProducing
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.pcp.BasicProducerConsumerProxy.stopProducing
  twisted.protocols.pcp.BasicProducerConsumerProxy.html#stopProducing
  Function
  Method
  PUBLIC
  Stop producing data.
- twisted.protocols.pcp.BasicProducerConsumerProxy.write
  twisted.protocols.pcp.BasicProducerConsumerProxy.html#write
  Function
  Method
  PUBLIC
  The producer will write data by calling this method.
- twisted.protocols.pcp.BasicProducerConsumerProxy.finish
  twisted.protocols.pcp.BasicProducerConsumerProxy.html#finish
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.pcp.BasicProducerConsumerProxy.registerProducer
  twisted.protocols.pcp.BasicProducerConsumerProxy.html#registerProducer
  Function
  Method
  PUBLIC
  Register to receive data from a producer.
- twisted.protocols.pcp.BasicProducerConsumerProxy.unregisterProducer
  twisted.protocols.pcp.BasicProducerConsumerProxy.html#unregisterProducer
  Function
  Method
  PUBLIC
  Stop consuming data from a producer, without disconnecting.
- twisted.protocols.pcp.BasicProducerConsumerProxy.__repr__
  twisted.protocols.pcp.BasicProducerConsumerProxy.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.pcp.ProducerConsumerProxy
  twisted.protocols.pcp.ProducerConsumerProxy.html
  Class
  Class
  PUBLIC
  ProducerConsumerProxy with a finite buffer.
- twisted.protocols.pcp.ProducerConsumerProxy.bufferSize
  twisted.protocols.pcp.ProducerConsumerProxy.html#bufferSize
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.protocols.pcp.ProducerConsumerProxy.producerPaused
  twisted.protocols.pcp.ProducerConsumerProxy.html#producerPaused
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.pcp.ProducerConsumerProxy.unregistered
  twisted.protocols.pcp.ProducerConsumerProxy.html#unregistered
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.pcp.ProducerConsumerProxy.pauseProducing
  twisted.protocols.pcp.ProducerConsumerProxy.html#pauseProducing
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.pcp.ProducerConsumerProxy.paused
  twisted.protocols.pcp.ProducerConsumerProxy.html#paused
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.pcp.ProducerConsumerProxy.resumeProducing
  twisted.protocols.pcp.ProducerConsumerProxy.html#resumeProducing
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.pcp.ProducerConsumerProxy.outstandingPull
  twisted.protocols.pcp.ProducerConsumerProxy.html#outstandingPull
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.pcp.ProducerConsumerProxy.write
  twisted.protocols.pcp.ProducerConsumerProxy.html#write
  Function
  Method
  PUBLIC
  The producer will write data by calling this method.
- twisted.protocols.pcp.ProducerConsumerProxy.registerProducer
  twisted.protocols.pcp.ProducerConsumerProxy.html#registerProducer
  Function
  Method
  PUBLIC
  Register to receive data from a producer.
- twisted.protocols.pcp.ProducerConsumerProxy.unregisterProducer
  twisted.protocols.pcp.ProducerConsumerProxy.html#unregisterProducer
  Function
  Method
  PUBLIC
  Stop consuming data from a producer, without disconnecting.
- twisted.protocols.pcp.ProducerConsumerProxy._writeSomeData
  twisted.protocols.pcp.ProducerConsumerProxy.html#_writeSomeData
  Function
  Method
  PRIVATE
  Write as much of this data as possible.
- twisted.protocols.htb.Bucket
  twisted.protocols.htb.Bucket.html
  Class
  Class
  PUBLIC
  Implementation of a Token bucket.
- twisted.protocols.htb.Bucket.maxburst
  twisted.protocols.htb.Bucket.html#maxburst
  Attribute
  Class Variable
  PUBLIC
  The maximum number of tokens that the bucket can hold at any given time. If this is `None`, the bucket has an infinite size.
- twisted.protocols.htb.Bucket.rate
  twisted.protocols.htb.Bucket.html#rate
  Attribute
  Class Variable
  PUBLIC
  The rate at which the bucket drains, in number of tokens per second. If the rate is `None`, the bucket drains instantaneously.
- twisted.protocols.htb.Bucket._refcount
  twisted.protocols.htb.Bucket.html#_refcount
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.protocols.htb.Bucket.__init__
  twisted.protocols.htb.Bucket.html#__init__
  Function
  Method
  PUBLIC
  Create a `Bucket` that may have a parent `Bucket`.
- twisted.protocols.htb.Bucket.content
  twisted.protocols.htb.Bucket.html#content
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.htb.Bucket.parentBucket
  twisted.protocols.htb.Bucket.html#parentBucket
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.htb.Bucket.lastDrip
  twisted.protocols.htb.Bucket.html#lastDrip
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.htb.Bucket.add
  twisted.protocols.htb.Bucket.html#add
  Function
  Method
  PUBLIC
  Adds tokens to the `Bucket` and its `parentBucket`.
- twisted.protocols.htb.Bucket.drip
  twisted.protocols.htb.Bucket.html#drip
  Function
  Method
  PUBLIC
  Let some of the bucket drain.
- twisted.protocols.htb.IBucketFilter
  twisted.protocols.htb.IBucketFilter.html
  Class
  Interface
  PUBLIC
  No interface docstring; 1/1 method documented
- twisted.protocols.htb.IBucketFilter.getBucketFor
  twisted.protocols.htb.IBucketFilter.html#getBucketFor
  Function
  Method
  PUBLIC
  Return a `Bucket` corresponding to the provided parameters.
- twisted.protocols.htb.HierarchicalBucketFilter
  twisted.protocols.htb.HierarchicalBucketFilter.html
  Class
  Class
  PUBLIC
  Filter things into buckets that can be nested.
- twisted.protocols.htb.HierarchicalBucketFilter.bucketFactory
  twisted.protocols.htb.HierarchicalBucketFilter.html#bucketFactory
  Attribute
  Class Variable
  PUBLIC
  Class of buckets to make.
- twisted.protocols.htb.HierarchicalBucketFilter.sweepInterval
  twisted.protocols.htb.HierarchicalBucketFilter.html#sweepInterval
  Attribute
  Class Variable
  PUBLIC
  Seconds between sweeping out the bucket cache.
- twisted.protocols.htb.HierarchicalBucketFilter.__init__
  twisted.protocols.htb.HierarchicalBucketFilter.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.htb.HierarchicalBucketFilter.buckets
  twisted.protocols.htb.HierarchicalBucketFilter.html#buckets
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.htb.HierarchicalBucketFilter.parentFilter
  twisted.protocols.htb.HierarchicalBucketFilter.html#parentFilter
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.htb.HierarchicalBucketFilter.lastSweep
  twisted.protocols.htb.HierarchicalBucketFilter.html#lastSweep
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.htb.HierarchicalBucketFilter.getBucketFor
  twisted.protocols.htb.HierarchicalBucketFilter.html#getBucketFor
  Function
  Method
  PUBLIC
  Find or create a `Bucket` corresponding to the provided parameters.
- twisted.protocols.htb.HierarchicalBucketFilter.getBucketKey
  twisted.protocols.htb.HierarchicalBucketFilter.html#getBucketKey
  Function
  Method
  PUBLIC
  Construct a key based on the input parameters to choose a `Bucket`.
- twisted.protocols.htb.HierarchicalBucketFilter.sweep
  twisted.protocols.htb.HierarchicalBucketFilter.html#sweep
  Function
  Method
  PUBLIC
  Remove empty buckets.
- twisted.protocols.htb.FilterByHost
  twisted.protocols.htb.FilterByHost.html
  Class
  Class
  PUBLIC
  A Hierarchical Bucket filter with a `Bucket` for each host.
- twisted.protocols.htb.FilterByHost.sweepInterval
  twisted.protocols.htb.FilterByHost.html#sweepInterval
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.protocols.htb.FilterByHost.getBucketKey
  twisted.protocols.htb.FilterByHost.html#getBucketKey
  Function
  Method
  PUBLIC
  Construct a key based on the input parameters to choose a `Bucket`.
- twisted.protocols.htb.FilterByServer
  twisted.protocols.htb.FilterByServer.html
  Class
  Class
  PUBLIC
  A Hierarchical Bucket filter with a `Bucket` for each service.
- twisted.protocols.htb.FilterByServer.sweepInterval
  twisted.protocols.htb.FilterByServer.html#sweepInterval
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.protocols.htb.FilterByServer.getBucketKey
  twisted.protocols.htb.FilterByServer.html#getBucketKey
  Function
  Method
  PUBLIC
  Construct a key based on the input parameters to choose a `Bucket`.
- twisted.protocols.htb.ShapedConsumer
  twisted.protocols.htb.ShapedConsumer.html
  Class
  Class
  PUBLIC
  Wraps a `Consumer` and shapes the rate at which it receives data.
- twisted.protocols.htb.ShapedConsumer.iAmStreaming
  twisted.protocols.htb.ShapedConsumer.html#iAmStreaming
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.protocols.htb.ShapedConsumer.__init__
  twisted.protocols.htb.ShapedConsumer.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.htb.ShapedConsumer.bucket
  twisted.protocols.htb.ShapedConsumer.html#bucket
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.htb.ShapedConsumer._writeSomeData
  twisted.protocols.htb.ShapedConsumer.html#_writeSomeData
  Function
  Method
  PRIVATE
  Write as much of this data as possible.
- twisted.protocols.htb.ShapedConsumer.stopProducing
  twisted.protocols.htb.ShapedConsumer.html#stopProducing
  Function
  Method
  PUBLIC
  Stop producing data.
- twisted.protocols.htb.ShapedTransport
  twisted.protocols.htb.ShapedTransport.html
  Class
  Class
  PUBLIC
  Wraps a `Transport` and shapes the rate at which it receives data.
- twisted.protocols.htb.ShapedTransport.iAmStreaming
  twisted.protocols.htb.ShapedTransport.html#iAmStreaming
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.protocols.htb.ShapedTransport.__getattr__
  twisted.protocols.htb.ShapedTransport.html#__getattr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.htb.ShapedProtocolFactory
  twisted.protocols.htb.ShapedProtocolFactory.html
  Class
  Class
  PUBLIC
  Dispense `Protocols` with traffic shaping on their transports.
- twisted.protocols.htb.ShapedProtocolFactory.__init__
  twisted.protocols.htb.ShapedProtocolFactory.html#__init__
  Function
  Method
  PUBLIC
  Tell me what to wrap and where to get buckets.
- twisted.protocols.htb.ShapedProtocolFactory.protocol
  twisted.protocols.htb.ShapedProtocolFactory.html#protocol
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.htb.ShapedProtocolFactory.bucketFilter
  twisted.protocols.htb.ShapedProtocolFactory.html#bucketFilter
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.htb.ShapedProtocolFactory.__call__
  twisted.protocols.htb.ShapedProtocolFactory.html#__call__
  Function
  Method
  PUBLIC
  Make a `Protocol` instance with a shaped transport.
- twisted.protocols.ident._MIN_PORT
  twisted.protocols.ident.html#_MIN_PORT
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.protocols.ident._MAX_PORT
  twisted.protocols.ident.html#_MAX_PORT
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.protocols.ident.IdentError
  twisted.protocols.ident.IdentError.html
  Class
  Exception
  PUBLIC
  Can't determine connection owner; reason unknown.
- twisted.protocols.ident.IdentError.identDescription
  twisted.protocols.ident.IdentError.html#identDescription
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.protocols.ident.IdentError.__str__
  twisted.protocols.ident.IdentError.html#__str__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.ident.NoUser
  twisted.protocols.ident.NoUser.html
  Class
  Exception
  PUBLIC
  The connection specified by the port pair is not currently in use or currently not owned by an identifiable entity.
- twisted.protocols.ident.NoUser.identDescription
  twisted.protocols.ident.NoUser.html#identDescription
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.protocols.ident.InvalidPort
  twisted.protocols.ident.InvalidPort.html
  Class
  Exception
  PUBLIC
  Either the local or foreign port was improperly specified. This should be returned if either or both of the port ids were out of range (TCP port numbers are from 1-65535), negative integers, reals or in any fashion not recognized as a non-negative integer.
- twisted.protocols.ident.InvalidPort.identDescription
  twisted.protocols.ident.InvalidPort.html#identDescription
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.protocols.ident.HiddenUser
  twisted.protocols.ident.HiddenUser.html
  Class
  Exception
  PUBLIC
  The server was able to identify the user of this port, but the information was not returned at the request of the user.
- twisted.protocols.ident.HiddenUser.identDescription
  twisted.protocols.ident.HiddenUser.html#identDescription
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.protocols.ident.IdentServer
  twisted.protocols.ident.IdentServer.html
  Class
  Class
  PUBLIC
  The Identification Protocol (a.k.a., "ident", a.k.a., "the Ident Protocol") provides a means to determine the identity of a user of a particular TCP connection. Given a TCP port number pair, it returns a character string which identifies the owner of that connection on the server's system.
- twisted.protocols.ident.IdentServer.lineReceived
  twisted.protocols.ident.IdentServer.html#lineReceived
  Function
  Method
  PUBLIC
  Override this for when each line is received.
- twisted.protocols.ident.IdentServer.invalidQuery
  twisted.protocols.ident.IdentServer.html#invalidQuery
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.ident.IdentServer.validQuery
  twisted.protocols.ident.IdentServer.html#validQuery
  Function
  Method
  PUBLIC
  Called when a valid query is received to look up and deliver the response.
- twisted.protocols.ident.IdentServer._cbLookup
  twisted.protocols.ident.IdentServer.html#_cbLookup
  Function
  Method
  PRIVATE
  Undocumented
- twisted.protocols.ident.IdentServer._ebLookup
  twisted.protocols.ident.IdentServer.html#_ebLookup
  Function
  Method
  PRIVATE
  Undocumented
- twisted.protocols.ident.IdentServer.lookup
  twisted.protocols.ident.IdentServer.html#lookup
  Function
  Method
  PUBLIC
  Lookup user information about the specified address pair.
- twisted.protocols.ident.ProcServerMixin
  twisted.protocols.ident.ProcServerMixin.html
  Class
  Class
  PUBLIC
  Implements lookup() to grab entries for responses from /proc/net/tcp
- twisted.protocols.ident.ProcServerMixin.SYSTEM_NAME
  twisted.protocols.ident.ProcServerMixin.html#SYSTEM_NAME
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.ident.ProcServerMixin.getUsername
  twisted.protocols.ident.ProcServerMixin.html#getUsername
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.ident.ProcServerMixin.entries
  twisted.protocols.ident.ProcServerMixin.html#entries
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.ident.ProcServerMixin.dottedQuadFromHexString
  twisted.protocols.ident.ProcServerMixin.html#dottedQuadFromHexString
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.ident.ProcServerMixin.unpackAddress
  twisted.protocols.ident.ProcServerMixin.html#unpackAddress
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.ident.ProcServerMixin.parseLine
  twisted.protocols.ident.ProcServerMixin.html#parseLine
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.ident.ProcServerMixin.lookup
  twisted.protocols.ident.ProcServerMixin.html#lookup
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.ident.IdentClient
  twisted.protocols.ident.IdentClient.html
  Class
  Class
  PUBLIC
  No class docstring; 0/1 instance variable, 0/1 class variable, 1/5 method documented
- twisted.protocols.ident.IdentClient.errorTypes
  twisted.protocols.ident.IdentClient.html#errorTypes
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.protocols.ident.IdentClient.__init__
  twisted.protocols.ident.IdentClient.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.ident.IdentClient.queries
  twisted.protocols.ident.IdentClient.html#queries
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.ident.IdentClient.lookup
  twisted.protocols.ident.IdentClient.html#lookup
  Function
  Method
  PUBLIC
  Lookup user information about the specified address pair.
- twisted.protocols.ident.IdentClient.lineReceived
  twisted.protocols.ident.IdentClient.html#lineReceived
  Function
  Method
  PUBLIC
  Override this for when each line is received.
- twisted.protocols.ident.IdentClient.connectionLost
  twisted.protocols.ident.IdentClient.html#connectionLost
  Function
  Method
  PUBLIC
  Called when the connection is shut down.
- twisted.protocols.ident.IdentClient.parseResponse
  twisted.protocols.ident.IdentClient.html#parseResponse
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.memcache.DEFAULT_PORT
  twisted.protocols.memcache.html#DEFAULT_PORT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.memcache.NoSuchCommand
  twisted.protocols.memcache.NoSuchCommand.html
  Class
  Exception
  PUBLIC
  Exception raised when a non existent command is called.
- twisted.protocols.memcache.ClientError
  twisted.protocols.memcache.ClientError.html
  Class
  Exception
  PUBLIC
  Error caused by an invalid client call.
- twisted.protocols.memcache.ServerError
  twisted.protocols.memcache.ServerError.html
  Class
  Exception
  PUBLIC
  Problem happening on the server.
- twisted.protocols.memcache.Command
  twisted.protocols.memcache.Command.html
  Class
  Class
  PUBLIC
  Wrap a client action into an object, that holds the values used in the protocol.
- twisted.protocols.memcache.Command._deferred
  twisted.protocols.memcache.Command.html#_deferred
  Attribute
  Instance Variable
  PRIVATE
  the `Deferred` object that will be fired when the result arrives.
- twisted.protocols.memcache.Command.command
  twisted.protocols.memcache.Command.html#command
  Attribute
  Instance Variable
  PUBLIC
  name of the command sent to the server.
- twisted.protocols.memcache.Command.__init__
  twisted.protocols.memcache.Command.html#__init__
  Function
  Method
  PUBLIC
  Create a command.
- twisted.protocols.memcache.Command.success
  twisted.protocols.memcache.Command.html#success
  Function
  Method
  PUBLIC
  Shortcut method to fire the underlying deferred.
- twisted.protocols.memcache.Command.fail
  twisted.protocols.memcache.Command.html#fail
  Function
  Method
  PUBLIC
  Make the underlying deferred fails.
- twisted.protocols.memcache.MemCacheProtocol
  twisted.protocols.memcache.MemCacheProtocol.html
  Class
  Class
  PUBLIC
  MemCache protocol: connect to a memcached server to store/retrieve values.
- twisted.protocols.memcache.MemCacheProtocol.persistentTimeOut
  twisted.protocols.memcache.MemCacheProtocol.html#persistentTimeOut
  Attribute
  Instance Variable
  PUBLIC
  the timeout period used to wait for a response.
- twisted.protocols.memcache.MemCacheProtocol._current
  twisted.protocols.memcache.MemCacheProtocol.html#_current
  Attribute
  Instance Variable
  PRIVATE
  current list of requests waiting for an answer from the server.
- twisted.protocols.memcache.MemCacheProtocol._lenExpected
  twisted.protocols.memcache.MemCacheProtocol.html#_lenExpected
  Attribute
  Instance Variable
  PRIVATE
  amount of data expected in raw mode, when reading for a value.
- twisted.protocols.memcache.MemCacheProtocol._getBuffer
  twisted.protocols.memcache.MemCacheProtocol.html#_getBuffer
  Attribute
  Instance Variable
  PRIVATE
  current buffer of data, used to store temporary data when reading in raw mode.
- twisted.protocols.memcache.MemCacheProtocol._bufferLength
  twisted.protocols.memcache.MemCacheProtocol.html#_bufferLength
  Attribute
  Instance Variable
  PRIVATE
  the total amount of bytes in `_getBuffer`.
- twisted.protocols.memcache.MemCacheProtocol._disconnected
  twisted.protocols.memcache.MemCacheProtocol.html#_disconnected
  Attribute
  Instance Variable
  PRIVATE
  indicate if the connectionLost has been called or not.
- twisted.protocols.memcache.MemCacheProtocol.MAX_KEY_LENGTH
  twisted.protocols.memcache.MemCacheProtocol.html#MAX_KEY_LENGTH
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.memcache.MemCacheProtocol.__init__
  twisted.protocols.memcache.MemCacheProtocol.html#__init__
  Function
  Method
  PUBLIC
  Create the protocol.
- twisted.protocols.memcache.MemCacheProtocol.timeOut
  twisted.protocols.memcache.MemCacheProtocol.html#timeOut
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.memcache.MemCacheProtocol._cancelCommands
  twisted.protocols.memcache.MemCacheProtocol.html#_cancelCommands
  Function
  Method
  PRIVATE
  Cancel all the outstanding commands, making them fail with `reason`.
- twisted.protocols.memcache.MemCacheProtocol.timeoutConnection
  twisted.protocols.memcache.MemCacheProtocol.html#timeoutConnection
  Function
  Method
  PUBLIC
  Close the connection in case of timeout.
- twisted.protocols.memcache.MemCacheProtocol.connectionLost
  twisted.protocols.memcache.MemCacheProtocol.html#connectionLost
  Function
  Method
  PUBLIC
  Cause any outstanding commands to fail.
- twisted.protocols.memcache.MemCacheProtocol.sendLine
  twisted.protocols.memcache.MemCacheProtocol.html#sendLine
  Function
  Method
  PUBLIC
  Override sendLine to add a timeout to response.
- twisted.protocols.memcache.MemCacheProtocol.rawDataReceived
  twisted.protocols.memcache.MemCacheProtocol.html#rawDataReceived
  Function
  Method
  PUBLIC
  Collect data for a get.
- twisted.protocols.memcache.MemCacheProtocol.cmd_STORED
  twisted.protocols.memcache.MemCacheProtocol.html#cmd_STORED
  Function
  Method
  PUBLIC
  Manage a success response to a set operation.
- twisted.protocols.memcache.MemCacheProtocol.cmd_NOT_STORED
  twisted.protocols.memcache.MemCacheProtocol.html#cmd_NOT_STORED
  Function
  Method
  PUBLIC
  Manage a specific 'not stored' response to a set operation: this is not an error, but some condition wasn't met.
- twisted.protocols.memcache.MemCacheProtocol.cmd_END
  twisted.protocols.memcache.MemCacheProtocol.html#cmd_END
  Function
  Method
  PUBLIC
  This the end token to a get or a stat operation.
- twisted.protocols.memcache.MemCacheProtocol.cmd_NOT_FOUND
  twisted.protocols.memcache.MemCacheProtocol.html#cmd_NOT_FOUND
  Function
  Method
  PUBLIC
  Manage error response for incr/decr/delete.
- twisted.protocols.memcache.MemCacheProtocol.cmd_VALUE
  twisted.protocols.memcache.MemCacheProtocol.html#cmd_VALUE
  Function
  Method
  PUBLIC
  Prepare the reading a value after a get.
- twisted.protocols.memcache.MemCacheProtocol.cmd_STAT
  twisted.protocols.memcache.MemCacheProtocol.html#cmd_STAT
  Function
  Method
  PUBLIC
  Reception of one stat line.
- twisted.protocols.memcache.MemCacheProtocol.cmd_VERSION
  twisted.protocols.memcache.MemCacheProtocol.html#cmd_VERSION
  Function
  Method
  PUBLIC
  Read version token.
- twisted.protocols.memcache.MemCacheProtocol.cmd_ERROR
  twisted.protocols.memcache.MemCacheProtocol.html#cmd_ERROR
  Function
  Method
  PUBLIC
  A non-existent command has been sent.
- twisted.protocols.memcache.MemCacheProtocol.cmd_CLIENT_ERROR
  twisted.protocols.memcache.MemCacheProtocol.html#cmd_CLIENT_ERROR
  Function
  Method
  PUBLIC
  An invalid input as been sent.
- twisted.protocols.memcache.MemCacheProtocol.cmd_SERVER_ERROR
  twisted.protocols.memcache.MemCacheProtocol.html#cmd_SERVER_ERROR
  Function
  Method
  PUBLIC
  An error has happened server-side.
- twisted.protocols.memcache.MemCacheProtocol.cmd_DELETED
  twisted.protocols.memcache.MemCacheProtocol.html#cmd_DELETED
  Function
  Method
  PUBLIC
  A delete command has completed successfully.
- twisted.protocols.memcache.MemCacheProtocol.cmd_OK
  twisted.protocols.memcache.MemCacheProtocol.html#cmd_OK
  Function
  Method
  PUBLIC
  The last command has been completed.
- twisted.protocols.memcache.MemCacheProtocol.cmd_EXISTS
  twisted.protocols.memcache.MemCacheProtocol.html#cmd_EXISTS
  Function
  Method
  PUBLIC
  A `checkAndSet` update has failed.
- twisted.protocols.memcache.MemCacheProtocol.lineReceived
  twisted.protocols.memcache.MemCacheProtocol.html#lineReceived
  Function
  Method
  PUBLIC
  Receive line commands from the server.
- twisted.protocols.memcache.MemCacheProtocol.increment
  twisted.protocols.memcache.MemCacheProtocol.html#increment
  Function
  Method
  PUBLIC
  Increment the value of `key` by given value (default to 1). `key` must be consistent with an int. Return the new value.
- twisted.protocols.memcache.MemCacheProtocol.decrement
  twisted.protocols.memcache.MemCacheProtocol.html#decrement
  Function
  Method
  PUBLIC
  Decrement the value of `key` by given value (default to 1). `key` must be consistent with an int. Return the new value, coerced to 0 if negative.
- twisted.protocols.memcache.MemCacheProtocol._incrdecr
  twisted.protocols.memcache.MemCacheProtocol.html#_incrdecr
  Function
  Method
  PRIVATE
  Internal wrapper for incr/decr.
- twisted.protocols.memcache.MemCacheProtocol.replace
  twisted.protocols.memcache.MemCacheProtocol.html#replace
  Function
  Method
  PUBLIC
  Replace the given `key`. It must already exist in the server.
- twisted.protocols.memcache.MemCacheProtocol.add
  twisted.protocols.memcache.MemCacheProtocol.html#add
  Function
  Method
  PUBLIC
  Add the given `key`. It must not exist in the server.
- twisted.protocols.memcache.MemCacheProtocol.set
  twisted.protocols.memcache.MemCacheProtocol.html#set
  Function
  Method
  PUBLIC
  Set the given `key`.
- twisted.protocols.memcache.MemCacheProtocol.checkAndSet
  twisted.protocols.memcache.MemCacheProtocol.html#checkAndSet
  Function
  Method
  PUBLIC
  Change the content of `key` only if the `cas` value matches the current one associated with the key. Use this to store a value which hasn't been modified since last time you fetched it.
- twisted.protocols.memcache.MemCacheProtocol._set
  twisted.protocols.memcache.MemCacheProtocol.html#_set
  Function
  Method
  PRIVATE
  Internal wrapper for setting values.
- twisted.protocols.memcache.MemCacheProtocol.append
  twisted.protocols.memcache.MemCacheProtocol.html#append
  Function
  Method
  PUBLIC
  Append given data to the value of an existing key.
- twisted.protocols.memcache.MemCacheProtocol.prepend
  twisted.protocols.memcache.MemCacheProtocol.html#prepend
  Function
  Method
  PUBLIC
  Prepend given data to the value of an existing key.
- twisted.protocols.memcache.MemCacheProtocol.get
  twisted.protocols.memcache.MemCacheProtocol.html#get
  Function
  Method
  PUBLIC
  Get the given `key`. It doesn't support multiple keys. If `withIdentifier` is set to `True`, the command issued is a `gets`, that will return the current identifier associated with the value. This identifier has to be used when issuing ...
- twisted.protocols.memcache.MemCacheProtocol.getMultiple
  twisted.protocols.memcache.MemCacheProtocol.html#getMultiple
  Function
  Method
  PUBLIC
  Get the given list of `keys`. If `withIdentifier` is set to `True`, the command issued is a `gets`, that will return the identifiers associated with each values. This identifier has to be used when issuing `checkAndSet`...
- twisted.protocols.memcache.MemCacheProtocol._get
  twisted.protocols.memcache.MemCacheProtocol.html#_get
  Function
  Method
  PRIVATE
  Helper method for `get` and `getMultiple`.
- twisted.protocols.memcache.MemCacheProtocol.stats
  twisted.protocols.memcache.MemCacheProtocol.html#stats
  Function
  Method
  PUBLIC
  Get some stats from the server. It will be available as a dict.
- twisted.protocols.memcache.MemCacheProtocol.version
  twisted.protocols.memcache.MemCacheProtocol.html#version
  Function
  Method
  PUBLIC
  Get the version of the server.
- twisted.protocols.memcache.MemCacheProtocol.delete
  twisted.protocols.memcache.MemCacheProtocol.html#delete
  Function
  Method
  PUBLIC
  Delete an existing `key`.
- twisted.protocols.memcache.MemCacheProtocol.flushAll
  twisted.protocols.memcache.MemCacheProtocol.html#flushAll
  Function
  Method
  PUBLIC
  Flush all cached values.
- twisted.protocols.portforward.Proxy
  twisted.protocols.portforward.Proxy.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.protocols.portforward.Proxy.noisy
  twisted.protocols.portforward.Proxy.html#noisy
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.protocols.portforward.Proxy.peer
  twisted.protocols.portforward.Proxy.html#peer
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.portforward.Proxy.setPeer
  twisted.protocols.portforward.Proxy.html#setPeer
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.portforward.Proxy.connectionLost
  twisted.protocols.portforward.Proxy.html#connectionLost
  Function
  Method
  PUBLIC
  Called when the connection is shut down.
- twisted.protocols.portforward.Proxy.dataReceived
  twisted.protocols.portforward.Proxy.html#dataReceived
  Function
  Method
  PUBLIC
  Called whenever data is received.
- twisted.protocols.portforward.ProxyClient
  twisted.protocols.portforward.ProxyClient.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.protocols.portforward.ProxyClient.connectionMade
  twisted.protocols.portforward.ProxyClient.html#connectionMade
  Function
  Method
  PUBLIC
  Called when a connection is made.
- twisted.protocols.portforward.ProxyClientFactory
  twisted.protocols.portforward.ProxyClientFactory.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.protocols.portforward.ProxyClientFactory.setServer
  twisted.protocols.portforward.ProxyClientFactory.html#setServer
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.portforward.ProxyClientFactory.server
  twisted.protocols.portforward.ProxyClientFactory.html#server
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.portforward.ProxyClientFactory.buildProtocol
  twisted.protocols.portforward.ProxyClientFactory.html#buildProtocol
  Function
  Method
  PUBLIC
  Create an instance of a subclass of Protocol.
- twisted.protocols.portforward.ProxyClientFactory.clientConnectionFailed
  twisted.protocols.portforward.ProxyClientFactory.html#clientConnectionFailed
  Function
  Method
  PUBLIC
  Called when a connection has failed to connect.
- twisted.protocols.portforward.ProxyServer
  twisted.protocols.portforward.ProxyServer.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.protocols.portforward.ProxyServer.reactor
  twisted.protocols.portforward.ProxyServer.html#reactor
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.portforward.ProxyServer.connectionMade
  twisted.protocols.portforward.ProxyServer.html#connectionMade
  Function
  Method
  PUBLIC
  Called when a connection is made.
- twisted.protocols.portforward.ProxyFactory
  twisted.protocols.portforward.ProxyFactory.html
  Class
  Class
  PUBLIC
  Factory for port forwarder.
- twisted.protocols.portforward.ProxyFactory.__init__
  twisted.protocols.portforward.ProxyFactory.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.portforward.ProxyFactory.host
  twisted.protocols.portforward.ProxyFactory.html#host
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.portforward.ProxyFactory.port
  twisted.protocols.portforward.ProxyFactory.html#port
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.postfix.quote
  twisted.protocols.postfix.html#quote
  Function
  Function
  PUBLIC
  Undocumented
- twisted.protocols.postfix.unquote
  twisted.protocols.postfix.html#unquote
  Function
  Function
  PUBLIC
  Undocumented
- twisted.protocols.postfix.PostfixTCPMapServer
  twisted.protocols.postfix.PostfixTCPMapServer.html
  Class
  Class
  PUBLIC
  Postfix mail transport agent TCP map protocol implementation.
- twisted.protocols.postfix.PostfixTCPMapServer.timeout
  twisted.protocols.postfix.PostfixTCPMapServer.html#timeout
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.protocols.postfix.PostfixTCPMapServer.delimiter
  twisted.protocols.postfix.PostfixTCPMapServer.html#delimiter
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.protocols.postfix.PostfixTCPMapServer.connectionMade
  twisted.protocols.postfix.PostfixTCPMapServer.html#connectionMade
  Function
  Method
  PUBLIC
  Called when a connection is made.
- twisted.protocols.postfix.PostfixTCPMapServer.sendCode
  twisted.protocols.postfix.PostfixTCPMapServer.html#sendCode
  Function
  Method
  PUBLIC
  Send an SMTP-like code with a message.
- twisted.protocols.postfix.PostfixTCPMapServer.lineReceived
  twisted.protocols.postfix.PostfixTCPMapServer.html#lineReceived
  Function
  Method
  PUBLIC
  Override this for when each line is received.
- twisted.protocols.postfix.PostfixTCPMapServer.do_get
  twisted.protocols.postfix.PostfixTCPMapServer.html#do_get
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.postfix.PostfixTCPMapServer._cbNot
  twisted.protocols.postfix.PostfixTCPMapServer.html#_cbNot
  Function
  Method
  PRIVATE
  Undocumented
- twisted.protocols.postfix.PostfixTCPMapServer._cbGot
  twisted.protocols.postfix.PostfixTCPMapServer.html#_cbGot
  Function
  Method
  PRIVATE
  Undocumented
- twisted.protocols.postfix.PostfixTCPMapServer.do_put
  twisted.protocols.postfix.PostfixTCPMapServer.html#do_put
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.postfix.PostfixTCPMapDictServerFactory
  twisted.protocols.postfix.PostfixTCPMapDictServerFactory.html
  Class
  Class
  PUBLIC
  An in-memory dictionary factory for PostfixTCPMapServer.
- twisted.protocols.postfix.PostfixTCPMapDeferringDictServerFactory
  twisted.protocols.postfix.PostfixTCPMapDeferringDictServerFactory.html
  Class
  Class
  PUBLIC
  An in-memory dictionary factory for PostfixTCPMapServer.
- twisted.protocols.postfix.PostfixTCPMapDeferringDictServerFactory.__init__
  twisted.protocols.postfix.PostfixTCPMapDeferringDictServerFactory.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.postfix.PostfixTCPMapDeferringDictServerFactory.data
  twisted.protocols.postfix.PostfixTCPMapDeferringDictServerFactory.html#data
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.postfix.PostfixTCPMapDeferringDictServerFactory.get
  twisted.protocols.postfix.PostfixTCPMapDeferringDictServerFactory.html#get
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.http.CACHED
  twisted.web.http.html#CACHED
  Attribute
  Constant
  PUBLIC
  A marker value to be returned from cache-related request methods to indicate to the caller that a cached response will be usable and no response body should be generated.
- twisted.web.http.FOUND
  twisted.web.http.html#FOUND
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.web.http.NOT_MODIFIED
  twisted.web.http.html#NOT_MODIFIED
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.web.http.PRECONDITION_FAILED
  twisted.web.http.html#PRECONDITION_FAILED
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.web.http.maxChunkSizeLineLength
  twisted.web.http.html#maxChunkSizeLineLength
  Attribute
  Variable
  PUBLIC
  Maximum allowable length of the CRLF-terminated line that indicates the size of a chunk and the extensions associated with it, as in the HTTP 1.1 chunked Transfer-Encoding (RFC 7230 section 4.1). This limits how much data may be buffered when decoding the line.
- twisted.web._responses._CONTINUE
  twisted.web._responses.html#_CONTINUE
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.web.http.ACCEPTED
  twisted.web.http.html#ACCEPTED
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.web.http.BAD_GATEWAY
  twisted.web.http.html#BAD_GATEWAY
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.web.http.BAD_REQUEST
  twisted.web.http.html#BAD_REQUEST
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.web.http.CONFLICT
  twisted.web.http.html#CONFLICT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.web.http.CREATED
  twisted.web.http.html#CREATED
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.web.http.EXPECTATION_FAILED
  twisted.web.http.html#EXPECTATION_FAILED
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.web.http.FORBIDDEN
  twisted.web.http.html#FORBIDDEN
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.web.http.GATEWAY_TIMEOUT
  twisted.web.http.html#GATEWAY_TIMEOUT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.web.http.GONE
  twisted.web.http.html#GONE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.web.http.HTTP_VERSION_NOT_SUPPORTED
  twisted.web.http.html#HTTP_VERSION_NOT_SUPPORTED
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.web.http.INSUFFICIENT_STORAGE_SPACE
  twisted.web.http.html#INSUFFICIENT_STORAGE_SPACE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.web.http.INTERNAL_SERVER_ERROR
  twisted.web.http.html#INTERNAL_SERVER_ERROR
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.web.http.LENGTH_REQUIRED
  twisted.web.http.html#LENGTH_REQUIRED
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.web.http.MOVED_PERMANENTLY
  twisted.web.http.html#MOVED_PERMANENTLY
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.web.http.MULTI_STATUS
  twisted.web.http.html#MULTI_STATUS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.web.http.MULTIPLE_CHOICE
  twisted.web.http.html#MULTIPLE_CHOICE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.web.http.NO_CONTENT
  twisted.web.http.html#NO_CONTENT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.web.http.NON_AUTHORITATIVE_INFORMATION
  twisted.web.http.html#NON_AUTHORITATIVE_INFORMATION
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.web.http.NOT_ACCEPTABLE
  twisted.web.http.html#NOT_ACCEPTABLE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.web.http.NOT_ALLOWED
  twisted.web.http.html#NOT_ALLOWED
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.web.http.NOT_EXTENDED
  twisted.web.http.html#NOT_EXTENDED
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.web.http.NOT_FOUND
  twisted.web.http.html#NOT_FOUND
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.web.http.NOT_IMPLEMENTED
  twisted.web.http.html#NOT_IMPLEMENTED
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.web.http.OK
  twisted.web.http.html#OK
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.web.http.PARTIAL_CONTENT
  twisted.web.http.html#PARTIAL_CONTENT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.web.http.PAYMENT_REQUIRED
  twisted.web.http.html#PAYMENT_REQUIRED
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.web.http.PERMANENT_REDIRECT
  twisted.web.http.html#PERMANENT_REDIRECT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.web.http.PROXY_AUTH_REQUIRED
  twisted.web.http.html#PROXY_AUTH_REQUIRED
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.web.http.REQUEST_ENTITY_TOO_LARGE
  twisted.web.http.html#REQUEST_ENTITY_TOO_LARGE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.web.http.REQUEST_TIMEOUT
  twisted.web.http.html#REQUEST_TIMEOUT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.web.http.REQUEST_URI_TOO_LONG
  twisted.web.http.html#REQUEST_URI_TOO_LONG
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.web.http.REQUESTED_RANGE_NOT_SATISFIABLE
  twisted.web.http.html#REQUESTED_RANGE_NOT_SATISFIABLE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.web.http.RESET_CONTENT
  twisted.web.http.html#RESET_CONTENT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.web.http.RESPONSES
  twisted.web.http.html#RESPONSES
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.web.http.SEE_OTHER
  twisted.web.http.html#SEE_OTHER
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.web.http.SERVICE_UNAVAILABLE
  twisted.web.http.html#SERVICE_UNAVAILABLE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.web.http.SWITCHING
  twisted.web.http.html#SWITCHING
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.web.http.TEMPORARY_REDIRECT
  twisted.web.http.html#TEMPORARY_REDIRECT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.web.http.UNAUTHORIZED
  twisted.web.http.html#UNAUTHORIZED
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.web.http.UNSUPPORTED_MEDIA_TYPE
  twisted.web.http.html#UNSUPPORTED_MEDIA_TYPE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.web.http.USE_PROXY
  twisted.web.http.html#USE_PROXY
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.web.http_headers._T
  twisted.web.http_headers.html#_T
  Attribute
  Type Variable
  PRIVATE
  Undocumented
- twisted.web.http_headers._dashCapitalize
  twisted.web.http_headers.html#_dashCapitalize
  Function
  Function
  PRIVATE
  Return a byte string which is capitalized using '-' as a word separator.
- twisted.web.http_headers._sanitizeLinearWhitespace
  twisted.web.http_headers.html#_sanitizeLinearWhitespace
  Function
  Function
  PRIVATE
  Replace linear whitespace (`\n`, `\r\n`, `\r`) in a header key or value with a single space.
- twisted.web.http_headers.Headers
  twisted.web.http_headers.Headers.html
  Class
  Class
  PUBLIC
  Stores HTTP headers in a key and multiple value format.
- twisted.web.http_headers.Headers._caseMappings
  twisted.web.http_headers.Headers.html#_caseMappings
  Attribute
  Class Variable
  PRIVATE
  A `dict` that maps lowercase header names to their canonicalized representation.
- twisted.web.http_headers.Headers._rawHeaders
  twisted.web.http_headers.Headers.html#_rawHeaders
  Attribute
  Instance Variable
  PRIVATE
  A `dict` mapping header names as `bytes` to `list`s of header values as `bytes`.
- twisted.web.http_headers.Headers.__init__
  twisted.web.http_headers.Headers.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.http_headers.Headers.__repr__
  twisted.web.http_headers.Headers.html#__repr__
  Function
  Method
  PUBLIC
  Return a string fully describing the headers set on this object.
- twisted.web.http_headers.Headers.__cmp__
  twisted.web.http_headers.Headers.html#__cmp__
  Function
  Method
  PUBLIC
  Define `Headers` instances as being equal to each other if they have the same raw headers.
- twisted.web.http_headers.Headers._encodeName
  twisted.web.http_headers.Headers.html#_encodeName
  Function
  Method
  PRIVATE
  Encode the name of a header (eg 'Content-Type') to an ISO-8859-1 encoded bytestring if required.
- twisted.web.http_headers.Headers.copy
  twisted.web.http_headers.Headers.html#copy
  Function
  Method
  PUBLIC
  Return a copy of itself with the same headers set.
- twisted.web.http_headers.Headers.hasHeader
  twisted.web.http_headers.Headers.html#hasHeader
  Function
  Method
  PUBLIC
  Check for the existence of a given header.
- twisted.web.http_headers.Headers.removeHeader
  twisted.web.http_headers.Headers.html#removeHeader
  Function
  Method
  PUBLIC
  Remove the named header from this header object.
- twisted.web.http_headers.Headers.setRawHeaders
  twisted.web.http_headers.Headers.html#setRawHeaders
  Function
  Method
  PUBLIC
  Sets the raw representation of the given header.
- twisted.web.http_headers.Headers.addRawHeader
  twisted.web.http_headers.Headers.html#addRawHeader
  Function
  Method
  PUBLIC
  Add a new raw value for the given header.
- twisted.web.http_headers.Headers.getRawHeaders 0
  twisted.web.http_headers.Headers.html#getRawHeaders%200
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.http_headers.Headers.getRawHeaders 1
  twisted.web.http_headers.Headers.html#getRawHeaders%201
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.http_headers.Headers.getRawHeaders
  twisted.web.http_headers.Headers.html#getRawHeaders
  Function
  Method
  PUBLIC
  Returns a sequence of headers matching the given name as the raw string given.
- twisted.web.http_headers.Headers.getAllRawHeaders
  twisted.web.http_headers.Headers.html#getAllRawHeaders
  Function
  Method
  PUBLIC
  Return an iterator of key, value pairs of all headers contained in this object, as `bytes`. The keys are capitalized in canonical capitalization.
- twisted.web.http_headers.Headers._canonicalNameCaps
  twisted.web.http_headers.Headers.html#_canonicalNameCaps
  Function
  Method
  PRIVATE
  Return the canonical name for the given header.
- twisted.web.iweb.UNKNOWN_LENGTH
  twisted.web.iweb.html#UNKNOWN_LENGTH
  Attribute
  Constant
  PUBLIC
  An opaque object which may be used as the value of `IBodyProducer.length` to indicate that the length of the entity body is not known in advance.
- twisted.web.iweb.IUsernameDigestHash
  twisted.web.iweb.IUsernameDigestHash.html
  Class
  Interface
  PUBLIC
  This credential is used when a CredentialChecker has access to the hash of the username:realm:password as in an Apache .htdigest file.
- twisted.web.iweb.IUsernameDigestHash.checkHash
  twisted.web.iweb.IUsernameDigestHash.html#checkHash
  Function
  Method
  PUBLIC
  No summary
- twisted.web.template.VALID_HTML_TAG_NAMES
  twisted.web.template.html#VALID_HTML_TAG_NAMES
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.web.template.TEMPLATE_NAMESPACE
  twisted.web.template.html#TEMPLATE_NAMESPACE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.web.template.tags
  twisted.web.template.html#tags
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.web._stan.voidElements
  twisted.web._stan.html#voidElements
  Attribute
  Variable
  PUBLIC
  the names of HTML 'void elements'; those which can't have contents and can therefore be self-closing in the output.
- twisted.web.template.CharRef
  twisted.web.template.CharRef.html
  Class
  Class
  PUBLIC
  A numeric character reference. Given a separate representation in the DOM so that non-ASCII characters may be output as pure ASCII.
- twisted.web.template.CharRef.ordinal
  twisted.web.template.CharRef.html#ordinal
  Attribute
  Instance Variable
  PUBLIC
  The ordinal value of the unicode character to which this object refers.
- twisted.web.template.CharRef.__repr__
  twisted.web.template.CharRef.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.urlpath._allascii
  twisted.python.urlpath.html#_allascii
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.python.urlpath._rereconstituter
  twisted.python.urlpath.html#_rereconstituter
  Function
  Function
  PRIVATE
  Attriute declaration to preserve mutability on `URLPath`.
- twisted.python.urlpath.URLPath
  twisted.python.urlpath.URLPath.html
  Class
  Class
  PUBLIC
  A representation of a URL.
- twisted.python.urlpath.URLPath.scheme
  twisted.python.urlpath.URLPath.html#scheme
  Attribute
  Instance Variable
  PUBLIC
  The scheme of the URL (e.g. 'http').
- twisted.python.urlpath.URLPath.netloc
  twisted.python.urlpath.URLPath.html#netloc
  Attribute
  Instance Variable
  PUBLIC
  The network location ("host").
- twisted.python.urlpath.URLPath.path
  twisted.python.urlpath.URLPath.html#path
  Attribute
  Instance Variable
  PUBLIC
  The path on the network location.
- twisted.python.urlpath.URLPath.query
  twisted.python.urlpath.URLPath.html#query
  Attribute
  Instance Variable
  PUBLIC
  The query argument (the portion after ? in the URL).
- twisted.python.urlpath.URLPath.fragment
  twisted.python.urlpath.URLPath.html#fragment
  Attribute
  Instance Variable
  PUBLIC
  The page fragment (the portion after # in the URL).
- twisted.python.urlpath.URLPath.__init__
  twisted.python.urlpath.URLPath.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.urlpath.URLPath._scheme
  twisted.python.urlpath.URLPath.html#_scheme
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.python.urlpath.URLPath._netloc
  twisted.python.urlpath.URLPath.html#_netloc
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.python.urlpath.URLPath._path
  twisted.python.urlpath.URLPath.html#_path
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.python.urlpath.URLPath._query
  twisted.python.urlpath.URLPath.html#_query
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.python.urlpath.URLPath._fragment
  twisted.python.urlpath.URLPath.html#_fragment
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.python.urlpath.URLPath._reconstitute
  twisted.python.urlpath.URLPath.html#_reconstitute
  Function
  Method
  PRIVATE
  Reconstitute this `URLPath` from all its given attributes.
- twisted.python.urlpath.URLPath._url
  twisted.python.urlpath.URLPath.html#_url
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.python.urlpath.URLPath._fromURL
  twisted.python.urlpath.URLPath.html#_fromURL
  Function
  Class Method
  PRIVATE
  Reconstruct all the public instance variables of this `URLPath` from its underlying `_URL`.
- twisted.python.urlpath.URLPath.pathList
  twisted.python.urlpath.URLPath.html#pathList
  Function
  Method
  PUBLIC
  Split this URL's path into its components.
- twisted.python.urlpath.URLPath.fromString
  twisted.python.urlpath.URLPath.html#fromString
  Function
  Class Method
  PUBLIC
  Make a `URLPath` from a `str` or `unicode`.
- twisted.python.urlpath.URLPath.fromBytes
  twisted.python.urlpath.URLPath.html#fromBytes
  Function
  Class Method
  PUBLIC
  Make a `URLPath` from a `bytes`.
- twisted.python.urlpath.URLPath.fromRequest
  twisted.python.urlpath.URLPath.html#fromRequest
  Function
  Class Method
  PUBLIC
  Make a `URLPath` from a `twisted.web.http.Request`.
- twisted.python.urlpath.URLPath._mod
  twisted.python.urlpath.URLPath.html#_mod
  Function
  Method
  PRIVATE
  Return a modified copy of `self` using `newURL`, keeping the query string if `keepQuery` is `True`.
- twisted.python.urlpath.URLPath.sibling
  twisted.python.urlpath.URLPath.html#sibling
  Function
  Method
  PUBLIC
  Get the sibling of the current `URLPath`. A sibling is a file which is in the same directory as the current file.
- twisted.python.urlpath.URLPath.child
  twisted.python.urlpath.URLPath.html#child
  Function
  Method
  PUBLIC
  Get the child of this `URLPath`.
- twisted.python.urlpath.URLPath.parent
  twisted.python.urlpath.URLPath.html#parent
  Function
  Method
  PUBLIC
  Get the parent directory of this `URLPath`.
- twisted.python.urlpath.URLPath.here
  twisted.python.urlpath.URLPath.html#here
  Function
  Method
  PUBLIC
  Get the current directory of this `URLPath`.
- twisted.python.urlpath.URLPath.click
  twisted.python.urlpath.URLPath.html#click
  Function
  Method
  PUBLIC
  Return a path which is the URL where a browser would presumably take you if you clicked on a link with an HREF as given.
- twisted.python.urlpath.URLPath.__str__
  twisted.python.urlpath.URLPath.html#__str__
  Function
  Method
  PUBLIC
  The `str` of a `URLPath` is its URL text.
- twisted.python.urlpath.URLPath.__repr__
  twisted.python.urlpath.URLPath.html#__repr__
  Function
  Method
  PUBLIC
  The `repr` of a `URLPath` is an eval-able expression which will construct a similar `URLPath`.
- twisted.web.error._codeToMessage
  twisted.web.error.html#_codeToMessage
  Function
  Function
  PRIVATE
  Returns the response message corresponding to an HTTP code, or None if the code is unknown or unrecognized.
- twisted.web.error.Error
  twisted.web.error.Error.html
  Class
  Exception
  PUBLIC
  A basic HTTP error.
- twisted.web.error.Error.status
  twisted.web.error.Error.html#status
  Attribute
  Instance Variable
  PUBLIC
  Refers to an HTTP status code, for example `http.NOT_FOUND`.
- twisted.web.error.Error.message
  twisted.web.error.Error.html#message
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.error.Error.response
  twisted.web.error.Error.html#response
  Attribute
  Instance Variable
  PUBLIC
  A complete HTML document for an error page.
- twisted.web.error.Error.__init__
  twisted.web.error.Error.html#__init__
  Function
  Method
  PUBLIC
  Initializes a basic exception.
- twisted.web.error.Error.__str__
  twisted.web.error.Error.html#__str__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.error.PageRedirect
  twisted.web.error.PageRedirect.html
  Class
  Exception
  PUBLIC
  A request resulted in an HTTP redirect.
- twisted.web.error.PageRedirect.location
  twisted.web.error.PageRedirect.html#location
  Attribute
  Instance Variable
  PUBLIC
  The location of the redirect which was not followed.
- twisted.web.error.PageRedirect.__init__
  twisted.web.error.PageRedirect.html#__init__
  Function
  Method
  PUBLIC
  Initializes a page redirect exception.
- twisted.web.error.PageRedirect.message
  twisted.web.error.PageRedirect.html#message
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.error.InfiniteRedirection
  twisted.web.error.InfiniteRedirection.html
  Class
  Exception
  PUBLIC
  HTTP redirection is occurring endlessly.
- twisted.web.error.InfiniteRedirection.location
  twisted.web.error.InfiniteRedirection.html#location
  Attribute
  Instance Variable
  PUBLIC
  The first URL in the series of redirections which was not followed.
- twisted.web.error.InfiniteRedirection.__init__
  twisted.web.error.InfiniteRedirection.html#__init__
  Function
  Method
  PUBLIC
  Initializes an infinite redirection exception.
- twisted.web.error.InfiniteRedirection.message
  twisted.web.error.InfiniteRedirection.html#message
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.error.RedirectWithNoLocation
  twisted.web.error.RedirectWithNoLocation.html
  Class
  Exception
  PUBLIC
  Exception passed to `ResponseFailed` if we got a redirect without a `Location` header field.
- twisted.web.error.RedirectWithNoLocation.uri
  twisted.web.error.RedirectWithNoLocation.html#uri
  Attribute
  Instance Variable
  PUBLIC
  The URI which failed to give a proper location header field.
- twisted.web.error.RedirectWithNoLocation.__init__
  twisted.web.error.RedirectWithNoLocation.html#__init__
  Function
  Method
  PUBLIC
  Initializes a page redirect exception when no location is given.
- twisted.web.error.RedirectWithNoLocation.message
  twisted.web.error.RedirectWithNoLocation.html#message
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.error.UnsupportedMethod
  twisted.web.error.UnsupportedMethod.html
  Class
  Exception
  PUBLIC
  Raised by a resource when faced with a strange request method.
- twisted.web.error.UnsupportedMethod.allowedMethods
  twisted.web.error.UnsupportedMethod.html#allowedMethods
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.error.UnsupportedMethod.__init__
  twisted.web.error.UnsupportedMethod.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.error.UnsupportedMethod.__str__
  twisted.web.error.UnsupportedMethod.html#__str__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.error.SchemeNotSupported
  twisted.web.error.SchemeNotSupported.html
  Class
  Exception
  PUBLIC
  The scheme of a URI was not one of the supported values.
- twisted.web.error.RenderError
  twisted.web.error.RenderError.html
  Class
  Exception
  PUBLIC
  Base exception class for all errors which can occur during template rendering.
- twisted.web.error.MissingRenderMethod
  twisted.web.error.MissingRenderMethod.html
  Class
  Exception
  PUBLIC
  Tried to use a render method which does not exist.
- twisted.web.error.MissingRenderMethod.element
  twisted.web.error.MissingRenderMethod.html#element
  Attribute
  Instance Variable
  PUBLIC
  The element which did not have the render method.
- twisted.web.error.MissingRenderMethod.renderName
  twisted.web.error.MissingRenderMethod.html#renderName
  Attribute
  Instance Variable
  PUBLIC
  The name of the renderer which could not be found.
- twisted.web.error.MissingRenderMethod.__init__
  twisted.web.error.MissingRenderMethod.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.error.MissingRenderMethod.__repr__
  twisted.web.error.MissingRenderMethod.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.error.MissingTemplateLoader
  twisted.web.error.MissingTemplateLoader.html
  Class
  Exception
  PUBLIC
  `MissingTemplateLoader` is raised when trying to render an Element without a template loader, i.e. a `loader` attribute.
- twisted.web.error.MissingTemplateLoader.element
  twisted.web.error.MissingTemplateLoader.html#element
  Attribute
  Instance Variable
  PUBLIC
  The Element which did not have a document factory.
- twisted.web.error.MissingTemplateLoader.__init__
  twisted.web.error.MissingTemplateLoader.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.error.MissingTemplateLoader.__repr__
  twisted.web.error.MissingTemplateLoader.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.error.UnexposedMethodError
  twisted.web.error.UnexposedMethodError.html
  Class
  Exception
  PUBLIC
  Raised on any attempt to get a method which has not been exposed.
- twisted.web.error.UnfilledSlot
  twisted.web.error.UnfilledSlot.html
  Class
  Exception
  PUBLIC
  During flattening, a slot with no associated data was encountered.
- twisted.web.error.UnsupportedType
  twisted.web.error.UnsupportedType.html
  Class
  Exception
  PUBLIC
  During flattening, an object of a type which cannot be flattened was encountered.
- twisted.web.error.ExcessiveBufferingError
  twisted.web.error.ExcessiveBufferingError.html
  Class
  Exception
  PUBLIC
  The HTTP/2 protocol has been forced to buffer an excessive amount of outbound data, and has therefore closed the connection and dropped all outbound data.
- twisted.web.error.FlattenerError
  twisted.web.error.FlattenerError.html
  Class
  Exception
  PUBLIC
  An error occurred while flattening an object.
- twisted.web.error.FlattenerError._roots
  twisted.web.error.FlattenerError.html#_roots
  Attribute
  Instance Variable
  PRIVATE
  A list of the objects on the flattener's stack at the time the unflattenable object was encountered. The first element is least deeply nested object and the last element is the most deeply nested.
- twisted.web.error.FlattenerError.__init__
  twisted.web.error.FlattenerError.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.error.FlattenerError._exception
  twisted.web.error.FlattenerError.html#_exception
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.web.error.FlattenerError._traceback
  twisted.web.error.FlattenerError.html#_traceback
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.web.error.FlattenerError._formatRoot
  twisted.web.error.FlattenerError.html#_formatRoot
  Function
  Method
  PRIVATE
  Convert an object from `self._roots` to a string suitable for inclusion in a render-traceback (like a normal Python traceback, but can include "frame" source locations which are not in Python source files).
- twisted.web.error.FlattenerError.__repr__
  twisted.web.error.FlattenerError.html#__repr__
  Function
  Method
  PUBLIC
  Present a string representation which includes a template traceback, so we can tell where this error occurred in the template, as well as in Python.
- twisted.web.error.FlattenerError.__str__
  twisted.web.error.FlattenerError.html#__str__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.error.UnsupportedSpecialHeader
  twisted.web.error.UnsupportedSpecialHeader.html
  Class
  Exception
  PUBLIC
  A HTTP/2 request was received that contained a HTTP/2 pseudo-header field that is not recognised by Twisted.
- twisted.web.resource.IResource
  twisted.web.resource.IResource.html
  Class
  Interface
  PUBLIC
  A web resource.
- twisted.web.resource.IResource.isLeaf
  twisted.web.resource.IResource.html#isLeaf
  Attribute
  Attribute
  PUBLIC
  Signal if this IResource implementor is a "leaf node" or not. If True, getChildWithDefault will not be called on this Resource.
- twisted.web.resource.IResource.getChildWithDefault
  twisted.web.resource.IResource.html#getChildWithDefault
  Function
  Method
  PUBLIC
  Return a child with the given name for the given request. This is the external interface used by the Resource publishing machinery. If implementing IResource without subclassing Resource, it must be provided...
- twisted.web.resource.IResource.putChild
  twisted.web.resource.IResource.html#putChild
  Function
  Method
  PUBLIC
  Put a child IResource implementor at the given path.
- twisted.web.resource.IResource.render
  twisted.web.resource.IResource.html#render
  Function
  Method
  PUBLIC
  Render a request. This is called on the leaf resource for a request.
- twisted.web.resource.getChildForRequest
  twisted.web.resource.html#getChildForRequest
  Function
  Function
  PUBLIC
  Traverse resource tree to find who will handle the request.
- twisted.web.resource.Resource
  twisted.web.resource.Resource.html
  Class
  Class
  PUBLIC
  Define a web-accessible resource.
- twisted.web.resource.Resource.server
  twisted.web.resource.Resource.html#server
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.web.resource.Resource.__init__
  twisted.web.resource.Resource.html#__init__
  Function
  Method
  PUBLIC
  Initialize.
- twisted.web.resource.Resource.children
  twisted.web.resource.Resource.html#children
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.resource.Resource.isLeaf
  twisted.web.resource.Resource.html#isLeaf
  Attribute
  Class Variable
  PUBLIC
  Signal if this IResource implementor is a "leaf node" or not. If True, getChildWithDefault will not be called on this Resource.
- twisted.web.resource.Resource.listStaticNames
  twisted.web.resource.Resource.html#listStaticNames
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.resource.Resource.listStaticEntities
  twisted.web.resource.Resource.html#listStaticEntities
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.resource.Resource.listNames
  twisted.web.resource.Resource.html#listNames
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.resource.Resource.listEntities
  twisted.web.resource.Resource.html#listEntities
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.resource.Resource.listDynamicNames
  twisted.web.resource.Resource.html#listDynamicNames
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.resource.Resource.listDynamicEntities
  twisted.web.resource.Resource.html#listDynamicEntities
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.resource.Resource.getStaticEntity
  twisted.web.resource.Resource.html#getStaticEntity
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.resource.Resource.getDynamicEntity
  twisted.web.resource.Resource.html#getDynamicEntity
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.resource.Resource.delEntity
  twisted.web.resource.Resource.html#delEntity
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.resource.Resource.reallyPutEntity
  twisted.web.resource.Resource.html#reallyPutEntity
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.resource.Resource.getChild
  twisted.web.resource.Resource.html#getChild
  Function
  Method
  PUBLIC
  Retrieve a 'child' resource from me.
- twisted.web.resource.Resource.getChildWithDefault
  twisted.web.resource.Resource.html#getChildWithDefault
  Function
  Method
  PUBLIC
  Retrieve a static or dynamically generated child resource from me.
- twisted.web.resource.Resource.getChildForRequest
  twisted.web.resource.Resource.html#getChildForRequest
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.resource.Resource.putChild
  twisted.web.resource.Resource.html#putChild
  Function
  Method
  PUBLIC
  Register a static child.
- twisted.web.resource.Resource.render
  twisted.web.resource.Resource.html#render
  Function
  Method
  PUBLIC
  Render a given resource. See `IResource`'s render method.
- twisted.web.resource.Resource.render_HEAD
  twisted.web.resource.Resource.html#render_HEAD
  Function
  Method
  PUBLIC
  Default handling of HEAD method.
- twisted.web.resource._computeAllowedMethods
  twisted.web.resource.html#_computeAllowedMethods
  Function
  Function
  PRIVATE
  Compute the allowed methods on a `Resource` based on defined render_FOO methods. Used when raising `UnsupportedMethod` but `Resource` does not define `allowedMethods` attribute.
- twisted.web.resource._UnsafeErrorPage
  twisted.web.resource._UnsafeErrorPage.html
  Class
  Class
  PRIVATE
  `_UnsafeErrorPage`, publicly available via the deprecated alias `ErrorPage`, is a resource which responds with a particular (parameterized) status and a body consisting of HTML containing some descriptive text...
- twisted.web.resource._UnsafeErrorPage.template
  twisted.web.resource._UnsafeErrorPage.html#template
  Attribute
  Instance Variable
  PUBLIC
  A native string which will have a dictionary interpolated into it to generate the response body. The dictionary has the following keys:
- twisted.web.resource._UnsafeErrorPage.code
  twisted.web.resource._UnsafeErrorPage.html#code
  Attribute
  Instance Variable
  PUBLIC
  An integer status code which will be used for the response.
- twisted.web.resource._UnsafeErrorPage.brief
  twisted.web.resource._UnsafeErrorPage.html#brief
  Attribute
  Instance Variable
  PUBLIC
  A short string which will be included in the response body as the page title.
- twisted.web.resource._UnsafeErrorPage.detail
  twisted.web.resource._UnsafeErrorPage.html#detail
  Attribute
  Instance Variable
  PUBLIC
  A longer string which will be included in the response body.
- twisted.web.resource._UnsafeErrorPage.__init__
  twisted.web.resource._UnsafeErrorPage.html#__init__
  Function
  Method
  PUBLIC
  Initialize.
- twisted.web.resource._UnsafeErrorPage.render
  twisted.web.resource._UnsafeErrorPage.html#render
  Function
  Method
  PUBLIC
  Render a given resource. See `IResource`'s render method.
- twisted.web.resource._UnsafeErrorPage.getChild
  twisted.web.resource._UnsafeErrorPage.html#getChild
  Function
  Method
  PUBLIC
  Retrieve a 'child' resource from me.
- twisted.web.resource._UnsafeNoResource
  twisted.web.resource._UnsafeNoResource.html
  Class
  Class
  PRIVATE
  `_UnsafeNoResource`, publicly available via the deprecated alias `NoResource`, is a specialization of `_UnsafeErrorPage` which returns the HTTP response code NOT FOUND.
- twisted.web.resource._UnsafeNoResource.__init__
  twisted.web.resource._UnsafeNoResource.html#__init__
  Function
  Method
  PUBLIC
  Initialize.
- twisted.web.resource._UnsafeForbiddenResource
  twisted.web.resource._UnsafeForbiddenResource.html
  Class
  Class
  PRIVATE
  `_UnsafeForbiddenResource`, publicly available via the deprecated alias `ForbiddenResource` is a specialization of `_UnsafeErrorPage` which returns the FORBIDDEN HTTP response code.
- twisted.web.resource._UnsafeForbiddenResource.__init__
  twisted.web.resource._UnsafeForbiddenResource.html#__init__
  Function
  Method
  PUBLIC
  Initialize.
- twisted.web.resource._IEncodingResource
  twisted.web.resource._IEncodingResource.html
  Class
  Interface
  PRIVATE
  A resource which knows about `_IRequestEncoderFactory`.
- twisted.web.resource._IEncodingResource.getEncoder
  twisted.web.resource._IEncodingResource.html#getEncoder
  Function
  Method
  PUBLIC
  Parse the request and return an encoder if applicable, using `_IRequestEncoderFactory.encoderForRequest`.
- twisted.web.resource.EncodingResourceWrapper
  twisted.web.resource.EncodingResourceWrapper.html
  Class
  Class
  PUBLIC
  Wrap a `IResource`, potentially applying an encoding to the response body generated.
- twisted.web.resource.EncodingResourceWrapper.encoders
  twisted.web.resource.EncodingResourceWrapper.html#encoders
  Attribute
  Instance Variable
  PUBLIC
  A list of `_IRequestEncoderFactory` returning `_IRequestEncoder` that may transform the data passed to `Request.write`. The list must be sorted in order of priority: the first encoder factory handling the request will prevent the others from doing the same.
- twisted.web.resource.EncodingResourceWrapper.__init__
  twisted.web.resource.EncodingResourceWrapper.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.resource.EncodingResourceWrapper._encoders
  twisted.web.resource.EncodingResourceWrapper.html#_encoders
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.web.resource.EncodingResourceWrapper.getEncoder
  twisted.web.resource.EncodingResourceWrapper.html#getEncoder
  Function
  Method
  PUBLIC
  Browser the list of encoders looking for one applicable encoder.
- twisted.web._element.T
  twisted.web._element.html#T
  Attribute
  Type Variable
  PUBLIC
  Undocumented
- twisted.web._element.Expose
  twisted.web._element.Expose.html
  Class
  Class
  PUBLIC
  Helper for exposing methods for various uses using a simple decorator-style callable.
- twisted.web._element.Expose.__call__
  twisted.web._element.Expose.html#__call__
  Function
  Method
  PUBLIC
  Add one or more functions to the set of exposed functions.
- twisted.web._element.Expose._nodefault
  twisted.web._element.Expose.html#_nodefault
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.web._element.Expose.get 0
  twisted.web._element.Expose.html#get%200
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web._element.Expose.get 1
  twisted.web._element.Expose.html#get%201
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web._element.Expose.get
  twisted.web._element.Expose.html#get
  Function
  Method
  PUBLIC
  Retrieve an exposed method with the given name from the given instance.
- twisted.web._element.exposer
  twisted.web._element.html#exposer
  Function
  Function
  PUBLIC
  Undocumented
- twisted.web._flatten.T
  twisted.web._flatten.html#T
  Attribute
  Type Variable
  PUBLIC
  For documentation purposes, read `FlattenableRecursive` as `Flattenable`. However, since mypy doesn't support recursive type definitions (yet?), we'll put Any in the actual definition.
- twisted.web._flatten.escapeForContent
  twisted.web._flatten.html#escapeForContent
  Function
  Function
  PUBLIC
  Escape some character or UTF-8 byte data for inclusion in an HTML or XML document, by replacing metacharacters (`&<>`) with their entity equivalents (`&amp;&lt;&gt;`).
- twisted.web._flatten.attributeEscapingDoneOutside
  twisted.web._flatten.html#attributeEscapingDoneOutside
  Function
  Function
  PUBLIC
  Escape some character or UTF-8 byte data for inclusion in the top level of an attribute. `attributeEscapingDoneOutside` actually passes the data through unchanged, because `writeWithAttributeEscaping` handles the quoting of the text within attributes outside the generator returned by ...
- twisted.web._flatten.writeWithAttributeEscaping
  twisted.web._flatten.html#writeWithAttributeEscaping
  Function
  Function
  PUBLIC
  Decorate a `write` callable so that all output written is properly quoted for inclusion within an XML attribute value.
- twisted.web._flatten.escapedCDATA
  twisted.web._flatten.html#escapedCDATA
  Function
  Function
  PUBLIC
  Escape CDATA for inclusion in a document.
- twisted.web._flatten.escapedComment
  twisted.web._flatten.html#escapedComment
  Function
  Function
  PUBLIC
  Escape a comment for inclusion in a document.
- twisted.web._flatten._getSlotValue
  twisted.web._flatten.html#_getSlotValue
  Function
  Function
  PRIVATE
  Find the value of the named slot in the given stack of slot data.
- twisted.web._flatten._fork
  twisted.web._flatten.html#_fork
  Function
  Function
  PRIVATE
  Create a new `Deferred` based on `d` that will fire and fail with `d`'s result or error, but will not modify `d`'s callback type.
- twisted.web._flatten._flattenElement
  twisted.web._flatten.html#_flattenElement
  Function
  Function
  PRIVATE
  Make `root` slightly more flat by yielding all its immediate contents as strings, deferreds or generators that are recursive calls to itself.
- twisted.web._flatten._flattenTree
  twisted.web._flatten.html#_flattenTree
  Function
  Function
  PRIVATE
  Make `root` into an iterable of `bytes` and `Deferred` by doing a depth first traversal of the tree.
- twisted.web._template_util._NSContext
  twisted.web._template_util._NSContext.html
  Class
  Class
  PRIVATE
  A mapping from XML namespaces onto their prefixes in the document.
- twisted.web._template_util._NSContext.__init__
  twisted.web._template_util._NSContext.html#__init__
  Function
  Method
  PUBLIC
  Pull out the parent's namespaces, if there's no parent then default to XML.
- twisted.web._template_util._NSContext.parent
  twisted.web._template_util._NSContext.html#parent
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web._template_util._NSContext.nss
  twisted.web._template_util._NSContext.html#nss
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web._template_util._NSContext.get
  twisted.web._template_util._NSContext.html#get
  Function
  Method
  PUBLIC
  Get a prefix for a namespace.
- twisted.web._template_util._NSContext.__setitem__
  twisted.web._template_util._NSContext.html#__setitem__
  Function
  Method
  PUBLIC
  Proxy through to setting the prefix for the namespace.
- twisted.web._template_util._NSContext.__getitem__
  twisted.web._template_util._NSContext.html#__getitem__
  Function
  Method
  PUBLIC
  Proxy through to getting the prefix for the namespace.
- twisted.web._template_util._ToStan
  twisted.web._template_util._ToStan.html
  Class
  Class
  PRIVATE
  A SAX parser which converts an XML document to the Twisted STAN Document Object Model.
- twisted.web._template_util._ToStan.__init__
  twisted.web._template_util._ToStan.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.web._template_util._ToStan.sourceFilename
  twisted.web._template_util._ToStan.html#sourceFilename
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web._template_util._ToStan.prefixMap
  twisted.web._template_util._ToStan.html#prefixMap
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web._template_util._ToStan.inCDATA
  twisted.web._template_util._ToStan.html#inCDATA
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web._template_util._ToStan.setDocumentLocator
  twisted.web._template_util._ToStan.html#setDocumentLocator
  Function
  Method
  PUBLIC
  Set the document locator, which knows about line and character numbers.
- twisted.web._template_util._ToStan.locator
  twisted.web._template_util._ToStan.html#locator
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web._template_util._ToStan.startDocument
  twisted.web._template_util._ToStan.html#startDocument
  Function
  Method
  PUBLIC
  Initialise the document.
- twisted.web._template_util._ToStan.document
  twisted.web._template_util._ToStan.html#document
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web._template_util._ToStan.current
  twisted.web._template_util._ToStan.html#current
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web._template_util._ToStan.stack
  twisted.web._template_util._ToStan.html#stack
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web._template_util._ToStan.xmlnsAttrs
  twisted.web._template_util._ToStan.html#xmlnsAttrs
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web._template_util._ToStan.endDocument
  twisted.web._template_util._ToStan.html#endDocument
  Function
  Method
  PUBLIC
  Document ended.
- twisted.web._template_util._ToStan.processingInstruction
  twisted.web._template_util._ToStan.html#processingInstruction
  Function
  Method
  PUBLIC
  Processing instructions are ignored.
- twisted.web._template_util._ToStan.startPrefixMapping
  twisted.web._template_util._ToStan.html#startPrefixMapping
  Function
  Method
  PUBLIC
  Set up the prefix mapping, which maps fully qualified namespace URIs onto namespace prefixes.
- twisted.web._template_util._ToStan.endPrefixMapping
  twisted.web._template_util._ToStan.html#endPrefixMapping
  Function
  Method
  PUBLIC
  "Pops the stack" on the prefix mapping.
- twisted.web._template_util._ToStan.startElementNS
  twisted.web._template_util._ToStan.html#startElementNS
  Function
  Method
  PUBLIC
  Gets called when we encounter a new xmlns attribute.
- twisted.web._template_util._ToStan.characters
  twisted.web._template_util._ToStan.html#characters
  Function
  Method
  PUBLIC
  Called when we receive some characters. CDATA characters get passed through as is.
- twisted.web._template_util._ToStan.endElementNS
  twisted.web._template_util._ToStan.html#endElementNS
  Function
  Method
  PUBLIC
  A namespace tag is closed. Pop the stack, if there's anything left in it, otherwise return to the document's namespace.
- twisted.web._template_util._ToStan.startDTD
  twisted.web._template_util._ToStan.html#startDTD
  Function
  Method
  PUBLIC
  DTDs are ignored.
- twisted.web._template_util._ToStan.endDTD
  twisted.web._template_util._ToStan.html#endDTD
  Function
  Method
  PUBLIC
  DTDs are ignored.
- twisted.web._template_util._ToStan.startCDATA
  twisted.web._template_util._ToStan.html#startCDATA
  Function
  Method
  PUBLIC
  We're starting to be in a CDATA element, make a note of this.
- twisted.web._template_util._ToStan.endCDATA
  twisted.web._template_util._ToStan.html#endCDATA
  Function
  Method
  PUBLIC
  We're no longer in a CDATA element. Collect up the characters we've parsed and put them in a new CDATA object.
- twisted.web._template_util._ToStan.comment
  twisted.web._template_util._ToStan.html#comment
  Function
  Method
  PUBLIC
  Add an XML comment which we've encountered.
- twisted.web._template_util._flatsaxParse
  twisted.web._template_util.html#_flatsaxParse
  Function
  Function
  PRIVATE
  Perform a SAX parse of an XML document with the _ToStan class.
- twisted.web._template_util.NOT_DONE_YET
  twisted.web._template_util.html#NOT_DONE_YET
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.web._template_util._moduleLog
  twisted.web._template_util.html#_moduleLog
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.web._template_util._TagFactory
  twisted.web._template_util._TagFactory.html
  Class
  Class
  PRIVATE
  A factory for `Tag` objects; the implementation of the `tags` object.
- twisted.web._template_util._TagFactory.__getattr__
  twisted.web._template_util._TagFactory.html#__getattr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.template.CDATA
  twisted.web.template.CDATA.html
  Class
  Class
  PUBLIC
  A `<![CDATA[]]>` block from a template. Given a separate representation in the DOM so that they may be round-tripped through rendering without losing information.
- twisted.web.template.CDATA.data
  twisted.web.template.CDATA.html#data
  Attribute
  Instance Variable
  PUBLIC
  The data between "`<![CDATA[`" and "`]]>`".
- twisted.web.template.CDATA.__repr__
  twisted.web.template.CDATA.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.template.Comment
  twisted.web.template.Comment.html
  Class
  Class
  PUBLIC
  A `<!-- -->` comment from a template. Given a separate representation in the DOM so that they may be round-tripped through rendering without losing information.
- twisted.web.template.Comment.data
  twisted.web.template.Comment.html#data
  Attribute
  Instance Variable
  PUBLIC
  The data between "`<!--`" and "`-->`".
- twisted.web.template.Comment.__repr__
  twisted.web.template.Comment.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.template.Element
  twisted.web.template.Element.html
  Class
  Class
  PUBLIC
  Base for classes which can render part of a page.
- twisted.web.template.Element.loader
  twisted.web.template.Element.html#loader
  Attribute
  Instance Variable
  PUBLIC
  The factory which will be used to load documents to return from `render`.
- twisted.web.template.Element.__init__
  twisted.web.template.Element.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.template.Element.lookupRenderMethod
  twisted.web.template.Element.html#lookupRenderMethod
  Function
  Method
  PUBLIC
  Look up and return the named render method.
- twisted.web.template.Element.render
  twisted.web.template.Element.html#render
  Function
  Method
  PUBLIC
  Implement `IRenderable` to allow one `Element` to be embedded in another's template or rendering output.
- twisted.web.template.Flattenable
  twisted.web.template.html#Flattenable
  Attribute
  Type Alias
  PUBLIC
  Type alias containing all types that can be flattened by `flatten()`.
- twisted.web.template.Tag
  twisted.web.template.Tag.html
  Class
  Class
  PUBLIC
  A `Tag` represents an XML tags with a tag name, attributes, and children. A `Tag` can be constructed using the special `twisted.web.template.tags` object, or it may be constructed directly with a tag name. `Tag`...
- twisted.web.template.Tag.tagName
  twisted.web.template.Tag.html#tagName
  Attribute
  Instance Variable
  PUBLIC
  The name of the represented element.
- twisted.web.template.Tag.attributes
  twisted.web.template.Tag.html#attributes
  Attribute
  Instance Variable
  PUBLIC
  The attributes of the element.
- twisted.web.template.Tag.children
  twisted.web.template.Tag.html#children
  Attribute
  Instance Variable
  PUBLIC
  The contents of this `Tag`.
- twisted.web.template.Tag.render
  twisted.web.template.Tag.html#render
  Attribute
  Instance Variable
  PUBLIC
  The name of the render method to use for this `Tag`.
- twisted.web.template.Tag.filename
  twisted.web.template.Tag.html#filename
  Attribute
  Instance Variable
  PUBLIC
  The name of the XML file from which this tag was parsed.
- twisted.web.template.Tag.lineNumber
  twisted.web.template.Tag.html#lineNumber
  Attribute
  Instance Variable
  PUBLIC
  The line number on which this tag was encountered in the XML file from which it was parsed.
- twisted.web.template.Tag.columnNumber
  twisted.web.template.Tag.html#columnNumber
  Attribute
  Instance Variable
  PUBLIC
  The column number at which this tag was encountered in the XML file from which it was parsed.
- twisted.web.template.Tag.slotData
  twisted.web.template.Tag.html#slotData
  Attribute
  Instance Variable
  PUBLIC
  The data which can fill slots.
- twisted.web.template.Tag.fillSlots
  twisted.web.template.Tag.html#fillSlots
  Function
  Method
  PUBLIC
  Remember the slots provided at this position in the DOM.
- twisted.web.template.Tag.__call__
  twisted.web.template.Tag.html#__call__
  Function
  Method
  PUBLIC
  Add children and change attributes on this tag.
- twisted.web.template.Tag._clone
  twisted.web.template.Tag.html#_clone
  Function
  Method
  PRIVATE
  Clone a `Flattenable` object; used by `Tag.clone`.
- twisted.web.template.Tag.clone
  twisted.web.template.Tag.html#clone
  Function
  Method
  PUBLIC
  Return a clone of this tag. If deep is True, clone all of this tag's children. Otherwise, just shallow copy the children list without copying the children themselves.
- twisted.web.template.Tag.clear
  twisted.web.template.Tag.html#clear
  Function
  Method
  PUBLIC
  Clear any existing children from this tag.
- twisted.web.template.Tag.__repr__
  twisted.web.template.Tag.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.template.TagLoader
  twisted.web.template.TagLoader.html
  Class
  Class
  PUBLIC
  An `ITemplateLoader` that loads an existing flattenable object.
- twisted.web.template.TagLoader.__init__
  twisted.web.template.TagLoader.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.web.template.TagLoader.tag
  twisted.web.template.TagLoader.html#tag
  Attribute
  Instance Variable
  PUBLIC
  The object which will be loaded.
- twisted.web.template.TagLoader.load
  twisted.web.template.TagLoader.html#load
  Function
  Method
  PUBLIC
  Load a template suitable for rendering.
- twisted.web.template.XMLFile
  twisted.web.template.XMLFile.html
  Class
  Class
  PUBLIC
  An `ITemplateLoader` that loads and parses XML from a file.
- twisted.web.template.XMLFile.__init__
  twisted.web.template.XMLFile.html#__init__
  Function
  Method
  PUBLIC
  Run the parser on a file.
- twisted.web.template.XMLFile._loadedTemplate
  twisted.web.template.XMLFile.html#_loadedTemplate
  Attribute
  Instance Variable
  PRIVATE
  The loaded document, or `None`, if not loaded.
- twisted.web.template.XMLFile._path
  twisted.web.template.XMLFile.html#_path
  Attribute
  Instance Variable
  PRIVATE
  The file that is being loaded from.
- twisted.web.template.XMLFile._loadDoc
  twisted.web.template.XMLFile.html#_loadDoc
  Function
  Method
  PRIVATE
  Read and parse the XML.
- twisted.web.template.XMLFile.__repr__
  twisted.web.template.XMLFile.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.template.XMLFile.load
  twisted.web.template.XMLFile.html#load
  Function
  Method
  PUBLIC
  Return the document, first loading it if necessary.
- twisted.web.template.XMLString
  twisted.web.template.XMLString.html
  Class
  Class
  PUBLIC
  An `ITemplateLoader` that loads and parses XML from a string.
- twisted.web.template.XMLString.__init__
  twisted.web.template.XMLString.html#__init__
  Function
  Method
  PUBLIC
  Run the parser on a `io.StringIO` copy of the string.
- twisted.web.template.XMLString._loadedTemplate
  twisted.web.template.XMLString.html#_loadedTemplate
  Attribute
  Instance Variable
  PRIVATE
  The loaded document.
- twisted.web.template.XMLString.load
  twisted.web.template.XMLString.html#load
  Function
  Method
  PUBLIC
  Return the document.
- twisted.web.template.flatten
  twisted.web.template.html#flatten
  Function
  Function
  PUBLIC
  Incrementally write out a string representation of `root` using `write`.
- twisted.web.template.flattenString
  twisted.web.template.html#flattenString
  Function
  Function
  PUBLIC
  Collate a string representation of `root` into a single string.
- twisted.web.template.renderElement
  twisted.web.template.html#renderElement
  Function
  Function
  PUBLIC
  Render an element or other `IRenderable`.
- twisted.web.template.renderer
  twisted.web.template.html#renderer
  Function
  Function
  PUBLIC
  Decorate with `renderer` to use methods as template render directives.
- twisted.web.template.slot
  twisted.web.template.slot.html
  Class
  Class
  PUBLIC
  Marker for markup insertion in a template.
- twisted.web.template.slot.name
  twisted.web.template.slot.html#name
  Attribute
  Instance Variable
  PUBLIC
  The name of this slot.
- twisted.web.template.slot.children
  twisted.web.template.slot.html#children
  Attribute
  Instance Variable
  PUBLIC
  The `Tag` objects included in this `slot`'s template.
- twisted.web.template.slot.default
  twisted.web.template.slot.html#default
  Attribute
  Instance Variable
  PUBLIC
  The default contents of this slot, if it is left unfilled.
- twisted.web.template.slot.filename
  twisted.web.template.slot.html#filename
  Attribute
  Instance Variable
  PUBLIC
  The name of the XML file from which this tag was parsed.
- twisted.web.template.slot.lineNumber
  twisted.web.template.slot.html#lineNumber
  Attribute
  Instance Variable
  PUBLIC
  The line number on which this tag was encountered in the XML file from which it was parsed.
- twisted.web.template.slot.columnNumber
  twisted.web.template.slot.html#columnNumber
  Attribute
  Instance Variable
  PUBLIC
  The column number at which this tag was encountered in the XML file from which it was parsed.
- twisted.web.iweb.IRequest
  twisted.web.iweb.IRequest.html
  Class
  Interface
  PUBLIC
  An HTTP request.
- twisted.web.iweb.IRequest.method
  twisted.web.iweb.IRequest.html#method
  Attribute
  Attribute
  PUBLIC
  A `bytes` giving the HTTP method that was used.
- twisted.web.iweb.IRequest.uri
  twisted.web.iweb.IRequest.html#uri
  Attribute
  Attribute
  PUBLIC
  A `bytes` giving the full encoded URI which was requested (including query arguments).
- twisted.web.iweb.IRequest.path
  twisted.web.iweb.IRequest.html#path
  Attribute
  Attribute
  PUBLIC
  A `bytes` giving the encoded query path of the request URI (not including query arguments).
- twisted.web.iweb.IRequest.args
  twisted.web.iweb.IRequest.html#args
  Attribute
  Attribute
  PUBLIC
  A mapping of decoded query argument names as `bytes` to corresponding query argument values as `list`s of `bytes`. For example, for a URI with `foo=bar&foo=baz&quux=spam` for its query part, `args` will be `{b'foo': [b'bar', b'baz'], b'quux': [b'spam']}`...
- twisted.web.iweb.IRequest.prepath
  twisted.web.iweb.IRequest.html#prepath
  Attribute
  Attribute
  PUBLIC
  The URL path segments which have been processed during resource traversal, as a list of `bytes`.
- twisted.web.iweb.IRequest.postpath
  twisted.web.iweb.IRequest.html#postpath
  Attribute
  Attribute
  PUBLIC
  The URL path segments which have not (yet) been processed during resource traversal, as a list of `bytes`.
- twisted.web.iweb.IRequest.requestHeaders
  twisted.web.iweb.IRequest.html#requestHeaders
  Attribute
  Attribute
  PUBLIC
  A `http_headers.Headers` instance giving all received HTTP request headers.
- twisted.web.iweb.IRequest.content
  twisted.web.iweb.IRequest.html#content
  Attribute
  Attribute
  PUBLIC
  A file-like object giving the request body. This may be a file on disk, an `io.BytesIO`, or some other type. The implementation is free to decide on a per-request basis.
- twisted.web.iweb.IRequest.responseHeaders
  twisted.web.iweb.IRequest.html#responseHeaders
  Attribute
  Attribute
  PUBLIC
  A `http_headers.Headers` instance holding all HTTP response headers to be sent.
- twisted.web.iweb.IRequest.getHeader
  twisted.web.iweb.IRequest.html#getHeader
  Function
  Method
  PUBLIC
  Get an HTTP request header.
- twisted.web.iweb.IRequest.getCookie
  twisted.web.iweb.IRequest.html#getCookie
  Function
  Method
  PUBLIC
  Get a cookie that was sent from the network.
- twisted.web.iweb.IRequest.getAllHeaders
  twisted.web.iweb.IRequest.html#getAllHeaders
  Function
  Method
  PUBLIC
  Return dictionary mapping the names of all received headers to the last value received for each.
- twisted.web.iweb.IRequest.getRequestHostname
  twisted.web.iweb.IRequest.html#getRequestHostname
  Function
  Method
  PUBLIC
  Get the hostname that the HTTP client passed in to the request.
- twisted.web.iweb.IRequest.getHost
  twisted.web.iweb.IRequest.html#getHost
  Function
  Method
  PUBLIC
  Get my originally requesting transport's host.
- twisted.web.iweb.IRequest.getClientAddress
  twisted.web.iweb.IRequest.html#getClientAddress
  Function
  Method
  PUBLIC
  Return the address of the client who submitted this request.
- twisted.web.iweb.IRequest.getClientIP
  twisted.web.iweb.IRequest.html#getClientIP
  Function
  Method
  PUBLIC
  Return the IP address of the client who submitted this request.
- twisted.web.iweb.IRequest.getUser
  twisted.web.iweb.IRequest.html#getUser
  Function
  Method
  PUBLIC
  Return the HTTP user sent with this request, if any.
- twisted.web.iweb.IRequest.getPassword
  twisted.web.iweb.IRequest.html#getPassword
  Function
  Method
  PUBLIC
  Return the HTTP password sent with this request, if any.
- twisted.web.iweb.IRequest.isSecure
  twisted.web.iweb.IRequest.html#isSecure
  Function
  Method
  PUBLIC
  Return True if this request is using a secure transport.
- twisted.web.iweb.IRequest.getSession
  twisted.web.iweb.IRequest.html#getSession
  Function
  Method
  PUBLIC
  Look up the session associated with this request or create a new one if there is not one.
- twisted.web.iweb.IRequest.URLPath
  twisted.web.iweb.IRequest.html#URLPath
  Function
  Method
  PUBLIC
  No summary
- twisted.web.iweb.IRequest.prePathURL
  twisted.web.iweb.IRequest.html#prePathURL
  Function
  Method
  PUBLIC
  At any time during resource traversal or resource rendering, returns an absolute URL to the most nested resource which has yet been reached.
- twisted.web.iweb.IRequest.rememberRootURL
  twisted.web.iweb.IRequest.html#rememberRootURL
  Function
  Method
  PUBLIC
  Remember the currently-processed part of the URL for later recalling.
- twisted.web.iweb.IRequest.getRootURL
  twisted.web.iweb.IRequest.html#getRootURL
  Function
  Method
  PUBLIC
  Get a previously-remembered URL.
- twisted.web.iweb.IRequest.finish
  twisted.web.iweb.IRequest.html#finish
  Function
  Method
  PUBLIC
  Indicate that the response to this request is complete.
- twisted.web.iweb.IRequest.write
  twisted.web.iweb.IRequest.html#write
  Function
  Method
  PUBLIC
  Write some data to the body of the response to this request. Response headers are written the first time this method is called, after which new response headers may not be added.
- twisted.web.iweb.IRequest.addCookie
  twisted.web.iweb.IRequest.html#addCookie
  Function
  Method
  PUBLIC
  Set an outgoing HTTP cookie.
- twisted.web.iweb.IRequest.setResponseCode
  twisted.web.iweb.IRequest.html#setResponseCode
  Function
  Method
  PUBLIC
  Set the HTTP response code.
- twisted.web.iweb.IRequest.setHeader
  twisted.web.iweb.IRequest.html#setHeader
  Function
  Method
  PUBLIC
  Set an HTTP response header. Overrides any previously set values for this header.
- twisted.web.iweb.IRequest.redirect
  twisted.web.iweb.IRequest.html#redirect
  Function
  Method
  PUBLIC
  Utility function that does a redirect.
- twisted.web.iweb.IRequest.setLastModified
  twisted.web.iweb.IRequest.html#setLastModified
  Function
  Method
  PUBLIC
  Set the `Last-Modified` time for the response to this request.
- twisted.web.iweb.IRequest.setETag
  twisted.web.iweb.IRequest.html#setETag
  Function
  Method
  PUBLIC
  Set an `entity tag` for the outgoing response.
- twisted.web.iweb.IRequest.setHost
  twisted.web.iweb.IRequest.html#setHost
  Function
  Method
  PUBLIC
  Change the host and port the request thinks it's using.
- twisted.web.iweb.INonQueuedRequestFactory
  twisted.web.iweb.INonQueuedRequestFactory.html
  Class
  Interface
  PUBLIC
  A factory of `IRequest` objects that does not take a ``queued`` parameter.
- twisted.web.iweb.INonQueuedRequestFactory.__call__
  twisted.web.iweb.INonQueuedRequestFactory.html#__call__
  Function
  Method
  PUBLIC
  Create an `IRequest` that is operating on the given channel. There must only be one `IRequest` object processing at any given time on a channel.
- twisted.web.iweb.IAccessLogFormatter
  twisted.web.iweb.IAccessLogFormatter.html
  Class
  Interface
  PUBLIC
  An object which can represent an HTTP request as a line of text for inclusion in an access log file.
- twisted.web.iweb.IAccessLogFormatter.__call__
  twisted.web.iweb.IAccessLogFormatter.html#__call__
  Function
  Method
  PUBLIC
  Generate a line for the access log.
- twisted.web.iweb.ICredentialFactory
  twisted.web.iweb.ICredentialFactory.html
  Class
  Interface
  PUBLIC
  A credential factory defines a way to generate a particular kind of authentication challenge and a way to interpret the responses to these challenges. It creates `ICredentials` providers from responses. ...
- twisted.web.iweb.ICredentialFactory.scheme
  twisted.web.iweb.ICredentialFactory.html#scheme
  Attribute
  Attribute
  PUBLIC
  A `str` giving the name of the authentication scheme with which this factory is associated. For example, `'basic'` or `'digest'`.
- twisted.web.iweb.ICredentialFactory.getChallenge
  twisted.web.iweb.ICredentialFactory.html#getChallenge
  Function
  Method
  PUBLIC
  Generate a new challenge to be sent to a client.
- twisted.web.iweb.ICredentialFactory.decode
  twisted.web.iweb.ICredentialFactory.html#decode
  Function
  Method
  PUBLIC
  Create a credentials object from the given response.
- twisted.web.iweb.IBodyProducer
  twisted.web.iweb.IBodyProducer.html
  Class
  Interface
  PUBLIC
  Objects which provide `IBodyProducer` write bytes to an object which provides `IConsumer` by calling its `write` method repeatedly.
- twisted.web.iweb.IBodyProducer.length
  twisted.web.iweb.IBodyProducer.html#length
  Attribute
  Attribute
  PUBLIC
  `length` is a `int` indicating how many bytes in total this `IBodyProducer` will write to the consumer or `UNKNOWN_LENGTH` if this is not known in advance.
- twisted.web.iweb.IBodyProducer.startProducing
  twisted.web.iweb.IBodyProducer.html#startProducing
  Function
  Method
  PUBLIC
  Start producing to the given `IConsumer` provider.
- twisted.web.iweb.IBodyProducer.stopProducing
  twisted.web.iweb.IBodyProducer.html#stopProducing
  Function
  Method
  PUBLIC
  In addition to the standard behavior of `IProducer.stopProducing` (stop producing data), make sure the `Deferred` returned by `startProducing` is never fired.
- twisted.web.iweb.IRenderable
  twisted.web.iweb.IRenderable.html
  Class
  Interface
  PUBLIC
  An `IRenderable` is an object that may be rendered by the `twisted.web.template` templating system.
- twisted.web.iweb.IRenderable.lookupRenderMethod
  twisted.web.iweb.IRenderable.html#lookupRenderMethod
  Function
  Method
  PUBLIC
  Look up and return the render method associated with the given name.
- twisted.web.iweb.IRenderable.render
  twisted.web.iweb.IRenderable.html#render
  Function
  Method
  PUBLIC
  Get the document for this `IRenderable`.
- twisted.web.iweb.ITemplateLoader
  twisted.web.iweb.ITemplateLoader.html
  Class
  Interface
  PUBLIC
  A loader for templates; something usable as a value for `twisted.web.template.Element`'s `loader` attribute.
- twisted.web.iweb.ITemplateLoader.load
  twisted.web.iweb.ITemplateLoader.html#load
  Function
  Method
  PUBLIC
  Load a template suitable for rendering.
- twisted.web.iweb.IResponse
  twisted.web.iweb.IResponse.html
  Class
  Interface
  PUBLIC
  An object representing an HTTP response received from an HTTP server.
- twisted.web.iweb.IResponse.version
  twisted.web.iweb.IResponse.html#version
  Attribute
  Attribute
  PUBLIC
  A three-tuple describing the protocol and protocol version of the response. The first element is of type `str`, the second and third are of type `int`. For example, `(b'HTTP', 1, 1)`.
- twisted.web.iweb.IResponse.code
  twisted.web.iweb.IResponse.html#code
  Attribute
  Attribute
  PUBLIC
  The HTTP status code of this response, as a `int`.
- twisted.web.iweb.IResponse.phrase
  twisted.web.iweb.IResponse.html#phrase
  Attribute
  Attribute
  PUBLIC
  The HTTP reason phrase of this response, as a `str`.
- twisted.web.iweb.IResponse.headers
  twisted.web.iweb.IResponse.html#headers
  Attribute
  Attribute
  PUBLIC
  The HTTP response `Headers` of this response.
- twisted.web.iweb.IResponse.length
  twisted.web.iweb.IResponse.html#length
  Attribute
  Attribute
  PUBLIC
  The `int` number of bytes expected to be in the body of this response or `UNKNOWN_LENGTH` if the server did not indicate how many bytes to expect. For HEAD responses, this will be 0; if the response includes a ...
- twisted.web.iweb.IResponse.request
  twisted.web.iweb.IResponse.html#request
  Attribute
  Attribute
  PUBLIC
  The `IClientRequest` that resulted in this response.
- twisted.web.iweb.IResponse.previousResponse
  twisted.web.iweb.IResponse.html#previousResponse
  Attribute
  Attribute
  PUBLIC
  The previous `IResponse` from a redirect, or `None` if there was no previous response. This can be used to walk the response or request history for redirections.
- twisted.web.iweb.IResponse.deliverBody
  twisted.web.iweb.IResponse.html#deliverBody
  Function
  Method
  PUBLIC
  Register an `IProtocol` provider to receive the response body.
- twisted.web.iweb.IResponse.setPreviousResponse
  twisted.web.iweb.IResponse.html#setPreviousResponse
  Function
  Method
  PUBLIC
  Set the reference to the previous `IResponse`.
- twisted.web.iweb._IRequestEncoder
  twisted.web.iweb._IRequestEncoder.html
  Class
  Interface
  PRIVATE
  An object encoding data passed to `IRequest.write`, for example for compression purpose.
- twisted.web.iweb._IRequestEncoder.encode
  twisted.web.iweb._IRequestEncoder.html#encode
  Function
  Method
  PUBLIC
  Encode the data given and return the result.
- twisted.web.iweb._IRequestEncoder.finish
  twisted.web.iweb._IRequestEncoder.html#finish
  Function
  Method
  PUBLIC
  Callback called when the request is closing.
- twisted.web.iweb._IRequestEncoderFactory
  twisted.web.iweb._IRequestEncoderFactory.html
  Class
  Interface
  PRIVATE
  A factory for returing `_IRequestEncoder` instances.
- twisted.web.iweb._IRequestEncoderFactory.encoderForRequest
  twisted.web.iweb._IRequestEncoderFactory.html#encoderForRequest
  Function
  Method
  PUBLIC
  If applicable, returns a `_IRequestEncoder` instance which will encode the request.
- twisted.web.iweb.IClientRequest
  twisted.web.iweb.IClientRequest.html
  Class
  Interface
  PUBLIC
  An object representing an HTTP request to make to an HTTP server.
- twisted.web.iweb.IClientRequest.method
  twisted.web.iweb.IClientRequest.html#method
  Attribute
  Attribute
  PUBLIC
  The HTTP method for this request, as `bytes`. For example: `b'GET'`, `b'HEAD'`, `b'POST'`, etc.
- twisted.web.iweb.IClientRequest.absoluteURI
  twisted.web.iweb.IClientRequest.html#absoluteURI
  Attribute
  Attribute
  PUBLIC
  The absolute URI of the requested resource, as `bytes`; or `None` if the absolute URI cannot be determined.
- twisted.web.iweb.IClientRequest.headers
  twisted.web.iweb.IClientRequest.html#headers
  Attribute
  Attribute
  PUBLIC
  Headers to be sent to the server, as a `twisted.web.http_headers.Headers` instance.
- twisted.web.iweb.IAgent
  twisted.web.iweb.IAgent.html
  Class
  Interface
  PUBLIC
  An agent makes HTTP requests.
- twisted.web.iweb.IAgent.request
  twisted.web.iweb.IAgent.html#request
  Function
  Method
  PUBLIC
  Request the resource at the given location.
- twisted.web.iweb.IPolicyForHTTPS
  twisted.web.iweb.IPolicyForHTTPS.html
  Class
  Interface
  PUBLIC
  An `IPolicyForHTTPS` provides a policy for verifying the certificates of HTTPS connections, in the form of a `client connection creator` per network location.
- twisted.web.iweb.IPolicyForHTTPS.creatorForNetloc
  twisted.web.iweb.IPolicyForHTTPS.html#creatorForNetloc
  Function
  Method
  PUBLIC
  Create a `client connection creator` appropriate for the given URL "netloc"; i.e. hostname and port number pair.
- twisted.web.iweb.IAgentEndpointFactory
  twisted.web.iweb.IAgentEndpointFactory.html
  Class
  Interface
  PUBLIC
  An `IAgentEndpointFactory` provides a way of constructing an endpoint used for outgoing Agent requests. This is useful in the case of needing to proxy outgoing connections, or to otherwise vary the transport used.
- twisted.web.iweb.IAgentEndpointFactory.endpointForURI
  twisted.web.iweb.IAgentEndpointFactory.html#endpointForURI
  Function
  Method
  PUBLIC
  Construct and return an `IStreamClientEndpoint` for the outgoing request's connection.
- twisted.web._http2._END_STREAM_SENTINEL
  twisted.web._http2.html#_END_STREAM_SENTINEL
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.web._http2.H2Connection
  twisted.web._http2.H2Connection.html
  Class
  Class
  PUBLIC
  A class representing a single HTTP/2 connection.
- twisted.web._http2.H2Connection.conn
  twisted.web._http2.H2Connection.html#conn
  Attribute
  Instance Variable
  PUBLIC
  The HTTP/2 connection state machine.
- twisted.web._http2.H2Connection.streams
  twisted.web._http2.H2Connection.html#streams
  Attribute
  Instance Variable
  PUBLIC
  A mapping of stream IDs to `H2Stream` objects, used to call specific methods on streams when events occur.
- twisted.web._http2.H2Connection.priority
  twisted.web._http2.H2Connection.html#priority
  Attribute
  Instance Variable
  PUBLIC
  A HTTP/2 priority tree used to ensure that responses are prioritised appropriately.
- twisted.web._http2.H2Connection._consumerBlocked
  twisted.web._http2.H2Connection.html#_consumerBlocked
  Attribute
  Instance Variable
  PRIVATE
  A flag tracking whether or not the `IConsumer` that is consuming this data has asked us to stop producing.
- twisted.web._http2.H2Connection._sendingDeferred
  twisted.web._http2.H2Connection.html#_sendingDeferred
  Attribute
  Instance Variable
  PRIVATE
  A `Deferred` used to restart the data-sending loop when more response data has been produced. Will not be present if there is outstanding data still to send.
- twisted.web._http2.H2Connection._outboundStreamQueues
  twisted.web._http2.H2Connection.html#_outboundStreamQueues
  Attribute
  Instance Variable
  PRIVATE
  A map of stream IDs to queues, used to store data blocks that are yet to be sent on the connection. These are used both to handle producers that do not respect `IConsumer` but also to allow priority to multiplex data appropriately.
- twisted.web._http2.H2Connection._sender
  twisted.web._http2.H2Connection.html#_sender
  Attribute
  Instance Variable
  PRIVATE
  A handle to the data-sending loop, allowing it to be terminated if needed.
- twisted.web._http2.H2Connection.abortTimeout
  twisted.web._http2.H2Connection.html#abortTimeout
  Attribute
  Instance Variable
  PUBLIC
  The number of seconds to wait after we attempt to shut the transport down cleanly to give up and forcibly terminate it. This is only used when we time a connection out, to prevent errors causing the FD to get leaked...
- twisted.web._http2.H2Connection._abortingCall
  twisted.web._http2.H2Connection.html#_abortingCall
  Attribute
  Instance Variable
  PRIVATE
  The `twisted.internet.base.DelayedCall` that will be used to forcibly close the transport if it doesn't close cleanly.
- twisted.web._http2.H2Connection.factory
  twisted.web._http2.H2Connection.html#factory
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.web._http2.H2Connection.site
  twisted.web._http2.H2Connection.html#site
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.web._http2.H2Connection._log
  twisted.web._http2.H2Connection.html#_log
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.web._http2.H2Connection.__init__
  twisted.web._http2.H2Connection.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web._http2.H2Connection._streamCleanupCallbacks
  twisted.web._http2.H2Connection.html#_streamCleanupCallbacks
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.web._http2.H2Connection._stillProducing
  twisted.web._http2.H2Connection.html#_stillProducing
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.web._http2.H2Connection._maxBufferedControlFrameBytes
  twisted.web._http2.H2Connection.html#_maxBufferedControlFrameBytes
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.web._http2.H2Connection._bufferedControlFrames
  twisted.web._http2.H2Connection.html#_bufferedControlFrames
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.web._http2.H2Connection._bufferedControlFrameBytes
  twisted.web._http2.H2Connection.html#_bufferedControlFrameBytes
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.web._http2.H2Connection._reactor
  twisted.web._http2.H2Connection.html#_reactor
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.web._http2.H2Connection.connectionMade
  twisted.web._http2.H2Connection.html#connectionMade
  Function
  Method
  PUBLIC
  Called by the reactor when a connection is received. May also be called by the `twisted.web.http._GenericHTTPChannelProtocol` during upgrade to HTTP/2.
- twisted.web._http2.H2Connection.dataReceived
  twisted.web._http2.H2Connection.html#dataReceived
  Function
  Method
  PUBLIC
  Called whenever a chunk of data is received from the transport.
- twisted.web._http2.H2Connection.timeoutConnection
  twisted.web._http2.H2Connection.html#timeoutConnection
  Function
  Method
  PUBLIC
  Called when the connection has been inactive for `self.timeOut` seconds. Cleanly tears the connection down, attempting to notify the peer if needed.
- twisted.web._http2.H2Connection.forceAbortClient
  twisted.web._http2.H2Connection.html#forceAbortClient
  Function
  Method
  PUBLIC
  Called if `abortTimeout` seconds have passed since the timeout fired, and the connection still hasn't gone away. This can really only happen on extremely bad connections or when clients are maliciously attempting to keep connections open.
- twisted.web._http2.H2Connection.connectionLost
  twisted.web._http2.H2Connection.html#connectionLost
  Function
  Method
  PUBLIC
  Called when the transport connection is lost.
- twisted.web._http2.H2Connection.stopProducing
  twisted.web._http2.H2Connection.html#stopProducing
  Function
  Method
  PUBLIC
  Stop producing data.
- twisted.web._http2.H2Connection.pauseProducing
  twisted.web._http2.H2Connection.html#pauseProducing
  Function
  Method
  PUBLIC
  Pause producing data.
- twisted.web._http2.H2Connection.resumeProducing
  twisted.web._http2.H2Connection.html#resumeProducing
  Function
  Method
  PUBLIC
  Resume producing data.
- twisted.web._http2.H2Connection._sendPrioritisedData
  twisted.web._http2.H2Connection.html#_sendPrioritisedData
  Function
  Method
  PRIVATE
  The data sending loop. This function repeatedly calls itself, either from `Deferred`s or from `reactor.callLater`
- twisted.web._http2.H2Connection._requestReceived
  twisted.web._http2.H2Connection.html#_requestReceived
  Function
  Method
  PRIVATE
  Internal handler for when a request has been received.
- twisted.web._http2.H2Connection._requestDataReceived
  twisted.web._http2.H2Connection.html#_requestDataReceived
  Function
  Method
  PRIVATE
  Internal handler for when a chunk of data is received for a given request.
- twisted.web._http2.H2Connection._requestEnded
  twisted.web._http2.H2Connection.html#_requestEnded
  Function
  Method
  PRIVATE
  Internal handler for when a request is complete, and we expect no further data for that request.
- twisted.web._http2.H2Connection._requestAborted
  twisted.web._http2.H2Connection.html#_requestAborted
  Function
  Method
  PRIVATE
  Internal handler for when a request is aborted by a remote peer.
- twisted.web._http2.H2Connection._handlePriorityUpdate
  twisted.web._http2.H2Connection.html#_handlePriorityUpdate
  Function
  Method
  PRIVATE
  Internal handler for when a stream priority is updated.
- twisted.web._http2.H2Connection.writeHeaders
  twisted.web._http2.H2Connection.html#writeHeaders
  Function
  Method
  PUBLIC
  Called by `twisted.web.http.Request` objects to write a complete set of HTTP headers to a stream.
- twisted.web._http2.H2Connection.writeDataToStream
  twisted.web._http2.H2Connection.html#writeDataToStream
  Function
  Method
  PUBLIC
  May be called by `H2Stream` objects to write response data to a given stream. Writes a single data frame.
- twisted.web._http2.H2Connection.endRequest
  twisted.web._http2.H2Connection.html#endRequest
  Function
  Method
  PUBLIC
  Called by `H2Stream` objects to signal completion of a response.
- twisted.web._http2.H2Connection.abortRequest
  twisted.web._http2.H2Connection.html#abortRequest
  Function
  Method
  PUBLIC
  Called by `H2Stream` objects to request early termination of a stream. This emits a RstStream frame and then removes all stream state.
- twisted.web._http2.H2Connection._requestDone
  twisted.web._http2.H2Connection.html#_requestDone
  Function
  Method
  PRIVATE
  Called internally by the data sending loop to clean up state that was being used for the stream. Called when the stream is complete.
- twisted.web._http2.H2Connection.remainingOutboundWindow
  twisted.web._http2.H2Connection.html#remainingOutboundWindow
  Function
  Method
  PUBLIC
  Called to determine how much room is left in the send window for a given stream. Allows us to handle blocking and unblocking producers.
- twisted.web._http2.H2Connection._handleWindowUpdate
  twisted.web._http2.H2Connection.html#_handleWindowUpdate
  Function
  Method
  PRIVATE
  Manage flow control windows.
- twisted.web._http2.H2Connection.getPeer
  twisted.web._http2.H2Connection.html#getPeer
  Function
  Method
  PUBLIC
  Get the remote address of this connection.
- twisted.web._http2.H2Connection.getHost
  twisted.web._http2.H2Connection.html#getHost
  Function
  Method
  PUBLIC
  Similar to getPeer, but returns an address describing this side of the connection.
- twisted.web._http2.H2Connection.openStreamWindow
  twisted.web._http2.H2Connection.html#openStreamWindow
  Function
  Method
  PUBLIC
  Open the stream window by a given increment.
- twisted.web._http2.H2Connection._isSecure
  twisted.web._http2.H2Connection.html#_isSecure
  Function
  Method
  PRIVATE
  Returns `True` if this channel is using a secure transport.
- twisted.web._http2.H2Connection._send100Continue
  twisted.web._http2.H2Connection.html#_send100Continue
  Function
  Method
  PRIVATE
  Sends a 100 Continue response, used to signal to clients that further processing will be performed.
- twisted.web._http2.H2Connection._respondToBadRequestAndDisconnect
  twisted.web._http2.H2Connection.html#_respondToBadRequestAndDisconnect
  Function
  Method
  PRIVATE
  This is a quick and dirty way of responding to bad requests.
- twisted.web._http2.H2Connection._streamIsActive
  twisted.web._http2.H2Connection.html#_streamIsActive
  Function
  Method
  PRIVATE
  Checks whether Twisted has still got state for a given stream and so can process events for that stream.
- twisted.web._http2.H2Connection._tryToWriteControlData
  twisted.web._http2.H2Connection.html#_tryToWriteControlData
  Function
  Method
  PRIVATE
  Checks whether the connection is blocked on flow control and, if it isn't, writes any buffered control data.
- twisted.web._http2.H2Connection._flushBufferedControlData
  twisted.web._http2.H2Connection.html#_flushBufferedControlData
  Function
  Method
  PRIVATE
  Called when the connection is marked writable again after being marked unwritable. Attempts to flush buffered control data if there is any.
- twisted.web._http2.H2Stream
  twisted.web._http2.H2Stream.html
  Class
  Class
  PUBLIC
  A class representing a single HTTP/2 stream.
- twisted.web._http2.H2Stream.streamID
  twisted.web._http2.H2Stream.html#streamID
  Attribute
  Instance Variable
  PUBLIC
  The numerical stream ID that this object corresponds to.
- twisted.web._http2.H2Stream.producing
  twisted.web._http2.H2Stream.html#producing
  Attribute
  Instance Variable
  PUBLIC
  Whether this stream is currently allowed to produce data to its consumer.
- twisted.web._http2.H2Stream.command
  twisted.web._http2.H2Stream.html#command
  Attribute
  Instance Variable
  PUBLIC
  The HTTP verb used on the request.
- twisted.web._http2.H2Stream.path
  twisted.web._http2.H2Stream.html#path
  Attribute
  Instance Variable
  PUBLIC
  The HTTP path used on the request.
- twisted.web._http2.H2Stream.producer
  twisted.web._http2.H2Stream.html#producer
  Attribute
  Instance Variable
  PUBLIC
  The object producing the response, if any.
- twisted.web._http2.H2Stream.site
  twisted.web._http2.H2Stream.html#site
  Attribute
  Instance Variable
  PUBLIC
  The `twisted.web.server.Site` object this stream belongs to, if any.
- twisted.web._http2.H2Stream.factory
  twisted.web._http2.H2Stream.html#factory
  Attribute
  Instance Variable
  PUBLIC
  The `twisted.web.http.HTTPFactory` object that constructed this stream's parent connection.
- twisted.web._http2.H2Stream._producerProducing
  twisted.web._http2.H2Stream.html#_producerProducing
  Attribute
  Instance Variable
  PRIVATE
  Whether the producer stored in producer is currently producing data.
- twisted.web._http2.H2Stream._inboundDataBuffer
  twisted.web._http2.H2Stream.html#_inboundDataBuffer
  Attribute
  Instance Variable
  PRIVATE
  Any data that has been received from the network but has not yet been received by the consumer.
- twisted.web._http2.H2Stream._conn
  twisted.web._http2.H2Stream.html#_conn
  Attribute
  Instance Variable
  PRIVATE
  A reference to the connection this stream belongs to.
- twisted.web._http2.H2Stream._request
  twisted.web._http2.H2Stream.html#_request
  Attribute
  Instance Variable
  PRIVATE
  A request object that this stream corresponds to.
- twisted.web._http2.H2Stream._buffer
  twisted.web._http2.H2Stream.html#_buffer
  Attribute
  Instance Variable
  PRIVATE
  A buffer containing data produced by the producer that could not be sent on the network at this time.
- twisted.web._http2.H2Stream.transport
  twisted.web._http2.H2Stream.html#transport
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.web._http2.H2Stream.__init__
  twisted.web._http2.H2Stream.html#__init__
  Function
  Method
  PUBLIC
  Initialize this HTTP/2 stream.
- twisted.web._http2.H2Stream._hasStreamingProducer
  twisted.web._http2.H2Stream.html#_hasStreamingProducer
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.web._http2.H2Stream._convertHeaders
  twisted.web._http2.H2Stream.html#_convertHeaders
  Function
  Method
  PRIVATE
  This method converts the HTTP/2 header set into something that looks like HTTP/1.1. In particular, it strips the 'special' headers and adds a Host: header.
- twisted.web._http2.H2Stream.receiveDataChunk
  twisted.web._http2.H2Stream.html#receiveDataChunk
  Function
  Method
  PUBLIC
  Called when the connection has received a chunk of data from the underlying transport. If the stream has been registered with a consumer, and is currently able to push data, immediately passes it through...
- twisted.web._http2.H2Stream.requestComplete
  twisted.web._http2.H2Stream.html#requestComplete
  Function
  Method
  PUBLIC
  Called by the `H2Connection` when the all data for a request has been received. Currently, with the legacy `twisted.web.http.Request` object, just calls requestReceived unless the producer wants us to be quiet.
- twisted.web._http2.H2Stream.connectionLost
  twisted.web._http2.H2Stream.html#connectionLost
  Function
  Method
  PUBLIC
  Called by the `H2Connection` when a connection is lost or a stream is reset.
- twisted.web._http2.H2Stream.windowUpdated
  twisted.web._http2.H2Stream.html#windowUpdated
  Function
  Method
  PUBLIC
  Called by the `H2Connection` when this stream's flow control window has been opened.
- twisted.web._http2.H2Stream.flowControlBlocked
  twisted.web._http2.H2Stream.html#flowControlBlocked
  Function
  Method
  PUBLIC
  Called by the `H2Connection` when this stream's flow control window has been exhausted.
- twisted.web._http2.H2Stream.writeHeaders
  twisted.web._http2.H2Stream.html#writeHeaders
  Function
  Method
  PUBLIC
  Called by the consumer to write headers to the stream.
- twisted.web._http2.H2Stream.requestDone
  twisted.web._http2.H2Stream.html#requestDone
  Function
  Method
  PUBLIC
  Called by a consumer to clean up whatever permanent state is in use.
- twisted.web._http2.H2Stream._send100Continue
  twisted.web._http2.H2Stream.html#_send100Continue
  Function
  Method
  PRIVATE
  Sends a 100 Continue response, used to signal to clients that further processing will be performed.
- twisted.web._http2.H2Stream._respondToBadRequestAndDisconnect
  twisted.web._http2.H2Stream.html#_respondToBadRequestAndDisconnect
  Function
  Method
  PRIVATE
  This is a quick and dirty way of responding to bad requests.
- twisted.web._http2.H2Stream.write
  twisted.web._http2.H2Stream.html#write
  Function
  Method
  PUBLIC
  Write a single chunk of data into a data frame.
- twisted.web._http2.H2Stream.writeSequence
  twisted.web._http2.H2Stream.html#writeSequence
  Function
  Method
  PUBLIC
  Write a sequence of chunks of data into data frames.
- twisted.web._http2.H2Stream.loseConnection
  twisted.web._http2.H2Stream.html#loseConnection
  Function
  Method
  PUBLIC
  Close the connection after writing all pending data.
- twisted.web._http2.H2Stream.abortConnection
  twisted.web._http2.H2Stream.html#abortConnection
  Function
  Method
  PUBLIC
  Forcefully abort the connection by sending a RstStream frame.
- twisted.web._http2.H2Stream.getPeer
  twisted.web._http2.H2Stream.html#getPeer
  Function
  Method
  PUBLIC
  Get information about the peer.
- twisted.web._http2.H2Stream.getHost
  twisted.web._http2.H2Stream.html#getHost
  Function
  Method
  PUBLIC
  Similar to getPeer, but for this side of the connection.
- twisted.web._http2.H2Stream.isSecure
  twisted.web._http2.H2Stream.html#isSecure
  Function
  Method
  PUBLIC
  Returns `True` if this channel is using a secure transport.
- twisted.web._http2.H2Stream.registerProducer
  twisted.web._http2.H2Stream.html#registerProducer
  Function
  Method
  PUBLIC
  Register to receive data from a producer.
- twisted.web._http2.H2Stream.hasStreamingProducer
  twisted.web._http2.H2Stream.html#hasStreamingProducer
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web._http2.H2Stream.unregisterProducer
  twisted.web._http2.H2Stream.html#unregisterProducer
  Function
  Method
  PUBLIC
  No summary
- twisted.web._http2.H2Stream.stopProducing
  twisted.web._http2.H2Stream.html#stopProducing
  Function
  Method
  PUBLIC
  No summary
- twisted.web._http2.H2Stream.pauseProducing
  twisted.web._http2.H2Stream.html#pauseProducing
  Function
  Method
  PUBLIC
  No summary
- twisted.web._http2.H2Stream.resumeProducing
  twisted.web._http2.H2Stream.html#resumeProducing
  Function
  Method
  PUBLIC
  No summary
- twisted.web._http2._addHeaderToRequest
  twisted.web._http2.html#_addHeaderToRequest
  Function
  Function
  PRIVATE
  Add a header tuple to a request header object.
- twisted.web.http.H2_ENABLED
  twisted.web.http.html#H2_ENABLED
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.web.http._REQUEST_TIMEOUT
  twisted.web.http.html#_REQUEST_TIMEOUT
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.web.http.protocol_version
  twisted.web.http.html#protocol_version
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.web.http.weekdayname
  twisted.web.http.html#weekdayname
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.web.http.monthname
  twisted.web.http.html#monthname
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.web.http.weekdayname_lower
  twisted.web.http.html#weekdayname_lower
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.web.http.monthname_lower
  twisted.web.http.html#monthname_lower
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.web.http._parseHeader
  twisted.web.http.html#_parseHeader
  Function
  Function
  PRIVATE
  Undocumented
- twisted.web.http.urlparse
  twisted.web.http.html#urlparse
  Function
  Function
  PUBLIC
  Parse an URL into six components.
- twisted.web.http.parse_qs
  twisted.web.http.html#parse_qs
  Function
  Function
  PUBLIC
  Like `cgi.parse_qs`, but with support for parsing byte strings on Python 3.
- twisted.web.http.datetimeToString
  twisted.web.http.html#datetimeToString
  Function
  Function
  PUBLIC
  Convert seconds since epoch to HTTP datetime string.
- twisted.web.http.datetimeToLogString
  twisted.web.http.html#datetimeToLogString
  Function
  Function
  PUBLIC
  Convert seconds since epoch to log datetime string.
- twisted.web.http.timegm
  twisted.web.http.html#timegm
  Function
  Function
  PUBLIC
  Convert time tuple in GMT to seconds since epoch, GMT
- twisted.web.http.stringToDatetime
  twisted.web.http.html#stringToDatetime
  Function
  Function
  PUBLIC
  Convert an HTTP date string (one of three formats) to seconds since epoch.
- twisted.web.http.toChunk
  twisted.web.http.html#toChunk
  Function
  Function
  PUBLIC
  Convert string to a chunk.
- twisted.web.http._ishexdigits
  twisted.web.http.html#_ishexdigits
  Function
  Function
  PRIVATE
  Is the string case-insensitively hexidecimal?
- twisted.web.http._hexint
  twisted.web.http.html#_hexint
  Function
  Function
  PRIVATE
  Decode a hexadecimal integer.
- twisted.web.http.fromChunk
  twisted.web.http.html#fromChunk
  Function
  Function
  PUBLIC
  Convert chunk to string.
- twisted.web.http.parseContentRange
  twisted.web.http.html#parseContentRange
  Function
  Function
  PUBLIC
  Parse a content-range header into (start, end, realLength).
- twisted.web.http._IDeprecatedHTTPChannelToRequestInterface
  twisted.web.http._IDeprecatedHTTPChannelToRequestInterface.html
  Class
  Interface
  PRIVATE
  The interface `HTTPChannel` expects of `Request`.
- twisted.web.http._IDeprecatedHTTPChannelToRequestInterface.requestHeaders
  twisted.web.http._IDeprecatedHTTPChannelToRequestInterface.html#requestHeaders
  Attribute
  Attribute
  PUBLIC
  A `http_headers.Headers` instance giving all received HTTP request headers.
- twisted.web.http._IDeprecatedHTTPChannelToRequestInterface.responseHeaders
  twisted.web.http._IDeprecatedHTTPChannelToRequestInterface.html#responseHeaders
  Attribute
  Attribute
  PUBLIC
  A `http_headers.Headers` instance holding all HTTP response headers to be sent.
- twisted.web.http._IDeprecatedHTTPChannelToRequestInterface.connectionLost
  twisted.web.http._IDeprecatedHTTPChannelToRequestInterface.html#connectionLost
  Function
  Method
  PUBLIC
  The underlying connection has been lost.
- twisted.web.http._IDeprecatedHTTPChannelToRequestInterface.gotLength
  twisted.web.http._IDeprecatedHTTPChannelToRequestInterface.html#gotLength
  Function
  Method
  PUBLIC
  Called when `HTTPChannel` has determined the length, if any, of the incoming request's body.
- twisted.web.http._IDeprecatedHTTPChannelToRequestInterface.handleContentChunk
  twisted.web.http._IDeprecatedHTTPChannelToRequestInterface.html#handleContentChunk
  Function
  Method
  PUBLIC
  Deliver a received chunk of body data to the request. Note this does not imply chunked transfer encoding.
- twisted.web.http._IDeprecatedHTTPChannelToRequestInterface.parseCookies
  twisted.web.http._IDeprecatedHTTPChannelToRequestInterface.html#parseCookies
  Function
  Method
  PUBLIC
  Parse the request's cookies out of received headers.
- twisted.web.http._IDeprecatedHTTPChannelToRequestInterface.requestReceived
  twisted.web.http._IDeprecatedHTTPChannelToRequestInterface.html#requestReceived
  Function
  Method
  PUBLIC
  Called when the entire request, including its body, has been received.
- twisted.web.http._IDeprecatedHTTPChannelToRequestInterface.__eq__
  twisted.web.http._IDeprecatedHTTPChannelToRequestInterface.html#__eq__
  Function
  Method
  PUBLIC
  Determines if two requests are the same object.
- twisted.web.http._IDeprecatedHTTPChannelToRequestInterface.__ne__
  twisted.web.http._IDeprecatedHTTPChannelToRequestInterface.html#__ne__
  Function
  Method
  PUBLIC
  Determines if two requests are not the same object.
- twisted.web.http._IDeprecatedHTTPChannelToRequestInterface.__hash__
  twisted.web.http._IDeprecatedHTTPChannelToRequestInterface.html#__hash__
  Function
  Method
  PUBLIC
  Generate a hash value for the request.
- twisted.web.http.StringTransport
  twisted.web.http.StringTransport.html
  Class
  Class
  PUBLIC
  I am a BytesIO wrapper that conforms for the transport API. I support the `writeSequence' method.
- twisted.web.http.StringTransport.__init__
  twisted.web.http.StringTransport.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.http.StringTransport.s
  twisted.web.http.StringTransport.html#s
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.http.StringTransport.writeSequence
  twisted.web.http.StringTransport.html#writeSequence
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.http.StringTransport.__getattr__
  twisted.web.http.StringTransport.html#__getattr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.http.HTTPClient
  twisted.web.http.HTTPClient.html
  Class
  Class
  PUBLIC
  A client for HTTP 1.0.
- twisted.web.http.HTTPClient.length
  twisted.web.http.HTTPClient.html#length
  Attribute
  Instance Variable
  PUBLIC
  The length of the request body in bytes.
- twisted.web.http.HTTPClient.firstLine
  twisted.web.http.HTTPClient.html#firstLine
  Attribute
  Instance Variable
  PUBLIC
  Are we waiting for the first header line?
- twisted.web.http.HTTPClient.__buffer
  twisted.web.http.HTTPClient.html#__buffer
  Attribute
  Instance Variable
  PRIVATE
  The buffer that stores the response to the HTTP request.
- twisted.web.http.HTTPClient._header
  twisted.web.http.HTTPClient.html#_header
  Attribute
  Instance Variable
  PRIVATE
  Part or all of an HTTP request header.
- twisted.web.http.HTTPClient.sendCommand
  twisted.web.http.HTTPClient.html#sendCommand
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.http.HTTPClient.sendHeader
  twisted.web.http.HTTPClient.html#sendHeader
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.http.HTTPClient.endHeaders
  twisted.web.http.HTTPClient.html#endHeaders
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.http.HTTPClient.extractHeader
  twisted.web.http.HTTPClient.html#extractHeader
  Function
  Method
  PUBLIC
  Given a complete HTTP header, extract the field name and value and process the header.
- twisted.web.http.HTTPClient.lineReceived
  twisted.web.http.HTTPClient.html#lineReceived
  Function
  Method
  PUBLIC
  Parse the status line and headers for an HTTP request.
- twisted.web.http.HTTPClient.connectionLost
  twisted.web.http.HTTPClient.html#connectionLost
  Function
  Method
  PUBLIC
  Called when the connection is shut down.
- twisted.web.http.HTTPClient.handleResponseEnd
  twisted.web.http.HTTPClient.html#handleResponseEnd
  Function
  Method
  PUBLIC
  The response has been completely received.
- twisted.web.http.HTTPClient.handleResponsePart
  twisted.web.http.HTTPClient.html#handleResponsePart
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.http.HTTPClient.connectionMade
  twisted.web.http.HTTPClient.html#connectionMade
  Function
  Method
  PUBLIC
  Called when a connection is made.
- twisted.web.http.HTTPClient.handleStatus
  twisted.web.http.HTTPClient.html#handleStatus
  Function
  Method
  PUBLIC
  Called when the status-line is received.
- twisted.web.http.HTTPClient.handleHeader
  twisted.web.http.HTTPClient.html#handleHeader
  Function
  Method
  PUBLIC
  Called every time a header is received.
- twisted.web.http.HTTPClient.handleEndHeaders
  twisted.web.http.HTTPClient.html#handleEndHeaders
  Function
  Method
  PUBLIC
  Called when all headers have been received.
- twisted.web.http.HTTPClient.rawDataReceived
  twisted.web.http.HTTPClient.html#rawDataReceived
  Function
  Method
  PUBLIC
  Override this for when raw data is received.
- twisted.web.http.NO_BODY_CODES
  twisted.web.http.html#NO_BODY_CODES
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.web.http._QUEUED_SENTINEL
  twisted.web.http.html#_QUEUED_SENTINEL
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.web.http._getContentFile
  twisted.web.http.html#_getContentFile
  Function
  Function
  PRIVATE
  Get a writeable file-like object to which request content can be written.
- twisted.web.http._hostHeaderExpression
  twisted.web.http.html#_hostHeaderExpression
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.web.http.Request
  twisted.web.http.Request.html
  Class
  Class
  PUBLIC
  A HTTP request.
- twisted.web.http.Request.method
  twisted.web.http.Request.html#method
  Attribute
  Instance Variable
  PUBLIC
  The HTTP method that was used, e.g. `b'GET'`.
- twisted.web.http.Request.uri
  twisted.web.http.Request.html#uri
  Attribute
  Instance Variable
  PUBLIC
  The full encoded URI which was requested (including query arguments), e.g. `b'/a/b%20/c?q=v'`.
- twisted.web.http.Request.path
  twisted.web.http.Request.html#path
  Attribute
  Instance Variable
  PUBLIC
  The encoded path of the request URI (not including query arguments), e.g. `b'/a/b%20/c'`.
- twisted.web.http.Request.args
  twisted.web.http.Request.html#args
  Attribute
  Instance Variable
  PUBLIC
  A mapping of decoded query argument names as `bytes` to corresponding query argument values as `list`s of `bytes`. For example, for a URI with `foo=bar&foo=baz&quux=spam` as its query part `args` will be `{b'foo': [b'bar', b'baz'], b'quux': [b'spam']}`...
- twisted.web.http.Request.content
  twisted.web.http.Request.html#content
  Attribute
  Instance Variable
  PUBLIC
  A file-like object giving the request body. This may be a file on disk, an `io.BytesIO`, or some other type. The implementation is free to decide on a per-request basis.
- twisted.web.http.Request.cookies
  twisted.web.http.Request.html#cookies
  Attribute
  Instance Variable
  PUBLIC
  The cookies that will be sent in the response.
- twisted.web.http.Request.requestHeaders
  twisted.web.http.Request.html#requestHeaders
  Attribute
  Instance Variable
  PUBLIC
  All received HTTP request headers.
- twisted.web.http.Request.responseHeaders
  twisted.web.http.Request.html#responseHeaders
  Attribute
  Instance Variable
  PUBLIC
  All HTTP response headers to be sent.
- twisted.web.http.Request.notifications
  twisted.web.http.Request.html#notifications
  Attribute
  Instance Variable
  PUBLIC
  A `list` of `Deferred`s which are waiting for notification that the response to this request has been finished (successfully or with an error). Don't use this attribute directly, instead use the `Request.notifyFinish`...
- twisted.web.http.Request._disconnected
  twisted.web.http.Request.html#_disconnected
  Attribute
  Instance Variable
  PRIVATE
  A flag which is `False` until the connection over which this request was received is closed and which is `True` after that.
- twisted.web.http.Request._log
  twisted.web.http.Request.html#_log
  Attribute
  Instance Variable
  PRIVATE
  A logger instance for request related messages.
- twisted.web.http.Request.producer
  twisted.web.http.Request.html#producer
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.http.Request.finished
  twisted.web.http.Request.html#finished
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.http.Request.code_message
  twisted.web.http.Request.html#code_message
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.http.Request.clientproto
  twisted.web.http.Request.html#clientproto
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.http.Request.startedWriting
  twisted.web.http.Request.html#startedWriting
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.http.Request.chunked
  twisted.web.http.Request.html#chunked
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.http.Request.sentLength
  twisted.web.http.Request.html#sentLength
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.http.Request.etag
  twisted.web.http.Request.html#etag
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.http.Request.lastModified
  twisted.web.http.Request.html#lastModified
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.http.Request._forceSSL
  twisted.web.http.Request.html#_forceSSL
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.web.http.Request.__init__
  twisted.web.http.Request.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.web.http.Request.channel
  twisted.web.http.Request.html#channel
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.http.Request.client
  twisted.web.http.Request.html#client
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.http.Request.host
  twisted.web.http.Request.html#host
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.http.Request.received_cookies
  twisted.web.http.Request.html#received_cookies
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.http.Request.transport
  twisted.web.http.Request.html#transport
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.http.Request.queued
  twisted.web.http.Request.html#queued
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.http.Request._cleanup
  twisted.web.http.Request.html#_cleanup
  Function
  Method
  PRIVATE
  Called when have finished responding and are no longer queued.
- twisted.web.http.Request.noLongerQueued
  twisted.web.http.Request.html#noLongerQueued
  Function
  Method
  PUBLIC
  Notify the object that it is no longer queued.
- twisted.web.http.Request.gotLength
  twisted.web.http.Request.html#gotLength
  Function
  Method
  PUBLIC
  Called when HTTP channel got length of content in this request.
- twisted.web.http.Request.parseCookies
  twisted.web.http.Request.html#parseCookies
  Function
  Method
  PUBLIC
  Parse cookie headers.
- twisted.web.http.Request.handleContentChunk
  twisted.web.http.Request.html#handleContentChunk
  Function
  Method
  PUBLIC
  Write a chunk of data.
- twisted.web.http.Request.requestReceived
  twisted.web.http.Request.html#requestReceived
  Function
  Method
  PUBLIC
  Called by channel when all data has been received.
- twisted.web.http.Request.__repr__
  twisted.web.http.Request.html#__repr__
  Function
  Method
  PUBLIC
  Return a string description of the request including such information as the request method and request URI.
- twisted.web.http.Request.process
  twisted.web.http.Request.html#process
  Function
  Method
  PUBLIC
  Override in subclasses.
- twisted.web.http.Request.registerProducer
  twisted.web.http.Request.html#registerProducer
  Function
  Method
  PUBLIC
  Register a producer.
- twisted.web.http.Request.streamingProducer
  twisted.web.http.Request.html#streamingProducer
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.http.Request.unregisterProducer
  twisted.web.http.Request.html#unregisterProducer
  Function
  Method
  PUBLIC
  Unregister the producer.
- twisted.web.http.Request.getHeader
  twisted.web.http.Request.html#getHeader
  Function
  Method
  PUBLIC
  Get an HTTP request header.
- twisted.web.http.Request.getCookie
  twisted.web.http.Request.html#getCookie
  Function
  Method
  PUBLIC
  Get a cookie that was sent from the network.
- twisted.web.http.Request.notifyFinish
  twisted.web.http.Request.html#notifyFinish
  Function
  Method
  PUBLIC
  Notify when the response to this request has finished.
- twisted.web.http.Request.finish
  twisted.web.http.Request.html#finish
  Function
  Method
  PUBLIC
  Indicate that all response data has been written to this `Request`.
- twisted.web.http.Request.write
  twisted.web.http.Request.html#write
  Function
  Method
  PUBLIC
  Write some data as a result of an HTTP request. The first time this is called, it writes out response data.
- twisted.web.http.Request.addCookie
  twisted.web.http.Request.html#addCookie
  Function
  Method
  PUBLIC
  Set an outgoing HTTP cookie.
- twisted.web.http.Request.setResponseCode
  twisted.web.http.Request.html#setResponseCode
  Function
  Method
  PUBLIC
  Set the HTTP response code.
- twisted.web.http.Request.code
  twisted.web.http.Request.html#code
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.http.Request.setHeader
  twisted.web.http.Request.html#setHeader
  Function
  Method
  PUBLIC
  Set an HTTP response header. Overrides any previously set values for this header.
- twisted.web.http.Request.redirect
  twisted.web.http.Request.html#redirect
  Function
  Method
  PUBLIC
  Utility function that does a redirect.
- twisted.web.http.Request.setLastModified
  twisted.web.http.Request.html#setLastModified
  Function
  Method
  PUBLIC
  Set the `Last-Modified` time for the response to this request.
- twisted.web.http.Request.setETag
  twisted.web.http.Request.html#setETag
  Function
  Method
  PUBLIC
  Set an `entity tag` for the outgoing response.
- twisted.web.http.Request.getAllHeaders
  twisted.web.http.Request.html#getAllHeaders
  Function
  Method
  PUBLIC
  Return dictionary mapping the names of all received headers to the last value received for each.
- twisted.web.http.Request.getRequestHostname
  twisted.web.http.Request.html#getRequestHostname
  Function
  Method
  PUBLIC
  Get the hostname that the HTTP client passed in to the request.
- twisted.web.http.Request.getHost
  twisted.web.http.Request.html#getHost
  Function
  Method
  PUBLIC
  Get my originally requesting transport's host.
- twisted.web.http.Request.setHost
  twisted.web.http.Request.html#setHost
  Function
  Method
  PUBLIC
  Change the host and port the request thinks it's using.
- twisted.web.http.Request.getClientIP
  twisted.web.http.Request.html#getClientIP
  Function
  Method
  PUBLIC
  Return the IP address of the client who submitted this request.
- twisted.web.http.Request.getClientAddress
  twisted.web.http.Request.html#getClientAddress
  Function
  Method
  PUBLIC
  Return the address of the client who submitted this request.
- twisted.web.http.Request.isSecure
  twisted.web.http.Request.html#isSecure
  Function
  Method
  PUBLIC
  Return `True` if this request is using a secure transport.
- twisted.web.http.Request._authorize
  twisted.web.http.Request.html#_authorize
  Function
  Method
  PRIVATE
  Undocumented
- twisted.web.http.Request.user
  twisted.web.http.Request.html#user
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.http.Request.password
  twisted.web.http.Request.html#password
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.http.Request.getUser
  twisted.web.http.Request.html#getUser
  Function
  Method
  PUBLIC
  Return the HTTP user sent with this request, if any.
- twisted.web.http.Request.getPassword
  twisted.web.http.Request.html#getPassword
  Function
  Method
  PUBLIC
  Return the HTTP password sent with this request, if any.
- twisted.web.http.Request.connectionLost
  twisted.web.http.Request.html#connectionLost
  Function
  Method
  PUBLIC
  There is no longer a connection for this request to respond over. Clean up anything which can't be useful anymore.
- twisted.web.http.Request.loseConnection
  twisted.web.http.Request.html#loseConnection
  Function
  Method
  PUBLIC
  Pass the loseConnection through to the underlying channel.
- twisted.web.http.Request.__eq__
  twisted.web.http.Request.html#__eq__
  Function
  Method
  PUBLIC
  Determines if two requests are the same object.
- twisted.web.http.Request.__hash__
  twisted.web.http.Request.html#__hash__
  Function
  Method
  PUBLIC
  A `Request` is hashable so that it can be used as a mapping key.
- twisted.web.http._DataLoss
  twisted.web.http._DataLoss.html
  Class
  Exception
  PRIVATE
  `_DataLoss` indicates that not all of a message body was received. This is only one of several possible exceptions which may indicate that data was lost. Because of this, it should not be checked for by specifically; any unexpected exception should be treated as having caused data loss.
- twisted.web.http.PotentialDataLoss
  twisted.web.http.PotentialDataLoss.html
  Class
  Exception
  PUBLIC
  `PotentialDataLoss` may be raised by a transfer encoding decoder's `noMoreData` method to indicate that it cannot be determined if the entire response body has been delivered. This only occurs when making requests to HTTP servers which do not set ...
- twisted.web.http._MalformedChunkedDataError
  twisted.web.http._MalformedChunkedDataError.html
  Class
  Exception
  PRIVATE
  `_ChunkedTransferDecoder` raises `_MalformedChunkedDataError` from its `dataReceived` method when it encounters malformed data. This exception indicates a client-side error. If this exception is raised, the connection should be dropped with a 400 error.
- twisted.web.http._IdentityTransferDecoder
  twisted.web.http._IdentityTransferDecoder.html
  Class
  Class
  PRIVATE
  Protocol for accumulating bytes up to a specified length. This handles the case where no Transfer-Encoding is specified.
- twisted.web.http._IdentityTransferDecoder.contentLength
  twisted.web.http._IdentityTransferDecoder.html#contentLength
  Attribute
  Instance Variable
  PUBLIC
  Counter keeping track of how many more bytes there are to receive.
- twisted.web.http._IdentityTransferDecoder.dataCallback
  twisted.web.http._IdentityTransferDecoder.html#dataCallback
  Attribute
  Instance Variable
  PUBLIC
  A one-argument callable which will be invoked each time application data is received.
- twisted.web.http._IdentityTransferDecoder.finishCallback
  twisted.web.http._IdentityTransferDecoder.html#finishCallback
  Attribute
  Instance Variable
  PUBLIC
  A one-argument callable which will be invoked when the terminal chunk is received. It will be invoked with all bytes which were delivered to this protocol which came after the terminal chunk.
- twisted.web.http._IdentityTransferDecoder.__init__
  twisted.web.http._IdentityTransferDecoder.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.http._IdentityTransferDecoder.dataReceived
  twisted.web.http._IdentityTransferDecoder.html#dataReceived
  Function
  Method
  PUBLIC
  Interpret the next chunk of bytes received. Either deliver them to the data callback or invoke the finish callback if enough bytes have been received.
- twisted.web.http._IdentityTransferDecoder.noMoreData
  twisted.web.http._IdentityTransferDecoder.html#noMoreData
  Function
  Method
  PUBLIC
  All data which will be delivered to this decoder has been. Check to make sure as much data as was expected has been received.
- twisted.web.http._chunkExtChars
  twisted.web.http.html#_chunkExtChars
  Attribute
  Variable
  PRIVATE
  Characters that are valid in a chunk extension.
- twisted.web.http._ChunkedTransferDecoder
  twisted.web.http._ChunkedTransferDecoder.html
  Class
  Class
  PRIVATE
  Protocol for decoding chunked Transfer-Encoding, as defined by RFC 7230, section 4.1. This protocol can interpret the contents of a request or response body which uses the chunked Transfer-Encoding. ...
- twisted.web.http._ChunkedTransferDecoder.dataCallback
  twisted.web.http._ChunkedTransferDecoder.html#dataCallback
  Attribute
  Instance Variable
  PUBLIC
  A one-argument callable which will be invoked each time application data is received. This callback is not reentrant.
- twisted.web.http._ChunkedTransferDecoder.finishCallback
  twisted.web.http._ChunkedTransferDecoder.html#finishCallback
  Attribute
  Instance Variable
  PUBLIC
  A one-argument callable which will be invoked when the terminal chunk is received. It will be invoked with all bytes which were delivered to this protocol which came after the terminal chunk.
- twisted.web.http._ChunkedTransferDecoder.length
  twisted.web.http._ChunkedTransferDecoder.html#length
  Attribute
  Instance Variable
  PUBLIC
  Counter keeping track of how many more bytes in a chunk there are to receive.
- twisted.web.http._ChunkedTransferDecoder.state
  twisted.web.http._ChunkedTransferDecoder.html#state
  Attribute
  Instance Variable
  PUBLIC
  One of `'CHUNK_LENGTH'`, `'CRLF'`, `'TRAILER'`, `'BODY'`, or `'FINISHED'`. For `'CHUNK_LENGTH'`, data for the chunk length line is currently being read. For `'CRLF'`, the CR LF pair which follows each chunk is being read...
- twisted.web.http._ChunkedTransferDecoder._buffer
  twisted.web.http._ChunkedTransferDecoder.html#_buffer
  Attribute
  Instance Variable
  PRIVATE
  Accumulated received data for the current state. At each state transition this is truncated at the front so that index 0 is where the next state shall begin.
- twisted.web.http._ChunkedTransferDecoder._start
  twisted.web.http._ChunkedTransferDecoder.html#_start
  Attribute
  Instance Variable
  PRIVATE
  While in the `'CHUNK_LENGTH'` state, tracks the index into the buffer at which search for CRLF should resume. Resuming the search at this position avoids doing quadratic work if the chunk length line arrives over many calls to ...
- twisted.web.http._ChunkedTransferDecoder.__init__
  twisted.web.http._ChunkedTransferDecoder.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.http._ChunkedTransferDecoder._trailerHeaders
  twisted.web.http._ChunkedTransferDecoder.html#_trailerHeaders
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.web.http._ChunkedTransferDecoder._maxTrailerHeadersSize
  twisted.web.http._ChunkedTransferDecoder.html#_maxTrailerHeadersSize
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.web.http._ChunkedTransferDecoder._receivedTrailerHeadersSize
  twisted.web.http._ChunkedTransferDecoder.html#_receivedTrailerHeadersSize
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.web.http._ChunkedTransferDecoder._dataReceived_CHUNK_LENGTH
  twisted.web.http._ChunkedTransferDecoder.html#_dataReceived_CHUNK_LENGTH
  Function
  Method
  PRIVATE
  Read the chunk size line, ignoring any extensions.
- twisted.web.http._ChunkedTransferDecoder._dataReceived_CRLF
  twisted.web.http._ChunkedTransferDecoder.html#_dataReceived_CRLF
  Function
  Method
  PRIVATE
  Await the carriage return and line feed characters that are the end of chunk marker that follow the chunk data.
- twisted.web.http._ChunkedTransferDecoder._dataReceived_TRAILER
  twisted.web.http._ChunkedTransferDecoder.html#_dataReceived_TRAILER
  Function
  Method
  PRIVATE
  Await the carriage return and line feed characters that follow the terminal zero-length chunk. Then invoke `finishCallback` and switch to state `'FINISHED'`.
- twisted.web.http._ChunkedTransferDecoder._dataReceived_BODY
  twisted.web.http._ChunkedTransferDecoder.html#_dataReceived_BODY
  Function
  Method
  PRIVATE
  Deliver any available chunk data to the `dataCallback`. When all the remaining data for the chunk arrives, switch to state `'CRLF'`.
- twisted.web.http._ChunkedTransferDecoder._dataReceived_FINISHED
  twisted.web.http._ChunkedTransferDecoder.html#_dataReceived_FINISHED
  Function
  Method
  PRIVATE
  Once `finishCallback` has been invoked receipt of additional data raises `RuntimeError` because it represents a programming error in the caller.
- twisted.web.http._ChunkedTransferDecoder.dataReceived
  twisted.web.http._ChunkedTransferDecoder.html#dataReceived
  Function
  Method
  PUBLIC
  Interpret data from a request or response body which uses the chunked Transfer-Encoding.
- twisted.web.http._ChunkedTransferDecoder.noMoreData
  twisted.web.http._ChunkedTransferDecoder.html#noMoreData
  Function
  Method
  PUBLIC
  Verify that all data has been received. If it has not been, raise `_DataLoss`.
- twisted.web.http._NoPushProducer
  twisted.web.http._NoPushProducer.html
  Class
  Class
  PRIVATE
  A no-op version of `interfaces.IPushProducer`, used to abstract over the possibility that a `HTTPChannel` transport does not provide `IPushProducer`.
- twisted.web.http._NoPushProducer.pauseProducing
  twisted.web.http._NoPushProducer.html#pauseProducing
  Function
  Method
  PUBLIC
  Pause producing data.
- twisted.web.http._NoPushProducer.resumeProducing
  twisted.web.http._NoPushProducer.html#resumeProducing
  Function
  Method
  PUBLIC
  Resume producing data.
- twisted.web.http._NoPushProducer.registerProducer
  twisted.web.http._NoPushProducer.html#registerProducer
  Function
  Method
  PUBLIC
  Register to receive data from a producer.
- twisted.web.http._NoPushProducer.unregisterProducer
  twisted.web.http._NoPushProducer.html#unregisterProducer
  Function
  Method
  PUBLIC
  Stop consuming data from a producer, without disconnecting.
- twisted.web.http._NoPushProducer.stopProducing
  twisted.web.http._NoPushProducer.html#stopProducing
  Function
  Method
  PUBLIC
  IProducer.stopProducing
- twisted.web.http.HTTPChannel
  twisted.web.http.HTTPChannel.html
  Class
  Class
  PUBLIC
  A receiver for HTTP requests.
- twisted.web.http.HTTPChannel.MAX_LENGTH
  twisted.web.http.HTTPChannel.html#MAX_LENGTH
  Attribute
  Instance Variable
  PUBLIC
  Maximum length for initial request line and each line from the header.
- twisted.web.http.HTTPChannel._transferDecoder
  twisted.web.http.HTTPChannel.html#_transferDecoder
  Attribute
  Instance Variable
  PRIVATE
  `None` or a decoder instance if the request body uses the chunked Transfer-Encoding.
- twisted.web.http.HTTPChannel.maxHeaders
  twisted.web.http.HTTPChannel.html#maxHeaders
  Attribute
  Instance Variable
  PUBLIC
  Maximum number of headers allowed per request.
- twisted.web.http.HTTPChannel.totalHeadersSize
  twisted.web.http.HTTPChannel.html#totalHeadersSize
  Attribute
  Instance Variable
  PUBLIC
  Maximum bytes for request line plus all headers from the request.
- twisted.web.http.HTTPChannel._receivedHeaderSize
  twisted.web.http.HTTPChannel.html#_receivedHeaderSize
  Attribute
  Instance Variable
  PRIVATE
  Bytes received so far for the header.
- twisted.web.http.HTTPChannel._handlingRequest
  twisted.web.http.HTTPChannel.html#_handlingRequest
  Attribute
  Instance Variable
  PRIVATE
  Whether a request is currently being processed.
- twisted.web.http.HTTPChannel._dataBuffer
  twisted.web.http.HTTPChannel.html#_dataBuffer
  Attribute
  Instance Variable
  PRIVATE
  Any data that has been received from the connection while processing an outstanding request.
- twisted.web.http.HTTPChannel._networkProducer
  twisted.web.http.HTTPChannel.html#_networkProducer
  Attribute
  Instance Variable
  PRIVATE
  Either the transport, if it provides `interfaces.IPushProducer`, or a null implementation of `interfaces.IPushProducer`. Used to attempt to prevent the transport from producing excess data when we're responding to a request.
- twisted.web.http.HTTPChannel._requestProducer
  twisted.web.http.HTTPChannel.html#_requestProducer
  Attribute
  Instance Variable
  PRIVATE
  If the `Request` object or anything it calls registers itself as an `interfaces.IProducer`, it will be stored here. This is used to create a producing pipeline: pause/resume producing methods will be propagated from the ...
- twisted.web.http.HTTPChannel._requestProducerStreaming
  twisted.web.http.HTTPChannel.html#_requestProducerStreaming
  Attribute
  Instance Variable
  PRIVATE
  A boolean that tracks whether the producer on the `Request` side of this channel has registered itself as a `interfaces.IPushProducer` or an `interfaces.IPullProducer`.
- twisted.web.http.HTTPChannel._waitingForTransport
  twisted.web.http.HTTPChannel.html#_waitingForTransport
  Attribute
  Instance Variable
  PRIVATE
  A boolean that tracks whether the transport has asked us to stop producing. This is used to keep track of what we're waiting for: if the transport has asked us to stop producing then we don't want to unpause the transport until it asks us to produce again.
- twisted.web.http.HTTPChannel.abortTimeout
  twisted.web.http.HTTPChannel.html#abortTimeout
  Attribute
  Instance Variable
  PUBLIC
  The number of seconds to wait after we attempt to shut the transport down cleanly to give up and forcibly terminate it. This is only used when we time a connection out, to prevent errors causing the FD to get leaked...
- twisted.web.http.HTTPChannel._abortingCall
  twisted.web.http.HTTPChannel.html#_abortingCall
  Attribute
  Instance Variable
  PRIVATE
  The `twisted.internet.base.DelayedCall` that will be used to forcibly close the transport if it doesn't close cleanly.
- twisted.web.http.HTTPChannel._optimisticEagerReadSize
  twisted.web.http.HTTPChannel.html#_optimisticEagerReadSize
  Attribute
  Instance Variable
  PRIVATE
  When a resource takes a long time to answer a request (via `twisted.web.server.NOT_DONE_YET`, hopefully one day by a `Deferred`), we would like to be able to let that resource know about the underlying transport disappearing as promptly as possible, via ...
- twisted.web.http.HTTPChannel.length
  twisted.web.http.HTTPChannel.html#length
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.http.HTTPChannel.persistent
  twisted.web.http.HTTPChannel.html#persistent
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.http.HTTPChannel.__header
  twisted.web.http.HTTPChannel.html#__header
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.web.http.HTTPChannel.__first_line
  twisted.web.http.HTTPChannel.html#__first_line
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.web.http.HTTPChannel.__content
  twisted.web.http.HTTPChannel.html#__content
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.web.http.HTTPChannel._savedTimeOut
  twisted.web.http.HTTPChannel.html#_savedTimeOut
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.web.http.HTTPChannel._receivedHeaderCount
  twisted.web.http.HTTPChannel.html#_receivedHeaderCount
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.web.http.HTTPChannel._log
  twisted.web.http.HTTPChannel.html#_log
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.web.http.HTTPChannel.__init__
  twisted.web.http.HTTPChannel.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.http.HTTPChannel.requests
  twisted.web.http.HTTPChannel.html#requests
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.http.HTTPChannel.connectionMade
  twisted.web.http.HTTPChannel.html#connectionMade
  Function
  Method
  PUBLIC
  Called when a connection is made.
- twisted.web.http.HTTPChannel.lineReceived
  twisted.web.http.HTTPChannel.html#lineReceived
  Function
  Method
  PUBLIC
  Called for each line from request until the end of headers when it enters binary mode.
- twisted.web.http.HTTPChannel._command
  twisted.web.http.HTTPChannel.html#_command
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.web.http.HTTPChannel._path
  twisted.web.http.HTTPChannel.html#_path
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.web.http.HTTPChannel._version
  twisted.web.http.HTTPChannel.html#_version
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.web.http.HTTPChannel._finishRequestBody
  twisted.web.http.HTTPChannel.html#_finishRequestBody
  Function
  Method
  PRIVATE
  Undocumented
- twisted.web.http.HTTPChannel._maybeChooseTransferDecoder
  twisted.web.http.HTTPChannel.html#_maybeChooseTransferDecoder
  Function
  Method
  PRIVATE
  If the provided header is `content-length` or `transfer-encoding`, choose the appropriate decoder if any.
- twisted.web.http.HTTPChannel.headerReceived
  twisted.web.http.HTTPChannel.html#headerReceived
  Function
  Method
  PUBLIC
  Do pre-processing (for content-length) and store this header away. Enforce the per-request header limit.
- twisted.web.http.HTTPChannel.allContentReceived
  twisted.web.http.HTTPChannel.html#allContentReceived
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.http.HTTPChannel.rawDataReceived
  twisted.web.http.HTTPChannel.html#rawDataReceived
  Function
  Method
  PUBLIC
  This is called when this HTTP/1.1 parser is in raw mode rather than line mode.
- twisted.web.http.HTTPChannel.allHeadersReceived
  twisted.web.http.HTTPChannel.html#allHeadersReceived
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.http.HTTPChannel.checkPersistence
  twisted.web.http.HTTPChannel.html#checkPersistence
  Function
  Method
  PUBLIC
  Check if the channel should close or not.
- twisted.web.http.HTTPChannel.requestDone
  twisted.web.http.HTTPChannel.html#requestDone
  Function
  Method
  PUBLIC
  Called by first request in queue when it is done.
- twisted.web.http.HTTPChannel.timeoutConnection
  twisted.web.http.HTTPChannel.html#timeoutConnection
  Function
  Method
  PUBLIC
  Called when the connection times out.
- twisted.web.http.HTTPChannel.forceAbortClient
  twisted.web.http.HTTPChannel.html#forceAbortClient
  Function
  Method
  PUBLIC
  Called if `abortTimeout` seconds have passed since the timeout fired, and the connection still hasn't gone away. This can really only happen on extremely bad connections or when clients are maliciously attempting to keep connections open.
- twisted.web.http.HTTPChannel.connectionLost
  twisted.web.http.HTTPChannel.html#connectionLost
  Function
  Method
  PUBLIC
  Called when the connection is shut down.
- twisted.web.http.HTTPChannel.isSecure
  twisted.web.http.HTTPChannel.html#isSecure
  Function
  Method
  PUBLIC
  Return `True` if this channel is using a secure transport.
- twisted.web.http.HTTPChannel.writeHeaders
  twisted.web.http.HTTPChannel.html#writeHeaders
  Function
  Method
  PUBLIC
  Called by `Request` objects to write a complete set of HTTP headers to a transport.
- twisted.web.http.HTTPChannel.write
  twisted.web.http.HTTPChannel.html#write
  Function
  Method
  PUBLIC
  Called by `Request` objects to write response data.
- twisted.web.http.HTTPChannel.writeSequence
  twisted.web.http.HTTPChannel.html#writeSequence
  Function
  Method
  PUBLIC
  Write a list of strings to the HTTP response.
- twisted.web.http.HTTPChannel.getPeer
  twisted.web.http.HTTPChannel.html#getPeer
  Function
  Method
  PUBLIC
  Get the remote address of this connection.
- twisted.web.http.HTTPChannel.getHost
  twisted.web.http.HTTPChannel.html#getHost
  Function
  Method
  PUBLIC
  Get the local address of this connection.
- twisted.web.http.HTTPChannel.loseConnection
  twisted.web.http.HTTPChannel.html#loseConnection
  Function
  Method
  PUBLIC
  Closes the connection. Will write any data that is pending to be sent on the network, but if this response has not yet been written to the network will not write anything.
- twisted.web.http.HTTPChannel.registerProducer
  twisted.web.http.HTTPChannel.html#registerProducer
  Function
  Method
  PUBLIC
  Register to receive data from a producer.
- twisted.web.http.HTTPChannel.unregisterProducer
  twisted.web.http.HTTPChannel.html#unregisterProducer
  Function
  Method
  PUBLIC
  Stop consuming data from a producer, without disconnecting.
- twisted.web.http.HTTPChannel.stopProducing
  twisted.web.http.HTTPChannel.html#stopProducing
  Function
  Method
  PUBLIC
  Stop producing data.
- twisted.web.http.HTTPChannel.pauseProducing
  twisted.web.http.HTTPChannel.html#pauseProducing
  Function
  Method
  PUBLIC
  Pause producing data.
- twisted.web.http.HTTPChannel.resumeProducing
  twisted.web.http.HTTPChannel.html#resumeProducing
  Function
  Method
  PUBLIC
  Resume producing data.
- twisted.web.http.HTTPChannel._send100Continue
  twisted.web.http.HTTPChannel.html#_send100Continue
  Function
  Method
  PRIVATE
  Sends a 100 Continue response, used to signal to clients that further processing will be performed.
- twisted.web.http.HTTPChannel._respondToBadRequestAndDisconnect
  twisted.web.http.HTTPChannel.html#_respondToBadRequestAndDisconnect
  Function
  Method
  PRIVATE
  This is a quick and dirty way of responding to bad requests.
- twisted.web.http._escape
  twisted.web.http.html#_escape
  Function
  Function
  PRIVATE
  Return a string like python repr, but always escaped as if surrounding quotes were double quotes.
- twisted.web.http.combinedLogFormatter
  twisted.web.http.html#combinedLogFormatter
  Function
  Function
  PUBLIC
  No summary
- twisted.web.http._XForwardedForAddress
  twisted.web.http._XForwardedForAddress.html
  Class
  Class
  PRIVATE
  `IAddress` which represents the client IP to log for a request, as gleaned from an X-Forwarded-For header.
- twisted.web.http._XForwardedForAddress.host
  twisted.web.http._XForwardedForAddress.html#host
  Attribute
  Instance Variable
  PUBLIC
  An IP address or `b"-"`.
- twisted.web.http._XForwardedForAddress.__init__
  twisted.web.http._XForwardedForAddress.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.http._XForwardedForRequest
  twisted.web.http._XForwardedForRequest.html
  Class
  Class
  PRIVATE
  Add a layer on top of another request that only uses the value of an X-Forwarded-For header as the result of `getClientAddress`.
- twisted.web.http._XForwardedForRequest.getClientAddress
  twisted.web.http._XForwardedForRequest.html#getClientAddress
  Function
  Method
  PUBLIC
  The client address (the first address) in the value of the X-Forwarded-For header. If the header is not present, the IP is considered to be `b"-"`.
- twisted.web.http._XForwardedForRequest.clientproto
  twisted.web.http._XForwardedForRequest.html#clientproto
  Attribute
  Property
  PUBLIC
  The protocol version in the request.
- twisted.web.http._XForwardedForRequest.code
  twisted.web.http._XForwardedForRequest.html#code
  Attribute
  Property
  PUBLIC
  The response code for the request.
- twisted.web.http._XForwardedForRequest.sentLength
  twisted.web.http._XForwardedForRequest.html#sentLength
  Attribute
  Property
  PUBLIC
  The number of bytes sent in the response body.
- twisted.web.http.proxiedLogFormatter
  twisted.web.http.html#proxiedLogFormatter
  Function
  Function
  PUBLIC
  No summary
- twisted.web.http._GenericHTTPChannelProtocol
  twisted.web.http._GenericHTTPChannelProtocol.html
  Class
  Class
  PRIVATE
  A proxy object that wraps one of the HTTP protocol objects, and switches between them depending on TLS negotiated protocol.
- twisted.web.http._GenericHTTPChannelProtocol._negotiatedProtocol
  twisted.web.http._GenericHTTPChannelProtocol.html#_negotiatedProtocol
  Attribute
  Instance Variable
  PRIVATE
  The protocol negotiated with ALPN or NPN, if any.
- twisted.web.http._GenericHTTPChannelProtocol._channel
  twisted.web.http._GenericHTTPChannelProtocol.html#_channel
  Attribute
  Instance Variable
  PRIVATE
  The object capable of behaving like a `HTTPChannel` that is backing this object. By default this is a `HTTPChannel`, but if a HTTP protocol upgrade takes place this may be a different channel object. Must implement ...
- twisted.web.http._GenericHTTPChannelProtocol._requestFactory
  twisted.web.http._GenericHTTPChannelProtocol.html#_requestFactory
  Attribute
  Instance Variable
  PRIVATE
  A callable to use to build `IRequest` objects.
- twisted.web.http._GenericHTTPChannelProtocol._site
  twisted.web.http._GenericHTTPChannelProtocol.html#_site
  Attribute
  Instance Variable
  PRIVATE
  A reference to the creating `twisted.web.server.Site` object.
- twisted.web.http._GenericHTTPChannelProtocol._factory
  twisted.web.http._GenericHTTPChannelProtocol.html#_factory
  Attribute
  Instance Variable
  PRIVATE
  A reference to the creating `HTTPFactory` object.
- twisted.web.http._GenericHTTPChannelProtocol._timeOut
  twisted.web.http._GenericHTTPChannelProtocol.html#_timeOut
  Attribute
  Instance Variable
  PRIVATE
  A timeout value to pass to the backing channel.
- twisted.web.http._GenericHTTPChannelProtocol._callLater
  twisted.web.http._GenericHTTPChannelProtocol.html#_callLater
  Attribute
  Instance Variable
  PRIVATE
  A value for the `callLater` callback.
- twisted.web.http._GenericHTTPChannelProtocol.factory
  twisted.web.http._GenericHTTPChannelProtocol.html#factory
  Attribute
  Property
  PUBLIC
  No summary
- twisted.web.http._GenericHTTPChannelProtocol.factory.setter
  twisted.web.http._GenericHTTPChannelProtocol.html#factory.setter
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.http._GenericHTTPChannelProtocol.requestFactory
  twisted.web.http._GenericHTTPChannelProtocol.html#requestFactory
  Attribute
  Property
  PUBLIC
  A callable to use to build `IRequest` objects.
- twisted.web.http._GenericHTTPChannelProtocol.requestFactory.setter
  twisted.web.http._GenericHTTPChannelProtocol.html#requestFactory.setter
  Function
  Method
  PUBLIC
  A callable to use to build `IRequest` objects.
- twisted.web.http._GenericHTTPChannelProtocol.site
  twisted.web.http._GenericHTTPChannelProtocol.html#site
  Attribute
  Property
  PUBLIC
  A reference to the creating `twisted.web.server.Site` object.
- twisted.web.http._GenericHTTPChannelProtocol.site.setter
  twisted.web.http._GenericHTTPChannelProtocol.html#site.setter
  Function
  Method
  PUBLIC
  A reference to the creating `twisted.web.server.Site` object.
- twisted.web.http._GenericHTTPChannelProtocol.timeOut
  twisted.web.http._GenericHTTPChannelProtocol.html#timeOut
  Attribute
  Property
  PUBLIC
  The idle timeout for the backing channel.
- twisted.web.http._GenericHTTPChannelProtocol.timeOut.setter
  twisted.web.http._GenericHTTPChannelProtocol.html#timeOut.setter
  Function
  Method
  PUBLIC
  The idle timeout for the backing channel.
- twisted.web.http._GenericHTTPChannelProtocol.callLater
  twisted.web.http._GenericHTTPChannelProtocol.html#callLater
  Attribute
  Property
  PUBLIC
  A value for the `callLater` callback. This callback is used by the `twisted.protocols.policies.TimeoutMixin` to handle timeouts.
- twisted.web.http._GenericHTTPChannelProtocol.callLater.setter
  twisted.web.http._GenericHTTPChannelProtocol.html#callLater.setter
  Function
  Method
  PUBLIC
  Sets the value for the `callLater` callback. This callback is used by the `twisted.protocols.policies.TimeoutMixin` to handle timeouts.
- twisted.web.http._GenericHTTPChannelProtocol.dataReceived
  twisted.web.http._GenericHTTPChannelProtocol.html#dataReceived
  Function
  Method
  PUBLIC
  An override of `IProtocol.dataReceived` that checks what protocol we're using.
- twisted.web.http._genericHTTPChannelProtocolFactory
  twisted.web.http.html#_genericHTTPChannelProtocolFactory
  Function
  Function
  PRIVATE
  Returns an appropriately initialized _GenericHTTPChannelProtocol.
- twisted.web.http.HTTPFactory
  twisted.web.http.HTTPFactory.html
  Class
  Class
  PUBLIC
  Factory for HTTP server.
- twisted.web.http.HTTPFactory._logDateTime
  twisted.web.http.HTTPFactory.html#_logDateTime
  Attribute
  Instance Variable
  PRIVATE
  A cached datetime string for log messages, updated by `_logDateTimeCall`.
- twisted.web.http.HTTPFactory._logDateTimeCall
  twisted.web.http.HTTPFactory.html#_logDateTimeCall
  Attribute
  Instance Variable
  PRIVATE
  A delayed call for the next update to the cached log datetime string.
- twisted.web.http.HTTPFactory._logFormatter
  twisted.web.http.HTTPFactory.html#_logFormatter
  Attribute
  Instance Variable
  PRIVATE
  See the `logFormatter` parameter to `__init__`
- twisted.web.http.HTTPFactory._nativeize
  twisted.web.http.HTTPFactory.html#_nativeize
  Attribute
  Instance Variable
  PRIVATE
  A flag that indicates whether the log file being written to wants native strings (`True`) or bytes (`False`). This is only to support writing to `twisted.python.log` which, unfortunately, works with native strings.
- twisted.web.http.HTTPFactory.reactor
  twisted.web.http.HTTPFactory.html#reactor
  Attribute
  Instance Variable
  PUBLIC
  An `IReactorTime` provider used to manage connection timeouts and compute logging timestamps.
- twisted.web.http.HTTPFactory.logPath
  twisted.web.http.HTTPFactory.html#logPath
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.http.HTTPFactory.__init__
  twisted.web.http.HTTPFactory.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.web.http.HTTPFactory.timeOut
  twisted.web.http.HTTPFactory.html#timeOut
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.http.HTTPFactory._updateLogDateTime
  twisted.web.http.HTTPFactory.html#_updateLogDateTime
  Function
  Method
  PRIVATE
  Update log datetime periodically, so we aren't always recalculating it.
- twisted.web.http.HTTPFactory.buildProtocol
  twisted.web.http.HTTPFactory.html#buildProtocol
  Function
  Method
  PUBLIC
  Create an instance of a subclass of Protocol.
- twisted.web.http.HTTPFactory.startFactory
  twisted.web.http.HTTPFactory.html#startFactory
  Function
  Method
  PUBLIC
  Set up request logging if necessary.
- twisted.web.http.HTTPFactory.logFile
  twisted.web.http.HTTPFactory.html#logFile
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.http.HTTPFactory.stopFactory
  twisted.web.http.HTTPFactory.html#stopFactory
  Function
  Method
  PUBLIC
  This will be called before I stop listening on all Ports/Connectors.
- twisted.web.http.HTTPFactory._openLogFile
  twisted.web.http.HTTPFactory.html#_openLogFile
  Function
  Method
  PRIVATE
  Override in subclasses, e.g. to use `twisted.python.logfile`.
- twisted.web.http.HTTPFactory.log
  twisted.web.http.HTTPFactory.html#log
  Function
  Method
  PUBLIC
  Write a line representing `request` to the access log file.
- twisted.protocols.shoutcast.ShoutcastClient
  twisted.protocols.shoutcast.ShoutcastClient.html
  Class
  Class
  PUBLIC
  Shoutcast HTTP stream.
- twisted.protocols.shoutcast.ShoutcastClient.userAgent
  twisted.protocols.shoutcast.ShoutcastClient.html#userAgent
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.protocols.shoutcast.ShoutcastClient.__init__
  twisted.protocols.shoutcast.ShoutcastClient.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.shoutcast.ShoutcastClient.path
  twisted.protocols.shoutcast.ShoutcastClient.html#path
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.shoutcast.ShoutcastClient.got_metadata
  twisted.protocols.shoutcast.ShoutcastClient.html#got_metadata
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.shoutcast.ShoutcastClient.metaint
  twisted.protocols.shoutcast.ShoutcastClient.html#metaint
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.shoutcast.ShoutcastClient.metamode
  twisted.protocols.shoutcast.ShoutcastClient.html#metamode
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.shoutcast.ShoutcastClient.databuffer
  twisted.protocols.shoutcast.ShoutcastClient.html#databuffer
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.shoutcast.ShoutcastClient.connectionMade
  twisted.protocols.shoutcast.ShoutcastClient.html#connectionMade
  Function
  Method
  PUBLIC
  Called when a connection is made.
- twisted.protocols.shoutcast.ShoutcastClient.lineReceived
  twisted.protocols.shoutcast.ShoutcastClient.html#lineReceived
  Function
  Method
  PUBLIC
  Parse the status line and headers for an HTTP request.
- twisted.protocols.shoutcast.ShoutcastClient.handleHeader
  twisted.protocols.shoutcast.ShoutcastClient.html#handleHeader
  Function
  Method
  PUBLIC
  Called every time a header is received.
- twisted.protocols.shoutcast.ShoutcastClient.handleEndHeaders
  twisted.protocols.shoutcast.ShoutcastClient.html#handleEndHeaders
  Function
  Method
  PUBLIC
  Called when all headers have been received.
- twisted.protocols.shoutcast.ShoutcastClient.handleResponsePart_with_metadata
  twisted.protocols.shoutcast.ShoutcastClient.html#handleResponsePart_with_metadata
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.shoutcast.ShoutcastClient.handle_length
  twisted.protocols.shoutcast.ShoutcastClient.html#handle_length
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.shoutcast.ShoutcastClient.remaining
  twisted.protocols.shoutcast.ShoutcastClient.html#remaining
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.shoutcast.ShoutcastClient.handle_mp3
  twisted.protocols.shoutcast.ShoutcastClient.html#handle_mp3
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.shoutcast.ShoutcastClient.handle_meta
  twisted.protocols.shoutcast.ShoutcastClient.html#handle_meta
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.shoutcast.ShoutcastClient.parseMetadata
  twisted.protocols.shoutcast.ShoutcastClient.html#parseMetadata
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.shoutcast.ShoutcastClient.gotMetaData
  twisted.protocols.shoutcast.ShoutcastClient.html#gotMetaData
  Function
  Method
  PUBLIC
  Called with a list of (key, value) pairs of metadata, if metadata is available on the server.
- twisted.protocols.shoutcast.ShoutcastClient.gotMP3Data
  twisted.protocols.shoutcast.ShoutcastClient.html#gotMP3Data
  Function
  Method
  PUBLIC
  Called with chunk of MP3 data.
- twisted.protocols.sip.PORT
  twisted.protocols.sip.html#PORT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.protocols.sip.shortHeaders
  twisted.protocols.sip.html#shortHeaders
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.protocols.sip.longHeaders
  twisted.protocols.sip.html#longHeaders
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.protocols.sip.statusCodes
  twisted.protocols.sip.html#statusCodes
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.protocols.sip.specialCases
  twisted.protocols.sip.html#specialCases
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.protocols.sip.dashCapitalize
  twisted.protocols.sip.html#dashCapitalize
  Function
  Function
  PUBLIC
  Capitalize a string, making sure to treat '-' as a word separator
- twisted.protocols.sip.unq
  twisted.protocols.sip.html#unq
  Function
  Function
  PUBLIC
  Undocumented
- twisted.protocols.sip._absent
  twisted.protocols.sip.html#_absent
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.protocols.sip.Via
  twisted.protocols.sip.Via.html
  Class
  Class
  PUBLIC
  A `Via` is a SIP Via header, representing a segment of the path taken by the request.
- twisted.protocols.sip.Via.transport
  twisted.protocols.sip.Via.html#transport
  Attribute
  Instance Variable
  PUBLIC
  Network protocol used for this leg. (Probably either "TCP" or "UDP".)
- twisted.protocols.sip.Via.branch
  twisted.protocols.sip.Via.html#branch
  Attribute
  Instance Variable
  PUBLIC
  Unique identifier for this request.
- twisted.protocols.sip.Via.host
  twisted.protocols.sip.Via.html#host
  Attribute
  Instance Variable
  PUBLIC
  Hostname or IP for this leg.
- twisted.protocols.sip.Via.port
  twisted.protocols.sip.Via.html#port
  Attribute
  Instance Variable
  PUBLIC
  Port used for this leg. @type port `int`, or None.
- twisted.protocols.sip.Via.rportRequested
  twisted.protocols.sip.Via.html#rportRequested
  Attribute
  Instance Variable
  PUBLIC
  Whether to request RFC 3581 client processing or not.
- twisted.protocols.sip.Via.rportValue
  twisted.protocols.sip.Via.html#rportValue
  Attribute
  Instance Variable
  PUBLIC
  Servers wishing to honor requests for RFC 3581 processing should set this parameter to the source port the request was received from.
- twisted.protocols.sip.Via.ttl
  twisted.protocols.sip.Via.html#ttl
  Attribute
  Instance Variable
  PUBLIC
  Time-to-live for requests on multicast paths.
- twisted.protocols.sip.Via.maddr
  twisted.protocols.sip.Via.html#maddr
  Attribute
  Instance Variable
  PUBLIC
  The destination multicast address, if any.
- twisted.protocols.sip.Via.hidden
  twisted.protocols.sip.Via.html#hidden
  Attribute
  Instance Variable
  PUBLIC
  Obsolete in SIP 2.0.
- twisted.protocols.sip.Via.otherParams
  twisted.protocols.sip.Via.html#otherParams
  Attribute
  Instance Variable
  PUBLIC
  Any other parameters in the header.
- twisted.protocols.sip.Via.__init__
  twisted.protocols.sip.Via.html#__init__
  Function
  Method
  PUBLIC
  Set parameters of this Via header. All arguments correspond to attributes of the same name.
- twisted.protocols.sip.Via.received
  twisted.protocols.sip.Via.html#received
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.sip.Via.rport
  twisted.protocols.sip.Via.html#rport
  Attribute
  Property
  PUBLIC
  Returns the rport value expected by the old SIP code.
- twisted.protocols.sip.Via.rport.setter
  twisted.protocols.sip.Via.html#rport.setter
  Function
  Method
  PUBLIC
  `Base._fixupNAT` sets `rport` directly, so this method sets `rportValue` based on that.
- twisted.protocols.sip.Via.toString
  twisted.protocols.sip.Via.html#toString
  Function
  Method
  PUBLIC
  Serialize this header for use in a request or response.
- twisted.protocols.sip.parseViaHeader
  twisted.protocols.sip.html#parseViaHeader
  Function
  Function
  PUBLIC
  Parse a Via header.
- twisted.protocols.sip.URL
  twisted.protocols.sip.URL.html
  Class
  Class
  PUBLIC
  A SIP URL.
- twisted.protocols.sip.URL.__init__
  twisted.protocols.sip.URL.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.sip.URL.username
  twisted.protocols.sip.URL.html#username
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.sip.URL.host
  twisted.protocols.sip.URL.html#host
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.sip.URL.password
  twisted.protocols.sip.URL.html#password
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.sip.URL.port
  twisted.protocols.sip.URL.html#port
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.sip.URL.transport
  twisted.protocols.sip.URL.html#transport
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.sip.URL.usertype
  twisted.protocols.sip.URL.html#usertype
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.sip.URL.method
  twisted.protocols.sip.URL.html#method
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.sip.URL.tag
  twisted.protocols.sip.URL.html#tag
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.sip.URL.ttl
  twisted.protocols.sip.URL.html#ttl
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.sip.URL.maddr
  twisted.protocols.sip.URL.html#maddr
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.sip.URL.other
  twisted.protocols.sip.URL.html#other
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.sip.URL.headers
  twisted.protocols.sip.URL.html#headers
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.sip.URL.toString
  twisted.protocols.sip.URL.html#toString
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.sip.URL.__str__
  twisted.protocols.sip.URL.html#__str__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.sip.URL.__repr__
  twisted.protocols.sip.URL.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.sip.parseURL
  twisted.protocols.sip.html#parseURL
  Function
  Function
  PUBLIC
  Return string into URL object.
- twisted.protocols.sip.cleanRequestURL
  twisted.protocols.sip.html#cleanRequestURL
  Function
  Function
  PUBLIC
  Clean a URL from a Request line.
- twisted.protocols.sip.parseAddress
  twisted.protocols.sip.html#parseAddress
  Function
  Function
  PUBLIC
  Return (name, uri, params) for From/To/Contact header.
- twisted.protocols.sip.SIPError
  twisted.protocols.sip.SIPError.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.protocols.sip.SIPError.__init__
  twisted.protocols.sip.SIPError.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.sip.SIPError.code
  twisted.protocols.sip.SIPError.html#code
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.sip.SIPError.phrase
  twisted.protocols.sip.SIPError.html#phrase
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.sip.RegistrationError
  twisted.protocols.sip.RegistrationError.html
  Class
  Exception
  PUBLIC
  Registration was not possible.
- twisted.protocols.sip.Message
  twisted.protocols.sip.Message.html
  Class
  Class
  PUBLIC
  A SIP message.
- twisted.protocols.sip.Message.length
  twisted.protocols.sip.Message.html#length
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.sip.Message.__init__
  twisted.protocols.sip.Message.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.sip.Message.headers
  twisted.protocols.sip.Message.html#headers
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.sip.Message.body
  twisted.protocols.sip.Message.html#body
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.sip.Message.finished
  twisted.protocols.sip.Message.html#finished
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.sip.Message.addHeader
  twisted.protocols.sip.Message.html#addHeader
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.sip.Message.bodyDataReceived
  twisted.protocols.sip.Message.html#bodyDataReceived
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.sip.Message.creationFinished
  twisted.protocols.sip.Message.html#creationFinished
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.sip.Message.toString
  twisted.protocols.sip.Message.html#toString
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.sip.Message._getHeaderLine
  twisted.protocols.sip.Message.html#_getHeaderLine
  Function
  Method
  PRIVATE
  Undocumented
- twisted.protocols.sip.Request
  twisted.protocols.sip.Request.html
  Class
  Class
  PUBLIC
  A Request for a URI
- twisted.protocols.sip.Request.__init__
  twisted.protocols.sip.Request.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.sip.Request.method
  twisted.protocols.sip.Request.html#method
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.sip.Request.uri
  twisted.protocols.sip.Request.html#uri
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.sip.Request.__repr__
  twisted.protocols.sip.Request.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.sip.Request._getHeaderLine
  twisted.protocols.sip.Request.html#_getHeaderLine
  Function
  Method
  PRIVATE
  Undocumented
- twisted.protocols.sip.Response
  twisted.protocols.sip.Response.html
  Class
  Class
  PUBLIC
  A Response to a URI Request
- twisted.protocols.sip.Response.__init__
  twisted.protocols.sip.Response.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.sip.Response.code
  twisted.protocols.sip.Response.html#code
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.sip.Response.phrase
  twisted.protocols.sip.Response.html#phrase
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.sip.Response.__repr__
  twisted.protocols.sip.Response.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.sip.Response._getHeaderLine
  twisted.protocols.sip.Response.html#_getHeaderLine
  Function
  Method
  PRIVATE
  Undocumented
- twisted.protocols.sip.MessagesParser
  twisted.protocols.sip.MessagesParser.html
  Class
  Class
  PUBLIC
  A SIP messages parser.
- twisted.protocols.sip.MessagesParser.version
  twisted.protocols.sip.MessagesParser.html#version
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.protocols.sip.MessagesParser.acceptResponses
  twisted.protocols.sip.MessagesParser.html#acceptResponses
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.protocols.sip.MessagesParser.acceptRequests
  twisted.protocols.sip.MessagesParser.html#acceptRequests
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.protocols.sip.MessagesParser.state
  twisted.protocols.sip.MessagesParser.html#state
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.sip.MessagesParser.debug
  twisted.protocols.sip.MessagesParser.html#debug
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.protocols.sip.MessagesParser.__init__
  twisted.protocols.sip.MessagesParser.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.sip.MessagesParser.messageReceived
  twisted.protocols.sip.MessagesParser.html#messageReceived
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.sip.MessagesParser.reset
  twisted.protocols.sip.MessagesParser.html#reset
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.sip.MessagesParser.length
  twisted.protocols.sip.MessagesParser.html#length
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.sip.MessagesParser.bodyReceived
  twisted.protocols.sip.MessagesParser.html#bodyReceived
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.sip.MessagesParser.message
  twisted.protocols.sip.MessagesParser.html#message
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.sip.MessagesParser.header
  twisted.protocols.sip.MessagesParser.html#header
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.sip.MessagesParser.invalidMessage
  twisted.protocols.sip.MessagesParser.html#invalidMessage
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.sip.MessagesParser.dataDone
  twisted.protocols.sip.MessagesParser.html#dataDone
  Function
  Method
  PUBLIC
  Clear out any buffered data that may be hanging around.
- twisted.protocols.sip.MessagesParser.dataReceived
  twisted.protocols.sip.MessagesParser.html#dataReceived
  Function
  Method
  PUBLIC
  Protocol.dataReceived. Translates bytes into lines, and calls lineReceived (or rawDataReceived, depending on mode.)
- twisted.protocols.sip.MessagesParser.handleFirstLine
  twisted.protocols.sip.MessagesParser.html#handleFirstLine
  Function
  Method
  PUBLIC
  Expected to create self.message.
- twisted.protocols.sip.MessagesParser.lineLengthExceeded
  twisted.protocols.sip.MessagesParser.html#lineLengthExceeded
  Function
  Method
  PUBLIC
  Called when the maximum line length has been reached. Override if it needs to be dealt with in some special way.
- twisted.protocols.sip.MessagesParser.lineReceived
  twisted.protocols.sip.MessagesParser.html#lineReceived
  Function
  Method
  PUBLIC
  Override this for when each line is received.
- twisted.protocols.sip.MessagesParser.messageDone
  twisted.protocols.sip.MessagesParser.html#messageDone
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.sip.MessagesParser.rawDataReceived
  twisted.protocols.sip.MessagesParser.html#rawDataReceived
  Function
  Method
  PUBLIC
  Override this for when raw data is received.
- twisted.protocols.sip.Base
  twisted.protocols.sip.Base.html
  Class
  Class
  PUBLIC
  Base class for SIP clients and servers.
- twisted.protocols.sip.Base.debug
  twisted.protocols.sip.Base.html#debug
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.protocols.sip.Base.__init__
  twisted.protocols.sip.Base.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.sip.Base.messages
  twisted.protocols.sip.Base.html#messages
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.sip.Base.parser
  twisted.protocols.sip.Base.html#parser
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.sip.Base.addMessage
  twisted.protocols.sip.Base.html#addMessage
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.sip.Base.datagramReceived
  twisted.protocols.sip.Base.html#datagramReceived
  Function
  Method
  PUBLIC
  Called when a datagram is received.
- twisted.protocols.sip.Base._fixupNAT
  twisted.protocols.sip.Base.html#_fixupNAT
  Function
  Method
  PRIVATE
  Undocumented
- twisted.protocols.sip.Base.deliverResponse
  twisted.protocols.sip.Base.html#deliverResponse
  Function
  Method
  PUBLIC
  Deliver response.
- twisted.protocols.sip.Base.responseFromRequest
  twisted.protocols.sip.Base.html#responseFromRequest
  Function
  Method
  PUBLIC
  Create a response to a request message.
- twisted.protocols.sip.Base.sendMessage
  twisted.protocols.sip.Base.html#sendMessage
  Function
  Method
  PUBLIC
  Send a message.
- twisted.protocols.sip.Base.handle_request
  twisted.protocols.sip.Base.html#handle_request
  Function
  Method
  PUBLIC
  Override to define behavior for requests received
- twisted.protocols.sip.Base.handle_response
  twisted.protocols.sip.Base.html#handle_response
  Function
  Method
  PUBLIC
  Override to define behavior for responses received.
- twisted.protocols.sip.IContact
  twisted.protocols.sip.IContact.html
  Class
  Interface
  PUBLIC
  A user of a registrar or proxy
- twisted.protocols.sip.Registration
  twisted.protocols.sip.Registration.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.protocols.sip.Registration.__init__
  twisted.protocols.sip.Registration.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.sip.Registration.secondsToExpiry
  twisted.protocols.sip.Registration.html#secondsToExpiry
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.sip.Registration.contactURL
  twisted.protocols.sip.Registration.html#contactURL
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.sip.IRegistry
  twisted.protocols.sip.IRegistry.html
  Class
  Interface
  PUBLIC
  Allows registration of logical->physical URL mapping.
- twisted.protocols.sip.IRegistry.registerAddress
  twisted.protocols.sip.IRegistry.html#registerAddress
  Function
  Method
  PUBLIC
  Register the physical address of a logical URL.
- twisted.protocols.sip.IRegistry.unregisterAddress
  twisted.protocols.sip.IRegistry.html#unregisterAddress
  Function
  Method
  PUBLIC
  Unregister the physical address of a logical URL.
- twisted.protocols.sip.IRegistry.getRegistrationInfo
  twisted.protocols.sip.IRegistry.html#getRegistrationInfo
  Function
  Method
  PUBLIC
  Get registration info for logical URL.
- twisted.protocols.sip.ILocator
  twisted.protocols.sip.ILocator.html
  Class
  Interface
  PUBLIC
  Allow looking up physical address for logical URL.
- twisted.protocols.sip.ILocator.getAddress
  twisted.protocols.sip.ILocator.html#getAddress
  Function
  Method
  PUBLIC
  Return physical URL of server for logical URL of user.
- twisted.protocols.sip.Proxy
  twisted.protocols.sip.Proxy.html
  Class
  Class
  PUBLIC
  SIP proxy.
- twisted.protocols.sip.Proxy.locator
  twisted.protocols.sip.Proxy.html#locator
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.protocols.sip.Proxy.__init__
  twisted.protocols.sip.Proxy.html#__init__
  Function
  Method
  PUBLIC
  Create new instance.
- twisted.protocols.sip.Proxy.host
  twisted.protocols.sip.Proxy.html#host
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.sip.Proxy.port
  twisted.protocols.sip.Proxy.html#port
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.sip.Proxy.getVia
  twisted.protocols.sip.Proxy.html#getVia
  Function
  Method
  PUBLIC
  Return value of Via header for this proxy.
- twisted.protocols.sip.Proxy.handle_request
  twisted.protocols.sip.Proxy.html#handle_request
  Function
  Method
  PUBLIC
  Override to define behavior for requests received
- twisted.protocols.sip.Proxy.handle_request_default
  twisted.protocols.sip.Proxy.html#handle_request_default
  Function
  Method
  PUBLIC
  Default request handler.
- twisted.protocols.sip.Proxy._cantForwardRequest
  twisted.protocols.sip.Proxy.html#_cantForwardRequest
  Function
  Method
  PRIVATE
  Undocumented
- twisted.protocols.sip.Proxy.deliverResponse
  twisted.protocols.sip.Proxy.html#deliverResponse
  Function
  Method
  PUBLIC
  Deliver response.
- twisted.protocols.sip.Proxy.responseFromRequest
  twisted.protocols.sip.Proxy.html#responseFromRequest
  Function
  Method
  PUBLIC
  Create a response to a request message.
- twisted.protocols.sip.Proxy.handle_response
  twisted.protocols.sip.Proxy.html#handle_response
  Function
  Method
  PUBLIC
  Default response handler.
- twisted.protocols.sip.Proxy.gotResponse
  twisted.protocols.sip.Proxy.html#gotResponse
  Function
  Method
  PUBLIC
  Called with responses that are addressed at this server.
- twisted.protocols.sip.IAuthorizer
  twisted.protocols.sip.IAuthorizer.html
  Class
  Interface
  PUBLIC
  No interface docstring; 2/2 methods documented
- twisted.protocols.sip.IAuthorizer.getChallenge
  twisted.protocols.sip.IAuthorizer.html#getChallenge
  Function
  Method
  PUBLIC
  Generate a challenge the client may respond to.
- twisted.protocols.sip.IAuthorizer.decode
  twisted.protocols.sip.IAuthorizer.html#decode
  Function
  Method
  PUBLIC
  Create a credentials object from the given response.
- twisted.protocols.sip.RegisterProxy
  twisted.protocols.sip.RegisterProxy.html
  Class
  Class
  PUBLIC
  A proxy that allows registration for a specific domain.
- twisted.protocols.sip.RegisterProxy.portal
  twisted.protocols.sip.RegisterProxy.html#portal
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.protocols.sip.RegisterProxy.registry
  twisted.protocols.sip.RegisterProxy.html#registry
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.protocols.sip.RegisterProxy.authorizers
  twisted.protocols.sip.RegisterProxy.html#authorizers
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.protocols.sip.RegisterProxy.__init__
  twisted.protocols.sip.RegisterProxy.html#__init__
  Function
  Method
  PUBLIC
  Create new instance.
- twisted.protocols.sip.RegisterProxy.liveChallenges
  twisted.protocols.sip.RegisterProxy.html#liveChallenges
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.sip.RegisterProxy.handle_ACK_request
  twisted.protocols.sip.RegisterProxy.html#handle_ACK_request
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.sip.RegisterProxy.handle_REGISTER_request
  twisted.protocols.sip.RegisterProxy.html#handle_REGISTER_request
  Function
  Method
  PUBLIC
  Handle a registration request.
- twisted.protocols.sip.RegisterProxy.unauthorized
  twisted.protocols.sip.RegisterProxy.html#unauthorized
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.sip.RegisterProxy.login
  twisted.protocols.sip.RegisterProxy.html#login
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.sip.RegisterProxy._cbLogin
  twisted.protocols.sip.RegisterProxy.html#_cbLogin
  Function
  Method
  PRIVATE
  Undocumented
- twisted.protocols.sip.RegisterProxy._ebLogin
  twisted.protocols.sip.RegisterProxy.html#_ebLogin
  Function
  Method
  PRIVATE
  Undocumented
- twisted.protocols.sip.RegisterProxy.register
  twisted.protocols.sip.RegisterProxy.html#register
  Function
  Method
  PUBLIC
  Allow all users to register
- twisted.protocols.sip.RegisterProxy._cbRegister
  twisted.protocols.sip.RegisterProxy.html#_cbRegister
  Function
  Method
  PRIVATE
  Undocumented
- twisted.protocols.sip.RegisterProxy._ebRegister
  twisted.protocols.sip.RegisterProxy.html#_ebRegister
  Function
  Method
  PRIVATE
  Undocumented
- twisted.protocols.sip.RegisterProxy.unregister
  twisted.protocols.sip.RegisterProxy.html#unregister
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.sip.RegisterProxy._cbUnregister
  twisted.protocols.sip.RegisterProxy.html#_cbUnregister
  Function
  Method
  PRIVATE
  Undocumented
- twisted.protocols.sip.RegisterProxy._ebUnregister
  twisted.protocols.sip.RegisterProxy.html#_ebUnregister
  Function
  Method
  PRIVATE
  Undocumented
- twisted.protocols.sip.InMemoryRegistry
  twisted.protocols.sip.InMemoryRegistry.html
  Class
  Class
  PUBLIC
  A simplistic registry for a specific domain.
- twisted.protocols.sip.InMemoryRegistry.__init__
  twisted.protocols.sip.InMemoryRegistry.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.sip.InMemoryRegistry.domain
  twisted.protocols.sip.InMemoryRegistry.html#domain
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.sip.InMemoryRegistry.users
  twisted.protocols.sip.InMemoryRegistry.html#users
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.sip.InMemoryRegistry.getAddress
  twisted.protocols.sip.InMemoryRegistry.html#getAddress
  Function
  Method
  PUBLIC
  Return physical URL of server for logical URL of user.
- twisted.protocols.sip.InMemoryRegistry.getRegistrationInfo
  twisted.protocols.sip.InMemoryRegistry.html#getRegistrationInfo
  Function
  Method
  PUBLIC
  Get registration info for logical URL.
- twisted.protocols.sip.InMemoryRegistry._expireRegistration
  twisted.protocols.sip.InMemoryRegistry.html#_expireRegistration
  Function
  Method
  PRIVATE
  Undocumented
- twisted.protocols.sip.InMemoryRegistry.registerAddress
  twisted.protocols.sip.InMemoryRegistry.html#registerAddress
  Function
  Method
  PUBLIC
  Register the physical address of a logical URL.
- twisted.protocols.sip.InMemoryRegistry.unregisterAddress
  twisted.protocols.sip.InMemoryRegistry.html#unregisterAddress
  Function
  Method
  PUBLIC
  Unregister the physical address of a logical URL.
- twisted.protocols.socks.SOCKSv4Outgoing
  twisted.protocols.socks.SOCKSv4Outgoing.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.protocols.socks.SOCKSv4Outgoing.__init__
  twisted.protocols.socks.SOCKSv4Outgoing.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.socks.SOCKSv4Outgoing.socks
  twisted.protocols.socks.SOCKSv4Outgoing.html#socks
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.socks.SOCKSv4Outgoing.connectionMade
  twisted.protocols.socks.SOCKSv4Outgoing.html#connectionMade
  Function
  Method
  PUBLIC
  Called when a connection is made.
- twisted.protocols.socks.SOCKSv4Outgoing.connectionLost
  twisted.protocols.socks.SOCKSv4Outgoing.html#connectionLost
  Function
  Method
  PUBLIC
  Called when the connection is shut down.
- twisted.protocols.socks.SOCKSv4Outgoing.dataReceived
  twisted.protocols.socks.SOCKSv4Outgoing.html#dataReceived
  Function
  Method
  PUBLIC
  Called whenever data is received.
- twisted.protocols.socks.SOCKSv4Outgoing.write
  twisted.protocols.socks.SOCKSv4Outgoing.html#write
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.socks.SOCKSv4Incoming
  twisted.protocols.socks.SOCKSv4Incoming.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.protocols.socks.SOCKSv4Incoming.__init__
  twisted.protocols.socks.SOCKSv4Incoming.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.socks.SOCKSv4Incoming.socks
  twisted.protocols.socks.SOCKSv4Incoming.html#socks
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.socks.SOCKSv4Incoming.connectionLost
  twisted.protocols.socks.SOCKSv4Incoming.html#connectionLost
  Function
  Method
  PUBLIC
  Called when the connection is shut down.
- twisted.protocols.socks.SOCKSv4Incoming.dataReceived
  twisted.protocols.socks.SOCKSv4Incoming.html#dataReceived
  Function
  Method
  PUBLIC
  Called whenever data is received.
- twisted.protocols.socks.SOCKSv4Incoming.write
  twisted.protocols.socks.SOCKSv4Incoming.html#write
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.socks.SOCKSv4
  twisted.protocols.socks.SOCKSv4.html
  Class
  Class
  PUBLIC
  An implementation of the SOCKSv4 protocol.
- twisted.protocols.socks.SOCKSv4.logging
  twisted.protocols.socks.SOCKSv4.html#logging
  Attribute
  Instance Variable
  PUBLIC
  If not `None`, the name of the logfile to which connection information will be written.
- twisted.protocols.socks.SOCKSv4.reactor
  twisted.protocols.socks.SOCKSv4.html#reactor
  Attribute
  Instance Variable
  PUBLIC
  The reactor used to create connections.
- twisted.protocols.socks.SOCKSv4.buf
  twisted.protocols.socks.SOCKSv4.html#buf
  Attribute
  Instance Variable
  PUBLIC
  Part of a SOCKSv4 connection request.
- twisted.protocols.socks.SOCKSv4.otherConn
  twisted.protocols.socks.SOCKSv4.html#otherConn
  Attribute
  Instance Variable
  PUBLIC
  Until the connection has been established, `otherConn` is `None`. After that, it is the proxy-to-destination protocol instance along which the client's connection is being forwarded.
- twisted.protocols.socks.SOCKSv4.__init__
  twisted.protocols.socks.SOCKSv4.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.socks.SOCKSv4.connectionMade
  twisted.protocols.socks.SOCKSv4.html#connectionMade
  Function
  Method
  PUBLIC
  Called when a connection is made.
- twisted.protocols.socks.SOCKSv4.dataReceived
  twisted.protocols.socks.SOCKSv4.html#dataReceived
  Function
  Method
  PUBLIC
  Called whenever data is received.
- twisted.protocols.socks.SOCKSv4._dataReceived2
  twisted.protocols.socks.SOCKSv4.html#_dataReceived2
  Function
  Method
  PRIVATE
  The second half of the SOCKS connection setup. For a SOCKSv4 packet this is after the server address has been extracted from the header. For a SOCKSv4a packet this is after the host name has been resolved.
- twisted.protocols.socks.SOCKSv4.connectionLost
  twisted.protocols.socks.SOCKSv4.html#connectionLost
  Function
  Method
  PUBLIC
  Called when the connection is shut down.
- twisted.protocols.socks.SOCKSv4.authorize
  twisted.protocols.socks.SOCKSv4.html#authorize
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.socks.SOCKSv4.connectClass
  twisted.protocols.socks.SOCKSv4.html#connectClass
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.socks.SOCKSv4.listenClass
  twisted.protocols.socks.SOCKSv4.html#listenClass
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.socks.SOCKSv4.makeReply
  twisted.protocols.socks.SOCKSv4.html#makeReply
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.socks.SOCKSv4.write
  twisted.protocols.socks.SOCKSv4.html#write
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.socks.SOCKSv4.log
  twisted.protocols.socks.SOCKSv4.html#log
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.socks.SOCKSv4Factory
  twisted.protocols.socks.SOCKSv4Factory.html
  Class
  Class
  PUBLIC
  A factory for a SOCKSv4 proxy.
- twisted.protocols.socks.SOCKSv4Factory.__init__
  twisted.protocols.socks.SOCKSv4Factory.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.socks.SOCKSv4Factory.logging
  twisted.protocols.socks.SOCKSv4Factory.html#logging
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.socks.SOCKSv4Factory.buildProtocol
  twisted.protocols.socks.SOCKSv4Factory.html#buildProtocol
  Function
  Method
  PUBLIC
  Create an instance of a subclass of Protocol.
- twisted.protocols.socks.SOCKSv4IncomingFactory
  twisted.protocols.socks.SOCKSv4IncomingFactory.html
  Class
  Class
  PUBLIC
  A utility class for building protocols for incoming connections.
- twisted.protocols.socks.SOCKSv4IncomingFactory.__init__
  twisted.protocols.socks.SOCKSv4IncomingFactory.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.socks.SOCKSv4IncomingFactory.socks
  twisted.protocols.socks.SOCKSv4IncomingFactory.html#socks
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.socks.SOCKSv4IncomingFactory.ip
  twisted.protocols.socks.SOCKSv4IncomingFactory.html#ip
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.protocols.socks.SOCKSv4IncomingFactory.buildProtocol
  twisted.protocols.socks.SOCKSv4IncomingFactory.html#buildProtocol
  Function
  Method
  PUBLIC
  Create an instance of a subclass of Protocol.
- twisted.protocols.stateful.StatefulProtocol
  twisted.protocols.stateful.StatefulProtocol.html
  Class
  Class
  PUBLIC
  A Protocol that stores state for you.
- twisted.protocols.stateful.StatefulProtocol._sful_data
  twisted.protocols.stateful.StatefulProtocol.html#_sful_data
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.protocols.stateful.StatefulProtocol.makeConnection
  twisted.protocols.stateful.StatefulProtocol.html#makeConnection
  Function
  Method
  PUBLIC
  Make a connection to a transport and a server.
- twisted.protocols.stateful.StatefulProtocol.getInitialState
  twisted.protocols.stateful.StatefulProtocol.html#getInitialState
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.stateful.StatefulProtocol.dataReceived
  twisted.protocols.stateful.StatefulProtocol.html#dataReceived
  Function
  Method
  PUBLIC
  Called whenever data is received.
- twisted.protocols.wire.Echo
  twisted.protocols.wire.Echo.html
  Class
  Class
  PUBLIC
  As soon as any data is received, write it back (RFC 862).
- twisted.protocols.wire.Echo.dataReceived
  twisted.protocols.wire.Echo.html#dataReceived
  Function
  Method
  PUBLIC
  Called whenever data is received.
- twisted.protocols.wire.Discard
  twisted.protocols.wire.Discard.html
  Class
  Class
  PUBLIC
  Discard any received data (RFC 863).
- twisted.protocols.wire.Discard.dataReceived
  twisted.protocols.wire.Discard.html#dataReceived
  Function
  Method
  PUBLIC
  Called whenever data is received.
- twisted.protocols.wire.Chargen
  twisted.protocols.wire.Chargen.html
  Class
  Class
  PUBLIC
  Generate repeating noise (RFC 864).
- twisted.protocols.wire.Chargen.noise
  twisted.protocols.wire.Chargen.html#noise
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.protocols.wire.Chargen.connectionMade
  twisted.protocols.wire.Chargen.html#connectionMade
  Function
  Method
  PUBLIC
  Called when a connection is made.
- twisted.protocols.wire.Chargen.resumeProducing
  twisted.protocols.wire.Chargen.html#resumeProducing
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.wire.Chargen.pauseProducing
  twisted.protocols.wire.Chargen.html#pauseProducing
  Function
  Method
  PUBLIC
  Undocumented
- twisted.protocols.wire.Chargen.stopProducing
  twisted.protocols.wire.Chargen.html#stopProducing
  Function
  Method
  PUBLIC
  Stop producing data.
- twisted.protocols.wire.QOTD
  twisted.protocols.wire.QOTD.html
  Class
  Class
  PUBLIC
  Return a quote of the day (RFC 865).
- twisted.protocols.wire.QOTD.connectionMade
  twisted.protocols.wire.QOTD.html#connectionMade
  Function
  Method
  PUBLIC
  Called when a connection is made.
- twisted.protocols.wire.QOTD.getQuote
  twisted.protocols.wire.QOTD.html#getQuote
  Function
  Method
  PUBLIC
  Return a quote. May be overrriden in subclasses.
- twisted.protocols.wire.Who
  twisted.protocols.wire.Who.html
  Class
  Class
  PUBLIC
  Return list of active users (RFC 866)
- twisted.protocols.wire.Who.connectionMade
  twisted.protocols.wire.Who.html#connectionMade
  Function
  Method
  PUBLIC
  Called when a connection is made.
- twisted.protocols.wire.Who.getUsers
  twisted.protocols.wire.Who.html#getUsers
  Function
  Method
  PUBLIC
  Return active users. Override in subclasses.
- twisted.protocols.wire.Daytime
  twisted.protocols.wire.Daytime.html
  Class
  Class
  PUBLIC
  Send back the daytime in ASCII form (RFC 867).
- twisted.protocols.wire.Daytime.connectionMade
  twisted.protocols.wire.Daytime.html#connectionMade
  Function
  Method
  PUBLIC
  Called when a connection is made.
- twisted.protocols.wire.Time
  twisted.protocols.wire.Time.html
  Class
  Class
  PUBLIC
  Send back the time in machine readable form (RFC 868).
- twisted.protocols.wire.Time.connectionMade
  twisted.protocols.wire.Time.html#connectionMade
  Function
  Method
  PUBLIC
  Called when a connection is made.
- twisted.python._appdirs.getDataDirectory
  twisted.python._appdirs.html#getDataDirectory
  Function
  Function
  PUBLIC
  Get a data directory for the caller function, or `moduleName` if given.
- twisted.python._release.NEWSFRAGMENT_TYPES
  twisted.python._release.html#NEWSFRAGMENT_TYPES
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.python._release.intersphinxURLs
  twisted.python._release.html#intersphinxURLs
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.python._release.runCommand
  twisted.python._release.html#runCommand
  Function
  Function
  PUBLIC
  Execute a vector of arguments.
- twisted.python._release.IVCSCommand
  twisted.python._release.IVCSCommand.html
  Class
  Interface
  PUBLIC
  An interface for VCS commands.
- twisted.python._release.IVCSCommand.ensureIsWorkingDirectory
  twisted.python._release.IVCSCommand.html#ensureIsWorkingDirectory
  Function
  Method
  PUBLIC
  Ensure that `path` is a working directory of this VCS.
- twisted.python._release.IVCSCommand.isStatusClean
  twisted.python._release.IVCSCommand.html#isStatusClean
  Function
  Method
  PUBLIC
  Return the Git status of the files in the specified path.
- twisted.python._release.IVCSCommand.remove
  twisted.python._release.IVCSCommand.html#remove
  Function
  Method
  PUBLIC
  Remove the specified path from a the VCS.
- twisted.python._release.IVCSCommand.exportTo
  twisted.python._release.IVCSCommand.html#exportTo
  Function
  Method
  PUBLIC
  Export the content of the VCSrepository to the specified directory.
- twisted.python._release.GitCommand
  twisted.python._release.GitCommand.html
  Class
  Class
  PUBLIC
  Subset of Git commands to release Twisted from a Git repository.
- twisted.python._release.GitCommand.ensureIsWorkingDirectory
  twisted.python._release.GitCommand.html#ensureIsWorkingDirectory
  Function
  Static Method
  PUBLIC
  Ensure that `path` is a Git working directory.
- twisted.python._release.GitCommand.isStatusClean
  twisted.python._release.GitCommand.html#isStatusClean
  Function
  Static Method
  PUBLIC
  Return the Git status of the files in the specified path.
- twisted.python._release.GitCommand.remove
  twisted.python._release.GitCommand.html#remove
  Function
  Static Method
  PUBLIC
  Remove the specified path from a Git repository.
- twisted.python._release.GitCommand.exportTo
  twisted.python._release.GitCommand.html#exportTo
  Function
  Static Method
  PUBLIC
  Export the content of a Git repository to the specified directory.
- twisted.python._release.getRepositoryCommand
  twisted.python._release.html#getRepositoryCommand
  Function
  Function
  PUBLIC
  Detect the VCS used in the specified directory and return a `GitCommand` if the directory is a Git repository. If the directory is not git, it raises a `NotWorkingDirectory` exception.
- twisted.python._release.Project
  twisted.python._release.Project.html
  Class
  Class
  PUBLIC
  A representation of a project that has a version.
- twisted.python._release.Project.directory
  twisted.python._release.Project.html#directory
  Attribute
  Instance Variable
  PUBLIC
  A `twisted.python.filepath.FilePath` pointing to the base directory of a Twisted-style Python package. The package should contain a `_version.py` file and a `newsfragments` directory that contains a `README` file.
- twisted.python._release.Project.__init__
  twisted.python._release.Project.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python._release.Project.__repr__
  twisted.python._release.Project.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python._release.Project.getVersion
  twisted.python._release.Project.html#getVersion
  Function
  Method
  PUBLIC
  No summary
- twisted.python._release.findTwistedProjects
  twisted.python._release.html#findTwistedProjects
  Function
  Function
  PUBLIC
  Find all Twisted-style projects beneath a base directory.
- twisted.python._release.replaceInFile
  twisted.python._release.html#replaceInFile
  Function
  Function
  PUBLIC
  I replace the text `oldstr' with `newstr' in `filename' using science.
- twisted.python._release.NoDocumentsFound
  twisted.python._release.NoDocumentsFound.html
  Class
  Exception
  PUBLIC
  Raised when no input documents are found.
- twisted.python._release.SphinxBuilder
  twisted.python._release.SphinxBuilder.html
  Class
  Class
  PUBLIC
  Generate HTML documentation using Sphinx.
- twisted.python._release.SphinxBuilder.main
  twisted.python._release.SphinxBuilder.html#main
  Function
  Method
  PUBLIC
  Build the main documentation.
- twisted.python._release.SphinxBuilder.build
  twisted.python._release.SphinxBuilder.html#build
  Function
  Method
  PUBLIC
  Build the documentation in `docDir` with Sphinx.
- twisted.python._release.filePathDelta
  twisted.python._release.html#filePathDelta
  Function
  Function
  PUBLIC
  Return a list of strings that represent `destination` as a path relative to `origin`.
- twisted.python._release.NotWorkingDirectory
  twisted.python._release.NotWorkingDirectory.html
  Class
  Exception
  PUBLIC
  Raised when a directory does not appear to be a repository directory of a supported VCS.
- twisted.python._release.CheckNewsfragmentScript
  twisted.python._release.CheckNewsfragmentScript.html
  Class
  Class
  PUBLIC
  A thing for checking whether a checkout has a newsfragment.
- twisted.python._release.CheckNewsfragmentScript.__init__
  twisted.python._release.CheckNewsfragmentScript.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python._release.CheckNewsfragmentScript._print
  twisted.python._release.CheckNewsfragmentScript.html#_print
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.python._release.CheckNewsfragmentScript.main
  twisted.python._release.CheckNewsfragmentScript.html#main
  Function
  Method
  PUBLIC
  Run the script.
- twisted.python.formmethod.FormException
  twisted.python.formmethod.FormException.html
  Class
  Exception
  PUBLIC
  An error occurred calling the form method.
- twisted.python.formmethod.FormException.__init__
  twisted.python.formmethod.FormException.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.formmethod.FormException.descriptions
  twisted.python.formmethod.FormException.html#descriptions
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.formmethod.InputError
  twisted.python.formmethod.InputError.html
  Class
  Exception
  PUBLIC
  An error occurred with some input.
- twisted.python.formmethod.Argument
  twisted.python.formmethod.Argument.html
  Class
  Class
  PUBLIC
  Base class for form arguments.
- twisted.python.formmethod.Argument.defaultDefault
  twisted.python.formmethod.Argument.html#defaultDefault
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.python.formmethod.Argument.__init__
  twisted.python.formmethod.Argument.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.formmethod.Argument.name
  twisted.python.formmethod.Argument.html#name
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.formmethod.Argument.allowNone
  twisted.python.formmethod.Argument.html#allowNone
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.formmethod.Argument.default
  twisted.python.formmethod.Argument.html#default
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.formmethod.Argument.shortDesc
  twisted.python.formmethod.Argument.html#shortDesc
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.formmethod.Argument.longDesc
  twisted.python.formmethod.Argument.html#longDesc
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.formmethod.Argument.hints
  twisted.python.formmethod.Argument.html#hints
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.formmethod.Argument.addHints
  twisted.python.formmethod.Argument.html#addHints
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.formmethod.Argument.getHint
  twisted.python.formmethod.Argument.html#getHint
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.formmethod.Argument.getShortDescription
  twisted.python.formmethod.Argument.html#getShortDescription
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.formmethod.Argument.getLongDescription
  twisted.python.formmethod.Argument.html#getLongDescription
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.formmethod.Argument.coerce
  twisted.python.formmethod.Argument.html#coerce
  Function
  Method
  PUBLIC
  Convert the value to the correct format.
- twisted.python.formmethod.String
  twisted.python.formmethod.String.html
  Class
  Class
  PUBLIC
  A single string.
- twisted.python.formmethod.String.defaultDefault
  twisted.python.formmethod.String.html#defaultDefault
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.python.formmethod.String.min
  twisted.python.formmethod.String.html#min
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.formmethod.String.max
  twisted.python.formmethod.String.html#max
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.formmethod.String.__init__
  twisted.python.formmethod.String.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.formmethod.String.coerce
  twisted.python.formmethod.String.html#coerce
  Function
  Method
  PUBLIC
  Convert the value to the correct format.
- twisted.python.formmethod.Text
  twisted.python.formmethod.Text.html
  Class
  Class
  PUBLIC
  A long string.
- twisted.python.formmethod.Password
  twisted.python.formmethod.Password.html
  Class
  Class
  PUBLIC
  A string which should be obscured when input.
- twisted.python.formmethod.VerifiedPassword
  twisted.python.formmethod.VerifiedPassword.html
  Class
  Class
  PUBLIC
  A string that should be obscured when input and needs verification.
- twisted.python.formmethod.VerifiedPassword.coerce
  twisted.python.formmethod.VerifiedPassword.html#coerce
  Function
  Method
  PUBLIC
  Convert the value to the correct format.
- twisted.python.formmethod.Hidden
  twisted.python.formmethod.Hidden.html
  Class
  Class
  PUBLIC
  A string which is not displayed.
- twisted.python.formmethod.Integer
  twisted.python.formmethod.Integer.html
  Class
  Class
  PUBLIC
  A single integer.
- twisted.python.formmethod.Integer.defaultDefault
  twisted.python.formmethod.Integer.html#defaultDefault
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.python.formmethod.Integer.__init__
  twisted.python.formmethod.Integer.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.formmethod.Integer.coerce
  twisted.python.formmethod.Integer.html#coerce
  Function
  Method
  PUBLIC
  Convert the value to the correct format.
- twisted.python.formmethod.IntegerRange
  twisted.python.formmethod.IntegerRange.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.python.formmethod.IntegerRange.__init__
  twisted.python.formmethod.IntegerRange.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.formmethod.IntegerRange.min
  twisted.python.formmethod.IntegerRange.html#min
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.formmethod.IntegerRange.max
  twisted.python.formmethod.IntegerRange.html#max
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.formmethod.IntegerRange.coerce
  twisted.python.formmethod.IntegerRange.html#coerce
  Function
  Method
  PUBLIC
  Convert the value to the correct format.
- twisted.python.formmethod.Float
  twisted.python.formmethod.Float.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.python.formmethod.Float.defaultDefault
  twisted.python.formmethod.Float.html#defaultDefault
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.python.formmethod.Float.__init__
  twisted.python.formmethod.Float.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.formmethod.Float.coerce
  twisted.python.formmethod.Float.html#coerce
  Function
  Method
  PUBLIC
  Convert the value to the correct format.
- twisted.python.formmethod.Choice
  twisted.python.formmethod.Choice.html
  Class
  Class
  PUBLIC
  The result of a choice between enumerated types. The choices should be a list of tuples of tag, value, and description. The tag will be the value returned if the user hits "Submit", and the description is the bale for the enumerated type...
- twisted.python.formmethod.Choice.__init__
  twisted.python.formmethod.Choice.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.formmethod.Choice.choices
  twisted.python.formmethod.Choice.html#choices
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.formmethod.Choice.coerce
  twisted.python.formmethod.Choice.html#coerce
  Function
  Method
  PUBLIC
  Convert the value to the correct format.
- twisted.python.formmethod.Flags
  twisted.python.formmethod.Flags.html
  Class
  Class
  PUBLIC
  The result of a checkbox group or multi-menu. The flags should be a list of tuples of tag, value, and description. The tag will be the value returned if the user hits "Submit", and the description is the bale for the enumerated type...
- twisted.python.formmethod.Flags.__init__
  twisted.python.formmethod.Flags.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.formmethod.Flags.flags
  twisted.python.formmethod.Flags.html#flags
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.formmethod.Flags.coerce
  twisted.python.formmethod.Flags.html#coerce
  Function
  Method
  PUBLIC
  Convert the value to the correct format.
- twisted.python.formmethod.CheckGroup
  twisted.python.formmethod.CheckGroup.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.python.formmethod.RadioGroup
  twisted.python.formmethod.RadioGroup.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.python.formmethod.Boolean
  twisted.python.formmethod.Boolean.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.python.formmethod.Boolean.coerce
  twisted.python.formmethod.Boolean.html#coerce
  Function
  Method
  PUBLIC
  Convert the value to the correct format.
- twisted.python.formmethod.File
  twisted.python.formmethod.File.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.python.formmethod.File.__init__
  twisted.python.formmethod.File.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.formmethod.File.coerce
  twisted.python.formmethod.File.html#coerce
  Function
  Method
  PUBLIC
  Convert the value to the correct format.
- twisted.python.formmethod.positiveInt
  twisted.python.formmethod.html#positiveInt
  Function
  Function
  PUBLIC
  Undocumented
- twisted.python.formmethod.Date
  twisted.python.formmethod.Date.html
  Class
  Class
  PUBLIC
  A date -- (year, month, day) tuple.
- twisted.python.formmethod.Date.defaultDefault
  twisted.python.formmethod.Date.html#defaultDefault
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.formmethod.Date.__init__
  twisted.python.formmethod.Date.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.formmethod.Date.allowNone
  twisted.python.formmethod.Date.html#allowNone
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.formmethod.Date.coerce
  twisted.python.formmethod.Date.html#coerce
  Function
  Method
  PUBLIC
  Return tuple of ints (year, month, day).
- twisted.python.formmethod.Submit
  twisted.python.formmethod.Submit.html
  Class
  Class
  PUBLIC
  Submit button or a reasonable facsimile thereof.
- twisted.python.formmethod.Submit.__init__
  twisted.python.formmethod.Submit.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.formmethod.Submit.allowNone
  twisted.python.formmethod.Submit.html#allowNone
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.formmethod.Submit.reset
  twisted.python.formmethod.Submit.html#reset
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.formmethod.Submit.coerce
  twisted.python.formmethod.Submit.html#coerce
  Function
  Method
  PUBLIC
  Convert the value to the correct format.
- twisted.python.formmethod.PresentationHint
  twisted.python.formmethod.PresentationHint.html
  Class
  Class
  PUBLIC
  A hint to a particular system.
- twisted.python.formmethod.MethodSignature
  twisted.python.formmethod.MethodSignature.html
  Class
  Class
  PUBLIC
  A signature of a callable.
- twisted.python.formmethod.MethodSignature.__init__
  twisted.python.formmethod.MethodSignature.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.formmethod.MethodSignature.methodSignature
  twisted.python.formmethod.MethodSignature.html#methodSignature
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.formmethod.MethodSignature.getArgument
  twisted.python.formmethod.MethodSignature.html#getArgument
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.formmethod.MethodSignature.method
  twisted.python.formmethod.MethodSignature.html#method
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.formmethod.FormMethod
  twisted.python.formmethod.FormMethod.html
  Class
  Class
  PUBLIC
  A callable object with a signature.
- twisted.python.formmethod.FormMethod.__init__
  twisted.python.formmethod.FormMethod.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.formmethod.FormMethod.signature
  twisted.python.formmethod.FormMethod.html#signature
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.formmethod.FormMethod.callable
  twisted.python.formmethod.FormMethod.html#callable
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.formmethod.FormMethod.takesRequest
  twisted.python.formmethod.FormMethod.html#takesRequest
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.formmethod.FormMethod.getArgs
  twisted.python.formmethod.FormMethod.html#getArgs
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.formmethod.FormMethod.call
  twisted.python.formmethod.FormMethod.html#call
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.rebuild.lastRebuild
  twisted.python.rebuild.html#lastRebuild
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.python.rebuild.Sensitive
  twisted.python.rebuild.Sensitive.html
  Class
  Class
  PUBLIC
  A utility mixin that's sensitive to rebuilds.
- twisted.python.rebuild.Sensitive.needRebuildUpdate
  twisted.python.rebuild.Sensitive.html#needRebuildUpdate
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.rebuild.Sensitive.rebuildUpToDate
  twisted.python.rebuild.Sensitive.html#rebuildUpToDate
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.rebuild.Sensitive.lastRebuild
  twisted.python.rebuild.Sensitive.html#lastRebuild
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.rebuild.Sensitive.latestVersionOf
  twisted.python.rebuild.Sensitive.html#latestVersionOf
  Function
  Method
  PUBLIC
  Get the latest version of an object.
- twisted.python.rebuild._modDictIDMap
  twisted.python.rebuild.html#_modDictIDMap
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.python.rebuild.latestFunction
  twisted.python.rebuild.html#latestFunction
  Function
  Function
  PUBLIC
  Get the latest version of a function.
- twisted.python.rebuild.latestClass
  twisted.python.rebuild.html#latestClass
  Function
  Function
  PUBLIC
  Get the latest version of a class.
- twisted.python.rebuild.RebuildError
  twisted.python.rebuild.RebuildError.html
  Class
  Exception
  PUBLIC
  Exception raised when trying to rebuild a class whereas it's not possible.
- twisted.python.rebuild.updateInstance
  twisted.python.rebuild.html#updateInstance
  Function
  Function
  PUBLIC
  Updates an instance to be current.
- twisted.python.rebuild.__injectedgetattr__
  twisted.python.rebuild.html#__injectedgetattr__
  Function
  Function
  PUBLIC
  A getattr method to cause a class to be refreshed.
- twisted.python.rebuild.rebuild
  twisted.python.rebuild.html#rebuild
  Function
  Function
  PUBLIC
  Reload a module and do as much as possible to replace its references.
- twisted.python.release.DirectoryExists
  twisted.python.release.DirectoryExists.html
  Class
  Exception
  PUBLIC
  Some directory exists when it shouldn't.
- twisted.python.release.DirectoryDoesntExist
  twisted.python.release.DirectoryDoesntExist.html
  Class
  Exception
  PUBLIC
  Some directory doesn't exist when it should.
- twisted.python.release.CommandFailed
  twisted.python.release.CommandFailed.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.python.release.sh
  twisted.python.release.html#sh
  Function
  Function
  PUBLIC
  I'll try to execute `command`, and if `prompt` is true, I'll ask before running it. If the command returns something other than 0, I'll raise `CommandFailed(command)`.
- twisted.python.release.runChdirSafe
  twisted.python.release.html#runChdirSafe
  Function
  Function
  PUBLIC
  Undocumented
- twisted.python.roots.NotSupportedError
  twisted.python.roots.NotSupportedError.html
  Class
  Exception
  PUBLIC
  An exception meaning that the tree-manipulation operation you're attempting to perform is not supported.
- twisted.python.roots.Request
  twisted.python.roots.Request.html
  Class
  Class
  PUBLIC
  I am an abstract representation of a request for an entity.
- twisted.python.roots.Request.wireProtocol
  twisted.python.roots.Request.html#wireProtocol
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.python.roots.Request.write
  twisted.python.roots.Request.html#write
  Function
  Method
  PUBLIC
  Add some data to the response to this request.
- twisted.python.roots.Request.finish
  twisted.python.roots.Request.html#finish
  Function
  Method
  PUBLIC
  The response to this request is finished; flush all data to the network stream.
- twisted.python.roots.Entity
  twisted.python.roots.Entity.html
  Class
  Class
  PUBLIC
  I am a terminal object in a hierarchy, with no children.
- twisted.python.roots.Entity.render
  twisted.python.roots.Entity.html#render
  Function
  Method
  PUBLIC
  I produce a stream of bytes for the request, by calling request.write() and request.finish().
- twisted.python.roots.Collection
  twisted.python.roots.Collection.html
  Class
  Class
  PUBLIC
  I represent a static collection of entities.
- twisted.python.roots.Collection.__init__
  twisted.python.roots.Collection.html#__init__
  Function
  Method
  PUBLIC
  Initialize me.
- twisted.python.roots.Collection.entities
  twisted.python.roots.Collection.html#entities
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.roots.Collection.getStaticEntity
  twisted.python.roots.Collection.html#getStaticEntity
  Function
  Method
  PUBLIC
  Get an entity that was added to me using putEntity.
- twisted.python.roots.Collection.getDynamicEntity
  twisted.python.roots.Collection.html#getDynamicEntity
  Function
  Method
  PUBLIC
  Subclass this to generate an entity on demand.
- twisted.python.roots.Collection.getEntity
  twisted.python.roots.Collection.html#getEntity
  Function
  Method
  PUBLIC
  Retrieve an entity from me.
- twisted.python.roots.Collection.putEntity
  twisted.python.roots.Collection.html#putEntity
  Function
  Method
  PUBLIC
  Store a static reference on 'name' for 'entity'.
- twisted.python.roots.Collection.delEntity
  twisted.python.roots.Collection.html#delEntity
  Function
  Method
  PUBLIC
  Remove a static reference for 'name'.
- twisted.python.roots.Collection.storeEntity
  twisted.python.roots.Collection.html#storeEntity
  Function
  Method
  PUBLIC
  Store an entity for 'name', based on the content of 'request'.
- twisted.python.roots.Collection.removeEntity
  twisted.python.roots.Collection.html#removeEntity
  Function
  Method
  PUBLIC
  Remove an entity for 'name', based on the content of 'request'.
- twisted.python.roots.Collection.listStaticEntities
  twisted.python.roots.Collection.html#listStaticEntities
  Function
  Method
  PUBLIC
  Retrieve a list of all name, entity pairs that I store references to.
- twisted.python.roots.Collection.listDynamicEntities
  twisted.python.roots.Collection.html#listDynamicEntities
  Function
  Method
  PUBLIC
  A list of all name, entity that I can generate on demand.
- twisted.python.roots.Collection.listEntities
  twisted.python.roots.Collection.html#listEntities
  Function
  Method
  PUBLIC
  Retrieve a list of all name, entity pairs I contain.
- twisted.python.roots.Collection.listStaticNames
  twisted.python.roots.Collection.html#listStaticNames
  Function
  Method
  PUBLIC
  Retrieve a list of the names of entities that I store references to.
- twisted.python.roots.Collection.listDynamicNames
  twisted.python.roots.Collection.html#listDynamicNames
  Function
  Method
  PUBLIC
  Retrieve a list of the names of entities that I store references to.
- twisted.python.roots.Collection.listNames
  twisted.python.roots.Collection.html#listNames
  Function
  Method
  PUBLIC
  Retrieve a list of all names for entities that I contain.
- twisted.python.roots.ConstraintViolation
  twisted.python.roots.ConstraintViolation.html
  Class
  Exception
  PUBLIC
  An exception raised when a constraint is violated.
- twisted.python.roots.Constrained
  twisted.python.roots.Constrained.html
  Class
  Class
  PUBLIC
  A collection that has constraints on its names and/or entities.
- twisted.python.roots.Constrained.nameConstraint
  twisted.python.roots.Constrained.html#nameConstraint
  Function
  Method
  PUBLIC
  A method that determines whether an entity may be added to me with a given name.
- twisted.python.roots.Constrained.entityConstraint
  twisted.python.roots.Constrained.html#entityConstraint
  Function
  Method
  PUBLIC
  A method that determines whether an entity may be added to me.
- twisted.python.roots.Constrained.reallyPutEntity
  twisted.python.roots.Constrained.html#reallyPutEntity
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.roots.Constrained.putEntity
  twisted.python.roots.Constrained.html#putEntity
  Function
  Method
  PUBLIC
  Store an entity if it meets both constraints.
- twisted.python.roots.Locked
  twisted.python.roots.Locked.html
  Class
  Class
  PUBLIC
  A collection that can be locked from adding entities.
- twisted.python.roots.Locked.locked
  twisted.python.roots.Locked.html#locked
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.roots.Locked.lock
  twisted.python.roots.Locked.html#lock
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.roots.Locked.entityConstraint
  twisted.python.roots.Locked.html#entityConstraint
  Function
  Method
  PUBLIC
  A method that determines whether an entity may be added to me.
- twisted.python.roots.Homogenous
  twisted.python.roots.Homogenous.html
  Class
  Class
  PUBLIC
  A homogenous collection of entities.
- twisted.python.roots.Homogenous.entityConstraint
  twisted.python.roots.Homogenous.html#entityConstraint
  Function
  Method
  PUBLIC
  A method that determines whether an entity may be added to me.
- twisted.python.roots.Homogenous.getNameType
  twisted.python.roots.Homogenous.html#getNameType
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.roots.Homogenous.getEntityType
  twisted.python.roots.Homogenous.html#getEntityType
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.shortcut.open
  twisted.python.shortcut.html#open
  Function
  Function
  PUBLIC
  Open an existing shortcut for reading.
- twisted.python.shortcut.Shortcut
  twisted.python.shortcut.Shortcut.html
  Class
  Class
  PUBLIC
  A shortcut on Win32.
- twisted.python.shortcut.Shortcut.__init__
  twisted.python.shortcut.Shortcut.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.python.shortcut.Shortcut._base
  twisted.python.shortcut.Shortcut.html#_base
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.python.shortcut.Shortcut.load
  twisted.python.shortcut.Shortcut.html#load
  Function
  Method
  PUBLIC
  Read a shortcut file from disk.
- twisted.python.shortcut.Shortcut.save
  twisted.python.shortcut.Shortcut.html#save
  Function
  Method
  PUBLIC
  Write the shortcut to disk.
- twisted.python.shortcut.Shortcut.__getattr__
  twisted.python.shortcut.Shortcut.html#__getattr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.syslog.syslog
  twisted.python.syslog.html#syslog
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.python.syslog.DEFAULT_OPTIONS
  twisted.python.syslog.html#DEFAULT_OPTIONS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.python.syslog.SyslogObserver
  twisted.python.syslog.SyslogObserver.html
  Class
  Class
  PUBLIC
  A log observer for logging to syslog.
- twisted.python.syslog.SyslogObserver.__init__
  twisted.python.syslog.SyslogObserver.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.python.syslog.SyslogObserver.emit
  twisted.python.syslog.SyslogObserver.html#emit
  Function
  Method
  PUBLIC
  Send a message event to the syslog.
- twisted.python.syslog.startLogging
  twisted.python.syslog.html#startLogging
  Function
  Function
  PUBLIC
  Send all Twisted logging output to syslog from now on.
- twisted.python.zipstream.ChunkingZipFile
  twisted.python.zipstream.ChunkingZipFile.html
  Class
  Class
  PUBLIC
  A `zipfile.ZipFile` object which, with `readfile`, also gives you access to a file-like object for each entry.
- twisted.python.zipstream.ChunkingZipFile.readfile
  twisted.python.zipstream.ChunkingZipFile.html#readfile
  Function
  Method
  PUBLIC
  Return file-like object for name.
- twisted.python.zipstream._FileEntry
  twisted.python.zipstream._FileEntry.html
  Class
  Class
  PRIVATE
  Abstract superclass of both compressed and uncompressed variants of file-like objects within a zip archive.
- twisted.python.zipstream._FileEntry.chunkingZipFile
  twisted.python.zipstream._FileEntry.html#chunkingZipFile
  Attribute
  Instance Variable
  PUBLIC
  a chunking zip file.
- twisted.python.zipstream._FileEntry.length
  twisted.python.zipstream._FileEntry.html#length
  Attribute
  Instance Variable
  PUBLIC
  The number of bytes within the zip file that represent this file. (This is the size on disk, not the number of decompressed bytes which will result from reading it.)
- twisted.python.zipstream._FileEntry.fp
  twisted.python.zipstream._FileEntry.html#fp
  Attribute
  Instance Variable
  PUBLIC
  the underlying file object (that contains pkzip data). Do not touch this, please. It will quite likely move or go away.
- twisted.python.zipstream._FileEntry.closed
  twisted.python.zipstream._FileEntry.html#closed
  Attribute
  Instance Variable
  PUBLIC
  File-like 'closed' attribute; True before this file has been closed, False after.
- twisted.python.zipstream._FileEntry.finished
  twisted.python.zipstream._FileEntry.html#finished
  Attribute
  Instance Variable
  PUBLIC
  An older, broken synonym for 'closed'. Do not touch this, please.
- twisted.python.zipstream._FileEntry.__init__
  twisted.python.zipstream._FileEntry.html#__init__
  Function
  Method
  PUBLIC
  Create a `_FileEntry` from a `ChunkingZipFile`.
- twisted.python.zipstream._FileEntry.isatty
  twisted.python.zipstream._FileEntry.html#isatty
  Function
  Method
  PUBLIC
  Returns false because zip files should not be ttys
- twisted.python.zipstream._FileEntry.close
  twisted.python.zipstream._FileEntry.html#close
  Function
  Method
  PUBLIC
  Close self (file-like object)
- twisted.python.zipstream._FileEntry.readline
  twisted.python.zipstream._FileEntry.html#readline
  Function
  Method
  PUBLIC
  Read a line.
- twisted.python.zipstream._FileEntry.__next__
  twisted.python.zipstream._FileEntry.html#__next__
  Function
  Method
  PUBLIC
  Implement next as file does (like readline, except raises StopIteration at EOF)
- twisted.python.zipstream._FileEntry.readlines
  twisted.python.zipstream._FileEntry.html#readlines
  Function
  Method
  PUBLIC
  Returns a list of all the lines
- twisted.python.zipstream._FileEntry.xreadlines
  twisted.python.zipstream._FileEntry.html#xreadlines
  Function
  Method
  PUBLIC
  Returns an iterator (so self)
- twisted.python.zipstream._FileEntry.__iter__
  twisted.python.zipstream._FileEntry.html#__iter__
  Function
  Method
  PUBLIC
  Returns an iterator (so self)
- twisted.python.zipstream._FileEntry.__enter__
  twisted.python.zipstream._FileEntry.html#__enter__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.zipstream._FileEntry.__exit__
  twisted.python.zipstream._FileEntry.html#__exit__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.zipstream.ZipFileEntry
  twisted.python.zipstream.ZipFileEntry.html
  Class
  Class
  PUBLIC
  File-like object used to read an uncompressed entry in a ZipFile
- twisted.python.zipstream.ZipFileEntry.__init__
  twisted.python.zipstream.ZipFileEntry.html#__init__
  Function
  Method
  PUBLIC
  Create a `_FileEntry` from a `ChunkingZipFile`.
- twisted.python.zipstream.ZipFileEntry.readBytes
  twisted.python.zipstream.ZipFileEntry.html#readBytes
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.zipstream.ZipFileEntry.tell
  twisted.python.zipstream.ZipFileEntry.html#tell
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.zipstream.ZipFileEntry.read
  twisted.python.zipstream.ZipFileEntry.html#read
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.zipstream.ZipFileEntry.finished
  twisted.python.zipstream.ZipFileEntry.html#finished
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.zipstream.DeflatedZipFileEntry
  twisted.python.zipstream.DeflatedZipFileEntry.html
  Class
  Class
  PUBLIC
  File-like object used to read a deflated entry in a ZipFile
- twisted.python.zipstream.DeflatedZipFileEntry.__init__
  twisted.python.zipstream.DeflatedZipFileEntry.html#__init__
  Function
  Method
  PUBLIC
  Create a `_FileEntry` from a `ChunkingZipFile`.
- twisted.python.zipstream.DeflatedZipFileEntry.returnedBytes
  twisted.python.zipstream.DeflatedZipFileEntry.html#returnedBytes
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.zipstream.DeflatedZipFileEntry.readBytes
  twisted.python.zipstream.DeflatedZipFileEntry.html#readBytes
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.zipstream.DeflatedZipFileEntry.decomp
  twisted.python.zipstream.DeflatedZipFileEntry.html#decomp
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.zipstream.DeflatedZipFileEntry.buffer
  twisted.python.zipstream.DeflatedZipFileEntry.html#buffer
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.zipstream.DeflatedZipFileEntry.tell
  twisted.python.zipstream.DeflatedZipFileEntry.html#tell
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.zipstream.DeflatedZipFileEntry.read
  twisted.python.zipstream.DeflatedZipFileEntry.html#read
  Function
  Method
  PUBLIC
  Undocumented
- twisted.python.zipstream.DeflatedZipFileEntry.finished
  twisted.python.zipstream.DeflatedZipFileEntry.html#finished
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.python.zipstream.DIR_BIT
  twisted.python.zipstream.html#DIR_BIT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.python.zipstream.countZipFileChunks
  twisted.python.zipstream.html#countZipFileChunks
  Function
  Function
  PUBLIC
  Predict the number of chunks that will be extracted from the entire zipfile, given chunksize blocks.
- twisted.python.zipstream.countFileChunks
  twisted.python.zipstream.html#countFileChunks
  Function
  Function
  PUBLIC
  Count the number of chunks that will result from the given `ZipInfo`.
- twisted.python.zipstream.unzipIterChunky
  twisted.python.zipstream.html#unzipIterChunky
  Function
  Function
  PUBLIC
  Return a generator for the zipfile. This implementation will yield after every chunksize uncompressed bytes, or at the end of a file, whichever comes first.
- twisted.runner.inetd.internalProtocols
  twisted.runner.inetd.html#internalProtocols
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.runner.inetd.InetdProtocol
  twisted.runner.inetd.InetdProtocol.html
  Class
  Class
  PUBLIC
  Forks a child process on connectionMade, passing the socket as fd 0.
- twisted.runner.inetd.InetdProtocol.connectionMade
  twisted.runner.inetd.InetdProtocol.html#connectionMade
  Function
  Method
  PUBLIC
  Called when a connection is made.
- twisted.runner.inetd.InetdFactory
  twisted.runner.inetd.InetdFactory.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.runner.inetd.InetdFactory.stderrFile
  twisted.runner.inetd.InetdFactory.html#stderrFile
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.runner.inetd.InetdFactory.__init__
  twisted.runner.inetd.InetdFactory.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.runner.inetd.InetdFactory.service
  twisted.runner.inetd.InetdFactory.html#service
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.runner.inetdconf.InvalidConfError
  twisted.runner.inetdconf.InvalidConfError.html
  Class
  Exception
  PUBLIC
  Invalid configuration file
- twisted.runner.inetdconf.InvalidInetdConfError
  twisted.runner.inetdconf.InvalidInetdConfError.html
  Class
  Exception
  PUBLIC
  Invalid inetd.conf file
- twisted.runner.inetdconf.InvalidServicesConfError
  twisted.runner.inetdconf.InvalidServicesConfError.html
  Class
  Exception
  PUBLIC
  Invalid services file
- twisted.runner.inetdconf.UnknownService
  twisted.runner.inetdconf.UnknownService.html
  Class
  Exception
  PUBLIC
  Unknown service name
- twisted.runner.inetdconf.SimpleConfFile
  twisted.runner.inetdconf.SimpleConfFile.html
  Class
  Class
  PUBLIC
  Simple configuration file parser superclass.
- twisted.runner.inetdconf.SimpleConfFile.commentChar
  twisted.runner.inetdconf.SimpleConfFile.html#commentChar
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.runner.inetdconf.SimpleConfFile.defaultFilename
  twisted.runner.inetdconf.SimpleConfFile.html#defaultFilename
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.runner.inetdconf.SimpleConfFile.parseFile
  twisted.runner.inetdconf.SimpleConfFile.html#parseFile
  Function
  Method
  PUBLIC
  Parse a configuration file
- twisted.runner.inetdconf.SimpleConfFile.parseLine
  twisted.runner.inetdconf.SimpleConfFile.html#parseLine
  Function
  Method
  PUBLIC
  Override this.
- twisted.runner.inetdconf.SimpleConfFile.parseFields
  twisted.runner.inetdconf.SimpleConfFile.html#parseFields
  Function
  Method
  PUBLIC
  Override this.
- twisted.runner.inetdconf.InetdService
  twisted.runner.inetdconf.InetdService.html
  Class
  Class
  PUBLIC
  A simple description of an inetd service.
- twisted.runner.inetdconf.InetdService.name
  twisted.runner.inetdconf.InetdService.html#name
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.runner.inetdconf.InetdService.port
  twisted.runner.inetdconf.InetdService.html#port
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.runner.inetdconf.InetdService.socketType
  twisted.runner.inetdconf.InetdService.html#socketType
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.runner.inetdconf.InetdService.protocol
  twisted.runner.inetdconf.InetdService.html#protocol
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.runner.inetdconf.InetdService.wait
  twisted.runner.inetdconf.InetdService.html#wait
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.runner.inetdconf.InetdService.user
  twisted.runner.inetdconf.InetdService.html#user
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.runner.inetdconf.InetdService.group
  twisted.runner.inetdconf.InetdService.html#group
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.runner.inetdconf.InetdService.program
  twisted.runner.inetdconf.InetdService.html#program
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.runner.inetdconf.InetdService.programArgs
  twisted.runner.inetdconf.InetdService.html#programArgs
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.runner.inetdconf.InetdService.__init__
  twisted.runner.inetdconf.InetdService.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.runner.inetdconf.InetdConf
  twisted.runner.inetdconf.InetdConf.html
  Class
  Class
  PUBLIC
  Configuration parser for a traditional UNIX inetd(8)
- twisted.runner.inetdconf.InetdConf.defaultFilename
  twisted.runner.inetdconf.InetdConf.html#defaultFilename
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.runner.inetdconf.InetdConf.__init__
  twisted.runner.inetdconf.InetdConf.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.runner.inetdconf.InetdConf.services
  twisted.runner.inetdconf.InetdConf.html#services
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.runner.inetdconf.InetdConf.knownServices
  twisted.runner.inetdconf.InetdConf.html#knownServices
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.runner.inetdconf.InetdConf.parseFields
  twisted.runner.inetdconf.InetdConf.html#parseFields
  Function
  Method
  PUBLIC
  Parse an inetd.conf file.
- twisted.runner.inetdconf.ServicesConf
  twisted.runner.inetdconf.ServicesConf.html
  Class
  Class
  PUBLIC
  /etc/services parser
- twisted.runner.inetdconf.ServicesConf.services
  twisted.runner.inetdconf.ServicesConf.html#services
  Attribute
  Instance Variable
  PUBLIC
  dict mapping service names to (port, protocol) tuples.
- twisted.runner.inetdconf.ServicesConf.defaultFilename
  twisted.runner.inetdconf.ServicesConf.html#defaultFilename
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.runner.inetdconf.ServicesConf.__init__
  twisted.runner.inetdconf.ServicesConf.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.runner.inetdconf.ServicesConf.parseFields
  twisted.runner.inetdconf.ServicesConf.html#parseFields
  Function
  Method
  PUBLIC
  Override this.
- twisted.runner.inetdtap.protocolDict
  twisted.runner.inetdtap.html#protocolDict
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.runner.inetdtap.Options
  twisted.runner.inetdtap.Options.html
  Class
  Class
  PUBLIC
  To use it, create a file named `sample-inetd.conf` with:
- twisted.runner.inetdtap.Options.optParameters
  twisted.runner.inetdtap.Options.html#optParameters
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.runner.inetdtap.Options.optFlags
  twisted.runner.inetdtap.Options.html#optFlags
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.runner.inetdtap.Options.compData
  twisted.runner.inetdtap.Options.html#compData
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.runner.inetdtap.makeService
  twisted.runner.inetdtap.html#makeService
  Function
  Function
  PUBLIC
  Undocumented
- twisted.runner.procmon._Process
  twisted.runner.procmon._Process.html
  Class
  Class
  PRIVATE
  The parameters of a process to be restarted.
- twisted.runner.procmon._Process.args
  twisted.runner.procmon._Process.html#args
  Attribute
  Instance Variable
  PUBLIC
  command-line arguments (including name of command as first one)
- twisted.runner.procmon._Process.uid
  twisted.runner.procmon._Process.html#uid
  Attribute
  Instance Variable
  PUBLIC
  user-id to run process as, or None (which means inherit uid)
- twisted.runner.procmon._Process.gid
  twisted.runner.procmon._Process.html#gid
  Attribute
  Instance Variable
  PUBLIC
  group-id to run process as, or None (which means inherit gid)
- twisted.runner.procmon._Process.env
  twisted.runner.procmon._Process.html#env
  Attribute
  Instance Variable
  PUBLIC
  environment for process
- twisted.runner.procmon._Process.cwd
  twisted.runner.procmon._Process.html#cwd
  Attribute
  Instance Variable
  PUBLIC
  initial working directory for process or None (which means inherit cwd)
- twisted.runner.procmon._Process.toTuple
  twisted.runner.procmon._Process.html#toTuple
  Function
  Method
  PUBLIC
  Convert process to tuple.
- twisted.runner.procmon.DummyTransport
  twisted.runner.procmon.DummyTransport.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.runner.procmon.DummyTransport.disconnecting
  twisted.runner.procmon.DummyTransport.html#disconnecting
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.runner.procmon.transport
  twisted.runner.procmon.html#transport
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.runner.procmon.LineLogger
  twisted.runner.procmon.LineLogger.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.runner.procmon.LineLogger.tag
  twisted.runner.procmon.LineLogger.html#tag
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.runner.procmon.LineLogger.stream
  twisted.runner.procmon.LineLogger.html#stream
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.runner.procmon.LineLogger.delimiter
  twisted.runner.procmon.LineLogger.html#delimiter
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.runner.procmon.LineLogger.service
  twisted.runner.procmon.LineLogger.html#service
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.runner.procmon.LineLogger.lineReceived
  twisted.runner.procmon.LineLogger.html#lineReceived
  Function
  Method
  PUBLIC
  Override this for when each line is received.
- twisted.runner.procmon.LoggingProtocol
  twisted.runner.procmon.LoggingProtocol.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.runner.procmon.LoggingProtocol.service
  twisted.runner.procmon.LoggingProtocol.html#service
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.runner.procmon.LoggingProtocol.name
  twisted.runner.procmon.LoggingProtocol.html#name
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.runner.procmon.LoggingProtocol.connectionMade
  twisted.runner.procmon.LoggingProtocol.html#connectionMade
  Function
  Method
  PUBLIC
  Called when a connection is made.
- twisted.runner.procmon.LoggingProtocol._output
  twisted.runner.procmon.LoggingProtocol.html#_output
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.runner.procmon.LoggingProtocol._outputEmpty
  twisted.runner.procmon.LoggingProtocol.html#_outputEmpty
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.runner.procmon.LoggingProtocol._error
  twisted.runner.procmon.LoggingProtocol.html#_error
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.runner.procmon.LoggingProtocol._errorEmpty
  twisted.runner.procmon.LoggingProtocol.html#_errorEmpty
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.runner.procmon.LoggingProtocol.outReceived
  twisted.runner.procmon.LoggingProtocol.html#outReceived
  Function
  Method
  PUBLIC
  Some data was received from stdout.
- twisted.runner.procmon.LoggingProtocol.errReceived
  twisted.runner.procmon.LoggingProtocol.html#errReceived
  Function
  Method
  PUBLIC
  Some data was received from stderr.
- twisted.runner.procmon.LoggingProtocol.processEnded
  twisted.runner.procmon.LoggingProtocol.html#processEnded
  Function
  Method
  PUBLIC
  Called when the child process exits and all file descriptors associated with it have been closed.
- twisted.runner.procmon.LoggingProtocol.output
  twisted.runner.procmon.LoggingProtocol.html#output
  Attribute
  Property
  PUBLIC
  Undocumented
- twisted.runner.procmon.LoggingProtocol.empty
  twisted.runner.procmon.LoggingProtocol.html#empty
  Attribute
  Property
  PUBLIC
  Undocumented
- twisted.runner.procmon.ProcessMonitor
  twisted.runner.procmon.ProcessMonitor.html
  Class
  Class
  PUBLIC
  ProcessMonitor runs processes, monitors their progress, and restarts them when they die.
- twisted.runner.procmon.ProcessMonitor.threshold
  twisted.runner.procmon.ProcessMonitor.html#threshold
  Attribute
  Instance Variable
  PUBLIC
  How long a process has to live before the death is considered instant, in seconds. The default value is 1 second.
- twisted.runner.procmon.ProcessMonitor.killTime
  twisted.runner.procmon.ProcessMonitor.html#killTime
  Attribute
  Instance Variable
  PUBLIC
  How long a process being killed has to get its affairs in order before it gets killed with an unmaskable signal. The default value is 5 seconds.
- twisted.runner.procmon.ProcessMonitor.minRestartDelay
  twisted.runner.procmon.ProcessMonitor.html#minRestartDelay
  Attribute
  Instance Variable
  PUBLIC
  The minimum time (in seconds) to wait before attempting to restart a process. Default 1s.
- twisted.runner.procmon.ProcessMonitor.maxRestartDelay
  twisted.runner.procmon.ProcessMonitor.html#maxRestartDelay
  Attribute
  Instance Variable
  PUBLIC
  The maximum time (in seconds) to wait before attempting to restart a process. Default 3600s (1h).
- twisted.runner.procmon.ProcessMonitor._reactor
  twisted.runner.procmon.ProcessMonitor.html#_reactor
  Attribute
  Instance Variable
  PRIVATE
  A provider of `IReactorProcess` and `IReactorTime` which will be used to spawn processes and register delayed calls.
- twisted.runner.procmon.ProcessMonitor.log
  twisted.runner.procmon.ProcessMonitor.html#log
  Attribute
  Instance Variable
  PUBLIC
  The logger used to propagate log messages from spawned processes.
- twisted.runner.procmon.ProcessMonitor.__init__
  twisted.runner.procmon.ProcessMonitor.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.runner.procmon.ProcessMonitor._processes
  twisted.runner.procmon.ProcessMonitor.html#_processes
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.runner.procmon.ProcessMonitor.protocols
  twisted.runner.procmon.ProcessMonitor.html#protocols
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.runner.procmon.ProcessMonitor.delay
  twisted.runner.procmon.ProcessMonitor.html#delay
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.runner.procmon.ProcessMonitor.timeStarted
  twisted.runner.procmon.ProcessMonitor.html#timeStarted
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.runner.procmon.ProcessMonitor.murder
  twisted.runner.procmon.ProcessMonitor.html#murder
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.runner.procmon.ProcessMonitor.restart
  twisted.runner.procmon.ProcessMonitor.html#restart
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.runner.procmon.ProcessMonitor.processes
  twisted.runner.procmon.ProcessMonitor.html#processes
  Attribute
  Property
  PUBLIC
  Processes as dict of tuples
- twisted.runner.procmon.ProcessMonitor.__getstate__
  twisted.runner.procmon.ProcessMonitor.html#__getstate__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.runner.procmon.ProcessMonitor.addProcess
  twisted.runner.procmon.ProcessMonitor.html#addProcess
  Function
  Method
  PUBLIC
  Add a new monitored process and start it immediately if the `ProcessMonitor` service is running.
- twisted.runner.procmon.ProcessMonitor.removeProcess
  twisted.runner.procmon.ProcessMonitor.html#removeProcess
  Function
  Method
  PUBLIC
  Stop the named process and remove it from the list of monitored processes.
- twisted.runner.procmon.ProcessMonitor.startService
  twisted.runner.procmon.ProcessMonitor.html#startService
  Function
  Method
  PUBLIC
  Start all monitored processes.
- twisted.runner.procmon.ProcessMonitor.stopService
  twisted.runner.procmon.ProcessMonitor.html#stopService
  Function
  Method
  PUBLIC
  Stop all monitored processes and cancel all scheduled process restarts.
- twisted.runner.procmon.ProcessMonitor.connectionLost
  twisted.runner.procmon.ProcessMonitor.html#connectionLost
  Function
  Method
  PUBLIC
  Called when a monitored processes exits. If `service.IService.running` is `True` (ie the service is started), the process will be restarted. If the process had been running for more than `ProcessMonitor.threshold`...
- twisted.runner.procmon.ProcessMonitor.startProcess
  twisted.runner.procmon.ProcessMonitor.html#startProcess
  Function
  Method
  PUBLIC
  No summary
- twisted.runner.procmon.ProcessMonitor._forceStopProcess
  twisted.runner.procmon.ProcessMonitor.html#_forceStopProcess
  Function
  Method
  PRIVATE
  No summary
- twisted.runner.procmon.ProcessMonitor.stopProcess
  twisted.runner.procmon.ProcessMonitor.html#stopProcess
  Function
  Method
  PUBLIC
  No summary
- twisted.runner.procmon.ProcessMonitor.restartAll
  twisted.runner.procmon.ProcessMonitor.html#restartAll
  Function
  Method
  PUBLIC
  Restart all processes. This is useful for third party management services to allow a user to restart servers because of an outside change in circumstances -- for example, a new version of a library is installed.
- twisted.runner.procmon.ProcessMonitor.__repr__
  twisted.runner.procmon.ProcessMonitor.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.runner.procmontap.Options
  twisted.runner.procmontap.Options.html
  Class
  Class
  PUBLIC
  Define the options accepted by the twistd procmon plugin.
- twisted.runner.procmontap.Options.synopsis
  twisted.runner.procmontap.Options.html#synopsis
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.runner.procmontap.Options.optParameters
  twisted.runner.procmontap.Options.html#optParameters
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.runner.procmontap.Options.optFlags
  twisted.runner.procmontap.Options.html#optFlags
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.runner.procmontap.Options.longdesc
  twisted.runner.procmontap.Options.html#longdesc
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.runner.procmontap.Options.parseArgs
  twisted.runner.procmontap.Options.html#parseArgs
  Function
  Method
  PUBLIC
  Grab the command line that is going to be started and monitored
- twisted.runner.procmontap.Options.postOptions
  twisted.runner.procmontap.Options.html#postOptions
  Function
  Method
  PUBLIC
  Check for dependencies.
- twisted.runner.procmontap.makeService
  twisted.runner.procmontap.html#makeService
  Function
  Function
  PUBLIC
  Undocumented
- twisted.scripts.htmlizer.__version__
  twisted.scripts.htmlizer.html#__version__
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.scripts.htmlizer.header
  twisted.scripts.htmlizer.html#header
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.scripts.htmlizer.footer
  twisted.scripts.htmlizer.html#footer
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.scripts.htmlizer.styleLink
  twisted.scripts.htmlizer.html#styleLink
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.scripts.htmlizer.alternateLink
  twisted.scripts.htmlizer.html#alternateLink
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.scripts.htmlizer.Options
  twisted.scripts.htmlizer.Options.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.scripts.htmlizer.Options.synopsis
  twisted.scripts.htmlizer.Options.html#synopsis
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.scripts.htmlizer.Options.optParameters
  twisted.scripts.htmlizer.Options.html#optParameters
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.scripts.htmlizer.Options.compData
  twisted.scripts.htmlizer.Options.html#compData
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.scripts.htmlizer.Options.parseArgs
  twisted.scripts.htmlizer.Options.html#parseArgs
  Function
  Method
  PUBLIC
  I am called with any leftover arguments which were not options.
- twisted.scripts.htmlizer.run
  twisted.scripts.htmlizer.html#run
  Function
  Function
  PUBLIC
  Undocumented
- twisted.trial.runner.pyunit
  twisted.trial.runner.html#pyunit
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.trial.runner.isPackage
  twisted.trial.runner.html#isPackage
  Function
  Function
  PUBLIC
  Given an object return True if the object looks like a package
- twisted.trial.runner.isPackageDirectory
  twisted.trial.runner.html#isPackageDirectory
  Function
  Function
  PUBLIC
  Is the directory at path 'dirname' a Python package directory? Returns the name of the __init__ file (it may have a weird extension) if dirname is a package directory. Otherwise, returns False
- twisted.trial.runner.samefile
  twisted.trial.runner.html#samefile
  Function
  Function
  PUBLIC
  A hacky implementation of `os.path.samefile`. Used by `filenameToModule` when the platform doesn't provide `os.path.samefile`. Do not use this.
- twisted.trial.runner.filenameToModule
  twisted.trial.runner.html#filenameToModule
  Function
  Function
  PUBLIC
  Given a filename, do whatever possible to return a module object matching that file.
- twisted.trial.runner._importFromFile
  twisted.trial.runner.html#_importFromFile
  Function
  Function
  PRIVATE
  Undocumented
- twisted.trial.runner._resolveDirectory
  twisted.trial.runner.html#_resolveDirectory
  Function
  Function
  PRIVATE
  Undocumented
- twisted.trial.runner._getMethodNameInClass
  twisted.trial.runner.html#_getMethodNameInClass
  Function
  Function
  PRIVATE
  Find the attribute name on the method's class which refers to the method.
- twisted.trial.runner.DestructiveTestSuite
  twisted.trial.runner.DestructiveTestSuite.html
  Class
  Class
  PUBLIC
  A test suite which remove the tests once run, to minimize memory usage.
- twisted.trial.runner.DestructiveTestSuite.run
  twisted.trial.runner.DestructiveTestSuite.html#run
  Function
  Method
  PUBLIC
  Almost the same as `TestSuite.run`, but with `self._tests` being empty at the end.
- twisted.trial.runner.NOT_IN_TEST
  twisted.trial.runner.html#NOT_IN_TEST
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.trial.runner.LoggedSuite
  twisted.trial.runner.LoggedSuite.html
  Class
  Class
  PUBLIC
  Any errors logged in this suite will be reported to the `TestResult` object.
- twisted.trial.runner.LoggedSuite.run
  twisted.trial.runner.LoggedSuite.html#run
  Function
  Method
  PUBLIC
  Run the suite, storing all errors in `result`. If an error is logged while no tests are running, then it will be added as an error to `result`.
- twisted.trial.runner.TrialSuite
  twisted.trial.runner.TrialSuite.html
  Class
  Class
  PUBLIC
  Suite to wrap around every single test in a `trial` run. Used internally by Trial to set up things necessary for Trial tests to work, regardless of what context they are run in.
- twisted.trial.runner.TrialSuite.__init__
  twisted.trial.runner.TrialSuite.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.trial.runner.TrialSuite._bail
  twisted.trial.runner.TrialSuite.html#_bail
  Function
  Method
  PRIVATE
  Undocumented
- twisted.trial.runner.TrialSuite.run
  twisted.trial.runner.TrialSuite.html#run
  Function
  Method
  PUBLIC
  Call `run` on every member of the suite.
- twisted.trial.runner.name
  twisted.trial.runner.html#name
  Function
  Function
  PUBLIC
  No summary
- twisted.trial.runner.isTestCase
  twisted.trial.runner.html#isTestCase
  Function
  Function
  PUBLIC
  No summary
- twisted.trial.runner.TestHolder
  twisted.trial.runner.TestHolder.html
  Class
  Class
  PUBLIC
  Placeholder for a `TestCase` inside a reporter. As far as a `TestResult` is concerned, this looks exactly like a unit test.
- twisted.trial.runner.TestHolder.failureException
  twisted.trial.runner.TestHolder.html#failureException
  Attribute
  Class Variable
  PUBLIC
  The exception class that is raised by failed assertions
- twisted.trial.runner.TestHolder.__init__
  twisted.trial.runner.TestHolder.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.trial.runner.TestHolder.description
  twisted.trial.runner.TestHolder.html#description
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.trial.runner.TestHolder.__call__
  twisted.trial.runner.TestHolder.html#__call__
  Function
  Method
  PUBLIC
  Run the test. Should always do exactly the same thing as run().
- twisted.trial.runner.TestHolder.id
  twisted.trial.runner.TestHolder.html#id
  Function
  Method
  PUBLIC
  Return a unique identifier for the test, usually the fully-qualified Python name.
- twisted.trial.runner.TestHolder.countTestCases
  twisted.trial.runner.TestHolder.html#countTestCases
  Function
  Method
  PUBLIC
  Return the number of tests in this test case. Usually 1.
- twisted.trial.runner.TestHolder.run
  twisted.trial.runner.TestHolder.html#run
  Function
  Method
  PUBLIC
  This test is just a placeholder. Run the test successfully.
- twisted.trial.runner.TestHolder.shortDescription
  twisted.trial.runner.TestHolder.html#shortDescription
  Function
  Method
  PUBLIC
  Return a short description of the test.
- twisted.trial.runner.ErrorHolder
  twisted.trial.runner.ErrorHolder.html
  Class
  Class
  PUBLIC
  Used to insert arbitrary errors into a test suite run. Provides enough methods to look like a `TestCase`, however, when it is run, it simply adds an error to the `TestResult`. The most common use-case is for when a module fails to import.
- twisted.trial.runner.ErrorHolder.__init__
  twisted.trial.runner.ErrorHolder.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.trial.runner.ErrorHolder.error
  twisted.trial.runner.ErrorHolder.html#error
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.trial.runner.ErrorHolder.__repr__
  twisted.trial.runner.ErrorHolder.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.trial.runner.ErrorHolder.run
  twisted.trial.runner.ErrorHolder.html#run
  Function
  Method
  PUBLIC
  Run the test, reporting the error.
- twisted.trial.runner.TestLoader
  twisted.trial.runner.TestLoader.html
  Class
  Class
  PUBLIC
  I find tests inside function, modules, files -- whatever -- then return them wrapped inside a Test (either a `TestSuite` or a `TestCase`).
- twisted.trial.runner.TestLoader.methodPrefix
  twisted.trial.runner.TestLoader.html#methodPrefix
  Attribute
  Instance Variable
  PUBLIC
  A string prefix. `TestLoader` will assume that all the methods in a class that begin with `methodPrefix` are test cases.
- twisted.trial.runner.TestLoader.modulePrefix
  twisted.trial.runner.TestLoader.html#modulePrefix
  Attribute
  Instance Variable
  PUBLIC
  A string prefix. Every module in a package that begins with `modulePrefix` is considered a module full of tests.
- twisted.trial.runner.TestLoader.forceGarbageCollection
  twisted.trial.runner.TestLoader.html#forceGarbageCollection
  Attribute
  Instance Variable
  PUBLIC
  A flag applied to each `TestCase` loaded. See `unittest.TestCase` for more information.
- twisted.trial.runner.TestLoader.sorter
  twisted.trial.runner.TestLoader.html#sorter
  Attribute
  Instance Variable
  PUBLIC
  A key function used to sort `TestCase`s, test classes, modules and packages.
- twisted.trial.runner.TestLoader.suiteFactory
  twisted.trial.runner.TestLoader.html#suiteFactory
  Attribute
  Instance Variable
  PUBLIC
  A callable which is passed a list of tests (which themselves may be suites of tests). Must return a test suite.
- twisted.trial.runner.TestLoader.__init__
  twisted.trial.runner.TestLoader.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.trial.runner.TestLoader._importErrors
  twisted.trial.runner.TestLoader.html#_importErrors
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.trial.runner.TestLoader.sort
  twisted.trial.runner.TestLoader.html#sort
  Function
  Method
  PUBLIC
  Sort the given things using `sorter`.
- twisted.trial.runner.TestLoader.findTestClasses
  twisted.trial.runner.TestLoader.html#findTestClasses
  Function
  Method
  PUBLIC
  Given a module, return all Trial test classes
- twisted.trial.runner.TestLoader.findByName
  twisted.trial.runner.TestLoader.html#findByName
  Function
  Method
  PUBLIC
  Find and load tests, given `name`.
- twisted.trial.runner.TestLoader.loadModule
  twisted.trial.runner.TestLoader.html#loadModule
  Function
  Method
  PUBLIC
  Return a test suite with all the tests from a module.
- twisted.trial.runner.TestLoader.loadClass
  twisted.trial.runner.TestLoader.html#loadClass
  Function
  Method
  PUBLIC
  Given a class which contains test cases, return a list of `TestCase`s.
- twisted.trial.runner.TestLoader.getTestCaseNames
  twisted.trial.runner.TestLoader.html#getTestCaseNames
  Function
  Method
  PUBLIC
  Given a class that contains `TestCase`s, return a list of names of methods that probably contain tests.
- twisted.trial.runner.TestLoader.loadMethod
  twisted.trial.runner.TestLoader.html#loadMethod
  Function
  Method
  PUBLIC
  Undocumented
- twisted.trial.runner.TestLoader._makeCase
  twisted.trial.runner.TestLoader.html#_makeCase
  Function
  Method
  PRIVATE
  Undocumented
- twisted.trial.runner.TestLoader.loadPackage
  twisted.trial.runner.TestLoader.html#loadPackage
  Function
  Method
  PUBLIC
  Load tests from a module object representing a package, and return a TestSuite containing those tests.
- twisted.trial.runner.TestLoader.loadDoctests
  twisted.trial.runner.TestLoader.html#loadDoctests
  Function
  Method
  PUBLIC
  Return a suite of tests for all the doctests defined in `module`.
- twisted.trial.runner.TestLoader.loadAnything
  twisted.trial.runner.TestLoader.html#loadAnything
  Function
  Method
  PUBLIC
  Load absolutely anything (as long as that anything is a module, package, class, or method (with associated parent class and qualname).
- twisted.trial.runner.TestLoader.loadByName
  twisted.trial.runner.TestLoader.html#loadByName
  Function
  Method
  PUBLIC
  Load some tests by name.
- twisted.trial.runner.TestLoader.loadByNames
  twisted.trial.runner.TestLoader.html#loadByNames
  Function
  Method
  PUBLIC
  Load some tests by a list of names.
- twisted.trial.runner.TestLoader._uniqueTests
  twisted.trial.runner.TestLoader.html#_uniqueTests
  Function
  Method
  PRIVATE
  Gather unique suite objects from loaded things. This will guarantee uniqueness of inherited methods on TestCases which would otherwise hash to same value and collapse to one test unexpectedly if using simpler means: e...
- twisted.trial.runner.TestLoader.loadFile
  twisted.trial.runner.TestLoader.html#loadFile
  Function
  Method
  PUBLIC
  Load a file, and then the tests in that file.
- twisted.trial.runner._qualNameWalker
  twisted.trial.runner.html#_qualNameWalker
  Function
  Function
  PRIVATE
  Given a Python qualified name, this function yields a 2-tuple of the most specific qualified name first, followed by the next-most-specific qualified name, and so on, paired with the remainder of the qualified name.
- twisted.trial.runner.TrialRunner
  twisted.trial.runner.TrialRunner.html
  Class
  Class
  PUBLIC
  A specialised runner that the trial front end uses.
- twisted.trial.runner.TrialRunner.DEBUG
  twisted.trial.runner.TrialRunner.html#DEBUG
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.trial.runner.TrialRunner.DRY_RUN
  twisted.trial.runner.TrialRunner.html#DRY_RUN
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.trial.runner.TrialRunner._setUpTestdir
  twisted.trial.runner.TrialRunner.html#_setUpTestdir
  Function
  Method
  PRIVATE
  Undocumented
- twisted.trial.runner.TrialRunner._testDirLock
  twisted.trial.runner.TrialRunner.html#_testDirLock
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.trial.runner.TrialRunner._tearDownTestdir
  twisted.trial.runner.TrialRunner.html#_tearDownTestdir
  Function
  Method
  PRIVATE
  Undocumented
- twisted.trial.runner.TrialRunner._makeResult
  twisted.trial.runner.TrialRunner.html#_makeResult
  Function
  Method
  PRIVATE
  Undocumented
- twisted.trial.runner.TrialRunner.__init__
  twisted.trial.runner.TrialRunner.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.trial.runner.TrialRunner.reporterFactory
  twisted.trial.runner.TrialRunner.html#reporterFactory
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.trial.runner.TrialRunner.logfile
  twisted.trial.runner.TrialRunner.html#logfile
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.trial.runner.TrialRunner.mode
  twisted.trial.runner.TrialRunner.html#mode
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.trial.runner.TrialRunner.stream
  twisted.trial.runner.TrialRunner.html#stream
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.trial.runner.TrialRunner.tbformat
  twisted.trial.runner.TrialRunner.html#tbformat
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.trial.runner.TrialRunner.rterrors
  twisted.trial.runner.TrialRunner.html#rterrors
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.trial.runner.TrialRunner.uncleanWarnings
  twisted.trial.runner.TrialRunner.html#uncleanWarnings
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.trial.runner.TrialRunner._result
  twisted.trial.runner.TrialRunner.html#_result
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.trial.runner.TrialRunner.workingDirectory
  twisted.trial.runner.TrialRunner.html#workingDirectory
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.trial.runner.TrialRunner._logFileObserver
  twisted.trial.runner.TrialRunner.html#_logFileObserver
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.trial.runner.TrialRunner._logFileObject
  twisted.trial.runner.TrialRunner.html#_logFileObject
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.trial.runner.TrialRunner._forceGarbageCollection
  twisted.trial.runner.TrialRunner.html#_forceGarbageCollection
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.trial.runner.TrialRunner.debugger
  twisted.trial.runner.TrialRunner.html#debugger
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.trial.runner.TrialRunner._exitFirst
  twisted.trial.runner.TrialRunner.html#_exitFirst
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.trial.runner.TrialRunner._tearDownLogFile
  twisted.trial.runner.TrialRunner.html#_tearDownLogFile
  Function
  Method
  PRIVATE
  Undocumented
- twisted.trial.runner.TrialRunner._setUpLogFile
  twisted.trial.runner.TrialRunner.html#_setUpLogFile
  Function
  Method
  PRIVATE
  Undocumented
- twisted.trial.runner.TrialRunner.run 0
  twisted.trial.runner.TrialRunner.html#run%200
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.trial.runner.TrialRunner.run
  twisted.trial.runner.TrialRunner.html#run
  Function
  Method
  PUBLIC
  Run the test or suite and return a result object.
- twisted.trial.runner.TrialRunner._runWithoutDecoration
  twisted.trial.runner.TrialRunner.html#_runWithoutDecoration
  Function
  Method
  PRIVATE
  Private helper that runs the given test but doesn't decorate it.
- twisted.trial.runner.TrialRunner.runUntilFailure
  twisted.trial.runner.TrialRunner.html#runUntilFailure
  Function
  Method
  PUBLIC
  Repeatedly run `test` until it fails.
- twisted.scripts.trial.TBFORMAT_MAP
  twisted.scripts.trial.html#TBFORMAT_MAP
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.scripts.trial._parseLocalVariables
  twisted.scripts.trial.html#_parseLocalVariables
  Function
  Function
  PRIVATE
  Accepts a single line in Emacs local variable declaration format and returns a dict of all the variables {name: value}. Raises ValueError if 'line' is in the wrong format.
- twisted.scripts.trial.loadLocalVariables
  twisted.scripts.trial.html#loadLocalVariables
  Function
  Function
  PUBLIC
  Accepts a filename and attempts to load the Emacs variable declarations from that file, simulating what Emacs does.
- twisted.scripts.trial.getTestModules
  twisted.scripts.trial.html#getTestModules
  Function
  Function
  PUBLIC
  Undocumented
- twisted.scripts.trial.isTestFile
  twisted.scripts.trial.html#isTestFile
  Function
  Function
  PUBLIC
  Returns true if 'filename' looks like a file containing unit tests. False otherwise. Doesn't care whether filename exists.
- twisted.scripts.trial._reporterAction
  twisted.scripts.trial.html#_reporterAction
  Function
  Function
  PRIVATE
  Undocumented
- twisted.scripts.trial._maybeFindSourceLine
  twisted.scripts.trial.html#_maybeFindSourceLine
  Function
  Function
  PRIVATE
  Try to find the source line of the given test thing.
- twisted.scripts.trial._runOrders
  twisted.scripts.trial.html#_runOrders
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.scripts.trial._checkKnownRunOrder
  twisted.scripts.trial.html#_checkKnownRunOrder
  Function
  Function
  PRIVATE
  Check that the given order is a known test running order.
- twisted.scripts.trial._BasicOptions
  twisted.scripts.trial._BasicOptions.html
  Class
  Class
  PRIVATE
  Basic options shared between trial and its local workers.
- twisted.scripts.trial._BasicOptions.longdesc
  twisted.scripts.trial._BasicOptions.html#longdesc
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.scripts.trial._BasicOptions.optFlags
  twisted.scripts.trial._BasicOptions.html#optFlags
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.scripts.trial._BasicOptions.optParameters
  twisted.scripts.trial._BasicOptions.html#optParameters
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.scripts.trial._BasicOptions.compData
  twisted.scripts.trial._BasicOptions.html#compData
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.scripts.trial._BasicOptions.tracer
  twisted.scripts.trial._BasicOptions.html#tracer
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.scripts.trial._BasicOptions.__init__
  twisted.scripts.trial._BasicOptions.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.scripts.trial._BasicOptions.getSynopsis
  twisted.scripts.trial._BasicOptions.html#getSynopsis
  Function
  Method
  PUBLIC
  Undocumented
- twisted.scripts.trial._BasicOptions.coverdir
  twisted.scripts.trial._BasicOptions.html#coverdir
  Function
  Method
  PUBLIC
  Return a `FilePath` representing the directory into which coverage results should be written.
- twisted.scripts.trial._BasicOptions.opt_coverage
  twisted.scripts.trial._BasicOptions.html#opt_coverage
  Function
  Method
  PUBLIC
  Generate coverage information in the coverage file in the directory specified by the temp-directory option.
- twisted.scripts.trial._BasicOptions.opt_testmodule
  twisted.scripts.trial._BasicOptions.html#opt_testmodule
  Function
  Method
  PUBLIC
  Filename to grep for test cases (-*- test-case-name).
- twisted.scripts.trial._BasicOptions.opt_spew
  twisted.scripts.trial._BasicOptions.html#opt_spew
  Function
  Method
  PUBLIC
  Print an insanely verbose log of everything that happens. Useful when debugging freezes or locks in complex code.
- twisted.scripts.trial._BasicOptions.opt_help_orders
  twisted.scripts.trial._BasicOptions.html#opt_help_orders
  Function
  Method
  PUBLIC
  Undocumented
- twisted.scripts.trial._BasicOptions.opt_help_reporters
  twisted.scripts.trial._BasicOptions.html#opt_help_reporters
  Function
  Method
  PUBLIC
  Undocumented
- twisted.scripts.trial._BasicOptions.opt_disablegc
  twisted.scripts.trial._BasicOptions.html#opt_disablegc
  Function
  Method
  PUBLIC
  Disable the garbage collector
- twisted.scripts.trial._BasicOptions.opt_tbformat
  twisted.scripts.trial._BasicOptions.html#opt_tbformat
  Function
  Method
  PUBLIC
  Specify the format to display tracebacks with. Valid formats are 'plain', 'emacs', and 'cgitb' which uses the nicely verbose stdlib cgitb.text function
- twisted.scripts.trial._BasicOptions.opt_recursionlimit
  twisted.scripts.trial._BasicOptions.html#opt_recursionlimit
  Function
  Method
  PUBLIC
  see sys.setrecursionlimit()
- twisted.scripts.trial._BasicOptions.opt_random
  twisted.scripts.trial._BasicOptions.html#opt_random
  Function
  Method
  PUBLIC
  Undocumented
- twisted.scripts.trial._BasicOptions.opt_without_module
  twisted.scripts.trial._BasicOptions.html#opt_without_module
  Function
  Method
  PUBLIC
  Fake the lack of the specified modules, separated with commas.
- twisted.scripts.trial._BasicOptions.parseArgs
  twisted.scripts.trial._BasicOptions.html#parseArgs
  Function
  Method
  PUBLIC
  Undocumented
- twisted.scripts.trial._BasicOptions._loadReporterByName
  twisted.scripts.trial._BasicOptions.html#_loadReporterByName
  Function
  Method
  PRIVATE
  Undocumented
- twisted.scripts.trial._BasicOptions.postOptions
  twisted.scripts.trial._BasicOptions.html#postOptions
  Function
  Method
  PUBLIC
  Undocumented
- twisted.scripts.trial.Options
  twisted.scripts.trial.Options.html
  Class
  Class
  PUBLIC
  Options to the trial command line tool.
- twisted.scripts.trial.Options._workerFlags
  twisted.scripts.trial.Options.html#_workerFlags
  Attribute
  Instance Variable
  PRIVATE
  List of flags which are accepted by trial distributed workers. This is used by `_getWorkerArguments` to build the command line arguments.
- twisted.scripts.trial.Options._workerParameters
  twisted.scripts.trial.Options.html#_workerParameters
  Attribute
  Instance Variable
  PRIVATE
  List of parameter which are accepted by trial distributed workers. This is used by `_getWorkerArguments` to build the command line arguments.
- twisted.scripts.trial.Options.optFlags
  twisted.scripts.trial.Options.html#optFlags
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.scripts.trial.Options.optParameters
  twisted.scripts.trial.Options.html#optParameters
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.scripts.trial.Options.compData
  twisted.scripts.trial.Options.html#compData
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.scripts.trial.Options.extra
  twisted.scripts.trial.Options.html#extra
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.scripts.trial.Options.tracer
  twisted.scripts.trial.Options.html#tracer
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.scripts.trial.Options.opt_jobs
  twisted.scripts.trial.Options.html#opt_jobs
  Function
  Method
  PUBLIC
  Number of local workers to run, a strictly positive integer.
- twisted.scripts.trial.Options._getWorkerArguments
  twisted.scripts.trial.Options.html#_getWorkerArguments
  Function
  Method
  PRIVATE
  Return a list of options to pass to distributed workers.
- twisted.scripts.trial.Options.postOptions
  twisted.scripts.trial.Options.html#postOptions
  Function
  Method
  PUBLIC
  I am called after the options are parsed.
- twisted.scripts.trial._initialDebugSetup
  twisted.scripts.trial.html#_initialDebugSetup
  Function
  Function
  PRIVATE
  Undocumented
- twisted.scripts.trial._getSuite
  twisted.scripts.trial.html#_getSuite
  Function
  Function
  PRIVATE
  Undocumented
- twisted.scripts.trial._getLoader
  twisted.scripts.trial.html#_getLoader
  Function
  Function
  PRIVATE
  Undocumented
- twisted.scripts.trial._wrappedPdb
  twisted.scripts.trial.html#_wrappedPdb
  Function
  Function
  PRIVATE
  Wrap an instance of `pdb.Pdb` with readline support and load any .rcs.
- twisted.scripts.trial._DebuggerNotFound
  twisted.scripts.trial._DebuggerNotFound.html
  Class
  Exception
  PRIVATE
  A debugger import failed.
- twisted.scripts.trial._makeRunner
  twisted.scripts.trial.html#_makeRunner
  Function
  Function
  PRIVATE
  Return a trial runner class set up with the parameters extracted from `config`.
- twisted.scripts.trial.run
  twisted.scripts.trial.html#run
  Function
  Function
  PUBLIC
  Undocumented
- twisted.spread.publish.Publishable
  twisted.spread.publish.Publishable.html
  Class
  Class
  PUBLIC
  An object whose cached state persists across sessions.
- twisted.spread.publish.Publishable.__init__
  twisted.spread.publish.Publishable.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.spread.publish.Publishable.publishedID
  twisted.spread.publish.Publishable.html#publishedID
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.publish.Publishable.republish
  twisted.spread.publish.Publishable.html#republish
  Function
  Method
  PUBLIC
  Set the timestamp to current and (TODO) update all observers.
- twisted.spread.publish.Publishable.timestamp
  twisted.spread.publish.Publishable.html#timestamp
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.publish.Publishable.view_getStateToPublish
  twisted.spread.publish.Publishable.html#view_getStateToPublish
  Function
  Method
  PUBLIC
  (internal)
- twisted.spread.publish.Publishable.getStateToPublishFor
  twisted.spread.publish.Publishable.html#getStateToPublishFor
  Function
  Method
  PUBLIC
  Implement me to special-case your state for a perspective.
- twisted.spread.publish.Publishable.getStateToPublish
  twisted.spread.publish.Publishable.html#getStateToPublish
  Function
  Method
  PUBLIC
  Implement me to return state to copy as part of the publish phase.
- twisted.spread.publish.Publishable.getStateToCacheAndObserveFor
  twisted.spread.publish.Publishable.html#getStateToCacheAndObserveFor
  Function
  Method
  PUBLIC
  Get all necessary metadata to keep a clientside cache.
- twisted.spread.publish.RemotePublished
  twisted.spread.publish.RemotePublished.html
  Class
  Class
  PUBLIC
  The local representation of remote Publishable object.
- twisted.spread.publish.RemotePublished.isActivated
  twisted.spread.publish.RemotePublished.html#isActivated
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.publish.RemotePublished._wasCleanWhenLoaded
  twisted.spread.publish.RemotePublished.html#_wasCleanWhenLoaded
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.spread.publish.RemotePublished.getFileName
  twisted.spread.publish.RemotePublished.html#getFileName
  Function
  Method
  PUBLIC
  Undocumented
- twisted.spread.publish.RemotePublished.setCopyableState
  twisted.spread.publish.RemotePublished.html#setCopyableState
  Function
  Method
  PUBLIC
  I will be invoked with the state to copy locally.
- twisted.spread.publish.RemotePublished._activationListeners
  twisted.spread.publish.RemotePublished.html#_activationListeners
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.spread.publish.RemotePublished.__getstate__
  twisted.spread.publish.RemotePublished.html#__getstate__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.spread.publish.RemotePublished._cbGotUpdate
  twisted.spread.publish.RemotePublished.html#_cbGotUpdate
  Function
  Method
  PRIVATE
  Undocumented
- twisted.spread.publish.RemotePublished.activated
  twisted.spread.publish.RemotePublished.html#activated
  Function
  Method
  PUBLIC
  Implement this method if you want to be notified when your publishable subclass is activated.
- twisted.spread.publish.RemotePublished.callWhenActivated
  twisted.spread.publish.RemotePublished.html#callWhenActivated
  Function
  Method
  PUBLIC
  Externally register for notification when this publishable has received all relevant data.
- twisted.spread.publish.whenReady
  twisted.spread.publish.html#whenReady
  Function
  Function
  PUBLIC
  Wrap a deferred returned from a pb method in another deferred that expects a RemotePublished as a result. This will allow you to wait until the result is really available.
- twisted.spread.publish._pubReady
  twisted.spread.publish.html#_pubReady
  Function
  Function
  PRIVATE
  (internal)
- twisted.spread.util.LocalMethod
  twisted.spread.util.LocalMethod.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.spread.util.LocalMethod.__init__
  twisted.spread.util.LocalMethod.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.spread.util.LocalMethod.local
  twisted.spread.util.LocalMethod.html#local
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.util.LocalMethod.name
  twisted.spread.util.LocalMethod.html#name
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.util.LocalMethod.__call__
  twisted.spread.util.LocalMethod.html#__call__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.spread.util.LocalAsRemote
  twisted.spread.util.LocalAsRemote.html
  Class
  Class
  PUBLIC
  A class useful for emulating the effects of remote behavior locally.
- twisted.spread.util.LocalAsRemote.reportAllTracebacks
  twisted.spread.util.LocalAsRemote.html#reportAllTracebacks
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.spread.util.LocalAsRemote.callRemote
  twisted.spread.util.LocalAsRemote.html#callRemote
  Function
  Method
  PUBLIC
  Call a specially-designated local method.
- twisted.spread.util.LocalAsRemote.remoteMethod
  twisted.spread.util.LocalAsRemote.html#remoteMethod
  Function
  Method
  PUBLIC
  Undocumented
- twisted.spread.util.LocalAsyncForwarder
  twisted.spread.util.LocalAsyncForwarder.html
  Class
  Class
  PUBLIC
  A class useful for forwarding a locally-defined interface.
- twisted.spread.util.LocalAsyncForwarder.__init__
  twisted.spread.util.LocalAsyncForwarder.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.spread.util.LocalAsyncForwarder.forwarded
  twisted.spread.util.LocalAsyncForwarder.html#forwarded
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.util.LocalAsyncForwarder.interfaceClass
  twisted.spread.util.LocalAsyncForwarder.html#interfaceClass
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.util.LocalAsyncForwarder.failWhenNotImplemented
  twisted.spread.util.LocalAsyncForwarder.html#failWhenNotImplemented
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.util.LocalAsyncForwarder._callMethod
  twisted.spread.util.LocalAsyncForwarder.html#_callMethod
  Function
  Method
  PRIVATE
  Undocumented
- twisted.spread.util.LocalAsyncForwarder.callRemote
  twisted.spread.util.LocalAsyncForwarder.html#callRemote
  Function
  Method
  PUBLIC
  Undocumented
- twisted.spread.util.Pager
  twisted.spread.util.Pager.html
  Class
  Class
  PUBLIC
  I am an object which pages out information.
- twisted.spread.util.Pager.__init__
  twisted.spread.util.Pager.html#__init__
  Function
  Method
  PUBLIC
  Create a pager with a Reference to a remote collector and an optional callable to invoke upon completion.
- twisted.spread.util.Pager.callback
  twisted.spread.util.Pager.html#callback
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.util.Pager.callbackArgs
  twisted.spread.util.Pager.html#callbackArgs
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.util.Pager.callbackKeyword
  twisted.spread.util.Pager.html#callbackKeyword
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.util.Pager._stillPaging
  twisted.spread.util.Pager.html#_stillPaging
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.spread.util.Pager.collector
  twisted.spread.util.Pager.html#collector
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.util.Pager.stillPaging
  twisted.spread.util.Pager.html#stillPaging
  Function
  Method
  PUBLIC
  (internal) Method called by Broker.
- twisted.spread.util.Pager.sendNextPage
  twisted.spread.util.Pager.html#sendNextPage
  Function
  Method
  PUBLIC
  (internal) Method called by Broker.
- twisted.spread.util.Pager.nextPage
  twisted.spread.util.Pager.html#nextPage
  Function
  Method
  PUBLIC
  Override this to return an object to be sent to my collector.
- twisted.spread.util.Pager.stopPaging
  twisted.spread.util.Pager.html#stopPaging
  Function
  Method
  PUBLIC
  Call this when you're done paging.
- twisted.spread.util.StringPager
  twisted.spread.util.StringPager.html
  Class
  Class
  PUBLIC
  A simple pager that splits a string into chunks.
- twisted.spread.util.StringPager.__init__
  twisted.spread.util.StringPager.html#__init__
  Function
  Method
  PUBLIC
  Create a pager with a Reference to a remote collector and an optional callable to invoke upon completion.
- twisted.spread.util.StringPager.string
  twisted.spread.util.StringPager.html#string
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.util.StringPager.pointer
  twisted.spread.util.StringPager.html#pointer
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.util.StringPager.chunkSize
  twisted.spread.util.StringPager.html#chunkSize
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.util.StringPager.nextPage
  twisted.spread.util.StringPager.html#nextPage
  Function
  Method
  PUBLIC
  Override this to return an object to be sent to my collector.
- twisted.spread.util.FilePager
  twisted.spread.util.FilePager.html
  Class
  Class
  PUBLIC
  Reads a file in chunks and sends the chunks as they come.
- twisted.spread.util.FilePager.__init__
  twisted.spread.util.FilePager.html#__init__
  Function
  Method
  PUBLIC
  Create a pager with a Reference to a remote collector and an optional callable to invoke upon completion.
- twisted.spread.util.FilePager.chunks
  twisted.spread.util.FilePager.html#chunks
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.util.FilePager.startProducing
  twisted.spread.util.FilePager.html#startProducing
  Function
  Method
  PUBLIC
  Undocumented
- twisted.spread.util.FilePager.deferred
  twisted.spread.util.FilePager.html#deferred
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.util.FilePager.registerProducer
  twisted.spread.util.FilePager.html#registerProducer
  Function
  Method
  PUBLIC
  Register to receive data from a producer.
- twisted.spread.util.FilePager.producer
  twisted.spread.util.FilePager.html#producer
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.util.FilePager.unregisterProducer
  twisted.spread.util.FilePager.html#unregisterProducer
  Function
  Method
  PUBLIC
  Stop consuming data from a producer, without disconnecting.
- twisted.spread.util.FilePager.write
  twisted.spread.util.FilePager.html#write
  Function
  Method
  PUBLIC
  The producer will write data by calling this method.
- twisted.spread.util.FilePager.sendNextPage
  twisted.spread.util.FilePager.html#sendNextPage
  Function
  Method
  PUBLIC
  Get the first chunk read and send it to collector.
- twisted.spread.util.CallbackPageCollector
  twisted.spread.util.CallbackPageCollector.html
  Class
  Class
  PUBLIC
  I receive pages from the peer. You may instantiate a Pager with a remote reference to me. I will call the callback with a list of pages once they are all received.
- twisted.spread.util.CallbackPageCollector.__init__
  twisted.spread.util.CallbackPageCollector.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.spread.util.CallbackPageCollector.pages
  twisted.spread.util.CallbackPageCollector.html#pages
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.util.CallbackPageCollector.callback
  twisted.spread.util.CallbackPageCollector.html#callback
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.spread.util.CallbackPageCollector.remote_gotPage
  twisted.spread.util.CallbackPageCollector.html#remote_gotPage
  Function
  Method
  PUBLIC
  Undocumented
- twisted.spread.util.CallbackPageCollector.remote_endedPaging
  twisted.spread.util.CallbackPageCollector.html#remote_endedPaging
  Function
  Method
  PUBLIC
  Undocumented
- twisted.spread.util.getAllPages
  twisted.spread.util.html#getAllPages
  Function
  Function
  PUBLIC
  A utility method that will call a remote method which expects a PageCollector as the first argument.
- twisted.tap.ftp.Options
  twisted.tap.ftp.Options.html
  Class
  Class
  PUBLIC
  No class docstring; 0/4 class variable, 1/2 method documented
- twisted.tap.ftp.Options.synopsis
  twisted.tap.ftp.Options.html#synopsis
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.tap.ftp.Options.optParameters
  twisted.tap.ftp.Options.html#optParameters
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.tap.ftp.Options.compData
  twisted.tap.ftp.Options.html#compData
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.tap.ftp.Options.longdesc
  twisted.tap.ftp.Options.html#longdesc
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.tap.ftp.Options.__init__
  twisted.tap.ftp.Options.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.tap.ftp.Options.opt_password_file
  twisted.tap.ftp.Options.html#opt_password_file
  Function
  Method
  PUBLIC
  Specify a file containing username:password login info for authenticated connections. (DEPRECATED; see --help-auth instead)
- twisted.tap.ftp.makeService
  twisted.tap.ftp.html#makeService
  Function
  Function
  PUBLIC
  Undocumented
- twisted.tap.portforward.Options
  twisted.tap.portforward.Options.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.tap.portforward.Options.synopsis
  twisted.tap.portforward.Options.html#synopsis
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.tap.portforward.Options.longdesc
  twisted.tap.portforward.Options.html#longdesc
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.tap.portforward.Options.optParameters
  twisted.tap.portforward.Options.html#optParameters
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.tap.portforward.Options.compData
  twisted.tap.portforward.Options.html#compData
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.tap.portforward.makeService
  twisted.tap.portforward.html#makeService
  Function
  Function
  PUBLIC
  Undocumented
- twisted.tap.socks.Options
  twisted.tap.socks.Options.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.tap.socks.Options.synopsis
  twisted.tap.socks.Options.html#synopsis
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.tap.socks.Options.optParameters
  twisted.tap.socks.Options.html#optParameters
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.tap.socks.Options.compData
  twisted.tap.socks.Options.html#compData
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.tap.socks.Options.longdesc
  twisted.tap.socks.Options.html#longdesc
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.tap.socks.makeService
  twisted.tap.socks.html#makeService
  Function
  Function
  PUBLIC
  Undocumented
- twisted.trial._dist._WORKER_AMP_STDIN
  twisted.trial._dist.html#_WORKER_AMP_STDIN
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.trial._dist._WORKER_AMP_STDOUT
  twisted.trial._dist.html#_WORKER_AMP_STDOUT
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.trial._dist.distreporter.DistReporter
  twisted.trial._dist.distreporter.DistReporter.html
  Class
  Class
  PUBLIC
  See module docstring.
- twisted.trial._dist.distreporter.DistReporter.__init__
  twisted.trial._dist.distreporter.DistReporter.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.trial._dist.distreporter.DistReporter.running
  twisted.trial._dist.distreporter.DistReporter.html#running
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.trial._dist.distreporter.DistReporter.startTest
  twisted.trial._dist.distreporter.DistReporter.html#startTest
  Function
  Method
  PUBLIC
  Queue test starting.
- twisted.trial._dist.distreporter.DistReporter.addFailure
  twisted.trial._dist.distreporter.DistReporter.html#addFailure
  Function
  Method
  PUBLIC
  Queue adding a failure.
- twisted.trial._dist.distreporter.DistReporter.addError
  twisted.trial._dist.distreporter.DistReporter.html#addError
  Function
  Method
  PUBLIC
  Queue error adding.
- twisted.trial._dist.distreporter.DistReporter.addSkip
  twisted.trial._dist.distreporter.DistReporter.html#addSkip
  Function
  Method
  PUBLIC
  Queue adding a skip.
- twisted.trial._dist.distreporter.DistReporter.addUnexpectedSuccess
  twisted.trial._dist.distreporter.DistReporter.html#addUnexpectedSuccess
  Function
  Method
  PUBLIC
  Queue adding an unexpected success.
- twisted.trial._dist.distreporter.DistReporter.addExpectedFailure
  twisted.trial._dist.distreporter.DistReporter.html#addExpectedFailure
  Function
  Method
  PUBLIC
  Queue adding an unexpected failure.
- twisted.trial._dist.distreporter.DistReporter.addSuccess
  twisted.trial._dist.distreporter.DistReporter.html#addSuccess
  Function
  Method
  PUBLIC
  Queue adding a success.
- twisted.trial._dist.distreporter.DistReporter.stopTest
  twisted.trial._dist.distreporter.DistReporter.html#stopTest
  Function
  Method
  PUBLIC
  Queue stopping the test, then unroll the queue.
- twisted.trial._dist.managercommands.AddSuccess
  twisted.trial._dist.managercommands.AddSuccess.html
  Class
  Class
  PUBLIC
  Add a success.
- twisted.trial._dist.managercommands.AddSuccess.arguments
  twisted.trial._dist.managercommands.AddSuccess.html#arguments
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.trial._dist.managercommands.AddSuccess.response
  twisted.trial._dist.managercommands.AddSuccess.html#response
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.trial._dist.managercommands.AddError
  twisted.trial._dist.managercommands.AddError.html
  Class
  Class
  PUBLIC
  Add an error.
- twisted.trial._dist.managercommands.AddError.arguments
  twisted.trial._dist.managercommands.AddError.html#arguments
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.trial._dist.managercommands.AddError.response
  twisted.trial._dist.managercommands.AddError.html#response
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.trial._dist.managercommands.AddFailure
  twisted.trial._dist.managercommands.AddFailure.html
  Class
  Class
  PUBLIC
  Add a failure.
- twisted.trial._dist.managercommands.AddFailure.arguments
  twisted.trial._dist.managercommands.AddFailure.html#arguments
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.trial._dist.managercommands.AddFailure.response
  twisted.trial._dist.managercommands.AddFailure.html#response
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.trial._dist.managercommands.AddSkip
  twisted.trial._dist.managercommands.AddSkip.html
  Class
  Class
  PUBLIC
  Add a skip.
- twisted.trial._dist.managercommands.AddSkip.arguments
  twisted.trial._dist.managercommands.AddSkip.html#arguments
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.trial._dist.managercommands.AddSkip.response
  twisted.trial._dist.managercommands.AddSkip.html#response
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.trial._dist.managercommands.AddExpectedFailure
  twisted.trial._dist.managercommands.AddExpectedFailure.html
  Class
  Class
  PUBLIC
  Add an expected failure.
- twisted.trial._dist.managercommands.AddExpectedFailure.arguments
  twisted.trial._dist.managercommands.AddExpectedFailure.html#arguments
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.trial._dist.managercommands.AddExpectedFailure.response
  twisted.trial._dist.managercommands.AddExpectedFailure.html#response
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.trial._dist.managercommands.AddUnexpectedSuccess
  twisted.trial._dist.managercommands.AddUnexpectedSuccess.html
  Class
  Class
  PUBLIC
  Add an unexpected success.
- twisted.trial._dist.managercommands.AddUnexpectedSuccess.arguments
  twisted.trial._dist.managercommands.AddUnexpectedSuccess.html#arguments
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.trial._dist.managercommands.AddUnexpectedSuccess.response
  twisted.trial._dist.managercommands.AddUnexpectedSuccess.html#response
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.trial._dist.managercommands.TestWrite
  twisted.trial._dist.managercommands.TestWrite.html
  Class
  Class
  PUBLIC
  Write test log.
- twisted.trial._dist.managercommands.TestWrite.arguments
  twisted.trial._dist.managercommands.TestWrite.html#arguments
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.trial._dist.managercommands.TestWrite.response
  twisted.trial._dist.managercommands.TestWrite.html#response
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.trial._dist.workercommands.Run
  twisted.trial._dist.workercommands.Run.html
  Class
  Class
  PUBLIC
  Run a test.
- twisted.trial._dist.workercommands.Run.arguments
  twisted.trial._dist.workercommands.Run.html#arguments
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.trial._dist.workercommands.Run.response
  twisted.trial._dist.workercommands.Run.html#response
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.trial._dist.workercommands.Start
  twisted.trial._dist.workercommands.Start.html
  Class
  Class
  PUBLIC
  Set up the worker process, giving the running directory.
- twisted.trial._dist.workercommands.Start.arguments
  twisted.trial._dist.workercommands.Start.html#arguments
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.trial._dist.workercommands.Start.response
  twisted.trial._dist.workercommands.Start.html#response
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.trial._dist.workerreporter.WorkerReporter
  twisted.trial._dist.workerreporter.WorkerReporter.html
  Class
  Class
  PUBLIC
  Reporter for trial's distributed workers. We send things not through a stream, but through an `AMP` protocol's `callRemote` method.
- twisted.trial._dist.workerreporter.WorkerReporter._DEFAULT_TODO
  twisted.trial._dist.workerreporter.WorkerReporter.html#_DEFAULT_TODO
  Attribute
  Constant
  PRIVATE
  Default message for expected failures and unexpected successes, used only if a `Todo` is not provided.
- twisted.trial._dist.workerreporter.WorkerReporter.__init__
  twisted.trial._dist.workerreporter.WorkerReporter.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.trial._dist.workerreporter.WorkerReporter.ampProtocol
  twisted.trial._dist.workerreporter.WorkerReporter.html#ampProtocol
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.trial._dist.workerreporter.WorkerReporter._getFailure
  twisted.trial._dist.workerreporter.WorkerReporter.html#_getFailure
  Function
  Method
  PRIVATE
  Convert a `sys.exc_info()`-style tuple to a `Failure`, if necessary.
- twisted.trial._dist.workerreporter.WorkerReporter._getFrames
  twisted.trial._dist.workerreporter.WorkerReporter.html#_getFrames
  Function
  Method
  PRIVATE
  Extract frames from a `Failure` instance.
- twisted.trial._dist.workerreporter.WorkerReporter.addSuccess
  twisted.trial._dist.workerreporter.WorkerReporter.html#addSuccess
  Function
  Method
  PUBLIC
  Send a success over.
- twisted.trial._dist.workerreporter.WorkerReporter.addError
  twisted.trial._dist.workerreporter.WorkerReporter.html#addError
  Function
  Method
  PUBLIC
  Send an error over.
- twisted.trial._dist.workerreporter.WorkerReporter.addFailure
  twisted.trial._dist.workerreporter.WorkerReporter.html#addFailure
  Function
  Method
  PUBLIC
  Send a Failure over.
- twisted.trial._dist.workerreporter.WorkerReporter.addSkip
  twisted.trial._dist.workerreporter.WorkerReporter.html#addSkip
  Function
  Method
  PUBLIC
  Send a skip over.
- twisted.trial._dist.workerreporter.WorkerReporter._getTodoReason
  twisted.trial._dist.workerreporter.WorkerReporter.html#_getTodoReason
  Function
  Method
  PRIVATE
  Get the reason for a `Todo`.
- twisted.trial._dist.workerreporter.WorkerReporter.addExpectedFailure
  twisted.trial._dist.workerreporter.WorkerReporter.html#addExpectedFailure
  Function
  Method
  PUBLIC
  Send an expected failure over.
- twisted.trial._dist.workerreporter.WorkerReporter.addUnexpectedSuccess
  twisted.trial._dist.workerreporter.WorkerReporter.html#addUnexpectedSuccess
  Function
  Method
  PUBLIC
  Send an unexpected success over.
- twisted.trial._dist.workerreporter.WorkerReporter.printSummary
  twisted.trial._dist.workerreporter.WorkerReporter.html#printSummary
  Function
  Method
  PUBLIC
  Don't print a summary
- twisted.trial._dist.worker.WorkerProtocol
  twisted.trial._dist.worker.WorkerProtocol.html
  Class
  Class
  PUBLIC
  The worker-side trial distributed protocol.
- twisted.trial._dist.worker.WorkerProtocol.__init__
  twisted.trial._dist.worker.WorkerProtocol.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.trial._dist.worker.WorkerProtocol._loader
  twisted.trial._dist.worker.WorkerProtocol.html#_loader
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.trial._dist.worker.WorkerProtocol._result
  twisted.trial._dist.worker.WorkerProtocol.html#_result
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.trial._dist.worker.WorkerProtocol._forceGarbageCollection
  twisted.trial._dist.worker.WorkerProtocol.html#_forceGarbageCollection
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.trial._dist.worker.WorkerProtocol.run
  twisted.trial._dist.worker.WorkerProtocol.html#run
  Function
  Method
  PUBLIC
  Run a test case by name.
- twisted.trial._dist.worker.WorkerProtocol.start
  twisted.trial._dist.worker.WorkerProtocol.html#start
  Function
  Method
  PUBLIC
  Set up the worker, moving into given directory for tests to run in them.
- twisted.trial._dist.worker.LocalWorkerAMP
  twisted.trial._dist.worker.LocalWorkerAMP.html
  Class
  Class
  PUBLIC
  Local implementation of the manager commands.
- twisted.trial._dist.worker.LocalWorkerAMP.addSuccess
  twisted.trial._dist.worker.LocalWorkerAMP.html#addSuccess
  Function
  Method
  PUBLIC
  Add a success to the reporter.
- twisted.trial._dist.worker.LocalWorkerAMP._buildFailure
  twisted.trial._dist.worker.LocalWorkerAMP.html#_buildFailure
  Function
  Method
  PRIVATE
  Helper to build a `Failure` with some traceback.
- twisted.trial._dist.worker.LocalWorkerAMP.addError
  twisted.trial._dist.worker.LocalWorkerAMP.html#addError
  Function
  Method
  PUBLIC
  Add an error to the reporter.
- twisted.trial._dist.worker.LocalWorkerAMP.addFailure
  twisted.trial._dist.worker.LocalWorkerAMP.html#addFailure
  Function
  Method
  PUBLIC
  Add a failure to the reporter.
- twisted.trial._dist.worker.LocalWorkerAMP.addSkip
  twisted.trial._dist.worker.LocalWorkerAMP.html#addSkip
  Function
  Method
  PUBLIC
  Add a skip to the reporter.
- twisted.trial._dist.worker.LocalWorkerAMP.addExpectedFailure
  twisted.trial._dist.worker.LocalWorkerAMP.html#addExpectedFailure
  Function
  Method
  PUBLIC
  Add an expected failure to the reporter.
- twisted.trial._dist.worker.LocalWorkerAMP.addUnexpectedSuccess
  twisted.trial._dist.worker.LocalWorkerAMP.html#addUnexpectedSuccess
  Function
  Method
  PUBLIC
  Add an unexpected success to the reporter.
- twisted.trial._dist.worker.LocalWorkerAMP.testWrite
  twisted.trial._dist.worker.LocalWorkerAMP.html#testWrite
  Function
  Method
  PUBLIC
  Print test output from the worker.
- twisted.trial._dist.worker.LocalWorkerAMP._stopTest
  twisted.trial._dist.worker.LocalWorkerAMP.html#_stopTest
  Function
  Method
  PRIVATE
  Stop the current running test case, forwarding the result.
- twisted.trial._dist.worker.LocalWorkerAMP.run
  twisted.trial._dist.worker.LocalWorkerAMP.html#run
  Function
  Method
  PUBLIC
  Run a test.
- twisted.trial._dist.worker.LocalWorkerAMP._testCase
  twisted.trial._dist.worker.LocalWorkerAMP.html#_testCase
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.trial._dist.worker.LocalWorkerAMP._result
  twisted.trial._dist.worker.LocalWorkerAMP.html#_result
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.trial._dist.worker.LocalWorkerAMP.setTestStream
  twisted.trial._dist.worker.LocalWorkerAMP.html#setTestStream
  Function
  Method
  PUBLIC
  Set the stream used to log output from tests.
- twisted.trial._dist.worker.LocalWorkerAMP._testStream
  twisted.trial._dist.worker.LocalWorkerAMP.html#_testStream
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.trial._dist.worker.LocalWorkerAddress
  twisted.trial._dist.worker.LocalWorkerAddress.html
  Class
  Class
  PUBLIC
  A `IAddress` implementation meant to provide stub addresses for `ITransport.getPeer` and `ITransport.getHost`.
- twisted.trial._dist.worker.LocalWorkerTransport
  twisted.trial._dist.worker.LocalWorkerTransport.html
  Class
  Class
  PUBLIC
  A stub transport implementation used to support `AMP` over a `ProcessProtocol` transport.
- twisted.trial._dist.worker.LocalWorkerTransport.__init__
  twisted.trial._dist.worker.LocalWorkerTransport.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.trial._dist.worker.LocalWorkerTransport._transport
  twisted.trial._dist.worker.LocalWorkerTransport.html#_transport
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.trial._dist.worker.LocalWorkerTransport.write
  twisted.trial._dist.worker.LocalWorkerTransport.html#write
  Function
  Method
  PUBLIC
  Forward data to transport.
- twisted.trial._dist.worker.LocalWorkerTransport.writeSequence
  twisted.trial._dist.worker.LocalWorkerTransport.html#writeSequence
  Function
  Method
  PUBLIC
  Emulate `writeSequence` by iterating data in the `sequence`.
- twisted.trial._dist.worker.LocalWorkerTransport.loseConnection
  twisted.trial._dist.worker.LocalWorkerTransport.html#loseConnection
  Function
  Method
  PUBLIC
  Closes the transport.
- twisted.trial._dist.worker.LocalWorkerTransport.getHost
  twisted.trial._dist.worker.LocalWorkerTransport.html#getHost
  Function
  Method
  PUBLIC
  Return a `LocalWorkerAddress` instance.
- twisted.trial._dist.worker.LocalWorkerTransport.getPeer
  twisted.trial._dist.worker.LocalWorkerTransport.html#getPeer
  Function
  Method
  PUBLIC
  Return a `LocalWorkerAddress` instance.
- twisted.trial._dist.worker.LocalWorker
  twisted.trial._dist.worker.LocalWorker.html
  Class
  Class
  PUBLIC
  Local process worker protocol. This worker runs as a local process and communicates via stdin/out.
- twisted.trial._dist.worker.LocalWorker._ampProtocol
  twisted.trial._dist.worker.LocalWorker.html#_ampProtocol
  Attribute
  Instance Variable
  PRIVATE
  The `AMP` protocol instance used to communicate with the worker.
- twisted.trial._dist.worker.LocalWorker._logDirectory
  twisted.trial._dist.worker.LocalWorker.html#_logDirectory
  Attribute
  Instance Variable
  PRIVATE
  The directory where logs will reside.
- twisted.trial._dist.worker.LocalWorker._logFile
  twisted.trial._dist.worker.LocalWorker.html#_logFile
  Attribute
  Instance Variable
  PRIVATE
  The name of the main log file for tests output.
- twisted.trial._dist.worker.LocalWorker.__init__
  twisted.trial._dist.worker.LocalWorker.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.trial._dist.worker.LocalWorker.endDeferred
  twisted.trial._dist.worker.LocalWorker.html#endDeferred
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.trial._dist.worker.LocalWorker.connectionMade
  twisted.trial._dist.worker.LocalWorker.html#connectionMade
  Function
  Method
  PUBLIC
  When connection is made, create the AMP protocol instance.
- twisted.trial._dist.worker.LocalWorker._outLog
  twisted.trial._dist.worker.LocalWorker.html#_outLog
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.trial._dist.worker.LocalWorker._errLog
  twisted.trial._dist.worker.LocalWorker.html#_errLog
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.trial._dist.worker.LocalWorker._testLog
  twisted.trial._dist.worker.LocalWorker.html#_testLog
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.trial._dist.worker.LocalWorker.connectionLost
  twisted.trial._dist.worker.LocalWorker.html#connectionLost
  Function
  Method
  PUBLIC
  On connection lost, close the log files that we're managing for stdin and stdout.
- twisted.trial._dist.worker.LocalWorker.processEnded
  twisted.trial._dist.worker.LocalWorker.html#processEnded
  Function
  Method
  PUBLIC
  When the process closes, call `connectionLost` for cleanup purposes and forward the information to the `_ampProtocol`.
- twisted.trial._dist.worker.LocalWorker.outReceived
  twisted.trial._dist.worker.LocalWorker.html#outReceived
  Function
  Method
  PUBLIC
  Send data received from stdout to log.
- twisted.trial._dist.worker.LocalWorker.errReceived
  twisted.trial._dist.worker.LocalWorker.html#errReceived
  Function
  Method
  PUBLIC
  Write error data to log.
- twisted.trial._dist.worker.LocalWorker.childDataReceived
  twisted.trial._dist.worker.LocalWorker.html#childDataReceived
  Function
  Method
  PUBLIC
  Handle data received on the specific pipe for the `_ampProtocol`.
- twisted.trial._dist.disttrial.DistTrialRunner
  twisted.trial._dist.disttrial.DistTrialRunner.html
  Class
  Class
  PUBLIC
  A specialized runner for distributed trial. The runner launches a number of local worker processes which will run tests.
- twisted.trial._dist.disttrial.DistTrialRunner._workerNumber
  twisted.trial._dist.disttrial.DistTrialRunner.html#_workerNumber
  Attribute
  Instance Variable
  PRIVATE
  the number of workers to be spawned.
- twisted.trial._dist.disttrial.DistTrialRunner._stream
  twisted.trial._dist.disttrial.DistTrialRunner.html#_stream
  Attribute
  Instance Variable
  PRIVATE
  stream which the reporter will use.
- twisted.trial._dist.disttrial.DistTrialRunner._reporterFactory
  twisted.trial._dist.disttrial.DistTrialRunner.html#_reporterFactory
  Attribute
  Instance Variable
  PRIVATE
  the reporter class to be used.
- twisted.trial._dist.disttrial.DistTrialRunner._makeResult
  twisted.trial._dist.disttrial.DistTrialRunner.html#_makeResult
  Function
  Method
  PRIVATE
  Make reporter factory, and wrap it with a `DistReporter`.
- twisted.trial._dist.disttrial.DistTrialRunner.__init__
  twisted.trial._dist.disttrial.DistTrialRunner.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.trial._dist.disttrial.DistTrialRunner._workerArguments
  twisted.trial._dist.disttrial.DistTrialRunner.html#_workerArguments
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.trial._dist.disttrial.DistTrialRunner._tbformat
  twisted.trial._dist.disttrial.DistTrialRunner.html#_tbformat
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.trial._dist.disttrial.DistTrialRunner._rterrors
  twisted.trial._dist.disttrial.DistTrialRunner.html#_rterrors
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.trial._dist.disttrial.DistTrialRunner._uncleanWarnings
  twisted.trial._dist.disttrial.DistTrialRunner.html#_uncleanWarnings
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.trial._dist.disttrial.DistTrialRunner._result
  twisted.trial._dist.disttrial.DistTrialRunner.html#_result
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.trial._dist.disttrial.DistTrialRunner._workingDirectory
  twisted.trial._dist.disttrial.DistTrialRunner.html#_workingDirectory
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.trial._dist.disttrial.DistTrialRunner._logFile
  twisted.trial._dist.disttrial.DistTrialRunner.html#_logFile
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.trial._dist.disttrial.DistTrialRunner._logFileObserver
  twisted.trial._dist.disttrial.DistTrialRunner.html#_logFileObserver
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.trial._dist.disttrial.DistTrialRunner._logFileObject
  twisted.trial._dist.disttrial.DistTrialRunner.html#_logFileObject
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.trial._dist.disttrial.DistTrialRunner._logWarnings
  twisted.trial._dist.disttrial.DistTrialRunner.html#_logWarnings
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.trial._dist.disttrial.DistTrialRunner.writeResults
  twisted.trial._dist.disttrial.DistTrialRunner.html#writeResults
  Function
  Method
  PUBLIC
  Write test run final outcome to result.
- twisted.trial._dist.disttrial.DistTrialRunner.createLocalWorkers
  twisted.trial._dist.disttrial.DistTrialRunner.html#createLocalWorkers
  Function
  Method
  PUBLIC
  Create local worker protocol instances and return them.
- twisted.trial._dist.disttrial.DistTrialRunner.launchWorkerProcesses
  twisted.trial._dist.disttrial.DistTrialRunner.html#launchWorkerProcesses
  Function
  Method
  PUBLIC
  Spawn processes from a list of process protocols.
- twisted.trial._dist.disttrial.DistTrialRunner._driveWorker
  twisted.trial._dist.disttrial.DistTrialRunner.html#_driveWorker
  Function
  Method
  PRIVATE
  Drive a `LocalWorkerAMP` instance, iterating the tests and calling `run` for every one of them.
- twisted.trial._dist.disttrial.DistTrialRunner.run
  twisted.trial._dist.disttrial.DistTrialRunner.html#run
  Function
  Method
  PUBLIC
  Spawn local worker processes and load tests. After that, run them.
- twisted.trial._dist.disttrial.DistTrialRunner.runUntilFailure
  twisted.trial._dist.disttrial.DistTrialRunner.html#runUntilFailure
  Function
  Method
  PUBLIC
  Run the tests with local worker processes until they fail.
- twisted.trial._dist.options.WorkerOptions
  twisted.trial._dist.options.WorkerOptions.html
  Class
  Class
  PUBLIC
  Options forwarded to the trial distributed worker.
- twisted.trial._dist.options.WorkerOptions.coverdir
  twisted.trial._dist.options.WorkerOptions.html#coverdir
  Function
  Method
  PUBLIC
  Return a `FilePath` representing the directory into which coverage results should be written.
- twisted.trial._dist.workertrial.WorkerLogObserver
  twisted.trial._dist.workertrial.WorkerLogObserver.html
  Class
  Class
  PUBLIC
  A log observer that forward its output to a `AMP` protocol.
- twisted.trial._dist.workertrial.WorkerLogObserver.__init__
  twisted.trial._dist.workertrial.WorkerLogObserver.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.trial._dist.workertrial.WorkerLogObserver.protocol
  twisted.trial._dist.workertrial.WorkerLogObserver.html#protocol
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.trial._dist.workertrial.WorkerLogObserver.emit
  twisted.trial._dist.workertrial.WorkerLogObserver.html#emit
  Function
  Method
  PUBLIC
  Produce a log output.
- twisted.trial._dist.workertrial.main
  twisted.trial._dist.workertrial.html#main
  Function
  Function
  PUBLIC
  Main function to be run if __name__ == "__main__".
- twisted.web.util._PRE
  twisted.web.util.html#_PRE
  Function
  Function
  PRIVATE
  Wraps <pre> tags around some text and HTML-escape it.
- twisted.web.util.ChildRedirector
  twisted.web.util.ChildRedirector.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.web.util.ChildRedirector.isLeaf
  twisted.web.util.ChildRedirector.html#isLeaf
  Attribute
  Class Variable
  PUBLIC
  Signal if this IResource implementor is a "leaf node" or not. If True, getChildWithDefault will not be called on this Resource.
- twisted.web.util.ChildRedirector.__init__
  twisted.web.util.ChildRedirector.html#__init__
  Function
  Method
  PUBLIC
  Initialize.
- twisted.web.util.ChildRedirector.getChild
  twisted.web.util.ChildRedirector.html#getChild
  Function
  Method
  PUBLIC
  Retrieve a 'child' resource from me.
- twisted.web.util.DeferredResource
  twisted.web.util.DeferredResource.html
  Class
  Class
  PUBLIC
  I wrap up a Deferred that will eventually result in a Resource object.
- twisted.web.util.DeferredResource.isLeaf
  twisted.web.util.DeferredResource.html#isLeaf
  Attribute
  Class Variable
  PUBLIC
  Signal if this IResource implementor is a "leaf node" or not. If True, getChildWithDefault will not be called on this Resource.
- twisted.web.util.DeferredResource.__init__
  twisted.web.util.DeferredResource.html#__init__
  Function
  Method
  PUBLIC
  Initialize.
- twisted.web.util.DeferredResource.d
  twisted.web.util.DeferredResource.html#d
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.util.DeferredResource.getChild
  twisted.web.util.DeferredResource.html#getChild
  Function
  Method
  PUBLIC
  Retrieve a 'child' resource from me.
- twisted.web.util.DeferredResource.render
  twisted.web.util.DeferredResource.html#render
  Function
  Method
  PUBLIC
  Render a given resource. See `IResource`'s render method.
- twisted.web.util.DeferredResource._cbChild
  twisted.web.util.DeferredResource.html#_cbChild
  Function
  Method
  PRIVATE
  Undocumented
- twisted.web.util.DeferredResource._ebChild
  twisted.web.util.DeferredResource.html#_ebChild
  Function
  Method
  PRIVATE
  Undocumented
- twisted.web.util.FailureElement
  twisted.web.util.FailureElement.html
  Class
  Class
  PUBLIC
  `FailureElement` is an `IRenderable` which can render detailed information about a `Failure`.
- twisted.web.util.FailureElement.failure
  twisted.web.util.FailureElement.html#failure
  Attribute
  Instance Variable
  PUBLIC
  The `Failure` instance which will be rendered.
- twisted.web.util.FailureElement.loader
  twisted.web.util.FailureElement.html#loader
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.web.util.FailureElement.__init__
  twisted.web.util.FailureElement.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.util.FailureElement.type
  twisted.web.util.FailureElement.html#type
  Function
  Method
  PUBLIC
  Render the exception type as a child of `tag`.
- twisted.web.util.FailureElement.value
  twisted.web.util.FailureElement.html#value
  Function
  Method
  PUBLIC
  Render the exception value as a child of `tag`.
- twisted.web.util.FailureElement.traceback
  twisted.web.util.FailureElement.html#traceback
  Function
  Method
  PUBLIC
  Render all the frames in the wrapped `Failure`'s traceback stack, replacing `tag`.
- twisted.web.util.ParentRedirect
  twisted.web.util.ParentRedirect.html
  Class
  Class
  PUBLIC
  Redirect to the nearest directory and strip any query string.
- twisted.web.util.ParentRedirect.isLeaf
  twisted.web.util.ParentRedirect.html#isLeaf
  Attribute
  Class Variable
  PUBLIC
  Signal if this IResource implementor is a "leaf node" or not. If True, getChildWithDefault will not be called on this Resource.
- twisted.web.util.ParentRedirect.render
  twisted.web.util.ParentRedirect.html#render
  Function
  Method
  PUBLIC
  Respond to all requests by redirecting to nearest directory.
- twisted.web.util.Redirect
  twisted.web.util.Redirect.html
  Class
  Class
  PUBLIC
  Resource that redirects to a specific URL.
- twisted.web.util.Redirect.url
  twisted.web.util.Redirect.html#url
  Attribute
  Instance Variable
  PUBLIC
  Redirect target URL to put in the Location response header.
- twisted.web.util.Redirect.isLeaf
  twisted.web.util.Redirect.html#isLeaf
  Attribute
  Class Variable
  PUBLIC
  Signal if this IResource implementor is a "leaf node" or not. If True, getChildWithDefault will not be called on this Resource.
- twisted.web.util.Redirect.__init__
  twisted.web.util.Redirect.html#__init__
  Function
  Method
  PUBLIC
  Initialize.
- twisted.web.util.Redirect.render
  twisted.web.util.Redirect.html#render
  Function
  Method
  PUBLIC
  Render a given resource. See `IResource`'s render method.
- twisted.web.util.Redirect.getChild
  twisted.web.util.Redirect.html#getChild
  Function
  Method
  PUBLIC
  Retrieve a 'child' resource from me.
- twisted.web.util._FrameElement
  twisted.web.util._FrameElement.html
  Class
  Class
  PRIVATE
  `_FrameElement` is an `IRenderable` which can render details about one frame from a `Failure`.
- twisted.web.util._FrameElement.frame
  twisted.web.util._FrameElement.html#frame
  Attribute
  Instance Variable
  PUBLIC
  A `Failure`-style frame object for which to load a source line to render. This is really a tuple holding some information from a frame object. See `Failure.frames` for specifics.
- twisted.web.util._FrameElement.__init__
  twisted.web.util._FrameElement.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.util._FrameElement.filename
  twisted.web.util._FrameElement.html#filename
  Function
  Method
  PUBLIC
  Render the name of the file this frame references as a child of `tag`.
- twisted.web.util._FrameElement.lineNumber
  twisted.web.util._FrameElement.html#lineNumber
  Function
  Method
  PUBLIC
  Render the source line number this frame references as a child of `tag`.
- twisted.web.util._FrameElement.function
  twisted.web.util._FrameElement.html#function
  Function
  Method
  PUBLIC
  Render the function name this frame references as a child of `tag`.
- twisted.web.util._FrameElement.source
  twisted.web.util._FrameElement.html#source
  Function
  Method
  PUBLIC
  Render the source code surrounding the line this frame references, replacing `tag`.
- twisted.web.util._SourceFragmentElement
  twisted.web.util._SourceFragmentElement.html
  Class
  Class
  PRIVATE
  `_SourceFragmentElement` is an `IRenderable` which can render several lines of source code near the line number of a particular frame object.
- twisted.web.util._SourceFragmentElement.frame
  twisted.web.util._SourceFragmentElement.html#frame
  Attribute
  Instance Variable
  PUBLIC
  A `Failure`-style frame object for which to load a source line to render. This is really a tuple holding some information from a frame object. See `Failure.frames` for specifics.
- twisted.web.util._SourceFragmentElement.__init__
  twisted.web.util._SourceFragmentElement.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.util._SourceFragmentElement._getSourceLines
  twisted.web.util._SourceFragmentElement.html#_getSourceLines
  Function
  Method
  PRIVATE
  Find the source line references by `self.frame` and yield, in source line order, it and the previous and following lines.
- twisted.web.util._SourceFragmentElement.sourceLines
  twisted.web.util._SourceFragmentElement.html#sourceLines
  Function
  Method
  PUBLIC
  Render the source line indicated by `self.frame` and several surrounding lines. The active line will be given a class of `"snippetHighlightLine"`. Other lines will be given a class of `"snippetLine"`.
- twisted.web.util._SourceLineElement
  twisted.web.util._SourceLineElement.html
  Class
  Class
  PRIVATE
  `_SourceLineElement` is an `IRenderable` which can render a single line of source code.
- twisted.web.util._SourceLineElement.number
  twisted.web.util._SourceLineElement.html#number
  Attribute
  Instance Variable
  PUBLIC
  A `int` giving the line number of the source code to be rendered.
- twisted.web.util._SourceLineElement.source
  twisted.web.util._SourceLineElement.html#source
  Attribute
  Instance Variable
  PUBLIC
  A `str` giving the source code to be rendered.
- twisted.web.util._SourceLineElement.__init__
  twisted.web.util._SourceLineElement.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.util._SourceLineElement.sourceLine
  twisted.web.util._SourceLineElement.html#sourceLine
  Function
  Method
  PUBLIC
  Render the line of source as a child of `tag`.
- twisted.web.util._SourceLineElement.lineNumber
  twisted.web.util._SourceLineElement.html#lineNumber
  Function
  Method
  PUBLIC
  Render the line number as a child of `tag`.
- twisted.web.util._StackElement
  twisted.web.util._StackElement.html
  Class
  Class
  PRIVATE
  `_StackElement` renders an `IRenderable` which can render a list of frames.
- twisted.web.util._StackElement.__init__
  twisted.web.util._StackElement.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.util._StackElement.stackFrames
  twisted.web.util._StackElement.html#stackFrames
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.util._StackElement.frames
  twisted.web.util._StackElement.html#frames
  Function
  Method
  PUBLIC
  Render the list of frames in this `_StackElement`, replacing `tag`.
- twisted.web.util.formatFailure
  twisted.web.util.html#formatFailure
  Function
  Function
  PUBLIC
  Construct an HTML representation of the given failure.
- twisted.web.util.redirectTo
  twisted.web.util.html#redirectTo
  Function
  Function
  PUBLIC
  Generate a redirect to the given location.
- twisted.web._auth.wrapper.UnauthorizedResource
  twisted.web._auth.wrapper.UnauthorizedResource.html
  Class
  Class
  PUBLIC
  Simple IResource to escape Resource dispatch
- twisted.web._auth.wrapper.UnauthorizedResource.isLeaf
  twisted.web._auth.wrapper.UnauthorizedResource.html#isLeaf
  Attribute
  Class Variable
  PUBLIC
  Signal if this IResource implementor is a "leaf node" or not. If True, getChildWithDefault will not be called on this Resource.
- twisted.web._auth.wrapper.UnauthorizedResource.__init__
  twisted.web._auth.wrapper.UnauthorizedResource.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web._auth.wrapper.UnauthorizedResource._credentialFactories
  twisted.web._auth.wrapper.UnauthorizedResource.html#_credentialFactories
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.web._auth.wrapper.UnauthorizedResource.render
  twisted.web._auth.wrapper.UnauthorizedResource.html#render
  Function
  Method
  PUBLIC
  Send www-authenticate headers to the client
- twisted.web._auth.wrapper.UnauthorizedResource.getChildWithDefault
  twisted.web._auth.wrapper.UnauthorizedResource.html#getChildWithDefault
  Function
  Method
  PUBLIC
  Disable resource dispatch
- twisted.web._auth.wrapper.UnauthorizedResource.putChild
  twisted.web._auth.wrapper.UnauthorizedResource.html#putChild
  Function
  Method
  PUBLIC
  Put a child IResource implementor at the given path.
- twisted.web._newclient.STATUS
  twisted.web._newclient.html#STATUS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.web._newclient.HEADER
  twisted.web._newclient.html#HEADER
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.web._newclient.BODY
  twisted.web._newclient.html#BODY
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.web._newclient.DONE
  twisted.web._newclient.html#DONE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.web._newclient._moduleLog
  twisted.web._newclient.html#_moduleLog
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.web._newclient.BadHeaders
  twisted.web._newclient.BadHeaders.html
  Class
  Exception
  PUBLIC
  Headers passed to `Request` were in some way invalid.
- twisted.web._newclient.ExcessWrite
  twisted.web._newclient.ExcessWrite.html
  Class
  Exception
  PUBLIC
  The body `IBodyProducer` for a request tried to write data after indicating it had finished writing data.
- twisted.web._newclient.ParseError
  twisted.web._newclient.ParseError.html
  Class
  Exception
  PUBLIC
  Some received data could not be parsed.
- twisted.web._newclient.ParseError.data
  twisted.web._newclient.ParseError.html#data
  Attribute
  Instance Variable
  PUBLIC
  The string which could not be parsed.
- twisted.web._newclient.ParseError.__init__
  twisted.web._newclient.ParseError.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web._newclient.BadResponseVersion
  twisted.web._newclient.BadResponseVersion.html
  Class
  Exception
  PUBLIC
  The version string in a status line was unparsable.
- twisted.web._newclient._WrapperException
  twisted.web._newclient._WrapperException.html
  Class
  Exception
  PRIVATE
  `_WrapperException` is the base exception type for exceptions which include one or more other exceptions as the low-level causes.
- twisted.web._newclient._WrapperException.reasons
  twisted.web._newclient._WrapperException.html#reasons
  Attribute
  Instance Variable
  PUBLIC
  A `list` of one or more `Failure` instances encountered during an HTTP request. See subclass documentation for more details.
- twisted.web._newclient._WrapperException.__init__
  twisted.web._newclient._WrapperException.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web._newclient.ConnectionAborted
  twisted.web._newclient.ConnectionAborted.html
  Class
  Exception
  PUBLIC
  The connection was explicitly aborted by application code.
- twisted.web._newclient.WrongBodyLength
  twisted.web._newclient.WrongBodyLength.html
  Class
  Exception
  PUBLIC
  An `IBodyProducer` declared the number of bytes it was going to produce (via its `length` attribute) and then produced a different number of bytes.
- twisted.web._newclient.RequestNotSent
  twisted.web._newclient.RequestNotSent.html
  Class
  Exception
  PUBLIC
  `RequestNotSent` indicates that an attempt was made to issue a request but for reasons unrelated to the details of the request itself, the request could not be sent. For example, this may indicate that an attempt was made to send a request using a protocol which is no longer connected to a server.
- twisted.web._newclient._callAppFunction
  twisted.web._newclient.html#_callAppFunction
  Function
  Function
  PRIVATE
  Call `function`. If it raises an exception, log it with a minimal description of the source.
- twisted.web._newclient.HTTPParser
  twisted.web._newclient.HTTPParser.html
  Class
  Class
  PUBLIC
  `HTTPParser` handles the parsing side of HTTP processing. With a suitable subclass, it can parse either the client side or the server side of the connection.
- twisted.web._newclient.HTTPParser.headers
  twisted.web._newclient.HTTPParser.html#headers
  Attribute
  Instance Variable
  PUBLIC
  All of the non-connection control message headers yet received.
- twisted.web._newclient.HTTPParser.state
  twisted.web._newclient.HTTPParser.html#state
  Attribute
  Instance Variable
  PUBLIC
  State indicator for the response parsing state machine. One of `STATUS`, `HEADER`, `BODY`, `DONE`.
- twisted.web._newclient.HTTPParser._partialHeader
  twisted.web._newclient.HTTPParser.html#_partialHeader
  Attribute
  Instance Variable
  PRIVATE
  `None` or a `list` of the lines of a multiline header while that header is being received.
- twisted.web._newclient.HTTPParser.delimiter
  twisted.web._newclient.HTTPParser.html#delimiter
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.web._newclient.HTTPParser.CONNECTION_CONTROL_HEADERS
  twisted.web._newclient.HTTPParser.html#CONNECTION_CONTROL_HEADERS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.web._newclient.HTTPParser.connectionMade
  twisted.web._newclient.HTTPParser.html#connectionMade
  Function
  Method
  PUBLIC
  Called when a connection is made.
- twisted.web._newclient.HTTPParser.connHeaders
  twisted.web._newclient.HTTPParser.html#connHeaders
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web._newclient.HTTPParser.switchToBodyMode
  twisted.web._newclient.HTTPParser.html#switchToBodyMode
  Function
  Method
  PUBLIC
  Switch to body parsing mode - interpret any more bytes delivered as part of the message body and deliver them to the given decoder.
- twisted.web._newclient.HTTPParser.bodyDecoder
  twisted.web._newclient.HTTPParser.html#bodyDecoder
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web._newclient.HTTPParser.lineReceived
  twisted.web._newclient.HTTPParser.html#lineReceived
  Function
  Method
  PUBLIC
  Handle one line from a response.
- twisted.web._newclient.HTTPParser.rawDataReceived
  twisted.web._newclient.HTTPParser.html#rawDataReceived
  Function
  Method
  PUBLIC
  Pass data from the message body to the body decoder object.
- twisted.web._newclient.HTTPParser.isConnectionControlHeader
  twisted.web._newclient.HTTPParser.html#isConnectionControlHeader
  Function
  Method
  PUBLIC
  Return `True` if the given lower-cased name is the name of a connection control header (rather than an entity header).
- twisted.web._newclient.HTTPParser.statusReceived
  twisted.web._newclient.HTTPParser.html#statusReceived
  Function
  Method
  PUBLIC
  Callback invoked whenever the first line of a new message is received. Override this.
- twisted.web._newclient.HTTPParser.headerReceived
  twisted.web._newclient.HTTPParser.html#headerReceived
  Function
  Method
  PUBLIC
  Store the given header in `self.headers`.
- twisted.web._newclient.HTTPParser.allHeadersReceived
  twisted.web._newclient.HTTPParser.html#allHeadersReceived
  Function
  Method
  PUBLIC
  Callback invoked after the last header is passed to `headerReceived`. Override this to change to the `BODY` or `DONE` state.
- twisted.web._newclient.HTTPClientParser
  twisted.web._newclient.HTTPClientParser.html
  Class
  Class
  PUBLIC
  An HTTP parser which only handles HTTP responses.
- twisted.web._newclient.HTTPClientParser.request
  twisted.web._newclient.HTTPClientParser.html#request
  Attribute
  Instance Variable
  PUBLIC
  The request with which the expected response is associated.
- twisted.web._newclient.HTTPClientParser.NO_BODY_CODES
  twisted.web._newclient.HTTPClientParser.html#NO_BODY_CODES
  Attribute
  Constant
  PUBLIC
  A `set` of response codes which MUST NOT have a body.
- twisted.web._newclient.HTTPClientParser.finisher
  twisted.web._newclient.HTTPClientParser.html#finisher
  Attribute
  Instance Variable
  PUBLIC
  A callable to invoke when this response is fully parsed.
- twisted.web._newclient.HTTPClientParser._responseDeferred
  twisted.web._newclient.HTTPClientParser.html#_responseDeferred
  Attribute
  Instance Variable
  PRIVATE
  A `Deferred` which will be called back with the response when all headers in the response have been received. Thereafter, `None`.
- twisted.web._newclient.HTTPClientParser._everReceivedData
  twisted.web._newclient.HTTPClientParser.html#_everReceivedData
  Attribute
  Instance Variable
  PRIVATE
  `True` if any bytes have been received.
- twisted.web._newclient.HTTPClientParser._transferDecoders
  twisted.web._newclient.HTTPClientParser.html#_transferDecoders
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.web._newclient.HTTPClientParser.bodyDecoder
  twisted.web._newclient.HTTPClientParser.html#bodyDecoder
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.web._newclient.HTTPClientParser._log
  twisted.web._newclient.HTTPClientParser.html#_log
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.web._newclient.HTTPClientParser.__init__
  twisted.web._newclient.HTTPClientParser.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web._newclient.HTTPClientParser.dataReceived
  twisted.web._newclient.HTTPClientParser.html#dataReceived
  Function
  Method
  PUBLIC
  Override so that we know if any response has been received.
- twisted.web._newclient.HTTPClientParser.parseVersion
  twisted.web._newclient.HTTPClientParser.html#parseVersion
  Function
  Method
  PUBLIC
  Parse version strings of the form Protocol '/' Major '.' Minor. E.g. b'HTTP/1.1'. Returns (protocol, major, minor). Will raise ValueError on bad syntax.
- twisted.web._newclient.HTTPClientParser.statusReceived
  twisted.web._newclient.HTTPClientParser.html#statusReceived
  Function
  Method
  PUBLIC
  Parse the status line into its components and create a response object to keep track of this response's state.
- twisted.web._newclient.HTTPClientParser.response
  twisted.web._newclient.HTTPClientParser.html#response
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web._newclient.HTTPClientParser._finished
  twisted.web._newclient.HTTPClientParser.html#_finished
  Function
  Method
  PRIVATE
  Called to indicate that an entire response has been received. No more bytes will be interpreted by this `HTTPClientParser`. Extra bytes are passed up and the state of this `HTTPClientParser` is set to DONE...
- twisted.web._newclient.HTTPClientParser.state
  twisted.web._newclient.HTTPClientParser.html#state
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web._newclient.HTTPClientParser.isConnectionControlHeader
  twisted.web._newclient.HTTPClientParser.html#isConnectionControlHeader
  Function
  Method
  PUBLIC
  Content-Length in the response to a HEAD request is an entity header, not a connection control header.
- twisted.web._newclient.HTTPClientParser.allHeadersReceived
  twisted.web._newclient.HTTPClientParser.html#allHeadersReceived
  Function
  Method
  PUBLIC
  Figure out how long the response body is going to be by examining headers and stuff.
- twisted.web._newclient.HTTPClientParser.connectionLost
  twisted.web._newclient.HTTPClientParser.html#connectionLost
  Function
  Method
  PUBLIC
  Called when the connection is shut down.
- twisted.web._newclient._VALID_METHOD
  twisted.web._newclient.html#_VALID_METHOD
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.web._newclient._ensureValidMethod
  twisted.web._newclient.html#_ensureValidMethod
  Function
  Function
  PRIVATE
  An HTTP method is an HTTP token, which consists of any visible ASCII character that is not a delimiter (i.e. one of `"(),/:;<=>?@[\]{}`.)
- twisted.web._newclient._VALID_URI
  twisted.web._newclient.html#_VALID_URI
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.web._newclient._ensureValidURI
  twisted.web._newclient.html#_ensureValidURI
  Function
  Function
  PRIVATE
  A valid URI cannot contain control characters (i.e., characters between 0-32, inclusive and 127) or non-ASCII characters (i.e., characters with values between 128-255, inclusive).
- twisted.web._newclient.Request
  twisted.web._newclient.Request.html
  Class
  Class
  PUBLIC
  A `Request` instance describes an HTTP request to be sent to an HTTP server.
- twisted.web._newclient.Request.method
  twisted.web._newclient.Request.html#method
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`.
- twisted.web._newclient.Request.uri
  twisted.web._newclient.Request.html#uri
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`.
- twisted.web._newclient.Request.headers
  twisted.web._newclient.Request.html#headers
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`.
- twisted.web._newclient.Request.bodyProducer
  twisted.web._newclient.Request.html#bodyProducer
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`.
- twisted.web._newclient.Request.persistent
  twisted.web._newclient.Request.html#persistent
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`.
- twisted.web._newclient.Request._parsedURI
  twisted.web._newclient.Request.html#_parsedURI
  Attribute
  Instance Variable
  PRIVATE
  Parsed URI for the request, or `None`.
- twisted.web._newclient.Request._log
  twisted.web._newclient.Request.html#_log
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.web._newclient.Request.__init__
  twisted.web._newclient.Request.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.web._newclient.Request._construct
  twisted.web._newclient.Request.html#_construct
  Function
  Class Method
  PRIVATE
  Private constructor.
- twisted.web._newclient.Request.absoluteURI
  twisted.web._newclient.Request.html#absoluteURI
  Attribute
  Property
  PUBLIC
  The absolute URI of the request as `bytes`, or `None` if the absolute URI cannot be determined.
- twisted.web._newclient.Request._writeHeaders
  twisted.web._newclient.Request.html#_writeHeaders
  Function
  Method
  PRIVATE
  Undocumented
- twisted.web._newclient.Request._writeToBodyProducerChunked
  twisted.web._newclient.Request.html#_writeToBodyProducerChunked
  Function
  Method
  PRIVATE
  Write this request to the given transport using chunked transfer-encoding to frame the body.
- twisted.web._newclient.Request._writeToBodyProducerContentLength
  twisted.web._newclient.Request.html#_writeToBodyProducerContentLength
  Function
  Method
  PRIVATE
  Write this request to the given transport using content-length to frame the body.
- twisted.web._newclient.Request._writeToEmptyBodyContentLength
  twisted.web._newclient.Request.html#_writeToEmptyBodyContentLength
  Function
  Method
  PRIVATE
  Write this request to the given transport using content-length to frame the (empty) body.
- twisted.web._newclient.Request.writeTo
  twisted.web._newclient.Request.html#writeTo
  Function
  Method
  PUBLIC
  Format this `Request` as an HTTP/1.1 request and write it to the given transport. If bodyProducer is not None, it will be associated with an `IConsumer`.
- twisted.web._newclient.Request.stopWriting
  twisted.web._newclient.Request.html#stopWriting
  Function
  Method
  PUBLIC
  Stop writing this request to the transport. This can only be called after `writeTo` and before the `Deferred` returned by `writeTo` fires. It should cancel any asynchronous task started by `writeTo`. The `Deferred`...
- twisted.web._newclient.LengthEnforcingConsumer
  twisted.web._newclient.LengthEnforcingConsumer.html
  Class
  Class
  PUBLIC
  An `IConsumer` proxy which enforces an exact length requirement on the total data written to it.
- twisted.web._newclient.LengthEnforcingConsumer._length
  twisted.web._newclient.LengthEnforcingConsumer.html#_length
  Attribute
  Instance Variable
  PRIVATE
  The number of bytes remaining to be written.
- twisted.web._newclient.LengthEnforcingConsumer._producer
  twisted.web._newclient.LengthEnforcingConsumer.html#_producer
  Attribute
  Instance Variable
  PRIVATE
  The `IBodyProducer` which is writing to this consumer.
- twisted.web._newclient.LengthEnforcingConsumer._consumer
  twisted.web._newclient.LengthEnforcingConsumer.html#_consumer
  Attribute
  Instance Variable
  PRIVATE
  The consumer to which at most `_length` bytes will be forwarded.
- twisted.web._newclient.LengthEnforcingConsumer._finished
  twisted.web._newclient.LengthEnforcingConsumer.html#_finished
  Attribute
  Instance Variable
  PRIVATE
  A `Deferred` which will be fired with a `Failure` if too many bytes are written to this consumer.
- twisted.web._newclient.LengthEnforcingConsumer.__init__
  twisted.web._newclient.LengthEnforcingConsumer.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web._newclient.LengthEnforcingConsumer._allowNoMoreWrites
  twisted.web._newclient.LengthEnforcingConsumer.html#_allowNoMoreWrites
  Function
  Method
  PRIVATE
  Indicate that no additional writes are allowed. Attempts to write after calling this method will be met with an exception.
- twisted.web._newclient.LengthEnforcingConsumer.write
  twisted.web._newclient.LengthEnforcingConsumer.html#write
  Function
  Method
  PUBLIC
  Write `bytes` to the underlying consumer unless `_noMoreWritesExpected` has been called or there are/have been too many bytes.
- twisted.web._newclient.LengthEnforcingConsumer._noMoreWritesExpected
  twisted.web._newclient.LengthEnforcingConsumer.html#_noMoreWritesExpected
  Function
  Method
  PRIVATE
  Called to indicate no more bytes will be written to this consumer. Check to see that the correct number have been written.
- twisted.web._newclient.makeStatefulDispatcher
  twisted.web._newclient.html#makeStatefulDispatcher
  Function
  Function
  PUBLIC
  Given a dispatch name and a function, return a function which can be used as a method and which, when called, will call another method defined on the instance and return the result. The other method which is called is determined by the value of the ...
- twisted.web._newclient._ClientRequestProxy
  twisted.web._newclient.html#_ClientRequestProxy
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.web._newclient.ChunkedEncoder
  twisted.web._newclient.ChunkedEncoder.html
  Class
  Class
  PUBLIC
  Helper object which exposes `IConsumer` on top of `HTTP11ClientProtocol` for streaming request bodies to the server.
- twisted.web._newclient.ChunkedEncoder.__init__
  twisted.web._newclient.ChunkedEncoder.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web._newclient.ChunkedEncoder.transport
  twisted.web._newclient.ChunkedEncoder.html#transport
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web._newclient.ChunkedEncoder._allowNoMoreWrites
  twisted.web._newclient.ChunkedEncoder.html#_allowNoMoreWrites
  Function
  Method
  PRIVATE
  Indicate that no additional writes are allowed. Attempts to write after calling this method will be met with an exception.
- twisted.web._newclient.ChunkedEncoder.registerProducer
  twisted.web._newclient.ChunkedEncoder.html#registerProducer
  Function
  Method
  PUBLIC
  Register the given producer with `self.transport`.
- twisted.web._newclient.ChunkedEncoder.write
  twisted.web._newclient.ChunkedEncoder.html#write
  Function
  Method
  PUBLIC
  Write the given request body bytes to the transport using chunked encoding.
- twisted.web._newclient.ChunkedEncoder.unregisterProducer
  twisted.web._newclient.ChunkedEncoder.html#unregisterProducer
  Function
  Method
  PUBLIC
  Indicate that the request body is complete and finish the request.
- twisted.web._newclient.TransportProxyProducer
  twisted.web._newclient.TransportProxyProducer.html
  Class
  Class
  PUBLIC
  An `twisted.internet.interfaces.IPushProducer` implementation which wraps another such thing and proxies calls to it until it is told to stop.
- twisted.web._newclient.TransportProxyProducer._producer
  twisted.web._newclient.TransportProxyProducer.html#_producer
  Attribute
  Instance Variable
  PRIVATE
  The wrapped `twisted.internet.interfaces.IPushProducer` provider or `None` after this proxy has been stopped.
- twisted.web._newclient.TransportProxyProducer.disconnecting
  twisted.web._newclient.TransportProxyProducer.html#disconnecting
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.web._newclient.TransportProxyProducer.__init__
  twisted.web._newclient.TransportProxyProducer.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web._newclient.TransportProxyProducer.stopProxying
  twisted.web._newclient.TransportProxyProducer.html#stopProxying
  Function
  Method
  PUBLIC
  Stop forwarding calls of `twisted.internet.interfaces.IPushProducer` methods to the underlying `twisted.internet.interfaces.IPushProducer` provider.
- twisted.web._newclient.TransportProxyProducer.stopProducing
  twisted.web._newclient.TransportProxyProducer.html#stopProducing
  Function
  Method
  PUBLIC
  Proxy the stoppage to the underlying producer, unless this proxy has been stopped.
- twisted.web._newclient.TransportProxyProducer.resumeProducing
  twisted.web._newclient.TransportProxyProducer.html#resumeProducing
  Function
  Method
  PUBLIC
  Proxy the resumption to the underlying producer, unless this proxy has been stopped.
- twisted.web._newclient.TransportProxyProducer.pauseProducing
  twisted.web._newclient.TransportProxyProducer.html#pauseProducing
  Function
  Method
  PUBLIC
  Proxy the pause to the underlying producer, unless this proxy has been stopped.
- twisted.web._newclient.TransportProxyProducer.loseConnection
  twisted.web._newclient.TransportProxyProducer.html#loseConnection
  Function
  Method
  PUBLIC
  Proxy the request to lose the connection to the underlying producer, unless this proxy has been stopped.
- twisted.web._newclient.HTTP11ClientProtocol
  twisted.web._newclient.HTTP11ClientProtocol.html
  Class
  Class
  PUBLIC
  `HTTP11ClientProtocol` is an implementation of the HTTP 1.1 client protocol. It supports as few features as possible.
- twisted.web._newclient.HTTP11ClientProtocol._parser
  twisted.web._newclient.HTTP11ClientProtocol.html#_parser
  Attribute
  Instance Variable
  PRIVATE
  After a request is issued, the `HTTPClientParser` to which received data making up the response to that request is delivered.
- twisted.web._newclient.HTTP11ClientProtocol._finishedRequest
  twisted.web._newclient.HTTP11ClientProtocol.html#_finishedRequest
  Attribute
  Instance Variable
  PRIVATE
  After a request is issued, the `Deferred` which will fire when a `Response` object corresponding to that request is available. This allows `HTTP11ClientProtocol` to fail the request if there is a connection or parsing problem.
- twisted.web._newclient.HTTP11ClientProtocol._currentRequest
  twisted.web._newclient.HTTP11ClientProtocol.html#_currentRequest
  Attribute
  Instance Variable
  PRIVATE
  After a request is issued, the `Request` instance used to make that request. This allows `HTTP11ClientProtocol` to stop request generation if necessary (for example, if the connection is lost).
- twisted.web._newclient.HTTP11ClientProtocol._transportProxy
  twisted.web._newclient.HTTP11ClientProtocol.html#_transportProxy
  Attribute
  Instance Variable
  PRIVATE
  After a request is issued, the `TransportProxyProducer` to which `_parser` is connected. This allows `_parser` to pause and resume the transport in a way which `HTTP11ClientProtocol` can exert some control over.
- twisted.web._newclient.HTTP11ClientProtocol._responseDeferred
  twisted.web._newclient.HTTP11ClientProtocol.html#_responseDeferred
  Attribute
  Instance Variable
  PRIVATE
  After a request is issued, the `Deferred` from `_parser` which will fire with a `Response` when one has been received. This is eventually chained with `_finishedRequest`, but only in certain cases to avoid double firing that Deferred.
- twisted.web._newclient.HTTP11ClientProtocol._state
  twisted.web._newclient.HTTP11ClientProtocol.html#_state
  Attribute
  Instance Variable
  PRIVATE
  Indicates what state this `HTTP11ClientProtocol` instance is in with respect to transmission of a request and reception of a response. This may be one of the following strings:
- twisted.web._newclient.HTTP11ClientProtocol._abortDeferreds
  twisted.web._newclient.HTTP11ClientProtocol.html#_abortDeferreds
  Attribute
  Instance Variable
  PRIVATE
  A list of `Deferred` instances that will fire when the connection is lost.
- twisted.web._newclient.HTTP11ClientProtocol._log
  twisted.web._newclient.HTTP11ClientProtocol.html#_log
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.web._newclient.HTTP11ClientProtocol.__init__
  twisted.web._newclient.HTTP11ClientProtocol.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web._newclient.HTTP11ClientProtocol._quiescentCallback
  twisted.web._newclient.HTTP11ClientProtocol.html#_quiescentCallback
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.web._newclient.HTTP11ClientProtocol.state
  twisted.web._newclient.HTTP11ClientProtocol.html#state
  Attribute
  Property
  PUBLIC
  Undocumented
- twisted.web._newclient.HTTP11ClientProtocol.request
  twisted.web._newclient.HTTP11ClientProtocol.html#request
  Function
  Method
  PUBLIC
  Issue `request` over `self.transport` and return a `Deferred` which will fire with a `Response` instance or an error.
- twisted.web._newclient.HTTP11ClientProtocol._finishResponse
  twisted.web._newclient.HTTP11ClientProtocol.html#_finishResponse
  Function
  Method
  PRIVATE
  Called by an `HTTPClientParser` to indicate that it has parsed a complete response.
- twisted.web._newclient.HTTP11ClientProtocol._finishResponse_WAITING
  twisted.web._newclient.HTTP11ClientProtocol.html#_finishResponse_WAITING
  Function
  Method
  PRIVATE
  Undocumented
- twisted.web._newclient.HTTP11ClientProtocol._disconnectParser
  twisted.web._newclient.HTTP11ClientProtocol.html#_disconnectParser
  Function
  Method
  PRIVATE
  If there is still a parser, call its `connectionLost` method with the given reason. If there is not, do nothing.
- twisted.web._newclient.HTTP11ClientProtocol._giveUp
  twisted.web._newclient.HTTP11ClientProtocol.html#_giveUp
  Function
  Method
  PRIVATE
  Lose the underlying connection and disconnect the parser with the given `Failure`.
- twisted.web._newclient.HTTP11ClientProtocol.dataReceived
  twisted.web._newclient.HTTP11ClientProtocol.html#dataReceived
  Function
  Method
  PUBLIC
  Handle some stuff from some place.
- twisted.web._newclient.HTTP11ClientProtocol.connectionLost
  twisted.web._newclient.HTTP11ClientProtocol.html#connectionLost
  Function
  Method
  PUBLIC
  The underlying transport went away. If appropriate, notify the parser object.
- twisted.web._newclient.HTTP11ClientProtocol._connectionLost_QUIESCENT
  twisted.web._newclient.HTTP11ClientProtocol.html#_connectionLost_QUIESCENT
  Function
  Method
  PRIVATE
  Nothing is currently happening. Move to the `'CONNECTION_LOST'` state but otherwise do nothing.
- twisted.web._newclient.HTTP11ClientProtocol._connectionLost_GENERATION_FAILED
  twisted.web._newclient.HTTP11ClientProtocol.html#_connectionLost_GENERATION_FAILED
  Function
  Method
  PRIVATE
  The connection was in an inconsistent state. Move to the `'CONNECTION_LOST'` state but otherwise do nothing.
- twisted.web._newclient.HTTP11ClientProtocol._connectionLost_TRANSMITTING
  twisted.web._newclient.HTTP11ClientProtocol.html#_connectionLost_TRANSMITTING
  Function
  Method
  PRIVATE
  Fail the `Deferred` for the current request, notify the request object that it does not need to continue transmitting itself, and move to the `'CONNECTION_LOST'` state.
- twisted.web._newclient.HTTP11ClientProtocol._connectionLost_TRANSMITTING_AFTER_RECEIVING_RESPONSE
  twisted.web._newclient.HTTP11ClientProtocol.html#_connectionLost_TRANSMITTING_AFTER_RECEIVING_RESPONSE
  Function
  Method
  PRIVATE
  Move to the `'CONNECTION_LOST'` state.
- twisted.web._newclient.HTTP11ClientProtocol._connectionLost_WAITING
  twisted.web._newclient.HTTP11ClientProtocol.html#_connectionLost_WAITING
  Function
  Method
  PRIVATE
  Disconnect the response parser so that it can propagate the event as necessary (for example, to call an application protocol's `connectionLost` method, or to fail a request `Deferred`) and move to the `'CONNECTION_LOST'`...
- twisted.web._newclient.HTTP11ClientProtocol._connectionLost_ABORTING
  twisted.web._newclient.HTTP11ClientProtocol.html#_connectionLost_ABORTING
  Function
  Method
  PRIVATE
  Disconnect the response parser with a `ConnectionAborted` failure, and move to the `'CONNECTION_LOST'` state.
- twisted.web._newclient.HTTP11ClientProtocol.abort
  twisted.web._newclient.HTTP11ClientProtocol.html#abort
  Function
  Method
  PUBLIC
  Close the connection and cause all outstanding `request` `Deferred`s to fire with an error.
- twisted.web.client.urlunparse
  twisted.web.client.html#urlunparse
  Function
  Function
  PUBLIC
  Undocumented
- twisted.web.client.PartialDownloadError
  twisted.web.client.PartialDownloadError.html
  Class
  Exception
  PUBLIC
  Page was only partially downloaded, we got disconnected in middle.
- twisted.web.client.PartialDownloadError.response
  twisted.web.client.PartialDownloadError.html#response
  Attribute
  Instance Variable
  PUBLIC
  All of the response body which was downloaded.
- twisted.web.client.URI
  twisted.web.client.URI.html
  Class
  Class
  PUBLIC
  A URI object.
- twisted.web.client.URI.__init__
  twisted.web.client.URI.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.web.client.URI.scheme
  twisted.web.client.URI.html#scheme
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.client.URI.netloc
  twisted.web.client.URI.html#netloc
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.client.URI.host
  twisted.web.client.URI.html#host
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.client.URI.port
  twisted.web.client.URI.html#port
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.client.URI.path
  twisted.web.client.URI.html#path
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.client.URI.params
  twisted.web.client.URI.html#params
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.client.URI.query
  twisted.web.client.URI.html#query
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.client.URI.fragment
  twisted.web.client.URI.html#fragment
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.client.URI.fromBytes
  twisted.web.client.URI.html#fromBytes
  Function
  Class Method
  PUBLIC
  Parse the given URI into a `URI`.
- twisted.web.client.URI.toBytes
  twisted.web.client.URI.html#toBytes
  Function
  Method
  PUBLIC
  Assemble the individual parts of the URI into a fully formed URI.
- twisted.web.client.URI.originForm
  twisted.web.client.URI.html#originForm
  Attribute
  Property
  PUBLIC
  The absolute URI path including URI parameters, query string and fragment identifier.
- twisted.web.client._urljoin
  twisted.web.client.html#_urljoin
  Function
  Function
  PRIVATE
  Construct a full ("absolute") URL by combining a "base URL" with another URL. Informally, this uses components of the base URL, in particular the addressing scheme, the network location and (part of) the path, to provide missing components in the relative URL.
- twisted.web.client._makeGetterFactory
  twisted.web.client.html#_makeGetterFactory
  Function
  Function
  PRIVATE
  Create and connect an HTTP page getting factory.
- twisted.web.client.RequestGenerationFailed
  twisted.web.client.RequestGenerationFailed.html
  Class
  Exception
  PUBLIC
  There was an error while creating the bytes which make up a request.
- twisted.web.client.RequestGenerationFailed.reasons
  twisted.web.client.RequestGenerationFailed.html#reasons
  Attribute
  Instance Variable
  PUBLIC
  A `list` of one or more `Failure` instances giving the reasons the request generation was considered to have failed.
- twisted.web.client.RequestTransmissionFailed
  twisted.web.client.RequestTransmissionFailed.html
  Class
  Exception
  PUBLIC
  There was an error while sending the bytes which make up a request.
- twisted.web.client.RequestTransmissionFailed.reasons
  twisted.web.client.RequestTransmissionFailed.html#reasons
  Attribute
  Instance Variable
  PUBLIC
  A `list` of one or more `Failure` instances giving the reasons the request transmission was considered to have failed.
- twisted.web.client.Response
  twisted.web.client.Response.html
  Class
  Class
  PUBLIC
  A `Response` instance describes an HTTP response received from an HTTP server.
- twisted.web.client.Response._transport
  twisted.web.client.Response.html#_transport
  Attribute
  Instance Variable
  PRIVATE
  See `__init__`.
- twisted.web.client.Response._bodyProtocol
  twisted.web.client.Response.html#_bodyProtocol
  Attribute
  Instance Variable
  PRIVATE
  The `IProtocol` provider to which the body is delivered. `None` before one has been registered with `deliverBody`.
- twisted.web.client.Response._bodyBuffer
  twisted.web.client.Response.html#_bodyBuffer
  Attribute
  Instance Variable
  PRIVATE
  A `list` of the strings passed to `bodyDataReceived` before `deliverBody` is called. `None` afterwards.
- twisted.web.client.Response._state
  twisted.web.client.Response.html#_state
  Attribute
  Instance Variable
  PRIVATE
  Indicates what state this `Response` instance is in, particularly with respect to delivering bytes from the response body to an application-supplied protocol object. This may be one of `'INITIAL'`, `'CONNECTED'`...
- twisted.web.client.Response._bodyFinished
  twisted.web.client.Response.html#_bodyFinished
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.web.client.Response.__init__
  twisted.web.client.Response.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.web.client.Response.version
  twisted.web.client.Response.html#version
  Attribute
  Instance Variable
  PUBLIC
  A three-tuple describing the protocol and protocol version of the response. The first element is of type `str`, the second and third are of type `int`. For example, `(b'HTTP', 1, 1)`.
- twisted.web.client.Response.code
  twisted.web.client.Response.html#code
  Attribute
  Instance Variable
  PUBLIC
  The HTTP status code of this response, as a `int`.
- twisted.web.client.Response.phrase
  twisted.web.client.Response.html#phrase
  Attribute
  Instance Variable
  PUBLIC
  The HTTP reason phrase of this response, as a `str`.
- twisted.web.client.Response.headers
  twisted.web.client.Response.html#headers
  Attribute
  Instance Variable
  PUBLIC
  The HTTP response `Headers` of this response.
- twisted.web.client.Response.request
  twisted.web.client.Response.html#request
  Attribute
  Instance Variable
  PUBLIC
  The `IClientRequest` that resulted in this response.
- twisted.web.client.Response.previousResponse
  twisted.web.client.Response.html#previousResponse
  Attribute
  Instance Variable
  PUBLIC
  The previous `IResponse` from a redirect, or `None` if there was no previous response. This can be used to walk the response or request history for redirections.
- twisted.web.client.Response._construct
  twisted.web.client.Response.html#_construct
  Function
  Class Method
  PRIVATE
  Private constructor.
- twisted.web.client.Response.setPreviousResponse
  twisted.web.client.Response.html#setPreviousResponse
  Function
  Method
  PUBLIC
  Set the reference to the previous `IResponse`.
- twisted.web.client.Response.deliverBody
  twisted.web.client.Response.html#deliverBody
  Function
  Method
  PUBLIC
  Dispatch the given `IProtocol` depending of the current state of the response.
- twisted.web.client.Response._deliverBody_INITIAL
  twisted.web.client.Response.html#_deliverBody_INITIAL
  Function
  Method
  PRIVATE
  Deliver any buffered data to `protocol` and prepare to deliver any future data to it. Move to the `'CONNECTED'` state.
- twisted.web.client.Response._deliverBody_CONNECTED
  twisted.web.client.Response.html#_deliverBody_CONNECTED
  Function
  Method
  PRIVATE
  It is invalid to attempt to deliver data to a protocol when it is already being delivered to another protocol.
- twisted.web.client.Response._deliverBody_DEFERRED_CLOSE
  twisted.web.client.Response.html#_deliverBody_DEFERRED_CLOSE
  Function
  Method
  PRIVATE
  Deliver any buffered data to `protocol` and then disconnect the protocol. Move to the `'FINISHED'` state.
- twisted.web.client.Response._deliverBody_FINISHED
  twisted.web.client.Response.html#_deliverBody_FINISHED
  Function
  Method
  PRIVATE
  It is invalid to attempt to deliver data to a protocol after the response body has been delivered to another protocol.
- twisted.web.client.Response._bodyDataReceived
  twisted.web.client.Response.html#_bodyDataReceived
  Function
  Method
  PRIVATE
  Called by HTTPClientParser with chunks of data from the response body. They will be buffered or delivered to the protocol passed to deliverBody.
- twisted.web.client.Response._bodyDataReceived_INITIAL
  twisted.web.client.Response.html#_bodyDataReceived_INITIAL
  Function
  Method
  PRIVATE
  Buffer any data received for later delivery to a protocol passed to `deliverBody`.
- twisted.web.client.Response._bodyDataReceived_CONNECTED
  twisted.web.client.Response.html#_bodyDataReceived_CONNECTED
  Function
  Method
  PRIVATE
  Deliver any data received to the protocol to which this `Response` is connected.
- twisted.web.client.Response._bodyDataReceived_DEFERRED_CLOSE
  twisted.web.client.Response.html#_bodyDataReceived_DEFERRED_CLOSE
  Function
  Method
  PRIVATE
  It is invalid for data to be delivered after it has been indicated that the response body has been completely delivered.
- twisted.web.client.Response._bodyDataReceived_FINISHED
  twisted.web.client.Response.html#_bodyDataReceived_FINISHED
  Function
  Method
  PRIVATE
  It is invalid for data to be delivered after the response body has been delivered to a protocol.
- twisted.web.client.Response._bodyDataFinished
  twisted.web.client.Response.html#_bodyDataFinished
  Function
  Method
  PRIVATE
  Called by HTTPClientParser when no more body data is available. If the optional reason is supplied, this indicates a problem or potential problem receiving all of the response body.
- twisted.web.client.Response._bodyDataFinished_INITIAL
  twisted.web.client.Response.html#_bodyDataFinished_INITIAL
  Function
  Method
  PRIVATE
  Move to the `'DEFERRED_CLOSE'` state to wait for a protocol to which to deliver the response body.
- twisted.web.client.Response._reason
  twisted.web.client.Response.html#_reason
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.web.client.Response._bodyDataFinished_CONNECTED
  twisted.web.client.Response.html#_bodyDataFinished_CONNECTED
  Function
  Method
  PRIVATE
  Disconnect the protocol and move to the `'FINISHED'` state.
- twisted.web.client.Response._bodyDataFinished_DEFERRED_CLOSE
  twisted.web.client.Response.html#_bodyDataFinished_DEFERRED_CLOSE
  Function
  Method
  PRIVATE
  It is invalid to attempt to notify the `Response` of the end of the response body data more than once.
- twisted.web.client.Response._bodyDataFinished_FINISHED
  twisted.web.client.Response.html#_bodyDataFinished_FINISHED
  Function
  Method
  PRIVATE
  It is invalid to attempt to notify the `Response` of the end of the response body data more than once.
- twisted.web.client.ResponseDone
  twisted.web.client.ResponseDone.html
  Class
  Exception
  PUBLIC
  `ResponseDone` may be passed to `IProtocol.connectionLost` on the protocol passed to `Response.deliverBody` and indicates that the entire response has been delivered.
- twisted.web.client.ResponseFailed
  twisted.web.client.ResponseFailed.html
  Class
  Exception
  PUBLIC
  `ResponseFailed` indicates that all of the response to a request was not received for some reason.
- twisted.web.client.ResponseFailed.reasons
  twisted.web.client.ResponseFailed.html#reasons
  Attribute
  Instance Variable
  PUBLIC
  A `list` of one or more `Failure` instances giving the reasons the response was considered to have failed.
- twisted.web.client.ResponseFailed.response
  twisted.web.client.ResponseFailed.html#response
  Attribute
  Instance Variable
  PUBLIC
  If specified, the `Response` received from the server (and in particular the status code and the headers).
- twisted.web.client.ResponseFailed.__init__
  twisted.web.client.ResponseFailed.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.client.ResponseNeverReceived
  twisted.web.client.ResponseNeverReceived.html
  Class
  Exception
  PUBLIC
  A `ResponseFailed` that knows no response bytes at all have been received.
- twisted.web.client._requireSSL
  twisted.web.client.html#_requireSSL
  Function
  Function
  PRIVATE
  The decorated method requires pyOpenSSL to be present, or it raises `NotImplementedError`.
- twisted.web.client.WebClientContextFactory
  twisted.web.client.WebClientContextFactory.html
  Class
  Class
  PUBLIC
  This class is deprecated. Please simply use `Agent` as-is, or if you want to customize something, use `BrowserLikePolicyForHTTPS`.
- twisted.web.client.WebClientContextFactory._getCertificateOptions
  twisted.web.client.WebClientContextFactory.html#_getCertificateOptions
  Function
  Method
  PRIVATE
  Return a `CertificateOptions`.
- twisted.web.client.WebClientContextFactory.getContext
  twisted.web.client.WebClientContextFactory.html#getContext
  Function
  Method
  PUBLIC
  Return an `OpenSSL.SSL.Context`.
- twisted.web.client.BrowserLikePolicyForHTTPS
  twisted.web.client.BrowserLikePolicyForHTTPS.html
  Class
  Class
  PUBLIC
  SSL connection creator for web clients.
- twisted.web.client.BrowserLikePolicyForHTTPS.__init__
  twisted.web.client.BrowserLikePolicyForHTTPS.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.client.BrowserLikePolicyForHTTPS._trustRoot
  twisted.web.client.BrowserLikePolicyForHTTPS.html#_trustRoot
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.web.client.BrowserLikePolicyForHTTPS.creatorForNetloc
  twisted.web.client.BrowserLikePolicyForHTTPS.html#creatorForNetloc
  Function
  Method
  PUBLIC
  Create a `client connection creator` for a given network location.
- twisted.web.client.HostnameCachingHTTPSPolicy
  twisted.web.client.HostnameCachingHTTPSPolicy.html
  Class
  Class
  PUBLIC
  IPolicyForHTTPS that wraps a `IPolicyForHTTPS` and caches the created `IOpenSSLClientConnectionCreator`.
- twisted.web.client.HostnameCachingHTTPSPolicy._policyForHTTPS
  twisted.web.client.HostnameCachingHTTPSPolicy.html#_policyForHTTPS
  Attribute
  Instance Variable
  PRIVATE
  See `policyforHTTPS` parameter of `__init__`.
- twisted.web.client.HostnameCachingHTTPSPolicy._cache
  twisted.web.client.HostnameCachingHTTPSPolicy.html#_cache
  Attribute
  Instance Variable
  PRIVATE
  A cache associating hostnames to their `client connection creators`.
- twisted.web.client.HostnameCachingHTTPSPolicy._cacheSize
  twisted.web.client.HostnameCachingHTTPSPolicy.html#_cacheSize
  Attribute
  Instance Variable
  PRIVATE
  See `cacheSize` parameter of `__init__`.
- twisted.web.client.HostnameCachingHTTPSPolicy.__init__
  twisted.web.client.HostnameCachingHTTPSPolicy.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.web.client.HostnameCachingHTTPSPolicy.creatorForNetloc
  twisted.web.client.HostnameCachingHTTPSPolicy.html#creatorForNetloc
  Function
  Method
  PUBLIC
  Create a `client connection creator` for a given network location and cache it for future use.
- twisted.web.client._ContextFactoryWithContext
  twisted.web.client._ContextFactoryWithContext.html
  Class
  Class
  PRIVATE
  A `_ContextFactoryWithContext` is like a `twisted.internet.ssl.ContextFactory` with a pre-created context.
- twisted.web.client._ContextFactoryWithContext._context
  twisted.web.client._ContextFactoryWithContext.html#_context
  Attribute
  Instance Variable
  PRIVATE
  A Context.
- twisted.web.client._ContextFactoryWithContext.__init__
  twisted.web.client._ContextFactoryWithContext.html#__init__
  Function
  Method
  PUBLIC
  Initialize a `_ContextFactoryWithContext` with a context.
- twisted.web.client._ContextFactoryWithContext.getContext
  twisted.web.client._ContextFactoryWithContext.html#getContext
  Function
  Method
  PUBLIC
  Return the context created by `_DeprecatedToCurrentPolicyForHTTPS._webContextFactory`.
- twisted.web.client._DeprecatedToCurrentPolicyForHTTPS
  twisted.web.client._DeprecatedToCurrentPolicyForHTTPS.html
  Class
  Class
  PRIVATE
  Adapt a web context factory to a normal context factory.
- twisted.web.client._DeprecatedToCurrentPolicyForHTTPS._webContextFactory
  twisted.web.client._DeprecatedToCurrentPolicyForHTTPS.html#_webContextFactory
  Attribute
  Instance Variable
  PRIVATE
  An object providing a getContext method with `hostname` and `port` arguments.
- twisted.web.client._DeprecatedToCurrentPolicyForHTTPS.__init__
  twisted.web.client._DeprecatedToCurrentPolicyForHTTPS.html#__init__
  Function
  Method
  PUBLIC
  Wrap a web context factory in an `IPolicyForHTTPS`.
- twisted.web.client._DeprecatedToCurrentPolicyForHTTPS.creatorForNetloc
  twisted.web.client._DeprecatedToCurrentPolicyForHTTPS.html#creatorForNetloc
  Function
  Method
  PUBLIC
  Called the wrapped web context factory's `getContext` method with a hostname and port number and return the resulting context object.
- twisted.web.client.FileBodyProducer
  twisted.web.client.FileBodyProducer.html
  Class
  Class
  PUBLIC
  `FileBodyProducer` produces bytes from an input file object incrementally and writes them to a consumer.
- twisted.web.client.FileBodyProducer._inputFile
  twisted.web.client.FileBodyProducer.html#_inputFile
  Attribute
  Instance Variable
  PRIVATE
  Any file-like object, bytes read from which will be written to a consumer.
- twisted.web.client.FileBodyProducer._cooperate
  twisted.web.client.FileBodyProducer.html#_cooperate
  Attribute
  Instance Variable
  PRIVATE
  A method like `Cooperator.cooperate` which is used to schedule all reads.
- twisted.web.client.FileBodyProducer._readSize
  twisted.web.client.FileBodyProducer.html#_readSize
  Attribute
  Instance Variable
  PRIVATE
  The number of bytes to read from `_inputFile` at a time.
- twisted.web.client.FileBodyProducer.__init__
  twisted.web.client.FileBodyProducer.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.client.FileBodyProducer.length
  twisted.web.client.FileBodyProducer.html#length
  Attribute
  Instance Variable
  PUBLIC
  `length` is a `int` indicating how many bytes in total this `IBodyProducer` will write to the consumer or `UNKNOWN_LENGTH` if this is not known in advance.
- twisted.web.client.FileBodyProducer._determineLength
  twisted.web.client.FileBodyProducer.html#_determineLength
  Function
  Method
  PRIVATE
  Determine how many bytes can be read out of `fObj` (assuming it is not modified from this point on). If the determination cannot be made, return `UNKNOWN_LENGTH`.
- twisted.web.client.FileBodyProducer.stopProducing
  twisted.web.client.FileBodyProducer.html#stopProducing
  Function
  Method
  PUBLIC
  Permanently stop writing bytes from the file to the consumer by stopping the underlying `CooperativeTask`.
- twisted.web.client.FileBodyProducer.startProducing
  twisted.web.client.FileBodyProducer.html#startProducing
  Function
  Method
  PUBLIC
  Start a cooperative task which will read bytes from the input file and write them to `consumer`. Return a `Deferred` which fires after all bytes have been written. If this `Deferred` is cancelled before it is fired, stop reading and writing bytes.
- twisted.web.client.FileBodyProducer._task
  twisted.web.client.FileBodyProducer.html#_task
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.web.client.FileBodyProducer._writeloop
  twisted.web.client.FileBodyProducer.html#_writeloop
  Function
  Method
  PRIVATE
  Return an iterator which reads one chunk of bytes from the input file and writes them to the consumer for each time it is iterated.
- twisted.web.client.FileBodyProducer.pauseProducing
  twisted.web.client.FileBodyProducer.html#pauseProducing
  Function
  Method
  PUBLIC
  Temporarily suspend copying bytes from the input file to the consumer by pausing the `CooperativeTask` which drives that activity.
- twisted.web.client.FileBodyProducer.resumeProducing
  twisted.web.client.FileBodyProducer.html#resumeProducing
  Function
  Method
  PUBLIC
  Undo the effects of a previous `pauseProducing` and resume copying bytes to the consumer by resuming the `CooperativeTask` which drives the write activity.
- twisted.web.client._HTTP11ClientFactory
  twisted.web.client._HTTP11ClientFactory.html
  Class
  Class
  PRIVATE
  A factory for `HTTP11ClientProtocol`, used by `HTTPConnectionPool`.
- twisted.web.client._HTTP11ClientFactory._quiescentCallback
  twisted.web.client._HTTP11ClientFactory.html#_quiescentCallback
  Attribute
  Instance Variable
  PRIVATE
  The quiescent callback to be passed to protocol instances, used to return them to the connection pool.
- twisted.web.client._HTTP11ClientFactory._metadata
  twisted.web.client._HTTP11ClientFactory.html#_metadata
  Attribute
  Instance Variable
  PRIVATE
  Metadata about the low-level connection details, used to make the repr more useful.
- twisted.web.client._HTTP11ClientFactory.__init__
  twisted.web.client._HTTP11ClientFactory.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.client._HTTP11ClientFactory.__repr__
  twisted.web.client._HTTP11ClientFactory.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.client._HTTP11ClientFactory.buildProtocol
  twisted.web.client._HTTP11ClientFactory.html#buildProtocol
  Function
  Method
  PUBLIC
  Create an instance of a subclass of Protocol.
- twisted.web.client._RetryingHTTP11ClientProtocol
  twisted.web.client._RetryingHTTP11ClientProtocol.html
  Class
  Class
  PRIVATE
  A wrapper for `HTTP11ClientProtocol` that automatically retries requests.
- twisted.web.client._RetryingHTTP11ClientProtocol._clientProtocol
  twisted.web.client._RetryingHTTP11ClientProtocol.html#_clientProtocol
  Attribute
  Instance Variable
  PRIVATE
  The underlying `HTTP11ClientProtocol`.
- twisted.web.client._RetryingHTTP11ClientProtocol._newConnection
  twisted.web.client._RetryingHTTP11ClientProtocol.html#_newConnection
  Attribute
  Instance Variable
  PRIVATE
  A callable that creates a new connection for a retry.
- twisted.web.client._RetryingHTTP11ClientProtocol.__init__
  twisted.web.client._RetryingHTTP11ClientProtocol.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.client._RetryingHTTP11ClientProtocol._shouldRetry
  twisted.web.client._RetryingHTTP11ClientProtocol.html#_shouldRetry
  Function
  Method
  PRIVATE
  Indicate whether request should be retried.
- twisted.web.client._RetryingHTTP11ClientProtocol.request
  twisted.web.client._RetryingHTTP11ClientProtocol.html#request
  Function
  Method
  PUBLIC
  Do a request, and retry once (with a new connection) if it fails in a retryable manner.
- twisted.web.client.HTTPConnectionPool
  twisted.web.client.HTTPConnectionPool.html
  Class
  Class
  PUBLIC
  A pool of persistent HTTP connections.
- twisted.web.client.HTTPConnectionPool.persistent
  twisted.web.client.HTTPConnectionPool.html#persistent
  Attribute
  Instance Variable
  PUBLIC
  Boolean indicating whether connections should be persistent. Connections are persistent by default.
- twisted.web.client.HTTPConnectionPool.maxPersistentPerHost
  twisted.web.client.HTTPConnectionPool.html#maxPersistentPerHost
  Attribute
  Instance Variable
  PUBLIC
  The maximum number of cached persistent connections for a `host:port` destination.
- twisted.web.client.HTTPConnectionPool.cachedConnectionTimeout
  twisted.web.client.HTTPConnectionPool.html#cachedConnectionTimeout
  Attribute
  Instance Variable
  PUBLIC
  Number of seconds a cached persistent connection will stay open before disconnecting.
- twisted.web.client.HTTPConnectionPool.retryAutomatically
  twisted.web.client.HTTPConnectionPool.html#retryAutomatically
  Attribute
  Instance Variable
  PUBLIC
  `boolean` indicating whether idempotent requests should be retried once if no response was received.
- twisted.web.client.HTTPConnectionPool._factory
  twisted.web.client.HTTPConnectionPool.html#_factory
  Attribute
  Instance Variable
  PRIVATE
  The factory used to connect to the proxy.
- twisted.web.client.HTTPConnectionPool._connections
  twisted.web.client.HTTPConnectionPool.html#_connections
  Attribute
  Instance Variable
  PRIVATE
  Map (scheme, host, port) to lists of `HTTP11ClientProtocol` instances.
- twisted.web.client.HTTPConnectionPool._timeouts
  twisted.web.client.HTTPConnectionPool.html#_timeouts
  Attribute
  Instance Variable
  PRIVATE
  Map `HTTP11ClientProtocol` instances to a `IDelayedCall` instance of their timeout.
- twisted.web.client.HTTPConnectionPool._log
  twisted.web.client.HTTPConnectionPool.html#_log
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.web.client.HTTPConnectionPool.__init__
  twisted.web.client.HTTPConnectionPool.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.client.HTTPConnectionPool._reactor
  twisted.web.client.HTTPConnectionPool.html#_reactor
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.web.client.HTTPConnectionPool.getConnection
  twisted.web.client.HTTPConnectionPool.html#getConnection
  Function
  Method
  PUBLIC
  Supply a connection, newly created or retrieved from the pool, to be used for one HTTP request.
- twisted.web.client.HTTPConnectionPool._newConnection
  twisted.web.client.HTTPConnectionPool.html#_newConnection
  Function
  Method
  PRIVATE
  Create a new connection.
- twisted.web.client.HTTPConnectionPool._removeConnection
  twisted.web.client.HTTPConnectionPool.html#_removeConnection
  Function
  Method
  PRIVATE
  Remove a connection from the cache and disconnect it.
- twisted.web.client.HTTPConnectionPool._putConnection
  twisted.web.client.HTTPConnectionPool.html#_putConnection
  Function
  Method
  PRIVATE
  Return a persistent connection to the pool. This will be called by `HTTP11ClientProtocol` when the connection becomes quiescent.
- twisted.web.client.HTTPConnectionPool.closeCachedConnections
  twisted.web.client.HTTPConnectionPool.html#closeCachedConnections
  Function
  Method
  PUBLIC
  Close all persistent connections and remove them from the pool.
- twisted.web.client._AgentBase
  twisted.web.client._AgentBase.html
  Class
  Class
  PRIVATE
  Base class offering common facilities for `Agent`-type classes.
- twisted.web.client._AgentBase._reactor
  twisted.web.client._AgentBase.html#_reactor
  Attribute
  Instance Variable
  PRIVATE
  The `IReactorTime` implementation which will be used by the pool, and perhaps by subclasses as well.
- twisted.web.client._AgentBase._pool
  twisted.web.client._AgentBase.html#_pool
  Attribute
  Instance Variable
  PRIVATE
  The `HTTPConnectionPool` used to manage HTTP connections.
- twisted.web.client._AgentBase.__init__
  twisted.web.client._AgentBase.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.client._AgentBase._computeHostValue
  twisted.web.client._AgentBase.html#_computeHostValue
  Function
  Method
  PRIVATE
  Compute the string to use for the value of the Host header, based on the given scheme, host name, and port number.
- twisted.web.client._AgentBase._requestWithEndpoint
  twisted.web.client._AgentBase.html#_requestWithEndpoint
  Function
  Method
  PRIVATE
  Issue a new request, given the endpoint and the path sent as part of the request.
- twisted.web.client._StandardEndpointFactory
  twisted.web.client._StandardEndpointFactory.html
  Class
  Class
  PRIVATE
  Standard HTTP endpoint destinations - TCP for HTTP, TCP+TLS for HTTPS.
- twisted.web.client._StandardEndpointFactory._policyForHTTPS
  twisted.web.client._StandardEndpointFactory.html#_policyForHTTPS
  Attribute
  Instance Variable
  PRIVATE
  A web context factory which will be used to create SSL context objects for any SSL connections the agent needs to make.
- twisted.web.client._StandardEndpointFactory._connectTimeout
  twisted.web.client._StandardEndpointFactory.html#_connectTimeout
  Attribute
  Instance Variable
  PRIVATE
  If not `None`, the timeout passed to `HostnameEndpoint` for specifying the connection timeout.
- twisted.web.client._StandardEndpointFactory._bindAddress
  twisted.web.client._StandardEndpointFactory.html#_bindAddress
  Attribute
  Instance Variable
  PRIVATE
  If not `None`, the address passed to `HostnameEndpoint` for specifying the local address to bind to.
- twisted.web.client._StandardEndpointFactory.__init__
  twisted.web.client._StandardEndpointFactory.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.web.client._StandardEndpointFactory._reactor
  twisted.web.client._StandardEndpointFactory.html#_reactor
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.web.client._StandardEndpointFactory.endpointForURI
  twisted.web.client._StandardEndpointFactory.html#endpointForURI
  Function
  Method
  PUBLIC
  Connect directly over TCP for `b'http'` scheme, and TLS for `b'https'`.
- twisted.web.client.Agent
  twisted.web.client.Agent.html
  Class
  Class
  PUBLIC
  `Agent` is a very basic HTTP client. It supports HTTP and HTTPS scheme URIs.
- twisted.web.client.Agent._pool
  twisted.web.client.Agent.html#_pool
  Attribute
  Instance Variable
  PRIVATE
  An `HTTPConnectionPool` instance.
- twisted.web.client.Agent._endpointFactory
  twisted.web.client.Agent.html#_endpointFactory
  Attribute
  Instance Variable
  PRIVATE
  The `IAgentEndpointFactory` which will be used to create endpoints for outgoing connections.
- twisted.web.client.Agent.__init__
  twisted.web.client.Agent.html#__init__
  Function
  Method
  PUBLIC
  Create an `Agent`.
- twisted.web.client.Agent.usingEndpointFactory
  twisted.web.client.Agent.html#usingEndpointFactory
  Function
  Class Method
  PUBLIC
  Create a new `Agent` that will use the endpoint factory to figure out how to connect to the server.
- twisted.web.client.Agent._init
  twisted.web.client.Agent.html#_init
  Function
  Method
  PRIVATE
  Initialize a new `Agent`.
- twisted.web.client.Agent._getEndpoint
  twisted.web.client.Agent.html#_getEndpoint
  Function
  Method
  PRIVATE
  Get an endpoint for the given URI, using `self._endpointFactory`.
- twisted.web.client.Agent.request
  twisted.web.client.Agent.html#request
  Function
  Method
  PUBLIC
  Issue a request to the server indicated by the given `uri`.
- twisted.web.client.ProxyAgent
  twisted.web.client.ProxyAgent.html
  Class
  Class
  PUBLIC
  An HTTP agent able to cross HTTP proxies.
- twisted.web.client.ProxyAgent._proxyEndpoint
  twisted.web.client.ProxyAgent.html#_proxyEndpoint
  Attribute
  Instance Variable
  PRIVATE
  The endpoint used to connect to the proxy.
- twisted.web.client.ProxyAgent.__init__
  twisted.web.client.ProxyAgent.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.client.ProxyAgent.request
  twisted.web.client.ProxyAgent.html#request
  Function
  Method
  PUBLIC
  Issue a new request via the configured proxy.
- twisted.web.client._FakeUrllib2Request
  twisted.web.client._FakeUrllib2Request.html
  Class
  Class
  PRIVATE
  A fake `urllib2.Request` object for `cookielib` to work with.
- twisted.web.client._FakeUrllib2Request.uri
  twisted.web.client._FakeUrllib2Request.html#uri
  Attribute
  Instance Variable
  PUBLIC
  Request URI.
- twisted.web.client._FakeUrllib2Request.headers
  twisted.web.client._FakeUrllib2Request.html#headers
  Attribute
  Instance Variable
  PUBLIC
  Request headers.
- twisted.web.client._FakeUrllib2Request.type
  twisted.web.client._FakeUrllib2Request.html#type
  Attribute
  Instance Variable
  PUBLIC
  The scheme of the URI.
- twisted.web.client._FakeUrllib2Request.host
  twisted.web.client._FakeUrllib2Request.html#host
  Attribute
  Instance Variable
  PUBLIC
  The host[:port] of the URI.
- twisted.web.client._FakeUrllib2Request.__init__
  twisted.web.client._FakeUrllib2Request.html#__init__
  Function
  Method
  PUBLIC
  Create a fake Urllib2 request.
- twisted.web.client._FakeUrllib2Request.origin_req_host
  twisted.web.client._FakeUrllib2Request.html#origin_req_host
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.client._FakeUrllib2Request.unverifiable
  twisted.web.client._FakeUrllib2Request.html#unverifiable
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.client._FakeUrllib2Request.has_header
  twisted.web.client._FakeUrllib2Request.html#has_header
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.client._FakeUrllib2Request.add_unredirected_header
  twisted.web.client._FakeUrllib2Request.html#add_unredirected_header
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.client._FakeUrllib2Request.get_full_url
  twisted.web.client._FakeUrllib2Request.html#get_full_url
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.client._FakeUrllib2Request.get_header
  twisted.web.client._FakeUrllib2Request.html#get_header
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.client._FakeUrllib2Request.get_host
  twisted.web.client._FakeUrllib2Request.html#get_host
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.client._FakeUrllib2Request.get_type
  twisted.web.client._FakeUrllib2Request.html#get_type
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.client._FakeUrllib2Request.is_unverifiable
  twisted.web.client._FakeUrllib2Request.html#is_unverifiable
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.client._FakeUrllib2Response
  twisted.web.client._FakeUrllib2Response.html
  Class
  Class
  PRIVATE
  A fake `urllib2.Response` object for `cookielib` to work with.
- twisted.web.client._FakeUrllib2Response.response
  twisted.web.client._FakeUrllib2Response.html#response
  Attribute
  Instance Variable
  PUBLIC
  Underlying Twisted Web response.
- twisted.web.client._FakeUrllib2Response.__init__
  twisted.web.client._FakeUrllib2Response.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.client._FakeUrllib2Response.info
  twisted.web.client._FakeUrllib2Response.html#info
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.client.CookieAgent
  twisted.web.client.CookieAgent.html
  Class
  Class
  PUBLIC
  `CookieAgent` extends the basic `Agent` to add RFC-compliant handling of HTTP cookies. Cookies are written to and extracted from a `cookielib.CookieJar` instance.
- twisted.web.client.CookieAgent._agent
  twisted.web.client.CookieAgent.html#_agent
  Attribute
  Instance Variable
  PRIVATE
  Underlying Twisted Web agent to issue requests through.
- twisted.web.client.CookieAgent.cookieJar
  twisted.web.client.CookieAgent.html#cookieJar
  Attribute
  Instance Variable
  PUBLIC
  Initialized cookie jar to read cookies from and store cookies to.
- twisted.web.client.CookieAgent.__init__
  twisted.web.client.CookieAgent.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.client.CookieAgent.request
  twisted.web.client.CookieAgent.html#request
  Function
  Method
  PUBLIC
  Issue a new request to the wrapped `Agent`.
- twisted.web.client.CookieAgent._extractCookies
  twisted.web.client.CookieAgent.html#_extractCookies
  Function
  Method
  PRIVATE
  Extract response cookies and store them in the cookie jar.
- twisted.web.client.GzipDecoder
  twisted.web.client.GzipDecoder.html
  Class
  Class
  PUBLIC
  A wrapper for a `Response` instance which handles gzip'ed body.
- twisted.web.client.GzipDecoder.original
  twisted.web.client.GzipDecoder.html#original
  Attribute
  Instance Variable
  PUBLIC
  The original `Response` object.
- twisted.web.client.GzipDecoder.__init__
  twisted.web.client.GzipDecoder.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.client.GzipDecoder.length
  twisted.web.client.GzipDecoder.html#length
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.client.GzipDecoder.deliverBody
  twisted.web.client.GzipDecoder.html#deliverBody
  Function
  Method
  PUBLIC
  Override `deliverBody` to wrap the given `protocol` with `_GzipProtocol`.
- twisted.web.client._GzipProtocol
  twisted.web.client._GzipProtocol.html
  Class
  Class
  PRIVATE
  A `Protocol` implementation which wraps another one, transparently decompressing received data.
- twisted.web.client._GzipProtocol._zlibDecompress
  twisted.web.client._GzipProtocol.html#_zlibDecompress
  Attribute
  Instance Variable
  PRIVATE
  A zlib decompress object used to decompress the data stream.
- twisted.web.client._GzipProtocol._response
  twisted.web.client._GzipProtocol.html#_response
  Attribute
  Instance Variable
  PRIVATE
  A reference to the original response, in case of errors.
- twisted.web.client._GzipProtocol.__init__
  twisted.web.client._GzipProtocol.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.client._GzipProtocol.original
  twisted.web.client._GzipProtocol.html#original
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.client._GzipProtocol.dataReceived
  twisted.web.client._GzipProtocol.html#dataReceived
  Function
  Method
  PUBLIC
  Decompress `data` with the zlib decompressor, forwarding the raw data to the original protocol.
- twisted.web.client._GzipProtocol.connectionLost
  twisted.web.client._GzipProtocol.html#connectionLost
  Function
  Method
  PUBLIC
  Forward the connection lost event, flushing remaining data from the decompressor if any.
- twisted.web.client.ContentDecoderAgent
  twisted.web.client.ContentDecoderAgent.html
  Class
  Class
  PUBLIC
  An `Agent` wrapper to handle encoded content.
- twisted.web.client.ContentDecoderAgent.__init__
  twisted.web.client.ContentDecoderAgent.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.client.ContentDecoderAgent._agent
  twisted.web.client.ContentDecoderAgent.html#_agent
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.web.client.ContentDecoderAgent._decoders
  twisted.web.client.ContentDecoderAgent.html#_decoders
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.web.client.ContentDecoderAgent._supported
  twisted.web.client.ContentDecoderAgent.html#_supported
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.web.client.ContentDecoderAgent.request
  twisted.web.client.ContentDecoderAgent.html#request
  Function
  Method
  PUBLIC
  Send a client request which declares supporting compressed content.
- twisted.web.client.ContentDecoderAgent._handleResponse
  twisted.web.client.ContentDecoderAgent.html#_handleResponse
  Function
  Method
  PRIVATE
  Check if the response is encoded, and wrap it to handle decompression.
- twisted.web.client._canonicalHeaderName
  twisted.web.client.html#_canonicalHeaderName
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.web.client._defaultSensitiveHeaders
  twisted.web.client.html#_defaultSensitiveHeaders
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.web.client.RedirectAgent
  twisted.web.client.RedirectAgent.html
  Class
  Class
  PUBLIC
  An `Agent` wrapper which handles HTTP redirects.
- twisted.web.client.RedirectAgent._redirectResponses
  twisted.web.client.RedirectAgent.html#_redirectResponses
  Attribute
  Class Variable
  PRIVATE
  A `list` of HTTP status codes to be redirected for GET and HEAD methods.
- twisted.web.client.RedirectAgent._seeOtherResponses
  twisted.web.client.RedirectAgent.html#_seeOtherResponses
  Attribute
  Class Variable
  PRIVATE
  A `list` of HTTP status codes to be redirected for any method and the method altered to GET.
- twisted.web.client.RedirectAgent.__init__
  twisted.web.client.RedirectAgent.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.client.RedirectAgent._agent
  twisted.web.client.RedirectAgent.html#_agent
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.web.client.RedirectAgent._redirectLimit
  twisted.web.client.RedirectAgent.html#_redirectLimit
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.web.client.RedirectAgent._sensitiveHeaderNames
  twisted.web.client.RedirectAgent.html#_sensitiveHeaderNames
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.web.client.RedirectAgent.request
  twisted.web.client.RedirectAgent.html#request
  Function
  Method
  PUBLIC
  Send a client request following HTTP redirects.
- twisted.web.client.RedirectAgent._resolveLocation
  twisted.web.client.RedirectAgent.html#_resolveLocation
  Function
  Method
  PRIVATE
  Resolve the redirect location against the request URI.
- twisted.web.client.RedirectAgent._handleRedirect
  twisted.web.client.RedirectAgent.html#_handleRedirect
  Function
  Method
  PRIVATE
  Handle a redirect response, checking the number of redirects already followed, and extracting the location header fields.
- twisted.web.client.RedirectAgent._handleResponse
  twisted.web.client.RedirectAgent.html#_handleResponse
  Function
  Method
  PRIVATE
  Handle the response, making another request if it indicates a redirect.
- twisted.web.client.BrowserLikeRedirectAgent
  twisted.web.client.BrowserLikeRedirectAgent.html
  Class
  Class
  PUBLIC
  An `Agent` wrapper which handles HTTP redirects in the same fashion as web browsers.
- twisted.web.client.BrowserLikeRedirectAgent._redirectResponses
  twisted.web.client.BrowserLikeRedirectAgent.html#_redirectResponses
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.web.client.BrowserLikeRedirectAgent._seeOtherResponses
  twisted.web.client.BrowserLikeRedirectAgent.html#_seeOtherResponses
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.web.client._ReadBodyProtocol
  twisted.web.client._ReadBodyProtocol.html
  Class
  Class
  PRIVATE
  Protocol that collects data sent to it.
- twisted.web.client._ReadBodyProtocol.deferred
  twisted.web.client._ReadBodyProtocol.html#deferred
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`.
- twisted.web.client._ReadBodyProtocol.status
  twisted.web.client._ReadBodyProtocol.html#status
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`.
- twisted.web.client._ReadBodyProtocol.message
  twisted.web.client._ReadBodyProtocol.html#message
  Attribute
  Instance Variable
  PUBLIC
  See `__init__`.
- twisted.web.client._ReadBodyProtocol.dataBuffer
  twisted.web.client._ReadBodyProtocol.html#dataBuffer
  Attribute
  Instance Variable
  PUBLIC
  list of byte-strings received
- twisted.web.client._ReadBodyProtocol.__init__
  twisted.web.client._ReadBodyProtocol.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.web.client._ReadBodyProtocol.dataReceived
  twisted.web.client._ReadBodyProtocol.html#dataReceived
  Function
  Method
  PUBLIC
  Accumulate some more bytes from the response.
- twisted.web.client._ReadBodyProtocol.connectionLost
  twisted.web.client._ReadBodyProtocol.html#connectionLost
  Function
  Method
  PUBLIC
  Deliver the accumulated response bytes to the waiting `Deferred`, if the response body has been completely received without error.
- twisted.web.client.readBody
  twisted.web.client.html#readBody
  Function
  Function
  PUBLIC
  Get the body of an `IResponse` and return it as a byte string.
- twisted.web.server.NOT_DONE_YET
  twisted.web.server.html#NOT_DONE_YET
  Attribute
  Constant
  PUBLIC
  A token value which `twisted.web.resource.IResource.render` implementations can return to indicate that the application will later call `.write` and `.finish` to complete the request, and that the HTTP connection should be left open.
- twisted.web.server.supportedMethods
  twisted.web.server.html#supportedMethods
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.web.server.quote
  twisted.web.server.html#quote
  Function
  Function
  PUBLIC
  Undocumented
- twisted.web.server._addressToTuple
  twisted.web.server.html#_addressToTuple
  Function
  Function
  PRIVATE
  Undocumented
- twisted.web.server.Request
  twisted.web.server.Request.html
  Class
  Class
  PUBLIC
  An HTTP request.
- twisted.web.server.Request.defaultContentType
  twisted.web.server.Request.html#defaultContentType
  Attribute
  Instance Variable
  PUBLIC
  A `bytes` giving the default Content-Type value to send in responses if no other value is set. `None` disables the default.
- twisted.web.server.Request._insecureSession
  twisted.web.server.Request.html#_insecureSession
  Attribute
  Instance Variable
  PRIVATE
  The `Session` object representing state that will be transmitted over plain-text HTTP.
- twisted.web.server.Request._secureSession
  twisted.web.server.Request.html#_secureSession
  Attribute
  Instance Variable
  PRIVATE
  The `Session` object representing the state that will be transmitted only over HTTPS.
- twisted.web.server.Request.site
  twisted.web.server.Request.html#site
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.server.Request.appRootURL
  twisted.web.server.Request.html#appRootURL
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.server.Request.prepath
  twisted.web.server.Request.html#prepath
  Attribute
  Instance Variable
  PUBLIC
  The URL path segments which have been processed during resource traversal, as a list of `bytes`.
- twisted.web.server.Request.postpath
  twisted.web.server.Request.html#postpath
  Attribute
  Instance Variable
  PUBLIC
  The URL path segments which have not (yet) been processed during resource traversal, as a list of `bytes`.
- twisted.web.server.Request.__pychecker__
  twisted.web.server.Request.html#__pychecker__
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.web.server.Request._inFakeHead
  twisted.web.server.Request.html#_inFakeHead
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.web.server.Request._encoder
  twisted.web.server.Request.html#_encoder
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.web.server.Request._log
  twisted.web.server.Request.html#_log
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.web.server.Request.__init__
  twisted.web.server.Request.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.web.server.Request.getStateToCopyFor
  twisted.web.server.Request.html#getStateToCopyFor
  Function
  Method
  PUBLIC
  Gather state to send when I am serialized for a particular perspective.
- twisted.web.server.Request.sibLink
  twisted.web.server.Request.html#sibLink
  Function
  Method
  PUBLIC
  Return the text that links to a sibling of the requested resource.
- twisted.web.server.Request.childLink
  twisted.web.server.Request.html#childLink
  Function
  Method
  PUBLIC
  Return the text that links to a child of the requested resource.
- twisted.web.server.Request.gotLength
  twisted.web.server.Request.html#gotLength
  Function
  Method
  PUBLIC
  Called when HTTP channel got length of content in this request.
- twisted.web.server.Request.process
  twisted.web.server.Request.html#process
  Function
  Method
  PUBLIC
  Process a request.
- twisted.web.server.Request.write
  twisted.web.server.Request.html#write
  Function
  Method
  PUBLIC
  Write data to the transport (if not responding to a HEAD request).
- twisted.web.server.Request.finish
  twisted.web.server.Request.html#finish
  Function
  Method
  PUBLIC
  Override `http.Request.finish` for possible encoding.
- twisted.web.server.Request.render
  twisted.web.server.Request.html#render
  Function
  Method
  PUBLIC
  Ask a resource to render itself.
- twisted.web.server.Request.processingFailed
  twisted.web.server.Request.html#processingFailed
  Function
  Method
  PUBLIC
  Finish this request with an indication that processing failed and possibly display a traceback.
- twisted.web.server.Request.view_write
  twisted.web.server.Request.html#view_write
  Function
  Method
  PUBLIC
  Remote version of write; same interface.
- twisted.web.server.Request.view_finish
  twisted.web.server.Request.html#view_finish
  Function
  Method
  PUBLIC
  Remote version of finish; same interface.
- twisted.web.server.Request.view_addCookie
  twisted.web.server.Request.html#view_addCookie
  Function
  Method
  PUBLIC
  Remote version of addCookie; same interface.
- twisted.web.server.Request.view_setHeader
  twisted.web.server.Request.html#view_setHeader
  Function
  Method
  PUBLIC
  Remote version of setHeader; same interface.
- twisted.web.server.Request.view_setLastModified
  twisted.web.server.Request.html#view_setLastModified
  Function
  Method
  PUBLIC
  Remote version of setLastModified; same interface.
- twisted.web.server.Request.view_setETag
  twisted.web.server.Request.html#view_setETag
  Function
  Method
  PUBLIC
  Remote version of setETag; same interface.
- twisted.web.server.Request.view_setResponseCode
  twisted.web.server.Request.html#view_setResponseCode
  Function
  Method
  PUBLIC
  Remote version of setResponseCode; same interface.
- twisted.web.server.Request.view_registerProducer
  twisted.web.server.Request.html#view_registerProducer
  Function
  Method
  PUBLIC
  Remote version of registerProducer; same interface. (requires a remote producer.)
- twisted.web.server.Request.view_unregisterProducer
  twisted.web.server.Request.html#view_unregisterProducer
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.server.Request.session
  twisted.web.server.Request.html#session
  Attribute
  Property
  PUBLIC
  If a session has already been created or looked up with `Request.getSession`, this will return that object. (This will always be the session that matches the security of the request; so if `forceNotSecure`...
- twisted.web.server.Request.getSession
  twisted.web.server.Request.html#getSession
  Function
  Method
  PUBLIC
  Check if there is a session cookie, and if not, create it.
- twisted.web.server.Request._prePathURL
  twisted.web.server.Request.html#_prePathURL
  Function
  Method
  PRIVATE
  Undocumented
- twisted.web.server.Request.prePathURL
  twisted.web.server.Request.html#prePathURL
  Function
  Method
  PUBLIC
  At any time during resource traversal or resource rendering, returns an absolute URL to the most nested resource which has yet been reached.
- twisted.web.server.Request.URLPath
  twisted.web.server.Request.html#URLPath
  Function
  Method
  PUBLIC
  No summary
- twisted.web.server.Request.rememberRootURL
  twisted.web.server.Request.html#rememberRootURL
  Function
  Method
  PUBLIC
  Remember the currently-processed part of the URL for later recalling.
- twisted.web.server.Request.getRootURL
  twisted.web.server.Request.html#getRootURL
  Function
  Method
  PUBLIC
  Get a previously-remembered URL.
- twisted.web.server.Request._handleStar
  twisted.web.server.Request.html#_handleStar
  Function
  Method
  PRIVATE
  Handle receiving a request whose path is '*'.
- twisted.web.server.GzipEncoderFactory
  twisted.web.server.GzipEncoderFactory.html
  Class
  Class
  PUBLIC
  No summary
- twisted.web.server.GzipEncoderFactory.compressLevel
  twisted.web.server.GzipEncoderFactory.html#compressLevel
  Attribute
  Class Variable
  PUBLIC
  The compression level used by the compressor, default to 9 (highest).
- twisted.web.server.GzipEncoderFactory._gzipCheckRegex
  twisted.web.server.GzipEncoderFactory.html#_gzipCheckRegex
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.web.server.GzipEncoderFactory.encoderForRequest
  twisted.web.server.GzipEncoderFactory.html#encoderForRequest
  Function
  Method
  PUBLIC
  Check the headers if the client accepts gzip encoding, and encodes the request if so.
- twisted.web.server._GzipEncoder
  twisted.web.server._GzipEncoder.html
  Class
  Class
  PRIVATE
  An encoder which supports gzip.
- twisted.web.server._GzipEncoder._zlibCompressor
  twisted.web.server._GzipEncoder.html#_zlibCompressor
  Attribute
  Instance Variable
  PRIVATE
  The zlib compressor instance used to compress the stream.
- twisted.web.server._GzipEncoder._request
  twisted.web.server._GzipEncoder.html#_request
  Attribute
  Instance Variable
  PRIVATE
  A reference to the originating request.
- twisted.web.server._GzipEncoder.__init__
  twisted.web.server._GzipEncoder.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.server._GzipEncoder.encode
  twisted.web.server._GzipEncoder.html#encode
  Function
  Method
  PUBLIC
  Write to the request, automatically compressing data on the fly.
- twisted.web.server._GzipEncoder.finish
  twisted.web.server._GzipEncoder.html#finish
  Function
  Method
  PUBLIC
  Finish handling the request request, flushing any data from the zlib buffer.
- twisted.web.server._RemoteProducerWrapper
  twisted.web.server._RemoteProducerWrapper.html
  Class
  Class
  PRIVATE
  Undocumented
- twisted.web.server._RemoteProducerWrapper.__init__
  twisted.web.server._RemoteProducerWrapper.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.server._RemoteProducerWrapper.resumeProducing
  twisted.web.server._RemoteProducerWrapper.html#resumeProducing
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.server._RemoteProducerWrapper.pauseProducing
  twisted.web.server._RemoteProducerWrapper.html#pauseProducing
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.server._RemoteProducerWrapper.stopProducing
  twisted.web.server._RemoteProducerWrapper.html#stopProducing
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.server.Session
  twisted.web.server.Session.html
  Class
  Class
  PUBLIC
  A user's session with a system.
- twisted.web.server.Session.site
  twisted.web.server.Session.html#site
  Attribute
  Instance Variable
  PUBLIC
  The `Site` that generated the session.
- twisted.web.server.Session.uid
  twisted.web.server.Session.html#uid
  Attribute
  Instance Variable
  PUBLIC
  A unique identifier for the session.
- twisted.web.server.Session._reactor
  twisted.web.server.Session.html#_reactor
  Attribute
  Instance Variable
  PRIVATE
  An object providing `IReactorTime` to use for scheduling expiration.
- twisted.web.server.Session.sessionTimeout
  twisted.web.server.Session.html#sessionTimeout
  Attribute
  Instance Variable
  PUBLIC
  Time after last modification the session will expire, in seconds.
- twisted.web.server.Session.lastModified
  twisted.web.server.Session.html#lastModified
  Attribute
  Instance Variable
  PUBLIC
  Time the `touch()` method was last called (or time the session was created). A UNIX timestamp as returned by `IReactorTime.seconds()`.
- twisted.web.server.Session._expireCall
  twisted.web.server.Session.html#_expireCall
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.web.server.Session.__init__
  twisted.web.server.Session.html#__init__
  Function
  Method
  PUBLIC
  Initialize a session with a unique ID for that session.
- twisted.web.server.Session.expireCallbacks
  twisted.web.server.Session.html#expireCallbacks
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.server.Session.sessionNamespaces
  twisted.web.server.Session.html#sessionNamespaces
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.server.Session.startCheckingExpiration
  twisted.web.server.Session.html#startCheckingExpiration
  Function
  Method
  PUBLIC
  Start expiration tracking.
- twisted.web.server.Session.notifyOnExpire
  twisted.web.server.Session.html#notifyOnExpire
  Function
  Method
  PUBLIC
  Call this callback when the session expires or logs out.
- twisted.web.server.Session.expire
  twisted.web.server.Session.html#expire
  Function
  Method
  PUBLIC
  Expire/logout of the session.
- twisted.web.server.Session.touch
  twisted.web.server.Session.html#touch
  Function
  Method
  PUBLIC
  Mark the session as modified, which resets expiration timer.
- twisted.web.server.version
  twisted.web.server.html#version
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.web.server.Site
  twisted.web.server.Site.html
  Class
  Class
  PUBLIC
  A web site: manage log, sessions, and resources.
- twisted.web.server.Site.requestFactory
  twisted.web.server.Site.html#requestFactory
  Attribute
  Instance Variable
  PUBLIC
  A factory which is called with (channel) and creates `Request` instances. Default to `Request`.
- twisted.web.server.Site.displayTracebacks
  twisted.web.server.Site.html#displayTracebacks
  Attribute
  Instance Variable
  PUBLIC
  If set, unhandled exceptions raised during rendering are returned to the client as HTML. Default to `False`.
- twisted.web.server.Site.sessionFactory
  twisted.web.server.Site.html#sessionFactory
  Attribute
  Instance Variable
  PUBLIC
  factory for sessions objects. Default to `Session`.
- twisted.web.server.Site.sessions
  twisted.web.server.Site.html#sessions
  Attribute
  Instance Variable
  PUBLIC
  Mapping of session IDs to objects returned by `sessionFactory`.
- twisted.web.server.Site.counter
  twisted.web.server.Site.html#counter
  Attribute
  Instance Variable
  PUBLIC
  The number of sessions that have been generated.
- twisted.web.server.Site.sessionCheckTime
  twisted.web.server.Site.html#sessionCheckTime
  Attribute
  Instance Variable
  PUBLIC
  Deprecated and unused. See `Session.sessionTimeout` instead.
- twisted.web.server.Site.__init__
  twisted.web.server.Site.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.web.server.Site.resource
  twisted.web.server.Site.html#resource
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.server.Site._openLogFile
  twisted.web.server.Site.html#_openLogFile
  Function
  Method
  PRIVATE
  Override in subclasses, e.g. to use `twisted.python.logfile`.
- twisted.web.server.Site.__getstate__
  twisted.web.server.Site.html#__getstate__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.server.Site._mkuid
  twisted.web.server.Site.html#_mkuid
  Function
  Method
  PRIVATE
  (internal) Generate an opaque, unique ID for a user's session.
- twisted.web.server.Site.makeSession
  twisted.web.server.Site.html#makeSession
  Function
  Method
  PUBLIC
  Generate a new Session instance, and store it for future reference.
- twisted.web.server.Site.getSession
  twisted.web.server.Site.html#getSession
  Function
  Method
  PUBLIC
  Get a previously generated session.
- twisted.web.server.Site.buildProtocol
  twisted.web.server.Site.html#buildProtocol
  Function
  Method
  PUBLIC
  Generate a channel attached to this site.
- twisted.web.server.Site.isLeaf
  twisted.web.server.Site.html#isLeaf
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.web.server.Site.render
  twisted.web.server.Site.html#render
  Function
  Method
  PUBLIC
  Redirect because a Site is always a directory.
- twisted.web.server.Site.getChildWithDefault
  twisted.web.server.Site.html#getChildWithDefault
  Function
  Method
  PUBLIC
  Emulate a resource's getChild method.
- twisted.web.server.Site.getResourceFor
  twisted.web.server.Site.html#getResourceFor
  Function
  Method
  PUBLIC
  Get a resource for a request.
- twisted.web.server.Site.acceptableProtocols
  twisted.web.server.Site.html#acceptableProtocols
  Function
  Method
  PUBLIC
  Protocols this server can speak.
- twisted.web.static.dangerousPathError
  twisted.web.static.html#dangerousPathError
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.web.static.isDangerous
  twisted.web.static.html#isDangerous
  Function
  Function
  PUBLIC
  Undocumented
- twisted.web.static.Data
  twisted.web.static.Data.html
  Class
  Class
  PUBLIC
  This is a static, in-memory resource.
- twisted.web.static.Data.__init__
  twisted.web.static.Data.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.web.static.Data.data
  twisted.web.static.Data.html#data
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.static.Data.type
  twisted.web.static.Data.html#type
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.static.Data.render_GET
  twisted.web.static.Data.html#render_GET
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.static.addSlash
  twisted.web.static.html#addSlash
  Function
  Function
  PUBLIC
  Add a trailing slash to `request`'s URI. Deprecated, do not use.
- twisted.web.static._addSlash
  twisted.web.static.html#_addSlash
  Function
  Function
  PRIVATE
  Add a trailing slash to `request`'s URI.
- twisted.web.static.Redirect
  twisted.web.static.Redirect.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.web.static.Redirect.__init__
  twisted.web.static.Redirect.html#__init__
  Function
  Method
  PUBLIC
  Initialize.
- twisted.web.static.Redirect.url
  twisted.web.static.Redirect.html#url
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.static.Redirect.render
  twisted.web.static.Redirect.html#render
  Function
  Method
  PUBLIC
  Render a given resource. See `IResource`'s render method.
- twisted.web.static.Registry
  twisted.web.static.Registry.html
  Class
  Class
  PUBLIC
  I am a Componentized object that will be made available to internal Twisted file-based dynamic web content such as .rpy and .epy scripts.
- twisted.web.static.Registry.__init__
  twisted.web.static.Registry.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.static.Registry._pathCache
  twisted.web.static.Registry.html#_pathCache
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.web.static.Registry.cachePath
  twisted.web.static.Registry.html#cachePath
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.static.Registry.getCachedPath
  twisted.web.static.Registry.html#getCachedPath
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.static.loadMimeTypes
  twisted.web.static.html#loadMimeTypes
  Function
  Function
  PUBLIC
  Produces a mapping of extensions (with leading dot) to MIME types.
- twisted.web.static.getTypeAndEncoding
  twisted.web.static.html#getTypeAndEncoding
  Function
  Function
  PUBLIC
  Undocumented
- twisted.web.static.File
  twisted.web.static.File.html
  Class
  Class
  PUBLIC
  File is a resource that represents a plain non-interpreted file (although it can look for an extension like .rpy or .cgi and hand the file to a processor for interpretation if you wish). Its constructor takes a file path.
- twisted.web.static.File.childNotFound
  twisted.web.static.File.html#childNotFound
  Attribute
  Class Variable
  PUBLIC
  `Resource` used to render 404 Not Found error pages.
- twisted.web.static.File.forbidden
  twisted.web.static.File.html#forbidden
  Attribute
  Class Variable
  PUBLIC
  `Resource` used to render 403 Forbidden error pages.
- twisted.web.static.File.contentTypes
  twisted.web.static.File.html#contentTypes
  Attribute
  Instance Variable
  PUBLIC
  a mapping of extensions to MIME types used to set the default value for the Content-Type header. It is initialized with the values returned by `loadMimeTypes`.
- twisted.web.static.File.contentEncodings
  twisted.web.static.File.html#contentEncodings
  Attribute
  Instance Variable
  PUBLIC
  a mapping of extensions to encoding types used to set default value for the Content-Encoding header.
- twisted.web.static.File.processors
  twisted.web.static.File.html#processors
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.web.static.File.indexNames
  twisted.web.static.File.html#indexNames
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.web.static.File.type
  twisted.web.static.File.html#type
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.static.File.__init__
  twisted.web.static.File.html#__init__
  Function
  Method
  PUBLIC
  Create a file with the given path.
- twisted.web.static.File.defaultType
  twisted.web.static.File.html#defaultType
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.static.File.ignoredExts
  twisted.web.static.File.html#ignoredExts
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.static.File.registry
  twisted.web.static.File.html#registry
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.static.File.ignoreExt
  twisted.web.static.File.html#ignoreExt
  Function
  Method
  PUBLIC
  Ignore the given extension.
- twisted.web.static.File.directoryListing
  twisted.web.static.File.html#directoryListing
  Function
  Method
  PUBLIC
  Return a resource that generates an HTML listing of the directory this path represents.
- twisted.web.static.File.getChild
  twisted.web.static.File.html#getChild
  Function
  Method
  PUBLIC
  If this `File`"s path refers to a directory, return a `File` referring to the file named `path` in that directory.
- twisted.web.static.File.openForReading
  twisted.web.static.File.html#openForReading
  Function
  Method
  PUBLIC
  Open a file and return it.
- twisted.web.static.File.getFileSize
  twisted.web.static.File.html#getFileSize
  Function
  Method
  PUBLIC
  Return file size.
- twisted.web.static.File._parseRangeHeader
  twisted.web.static.File.html#_parseRangeHeader
  Function
  Method
  PRIVATE
  Parse the value of a Range header into (start, stop) pairs.
- twisted.web.static.File._rangeToOffsetAndSize
  twisted.web.static.File.html#_rangeToOffsetAndSize
  Function
  Method
  PRIVATE
  Convert a start and end from a Range header to an offset and size.
- twisted.web.static.File._contentRange
  twisted.web.static.File.html#_contentRange
  Function
  Method
  PRIVATE
  Return a string suitable for the value of a Content-Range header for a range with the given offset and size.
- twisted.web.static.File._doSingleRangeRequest
  twisted.web.static.File.html#_doSingleRangeRequest
  Function
  Method
  PRIVATE
  Set up the response for Range headers that specify a single range.
- twisted.web.static.File._doMultipleRangeRequest
  twisted.web.static.File.html#_doMultipleRangeRequest
  Function
  Method
  PRIVATE
  Set up the response for Range headers that specify a single range.
- twisted.web.static.File._setContentHeaders
  twisted.web.static.File.html#_setContentHeaders
  Function
  Method
  PRIVATE
  Set the Content-length and Content-type headers for this request.
- twisted.web.static.File.makeProducer
  twisted.web.static.File.html#makeProducer
  Function
  Method
  PUBLIC
  Make a `StaticProducer` that will produce the body of this response.
- twisted.web.static.File.render_GET
  twisted.web.static.File.html#render_GET
  Function
  Method
  PUBLIC
  Begin sending the contents of this `File` (or a subset of the contents, based on the 'range' header) to the given request.
- twisted.web.static.File.encoding
  twisted.web.static.File.html#encoding
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.static.File.redirect
  twisted.web.static.File.html#redirect
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.static.File.listNames
  twisted.web.static.File.html#listNames
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.static.File.listEntities
  twisted.web.static.File.html#listEntities
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.static.File.createSimilarFile
  twisted.web.static.File.html#createSimilarFile
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.static.StaticProducer
  twisted.web.static.StaticProducer.html
  Class
  Class
  PUBLIC
  Superclass for classes that implement the business of producing.
- twisted.web.static.StaticProducer.request
  twisted.web.static.StaticProducer.html#request
  Attribute
  Instance Variable
  PUBLIC
  The `IRequest` to write the contents of the file to.
- twisted.web.static.StaticProducer.fileObject
  twisted.web.static.StaticProducer.html#fileObject
  Attribute
  Instance Variable
  PUBLIC
  The file the contents of which to write to the request.
- twisted.web.static.StaticProducer.__init__
  twisted.web.static.StaticProducer.html#__init__
  Function
  Method
  PUBLIC
  Initialize the instance.
- twisted.web.static.StaticProducer.start
  twisted.web.static.StaticProducer.html#start
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.static.StaticProducer.resumeProducing
  twisted.web.static.StaticProducer.html#resumeProducing
  Function
  Method
  PUBLIC
  Produce data for the consumer a single time.
- twisted.web.static.StaticProducer.stopProducing
  twisted.web.static.StaticProducer.html#stopProducing
  Function
  Method
  PUBLIC
  Stop producing data.
- twisted.web.static.NoRangeStaticProducer
  twisted.web.static.NoRangeStaticProducer.html
  Class
  Class
  PUBLIC
  A `StaticProducer` that writes the entire file to the request.
- twisted.web.static.NoRangeStaticProducer.start
  twisted.web.static.NoRangeStaticProducer.html#start
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.static.NoRangeStaticProducer.resumeProducing
  twisted.web.static.NoRangeStaticProducer.html#resumeProducing
  Function
  Method
  PUBLIC
  Produce data for the consumer a single time.
- twisted.web.static.SingleRangeStaticProducer
  twisted.web.static.SingleRangeStaticProducer.html
  Class
  Class
  PUBLIC
  A `StaticProducer` that writes a single chunk of a file to the request.
- twisted.web.static.SingleRangeStaticProducer.__init__
  twisted.web.static.SingleRangeStaticProducer.html#__init__
  Function
  Method
  PUBLIC
  Initialize the instance.
- twisted.web.static.SingleRangeStaticProducer.offset
  twisted.web.static.SingleRangeStaticProducer.html#offset
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.static.SingleRangeStaticProducer.size
  twisted.web.static.SingleRangeStaticProducer.html#size
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.static.SingleRangeStaticProducer.start
  twisted.web.static.SingleRangeStaticProducer.html#start
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.static.SingleRangeStaticProducer.bytesWritten
  twisted.web.static.SingleRangeStaticProducer.html#bytesWritten
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.static.SingleRangeStaticProducer.resumeProducing
  twisted.web.static.SingleRangeStaticProducer.html#resumeProducing
  Function
  Method
  PUBLIC
  Produce data for the consumer a single time.
- twisted.web.static.MultipleRangeStaticProducer
  twisted.web.static.MultipleRangeStaticProducer.html
  Class
  Class
  PUBLIC
  A `StaticProducer` that writes several chunks of a file to the request.
- twisted.web.static.MultipleRangeStaticProducer.__init__
  twisted.web.static.MultipleRangeStaticProducer.html#__init__
  Function
  Method
  PUBLIC
  Initialize the instance.
- twisted.web.static.MultipleRangeStaticProducer.rangeInfo
  twisted.web.static.MultipleRangeStaticProducer.html#rangeInfo
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.static.MultipleRangeStaticProducer.start
  twisted.web.static.MultipleRangeStaticProducer.html#start
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.static.MultipleRangeStaticProducer.rangeIter
  twisted.web.static.MultipleRangeStaticProducer.html#rangeIter
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.static.MultipleRangeStaticProducer._nextRange
  twisted.web.static.MultipleRangeStaticProducer.html#_nextRange
  Function
  Method
  PRIVATE
  Undocumented
- twisted.web.static.MultipleRangeStaticProducer.partBoundary
  twisted.web.static.MultipleRangeStaticProducer.html#partBoundary
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.static.MultipleRangeStaticProducer._partSize
  twisted.web.static.MultipleRangeStaticProducer.html#_partSize
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.web.static.MultipleRangeStaticProducer._partBytesWritten
  twisted.web.static.MultipleRangeStaticProducer.html#_partBytesWritten
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.web.static.MultipleRangeStaticProducer.resumeProducing
  twisted.web.static.MultipleRangeStaticProducer.html#resumeProducing
  Function
  Method
  PUBLIC
  Produce data for the consumer a single time.
- twisted.web.static.ASISProcessor
  twisted.web.static.ASISProcessor.html
  Class
  Class
  PUBLIC
  Serve files exactly as responses without generating a status-line or any headers. Inspired by Apache's mod_asis.
- twisted.web.static.ASISProcessor.__init__
  twisted.web.static.ASISProcessor.html#__init__
  Function
  Method
  PUBLIC
  Initialize.
- twisted.web.static.ASISProcessor.path
  twisted.web.static.ASISProcessor.html#path
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.static.ASISProcessor.registry
  twisted.web.static.ASISProcessor.html#registry
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.static.ASISProcessor.render
  twisted.web.static.ASISProcessor.html#render
  Function
  Method
  PUBLIC
  Render a given resource. See `IResource`'s render method.
- twisted.web.static.formatFileSize
  twisted.web.static.html#formatFileSize
  Function
  Function
  PUBLIC
  Format the given file size in bytes to human readable format.
- twisted.web.static.DirectoryLister
  twisted.web.static.DirectoryLister.html
  Class
  Class
  PUBLIC
  Print the content of a directory.
- twisted.web.static.DirectoryLister.template
  twisted.web.static.DirectoryLister.html#template
  Attribute
  Instance Variable
  PUBLIC
  page template used to render the content of the directory. It must contain the format keys header and tableContent.
- twisted.web.static.DirectoryLister.linePattern
  twisted.web.static.DirectoryLister.html#linePattern
  Attribute
  Instance Variable
  PUBLIC
  template used to render one line in the listing table. It must contain the format keys class, href, text, size, type and encoding.
- twisted.web.static.DirectoryLister.contentTypes
  twisted.web.static.DirectoryLister.html#contentTypes
  Attribute
  Instance Variable
  PUBLIC
  a mapping of extensions to MIME types used to populate the information of a member of this directory. It is initialized with the value `File.contentTypes`.
- twisted.web.static.DirectoryLister.contentEncodings
  twisted.web.static.DirectoryLister.html#contentEncodings
  Attribute
  Instance Variable
  PUBLIC
  a mapping of extensions to encoding types. It is initialized with the value `File.contentEncodings`.
- twisted.web.static.DirectoryLister.defaultType
  twisted.web.static.DirectoryLister.html#defaultType
  Attribute
  Instance Variable
  PUBLIC
  default type used when no mimetype is detected.
- twisted.web.static.DirectoryLister.dirs
  twisted.web.static.DirectoryLister.html#dirs
  Attribute
  Instance Variable
  PUBLIC
  filtered content of `path`, if the whole content should not be displayed (default to `None`, which means the actual content of `path` is printed).
- twisted.web.static.DirectoryLister.path
  twisted.web.static.DirectoryLister.html#path
  Attribute
  Instance Variable
  PUBLIC
  directory which content should be listed.
- twisted.web.static.DirectoryLister.__init__
  twisted.web.static.DirectoryLister.html#__init__
  Function
  Method
  PUBLIC
  Initialize.
- twisted.web.static.DirectoryLister._getFilesAndDirectories
  twisted.web.static.DirectoryLister.html#_getFilesAndDirectories
  Function
  Method
  PRIVATE
  Helper returning files and directories in given directory listing, with attributes to be used to build a table content with `self.linePattern`.
- twisted.web.static.DirectoryLister._buildTableContent
  twisted.web.static.DirectoryLister.html#_buildTableContent
  Function
  Method
  PRIVATE
  Build a table content using `self.linePattern` and giving elements odd and even classes.
- twisted.web.static.DirectoryLister.render
  twisted.web.static.DirectoryLister.html#render
  Function
  Method
  PUBLIC
  Render a listing of the content of `self.path`.
- twisted.web.static.DirectoryLister.__repr__
  twisted.web.static.DirectoryLister.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.demo.Test
  twisted.web.demo.Test.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.web.demo.Test.isLeaf
  twisted.web.demo.Test.html#isLeaf
  Attribute
  Class Variable
  PUBLIC
  Signal if this IResource implementor is a "leaf node" or not. If True, getChildWithDefault will not be called on this Resource.
- twisted.web.demo.Test.__init__
  twisted.web.demo.Test.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.web.distrib._ReferenceableProducerWrapper
  twisted.web.distrib._ReferenceableProducerWrapper.html
  Class
  Class
  PRIVATE
  Undocumented
- twisted.web.distrib._ReferenceableProducerWrapper.__init__
  twisted.web.distrib._ReferenceableProducerWrapper.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.distrib._ReferenceableProducerWrapper.producer
  twisted.web.distrib._ReferenceableProducerWrapper.html#producer
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.distrib._ReferenceableProducerWrapper.remote_resumeProducing
  twisted.web.distrib._ReferenceableProducerWrapper.html#remote_resumeProducing
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.distrib._ReferenceableProducerWrapper.remote_pauseProducing
  twisted.web.distrib._ReferenceableProducerWrapper.html#remote_pauseProducing
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.distrib._ReferenceableProducerWrapper.remote_stopProducing
  twisted.web.distrib._ReferenceableProducerWrapper.html#remote_stopProducing
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.distrib.Request
  twisted.web.distrib.Request.html
  Class
  Class
  PUBLIC
  A request which was received by a `ResourceSubscription` and sent via PB to a distributed node.
- twisted.web.distrib.Request.setCopyableState
  twisted.web.distrib.Request.html#setCopyableState
  Function
  Method
  PUBLIC
  Initialize this `twisted.web.distrib.Request` based on the copied state so that it closely resembles a `twisted.web.server.Request`.
- twisted.web.distrib.Request.content
  twisted.web.distrib.Request.html#content
  Attribute
  Instance Variable
  PUBLIC
  A file-like object giving the request body. This may be a file on disk, an `io.BytesIO`, or some other type. The implementation is free to decide on a per-request basis.
- twisted.web.distrib.Request._write
  twisted.web.distrib.Request.html#_write
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.web.distrib.Request.write
  twisted.web.distrib.Request.html#write
  Function
  Method
  PUBLIC
  Write the given bytes to the response body.
- twisted.web.distrib.Request.registerProducer
  twisted.web.distrib.Request.html#registerProducer
  Function
  Method
  PUBLIC
  Register a producer.
- twisted.web.distrib.Request.unregisterProducer
  twisted.web.distrib.Request.html#unregisterProducer
  Function
  Method
  PUBLIC
  Unregister the producer.
- twisted.web.distrib.Request.fail
  twisted.web.distrib.Request.html#fail
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.distrib.Issue
  twisted.web.distrib.Issue.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.web.distrib.Issue._log
  twisted.web.distrib.Issue.html#_log
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.web.distrib.Issue.__init__
  twisted.web.distrib.Issue.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.distrib.Issue.request
  twisted.web.distrib.Issue.html#request
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.distrib.Issue.finished
  twisted.web.distrib.Issue.html#finished
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.distrib.Issue.failed
  twisted.web.distrib.Issue.html#failed
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.distrib.ResourceSubscription
  twisted.web.distrib.ResourceSubscription.html
  Class
  Class
  PUBLIC
  No class docstring; 0/5 instance variable, 0/2 class variable, 4/6 methods documented
- twisted.web.distrib.ResourceSubscription.isLeaf
  twisted.web.distrib.ResourceSubscription.html#isLeaf
  Attribute
  Class Variable
  PUBLIC
  Signal if this IResource implementor is a "leaf node" or not. If True, getChildWithDefault will not be called on this Resource.
- twisted.web.distrib.ResourceSubscription.waiting
  twisted.web.distrib.ResourceSubscription.html#waiting
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.distrib.ResourceSubscription._log
  twisted.web.distrib.ResourceSubscription.html#_log
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.web.distrib.ResourceSubscription.__init__
  twisted.web.distrib.ResourceSubscription.html#__init__
  Function
  Method
  PUBLIC
  Initialize.
- twisted.web.distrib.ResourceSubscription.host
  twisted.web.distrib.ResourceSubscription.html#host
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.distrib.ResourceSubscription.port
  twisted.web.distrib.ResourceSubscription.html#port
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.distrib.ResourceSubscription.pending
  twisted.web.distrib.ResourceSubscription.html#pending
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.distrib.ResourceSubscription.publisher
  twisted.web.distrib.ResourceSubscription.html#publisher
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.distrib.ResourceSubscription.__getstate__
  twisted.web.distrib.ResourceSubscription.html#__getstate__
  Function
  Method
  PUBLIC
  Get persistent state for this ResourceSubscription.
- twisted.web.distrib.ResourceSubscription.connected
  twisted.web.distrib.ResourceSubscription.html#connected
  Function
  Method
  PUBLIC
  I've connected to a publisher; I'll now send all my requests.
- twisted.web.distrib.ResourceSubscription.notConnected
  twisted.web.distrib.ResourceSubscription.html#notConnected
  Function
  Method
  PUBLIC
  I can't connect to a publisher; I'll now reply to all pending requests.
- twisted.web.distrib.ResourceSubscription.booted
  twisted.web.distrib.ResourceSubscription.html#booted
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.distrib.ResourceSubscription.render
  twisted.web.distrib.ResourceSubscription.html#render
  Function
  Method
  PUBLIC
  Render this request, from my server.
- twisted.web.distrib.ResourcePublisher
  twisted.web.distrib.ResourcePublisher.html
  Class
  Class
  PUBLIC
  `ResourcePublisher` exposes a remote API which can be used to respond to request.
- twisted.web.distrib.ResourcePublisher.site
  twisted.web.distrib.ResourcePublisher.html#site
  Attribute
  Instance Variable
  PUBLIC
  The site which will be used for resource lookup.
- twisted.web.distrib.ResourcePublisher._log
  twisted.web.distrib.ResourcePublisher.html#_log
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.web.distrib.ResourcePublisher.__init__
  twisted.web.distrib.ResourcePublisher.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.distrib.ResourcePublisher.persistenceVersion
  twisted.web.distrib.ResourcePublisher.html#persistenceVersion
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.web.distrib.ResourcePublisher.upgradeToVersion2
  twisted.web.distrib.ResourcePublisher.html#upgradeToVersion2
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.distrib.ResourcePublisher.getPerspectiveNamed
  twisted.web.distrib.ResourcePublisher.html#getPerspectiveNamed
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.distrib.ResourcePublisher.remote_request
  twisted.web.distrib.ResourcePublisher.html#remote_request
  Function
  Method
  PUBLIC
  Look up the resource for the given request and render it.
- twisted.web.distrib.UserDirectory
  twisted.web.distrib.UserDirectory.html
  Class
  Class
  PUBLIC
  A resource which lists available user resources and serves them as children.
- twisted.web.distrib.UserDirectory._pwd
  twisted.web.distrib.UserDirectory.html#_pwd
  Attribute
  Instance Variable
  PRIVATE
  An object like `pwd` which is used to enumerate users and their home directories.
- twisted.web.distrib.UserDirectory.userDirName
  twisted.web.distrib.UserDirectory.html#userDirName
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.web.distrib.UserDirectory.userSocketName
  twisted.web.distrib.UserDirectory.html#userSocketName
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.web.distrib.UserDirectory.template
  twisted.web.distrib.UserDirectory.html#template
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.web.distrib.UserDirectory.__init__
  twisted.web.distrib.UserDirectory.html#__init__
  Function
  Method
  PUBLIC
  Initialize.
- twisted.web.distrib.UserDirectory._users
  twisted.web.distrib.UserDirectory.html#_users
  Function
  Method
  PRIVATE
  Return a list of two-tuples giving links to user resources and text to associate with those links.
- twisted.web.distrib.UserDirectory.render_GET
  twisted.web.distrib.UserDirectory.html#render_GET
  Function
  Method
  PUBLIC
  Render as HTML a listing of all known users with links to their personal resources.
- twisted.web.distrib.UserDirectory.getChild
  twisted.web.distrib.UserDirectory.html#getChild
  Function
  Method
  PUBLIC
  Retrieve a 'child' resource from me.
- twisted.web.sux.BEGIN_HANDLER
  twisted.web.sux.html#BEGIN_HANDLER
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.web.sux.DO_HANDLER
  twisted.web.sux.html#DO_HANDLER
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.web.sux.END_HANDLER
  twisted.web.sux.html#END_HANDLER
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.web.sux.identChars
  twisted.web.sux.html#identChars
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.web.sux.lenientIdentChars
  twisted.web.sux.html#lenientIdentChars
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.web.sux.nop
  twisted.web.sux.html#nop
  Function
  Function
  PUBLIC
  Do nothing.
- twisted.web.sux.unionlist
  twisted.web.sux.html#unionlist
  Function
  Function
  PUBLIC
  Undocumented
- twisted.web.sux.zipfndict
  twisted.web.sux.html#zipfndict
  Function
  Function
  PUBLIC
  Undocumented
- twisted.web.sux.prefixedMethodClassDict
  twisted.web.sux.html#prefixedMethodClassDict
  Function
  Function
  PUBLIC
  Undocumented
- twisted.web.sux.prefixedMethodObjDict
  twisted.web.sux.html#prefixedMethodObjDict
  Function
  Function
  PUBLIC
  Undocumented
- twisted.web.sux.ParseError
  twisted.web.sux.ParseError.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.web.sux.ParseError.__init__
  twisted.web.sux.ParseError.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.sux.ParseError.filename
  twisted.web.sux.ParseError.html#filename
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.sux.ParseError.line
  twisted.web.sux.ParseError.html#line
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.sux.ParseError.col
  twisted.web.sux.ParseError.html#col
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.sux.ParseError.message
  twisted.web.sux.ParseError.html#message
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.sux.ParseError.__str__
  twisted.web.sux.ParseError.html#__str__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.sux.XMLParser
  twisted.web.sux.XMLParser.html
  Class
  Class
  PUBLIC
  No class docstring; 0/23 instance variable, 0/2 class variable, 10/55 methods documented
- twisted.web.sux.XMLParser.state
  twisted.web.sux.XMLParser.html#state
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.sux.XMLParser.encodings
  twisted.web.sux.XMLParser.html#encodings
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.sux.XMLParser.filename
  twisted.web.sux.XMLParser.html#filename
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.web.sux.XMLParser.beExtremelyLenient
  twisted.web.sux.XMLParser.html#beExtremelyLenient
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.web.sux.XMLParser._prepend
  twisted.web.sux.XMLParser.html#_prepend
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.web.sux.XMLParser._leadingBodyData
  twisted.web.sux.XMLParser.html#_leadingBodyData
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.web.sux.XMLParser.connectionMade
  twisted.web.sux.XMLParser.html#connectionMade
  Function
  Method
  PUBLIC
  Called when a connection is made.
- twisted.web.sux.XMLParser.lineno
  twisted.web.sux.XMLParser.html#lineno
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.sux.XMLParser.colno
  twisted.web.sux.XMLParser.html#colno
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.sux.XMLParser.saveMark
  twisted.web.sux.XMLParser.html#saveMark
  Function
  Method
  PUBLIC
  Get the line number and column of the last character parsed
- twisted.web.sux.XMLParser._parseError
  twisted.web.sux.XMLParser.html#_parseError
  Function
  Method
  PRIVATE
  Undocumented
- twisted.web.sux.XMLParser._buildStateTable
  twisted.web.sux.XMLParser.html#_buildStateTable
  Function
  Method
  PRIVATE
  Return a dictionary of begin, do, end state function tuples
- twisted.web.sux.XMLParser._decode
  twisted.web.sux.XMLParser.html#_decode
  Function
  Method
  PRIVATE
  Undocumented
- twisted.web.sux.XMLParser.maybeBodyData
  twisted.web.sux.XMLParser.html#maybeBodyData
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.sux.XMLParser.dataReceived
  twisted.web.sux.XMLParser.html#dataReceived
  Function
  Method
  PUBLIC
  Called whenever data is received.
- twisted.web.sux.XMLParser.connectionLost
  twisted.web.sux.XMLParser.html#connectionLost
  Function
  Method
  PUBLIC
  End the last state we were in.
- twisted.web.sux.XMLParser.do_begin
  twisted.web.sux.XMLParser.html#do_begin
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.sux.XMLParser.begin_comment
  twisted.web.sux.XMLParser.html#begin_comment
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.sux.XMLParser.commentbuf
  twisted.web.sux.XMLParser.html#commentbuf
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.sux.XMLParser.do_comment
  twisted.web.sux.XMLParser.html#do_comment
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.sux.XMLParser.begin_tagstart
  twisted.web.sux.XMLParser.html#begin_tagstart
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.sux.XMLParser.tagName
  twisted.web.sux.XMLParser.html#tagName
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.sux.XMLParser.tagAttributes
  twisted.web.sux.XMLParser.html#tagAttributes
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.sux.XMLParser.termtag
  twisted.web.sux.XMLParser.html#termtag
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.sux.XMLParser.endtag
  twisted.web.sux.XMLParser.html#endtag
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.sux.XMLParser.do_tagstart
  twisted.web.sux.XMLParser.html#do_tagstart
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.sux.XMLParser.begin_unentity
  twisted.web.sux.XMLParser.html#begin_unentity
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.sux.XMLParser.do_unentity
  twisted.web.sux.XMLParser.html#do_unentity
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.sux.XMLParser.end_unentity
  twisted.web.sux.XMLParser.html#end_unentity
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.sux.XMLParser.begin_expectcdata
  twisted.web.sux.XMLParser.html#begin_expectcdata
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.sux.XMLParser.cdatabuf
  twisted.web.sux.XMLParser.html#cdatabuf
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.sux.XMLParser.do_expectcdata
  twisted.web.sux.XMLParser.html#do_expectcdata
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.sux.XMLParser.do_cdata
  twisted.web.sux.XMLParser.html#do_cdata
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.sux.XMLParser.end_cdata
  twisted.web.sux.XMLParser.html#end_cdata
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.sux.XMLParser.do_attrs
  twisted.web.sux.XMLParser.html#do_attrs
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.sux.XMLParser.begin_doctype
  twisted.web.sux.XMLParser.html#begin_doctype
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.sux.XMLParser.doctype
  twisted.web.sux.XMLParser.html#doctype
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.sux.XMLParser.do_doctype
  twisted.web.sux.XMLParser.html#do_doctype
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.sux.XMLParser.end_doctype
  twisted.web.sux.XMLParser.html#end_doctype
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.sux.XMLParser.do_waitforgt
  twisted.web.sux.XMLParser.html#do_waitforgt
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.sux.XMLParser.begin_attrname
  twisted.web.sux.XMLParser.html#begin_attrname
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.sux.XMLParser.attrname
  twisted.web.sux.XMLParser.html#attrname
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.sux.XMLParser._attrname_termtag
  twisted.web.sux.XMLParser.html#_attrname_termtag
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.web.sux.XMLParser.do_attrname
  twisted.web.sux.XMLParser.html#do_attrname
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.sux.XMLParser.do_beforeattrval
  twisted.web.sux.XMLParser.html#do_beforeattrval
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.sux.XMLParser.attrval
  twisted.web.sux.XMLParser.html#attrval
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.sux.XMLParser.begin_beforeeq
  twisted.web.sux.XMLParser.html#begin_beforeeq
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.sux.XMLParser._beforeeq_termtag
  twisted.web.sux.XMLParser.html#_beforeeq_termtag
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.web.sux.XMLParser.do_beforeeq
  twisted.web.sux.XMLParser.html#do_beforeeq
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.sux.XMLParser.begin_attrval
  twisted.web.sux.XMLParser.html#begin_attrval
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.sux.XMLParser.quotetype
  twisted.web.sux.XMLParser.html#quotetype
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.sux.XMLParser.do_attrval
  twisted.web.sux.XMLParser.html#do_attrval
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.sux.XMLParser.end_attrval
  twisted.web.sux.XMLParser.html#end_attrval
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.sux.XMLParser.begin_messyattr
  twisted.web.sux.XMLParser.html#begin_messyattr
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.sux.XMLParser.do_messyattr
  twisted.web.sux.XMLParser.html#do_messyattr
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.sux.XMLParser.end_messyattr
  twisted.web.sux.XMLParser.html#end_messyattr
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.sux.XMLParser.begin_afterslash
  twisted.web.sux.XMLParser.html#begin_afterslash
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.sux.XMLParser._after_slash_closed
  twisted.web.sux.XMLParser.html#_after_slash_closed
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.web.sux.XMLParser.do_afterslash
  twisted.web.sux.XMLParser.html#do_afterslash
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.sux.XMLParser.begin_bodydata
  twisted.web.sux.XMLParser.html#begin_bodydata
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.sux.XMLParser.bodydata
  twisted.web.sux.XMLParser.html#bodydata
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.sux.XMLParser.do_bodydata
  twisted.web.sux.XMLParser.html#do_bodydata
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.sux.XMLParser.end_bodydata
  twisted.web.sux.XMLParser.html#end_bodydata
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.sux.XMLParser.do_waitforendscript
  twisted.web.sux.XMLParser.html#do_waitforendscript
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.sux.XMLParser.begin_waitscriptendtag
  twisted.web.sux.XMLParser.html#begin_waitscriptendtag
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.sux.XMLParser.temptagdata
  twisted.web.sux.XMLParser.html#temptagdata
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.sux.XMLParser.do_waitscriptendtag
  twisted.web.sux.XMLParser.html#do_waitscriptendtag
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.sux.XMLParser.begin_entityref
  twisted.web.sux.XMLParser.html#begin_entityref
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.sux.XMLParser.erefbuf
  twisted.web.sux.XMLParser.html#erefbuf
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.sux.XMLParser.erefextra
  twisted.web.sux.XMLParser.html#erefextra
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.sux.XMLParser.do_entityref
  twisted.web.sux.XMLParser.html#do_entityref
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.sux.XMLParser.end_entityref
  twisted.web.sux.XMLParser.html#end_entityref
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.sux.XMLParser.begin_spacebodydata
  twisted.web.sux.XMLParser.html#begin_spacebodydata
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.sux.XMLParser.gotTagStart
  twisted.web.sux.XMLParser.html#gotTagStart
  Function
  Method
  PUBLIC
  Encountered an opening tag.
- twisted.web.sux.XMLParser.gotText
  twisted.web.sux.XMLParser.html#gotText
  Function
  Method
  PUBLIC
  Encountered text
- twisted.web.sux.XMLParser.gotEntityReference
  twisted.web.sux.XMLParser.html#gotEntityReference
  Function
  Method
  PUBLIC
  Encountered mnemonic entity reference
- twisted.web.sux.XMLParser.gotComment
  twisted.web.sux.XMLParser.html#gotComment
  Function
  Method
  PUBLIC
  Encountered comment.
- twisted.web.sux.XMLParser.gotCData
  twisted.web.sux.XMLParser.html#gotCData
  Function
  Method
  PUBLIC
  Encountered CDATA
- twisted.web.sux.XMLParser.gotDoctype
  twisted.web.sux.XMLParser.html#gotDoctype
  Function
  Method
  PUBLIC
  Encountered DOCTYPE
- twisted.web.sux.XMLParser.gotTagEnd
  twisted.web.sux.XMLParser.html#gotTagEnd
  Function
  Method
  PUBLIC
  Encountered closing tag
- twisted.web.microdom.getElementsByTagName
  twisted.web.microdom.html#getElementsByTagName
  Function
  Function
  PUBLIC
  Return a list of all child elements of `iNode` with a name matching `name`.
- twisted.web.microdom.getElementsByTagNameNoCase
  twisted.web.microdom.html#getElementsByTagNameNoCase
  Function
  Function
  PUBLIC
  Undocumented
- twisted.web.microdom._streamWriteWrapper
  twisted.web.microdom.html#_streamWriteWrapper
  Function
  Function
  PRIVATE
  Undocumented
- twisted.web.microdom.HTML_ESCAPE_CHARS
  twisted.web.microdom.html#HTML_ESCAPE_CHARS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.web.microdom.REV_HTML_ESCAPE_CHARS
  twisted.web.microdom.html#REV_HTML_ESCAPE_CHARS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.web.microdom.XML_ESCAPE_CHARS
  twisted.web.microdom.html#XML_ESCAPE_CHARS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.web.microdom.REV_XML_ESCAPE_CHARS
  twisted.web.microdom.html#REV_XML_ESCAPE_CHARS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.web.microdom.unescape
  twisted.web.microdom.html#unescape
  Function
  Function
  PUBLIC
  Perform the exact opposite of 'escape'.
- twisted.web.microdom.escape
  twisted.web.microdom.html#escape
  Function
  Function
  PUBLIC
  Escape a few XML special chars with XML entities.
- twisted.web.microdom.MismatchedTags
  twisted.web.microdom.MismatchedTags.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.web.microdom.MismatchedTags.__init__
  twisted.web.microdom.MismatchedTags.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.microdom.MismatchedTags.filename
  twisted.web.microdom.MismatchedTags.html#filename
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.microdom.MismatchedTags.expect
  twisted.web.microdom.MismatchedTags.html#expect
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.microdom.MismatchedTags.got
  twisted.web.microdom.MismatchedTags.html#got
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.microdom.MismatchedTags.begLine
  twisted.web.microdom.MismatchedTags.html#begLine
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.microdom.MismatchedTags.begCol
  twisted.web.microdom.MismatchedTags.html#begCol
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.microdom.MismatchedTags.endLine
  twisted.web.microdom.MismatchedTags.html#endLine
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.microdom.MismatchedTags.endCol
  twisted.web.microdom.MismatchedTags.html#endCol
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.microdom.MismatchedTags.__str__
  twisted.web.microdom.MismatchedTags.html#__str__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.microdom.Node
  twisted.web.microdom.Node.html
  Class
  Class
  PUBLIC
  No class docstring; 0/2 instance variable, 0/1 class variable, 5/14 methods documented
- twisted.web.microdom.Node.nodeName
  twisted.web.microdom.Node.html#nodeName
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.web.microdom.Node.__init__
  twisted.web.microdom.Node.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.microdom.Node.parentNode
  twisted.web.microdom.Node.html#parentNode
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.microdom.Node.childNodes
  twisted.web.microdom.Node.html#childNodes
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.microdom.Node.isEqualToNode
  twisted.web.microdom.Node.html#isEqualToNode
  Function
  Method
  PUBLIC
  Compare this node to `other`. If the nodes have the same number of children and corresponding children are equal to each other, return `True`, otherwise return `False`.
- twisted.web.microdom.Node.writexml
  twisted.web.microdom.Node.html#writexml
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.microdom.Node.toxml
  twisted.web.microdom.Node.html#toxml
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.microdom.Node.writeprettyxml
  twisted.web.microdom.Node.html#writeprettyxml
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.microdom.Node.toprettyxml
  twisted.web.microdom.Node.html#toprettyxml
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.microdom.Node.cloneNode
  twisted.web.microdom.Node.html#cloneNode
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.microdom.Node.hasChildNodes
  twisted.web.microdom.Node.html#hasChildNodes
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.microdom.Node.appendChild
  twisted.web.microdom.Node.html#appendChild
  Function
  Method
  PUBLIC
  Make the given `Node` the last child of this node.
- twisted.web.microdom.Node.insertBefore
  twisted.web.microdom.Node.html#insertBefore
  Function
  Method
  PUBLIC
  Make the given `Node` `new` a child of this node which comes before the `Node` `ref`.
- twisted.web.microdom.Node.removeChild
  twisted.web.microdom.Node.html#removeChild
  Function
  Method
  PUBLIC
  Remove the given `Node` from this node's children.
- twisted.web.microdom.Node.replaceChild
  twisted.web.microdom.Node.html#replaceChild
  Function
  Method
  PUBLIC
  Replace a `Node` which is already a child of this node with a different node.
- twisted.web.microdom.Node.lastChild
  twisted.web.microdom.Node.html#lastChild
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.microdom.Node.firstChild
  twisted.web.microdom.Node.html#firstChild
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.microdom.Document
  twisted.web.microdom.Document.html
  Class
  Class
  PUBLIC
  No class docstring; 0/1 property, 0/1 class variable, 1/10 method documented
- twisted.web.microdom.Document.__init__
  twisted.web.microdom.Document.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.microdom.Document.cloneNode
  twisted.web.microdom.Document.html#cloneNode
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.microdom.Document.doctype
  twisted.web.microdom.Document.html#doctype
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.web.microdom.Document.isEqualToDocument
  twisted.web.microdom.Document.html#isEqualToDocument
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.microdom.Document.documentElement
  twisted.web.microdom.Document.html#documentElement
  Attribute
  Property
  PUBLIC
  Undocumented
- twisted.web.microdom.Document.appendChild
  twisted.web.microdom.Document.html#appendChild
  Function
  Method
  PUBLIC
  Make the given `Node` the document element of this `Document`.
- twisted.web.microdom.Document.writexml
  twisted.web.microdom.Document.html#writexml
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.microdom.Document.createElement
  twisted.web.microdom.Document.html#createElement
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.microdom.Document.createTextNode
  twisted.web.microdom.Document.html#createTextNode
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.microdom.Document.createComment
  twisted.web.microdom.Document.html#createComment
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.microdom.Document.getElementsByTagName
  twisted.web.microdom.Document.html#getElementsByTagName
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.microdom.Document.getElementById
  twisted.web.microdom.Document.html#getElementById
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.microdom.EntityReference
  twisted.web.microdom.EntityReference.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.web.microdom.EntityReference.__init__
  twisted.web.microdom.EntityReference.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.microdom.EntityReference.eref
  twisted.web.microdom.EntityReference.html#eref
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.microdom.EntityReference.nodeValue
  twisted.web.microdom.EntityReference.html#nodeValue
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.microdom.EntityReference.data
  twisted.web.microdom.EntityReference.html#data
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.microdom.EntityReference.isEqualToEntityReference
  twisted.web.microdom.EntityReference.html#isEqualToEntityReference
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.microdom.EntityReference.writexml
  twisted.web.microdom.EntityReference.html#writexml
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.microdom.EntityReference.cloneNode
  twisted.web.microdom.EntityReference.html#cloneNode
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.microdom.CharacterData
  twisted.web.microdom.CharacterData.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.web.microdom.CharacterData.__init__
  twisted.web.microdom.CharacterData.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.microdom.CharacterData.value
  twisted.web.microdom.CharacterData.html#value
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.microdom.CharacterData.data
  twisted.web.microdom.CharacterData.html#data
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.microdom.CharacterData.nodeValue
  twisted.web.microdom.CharacterData.html#nodeValue
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.microdom.CharacterData.isEqualToCharacterData
  twisted.web.microdom.CharacterData.html#isEqualToCharacterData
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.microdom.Comment
  twisted.web.microdom.Comment.html
  Class
  Class
  PUBLIC
  A comment node.
- twisted.web.microdom.Comment.writexml
  twisted.web.microdom.Comment.html#writexml
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.microdom.Comment.cloneNode
  twisted.web.microdom.Comment.html#cloneNode
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.microdom.Text
  twisted.web.microdom.Text.html
  Class
  Class
  PUBLIC
  No class docstring; 0/1 instance variable, 1/5 method documented
- twisted.web.microdom.Text.__init__
  twisted.web.microdom.Text.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.microdom.Text.raw
  twisted.web.microdom.Text.html#raw
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.microdom.Text.isEqualToNode
  twisted.web.microdom.Text.html#isEqualToNode
  Function
  Method
  PUBLIC
  Compare this text to `text`. If the underlying values and the `raw` flag are the same, return `True`, otherwise return `False`.
- twisted.web.microdom.Text.cloneNode
  twisted.web.microdom.Text.html#cloneNode
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.microdom.Text.writexml
  twisted.web.microdom.Text.html#writexml
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.microdom.Text.__repr__
  twisted.web.microdom.Text.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.microdom.CDATASection
  twisted.web.microdom.CDATASection.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.web.microdom.CDATASection.cloneNode
  twisted.web.microdom.CDATASection.html#cloneNode
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.microdom.CDATASection.writexml
  twisted.web.microdom.CDATASection.html#writexml
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.microdom._genprefix
  twisted.web.microdom.html#_genprefix
  Function
  Function
  PRIVATE
  Undocumented
- twisted.web.microdom.genprefix
  twisted.web.microdom.html#genprefix
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.web.microdom._Attr
  twisted.web.microdom._Attr.html
  Class
  Class
  PRIVATE
  Support class for getAttributeNode.
- twisted.web.microdom.Element
  twisted.web.microdom.Element.html
  Class
  Class
  PUBLIC
  No class docstring; 0/10 instance variable, 2/17 methods documented
- twisted.web.microdom.Element.preserveCase
  twisted.web.microdom.Element.html#preserveCase
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.microdom.Element.caseInsensitive
  twisted.web.microdom.Element.html#caseInsensitive
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.microdom.Element.nsprefixes
  twisted.web.microdom.Element.html#nsprefixes
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.microdom.Element.__init__
  twisted.web.microdom.Element.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.microdom.Element.attributes
  twisted.web.microdom.Element.html#attributes
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.microdom.Element.endTagName
  twisted.web.microdom.Element.html#endTagName
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.microdom.Element.nodeName
  twisted.web.microdom.Element.html#nodeName
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.microdom.Element.tagName
  twisted.web.microdom.Element.html#tagName
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.microdom.Element._filename
  twisted.web.microdom.Element.html#_filename
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.web.microdom.Element._markpos
  twisted.web.microdom.Element.html#_markpos
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.web.microdom.Element.namespace
  twisted.web.microdom.Element.html#namespace
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.microdom.Element.addPrefixes
  twisted.web.microdom.Element.html#addPrefixes
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.microdom.Element.endTag
  twisted.web.microdom.Element.html#endTag
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.microdom.Element.isEqualToElement
  twisted.web.microdom.Element.html#isEqualToElement
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.microdom.Element.isEqualToNode
  twisted.web.microdom.Element.html#isEqualToNode
  Function
  Method
  PUBLIC
  Compare this element to `other`. If the `nodeName`, `namespace`, `attributes`, and `childNodes` are all the same, return `True`, otherwise return `False`.
- twisted.web.microdom.Element.cloneNode
  twisted.web.microdom.Element.html#cloneNode
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.microdom.Element.getElementsByTagName
  twisted.web.microdom.Element.html#getElementsByTagName
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.microdom.Element.hasAttributes
  twisted.web.microdom.Element.html#hasAttributes
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.microdom.Element.getAttribute
  twisted.web.microdom.Element.html#getAttribute
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.microdom.Element.getAttributeNS
  twisted.web.microdom.Element.html#getAttributeNS
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.microdom.Element.getAttributeNode
  twisted.web.microdom.Element.html#getAttributeNode
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.microdom.Element.setAttribute
  twisted.web.microdom.Element.html#setAttribute
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.microdom.Element.removeAttribute
  twisted.web.microdom.Element.html#removeAttribute
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.microdom.Element.hasAttribute
  twisted.web.microdom.Element.html#hasAttribute
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.microdom.Element.writexml
  twisted.web.microdom.Element.html#writexml
  Function
  Method
  PUBLIC
  Serialize this `Element` to the given stream.
- twisted.web.microdom.Element.__repr__
  twisted.web.microdom.Element.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.microdom.Element.__str__
  twisted.web.microdom.Element.html#__str__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.microdom._unescapeDict
  twisted.web.microdom.html#_unescapeDict
  Function
  Function
  PRIVATE
  Undocumented
- twisted.web.microdom._reverseDict
  twisted.web.microdom.html#_reverseDict
  Function
  Function
  PRIVATE
  Undocumented
- twisted.web.microdom.MicroDOMParser
  twisted.web.microdom.MicroDOMParser.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.web.microdom.MicroDOMParser.soonClosers
  twisted.web.microdom.MicroDOMParser.html#soonClosers
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.microdom.MicroDOMParser.laterClosers
  twisted.web.microdom.MicroDOMParser.html#laterClosers
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.microdom.MicroDOMParser.__init__
  twisted.web.microdom.MicroDOMParser.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.microdom.MicroDOMParser.elementstack
  twisted.web.microdom.MicroDOMParser.html#elementstack
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.microdom.MicroDOMParser.nsstack
  twisted.web.microdom.MicroDOMParser.html#nsstack
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.microdom.MicroDOMParser.documents
  twisted.web.microdom.MicroDOMParser.html#documents
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.microdom.MicroDOMParser._mddoctype
  twisted.web.microdom.MicroDOMParser.html#_mddoctype
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.web.microdom.MicroDOMParser.beExtremelyLenient
  twisted.web.microdom.MicroDOMParser.html#beExtremelyLenient
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.microdom.MicroDOMParser.caseInsensitive
  twisted.web.microdom.MicroDOMParser.html#caseInsensitive
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.microdom.MicroDOMParser.preserveCase
  twisted.web.microdom.MicroDOMParser.html#preserveCase
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.microdom.MicroDOMParser.shouldPreserveSpace
  twisted.web.microdom.MicroDOMParser.html#shouldPreserveSpace
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.microdom.MicroDOMParser._getparent
  twisted.web.microdom.MicroDOMParser.html#_getparent
  Function
  Method
  PRIVATE
  Undocumented
- twisted.web.microdom.MicroDOMParser.COMMENT
  twisted.web.microdom.MicroDOMParser.html#COMMENT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.web.microdom.MicroDOMParser._fixScriptElement
  twisted.web.microdom.MicroDOMParser.html#_fixScriptElement
  Function
  Method
  PRIVATE
  Undocumented
- twisted.web.microdom.MicroDOMParser.gotDoctype
  twisted.web.microdom.MicroDOMParser.html#gotDoctype
  Function
  Method
  PUBLIC
  Encountered DOCTYPE
- twisted.web.microdom.MicroDOMParser.gotTagStart
  twisted.web.microdom.MicroDOMParser.html#gotTagStart
  Function
  Method
  PUBLIC
  Encountered an opening tag.
- twisted.web.microdom.MicroDOMParser._gotStandalone
  twisted.web.microdom.MicroDOMParser.html#_gotStandalone
  Function
  Method
  PRIVATE
  Undocumented
- twisted.web.microdom.MicroDOMParser.gotText
  twisted.web.microdom.MicroDOMParser.html#gotText
  Function
  Method
  PUBLIC
  Encountered text
- twisted.web.microdom.MicroDOMParser.gotComment
  twisted.web.microdom.MicroDOMParser.html#gotComment
  Function
  Method
  PUBLIC
  Encountered comment.
- twisted.web.microdom.MicroDOMParser.gotEntityReference
  twisted.web.microdom.MicroDOMParser.html#gotEntityReference
  Function
  Method
  PUBLIC
  Encountered mnemonic entity reference
- twisted.web.microdom.MicroDOMParser.gotCData
  twisted.web.microdom.MicroDOMParser.html#gotCData
  Function
  Method
  PUBLIC
  Encountered CDATA
- twisted.web.microdom.MicroDOMParser.gotTagEnd
  twisted.web.microdom.MicroDOMParser.html#gotTagEnd
  Function
  Method
  PUBLIC
  Encountered closing tag
- twisted.web.microdom.MicroDOMParser.connectionLost
  twisted.web.microdom.MicroDOMParser.html#connectionLost
  Function
  Method
  PUBLIC
  End the last state we were in.
- twisted.web.microdom.parse
  twisted.web.microdom.html#parse
  Function
  Function
  PUBLIC
  Parse HTML or XML readable.
- twisted.web.microdom.parseString
  twisted.web.microdom.html#parseString
  Function
  Function
  PUBLIC
  Undocumented
- twisted.web.microdom.parseXML
  twisted.web.microdom.html#parseXML
  Function
  Function
  PUBLIC
  Parse an XML readable object.
- twisted.web.microdom.parseXMLString
  twisted.web.microdom.html#parseXMLString
  Function
  Function
  PUBLIC
  Parse an XML readable object.
- twisted.web.microdom.lmx
  twisted.web.microdom.lmx.html
  Class
  Class
  PUBLIC
  Easy creation of XML.
- twisted.web.microdom.lmx.__init__
  twisted.web.microdom.lmx.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.microdom.lmx.node
  twisted.web.microdom.lmx.html#node
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.microdom.lmx.__getattr__
  twisted.web.microdom.lmx.html#__getattr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.microdom.lmx.__setitem__
  twisted.web.microdom.lmx.html#__setitem__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.microdom.lmx.__getitem__
  twisted.web.microdom.lmx.html#__getitem__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.microdom.lmx.text
  twisted.web.microdom.lmx.html#text
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.microdom.lmx.add
  twisted.web.microdom.lmx.html#add
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.domhelpers.NodeLookupError
  twisted.web.domhelpers.NodeLookupError.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.web.domhelpers.substitute
  twisted.web.domhelpers.html#substitute
  Function
  Function
  PUBLIC
  Look through the given node's children for strings, and attempt to do string substitution with the given parameter.
- twisted.web.domhelpers._get
  twisted.web.domhelpers.html#_get
  Function
  Function
  PRIVATE
  (internal) Get a node with the specified `nodeId` as any of the `class`, `id` or `pattern` attributes.
- twisted.web.domhelpers.get
  twisted.web.domhelpers.html#get
  Function
  Function
  PUBLIC
  Get a node with the specified `nodeId` as any of the `class`, `id` or `pattern` attributes. If there is no such node, raise `NodeLookupError`.
- twisted.web.domhelpers.getIfExists
  twisted.web.domhelpers.html#getIfExists
  Function
  Function
  PUBLIC
  Get a node with the specified `nodeId` as any of the `class`, `id` or `pattern` attributes. If there is no such node, return `None`.
- twisted.web.domhelpers.getAndClear
  twisted.web.domhelpers.html#getAndClear
  Function
  Function
  PUBLIC
  Get a node with the specified `nodeId` as any of the `class`, `id` or `pattern` attributes. If there is no such node, raise `NodeLookupError`. Remove all child nodes before returning.
- twisted.web.domhelpers.clearNode
  twisted.web.domhelpers.html#clearNode
  Function
  Function
  PUBLIC
  Remove all children from the given node.
- twisted.web.domhelpers.locateNodes
  twisted.web.domhelpers.html#locateNodes
  Function
  Function
  PUBLIC
  Find subnodes in the given node where the given attribute has the given value.
- twisted.web.domhelpers.superSetAttribute
  twisted.web.domhelpers.html#superSetAttribute
  Function
  Function
  PUBLIC
  Undocumented
- twisted.web.domhelpers.superPrependAttribute
  twisted.web.domhelpers.html#superPrependAttribute
  Function
  Function
  PUBLIC
  Undocumented
- twisted.web.domhelpers.superAppendAttribute
  twisted.web.domhelpers.html#superAppendAttribute
  Function
  Function
  PUBLIC
  Undocumented
- twisted.web.domhelpers.gatherTextNodes
  twisted.web.domhelpers.html#gatherTextNodes
  Function
  Function
  PUBLIC
  Visit each child node and collect its text data, if any, into a string. For example:
- twisted.web.domhelpers.RawText
  twisted.web.domhelpers.RawText.html
  Class
  Class
  PUBLIC
  This is an evil and horrible speed hack. Basically, if you have a big chunk of XML that you want to insert into the DOM, but you don't want to incur the cost of parsing it, you can construct one of these and insert it into the DOM...
- twisted.web.domhelpers.RawText.writexml
  twisted.web.domhelpers.RawText.html#writexml
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.domhelpers.findNodes
  twisted.web.domhelpers.html#findNodes
  Function
  Function
  PUBLIC
  Undocumented
- twisted.web.domhelpers.findNodesShallowOnMatch
  twisted.web.domhelpers.html#findNodesShallowOnMatch
  Function
  Function
  PUBLIC
  Undocumented
- twisted.web.domhelpers.findNodesShallow
  twisted.web.domhelpers.html#findNodesShallow
  Function
  Function
  PUBLIC
  Undocumented
- twisted.web.domhelpers.findElementsWithAttributeShallow
  twisted.web.domhelpers.html#findElementsWithAttributeShallow
  Function
  Function
  PUBLIC
  Return an iterable of the elements which are direct children of `parent` and which have the `attribute` attribute.
- twisted.web.domhelpers.findElements
  twisted.web.domhelpers.html#findElements
  Function
  Function
  PUBLIC
  Return an iterable of the elements which are children of `parent` for which the predicate `matcher` returns true.
- twisted.web.domhelpers.findElementsWithAttribute
  twisted.web.domhelpers.html#findElementsWithAttribute
  Function
  Function
  PUBLIC
  Undocumented
- twisted.web.domhelpers.findNodesNamed
  twisted.web.domhelpers.html#findNodesNamed
  Function
  Function
  PUBLIC
  Undocumented
- twisted.web.domhelpers.writeNodeData
  twisted.web.domhelpers.html#writeNodeData
  Function
  Function
  PUBLIC
  Undocumented
- twisted.web.domhelpers.getNodeText
  twisted.web.domhelpers.html#getNodeText
  Function
  Function
  PUBLIC
  Undocumented
- twisted.web.domhelpers.getParents
  twisted.web.domhelpers.html#getParents
  Function
  Function
  PUBLIC
  Undocumented
- twisted.web.domhelpers.namedChildren
  twisted.web.domhelpers.html#namedChildren
  Function
  Function
  PUBLIC
  namedChildren(parent, nodeName) -> children (not descendants) of parent that have tagName == nodeName
- twisted.web.guard.BasicCredentialFactory
  twisted.web.guard.BasicCredentialFactory.html
  Class
  Class
  PUBLIC
  Credential Factory for HTTP Basic Authentication
- twisted.web.guard.BasicCredentialFactory.authenticationRealm
  twisted.web.guard.BasicCredentialFactory.html#authenticationRealm
  Attribute
  Instance Variable
  PUBLIC
  The HTTP authentication realm which will be issued in challenges.
- twisted.web.guard.BasicCredentialFactory.scheme
  twisted.web.guard.BasicCredentialFactory.html#scheme
  Attribute
  Class Variable
  PUBLIC
  A `str` giving the name of the authentication scheme with which this factory is associated. For example, `'basic'` or `'digest'`.
- twisted.web.guard.BasicCredentialFactory.__init__
  twisted.web.guard.BasicCredentialFactory.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.guard.BasicCredentialFactory.getChallenge
  twisted.web.guard.BasicCredentialFactory.html#getChallenge
  Function
  Method
  PUBLIC
  Return a challenge including the HTTP authentication realm with which this factory was created.
- twisted.web.guard.BasicCredentialFactory.decode
  twisted.web.guard.BasicCredentialFactory.html#decode
  Function
  Method
  PUBLIC
  Parse the base64-encoded, colon-separated username and password into a `credentials.UsernamePassword` instance.
- twisted.web.guard.DigestCredentialFactory
  twisted.web.guard.DigestCredentialFactory.html
  Class
  Class
  PUBLIC
  Wrapper for `digest.DigestCredentialFactory` that implements the `ICredentialFactory` interface.
- twisted.web.guard.DigestCredentialFactory.scheme
  twisted.web.guard.DigestCredentialFactory.html#scheme
  Attribute
  Class Variable
  PUBLIC
  A `str` giving the name of the authentication scheme with which this factory is associated. For example, `'basic'` or `'digest'`.
- twisted.web.guard.DigestCredentialFactory.__init__
  twisted.web.guard.DigestCredentialFactory.html#__init__
  Function
  Method
  PUBLIC
  Create the digest credential factory that this object wraps.
- twisted.web.guard.DigestCredentialFactory.digest
  twisted.web.guard.DigestCredentialFactory.html#digest
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.guard.DigestCredentialFactory.getChallenge
  twisted.web.guard.DigestCredentialFactory.html#getChallenge
  Function
  Method
  PUBLIC
  Generate the challenge for use in the WWW-Authenticate header
- twisted.web.guard.DigestCredentialFactory.decode
  twisted.web.guard.DigestCredentialFactory.html#decode
  Function
  Method
  PUBLIC
  Create a `twisted.cred.credentials.DigestedCredentials` object from the given response and request.
- twisted.web.guard.HTTPAuthSessionWrapper
  twisted.web.guard.HTTPAuthSessionWrapper.html
  Class
  Class
  PUBLIC
  Wrap a portal, enforcing supported header-based authentication schemes.
- twisted.web.guard.HTTPAuthSessionWrapper._portal
  twisted.web.guard.HTTPAuthSessionWrapper.html#_portal
  Attribute
  Instance Variable
  PRIVATE
  The `Portal` which will be used to retrieve `IResource` avatars.
- twisted.web.guard.HTTPAuthSessionWrapper._credentialFactories
  twisted.web.guard.HTTPAuthSessionWrapper.html#_credentialFactories
  Attribute
  Instance Variable
  PRIVATE
  A list of `ICredentialFactory` providers which will be used to decode Authorization headers into `ICredentials` providers.
- twisted.web.guard.HTTPAuthSessionWrapper.isLeaf
  twisted.web.guard.HTTPAuthSessionWrapper.html#isLeaf
  Attribute
  Class Variable
  PUBLIC
  Signal if this IResource implementor is a "leaf node" or not. If True, getChildWithDefault will not be called on this Resource.
- twisted.web.guard.HTTPAuthSessionWrapper._log
  twisted.web.guard.HTTPAuthSessionWrapper.html#_log
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.web.guard.HTTPAuthSessionWrapper.__init__
  twisted.web.guard.HTTPAuthSessionWrapper.html#__init__
  Function
  Method
  PUBLIC
  Initialize a session wrapper
- twisted.web.guard.HTTPAuthSessionWrapper._authorizedResource
  twisted.web.guard.HTTPAuthSessionWrapper.html#_authorizedResource
  Function
  Method
  PRIVATE
  Get the `IResource` which the given request is authorized to receive. If the proper authorization headers are present, the resource will be requested from the portal. If not, an anonymous login attempt will be made.
- twisted.web.guard.HTTPAuthSessionWrapper.render
  twisted.web.guard.HTTPAuthSessionWrapper.html#render
  Function
  Method
  PUBLIC
  Find the `IResource` avatar suitable for the given request, if possible, and render it. Otherwise, perhaps render an error page requiring authorization or describing an internal server failure.
- twisted.web.guard.HTTPAuthSessionWrapper.getChildWithDefault
  twisted.web.guard.HTTPAuthSessionWrapper.html#getChildWithDefault
  Function
  Method
  PUBLIC
  Inspect the Authorization HTTP header, and return a deferred which, when fired after successful authentication, will return an authorized `Avatar`. On authentication failure, an `UnauthorizedResource` will be returned, essentially halting further dispatch on the wrapped resource and all children...
- twisted.web.guard.HTTPAuthSessionWrapper._login
  twisted.web.guard.HTTPAuthSessionWrapper.html#_login
  Function
  Method
  PRIVATE
  Get the `IResource` avatar for the given credentials.
- twisted.web.guard.HTTPAuthSessionWrapper._loginSucceeded
  twisted.web.guard.HTTPAuthSessionWrapper.html#_loginSucceeded
  Function
  Method
  PRIVATE
  Handle login success by wrapping the resulting `IResource` avatar so that the `logout` callback will be invoked when rendering is complete.
- twisted.web.guard.HTTPAuthSessionWrapper._loginFailed
  twisted.web.guard.HTTPAuthSessionWrapper.html#_loginFailed
  Function
  Method
  PRIVATE
  Handle login failure by presenting either another challenge (for expected authentication/authorization-related failures) or a server error page (for anything else).
- twisted.web.guard.HTTPAuthSessionWrapper._selectParseHeader
  twisted.web.guard.HTTPAuthSessionWrapper.html#_selectParseHeader
  Function
  Method
  PRIVATE
  Choose an `ICredentialFactory` from `_credentialFactories` suitable to use to decode the given Authenticate header.
- twisted.web.guard.HTTPAuthSessionWrapper.putChild
  twisted.web.guard.HTTPAuthSessionWrapper.html#putChild
  Function
  Method
  PUBLIC
  Put a child IResource implementor at the given path.
- twisted.web.html.PRE
  twisted.web.html.html#PRE
  Function
  Function
  PUBLIC
  Wrap <pre> tags around some text and HTML-escape it.
- twisted.web.html.UL
  twisted.web.html.html#UL
  Function
  Function
  PUBLIC
  Undocumented
- twisted.web.html.linkList
  twisted.web.html.html#linkList
  Function
  Function
  PUBLIC
  Undocumented
- twisted.web.html.output
  twisted.web.html.html#output
  Function
  Function
  PUBLIC
  output(func, *args, **kw) -> html string Either return the result of a function (which presumably returns an HTML-legal string) or a sparse HTMLized error message and a message in the server log.
- twisted.web.pages._ErrorPage
  twisted.web.pages._ErrorPage.html
  Class
  Class
  PRIVATE
  `_ErrorPage` is a resource that responds to all requests with a particular (parameterized) HTTP status code and an HTML body containing some descriptive text. This is useful for rendering simple error pages.
- twisted.web.pages._ErrorPage._code
  twisted.web.pages._ErrorPage.html#_code
  Attribute
  Instance Variable
  PRIVATE
  An integer HTTP status code which will be used for the response.
- twisted.web.pages._ErrorPage._brief
  twisted.web.pages._ErrorPage.html#_brief
  Attribute
  Instance Variable
  PRIVATE
  A short string which will be included in the response body as the page title.
- twisted.web.pages._ErrorPage._detail
  twisted.web.pages._ErrorPage.html#_detail
  Attribute
  Instance Variable
  PRIVATE
  A longer string which will be included in the response body.
- twisted.web.pages._ErrorPage.__init__
  twisted.web.pages._ErrorPage.html#__init__
  Function
  Method
  PUBLIC
  Initialize.
- twisted.web.pages._ErrorPage.render
  twisted.web.pages._ErrorPage.html#render
  Function
  Method
  PUBLIC
  Respond to all requests with the given HTTP status code and an HTML document containing the explanatory strings.
- twisted.web.pages._ErrorPage.getChild
  twisted.web.pages._ErrorPage.html#getChild
  Function
  Method
  PUBLIC
  Handle all requests for which `_ErrorPage` lacks a child by returning this error page.
- twisted.web.pages.errorPage
  twisted.web.pages.html#errorPage
  Function
  Function
  PUBLIC
  Build a resource that responds to all requests with a particular HTTP status code and an HTML body containing some descriptive text. This is useful for rendering simple error pages.
- twisted.web.pages.notFound
  twisted.web.pages.html#notFound
  Function
  Function
  PUBLIC
  Generate an `IResource` with a 404 Not Found status code.
- twisted.web.pages.forbidden
  twisted.web.pages.html#forbidden
  Function
  Function
  PUBLIC
  Generate an `IResource` with a 403 Forbidden status code.
- twisted.web.proxy.ProxyClient
  twisted.web.proxy.ProxyClient.html
  Class
  Class
  PUBLIC
  Used by ProxyClientFactory to implement a simple web proxy.
- twisted.web.proxy.ProxyClient._finished
  twisted.web.proxy.ProxyClient.html#_finished
  Attribute
  Instance Variable
  PRIVATE
  A flag which indicates whether or not the original request has been finished yet.
- twisted.web.proxy.ProxyClient.__init__
  twisted.web.proxy.ProxyClient.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.proxy.ProxyClient.father
  twisted.web.proxy.ProxyClient.html#father
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.proxy.ProxyClient.command
  twisted.web.proxy.ProxyClient.html#command
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.proxy.ProxyClient.rest
  twisted.web.proxy.ProxyClient.html#rest
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.proxy.ProxyClient.headers
  twisted.web.proxy.ProxyClient.html#headers
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.proxy.ProxyClient.data
  twisted.web.proxy.ProxyClient.html#data
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.proxy.ProxyClient.connectionMade
  twisted.web.proxy.ProxyClient.html#connectionMade
  Function
  Method
  PUBLIC
  Called when a connection is made.
- twisted.web.proxy.ProxyClient.handleStatus
  twisted.web.proxy.ProxyClient.html#handleStatus
  Function
  Method
  PUBLIC
  Called when the status-line is received.
- twisted.web.proxy.ProxyClient.handleHeader
  twisted.web.proxy.ProxyClient.html#handleHeader
  Function
  Method
  PUBLIC
  Called every time a header is received.
- twisted.web.proxy.ProxyClient.handleResponsePart
  twisted.web.proxy.ProxyClient.html#handleResponsePart
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.proxy.ProxyClient.handleResponseEnd
  twisted.web.proxy.ProxyClient.html#handleResponseEnd
  Function
  Method
  PUBLIC
  Finish the original request, indicating that the response has been completely written to it, and disconnect the outgoing transport.
- twisted.web.proxy.ProxyClientFactory
  twisted.web.proxy.ProxyClientFactory.html
  Class
  Class
  PUBLIC
  Used by ProxyRequest to implement a simple web proxy.
- twisted.web.proxy.ProxyClientFactory.__init__
  twisted.web.proxy.ProxyClientFactory.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.proxy.ProxyClientFactory.father
  twisted.web.proxy.ProxyClientFactory.html#father
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.proxy.ProxyClientFactory.command
  twisted.web.proxy.ProxyClientFactory.html#command
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.proxy.ProxyClientFactory.rest
  twisted.web.proxy.ProxyClientFactory.html#rest
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.proxy.ProxyClientFactory.headers
  twisted.web.proxy.ProxyClientFactory.html#headers
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.proxy.ProxyClientFactory.data
  twisted.web.proxy.ProxyClientFactory.html#data
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.proxy.ProxyClientFactory.version
  twisted.web.proxy.ProxyClientFactory.html#version
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.proxy.ProxyClientFactory.buildProtocol
  twisted.web.proxy.ProxyClientFactory.html#buildProtocol
  Function
  Method
  PUBLIC
  Create an instance of a subclass of Protocol.
- twisted.web.proxy.ProxyClientFactory.clientConnectionFailed
  twisted.web.proxy.ProxyClientFactory.html#clientConnectionFailed
  Function
  Method
  PUBLIC
  Report a connection failure in a response to the incoming request as an error.
- twisted.web.proxy.ProxyRequest
  twisted.web.proxy.ProxyRequest.html
  Class
  Class
  PUBLIC
  Used by Proxy to implement a simple web proxy.
- twisted.web.proxy.ProxyRequest.reactor
  twisted.web.proxy.ProxyRequest.html#reactor
  Attribute
  Instance Variable
  PUBLIC
  the reactor used to create connections.
- twisted.web.proxy.ProxyRequest.protocols
  twisted.web.proxy.ProxyRequest.html#protocols
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.web.proxy.ProxyRequest.ports
  twisted.web.proxy.ProxyRequest.html#ports
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.web.proxy.ProxyRequest.__init__
  twisted.web.proxy.ProxyRequest.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.web.proxy.ProxyRequest.process
  twisted.web.proxy.ProxyRequest.html#process
  Function
  Method
  PUBLIC
  Override in subclasses.
- twisted.web.proxy.Proxy
  twisted.web.proxy.Proxy.html
  Class
  Class
  PUBLIC
  This class implements a simple web proxy.
- twisted.web.proxy.ReverseProxyRequest
  twisted.web.proxy.ReverseProxyRequest.html
  Class
  Class
  PUBLIC
  Used by ReverseProxy to implement a simple reverse proxy.
- twisted.web.proxy.ReverseProxyRequest.proxyClientFactoryClass
  twisted.web.proxy.ReverseProxyRequest.html#proxyClientFactoryClass
  Attribute
  Instance Variable
  PUBLIC
  a proxy client factory class, used to create new connections.
- twisted.web.proxy.ReverseProxyRequest.reactor
  twisted.web.proxy.ReverseProxyRequest.html#reactor
  Attribute
  Instance Variable
  PUBLIC
  the reactor used to create connections.
- twisted.web.proxy.ReverseProxyRequest.__init__
  twisted.web.proxy.ReverseProxyRequest.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.web.proxy.ReverseProxyRequest.process
  twisted.web.proxy.ReverseProxyRequest.html#process
  Function
  Method
  PUBLIC
  Handle this request by connecting to the proxied server and forwarding it there, then forwarding the response back as the response to this request.
- twisted.web.proxy.ReverseProxy
  twisted.web.proxy.ReverseProxy.html
  Class
  Class
  PUBLIC
  Implements a simple reverse proxy.
- twisted.web.proxy.ReverseProxyResource
  twisted.web.proxy.ReverseProxyResource.html
  Class
  Class
  PUBLIC
  Resource that renders the results gotten from another server
- twisted.web.proxy.ReverseProxyResource.proxyClientFactoryClass
  twisted.web.proxy.ReverseProxyResource.html#proxyClientFactoryClass
  Attribute
  Instance Variable
  PUBLIC
  a proxy client factory class, used to create new connections.
- twisted.web.proxy.ReverseProxyResource.reactor
  twisted.web.proxy.ReverseProxyResource.html#reactor
  Attribute
  Instance Variable
  PUBLIC
  the reactor used to create connections.
- twisted.web.proxy.ReverseProxyResource.__init__
  twisted.web.proxy.ReverseProxyResource.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.web.proxy.ReverseProxyResource.host
  twisted.web.proxy.ReverseProxyResource.html#host
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.proxy.ReverseProxyResource.port
  twisted.web.proxy.ReverseProxyResource.html#port
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.proxy.ReverseProxyResource.path
  twisted.web.proxy.ReverseProxyResource.html#path
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.proxy.ReverseProxyResource.getChild
  twisted.web.proxy.ReverseProxyResource.html#getChild
  Function
  Method
  PUBLIC
  Create and return a proxy resource with the same proxy configuration as this one, except that its path also contains the segment given by `path` at the end.
- twisted.web.proxy.ReverseProxyResource.render
  twisted.web.proxy.ReverseProxyResource.html#render
  Function
  Method
  PUBLIC
  Render a request by forwarding it to the proxied server.
- twisted.web.rewrite.RewriterResource
  twisted.web.rewrite.RewriterResource.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.web.rewrite.RewriterResource.__init__
  twisted.web.rewrite.RewriterResource.html#__init__
  Function
  Method
  PUBLIC
  Initialize.
- twisted.web.rewrite.RewriterResource.resource
  twisted.web.rewrite.RewriterResource.html#resource
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.rewrite.RewriterResource.rewriteRules
  twisted.web.rewrite.RewriterResource.html#rewriteRules
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.rewrite.RewriterResource._rewrite
  twisted.web.rewrite.RewriterResource.html#_rewrite
  Function
  Method
  PRIVATE
  Undocumented
- twisted.web.rewrite.RewriterResource.getChild
  twisted.web.rewrite.RewriterResource.html#getChild
  Function
  Method
  PUBLIC
  Retrieve a 'child' resource from me.
- twisted.web.rewrite.RewriterResource.render
  twisted.web.rewrite.RewriterResource.html#render
  Function
  Method
  PUBLIC
  Render a given resource. See `IResource`'s render method.
- twisted.web.rewrite.tildeToUsers
  twisted.web.rewrite.html#tildeToUsers
  Function
  Function
  PUBLIC
  Undocumented
- twisted.web.rewrite.alias
  twisted.web.rewrite.html#alias
  Function
  Function
  PUBLIC
  I am not a very good aliaser. But I'm the best I can be. If I'm aliasing to a Resource that generates links, and it uses any parts of request.prepath to do so, the links will not be relative to the aliased path, but rather to the aliased-to path...
- twisted.web.script.rpyNoResource
  twisted.web.script.html#rpyNoResource
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.web.script.AlreadyCached
  twisted.web.script.AlreadyCached.html
  Class
  Exception
  PUBLIC
  This exception is raised when a path has already been cached.
- twisted.web.script.CacheScanner
  twisted.web.script.CacheScanner.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.web.script.CacheScanner.__init__
  twisted.web.script.CacheScanner.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.script.CacheScanner.path
  twisted.web.script.CacheScanner.html#path
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.script.CacheScanner.registry
  twisted.web.script.CacheScanner.html#registry
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.script.CacheScanner.doCache
  twisted.web.script.CacheScanner.html#doCache
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.script.CacheScanner.cache
  twisted.web.script.CacheScanner.html#cache
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.script.CacheScanner.recache
  twisted.web.script.CacheScanner.html#recache
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.script.noRsrc
  twisted.web.script.html#noRsrc
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.web.script.ResourceScript
  twisted.web.script.html#ResourceScript
  Function
  Function
  PUBLIC
  I am a normal py file which must define a 'resource' global, which should be an instance of (a subclass of) web.resource.Resource; it will be renderred.
- twisted.web.script.ResourceTemplate
  twisted.web.script.html#ResourceTemplate
  Function
  Function
  PUBLIC
  Undocumented
- twisted.web.script.ResourceScriptWrapper
  twisted.web.script.ResourceScriptWrapper.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.web.script.ResourceScriptWrapper.__init__
  twisted.web.script.ResourceScriptWrapper.html#__init__
  Function
  Method
  PUBLIC
  Initialize.
- twisted.web.script.ResourceScriptWrapper.path
  twisted.web.script.ResourceScriptWrapper.html#path
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.script.ResourceScriptWrapper.registry
  twisted.web.script.ResourceScriptWrapper.html#registry
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.script.ResourceScriptWrapper.render
  twisted.web.script.ResourceScriptWrapper.html#render
  Function
  Method
  PUBLIC
  Render a given resource. See `IResource`'s render method.
- twisted.web.script.ResourceScriptWrapper.getChildWithDefault
  twisted.web.script.ResourceScriptWrapper.html#getChildWithDefault
  Function
  Method
  PUBLIC
  Retrieve a static or dynamically generated child resource from me.
- twisted.web.script.ResourceScriptDirectory
  twisted.web.script.ResourceScriptDirectory.html
  Class
  Class
  PUBLIC
  `ResourceScriptDirectory` is a resource which serves scripts from a filesystem directory. File children of a `ResourceScriptDirectory` will be served using `ResourceScript`. Directory children will be served using another ...
- twisted.web.script.ResourceScriptDirectory.path
  twisted.web.script.ResourceScriptDirectory.html#path
  Attribute
  Instance Variable
  PUBLIC
  A `str` giving the filesystem path in which children will be looked up.
- twisted.web.script.ResourceScriptDirectory.registry
  twisted.web.script.ResourceScriptDirectory.html#registry
  Attribute
  Instance Variable
  PUBLIC
  A `static.Registry` instance which will be used to decide how to interpret scripts found as children of this resource.
- twisted.web.script.ResourceScriptDirectory.__init__
  twisted.web.script.ResourceScriptDirectory.html#__init__
  Function
  Method
  PUBLIC
  Initialize.
- twisted.web.script.ResourceScriptDirectory.getChild
  twisted.web.script.ResourceScriptDirectory.html#getChild
  Function
  Method
  PUBLIC
  Retrieve a 'child' resource from me.
- twisted.web.script.ResourceScriptDirectory.render
  twisted.web.script.ResourceScriptDirectory.html#render
  Function
  Method
  PUBLIC
  Render a given resource. See `IResource`'s render method.
- twisted.web.script.PythonScript
  twisted.web.script.PythonScript.html
  Class
  Class
  PUBLIC
  I am an extremely simple dynamic resource; an embedded python script.
- twisted.web.script.PythonScript.isLeaf
  twisted.web.script.PythonScript.html#isLeaf
  Attribute
  Class Variable
  PUBLIC
  Signal if this IResource implementor is a "leaf node" or not. If True, getChildWithDefault will not be called on this Resource.
- twisted.web.script.PythonScript.__init__
  twisted.web.script.PythonScript.html#__init__
  Function
  Method
  PUBLIC
  Initialize me with a script name.
- twisted.web.script.PythonScript.filename
  twisted.web.script.PythonScript.html#filename
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.script.PythonScript.registry
  twisted.web.script.PythonScript.html#registry
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.script.PythonScript.render
  twisted.web.script.PythonScript.html#render
  Function
  Method
  PUBLIC
  Render me to a web client.
- twisted.web.soap.SOAPPublisher
  twisted.web.soap.SOAPPublisher.html
  Class
  Class
  PUBLIC
  Publish SOAP methods.
- twisted.web.soap.SOAPPublisher.isLeaf
  twisted.web.soap.SOAPPublisher.html#isLeaf
  Attribute
  Class Variable
  PUBLIC
  Signal if this IResource implementor is a "leaf node" or not. If True, getChildWithDefault will not be called on this Resource.
- twisted.web.soap.SOAPPublisher.encoding
  twisted.web.soap.SOAPPublisher.html#encoding
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.web.soap.SOAPPublisher.lookupFunction
  twisted.web.soap.SOAPPublisher.html#lookupFunction
  Function
  Method
  PUBLIC
  Lookup published SOAP function.
- twisted.web.soap.SOAPPublisher.render
  twisted.web.soap.SOAPPublisher.html#render
  Function
  Method
  PUBLIC
  Handle a SOAP command.
- twisted.web.soap.SOAPPublisher._methodNotFound
  twisted.web.soap.SOAPPublisher.html#_methodNotFound
  Function
  Method
  PRIVATE
  Undocumented
- twisted.web.soap.SOAPPublisher._gotResult
  twisted.web.soap.SOAPPublisher.html#_gotResult
  Function
  Method
  PRIVATE
  Undocumented
- twisted.web.soap.SOAPPublisher._gotError
  twisted.web.soap.SOAPPublisher.html#_gotError
  Function
  Method
  PRIVATE
  Undocumented
- twisted.web.soap.SOAPPublisher._sendResponse
  twisted.web.soap.SOAPPublisher.html#_sendResponse
  Function
  Method
  PRIVATE
  Undocumented
- twisted.web.soap.Proxy
  twisted.web.soap.Proxy.html
  Class
  Class
  PUBLIC
  A Proxy for making remote SOAP calls.
- twisted.web.soap.Proxy.__init__
  twisted.web.soap.Proxy.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.soap.Proxy.url
  twisted.web.soap.Proxy.html#url
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.soap.Proxy.namespace
  twisted.web.soap.Proxy.html#namespace
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.soap.Proxy.header
  twisted.web.soap.Proxy.html#header
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.soap.Proxy._cbGotResult
  twisted.web.soap.Proxy.html#_cbGotResult
  Function
  Method
  PRIVATE
  Undocumented
- twisted.web.soap.Proxy.callRemote
  twisted.web.soap.Proxy.html#callRemote
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.twcgi.CGIDirectory
  twisted.web.twcgi.CGIDirectory.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.web.twcgi.CGIDirectory.__init__
  twisted.web.twcgi.CGIDirectory.html#__init__
  Function
  Method
  PUBLIC
  Initialize.
- twisted.web.twcgi.CGIDirectory.getChild
  twisted.web.twcgi.CGIDirectory.html#getChild
  Function
  Method
  PUBLIC
  Retrieve a 'child' resource from me.
- twisted.web.twcgi.CGIDirectory.render
  twisted.web.twcgi.CGIDirectory.html#render
  Function
  Method
  PUBLIC
  Render a given resource. See `IResource`'s render method.
- twisted.web.twcgi.CGIScript
  twisted.web.twcgi.CGIScript.html
  Class
  Class
  PUBLIC
  `CGIScript` is a resource which runs child processes according to the CGI specification.
- twisted.web.twcgi.CGIScript.isLeaf
  twisted.web.twcgi.CGIScript.html#isLeaf
  Attribute
  Class Variable
  PUBLIC
  Signal if this IResource implementor is a "leaf node" or not. If True, getChildWithDefault will not be called on this Resource.
- twisted.web.twcgi.CGIScript.__init__
  twisted.web.twcgi.CGIScript.html#__init__
  Function
  Method
  PUBLIC
  Initialize, with the name of a CGI script file.
- twisted.web.twcgi.CGIScript.filename
  twisted.web.twcgi.CGIScript.html#filename
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.twcgi.CGIScript._reactor
  twisted.web.twcgi.CGIScript.html#_reactor
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.web.twcgi.CGIScript.render
  twisted.web.twcgi.CGIScript.html#render
  Function
  Method
  PUBLIC
  Do various things to conform to the CGI specification.
- twisted.web.twcgi.CGIScript.runProcess
  twisted.web.twcgi.CGIScript.html#runProcess
  Function
  Method
  PUBLIC
  Run the cgi script.
- twisted.web.twcgi.FilteredScript
  twisted.web.twcgi.FilteredScript.html
  Class
  Class
  PUBLIC
  I am a special version of a CGI script, that uses a specific executable.
- twisted.web.twcgi.FilteredScript.filter
  twisted.web.twcgi.FilteredScript.html#filter
  Attribute
  Instance Variable
  PUBLIC
  The absolute path to the executable.
- twisted.web.twcgi.FilteredScript.runProcess
  twisted.web.twcgi.FilteredScript.html#runProcess
  Function
  Method
  PUBLIC
  Run a script through the `filter` executable.
- twisted.web.twcgi.CGIProcessProtocol
  twisted.web.twcgi.CGIProcessProtocol.html
  Class
  Class
  PUBLIC
  No class docstring; 0/5 instance variable, 0/2 class variable, 2/12 methods documented
- twisted.web.twcgi.CGIProcessProtocol.handling_headers
  twisted.web.twcgi.CGIProcessProtocol.html#handling_headers
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.twcgi.CGIProcessProtocol.headers_written
  twisted.web.twcgi.CGIProcessProtocol.html#headers_written
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.web.twcgi.CGIProcessProtocol.headertext
  twisted.web.twcgi.CGIProcessProtocol.html#headertext
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.twcgi.CGIProcessProtocol.errortext
  twisted.web.twcgi.CGIProcessProtocol.html#errortext
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.twcgi.CGIProcessProtocol._log
  twisted.web.twcgi.CGIProcessProtocol.html#_log
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.web.twcgi.CGIProcessProtocol._requestFinished
  twisted.web.twcgi.CGIProcessProtocol.html#_requestFinished
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.web.twcgi.CGIProcessProtocol.view_resumeProducing
  twisted.web.twcgi.CGIProcessProtocol.html#view_resumeProducing
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.twcgi.CGIProcessProtocol.view_pauseProducing
  twisted.web.twcgi.CGIProcessProtocol.html#view_pauseProducing
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.twcgi.CGIProcessProtocol.view_stopProducing
  twisted.web.twcgi.CGIProcessProtocol.html#view_stopProducing
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.twcgi.CGIProcessProtocol.resumeProducing
  twisted.web.twcgi.CGIProcessProtocol.html#resumeProducing
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.twcgi.CGIProcessProtocol.pauseProducing
  twisted.web.twcgi.CGIProcessProtocol.html#pauseProducing
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.twcgi.CGIProcessProtocol.stopProducing
  twisted.web.twcgi.CGIProcessProtocol.html#stopProducing
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.twcgi.CGIProcessProtocol.__init__
  twisted.web.twcgi.CGIProcessProtocol.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.twcgi.CGIProcessProtocol.request
  twisted.web.twcgi.CGIProcessProtocol.html#request
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.twcgi.CGIProcessProtocol.connectionMade
  twisted.web.twcgi.CGIProcessProtocol.html#connectionMade
  Function
  Method
  PUBLIC
  Called when a connection is made.
- twisted.web.twcgi.CGIProcessProtocol.errReceived
  twisted.web.twcgi.CGIProcessProtocol.html#errReceived
  Function
  Method
  PUBLIC
  Some data was received from stderr.
- twisted.web.twcgi.CGIProcessProtocol.outReceived
  twisted.web.twcgi.CGIProcessProtocol.html#outReceived
  Function
  Method
  PUBLIC
  Handle a chunk of input
- twisted.web.twcgi.CGIProcessProtocol.processEnded
  twisted.web.twcgi.CGIProcessProtocol.html#processEnded
  Function
  Method
  PUBLIC
  Called when the child process exits and all file descriptors associated with it have been closed.
- twisted.web.twcgi.CGIProcessProtocol._finished
  twisted.web.twcgi.CGIProcessProtocol.html#_finished
  Function
  Method
  PRIVATE
  Record the end of the response generation for the request being serviced.
- twisted.web.wsgi._wsgiString
  twisted.web.wsgi.html#_wsgiString
  Function
  Function
  PRIVATE
  Convert `string` to an ISO-8859-1 byte string, if it is not already.
- twisted.web.wsgi._wsgiStringToBytes
  twisted.web.wsgi.html#_wsgiStringToBytes
  Function
  Function
  PRIVATE
  Return `string` as is; a WSGI string is a byte string in Python 2.
- twisted.web.wsgi._ErrorStream
  twisted.web.wsgi._ErrorStream.html
  Class
  Class
  PRIVATE
  File-like object instances of which are used as the value for the `'wsgi.errors'` key in the `environ` dictionary passed to the application object.
- twisted.web.wsgi._ErrorStream._log
  twisted.web.wsgi._ErrorStream.html#_log
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.web.wsgi._ErrorStream.write
  twisted.web.wsgi._ErrorStream.html#write
  Function
  Method
  PUBLIC
  Generate an event for the logging system with the given bytes as the message.
- twisted.web.wsgi._ErrorStream.writelines
  twisted.web.wsgi._ErrorStream.html#writelines
  Function
  Method
  PUBLIC
  Join the given lines and pass them to `write` to be handled in the usual way.
- twisted.web.wsgi._ErrorStream.flush
  twisted.web.wsgi._ErrorStream.html#flush
  Function
  Method
  PUBLIC
  Nothing is buffered, so flushing does nothing. This method is required to exist by PEP 333, though.
- twisted.web.wsgi._InputStream
  twisted.web.wsgi._InputStream.html
  Class
  Class
  PRIVATE
  File-like object instances of which are used as the value for the `'wsgi.input'` key in the `environ` dictionary passed to the application object.
- twisted.web.wsgi._InputStream.__init__
  twisted.web.wsgi._InputStream.html#__init__
  Function
  Method
  PUBLIC
  Initialize the instance.
- twisted.web.wsgi._InputStream._wrapped
  twisted.web.wsgi._InputStream.html#_wrapped
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.web.wsgi._InputStream.read
  twisted.web.wsgi._InputStream.html#read
  Function
  Method
  PUBLIC
  Pass through to the underlying `read`.
- twisted.web.wsgi._InputStream.readline
  twisted.web.wsgi._InputStream.html#readline
  Function
  Method
  PUBLIC
  Pass through to the underlying `readline`, with a size of `-1` replaced with a size of `None`.
- twisted.web.wsgi._InputStream.readlines
  twisted.web.wsgi._InputStream.html#readlines
  Function
  Method
  PUBLIC
  Pass through to the underlying `readlines`.
- twisted.web.wsgi._InputStream.__iter__
  twisted.web.wsgi._InputStream.html#__iter__
  Function
  Method
  PUBLIC
  Pass through to the underlying `__iter__`.
- twisted.web.wsgi._WSGIResponse
  twisted.web.wsgi._WSGIResponse.html
  Class
  Class
  PRIVATE
  Helper for `WSGIResource` which drives the WSGI application using a threadpool and hooks it up to the `http.Request`.
- twisted.web.wsgi._WSGIResponse.started
  twisted.web.wsgi._WSGIResponse.html#started
  Attribute
  Instance Variable
  PUBLIC
  A `bool` indicating whether or not the response status and headers have been written to the request yet. This may only be read or written in the WSGI application thread.
- twisted.web.wsgi._WSGIResponse.reactor
  twisted.web.wsgi._WSGIResponse.html#reactor
  Attribute
  Instance Variable
  PUBLIC
  An `IReactorThreads` provider which is used to call methods on the request in the I/O thread.
- twisted.web.wsgi._WSGIResponse.threadpool
  twisted.web.wsgi._WSGIResponse.html#threadpool
  Attribute
  Instance Variable
  PUBLIC
  A `ThreadPool` which is used to call the WSGI application object in a non-I/O thread.
- twisted.web.wsgi._WSGIResponse.application
  twisted.web.wsgi._WSGIResponse.html#application
  Attribute
  Instance Variable
  PUBLIC
  The WSGI application object.
- twisted.web.wsgi._WSGIResponse.request
  twisted.web.wsgi._WSGIResponse.html#request
  Attribute
  Instance Variable
  PUBLIC
  The `http.Request` upon which the WSGI environment is based and to which the application's output will be sent.
- twisted.web.wsgi._WSGIResponse.environ
  twisted.web.wsgi._WSGIResponse.html#environ
  Attribute
  Instance Variable
  PUBLIC
  The WSGI environment `dict`.
- twisted.web.wsgi._WSGIResponse.status
  twisted.web.wsgi._WSGIResponse.html#status
  Attribute
  Instance Variable
  PUBLIC
  The HTTP response status `str` supplied to the WSGI start_response callable by the application.
- twisted.web.wsgi._WSGIResponse.headers
  twisted.web.wsgi._WSGIResponse.html#headers
  Attribute
  Instance Variable
  PUBLIC
  A list of HTTP response headers supplied to the WSGI start_response callable by the application.
- twisted.web.wsgi._WSGIResponse._requestFinished
  twisted.web.wsgi._WSGIResponse.html#_requestFinished
  Attribute
  Instance Variable
  PRIVATE
  A flag which indicates whether it is possible to generate more response data or not. This is `False` until `http.Request.notifyFinish` tells us the request is done, then `True`.
- twisted.web.wsgi._WSGIResponse._log
  twisted.web.wsgi._WSGIResponse.html#_log
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.web.wsgi._WSGIResponse.__init__
  twisted.web.wsgi._WSGIResponse.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.wsgi._WSGIResponse._finished
  twisted.web.wsgi._WSGIResponse.html#_finished
  Function
  Method
  PRIVATE
  Record the end of the response generation for the request being serviced.
- twisted.web.wsgi._WSGIResponse.startResponse
  twisted.web.wsgi._WSGIResponse.html#startResponse
  Function
  Method
  PUBLIC
  The WSGI start_response callable. The given values are saved until they are needed to generate the response.
- twisted.web.wsgi._WSGIResponse.write
  twisted.web.wsgi._WSGIResponse.html#write
  Function
  Method
  PUBLIC
  The WSGI write callable returned by the start_response callable. The given bytes will be written to the response body, possibly flushing the status and headers first.
- twisted.web.wsgi._WSGIResponse._sendResponseHeaders
  twisted.web.wsgi._WSGIResponse.html#_sendResponseHeaders
  Function
  Method
  PRIVATE
  Set the response code and response headers on the request object, but do not flush them. The caller is responsible for doing a write in order for anything to actually be written out in response to the request.
- twisted.web.wsgi._WSGIResponse.start
  twisted.web.wsgi._WSGIResponse.html#start
  Function
  Method
  PUBLIC
  Start the WSGI application in the threadpool.
- twisted.web.wsgi._WSGIResponse.run
  twisted.web.wsgi._WSGIResponse.html#run
  Function
  Method
  PUBLIC
  Call the WSGI application object, iterate it, and handle its output.
- twisted.web.wsgi.WSGIResource
  twisted.web.wsgi.WSGIResource.html
  Class
  Class
  PUBLIC
  An `IResource` implementation which delegates responsibility for all resources hierarchically inferior to it to a WSGI application.
- twisted.web.wsgi.WSGIResource._reactor
  twisted.web.wsgi.WSGIResource.html#_reactor
  Attribute
  Instance Variable
  PRIVATE
  An `IReactorThreads` provider which will be passed on to `_WSGIResponse` to schedule calls in the I/O thread.
- twisted.web.wsgi.WSGIResource._threadpool
  twisted.web.wsgi.WSGIResource.html#_threadpool
  Attribute
  Instance Variable
  PRIVATE
  A `ThreadPool` which will be passed on to `_WSGIResponse` to run the WSGI application object.
- twisted.web.wsgi.WSGIResource._application
  twisted.web.wsgi.WSGIResource.html#_application
  Attribute
  Instance Variable
  PRIVATE
  The WSGI application object.
- twisted.web.wsgi.WSGIResource.isLeaf
  twisted.web.wsgi.WSGIResource.html#isLeaf
  Attribute
  Class Variable
  PUBLIC
  Signal if this IResource implementor is a "leaf node" or not. If True, getChildWithDefault will not be called on this Resource.
- twisted.web.wsgi.WSGIResource.__init__
  twisted.web.wsgi.WSGIResource.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.wsgi.WSGIResource.render
  twisted.web.wsgi.WSGIResource.html#render
  Function
  Method
  PUBLIC
  Turn the request into the appropriate `environ` `dict` suitable to be passed to the WSGI application object and then pass it on.
- twisted.web.wsgi.WSGIResource.getChildWithDefault
  twisted.web.wsgi.WSGIResource.html#getChildWithDefault
  Function
  Method
  PUBLIC
  Reject attempts to retrieve a child resource. All path segments beyond the one which refers to this resource are handled by the WSGI application object.
- twisted.web.wsgi.WSGIResource.putChild
  twisted.web.wsgi.WSGIResource.html#putChild
  Function
  Method
  PUBLIC
  Reject attempts to add a child resource to this resource. The WSGI application object handles all path segments beneath this resource, so `IResource` children can never be found.
- twisted.web.tap.Options
  twisted.web.tap.Options.html
  Class
  Class
  PUBLIC
  Define the options accepted by the twistd web plugin.
- twisted.web.tap.Options.synopsis
  twisted.web.tap.Options.html#synopsis
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.web.tap.Options.optParameters
  twisted.web.tap.Options.html#optParameters
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.web.tap.Options.optFlags
  twisted.web.tap.Options.html#optFlags
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.web.tap.Options.compData
  twisted.web.tap.Options.html#compData
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.web.tap.Options.longdesc
  twisted.web.tap.Options.html#longdesc
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.web.tap.Options.__init__
  twisted.web.tap.Options.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.tap.Options.opt_port
  twisted.web.tap.Options.html#opt_port
  Function
  Method
  PUBLIC
  (DEPRECATED: use --listen) Strports description of port to start the server on
- twisted.web.tap.Options.opt_https
  twisted.web.tap.Options.html#opt_https
  Function
  Method
  PUBLIC
  (DEPRECATED: use --listen) Port to listen on for Secure HTTP.
- twisted.web.tap.Options.opt_listen
  twisted.web.tap.Options.html#opt_listen
  Function
  Method
  PUBLIC
  Add an strports description of port to start the server on. [default: tcp:8080]
- twisted.web.tap.Options.opt_index
  twisted.web.tap.Options.html#opt_index
  Function
  Method
  PUBLIC
  Add the name of a file used to check for directory indexes. [default: index, index.html]
- twisted.web.tap.Options.opt_user
  twisted.web.tap.Options.html#opt_user
  Function
  Method
  PUBLIC
  Makes a server with ~/public_html and ~/.twistd-web-pb support for users.
- twisted.web.tap.Options.opt_path
  twisted.web.tap.Options.html#opt_path
  Function
  Method
  PUBLIC
  <path> is either a specific file or a directory to be set as the root of the web server. Use this if you have a directory full of HTML, cgi, epy, or rpy files or any other files that you want to be served up raw.
- twisted.web.tap.Options.opt_processor
  twisted.web.tap.Options.html#opt_processor
  Function
  Method
  PUBLIC
  `ext=class' where `class' is added as a Processor for files ending with `ext'.
- twisted.web.tap.Options.opt_class
  twisted.web.tap.Options.html#opt_class
  Function
  Method
  PUBLIC
  Create a Resource subclass with a zero-argument constructor.
- twisted.web.tap.Options.opt_resource_script
  twisted.web.tap.Options.html#opt_resource_script
  Function
  Method
  PUBLIC
  An .rpy file to be used as the root resource of the webserver.
- twisted.web.tap.Options.opt_wsgi
  twisted.web.tap.Options.html#opt_wsgi
  Function
  Method
  PUBLIC
  The FQPN of a WSGI application object to serve as the root resource of the webserver.
- twisted.web.tap.Options.opt_mime_type
  twisted.web.tap.Options.html#opt_mime_type
  Function
  Method
  PUBLIC
  Specify the default mime-type for static files.
- twisted.web.tap.Options.opt_allow_ignore_ext
  twisted.web.tap.Options.html#opt_allow_ignore_ext
  Function
  Method
  PUBLIC
  Specify whether or not a request for 'foo' should return 'foo.ext'
- twisted.web.tap.Options.opt_ignore_ext
  twisted.web.tap.Options.html#opt_ignore_ext
  Function
  Method
  PUBLIC
  Specify an extension to ignore. These will be processed in order.
- twisted.web.tap.Options.opt_add_header
  twisted.web.tap.Options.html#opt_add_header
  Function
  Method
  PUBLIC
  Specify an additional header to be included in all responses. Specified as "HeaderName: HeaderValue".
- twisted.web.tap.Options.postOptions
  twisted.web.tap.Options.html#postOptions
  Function
  Method
  PUBLIC
  Set up conditional defaults and check for dependencies.
- twisted.web.tap.makePersonalServerFactory
  twisted.web.tap.html#makePersonalServerFactory
  Function
  Function
  PUBLIC
  Create and return a factory which will respond to distrib requests against the given site.
- twisted.web.tap._AddHeadersResource
  twisted.web.tap._AddHeadersResource.html
  Class
  Class
  PRIVATE
  Undocumented
- twisted.web.tap._AddHeadersResource.__init__
  twisted.web.tap._AddHeadersResource.html#__init__
  Function
  Method
  PUBLIC
  Initialize.
- twisted.web.tap._AddHeadersResource._originalResource
  twisted.web.tap._AddHeadersResource.html#_originalResource
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.web.tap._AddHeadersResource._headers
  twisted.web.tap._AddHeadersResource.html#_headers
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.web.tap._AddHeadersResource.getChildWithDefault
  twisted.web.tap._AddHeadersResource.html#getChildWithDefault
  Function
  Method
  PUBLIC
  Retrieve a static or dynamically generated child resource from me.
- twisted.web.tap.makeService
  twisted.web.tap.html#makeService
  Function
  Function
  PUBLIC
  Undocumented
- twisted.web.vhost.VirtualHostCollection
  twisted.web.vhost.VirtualHostCollection.html
  Class
  Class
  PUBLIC
  Wrapper for virtual hosts collection.
- twisted.web.vhost.VirtualHostCollection.__init__
  twisted.web.vhost.VirtualHostCollection.html#__init__
  Function
  Method
  PUBLIC
  Initialize me.
- twisted.web.vhost.VirtualHostCollection.nvh
  twisted.web.vhost.VirtualHostCollection.html#nvh
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.vhost.VirtualHostCollection.listStaticEntities
  twisted.web.vhost.VirtualHostCollection.html#listStaticEntities
  Function
  Method
  PUBLIC
  Retrieve a list of all name, entity pairs that I store references to.
- twisted.web.vhost.VirtualHostCollection.getStaticEntity
  twisted.web.vhost.VirtualHostCollection.html#getStaticEntity
  Function
  Method
  PUBLIC
  Get an entity that was added to me using putEntity.
- twisted.web.vhost.VirtualHostCollection.reallyPutEntity
  twisted.web.vhost.VirtualHostCollection.html#reallyPutEntity
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.vhost.VirtualHostCollection.delEntity
  twisted.web.vhost.VirtualHostCollection.html#delEntity
  Function
  Method
  PUBLIC
  Remove a static reference for 'name'.
- twisted.web.vhost.NameVirtualHost
  twisted.web.vhost.NameVirtualHost.html
  Class
  Class
  PUBLIC
  I am a resource which represents named virtual hosts.
- twisted.web.vhost.NameVirtualHost.default
  twisted.web.vhost.NameVirtualHost.html#default
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.web.vhost.NameVirtualHost.__init__
  twisted.web.vhost.NameVirtualHost.html#__init__
  Function
  Method
  PUBLIC
  Initialize.
- twisted.web.vhost.NameVirtualHost.hosts
  twisted.web.vhost.NameVirtualHost.html#hosts
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.vhost.NameVirtualHost.listStaticEntities
  twisted.web.vhost.NameVirtualHost.html#listStaticEntities
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.vhost.NameVirtualHost.getStaticEntity
  twisted.web.vhost.NameVirtualHost.html#getStaticEntity
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.vhost.NameVirtualHost.addHost
  twisted.web.vhost.NameVirtualHost.html#addHost
  Function
  Method
  PUBLIC
  Add a host to this virtual host.
- twisted.web.vhost.NameVirtualHost.removeHost
  twisted.web.vhost.NameVirtualHost.html#removeHost
  Function
  Method
  PUBLIC
  Remove a host.
- twisted.web.vhost.NameVirtualHost._getResourceForRequest
  twisted.web.vhost.NameVirtualHost.html#_getResourceForRequest
  Function
  Method
  PRIVATE
  (Internal) Get the appropriate resource for the given host.
- twisted.web.vhost.NameVirtualHost.render
  twisted.web.vhost.NameVirtualHost.html#render
  Function
  Method
  PUBLIC
  Implementation of resource.Resource's render method.
- twisted.web.vhost.NameVirtualHost.getChild
  twisted.web.vhost.NameVirtualHost.html#getChild
  Function
  Method
  PUBLIC
  Implementation of resource.Resource's getChild method.
- twisted.web.vhost._HostResource
  twisted.web.vhost._HostResource.html
  Class
  Class
  PRIVATE
  Undocumented
- twisted.web.vhost._HostResource.getChild
  twisted.web.vhost._HostResource.html#getChild
  Function
  Method
  PUBLIC
  Retrieve a 'child' resource from me.
- twisted.web.vhost.VHostMonsterResource
  twisted.web.vhost.VHostMonsterResource.html
  Class
  Class
  PUBLIC
  Use this to be able to record the hostname and method (http vs. https) in the URL without disturbing your web site. If you put this resource in a URL http://foo.com/bar then requests to http://foo.com/bar/http/baz...
- twisted.web.vhost.VHostMonsterResource.getChild
  twisted.web.vhost.VHostMonsterResource.html#getChild
  Function
  Method
  PUBLIC
  Retrieve a 'child' resource from me.
- twisted.web.xmlrpc.Fault
  twisted.web.xmlrpc.html#Fault
  Attribute
  Variable
  PUBLIC
  See `xmlrpclib.Fault`
- twisted.web.xmlrpc.NOT_FOUND
  twisted.web.xmlrpc.html#NOT_FOUND
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.web.xmlrpc.FAILURE
  twisted.web.xmlrpc.html#FAILURE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.web.xmlrpc.withRequest
  twisted.web.xmlrpc.html#withRequest
  Function
  Function
  PUBLIC
  Decorator to cause the request to be passed as the first argument to the method.
- twisted.web.xmlrpc.NoSuchFunction
  twisted.web.xmlrpc.NoSuchFunction.html
  Class
  Class
  PUBLIC
  There is no function by the given name.
- twisted.web.xmlrpc.Handler
  twisted.web.xmlrpc.Handler.html
  Class
  Class
  PUBLIC
  Handle a XML-RPC request and store the state for a request in progress.
- twisted.web.xmlrpc.Handler.__init__
  twisted.web.xmlrpc.Handler.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.xmlrpc.Handler.resource
  twisted.web.xmlrpc.Handler.html#resource
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.xmlrpc.Handler.result
  twisted.web.xmlrpc.Handler.html#result
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.xmlrpc.Handler.run
  twisted.web.xmlrpc.Handler.html#run
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.xmlrpc.XMLRPC
  twisted.web.xmlrpc.XMLRPC.html
  Class
  Class
  PUBLIC
  A resource that implements XML-RPC.
- twisted.web.xmlrpc.XMLRPC.allowNone
  twisted.web.xmlrpc.XMLRPC.html#allowNone
  Attribute
  Instance Variable
  PUBLIC
  Permit XML translating of Python constant None.
- twisted.web.xmlrpc.XMLRPC.useDateTime
  twisted.web.xmlrpc.XMLRPC.html#useDateTime
  Attribute
  Instance Variable
  PUBLIC
  Present `datetime` values as `datetime.datetime` objects?
- twisted.web.xmlrpc.XMLRPC.NOT_FOUND
  twisted.web.xmlrpc.XMLRPC.html#NOT_FOUND
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.web.xmlrpc.XMLRPC.FAILURE
  twisted.web.xmlrpc.XMLRPC.html#FAILURE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.web.xmlrpc.XMLRPC.isLeaf
  twisted.web.xmlrpc.XMLRPC.html#isLeaf
  Attribute
  Class Variable
  PUBLIC
  Signal if this IResource implementor is a "leaf node" or not. If True, getChildWithDefault will not be called on this Resource.
- twisted.web.xmlrpc.XMLRPC.separator
  twisted.web.xmlrpc.XMLRPC.html#separator
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.web.xmlrpc.XMLRPC.allowedMethods
  twisted.web.xmlrpc.XMLRPC.html#allowedMethods
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.web.xmlrpc.XMLRPC._log
  twisted.web.xmlrpc.XMLRPC.html#_log
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.web.xmlrpc.XMLRPC.__init__
  twisted.web.xmlrpc.XMLRPC.html#__init__
  Function
  Method
  PUBLIC
  Initialize.
- twisted.web.xmlrpc.XMLRPC.subHandlers
  twisted.web.xmlrpc.XMLRPC.html#subHandlers
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.xmlrpc.XMLRPC.__setattr__
  twisted.web.xmlrpc.XMLRPC.html#__setattr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.xmlrpc.XMLRPC.putSubHandler
  twisted.web.xmlrpc.XMLRPC.html#putSubHandler
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.xmlrpc.XMLRPC.getSubHandler
  twisted.web.xmlrpc.XMLRPC.html#getSubHandler
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.xmlrpc.XMLRPC.getSubHandlerPrefixes
  twisted.web.xmlrpc.XMLRPC.html#getSubHandlerPrefixes
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.xmlrpc.XMLRPC.render_POST
  twisted.web.xmlrpc.XMLRPC.html#render_POST
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.xmlrpc.XMLRPC._cbRender
  twisted.web.xmlrpc.XMLRPC.html#_cbRender
  Function
  Method
  PRIVATE
  Undocumented
- twisted.web.xmlrpc.XMLRPC._ebRender
  twisted.web.xmlrpc.XMLRPC.html#_ebRender
  Function
  Method
  PRIVATE
  Undocumented
- twisted.web.xmlrpc.XMLRPC.lookupProcedure
  twisted.web.xmlrpc.XMLRPC.html#lookupProcedure
  Function
  Method
  PUBLIC
  Given a string naming a procedure, return a callable object for that procedure or raise NoSuchFunction.
- twisted.web.xmlrpc.XMLRPC.listProcedures
  twisted.web.xmlrpc.XMLRPC.html#listProcedures
  Function
  Method
  PUBLIC
  Return a list of the names of all xmlrpc procedures.
- twisted.web.xmlrpc.XMLRPCIntrospection
  twisted.web.xmlrpc.XMLRPCIntrospection.html
  Class
  Class
  PUBLIC
  Implement the XML-RPC Introspection API.
- twisted.web.xmlrpc.XMLRPCIntrospection.__init__
  twisted.web.xmlrpc.XMLRPCIntrospection.html#__init__
  Function
  Method
  PUBLIC
  Implement Introspection support for an XMLRPC server.
- twisted.web.xmlrpc.XMLRPCIntrospection._xmlrpc_parent
  twisted.web.xmlrpc.XMLRPCIntrospection.html#_xmlrpc_parent
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.web.xmlrpc.XMLRPCIntrospection.xmlrpc_listMethods
  twisted.web.xmlrpc.XMLRPCIntrospection.html#xmlrpc_listMethods
  Function
  Method
  PUBLIC
  Return a list of the method names implemented by this server.
- twisted.web.xmlrpc.XMLRPCIntrospection.xmlrpc_methodHelp
  twisted.web.xmlrpc.XMLRPCIntrospection.html#xmlrpc_methodHelp
  Function
  Method
  PUBLIC
  Return a documentation string describing the use of the given method.
- twisted.web.xmlrpc.XMLRPCIntrospection.xmlrpc_methodSignature
  twisted.web.xmlrpc.XMLRPCIntrospection.html#xmlrpc_methodSignature
  Function
  Method
  PUBLIC
  Return a list of type signatures.
- twisted.web.xmlrpc.addIntrospection
  twisted.web.xmlrpc.html#addIntrospection
  Function
  Function
  PUBLIC
  Add Introspection support to an XMLRPC server.
- twisted.web.xmlrpc.QueryProtocol
  twisted.web.xmlrpc.QueryProtocol.html
  Class
  Class
  PUBLIC
  No class docstring; 0/1 instance variable, 2/4 methods documented
- twisted.web.xmlrpc.QueryProtocol.connectionMade
  twisted.web.xmlrpc.QueryProtocol.html#connectionMade
  Function
  Method
  PUBLIC
  Called when a connection is made.
- twisted.web.xmlrpc.QueryProtocol._response
  twisted.web.xmlrpc.QueryProtocol.html#_response
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.web.xmlrpc.QueryProtocol.handleStatus
  twisted.web.xmlrpc.QueryProtocol.html#handleStatus
  Function
  Method
  PUBLIC
  Called when the status-line is received.
- twisted.web.xmlrpc.QueryProtocol.handleResponse
  twisted.web.xmlrpc.QueryProtocol.html#handleResponse
  Function
  Method
  PUBLIC
  Handle the XML-RPC response received from the server.
- twisted.web.xmlrpc.QueryProtocol.connectionLost
  twisted.web.xmlrpc.QueryProtocol.html#connectionLost
  Function
  Method
  PUBLIC
  The connection to the server has been lost.
- twisted.web.xmlrpc.payloadTemplate
  twisted.web.xmlrpc.html#payloadTemplate
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.web.xmlrpc.QueryFactory
  twisted.web.xmlrpc.QueryFactory.html
  Class
  Class
  PUBLIC
  XML-RPC Client Factory
- twisted.web.xmlrpc.QueryFactory.path
  twisted.web.xmlrpc.QueryFactory.html#path
  Attribute
  Instance Variable
  PUBLIC
  The path portion of the URL to which to post method calls.
- twisted.web.xmlrpc.QueryFactory.host
  twisted.web.xmlrpc.QueryFactory.html#host
  Attribute
  Instance Variable
  PUBLIC
  The value to use for the Host HTTP header.
- twisted.web.xmlrpc.QueryFactory.user
  twisted.web.xmlrpc.QueryFactory.html#user
  Attribute
  Instance Variable
  PUBLIC
  The username with which to authenticate with the server when making calls.
- twisted.web.xmlrpc.QueryFactory.password
  twisted.web.xmlrpc.QueryFactory.html#password
  Attribute
  Instance Variable
  PUBLIC
  The password with which to authenticate with the server when making calls.
- twisted.web.xmlrpc.QueryFactory.useDateTime
  twisted.web.xmlrpc.QueryFactory.html#useDateTime
  Attribute
  Instance Variable
  PUBLIC
  Accept datetime values as datetime.datetime objects. also passed to the underlying xmlrpclib implementation. Defaults to `False`.
- twisted.web.xmlrpc.QueryFactory.deferred
  twisted.web.xmlrpc.QueryFactory.html#deferred
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.xmlrpc.QueryFactory.__init__
  twisted.web.xmlrpc.QueryFactory.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.web.xmlrpc.QueryFactory.payload
  twisted.web.xmlrpc.QueryFactory.html#payload
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.xmlrpc.QueryFactory.parseResponse
  twisted.web.xmlrpc.QueryFactory.html#parseResponse
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.xmlrpc.QueryFactory.clientConnectionLost
  twisted.web.xmlrpc.QueryFactory.html#clientConnectionLost
  Function
  Method
  PUBLIC
  Called when an established connection is lost.
- twisted.web.xmlrpc.QueryFactory.badStatus
  twisted.web.xmlrpc.QueryFactory.html#badStatus
  Function
  Method
  PUBLIC
  Undocumented
- twisted.web.xmlrpc.Proxy
  twisted.web.xmlrpc.Proxy.html
  Class
  Class
  PUBLIC
  A Proxy for making remote XML-RPC calls.
- twisted.web.xmlrpc.Proxy.user
  twisted.web.xmlrpc.Proxy.html#user
  Attribute
  Instance Variable
  PUBLIC
  The username with which to authenticate with the server when making calls. If specified, overrides any username information embedded in `url`. If not specified, a value may be taken from `url` if present.
- twisted.web.xmlrpc.Proxy.password
  twisted.web.xmlrpc.Proxy.html#password
  Attribute
  Instance Variable
  PUBLIC
  The password with which to authenticate with the server when making calls. If specified, overrides any password information embedded in `url`. If not specified, a value may be taken from `url` if present.
- twisted.web.xmlrpc.Proxy.allowNone
  twisted.web.xmlrpc.Proxy.html#allowNone
  Attribute
  Instance Variable
  PUBLIC
  allow the use of None values in parameters. It's passed to the underlying `xmlrpclib` implementation. Defaults to `False`.
- twisted.web.xmlrpc.Proxy.useDateTime
  twisted.web.xmlrpc.Proxy.html#useDateTime
  Attribute
  Instance Variable
  PUBLIC
  Accept datetime values as datetime.datetime objects. also passed to the underlying `xmlrpclib` implementation. Defaults to `False`.
- twisted.web.xmlrpc.Proxy.connectTimeout
  twisted.web.xmlrpc.Proxy.html#connectTimeout
  Attribute
  Instance Variable
  PUBLIC
  Number of seconds to wait before assuming the connection has failed.
- twisted.web.xmlrpc.Proxy._reactor
  twisted.web.xmlrpc.Proxy.html#_reactor
  Attribute
  Instance Variable
  PRIVATE
  The reactor used to create connections.
- twisted.web.xmlrpc.Proxy.queryFactory
  twisted.web.xmlrpc.Proxy.html#queryFactory
  Attribute
  Instance Variable
  PUBLIC
  Object returning a factory for XML-RPC protocol. Use this for testing, or to manipulate the XML-RPC parsing behavior. For example, you may set this to a custom "debugging" factory object that reimplements ...
- twisted.web.xmlrpc.Proxy.__init__
  twisted.web.xmlrpc.Proxy.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.web.xmlrpc.Proxy.host
  twisted.web.xmlrpc.Proxy.html#host
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.xmlrpc.Proxy.port
  twisted.web.xmlrpc.Proxy.html#port
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.xmlrpc.Proxy.path
  twisted.web.xmlrpc.Proxy.html#path
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.xmlrpc.Proxy.secure
  twisted.web.xmlrpc.Proxy.html#secure
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.web.xmlrpc.Proxy.callRemote
  twisted.web.xmlrpc.Proxy.html#callRemote
  Function
  Method
  PUBLIC
  Call remote XML-RPC `method` with given arguments.
- twisted.words.ewords.WordsError
  twisted.words.ewords.WordsError.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.words.ewords.WordsError.__str__
  twisted.words.ewords.WordsError.html#__str__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.ewords.NoSuchUser
  twisted.words.ewords.NoSuchUser.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.words.ewords.DuplicateUser
  twisted.words.ewords.DuplicateUser.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.words.ewords.NoSuchGroup
  twisted.words.ewords.NoSuchGroup.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.words.ewords.DuplicateGroup
  twisted.words.ewords.DuplicateGroup.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.words.ewords.AlreadyLoggedIn
  twisted.words.ewords.AlreadyLoggedIn.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.words.im.baseaccount.AccountManager
  twisted.words.im.baseaccount.AccountManager.html
  Class
  Class
  PUBLIC
  I am responsible for managing a user's accounts.
- twisted.words.im.baseaccount.AccountManager.accounts
  twisted.words.im.baseaccount.AccountManager.html#accounts
  Attribute
  Instance Variable
  PUBLIC
  A collection of available accounts.
- twisted.words.im.baseaccount.AccountManager.__init__
  twisted.words.im.baseaccount.AccountManager.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.im.baseaccount.AccountManager.getSnapShot
  twisted.words.im.baseaccount.AccountManager.html#getSnapShot
  Function
  Method
  PUBLIC
  A snapshot of all the accounts and their status.
- twisted.words.im.baseaccount.AccountManager.isEmpty
  twisted.words.im.baseaccount.AccountManager.html#isEmpty
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.im.baseaccount.AccountManager.getConnectionInfo
  twisted.words.im.baseaccount.AccountManager.html#getConnectionInfo
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.im.baseaccount.AccountManager.addAccount
  twisted.words.im.baseaccount.AccountManager.html#addAccount
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.im.baseaccount.AccountManager.delAccount
  twisted.words.im.baseaccount.AccountManager.html#delAccount
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.im.baseaccount.AccountManager.connect
  twisted.words.im.baseaccount.AccountManager.html#connect
  Function
  Method
  PUBLIC
  No summary
- twisted.words.im.baseaccount.AccountManager.disconnect
  twisted.words.im.baseaccount.AccountManager.html#disconnect
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.im.baseaccount.AccountManager.quit
  twisted.words.im.baseaccount.AccountManager.html#quit
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.im.locals.Enum
  twisted.words.im.locals.Enum.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.words.im.locals.Enum.group
  twisted.words.im.locals.Enum.html#group
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.words.im.locals.Enum.__init__
  twisted.words.im.locals.Enum.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.im.locals.Enum.label
  twisted.words.im.locals.Enum.html#label
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.im.locals.Enum.__repr__
  twisted.words.im.locals.Enum.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.im.locals.Enum.__str__
  twisted.words.im.locals.Enum.html#__str__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.im.locals.StatusEnum
  twisted.words.im.locals.StatusEnum.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.words.im.locals.StatusEnum.group
  twisted.words.im.locals.StatusEnum.html#group
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.words.im.locals.OFFLINE
  twisted.words.im.locals.html#OFFLINE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.im.locals.ONLINE
  twisted.words.im.locals.html#ONLINE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.im.locals.AWAY
  twisted.words.im.locals.html#AWAY
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.im.locals.OfflineError
  twisted.words.im.locals.OfflineError.html
  Class
  Exception
  PUBLIC
  The requested action can't happen while offline.
- twisted.words.im.basechat.ContactsList
  twisted.words.im.basechat.ContactsList.html
  Class
  Class
  PUBLIC
  A GUI object that displays a contacts list.
- twisted.words.im.basechat.ContactsList.chatui
  twisted.words.im.basechat.ContactsList.html#chatui
  Attribute
  Instance Variable
  PUBLIC
  The GUI chat client associated with this contacts list.
- twisted.words.im.basechat.ContactsList.contacts
  twisted.words.im.basechat.ContactsList.html#contacts
  Attribute
  Instance Variable
  PUBLIC
  The contacts.
- twisted.words.im.basechat.ContactsList.onlineContacts
  twisted.words.im.basechat.ContactsList.html#onlineContacts
  Attribute
  Instance Variable
  PUBLIC
  The contacts who are currently online (have a status that is not `OFFLINE`).
- twisted.words.im.basechat.ContactsList.clients
  twisted.words.im.basechat.ContactsList.html#clients
  Attribute
  Instance Variable
  PUBLIC
  The signed-on clients.
- twisted.words.im.basechat.ContactsList.__init__
  twisted.words.im.basechat.ContactsList.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.words.im.basechat.ContactsList.setContactStatus
  twisted.words.im.basechat.ContactsList.html#setContactStatus
  Function
  Method
  PUBLIC
  Inform the user that a person's status has changed.
- twisted.words.im.basechat.ContactsList.registerAccountClient
  twisted.words.im.basechat.ContactsList.html#registerAccountClient
  Function
  Method
  PUBLIC
  Notify the user that an account client has been signed on to.
- twisted.words.im.basechat.ContactsList.unregisterAccountClient
  twisted.words.im.basechat.ContactsList.html#unregisterAccountClient
  Function
  Method
  PUBLIC
  Notify the user that an account client has been signed off or disconnected from.
- twisted.words.im.basechat.ContactsList.contactChangedNick
  twisted.words.im.basechat.ContactsList.html#contactChangedNick
  Function
  Method
  PUBLIC
  Update your contact information to reflect a change to a contact's nickname.
- twisted.words.im.basechat.Conversation
  twisted.words.im.basechat.Conversation.html
  Class
  Class
  PUBLIC
  A GUI window of a conversation with a specific person.
- twisted.words.im.basechat.Conversation.person
  twisted.words.im.basechat.Conversation.html#person
  Attribute
  Instance Variable
  PUBLIC
  The person who you're having this conversation with.
- twisted.words.im.basechat.Conversation.chatui
  twisted.words.im.basechat.Conversation.html#chatui
  Attribute
  Instance Variable
  PUBLIC
  The GUI chat client associated with this conversation.
- twisted.words.im.basechat.Conversation.__init__
  twisted.words.im.basechat.Conversation.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.words.im.basechat.Conversation.show
  twisted.words.im.basechat.Conversation.html#show
  Function
  Method
  PUBLIC
  Display the ConversationWindow.
- twisted.words.im.basechat.Conversation.hide
  twisted.words.im.basechat.Conversation.html#hide
  Function
  Method
  PUBLIC
  Hide the ConversationWindow.
- twisted.words.im.basechat.Conversation.sendText
  twisted.words.im.basechat.Conversation.html#sendText
  Function
  Method
  PUBLIC
  Send text to the person with whom the user is conversing.
- twisted.words.im.basechat.Conversation.showMessage
  twisted.words.im.basechat.Conversation.html#showMessage
  Function
  Method
  PUBLIC
  Display a message sent from the person with whom the user is conversing.
- twisted.words.im.basechat.Conversation.contactChangedNick
  twisted.words.im.basechat.Conversation.html#contactChangedNick
  Function
  Method
  PUBLIC
  Change a person's name.
- twisted.words.im.basechat.GroupConversation
  twisted.words.im.basechat.GroupConversation.html
  Class
  Class
  PUBLIC
  A GUI window of a conversation with a group of people.
- twisted.words.im.basechat.GroupConversation.chatui
  twisted.words.im.basechat.GroupConversation.html#chatui
  Attribute
  Instance Variable
  PUBLIC
  The GUI chat client associated with this conversation.
- twisted.words.im.basechat.GroupConversation.group
  twisted.words.im.basechat.GroupConversation.html#group
  Attribute
  Instance Variable
  PUBLIC
  The group of people that are having this conversation.
- twisted.words.im.basechat.GroupConversation.members
  twisted.words.im.basechat.GroupConversation.html#members
  Attribute
  Instance Variable
  PUBLIC
  The names of the people in this conversation.
- twisted.words.im.basechat.GroupConversation.__init__
  twisted.words.im.basechat.GroupConversation.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.words.im.basechat.GroupConversation.show
  twisted.words.im.basechat.GroupConversation.html#show
  Function
  Method
  PUBLIC
  Display the GroupConversationWindow.
- twisted.words.im.basechat.GroupConversation.hide
  twisted.words.im.basechat.GroupConversation.html#hide
  Function
  Method
  PUBLIC
  Hide the GroupConversationWindow.
- twisted.words.im.basechat.GroupConversation.sendText
  twisted.words.im.basechat.GroupConversation.html#sendText
  Function
  Method
  PUBLIC
  Send text to the group.
- twisted.words.im.basechat.GroupConversation.showGroupMessage
  twisted.words.im.basechat.GroupConversation.html#showGroupMessage
  Function
  Method
  PUBLIC
  Display to the user a message sent to this group from the given sender.
- twisted.words.im.basechat.GroupConversation.setGroupMembers
  twisted.words.im.basechat.GroupConversation.html#setGroupMembers
  Function
  Method
  PUBLIC
  Set the list of members in the group.
- twisted.words.im.basechat.GroupConversation.setTopic
  twisted.words.im.basechat.GroupConversation.html#setTopic
  Function
  Method
  PUBLIC
  Change the topic for the group conversation window and display this change to the user.
- twisted.words.im.basechat.GroupConversation.memberJoined
  twisted.words.im.basechat.GroupConversation.html#memberJoined
  Function
  Method
  PUBLIC
  Add the given member to the list of members in the group conversation and displays this to the user.
- twisted.words.im.basechat.GroupConversation.memberChangedNick
  twisted.words.im.basechat.GroupConversation.html#memberChangedNick
  Function
  Method
  PUBLIC
  Change the nickname for a member of the group conversation and displays this change to the user.
- twisted.words.im.basechat.GroupConversation.memberLeft
  twisted.words.im.basechat.GroupConversation.html#memberLeft
  Function
  Method
  PUBLIC
  Delete the given member from the list of members in the group conversation and displays the change to the user.
- twisted.words.im.basechat.ChatUI
  twisted.words.im.basechat.ChatUI.html
  Class
  Class
  PUBLIC
  A GUI chat client.
- twisted.words.im.basechat.ChatUI.conversations
  twisted.words.im.basechat.ChatUI.html#conversations
  Attribute
  Instance Variable
  PUBLIC
  A cache of all the direct windows.
- twisted.words.im.basechat.ChatUI.groupConversations
  twisted.words.im.basechat.ChatUI.html#groupConversations
  Attribute
  Instance Variable
  PUBLIC
  A cache of all the group windows.
- twisted.words.im.basechat.ChatUI.persons
  twisted.words.im.basechat.ChatUI.html#persons
  Attribute
  Instance Variable
  PUBLIC
  A cache of all the users associated with this client.
- twisted.words.im.basechat.ChatUI.groups
  twisted.words.im.basechat.ChatUI.html#groups
  Attribute
  Instance Variable
  PUBLIC
  A cache of all the groups associated with this client.
- twisted.words.im.basechat.ChatUI.onlineClients
  twisted.words.im.basechat.ChatUI.html#onlineClients
  Attribute
  Instance Variable
  PUBLIC
  A list of message sources currently online.
- twisted.words.im.basechat.ChatUI.contactsList
  twisted.words.im.basechat.ChatUI.html#contactsList
  Attribute
  Instance Variable
  PUBLIC
  A contacts list.
- twisted.words.im.basechat.ChatUI.__init__
  twisted.words.im.basechat.ChatUI.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.im.basechat.ChatUI.registerAccountClient
  twisted.words.im.basechat.ChatUI.html#registerAccountClient
  Function
  Method
  PUBLIC
  Notify the user that an account has been signed on to.
- twisted.words.im.basechat.ChatUI.unregisterAccountClient
  twisted.words.im.basechat.ChatUI.html#unregisterAccountClient
  Function
  Method
  PUBLIC
  Notify the user that an account has been signed off or disconnected.
- twisted.words.im.basechat.ChatUI.getContactsList
  twisted.words.im.basechat.ChatUI.html#getContactsList
  Function
  Method
  PUBLIC
  Get the contacts list associated with this chat window.
- twisted.words.im.basechat.ChatUI.getConversation
  twisted.words.im.basechat.ChatUI.html#getConversation
  Function
  Method
  PUBLIC
  For the given person object, return the conversation window or create and return a new conversation window if one does not exist.
- twisted.words.im.basechat.ChatUI.getGroupConversation
  twisted.words.im.basechat.ChatUI.html#getGroupConversation
  Function
  Method
  PUBLIC
  For the given group object, return the group conversation window or create and return a new group conversation window if it doesn't exist.
- twisted.words.im.basechat.ChatUI.getPerson
  twisted.words.im.basechat.ChatUI.html#getPerson
  Function
  Method
  PUBLIC
  For the given name and account client, return an instance of a `IGroup` provider or create and return a new instance of a `IGroup` provider.
- twisted.words.im.basechat.ChatUI.getGroup
  twisted.words.im.basechat.ChatUI.html#getGroup
  Function
  Method
  PUBLIC
  For the given name and account client, return an instance of a `IGroup` provider or create and return a new instance of a `IGroup` provider.
- twisted.words.im.basechat.ChatUI.contactChangedNick
  twisted.words.im.basechat.ChatUI.html#contactChangedNick
  Function
  Method
  PUBLIC
  For the given `person`, change the `person`'s `name` to `newnick` and tell the contact list and any conversation windows with that `person` to change as well.
- twisted.words.im.basesupport.AbstractGroup
  twisted.words.im.basesupport.AbstractGroup.html
  Class
  Class
  PUBLIC
  No class docstring; 0/2 instance variable, 2/7 methods documented
- twisted.words.im.basesupport.AbstractGroup.__init__
  twisted.words.im.basesupport.AbstractGroup.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.im.basesupport.AbstractGroup.name
  twisted.words.im.basesupport.AbstractGroup.html#name
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.im.basesupport.AbstractGroup.account
  twisted.words.im.basesupport.AbstractGroup.html#account
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.im.basesupport.AbstractGroup.getGroupCommands
  twisted.words.im.basesupport.AbstractGroup.html#getGroupCommands
  Function
  Method
  PUBLIC
  finds group commands
- twisted.words.im.basesupport.AbstractGroup.getTargetCommands
  twisted.words.im.basesupport.AbstractGroup.html#getTargetCommands
  Function
  Method
  PUBLIC
  finds group commands
- twisted.words.im.basesupport.AbstractGroup.join
  twisted.words.im.basesupport.AbstractGroup.html#join
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.im.basesupport.AbstractGroup.leave
  twisted.words.im.basesupport.AbstractGroup.html#leave
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.im.basesupport.AbstractGroup.__repr__
  twisted.words.im.basesupport.AbstractGroup.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.im.basesupport.AbstractGroup.__str__
  twisted.words.im.basesupport.AbstractGroup.html#__str__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.im.basesupport.AbstractPerson
  twisted.words.im.basesupport.AbstractPerson.html
  Class
  Class
  PUBLIC
  No class docstring; 0/3 instance variable, 2/5 methods documented
- twisted.words.im.basesupport.AbstractPerson.__init__
  twisted.words.im.basesupport.AbstractPerson.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.im.basesupport.AbstractPerson.name
  twisted.words.im.basesupport.AbstractPerson.html#name
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.im.basesupport.AbstractPerson.account
  twisted.words.im.basesupport.AbstractPerson.html#account
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.im.basesupport.AbstractPerson.status
  twisted.words.im.basesupport.AbstractPerson.html#status
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.im.basesupport.AbstractPerson.getPersonCommands
  twisted.words.im.basesupport.AbstractPerson.html#getPersonCommands
  Function
  Method
  PUBLIC
  finds person commands
- twisted.words.im.basesupport.AbstractPerson.getIdleTime
  twisted.words.im.basesupport.AbstractPerson.html#getIdleTime
  Function
  Method
  PUBLIC
  Returns a string.
- twisted.words.im.basesupport.AbstractPerson.__repr__
  twisted.words.im.basesupport.AbstractPerson.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.im.basesupport.AbstractPerson.__str__
  twisted.words.im.basesupport.AbstractPerson.html#__str__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.im.basesupport.AbstractClientMixin
  twisted.words.im.basesupport.AbstractClientMixin.html
  Class
  Class
  PUBLIC
  Designed to be mixed in to a Protocol implementing class.
- twisted.words.im.basesupport.AbstractClientMixin._logonDeferred
  twisted.words.im.basesupport.AbstractClientMixin.html#_logonDeferred
  Attribute
  Instance Variable
  PRIVATE
  Fired when I am done logging in.
- twisted.words.im.basesupport.AbstractClientMixin._protoBase
  twisted.words.im.basesupport.AbstractClientMixin.html#_protoBase
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.words.im.basesupport.AbstractClientMixin.__init__
  twisted.words.im.basesupport.AbstractClientMixin.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.im.basesupport.AbstractClientMixin.account
  twisted.words.im.basesupport.AbstractClientMixin.html#account
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.im.basesupport.AbstractClientMixin.chat
  twisted.words.im.basesupport.AbstractClientMixin.html#chat
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.im.basesupport.AbstractClientMixin.connectionMade
  twisted.words.im.basesupport.AbstractClientMixin.html#connectionMade
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.im.basesupport.AbstractClientMixin.connectionLost
  twisted.words.im.basesupport.AbstractClientMixin.html#connectionLost
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.im.basesupport.AbstractClientMixin.unregisterAsAccountClient
  twisted.words.im.basesupport.AbstractClientMixin.html#unregisterAsAccountClient
  Function
  Method
  PUBLIC
  Tell the chat UI that I have `signed off'.
- twisted.words.im.basesupport.AbstractAccount
  twisted.words.im.basesupport.AbstractAccount.html
  Class
  Class
  PUBLIC
  Base class for Accounts.
- twisted.words.im.basesupport.AbstractAccount._groupFactory
  twisted.words.im.basesupport.AbstractAccount.html#_groupFactory
  Attribute
  Class Variable
  PRIVATE
  A Callable that will return a `IGroup` appropriate for this account type.
- twisted.words.im.basesupport.AbstractAccount._personFactory
  twisted.words.im.basesupport.AbstractAccount.html#_personFactory
  Attribute
  Class Variable
  PRIVATE
  A Callable that will return a `IPerson` appropriate for this account type.
- twisted.words.im.basesupport.AbstractAccount._isConnecting
  twisted.words.im.basesupport.AbstractAccount.html#_isConnecting
  Attribute
  Instance Variable
  PRIVATE
  Whether I am in the process of establishing a connection to the server.
- twisted.words.im.basesupport.AbstractAccount._isOnline
  twisted.words.im.basesupport.AbstractAccount.html#_isOnline
  Attribute
  Instance Variable
  PRIVATE
  Whether I am currently on-line with the server.
- twisted.words.im.basesupport.AbstractAccount.accountName
  twisted.words.im.basesupport.AbstractAccount.html#accountName
  Attribute
  Instance Variable
  PUBLIC
  No summary
- twisted.words.im.basesupport.AbstractAccount.autoLogin
  twisted.words.im.basesupport.AbstractAccount.html#autoLogin
  Attribute
  Instance Variable
  PUBLIC
  No summary
- twisted.words.im.basesupport.AbstractAccount.username
  twisted.words.im.basesupport.AbstractAccount.html#username
  Attribute
  Instance Variable
  PUBLIC
  No summary
- twisted.words.im.basesupport.AbstractAccount.password
  twisted.words.im.basesupport.AbstractAccount.html#password
  Attribute
  Instance Variable
  PUBLIC
  No summary
- twisted.words.im.basesupport.AbstractAccount.host
  twisted.words.im.basesupport.AbstractAccount.html#host
  Attribute
  Instance Variable
  PUBLIC
  No summary
- twisted.words.im.basesupport.AbstractAccount.port
  twisted.words.im.basesupport.AbstractAccount.html#port
  Attribute
  Instance Variable
  PUBLIC
  No summary
- twisted.words.im.basesupport.AbstractAccount.client
  twisted.words.im.basesupport.AbstractAccount.html#client
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.im.basesupport.AbstractAccount.persistanceVersion
  twisted.words.im.basesupport.AbstractAccount.html#persistanceVersion
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.words.im.basesupport.AbstractAccount.__init__
  twisted.words.im.basesupport.AbstractAccount.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.im.basesupport.AbstractAccount._groups
  twisted.words.im.basesupport.AbstractAccount.html#_groups
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.words.im.basesupport.AbstractAccount._persons
  twisted.words.im.basesupport.AbstractAccount.html#_persons
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.words.im.basesupport.AbstractAccount.upgrateToVersion2
  twisted.words.im.basesupport.AbstractAccount.html#upgrateToVersion2
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.im.basesupport.AbstractAccount.__getstate__
  twisted.words.im.basesupport.AbstractAccount.html#__getstate__
  Function
  Method
  PUBLIC
  Get state, adding a version number to it on its way out.
- twisted.words.im.basesupport.AbstractAccount.isOnline
  twisted.words.im.basesupport.AbstractAccount.html#isOnline
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.im.basesupport.AbstractAccount.logOn
  twisted.words.im.basesupport.AbstractAccount.html#logOn
  Function
  Method
  PUBLIC
  Log on to this account.
- twisted.words.im.basesupport.AbstractAccount.getGroup
  twisted.words.im.basesupport.AbstractAccount.html#getGroup
  Function
  Method
  PUBLIC
  Group factory.
- twisted.words.im.basesupport.AbstractAccount.getPerson
  twisted.words.im.basesupport.AbstractAccount.html#getPerson
  Function
  Method
  PUBLIC
  Person factory.
- twisted.words.im.basesupport.AbstractAccount._startLogOn
  twisted.words.im.basesupport.AbstractAccount.html#_startLogOn
  Function
  Method
  PRIVATE
  Start the sign on process.
- twisted.words.im.basesupport.AbstractAccount._cb_logOn
  twisted.words.im.basesupport.AbstractAccount.html#_cb_logOn
  Function
  Method
  PRIVATE
  Undocumented
- twisted.words.im.basesupport.AbstractAccount._loginFailed
  twisted.words.im.basesupport.AbstractAccount.html#_loginFailed
  Function
  Method
  PRIVATE
  Errorback for `logOn`.
- twisted.words.im.basesupport.AbstractAccount._clientLost
  twisted.words.im.basesupport.AbstractAccount.html#_clientLost
  Function
  Method
  PRIVATE
  Undocumented
- twisted.words.im.basesupport.AbstractAccount.__repr__
  twisted.words.im.basesupport.AbstractAccount.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.im.interfaces.IAccount
  twisted.words.im.interfaces.IAccount.html
  Class
  Interface
  PUBLIC
  I represent a user's account with a chat service.
- twisted.words.im.interfaces.IAccount.client
  twisted.words.im.interfaces.IAccount.html#client
  Attribute
  Attribute
  PUBLIC
  The `IClient` currently connecting to this account, if any.
- twisted.words.im.interfaces.IAccount.gatewayType
  twisted.words.im.interfaces.IAccount.html#gatewayType
  Attribute
  Attribute
  PUBLIC
  A `str` that identifies the protocol used by this account.
- twisted.words.im.interfaces.IAccount.__init__
  twisted.words.im.interfaces.IAccount.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.words.im.interfaces.IAccount.isOnline
  twisted.words.im.interfaces.IAccount.html#isOnline
  Function
  Method
  PUBLIC
  Am I online?
- twisted.words.im.interfaces.IAccount.logOn
  twisted.words.im.interfaces.IAccount.html#logOn
  Function
  Method
  PUBLIC
  Go on-line.
- twisted.words.im.interfaces.IAccount.logOff
  twisted.words.im.interfaces.IAccount.html#logOff
  Function
  Method
  PUBLIC
  Sign off.
- twisted.words.im.interfaces.IAccount.getGroup
  twisted.words.im.interfaces.IAccount.html#getGroup
  Function
  Method
  PUBLIC
  No summary
- twisted.words.im.interfaces.IAccount.getPerson
  twisted.words.im.interfaces.IAccount.html#getPerson
  Function
  Method
  PUBLIC
  No summary
- twisted.words.im.interfaces.IClient
  twisted.words.im.interfaces.IClient.html
  Class
  Interface
  PUBLIC
  No interface docstring; 1/1 attribute, 3/5 methods documented
- twisted.words.im.interfaces.IClient.account
  twisted.words.im.interfaces.IClient.html#account
  Attribute
  Attribute
  PUBLIC
  The `IAccount` I am a Client for
- twisted.words.im.interfaces.IClient.__init__
  twisted.words.im.interfaces.IClient.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.words.im.interfaces.IClient.joinGroup
  twisted.words.im.interfaces.IClient.html#joinGroup
  Function
  Method
  PUBLIC
  No summary
- twisted.words.im.interfaces.IClient.leaveGroup
  twisted.words.im.interfaces.IClient.html#leaveGroup
  Function
  Method
  PUBLIC
  No summary
- twisted.words.im.interfaces.IClient.getGroupConversation
  twisted.words.im.interfaces.IClient.html#getGroupConversation
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.im.interfaces.IClient.getPerson
  twisted.words.im.interfaces.IClient.html#getPerson
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.im.interfaces.IPerson
  twisted.words.im.interfaces.IPerson.html
  Class
  Interface
  PUBLIC
  No interface docstring; 5/5 methods documented
- twisted.words.im.interfaces.IPerson.__init__
  twisted.words.im.interfaces.IPerson.html#__init__
  Function
  Method
  PUBLIC
  Initialize me.
- twisted.words.im.interfaces.IPerson.isOnline
  twisted.words.im.interfaces.IPerson.html#isOnline
  Function
  Method
  PUBLIC
  Am I online right now?
- twisted.words.im.interfaces.IPerson.getStatus
  twisted.words.im.interfaces.IPerson.html#getStatus
  Function
  Method
  PUBLIC
  What is my on-line status?
- twisted.words.im.interfaces.IPerson.getIdleTime
  twisted.words.im.interfaces.IPerson.html#getIdleTime
  Function
  Method
  PUBLIC
  No summary
- twisted.words.im.interfaces.IPerson.sendMessage
  twisted.words.im.interfaces.IPerson.html#sendMessage
  Function
  Method
  PUBLIC
  Send a message to this person.
- twisted.words.im.interfaces.IGroup
  twisted.words.im.interfaces.IGroup.html
  Class
  Interface
  PUBLIC
  A group which you may have a conversation with.
- twisted.words.im.interfaces.IGroup.name
  twisted.words.im.interfaces.IGroup.html#name
  Attribute
  Attribute
  PUBLIC
  My `str` name, as the server knows me.
- twisted.words.im.interfaces.IGroup.account
  twisted.words.im.interfaces.IGroup.html#account
  Attribute
  Attribute
  PUBLIC
  The `Account` I am accessed through.
- twisted.words.im.interfaces.IGroup.__init__
  twisted.words.im.interfaces.IGroup.html#__init__
  Function
  Method
  PUBLIC
  Initialize me.
- twisted.words.im.interfaces.IGroup.setTopic
  twisted.words.im.interfaces.IGroup.html#setTopic
  Function
  Method
  PUBLIC
  Set this Groups topic on the server.
- twisted.words.im.interfaces.IGroup.sendGroupMessage
  twisted.words.im.interfaces.IGroup.html#sendGroupMessage
  Function
  Method
  PUBLIC
  Send a message to this group.
- twisted.words.im.interfaces.IGroup.join
  twisted.words.im.interfaces.IGroup.html#join
  Function
  Method
  PUBLIC
  Join this group.
- twisted.words.im.interfaces.IGroup.leave
  twisted.words.im.interfaces.IGroup.html#leave
  Function
  Method
  PUBLIC
  Depart this group.
- twisted.words.im.interfaces.IConversation
  twisted.words.im.interfaces.IConversation.html
  Class
  Interface
  PUBLIC
  A conversation with a specific person.
- twisted.words.im.interfaces.IConversation.__init__
  twisted.words.im.interfaces.IConversation.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.words.im.interfaces.IConversation.show
  twisted.words.im.interfaces.IConversation.html#show
  Function
  Method
  PUBLIC
  doesn't seem like it belongs in this interface.
- twisted.words.im.interfaces.IConversation.hide
  twisted.words.im.interfaces.IConversation.html#hide
  Function
  Method
  PUBLIC
  nor this neither.
- twisted.words.im.interfaces.IConversation.sendText
  twisted.words.im.interfaces.IConversation.html#sendText
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.im.interfaces.IConversation.showMessage
  twisted.words.im.interfaces.IConversation.html#showMessage
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.im.interfaces.IConversation.changedNick
  twisted.words.im.interfaces.IConversation.html#changedNick
  Function
  Method
  PUBLIC
  No summary
- twisted.words.im.interfaces.IGroupConversation
  twisted.words.im.interfaces.IGroupConversation.html
  Class
  Interface
  PUBLIC
  No interface docstring; 7/9 methods documented
- twisted.words.im.interfaces.IGroupConversation.show
  twisted.words.im.interfaces.IGroupConversation.html#show
  Function
  Method
  PUBLIC
  doesn't seem like it belongs in this interface.
- twisted.words.im.interfaces.IGroupConversation.hide
  twisted.words.im.interfaces.IGroupConversation.html#hide
  Function
  Method
  PUBLIC
  nor this neither.
- twisted.words.im.interfaces.IGroupConversation.sendText
  twisted.words.im.interfaces.IGroupConversation.html#sendText
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.im.interfaces.IGroupConversation.showGroupMessage
  twisted.words.im.interfaces.IGroupConversation.html#showGroupMessage
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.im.interfaces.IGroupConversation.setGroupMembers
  twisted.words.im.interfaces.IGroupConversation.html#setGroupMembers
  Function
  Method
  PUBLIC
  Sets the list of members in the group and displays it to the user.
- twisted.words.im.interfaces.IGroupConversation.setTopic
  twisted.words.im.interfaces.IGroupConversation.html#setTopic
  Function
  Method
  PUBLIC
  Displays the topic (from the server) for the group conversation window.
- twisted.words.im.interfaces.IGroupConversation.memberJoined
  twisted.words.im.interfaces.IGroupConversation.html#memberJoined
  Function
  Method
  PUBLIC
  Adds the given member to the list of members in the group conversation and displays this to the user,
- twisted.words.im.interfaces.IGroupConversation.memberChangedNick
  twisted.words.im.interfaces.IGroupConversation.html#memberChangedNick
  Function
  Method
  PUBLIC
  Changes the oldnick in the list of members to `newnick` and displays this change to the user,
- twisted.words.im.interfaces.IGroupConversation.memberLeft
  twisted.words.im.interfaces.IGroupConversation.html#memberLeft
  Function
  Method
  PUBLIC
  Deletes the given member from the list of members in the group conversation and displays the change to the user.
- twisted.words.im.interfaces.IChatUI
  twisted.words.im.interfaces.IChatUI.html
  Class
  Interface
  PUBLIC
  No interface docstring; 8/8 methods documented
- twisted.words.im.interfaces.IChatUI.registerAccountClient
  twisted.words.im.interfaces.IChatUI.html#registerAccountClient
  Function
  Method
  PUBLIC
  Notifies user that an account has been signed on to.
- twisted.words.im.interfaces.IChatUI.unregisterAccountClient
  twisted.words.im.interfaces.IChatUI.html#unregisterAccountClient
  Function
  Method
  PUBLIC
  Notifies user that an account has been signed off or disconnected.
- twisted.words.im.interfaces.IChatUI.getContactsList
  twisted.words.im.interfaces.IChatUI.html#getContactsList
  Function
  Method
  PUBLIC
  No summary
- twisted.words.im.interfaces.IChatUI.getConversation
  twisted.words.im.interfaces.IChatUI.html#getConversation
  Function
  Method
  PUBLIC
  For the given person object, returns the conversation window or creates and returns a new conversation window if one does not exist.
- twisted.words.im.interfaces.IChatUI.getGroupConversation
  twisted.words.im.interfaces.IChatUI.html#getGroupConversation
  Function
  Method
  PUBLIC
  For the given group object, returns the group conversation window or creates and returns a new group conversation window if it doesn't exist.
- twisted.words.im.interfaces.IChatUI.getPerson
  twisted.words.im.interfaces.IChatUI.html#getPerson
  Function
  Method
  PUBLIC
  Get a Person for a client.
- twisted.words.im.interfaces.IChatUI.getGroup
  twisted.words.im.interfaces.IChatUI.html#getGroup
  Function
  Method
  PUBLIC
  Get a Group for a client.
- twisted.words.im.interfaces.IChatUI.contactChangedNick
  twisted.words.im.interfaces.IChatUI.html#contactChangedNick
  Function
  Method
  PUBLIC
  For the given person, changes the person's name to newnick, and tells the contact list and any conversation windows with that person to change as well.
- twisted.words.protocols.irc.MAX_COMMAND_LENGTH
  twisted.words.protocols.irc.html#MAX_COMMAND_LENGTH
  Attribute
  Constant
  PUBLIC
  The maximum length of a command, as defined by RFC 2812 section 2.3.
- twisted.words.protocols.irc.attributes
  twisted.words.protocols.irc.html#attributes
  Attribute
  Variable
  PUBLIC
  Singleton instance of `_CharacterAttributes`, used for constructing formatted text information.
- twisted.words.protocols.irc.NUL
  twisted.words.protocols.irc.html#NUL
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.CR
  twisted.words.protocols.irc.html#CR
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.NL
  twisted.words.protocols.irc.html#NL
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.SPC
  twisted.words.protocols.irc.html#SPC
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.CHANNEL_PREFIXES
  twisted.words.protocols.irc.html#CHANNEL_PREFIXES
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.IRCBadMessage
  twisted.words.protocols.irc.IRCBadMessage.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.IRCPasswordMismatch
  twisted.words.protocols.irc.IRCPasswordMismatch.html
  Class
  Exception
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.IRCBadModes
  twisted.words.protocols.irc.IRCBadModes.html
  Class
  Exception
  PUBLIC
  A malformed mode was encountered while attempting to parse a mode string.
- twisted.words.protocols.irc.parsemsg
  twisted.words.protocols.irc.html#parsemsg
  Function
  Function
  PUBLIC
  Breaks a message from an IRC server into its prefix, command, and arguments.
- twisted.words.protocols.irc.split
  twisted.words.protocols.irc.html#split
  Function
  Function
  PUBLIC
  Split a string into multiple lines.
- twisted.words.protocols.irc._intOrDefault
  twisted.words.protocols.irc.html#_intOrDefault
  Function
  Function
  PRIVATE
  Convert a value to an integer if possible.
- twisted.words.protocols.irc.UnhandledCommand
  twisted.words.protocols.irc.UnhandledCommand.html
  Class
  Exception
  PUBLIC
  A command dispatcher could not locate an appropriate command handler.
- twisted.words.protocols.irc._CommandDispatcherMixin
  twisted.words.protocols.irc._CommandDispatcherMixin.html
  Class
  Class
  PRIVATE
  Dispatch commands to handlers based on their name.
- twisted.words.protocols.irc._CommandDispatcherMixin.prefix
  twisted.words.protocols.irc._CommandDispatcherMixin.html#prefix
  Attribute
  Instance Variable
  PUBLIC
  Command handler prefix, used to locate handler attributes
- twisted.words.protocols.irc._CommandDispatcherMixin.dispatch
  twisted.words.protocols.irc._CommandDispatcherMixin.html#dispatch
  Function
  Method
  PUBLIC
  Perform actual command dispatch.
- twisted.words.protocols.irc.parseModes
  twisted.words.protocols.irc.html#parseModes
  Function
  Function
  PUBLIC
  Parse an IRC mode string.
- twisted.words.protocols.irc.IRC
  twisted.words.protocols.irc.IRC.html
  Class
  Class
  PUBLIC
  Internet Relay Chat server protocol.
- twisted.words.protocols.irc.IRC.buffer
  twisted.words.protocols.irc.IRC.html#buffer
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.IRC.hostname
  twisted.words.protocols.irc.IRC.html#hostname
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.IRC.encoding
  twisted.words.protocols.irc.IRC.html#encoding
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.IRC.connectionMade
  twisted.words.protocols.irc.IRC.html#connectionMade
  Function
  Method
  PUBLIC
  Called when a connection is made.
- twisted.words.protocols.irc.IRC.channels
  twisted.words.protocols.irc.IRC.html#channels
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.IRC.sendLine
  twisted.words.protocols.irc.IRC.html#sendLine
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.IRC.sendMessage
  twisted.words.protocols.irc.IRC.html#sendMessage
  Function
  Method
  PUBLIC
  Send a line formatted as an IRC message.
- twisted.words.protocols.irc.IRC.sendCommand
  twisted.words.protocols.irc.IRC.html#sendCommand
  Function
  Method
  PUBLIC
  Send to the remote peer a line formatted as an IRC message.
- twisted.words.protocols.irc.IRC._stringTags
  twisted.words.protocols.irc.IRC.html#_stringTags
  Function
  Method
  PRIVATE
  Converts a tag dictionary to a string.
- twisted.words.protocols.irc.IRC._validateTags
  twisted.words.protocols.irc.IRC.html#_validateTags
  Function
  Method
  PRIVATE
  Checks the tag dict for errors and raises `ValueError` if an error is found.
- twisted.words.protocols.irc.IRC._escapeTagValue
  twisted.words.protocols.irc.IRC.html#_escapeTagValue
  Function
  Method
  PRIVATE
  Escape the given tag value according to escaping rules in IRCv3.
- twisted.words.protocols.irc.IRC.dataReceived
  twisted.words.protocols.irc.IRC.html#dataReceived
  Function
  Method
  PUBLIC
  This hack is to support mIRC, which sends LF only, even though the RFC says CRLF. (Also, the flexibility of LineReceiver to turn "line mode" on and off was not required.)
- twisted.words.protocols.irc.IRC.handleCommand
  twisted.words.protocols.irc.IRC.html#handleCommand
  Function
  Method
  PUBLIC
  Determine the function to call for the given command and call it with the given arguments.
- twisted.words.protocols.irc.IRC.irc_unknown
  twisted.words.protocols.irc.IRC.html#irc_unknown
  Function
  Method
  PUBLIC
  Called by `handleCommand` on a command that doesn't have a defined handler. Subclasses should override this method.
- twisted.words.protocols.irc.IRC.privmsg
  twisted.words.protocols.irc.IRC.html#privmsg
  Function
  Method
  PUBLIC
  Send a message to a channel or user
- twisted.words.protocols.irc.IRC.notice
  twisted.words.protocols.irc.IRC.html#notice
  Function
  Method
  PUBLIC
  Send a "notice" to a channel or user.
- twisted.words.protocols.irc.IRC.action
  twisted.words.protocols.irc.IRC.html#action
  Function
  Method
  PUBLIC
  Send an action to a channel or user.
- twisted.words.protocols.irc.IRC.topic
  twisted.words.protocols.irc.IRC.html#topic
  Function
  Method
  PUBLIC
  Send the topic to a user.
- twisted.words.protocols.irc.IRC.topicAuthor
  twisted.words.protocols.irc.IRC.html#topicAuthor
  Function
  Method
  PUBLIC
  Send the author of and time at which a topic was set for the given channel.
- twisted.words.protocols.irc.IRC.names
  twisted.words.protocols.irc.IRC.html#names
  Function
  Method
  PUBLIC
  Send the names of a channel's participants to a user.
- twisted.words.protocols.irc.IRC.who
  twisted.words.protocols.irc.IRC.html#who
  Function
  Method
  PUBLIC
  Send a list of users participating in a channel.
- twisted.words.protocols.irc.IRC.whois
  twisted.words.protocols.irc.IRC.html#whois
  Function
  Method
  PUBLIC
  Send information about the state of a particular user.
- twisted.words.protocols.irc.IRC.join
  twisted.words.protocols.irc.IRC.html#join
  Function
  Method
  PUBLIC
  Send a join message.
- twisted.words.protocols.irc.IRC.part
  twisted.words.protocols.irc.IRC.html#part
  Function
  Method
  PUBLIC
  Send a part message.
- twisted.words.protocols.irc.IRC.channelMode
  twisted.words.protocols.irc.IRC.html#channelMode
  Function
  Method
  PUBLIC
  Send information about the mode of a channel.
- twisted.words.protocols.irc.ServerSupportedFeatures
  twisted.words.protocols.irc.ServerSupportedFeatures.html
  Class
  Class
  PUBLIC
  Handle ISUPPORT messages.
- twisted.words.protocols.irc.ServerSupportedFeatures.prefix
  twisted.words.protocols.irc.ServerSupportedFeatures.html#prefix
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.ServerSupportedFeatures.__init__
  twisted.words.protocols.irc.ServerSupportedFeatures.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.ServerSupportedFeatures._features
  twisted.words.protocols.irc.ServerSupportedFeatures.html#_features
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.words.protocols.irc.ServerSupportedFeatures._splitParamArgs
  twisted.words.protocols.irc.ServerSupportedFeatures.html#_splitParamArgs
  Function
  Class Method
  PRIVATE
  Split ISUPPORT parameter arguments.
- twisted.words.protocols.irc.ServerSupportedFeatures._unescapeParamValue
  twisted.words.protocols.irc.ServerSupportedFeatures.html#_unescapeParamValue
  Function
  Class Method
  PRIVATE
  Unescape an ISUPPORT parameter.
- twisted.words.protocols.irc.ServerSupportedFeatures._splitParam
  twisted.words.protocols.irc.ServerSupportedFeatures.html#_splitParam
  Function
  Class Method
  PRIVATE
  Split an ISUPPORT parameter.
- twisted.words.protocols.irc.ServerSupportedFeatures._parsePrefixParam
  twisted.words.protocols.irc.ServerSupportedFeatures.html#_parsePrefixParam
  Function
  Class Method
  PRIVATE
  Parse the ISUPPORT "PREFIX" parameter.
- twisted.words.protocols.irc.ServerSupportedFeatures._parseChanModesParam
  twisted.words.protocols.irc.ServerSupportedFeatures.html#_parseChanModesParam
  Function
  Class Method
  PRIVATE
  Parse the ISUPPORT "CHANMODES" parameter.
- twisted.words.protocols.irc.ServerSupportedFeatures.getFeature
  twisted.words.protocols.irc.ServerSupportedFeatures.html#getFeature
  Function
  Method
  PUBLIC
  Get a server supported feature's value.
- twisted.words.protocols.irc.ServerSupportedFeatures.hasFeature
  twisted.words.protocols.irc.ServerSupportedFeatures.html#hasFeature
  Function
  Method
  PUBLIC
  Determine whether a feature is supported or not.
- twisted.words.protocols.irc.ServerSupportedFeatures.parse
  twisted.words.protocols.irc.ServerSupportedFeatures.html#parse
  Function
  Method
  PUBLIC
  Parse ISUPPORT parameters.
- twisted.words.protocols.irc.ServerSupportedFeatures.isupport_unknown
  twisted.words.protocols.irc.ServerSupportedFeatures.html#isupport_unknown
  Function
  Method
  PUBLIC
  Unknown ISUPPORT parameter.
- twisted.words.protocols.irc.ServerSupportedFeatures.isupport_CHANLIMIT
  twisted.words.protocols.irc.ServerSupportedFeatures.html#isupport_CHANLIMIT
  Function
  Method
  PUBLIC
  The maximum number of each channel type a user may join.
- twisted.words.protocols.irc.ServerSupportedFeatures.isupport_CHANMODES
  twisted.words.protocols.irc.ServerSupportedFeatures.html#isupport_CHANMODES
  Function
  Method
  PUBLIC
  Available channel modes.
- twisted.words.protocols.irc.ServerSupportedFeatures.isupport_CHANNELLEN
  twisted.words.protocols.irc.ServerSupportedFeatures.html#isupport_CHANNELLEN
  Function
  Method
  PUBLIC
  Maximum length of a channel name a client may create.
- twisted.words.protocols.irc.ServerSupportedFeatures.isupport_CHANTYPES
  twisted.words.protocols.irc.ServerSupportedFeatures.html#isupport_CHANTYPES
  Function
  Method
  PUBLIC
  Valid channel prefixes.
- twisted.words.protocols.irc.ServerSupportedFeatures.isupport_EXCEPTS
  twisted.words.protocols.irc.ServerSupportedFeatures.html#isupport_EXCEPTS
  Function
  Method
  PUBLIC
  Mode character for "ban exceptions".
- twisted.words.protocols.irc.ServerSupportedFeatures.isupport_IDCHAN
  twisted.words.protocols.irc.ServerSupportedFeatures.html#isupport_IDCHAN
  Function
  Method
  PUBLIC
  Safe channel identifiers.
- twisted.words.protocols.irc.ServerSupportedFeatures.isupport_INVEX
  twisted.words.protocols.irc.ServerSupportedFeatures.html#isupport_INVEX
  Function
  Method
  PUBLIC
  Mode character for "invite exceptions".
- twisted.words.protocols.irc.ServerSupportedFeatures.isupport_KICKLEN
  twisted.words.protocols.irc.ServerSupportedFeatures.html#isupport_KICKLEN
  Function
  Method
  PUBLIC
  Maximum length of a kick message a client may provide.
- twisted.words.protocols.irc.ServerSupportedFeatures.isupport_MAXLIST
  twisted.words.protocols.irc.ServerSupportedFeatures.html#isupport_MAXLIST
  Function
  Method
  PUBLIC
  Maximum number of "list modes" a client may set on a channel at once.
- twisted.words.protocols.irc.ServerSupportedFeatures.isupport_MODES
  twisted.words.protocols.irc.ServerSupportedFeatures.html#isupport_MODES
  Function
  Method
  PUBLIC
  Maximum number of modes accepting parameters that may be sent, by a client, in a single MODE command.
- twisted.words.protocols.irc.ServerSupportedFeatures.isupport_NETWORK
  twisted.words.protocols.irc.ServerSupportedFeatures.html#isupport_NETWORK
  Function
  Method
  PUBLIC
  IRC network name.
- twisted.words.protocols.irc.ServerSupportedFeatures.isupport_NICKLEN
  twisted.words.protocols.irc.ServerSupportedFeatures.html#isupport_NICKLEN
  Function
  Method
  PUBLIC
  Maximum length of a nickname the client may use.
- twisted.words.protocols.irc.ServerSupportedFeatures.isupport_PREFIX
  twisted.words.protocols.irc.ServerSupportedFeatures.html#isupport_PREFIX
  Function
  Method
  PUBLIC
  Mapping of channel modes that clients may have to status flags.
- twisted.words.protocols.irc.ServerSupportedFeatures.isupport_SAFELIST
  twisted.words.protocols.irc.ServerSupportedFeatures.html#isupport_SAFELIST
  Function
  Method
  PUBLIC
  Flag indicating that a client may request a LIST without being disconnected due to the large amount of data generated.
- twisted.words.protocols.irc.ServerSupportedFeatures.isupport_STATUSMSG
  twisted.words.protocols.irc.ServerSupportedFeatures.html#isupport_STATUSMSG
  Function
  Method
  PUBLIC
  The server supports sending messages to only to clients on a channel with a specific status.
- twisted.words.protocols.irc.ServerSupportedFeatures.isupport_TARGMAX
  twisted.words.protocols.irc.ServerSupportedFeatures.html#isupport_TARGMAX
  Function
  Method
  PUBLIC
  Maximum number of targets allowable for commands that accept multiple targets.
- twisted.words.protocols.irc.ServerSupportedFeatures.isupport_TOPICLEN
  twisted.words.protocols.irc.ServerSupportedFeatures.html#isupport_TOPICLEN
  Function
  Method
  PUBLIC
  Maximum length of a topic that may be set.
- twisted.words.protocols.irc.IRCClient
  twisted.words.protocols.irc.IRCClient.html
  Class
  Class
  PUBLIC
  Internet Relay Chat client protocol, with sprinkles.
- twisted.words.protocols.irc.IRCClient.nickname
  twisted.words.protocols.irc.IRCClient.html#nickname
  Attribute
  Instance Variable
  PUBLIC
  Nickname the client will use.
- twisted.words.protocols.irc.IRCClient.password
  twisted.words.protocols.irc.IRCClient.html#password
  Attribute
  Instance Variable
  PUBLIC
  Password used to log on to the server. May be `None`.
- twisted.words.protocols.irc.IRCClient.realname
  twisted.words.protocols.irc.IRCClient.html#realname
  Attribute
  Instance Variable
  PUBLIC
  Supplied to the server during login as the "Real name" or "ircname". May be `None`.
- twisted.words.protocols.irc.IRCClient.username
  twisted.words.protocols.irc.IRCClient.html#username
  Attribute
  Instance Variable
  PUBLIC
  Supplied to the server during login as the "User name". May be `None`
- twisted.words.protocols.irc.IRCClient.userinfo
  twisted.words.protocols.irc.IRCClient.html#userinfo
  Attribute
  Instance Variable
  PUBLIC
  Sent in reply to a `USERINFO` CTCP query. If `None`, no USERINFO reply will be sent. "This is used to transmit a string which is settable by the user (and never should be set by the client)."
- twisted.words.protocols.irc.IRCClient.fingerReply
  twisted.words.protocols.irc.IRCClient.html#fingerReply
  Attribute
  Instance Variable
  PUBLIC
  Sent in reply to a `FINGER` CTCP query. If `None`, no FINGER reply will be sent.
- twisted.words.protocols.irc.IRCClient.versionName
  twisted.words.protocols.irc.IRCClient.html#versionName
  Attribute
  Instance Variable
  PUBLIC
  CTCP VERSION reply, client name. If `None`, no VERSION reply will be sent.
- twisted.words.protocols.irc.IRCClient.versionNum
  twisted.words.protocols.irc.IRCClient.html#versionNum
  Attribute
  Instance Variable
  PUBLIC
  CTCP VERSION reply, client version.
- twisted.words.protocols.irc.IRCClient.versionEnv
  twisted.words.protocols.irc.IRCClient.html#versionEnv
  Attribute
  Instance Variable
  PUBLIC
  CTCP VERSION reply, environment the client is running in.
- twisted.words.protocols.irc.IRCClient.sourceURL
  twisted.words.protocols.irc.IRCClient.html#sourceURL
  Attribute
  Instance Variable
  PUBLIC
  CTCP SOURCE reply, a URL where the source code of this client may be found. If `None`, no SOURCE reply will be sent.
- twisted.words.protocols.irc.IRCClient.lineRate
  twisted.words.protocols.irc.IRCClient.html#lineRate
  Attribute
  Instance Variable
  PUBLIC
  Minimum delay between lines sent to the server. If `None`, no delay will be imposed.
- twisted.words.protocols.irc.IRCClient.motd
  twisted.words.protocols.irc.IRCClient.html#motd
  Attribute
  Instance Variable
  PUBLIC
  Either `None` or, between receipt of RPL_MOTDSTART and RPL_ENDOFMOTD, a `list` of `str`, each of which is the content of an RPL_MOTD message.
- twisted.words.protocols.irc.IRCClient.erroneousNickFallback
  twisted.words.protocols.irc.IRCClient.html#erroneousNickFallback
  Attribute
  Instance Variable
  PUBLIC
  Default nickname assigned when an unregistered client triggers an `ERR_ERRONEUSNICKNAME` while trying to register with an illegal nickname.
- twisted.words.protocols.irc.IRCClient._registered
  twisted.words.protocols.irc.IRCClient.html#_registered
  Attribute
  Instance Variable
  PRIVATE
  Whether or not the user is registered. It becomes True once a welcome has been received from the server.
- twisted.words.protocols.irc.IRCClient._attemptedNick
  twisted.words.protocols.irc.IRCClient.html#_attemptedNick
  Attribute
  Instance Variable
  PRIVATE
  The nickname that will try to get registered. It may change if it is illegal or already taken. `nickname` becomes the `_attemptedNick` that is successfully registered.
- twisted.words.protocols.irc.IRCClient.supported
  twisted.words.protocols.irc.IRCClient.html#supported
  Attribute
  Instance Variable
  PUBLIC
  Available ISUPPORT features on the server
- twisted.words.protocols.irc.IRCClient.hostname
  twisted.words.protocols.irc.IRCClient.html#hostname
  Attribute
  Instance Variable
  PUBLIC
  Host name of the IRC server the client is connected to. Initially the host name is `None` and later is set to the host name from which the RPL_WELCOME message is received.
- twisted.words.protocols.irc.IRCClient._heartbeat
  twisted.words.protocols.irc.IRCClient.html#_heartbeat
  Attribute
  Instance Variable
  PRIVATE
  Looping call to perform the keepalive by calling `IRCClient._sendHeartbeat` every `heartbeatInterval` seconds, or `None` if there is no heartbeat.
- twisted.words.protocols.irc.IRCClient.heartbeatInterval
  twisted.words.protocols.irc.IRCClient.html#heartbeatInterval
  Attribute
  Instance Variable
  PUBLIC
  Interval, in seconds, to send PING messages to the server as a form of keepalive, defaults to 120 seconds. Use `None` to disable the heartbeat.
- twisted.words.protocols.irc.IRCClient.dcc_destdir
  twisted.words.protocols.irc.IRCClient.html#dcc_destdir
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.IRCClient.dcc_sessions
  twisted.words.protocols.irc.IRCClient.html#dcc_sessions
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.IRCClient.performLogin
  twisted.words.protocols.irc.IRCClient.html#performLogin
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.IRCClient._queue
  twisted.words.protocols.irc.IRCClient.html#_queue
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.words.protocols.irc.IRCClient._queueEmptying
  twisted.words.protocols.irc.IRCClient.html#_queueEmptying
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.words.protocols.irc.IRCClient.delimiter
  twisted.words.protocols.irc.IRCClient.html#delimiter
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.IRCClient.__pychecker__
  twisted.words.protocols.irc.IRCClient.html#__pychecker__
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.IRCClient._reallySendLine
  twisted.words.protocols.irc.IRCClient.html#_reallySendLine
  Function
  Method
  PRIVATE
  Undocumented
- twisted.words.protocols.irc.IRCClient.sendLine
  twisted.words.protocols.irc.IRCClient.html#sendLine
  Function
  Method
  PUBLIC
  Sends a line to the other end of the connection.
- twisted.words.protocols.irc.IRCClient._sendLine
  twisted.words.protocols.irc.IRCClient.html#_sendLine
  Function
  Method
  PRIVATE
  Undocumented
- twisted.words.protocols.irc.IRCClient.connectionLost
  twisted.words.protocols.irc.IRCClient.html#connectionLost
  Function
  Method
  PUBLIC
  Called when the connection is shut down.
- twisted.words.protocols.irc.IRCClient._createHeartbeat
  twisted.words.protocols.irc.IRCClient.html#_createHeartbeat
  Function
  Method
  PRIVATE
  Create the heartbeat `LoopingCall`.
- twisted.words.protocols.irc.IRCClient._sendHeartbeat
  twisted.words.protocols.irc.IRCClient.html#_sendHeartbeat
  Function
  Method
  PRIVATE
  Send a PING message to the IRC server as a form of keepalive.
- twisted.words.protocols.irc.IRCClient.stopHeartbeat
  twisted.words.protocols.irc.IRCClient.html#stopHeartbeat
  Function
  Method
  PUBLIC
  Stop sending PING messages to keep the connection to the server alive.
- twisted.words.protocols.irc.IRCClient.startHeartbeat
  twisted.words.protocols.irc.IRCClient.html#startHeartbeat
  Function
  Method
  PUBLIC
  Start sending PING messages every `IRCClient.heartbeatInterval` seconds to keep the connection to the server alive during periods of no activity.
- twisted.words.protocols.irc.IRCClient.created
  twisted.words.protocols.irc.IRCClient.html#created
  Function
  Method
  PUBLIC
  Called with creation date information about the server, usually at logon.
- twisted.words.protocols.irc.IRCClient.yourHost
  twisted.words.protocols.irc.IRCClient.html#yourHost
  Function
  Method
  PUBLIC
  Called with daemon information about the server, usually at logon.
- twisted.words.protocols.irc.IRCClient.myInfo
  twisted.words.protocols.irc.IRCClient.html#myInfo
  Function
  Method
  PUBLIC
  Called with information about the server, usually at logon.
- twisted.words.protocols.irc.IRCClient.luserClient
  twisted.words.protocols.irc.IRCClient.html#luserClient
  Function
  Method
  PUBLIC
  Called with information about the number of connections, usually at logon.
- twisted.words.protocols.irc.IRCClient.bounce
  twisted.words.protocols.irc.IRCClient.html#bounce
  Function
  Method
  PUBLIC
  Called with information about where the client should reconnect.
- twisted.words.protocols.irc.IRCClient.isupport
  twisted.words.protocols.irc.IRCClient.html#isupport
  Function
  Method
  PUBLIC
  Called with various information about what the server supports.
- twisted.words.protocols.irc.IRCClient.luserChannels
  twisted.words.protocols.irc.IRCClient.html#luserChannels
  Function
  Method
  PUBLIC
  Called with the number of channels existent on the server.
- twisted.words.protocols.irc.IRCClient.luserOp
  twisted.words.protocols.irc.IRCClient.html#luserOp
  Function
  Method
  PUBLIC
  Called with the number of ops logged on to the server.
- twisted.words.protocols.irc.IRCClient.luserMe
  twisted.words.protocols.irc.IRCClient.html#luserMe
  Function
  Method
  PUBLIC
  Called with information about the server connected to.
- twisted.words.protocols.irc.IRCClient.privmsg
  twisted.words.protocols.irc.IRCClient.html#privmsg
  Function
  Method
  PUBLIC
  Called when I have a message from a user to me or a channel.
- twisted.words.protocols.irc.IRCClient.joined
  twisted.words.protocols.irc.IRCClient.html#joined
  Function
  Method
  PUBLIC
  Called when I finish joining a channel.
- twisted.words.protocols.irc.IRCClient.left
  twisted.words.protocols.irc.IRCClient.html#left
  Function
  Method
  PUBLIC
  Called when I have left a channel.
- twisted.words.protocols.irc.IRCClient.noticed
  twisted.words.protocols.irc.IRCClient.html#noticed
  Function
  Method
  PUBLIC
  Called when I have a notice from a user to me or a channel.
- twisted.words.protocols.irc.IRCClient.modeChanged
  twisted.words.protocols.irc.IRCClient.html#modeChanged
  Function
  Method
  PUBLIC
  Called when users or channel's modes are changed.
- twisted.words.protocols.irc.IRCClient.pong
  twisted.words.protocols.irc.IRCClient.html#pong
  Function
  Method
  PUBLIC
  Called with the results of a CTCP PING query.
- twisted.words.protocols.irc.IRCClient.signedOn
  twisted.words.protocols.irc.IRCClient.html#signedOn
  Function
  Method
  PUBLIC
  Called after successfully signing on to the server.
- twisted.words.protocols.irc.IRCClient.kickedFrom
  twisted.words.protocols.irc.IRCClient.html#kickedFrom
  Function
  Method
  PUBLIC
  Called when I am kicked from a channel.
- twisted.words.protocols.irc.IRCClient.nickChanged
  twisted.words.protocols.irc.IRCClient.html#nickChanged
  Function
  Method
  PUBLIC
  Called when my nick has been changed.
- twisted.words.protocols.irc.IRCClient.userJoined
  twisted.words.protocols.irc.IRCClient.html#userJoined
  Function
  Method
  PUBLIC
  Called when I see another user joining a channel.
- twisted.words.protocols.irc.IRCClient.userLeft
  twisted.words.protocols.irc.IRCClient.html#userLeft
  Function
  Method
  PUBLIC
  Called when I see another user leaving a channel.
- twisted.words.protocols.irc.IRCClient.userQuit
  twisted.words.protocols.irc.IRCClient.html#userQuit
  Function
  Method
  PUBLIC
  Called when I see another user disconnect from the network.
- twisted.words.protocols.irc.IRCClient.userKicked
  twisted.words.protocols.irc.IRCClient.html#userKicked
  Function
  Method
  PUBLIC
  Called when I observe someone else being kicked from a channel.
- twisted.words.protocols.irc.IRCClient.action
  twisted.words.protocols.irc.IRCClient.html#action
  Function
  Method
  PUBLIC
  Called when I see a user perform an ACTION on a channel.
- twisted.words.protocols.irc.IRCClient.topicUpdated
  twisted.words.protocols.irc.IRCClient.html#topicUpdated
  Function
  Method
  PUBLIC
  In channel, user changed the topic to newTopic.
- twisted.words.protocols.irc.IRCClient.userRenamed
  twisted.words.protocols.irc.IRCClient.html#userRenamed
  Function
  Method
  PUBLIC
  A user changed their name from oldname to newname.
- twisted.words.protocols.irc.IRCClient.receivedMOTD
  twisted.words.protocols.irc.IRCClient.html#receivedMOTD
  Function
  Method
  PUBLIC
  I received a message-of-the-day banner from the server.
- twisted.words.protocols.irc.IRCClient.join
  twisted.words.protocols.irc.IRCClient.html#join
  Function
  Method
  PUBLIC
  Join a channel.
- twisted.words.protocols.irc.IRCClient.leave
  twisted.words.protocols.irc.IRCClient.html#leave
  Function
  Method
  PUBLIC
  Leave a channel.
- twisted.words.protocols.irc.IRCClient.kick
  twisted.words.protocols.irc.IRCClient.html#kick
  Function
  Method
  PUBLIC
  Attempt to kick a user from a channel.
- twisted.words.protocols.irc.IRCClient.invite
  twisted.words.protocols.irc.IRCClient.html#invite
  Function
  Method
  PUBLIC
  Attempt to invite user to channel
- twisted.words.protocols.irc.IRCClient.topic
  twisted.words.protocols.irc.IRCClient.html#topic
  Function
  Method
  PUBLIC
  Attempt to set the topic of the given channel, or ask what it is.
- twisted.words.protocols.irc.IRCClient.mode
  twisted.words.protocols.irc.IRCClient.html#mode
  Function
  Method
  PUBLIC
  Change the modes on a user or channel.
- twisted.words.protocols.irc.IRCClient.say
  twisted.words.protocols.irc.IRCClient.html#say
  Function
  Method
  PUBLIC
  Send a message to a channel
- twisted.words.protocols.irc.IRCClient._safeMaximumLineLength
  twisted.words.protocols.irc.IRCClient.html#_safeMaximumLineLength
  Function
  Method
  PRIVATE
  Estimate a safe maximum line length for the given command.
- twisted.words.protocols.irc.IRCClient.msg
  twisted.words.protocols.irc.IRCClient.html#msg
  Function
  Method
  PUBLIC
  Send a message to a user or channel.
- twisted.words.protocols.irc.IRCClient.notice
  twisted.words.protocols.irc.IRCClient.html#notice
  Function
  Method
  PUBLIC
  Send a notice to a user.
- twisted.words.protocols.irc.IRCClient.away
  twisted.words.protocols.irc.IRCClient.html#away
  Function
  Method
  PUBLIC
  Mark this client as away.
- twisted.words.protocols.irc.IRCClient.back
  twisted.words.protocols.irc.IRCClient.html#back
  Function
  Method
  PUBLIC
  Clear the away status.
- twisted.words.protocols.irc.IRCClient.whois
  twisted.words.protocols.irc.IRCClient.html#whois
  Function
  Method
  PUBLIC
  Retrieve user information about the given nickname.
- twisted.words.protocols.irc.IRCClient.register
  twisted.words.protocols.irc.IRCClient.html#register
  Function
  Method
  PUBLIC
  Login to the server.
- twisted.words.protocols.irc.IRCClient.setNick
  twisted.words.protocols.irc.IRCClient.html#setNick
  Function
  Method
  PUBLIC
  Set this client's nickname.
- twisted.words.protocols.irc.IRCClient.quit
  twisted.words.protocols.irc.IRCClient.html#quit
  Function
  Method
  PUBLIC
  Disconnect from the server
- twisted.words.protocols.irc.IRCClient.describe
  twisted.words.protocols.irc.IRCClient.html#describe
  Function
  Method
  PUBLIC
  Strike a pose.
- twisted.words.protocols.irc.IRCClient._pings
  twisted.words.protocols.irc.IRCClient.html#_pings
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.words.protocols.irc.IRCClient._MAX_PINGRING
  twisted.words.protocols.irc.IRCClient.html#_MAX_PINGRING
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.words.protocols.irc.IRCClient.ping
  twisted.words.protocols.irc.IRCClient.html#ping
  Function
  Method
  PUBLIC
  Measure round-trip delay to another IRC client.
- twisted.words.protocols.irc.IRCClient.dccSend
  twisted.words.protocols.irc.IRCClient.html#dccSend
  Function
  Method
  PUBLIC
  This is supposed to send a user a file directly. This generally doesn't work on any client, and this method is included only for backwards compatibility and completeness.
- twisted.words.protocols.irc.IRCClient.dccResume
  twisted.words.protocols.irc.IRCClient.html#dccResume
  Function
  Method
  PUBLIC
  Send a DCC RESUME request to another user.
- twisted.words.protocols.irc.IRCClient.dccAcceptResume
  twisted.words.protocols.irc.IRCClient.html#dccAcceptResume
  Function
  Method
  PUBLIC
  Send a DCC ACCEPT response to clients who have requested a resume.
- twisted.words.protocols.irc.IRCClient.irc_ERR_NICKNAMEINUSE
  twisted.words.protocols.irc.IRCClient.html#irc_ERR_NICKNAMEINUSE
  Function
  Method
  PUBLIC
  Called when we try to register or change to a nickname that is already taken.
- twisted.words.protocols.irc.IRCClient.alterCollidedNick
  twisted.words.protocols.irc.IRCClient.html#alterCollidedNick
  Function
  Method
  PUBLIC
  Generate an altered version of a nickname that caused a collision in an effort to create an unused related name for subsequent registration.
- twisted.words.protocols.irc.IRCClient.irc_ERR_ERRONEUSNICKNAME
  twisted.words.protocols.irc.IRCClient.html#irc_ERR_ERRONEUSNICKNAME
  Function
  Method
  PUBLIC
  Called when we try to register or change to an illegal nickname.
- twisted.words.protocols.irc.IRCClient.irc_ERR_PASSWDMISMATCH
  twisted.words.protocols.irc.IRCClient.html#irc_ERR_PASSWDMISMATCH
  Function
  Method
  PUBLIC
  Called when the login was incorrect.
- twisted.words.protocols.irc.IRCClient.irc_RPL_WELCOME
  twisted.words.protocols.irc.IRCClient.html#irc_RPL_WELCOME
  Function
  Method
  PUBLIC
  Called when we have received the welcome from the server.
- twisted.words.protocols.irc.IRCClient.irc_JOIN
  twisted.words.protocols.irc.IRCClient.html#irc_JOIN
  Function
  Method
  PUBLIC
  Called when a user joins a channel.
- twisted.words.protocols.irc.IRCClient.irc_PART
  twisted.words.protocols.irc.IRCClient.html#irc_PART
  Function
  Method
  PUBLIC
  Called when a user leaves a channel.
- twisted.words.protocols.irc.IRCClient.irc_QUIT
  twisted.words.protocols.irc.IRCClient.html#irc_QUIT
  Function
  Method
  PUBLIC
  Called when a user has quit.
- twisted.words.protocols.irc.IRCClient.irc_MODE
  twisted.words.protocols.irc.IRCClient.html#irc_MODE
  Function
  Method
  PUBLIC
  Parse a server mode change message.
- twisted.words.protocols.irc.IRCClient.irc_PING
  twisted.words.protocols.irc.IRCClient.html#irc_PING
  Function
  Method
  PUBLIC
  Called when some has pinged us.
- twisted.words.protocols.irc.IRCClient.irc_PRIVMSG
  twisted.words.protocols.irc.IRCClient.html#irc_PRIVMSG
  Function
  Method
  PUBLIC
  Called when we get a message.
- twisted.words.protocols.irc.IRCClient.irc_NOTICE
  twisted.words.protocols.irc.IRCClient.html#irc_NOTICE
  Function
  Method
  PUBLIC
  Called when a user gets a notice.
- twisted.words.protocols.irc.IRCClient.irc_NICK
  twisted.words.protocols.irc.IRCClient.html#irc_NICK
  Function
  Method
  PUBLIC
  Called when a user changes their nickname.
- twisted.words.protocols.irc.IRCClient.irc_KICK
  twisted.words.protocols.irc.IRCClient.html#irc_KICK
  Function
  Method
  PUBLIC
  Called when a user is kicked from a channel.
- twisted.words.protocols.irc.IRCClient.irc_TOPIC
  twisted.words.protocols.irc.IRCClient.html#irc_TOPIC
  Function
  Method
  PUBLIC
  Someone in the channel set the topic.
- twisted.words.protocols.irc.IRCClient.irc_RPL_TOPIC
  twisted.words.protocols.irc.IRCClient.html#irc_RPL_TOPIC
  Function
  Method
  PUBLIC
  Called when the topic for a channel is initially reported or when it subsequently changes.
- twisted.words.protocols.irc.IRCClient.irc_RPL_NOTOPIC
  twisted.words.protocols.irc.IRCClient.html#irc_RPL_NOTOPIC
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.IRCClient.irc_RPL_MOTDSTART
  twisted.words.protocols.irc.IRCClient.html#irc_RPL_MOTDSTART
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.IRCClient.irc_RPL_MOTD
  twisted.words.protocols.irc.IRCClient.html#irc_RPL_MOTD
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.IRCClient.irc_RPL_ENDOFMOTD
  twisted.words.protocols.irc.IRCClient.html#irc_RPL_ENDOFMOTD
  Function
  Method
  PUBLIC
  RPL_ENDOFMOTD indicates the end of the message of the day messages. Deliver the accumulated lines to `receivedMOTD`.
- twisted.words.protocols.irc.IRCClient.irc_RPL_CREATED
  twisted.words.protocols.irc.IRCClient.html#irc_RPL_CREATED
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.IRCClient.irc_RPL_YOURHOST
  twisted.words.protocols.irc.IRCClient.html#irc_RPL_YOURHOST
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.IRCClient.irc_RPL_MYINFO
  twisted.words.protocols.irc.IRCClient.html#irc_RPL_MYINFO
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.IRCClient.irc_RPL_BOUNCE
  twisted.words.protocols.irc.IRCClient.html#irc_RPL_BOUNCE
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.IRCClient.irc_RPL_ISUPPORT
  twisted.words.protocols.irc.IRCClient.html#irc_RPL_ISUPPORT
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.IRCClient.irc_RPL_LUSERCLIENT
  twisted.words.protocols.irc.IRCClient.html#irc_RPL_LUSERCLIENT
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.IRCClient.irc_RPL_LUSEROP
  twisted.words.protocols.irc.IRCClient.html#irc_RPL_LUSEROP
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.IRCClient.irc_RPL_LUSERCHANNELS
  twisted.words.protocols.irc.IRCClient.html#irc_RPL_LUSERCHANNELS
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.IRCClient.irc_RPL_LUSERME
  twisted.words.protocols.irc.IRCClient.html#irc_RPL_LUSERME
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.IRCClient.irc_unknown
  twisted.words.protocols.irc.IRCClient.html#irc_unknown
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.IRCClient.ctcpQuery
  twisted.words.protocols.irc.IRCClient.html#ctcpQuery
  Function
  Method
  PUBLIC
  Dispatch method for any CTCP queries received.
- twisted.words.protocols.irc.IRCClient.ctcpUnknownQuery
  twisted.words.protocols.irc.IRCClient.html#ctcpUnknownQuery
  Function
  Method
  PUBLIC
  Fallback handler for unrecognized CTCP queries.
- twisted.words.protocols.irc.IRCClient.ctcpQuery_ACTION
  twisted.words.protocols.irc.IRCClient.html#ctcpQuery_ACTION
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.IRCClient.ctcpQuery_PING
  twisted.words.protocols.irc.IRCClient.html#ctcpQuery_PING
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.IRCClient.ctcpQuery_FINGER
  twisted.words.protocols.irc.IRCClient.html#ctcpQuery_FINGER
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.IRCClient.ctcpQuery_VERSION
  twisted.words.protocols.irc.IRCClient.html#ctcpQuery_VERSION
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.IRCClient.ctcpQuery_SOURCE
  twisted.words.protocols.irc.IRCClient.html#ctcpQuery_SOURCE
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.IRCClient.ctcpQuery_USERINFO
  twisted.words.protocols.irc.IRCClient.html#ctcpQuery_USERINFO
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.IRCClient.ctcpQuery_CLIENTINFO
  twisted.words.protocols.irc.IRCClient.html#ctcpQuery_CLIENTINFO
  Function
  Method
  PUBLIC
  A master index of what CTCP tags this client knows.
- twisted.words.protocols.irc.IRCClient.ctcpQuery_ERRMSG
  twisted.words.protocols.irc.IRCClient.html#ctcpQuery_ERRMSG
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.IRCClient.ctcpQuery_TIME
  twisted.words.protocols.irc.IRCClient.html#ctcpQuery_TIME
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.IRCClient.ctcpQuery_DCC
  twisted.words.protocols.irc.IRCClient.html#ctcpQuery_DCC
  Function
  Method
  PUBLIC
  Initiate a Direct Client Connection
- twisted.words.protocols.irc.IRCClient.dcc_SEND
  twisted.words.protocols.irc.IRCClient.html#dcc_SEND
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.IRCClient.dcc_ACCEPT
  twisted.words.protocols.irc.IRCClient.html#dcc_ACCEPT
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.IRCClient.dcc_RESUME
  twisted.words.protocols.irc.IRCClient.html#dcc_RESUME
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.IRCClient.dcc_CHAT
  twisted.words.protocols.irc.IRCClient.html#dcc_CHAT
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.IRCClient.dccDoSend
  twisted.words.protocols.irc.IRCClient.html#dccDoSend
  Function
  Method
  PUBLIC
  Called when I receive a DCC SEND offer from a client.
- twisted.words.protocols.irc.IRCClient.dccDoResume
  twisted.words.protocols.irc.IRCClient.html#dccDoResume
  Function
  Method
  PUBLIC
  Called when a client is trying to resume an offered file via DCC send. It should be either replied to with a DCC ACCEPT or ignored (default).
- twisted.words.protocols.irc.IRCClient.dccDoAcceptResume
  twisted.words.protocols.irc.IRCClient.html#dccDoAcceptResume
  Function
  Method
  PUBLIC
  Called when a client has verified and accepted a DCC resume request made by us. By default it will do nothing.
- twisted.words.protocols.irc.IRCClient.dccDoChat
  twisted.words.protocols.irc.IRCClient.html#dccDoChat
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.IRCClient.ctcpMakeReply
  twisted.words.protocols.irc.IRCClient.html#ctcpMakeReply
  Function
  Method
  PUBLIC
  Send one or more `extended messages` as a CTCP reply.
- twisted.words.protocols.irc.IRCClient.ctcpMakeQuery
  twisted.words.protocols.irc.IRCClient.html#ctcpMakeQuery
  Function
  Method
  PUBLIC
  Send one or more `extended messages` as a CTCP query.
- twisted.words.protocols.irc.IRCClient.ctcpReply
  twisted.words.protocols.irc.IRCClient.html#ctcpReply
  Function
  Method
  PUBLIC
  Dispatch method for any CTCP replies received.
- twisted.words.protocols.irc.IRCClient.ctcpReply_PING
  twisted.words.protocols.irc.IRCClient.html#ctcpReply_PING
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.IRCClient.ctcpUnknownReply
  twisted.words.protocols.irc.IRCClient.html#ctcpUnknownReply
  Function
  Method
  PUBLIC
  Called when a fitting ctcpReply_ method is not found.
- twisted.words.protocols.irc.IRCClient.badMessage
  twisted.words.protocols.irc.IRCClient.html#badMessage
  Function
  Method
  PUBLIC
  When I get a message that's so broken I can't use it.
- twisted.words.protocols.irc.IRCClient.quirkyMessage
  twisted.words.protocols.irc.IRCClient.html#quirkyMessage
  Function
  Method
  PUBLIC
  This is called when I receive a message which is peculiar, but not wholly indecipherable.
- twisted.words.protocols.irc.IRCClient.connectionMade
  twisted.words.protocols.irc.IRCClient.html#connectionMade
  Function
  Method
  PUBLIC
  Called when a connection is made.
- twisted.words.protocols.irc.IRCClient.dataReceived
  twisted.words.protocols.irc.IRCClient.html#dataReceived
  Function
  Method
  PUBLIC
  Protocol.dataReceived. Translates bytes into lines, and calls lineReceived (or rawDataReceived, depending on mode.)
- twisted.words.protocols.irc.IRCClient.lineReceived
  twisted.words.protocols.irc.IRCClient.html#lineReceived
  Function
  Method
  PUBLIC
  Override this for when each line is received.
- twisted.words.protocols.irc.IRCClient.getUserModeParams
  twisted.words.protocols.irc.IRCClient.html#getUserModeParams
  Function
  Method
  PUBLIC
  Get user modes that require parameters for correct parsing.
- twisted.words.protocols.irc.IRCClient.getChannelModeParams
  twisted.words.protocols.irc.IRCClient.html#getChannelModeParams
  Function
  Method
  PUBLIC
  Get channel modes that require parameters for correct parsing.
- twisted.words.protocols.irc.IRCClient.handleCommand
  twisted.words.protocols.irc.IRCClient.html#handleCommand
  Function
  Method
  PUBLIC
  Determine the function to call for the given command and call it with the given arguments.
- twisted.words.protocols.irc.IRCClient.__getstate__
  twisted.words.protocols.irc.IRCClient.html#__getstate__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.dccParseAddress
  twisted.words.protocols.irc.html#dccParseAddress
  Function
  Function
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.DccFileReceiveBasic
  twisted.words.protocols.irc.DccFileReceiveBasic.html
  Class
  Class
  PUBLIC
  Bare protocol to receive a Direct Client Connection SEND stream.
- twisted.words.protocols.irc.DccFileReceiveBasic.bytesReceived
  twisted.words.protocols.irc.DccFileReceiveBasic.html#bytesReceived
  Attribute
  Instance Variable
  PUBLIC
  An integer representing the number of bytes of data received.
- twisted.words.protocols.irc.DccFileReceiveBasic.__init__
  twisted.words.protocols.irc.DccFileReceiveBasic.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.words.protocols.irc.DccFileReceiveBasic.resume
  twisted.words.protocols.irc.DccFileReceiveBasic.html#resume
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.DccFileReceiveBasic.dataReceived
  twisted.words.protocols.irc.DccFileReceiveBasic.html#dataReceived
  Function
  Method
  PUBLIC
  See: `protocol.Protocol.dataReceived`
- twisted.words.protocols.irc.DccSendProtocol
  twisted.words.protocols.irc.DccSendProtocol.html
  Class
  Class
  PUBLIC
  Protocol for an outgoing Direct Client Connection SEND.
- twisted.words.protocols.irc.DccSendProtocol.blocksize
  twisted.words.protocols.irc.DccSendProtocol.html#blocksize
  Attribute
  Instance Variable
  PUBLIC
  An integer representing the size of an individual block of data.
- twisted.words.protocols.irc.DccSendProtocol.file
  twisted.words.protocols.irc.DccSendProtocol.html#file
  Attribute
  Instance Variable
  PUBLIC
  The file to be sent. This can be either a file object or simply the name of the file.
- twisted.words.protocols.irc.DccSendProtocol.bytesSent
  twisted.words.protocols.irc.DccSendProtocol.html#bytesSent
  Attribute
  Instance Variable
  PUBLIC
  An integer representing the number of bytes sent.
- twisted.words.protocols.irc.DccSendProtocol.completed
  twisted.words.protocols.irc.DccSendProtocol.html#completed
  Attribute
  Instance Variable
  PUBLIC
  An integer representing whether the transfer has been completed or not.
- twisted.words.protocols.irc.DccSendProtocol.connected
  twisted.words.protocols.irc.DccSendProtocol.html#connected
  Attribute
  Instance Variable
  PUBLIC
  An integer representing whether the connection has been established or not.
- twisted.words.protocols.irc.DccSendProtocol.__init__
  twisted.words.protocols.irc.DccSendProtocol.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.DccSendProtocol.connectionMade
  twisted.words.protocols.irc.DccSendProtocol.html#connectionMade
  Function
  Method
  PUBLIC
  Called when a connection is made.
- twisted.words.protocols.irc.DccSendProtocol.dataReceived
  twisted.words.protocols.irc.DccSendProtocol.html#dataReceived
  Function
  Method
  PUBLIC
  Called whenever data is received.
- twisted.words.protocols.irc.DccSendProtocol.sendBlock
  twisted.words.protocols.irc.DccSendProtocol.html#sendBlock
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.DccSendProtocol.connectionLost
  twisted.words.protocols.irc.DccSendProtocol.html#connectionLost
  Function
  Method
  PUBLIC
  Called when the connection is shut down.
- twisted.words.protocols.irc.DccSendFactory
  twisted.words.protocols.irc.DccSendFactory.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.DccSendFactory.__init__
  twisted.words.protocols.irc.DccSendFactory.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.DccSendFactory.file
  twisted.words.protocols.irc.DccSendFactory.html#file
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.DccSendFactory.buildProtocol
  twisted.words.protocols.irc.DccSendFactory.html#buildProtocol
  Function
  Method
  PUBLIC
  Create an instance of a subclass of Protocol.
- twisted.words.protocols.irc.fileSize
  twisted.words.protocols.irc.html#fileSize
  Function
  Function
  PUBLIC
  I'll try my damndest to determine the size of this file object.
- twisted.words.protocols.irc.DccChat
  twisted.words.protocols.irc.DccChat.html
  Class
  Class
  PUBLIC
  Direct Client Connection protocol type CHAT.
- twisted.words.protocols.irc.DccChat.queryData
  twisted.words.protocols.irc.DccChat.html#queryData
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.DccChat.delimiter
  twisted.words.protocols.irc.DccChat.html#delimiter
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.DccChat.client
  twisted.words.protocols.irc.DccChat.html#client
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.DccChat.remoteParty
  twisted.words.protocols.irc.DccChat.html#remoteParty
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.DccChat.buffer
  twisted.words.protocols.irc.DccChat.html#buffer
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.DccChat.__init__
  twisted.words.protocols.irc.DccChat.html#__init__
  Function
  Method
  PUBLIC
  Initialize a new DCC CHAT session.
- twisted.words.protocols.irc.DccChat.dataReceived
  twisted.words.protocols.irc.DccChat.html#dataReceived
  Function
  Method
  PUBLIC
  Protocol.dataReceived. Translates bytes into lines, and calls lineReceived (or rawDataReceived, depending on mode.)
- twisted.words.protocols.irc.DccChat.lineReceived
  twisted.words.protocols.irc.DccChat.html#lineReceived
  Function
  Method
  PUBLIC
  Override this for when each line is received.
- twisted.words.protocols.irc.DccChatFactory
  twisted.words.protocols.irc.DccChatFactory.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.DccChatFactory.noisy
  twisted.words.protocols.irc.DccChatFactory.html#noisy
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.DccChatFactory.__init__
  twisted.words.protocols.irc.DccChatFactory.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.DccChatFactory.client
  twisted.words.protocols.irc.DccChatFactory.html#client
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.DccChatFactory.queryData
  twisted.words.protocols.irc.DccChatFactory.html#queryData
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.DccChatFactory.buildProtocol
  twisted.words.protocols.irc.DccChatFactory.html#buildProtocol
  Function
  Method
  PUBLIC
  Create an instance of a subclass of Protocol.
- twisted.words.protocols.irc.DccChatFactory.clientConnectionFailed
  twisted.words.protocols.irc.DccChatFactory.html#clientConnectionFailed
  Function
  Method
  PUBLIC
  Called when a connection has failed to connect.
- twisted.words.protocols.irc.DccChatFactory.clientConnectionLost
  twisted.words.protocols.irc.DccChatFactory.html#clientConnectionLost
  Function
  Method
  PUBLIC
  Called when an established connection is lost.
- twisted.words.protocols.irc.dccDescribe
  twisted.words.protocols.irc.html#dccDescribe
  Function
  Function
  PUBLIC
  Given the data chunk from a DCC query, return a descriptive string.
- twisted.words.protocols.irc.DccFileReceive
  twisted.words.protocols.irc.DccFileReceive.html
  Class
  Class
  PUBLIC
  Higher-level coverage for getting a file from DCC SEND.
- twisted.words.protocols.irc.DccFileReceive.filename
  twisted.words.protocols.irc.DccFileReceive.html#filename
  Attribute
  Instance Variable
  PUBLIC
  The name of the file to get.
- twisted.words.protocols.irc.DccFileReceive.fileSize
  twisted.words.protocols.irc.DccFileReceive.html#fileSize
  Attribute
  Instance Variable
  PUBLIC
  The size of the file to get, which has a default value of `-1` if the size of the file was not specified in the DCC SEND request.
- twisted.words.protocols.irc.DccFileReceive.destDir
  twisted.words.protocols.irc.DccFileReceive.html#destDir
  Attribute
  Instance Variable
  PUBLIC
  The destination directory for the file to be received.
- twisted.words.protocols.irc.DccFileReceive.overwrite
  twisted.words.protocols.irc.DccFileReceive.html#overwrite
  Attribute
  Instance Variable
  PUBLIC
  An integer representing whether an existing file should be overwritten or not. This initially is an `int` but can be modified to be a `bool` using the `set_overwrite` method.
- twisted.words.protocols.irc.DccFileReceive.queryData
  twisted.words.protocols.irc.DccFileReceive.html#queryData
  Attribute
  Instance Variable
  PUBLIC
  queryData is a 3-tuple of (user, channel, data).
- twisted.words.protocols.irc.DccFileReceive.fromUser
  twisted.words.protocols.irc.DccFileReceive.html#fromUser
  Attribute
  Instance Variable
  PUBLIC
  This is the hostmask of the requesting user and is found at index 0 of `queryData`.
- twisted.words.protocols.irc.DccFileReceive.__init__
  twisted.words.protocols.irc.DccFileReceive.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.words.protocols.irc.DccFileReceive._resumeOffset
  twisted.words.protocols.irc.DccFileReceive.html#_resumeOffset
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.words.protocols.irc.DccFileReceive.set_directory
  twisted.words.protocols.irc.DccFileReceive.html#set_directory
  Function
  Method
  PUBLIC
  Set the directory where the downloaded file will be placed.
- twisted.words.protocols.irc.DccFileReceive.set_filename
  twisted.words.protocols.irc.DccFileReceive.html#set_filename
  Function
  Method
  PUBLIC
  Change the name of the file being transferred.
- twisted.words.protocols.irc.DccFileReceive.set_overwrite
  twisted.words.protocols.irc.DccFileReceive.html#set_overwrite
  Function
  Method
  PUBLIC
  May I overwrite existing files?
- twisted.words.protocols.irc.DccFileReceive.connectionMade
  twisted.words.protocols.irc.DccFileReceive.html#connectionMade
  Function
  Method
  PUBLIC
  Called when a connection is made.
- twisted.words.protocols.irc.DccFileReceive.file
  twisted.words.protocols.irc.DccFileReceive.html#file
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.DccFileReceive.dataReceived
  twisted.words.protocols.irc.DccFileReceive.html#dataReceived
  Function
  Method
  PUBLIC
  See: `protocol.Protocol.dataReceived`
- twisted.words.protocols.irc.DccFileReceive.connectionLost
  twisted.words.protocols.irc.DccFileReceive.html#connectionLost
  Function
  Method
  PUBLIC
  When the connection is lost, I close the file.
- twisted.words.protocols.irc.DccFileReceive.connected
  twisted.words.protocols.irc.DccFileReceive.html#connected
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.DccFileReceive.__str__
  twisted.words.protocols.irc.DccFileReceive.html#__str__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.DccFileReceive.__repr__
  twisted.words.protocols.irc.DccFileReceive.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.irc._OFF
  twisted.words.protocols.irc.html#_OFF
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.words.protocols.irc._BOLD
  twisted.words.protocols.irc.html#_BOLD
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.words.protocols.irc._COLOR
  twisted.words.protocols.irc.html#_COLOR
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.words.protocols.irc._REVERSE_VIDEO
  twisted.words.protocols.irc.html#_REVERSE_VIDEO
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.words.protocols.irc._UNDERLINE
  twisted.words.protocols.irc.html#_UNDERLINE
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.words.protocols.irc._IRC_COLORS
  twisted.words.protocols.irc.html#_IRC_COLORS
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.words.protocols.irc._IRC_COLOR_NAMES
  twisted.words.protocols.irc.html#_IRC_COLOR_NAMES
  Attribute
  Constant
  PRIVATE
  Undocumented
- twisted.words.protocols.irc._CharacterAttributes
  twisted.words.protocols.irc._CharacterAttributes.html
  Class
  Class
  PRIVATE
  Factory for character attributes, including foreground and background color and non-color attributes such as bold, reverse video and underline.
- twisted.words.protocols.irc._CharacterAttributes.fg
  twisted.words.protocols.irc._CharacterAttributes.html#fg
  Attribute
  Instance Variable
  PUBLIC
  Foreground colors accessed by attribute name, see above for possible names.
- twisted.words.protocols.irc._CharacterAttributes.bg
  twisted.words.protocols.irc._CharacterAttributes.html#bg
  Attribute
  Instance Variable
  PUBLIC
  Background colors accessed by attribute name, see above for possible names.
- twisted.words.protocols.irc._CharacterAttributes.attrs
  twisted.words.protocols.irc._CharacterAttributes.html#attrs
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.irc._FormattingState
  twisted.words.protocols.irc._FormattingState.html
  Class
  Class
  PRIVATE
  Formatting state/attributes of a single character.
- twisted.words.protocols.irc._FormattingState.compareAttributes
  twisted.words.protocols.irc._FormattingState.html#compareAttributes
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.irc._FormattingState.__init__
  twisted.words.protocols.irc._FormattingState.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.irc._FormattingState.off
  twisted.words.protocols.irc._FormattingState.html#off
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.irc._FormattingState.bold
  twisted.words.protocols.irc._FormattingState.html#bold
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.irc._FormattingState.underline
  twisted.words.protocols.irc._FormattingState.html#underline
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.irc._FormattingState.reverseVideo
  twisted.words.protocols.irc._FormattingState.html#reverseVideo
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.irc._FormattingState.foreground
  twisted.words.protocols.irc._FormattingState.html#foreground
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.irc._FormattingState.background
  twisted.words.protocols.irc._FormattingState.html#background
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.irc._FormattingState.toMIRCControlCodes
  twisted.words.protocols.irc._FormattingState.html#toMIRCControlCodes
  Function
  Method
  PUBLIC
  Emit a mIRC control sequence that will set up all the attributes this formatting state has set.
- twisted.words.protocols.irc._foldr
  twisted.words.protocols.irc.html#_foldr
  Function
  Function
  PRIVATE
  Apply a function of two arguments cumulatively to the items of a sequence, from right to left, so as to reduce the sequence to a single value.
- twisted.words.protocols.irc._FormattingParser
  twisted.words.protocols.irc._FormattingParser.html
  Class
  Class
  PRIVATE
  A finite-state machine that parses formatted IRC text.
- twisted.words.protocols.irc._FormattingParser._formatCodes
  twisted.words.protocols.irc._FormattingParser.html#_formatCodes
  Attribute
  Class Variable
  PRIVATE
  Mapping of format code values to names.
- twisted.words.protocols.irc._FormattingParser.state
  twisted.words.protocols.irc._FormattingParser.html#state
  Attribute
  Instance Variable
  PUBLIC
  Current state of the finite-state machine.
- twisted.words.protocols.irc._FormattingParser._buffer
  twisted.words.protocols.irc._FormattingParser.html#_buffer
  Attribute
  Instance Variable
  PRIVATE
  Buffer, containing the text content, of the formatting sequence currently being parsed, the buffer is used as the content for `_attrs` before being added to `_result` and emptied upon calling `emit`.
- twisted.words.protocols.irc._FormattingParser._attrs
  twisted.words.protocols.irc._FormattingParser.html#_attrs
  Attribute
  Instance Variable
  PRIVATE
  Set of the applicable formatting states (bold, underline, etc.) for the current `_buffer`, these are applied to `_buffer` when calling `emit`.
- twisted.words.protocols.irc._FormattingParser.foreground
  twisted.words.protocols.irc._FormattingParser.html#foreground
  Attribute
  Instance Variable
  PUBLIC
  Current foreground color attribute, or `None`.
- twisted.words.protocols.irc._FormattingParser.background
  twisted.words.protocols.irc._FormattingParser.html#background
  Attribute
  Instance Variable
  PUBLIC
  Current background color attribute, or `None`.
- twisted.words.protocols.irc._FormattingParser._result
  twisted.words.protocols.irc._FormattingParser.html#_result
  Attribute
  Instance Variable
  PRIVATE
  Current parse result.
- twisted.words.protocols.irc._FormattingParser.prefix
  twisted.words.protocols.irc._FormattingParser.html#prefix
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.irc._FormattingParser.__init__
  twisted.words.protocols.irc._FormattingParser.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.irc._FormattingParser.process
  twisted.words.protocols.irc._FormattingParser.html#process
  Function
  Method
  PUBLIC
  Handle input.
- twisted.words.protocols.irc._FormattingParser.complete
  twisted.words.protocols.irc._FormattingParser.html#complete
  Function
  Method
  PUBLIC
  Flush the current buffer and return the final parsed result.
- twisted.words.protocols.irc._FormattingParser.emit
  twisted.words.protocols.irc._FormattingParser.html#emit
  Function
  Method
  PUBLIC
  Add the currently parsed input to the result.
- twisted.words.protocols.irc._FormattingParser.state_TEXT
  twisted.words.protocols.irc._FormattingParser.html#state_TEXT
  Function
  Method
  PUBLIC
  Handle the "text" state.
- twisted.words.protocols.irc._FormattingParser.state_COLOR_FOREGROUND
  twisted.words.protocols.irc._FormattingParser.html#state_COLOR_FOREGROUND
  Function
  Method
  PUBLIC
  Handle the foreground color state.
- twisted.words.protocols.irc._FormattingParser.state_COLOR_BACKGROUND
  twisted.words.protocols.irc._FormattingParser.html#state_COLOR_BACKGROUND
  Function
  Method
  PUBLIC
  Handle the background color state.
- twisted.words.protocols.irc.parseFormattedText
  twisted.words.protocols.irc.html#parseFormattedText
  Function
  Function
  PUBLIC
  Parse text containing IRC formatting codes into structured information.
- twisted.words.protocols.irc.assembleFormattedText
  twisted.words.protocols.irc.html#assembleFormattedText
  Function
  Function
  PUBLIC
  Assemble formatted text from structured information.
- twisted.words.protocols.irc.stripFormatting
  twisted.words.protocols.irc.html#stripFormatting
  Function
  Function
  PUBLIC
  Remove all formatting codes from `text`, leaving only the text.
- twisted.words.protocols.irc.X_DELIM
  twisted.words.protocols.irc.html#X_DELIM
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.ctcpExtract
  twisted.words.protocols.irc.html#ctcpExtract
  Function
  Function
  PUBLIC
  Extract CTCP data from a string.
- twisted.words.protocols.irc.M_QUOTE
  twisted.words.protocols.irc.html#M_QUOTE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.mQuoteTable
  twisted.words.protocols.irc.html#mQuoteTable
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.mDequoteTable
  twisted.words.protocols.irc.html#mDequoteTable
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.mEscape_re
  twisted.words.protocols.irc.html#mEscape_re
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.lowQuote
  twisted.words.protocols.irc.html#lowQuote
  Function
  Function
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.lowDequote
  twisted.words.protocols.irc.html#lowDequote
  Function
  Function
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.X_QUOTE
  twisted.words.protocols.irc.html#X_QUOTE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.xQuoteTable
  twisted.words.protocols.irc.html#xQuoteTable
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.xDequoteTable
  twisted.words.protocols.irc.html#xDequoteTable
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.xEscape_re
  twisted.words.protocols.irc.html#xEscape_re
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.ctcpQuote
  twisted.words.protocols.irc.html#ctcpQuote
  Function
  Function
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.ctcpDequote
  twisted.words.protocols.irc.html#ctcpDequote
  Function
  Function
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.ctcpStringify
  twisted.words.protocols.irc.html#ctcpStringify
  Function
  Function
  PUBLIC
  No summary
- twisted.words.protocols.irc.RPL_WELCOME
  twisted.words.protocols.irc.html#RPL_WELCOME
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_YOURHOST
  twisted.words.protocols.irc.html#RPL_YOURHOST
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_CREATED
  twisted.words.protocols.irc.html#RPL_CREATED
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_MYINFO
  twisted.words.protocols.irc.html#RPL_MYINFO
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_ISUPPORT
  twisted.words.protocols.irc.html#RPL_ISUPPORT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_BOUNCE
  twisted.words.protocols.irc.html#RPL_BOUNCE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_USERHOST
  twisted.words.protocols.irc.html#RPL_USERHOST
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_ISON
  twisted.words.protocols.irc.html#RPL_ISON
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_AWAY
  twisted.words.protocols.irc.html#RPL_AWAY
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_UNAWAY
  twisted.words.protocols.irc.html#RPL_UNAWAY
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_NOWAWAY
  twisted.words.protocols.irc.html#RPL_NOWAWAY
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_WHOISUSER
  twisted.words.protocols.irc.html#RPL_WHOISUSER
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_WHOISSERVER
  twisted.words.protocols.irc.html#RPL_WHOISSERVER
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_WHOISOPERATOR
  twisted.words.protocols.irc.html#RPL_WHOISOPERATOR
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_WHOISIDLE
  twisted.words.protocols.irc.html#RPL_WHOISIDLE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_ENDOFWHOIS
  twisted.words.protocols.irc.html#RPL_ENDOFWHOIS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_WHOISCHANNELS
  twisted.words.protocols.irc.html#RPL_WHOISCHANNELS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_WHOWASUSER
  twisted.words.protocols.irc.html#RPL_WHOWASUSER
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_ENDOFWHOWAS
  twisted.words.protocols.irc.html#RPL_ENDOFWHOWAS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_LISTSTART
  twisted.words.protocols.irc.html#RPL_LISTSTART
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_LIST
  twisted.words.protocols.irc.html#RPL_LIST
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_LISTEND
  twisted.words.protocols.irc.html#RPL_LISTEND
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_UNIQOPIS
  twisted.words.protocols.irc.html#RPL_UNIQOPIS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_CHANNELMODEIS
  twisted.words.protocols.irc.html#RPL_CHANNELMODEIS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_NOTOPIC
  twisted.words.protocols.irc.html#RPL_NOTOPIC
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_TOPIC
  twisted.words.protocols.irc.html#RPL_TOPIC
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_INVITING
  twisted.words.protocols.irc.html#RPL_INVITING
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_SUMMONING
  twisted.words.protocols.irc.html#RPL_SUMMONING
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_INVITELIST
  twisted.words.protocols.irc.html#RPL_INVITELIST
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_ENDOFINVITELIST
  twisted.words.protocols.irc.html#RPL_ENDOFINVITELIST
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_EXCEPTLIST
  twisted.words.protocols.irc.html#RPL_EXCEPTLIST
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_ENDOFEXCEPTLIST
  twisted.words.protocols.irc.html#RPL_ENDOFEXCEPTLIST
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_VERSION
  twisted.words.protocols.irc.html#RPL_VERSION
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_WHOREPLY
  twisted.words.protocols.irc.html#RPL_WHOREPLY
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_ENDOFWHO
  twisted.words.protocols.irc.html#RPL_ENDOFWHO
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_NAMREPLY
  twisted.words.protocols.irc.html#RPL_NAMREPLY
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_ENDOFNAMES
  twisted.words.protocols.irc.html#RPL_ENDOFNAMES
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_LINKS
  twisted.words.protocols.irc.html#RPL_LINKS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_ENDOFLINKS
  twisted.words.protocols.irc.html#RPL_ENDOFLINKS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_BANLIST
  twisted.words.protocols.irc.html#RPL_BANLIST
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_ENDOFBANLIST
  twisted.words.protocols.irc.html#RPL_ENDOFBANLIST
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_INFO
  twisted.words.protocols.irc.html#RPL_INFO
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_ENDOFINFO
  twisted.words.protocols.irc.html#RPL_ENDOFINFO
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_MOTDSTART
  twisted.words.protocols.irc.html#RPL_MOTDSTART
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_MOTD
  twisted.words.protocols.irc.html#RPL_MOTD
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_ENDOFMOTD
  twisted.words.protocols.irc.html#RPL_ENDOFMOTD
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_YOUREOPER
  twisted.words.protocols.irc.html#RPL_YOUREOPER
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_REHASHING
  twisted.words.protocols.irc.html#RPL_REHASHING
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_YOURESERVICE
  twisted.words.protocols.irc.html#RPL_YOURESERVICE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_TIME
  twisted.words.protocols.irc.html#RPL_TIME
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_USERSSTART
  twisted.words.protocols.irc.html#RPL_USERSSTART
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_USERS
  twisted.words.protocols.irc.html#RPL_USERS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_ENDOFUSERS
  twisted.words.protocols.irc.html#RPL_ENDOFUSERS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_NOUSERS
  twisted.words.protocols.irc.html#RPL_NOUSERS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_TRACELINK
  twisted.words.protocols.irc.html#RPL_TRACELINK
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_TRACECONNECTING
  twisted.words.protocols.irc.html#RPL_TRACECONNECTING
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_TRACEHANDSHAKE
  twisted.words.protocols.irc.html#RPL_TRACEHANDSHAKE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_TRACEUNKNOWN
  twisted.words.protocols.irc.html#RPL_TRACEUNKNOWN
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_TRACEOPERATOR
  twisted.words.protocols.irc.html#RPL_TRACEOPERATOR
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_TRACEUSER
  twisted.words.protocols.irc.html#RPL_TRACEUSER
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_TRACESERVER
  twisted.words.protocols.irc.html#RPL_TRACESERVER
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_TRACESERVICE
  twisted.words.protocols.irc.html#RPL_TRACESERVICE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_TRACENEWTYPE
  twisted.words.protocols.irc.html#RPL_TRACENEWTYPE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_TRACECLASS
  twisted.words.protocols.irc.html#RPL_TRACECLASS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_TRACERECONNECT
  twisted.words.protocols.irc.html#RPL_TRACERECONNECT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_TRACELOG
  twisted.words.protocols.irc.html#RPL_TRACELOG
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_TRACEEND
  twisted.words.protocols.irc.html#RPL_TRACEEND
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_STATSLINKINFO
  twisted.words.protocols.irc.html#RPL_STATSLINKINFO
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_STATSCOMMANDS
  twisted.words.protocols.irc.html#RPL_STATSCOMMANDS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_ENDOFSTATS
  twisted.words.protocols.irc.html#RPL_ENDOFSTATS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_STATSUPTIME
  twisted.words.protocols.irc.html#RPL_STATSUPTIME
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_STATSOLINE
  twisted.words.protocols.irc.html#RPL_STATSOLINE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_UMODEIS
  twisted.words.protocols.irc.html#RPL_UMODEIS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_SERVLIST
  twisted.words.protocols.irc.html#RPL_SERVLIST
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_SERVLISTEND
  twisted.words.protocols.irc.html#RPL_SERVLISTEND
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_LUSERCLIENT
  twisted.words.protocols.irc.html#RPL_LUSERCLIENT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_LUSEROP
  twisted.words.protocols.irc.html#RPL_LUSEROP
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_LUSERUNKNOWN
  twisted.words.protocols.irc.html#RPL_LUSERUNKNOWN
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_LUSERCHANNELS
  twisted.words.protocols.irc.html#RPL_LUSERCHANNELS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_LUSERME
  twisted.words.protocols.irc.html#RPL_LUSERME
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_ADMINME
  twisted.words.protocols.irc.html#RPL_ADMINME
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_ADMINLOC1
  twisted.words.protocols.irc.html#RPL_ADMINLOC1
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_ADMINLOC2
  twisted.words.protocols.irc.html#RPL_ADMINLOC2
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_ADMINEMAIL
  twisted.words.protocols.irc.html#RPL_ADMINEMAIL
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.RPL_TRYAGAIN
  twisted.words.protocols.irc.html#RPL_TRYAGAIN
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.ERR_NOSUCHNICK
  twisted.words.protocols.irc.html#ERR_NOSUCHNICK
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.ERR_NOSUCHSERVER
  twisted.words.protocols.irc.html#ERR_NOSUCHSERVER
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.ERR_NOSUCHCHANNEL
  twisted.words.protocols.irc.html#ERR_NOSUCHCHANNEL
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.ERR_CANNOTSENDTOCHAN
  twisted.words.protocols.irc.html#ERR_CANNOTSENDTOCHAN
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.ERR_TOOMANYCHANNELS
  twisted.words.protocols.irc.html#ERR_TOOMANYCHANNELS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.ERR_WASNOSUCHNICK
  twisted.words.protocols.irc.html#ERR_WASNOSUCHNICK
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.ERR_TOOMANYTARGETS
  twisted.words.protocols.irc.html#ERR_TOOMANYTARGETS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.ERR_NOSUCHSERVICE
  twisted.words.protocols.irc.html#ERR_NOSUCHSERVICE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.ERR_NOORIGIN
  twisted.words.protocols.irc.html#ERR_NOORIGIN
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.ERR_NORECIPIENT
  twisted.words.protocols.irc.html#ERR_NORECIPIENT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.ERR_NOTEXTTOSEND
  twisted.words.protocols.irc.html#ERR_NOTEXTTOSEND
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.ERR_NOTOPLEVEL
  twisted.words.protocols.irc.html#ERR_NOTOPLEVEL
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.ERR_WILDTOPLEVEL
  twisted.words.protocols.irc.html#ERR_WILDTOPLEVEL
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.ERR_BADMASK
  twisted.words.protocols.irc.html#ERR_BADMASK
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.ERR_TOOMANYMATCHES
  twisted.words.protocols.irc.html#ERR_TOOMANYMATCHES
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.ERR_UNKNOWNCOMMAND
  twisted.words.protocols.irc.html#ERR_UNKNOWNCOMMAND
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.ERR_NOMOTD
  twisted.words.protocols.irc.html#ERR_NOMOTD
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.ERR_NOADMININFO
  twisted.words.protocols.irc.html#ERR_NOADMININFO
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.ERR_FILEERROR
  twisted.words.protocols.irc.html#ERR_FILEERROR
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.ERR_NONICKNAMEGIVEN
  twisted.words.protocols.irc.html#ERR_NONICKNAMEGIVEN
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.ERR_ERRONEUSNICKNAME
  twisted.words.protocols.irc.html#ERR_ERRONEUSNICKNAME
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.ERR_NICKNAMEINUSE
  twisted.words.protocols.irc.html#ERR_NICKNAMEINUSE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.ERR_NICKCOLLISION
  twisted.words.protocols.irc.html#ERR_NICKCOLLISION
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.ERR_UNAVAILRESOURCE
  twisted.words.protocols.irc.html#ERR_UNAVAILRESOURCE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.ERR_USERNOTINCHANNEL
  twisted.words.protocols.irc.html#ERR_USERNOTINCHANNEL
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.ERR_NOTONCHANNEL
  twisted.words.protocols.irc.html#ERR_NOTONCHANNEL
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.ERR_USERONCHANNEL
  twisted.words.protocols.irc.html#ERR_USERONCHANNEL
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.ERR_NOLOGIN
  twisted.words.protocols.irc.html#ERR_NOLOGIN
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.ERR_SUMMONDISABLED
  twisted.words.protocols.irc.html#ERR_SUMMONDISABLED
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.ERR_USERSDISABLED
  twisted.words.protocols.irc.html#ERR_USERSDISABLED
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.ERR_NOTREGISTERED
  twisted.words.protocols.irc.html#ERR_NOTREGISTERED
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.ERR_NEEDMOREPARAMS
  twisted.words.protocols.irc.html#ERR_NEEDMOREPARAMS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.ERR_ALREADYREGISTRED
  twisted.words.protocols.irc.html#ERR_ALREADYREGISTRED
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.ERR_NOPERMFORHOST
  twisted.words.protocols.irc.html#ERR_NOPERMFORHOST
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.ERR_PASSWDMISMATCH
  twisted.words.protocols.irc.html#ERR_PASSWDMISMATCH
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.ERR_YOUREBANNEDCREEP
  twisted.words.protocols.irc.html#ERR_YOUREBANNEDCREEP
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.ERR_YOUWILLBEBANNED
  twisted.words.protocols.irc.html#ERR_YOUWILLBEBANNED
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.ERR_KEYSET
  twisted.words.protocols.irc.html#ERR_KEYSET
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.ERR_CHANNELISFULL
  twisted.words.protocols.irc.html#ERR_CHANNELISFULL
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.ERR_UNKNOWNMODE
  twisted.words.protocols.irc.html#ERR_UNKNOWNMODE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.ERR_INVITEONLYCHAN
  twisted.words.protocols.irc.html#ERR_INVITEONLYCHAN
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.ERR_BANNEDFROMCHAN
  twisted.words.protocols.irc.html#ERR_BANNEDFROMCHAN
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.ERR_BADCHANNELKEY
  twisted.words.protocols.irc.html#ERR_BADCHANNELKEY
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.ERR_BADCHANMASK
  twisted.words.protocols.irc.html#ERR_BADCHANMASK
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.ERR_NOCHANMODES
  twisted.words.protocols.irc.html#ERR_NOCHANMODES
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.ERR_BANLISTFULL
  twisted.words.protocols.irc.html#ERR_BANLISTFULL
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.ERR_NOPRIVILEGES
  twisted.words.protocols.irc.html#ERR_NOPRIVILEGES
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.ERR_CHANOPRIVSNEEDED
  twisted.words.protocols.irc.html#ERR_CHANOPRIVSNEEDED
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.ERR_CANTKILLSERVER
  twisted.words.protocols.irc.html#ERR_CANTKILLSERVER
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.ERR_RESTRICTED
  twisted.words.protocols.irc.html#ERR_RESTRICTED
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.ERR_UNIQOPPRIVSNEEDED
  twisted.words.protocols.irc.html#ERR_UNIQOPPRIVSNEEDED
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.ERR_NOOPERHOST
  twisted.words.protocols.irc.html#ERR_NOOPERHOST
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.ERR_NOSERVICEHOST
  twisted.words.protocols.irc.html#ERR_NOSERVICEHOST
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.ERR_UMODEUNKNOWNFLAG
  twisted.words.protocols.irc.html#ERR_UMODEUNKNOWNFLAG
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.ERR_USERSDONTMATCH
  twisted.words.protocols.irc.html#ERR_USERSDONTMATCH
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.symbolic_to_numeric
  twisted.words.protocols.irc.html#symbolic_to_numeric
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.irc.numeric_to_symbolic
  twisted.words.protocols.irc.html#numeric_to_symbolic
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.words.im.ircsupport.IRCPerson
  twisted.words.im.ircsupport.IRCPerson.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.words.im.ircsupport.IRCPerson.imperson_whois
  twisted.words.im.ircsupport.IRCPerson.html#imperson_whois
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.im.ircsupport.IRCPerson.isOnline
  twisted.words.im.ircsupport.IRCPerson.html#isOnline
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.im.ircsupport.IRCPerson.getStatus
  twisted.words.im.ircsupport.IRCPerson.html#getStatus
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.im.ircsupport.IRCPerson.setStatus
  twisted.words.im.ircsupport.IRCPerson.html#setStatus
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.im.ircsupport.IRCPerson.status
  twisted.words.im.ircsupport.IRCPerson.html#status
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.im.ircsupport.IRCPerson.sendMessage
  twisted.words.im.ircsupport.IRCPerson.html#sendMessage
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.im.ircsupport.IRCGroup
  twisted.words.im.ircsupport.IRCGroup.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.words.im.ircsupport.IRCGroup.imgroup_testAction
  twisted.words.im.ircsupport.IRCGroup.html#imgroup_testAction
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.im.ircsupport.IRCGroup.imtarget_kick
  twisted.words.im.ircsupport.IRCGroup.html#imtarget_kick
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.im.ircsupport.IRCGroup.setTopic
  twisted.words.im.ircsupport.IRCGroup.html#setTopic
  Function
  Method
  PUBLIC
  Set this Groups topic on the server.
- twisted.words.im.ircsupport.IRCGroup.sendGroupMessage
  twisted.words.im.ircsupport.IRCGroup.html#sendGroupMessage
  Function
  Method
  PUBLIC
  Send a message to this group.
- twisted.words.im.ircsupport.IRCGroup.leave
  twisted.words.im.ircsupport.IRCGroup.html#leave
  Function
  Method
  PUBLIC
  Depart this group.
- twisted.words.im.ircsupport.IRCProto
  twisted.words.im.ircsupport.IRCProto.html
  Class
  Class
  PUBLIC
  No class docstring; 0/10 instance variable, 2/21 methods documented
- twisted.words.im.ircsupport.IRCProto.__init__
  twisted.words.im.ircsupport.IRCProto.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.im.ircsupport.IRCProto._namreplies
  twisted.words.im.ircsupport.IRCProto.html#_namreplies
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.words.im.ircsupport.IRCProto._ingroups
  twisted.words.im.ircsupport.IRCProto.html#_ingroups
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.words.im.ircsupport.IRCProto._groups
  twisted.words.im.ircsupport.IRCProto.html#_groups
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.words.im.ircsupport.IRCProto._topics
  twisted.words.im.ircsupport.IRCProto.html#_topics
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.words.im.ircsupport.IRCProto.getGroupConversation
  twisted.words.im.ircsupport.IRCProto.html#getGroupConversation
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.im.ircsupport.IRCProto.getPerson
  twisted.words.im.ircsupport.IRCProto.html#getPerson
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.im.ircsupport.IRCProto.connectionMade
  twisted.words.im.ircsupport.IRCProto.html#connectionMade
  Function
  Method
  PUBLIC
  Called when a connection is made.
- twisted.words.im.ircsupport.IRCProto.performLogin
  twisted.words.im.ircsupport.IRCProto.html#performLogin
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.im.ircsupport.IRCProto.nickname
  twisted.words.im.ircsupport.IRCProto.html#nickname
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.im.ircsupport.IRCProto.password
  twisted.words.im.ircsupport.IRCProto.html#password
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.im.ircsupport.IRCProto.realname
  twisted.words.im.ircsupport.IRCProto.html#realname
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.im.ircsupport.IRCProto.setNick
  twisted.words.im.ircsupport.IRCProto.html#setNick
  Function
  Method
  PUBLIC
  Set this client's nickname.
- twisted.words.im.ircsupport.IRCProto.name
  twisted.words.im.ircsupport.IRCProto.html#name
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.im.ircsupport.IRCProto.accountName
  twisted.words.im.ircsupport.IRCProto.html#accountName
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.im.ircsupport.IRCProto.kickedFrom
  twisted.words.im.ircsupport.IRCProto.html#kickedFrom
  Function
  Method
  PUBLIC
  Called when I am kicked from a channel.
- twisted.words.im.ircsupport.IRCProto.userKicked
  twisted.words.im.ircsupport.IRCProto.html#userKicked
  Function
  Method
  PUBLIC
  Called when I observe someone else being kicked from a channel.
- twisted.words.im.ircsupport.IRCProto.noticed
  twisted.words.im.ircsupport.IRCProto.html#noticed
  Function
  Method
  PUBLIC
  Called when I have a notice from a user to me or a channel.
- twisted.words.im.ircsupport.IRCProto.privmsg
  twisted.words.im.ircsupport.IRCProto.html#privmsg
  Function
  Method
  PUBLIC
  Called when I have a message from a user to me or a channel.
- twisted.words.im.ircsupport.IRCProto.action
  twisted.words.im.ircsupport.IRCProto.html#action
  Function
  Method
  PUBLIC
  Called when I see a user perform an ACTION on a channel.
- twisted.words.im.ircsupport.IRCProto.irc_RPL_NAMREPLY
  twisted.words.im.ircsupport.IRCProto.html#irc_RPL_NAMREPLY
  Function
  Method
  PUBLIC
  RPL_NAMREPLY >> NAMES #bnl << :Arlington.VA.US.Undernet.Org 353 z3p = #bnl :pSwede Dan-- SkOyg AG
- twisted.words.im.ircsupport.IRCProto.irc_RPL_ENDOFNAMES
  twisted.words.im.ircsupport.IRCProto.html#irc_RPL_ENDOFNAMES
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.im.ircsupport.IRCProto.irc_RPL_TOPIC
  twisted.words.im.ircsupport.IRCProto.html#irc_RPL_TOPIC
  Function
  Method
  PUBLIC
  Called when the topic for a channel is initially reported or when it subsequently changes.
- twisted.words.im.ircsupport.IRCProto.irc_333
  twisted.words.im.ircsupport.IRCProto.html#irc_333
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.im.ircsupport.IRCProto.irc_TOPIC
  twisted.words.im.ircsupport.IRCProto.html#irc_TOPIC
  Function
  Method
  PUBLIC
  Someone in the channel set the topic.
- twisted.words.im.ircsupport.IRCProto.irc_JOIN
  twisted.words.im.ircsupport.IRCProto.html#irc_JOIN
  Function
  Method
  PUBLIC
  Called when a user joins a channel.
- twisted.words.im.ircsupport.IRCProto.irc_PART
  twisted.words.im.ircsupport.IRCProto.html#irc_PART
  Function
  Method
  PUBLIC
  Called when a user leaves a channel.
- twisted.words.im.ircsupport.IRCProto.irc_QUIT
  twisted.words.im.ircsupport.IRCProto.html#irc_QUIT
  Function
  Method
  PUBLIC
  Called when a user has quit.
- twisted.words.im.ircsupport.IRCProto.irc_NICK
  twisted.words.im.ircsupport.IRCProto.html#irc_NICK
  Function
  Method
  PUBLIC
  Called when a user changes their nickname.
- twisted.words.im.ircsupport.IRCProto.irc_unknown
  twisted.words.im.ircsupport.IRCProto.html#irc_unknown
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.im.ircsupport.IRCProto.joinGroup
  twisted.words.im.ircsupport.IRCProto.html#joinGroup
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.im.ircsupport.IRCAccount
  twisted.words.im.ircsupport.IRCAccount.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.words.im.ircsupport.IRCAccount.gatewayType
  twisted.words.im.ircsupport.IRCAccount.html#gatewayType
  Attribute
  Class Variable
  PUBLIC
  A `str` that identifies the protocol used by this account.
- twisted.words.im.ircsupport.IRCAccount.__init__
  twisted.words.im.ircsupport.IRCAccount.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.words.im.ircsupport.IRCAccount.channels
  twisted.words.im.ircsupport.IRCAccount.html#channels
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.im.ircsupport.IRCAccount._startLogOn
  twisted.words.im.ircsupport.IRCAccount.html#_startLogOn
  Function
  Method
  PRIVATE
  Start the sign on process.
- twisted.words.im.ircsupport.IRCAccount.logOff
  twisted.words.im.ircsupport.IRCAccount.html#logOff
  Function
  Method
  PUBLIC
  Sign off.
- twisted.words.im.pbsupport.TwistedWordsPerson
  twisted.words.im.pbsupport.TwistedWordsPerson.html
  Class
  Class
  PUBLIC
  I a facade for a person you can talk to through a twisted.words service.
- twisted.words.im.pbsupport.TwistedWordsPerson.__init__
  twisted.words.im.pbsupport.TwistedWordsPerson.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.im.pbsupport.TwistedWordsPerson.status
  twisted.words.im.pbsupport.TwistedWordsPerson.html#status
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.im.pbsupport.TwistedWordsPerson.isOnline
  twisted.words.im.pbsupport.TwistedWordsPerson.html#isOnline
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.im.pbsupport.TwistedWordsPerson.getStatus
  twisted.words.im.pbsupport.TwistedWordsPerson.html#getStatus
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.im.pbsupport.TwistedWordsPerson.sendMessage
  twisted.words.im.pbsupport.TwistedWordsPerson.html#sendMessage
  Function
  Method
  PUBLIC
  Return a deferred...
- twisted.words.im.pbsupport.TwistedWordsPerson.metadataFailed
  twisted.words.im.pbsupport.TwistedWordsPerson.html#metadataFailed
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.im.pbsupport.TwistedWordsPerson.setStatus
  twisted.words.im.pbsupport.TwistedWordsPerson.html#setStatus
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.im.pbsupport.TwistedWordsGroup
  twisted.words.im.pbsupport.TwistedWordsGroup.html
  Class
  Class
  PUBLIC
  No class docstring; 0/1 instance variable, 1/7 method documented
- twisted.words.im.pbsupport.TwistedWordsGroup.__init__
  twisted.words.im.pbsupport.TwistedWordsGroup.html#__init__
  Function
  Method
  PUBLIC
  Initialize me.
- twisted.words.im.pbsupport.TwistedWordsGroup.joined
  twisted.words.im.pbsupport.TwistedWordsGroup.html#joined
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.im.pbsupport.TwistedWordsGroup.sendGroupMessage
  twisted.words.im.pbsupport.TwistedWordsGroup.html#sendGroupMessage
  Function
  Method
  PUBLIC
  Return a deferred.
- twisted.words.im.pbsupport.TwistedWordsGroup.setTopic
  twisted.words.im.pbsupport.TwistedWordsGroup.html#setTopic
  Function
  Method
  PUBLIC
  Set this Groups topic on the server.
- twisted.words.im.pbsupport.TwistedWordsGroup.metadataFailed
  twisted.words.im.pbsupport.TwistedWordsGroup.html#metadataFailed
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.im.pbsupport.TwistedWordsGroup.joining
  twisted.words.im.pbsupport.TwistedWordsGroup.html#joining
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.im.pbsupport.TwistedWordsGroup.leaving
  twisted.words.im.pbsupport.TwistedWordsGroup.html#leaving
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.im.pbsupport.TwistedWordsGroup.leave
  twisted.words.im.pbsupport.TwistedWordsGroup.html#leave
  Function
  Method
  PUBLIC
  Depart this group.
- twisted.words.im.pbsupport.TwistedWordsClient
  twisted.words.im.pbsupport.TwistedWordsClient.html
  Class
  Class
  PUBLIC
  In some cases, this acts as an Account, since it a source of text messages (multiple Words instances may be on a single PB connection)
- twisted.words.im.pbsupport.TwistedWordsClient.__init__
  twisted.words.im.pbsupport.TwistedWordsClient.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.im.pbsupport.TwistedWordsClient.accountName
  twisted.words.im.pbsupport.TwistedWordsClient.html#accountName
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.im.pbsupport.TwistedWordsClient.name
  twisted.words.im.pbsupport.TwistedWordsClient.html#name
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.im.pbsupport.TwistedWordsClient.chat
  twisted.words.im.pbsupport.TwistedWordsClient.html#chat
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.im.pbsupport.TwistedWordsClient.account
  twisted.words.im.pbsupport.TwistedWordsClient.html#account
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.im.pbsupport.TwistedWordsClient._logonDeferred
  twisted.words.im.pbsupport.TwistedWordsClient.html#_logonDeferred
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.words.im.pbsupport.TwistedWordsClient.getPerson
  twisted.words.im.pbsupport.TwistedWordsClient.html#getPerson
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.im.pbsupport.TwistedWordsClient.getGroup
  twisted.words.im.pbsupport.TwistedWordsClient.html#getGroup
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.im.pbsupport.TwistedWordsClient.getGroupConversation
  twisted.words.im.pbsupport.TwistedWordsClient.html#getGroupConversation
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.im.pbsupport.TwistedWordsClient.addContact
  twisted.words.im.pbsupport.TwistedWordsClient.html#addContact
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.im.pbsupport.TwistedWordsClient.remote_receiveGroupMembers
  twisted.words.im.pbsupport.TwistedWordsClient.html#remote_receiveGroupMembers
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.im.pbsupport.TwistedWordsClient.remote_receiveGroupMessage
  twisted.words.im.pbsupport.TwistedWordsClient.html#remote_receiveGroupMessage
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.im.pbsupport.TwistedWordsClient.remote_memberJoined
  twisted.words.im.pbsupport.TwistedWordsClient.html#remote_memberJoined
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.im.pbsupport.TwistedWordsClient.remote_memberLeft
  twisted.words.im.pbsupport.TwistedWordsClient.html#remote_memberLeft
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.im.pbsupport.TwistedWordsClient.remote_notifyStatusChanged
  twisted.words.im.pbsupport.TwistedWordsClient.html#remote_notifyStatusChanged
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.im.pbsupport.TwistedWordsClient.remote_receiveDirectMessage
  twisted.words.im.pbsupport.TwistedWordsClient.html#remote_receiveDirectMessage
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.im.pbsupport.TwistedWordsClient.remote_receiveContactList
  twisted.words.im.pbsupport.TwistedWordsClient.html#remote_receiveContactList
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.im.pbsupport.TwistedWordsClient.remote_setGroupMetadata
  twisted.words.im.pbsupport.TwistedWordsClient.html#remote_setGroupMetadata
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.im.pbsupport.TwistedWordsClient.joinGroup
  twisted.words.im.pbsupport.TwistedWordsClient.html#joinGroup
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.im.pbsupport.TwistedWordsClient.leaveGroup
  twisted.words.im.pbsupport.TwistedWordsClient.html#leaveGroup
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.im.pbsupport.TwistedWordsClient._cbGroupJoined
  twisted.words.im.pbsupport.TwistedWordsClient.html#_cbGroupJoined
  Function
  Method
  PRIVATE
  Undocumented
- twisted.words.im.pbsupport.TwistedWordsClient._cbGroupLeft
  twisted.words.im.pbsupport.TwistedWordsClient.html#_cbGroupLeft
  Function
  Method
  PRIVATE
  Undocumented
- twisted.words.im.pbsupport.TwistedWordsClient.connected
  twisted.words.im.pbsupport.TwistedWordsClient.html#connected
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.im.pbsupport.TwistedWordsClient.perspective
  twisted.words.im.pbsupport.TwistedWordsClient.html#perspective
  Attribute
  Instance Variable
  PUBLIC
  I am an object sent remotely as a direct reference.
- twisted.words.im.pbsupport.pbFrontEnds
  twisted.words.im.pbsupport.html#pbFrontEnds
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.words.im.pbsupport.PBAccount
  twisted.words.im.pbsupport.PBAccount.html
  Class
  Class
  PUBLIC
  No class docstring; 0/2 instance variable, 0/1 class variable, 2/7 methods documented
- twisted.words.im.pbsupport.PBAccount.gatewayType
  twisted.words.im.pbsupport.PBAccount.html#gatewayType
  Attribute
  Class Variable
  PUBLIC
  A `str` that identifies the protocol used by this account.
- twisted.words.im.pbsupport.PBAccount.__init__
  twisted.words.im.pbsupport.PBAccount.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.words.im.pbsupport.PBAccount.services
  twisted.words.im.pbsupport.PBAccount.html#services
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.im.pbsupport.PBAccount.logOn
  twisted.words.im.pbsupport.PBAccount.html#logOn
  Function
  Method
  PUBLIC
  No summary
- twisted.words.im.pbsupport.PBAccount._isConnecting
  twisted.words.im.pbsupport.PBAccount.html#_isConnecting
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.words.im.pbsupport.PBAccount.logOff
  twisted.words.im.pbsupport.PBAccount.html#logOff
  Function
  Method
  PUBLIC
  Sign off.
- twisted.words.im.pbsupport.PBAccount._startLogOn
  twisted.words.im.pbsupport.PBAccount.html#_startLogOn
  Function
  Method
  PRIVATE
  Start the sign on process.
- twisted.words.im.pbsupport.PBAccount._cbConnected
  twisted.words.im.pbsupport.PBAccount.html#_cbConnected
  Function
  Method
  PRIVATE
  Undocumented
- twisted.words.im.pbsupport.PBAccount._cbIdent
  twisted.words.im.pbsupport.PBAccount.html#_cbIdent
  Function
  Method
  PRIVATE
  Undocumented
- twisted.words.im.pbsupport.PBAccount._ebConnected
  twisted.words.im.pbsupport.PBAccount.html#_ebConnected
  Function
  Method
  PRIVATE
  Undocumented
- twisted.words.xish.domish._splitPrefix
  twisted.words.xish.domish.html#_splitPrefix
  Function
  Function
  PRIVATE
  Internal method for splitting a prefixed Element name into its respective parts
- twisted.words.xish.domish.G_PREFIXES
  twisted.words.xish.domish.html#G_PREFIXES
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.xish.domish._ListSerializer
  twisted.words.xish.domish._ListSerializer.html
  Class
  Class
  PRIVATE
  Internal class which serializes an Element tree into a buffer
- twisted.words.xish.domish._ListSerializer.__init__
  twisted.words.xish.domish._ListSerializer.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.xish.domish._ListSerializer.writelist
  twisted.words.xish.domish._ListSerializer.html#writelist
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.xish.domish._ListSerializer.prefixes
  twisted.words.xish.domish._ListSerializer.html#prefixes
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.xish.domish._ListSerializer.prefixStack
  twisted.words.xish.domish._ListSerializer.html#prefixStack
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.xish.domish._ListSerializer.prefixCounter
  twisted.words.xish.domish._ListSerializer.html#prefixCounter
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.xish.domish._ListSerializer.getValue
  twisted.words.xish.domish._ListSerializer.html#getValue
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.xish.domish._ListSerializer.getPrefix
  twisted.words.xish.domish._ListSerializer.html#getPrefix
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.xish.domish._ListSerializer.prefixInScope
  twisted.words.xish.domish._ListSerializer.html#prefixInScope
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.xish.domish._ListSerializer.serialize
  twisted.words.xish.domish._ListSerializer.html#serialize
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.xish.domish.escapeToXml
  twisted.words.xish.domish.html#escapeToXml
  Function
  Function
  PUBLIC
  Escape text to proper XML form, per section 2.3 in the XML specification.
- twisted.words.xish.domish.unescapeFromXml
  twisted.words.xish.domish.html#unescapeFromXml
  Function
  Function
  PUBLIC
  Undocumented
- twisted.words.xish.domish.generateOnlyInterface
  twisted.words.xish.domish.html#generateOnlyInterface
  Function
  Function
  PUBLIC
  Filters items in a list by class
- twisted.words.xish.domish.generateElementsQNamed
  twisted.words.xish.domish.html#generateElementsQNamed
  Function
  Function
  PUBLIC
  Filters Element items in a list with matching name and URI.
- twisted.words.xish.domish.generateElementsNamed
  twisted.words.xish.domish.html#generateElementsNamed
  Function
  Function
  PUBLIC
  Filters Element items in a list with matching name, regardless of URI.
- twisted.words.xish.domish.SerializedXML
  twisted.words.xish.domish.SerializedXML.html
  Class
  Class
  PUBLIC
  Marker class for pre-serialized XML in the DOM.
- twisted.words.xish.domish.Namespace
  twisted.words.xish.domish.Namespace.html
  Class
  Class
  PUBLIC
  Convenience object for tracking namespace declarations.
- twisted.words.xish.domish.Namespace.__init__
  twisted.words.xish.domish.Namespace.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.xish.domish.Namespace._uri
  twisted.words.xish.domish.Namespace.html#_uri
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.words.xish.domish.Namespace.__getattr__
  twisted.words.xish.domish.Namespace.html#__getattr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.xish.domish.Namespace.__getitem__
  twisted.words.xish.domish.Namespace.html#__getitem__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.xish.domish.IElement
  twisted.words.xish.domish.IElement.html
  Class
  Interface
  PUBLIC
  Interface to XML element nodes.
- twisted.words.xish.domish.IElement.uri
  twisted.words.xish.domish.IElement.html#uri
  Attribute
  Attribute
  PUBLIC
  Element's namespace URI
- twisted.words.xish.domish.IElement.name
  twisted.words.xish.domish.IElement.html#name
  Attribute
  Attribute
  PUBLIC
  Element's local name
- twisted.words.xish.domish.IElement.defaultUri
  twisted.words.xish.domish.IElement.html#defaultUri
  Attribute
  Attribute
  PUBLIC
  Default namespace URI of child elements
- twisted.words.xish.domish.IElement.attributes
  twisted.words.xish.domish.IElement.html#attributes
  Attribute
  Attribute
  PUBLIC
  Dictionary of element attributes
- twisted.words.xish.domish.IElement.children
  twisted.words.xish.domish.IElement.html#children
  Attribute
  Attribute
  PUBLIC
  List of child nodes
- twisted.words.xish.domish.IElement.parent
  twisted.words.xish.domish.IElement.html#parent
  Attribute
  Attribute
  PUBLIC
  Reference to element's parent element
- twisted.words.xish.domish.IElement.localPrefixes
  twisted.words.xish.domish.IElement.html#localPrefixes
  Attribute
  Attribute
  PUBLIC
  Dictionary of local prefixes
- twisted.words.xish.domish.IElement.toXml
  twisted.words.xish.domish.IElement.html#toXml
  Function
  Method
  PUBLIC
  Serializes object to a (partial) XML document
- twisted.words.xish.domish.IElement.addElement
  twisted.words.xish.domish.IElement.html#addElement
  Function
  Method
  PUBLIC
  Create an element and add as child.
- twisted.words.xish.domish.IElement.addChild
  twisted.words.xish.domish.IElement.html#addChild
  Function
  Method
  PUBLIC
  Adds a node as child of this element.
- twisted.words.xish.domish.IElement.addContent
  twisted.words.xish.domish.IElement.html#addContent
  Function
  Method
  PUBLIC
  Adds character data to this element.
- twisted.words.xish.domish.Element
  twisted.words.xish.domish.Element.html
  Class
  Class
  PUBLIC
  Represents an XML element node.
- twisted.words.xish.domish.Element.uri
  twisted.words.xish.domish.Element.html#uri
  Attribute
  Instance Variable
  PUBLIC
  URI of this Element's name
- twisted.words.xish.domish.Element.name
  twisted.words.xish.domish.Element.html#name
  Attribute
  Instance Variable
  PUBLIC
  Name of this Element
- twisted.words.xish.domish.Element.defaultUri
  twisted.words.xish.domish.Element.html#defaultUri
  Attribute
  Instance Variable
  PUBLIC
  URI this Element exists within
- twisted.words.xish.domish.Element.children
  twisted.words.xish.domish.Element.html#children
  Attribute
  Instance Variable
  PUBLIC
  List of child Elements and content
- twisted.words.xish.domish.Element.parent
  twisted.words.xish.domish.Element.html#parent
  Attribute
  Instance Variable
  PUBLIC
  Reference to the parent Element, if any.
- twisted.words.xish.domish.Element.attributes
  twisted.words.xish.domish.Element.html#attributes
  Attribute
  Instance Variable
  PUBLIC
  Dictionary of attributes associated with this Element.
- twisted.words.xish.domish.Element.localPrefixes
  twisted.words.xish.domish.Element.html#localPrefixes
  Attribute
  Instance Variable
  PUBLIC
  Dictionary of namespace declarations on this element. The key is the prefix to bind the namespace uri to.
- twisted.words.xish.domish.Element._idCounter
  twisted.words.xish.domish.Element.html#_idCounter
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.words.xish.domish.Element.__init__
  twisted.words.xish.domish.Element.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.words.xish.domish.Element.__getattr__
  twisted.words.xish.domish.Element.html#__getattr__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.xish.domish.Element.__getitem__
  twisted.words.xish.domish.Element.html#__getitem__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.xish.domish.Element.__delitem__
  twisted.words.xish.domish.Element.html#__delitem__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.xish.domish.Element.__setitem__
  twisted.words.xish.domish.Element.html#__setitem__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.xish.domish.Element.__unicode__
  twisted.words.xish.domish.Element.html#__unicode__
  Function
  Method
  PUBLIC
  Retrieve the first CData (content) node
- twisted.words.xish.domish.Element.__bytes__
  twisted.words.xish.domish.Element.html#__bytes__
  Function
  Method
  PUBLIC
  Retrieve the first character data node as UTF-8 bytes.
- twisted.words.xish.domish.Element._dqa
  twisted.words.xish.domish.Element.html#_dqa
  Function
  Method
  PRIVATE
  Dequalify an attribute key as needed
- twisted.words.xish.domish.Element.getAttribute
  twisted.words.xish.domish.Element.html#getAttribute
  Function
  Method
  PUBLIC
  Retrieve the value of attribname, if it exists
- twisted.words.xish.domish.Element.hasAttribute
  twisted.words.xish.domish.Element.html#hasAttribute
  Function
  Method
  PUBLIC
  Determine if the specified attribute exists
- twisted.words.xish.domish.Element.compareAttribute
  twisted.words.xish.domish.Element.html#compareAttribute
  Function
  Method
  PUBLIC
  Safely compare the value of an attribute against a provided value.
- twisted.words.xish.domish.Element.swapAttributeValues
  twisted.words.xish.domish.Element.html#swapAttributeValues
  Function
  Method
  PUBLIC
  Swap the values of two attribute.
- twisted.words.xish.domish.Element.addChild
  twisted.words.xish.domish.Element.html#addChild
  Function
  Method
  PUBLIC
  Add a child to this Element.
- twisted.words.xish.domish.Element.addContent
  twisted.words.xish.domish.Element.html#addContent
  Function
  Method
  PUBLIC
  Add some text data to this Element.
- twisted.words.xish.domish.Element.addElement
  twisted.words.xish.domish.Element.html#addElement
  Function
  Method
  PUBLIC
  Create an element and add as child.
- twisted.words.xish.domish.Element.addRawXml
  twisted.words.xish.domish.Element.html#addRawXml
  Function
  Method
  PUBLIC
  Add a pre-serialized chunk o' XML as a child of this Element.
- twisted.words.xish.domish.Element.addUniqueId
  twisted.words.xish.domish.Element.html#addUniqueId
  Function
  Method
  PUBLIC
  Add a unique (across a given Python session) id attribute to this Element.
- twisted.words.xish.domish.Element.elements
  twisted.words.xish.domish.Element.html#elements
  Function
  Method
  PUBLIC
  Iterate across all children of this Element that are Elements.
- twisted.words.xish.domish.Element.toXml
  twisted.words.xish.domish.Element.html#toXml
  Function
  Method
  PUBLIC
  Serialize this Element and all children to a string.
- twisted.words.xish.domish.Element.firstChildElement
  twisted.words.xish.domish.Element.html#firstChildElement
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.xish.domish.ParserError
  twisted.words.xish.domish.ParserError.html
  Class
  Exception
  PUBLIC
  Exception thrown when a parsing error occurs
- twisted.words.xish.domish.elementStream
  twisted.words.xish.domish.html#elementStream
  Function
  Function
  PUBLIC
  Preferred method to construct an ElementStream
- twisted.words.xish.domish.SuxElementStream
  twisted.words.xish.domish.SuxElementStream.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.words.xish.domish.SuxElementStream.__init__
  twisted.words.xish.domish.SuxElementStream.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.xish.domish.SuxElementStream.DocumentStartEvent
  twisted.words.xish.domish.SuxElementStream.html#DocumentStartEvent
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.xish.domish.SuxElementStream.ElementEvent
  twisted.words.xish.domish.SuxElementStream.html#ElementEvent
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.xish.domish.SuxElementStream.DocumentEndEvent
  twisted.words.xish.domish.SuxElementStream.html#DocumentEndEvent
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.xish.domish.SuxElementStream.currElem
  twisted.words.xish.domish.SuxElementStream.html#currElem
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.xish.domish.SuxElementStream.rootElem
  twisted.words.xish.domish.SuxElementStream.html#rootElem
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.xish.domish.SuxElementStream.documentStarted
  twisted.words.xish.domish.SuxElementStream.html#documentStarted
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.xish.domish.SuxElementStream.defaultNsStack
  twisted.words.xish.domish.SuxElementStream.html#defaultNsStack
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.xish.domish.SuxElementStream.prefixStack
  twisted.words.xish.domish.SuxElementStream.html#prefixStack
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.xish.domish.SuxElementStream.parse
  twisted.words.xish.domish.SuxElementStream.html#parse
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.xish.domish.SuxElementStream.findUri
  twisted.words.xish.domish.SuxElementStream.html#findUri
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.xish.domish.SuxElementStream.gotTagStart
  twisted.words.xish.domish.SuxElementStream.html#gotTagStart
  Function
  Method
  PUBLIC
  Encountered an opening tag.
- twisted.words.xish.domish.SuxElementStream.gotText
  twisted.words.xish.domish.SuxElementStream.html#gotText
  Function
  Method
  PUBLIC
  Encountered text
- twisted.words.xish.domish.SuxElementStream.gotCData
  twisted.words.xish.domish.SuxElementStream.html#gotCData
  Function
  Method
  PUBLIC
  Encountered CDATA
- twisted.words.xish.domish.SuxElementStream.gotComment
  twisted.words.xish.domish.SuxElementStream.html#gotComment
  Function
  Method
  PUBLIC
  Encountered comment.
- twisted.words.xish.domish.SuxElementStream.entities
  twisted.words.xish.domish.SuxElementStream.html#entities
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.words.xish.domish.SuxElementStream.gotEntityReference
  twisted.words.xish.domish.SuxElementStream.html#gotEntityReference
  Function
  Method
  PUBLIC
  Encountered mnemonic entity reference
- twisted.words.xish.domish.SuxElementStream.gotTagEnd
  twisted.words.xish.domish.SuxElementStream.html#gotTagEnd
  Function
  Method
  PUBLIC
  Encountered closing tag
- twisted.words.xish.domish.ExpatElementStream
  twisted.words.xish.domish.ExpatElementStream.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.words.xish.domish.ExpatElementStream.__init__
  twisted.words.xish.domish.ExpatElementStream.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.xish.domish.ExpatElementStream.DocumentStartEvent
  twisted.words.xish.domish.ExpatElementStream.html#DocumentStartEvent
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.xish.domish.ExpatElementStream.ElementEvent
  twisted.words.xish.domish.ExpatElementStream.html#ElementEvent
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.xish.domish.ExpatElementStream.DocumentEndEvent
  twisted.words.xish.domish.ExpatElementStream.html#DocumentEndEvent
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.xish.domish.ExpatElementStream.error
  twisted.words.xish.domish.ExpatElementStream.html#error
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.xish.domish.ExpatElementStream.parser
  twisted.words.xish.domish.ExpatElementStream.html#parser
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.xish.domish.ExpatElementStream.currElem
  twisted.words.xish.domish.ExpatElementStream.html#currElem
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.xish.domish.ExpatElementStream.defaultNsStack
  twisted.words.xish.domish.ExpatElementStream.html#defaultNsStack
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.xish.domish.ExpatElementStream.documentStarted
  twisted.words.xish.domish.ExpatElementStream.html#documentStarted
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.xish.domish.ExpatElementStream.localPrefixes
  twisted.words.xish.domish.ExpatElementStream.html#localPrefixes
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.xish.domish.ExpatElementStream.parse
  twisted.words.xish.domish.ExpatElementStream.html#parse
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.xish.domish.ExpatElementStream._onStartElement
  twisted.words.xish.domish.ExpatElementStream.html#_onStartElement
  Function
  Method
  PRIVATE
  Undocumented
- twisted.words.xish.domish.ExpatElementStream._onEndElement
  twisted.words.xish.domish.ExpatElementStream.html#_onEndElement
  Function
  Method
  PRIVATE
  Undocumented
- twisted.words.xish.domish.ExpatElementStream._onCdata
  twisted.words.xish.domish.ExpatElementStream.html#_onCdata
  Function
  Method
  PRIVATE
  Undocumented
- twisted.words.xish.domish.ExpatElementStream._onStartNamespace
  twisted.words.xish.domish.ExpatElementStream.html#_onStartNamespace
  Function
  Method
  PRIVATE
  Undocumented
- twisted.words.xish.domish.ExpatElementStream._onEndNamespace
  twisted.words.xish.domish.ExpatElementStream.html#_onEndNamespace
  Function
  Method
  PRIVATE
  Undocumented
- twisted.words.protocols.jabber.error.NS_XML
  twisted.words.protocols.jabber.error.html#NS_XML
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.error.NS_XMPP_STREAMS
  twisted.words.protocols.jabber.error.html#NS_XMPP_STREAMS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.error.NS_XMPP_STANZAS
  twisted.words.protocols.jabber.error.html#NS_XMPP_STANZAS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.error.STANZA_CONDITIONS
  twisted.words.protocols.jabber.error.html#STANZA_CONDITIONS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.error.CODES_TO_CONDITIONS
  twisted.words.protocols.jabber.error.html#CODES_TO_CONDITIONS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.error.BaseError
  twisted.words.protocols.jabber.error.BaseError.html
  Class
  Exception
  PUBLIC
  Base class for XMPP error exceptions.
- twisted.words.protocols.jabber.error.BaseError.namespace
  twisted.words.protocols.jabber.error.BaseError.html#namespace
  Attribute
  Class Variable
  PUBLIC
  The namespace of the `error` element generated by `getElement`.
- twisted.words.protocols.jabber.error.BaseError.condition
  twisted.words.protocols.jabber.error.BaseError.html#condition
  Attribute
  Instance Variable
  PUBLIC
  The error condition. The valid values are defined by subclasses of `BaseError`.
- twisted.words.protocols.jabber.error.BaseError.text
  twisted.words.protocols.jabber.error.BaseError.html#text
  Attribute
  Instance Variable
  PUBLIC
  Optional text message to supplement the condition or application specific condition.
- twisted.words.protocols.jabber.error.BaseError.textLang
  twisted.words.protocols.jabber.error.BaseError.html#textLang
  Attribute
  Instance Variable
  PUBLIC
  Identifier of the language used for the message in `text`. Values are as described in RFC 3066.
- twisted.words.protocols.jabber.error.BaseError.appCondition
  twisted.words.protocols.jabber.error.BaseError.html#appCondition
  Attribute
  Instance Variable
  PUBLIC
  Application specific condition element, supplementing the error condition in `condition`.
- twisted.words.protocols.jabber.error.BaseError.__init__
  twisted.words.protocols.jabber.error.BaseError.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.error.BaseError.__str__
  twisted.words.protocols.jabber.error.BaseError.html#__str__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.error.BaseError.getElement
  twisted.words.protocols.jabber.error.BaseError.html#getElement
  Function
  Method
  PUBLIC
  Get XML representation from self.
- twisted.words.protocols.jabber.error.StreamError
  twisted.words.protocols.jabber.error.StreamError.html
  Class
  Exception
  PUBLIC
  Stream Error exception.
- twisted.words.protocols.jabber.error.StreamError.getElement
  twisted.words.protocols.jabber.error.StreamError.html#getElement
  Function
  Method
  PUBLIC
  Get XML representation from self.
- twisted.words.protocols.jabber.error.StanzaError
  twisted.words.protocols.jabber.error.StanzaError.html
  Class
  Exception
  PUBLIC
  Stanza Error exception.
- twisted.words.protocols.jabber.error.StanzaError.type
  twisted.words.protocols.jabber.error.StanzaError.html#type
  Attribute
  Instance Variable
  PUBLIC
  The stanza error type. Gives a suggestion to the recipient of the error on how to proceed.
- twisted.words.protocols.jabber.error.StanzaError.code
  twisted.words.protocols.jabber.error.StanzaError.html#code
  Attribute
  Instance Variable
  PUBLIC
  A numeric identifier for the error condition for backwards compatibility with pre-XMPP Jabber implementations.
- twisted.words.protocols.jabber.error.StanzaError.__init__
  twisted.words.protocols.jabber.error.StanzaError.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.error.StanzaError.children
  twisted.words.protocols.jabber.error.StanzaError.html#children
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.error.StanzaError.iq
  twisted.words.protocols.jabber.error.StanzaError.html#iq
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.error.StanzaError.getElement
  twisted.words.protocols.jabber.error.StanzaError.html#getElement
  Function
  Method
  PUBLIC
  Get XML representation from self.
- twisted.words.protocols.jabber.error.StanzaError.toResponse
  twisted.words.protocols.jabber.error.StanzaError.html#toResponse
  Function
  Method
  PUBLIC
  Construct error response stanza.
- twisted.words.protocols.jabber.error._parseError
  twisted.words.protocols.jabber.error.html#_parseError
  Function
  Function
  PRIVATE
  Parses an error element.
- twisted.words.protocols.jabber.error.exceptionFromStreamError
  twisted.words.protocols.jabber.error.html#exceptionFromStreamError
  Function
  Function
  PUBLIC
  Build an exception object from a stream error.
- twisted.words.protocols.jabber.error.exceptionFromStanza
  twisted.words.protocols.jabber.error.html#exceptionFromStanza
  Function
  Function
  PUBLIC
  Build an exception object from an error stanza.
- twisted.words.protocols.jabber.sasl_mechanisms.ISASLMechanism
  twisted.words.protocols.jabber.sasl_mechanisms.ISASLMechanism.html
  Class
  Interface
  PUBLIC
  No interface docstring; 1/1 attribute, 2/2 methods documented
- twisted.words.protocols.jabber.sasl_mechanisms.ISASLMechanism.name
  twisted.words.protocols.jabber.sasl_mechanisms.ISASLMechanism.html#name
  Attribute
  Attribute
  PUBLIC
  Common name for the SASL Mechanism.
- twisted.words.protocols.jabber.sasl_mechanisms.ISASLMechanism.getInitialResponse
  twisted.words.protocols.jabber.sasl_mechanisms.ISASLMechanism.html#getInitialResponse
  Function
  Method
  PUBLIC
  Get the initial client response, if defined for this mechanism.
- twisted.words.protocols.jabber.sasl_mechanisms.ISASLMechanism.getResponse
  twisted.words.protocols.jabber.sasl_mechanisms.ISASLMechanism.html#getResponse
  Function
  Method
  PUBLIC
  Get the response to a server challenge.
- twisted.words.protocols.jabber.sasl_mechanisms.Anonymous
  twisted.words.protocols.jabber.sasl_mechanisms.Anonymous.html
  Class
  Class
  PUBLIC
  Implements the ANONYMOUS SASL authentication mechanism.
- twisted.words.protocols.jabber.sasl_mechanisms.Anonymous.name
  twisted.words.protocols.jabber.sasl_mechanisms.Anonymous.html#name
  Attribute
  Class Variable
  PUBLIC
  Common name for the SASL Mechanism.
- twisted.words.protocols.jabber.sasl_mechanisms.Anonymous.getInitialResponse
  twisted.words.protocols.jabber.sasl_mechanisms.Anonymous.html#getInitialResponse
  Function
  Method
  PUBLIC
  Get the initial client response, if defined for this mechanism.
- twisted.words.protocols.jabber.sasl_mechanisms.Anonymous.getResponse
  twisted.words.protocols.jabber.sasl_mechanisms.Anonymous.html#getResponse
  Function
  Method
  PUBLIC
  Get the response to a server challenge.
- twisted.words.protocols.jabber.sasl_mechanisms.Plain
  twisted.words.protocols.jabber.sasl_mechanisms.Plain.html
  Class
  Class
  PUBLIC
  Implements the PLAIN SASL authentication mechanism.
- twisted.words.protocols.jabber.sasl_mechanisms.Plain.name
  twisted.words.protocols.jabber.sasl_mechanisms.Plain.html#name
  Attribute
  Class Variable
  PUBLIC
  Common name for the SASL Mechanism.
- twisted.words.protocols.jabber.sasl_mechanisms.Plain.__init__
  twisted.words.protocols.jabber.sasl_mechanisms.Plain.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.words.protocols.jabber.sasl_mechanisms.Plain.authzid
  twisted.words.protocols.jabber.sasl_mechanisms.Plain.html#authzid
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.sasl_mechanisms.Plain.authcid
  twisted.words.protocols.jabber.sasl_mechanisms.Plain.html#authcid
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.sasl_mechanisms.Plain.password
  twisted.words.protocols.jabber.sasl_mechanisms.Plain.html#password
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.sasl_mechanisms.Plain.getInitialResponse
  twisted.words.protocols.jabber.sasl_mechanisms.Plain.html#getInitialResponse
  Function
  Method
  PUBLIC
  Get the initial client response, if defined for this mechanism.
- twisted.words.protocols.jabber.sasl_mechanisms.Plain.getResponse
  twisted.words.protocols.jabber.sasl_mechanisms.Plain.html#getResponse
  Function
  Method
  PUBLIC
  Get the response to a server challenge.
- twisted.words.protocols.jabber.sasl_mechanisms.DigestMD5
  twisted.words.protocols.jabber.sasl_mechanisms.DigestMD5.html
  Class
  Class
  PUBLIC
  Implements the DIGEST-MD5 SASL authentication mechanism.
- twisted.words.protocols.jabber.sasl_mechanisms.DigestMD5.name
  twisted.words.protocols.jabber.sasl_mechanisms.DigestMD5.html#name
  Attribute
  Class Variable
  PUBLIC
  Common name for the SASL Mechanism.
- twisted.words.protocols.jabber.sasl_mechanisms.DigestMD5.__init__
  twisted.words.protocols.jabber.sasl_mechanisms.DigestMD5.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.words.protocols.jabber.sasl_mechanisms.DigestMD5.username
  twisted.words.protocols.jabber.sasl_mechanisms.DigestMD5.html#username
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.sasl_mechanisms.DigestMD5.password
  twisted.words.protocols.jabber.sasl_mechanisms.DigestMD5.html#password
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.sasl_mechanisms.DigestMD5.defaultRealm
  twisted.words.protocols.jabber.sasl_mechanisms.DigestMD5.html#defaultRealm
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.sasl_mechanisms.DigestMD5.digest_uri
  twisted.words.protocols.jabber.sasl_mechanisms.DigestMD5.html#digest_uri
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.sasl_mechanisms.DigestMD5.getInitialResponse
  twisted.words.protocols.jabber.sasl_mechanisms.DigestMD5.html#getInitialResponse
  Function
  Method
  PUBLIC
  Get the initial client response, if defined for this mechanism.
- twisted.words.protocols.jabber.sasl_mechanisms.DigestMD5.getResponse
  twisted.words.protocols.jabber.sasl_mechanisms.DigestMD5.html#getResponse
  Function
  Method
  PUBLIC
  Get the response to a server challenge.
- twisted.words.protocols.jabber.sasl_mechanisms.DigestMD5._parse
  twisted.words.protocols.jabber.sasl_mechanisms.DigestMD5.html#_parse
  Function
  Method
  PRIVATE
  Parses the server challenge.
- twisted.words.protocols.jabber.sasl_mechanisms.DigestMD5._unparse
  twisted.words.protocols.jabber.sasl_mechanisms.DigestMD5.html#_unparse
  Function
  Method
  PRIVATE
  Create message string from directives.
- twisted.words.protocols.jabber.sasl_mechanisms.DigestMD5._calculateResponse
  twisted.words.protocols.jabber.sasl_mechanisms.DigestMD5.html#_calculateResponse
  Function
  Method
  PRIVATE
  Calculates response with given encoded parameters.
- twisted.words.protocols.jabber.sasl_mechanisms.DigestMD5._genResponse
  twisted.words.protocols.jabber.sasl_mechanisms.DigestMD5.html#_genResponse
  Function
  Method
  PRIVATE
  Generate response-value.
- twisted.words.protocols.jabber.sasl_mechanisms.DigestMD5._gen_nonce
  twisted.words.protocols.jabber.sasl_mechanisms.DigestMD5.html#_gen_nonce
  Function
  Method
  PRIVATE
  Undocumented
- twisted.words.protocols.jabber.xmlstream.STREAM_AUTHD_EVENT
  twisted.words.protocols.jabber.xmlstream.html#STREAM_AUTHD_EVENT
  Attribute
  Constant
  PUBLIC
  Token dispatched by `Authenticator` when the stream has been completely initialized
- twisted.words.protocols.jabber.xmlstream.INIT_FAILED_EVENT
  twisted.words.protocols.jabber.xmlstream.html#INIT_FAILED_EVENT
  Attribute
  Constant
  PUBLIC
  Token dispatched by `Authenticator` when the stream has failed to be initialized
- twisted.words.protocols.jabber.xmlstream.Reset
  twisted.words.protocols.jabber.xmlstream.html#Reset
  Attribute
  Variable
  PUBLIC
  Token to signal that the XML stream has been reset.
- twisted.words.protocols.jabber.ijabber.IInitializer
  twisted.words.protocols.jabber.ijabber.IInitializer.html
  Class
  Interface
  PUBLIC
  Interface for XML stream initializers.
- twisted.words.protocols.jabber.ijabber.IInitiatingInitializer
  twisted.words.protocols.jabber.ijabber.IInitiatingInitializer.html
  Class
  Interface
  PUBLIC
  Interface for XML stream initializers for the initiating entity.
- twisted.words.protocols.jabber.ijabber.IInitiatingInitializer.xmlstream
  twisted.words.protocols.jabber.ijabber.IInitiatingInitializer.html#xmlstream
  Attribute
  Attribute
  PUBLIC
  The associated XML stream
- twisted.words.protocols.jabber.ijabber.IInitiatingInitializer.initialize
  twisted.words.protocols.jabber.ijabber.IInitiatingInitializer.html#initialize
  Function
  Method
  PUBLIC
  Initiate the initialization step.
- twisted.words.protocols.jabber.ijabber.IIQResponseTracker
  twisted.words.protocols.jabber.ijabber.IIQResponseTracker.html
  Class
  Interface
  PUBLIC
  IQ response tracker interface.
- twisted.words.protocols.jabber.ijabber.IIQResponseTracker.iqDeferreds
  twisted.words.protocols.jabber.ijabber.IIQResponseTracker.html#iqDeferreds
  Attribute
  Attribute
  PUBLIC
  Dictionary of deferreds waiting for an iq response
- twisted.words.protocols.jabber.ijabber.IXMPPHandler
  twisted.words.protocols.jabber.ijabber.IXMPPHandler.html
  Class
  Interface
  PUBLIC
  Interface for XMPP protocol handlers.
- twisted.words.protocols.jabber.ijabber.IXMPPHandler.parent
  twisted.words.protocols.jabber.ijabber.IXMPPHandler.html#parent
  Attribute
  Attribute
  PUBLIC
  XML stream manager for this handler
- twisted.words.protocols.jabber.ijabber.IXMPPHandler.xmlstream
  twisted.words.protocols.jabber.ijabber.IXMPPHandler.html#xmlstream
  Attribute
  Attribute
  PUBLIC
  The managed XML stream
- twisted.words.protocols.jabber.ijabber.IXMPPHandler.setHandlerParent
  twisted.words.protocols.jabber.ijabber.IXMPPHandler.html#setHandlerParent
  Function
  Method
  PUBLIC
  Set the parent of the handler.
- twisted.words.protocols.jabber.ijabber.IXMPPHandler.disownHandlerParent
  twisted.words.protocols.jabber.ijabber.IXMPPHandler.html#disownHandlerParent
  Function
  Method
  PUBLIC
  Remove the parent of the handler.
- twisted.words.protocols.jabber.ijabber.IXMPPHandler.makeConnection
  twisted.words.protocols.jabber.ijabber.IXMPPHandler.html#makeConnection
  Function
  Method
  PUBLIC
  A connection over the underlying transport of the XML stream has been established.
- twisted.words.protocols.jabber.ijabber.IXMPPHandler.connectionMade
  twisted.words.protocols.jabber.ijabber.IXMPPHandler.html#connectionMade
  Function
  Method
  PUBLIC
  Called after a connection has been established.
- twisted.words.protocols.jabber.ijabber.IXMPPHandler.connectionInitialized
  twisted.words.protocols.jabber.ijabber.IXMPPHandler.html#connectionInitialized
  Function
  Method
  PUBLIC
  The XML stream has been initialized.
- twisted.words.protocols.jabber.ijabber.IXMPPHandler.connectionLost
  twisted.words.protocols.jabber.ijabber.IXMPPHandler.html#connectionLost
  Function
  Method
  PUBLIC
  The XML stream has been closed.
- twisted.words.protocols.jabber.ijabber.IXMPPHandlerCollection
  twisted.words.protocols.jabber.ijabber.IXMPPHandlerCollection.html
  Class
  Interface
  PUBLIC
  Collection of handlers.
- twisted.words.protocols.jabber.ijabber.IXMPPHandlerCollection.__iter__
  twisted.words.protocols.jabber.ijabber.IXMPPHandlerCollection.html#__iter__
  Function
  Method
  PUBLIC
  Get an iterator over all child handlers.
- twisted.words.protocols.jabber.ijabber.IXMPPHandlerCollection.addHandler
  twisted.words.protocols.jabber.ijabber.IXMPPHandlerCollection.html#addHandler
  Function
  Method
  PUBLIC
  Add a child handler.
- twisted.words.protocols.jabber.ijabber.IXMPPHandlerCollection.removeHandler
  twisted.words.protocols.jabber.ijabber.IXMPPHandlerCollection.html#removeHandler
  Function
  Method
  PUBLIC
  Remove a child handler.
- twisted.words.protocols.jabber.ijabber.IService
  twisted.words.protocols.jabber.ijabber.IService.html
  Class
  Interface
  PUBLIC
  External server-side component service interface.
- twisted.words.protocols.jabber.ijabber.IService.componentConnected
  twisted.words.protocols.jabber.ijabber.IService.html#componentConnected
  Function
  Method
  PUBLIC
  Parent component has established a connection.
- twisted.words.protocols.jabber.ijabber.IService.componentDisconnected
  twisted.words.protocols.jabber.ijabber.IService.html#componentDisconnected
  Function
  Method
  PUBLIC
  Parent component has lost the connection to the Jabber server.
- twisted.words.protocols.jabber.ijabber.IService.transportConnected
  twisted.words.protocols.jabber.ijabber.IService.html#transportConnected
  Function
  Method
  PUBLIC
  Parent component has established a connection over the underlying transport.
- twisted.words.protocols.jabber.xmpp_stringprep.crippled
  twisted.words.protocols.jabber.xmpp_stringprep.html#crippled
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.xmpp_stringprep.ILookupTable
  twisted.words.protocols.jabber.xmpp_stringprep.ILookupTable.html
  Class
  Interface
  PUBLIC
  Interface for character lookup classes.
- twisted.words.protocols.jabber.xmpp_stringprep.ILookupTable.lookup
  twisted.words.protocols.jabber.xmpp_stringprep.ILookupTable.html#lookup
  Function
  Method
  PUBLIC
  Return whether character is in this table.
- twisted.words.protocols.jabber.xmpp_stringprep.IMappingTable
  twisted.words.protocols.jabber.xmpp_stringprep.IMappingTable.html
  Class
  Interface
  PUBLIC
  Interface for character mapping classes.
- twisted.words.protocols.jabber.xmpp_stringprep.IMappingTable.map
  twisted.words.protocols.jabber.xmpp_stringprep.IMappingTable.html#map
  Function
  Method
  PUBLIC
  Return mapping for character.
- twisted.words.protocols.jabber.xmpp_stringprep.LookupTableFromFunction
  twisted.words.protocols.jabber.xmpp_stringprep.LookupTableFromFunction.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.xmpp_stringprep.LookupTableFromFunction.__init__
  twisted.words.protocols.jabber.xmpp_stringprep.LookupTableFromFunction.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.xmpp_stringprep.LookupTableFromFunction.lookup
  twisted.words.protocols.jabber.xmpp_stringprep.LookupTableFromFunction.html#lookup
  Attribute
  Instance Variable
  PUBLIC
  Return whether character is in this table.
- twisted.words.protocols.jabber.xmpp_stringprep.LookupTable
  twisted.words.protocols.jabber.xmpp_stringprep.LookupTable.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.xmpp_stringprep.LookupTable.__init__
  twisted.words.protocols.jabber.xmpp_stringprep.LookupTable.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.xmpp_stringprep.LookupTable._table
  twisted.words.protocols.jabber.xmpp_stringprep.LookupTable.html#_table
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.words.protocols.jabber.xmpp_stringprep.LookupTable.lookup
  twisted.words.protocols.jabber.xmpp_stringprep.LookupTable.html#lookup
  Function
  Method
  PUBLIC
  Return whether character is in this table.
- twisted.words.protocols.jabber.xmpp_stringprep.MappingTableFromFunction
  twisted.words.protocols.jabber.xmpp_stringprep.MappingTableFromFunction.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.xmpp_stringprep.MappingTableFromFunction.__init__
  twisted.words.protocols.jabber.xmpp_stringprep.MappingTableFromFunction.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.xmpp_stringprep.MappingTableFromFunction.map
  twisted.words.protocols.jabber.xmpp_stringprep.MappingTableFromFunction.html#map
  Attribute
  Instance Variable
  PUBLIC
  Return mapping for character.
- twisted.words.protocols.jabber.xmpp_stringprep.EmptyMappingTable
  twisted.words.protocols.jabber.xmpp_stringprep.EmptyMappingTable.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.xmpp_stringprep.EmptyMappingTable.__init__
  twisted.words.protocols.jabber.xmpp_stringprep.EmptyMappingTable.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.xmpp_stringprep.EmptyMappingTable._in_table_function
  twisted.words.protocols.jabber.xmpp_stringprep.EmptyMappingTable.html#_in_table_function
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.words.protocols.jabber.xmpp_stringprep.EmptyMappingTable.map
  twisted.words.protocols.jabber.xmpp_stringprep.EmptyMappingTable.html#map
  Function
  Method
  PUBLIC
  Return mapping for character.
- twisted.words.protocols.jabber.xmpp_stringprep.Profile
  twisted.words.protocols.jabber.xmpp_stringprep.Profile.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.xmpp_stringprep.Profile.__init__
  twisted.words.protocols.jabber.xmpp_stringprep.Profile.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.xmpp_stringprep.Profile.mappings
  twisted.words.protocols.jabber.xmpp_stringprep.Profile.html#mappings
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.xmpp_stringprep.Profile.normalize
  twisted.words.protocols.jabber.xmpp_stringprep.Profile.html#normalize
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.xmpp_stringprep.Profile.prohibiteds
  twisted.words.protocols.jabber.xmpp_stringprep.Profile.html#prohibiteds
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.xmpp_stringprep.Profile.do_check_unassigneds
  twisted.words.protocols.jabber.xmpp_stringprep.Profile.html#do_check_unassigneds
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.xmpp_stringprep.Profile.do_check_bidi
  twisted.words.protocols.jabber.xmpp_stringprep.Profile.html#do_check_bidi
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.xmpp_stringprep.Profile.prepare
  twisted.words.protocols.jabber.xmpp_stringprep.Profile.html#prepare
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.xmpp_stringprep.Profile.map
  twisted.words.protocols.jabber.xmpp_stringprep.Profile.html#map
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.xmpp_stringprep.Profile.check_prohibiteds
  twisted.words.protocols.jabber.xmpp_stringprep.Profile.html#check_prohibiteds
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.xmpp_stringprep.Profile.check_unassigneds
  twisted.words.protocols.jabber.xmpp_stringprep.Profile.html#check_unassigneds
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.xmpp_stringprep.Profile.check_bidirectionals
  twisted.words.protocols.jabber.xmpp_stringprep.Profile.html#check_bidirectionals
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.xmpp_stringprep.NamePrep
  twisted.words.protocols.jabber.xmpp_stringprep.NamePrep.html
  Class
  Class
  PUBLIC
  Implements preparation of internationalized domain names.
- twisted.words.protocols.jabber.xmpp_stringprep.NamePrep.prohibiteds
  twisted.words.protocols.jabber.xmpp_stringprep.NamePrep.html#prohibiteds
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.xmpp_stringprep.NamePrep.prepare
  twisted.words.protocols.jabber.xmpp_stringprep.NamePrep.html#prepare
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.xmpp_stringprep.NamePrep.check_prohibiteds
  twisted.words.protocols.jabber.xmpp_stringprep.NamePrep.html#check_prohibiteds
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.xmpp_stringprep.NamePrep.nameprep
  twisted.words.protocols.jabber.xmpp_stringprep.NamePrep.html#nameprep
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.xmpp_stringprep.C_11
  twisted.words.protocols.jabber.xmpp_stringprep.html#C_11
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.xmpp_stringprep.C_12
  twisted.words.protocols.jabber.xmpp_stringprep.html#C_12
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.xmpp_stringprep.C_21
  twisted.words.protocols.jabber.xmpp_stringprep.html#C_21
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.xmpp_stringprep.C_22
  twisted.words.protocols.jabber.xmpp_stringprep.html#C_22
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.xmpp_stringprep.C_3
  twisted.words.protocols.jabber.xmpp_stringprep.html#C_3
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.xmpp_stringprep.C_4
  twisted.words.protocols.jabber.xmpp_stringprep.html#C_4
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.xmpp_stringprep.C_5
  twisted.words.protocols.jabber.xmpp_stringprep.html#C_5
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.xmpp_stringprep.C_6
  twisted.words.protocols.jabber.xmpp_stringprep.html#C_6
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.xmpp_stringprep.C_7
  twisted.words.protocols.jabber.xmpp_stringprep.html#C_7
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.xmpp_stringprep.C_8
  twisted.words.protocols.jabber.xmpp_stringprep.html#C_8
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.xmpp_stringprep.C_9
  twisted.words.protocols.jabber.xmpp_stringprep.html#C_9
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.xmpp_stringprep.B_1
  twisted.words.protocols.jabber.xmpp_stringprep.html#B_1
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.xmpp_stringprep.B_2
  twisted.words.protocols.jabber.xmpp_stringprep.html#B_2
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.xmpp_stringprep.nodeprep
  twisted.words.protocols.jabber.xmpp_stringprep.html#nodeprep
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.xmpp_stringprep.resourceprep
  twisted.words.protocols.jabber.xmpp_stringprep.html#resourceprep
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.xmpp_stringprep.nameprep
  twisted.words.protocols.jabber.xmpp_stringprep.html#nameprep
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.jid.InvalidFormat
  twisted.words.protocols.jabber.jid.InvalidFormat.html
  Class
  Exception
  PUBLIC
  The given string could not be parsed into a valid Jabber Identifier (JID).
- twisted.words.protocols.jabber.jid.parse
  twisted.words.protocols.jabber.jid.html#parse
  Function
  Function
  PUBLIC
  Parse given JID string into its respective parts and apply stringprep.
- twisted.words.protocols.jabber.jid.prep
  twisted.words.protocols.jabber.jid.html#prep
  Function
  Function
  PUBLIC
  Perform stringprep on all JID fragments.
- twisted.words.protocols.jabber.jid.__internJIDs
  twisted.words.protocols.jabber.jid.html#__internJIDs
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.words.protocols.jabber.jid.internJID
  twisted.words.protocols.jabber.jid.html#internJID
  Function
  Function
  PUBLIC
  Return interned JID.
- twisted.words.protocols.jabber.jid.JID
  twisted.words.protocols.jabber.jid.JID.html
  Class
  Class
  PUBLIC
  Represents a stringprep'd Jabber ID.
- twisted.words.protocols.jabber.jid.JID.__init__
  twisted.words.protocols.jabber.jid.JID.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.jid.JID.user
  twisted.words.protocols.jabber.jid.JID.html#user
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.jid.JID.host
  twisted.words.protocols.jabber.jid.JID.html#host
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.jid.JID.resource
  twisted.words.protocols.jabber.jid.JID.html#resource
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.jid.JID.userhost
  twisted.words.protocols.jabber.jid.JID.html#userhost
  Function
  Method
  PUBLIC
  Extract the bare JID as a unicode string.
- twisted.words.protocols.jabber.jid.JID.userhostJID
  twisted.words.protocols.jabber.jid.JID.html#userhostJID
  Function
  Method
  PUBLIC
  Extract the bare JID.
- twisted.words.protocols.jabber.jid.JID.full
  twisted.words.protocols.jabber.jid.JID.html#full
  Function
  Method
  PUBLIC
  Return the string representation of this JID.
- twisted.words.protocols.jabber.jid.JID.__eq__
  twisted.words.protocols.jabber.jid.JID.html#__eq__
  Function
  Method
  PUBLIC
  Equality comparison.
- twisted.words.protocols.jabber.jid.JID.__hash__
  twisted.words.protocols.jabber.jid.JID.html#__hash__
  Function
  Method
  PUBLIC
  Calculate hash.
- twisted.words.protocols.jabber.jid.JID.__unicode__
  twisted.words.protocols.jabber.jid.JID.html#__unicode__
  Function
  Method
  PUBLIC
  Get unicode representation.
- twisted.words.protocols.jabber.jid.JID.__repr__
  twisted.words.protocols.jabber.jid.JID.html#__repr__
  Function
  Method
  PUBLIC
  Get object representation.
- twisted.words.xish.xpath.LiteralValue
  twisted.words.xish.xpath.LiteralValue.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.words.xish.xpath.LiteralValue.value
  twisted.words.xish.xpath.LiteralValue.html#value
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.xish.xpath.IndexValue
  twisted.words.xish.xpath.IndexValue.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.words.xish.xpath.IndexValue.__init__
  twisted.words.xish.xpath.IndexValue.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.xish.xpath.IndexValue.index
  twisted.words.xish.xpath.IndexValue.html#index
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.xish.xpath.IndexValue.value
  twisted.words.xish.xpath.IndexValue.html#value
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.xish.xpath.AttribValue
  twisted.words.xish.xpath.AttribValue.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.words.xish.xpath.AttribValue.__init__
  twisted.words.xish.xpath.AttribValue.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.xish.xpath.AttribValue.attribname
  twisted.words.xish.xpath.AttribValue.html#attribname
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.xish.xpath.AttribValue.value_ns
  twisted.words.xish.xpath.AttribValue.html#value_ns
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.xish.xpath.AttribValue.value 0
  twisted.words.xish.xpath.AttribValue.html#value%200
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.xish.xpath.AttribValue.value
  twisted.words.xish.xpath.AttribValue.html#value
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.xish.xpath.CompareValue
  twisted.words.xish.xpath.CompareValue.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.words.xish.xpath.CompareValue.__init__
  twisted.words.xish.xpath.CompareValue.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.xish.xpath.CompareValue.lhs
  twisted.words.xish.xpath.CompareValue.html#lhs
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.xish.xpath.CompareValue.rhs
  twisted.words.xish.xpath.CompareValue.html#rhs
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.xish.xpath.CompareValue.value
  twisted.words.xish.xpath.CompareValue.html#value
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.xish.xpath.CompareValue._compareEqual
  twisted.words.xish.xpath.CompareValue.html#_compareEqual
  Function
  Method
  PRIVATE
  Undocumented
- twisted.words.xish.xpath.CompareValue._compareNotEqual
  twisted.words.xish.xpath.CompareValue.html#_compareNotEqual
  Function
  Method
  PRIVATE
  Undocumented
- twisted.words.xish.xpath.BooleanValue
  twisted.words.xish.xpath.BooleanValue.html
  Class
  Class
  PUBLIC
  Provide boolean XPath expression operators.
- twisted.words.xish.xpath.BooleanValue.lhs
  twisted.words.xish.xpath.BooleanValue.html#lhs
  Attribute
  Instance Variable
  PUBLIC
  Left hand side expression of the operator.
- twisted.words.xish.xpath.BooleanValue.op
  twisted.words.xish.xpath.BooleanValue.html#op
  Attribute
  Instance Variable
  PUBLIC
  The operator. One of `'and'`, `'or'`.
- twisted.words.xish.xpath.BooleanValue.rhs
  twisted.words.xish.xpath.BooleanValue.html#rhs
  Attribute
  Instance Variable
  PUBLIC
  Right hand side expression of the operator.
- twisted.words.xish.xpath.BooleanValue.value
  twisted.words.xish.xpath.BooleanValue.html#value
  Attribute
  Instance Variable
  PUBLIC
  Reference to the method that will calculate the value of this expression given an element.
- twisted.words.xish.xpath.BooleanValue.__init__
  twisted.words.xish.xpath.BooleanValue.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.xish.xpath.BooleanValue._booleanAnd
  twisted.words.xish.xpath.BooleanValue.html#_booleanAnd
  Function
  Method
  PRIVATE
  Calculate boolean and of the given expressions given an element.
- twisted.words.xish.xpath.BooleanValue._booleanOr
  twisted.words.xish.xpath.BooleanValue.html#_booleanOr
  Function
  Method
  PRIVATE
  Calculate boolean or of the given expressions given an element.
- twisted.words.xish.xpath.Function
  twisted.words.xish.xpath.html#Function
  Function
  Function
  PUBLIC
  Internal method which selects the function object
- twisted.words.xish.xpath._not_Function
  twisted.words.xish.xpath._not_Function.html
  Class
  Class
  PRIVATE
  Undocumented
- twisted.words.xish.xpath._not_Function.__init__
  twisted.words.xish.xpath._not_Function.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.xish.xpath._not_Function.baseValue
  twisted.words.xish.xpath._not_Function.html#baseValue
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.xish.xpath._not_Function.setParams
  twisted.words.xish.xpath._not_Function.html#setParams
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.xish.xpath._not_Function.value
  twisted.words.xish.xpath._not_Function.html#value
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.xish.xpath._text_Function
  twisted.words.xish.xpath._text_Function.html
  Class
  Class
  PRIVATE
  Undocumented
- twisted.words.xish.xpath._text_Function.setParams
  twisted.words.xish.xpath._text_Function.html#setParams
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.xish.xpath._text_Function.value
  twisted.words.xish.xpath._text_Function.html#value
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.xish.xpath._Location
  twisted.words.xish.xpath._Location.html
  Class
  Class
  PRIVATE
  Undocumented
- twisted.words.xish.xpath._Location.__init__
  twisted.words.xish.xpath._Location.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.xish.xpath._Location.predicates
  twisted.words.xish.xpath._Location.html#predicates
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.xish.xpath._Location.elementName
  twisted.words.xish.xpath._Location.html#elementName
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.xish.xpath._Location.childLocation
  twisted.words.xish.xpath._Location.html#childLocation
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.xish.xpath._Location.matchesPredicates
  twisted.words.xish.xpath._Location.html#matchesPredicates
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.xish.xpath._Location.matches
  twisted.words.xish.xpath._Location.html#matches
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.xish.xpath._Location.queryForString
  twisted.words.xish.xpath._Location.html#queryForString
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.xish.xpath._Location.queryForNodes
  twisted.words.xish.xpath._Location.html#queryForNodes
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.xish.xpath._Location.queryForStringList
  twisted.words.xish.xpath._Location.html#queryForStringList
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.xish.xpath._AnyLocation
  twisted.words.xish.xpath._AnyLocation.html
  Class
  Class
  PRIVATE
  Undocumented
- twisted.words.xish.xpath._AnyLocation.__init__
  twisted.words.xish.xpath._AnyLocation.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.xish.xpath._AnyLocation.predicates
  twisted.words.xish.xpath._AnyLocation.html#predicates
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.xish.xpath._AnyLocation.elementName
  twisted.words.xish.xpath._AnyLocation.html#elementName
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.xish.xpath._AnyLocation.childLocation
  twisted.words.xish.xpath._AnyLocation.html#childLocation
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.xish.xpath._AnyLocation.matchesPredicates
  twisted.words.xish.xpath._AnyLocation.html#matchesPredicates
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.xish.xpath._AnyLocation.listParents
  twisted.words.xish.xpath._AnyLocation.html#listParents
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.xish.xpath._AnyLocation.isRootMatch
  twisted.words.xish.xpath._AnyLocation.html#isRootMatch
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.xish.xpath._AnyLocation.findFirstRootMatch
  twisted.words.xish.xpath._AnyLocation.html#findFirstRootMatch
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.xish.xpath._AnyLocation.matches
  twisted.words.xish.xpath._AnyLocation.html#matches
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.xish.xpath._AnyLocation.queryForString
  twisted.words.xish.xpath._AnyLocation.html#queryForString
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.xish.xpath._AnyLocation.queryForNodes
  twisted.words.xish.xpath._AnyLocation.html#queryForNodes
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.xish.xpath._AnyLocation.queryForStringList
  twisted.words.xish.xpath._AnyLocation.html#queryForStringList
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.xish.xpath.XPathQuery
  twisted.words.xish.xpath.XPathQuery.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.words.xish.xpath.XPathQuery.__init__
  twisted.words.xish.xpath.XPathQuery.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.xish.xpath.XPathQuery.queryStr
  twisted.words.xish.xpath.XPathQuery.html#queryStr
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.xish.xpath.XPathQuery.baseLocation
  twisted.words.xish.xpath.XPathQuery.html#baseLocation
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.xish.xpath.XPathQuery.__hash__
  twisted.words.xish.xpath.XPathQuery.html#__hash__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.xish.xpath.XPathQuery.matches
  twisted.words.xish.xpath.XPathQuery.html#matches
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.xish.xpath.XPathQuery.queryForString
  twisted.words.xish.xpath.XPathQuery.html#queryForString
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.xish.xpath.XPathQuery.queryForNodes
  twisted.words.xish.xpath.XPathQuery.html#queryForNodes
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.xish.xpath.XPathQuery.queryForStringList
  twisted.words.xish.xpath.XPathQuery.html#queryForStringList
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.xish.xpath.__internedQueries
  twisted.words.xish.xpath.html#__internedQueries
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.words.xish.xpath.internQuery
  twisted.words.xish.xpath.html#internQuery
  Function
  Function
  PUBLIC
  Undocumented
- twisted.words.xish.xpath.matches
  twisted.words.xish.xpath.html#matches
  Function
  Function
  PUBLIC
  Undocumented
- twisted.words.xish.xpath.queryForStringList
  twisted.words.xish.xpath.html#queryForStringList
  Function
  Function
  PUBLIC
  Undocumented
- twisted.words.xish.xpath.queryForString
  twisted.words.xish.xpath.html#queryForString
  Function
  Function
  PUBLIC
  Undocumented
- twisted.words.xish.xpath.queryForNodes
  twisted.words.xish.xpath.html#queryForNodes
  Function
  Function
  PUBLIC
  Undocumented
- twisted.words.xish.utility._MethodWrapper
  twisted.words.xish.utility._MethodWrapper.html
  Class
  Class
  PRIVATE
  Internal class for tracking method calls.
- twisted.words.xish.utility._MethodWrapper.__init__
  twisted.words.xish.utility._MethodWrapper.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.xish.utility._MethodWrapper.method
  twisted.words.xish.utility._MethodWrapper.html#method
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.xish.utility._MethodWrapper.args
  twisted.words.xish.utility._MethodWrapper.html#args
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.xish.utility._MethodWrapper.kwargs
  twisted.words.xish.utility._MethodWrapper.html#kwargs
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.xish.utility._MethodWrapper.__call__
  twisted.words.xish.utility._MethodWrapper.html#__call__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.xish.utility.CallbackList
  twisted.words.xish.utility.CallbackList.html
  Class
  Class
  PUBLIC
  Container for callbacks.
- twisted.words.xish.utility.CallbackList.callbacks
  twisted.words.xish.utility.CallbackList.html#callbacks
  Attribute
  Instance Variable
  PUBLIC
  The registered callbacks as mapping from the callable to a tuple of a wrapper for that callable that keeps the callback specific arguments and a boolean that signifies if it is to be called only once.
- twisted.words.xish.utility.CallbackList.__init__
  twisted.words.xish.utility.CallbackList.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.xish.utility.CallbackList.addCallback
  twisted.words.xish.utility.CallbackList.html#addCallback
  Function
  Method
  PUBLIC
  Add callback.
- twisted.words.xish.utility.CallbackList.removeCallback
  twisted.words.xish.utility.CallbackList.html#removeCallback
  Function
  Method
  PUBLIC
  Remove callback.
- twisted.words.xish.utility.CallbackList.callback
  twisted.words.xish.utility.CallbackList.html#callback
  Function
  Method
  PUBLIC
  Call all registered callbacks.
- twisted.words.xish.utility.CallbackList.isEmpty
  twisted.words.xish.utility.CallbackList.html#isEmpty
  Function
  Method
  PUBLIC
  Return if list of registered callbacks is empty.
- twisted.words.xish.utility.EventDispatcher
  twisted.words.xish.utility.EventDispatcher.html
  Class
  Class
  PUBLIC
  Event dispatching service.
- twisted.words.xish.utility.EventDispatcher.__init__
  twisted.words.xish.utility.EventDispatcher.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.xish.utility.EventDispatcher.prefix
  twisted.words.xish.utility.EventDispatcher.html#prefix
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.xish.utility.EventDispatcher._eventObservers
  twisted.words.xish.utility.EventDispatcher.html#_eventObservers
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.words.xish.utility.EventDispatcher._xpathObservers
  twisted.words.xish.utility.EventDispatcher.html#_xpathObservers
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.words.xish.utility.EventDispatcher._dispatchDepth
  twisted.words.xish.utility.EventDispatcher.html#_dispatchDepth
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.words.xish.utility.EventDispatcher._updateQueue
  twisted.words.xish.utility.EventDispatcher.html#_updateQueue
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.words.xish.utility.EventDispatcher._getEventAndObservers
  twisted.words.xish.utility.EventDispatcher.html#_getEventAndObservers
  Function
  Method
  PRIVATE
  Undocumented
- twisted.words.xish.utility.EventDispatcher.addOnetimeObserver
  twisted.words.xish.utility.EventDispatcher.html#addOnetimeObserver
  Function
  Method
  PUBLIC
  Register a one-time observer for an event.
- twisted.words.xish.utility.EventDispatcher.addObserver
  twisted.words.xish.utility.EventDispatcher.html#addObserver
  Function
  Method
  PUBLIC
  Register an observer for an event.
- twisted.words.xish.utility.EventDispatcher._addObserver
  twisted.words.xish.utility.EventDispatcher.html#_addObserver
  Function
  Method
  PRIVATE
  Undocumented
- twisted.words.xish.utility.EventDispatcher.removeObserver
  twisted.words.xish.utility.EventDispatcher.html#removeObserver
  Function
  Method
  PUBLIC
  Remove callable as observer for an event.
- twisted.words.xish.utility.EventDispatcher.dispatch
  twisted.words.xish.utility.EventDispatcher.html#dispatch
  Function
  Method
  PUBLIC
  Dispatch an event.
- twisted.words.xish.utility.XmlPipe
  twisted.words.xish.utility.XmlPipe.html
  Class
  Class
  PUBLIC
  XML stream pipe.
- twisted.words.xish.utility.XmlPipe.source
  twisted.words.xish.utility.XmlPipe.html#source
  Attribute
  Instance Variable
  PUBLIC
  Source XML stream.
- twisted.words.xish.utility.XmlPipe.sink
  twisted.words.xish.utility.XmlPipe.html#sink
  Attribute
  Instance Variable
  PUBLIC
  Sink XML stream.
- twisted.words.xish.utility.XmlPipe.__init__
  twisted.words.xish.utility.XmlPipe.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.xish.xmlstream.XmlStream
  twisted.words.xish.xmlstream.XmlStream.html
  Class
  Class
  PUBLIC
  Generic Streaming XML protocol handler.
- twisted.words.xish.xmlstream.XmlStream.__init__
  twisted.words.xish.xmlstream.XmlStream.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.xish.xmlstream.XmlStream.stream
  twisted.words.xish.xmlstream.XmlStream.html#stream
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.xish.xmlstream.XmlStream.rawDataOutFn
  twisted.words.xish.xmlstream.XmlStream.html#rawDataOutFn
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.xish.xmlstream.XmlStream.rawDataInFn
  twisted.words.xish.xmlstream.XmlStream.html#rawDataInFn
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.xish.xmlstream.XmlStream._initializeStream
  twisted.words.xish.xmlstream.XmlStream.html#_initializeStream
  Function
  Method
  PRIVATE
  Sets up XML Parser.
- twisted.words.xish.xmlstream.XmlStream.connectionMade
  twisted.words.xish.xmlstream.XmlStream.html#connectionMade
  Function
  Method
  PUBLIC
  Called when a connection is made.
- twisted.words.xish.xmlstream.XmlStream.dataReceived
  twisted.words.xish.xmlstream.XmlStream.html#dataReceived
  Function
  Method
  PUBLIC
  Called whenever data is received.
- twisted.words.xish.xmlstream.XmlStream.connectionLost
  twisted.words.xish.xmlstream.XmlStream.html#connectionLost
  Function
  Method
  PUBLIC
  Called when the connection is shut down.
- twisted.words.xish.xmlstream.XmlStream.onDocumentStart
  twisted.words.xish.xmlstream.XmlStream.html#onDocumentStart
  Function
  Method
  PUBLIC
  Called whenever the start tag of a root element has been received.
- twisted.words.xish.xmlstream.XmlStream.onElement
  twisted.words.xish.xmlstream.XmlStream.html#onElement
  Function
  Method
  PUBLIC
  Called whenever a direct child element of the root element has been received.
- twisted.words.xish.xmlstream.XmlStream.onDocumentEnd
  twisted.words.xish.xmlstream.XmlStream.html#onDocumentEnd
  Function
  Method
  PUBLIC
  Called whenever the end tag of the root element has been received.
- twisted.words.xish.xmlstream.XmlStream.setDispatchFn
  twisted.words.xish.xmlstream.XmlStream.html#setDispatchFn
  Function
  Method
  PUBLIC
  Set another function to handle elements.
- twisted.words.xish.xmlstream.XmlStream.resetDispatchFn
  twisted.words.xish.xmlstream.XmlStream.html#resetDispatchFn
  Function
  Method
  PUBLIC
  Set the default function (`onElement`) to handle elements.
- twisted.words.xish.xmlstream.XmlStream.send
  twisted.words.xish.xmlstream.XmlStream.html#send
  Function
  Method
  PUBLIC
  Send data over the stream.
- twisted.words.xish.xmlstream.BootstrapMixin
  twisted.words.xish.xmlstream.BootstrapMixin.html
  Class
  Class
  PUBLIC
  XmlStream factory mixin to install bootstrap event observers.
- twisted.words.xish.xmlstream.BootstrapMixin.bootstraps
  twisted.words.xish.xmlstream.BootstrapMixin.html#bootstraps
  Attribute
  Instance Variable
  PUBLIC
  The list of registered bootstrap event observers.
- twisted.words.xish.xmlstream.BootstrapMixin.__init__
  twisted.words.xish.xmlstream.BootstrapMixin.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.xish.xmlstream.BootstrapMixin.installBootstraps
  twisted.words.xish.xmlstream.BootstrapMixin.html#installBootstraps
  Function
  Method
  PUBLIC
  Install registered bootstrap observers.
- twisted.words.xish.xmlstream.BootstrapMixin.addBootstrap
  twisted.words.xish.xmlstream.BootstrapMixin.html#addBootstrap
  Function
  Method
  PUBLIC
  Add a bootstrap event handler.
- twisted.words.xish.xmlstream.BootstrapMixin.removeBootstrap
  twisted.words.xish.xmlstream.BootstrapMixin.html#removeBootstrap
  Function
  Method
  PUBLIC
  Remove a bootstrap event handler.
- twisted.words.xish.xmlstream.XmlStreamFactoryMixin
  twisted.words.xish.xmlstream.XmlStreamFactoryMixin.html
  Class
  Class
  PUBLIC
  XmlStream factory mixin that takes care of event handlers.
- twisted.words.xish.xmlstream.XmlStreamFactoryMixin.args
  twisted.words.xish.xmlstream.XmlStreamFactoryMixin.html#args
  Attribute
  Instance Variable
  PUBLIC
  Positional arguments passed to the protocol upon instantiation.
- twisted.words.xish.xmlstream.XmlStreamFactoryMixin.kwargs
  twisted.words.xish.xmlstream.XmlStreamFactoryMixin.html#kwargs
  Attribute
  Instance Variable
  PUBLIC
  Keyword arguments passed to the protocol upon instantiation.
- twisted.words.xish.xmlstream.XmlStreamFactoryMixin.__init__
  twisted.words.xish.xmlstream.XmlStreamFactoryMixin.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.xish.xmlstream.XmlStreamFactoryMixin.buildProtocol
  twisted.words.xish.xmlstream.XmlStreamFactoryMixin.html#buildProtocol
  Function
  Method
  PUBLIC
  Create an instance of XmlStream.
- twisted.words.xish.xmlstream.XmlStreamFactory
  twisted.words.xish.xmlstream.XmlStreamFactory.html
  Class
  Class
  PUBLIC
  Factory for XmlStream protocol objects as a reconnection client.
- twisted.words.xish.xmlstream.XmlStreamFactory.buildProtocol
  twisted.words.xish.xmlstream.XmlStreamFactory.html#buildProtocol
  Function
  Method
  PUBLIC
  Create a protocol instance.
- twisted.words.protocols.jabber.xmlstream.STREAM_CONNECTED_EVENT
  twisted.words.protocols.jabber.xmlstream.html#STREAM_CONNECTED_EVENT
  Attribute
  Constant
  PUBLIC
  This event signals that the connection has been established.
- twisted.words.protocols.jabber.xmlstream.STREAM_END_EVENT
  twisted.words.protocols.jabber.xmlstream.html#STREAM_END_EVENT
  Attribute
  Constant
  PUBLIC
  This event signals that the connection has been closed.
- twisted.words.protocols.jabber.xmlstream.STREAM_ERROR_EVENT
  twisted.words.protocols.jabber.xmlstream.html#STREAM_ERROR_EVENT
  Attribute
  Constant
  PUBLIC
  This event signals that a parse error occurred.
- twisted.words.protocols.jabber.xmlstream.STREAM_START_EVENT
  twisted.words.protocols.jabber.xmlstream.html#STREAM_START_EVENT
  Attribute
  Constant
  PUBLIC
  This event signals that the root element of the XML Stream has been received. For XMPP, this would be the `<stream:stream ...>` opening tag.
- twisted.words.protocols.jabber.xmlstream.NS_STREAMS
  twisted.words.protocols.jabber.xmlstream.html#NS_STREAMS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.xmlstream.NS_XMPP_TLS
  twisted.words.protocols.jabber.xmlstream.html#NS_XMPP_TLS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.xmlstream.hashPassword
  twisted.words.protocols.jabber.xmlstream.html#hashPassword
  Function
  Function
  PUBLIC
  Create a SHA1-digest string of a session identifier and password.
- twisted.words.protocols.jabber.xmlstream.Authenticator
  twisted.words.protocols.jabber.xmlstream.Authenticator.html
  Class
  Class
  PUBLIC
  Base class for business logic of initializing an XmlStream
- twisted.words.protocols.jabber.xmlstream.Authenticator.xmlstream
  twisted.words.protocols.jabber.xmlstream.Authenticator.html#xmlstream
  Attribute
  Instance Variable
  PUBLIC
  The XmlStream that needs authentication
- twisted.words.protocols.jabber.xmlstream.Authenticator.__init__
  twisted.words.protocols.jabber.xmlstream.Authenticator.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.xmlstream.Authenticator.connectionMade
  twisted.words.protocols.jabber.xmlstream.Authenticator.html#connectionMade
  Function
  Method
  PUBLIC
  Called by the XmlStream when the underlying socket connection is in place.
- twisted.words.protocols.jabber.xmlstream.Authenticator.streamStarted
  twisted.words.protocols.jabber.xmlstream.Authenticator.html#streamStarted
  Function
  Method
  PUBLIC
  Called by the XmlStream when the stream has started.
- twisted.words.protocols.jabber.xmlstream.Authenticator.associateWithStream
  twisted.words.protocols.jabber.xmlstream.Authenticator.html#associateWithStream
  Function
  Method
  PUBLIC
  Called by the XmlStreamFactory when a connection has been made to the requested peer, and an XmlStream object has been instantiated.
- twisted.words.protocols.jabber.xmlstream.ConnectAuthenticator
  twisted.words.protocols.jabber.xmlstream.ConnectAuthenticator.html
  Class
  Class
  PUBLIC
  Authenticator for initiating entities.
- twisted.words.protocols.jabber.xmlstream.ConnectAuthenticator.namespace
  twisted.words.protocols.jabber.xmlstream.ConnectAuthenticator.html#namespace
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.xmlstream.ConnectAuthenticator.__init__
  twisted.words.protocols.jabber.xmlstream.ConnectAuthenticator.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.xmlstream.ConnectAuthenticator.otherHost
  twisted.words.protocols.jabber.xmlstream.ConnectAuthenticator.html#otherHost
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.xmlstream.ConnectAuthenticator.connectionMade
  twisted.words.protocols.jabber.xmlstream.ConnectAuthenticator.html#connectionMade
  Function
  Method
  PUBLIC
  Called by the XmlStream when the underlying socket connection is in place.
- twisted.words.protocols.jabber.xmlstream.ConnectAuthenticator.initializeStream
  twisted.words.protocols.jabber.xmlstream.ConnectAuthenticator.html#initializeStream
  Function
  Method
  PUBLIC
  Perform stream initialization procedures.
- twisted.words.protocols.jabber.xmlstream.ConnectAuthenticator.streamStarted
  twisted.words.protocols.jabber.xmlstream.ConnectAuthenticator.html#streamStarted
  Function
  Method
  PUBLIC
  Called by the XmlStream when the stream has started.
- twisted.words.protocols.jabber.xmlstream.ListenAuthenticator
  twisted.words.protocols.jabber.xmlstream.ListenAuthenticator.html
  Class
  Class
  PUBLIC
  Authenticator for receiving entities.
- twisted.words.protocols.jabber.xmlstream.ListenAuthenticator.namespace
  twisted.words.protocols.jabber.xmlstream.ListenAuthenticator.html#namespace
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.xmlstream.ListenAuthenticator.associateWithStream
  twisted.words.protocols.jabber.xmlstream.ListenAuthenticator.html#associateWithStream
  Function
  Method
  PUBLIC
  Called by the XmlStreamFactory when a connection has been made.
- twisted.words.protocols.jabber.xmlstream.ListenAuthenticator.streamStarted
  twisted.words.protocols.jabber.xmlstream.ListenAuthenticator.html#streamStarted
  Function
  Method
  PUBLIC
  Called by the XmlStream when the stream has started.
- twisted.words.protocols.jabber.xmlstream.FeatureNotAdvertized
  twisted.words.protocols.jabber.xmlstream.FeatureNotAdvertized.html
  Class
  Exception
  PUBLIC
  Exception indicating a stream feature was not advertized, while required by the initiating entity.
- twisted.words.protocols.jabber.xmlstream.BaseFeatureInitiatingInitializer
  twisted.words.protocols.jabber.xmlstream.BaseFeatureInitiatingInitializer.html
  Class
  Class
  PUBLIC
  Base class for initializers with a stream feature.
- twisted.words.protocols.jabber.xmlstream.BaseFeatureInitiatingInitializer.feature
  twisted.words.protocols.jabber.xmlstream.BaseFeatureInitiatingInitializer.html#feature
  Attribute
  Class Variable
  PUBLIC
  tuple of (uri, name) of the stream feature root element.
- twisted.words.protocols.jabber.xmlstream.BaseFeatureInitiatingInitializer.required
  twisted.words.protocols.jabber.xmlstream.BaseFeatureInitiatingInitializer.html#required
  Attribute
  Instance Variable
  PUBLIC
  whether the stream feature is required to be advertized by the receiving entity.
- twisted.words.protocols.jabber.xmlstream.BaseFeatureInitiatingInitializer.__init__
  twisted.words.protocols.jabber.xmlstream.BaseFeatureInitiatingInitializer.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.xmlstream.BaseFeatureInitiatingInitializer.xmlstream
  twisted.words.protocols.jabber.xmlstream.BaseFeatureInitiatingInitializer.html#xmlstream
  Attribute
  Instance Variable
  PUBLIC
  The associated XML stream
- twisted.words.protocols.jabber.xmlstream.BaseFeatureInitiatingInitializer.initialize
  twisted.words.protocols.jabber.xmlstream.BaseFeatureInitiatingInitializer.html#initialize
  Function
  Method
  PUBLIC
  Initiate the initialization.
- twisted.words.protocols.jabber.xmlstream.BaseFeatureInitiatingInitializer.start
  twisted.words.protocols.jabber.xmlstream.BaseFeatureInitiatingInitializer.html#start
  Function
  Method
  PUBLIC
  Start the actual initialization.
- twisted.words.protocols.jabber.xmlstream.TLSError
  twisted.words.protocols.jabber.xmlstream.TLSError.html
  Class
  Exception
  PUBLIC
  TLS base exception.
- twisted.words.protocols.jabber.xmlstream.TLSFailed
  twisted.words.protocols.jabber.xmlstream.TLSFailed.html
  Class
  Exception
  PUBLIC
  Exception indicating failed TLS negotiation
- twisted.words.protocols.jabber.xmlstream.TLSRequired
  twisted.words.protocols.jabber.xmlstream.TLSRequired.html
  Class
  Exception
  PUBLIC
  Exception indicating required TLS negotiation.
- twisted.words.protocols.jabber.xmlstream.TLSNotSupported
  twisted.words.protocols.jabber.xmlstream.TLSNotSupported.html
  Class
  Exception
  PUBLIC
  Exception indicating missing TLS support.
- twisted.words.protocols.jabber.xmlstream.TLSInitiatingInitializer
  twisted.words.protocols.jabber.xmlstream.TLSInitiatingInitializer.html
  Class
  Class
  PUBLIC
  TLS stream initializer for the initiating entity.
- twisted.words.protocols.jabber.xmlstream.TLSInitiatingInitializer.wanted
  twisted.words.protocols.jabber.xmlstream.TLSInitiatingInitializer.html#wanted
  Attribute
  Instance Variable
  PUBLIC
  indicates if TLS negotiation is wanted.
- twisted.words.protocols.jabber.xmlstream.TLSInitiatingInitializer.feature
  twisted.words.protocols.jabber.xmlstream.TLSInitiatingInitializer.html#feature
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.xmlstream.TLSInitiatingInitializer._deferred
  twisted.words.protocols.jabber.xmlstream.TLSInitiatingInitializer.html#_deferred
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.words.protocols.jabber.xmlstream.TLSInitiatingInitializer._configurationForTLS
  twisted.words.protocols.jabber.xmlstream.TLSInitiatingInitializer.html#_configurationForTLS
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.words.protocols.jabber.xmlstream.TLSInitiatingInitializer.__init__
  twisted.words.protocols.jabber.xmlstream.TLSInitiatingInitializer.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.words.protocols.jabber.xmlstream.TLSInitiatingInitializer.onProceed
  twisted.words.protocols.jabber.xmlstream.TLSInitiatingInitializer.html#onProceed
  Function
  Method
  PUBLIC
  Proceed with TLS negotiation and reset the XML stream.
- twisted.words.protocols.jabber.xmlstream.TLSInitiatingInitializer.onFailure
  twisted.words.protocols.jabber.xmlstream.TLSInitiatingInitializer.html#onFailure
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.xmlstream.TLSInitiatingInitializer.start
  twisted.words.protocols.jabber.xmlstream.TLSInitiatingInitializer.html#start
  Function
  Method
  PUBLIC
  Start TLS negotiation.
- twisted.words.protocols.jabber.xmlstream.XmlStream
  twisted.words.protocols.jabber.xmlstream.XmlStream.html
  Class
  Class
  PUBLIC
  XMPP XML Stream protocol handler.
- twisted.words.protocols.jabber.xmlstream.XmlStream.version
  twisted.words.protocols.jabber.xmlstream.XmlStream.html#version
  Attribute
  Instance Variable
  PUBLIC
  XML stream version as a tuple (major, minor). Initially, this is set to the minimally supported version. Upon receiving the stream header of the peer, it is set to the minimum of that value and the version on the received header.
- twisted.words.protocols.jabber.xmlstream.XmlStream.namespace
  twisted.words.protocols.jabber.xmlstream.XmlStream.html#namespace
  Attribute
  Instance Variable
  PUBLIC
  default namespace URI for stream
- twisted.words.protocols.jabber.xmlstream.XmlStream.thisEntity
  twisted.words.protocols.jabber.xmlstream.XmlStream.html#thisEntity
  Attribute
  Instance Variable
  PUBLIC
  JID of this entity
- twisted.words.protocols.jabber.xmlstream.XmlStream.otherEntity
  twisted.words.protocols.jabber.xmlstream.XmlStream.html#otherEntity
  Attribute
  Instance Variable
  PUBLIC
  JID of the peer entity
- twisted.words.protocols.jabber.xmlstream.XmlStream.sid
  twisted.words.protocols.jabber.xmlstream.XmlStream.html#sid
  Attribute
  Instance Variable
  PUBLIC
  session identifier
- twisted.words.protocols.jabber.xmlstream.XmlStream.initiating
  twisted.words.protocols.jabber.xmlstream.XmlStream.html#initiating
  Attribute
  Instance Variable
  PUBLIC
  True if this is the initiating stream
- twisted.words.protocols.jabber.xmlstream.XmlStream.features
  twisted.words.protocols.jabber.xmlstream.XmlStream.html#features
  Attribute
  Instance Variable
  PUBLIC
  map of (uri, name) to stream features element received from the receiving entity.
- twisted.words.protocols.jabber.xmlstream.XmlStream.prefixes
  twisted.words.protocols.jabber.xmlstream.XmlStream.html#prefixes
  Attribute
  Instance Variable
  PUBLIC
  map of URI to prefixes that are to appear on stream header.
- twisted.words.protocols.jabber.xmlstream.XmlStream.initializers
  twisted.words.protocols.jabber.xmlstream.XmlStream.html#initializers
  Attribute
  Instance Variable
  PUBLIC
  list of stream initializer objects
- twisted.words.protocols.jabber.xmlstream.XmlStream.authenticator
  twisted.words.protocols.jabber.xmlstream.XmlStream.html#authenticator
  Attribute
  Instance Variable
  PUBLIC
  associated authenticator that uses `initializers` to initialize the XML stream.
- twisted.words.protocols.jabber.xmlstream.XmlStream._headerSent
  twisted.words.protocols.jabber.xmlstream.XmlStream.html#_headerSent
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.words.protocols.jabber.xmlstream.XmlStream.__init__
  twisted.words.protocols.jabber.xmlstream.XmlStream.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.xmlstream.XmlStream._callLater
  twisted.words.protocols.jabber.xmlstream.XmlStream.html#_callLater
  Function
  Method
  PRIVATE
  Undocumented
- twisted.words.protocols.jabber.xmlstream.XmlStream.reset
  twisted.words.protocols.jabber.xmlstream.XmlStream.html#reset
  Function
  Method
  PUBLIC
  Reset XML Stream.
- twisted.words.protocols.jabber.xmlstream.XmlStream.onStreamError
  twisted.words.protocols.jabber.xmlstream.XmlStream.html#onStreamError
  Function
  Method
  PUBLIC
  Called when a stream:error element has been received.
- twisted.words.protocols.jabber.xmlstream.XmlStream.sendHeader
  twisted.words.protocols.jabber.xmlstream.XmlStream.html#sendHeader
  Function
  Method
  PUBLIC
  Send stream header.
- twisted.words.protocols.jabber.xmlstream.XmlStream.sendFooter
  twisted.words.protocols.jabber.xmlstream.XmlStream.html#sendFooter
  Function
  Method
  PUBLIC
  Send stream footer.
- twisted.words.protocols.jabber.xmlstream.XmlStream.sendStreamError
  twisted.words.protocols.jabber.xmlstream.XmlStream.html#sendStreamError
  Function
  Method
  PUBLIC
  Send stream level error.
- twisted.words.protocols.jabber.xmlstream.XmlStream.send
  twisted.words.protocols.jabber.xmlstream.XmlStream.html#send
  Function
  Method
  PUBLIC
  Send data over the stream.
- twisted.words.protocols.jabber.xmlstream.XmlStream.connectionMade
  twisted.words.protocols.jabber.xmlstream.XmlStream.html#connectionMade
  Function
  Method
  PUBLIC
  Called when a connection is made.
- twisted.words.protocols.jabber.xmlstream.XmlStream.onDocumentStart
  twisted.words.protocols.jabber.xmlstream.XmlStream.html#onDocumentStart
  Function
  Method
  PUBLIC
  Called when the stream header has been received.
- twisted.words.protocols.jabber.xmlstream.XmlStreamFactory
  twisted.words.protocols.jabber.xmlstream.XmlStreamFactory.html
  Class
  Class
  PUBLIC
  Factory for Jabber XmlStream objects as a reconnecting client.
- twisted.words.protocols.jabber.xmlstream.XmlStreamFactory.__init__
  twisted.words.protocols.jabber.xmlstream.XmlStreamFactory.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.xmlstream.XmlStreamFactory.authenticator
  twisted.words.protocols.jabber.xmlstream.XmlStreamFactory.html#authenticator
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.xmlstream.XmlStreamServerFactory
  twisted.words.protocols.jabber.xmlstream.XmlStreamServerFactory.html
  Class
  Class
  PUBLIC
  Factory for Jabber XmlStream objects as a server.
- twisted.words.protocols.jabber.xmlstream.XmlStreamServerFactory.authenticatorFactory
  twisted.words.protocols.jabber.xmlstream.XmlStreamServerFactory.html#authenticatorFactory
  Attribute
  Instance Variable
  PUBLIC
  Factory callable that takes no arguments, to create a fresh authenticator to be associated with the XmlStream.
- twisted.words.protocols.jabber.xmlstream.XmlStreamServerFactory.__init__
  twisted.words.protocols.jabber.xmlstream.XmlStreamServerFactory.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.xmlstream.XmlStreamServerFactory.buildProtocol
  twisted.words.protocols.jabber.xmlstream.XmlStreamServerFactory.html#buildProtocol
  Function
  Method
  PUBLIC
  Create an instance of XmlStream.
- twisted.words.protocols.jabber.xmlstream.TimeoutError
  twisted.words.protocols.jabber.xmlstream.TimeoutError.html
  Class
  Exception
  PUBLIC
  Exception raised when no IQ response has been received before the configured timeout.
- twisted.words.protocols.jabber.xmlstream.upgradeWithIQResponseTracker
  twisted.words.protocols.jabber.xmlstream.html#upgradeWithIQResponseTracker
  Function
  Function
  PUBLIC
  Enhances an XmlStream for iq response tracking.
- twisted.words.protocols.jabber.xmlstream.IQ
  twisted.words.protocols.jabber.xmlstream.IQ.html
  Class
  Class
  PUBLIC
  Wrapper for an iq stanza.
- twisted.words.protocols.jabber.xmlstream.IQ.timeout
  twisted.words.protocols.jabber.xmlstream.IQ.html#timeout
  Attribute
  Instance Variable
  PUBLIC
  if set, a timeout period after which the deferred returned by `send` will have its errback called with a `TimeoutError` failure.
- twisted.words.protocols.jabber.xmlstream.IQ.__init__
  twisted.words.protocols.jabber.xmlstream.IQ.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.words.protocols.jabber.xmlstream.IQ._xmlstream
  twisted.words.protocols.jabber.xmlstream.IQ.html#_xmlstream
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.words.protocols.jabber.xmlstream.IQ.send
  twisted.words.protocols.jabber.xmlstream.IQ.html#send
  Function
  Method
  PUBLIC
  Send out this iq.
- twisted.words.protocols.jabber.xmlstream.toResponse
  twisted.words.protocols.jabber.xmlstream.html#toResponse
  Function
  Function
  PUBLIC
  Create a response stanza from another stanza.
- twisted.words.protocols.jabber.xmlstream.XMPPHandler
  twisted.words.protocols.jabber.xmlstream.XMPPHandler.html
  Class
  Class
  PUBLIC
  XMPP protocol handler.
- twisted.words.protocols.jabber.xmlstream.XMPPHandler.__init__
  twisted.words.protocols.jabber.xmlstream.XMPPHandler.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.xmlstream.XMPPHandler.parent
  twisted.words.protocols.jabber.xmlstream.XMPPHandler.html#parent
  Attribute
  Instance Variable
  PUBLIC
  XML stream manager for this handler
- twisted.words.protocols.jabber.xmlstream.XMPPHandler.xmlstream
  twisted.words.protocols.jabber.xmlstream.XMPPHandler.html#xmlstream
  Attribute
  Instance Variable
  PUBLIC
  The managed XML stream
- twisted.words.protocols.jabber.xmlstream.XMPPHandler.setHandlerParent
  twisted.words.protocols.jabber.xmlstream.XMPPHandler.html#setHandlerParent
  Function
  Method
  PUBLIC
  Set the parent of the handler.
- twisted.words.protocols.jabber.xmlstream.XMPPHandler.disownHandlerParent
  twisted.words.protocols.jabber.xmlstream.XMPPHandler.html#disownHandlerParent
  Function
  Method
  PUBLIC
  Remove the parent of the handler.
- twisted.words.protocols.jabber.xmlstream.XMPPHandler.makeConnection
  twisted.words.protocols.jabber.xmlstream.XMPPHandler.html#makeConnection
  Function
  Method
  PUBLIC
  A connection over the underlying transport of the XML stream has been established.
- twisted.words.protocols.jabber.xmlstream.XMPPHandler.connectionMade
  twisted.words.protocols.jabber.xmlstream.XMPPHandler.html#connectionMade
  Function
  Method
  PUBLIC
  Called after a connection has been established.
- twisted.words.protocols.jabber.xmlstream.XMPPHandler.connectionInitialized
  twisted.words.protocols.jabber.xmlstream.XMPPHandler.html#connectionInitialized
  Function
  Method
  PUBLIC
  The XML stream has been initialized.
- twisted.words.protocols.jabber.xmlstream.XMPPHandler.connectionLost
  twisted.words.protocols.jabber.xmlstream.XMPPHandler.html#connectionLost
  Function
  Method
  PUBLIC
  The XML stream has been closed.
- twisted.words.protocols.jabber.xmlstream.XMPPHandler.send
  twisted.words.protocols.jabber.xmlstream.XMPPHandler.html#send
  Function
  Method
  PUBLIC
  Send data over the managed XML stream.
- twisted.words.protocols.jabber.xmlstream.XMPPHandlerCollection
  twisted.words.protocols.jabber.xmlstream.XMPPHandlerCollection.html
  Class
  Class
  PUBLIC
  Collection of XMPP subprotocol handlers.
- twisted.words.protocols.jabber.xmlstream.XMPPHandlerCollection.handlers
  twisted.words.protocols.jabber.xmlstream.XMPPHandlerCollection.html#handlers
  Attribute
  Instance Variable
  PUBLIC
  List of protocol handlers.
- twisted.words.protocols.jabber.xmlstream.XMPPHandlerCollection.__init__
  twisted.words.protocols.jabber.xmlstream.XMPPHandlerCollection.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.xmlstream.XMPPHandlerCollection.__iter__
  twisted.words.protocols.jabber.xmlstream.XMPPHandlerCollection.html#__iter__
  Function
  Method
  PUBLIC
  Act as a container for handlers.
- twisted.words.protocols.jabber.xmlstream.XMPPHandlerCollection.addHandler
  twisted.words.protocols.jabber.xmlstream.XMPPHandlerCollection.html#addHandler
  Function
  Method
  PUBLIC
  Add protocol handler.
- twisted.words.protocols.jabber.xmlstream.XMPPHandlerCollection.removeHandler
  twisted.words.protocols.jabber.xmlstream.XMPPHandlerCollection.html#removeHandler
  Function
  Method
  PUBLIC
  Remove protocol handler.
- twisted.words.protocols.jabber.xmlstream.StreamManager
  twisted.words.protocols.jabber.xmlstream.StreamManager.html
  Class
  Class
  PUBLIC
  Business logic representing a managed XMPP connection.
- twisted.words.protocols.jabber.xmlstream.StreamManager.xmlstream
  twisted.words.protocols.jabber.xmlstream.StreamManager.html#xmlstream
  Attribute
  Instance Variable
  PUBLIC
  currently managed XML stream
- twisted.words.protocols.jabber.xmlstream.StreamManager.logTraffic
  twisted.words.protocols.jabber.xmlstream.StreamManager.html#logTraffic
  Attribute
  Instance Variable
  PUBLIC
  if true, log all traffic.
- twisted.words.protocols.jabber.xmlstream.StreamManager._initialized
  twisted.words.protocols.jabber.xmlstream.StreamManager.html#_initialized
  Attribute
  Instance Variable
  PRIVATE
  Whether the stream represented by `xmlstream` has been initialized. This is used when caching outgoing stanzas.
- twisted.words.protocols.jabber.xmlstream.StreamManager._packetQueue
  twisted.words.protocols.jabber.xmlstream.StreamManager.html#_packetQueue
  Attribute
  Instance Variable
  PRIVATE
  internal buffer of unsent data. See `send` for details.
- twisted.words.protocols.jabber.xmlstream.StreamManager.__init__
  twisted.words.protocols.jabber.xmlstream.StreamManager.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.xmlstream.StreamManager.factory
  twisted.words.protocols.jabber.xmlstream.StreamManager.html#factory
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.xmlstream.StreamManager.addHandler
  twisted.words.protocols.jabber.xmlstream.StreamManager.html#addHandler
  Function
  Method
  PUBLIC
  Add protocol handler.
- twisted.words.protocols.jabber.xmlstream.StreamManager._connected
  twisted.words.protocols.jabber.xmlstream.StreamManager.html#_connected
  Function
  Method
  PRIVATE
  Called when the transport connection has been established.
- twisted.words.protocols.jabber.xmlstream.StreamManager._authd
  twisted.words.protocols.jabber.xmlstream.StreamManager.html#_authd
  Function
  Method
  PRIVATE
  Called when the stream has been initialized.
- twisted.words.protocols.jabber.xmlstream.StreamManager.initializationFailed
  twisted.words.protocols.jabber.xmlstream.StreamManager.html#initializationFailed
  Function
  Method
  PUBLIC
  Called when stream initialization has failed.
- twisted.words.protocols.jabber.xmlstream.StreamManager._disconnected
  twisted.words.protocols.jabber.xmlstream.StreamManager.html#_disconnected
  Function
  Method
  PRIVATE
  Called when the stream has been closed.
- twisted.words.protocols.jabber.xmlstream.StreamManager.send
  twisted.words.protocols.jabber.xmlstream.StreamManager.html#send
  Function
  Method
  PUBLIC
  Send data over the XML stream.
- twisted.words.protocols.jabber.sasl.NS_XMPP_SASL
  twisted.words.protocols.jabber.sasl.html#NS_XMPP_SASL
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.sasl.get_mechanisms
  twisted.words.protocols.jabber.sasl.html#get_mechanisms
  Function
  Function
  PUBLIC
  Parse the SASL feature to extract the available mechanism names.
- twisted.words.protocols.jabber.sasl.SASLError
  twisted.words.protocols.jabber.sasl.SASLError.html
  Class
  Exception
  PUBLIC
  SASL base exception.
- twisted.words.protocols.jabber.sasl.SASLNoAcceptableMechanism
  twisted.words.protocols.jabber.sasl.SASLNoAcceptableMechanism.html
  Class
  Exception
  PUBLIC
  The server did not present an acceptable SASL mechanism.
- twisted.words.protocols.jabber.sasl.SASLAuthError
  twisted.words.protocols.jabber.sasl.SASLAuthError.html
  Class
  Exception
  PUBLIC
  SASL Authentication failed.
- twisted.words.protocols.jabber.sasl.SASLAuthError.__init__
  twisted.words.protocols.jabber.sasl.SASLAuthError.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.sasl.SASLAuthError.condition
  twisted.words.protocols.jabber.sasl.SASLAuthError.html#condition
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.sasl.SASLAuthError.__str__
  twisted.words.protocols.jabber.sasl.SASLAuthError.html#__str__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.sasl.SASLIncorrectEncodingError
  twisted.words.protocols.jabber.sasl.SASLIncorrectEncodingError.html
  Class
  Exception
  PUBLIC
  SASL base64 encoding was incorrect.
- twisted.words.protocols.jabber.sasl.base64Pattern
  twisted.words.protocols.jabber.sasl.html#base64Pattern
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.sasl.fromBase64
  twisted.words.protocols.jabber.sasl.html#fromBase64
  Function
  Function
  PUBLIC
  Decode base64 encoded string.
- twisted.words.protocols.jabber.sasl.SASLInitiatingInitializer
  twisted.words.protocols.jabber.sasl.SASLInitiatingInitializer.html
  Class
  Class
  PUBLIC
  Stream initializer that performs SASL authentication.
- twisted.words.protocols.jabber.sasl.SASLInitiatingInitializer.feature
  twisted.words.protocols.jabber.sasl.SASLInitiatingInitializer.html#feature
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.sasl.SASLInitiatingInitializer._deferred
  twisted.words.protocols.jabber.sasl.SASLInitiatingInitializer.html#_deferred
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.words.protocols.jabber.sasl.SASLInitiatingInitializer.setMechanism
  twisted.words.protocols.jabber.sasl.SASLInitiatingInitializer.html#setMechanism
  Function
  Method
  PUBLIC
  Select and setup authentication mechanism.
- twisted.words.protocols.jabber.sasl.SASLInitiatingInitializer.mechanism
  twisted.words.protocols.jabber.sasl.SASLInitiatingInitializer.html#mechanism
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.sasl.SASLInitiatingInitializer.start
  twisted.words.protocols.jabber.sasl.SASLInitiatingInitializer.html#start
  Function
  Method
  PUBLIC
  Start SASL authentication exchange.
- twisted.words.protocols.jabber.sasl.SASLInitiatingInitializer.sendAuth
  twisted.words.protocols.jabber.sasl.SASLInitiatingInitializer.html#sendAuth
  Function
  Method
  PUBLIC
  Initiate authentication protocol exchange.
- twisted.words.protocols.jabber.sasl.SASLInitiatingInitializer.sendResponse
  twisted.words.protocols.jabber.sasl.SASLInitiatingInitializer.html#sendResponse
  Function
  Method
  PUBLIC
  Send response to a challenge.
- twisted.words.protocols.jabber.sasl.SASLInitiatingInitializer.onChallenge
  twisted.words.protocols.jabber.sasl.SASLInitiatingInitializer.html#onChallenge
  Function
  Method
  PUBLIC
  Parse challenge and send response from the mechanism.
- twisted.words.protocols.jabber.sasl.SASLInitiatingInitializer.onSuccess
  twisted.words.protocols.jabber.sasl.SASLInitiatingInitializer.html#onSuccess
  Function
  Method
  PUBLIC
  Clean up observers, reset the XML stream and send a new header.
- twisted.words.protocols.jabber.sasl.SASLInitiatingInitializer.onFailure
  twisted.words.protocols.jabber.sasl.SASLInitiatingInitializer.html#onFailure
  Function
  Method
  PUBLIC
  Clean up observers, parse the failure and errback the deferred.
- twisted.words.protocols.jabber.client.NS_XMPP_STREAMS
  twisted.words.protocols.jabber.client.html#NS_XMPP_STREAMS
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.client.NS_XMPP_BIND
  twisted.words.protocols.jabber.client.html#NS_XMPP_BIND
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.client.NS_XMPP_SESSION
  twisted.words.protocols.jabber.client.html#NS_XMPP_SESSION
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.client.NS_IQ_AUTH_FEATURE
  twisted.words.protocols.jabber.client.html#NS_IQ_AUTH_FEATURE
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.client.DigestAuthQry
  twisted.words.protocols.jabber.client.html#DigestAuthQry
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.client.PlaintextAuthQry
  twisted.words.protocols.jabber.client.html#PlaintextAuthQry
  Attribute
  Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.client.basicClientFactory
  twisted.words.protocols.jabber.client.html#basicClientFactory
  Function
  Function
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.client.IQ
  twisted.words.protocols.jabber.client.IQ.html
  Class
  Class
  PUBLIC
  Wrapper for a Info/Query packet.
- twisted.words.protocols.jabber.client.IQ.callbacks
  twisted.words.protocols.jabber.client.IQ.html#callbacks
  Attribute
  Instance Variable
  PUBLIC
  Callback list to be notified when response comes back
- twisted.words.protocols.jabber.client.IQ.__init__
  twisted.words.protocols.jabber.client.IQ.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.words.protocols.jabber.client.IQ._xmlstream
  twisted.words.protocols.jabber.client.IQ.html#_xmlstream
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.words.protocols.jabber.client.IQ.addCallback
  twisted.words.protocols.jabber.client.IQ.html#addCallback
  Function
  Method
  PUBLIC
  Register a callback for notification when the IQ result is available.
- twisted.words.protocols.jabber.client.IQ.send
  twisted.words.protocols.jabber.client.IQ.html#send
  Function
  Method
  PUBLIC
  Call this method to send this IQ request via the associated XmlStream.
- twisted.words.protocols.jabber.client.IQ._resultEvent
  twisted.words.protocols.jabber.client.IQ.html#_resultEvent
  Function
  Method
  PRIVATE
  Undocumented
- twisted.words.protocols.jabber.client.IQAuthInitializer
  twisted.words.protocols.jabber.client.IQAuthInitializer.html
  Class
  Class
  PUBLIC
  Non-SASL Authentication initializer for the initiating entity.
- twisted.words.protocols.jabber.client.IQAuthInitializer.INVALID_USER_EVENT
  twisted.words.protocols.jabber.client.IQAuthInitializer.html#INVALID_USER_EVENT
  Attribute
  Constant
  PUBLIC
  Token to signal that authentication failed, due to invalid username.
- twisted.words.protocols.jabber.client.IQAuthInitializer.AUTH_FAILED_EVENT
  twisted.words.protocols.jabber.client.IQAuthInitializer.html#AUTH_FAILED_EVENT
  Attribute
  Constant
  PUBLIC
  Token to signal that authentication failed, due to invalid password.
- twisted.words.protocols.jabber.client.IQAuthInitializer.__init__
  twisted.words.protocols.jabber.client.IQAuthInitializer.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.client.IQAuthInitializer.xmlstream
  twisted.words.protocols.jabber.client.IQAuthInitializer.html#xmlstream
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.client.IQAuthInitializer.initialize
  twisted.words.protocols.jabber.client.IQAuthInitializer.html#initialize
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.client.IQAuthInitializer._cbAuthQuery
  twisted.words.protocols.jabber.client.IQAuthInitializer.html#_cbAuthQuery
  Function
  Method
  PRIVATE
  Undocumented
- twisted.words.protocols.jabber.client.IQAuthInitializer._ebAuthQuery
  twisted.words.protocols.jabber.client.IQAuthInitializer.html#_ebAuthQuery
  Function
  Method
  PRIVATE
  Undocumented
- twisted.words.protocols.jabber.client.IQAuthInitializer._cbAuth
  twisted.words.protocols.jabber.client.IQAuthInitializer.html#_cbAuth
  Function
  Method
  PRIVATE
  Undocumented
- twisted.words.protocols.jabber.client.IQAuthInitializer._ebAuth
  twisted.words.protocols.jabber.client.IQAuthInitializer.html#_ebAuth
  Function
  Method
  PRIVATE
  Undocumented
- twisted.words.protocols.jabber.client.BasicAuthenticator
  twisted.words.protocols.jabber.client.BasicAuthenticator.html
  Class
  Class
  PUBLIC
  Authenticates an XmlStream against a Jabber server as a Client.
- twisted.words.protocols.jabber.client.BasicAuthenticator.INVALID_USER_EVENT
  twisted.words.protocols.jabber.client.BasicAuthenticator.html#INVALID_USER_EVENT
  Attribute
  Constant
  PUBLIC
  See `IQAuthInitializer.INVALID_USER_EVENT`.
- twisted.words.protocols.jabber.client.BasicAuthenticator.AUTH_FAILED_EVENT
  twisted.words.protocols.jabber.client.BasicAuthenticator.html#AUTH_FAILED_EVENT
  Attribute
  Constant
  PUBLIC
  See `IQAuthInitializer.AUTH_FAILED_EVENT`.
- twisted.words.protocols.jabber.client.BasicAuthenticator.REGISTER_FAILED_EVENT
  twisted.words.protocols.jabber.client.BasicAuthenticator.html#REGISTER_FAILED_EVENT
  Attribute
  Constant
  PUBLIC
  Token to signal that registration failed.
- twisted.words.protocols.jabber.client.BasicAuthenticator.namespace
  twisted.words.protocols.jabber.client.BasicAuthenticator.html#namespace
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.client.BasicAuthenticator.__init__
  twisted.words.protocols.jabber.client.BasicAuthenticator.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.client.BasicAuthenticator.jid
  twisted.words.protocols.jabber.client.BasicAuthenticator.html#jid
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.client.BasicAuthenticator.password
  twisted.words.protocols.jabber.client.BasicAuthenticator.html#password
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.client.BasicAuthenticator.associateWithStream
  twisted.words.protocols.jabber.client.BasicAuthenticator.html#associateWithStream
  Function
  Method
  PUBLIC
  Called by the XmlStreamFactory when a connection has been made to the requested peer, and an XmlStream object has been instantiated.
- twisted.words.protocols.jabber.client.BasicAuthenticator.registerAccount
  twisted.words.protocols.jabber.client.BasicAuthenticator.html#registerAccount
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.client.BasicAuthenticator._registerResultEvent
  twisted.words.protocols.jabber.client.BasicAuthenticator.html#_registerResultEvent
  Function
  Method
  PRIVATE
  Undocumented
- twisted.words.protocols.jabber.client.CheckVersionInitializer
  twisted.words.protocols.jabber.client.CheckVersionInitializer.html
  Class
  Class
  PUBLIC
  Initializer that checks if the minimum common stream version number is 1.0.
- twisted.words.protocols.jabber.client.CheckVersionInitializer.__init__
  twisted.words.protocols.jabber.client.CheckVersionInitializer.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.client.CheckVersionInitializer.xmlstream
  twisted.words.protocols.jabber.client.CheckVersionInitializer.html#xmlstream
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.client.CheckVersionInitializer.initialize
  twisted.words.protocols.jabber.client.CheckVersionInitializer.html#initialize
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.client.BindInitializer
  twisted.words.protocols.jabber.client.BindInitializer.html
  Class
  Class
  PUBLIC
  Initializer that implements Resource Binding for the initiating entity.
- twisted.words.protocols.jabber.client.BindInitializer.feature
  twisted.words.protocols.jabber.client.BindInitializer.html#feature
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.client.BindInitializer.start
  twisted.words.protocols.jabber.client.BindInitializer.html#start
  Function
  Method
  PUBLIC
  Start the actual initialization.
- twisted.words.protocols.jabber.client.BindInitializer.onBind
  twisted.words.protocols.jabber.client.BindInitializer.html#onBind
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.client.SessionInitializer
  twisted.words.protocols.jabber.client.SessionInitializer.html
  Class
  Class
  PUBLIC
  Initializer that implements session establishment for the initiating entity.
- twisted.words.protocols.jabber.client.SessionInitializer.feature
  twisted.words.protocols.jabber.client.SessionInitializer.html#feature
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.client.SessionInitializer.start
  twisted.words.protocols.jabber.client.SessionInitializer.html#start
  Function
  Method
  PUBLIC
  Start the actual initialization.
- twisted.words.protocols.jabber.client.XMPPClientFactory
  twisted.words.protocols.jabber.client.html#XMPPClientFactory
  Function
  Function
  PUBLIC
  Client factory for XMPP 1.0 (only).
- twisted.words.protocols.jabber.client.XMPPAuthenticator
  twisted.words.protocols.jabber.client.XMPPAuthenticator.html
  Class
  Class
  PUBLIC
  Initializes an XmlStream connecting to an XMPP server as a Client.
- twisted.words.protocols.jabber.client.XMPPAuthenticator.jid
  twisted.words.protocols.jabber.client.XMPPAuthenticator.html#jid
  Attribute
  Instance Variable
  PUBLIC
  Jabber ID to authenticate with. This may contain a resource part, as a suggestion to the server for resource binding. A server may override this, though. If the resource part is left off, the server will generate a unique resource identifier...
- twisted.words.protocols.jabber.client.XMPPAuthenticator.password
  twisted.words.protocols.jabber.client.XMPPAuthenticator.html#password
  Attribute
  Instance Variable
  PUBLIC
  password to be used during SASL authentication.
- twisted.words.protocols.jabber.client.XMPPAuthenticator.namespace
  twisted.words.protocols.jabber.client.XMPPAuthenticator.html#namespace
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.client.XMPPAuthenticator.__init__
  twisted.words.protocols.jabber.client.XMPPAuthenticator.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.words.protocols.jabber.client.XMPPAuthenticator._configurationForTLS
  twisted.words.protocols.jabber.client.XMPPAuthenticator.html#_configurationForTLS
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.words.protocols.jabber.client.XMPPAuthenticator.associateWithStream
  twisted.words.protocols.jabber.client.XMPPAuthenticator.html#associateWithStream
  Function
  Method
  PUBLIC
  Register with the XML stream.
- twisted.words.protocols.jabber.jstrports._parseTCPSSL
  twisted.words.protocols.jabber.jstrports.html#_parseTCPSSL
  Function
  Function
  PRIVATE
  For the moment, parse TCP or SSL connections the same
- twisted.words.protocols.jabber.jstrports._parseUNIX
  twisted.words.protocols.jabber.jstrports.html#_parseUNIX
  Function
  Function
  PRIVATE
  Undocumented
- twisted.words.protocols.jabber.jstrports._funcs
  twisted.words.protocols.jabber.jstrports.html#_funcs
  Attribute
  Variable
  PRIVATE
  Undocumented
- twisted.words.protocols.jabber.jstrports.parse
  twisted.words.protocols.jabber.jstrports.html#parse
  Function
  Function
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.jstrports.client
  twisted.words.protocols.jabber.jstrports.html#client
  Function
  Function
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.component.NS_COMPONENT_ACCEPT
  twisted.words.protocols.jabber.component.html#NS_COMPONENT_ACCEPT
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.component.componentFactory
  twisted.words.protocols.jabber.component.html#componentFactory
  Function
  Function
  PUBLIC
  XML stream factory for external server-side components.
- twisted.words.protocols.jabber.component.ComponentInitiatingInitializer
  twisted.words.protocols.jabber.component.ComponentInitiatingInitializer.html
  Class
  Class
  PUBLIC
  External server-side component authentication initializer for the initiating entity.
- twisted.words.protocols.jabber.component.ComponentInitiatingInitializer.xmlstream
  twisted.words.protocols.jabber.component.ComponentInitiatingInitializer.html#xmlstream
  Attribute
  Instance Variable
  PUBLIC
  XML stream between server and component.
- twisted.words.protocols.jabber.component.ComponentInitiatingInitializer.__init__
  twisted.words.protocols.jabber.component.ComponentInitiatingInitializer.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.component.ComponentInitiatingInitializer._deferred
  twisted.words.protocols.jabber.component.ComponentInitiatingInitializer.html#_deferred
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.words.protocols.jabber.component.ComponentInitiatingInitializer.initialize
  twisted.words.protocols.jabber.component.ComponentInitiatingInitializer.html#initialize
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.component.ComponentInitiatingInitializer._cbHandshake
  twisted.words.protocols.jabber.component.ComponentInitiatingInitializer.html#_cbHandshake
  Function
  Method
  PRIVATE
  Undocumented
- twisted.words.protocols.jabber.component.ConnectComponentAuthenticator
  twisted.words.protocols.jabber.component.ConnectComponentAuthenticator.html
  Class
  Class
  PUBLIC
  Authenticator to permit an XmlStream to authenticate against a Jabber server as an external component (where the Authenticator is initiating the stream).
- twisted.words.protocols.jabber.component.ConnectComponentAuthenticator.__init__
  twisted.words.protocols.jabber.component.ConnectComponentAuthenticator.html#__init__
  Function
  Method
  PUBLIC
  No summary
- twisted.words.protocols.jabber.component.ConnectComponentAuthenticator.password
  twisted.words.protocols.jabber.component.ConnectComponentAuthenticator.html#password
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.component.ConnectComponentAuthenticator.associateWithStream
  twisted.words.protocols.jabber.component.ConnectComponentAuthenticator.html#associateWithStream
  Function
  Method
  PUBLIC
  Called by the XmlStreamFactory when a connection has been made to the requested peer, and an XmlStream object has been instantiated.
- twisted.words.protocols.jabber.component.ListenComponentAuthenticator
  twisted.words.protocols.jabber.component.ListenComponentAuthenticator.html
  Class
  Class
  PUBLIC
  Authenticator for accepting components.
- twisted.words.protocols.jabber.component.ListenComponentAuthenticator.secret
  twisted.words.protocols.jabber.component.ListenComponentAuthenticator.html#secret
  Attribute
  Instance Variable
  PUBLIC
  The shared secret used to authorized incoming component connections.
- twisted.words.protocols.jabber.component.ListenComponentAuthenticator.__init__
  twisted.words.protocols.jabber.component.ListenComponentAuthenticator.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.component.ListenComponentAuthenticator.associateWithStream
  twisted.words.protocols.jabber.component.ListenComponentAuthenticator.html#associateWithStream
  Function
  Method
  PUBLIC
  Associate the authenticator with a stream.
- twisted.words.protocols.jabber.component.ListenComponentAuthenticator.streamStarted
  twisted.words.protocols.jabber.component.ListenComponentAuthenticator.html#streamStarted
  Function
  Method
  PUBLIC
  Called by the stream when it has started.
- twisted.words.protocols.jabber.component.ListenComponentAuthenticator.onElement
  twisted.words.protocols.jabber.component.ListenComponentAuthenticator.html#onElement
  Function
  Method
  PUBLIC
  Called on incoming XML Stanzas.
- twisted.words.protocols.jabber.component.ListenComponentAuthenticator.onHandshake
  twisted.words.protocols.jabber.component.ListenComponentAuthenticator.html#onHandshake
  Function
  Method
  PUBLIC
  Called upon receiving the handshake request.
- twisted.words.protocols.jabber.component.Service
  twisted.words.protocols.jabber.component.Service.html
  Class
  Class
  PUBLIC
  External server-side component service.
- twisted.words.protocols.jabber.component.Service.componentConnected
  twisted.words.protocols.jabber.component.Service.html#componentConnected
  Function
  Method
  PUBLIC
  Parent component has established a connection.
- twisted.words.protocols.jabber.component.Service.componentDisconnected
  twisted.words.protocols.jabber.component.Service.html#componentDisconnected
  Function
  Method
  PUBLIC
  Parent component has lost the connection to the Jabber server.
- twisted.words.protocols.jabber.component.Service.transportConnected
  twisted.words.protocols.jabber.component.Service.html#transportConnected
  Function
  Method
  PUBLIC
  Parent component has established a connection over the underlying transport.
- twisted.words.protocols.jabber.component.Service.send
  twisted.words.protocols.jabber.component.Service.html#send
  Function
  Method
  PUBLIC
  Send data over service parent's XML stream.
- twisted.words.protocols.jabber.component.ServiceManager
  twisted.words.protocols.jabber.component.ServiceManager.html
  Class
  Class
  PUBLIC
  Business logic for a managed component connection to a Jabber router.
- twisted.words.protocols.jabber.component.ServiceManager.__init__
  twisted.words.protocols.jabber.component.ServiceManager.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.component.ServiceManager.jabberId
  twisted.words.protocols.jabber.component.ServiceManager.html#jabberId
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.component.ServiceManager.xmlstream
  twisted.words.protocols.jabber.component.ServiceManager.html#xmlstream
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.component.ServiceManager._packetQueue
  twisted.words.protocols.jabber.component.ServiceManager.html#_packetQueue
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.words.protocols.jabber.component.ServiceManager._xsFactory
  twisted.words.protocols.jabber.component.ServiceManager.html#_xsFactory
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
- twisted.words.protocols.jabber.component.ServiceManager.addBootstrap
  twisted.words.protocols.jabber.component.ServiceManager.html#addBootstrap
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.component.ServiceManager.removeBootstrap
  twisted.words.protocols.jabber.component.ServiceManager.html#removeBootstrap
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.component.ServiceManager.getFactory
  twisted.words.protocols.jabber.component.ServiceManager.html#getFactory
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.component.ServiceManager._connected
  twisted.words.protocols.jabber.component.ServiceManager.html#_connected
  Function
  Method
  PRIVATE
  Undocumented
- twisted.words.protocols.jabber.component.ServiceManager._authd
  twisted.words.protocols.jabber.component.ServiceManager.html#_authd
  Function
  Method
  PRIVATE
  Undocumented
- twisted.words.protocols.jabber.component.ServiceManager._disconnected
  twisted.words.protocols.jabber.component.ServiceManager.html#_disconnected
  Function
  Method
  PRIVATE
  Undocumented
- twisted.words.protocols.jabber.component.ServiceManager.send
  twisted.words.protocols.jabber.component.ServiceManager.html#send
  Function
  Method
  PUBLIC
  Send data over the XML stream.
- twisted.words.protocols.jabber.component.buildServiceManager
  twisted.words.protocols.jabber.component.html#buildServiceManager
  Function
  Function
  PUBLIC
  Constructs a pre-built `ServiceManager`, using the specified strport string.
- twisted.words.protocols.jabber.component.Router
  twisted.words.protocols.jabber.component.Router.html
  Class
  Class
  PUBLIC
  XMPP Server's Router.
- twisted.words.protocols.jabber.component.Router.routes
  twisted.words.protocols.jabber.component.Router.html#routes
  Attribute
  Instance Variable
  PUBLIC
  Routes based on the host part of JIDs. Maps host names to the `EventDispatcher`s that should receive the traffic. A key of `None` means the default route.
- twisted.words.protocols.jabber.component.Router.__init__
  twisted.words.protocols.jabber.component.Router.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.component.Router.addRoute
  twisted.words.protocols.jabber.component.Router.html#addRoute
  Function
  Method
  PUBLIC
  Add a new route.
- twisted.words.protocols.jabber.component.Router.removeRoute
  twisted.words.protocols.jabber.component.Router.html#removeRoute
  Function
  Method
  PUBLIC
  Remove a route.
- twisted.words.protocols.jabber.component.Router.route
  twisted.words.protocols.jabber.component.Router.html#route
  Function
  Method
  PUBLIC
  Route a stanza.
- twisted.words.protocols.jabber.component.XMPPComponentServerFactory
  twisted.words.protocols.jabber.component.XMPPComponentServerFactory.html
  Class
  Class
  PUBLIC
  XMPP Component Server factory.
- twisted.words.protocols.jabber.component.XMPPComponentServerFactory.logTraffic
  twisted.words.protocols.jabber.component.XMPPComponentServerFactory.html#logTraffic
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.component.XMPPComponentServerFactory.__init__
  twisted.words.protocols.jabber.component.XMPPComponentServerFactory.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.component.XMPPComponentServerFactory.router
  twisted.words.protocols.jabber.component.XMPPComponentServerFactory.html#router
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.component.XMPPComponentServerFactory.secret
  twisted.words.protocols.jabber.component.XMPPComponentServerFactory.html#secret
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.component.XMPPComponentServerFactory.serial
  twisted.words.protocols.jabber.component.XMPPComponentServerFactory.html#serial
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.component.XMPPComponentServerFactory.onConnectionMade
  twisted.words.protocols.jabber.component.XMPPComponentServerFactory.html#onConnectionMade
  Function
  Method
  PUBLIC
  Called when a component connection was made.
- twisted.words.protocols.jabber.component.XMPPComponentServerFactory.onAuthenticated
  twisted.words.protocols.jabber.component.XMPPComponentServerFactory.html#onAuthenticated
  Function
  Method
  PUBLIC
  Called when a component has successfully authenticated.
- twisted.words.protocols.jabber.component.XMPPComponentServerFactory.onError
  twisted.words.protocols.jabber.component.XMPPComponentServerFactory.html#onError
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.protocols.jabber.component.XMPPComponentServerFactory.onConnectionLost
  twisted.words.protocols.jabber.component.XMPPComponentServerFactory.html#onConnectionLost
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.service.Group
  twisted.words.service.Group.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.words.service.Group.__init__
  twisted.words.service.Group.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.service.Group.name
  twisted.words.service.Group.html#name
  Attribute
  Instance Variable
  PUBLIC
  A short string, unique among groups.
- twisted.words.service.Group.users
  twisted.words.service.Group.html#users
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.service.Group.meta
  twisted.words.service.Group.html#meta
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.service.Group._ebUserCall
  twisted.words.service.Group.html#_ebUserCall
  Function
  Method
  PRIVATE
  Undocumented
- twisted.words.service.Group._cbUserCall
  twisted.words.service.Group.html#_cbUserCall
  Function
  Method
  PRIVATE
  Undocumented
- twisted.words.service.Group.add
  twisted.words.service.Group.html#add
  Function
  Method
  PUBLIC
  Include the given user in this group.
- twisted.words.service.Group.remove
  twisted.words.service.Group.html#remove
  Function
  Method
  PUBLIC
  Remove the given user from this group.
- twisted.words.service.Group.size
  twisted.words.service.Group.html#size
  Function
  Method
  PUBLIC
  Return the number of participants in this group.
- twisted.words.service.Group.receive
  twisted.words.service.Group.html#receive
  Function
  Method
  PUBLIC
  Broadcast the given message from the given sender to other users in group.
- twisted.words.service.Group.setMetadata
  twisted.words.service.Group.html#setMetadata
  Function
  Method
  PUBLIC
  Change the metadata associated with this group.
- twisted.words.service.Group.iterusers
  twisted.words.service.Group.html#iterusers
  Function
  Method
  PUBLIC
  Return an iterator of all users in this group.
- twisted.words.service.User
  twisted.words.service.User.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.words.service.User.realm
  twisted.words.service.User.html#realm
  Attribute
  Instance Variable
  PUBLIC
  A reference to the Realm to which this user belongs. Set if and only if the user is logged in.
- twisted.words.service.User.mind
  twisted.words.service.User.html#mind
  Attribute
  Instance Variable
  PUBLIC
  A reference to the mind which logged in to this user. Set if and only if the user is logged in.
- twisted.words.service.User.__init__
  twisted.words.service.User.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.service.User.name
  twisted.words.service.User.html#name
  Attribute
  Instance Variable
  PUBLIC
  A short string, unique among users.
- twisted.words.service.User.groups
  twisted.words.service.User.html#groups
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.service.User.lastMessage
  twisted.words.service.User.html#lastMessage
  Attribute
  Instance Variable
  PUBLIC
  A POSIX timestamp indicating the time of the last message received from this user.
- twisted.words.service.User.loggedIn
  twisted.words.service.User.html#loggedIn
  Function
  Method
  PUBLIC
  Invoked by the associated `IChatService` when login occurs.
- twisted.words.service.User.signOn
  twisted.words.service.User.html#signOn
  Attribute
  Instance Variable
  PUBLIC
  A POSIX timestamp indicating this user's most recent sign on time.
- twisted.words.service.User.join
  twisted.words.service.User.html#join
  Function
  Method
  PUBLIC
  Attempt to join the given group.
- twisted.words.service.User.leave
  twisted.words.service.User.html#leave
  Function
  Method
  PUBLIC
  Discontinue participation in the given group.
- twisted.words.service.User.send
  twisted.words.service.User.html#send
  Function
  Method
  PUBLIC
  Send the given message to the given user or group.
- twisted.words.service.User.itergroups
  twisted.words.service.User.html#itergroups
  Function
  Method
  PUBLIC
  Return an iterator of all groups of which this user is a member.
- twisted.words.service.User.logout
  twisted.words.service.User.html#logout
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.service.NICKSERV
  twisted.words.service.html#NICKSERV
  Attribute
  Constant
  PUBLIC
  Undocumented
- twisted.words.service.IRCUser
  twisted.words.service.IRCUser.html
  Class
  Class
  PUBLIC
  Protocol instance representing an IRC user connected to the server.
- twisted.words.service.IRCUser.groups
  twisted.words.service.IRCUser.html#groups
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.words.service.IRCUser.logout
  twisted.words.service.IRCUser.html#logout
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.service.IRCUser.avatar
  twisted.words.service.IRCUser.html#avatar
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.service.IRCUser.realm
  twisted.words.service.IRCUser.html#realm
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.service.IRCUser.encoding
  twisted.words.service.IRCUser.html#encoding
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.words.service.IRCUser.connectionMade
  twisted.words.service.IRCUser.html#connectionMade
  Function
  Method
  PUBLIC
  Called when a connection is made.
- twisted.words.service.IRCUser.hostname
  twisted.words.service.IRCUser.html#hostname
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.service.IRCUser.connectionLost
  twisted.words.service.IRCUser.html#connectionLost
  Function
  Method
  PUBLIC
  Called when the connection is shut down.
- twisted.words.service.IRCUser.sendMessage
  twisted.words.service.IRCUser.html#sendMessage
  Function
  Method
  PUBLIC
  Send a line formatted as an IRC message.
- twisted.words.service.IRCUser.userJoined
  twisted.words.service.IRCUser.html#userJoined
  Function
  Method
  PUBLIC
  Callback notifying this user that the given user has joined the given group.
- twisted.words.service.IRCUser.userLeft
  twisted.words.service.IRCUser.html#userLeft
  Function
  Method
  PUBLIC
  Callback notifying this user that the given user has left the given group for the given reason.
- twisted.words.service.IRCUser.receive
  twisted.words.service.IRCUser.html#receive
  Function
  Method
  PUBLIC
  Callback notifying this user of the given message sent by the given user.
- twisted.words.service.IRCUser.groupMetaUpdate
  twisted.words.service.IRCUser.html#groupMetaUpdate
  Function
  Method
  PUBLIC
  Callback notifying this user that the metadata for the given group has changed.
- twisted.words.service.IRCUser.nickname
  twisted.words.service.IRCUser.html#nickname
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.service.IRCUser.password
  twisted.words.service.IRCUser.html#password
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.service.IRCUser.irc_PASS
  twisted.words.service.IRCUser.html#irc_PASS
  Function
  Method
  PUBLIC
  Password message -- Register a password.
- twisted.words.service.IRCUser.irc_NICK
  twisted.words.service.IRCUser.html#irc_NICK
  Function
  Method
  PUBLIC
  Nick message -- Set your nickname.
- twisted.words.service.IRCUser.name
  twisted.words.service.IRCUser.html#name
  Attribute
  Instance Variable
  PUBLIC
  A short string, unique among users. This will be set by the `IChatService` at login time.
- twisted.words.service.IRCUser.irc_USER
  twisted.words.service.IRCUser.html#irc_USER
  Function
  Method
  PUBLIC
  User message -- Set your realname.
- twisted.words.service.IRCUser.realname
  twisted.words.service.IRCUser.html#realname
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.service.IRCUser.irc_NICKSERV_PRIVMSG
  twisted.words.service.IRCUser.html#irc_NICKSERV_PRIVMSG
  Function
  Method
  PUBLIC
  Send a (private) message.
- twisted.words.service.IRCUser.logInAs
  twisted.words.service.IRCUser.html#logInAs
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.service.IRCUser._welcomeMessages
  twisted.words.service.IRCUser.html#_welcomeMessages
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.words.service.IRCUser._motdMessages
  twisted.words.service.IRCUser.html#_motdMessages
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.words.service.IRCUser._cbLogin
  twisted.words.service.IRCUser.html#_cbLogin
  Function
  Method
  PRIVATE
  Undocumented
- twisted.words.service.IRCUser._ebLogin
  twisted.words.service.IRCUser.html#_ebLogin
  Function
  Method
  PRIVATE
  Undocumented
- twisted.words.service.IRCUser.irc_PING
  twisted.words.service.IRCUser.html#irc_PING
  Function
  Method
  PUBLIC
  Ping message
- twisted.words.service.IRCUser.irc_QUIT
  twisted.words.service.IRCUser.html#irc_QUIT
  Function
  Method
  PUBLIC
  Quit
- twisted.words.service.IRCUser._channelMode
  twisted.words.service.IRCUser.html#_channelMode
  Function
  Method
  PRIVATE
  Undocumented
- twisted.words.service.IRCUser._userMode
  twisted.words.service.IRCUser.html#_userMode
  Function
  Method
  PRIVATE
  Undocumented
- twisted.words.service.IRCUser.irc_MODE
  twisted.words.service.IRCUser.html#irc_MODE
  Function
  Method
  PUBLIC
  User mode message
- twisted.words.service.IRCUser.irc_USERHOST
  twisted.words.service.IRCUser.html#irc_USERHOST
  Function
  Method
  PUBLIC
  Userhost message
- twisted.words.service.IRCUser.irc_PRIVMSG 0
  twisted.words.service.IRCUser.html#irc_PRIVMSG%200
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.service.IRCUser.irc_PRIVMSG
  twisted.words.service.IRCUser.html#irc_PRIVMSG
  Function
  Method
  PUBLIC
  Send a (private) message.
- twisted.words.service.IRCUser.irc_JOIN
  twisted.words.service.IRCUser.html#irc_JOIN
  Function
  Method
  PUBLIC
  Join message
- twisted.words.service.IRCUser.irc_PART
  twisted.words.service.IRCUser.html#irc_PART
  Function
  Method
  PUBLIC
  Part message
- twisted.words.service.IRCUser.irc_NAMES
  twisted.words.service.IRCUser.html#irc_NAMES
  Function
  Method
  PUBLIC
  Names message
- twisted.words.service.IRCUser.irc_TOPIC
  twisted.words.service.IRCUser.html#irc_TOPIC
  Function
  Method
  PUBLIC
  Topic message
- twisted.words.service.IRCUser._sendTopic
  twisted.words.service.IRCUser.html#_sendTopic
  Function
  Method
  PRIVATE
  Send the topic of the given group to this user, if it has one.
- twisted.words.service.IRCUser._getTopic
  twisted.words.service.IRCUser.html#_getTopic
  Function
  Method
  PRIVATE
  Undocumented
- twisted.words.service.IRCUser._setTopic
  twisted.words.service.IRCUser.html#_setTopic
  Function
  Method
  PRIVATE
  Undocumented
- twisted.words.service.IRCUser.list
  twisted.words.service.IRCUser.html#list
  Function
  Method
  PUBLIC
  Send a group of LIST response lines
- twisted.words.service.IRCUser.irc_LIST
  twisted.words.service.IRCUser.html#irc_LIST
  Function
  Method
  PUBLIC
  List query
- twisted.words.service.IRCUser._channelWho
  twisted.words.service.IRCUser.html#_channelWho
  Function
  Method
  PRIVATE
  Undocumented
- twisted.words.service.IRCUser._userWho
  twisted.words.service.IRCUser.html#_userWho
  Function
  Method
  PRIVATE
  Undocumented
- twisted.words.service.IRCUser.irc_WHO
  twisted.words.service.IRCUser.html#irc_WHO
  Function
  Method
  PUBLIC
  Who query
- twisted.words.service.IRCUser.irc_WHOIS
  twisted.words.service.IRCUser.html#irc_WHOIS
  Function
  Method
  PUBLIC
  Whois query
- twisted.words.service.IRCUser.irc_OPER
  twisted.words.service.IRCUser.html#irc_OPER
  Function
  Method
  PUBLIC
  Oper message
- twisted.words.service.IRCFactory
  twisted.words.service.IRCFactory.html
  Class
  Class
  PUBLIC
  IRC server that creates instances of the `IRCUser` protocol.
- twisted.words.service.IRCFactory._serverInfo
  twisted.words.service.IRCFactory.html#_serverInfo
  Attribute
  Instance Variable
  PRIVATE
  A dictionary mapping: "serviceName" to the name of the server, "serviceVersion" to the copyright version, "creationDate" to the time that the server was started.
- twisted.words.service.IRCFactory.__init__
  twisted.words.service.IRCFactory.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.service.IRCFactory.realm
  twisted.words.service.IRCFactory.html#realm
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.service.IRCFactory.portal
  twisted.words.service.IRCFactory.html#portal
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.service.PBMind
  twisted.words.service.PBMind.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.words.service.PBMind.__init__
  twisted.words.service.PBMind.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.service.PBMind.jellyFor
  twisted.words.service.PBMind.html#jellyFor
  Function
  Method
  PUBLIC
  (internal)
- twisted.words.service.PBMind.remote_userJoined
  twisted.words.service.PBMind.html#remote_userJoined
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.service.PBMind.remote_userLeft
  twisted.words.service.PBMind.html#remote_userLeft
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.service.PBMind.remote_receive
  twisted.words.service.PBMind.html#remote_receive
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.service.PBMind.remote_groupMetaUpdate
  twisted.words.service.PBMind.html#remote_groupMetaUpdate
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.service.PBMindReference
  twisted.words.service.PBMindReference.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.words.service.PBMindReference.name
  twisted.words.service.PBMindReference.html#name
  Attribute
  Class Variable
  PUBLIC
  A short string, unique among users. This will be set by the `IChatService` at login time.
- twisted.words.service.PBMindReference.receive
  twisted.words.service.PBMindReference.html#receive
  Function
  Method
  PUBLIC
  Callback notifying this user of the given message sent by the given user.
- twisted.words.service.PBMindReference.groupMetaUpdate
  twisted.words.service.PBMindReference.html#groupMetaUpdate
  Function
  Method
  PUBLIC
  Callback notifying this user that the metadata for the given group has changed.
- twisted.words.service.PBMindReference.userJoined
  twisted.words.service.PBMindReference.html#userJoined
  Function
  Method
  PUBLIC
  Callback notifying this user that the given user has joined the given group.
- twisted.words.service.PBMindReference.userLeft
  twisted.words.service.PBMindReference.html#userLeft
  Function
  Method
  PUBLIC
  Callback notifying this user that the given user has left the given group for the given reason.
- twisted.words.service.PBGroup
  twisted.words.service.PBGroup.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.words.service.PBGroup.__init__
  twisted.words.service.PBGroup.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.service.PBGroup.realm
  twisted.words.service.PBGroup.html#realm
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.service.PBGroup.avatar
  twisted.words.service.PBGroup.html#avatar
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.service.PBGroup.group
  twisted.words.service.PBGroup.html#group
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.service.PBGroup.processUniqueID
  twisted.words.service.PBGroup.html#processUniqueID
  Function
  Method
  PUBLIC
  Return an ID which uniquely represents this object for this process.
- twisted.words.service.PBGroup.jellyFor
  twisted.words.service.PBGroup.html#jellyFor
  Function
  Method
  PUBLIC
  (internal)
- twisted.words.service.PBGroup.remote_leave
  twisted.words.service.PBGroup.html#remote_leave
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.service.PBGroup.remote_send
  twisted.words.service.PBGroup.html#remote_send
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.service.PBGroupReference
  twisted.words.service.PBGroupReference.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.words.service.PBGroupReference.unjellyFor
  twisted.words.service.PBGroupReference.html#unjellyFor
  Function
  Method
  PUBLIC
  Unjelly myself for the jellier.
- twisted.words.service.PBGroupReference.name
  twisted.words.service.PBGroupReference.html#name
  Attribute
  Instance Variable
  PUBLIC
  A short string, unique among groups.
- twisted.words.service.PBGroupReference.leave
  twisted.words.service.PBGroupReference.html#leave
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.service.PBGroupReference.send
  twisted.words.service.PBGroupReference.html#send
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.service.PBGroupReference.add
  twisted.words.service.PBGroupReference.html#add
  Function
  Method
  PUBLIC
  Include the given user in this group.
- twisted.words.service.PBGroupReference.iterusers
  twisted.words.service.PBGroupReference.html#iterusers
  Function
  Method
  PUBLIC
  Return an iterator of all users in this group.
- twisted.words.service.PBGroupReference.receive
  twisted.words.service.PBGroupReference.html#receive
  Function
  Method
  PUBLIC
  Broadcast the given message from the given sender to other users in group.
- twisted.words.service.PBGroupReference.remove
  twisted.words.service.PBGroupReference.html#remove
  Function
  Method
  PUBLIC
  Remove the given user from this group.
- twisted.words.service.PBGroupReference.setMetadata
  twisted.words.service.PBGroupReference.html#setMetadata
  Function
  Method
  PUBLIC
  Change the metadata associated with this group.
- twisted.words.service.PBGroupReference.size
  twisted.words.service.PBGroupReference.html#size
  Function
  Method
  PUBLIC
  Return the number of participants in this group.
- twisted.words.service.PBUser
  twisted.words.service.PBUser.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.words.service.PBUser.__init__
  twisted.words.service.PBUser.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.service.PBUser.realm
  twisted.words.service.PBUser.html#realm
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.service.PBUser.avatar
  twisted.words.service.PBUser.html#avatar
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.service.PBUser.user
  twisted.words.service.PBUser.html#user
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.service.PBUser.processUniqueID
  twisted.words.service.PBUser.html#processUniqueID
  Function
  Method
  PUBLIC
  Return an ID which uniquely represents this object for this process.
- twisted.words.service.ChatAvatar
  twisted.words.service.ChatAvatar.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.words.service.ChatAvatar.__init__
  twisted.words.service.ChatAvatar.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.service.ChatAvatar.avatar
  twisted.words.service.ChatAvatar.html#avatar
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.service.ChatAvatar.jellyFor
  twisted.words.service.ChatAvatar.html#jellyFor
  Function
  Method
  PUBLIC
  (internal)
- twisted.words.service.ChatAvatar.remote_join
  twisted.words.service.ChatAvatar.html#remote_join
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.service.ChatAvatar.name
  twisted.words.service.ChatAvatar.html#name
  Attribute
  Property
  PUBLIC
  A short string, unique among users. This will be set by the `IChatService` at login time.
- twisted.words.service.ChatAvatar.name.setter
  twisted.words.service.ChatAvatar.html#name.setter
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.service.ChatAvatar.groupMetaUpdate
  twisted.words.service.ChatAvatar.html#groupMetaUpdate
  Function
  Method
  PUBLIC
  Callback notifying this user that the metadata for the given group has changed.
- twisted.words.service.ChatAvatar.receive
  twisted.words.service.ChatAvatar.html#receive
  Function
  Method
  PUBLIC
  Callback notifying this user of the given message sent by the given user.
- twisted.words.service.ChatAvatar.userJoined
  twisted.words.service.ChatAvatar.html#userJoined
  Function
  Method
  PUBLIC
  Callback notifying this user that the given user has joined the given group.
- twisted.words.service.ChatAvatar.userLeft
  twisted.words.service.ChatAvatar.html#userLeft
  Function
  Method
  PUBLIC
  Callback notifying this user that the given user has left the given group for the given reason.
- twisted.words.service.AvatarReference
  twisted.words.service.AvatarReference.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.words.service.AvatarReference.join
  twisted.words.service.AvatarReference.html#join
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.service.AvatarReference.quit
  twisted.words.service.AvatarReference.html#quit
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.service.WordsRealm
  twisted.words.service.WordsRealm.html
  Class
  Class
  PUBLIC
  No class docstring; 0/1 instance variable, 0/3 class variable, 2/14 methods documented
- twisted.words.service.WordsRealm._encoding
  twisted.words.service.WordsRealm.html#_encoding
  Attribute
  Class Variable
  PRIVATE
  Undocumented
- twisted.words.service.WordsRealm.__init__
  twisted.words.service.WordsRealm.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.service.WordsRealm.name
  twisted.words.service.WordsRealm.html#name
  Attribute
  Instance Variable
  PUBLIC
  A short string identifying this chat service (eg, a hostname)
- twisted.words.service.WordsRealm.userFactory
  twisted.words.service.WordsRealm.html#userFactory
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.service.WordsRealm.groupFactory
  twisted.words.service.WordsRealm.html#groupFactory
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.service.WordsRealm.logoutFactory
  twisted.words.service.WordsRealm.html#logoutFactory
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.service.WordsRealm.requestAvatar
  twisted.words.service.WordsRealm.html#requestAvatar
  Function
  Method
  PUBLIC
  Return avatar which provides one of the given interfaces.
- twisted.words.service.WordsRealm.itergroups
  twisted.words.service.WordsRealm.html#itergroups
  Function
  Method
  PUBLIC
  Return all groups available on this service.
- twisted.words.service.WordsRealm.createGroupOnRequest
  twisted.words.service.WordsRealm.html#createGroupOnRequest
  Attribute
  Class Variable
  PUBLIC
  A boolean indicating whether `getGroup` should implicitly create groups which are requested but which do not yet exist.
- twisted.words.service.WordsRealm.createUserOnRequest
  twisted.words.service.WordsRealm.html#createUserOnRequest
  Attribute
  Class Variable
  PUBLIC
  A boolean indicating whether `getUser` should implicitly create users which are requested but which do not yet exist.
- twisted.words.service.WordsRealm.lookupUser
  twisted.words.service.WordsRealm.html#lookupUser
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.service.WordsRealm.lookupGroup
  twisted.words.service.WordsRealm.html#lookupGroup
  Function
  Method
  PUBLIC
  Retrieve a group by name.
- twisted.words.service.WordsRealm.addUser
  twisted.words.service.WordsRealm.html#addUser
  Function
  Method
  PUBLIC
  Add the given user to this service.
- twisted.words.service.WordsRealm.addGroup
  twisted.words.service.WordsRealm.html#addGroup
  Function
  Method
  PUBLIC
  Add the given group to this service.
- twisted.words.service.WordsRealm.getGroup
  twisted.words.service.WordsRealm.html#getGroup
  Function
  Method
  PUBLIC
  Retrieve the group by the given name.
- twisted.words.service.WordsRealm.getUser
  twisted.words.service.WordsRealm.html#getUser
  Function
  Method
  PUBLIC
  Retrieve the user by the given name.
- twisted.words.service.WordsRealm.createUser
  twisted.words.service.WordsRealm.html#createUser
  Function
  Method
  PUBLIC
  Create a new user with the given name.
- twisted.words.service.WordsRealm.createGroup
  twisted.words.service.WordsRealm.html#createGroup
  Function
  Method
  PUBLIC
  Create a new group with the given name.
- twisted.words.service.InMemoryWordsRealm
  twisted.words.service.InMemoryWordsRealm.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.words.service.InMemoryWordsRealm.__init__
  twisted.words.service.InMemoryWordsRealm.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.service.InMemoryWordsRealm.users
  twisted.words.service.InMemoryWordsRealm.html#users
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.service.InMemoryWordsRealm.groups
  twisted.words.service.InMemoryWordsRealm.html#groups
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
- twisted.words.service.InMemoryWordsRealm.itergroups
  twisted.words.service.InMemoryWordsRealm.html#itergroups
  Function
  Method
  PUBLIC
  Return all groups available on this service.
- twisted.words.service.InMemoryWordsRealm.addUser
  twisted.words.service.InMemoryWordsRealm.html#addUser
  Function
  Method
  PUBLIC
  Add the given user to this service.
- twisted.words.service.InMemoryWordsRealm.addGroup
  twisted.words.service.InMemoryWordsRealm.html#addGroup
  Function
  Method
  PUBLIC
  Add the given group to this service.
- twisted.words.service.InMemoryWordsRealm.lookupUser
  twisted.words.service.InMemoryWordsRealm.html#lookupUser
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.service.InMemoryWordsRealm.lookupGroup
  twisted.words.service.InMemoryWordsRealm.html#lookupGroup
  Function
  Method
  PUBLIC
  Retrieve a group by name.
- twisted.words.tap.Options
  twisted.words.tap.Options.html
  Class
  Class
  PUBLIC
  No class docstring; 0/5 class variable, 2/3 methods documented
- twisted.words.tap.Options.supportedInterfaces
  twisted.words.tap.Options.html#supportedInterfaces
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.words.tap.Options.optParameters
  twisted.words.tap.Options.html#optParameters
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.words.tap.Options.compData
  twisted.words.tap.Options.html#compData
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.words.tap.Options.interfacePlugins
  twisted.words.tap.Options.html#interfacePlugins
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.words.tap.Options.plg
  twisted.words.tap.Options.html#plg
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.words.tap.Options.__init__
  twisted.words.tap.Options.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
- twisted.words.tap.Options.opt_group
  twisted.words.tap.Options.html#opt_group
  Function
  Method
  PUBLIC
  Specify a group which should exist
- twisted.words.tap.Options.opt_passwd
  twisted.words.tap.Options.html#opt_passwd
  Function
  Method
  PUBLIC
  Name of a passwd-style file. (This is for backwards-compatibility only; you should use the --auth command instead.)
- twisted.words.tap.makeService
  twisted.words.tap.html#makeService
  Function
  Function
  PUBLIC
  Undocumented
- twisted.words.xmpproutertap.Options
  twisted.words.xmpproutertap.Options.html
  Class
  Class
  PUBLIC
  Undocumented
- twisted.words.xmpproutertap.Options.optParameters
  twisted.words.xmpproutertap.Options.html#optParameters
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.words.xmpproutertap.Options.optFlags
  twisted.words.xmpproutertap.Options.html#optFlags
  Attribute
  Class Variable
  PUBLIC
  Undocumented
- twisted.words.xmpproutertap.makeService
  twisted.words.xmpproutertap.html#makeService
  Function
  Function
  PUBLIC
  Undocumented