mirror/hdf5
2
0
Fork 0
mirror of https://github.com/HDFGroup/hdf5.git synced 2025-02-23 16:20:57 +08:00
Code Issues Packages Projects Releases Wiki Activity

Document usage for H5TSmutex_release/acquire() (#4836)

Browse Source
This commit is contained in:
mattjala 2024-09-17 11:06:03 -05:00 committed by GitHub
parent 405d1b91d9
commit ca217e2c71
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 14 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
src/H5TS.c
View File

@ -67,10 +67,12 @@ H5TS_api_info_t H5TS_api_info_p;
/*--------------------------------------------------------------------------
* Function: H5TSmutex_acquire
*
* Purpose: Attempts to acquire the HDF5 library global lock
* Purpose: Attempts to acquire the HDF5 library global lock. Should be preceded by a call to
* H5TSmutex_release().
*
* Note: On success, the 'acquired' flag indicates if the HDF5 library
* global lock was acquired.
* Parameters:
* lock_count; IN: The lock count that was held on the mutex before its release
* acquired; OUT: Whether the HDF5 library global lock was acquired
*
* Return: Non-negative on success / Negative on failure
*
@ -118,10 +120,17 @@ H5TSmutex_get_attempt_count(unsigned *count)
/*--------------------------------------------------------------------------
* Function: H5TSmutex_release
*
* Purpose: Releases the HDF5 library global lock
* Purpose: Releases the HDF5 library global lock. Should be followed by a call to H5TSmutex_acquire().
*
* This should be used by applications to temporarily release the lock in order to either perform
* multi-threaded work of their own or yield control to another thread using HDF5. The value
* returned in lock_count should be provided to H5TSmutex_acquire() in order to resume a
* consistent library state.
*
* Parameters:
* lock_count; OUT: The current lock count for the calling thread.
*
* Return: Non-negative on success / Negative on failure
*
*--------------------------------------------------------------------------
*/
herr_t