A lock file is a file that, if it exists, indicates that a particular
resource is in use. The lock_files package contains procedures to create
and destroy lock files under any operating system. If a lock file cannot
be locked, an error is reported.
Create a lock file named file in directory dir. Retry up to retries (natural) times, waiting for wait (duration) seconds between retries. Default for wait/retries in 1.0 second and almost forever.
Example
lock_files.lock_file( "test_lock.lck" );
Parameters
Param
Mode
Type
Default
Description
dir
in
string
"."
the directory to place the lock file in
file
in
string
required
the name of the lock file
wait
in
duration
1.0
the number of seconds to wait between retries
retries
in
natural
largest natural
the maximum number of retries
Exceptions
If the file cannot be locked, SparForte reports an error.