Package flumotion :: Package twisted :: Module pb :: Class FPBClientFactory
[show private | hide private]
[frames | no frames]

Class FPBClientFactory

         Loggable --+
                    |
  Factory --+       |
            |       |
ClientFactory --+   |
                |   |
  PBClientFactory --+
                    |
                   FPBClientFactory

Known Subclasses:
FeedClientFactory, ReconnectingFPBClientFactory

I am an extended Perspective Broker client factory using generic keycards for login.
Method Summary
defer.Deferred returning list of str getKeycardClasses(self)
Ask the remote PB server for all the keycard interfaces it supports.
  login(self, authenticator)
Login, respond to challenges, and eventually get perspective from remote PB server.
  _cbLoginCallback(self, result, root, authenticator, client, interfaces, count)
  _cbSendKeycard(self, root, authenticator, client, interfaces, count)
  _cbSendUsername(self, root, username, password, avatarId, client, interfaces)
    Inherited from PBClientFactory
  __init__(self)
  clientConnectionFailed(self, connector, reason)
Called when a connection has failed to connect.
  clientConnectionLost(self, connector, reason, reconnecting)
Reconnecting subclasses should call with reconnecting=1.
  clientConnectionMade(self, broker)
  disconnect(self)
If the factory is connected, close the connection.
  getPerspective(self, username, password, serviceName, perspectiveName, client)
Get perspective from remote PB server.
  getRootObject(self)
Get root object of remote PB server.
  _cbResponse(self, (challenge, challenger), password, client)
  _failAll(self, reason)
  _reset(self)
    Inherited from ClientFactory
  startedConnecting(self, connector)
Called when a connection has been started.
    Inherited from Factory
  buildProtocol(self, addr)
Create an instance of a subclass of Protocol.
  doStart(self)
Make sure startFactory is called.
  doStop(self)
Make sure stopFactory is called.
  startFactory(self)
This will be called before I begin listening on a Port or Connector.
  stopFactory(self)
This will be called before I stop listening on all Ports/Connectors.
    Inherited from Loggable
  debug(self, *args)
Log a debug message.
dict doLog(self, level, where, format, *args, **kwargs)
Log a message at the given level, with the possibility of going higher up in the stack.
  error(self, *args)
Log an error.
  info(self, *args)
Log an informational message.
  log(self, *args)
Log a log message.
  logFunction(self, *args)
Overridable log function.
  logObjectName(self)
Overridable object name function.
  warning(self, *args)
Log a warning.
  warningFailure(self, failure, swallow)
Log a warning about a Failure.

Instance Variable Summary
keycards.Keycard keycard: the keycard used last for logging in; set after self.login has completed
flumotion.common.medium.BaseMedium medium: the client-side referenceable for the PB server to call on, and for the client to call to the PB server
subclass of flumotion.common.interfaces.IMedium perspectiveInterface: the interface we want to request a perspective for

Class Variable Summary
str logCategory: Implementors can provide a category to log their messages under.
    Inherited from PBClientFactory
int unsafeTracebacks = 0                                                                     
    Inherited from Factory
Implements __implemented__ = <implementedBy twisted.internet.protoc...
ClassProvides __providedBy__ = <zope.interface.declarations.ClassProvi...
ClassProvides __provides__ = <zope.interface.declarations.ClassProvide...
bool noisy = True
int numPorts = 0                                                                     
NoneType protocol = None                                                                  

Method Details

getKeycardClasses(self)

Ask the remote PB server for all the keycard interfaces it supports.
Returns:
defer.Deferred returning list of str

login(self, authenticator)

Login, respond to challenges, and eventually get perspective from remote PB server.

Currently only credentials implementing IUsernamePassword are supported.
Returns:
Deferred of RemoteReference to the perspective.
Overrides:
twisted.spread.pb.PBClientFactory.login

Instance Variable Details

keycard

the keycard used last for logging in; set after self.login has completed
Type:
keycards.Keycard
Value:
None                                                                  

medium

the client-side referenceable for the PB server to call on, and for the client to call to the PB server
Type:
flumotion.common.medium.BaseMedium
Value:
None                                                                  

perspectiveInterface

the interface we want to request a perspective for
Type:
subclass of flumotion.common.interfaces.IMedium
Value:
None                                                                  

Class Variable Details

logCategory

Implementors can provide a category to log their messages under.
Type:
str
Value:
'FPBClientFactory'                                                     

Generated by Epydoc 2.1 on Fri Apr 6 10:13:41 2007 http://epydoc.sf.net