Package flumotion :: Package worker :: Module job :: Class JobClientFactory
[show private | hide private]
[frames | no frames]

Class JobClientFactory

         Loggable --+
                    |
  Factory --+       |
            |       |
ClientFactory --+   |
                |   |
  PBClientFactory --+
                    |
                   JobClientFactory


I am a client factory that logs in to the WorkerBrain. I live in the flumotion-worker job process.
Method Summary
  __init__(self, id, options)
  login(self, username)
  stopFactory(self)
This will be called before I stop listening on all Ports/Connectors.
  _connectedCallback(self, remoteReference)
  _connectedErrback(self, error)
    Inherited from PBClientFactory
  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.
  _cbAuthIdentity(self, authServRef, username, password)
  _cbGetPerspective(self, identityWrapper, serviceName, perspectiveName, client)
  _cbRespondToChallenge(self, (challenge, challenger), password)
  _cbResponse(self, (challenge, challenger), password, client)
  _cbSendUsername(self, root, username, 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.
    Inherited from Loggable
  debug(self, *args)
Log a debug message.
  error(self, *args)
Log an error.
  info(self, *args)
Log an informational message.
  log(self, *args)
Log a log message.
  logFunction(self, message)
Overridable log function.
  logObjectName(self)
Overridable object name function.
  warning(self, *args)
Log a warning.

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...
_implementsTuple __implements__ = (<MetaInterface twisted.internet.interf...
ClassProvides __providedBy__ = <zope.interface.declarations.ClassProvi...
ClassProvides __provides__ = <zope.interface.declarations.ClassProvide...
bool noisy = True
int numPorts = 0                                                                     
NoneType protocol = None                                                                  

Method Details

__init__(self, id, options)
(Constructor)

Parameters:
id
           (type=string)
options - the command-line options the worker was started with
Overrides:
twisted.spread.pb.PBClientFactory.__init__

stopFactory(self)

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.
Overrides:
twisted.internet.protocol.Factory.stopFactory (inherited documentation)

Class Variable Details

logCategory

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

Generated by Epydoc 2.1 on Sun Sep 4 00:24:44 2005 http://epydoc.sf.net