Trees | Indices | Help |
---|
|
object --+ | common.common.InitMixin --+ | common.log.Loggable --+ | object --+ | | | gobject.GObject --+ | BaseComponent
I am the base class for all Flumotion components.
|
|||
child class of BaseComponentMedium |
componentMediumClass the medium class to use for this component |
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
int |
|
||
|
|||
|
|||
|
|||
|
|||
|
|||
Inherited from Inherited from Inherited from |
|
|||
logCategory =
Implementors can provide a category to log their messages under. |
|||
__gtype__ = <GType flumotion+component+component+BaseComponent
|
|||
Inherited from |
|
|||
BaseComponentMedium |
medium the component's medium |
||
string |
name the name of the component |
|
|||
Inherited from Inherited from |
|
Subclasses should not override __init__ at all. Instead, they should implement init(), which will be called by this implementation automatically. See flumotion.common.common.InitMixin for more details.
|
A subclass should do as little as possible in its init method. In particular, it should not try to access resources. Failures during init are marshalled back to the manager through the worker's remote_create method, since there is no component state proxied to the manager yet at the time of init. |
Subclasses can implement me to run any checks before the component performs setup. Messages can be added to the component state's 'messages' list key. Any error messages added will trigger the component going to sad an flumotion.common.errors.ComponentSetupError being raised; do_setup() will not be called. In the event of a fatal problem that can't be expressed through an error message, this method should set the mood to sad and raise the error on its own. self.config will be set before this is called.
|
Subclasses can implement me to set up the component before it is started. It should set up the component, possibly opening files and resources. Non-programming errors should not be raised, but returned as a failing deferred. self.config will be set before this is called.
|
BaseComponent vmethod for starting up. If you override this method, you are responsible for arranging that the component becomes happy.
|
BaseComponent vmethod for stopping. The component should do any cleanup it needs, but must not set the component's mood to sleeping.
|
Sets up the component with the given config. Called by the manager through the medium.
|
Tell the component to start. This is called when all its dependencies are already started. To hook onto this method, implement your own do_start method. See BaseComponent.do_start() for what your do_start method is responsible for doing. Again, don't override this method. Thanks. |
Set the shutdown hook for this component (replacing any previous hook). When a component is stopped, then this hook will be fired. |
Tell the component to stop. The connection to the manager will be closed. The job process will also finish. |
|
Add a message to the component. If any of the messages is an error, the component will turn sad.
|
Fix properties that have been renamed from a previous version, and add a warning for them.
|
Call a remote method on all admin client views on this component. This gets serialized through the manager and multiplexed to all admin clients, and from there on to all views connected to each admin client model. Because there can be any number of admin clients that this call will go out do, it does not make sense to have one return value. This function will return None always. |
|
__gtype__
|
Trees | Indices | Help |
---|
Generated by Epydoc 3.0.1 on Fri Apr 11 07:40:25 2008 | http://epydoc.sourceforge.net |