Package flumotion :: Package component :: Module component :: Class BaseComponentMedium
[hide private]

Class BaseComponentMedium

source code

 twisted.spread.jelly.Jellyable --+                    
                                  |                    
twisted.spread.flavors.Serializable --+                
                                      |                
   twisted.spread.flavors.Referenceable --+            
                                          |            
                extern.log.log.Loggable --+            
                                          |            
                   twisted.pb.Referenceable --+        
                                              |        
                       common.medium.BaseMedium --+    
                                                  |    
                        common.medium.PingingMedium --+
                                                      |
                                                     BaseComponentMedium
Known Subclasses:

I am a medium interfacing with a manager-side avatar. I implement a Referenceable for the manager's avatar to call on me. I have a remote reference to the manager's avatar to call upon. I am created by the ComponentClientFactory.

Instance Methods [hide private]
 
__init__(self, component) source code
 
setRemoteReference(self, reference)
Set the given remoteReference as the reference to the server-side avatar.
source code
 
setup(self, config) source code
 
getManagerIP(self)
Return the manager IP as seen by us.
source code
 
getIP(self)
Return the IP of this component based on connection to the manager.
source code
 
setAuthenticator(self, authenticator)
Set the authenticator the client factory has used to log in to the manager.
source code
flumotion.common.planet.WorkerJobState
remote_getState(self)
Return the state of the component, which will be serialized to a flumotion.common.planet.ManagerJobState object.
source code
dict
remote_getConfig(self)
Return the configuration of the component.
source code
 
remote_stop(self) source code
 
remote_reloadComponent(self)
Reload modules in the component.
source code
 
remote_getUIState(self)
Get a WorkerComponentUIState containing details needed to present an admin-side UI state
source code
 
remote_getMasterClockInfo(self)
Base implementation of getMasterClockInfo, can be overridden by subclasses.
source code
 
remote_getVersions(self) source code
 
remote_setFluDebug(self, debug)
Sets the Flumotion debugging levels based on the passed debug string.
source code

Inherited from common.medium.PingingMedium: remote_writeFluDebugMarker, startPinging, stopPinging

Inherited from common.medium.BaseMedium: callRemote, callRemoteLogging, getBundledFunction, hasRemoteReference, runBundledFunction

Inherited from twisted.pb.Referenceable: remoteMessageReceived

Inherited from twisted.spread.flavors.Referenceable: jellyFor

Inherited from twisted.spread.flavors.Serializable: processUniqueID

Inherited from twisted.spread.jelly.Jellyable: __providedBy__, getStateFor

Inherited from extern.log.log.Loggable: debug, doLog, error, info, log, logFunction, logObjectName, warning, warningFailure, writeMarker

Class Variables [hide private]
  logCategory = 'basecompmed'
Implementors can provide a category to log their messages under.
  __implemented__ = <implementedBy flumotion.component.component...
  __provides__ = <zope.interface.declarations.ClassProvides obje...
flumotion.twisted.pb.Authenticator authenticator
the authenticator used to log in to manager

Inherited from common.medium.BaseMedium: bundleLoader, remoteLogName

Inherited from twisted.spread.flavors.Referenceable: perspective

Instance Variables [hide private]

Inherited from common.medium.BaseMedium: remote

Method Details [hide private]

__init__(self, component)
(Constructor)

source code 
Parameters:

setRemoteReference(self, reference)

source code 

Set the given remoteReference as the reference to the server-side avatar.

Parameters:
  • remoteReference - twisted.spread.pb.RemoteReference
Overrides: common.medium.BaseMedium.setRemoteReference
(inherited documentation)

getIP(self)

source code 

Return the IP of this component based on connection to the manager.

Note: this is insufficient in general, and should be replaced by network mapping stuff later.

setAuthenticator(self, authenticator)

source code 

Set the authenticator the client factory has used to log in to the manager. Can be reused by the component's medium to make feed connections which also get authenticated by the manager's bouncer.

Parameters:

remote_getState(self)

source code 

Return the state of the component, which will be serialized to a flumotion.common.planet.ManagerJobState object.

Returns: flumotion.common.planet.WorkerJobState
state of component

remote_getConfig(self)

source code 

Return the configuration of the component.

Returns: dict
component's current configuration

remote_getMasterClockInfo(self)

source code 

Base implementation of getMasterClockInfo, can be overridden by subclasses. By default, just returns None.

remote_setFluDebug(self, debug)

source code 

Sets the Flumotion debugging levels based on the passed debug string.

Since: 0.6.0


Class Variable Details [hide private]

__implemented__

Value:
<implementedBy flumotion.component.component.BaseComponentMedium>

__provides__

Value:
<zope.interface.declarations.ClassProvides object at 0x98a5fcc>