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._client_service
  twisted.application._client_service.html
  Module
  Module
  PRIVATE
  Implementation of twisted.application.internet.ClientService, particularly its automat state machine.
• 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.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._deprecate
  twisted.internet._deprecate.html
  Module
  Module
  PRIVATE
  Support similar deprecation of several reactors.
• 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._multicast
  twisted.internet._multicast.html
  Module
  Module
  PRIVATE
  No module docstring; 0/1 function, 1/1 class documented
• 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/7 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 is a legacy compatibility alias for twisted.internet.gireactor. See that module instead.
• 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._token
  twisted.persisted._token.html
  Module
  Module
  PRIVATE
  FIXME:https://github.com/twisted/twisted/issues/3843 This can be removed once t.persisted.aot is removed. New code should not make use of this.
• twisted.persisted._tokenize
  twisted.persisted._tokenize.html
  Module
  Module
  PRIVATE
  FIXME:https://github.com/twisted/twisted/issues/3843 This can be removed once t.persisted.aot is removed. New code should not make use of this.
• 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.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.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; 0/1 type variable, 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, 8/14 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.functional
  twisted.trial._dist.functional.html
  Module
  Module
  PUBLIC
  General functional-style helpers for disttrial.
• 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.stream
  twisted.trial._dist.stream.html
  Module
  Module
  PUBLIC
  Buffer byte streams.
• 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._abnf
  twisted.web._abnf.html
  Module
  Module
  PRIVATE
  Tools for pedantically processing the HTTP protocol.
• 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/2 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.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.NoMore
  twisted._threads._memory.NoMore.html
  Class
  Class
  PUBLIC
  Undocumented
• twisted._threads._memory.NoMore.Work
  twisted._threads._memory.NoMore.html#Work
  Attribute
  Class 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._P
  twisted.python.deprecate.html#_P
  Attribute
  Constant
  PRIVATE
  Undocumented
• twisted.python.deprecate._R
  twisted.python.deprecate.html#_R
  Attribute
  Type Variable
  PRIVATE
  Undocumented
• 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._PYPY
  twisted.python.compat.html#_PYPY
  Attribute
  Variable
  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 memory view 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._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._T_Callable
  twisted.python.failure.html#_T_Callable
  Attribute
  Type Variable
  PRIVATE
  Undocumented
• 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.pickled
  twisted.python.failure.Failure.html#pickled
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• twisted.python.failure.Failure._parents
  twisted.python.failure.Failure.html#_parents
  Attribute
  Instance 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.frames 0
  twisted.python.failure.Failure.html#frames%200
  Attribute
  Instance Variable
  PUBLIC
  list of frames, innermost first.
• twisted.python.failure.Failure.frames
  twisted.python.failure.Failure.html#frames
  Attribute
  Property
  PUBLIC
  Undocumented
• twisted.python.failure.Failure.frames.setter
  twisted.python.failure.Failure.html#frames.setter
  Function
  Method
  PUBLIC
  Undocumented
• twisted.python.failure.Failure._frames
  twisted.python.failure.Failure.html#_frames
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• twisted.python.failure.Failure.stack 0
  twisted.python.failure.Failure.html#stack%200
  Attribute
  Instance Variable
  PUBLIC
  Deprecated, always an empty list. Equivalent information can be extracted from import traceback; traceback.extract_stack(your_failure.tb)
• twisted.python.failure.Failure.stack
  twisted.python.failure.Failure.html#stack
  Attribute
  Property
  PUBLIC
  Undocumented
• twisted.python.failure.Failure.stack.setter
  twisted.python.failure.Failure.html#stack.setter
  Function
  Method
  PUBLIC
  Undocumented
• twisted.python.failure.Failure.parents
  twisted.python.failure.Failure.html#parents
  Attribute
  Property
  PUBLIC
  Undocumented
• twisted.python.failure.Failure.parents.setter
  twisted.python.failure.Failure.html#parents.setter
  Function
  Method
  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._withoutTraceback
  twisted.python.failure.Failure.html#_withoutTraceback
  Function
  Static Method
  PRIVATE
  Create a Failure for an exception without a traceback.
• 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.__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.__setstate__
  twisted.python.failure.Failure.html#__setstate__
  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.__reduce__
  twisted.python.failure.Failure.html#__reduce__
  Function
  Method
  PUBLIC
  Undocumented
• 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._FailCtxMgr
  twisted.logger._logger._FailCtxMgr.html
  Class
  Class
  PRIVATE
  Undocumented
• twisted.logger._logger._FailCtxMgr.succeeded
  twisted.logger._logger._FailCtxMgr.html#succeeded
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• twisted.logger._logger._FailCtxMgr.failure
  twisted.logger._logger._FailCtxMgr.html#failure
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• twisted.logger._logger._FailCtxMgr.__init__
  twisted.logger._logger._FailCtxMgr.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• twisted.logger._logger._FailCtxMgr._fail
  twisted.logger._logger._FailCtxMgr.html#_fail
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• twisted.logger._logger._FailCtxMgr.failed
  twisted.logger._logger._FailCtxMgr.html#failed
  Attribute
  Property
  PUBLIC
  Undocumented
• twisted.logger._logger._FailCtxMgr.__enter__
  twisted.logger._logger._FailCtxMgr.html#__enter__
  Function
  Method
  PUBLIC
  Undocumented
• twisted.logger._logger._FailCtxMgr.__exit__
  twisted.logger._logger._FailCtxMgr.html#__exit__
  Function
  Method
  PUBLIC
  Undocumented
• twisted.logger._logger._FastFailCtxMgr
  twisted.logger._logger._FastFailCtxMgr.html
  Class
  Class
  PRIVATE
  Undocumented
• twisted.logger._logger._FastFailCtxMgr.__init__
  twisted.logger._logger._FastFailCtxMgr.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• twisted.logger._logger._FastFailCtxMgr._fail
  twisted.logger._logger._FastFailCtxMgr.html#_fail
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• twisted.logger._logger._FastFailCtxMgr.__enter__
  twisted.logger._logger._FastFailCtxMgr.html#__enter__
  Function
  Method
  PUBLIC
  Undocumented
• twisted.logger._logger._FastFailCtxMgr.__exit__
  twisted.logger._logger._FastFailCtxMgr.html#__exit__
  Function
  Method
  PUBLIC
  Undocumented
• twisted.logger._logger._FastFailCtxMgr.failure
  twisted.logger._logger._FastFailCtxMgr.html#failure
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• 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.keycall
  twisted.logger._format.html#keycall
  Function
  Function
  PUBLIC
  Check to see if key ends with parentheses ("()"); if not, wrap up the result of get in a PotentialCallWrapper. Otherwise, call the result of get first, before wrapping it up.
• twisted.logger._format.PotentialCallWrapper
  twisted.logger._format.PotentialCallWrapper.html
  Class
  Class
  PUBLIC
  Object wrapper that wraps getattr() so as to process call-parentheses "()" after a dotted attribute access.
• twisted.logger._format.PotentialCallWrapper.__init__
  twisted.logger._format.PotentialCallWrapper.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• twisted.logger._format.PotentialCallWrapper._wrapped
  twisted.logger._format.PotentialCallWrapper.html#_wrapped
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• twisted.logger._format.PotentialCallWrapper.__getattr__
  twisted.logger._format.PotentialCallWrapper.html#__getattr__
  Function
  Method
  PUBLIC
  Undocumented
• twisted.logger._format.PotentialCallWrapper.__getitem__
  twisted.logger._format.PotentialCallWrapper.html#__getitem__
  Function
  Method
  PUBLIC
  Undocumented
• twisted.logger._format.PotentialCallWrapper.__format__
  twisted.logger._format.PotentialCallWrapper.html#__format__
  Function
  Method
  PUBLIC
  Undocumented
• twisted.logger._format.PotentialCallWrapper.__repr__
  twisted.logger._format.PotentialCallWrapper.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
• twisted.logger._format.PotentialCallWrapper.__str__
  twisted.logger._format.PotentialCallWrapper.html#__str__
  Function
  Method
  PUBLIC
  Undocumented
• 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.Logger.failuresHandled
  twisted.logger.Logger.html#failuresHandled
  Function
  Method
  PUBLIC
  Run some application code, logging a failure and emitting a traceback in the event that any of it fails, but continuing on. For example:
• twisted.logger.Logger.failureHandler
  twisted.logger.Logger.html#failureHandler
  Function
  Method
  PUBLIC
  For performance-sensitive frameworks that needs to handle potential failures from frequently-called application code, and do not need to include detailed structured information about the failure nor inspect the result of the operation, this method returns a context manager that will log exceptions and continue, that can be shared across multiple invocations...
• twisted.logger._loggerFor
  twisted.logger.html#_loggerFor
  Function
  Function
  PRIVATE
  Get a Logger instance attached to the given class.
• twisted.logger.Operation
  twisted.logger.Operation.html
  Class
  Class
  PUBLIC
  An Operation represents the success (or lack thereof) of code performed within the body of the Logger.failureHandler context manager.
• twisted.logger.Operation.succeeded
  twisted.logger.Operation.html#succeeded
  Attribute
  Property
  PUBLIC
  Did the operation succeed? True iff the code completed without raising an exception; False while the code is running and False if it raises an exception.
• twisted.logger.Operation.failure
  twisted.logger.Operation.html#failure
  Attribute
  Property
  PUBLIC
  Did the operation raise an exception? If so, this Failure is that exception.
• twisted.logger.Operation.failed
  twisted.logger.Operation.html#failed
  Attribute
  Property
  PUBLIC
  Did the operation fail? True iff the code raised an exception; False while the code is running and False if it completed without error.
• 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 ILogFilterPredicates.
• 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 dicts 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._T
  twisted.python.util.html#_T
  Attribute
  Type Variable
  PRIVATE
  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.Stop.html
  Class
  Class
  PUBLIC
  Undocumented
• twisted._threads._threadworker.Stop.Thread
  twisted._threads._threadworker.Stop.html#Thread
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• twisted._threads._threadworker.T
  twisted._threads._threadworker.html#T
  Attribute
  Type Variable
  PUBLIC
  Undocumented
• twisted._threads._threadworker.U
  twisted._threads._threadworker.html#U
  Attribute
  Type Variable
  PUBLIC
  Undocumented
• twisted._threads._threadworker.SimpleQueue
  twisted._threads._threadworker.SimpleQueue.html
  Class
  Class
  PUBLIC
  Undocumented
• twisted._threads._threadworker.SimpleQueue.put
  twisted._threads._threadworker.SimpleQueue.html#put
  Function
  Method
  PUBLIC
  Undocumented
• twisted._threads._threadworker.SimpleQueue.get
  twisted._threads._threadworker.SimpleQueue.html#get
  Function
  Method
  PUBLIC
  Undocumented
• twisted._threads._threadworker.smartiter
  twisted._threads._threadworker.html#smartiter
  Attribute
  Variable
  PUBLIC
  Undocumented
• twisted._threads._threadworker.SimpleLock
  twisted._threads._threadworker.SimpleLock.html
  Class
  Class
  PUBLIC
  Undocumented
• twisted._threads._threadworker.SimpleLock.acquire
  twisted._threads._threadworker.SimpleLock.html#acquire
  Function
  Method
  PUBLIC
  Undocumented
• twisted._threads._threadworker.SimpleLock.release
  twisted._threads._threadworker.SimpleLock.html#release
  Function
  Method
  PUBLIC
  Undocumented
• twisted._threads._pool._ThreadFactory
  twisted._threads._pool._ThreadFactory.html
  Class
  Class
  PRIVATE
  Undocumented
• twisted._threads._pool._ThreadFactory.__call__
  twisted._threads._pool._ThreadFactory.html#__call__
  Function
  Method
  PUBLIC
  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._Self
  twisted.python.filepath.html#_Self
  Attribute
  Type Variable
  PRIVATE
  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.OtherAnyStr
  twisted.python.filepath.html#OtherAnyStr
  Attribute
  Type Variable
  PUBLIC
  Undocumented
• twisted.python.filepath.FileMode
  twisted.python.filepath.html#FileMode
  Attribute
  Type Alias
  PUBLIC
  Undocumented
• 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.path
  twisted.python.filepath.AbstractFilePath.html#path
  Attribute
  Instance Variable
  PUBLIC
  Subclasses must set this variable.
• twisted.python.filepath.AbstractFilePath.Selfish
  twisted.python.filepath.AbstractFilePath.html#Selfish
  Attribute
  Type Variable
  PUBLIC
  Undocumented
• twisted.python.filepath.AbstractFilePath.getAccessTime
  twisted.python.filepath.AbstractFilePath.html#getAccessTime
  Function
  Method
  PUBLIC
  Subclasses must implement this.
• twisted.python.filepath.AbstractFilePath.getModificationTime
  twisted.python.filepath.AbstractFilePath.html#getModificationTime
  Function
  Method
  PUBLIC
  Subclasses must implement this.
• twisted.python.filepath.AbstractFilePath.getStatusChangeTime
  twisted.python.filepath.AbstractFilePath.html#getStatusChangeTime
  Function
  Method
  PUBLIC
  Subclasses must implement this.
• twisted.python.filepath.AbstractFilePath.open
  twisted.python.filepath.AbstractFilePath.html#open
  Function
  Method
  PUBLIC
  Subclasses must implement this.
• twisted.python.filepath.AbstractFilePath.isdir
  twisted.python.filepath.AbstractFilePath.html#isdir
  Function
  Method
  PUBLIC
  Subclasses must implement this.
• twisted.python.filepath.AbstractFilePath.basename
  twisted.python.filepath.AbstractFilePath.html#basename
  Function
  Method
  PUBLIC
  Subclasses must implement this.
• twisted.python.filepath.AbstractFilePath.parent
  twisted.python.filepath.AbstractFilePath.html#parent
  Function
  Method
  PUBLIC
  Subclasses must implement this.
• twisted.python.filepath.AbstractFilePath.listdir
  twisted.python.filepath.AbstractFilePath.html#listdir
  Function
  Method
  PUBLIC
  Subclasses must implement this.
• twisted.python.filepath.AbstractFilePath.child
  twisted.python.filepath.AbstractFilePath.html#child
  Function
  Method
  PUBLIC
  Subclasses must implement this.
• 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 AbstractFilePath 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.sibling
  twisted.python.filepath.FilePath.html#sibling
  Function
  Method
  PUBLIC
  Return a FilePath with the same directory as this instance but with a basename of path.
• twisted.python.filepath.FilePath.descendant
  twisted.python.filepath.FilePath.html#descendant
  Function
  Method
  PUBLIC
  Retrieve a child or child's child of this path.
• twisted.python.filepath.FilePath.parents
  twisted.python.filepath.FilePath.html#parents
  Function
  Method
  PUBLIC
  Retrieve an iterator of all the ancestors of this path.
• twisted.python.filepath.FilePath.__gt__
  twisted.python.filepath.FilePath.html#__gt__
  Function
  Method
  PUBLIC
  Undocumented
• twisted.python.filepath.FilePath.__ge__
  twisted.python.filepath.FilePath.html#__ge__
  Function
  Method
  PUBLIC
  Undocumented
• twisted.python.filepath.FilePath.__lt__
  twisted.python.filepath.FilePath.html#__lt__
  Function
  Method
  PUBLIC
  Undocumented
• twisted.python.filepath.FilePath.__le__
  twisted.python.filepath.FilePath.html#__le__
  Function
  Method
  PUBLIC
  Undocumented
• twisted.python.filepath.FilePath.__eq__
  twisted.python.filepath.FilePath.html#__eq__
  Function
  Method
  PUBLIC
  Undocumented
• twisted.python.filepath.FilePath.__ne__
  twisted.python.filepath.FilePath.html#__ne__
  Function
  Method
  PUBLIC
  Undocumented
• twisted.python.filepath.FilePath.clonePath
  twisted.python.filepath.FilePath.html#clonePath
  Function
  Method
  PUBLIC
  Make an object of the same type as this FilePath, but with path of path.
• 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.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._P
  twisted.internet.defer.html#_P
  Attribute
  Constant
  PRIVATE
  Undocumented
• twisted.internet.defer._oldPypyStack
  twisted.internet.defer.html#_oldPypyStack
  Attribute
  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 or coroutine.
• 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 Failures that are CancelledErrors to TimeoutErrors.
• 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.callbacks 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._SelfResultT
  twisted.internet.defer.html#_SelfResultT
  Attribute
  Type Variable
  PRIVATE
  Undocumented
• twisted.internet.defer._NextResultT
  twisted.internet.defer.html#_NextResultT
  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.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 Deferreds, wrapping it in a Deferred that will fire on success/failure of the coroutine.
• twisted.internet.defer.Deferred.__init_subclass__
  twisted.internet.defer.Deferred.html#__init_subclass__
  Function
  Method
  PUBLIC
  Undocumented
• twisted.internet.defer._DEFERRED_SUBCLASSES
  twisted.internet.defer.html#_DEFERRED_SUBCLASSES
  Attribute
  Constant
  PRIVATE
  Undocumented
• twisted.internet.defer.ensureDeferred
  twisted.internet.defer.html#ensureDeferred
  Function
  Function
  PUBLIC
  Schedule the execution of a coroutine that awaits/yields from Deferreds, 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 (mimicking 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
  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 Deferreds 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 Deferreds - in effect, a "join" of multiple deferred operations.
• twisted.internet.defer.FailureGroup
  twisted.internet.defer.FailureGroup.html
  Class
  Exception
  PUBLIC
  More than one failure occurred.
• twisted.internet.defer.FailureGroup.__init__
  twisted.internet.defer.FailureGroup.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• twisted.internet.defer.FailureGroup.failures
  twisted.internet.defer.FailureGroup.html#failures
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• twisted.internet.defer.race
  twisted.internet.defer.html#race
  Function
  Function
  PUBLIC
  Select the first available result from the sequence of Deferreds and cancel the rest.
• 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._gotResultInlineCallbacks
  twisted.internet.defer.html#_gotResultInlineCallbacks
  Function
  Function
  PRIVATE
  Helper for _inlineCallbacks to handle a nested Deferred firing.
• twisted.internet.defer._inlineCallbacks
  twisted.internet.defer.html#_inlineCallbacks
  Function
  Function
  PRIVATE
  Carry out the work of inlineCallbacks.
• twisted.internet.defer._addCancelCallbackToDeferred
  twisted.internet.defer.html#_addCancelCallbackToDeferred
  Function
  Function
  PRIVATE
  Helper for _cancellableInlineCallbacks to add _handleCancelInlineCallbacks as the first errback.
• twisted.internet.defer._handleCancelInlineCallbacks
  twisted.internet.defer.html#_handleCancelInlineCallbacks
  Function
  Function
  PRIVATE
  Propagate the cancellation of an @inlineCallbacks to the Deferred it is waiting on.
• 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._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.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.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.transport
  twisted.internet.protocol.ProcessProtocol.html#transport
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• 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.python.threadpool._P
  twisted.python.threadpool.html#_P
  Attribute
  Constant
  PRIVATE
  Undocumented
• twisted.python.threadpool._R
  twisted.python.threadpool.html#_R
  Attribute
  Type Variable
  PRIVATE
  Undocumented
• twisted.python.threadpool._SupportsQsize
  twisted.python.threadpool._SupportsQsize.html
  Class
  Class
  PRIVATE
  Undocumented
• twisted.python.threadpool._SupportsQsize.qsize
  twisted.python.threadpool._SupportsQsize.html#qsize
  Function
  Method
  PUBLIC
  Undocumented
• twisted.python.threadpool._State
  twisted.python.threadpool._State.html
  Class
  Class
  PRIVATE
  Undocumented
• twisted.python.threadpool._State.min
  twisted.python.threadpool._State.html#min
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• twisted.python.threadpool._State.max
  twisted.python.threadpool._State.html#max
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• 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.threads._P
  twisted.internet.threads.html#_P
  Attribute
  Constant
  PRIVATE
  Undocumented
• twisted.internet.threads._R
  twisted.internet.threads.html#_R
  Attribute
  Type Variable
  PRIVATE
  Undocumented
• 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._GETADDRINFO_RESULT
  twisted.internet._resolver.html#_GETADDRINFO_RESULT
  Attribute
  Type Alias
  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.internet.process._PS_CLOSE
  twisted.internet.process.html#_PS_CLOSE
  Attribute
  Variable
  PRIVATE
  Undocumented
• twisted.internet.process._PS_DUP2
  twisted.internet.process.html#_PS_DUP2
  Attribute
  Variable
  PRIVATE
  Undocumented
• twisted.internet._baseprocess._log
  twisted.internet._baseprocess.html#_log
  Attribute
  Variable
  PRIVATE
  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
  Instance 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
  Instance 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._trySpawnInsteadOfFork
  twisted.internet.process._BaseProcess.html#_trySpawnInsteadOfFork
  Function
  Method
  PRIVATE
  Try to use posix_spawnp() instead of fork(), if possible.
• 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._getFileActions
  twisted.internet.process.html#_getFileActions
  Function
  Function
  PRIVATE
  Get the file_actions parameter for posix_spawn based on the parameters describing the current process state.
• 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
  Instance Variable
  PUBLIC
  Undocumented
• twisted.internet.process.Process.pid
  twisted.internet.process.Process.html#pid
  Attribute
  Instance 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._reactor
  twisted.internet.process.Process.html#_reactor
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• 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._trySpawnInsteadOfFork
  twisted.internet.process.Process.html#_trySpawnInsteadOfFork
  Function
  Method
  PRIVATE
  Try to use posix_spawnp() instead of fork(), if possible.
• 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
  Instance 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.internet._signals.SignalHandler
  twisted.internet._signals.html#SignalHandler
  Attribute
  Type Alias
  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.internet._signals.SignalHandling
  twisted.internet._signals.SignalHandling.html
  Class
  Class
  PUBLIC
  The SignalHandling protocol enables customizable signal-handling behaviors for reactors.
• twisted.internet._signals.SignalHandling.install
  twisted.internet._signals.SignalHandling.html#install
  Function
  Method
  PUBLIC
  Install the signal handlers.
• twisted.internet._signals.SignalHandling.uninstall
  twisted.internet._signals.SignalHandling.html#uninstall
  Function
  Method
  PUBLIC
  Restore signal handlers to their original state.
• twisted.internet._signals._WithoutSignalHandling
  twisted.internet._signals._WithoutSignalHandling.html
  Class
  Class
  PRIVATE
  A SignalHandling implementation that does no signal handling.
• twisted.internet._signals._WithoutSignalHandling.install
  twisted.internet._signals._WithoutSignalHandling.html#install
  Function
  Method
  PUBLIC
  Do not install any signal handlers.
• twisted.internet._signals._WithoutSignalHandling.uninstall
  twisted.internet._signals._WithoutSignalHandling.html#uninstall
  Function
  Method
  PUBLIC
  Do nothing because install installed nothing.
• twisted.internet._signals._WithSignalHandling
  twisted.internet._signals._WithSignalHandling.html
  Class
  Class
  PRIVATE
  A reactor core helper that can manage signals: it installs signal handlers at start time.
• twisted.internet._signals._WithSignalHandling._sigInt
  twisted.internet._signals._WithSignalHandling.html#_sigInt
  Attribute
  Class Variable
  PRIVATE
  Undocumented
• twisted.internet._signals._WithSignalHandling._sigBreak
  twisted.internet._signals._WithSignalHandling.html#_sigBreak
  Attribute
  Class Variable
  PRIVATE
  Undocumented
• twisted.internet._signals._WithSignalHandling._sigTerm
  twisted.internet._signals._WithSignalHandling.html#_sigTerm
  Attribute
  Class Variable
  PRIVATE
  Undocumented
• twisted.internet._signals._WithSignalHandling.install
  twisted.internet._signals._WithSignalHandling.html#install
  Function
  Method
  PUBLIC
  Install the signal handlers for the Twisted event loop.
• twisted.internet._signals._WithSignalHandling.uninstall
  twisted.internet._signals._WithSignalHandling.html#uninstall
  Function
  Method
  PUBLIC
  At the moment, do nothing (for historical reasons).
• twisted.internet._signals._MultiSignalHandling
  twisted.internet._signals._MultiSignalHandling.html
  Class
  Class
  PRIVATE
  An implementation of SignalHandling which propagates protocol method calls to a number of other implementations.
• twisted.internet._signals._MultiSignalHandling._signalHandlings
  twisted.internet._signals._MultiSignalHandling.html#_signalHandlings
  Attribute
  Instance Variable
  PRIVATE
  The other SignalHandling implementations to which to propagate calls.
• twisted.internet._signals._MultiSignalHandling._installed
  twisted.internet._signals._MultiSignalHandling.html#_installed
  Attribute
  Instance Variable
  PRIVATE
  If install has been called but uninstall has not. This is used to avoid double cleanup which otherwise results (at least during test suite runs) because twisted.internet.reactormixins doesn't keep track of whether a reactor has run or not but always invokes its cleanup logic.
• twisted.internet._signals._MultiSignalHandling.install
  twisted.internet._signals._MultiSignalHandling.html#install
  Function
  Method
  PUBLIC
  Undocumented
• twisted.internet._signals._MultiSignalHandling.uninstall
  twisted.internet._signals._MultiSignalHandling.html#uninstall
  Function
  Method
  PUBLIC
  Undocumented
• twisted.internet._signals._ChildSignalHandling
  twisted.internet._signals._ChildSignalHandling.html
  Class
  Class
  PRIVATE
  Signal handling behavior which supports SIGCHLD for notification about changes to child process state.
• twisted.internet._signals._ChildSignalHandling._childWaker
  twisted.internet._signals._ChildSignalHandling.html#_childWaker
  Attribute
  Instance Variable
  PRIVATE
  None or a reference to the _SIGCHLDWaker which is used to properly notice child process termination. This is None when this handling behavior is not installed and non-None otherwise. This is mostly an unfortunate implementation detail due to ...
• twisted.internet._signals._ChildSignalHandling._addInternalReader
  twisted.internet._signals._ChildSignalHandling.html#_addInternalReader
  Attribute
  Class Variable
  PRIVATE
  Undocumented
• twisted.internet._signals._ChildSignalHandling._removeInternalReader
  twisted.internet._signals._ChildSignalHandling.html#_removeInternalReader
  Attribute
  Class Variable
  PRIVATE
  Undocumented
• twisted.internet._signals._ChildSignalHandling.install
  twisted.internet._signals._ChildSignalHandling.html#install
  Function
  Method
  PUBLIC
  Extend the basic signal handling logic to also support handling SIGCHLD to know when to try to reap child processes.
• twisted.internet._signals._ChildSignalHandling.uninstall
  twisted.internet._signals._ChildSignalHandling.html#uninstall
  Function
  Method
  PUBLIC
  If a child waker was created and installed, uninstall it now.
• twisted.internet._signals._IWaker
  twisted.internet._signals._IWaker.html
  Class
  Interface
  PRIVATE
  Interface to wake up the event loop based on the self-pipe trick.
• twisted.internet._signals._IWaker.disconnected
  twisted.internet._signals._IWaker.html#disconnected
  Attribute
  Attribute
  PUBLIC
  Undocumented
• twisted.internet._signals._IWaker.wakeUp
  twisted.internet._signals._IWaker.html#wakeUp
  Function
  Method
  PUBLIC
  Called when the event should be wake up.
• twisted.internet._signals._IWaker.doRead
  twisted.internet._signals._IWaker.html#doRead
  Function
  Method
  PUBLIC
  Read some data from my connection and discard it.
• twisted.internet._signals._IWaker.connectionLost
  twisted.internet._signals._IWaker.html#connectionLost
  Function
  Method
  PUBLIC
  Called when connection was closed and the pipes.
• twisted.internet._signals._SocketWaker
  twisted.internet._signals._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._signals._SocketWaker.disconnected
  twisted.internet._signals._SocketWaker.html#disconnected
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• twisted.internet._signals._SocketWaker.__init__
  twisted.internet._signals._SocketWaker.html#__init__
  Function
  Method
  PUBLIC
  Initialize.
• twisted.internet._signals._SocketWaker.r
  twisted.internet._signals._SocketWaker.html#r
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• twisted.internet._signals._SocketWaker.w
  twisted.internet._signals._SocketWaker.html#w
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• twisted.internet._signals._SocketWaker.fileno
  twisted.internet._signals._SocketWaker.html#fileno
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• twisted.internet._signals._SocketWaker.wakeUp
  twisted.internet._signals._SocketWaker.html#wakeUp
  Function
  Method
  PUBLIC
  Send a byte to my connection.
• twisted.internet._signals._SocketWaker.doRead
  twisted.internet._signals._SocketWaker.html#doRead
  Function
  Method
  PUBLIC
  Read some data from my connection.
• twisted.internet._signals._SocketWaker.connectionLost
  twisted.internet._signals._SocketWaker.html#connectionLost
  Function
  Method
  PUBLIC
  Called when connection was closed and the pipes.
• twisted.internet._signals._FDWaker
  twisted.internet._signals._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._signals._FDWaker.o
  twisted.internet._signals._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._signals._FDWaker.i
  twisted.internet._signals._FDWaker.html#i
  Attribute
  Instance Variable
  PUBLIC
  The file descriptor which should be monitored in order to be awoken by this waker.
• twisted.internet._signals._FDWaker.disconnected
  twisted.internet._signals._FDWaker.html#disconnected
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• twisted.internet._signals._FDWaker.__init__
  twisted.internet._signals._FDWaker.html#__init__
  Function
  Method
  PUBLIC
  Initialize.
• twisted.internet._signals._FDWaker.fileno
  twisted.internet._signals._FDWaker.html#fileno
  Attribute
  Instance Variable
  PUBLIC
  No summary
• twisted.internet._signals._FDWaker.doRead
  twisted.internet._signals._FDWaker.html#doRead
  Function
  Method
  PUBLIC
  Read some bytes from the pipe and discard them.
• twisted.internet._signals._FDWaker.connectionLost
  twisted.internet._signals._FDWaker.html#connectionLost
  Function
  Method
  PUBLIC
  Close both ends of my pipe.
• twisted.internet._signals._UnixWaker
  twisted.internet._signals._UnixWaker.html
  Class
  Class
  PRIVATE
  This class provides a simple interface to wake up the event loop.
• twisted.internet._signals._UnixWaker.wakeUp
  twisted.internet._signals._UnixWaker.html#wakeUp
  Function
  Method
  PUBLIC
  Write one byte to the pipe, and flush it.
• twisted.internet._signals._SIGCHLDWaker
  twisted.internet._signals._SIGCHLDWaker.html
  Class
  Class
  PRIVATE
  _SIGCHLDWaker can wake up a reactor whenever SIGCHLD is received.
• twisted.internet._signals._SIGCHLDWaker.install
  twisted.internet._signals._SIGCHLDWaker.html#install
  Function
  Method
  PUBLIC
  Install the handler necessary to make this waker active.
• twisted.internet._signals._SIGCHLDWaker.uninstall
  twisted.internet._signals._SIGCHLDWaker.html#uninstall
  Function
  Method
  PUBLIC
  Remove the handler which makes this waker active.
• twisted.internet._signals._SIGCHLDWaker.doRead
  twisted.internet._signals._SIGCHLDWaker.html#doRead
  Function
  Method
  PUBLIC
  Having woken up the reactor in response to receipt of SIGCHLD, reap the process which exited.
• twisted.internet.base._log
  twisted.internet.base.html#_log
  Attribute
  Variable
  PRIVATE
  Undocumented
• twisted.internet.base._topHandler
  twisted.internet.base.html#_topHandler
  Attribute
  Variable
  PRIVATE
  Undocumented
• twisted.internet.base._threadCallHandler
  twisted.internet.base.html#_threadCallHandler
  Attribute
  Variable
  PRIVATE
  Undocumented
• twisted.internet.base._systemEventHandler
  twisted.internet.base.html#_systemEventHandler
  Attribute
  Variable
  PRIVATE
  Undocumented
• 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.creator
  twisted.internet.base.DelayedCall.html#creator
  Attribute
  Instance Variable
  PUBLIC
  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.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._DEFAULT_DELAYED_CALL_LOGGING_HANDLER
  twisted.internet.base.html#_DEFAULT_DELAYED_CALL_LOGGING_HANDLER
  Attribute
  Constant
  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._installSignalHandlers
  twisted.internet.base.ReactorBase.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
• twisted.internet.base.ReactorBase._signals
  twisted.internet.base.ReactorBase.html#_signals
  Attribute
  Instance Variable
  PRIVATE
  An object which knows how to install and uninstall the reactor's signal-handling behavior.
• 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._makeSignalHandling
  twisted.internet.base.ReactorBase.html#_makeSignalHandling
  Function
  Method
  PRIVATE
  Get an appropriate signal handling object.
• twisted.internet.base.ReactorBase._signalsFactory
  twisted.internet.base.ReactorBase.html#_signalsFactory
  Function
  Method
  PRIVATE
  Get a signal handling object that implements the basic behavior of stopping the reactor on SIGINT, SIGBREAK, and SIGTERM.
• twisted.internet.base.ReactorBase._addInternalReader
  twisted.internet.base.ReactorBase.html#_addInternalReader
  Function
  Method
  PRIVATE
  Add a read descriptor which is part of the implementation of the reactor itself.
• twisted.internet.base.ReactorBase._removeInternalReader
  twisted.internet.base.ReactorBase.html#_removeInternalReader
  Function
  Method
  PRIVATE
  Remove a read descriptor which is part of the implementation of the reactor itself.
• 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.mainLoop
  twisted.internet.base.ReactorBase.html#mainLoop
  Function
  Method
  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.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.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 Deferreds 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._log
  twisted.internet._producer_helpers.html#_log
  Attribute
  Variable
  PRIVATE
  Undocumented
• 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._log
  twisted.internet._sslverify.html#_log
  Attribute
  Variable
  PRIVATE
  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._representsEOF
  twisted.protocols.tls.html#_representsEOF
  Function
  Function
  PRIVATE
  Does the given OpenSSL.SSL.Error represent an end-of-file?
• 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._AggregateSmallWrites
  twisted.protocols.tls._AggregateSmallWrites.html
  Class
  Class
  PRIVATE
  Aggregate small writes so they get written in large batches.
• twisted.protocols.tls._AggregateSmallWrites.MAX_BUFFER_SIZE
  twisted.protocols.tls._AggregateSmallWrites.html#MAX_BUFFER_SIZE
  Attribute
  Constant
  PUBLIC
  The maximum amount of bytes to buffer before writing them out.
• twisted.protocols.tls._AggregateSmallWrites.__init__
  twisted.protocols.tls._AggregateSmallWrites.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• twisted.protocols.tls._AggregateSmallWrites._write
  twisted.protocols.tls._AggregateSmallWrites.html#_write
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• twisted.protocols.tls._AggregateSmallWrites._clock
  twisted.protocols.tls._AggregateSmallWrites.html#_clock
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• twisted.protocols.tls._AggregateSmallWrites._buffer
  twisted.protocols.tls._AggregateSmallWrites.html#_buffer
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• twisted.protocols.tls._AggregateSmallWrites._bufferLeft
  twisted.protocols.tls._AggregateSmallWrites.html#_bufferLeft
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• twisted.protocols.tls._AggregateSmallWrites._scheduled
  twisted.protocols.tls._AggregateSmallWrites.html#_scheduled
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• twisted.protocols.tls._AggregateSmallWrites.write
  twisted.protocols.tls._AggregateSmallWrites.html#write
  Function
  Method
  PUBLIC
  Buffer the data, or write it immediately if we've accumulated enough to make it worth it.
• twisted.protocols.tls._AggregateSmallWrites._scheduledFlush
  twisted.protocols.tls._AggregateSmallWrites.html#_scheduledFlush
  Function
  Method
  PRIVATE
  Called in next reactor iteration.
• twisted.protocols.tls._AggregateSmallWrites.flush
  twisted.protocols.tls._AggregateSmallWrites.html#flush
  Function
  Method
  PUBLIC
  Flush any buffered writes.
• twisted.protocols.tls._get_default_clock
  twisted.protocols.tls.html#_get_default_clock
  Function
  Function
  PRIVATE
  Return the default reactor.
• twisted.protocols.tls.BufferingTLSTransport
  twisted.protocols.tls.BufferingTLSTransport.html
  Class
  Class
  PUBLIC
  A TLS transport implemented by wrapping buffering around a TLSMemoryBIOProtocol.
• twisted.protocols.tls.BufferingTLSTransport.__init__
  twisted.protocols.tls.BufferingTLSTransport.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• twisted.protocols.tls.BufferingTLSTransport._aggregator
  twisted.protocols.tls.BufferingTLSTransport.html#_aggregator
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• twisted.protocols.tls.BufferingTLSTransport.writeSequence
  twisted.protocols.tls.BufferingTLSTransport.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.BufferingTLSTransport.loseConnection
  twisted.protocols.tls.BufferingTLSTransport.html#loseConnection
  Function
  Method
  PUBLIC
  Send a TLS close alert and close the underlying connection.
• 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._clock
  twisted.protocols.tls.TLSMemoryBIOFactory.html#_clock
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• 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
  Variable
  PUBLIC
  Undocumented
• twisted.internet.tcp.ENFILE
  twisted.internet.tcp.html#ENFILE
  Attribute
  Variable
  PUBLIC
  Undocumented
• twisted.internet.tcp.ENOMEM
  twisted.internet.tcp.html#ENOMEM
  Attribute
  Variable
  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.server
  twisted.internet.ssl.Server.html#server
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• 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
  Instance 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 May 2022, 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 Certificates.
• 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
  Variable
  PUBLIC
  Undocumented
• twisted.names.dns.NS
  twisted.names.dns.html#NS
  Attribute
  Variable
  PUBLIC
  Undocumented
• twisted.names.dns.MD
  twisted.names.dns.html#MD
  Attribute
  Variable
  PUBLIC
  Undocumented
• twisted.names.dns.MF
  twisted.names.dns.html#MF
  Attribute
  Variable
  PUBLIC
  Undocumented
• twisted.names.dns.CNAME
  twisted.names.dns.html#CNAME
  Attribute
  Variable
  PUBLIC
  Undocumented
• twisted.names.dns.SOA
  twisted.names.dns.html#SOA
  Attribute
  Variable
  PUBLIC
  Undocumented
• twisted.names.dns.MB
  twisted.names.dns.html#MB
  Attribute
  Variable
  PUBLIC
  Undocumented
• twisted.names.dns.MG
  twisted.names.dns.html#MG
  Attribute
  Variable
  PUBLIC
  Undocumented
• twisted.names.dns.MR
  twisted.names.dns.html#MR
  Attribute
  Variable
  PUBLIC
  Undocumented
• twisted.names.dns.NULL
  twisted.names.dns.html#NULL
  Attribute
  Variable
  PUBLIC
  Undocumented
• twisted.names.dns.WKS
  twisted.names.dns.html#WKS
  Attribute
  Variable
  PUBLIC
  Undocumented
• twisted.names.dns.PTR
  twisted.names.dns.html#PTR
  Attribute
  Variable
  PUBLIC
  Undocumented
• twisted.names.dns.HINFO
  twisted.names.dns.html#HINFO
  Attribute
  Variable
  PUBLIC
  Undocumented
• twisted.names.dns.MINFO
  twisted.names.dns.html#MINFO
  Attribute
  Variable
  PUBLIC
  Undocumented
• twisted.names.dns.MX
  twisted.names.dns.html#MX
  Attribute
  Variable
  PUBLIC
  Undocumented
• twisted.names.dns.TXT
  twisted.names.dns.html#TXT
  Attribute
  Variable
  PUBLIC
  Undocumented
• twisted.names.dns.RP
  twisted.names.dns.html#RP
  Attribute
  Variable
  PUBLIC
  Undocumented
• twisted.names.dns.AFSDB
  twisted.names.dns.html#AFSDB
  Attribute
  Variable
  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
  Variable
  PUBLIC
  Undocumented
• twisted.names.dns.AXFR
  twisted.names.dns.html#AXFR
  Attribute
  Variable
  PUBLIC
  Undocumented
• twisted.names.dns.MAILB
  twisted.names.dns.html#MAILB
  Attribute
  Variable
  PUBLIC
  Undocumented
• twisted.names.dns.MAILA
  twisted.names.dns.html#MAILA
  Attribute
  Variable
  PUBLIC
  Undocumented
• twisted.names.dns.ALL_RECORDS
  twisted.names.dns.html#ALL_RECORDS
  Attribute
  Variable
  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
  Variable
  PUBLIC
  Undocumented
• twisted.names.dns.CS
  twisted.names.dns.html#CS
  Attribute
  Variable
  PUBLIC
  Undocumented
• twisted.names.dns.CH
  twisted.names.dns.html#CH
  Attribute
  Variable
  PUBLIC
  Undocumented
• twisted.names.dns.HS
  twisted.names.dns.html#HS
  Attribute
  Variable
  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
  Variable
  PUBLIC
  Undocumented
• twisted.names.dns.OP_INVERSE
  twisted.names.dns.html#OP_INVERSE
  Attribute
  Variable
  PUBLIC
  Undocumented
• twisted.names.dns.OP_STATUS
  twisted.names.dns.html#OP_STATUS
  Attribute
  Variable
  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
  Variable
  PUBLIC
  Undocumented
• twisted.names.dns.EFORMAT
  twisted.names.dns.html#EFORMAT
  Attribute
  Variable
  PUBLIC
  Undocumented
• twisted.names.dns.ESERVER
  twisted.names.dns.html#ESERVER
  Attribute
  Variable
  PUBLIC
  Undocumented
• twisted.names.dns.ENAME
  twisted.names.dns.html#ENAME
  Attribute
  Variable
  PUBLIC
  Undocumented
• twisted.names.dns.ENOTIMP
  twisted.names.dns.html#ENOTIMP
  Attribute
  Variable
  PUBLIC
  Undocumented
• twisted.names.dns.EREFUSED
  twisted.names.dns.html#EREFUSED
  Attribute
  Variable
  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
  Variable
  PUBLIC
  Undocumented
• twisted.names.dns.EBADKEY
  twisted.names.dns.html#EBADKEY
  Attribute
  Variable
  PUBLIC
  Undocumented
• twisted.names.dns.EBADTIME
  twisted.names.dns.html#EBADTIME
  Attribute
  Variable
  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
  PRIVATE
  mypy doesn't like type-punning str | bytes | int | None into a str so we have this helper function.
• 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
  Asynchronously resolve a hostname to a single IPv4 address.
• 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 IStreamServerEndpoints 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 DelayedCalls.
• 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 DelayedCalls, 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._P
  twisted.trial.util.html#_P
  Attribute
  Constant
  PRIVATE
  Undocumented
• twisted.trial.util._T
  twisted.trial.util.html#_T
  Attribute
  Type Variable
  PRIVATE
  Undocumented
• 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.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.__exit__
  twisted.python.monkey.MonkeyPatcher.html#__exit__
  Function
  Method
  PUBLIC
  Undocumented
• 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._P
  twisted.trial._synctest.html#_P
  Attribute
  Constant
  PRIVATE
  Undocumented
• twisted.trial._synctest.T
  twisted.trial._synctest.html#T
  Attribute
  Type Variable
  PUBLIC
  Undocumented
• 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.reporter.ExcInfo
  twisted.trial.reporter.html#ExcInfo
  Attribute
  Type Alias
  PUBLIC
  Undocumented
• twisted.trial.reporter.XUnitFailure
  twisted.trial.reporter.html#XUnitFailure
  Attribute
  Type Alias
  PUBLIC
  Undocumented
• twisted.trial.reporter.TrialFailure
  twisted.trial.reporter.html#TrialFailure
  Attribute
  Type Alias
  PUBLIC
  Undocumented
• 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.TestCases.
• 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._startTime
  twisted.trial.reporter.TestResult.html#_startTime
  Attribute
  Instance Variable
  PRIVATE
  The time when the current test was started. It defaults to None, which means that the test was skipped.
• twisted.trial.reporter.TestResult._lastTime
  twisted.trial.reporter.TestResult.html#_lastTime
  Attribute
  Instance Variable
  PRIVATE
  The duration of the current test run. It defaults to None, which means that the test was skipped.
• twisted.trial.reporter.TestResult._DEFAULT_TODO
  twisted.trial.reporter.TestResult.html#_DEFAULT_TODO
  Attribute
  Constant
  PRIVATE
  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._testStarted
  twisted.trial.reporter.TestResult.html#_testStarted
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• twisted.trial.reporter.TestResult.__init__
  twisted.trial.reporter.TestResult.html#__init__
  Function
  Method
  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.stopTest
  twisted.trial.reporter.TestResult.html#stopTest
  Function
  Method
  PUBLIC
  This must be called after the given test is completed.
• 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.DirtyReactorAggregateErrors 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.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._P
  twisted.trial._asynctest.html#_P
  Attribute
  Constant
  PRIVATE
  Undocumented
• 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.Deferreds. 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.Failures 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 TestResults. If todo'd tests fail, they do not fail the suite and the errors are reported in a separate category...
• twisted.trial.unittest.Todo.reason
  twisted.trial.unittest.Todo.html#reason
  Attribute
  Instance Variable
  PUBLIC
  A string explaining why the test is marked 'todo'
• twisted.trial.unittest.Todo.errors
  twisted.trial.unittest.Todo.html#errors
  Attribute
  Instance Variable
  PUBLIC
  An iterable of exception types that the test is expected to raise. If one of these errors is raised by the test, it will be trapped. Raising any other kind of error will fail the test. If None then all errors will be trapped.
• 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.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.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._ArchiveStr
  twisted.python.zippath.html#_ArchiveStr
  Attribute
  Type Variable
  PRIVATE
  Undocumented
• twisted.python.zippath._ZipStr
  twisted.python.zippath.html#_ZipStr
  Attribute
  Type Variable
  PRIVATE
  Undocumented
• twisted.python.zippath._ZipSelf
  twisted.python.zippath.html#_ZipSelf
  Attribute
  Type Variable
  PRIVATE
  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.path
  twisted.python.zippath.ZipPath.html#path
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• 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._nativePathInArchive
  twisted.python.zippath.ZipPath.html#_nativePathInArchive
  Attribute
  Instance Variable
  PRIVATE
  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._nativeParent
  twisted.python.zippath.ZipPath.html#_nativeParent
  Function
  Method
  PRIVATE
  Return parent, discarding our own encoding in favor of whatever the archive's is.
• twisted.python.zippath.ZipPath.parent
  twisted.python.zippath.ZipPath.html#parent
  Function
  Method
  PUBLIC
  Subclasses must implement this.
• twisted.python.zippath.ZipPath.parents
  twisted.python.zippath.ZipPath.html#parents
  Function
  Method
  PUBLIC
  Retrieve an iterator of all the ancestors of this 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
  Subclasses must implement this.
• 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
  Subclasses must implement this.
• 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
  Subclasses must implement this.
• 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
  Subclasses must implement this.
• 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._zipfileFilename
  twisted.python.zippath.ZipArchive.html#_zipfileFilename
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• 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.__cmp__
  twisted.python.zippath.ZipArchive.html#__cmp__
  Function
  Method
  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.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.application._client_service.T
  twisted.application._client_service.html#T
  Attribute
  Type Variable
  PUBLIC
  Undocumented
• twisted.application._client_service._maybeGlobalReactor
  twisted.application._client_service.html#_maybeGlobalReactor
  Function
  Function
  PRIVATE
  No summary
• twisted.application._client_service._Client
  twisted.application._client_service._Client.html
  Class
  Class
  PRIVATE
  No class docstring; 7/7 methods documented
• twisted.application._client_service._Client.start
  twisted.application._client_service._Client.html#start
  Function
  Method
  PUBLIC
  Start this ClientService, initiating the connection retry loop.
• twisted.application._client_service._Client.stop
  twisted.application._client_service._Client.html#stop
  Function
  Method
  PUBLIC
  Stop trying to connect and disconnect any current connection.
• twisted.application._client_service._Client._connectionMade
  twisted.application._client_service._Client.html#_connectionMade
  Function
  Method
  PRIVATE
  A connection has been made.
• twisted.application._client_service._Client._connectionFailed
  twisted.application._client_service._Client.html#_connectionFailed
  Function
  Method
  PRIVATE
  Deliver connection failures to any ClientService.whenConnected Deferreds that have met their failAfterFailures threshold.
• twisted.application._client_service._Client._reconnect
  twisted.application._client_service._Client.html#_reconnect
  Function
  Method
  PRIVATE
  The wait between connection attempts is done.
• twisted.application._client_service._Client._clientDisconnected
  twisted.application._client_service._Client.html#_clientDisconnected
  Function
  Method
  PRIVATE
  The current connection has been disconnected.
• twisted.application._client_service._Client.whenConnected
  twisted.application._client_service._Client.html#whenConnected
  Function
  Method
  PUBLIC
  Retrieve the currently-connected Protocol, or the next one to connect.
• twisted.application._client_service._ReconnectingProtocolProxy
  twisted.application._client_service._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._client_service._ReconnectingProtocolProxy.__init__
  twisted.application._client_service._ReconnectingProtocolProxy.html#__init__
  Function
  Method
  PUBLIC
  Create a _ReconnectingProtocolProxy.
• twisted.application._client_service._ReconnectingProtocolProxy._protocol
  twisted.application._client_service._ReconnectingProtocolProxy.html#_protocol
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• twisted.application._client_service._ReconnectingProtocolProxy._lostNotification
  twisted.application._client_service._ReconnectingProtocolProxy.html#_lostNotification
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• twisted.application._client_service._ReconnectingProtocolProxy.makeConnection
  twisted.application._client_service._ReconnectingProtocolProxy.html#makeConnection
  Function
  Method
  PUBLIC
  Make a connection to a transport and a server.
• twisted.application._client_service._ReconnectingProtocolProxy._transport
  twisted.application._client_service._ReconnectingProtocolProxy.html#_transport
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• twisted.application._client_service._ReconnectingProtocolProxy.connectionLost
  twisted.application._client_service._ReconnectingProtocolProxy.html#connectionLost
  Function
  Method
  PUBLIC
  The connection was lost. Relay this information.
• twisted.application._client_service._ReconnectingProtocolProxy.__getattr__
  twisted.application._client_service._ReconnectingProtocolProxy.html#__getattr__
  Function
  Method
  PUBLIC
  Undocumented
• twisted.application._client_service._ReconnectingProtocolProxy.__repr__
  twisted.application._client_service._ReconnectingProtocolProxy.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
• twisted.application._client_service._DisconnectFactory
  twisted.application._client_service._DisconnectFactory.html
  Class
  Class
  PRIVATE
  A _DisconnectFactory is a proxy for IProtocolFactory that catches connectionLost notifications and relays them.
• twisted.application._client_service._DisconnectFactory.__init__
  twisted.application._client_service._DisconnectFactory.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• twisted.application._client_service._DisconnectFactory._protocolFactory
  twisted.application._client_service._DisconnectFactory.html#_protocolFactory
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• twisted.application._client_service._DisconnectFactory._protocolDisconnected
  twisted.application._client_service._DisconnectFactory.html#_protocolDisconnected
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• twisted.application._client_service._DisconnectFactory.buildProtocol
  twisted.application._client_service._DisconnectFactory.html#buildProtocol
  Function
  Method
  PUBLIC
  Create a _ReconnectingProtocolProxy with the disconnect-notification callback we were called with.
• twisted.application._client_service._DisconnectFactory.__getattr__
  twisted.application._client_service._DisconnectFactory.html#__getattr__
  Function
  Method
  PUBLIC
  Undocumented
• twisted.application._client_service._DisconnectFactory.__repr__
  twisted.application._client_service._DisconnectFactory.html#__repr__
  Function
  Method
  PUBLIC
  Undocumented
• twisted.application._client_service._deinterface
  twisted.application._client_service.html#_deinterface
  Function
  Function
  PRIVATE
  Remove the special runtime attributes set by implementer so that a class can proxy through those attributes with __getattr__ and thereby forward optionally-provided interfaces by the delegated class.
• twisted.application._client_service._Core
  twisted.application._client_service._Core.html
  Class
  Class
  PRIVATE
  Shared core for ClientService state machine.
• twisted.application._client_service._Core.endpoint
  twisted.application._client_service._Core.html#endpoint
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• twisted.application._client_service._Core.factory
  twisted.application._client_service._Core.html#factory
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• twisted.application._client_service._Core.timeoutForAttempt
  twisted.application._client_service._Core.html#timeoutForAttempt
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• twisted.application._client_service._Core.clock
  twisted.application._client_service._Core.html#clock
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• twisted.application._client_service._Core.prepareConnection
  twisted.application._client_service._Core.html#prepareConnection
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• twisted.application._client_service._Core.stopWaiters
  twisted.application._client_service._Core.html#stopWaiters
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• twisted.application._client_service._Core.awaitingConnected
  twisted.application._client_service._Core.html#awaitingConnected
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• twisted.application._client_service._Core.failedAttempts
  twisted.application._client_service._Core.html#failedAttempts
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• twisted.application._client_service._Core.log
  twisted.application._client_service._Core.html#log
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• twisted.application._client_service._Core.waitForStop
  twisted.application._client_service._Core.html#waitForStop
  Function
  Method
  PUBLIC
  Undocumented
• twisted.application._client_service._Core.unawait
  twisted.application._client_service._Core.html#unawait
  Function
  Method
  PUBLIC
  Undocumented
• twisted.application._client_service._Core.cancelConnectWaiters
  twisted.application._client_service._Core.html#cancelConnectWaiters
  Function
  Method
  PUBLIC
  Undocumented
• twisted.application._client_service._Core.finishStopping
  twisted.application._client_service._Core.html#finishStopping
  Function
  Method
  PUBLIC
  Undocumented
• twisted.application._client_service.makeMachine
  twisted.application._client_service.html#makeMachine
  Function
  Function
  PUBLIC
  Undocumented
• twisted.application._client_service._defaultPolicy
  twisted.application._client_service.html#_defaultPolicy
  Attribute
  Variable
  PRIVATE
  Undocumented
• twisted.application._client_service.ClientMachine
  twisted.application._client_service.html#ClientMachine
  Attribute
  Variable
  PUBLIC
  Undocumented
• 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.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.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
  Instance 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
  Instance 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.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.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._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
  Instance 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
  Instance 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
  Instance 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
  Instance 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
  Instance 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
  Instance 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
  Instance 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
  Instance 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
  Instance 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
  Instance 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.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
  Instance Variable
  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
  Instance Variable
  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
  Instance Variable
  PUBLIC
  Undocumented
• twisted.protocols.basic.Int32StringReceiver.prefixLength
  twisted.protocols.basic.Int32StringReceiver.html#prefixLength
  Attribute
  Instance 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
  Instance Variable
  PUBLIC
  Undocumented
• twisted.protocols.basic.Int16StringReceiver.prefixLength
  twisted.protocols.basic.Int16StringReceiver.html#prefixLength
  Attribute
  Instance 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
  Instance Variable
  PUBLIC
  Undocumented
• twisted.protocols.basic.Int8StringReceiver.prefixLength
  twisted.protocols.basic.Int8StringReceiver.html#prefixLength
  Attribute
  Instance 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._P
  twisted.internet.testing.html#_P
  Attribute
  Constant
  PRIVATE
  Undocumented
• 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.testing._T
  twisted.internet.testing.html#_T
  Attribute
  Type Variable
  PRIVATE
  Undocumented
• twisted.internet.testing._benchmarkWithReactor
  twisted.internet.testing.html#_benchmarkWithReactor
  Function
  Function
  PRIVATE
  Decorator for running a benchmark tests that loops the reactor.
• twisted.internet.testing._runReactor
  twisted.internet.testing.html#_runReactor
  Function
  Function
  PRIVATE
  (re)Start a reactor that might have been previously started.
• twisted.internet.testing._stopReactor
  twisted.internet.testing.html#_stopReactor
  Function
  Function
  PRIVATE
  Stop the reactor and allow it to be re-started later.
• 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._win32stdio._log
  twisted.internet._win32stdio.html#_log
  Attribute
  Variable
  PRIVATE
  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._names
  twisted.python.systemd.ListenFDs.html#_names
  Attribute
  Instance Variable
  PRIVATE
  A Sequence of str giving the names of the descriptors which were inherited.
• 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.python.systemd.ListenFDs.inheritedNamedDescriptors
  twisted.python.systemd.ListenFDs.html#inheritedNamedDescriptors
  Function
  Method
  PUBLIC
  No summary
• twisted.python.systemd._parseDescriptors
  twisted.python.systemd.html#_parseDescriptors
  Function
  Function
  PRIVATE
  Parse the LISTEN_FDS environment variable supplied by systemd.
• twisted.python.systemd._parseNames
  twisted.python.systemd.html#_parseNames
  Function
  Function
  PRIVATE
  Parse the LISTEN_FDNAMES environment variable supplied by systemd.
• 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._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
  Variable
  PRIVATE
  Undocumented
• twisted.internet.endpoints._STRING
  twisted.internet.endpoints.html#_STRING
  Attribute
  Variable
  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._lastUID
  twisted.python.fakepwd.UserDatabase.html#_lastUID
  Attribute
  Class Variable
  PRIVATE
  Undocumented
• twisted.python.fakepwd.UserDatabase._lastGID
  twisted.python.fakepwd.UserDatabase.html#_lastGID
  Attribute
  Class Variable
  PRIVATE
  Undocumented
• 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.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.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.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.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._sk
  twisted.conch.ssh.keys.Key.html#_sk
  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.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.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 Deferreds.
• 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.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.UserRecord
  twisted.conch.checkers.UserRecord.html
  Class
  Class
  PUBLIC
  A record in a UNIX-style password database. See pwd for field details.
• twisted.conch.checkers.UserRecord.pw_dir
  twisted.conch.checkers.UserRecord.html#pw_dir
  Attribute
  Property
  PUBLIC
  Undocumented
• twisted.conch.checkers.UserDB
  twisted.conch.checkers.UserDB.html
  Class
  Class
  PUBLIC
  A database of users by name, like the stdlib pwd module.
• twisted.conch.checkers.UserDB.getpwnam
  twisted.conch.checkers.UserDB.html#getpwnam
  Function
  Method
  PUBLIC
  Lookup a user record by name.
• twisted.conch.checkers.pwd
  twisted.conch.checkers.html#pwd
  Attribute
  Variable
  PUBLIC
  Undocumented
• twisted.conch.checkers.CryptedPasswordRecord
  twisted.conch.checkers.CryptedPasswordRecord.html
  Class
  Class
  PUBLIC
  A sequence where the item at index 1 may be a crypted password.
• twisted.conch.checkers.CryptedPasswordRecord.__getitem__
  twisted.conch.checkers.CryptedPasswordRecord.html#__getitem__
  Function
  Method
  PUBLIC
  Get the crypted password.
• twisted.conch.checkers._lookupUser
  twisted.conch.checkers.html#_lookupUser
  Function
  Function
  PRIVATE
  Lookup a user by name in a pwd-style database.
• 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 validate 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._userdb
  twisted.conch.checkers.SSHPublicKeyDatabase.html#_userdb
  Attribute
  Class Variable
  PRIVATE
  Undocumented
• 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.Keys.
• 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
  Look up the authorized keys for a user.
• 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._userdb
  twisted.conch.checkers.UNIXAuthorizedKeysFiles.html#_userdb
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• twisted.conch.checkers.UNIXAuthorizedKeysFiles.__init__
  twisted.conch.checkers.UNIXAuthorizedKeysFiles.html#__init__
  Function
  Method
  PUBLIC
  Initializes a new UNIXAuthorizedKeysFiles.
• 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._DigestMod
  twisted.conch.ssh.transport.html#_DigestMod
  Attribute
  Type Alias
  PRIVATE
  Undocumented
• 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
  Variable
  PUBLIC
  Undocumented
• twisted.conch.ssh.transport.DH_PRIME
  twisted.conch.ssh.transport.html#DH_PRIME
  Attribute
  Variable
  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
  Instance 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._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.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
  Variable
  PUBLIC
  Undocumented
• twisted.conch.insults.helper.RED
  twisted.conch.insults.helper.html#RED
  Attribute
  Variable
  PUBLIC
  Undocumented
• twisted.conch.insults.helper.GREEN
  twisted.conch.insults.helper.html#GREEN
  Attribute
  Variable
  PUBLIC
  Undocumented
• twisted.conch.insults.helper.YELLOW
  twisted.conch.insults.helper.html#YELLOW
  Attribute
  Variable
  PUBLIC
  Undocumented
• twisted.conch.insults.helper.BLUE
  twisted.conch.insults.helper.html#BLUE
  Attribute
  Variable
  PUBLIC
  Undocumented
• twisted.conch.insults.helper.MAGENTA
  twisted.conch.insults.helper.html#MAGENTA
  Attribute
  Variable
  PUBLIC
  Undocumented
• twisted.conch.insults.helper.CYAN
  twisted.conch.insults.helper.html#CYAN
  Attribute
  Variable
  PUBLIC
  Undocumented
• twisted.conch.insults.helper.WHITE
  twisted.conch.insults.helper.html#WHITE
  Attribute
  Variable
  PUBLIC
  Undocumented
• twisted.conch.insults.helper.N_COLORS
  twisted.conch.insults.helper.html#N_COLORS
  Attribute
  Variable
  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
  Instance 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
  Class Variable
  PUBLIC
  Undocumented
• twisted.conch.insults.window._Box.CENTER
  twisted.conch.insults.window._Box.html#CENTER
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• twisted.conch.insults.window._Box.BOTTOM
  twisted.conch.insults.window._Box.html#BOTTOM
  Attribute
  Class Variable
  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
  Instance 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
  Class Variable
  PUBLIC
  Undocumented
• twisted.conch.insults.window.TextOutputArea.TRUNCATE
  twisted.conch.insults.window.TextOutputArea.html#TRUNCATE
  Attribute
  Class Variable
  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 ITerminalTransports.
• 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
  Instance 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.monkeyPatcher
  twisted.conch.manhole.ManholeInterpreter.html#monkeyPatcher
  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.excepthook
  twisted.conch.manhole.ManholeInterpreter.html#excepthook
  Function
  Method
  PUBLIC
  Format exception tracebacks and write them to the output handler.
• 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.primes
  twisted.conch.ssh.factory.SSHFactory.html#primes
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• 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.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
  Instance 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
  Instance Variable
  PUBLIC
  Undocumented
• twisted.conch.manhole_ssh.ConchFactory.privateKeys
  twisted.conch.manhole_ssh.ConchFactory.html#privateKeys
  Attribute
  Instance 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._InterfaceItself
  twisted.cred.portal.html#_InterfaceItself
  Attribute
  Type Alias
  PRIVATE
  Undocumented
• twisted.cred.portal._requestResult
  twisted.cred.portal.html#_requestResult
  Attribute
  Type Alias
  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.checkers
  twisted.cred.portal.Portal.html#checkers
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• 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.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
  Instance 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._getKeyOrDefault
  twisted.conch.scripts.ckeygen.html#_getKeyOrDefault
  Function
  Function
  PRIVATE
  If options["filename"] is None, prompt the user to enter a path or attempt to set it to .ssh/id_rsa
• 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
  Instance 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
  Instance 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
  Instance 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
  Class Variable
  PUBLIC
  Undocumented
• twisted.conch.ui.ansi.ColorText.RED
  twisted.conch.ui.ansi.ColorText.html#RED
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• twisted.conch.ui.ansi.ColorText.GREEN
  twisted.conch.ui.ansi.ColorText.html#GREEN
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• twisted.conch.ui.ansi.ColorText.YELLOW
  twisted.conch.ui.ansi.ColorText.html#YELLOW
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• twisted.conch.ui.ansi.ColorText.BLUE
  twisted.conch.ui.ansi.ColorText.html#BLUE
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• twisted.conch.ui.ansi.ColorText.MAGENTA
  twisted.conch.ui.ansi.ColorText.html#MAGENTA
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• twisted.conch.ui.ansi.ColorText.CYAN
  twisted.conch.ui.ansi.ColorText.html#CYAN
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• twisted.conch.ui.ansi.ColorText.WHITE
  twisted.conch.ui.ansi.ColorText.html#WHITE
  Attribute
  Class Variable
  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
  Instance 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.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._deprecate.deprecatedGnomeReactor
  twisted.internet._deprecate.html#deprecatedGnomeReactor
  Function
  Function
  PUBLIC
  Emit a deprecation warning about a gnome-related reactor.
• 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._multicast._maybeResolve
  twisted.internet._multicast.html#_maybeResolve
  Function
  Function
  PRIVATE
  Undocumented
• twisted.internet._multicast.MulticastMixin
  twisted.internet._multicast.MulticastMixin.html
  Class
  Class
  PUBLIC
  Implement multicast functionality.
• twisted.internet._multicast.MulticastMixin.addressFamily
  twisted.internet._multicast.MulticastMixin.html#addressFamily
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• twisted.internet._multicast.MulticastMixin.reactor
  twisted.internet._multicast.MulticastMixin.html#reactor
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• twisted.internet._multicast.MulticastMixin.socket
  twisted.internet._multicast.MulticastMixin.html#socket
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• twisted.internet._multicast.MulticastMixin._addrpack
  twisted.internet._multicast.MulticastMixin.html#_addrpack
  Function
  Method
  PRIVATE
  Pack an IP address literal into bytes, according to the address family of this transport.
• twisted.internet._multicast.MulticastMixin._ipproto
  twisted.internet._multicast.MulticastMixin.html#_ipproto
  Attribute
  Property
  PRIVATE
  Undocumented
• twisted.internet._multicast.MulticastMixin._multiloop
  twisted.internet._multicast.MulticastMixin.html#_multiloop
  Attribute
  Property
  PRIVATE
  Undocumented
• twisted.internet._multicast.MulticastMixin._multiif
  twisted.internet._multicast.MulticastMixin.html#_multiif
  Attribute
  Property
  PRIVATE
  Undocumented
• twisted.internet._multicast.MulticastMixin._joingroup
  twisted.internet._multicast.MulticastMixin.html#_joingroup
  Attribute
  Property
  PRIVATE
  Undocumented
• twisted.internet._multicast.MulticastMixin._leavegroup
  twisted.internet._multicast.MulticastMixin.html#_leavegroup
  Attribute
  Property
  PRIVATE
  Undocumented
• twisted.internet._multicast.MulticastMixin.getOutgoingInterface
  twisted.internet._multicast.MulticastMixin.html#getOutgoingInterface
  Function
  Method
  PUBLIC
  Undocumented
• twisted.internet._multicast.MulticastMixin.setOutgoingInterface
  twisted.internet._multicast.MulticastMixin.html#setOutgoingInterface
  Function
  Method
  PUBLIC
  No summary
• twisted.internet._multicast.MulticastMixin.getLoopbackMode
  twisted.internet._multicast.MulticastMixin.html#getLoopbackMode
  Function
  Method
  PUBLIC
  Undocumented
• twisted.internet._multicast.MulticastMixin.setLoopbackMode
  twisted.internet._multicast.MulticastMixin.html#setLoopbackMode
  Function
  Method
  PUBLIC
  Undocumented
• twisted.internet._multicast.MulticastMixin.getTTL
  twisted.internet._multicast.MulticastMixin.html#getTTL
  Function
  Method
  PUBLIC
  Undocumented
• twisted.internet._multicast.MulticastMixin.setTTL
  twisted.internet._multicast.MulticastMixin.html#setTTL
  Function
  Method
  PUBLIC
  Undocumented
• twisted.internet._multicast.MulticastMixin._joinleave
  twisted.internet._multicast.MulticastMixin.html#_joinleave
  Function
  Method
  PRIVATE
  Undocumented
• twisted.internet._multicast.MulticastMixin.joinGroup
  twisted.internet._multicast.MulticastMixin.html#joinGroup
  Function
  Method
  PUBLIC
  No summary
• twisted.internet._multicast.MulticastMixin.leaveGroup
  twisted.internet._multicast.MulticastMixin.html#leaveGroup
  Function
  Method
  PUBLIC
  No summary
• 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.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
  Override Port.createInternetSocket to configure the socket to honor the listenMultiple argument to IReactorMulticast.listenMultiple.
• 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.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, 1/5 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.Server.getTcpNoDelay
  twisted.internet.unix.Server.html#getTcpNoDelay
  Function
  Method
  PUBLIC
  FIXME:https://github.com/twisted/twisted/issues/12369
• twisted.internet.unix.Server.setTcpNoDelay
  twisted.internet.unix.Server.html#setTcpNoDelay
  Function
  Method
  PUBLIC
  Enable/disable TCP_NODELAY.
• 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.Client.getTcpNoDelay
  twisted.internet.unix.Client.html#getTcpNoDelay
  Function
  Method
  PUBLIC
  FIXME:https://github.com/twisted/twisted/issues/12369
• twisted.internet.unix.Client.setTcpNoDelay
  twisted.internet.unix.Client.html#setTcpNoDelay
  Function
  Method
  PUBLIC
  Enable/disable TCP_NODELAY.
• 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._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._wakerFactory
  twisted.internet.posixbase.PosixReactorBase.html#_wakerFactory
  Function
  Method
  PRIVATE
  Undocumented
• 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._signalsFactory
  twisted.internet.posixbase.PosixReactorBase.html#_signalsFactory
  Function
  Method
  PRIVATE
  Customize reactor signal handling to support child processes on POSIX platforms.
• 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 IReadDescriptors and IWriteDescriptors.
• 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._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.__init__
  twisted.internet._glibbase.GlibWaker.html#__init__
  Function
  Method
  PUBLIC
  Initialize.
• twisted.internet._glibbase.GlibWaker.reactor
  twisted.internet._glibbase.GlibWaker.html#reactor
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• 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._signalGlue
  twisted.internet._glibbase.html#_signalGlue
  Function
  Function
  PRIVATE
  Integrate glib's wakeup file descriptor usage and our own.
• twisted.internet._glibbase._loopQuitter
  twisted.internet._glibbase.html#_loopQuitter
  Function
  Function
  PRIVATE
  Combine the glib.idle_add and glib.MainLoop.quit functions into a function suitable for crashing the reactor.
• 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._wakerFactory
  twisted.internet._glibbase.GlibReactorBase.html#_wakerFactory
  Function
  Method
  PRIVATE
  Undocumented
• 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._POLL_DISCONNECTED
  twisted.internet._glibbase.GlibReactorBase.html#_POLL_DISCONNECTED
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• twisted.internet._glibbase.GlibReactorBase._POLL_IN
  twisted.internet._glibbase.GlibReactorBase.html#_POLL_IN
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• twisted.internet._glibbase.GlibReactorBase._POLL_OUT
  twisted.internet._glibbase.GlibReactorBase.html#_POLL_OUT
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• twisted.internet._glibbase.GlibReactorBase.INFLAGS
  twisted.internet._glibbase.GlibReactorBase.html#INFLAGS
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• twisted.internet._glibbase.GlibReactorBase.OUTFLAGS
  twisted.internet._glibbase.GlibReactorBase.html#OUTFLAGS
  Attribute
  Instance Variable
  PUBLIC
  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.context
  twisted.internet._glibbase.GlibReactorBase.html#context
  Attribute
  Instance Variable
  PUBLIC
  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.loop
  twisted.internet._glibbase.GlibReactorBase.html#loop
  Attribute
  Instance Variable
  PUBLIC
  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._reallyStartRunning
  twisted.internet._glibbase.GlibReactorBase.html#_reallyStartRunning
  Function
  Method
  PRIVATE
  Make sure the reactor's signal handlers are installed despite any outside interference.
• 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 FileDescriptors.
• 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.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
  Instance 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
  Instance 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._log
  twisted.internet._posixstdio.html#_log
  Attribute
  Variable
  PRIVATE
  Undocumented
• 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.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._T
  twisted.internet.selectreactor.html#_T
  Attribute
  Type Variable
  PRIVATE
  Undocumented
• twisted.internet.selectreactor._onePreen
  twisted.internet.selectreactor.html#_onePreen
  Function
  Function
  PRIVATE
  Undocumented
• twisted.internet.selectreactor._preenDescriptors
  twisted.internet.selectreactor.html#_preenDescriptors
  Function
  Function
  PRIVATE
  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._threadedselect._log
  twisted.internet._threadedselect.html#_log
  Attribute
  Variable
  PRIVATE
  Undocumented
• twisted.internet._threadedselect.raiseException
  twisted.internet._threadedselect.html#raiseException
  Function
  Function
  PUBLIC
  Undocumented
• twisted.internet._threadedselect._threadsafeSelect
  twisted.internet._threadedselect.html#_threadsafeSelect
  Function
  Function
  PRIVATE
  Invoke select. This will be called in a non-main thread, so it is very careful to work only on integers and avoid calling any application code.
• 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._selectorThread
  twisted.internet._threadedselect.ThreadedSelectReactor.html#_selectorThread
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• twisted.internet._threadedselect.ThreadedSelectReactor.mainWaker
  twisted.internet._threadedselect.ThreadedSelectReactor.html#mainWaker
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• twisted.internet._threadedselect.ThreadedSelectReactor._iterationQueue
  twisted.internet._threadedselect.ThreadedSelectReactor.html#_iterationQueue
  Attribute
  Instance Variable
  PRIVATE
  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._doReadOrWrite
  twisted.internet._threadedselect.ThreadedSelectReactor.html#_doReadOrWrite
  Function
  Method
  PRIVATE
  Undocumented
• twisted.internet._threadedselect.ThreadedSelectReactor._selectOnce
  twisted.internet._threadedselect.ThreadedSelectReactor.html#_selectOnce
  Function
  Method
  PRIVATE
  Undocumented
• twisted.internet._threadedselect.ThreadedSelectReactor._cleanUpThread
  twisted.internet._threadedselect.ThreadedSelectReactor.html#_cleanUpThread
  Function
  Method
  PRIVATE
  Ensure that the selector thread is stopped.
• 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.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.crash
  twisted.internet._threadedselect.ThreadedSelectReactor.html#crash
  Function
  Method
  PUBLIC
  See twisted.internet.interfaces.IReactorCore.crash.
• twisted.internet._threadedselect.ThreadedSelectReactor._testMainLoopSetup
  twisted.internet._threadedselect.ThreadedSelectReactor.html#_testMainLoopSetup
  Function
  Method
  PRIVATE
  Mostly for compliance with IReactorCore and usability with the tests, set up a fake blocking main-loop; make the "foreign" main loop we are interfacing with be self.mainLoop(), that is reading from a basic Queue.
• twisted.internet._threadedselect.ThreadedSelectReactor._uninstallHandler
  twisted.internet._threadedselect.ThreadedSelectReactor.html#_uninstallHandler
  Function
  Method
  PRIVATE
  Handle uninstallation to ensure that cleanup is properly performed by ReactorBuilder tests.
• twisted.internet._threadedselect.ThreadedSelectReactor.iterate
  twisted.internet._threadedselect.ThreadedSelectReactor.html#iterate
  Function
  Method
  PUBLIC
  See twisted.internet.interfaces.IReactorCore.iterate.
• twisted.internet._threadedselect.ThreadedSelectReactor.doIteration
  twisted.internet._threadedselect.ThreadedSelectReactor.html#doIteration
  Function
  Method
  PUBLIC
  Do one iteration over the readers and writers which have been added.
• twisted.internet._threadedselect.ThreadedSelectReactor.mainLoop
  twisted.internet._threadedselect.ThreadedSelectReactor.html#mainLoop
  Function
  Method
  PUBLIC
  This should not normally be run.
• 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.__init__
  twisted.internet.cfreactor._WakerPlus.html#__init__
  Function
  Method
  PUBLIC
  Initialize.
• twisted.internet.cfreactor._WakerPlus.reactor
  twisted.internet.cfreactor._WakerPlus.html#reactor
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• 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._wakerFactory
  twisted.internet.cfreactor.CFReactor.html#_wakerFactory
  Function
  Method
  PRIVATE
  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.startRunning
  twisted.internet.cfreactor.CFReactor.html#startRunning
  Function
  Method
  PUBLIC
  Start running the reactor, then kick off the timer that advances Twisted's clock to keep pace with CFRunLoop's.
• 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._started
  twisted.internet.cfreactor.CFReactor.html#_started
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• twisted.internet.cfreactor.CFReactor._stopSimulating
  twisted.internet.cfreactor.CFReactor.html#_stopSimulating
  Function
  Method
  PRIVATE
  If we have a CFRunLoopTimer registered with the CFRunLoop, invalidate it and set it to None.
• 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.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
  Variable
  PUBLIC
  Undocumented
• twisted.internet.epollreactor.EPOLLERR
  twisted.internet.epollreactor.html#EPOLLERR
  Attribute
  Variable
  PUBLIC
  Undocumented
• twisted.internet.epollreactor.EPOLLIN
  twisted.internet.epollreactor.html#EPOLLIN
  Attribute
  Variable
  PUBLIC
  Undocumented
• twisted.internet.epollreactor.EPOLLOUT
  twisted.internet.epollreactor.html#EPOLLOUT
  Attribute
  Variable
  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.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.__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
  Undocumented
• 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.PortableGIReactor.simulate
  twisted.internet.gireactor.PortableGIReactor.html#simulate
  Function
  Method
  PUBLIC
  For compatibility only. Do nothing.
• 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.__init__
  twisted.internet.gtk2reactor.Gtk2Reactor.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• 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.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.reactor
  twisted.internet.iocpreactor.udp.Port.html#reactor
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• 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.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
  Variable
  PUBLIC
  Undocumented
• twisted.internet.iocpreactor.reactor.KEY_WAKEUP
  twisted.internet.iocpreactor.reactor.html#KEY_WAKEUP
  Attribute
  Variable
  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
  Variable
  PUBLIC
  Undocumented
• twisted.internet.kqreactor.KQ_EV_DELETE
  twisted.internet.kqreactor.html#KQ_EV_DELETE
  Attribute
  Variable
  PUBLIC
  Undocumented
• twisted.internet.kqreactor.KQ_EV_EOF
  twisted.internet.kqreactor.html#KQ_EV_EOF
  Attribute
  Variable
  PUBLIC
  Undocumented
• twisted.internet.kqreactor.KQ_FILTER_READ
  twisted.internet.kqreactor.html#KQ_FILTER_READ
  Attribute
  Variable
  PUBLIC
  Undocumented
• twisted.internet.kqreactor.KQ_FILTER_WRITE
  twisted.internet.kqreactor.html#KQ_FILTER_WRITE
  Attribute
  Variable
  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 FileDescriptors 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 FileDescriptors 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.trial.runner._P
  twisted.trial.runner.html#_P
  Attribute
  Constant
  PRIVATE
  Undocumented
• twisted.trial.runner._Debugger
  twisted.trial.runner._Debugger.html
  Class
  Class
  PRIVATE
  Undocumented
• twisted.trial.runner._Debugger.runcall
  twisted.trial.runner._Debugger.html#runcall
  Function
  Method
  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._Loadable
  twisted.trial.runner.html#_Loadable
  Attribute
  Type Alias
  PRIVATE
  Undocumented
• 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 TestCases, 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.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 TestCases.
• twisted.trial.runner.TestLoader.getTestCaseNames
  twisted.trial.runner.TestLoader.html#getTestCaseNames
  Function
  Method
  PUBLIC
  Given a class that contains TestCases, return a list of names of methods that probably contain tests.
• 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._testDirectory
  twisted.trial.runner.html#_testDirectory
  Function
  Function
  PRIVATE
  A context manager which obtains a lock on a trial working directory and enters (os.chdir) it and then reverses these things.
• twisted.trial.runner._logFile
  twisted.trial.runner.html#_logFile
  Function
  Function
  PRIVATE
  A context manager which adds a log observer and then removes it.
• twisted.trial.runner._Runner
  twisted.trial.runner._Runner.html
  Class
  Class
  PRIVATE
  Undocumented
• twisted.trial.runner._Runner.stream
  twisted.trial.runner._Runner.html#stream
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• twisted.trial.runner._Runner.run
  twisted.trial.runner._Runner.html#run
  Function
  Method
  PUBLIC
  Undocumented
• twisted.trial.runner._Runner.runUntilFailure
  twisted.trial.runner._Runner.html#runUntilFailure
  Function
  Method
  PUBLIC
  Undocumented
• 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.reporterFactory
  twisted.trial.runner.TrialRunner.html#reporterFactory
  Attribute
  Instance Variable
  PUBLIC
  A callable to create a reporter to use.
• twisted.trial.runner.TrialRunner.mode
  twisted.trial.runner.TrialRunner.html#mode
  Attribute
  Instance Variable
  PUBLIC
  Either None for a normal test run, TrialRunner.DEBUG for a run in the debugger, or TrialRunner.DRY_RUN to collect and report the tests but not call any of them.
• twisted.trial.runner.TrialRunner.logfile
  twisted.trial.runner.TrialRunner.html#logfile
  Attribute
  Instance Variable
  PUBLIC
  The path to the file to write the test run log.
• twisted.trial.runner.TrialRunner.stream
  twisted.trial.runner.TrialRunner.html#stream
  Attribute
  Instance Variable
  PUBLIC
  The file to report results to.
• twisted.trial.runner.TrialRunner.profile
  twisted.trial.runner.TrialRunner.html#profile
  Attribute
  Instance Variable
  PUBLIC
  True to run the tests with a profiler enabled.
• twisted.trial.runner.TrialRunner._tracebackFormat
  twisted.trial.runner.TrialRunner.html#_tracebackFormat
  Attribute
  Instance Variable
  PRIVATE
  A format name to use with Failure for reporting failures.
• twisted.trial.runner.TrialRunner._realTimeErrors
  twisted.trial.runner.TrialRunner.html#_realTimeErrors
  Attribute
  Instance Variable
  PRIVATE
  True if errors should be reported as they happen. False if they should only be reported at the end of the test run in the summary.
• twisted.trial.runner.TrialRunner.uncleanWarnings
  twisted.trial.runner.TrialRunner.html#uncleanWarnings
  Attribute
  Instance Variable
  PUBLIC
  True to report dirty reactor errors as warnings, False to report them as test-failing errors.
• twisted.trial.runner.TrialRunner.workingDirectory
  twisted.trial.runner.TrialRunner.html#workingDirectory
  Attribute
  Instance Variable
  PUBLIC
  A path template to a directory which will be the process's working directory while the tests are running.
• twisted.trial.runner.TrialRunner._forceGarbageCollection
  twisted.trial.runner.TrialRunner.html#_forceGarbageCollection
  Attribute
  Instance Variable
  PRIVATE
  True to perform a full garbage collection at least after each test. False to let garbage collection run only when it normally would.
• twisted.trial.runner.TrialRunner.debugger
  twisted.trial.runner.TrialRunner.html#debugger
  Attribute
  Instance Variable
  PUBLIC
  In debug mode, an object to use to launch the debugger.
• twisted.trial.runner.TrialRunner._exitFirst
  twisted.trial.runner.TrialRunner.html#_exitFirst
  Attribute
  Instance Variable
  PRIVATE
  True to stop after the first failed test. False to run the whole suite.
• twisted.trial.runner.TrialRunner.log
  twisted.trial.runner.TrialRunner.html#log
  Attribute
  Instance Variable
  PUBLIC
  An object to give to the reporter to use as a log publisher.
• 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._makeResult
  twisted.trial.runner.TrialRunner.html#_makeResult
  Function
  Method
  PRIVATE
  Undocumented
• twisted.trial.runner.TrialRunner.tbformat
  twisted.trial.runner.TrialRunner.html#tbformat
  Attribute
  Property
  PUBLIC
  Undocumented
• twisted.trial.runner.TrialRunner.rterrors
  twisted.trial.runner.TrialRunner.html#rterrors
  Attribute
  Property
  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.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.