OpenMediaVault  0.6 (Kralizec)
The open network attached storage solution
 All Classes Functions Variables Groups Pages
Public Member Functions | List of all members
OMVIModuleService Interface Reference
Inheritance diagram for OMVIModuleService:
OMVModuleServiceAbstract

Public Member Functions

 shouldApply ()
 
 shouldStart ()
 
 startBefore ()
 
 shouldStop ()
 
 stopAfter ()
 
 applyConfig ()
 
 stopService ()
 
 startService ()
 

Detailed Description

Interface to implement a service managed by the module.

Member Function Documentation

OMVIModuleService::applyConfig ( )

Generate the configuration.

Implemented in OMVModuleServiceAbstract.

OMVIModuleService::shouldApply ( )

Defines the modules that if present should build their configuration before the service provided by this module. Nevertheless, the module can still apply the configuration if the listed dependencies are missing.

Returns
An array of modules. Returns an empty array if no dependencies exist.

Implemented in OMVModuleServiceAbstract.

OMVIModuleService::shouldStart ( )

Defines the modules that if present should start before the service provided by this module. Nevertheless, the module can still start if the listed dependencies are missing.

Returns
An array of modules. Returns an empty array if no dependencies exist.

Implemented in OMVModuleServiceAbstract.

OMVIModuleService::shouldStop ( )

Defines the modules that if present should be stopped after the service provided by this module. Normally you would include here the same dependencies as those provided with the shouldStart method. Nevertheless, the module can still stop if the listed dependencies are missing.

Returns
An array of modules. Returns an empty array if no dependencies exist.

Implemented in OMVModuleServiceAbstract.

OMVIModuleService::startBefore ( )

Defines the modules that if present should start after the service provided by this module.

Returns
An array of modules. Returns an empty array if no dependencies exist.

Implemented in OMVModuleServiceAbstract.

OMVIModuleService::startService ( )

Start the managed service.

Implemented in OMVModuleServiceAbstract.

OMVIModuleService::stopAfter ( )

Defines the modules that if present should stop before the service provided by this module.

Returns
An array of modules. Returns an empty array if no dependencies exist.

Implemented in OMVModuleServiceAbstract.

OMVIModuleService::stopService ( )

Stop the managed service.

Implemented in OMVModuleServiceAbstract.


The documentation for this interface was generated from the following file: