Package flumotion :: Package manager :: Module base :: Class ManagerHeaven
[hide private]

Class ManagerHeaven

source code

 twisted.spread.jelly.Jellyable --+            
                                  |            
twisted.spread.flavors.Serializable --+        
                                      |        
   twisted.spread.flavors.Referenceable --+    
                                          |    
                twisted.spread.flavors.Root --+
                                              |
                        common.log.Loggable --+
                                              |
                                             ManagerHeaven
Known Subclasses:

I am a base class for heavens in the manager.

Instance Methods [hide private]
 
__init__(self, vishnu) source code
flumotion.manager.base.ManagerAvatar
createAvatar(self, avatarId, remoteIdentity)
Create a new avatar and manage it.
source code
 
removeAvatar(self, avatarId)
Stop managing the given avatar.
source code
ManagerAvatar
getAvatar(self, avatarId)
Get the avatar with the given id.
source code
bool
hasAvatar(self, avatarId)
Check if a component with that name is registered.
source code
list of ManagerAvatar
getAvatars(self)
Get all avatars in this heaven.
source code

Inherited from twisted.spread.flavors.Root: rootObject

Inherited from twisted.spread.flavors.Referenceable: jellyFor, remoteMessageReceived

Inherited from twisted.spread.flavors.Serializable: processUniqueID

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

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

Class Variables [hide private]
  avatarClass = None
the class object this heaven instantiates avatars from.
  __implemented__ = <implementedBy flumotion.manager.base.Manage...
  __provides__ = <zope.interface.declarations.ClassProvides obje...

Inherited from twisted.spread.flavors.Referenceable: perspective

Inherited from common.log.Loggable: logCategory

Instance Variables [hide private]
dict of str -> ManagerAvatar avatars
a dict of avatarId -> Avatar
flumotion.manager.manager.Vishnu vishnu
the Vishnu in control of all the heavens
Method Details [hide private]

__init__(self, vishnu)
(Constructor)

source code 
Parameters:

createAvatar(self, avatarId, remoteIdentity)

source code 

Create a new avatar and manage it.

Parameters:
Returns: flumotion.manager.base.ManagerAvatar
a new avatar for the client

removeAvatar(self, avatarId)

source code 

Stop managing the given avatar.

Parameters:
  • avatarId (str) - id of the avatar to remove

getAvatar(self, avatarId)

source code 

Get the avatar with the given id.

Parameters:
  • avatarId (str) - id of the avatar to get
Returns: ManagerAvatar
the avatar with the given id

hasAvatar(self, avatarId)

source code 

Check if a component with that name is registered.

Parameters:
  • avatarId (str) - id of the avatar to check
Returns: bool
True if an avatar with that id is registered

getAvatars(self)

source code 

Get all avatars in this heaven.

Returns: list of ManagerAvatar
a list of all avatars in this heaven

Class Variable Details [hide private]

avatarClass

the class object this heaven instantiates avatars from. To be set in subclass.
Value:
None

__implemented__

Value:
<implementedBy flumotion.manager.base.ManagerHeaven>

__provides__

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