apr/include/apr_proc_mutex.h

56 /** Opaque structure representing a process mutex. */
62  * Create and initialize a mutex that can be used to synchronize processes.
63  * @param mutex the memory address where the newly created mutex will be
77  * @param pool the pool from which to allocate the mutex.
82 APR_DECLARE(apr_status_t) apr_proc_mutex_create(apr_proc_mutex_t **mutex,
88  * Re-open a mutex in a child process.
89  * @param mutex The newly re-opened mutex structure.
90  * @param fname A file name to use if the mutex mechanism requires one.  This
91  *              argument should always be provided.  The mutex code itself will
98 APR_DECLARE(apr_status_t) apr_proc_mutex_child_init(apr_proc_mutex_t **mutex,
103  * Acquire the lock for the given mutex. If the mutex is already locked,
105  * @param mutex the mutex on which to acquire the lock.
107 APR_DECLARE(apr_status_t) apr_proc_mutex_lock(apr_proc_mutex_t *mutex);
110  * Attempt to acquire the lock for the given mutex. If the mutex has already
114  * @param mutex the mutex on which to attempt the lock acquiring.
116 APR_DECLARE(apr_status_t) apr_proc_mutex_trylock(apr_proc_mutex_t *mutex);
119  * Attempt to acquire the lock for the given mutex until timeout expires.
121  * @param mutex the mutex on which to attempt the lock acquiring.
126 APR_DECLARE(apr_status_t) apr_proc_mutex_timedlock(apr_proc_mutex_t *mutex,
130  * Release the lock for the given mutex.
131  * @param mutex the mutex from which to release the lock.
133 APR_DECLARE(apr_status_t) apr_proc_mutex_unlock(apr_proc_mutex_t *mutex);
136  * Destroy the mutex and free the memory associated with the lock.
137  * @param mutex the mutex to destroy.
139 APR_DECLARE(apr_status_t) apr_proc_mutex_destroy(apr_proc_mutex_t *mutex);
142  * Destroy the mutex and free the memory associated with the lock.
143  * @param mutex the mutex to destroy.
145  *       created mutex
147 APR_DECLARE(apr_status_t) apr_proc_mutex_cleanup(void *mutex);
150  * Return the name of the lockfile for the mutex, or NULL
151  * if the mutex doesn't use a lock file
154 APR_DECLARE(const char *) apr_proc_mutex_lockfile(apr_proc_mutex_t *mutex);
157  * Get the mechanism of the mutex, as it relates to the actual method
159  * @param mutex the mutex to get the mechanism from.
161 APR_DECLARE(apr_lockmech_e) apr_proc_mutex_mech(apr_proc_mutex_t *mutex);
164  * Get the mechanism's name of the mutex, as it relates to the actual method
166  * @param mutex the mutex to get the mechanism's name from.
168 APR_DECLARE(const char *) apr_proc_mutex_name(apr_proc_mutex_t *mutex);
171  * Display the name of the default mutex: APR_LOCK_DEFAULT
176  * Set mutex permissions.