class documentation

class SSHClientFactory(protocol.ClientFactory): (source)

View In Hierarchy

Undocumented

Method __init__ Undocumented
Method build​Protocol Create an instance of a subclass of Protocol.
Method client​Connection​Failed Called when a connection has failed to connect.
Method client​Connection​Lost Called when an established connection is lost.
Instance Variable d Undocumented
Instance Variable options Undocumented
Instance Variable user​Auth​Object Undocumented
Instance Variable verify​Host​Key Undocumented

Inherited from ClientFactory:

Method started​Connecting Called when a connection has been started.

Inherited from Factory (via ClientFactory):

Class Method for​Protocol Create a factory for the given protocol.
Method do​Start Make sure startFactory is called.
Method do​Stop Make sure stopFactory is called.
Method log​Prefix Describe this factory for log messages.
Method start​Factory This will be called before I begin listening on a Port or Connector.
Method stop​Factory This will be called before I stop listening on all Ports/Connectors.
Class Variable noisy Undocumented
Class Variable protocol Undocumented
Instance Variable num​Ports Undocumented
def __init__(self, d, options, verifyHostKey, userAuthObject): (source)

Undocumented

def buildProtocol(self, addr): (source)

Create an instance of a subclass of Protocol.

The returned instance will handle input on an incoming server connection, and an attribute "factory" pointing to the creating factory.

Alternatively, None may be returned to immediately close the new connection.

Override this method to alter how Protocol instances get created.

Parameters
addran object implementing twisted.internet.interfaces.IAddress
def clientConnectionFailed(self, connector, reason): (source)

Called when a connection has failed to connect.

It may be useful to call connector.connect() - this will reconnect.

Parameters
connectorUndocumented
reason:twisted.python.failure.FailureUndocumented
def clientConnectionLost(self, connector, reason): (source)

Called when an established connection is lost.

It may be useful to call connector.connect() - this will reconnect.

Parameters
connectorUndocumented
reason:twisted.python.failure.FailureUndocumented

Undocumented

options = (source)

Undocumented

userAuthObject = (source)

Undocumented

verifyHostKey = (source)

Undocumented