Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document usage for H5TSmutex_release/acquire() #4836

Merged
merged 1 commit into from
Sep 17, 2024
Merged

Document usage for H5TSmutex_release/acquire() #4836

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 14 additions & 5 deletions src/H5TS.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
*
Expand Down Expand Up @@ -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().
*
* Return: Non-negative on success / Negative on failure
* 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
Expand Down
Loading