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
◆ applyConfig()
| OMV\Engine\Module\IService::applyConfig | ( | ) |
Generate the configuration.
Implemented in OMV\Engine\Module\ServiceAbstract.
◆ shouldApply()
| OMV\Engine\Module\IService::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 OMV\Engine\Module\ServiceAbstract.
◆ shouldStart()
| OMV\Engine\Module\IService::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 OMV\Engine\Module\ServiceAbstract.
◆ shouldStop()
| OMV\Engine\Module\IService::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 OMV\Engine\Module\ServiceAbstract.
◆ startBefore()
| OMV\Engine\Module\IService::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 OMV\Engine\Module\ServiceAbstract.
◆ startService()
| OMV\Engine\Module\IService::startService | ( | ) |
Start the managed service.
Implemented in OMV\Engine\Module\ServiceAbstract.
◆ stopAfter()
| OMV\Engine\Module\IService::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 OMV\Engine\Module\ServiceAbstract.
◆ stopService()
| OMV\Engine\Module\IService::stopService | ( | ) |
Stop the managed service.
Implemented in OMV\Engine\Module\ServiceAbstract.
The documentation for this interface was generated from the following file:
- iservice.inc
