twisted.spread.pb.PBClientFactory(protocol.ClientFactory) class documentation

Part of twisted.spread.pb (View In Hierarchy)

Client factory for PB brokers.

As with all client factories, use with reactor.connectTCP/SSL/etc.. getPerspective and getRootObject can be called either before or after the connect.

Method __init__
Method buildProtocol Build the broker instance, passing the security options to it.
Method clientConnectionFailed Called when a connection has failed to connect.
Method clientConnectionLost Reconnecting subclasses should call with reconnecting=1.
Method clientConnectionMade Undocumented
Method getRootObject Get root object of remote PB server.
Method disconnect If the factory is connected, close the connection.
Method login Login and get perspective from remote PB server.
Method _reset Undocumented
Method _failAll Undocumented
Method _cbSendUsername Undocumented
Method _cbResponse Undocumented
Method _cbLoginAnonymous Attempt an anonymous login on the given remote root object.

Inherited from ClientFactory:

Method startedConnecting Called when a connection has been started.

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.
Method stopFactory This will be called before I stop listening on all Ports/Connectors.
def __init__(self, unsafeTracebacks=False, security=globalSecurity):
ParametersunsafeTracebacksif set, tracebacks for exceptions will be sent over the wire. (type: bool)
securitysecurity options used by the broker, default to globalSecurity. (type: twisted.spread.jelly.SecurityOptions)
def buildProtocol(self, addr):
from twisted.internet.interfaces.IProtocolFactory
overrides twisted.internet.protocol.Factory.buildProtocol

Build the broker instance, passing the security options to it.

def _reset(self):
Undocumented
def _failAll(self, reason):
Undocumented
def clientConnectionFailed(self, connector, reason):
overrides twisted.internet.protocol.ClientFactory.clientConnectionFailed

Called when a connection has failed to connect.

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

def clientConnectionLost(self, connector, reason, reconnecting=0):
overrides twisted.internet.protocol.ClientFactory.clientConnectionLost

Reconnecting subclasses should call with reconnecting=1.

def clientConnectionMade(self, broker):
Undocumented
def getRootObject(self):

Get root object of remote PB server.

ReturnsDeferred of the root object.
def disconnect(self):

If the factory is connected, close the connection.

Note that if you set up the factory to reconnect, you will need to implement extra logic to prevent automatic reconnection after this is called.

def _cbSendUsername(self, root, username, password, client):
Undocumented
def _cbResponse(self, challenges, password, client):
Undocumented
def _cbLoginAnonymous(self, root, client):

Attempt an anonymous login on the given remote root object.

ParametersrootThe object on which to attempt the login, most likely returned by a call to PBClientFactory.getRootObject. (type: RemoteReference)
clientA jellyable object which will be used as the mind parameter for the login attempt.
ReturnsA Deferred which will be called back with a RemoteReference to an avatar when anonymous login succeeds, or which will errback if anonymous login fails. (type: Deferred)
def login(self, credentials, client=None):

Login and get perspective from remote PB server.

Currently the following credentials are supported:

   L{twisted.cred.credentials.IUsernamePassword}
   L{twisted.cred.credentials.IAnonymous}
ReturnsA Deferred which will be called back with a RemoteReference for the avatar logged in to, or which will errback if login fails. (type: Deferred)
API Documentation for twisted, generated by pydoctor at 2020-03-25 17:34:30.