Package buildbot :: Module manhole :: Class _BaseManhole
[hide private]
[frames] | no frames]

Class _BaseManhole

source code

 twisted.application.service.Service --+    
                                       |    
twisted.application.service.MultiService --+
                                           |
                                          _BaseManhole
Known Subclasses:

This provides remote access to a python interpreter (a read/exec/print loop) embedded in the buildmaster via an internal SSH server. This allows detailed inspection of the buildmaster state. It is of most use to buildbot developers. Connect to this by running an ssh client.

Instance Methods [hide private]
 
__init__(self, port, checker, using_ssh=True) source code
 
startService(self) source code

Inherited from twisted.application.service.MultiService: __iter__, addService, getServiceNamed, privilegedStartService, removeService, stopService

Inherited from twisted.application.service.Service: __getstate__, __providedBy__, disownServiceParent, setName, setServiceParent

Class Variables [hide private]

Inherited from twisted.application.service.MultiService: __implemented__, __provides__

Inherited from twisted.application.service.Service: name, parent, running

Method Details [hide private]

__init__(self, port, checker, using_ssh=True)
(Constructor)

source code 
Parameters:
  • port (string or int) - what port should the Manhole listen on? This is a strports specification string, like 'tcp:12345' or 'tcp:12345:interface=127.0.0.1'. Bare integers are treated as a simple tcp port.
  • checker (an object providing the twisted.cred.checkers.ICredentialsChecker interface) - if provided, this checker is used to authenticate the client instead of using the username/password scheme. You must either provide a username/password or a Checker. Some useful values are:
       import twisted.cred.checkers as credc
       import twisted.conch.checkers as conchc
       c = credc.AllowAnonymousAccess # completely open
       c = credc.FilePasswordDB(passwd_filename) # file of name:passwd
       c = conchc.UNIXPasswordDatabase # getpwnam() (probably /etc/passwd)
    
  • using_ssh (bool) - If True, accept SSH connections. If False, accept regular unencrypted telnet connections.
Overrides: twisted.application.service.MultiService.__init__

startService(self)

source code 
Overrides: twisted.application.service.Service.startService