flumotion.common.planet.ManagerComponentState

Package flumotion :: Package common :: Module planet :: Class ManagerComponentState

[show private | hide private]

Class ManagerComponentState

Jellyable --+                
            |                
 Serializable --+            
                |            
         Copyable --+        
                    |        
            Cacheable --+    
                        |    
           StateCacheable --+
                            |
                           ManagerComponentState

I represent the state of a component in the manager. I have my own state, and also proxy state from the ManagerJobState when the component is actually created in a worker.

I have the following keys of my own:

name: str, name of the component, unique in the parent
parent: ManagerFlowState or ManagerAtmosphereState
type: str, type of the component
moodPending: int, the mood value the component is being set to
workerRequested: str, name of the worker this component is requested to be started on.
config: dict, the configuration dict for this component

It also has a special key, 'mood'. This acts as a proxy for the mood in the WorkerJobState, when there is a job attached (the job's copy is authoritative when it connects), and is controlled independently at other times.

I proxy the following keys from the serialized WorkerJobState:

mood, manager-ip, pid, workerName, cpu
messages (list)

Method Summary
	`__init__(self)`
	`__repr__(self)`
	`clearJobState(self)` Remove the job state.
	`setJobState(self, jobState)` Set the job state I proxy from.
	`setMood(self, moodValue)`
Inherited from StateCacheable
	`addDictKey(self, key, value)` Add a key for a dict value to the state cache.
	`addKey(self, key, value)` Add a key to the state cache so it can be used with set.
	`addListKey(self, key, value)` Add a key for a list of objects to the state cache.
	`append(self, key, value)` Append the given object to the given list.
	`delitem(self, key, subkey)` Removes an element from the given dict.
	`get(self, key, otherwise)` Get the state cache value for the given key.
	`getStateToCacheAndObserveFor(self, perspective, observer)` Get state to cache on the client and client-cache reference to observe locally.
	`hasKey(self, key)`
	`keys(self)`
	`remove(self, key, value)` Remove the given object from the given list.
	`set(self, key, value)` Set a given state key to the given value.
	`setitem(self, key, subkey, value)` Set a value in the given dict.
	`stoppedObserving(self, perspective, observer)` This method is called when a client has stopped observing me.
Inherited from Cacheable
	`jellyFor(self, jellier)` Return an appropriate tuple to serialize me.
Inherited from Copyable
	`getStateToCopy(self)` Gather state to send when I am serialized for a peer.
	`getStateToCopyFor(self, perspective)` Gather state to send when I am serialized for a particular perspective.
	`getTypeToCopy(self)` Determine what type tag to send for me.
	`getTypeToCopyFor(self, perspective)` Determine what type tag to send for me.
Inherited from Serializable
	`processUniqueID(self)` Return an ID which uniquely represents this object for this process.
Inherited from Jellyable
	`getStateFor(self, jellier)`

Class Variable Summary
Inherited from Copyable
`Implements`	`__implemented__` = `<implementedBy twisted.spread.flavors....`
`ClassProvides`	`__provides__` = `<zope.interface.declarations.ClassProvide...`
Inherited from Jellyable
`ClassProvides`	`__providedBy__` = `<zope.interface.declarations.ClassProvi...`

Method Details

clearJobState(self)

Remove the job state.

setJobState(self, jobState)

Set the job state I proxy from.

Parameters:: jobState
(type=ManagerJobState)

Generated by Epydoc 2.1 on Sun Oct 26 16:39:17 2008

http://epydoc.sf.net