plibsys
pspinlock.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 
55 #if !defined (PLIBSYS_H_INSIDE) && !defined (PLIBSYS_COMPILATION)
56 # error "Header files shouldn't be included directly, consider using <plibsys.h> instead."
57 #endif
58 
59 #ifndef PLIBSYS_HEADER_PSPINLOCK_H
60 #define PLIBSYS_HEADER_PSPINLOCK_H
61 
62 #include <pmacros.h>
63 #include <ptypes.h>
64 
66 
68 typedef struct PSpinLock_ PSpinLock;
69 
76 
93 
110 
126 
138 P_LIB_API void p_spinlock_free (PSpinLock *spinlock);
139 
141 
142 #endif /* PLIBSYS_HEADER_PSPINLOCK_H */
P_LIB_API pboolean p_spinlock_unlock(PSpinLock *spinlock)
Releases a locked spinlock.
#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
Miscellaneous macros.
P_LIB_API PSpinLock * p_spinlock_new(void)
Creates a new PSpinLock object.
P_LIB_API pboolean p_spinlock_lock(PSpinLock *spinlock)
Locks a spinlock.
signed int pboolean
Type for a bool.
Definition: ptypes.h:114
#define P_LIB_API
Exports a symbol from a shared library.
Definition: pmacros.h:138
P_LIB_API pboolean p_spinlock_trylock(PSpinLock *spinlock)
Tries to lock a spinlock immediately.
P_LIB_API void p_spinlock_free(PSpinLock *spinlock)
Frees PSpinLock object.
Types definitions.
#define P_BEGIN_DECLS
Starts .h file declarations to be exported as C functions.
Definition: pmacros.h:298
typedefP_BEGIN_DECLS struct PSpinLock_ PSpinLock
Spinlock opaque data structure.
Definition: pspinlock.h:68