Trees | Indices | Help |
---|
|
object --+ | common.common.InitMixin --+ | extern.log.log.Loggable --+ | 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 |
|
|||
logCategory =
Implementors can provide a category to log their messages under. |
|||
__implemented__ = <implementedBy flumotion.component.component
|
|
|||
BaseComponentMedium |
medium the component's medium |
||
string |
name the name of the component |
||
componentui.WorkerComponentUIState |
uiState state of the component to be shown in a UI. |
|
|||
Inherited from |
|
Subclasses should not override __init__ at all. Instead, they should implement init(), which will be called by this implementation automatically. 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. |
Triggered when a uiState observer was added. Default implementation is to start the memory and cpu pollers. Note: Subclasses can override me but should chain me up to start these pollers |
Triggered when a uiState observer has left. Default implementation is to stop the memory and cpu pollers when the total number of observers denoted by the 'num' argument becomes zero. Note: Subclasses can override me but should chain me up to stop these pollers |
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, with flumotion.common.errors.ComponentSetupError being raised before getting to setup stage; 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 raise an exception or return a failure. It is not necessary to chain up in this function. The return value may be a deferred. |
BaseComponent convenience vmethod for running checks. A component implementation can override this method to run any checks that it needs to. Typically, a check_properties implementation will call the provided addMessage() callback to note warnings or errors. For errors, addMessage() will set component's mood to sad, which will abort the init process before getting to do_setup().
|
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. The return value may be a deferred. |
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. Called during __init__, so be sure not to raise exceptions, instead adding messages to the component state. |
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.
|
Remove a message with a given id from the component.
|
Add a warning messages for deprecated properties.
|
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. |
Modifies a property of the compoment. Components with modifiable properties (properties that can be changed on the fly) should implement modify_property_(propertyName) to receive the call
|
Check that the value to be set in a property is of the correct type
|
Special descriptor for class __provides__ The descriptor caches the implementedBy info, so that we can get declarations for objects without instance-specific interfaces a bit quicker.
|
|
__implemented__
|
|
uiStatestate of the component to be shown in a UI. Contains at least the following keys.
Subclasses can add additional keys for their respective UI. |
Trees | Indices | Help |
---|
Generated by Epydoc 3.0.1 on Tue Aug 13 06:17:03 2013 | http://epydoc.sourceforge.net |