API Documentation

These are the lowest-level documents, directly from the doc-strings in the code with some minimal organization; if you’re just getting started with txtorcon the “Programming Guide” is a better place to start.

• High Level API
  • Tor
  • connect
  • launch
• Tracking and Changing Live Tor State
  • TorState
  • Circuit
  • Stream
  • Router
• Reading and Writing Live Tor Configuration
  • TorConfig
  • HiddenService
• Endpoints and Related Classes
  • TCPHiddenServiceEndpoint
  • TCPHiddenServiceEndpointParser
  • TorOnionAddress
  • TorOnionListeningPort
  • IProgressProvider
  • IHiddenService
• Low-Level Protocol Classes
  • build_tor_connection
  • build_local_tor_connection
  • TorControlProtocol
  • TorProtocolFactory
  • TorProcessProtocol
• txtorcon.socks Module
  • SOCKS5 Errors
    • SocksError
    • GeneralServerFailureError
    • ConnectionNotAllowedError
    • NetworkUnreachableError
    • HostUnreachableError
    • ConnectionRefusedError
    • TtlExpiredError
    • CommandNotSupportedError
    • AddressTypeNotSupportedError
  • resolve
  • resolve_ptr
  • TorSocksEndpoint
• txtorcon.interface Module
  • interface.IStreamAttacher
  • interface.IStreamListener
  • interface.ICircuitListener
  • interface.ICircuitContainer
  • interface.IRouterContainer
  • interface.ITorControlProtocol
• txtorcon.util Module
  • util.NetLocation
  • util.process_from_address
  • util.delete_file_or_tree