plibsys
prwlock.h
Go to the documentation of this file.
1 /*
2  * The MIT License
3  *
4  * Copyright (C) 2016 Alexander Saprykin <saprykin.spb@gmail.com>
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining
7  * a copy of this software and associated documentation files (the
8  * 'Software'), to deal in the Software without restriction, including
9  * without limitation the rights to use, copy, modify, merge, publish,
10  * distribute, sublicense, and/or sell copies of the Software, and to
11  * permit persons to whom the Software is furnished to do so, subject to
12  * the following conditions:
13  *
14  * The above copyright notice and this permission notice shall be
15  * included in all copies or substantial portions of the Software.
16  *
17  * THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
18  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
19  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
20  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
21  * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
22  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
23  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
24  */
25 
66 #if !defined (PLIBSYS_H_INSIDE) && !defined (PLIBSYS_COMPILATION)
67 # error "Header files shouldn't be included directly, consider using <plibsys.h> instead."
68 #endif
69 
70 #ifndef PLIBSYS_HEADER_PRWLOCK_H
71 #define PLIBSYS_HEADER_PRWLOCK_H
72 
73 #include <pmacros.h>
74 #include <ptypes.h>
75 
77 
79 typedef struct PRWLock_ PRWLock;
80 
87 
100 
113 
130 
143 
156 
173 
181 P_LIB_API void p_rwlock_free (PRWLock *lock);
182 
184 
185 #endif /* PLIBSYS_HEADER_PRWLOCK_H */
P_LIB_API void p_rwlock_free(PRWLock *lock)
Frees a PRWLock object.
#define P_END_DECLS
Closes .h file declarations to be exported as C functions, should be always used after P_BEGIN_DECLS...
Definition: pmacros.h:299
typedefP_BEGIN_DECLS struct PRWLock_ PRWLock
Read-write lock opaque data structure.
Definition: prwlock.h:79
Miscellaneous macros.
P_LIB_API pboolean p_rwlock_writer_lock(PRWLock *lock)
Locks a read-write lock for writing.
P_LIB_API pboolean p_rwlock_writer_unlock(PRWLock *lock)
Releases a locked for writing read-write lock.
P_LIB_API pboolean p_rwlock_reader_unlock(PRWLock *lock)
Releases a locked for reading read-write lock.
signed int pboolean
Type for a bool.
Definition: ptypes.h:114
P_LIB_API pboolean p_rwlock_reader_lock(PRWLock *lock)
Locks a read-write lock for reading.
P_LIB_API pboolean p_rwlock_reader_trylock(PRWLock *lock)
Tries to lock a read-write lock for reading immediately.
P_LIB_API pboolean p_rwlock_writer_trylock(PRWLock *lock)
Tries to lock a read-write lock immediately.
P_LIB_API PRWLock * p_rwlock_new(void)
Creates a new PRWLock object.
#define P_LIB_API
Exports a symbol from a shared library.
Definition: pmacros.h:138
Types definitions.
#define P_BEGIN_DECLS
Starts .h file declarations to be exported as C functions.
Definition: pmacros.h:298