fwDPELock.ctl File Reference
The library to handle DPE locks.This library contains a set of functions that handle DPE Locks: lock, unlock, check the state of locking, as well as a lock-monitor that guards that the locked datapoints will not remain locked unnecessarily.
More...
Functions |
| string | _fwDPELock_getLockConfig (string dpeWithConfig) |
| bool | fwDPELock_isLocked (string dpeWithConfig) |
| bool | fwDPELock_getLocked (string dpeWithConfig, dyn_string &lockDetails, dyn_string &exceptionInfo) |
| bool | fwDPELock_tryLock (string dpeWithConfig, dyn_string &exceptionInfo, int lockTimeout=1, int lockLifetime=5) |
| void | fwDPELock_unlock (string dpeWithConfig, dyn_string &exceptionInfo, bool force=false) |
| private void | _fwDPELock_checkStartLockManager () |
| void | fwDPELock_lockGuard (string lockConfig, unsigned timeout=5) |
| private void | fwDPELock_startFunctionWithParams (string function, mixed params) |
| void | _fwDPELock_traceLockDPE (mixed params) |
| void | fwDPELock_traceLockDPE_callback (string where, bool value) |
| void | _fwDPELock_dpLockManager (string dummyParam) |
| private void | _fwDPELock_sudoUnlock (string lockConfig, dyn_string &exceptionInfo) |
Variables |
| const int | fwDPELock_ERR_DPE_DOES_NOT_EXIST = 8 |
| const int | fwDPELock_ERR_CONFIG_DOES_NOT_EXIST = 9 |
| global private bool | _fwDPELock_lockManagerRunning = false |
| global private dyn_dyn_mixed | _fwDPELock_dpLockList |
| global mixed | g_fwDPELock_startScriptParams |
| global dyn_string | g_fwDPELock_traceLockDPE_list |
Detailed Description
The library to handle DPE locks.
This library contains a set of functions that handle DPE Locks: lock, unlock, check the state of locking, as well as a lock-monitor that guards that the locked datapoints will not remain locked unnecessarily.
- Author:
- Piotr Golonka, CERN EN/ICE-SCD
Copyright CERN 2015, All Rights Reserved
- Constraints
- It is not (yet) guaranteed that this version works across distributed systems.
- It is not (yet) guaranteed that this version works in redundant systems.
Function Documentation
| private void _fwDPELock_checkStartLockManager |
( |
|
) |
|
| void fwDPELock_lockGuard |
( |
string |
lockConfig, |
|
|
unsigned |
timeout = 5 | |
|
) |
| | |
| private void fwDPELock_startFunctionWithParams |
( |
string |
function, |
|
|
mixed |
params | |
|
) |
| | |
| void _fwDPELock_traceLockDPE |
( |
mixed |
params |
) |
|
| void fwDPELock_traceLockDPE_callback |
( |
string |
where, |
|
|
bool |
value | |
|
) |
| | |
| void _fwDPELock_dpLockManager |
( |
string |
dummyParam |
) |
|
| private void _fwDPELock_sudoUnlock |
( |
string |
lockConfig, |
|
|
dyn_string & |
exceptionInfo | |
|
) |
| | |
Internal
Execute DPE unlocking as root, with fwAccessControl_sudo
Variable Documentation