t.c.s.t.SSHClientFactory(protocol.ClientFactory) : class documentation

Part of twisted.conch.scripts.tkconch View Source View In Hierarchy

Undocumented
Method stopFactory This will be called before I stop listening on all Ports/Connectors.
Method buildProtocol Create an instance of a subclass of Protocol.
Method clientConnectionFailed Called when a connection has failed to connect.

Inherited from ClientFactory:

Method startedConnecting Called when a connection has been started.
Method clientConnectionLost Called when an established connection is lost.

Inherited from Factory (via ClientFactory):

Class Method forProtocol Create a factory for the given protocol.
Method logPrefix Describe this factory for log messages.
Method doStart Make sure startFactory is called.
Method doStop Make sure stopFactory is called.
Method startFactory This will be called before I begin listening on a Port or Connector.
def stopFactory(self): (source)
This will be called before I stop listening on all Ports/Connectors.

This can be overridden to perform 'shutdown' tasks such as disconnecting database connections, closing files, etc.

It will be called, for example, before an application shuts down, if it was connected to a port. User code should not call this function directly.

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.

Override this method to alter how Protocol instances get created.

Parametersaddran 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.

API Documentation for Twisted, generated by pydoctor at 2014-05-12 18:27:00.