Module Hierarchy

• admin: client-side code for administration clients
  • admin: model abstraction for administration clients supporting different views
• common: common code used by all flumotion processes
  • bundle: bundles of files used to implement caching over the network
  • common: small common functions used by all processes
  • component: Component state shared between manager and admin clients
  • config: parsing of configuration files
  • enum: Enum class implementation
  • errors: serializable Flumotion exceptions
  • gstreamer: GStreamer helper functionality
  • interfaces: Flumotion interfaces
  • keycards: serializable keycards used for authentication inside Flumotion
  • log: Flumotion logging
  • pygobject: PyGTK helper functions
  • registry: parsing of registry, which holds component and bundle information
  • reload: This module provides utility functions for Flumotion.
  • setup
  • worker
• component: code executed by components in workers and for components in admin clients
  • base
    • converter
    • producer
  • bouncers
    • bouncer
  • component: worker-side objects for components
  • feedcomponent: Feed components, participating in the stream
• configure: configure-time information and settings
  • configure: configure-time variables for installed or uninstalled operation
• manager: manager-side code
  • admin: manager-side objects to handle administrative clients
  • base: common classes and code to support manager-side objects
  • component: manager-side objects for components
  • main: manager main function
  • manager: manager implementation and related classes
  • worker: manager-side objects to handle worker clients
• twisted: Twisted-like base code written for Flumotion
  • checkers: Flumotion Twisted credential checkers
  • credentials: Flumotion Twisted credentials
  • flavors: Flumotion Twisted-like flavors
  • gstreactor: a GStreamer mainloop-based Twisted reactor
  • pb: Flumotion Perspective Broker using keycards
  • portal: portal-related functionality inspired by twisted.cred.portal
  • reflect: functions based on twisted.python.reflect
• worker: code for workers executing jobs for the manager
  • config: Parsing of configuration files.
  • job: worker-side objects to handle job processes
  • main
  • worker: worker-side objects to handle worker clients

Class Hierarchy

• __builtin__.object: The most base type
  • flumotion.common.enum.Enum
  • flumotion.common.enum.EnumClass
  • gobject.GObject: Object GObject...
    • flumotion.admin.admin.AdminModel: I live in the admin client.
    • flumotion.component.component.BaseComponent: I am the base class for all Flumotion components.
      • flumotion.component.bouncers.bouncer.Bouncer
      • flumotion.component.feedcomponent.FeedComponent: I am a base class for all Flumotion feed components.
        • flumotion.component.feedcomponent.ParseLaunchComponent: A component using gst-launch syntax
          • flumotion.component.base.converter.Converter
          • flumotion.component.base.producer.Producer
  • twisted.python.components.Interface: Base class for interfaces.
    • twisted.cred.credentials.ICredentials: I check credentials.
      • flumotion.twisted.credentials.IUsernameCryptPassword: I encapsulate a username and check crypted passwords.
    • twisted.cred.checkers.ICredentialsChecker: I check sub-interfaces of ICredentials.
    • flumotion.common.interfaces.IHeaven: My implementors manage avatars logging in to the manager.
    • flumotion.common.interfaces.IMedium: I am a base interface for PB client-side mediums interfacing with manager-side avatars.
      • flumotion.common.interfaces.IAdminMedium: I am an interface for admin-side mediums interfacing with manager-side avatars.
      • flumotion.common.interfaces.IComponentMedium: I am an interface for component-side mediums interfacing with server-side avatars.
      • flumotion.common.interfaces.IJobMedium: I am an interface for job-side mediums interfacing with worker-side avatars.
      • flumotion.common.interfaces.IWorkerMedium: I am an interface for worker-side mediums interfacing with manager-side avatars.
    • twisted.spread.pb.IPerspective: per*spec*tive, n.
    • twisted.cred.portal.IRealm
    • flumotion.twisted.flavors.IStateListener: I am an interface for objects that want to listen to changes on cached states.
  • __builtin__.type: type(object) -> the object's type type(name, bases, dict) -> a new type
    • flumotion.common.enum.EnumMetaClass
• exceptions.Exception: Common base class for all exceptions.
  • flumotion.common.config.ConfigError: Error during parsing of configuration
  • flumotion.worker.config.ConfigError
  • twisted.spread.pb.Error: This error can be raised to generate known error conditions.
    • flumotion.common.errors.ComponentStart: An error during starting of a component
    • flumotion.common.errors.ConnectionError: General connection error
      • flumotion.common.errors.AlreadyConnectedError: Already connected
      • flumotion.common.errors.NotConnectedError: Not connected
        • flumotion.common.errors.ManagerNotConnectedError: Manager not connected
    • flumotion.common.errors.EntrySyntaxError: Syntax error while getting entry point in a bundle
    • flumotion.common.errors.FlumotionError: Generic Flumotion error
    • flumotion.common.errors.GstError: Generic GStreamer error
      • flumotion.common.errors.DeviceBusyError: Generic GStreamer error
      • flumotion.common.errors.PermissionDeniedError: Permission denied
    • flumotion.common.errors.NoBundleError: The requested bundle was not found
    • flumotion.common.errors.NoPerspectiveError: The component does not have a perspective
    • flumotion.common.errors.NotReadyError: The component is not ready yet
    • flumotion.common.errors.PipelineParseError: An error occurred while trying to parse the pipeline
    • flumotion.common.errors.PropertyError: An error occurred while setting a property on the component
    • flumotion.common.errors.ReloadSyntaxError: A syntax error during a reload of a module
    • flumotion.common.errors.RemoteMethodError: Generic remote method error
      • flumotion.common.errors.NoMethodError: The remote method does not exist
      • flumotion.common.errors.RemoteRunError: Error while running remote code
    • flumotion.common.errors.SystemError: A system error, is usually fatal
    • flumotion.common.errors.UnknownComponentError: A given component or component type does not exist
    • flumotion.common.errors.UnknownDeviceError: The device does not exist
    • flumotion.common.errors.UnknownEffectError: A given effect or effect type does not exist
  • flumotion.common.errors.OptionError: Error in options
• flumotion.common.bundle.Bundle: I am a bundle of files, represented by a zip file and md5sum.
• flumotion.common.bundle.Bundler: I bundle files into a bundle so they can be cached remotely easily.
• flumotion.common.bundle.BundlerBasket: I manage bundlers that are registered through me.
• flumotion.common.bundle.Unbundler: I unbundle bundles by unpacking them in the given directory under directories with the bundle's md5sum.
• flumotion.common.config.ConfigEntryAtmosphere: I represent a <atmosphere> entry in a planet config file
• flumotion.common.config.ConfigEntryFlow: I represent a <flow> entry in a planet config file
• flumotion.common.config.ConfigEntryManager: I represent a <manager> entry in a planet config file
• flumotion.common.log.Loggable: Base class for objects that want to be able to log messages with different level of severity.
  • flumotion.admin.admin.AdminModel: I live in the admin client.
  • flumotion.component.component.BaseComponent: I am the base class for all Flumotion components.
    • flumotion.component.bouncers.bouncer.Bouncer
    • flumotion.component.feedcomponent.FeedComponent: I am a base class for all Flumotion feed components.
      • flumotion.component.feedcomponent.ParseLaunchComponent: A component using gst-launch syntax
        • flumotion.component.base.converter.Converter
        • flumotion.component.base.producer.Producer
  • flumotion.component.component.BaseComponentMedium: I am a medium interfacing with a manager-side avatar.
    • flumotion.component.feedcomponent.FeedComponentMedium: I am a component-side medium for a FeedComponent to interface with the manager-side ComponentAvatar.
  • flumotion.twisted.portal.BouncerPortal: I am a portal for an FPB server using a bouncer to decide on FPB client access.
  • flumotion.common.registry.ComponentRegistry: Registry, this is normally not instantiated.
  • flumotion.common.config.ConfigEntryComponent: I represent a <component> entry in a planet config file
  • flumotion.twisted.checkers.CryptChecker: I check credentials using a crypt-based backend.
  • flumotion.component.feedcomponent.Effect: I am a part of a feed component for a specific group of functionality.
  • flumotion.twisted.checkers.FlexibleCredentialsChecker: I am an in-memory username/password credentials checker that also allows anonymous logins if instructed to do so.
  • flumotion.common.config.FlumotionConfigXML: I represent a planet configuration file for Flumotion.
  • flumotion.twisted.pb.FPBClientFactory: I am an extended Perspective Broker client factory using generic keycards for login.
    • flumotion.component.component.ComponentClientFactory: I am a client factory for a component logging in to the manager.
    • flumotion.twisted.pb.ReconnectingFPBClientFactory: Reconnecting client factory for FPB brokers.
      • flumotion.worker.worker.WorkerClientFactory: I am a client factory for the worker to log in to the manager.
  • flumotion.worker.worker.JobAvatar: I am an avatar for the job living in the worker.
  • flumotion.worker.job.JobClientFactory: I am a client factory that logs in to the WorkerBrain.
  • flumotion.worker.worker.JobHeaven: I am similar to but not quite the same as a manager-side Heaven.
  • flumotion.worker.job.JobMedium: I am a medium between the job and the worker's job avatar.
  • flumotion.worker.worker.Kindergarten: I spawn job processes.
  • flumotion.manager.base.ManagerAvatar: I am a base class for manager-side avatars to subclass from.
    • flumotion.manager.admin.AdminAvatar: I am an avatar created for an administrative client interface.
    • flumotion.manager.component.ComponentAvatar: Manager-side avatar for a component.
    • flumotion.manager.worker.WorkerAvatar: I am an avatar created for a worker.
  • flumotion.manager.base.ManagerHeaven: I am a base class for heavens in the manager.
    • flumotion.manager.admin.AdminHeaven: I interface between the Manager and administrative clients.
    • flumotion.manager.component.ComponentHeaven: I handle all registered components and provide avatars for them.
    • flumotion.manager.worker.WorkerHeaven: I interface between the Manager and worker clients.
  • flumotion.manager.manager.Vishnu: I am the toplevel manager object that knows about all heavens and factories.
  • flumotion.worker.worker.WorkerBrain: I manage jobs and everything related.
  • flumotion.worker.config.WorkerConfigXML
  • flumotion.worker.worker.WorkerMedium: I am a medium interfacing with the manager-side WorkerAvatar.
• flumotion.manager.main.ServerContextFactory
• flumotion.twisted.credentials.Username: I am your average username and password credentials.
• flumotion.twisted.credentials.UsernameCryptPasswordCrypt: I take a username and a crypt password.
• flumotion.twisted.credentials.UsernameCryptPasswordCryptChallenger: I take a username.
  • flumotion.common.keycards.KeycardUACPCC: I am a keycard with a username and IP address.
• flumotion.twisted.credentials.UsernameCryptPasswordPlaintext: I take a username and a plaintext password.
  • flumotion.common.keycards.KeycardUACPP: I am a keycard with a username, plaintext password and IP address.
• flumotion.worker.config.ConfigEntryAuthentication: I represent a <authentication> entry in a worker config file
• flumotion.worker.config.ConfigEntryManager: I represent a <manager> entry in a worker config file
• flumotion.worker.worker.JobDispatcher: I am a Realm inside the worker for forked jobs to log in to.
• flumotion.worker.worker.Kid: I am an abstraction of a job process started by the worker.
• flumotion.worker.worker.Port: I am an abstraction of a local TCP port which will be used by GStreamer.
• twisted.cred.checkers.InMemoryUsernamePasswordDatabaseDontUse
  • flumotion.twisted.checkers.FlexibleCredentialsChecker: I am an in-memory username/password credentials checker that also allows anonymous logins if instructed to do so.
• twisted.internet.base.ReactorBase: Default base class for Reactors.
  • twisted.internet.default.PosixReactorBase: A basis for reactors that use file descriptors.
• twisted.internet.protocol.Factory: This is a factory which produces protocols.
  • twisted.internet.protocol.ClientFactory: A Protocol factory for clients.
    • twisted.spread.pb.PBClientFactory: Client factory for PB brokers.
      • flumotion.twisted.pb.FPBClientFactory: I am an extended Perspective Broker client factory using generic keycards for login.
        • flumotion.component.component.ComponentClientFactory: I am a client factory for a component logging in to the manager.
        • flumotion.twisted.pb.ReconnectingFPBClientFactory: Reconnecting client factory for FPB brokers.
          • flumotion.worker.worker.WorkerClientFactory: I am a client factory for the worker to log in to the manager.
      • flumotion.worker.job.JobClientFactory: I am a client factory that logs in to the WorkerBrain.
    • twisted.internet.protocol.ReconnectingClientFactory: My clients auto-reconnect with an exponential back-off.
      • flumotion.twisted.pb.ReconnectingFPBClientFactory: Reconnecting client factory for FPB brokers.
        • flumotion.worker.worker.WorkerClientFactory: I am a client factory for the worker to log in to the manager.
• twisted.persisted.styles.Ephemeral: This type of object is never persisted; if possible, even references to it are eliminated.
  • twisted.spread.banana.Pynana
    • twisted.spread.banana.Canana
      • twisted.spread.pb.Broker: I am a broker for objects.
• twisted.spread.jelly.Jellyable: Inherit from me to Jelly yourself directly with the `getStateFor' convenience method.
  • twisted.spread.flavors.Serializable: An object that can be passed remotely.
    • twisted.spread.flavors.Copyable: Subclass me to get copied each time you are returned from or passed to a remote method.
      • twisted.spread.flavors.Cacheable: A cached instance.
        • flumotion.twisted.flavors.StateCacheable: I am a cacheable state object.
          • flumotion.common.component.JobComponentState
          • flumotion.common.component.ManagerComponentState
          • flumotion.common.worker.ManagerWorkerHeavenState
      • flumotion.common.keycards.Keycard: I am the base class for keycards which together with credentials are a serializable object used in authentication inside Flumotion.
        • flumotion.common.keycards.KeycardUACPCC: I am a keycard with a username and IP address.
        • flumotion.common.keycards.KeycardUACPP: I am a keycard with a username, plaintext password and IP address.
    • twisted.spread.flavors.Referenceable
      • flumotion.admin.admin.AdminModel: I live in the admin client.
      • flumotion.component.component.BaseComponentMedium: I am a medium interfacing with a manager-side avatar.
        • flumotion.component.feedcomponent.FeedComponentMedium: I am a component-side medium for a FeedComponent to interface with the manager-side ComponentAvatar.
      • flumotion.worker.job.JobMedium: I am a medium between the job and the worker's job avatar.
      • twisted.spread.flavors.Root: I provide a root object to pb.Brokers for a pb.BrokerFactory.
        • flumotion.worker.worker.JobHeaven: I am similar to but not quite the same as a manager-side Heaven.
        • flumotion.manager.base.ManagerHeaven: I am a base class for heavens in the manager.
          • flumotion.manager.admin.AdminHeaven: I interface between the Manager and administrative clients.
          • flumotion.manager.component.ComponentHeaven: I handle all registered components and provide avatars for them.
          • flumotion.manager.worker.WorkerHeaven: I interface between the Manager and worker clients.
      • flumotion.worker.worker.WorkerMedium: I am a medium interfacing with the manager-side WorkerAvatar.
    • twisted.spread.flavors.RemoteCache: A cache is a local representation of a remote Cacheable object.
      • flumotion.twisted.flavors.StateRemoteCache: I am a remote cache of a state object.
        • flumotion.common.component.AdminComponentState
        • flumotion.common.worker.AdminWorkerHeavenState
        • flumotion.common.component.ManagerComponentState
• twisted.spread.jelly.Unjellyable: Inherit from me to Unjelly yourself directly with the `setStateFor' convenience method.
  • twisted.spread.flavors.RemoteCopy: I am a remote copy of a Copyable object.
    • flumotion.common.keycards.Keycard: I am the base class for keycards which together with credentials are a serializable object used in authentication inside Flumotion.
      • flumotion.common.keycards.KeycardUACPCC: I am a keycard with a username and IP address.
      • flumotion.common.keycards.KeycardUACPP: I am a keycard with a username, plaintext password and IP address.
    • twisted.spread.flavors.RemoteCache: A cache is a local representation of a remote Cacheable object.
      • flumotion.twisted.flavors.StateRemoteCache: I am a remote cache of a state object.
        • flumotion.common.component.AdminComponentState
        • flumotion.common.worker.AdminWorkerHeavenState
        • flumotion.common.component.ManagerComponentState
• twisted.spread.pb.Avatar: A default IPerspective implementor.
  • flumotion.worker.worker.JobAvatar: I am an avatar for the job living in the worker.
  • flumotion.manager.base.ManagerAvatar: I am a base class for manager-side avatars to subclass from.
    • flumotion.manager.admin.AdminAvatar: I am an avatar created for an administrative client interface.
    • flumotion.manager.component.ComponentAvatar: Manager-side avatar for a component.
    • flumotion.manager.worker.WorkerAvatar: I am an avatar created for a worker.