Coin: SbMutex.h Source File

| Coin3D is Free Software, published under the BSD 3-clause license. | https://coin3d.github.io https://www.kongsberg.com/en/kogt/

SbMutex.h
1#ifndef COIN_SBMUTEX_H
2#define COIN_SBMUTEX_H
3
4/**************************************************************************\
5 * Copyright (c) Kongsberg Oil & Gas Technologies AS
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are
10 * met:
11 *
12 * Redistributions of source code must retain the above copyright notice,
13 * this list of conditions and the following disclaimer.
14 *
15 * Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 *
19 * Neither the name of the copyright holder nor the names of its
20 * contributors may be used to endorse or promote products derived from
21 * this software without specific prior written permission.
22 *
23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
26 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
27 * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
28 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
29 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
30 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
31 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
32 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34\**************************************************************************/
35
36#include <Inventor/SbBasic.h>
37#include <Inventor/C/threads/mutex.h>
38
39 class SbMutex {
40public:
41 SbMutex(void) { this->mutex = cc_mutex_construct(); }
42 ~SbMutex() { cc_mutex_destruct(this->mutex); }
43
44 int lock(void) {
45 cc_mutex_lock(this->mutex);
46 /* Useless return, here just for compatibility with TGS'
47 SbThreadMutex API: */
48 return 0;
49 }
50
51 SbBool tryLock(void) {
52 return cc_mutex_try_lock(this->mutex) == CC_OK;
53 }
54
55 int unlock(void) {
56 cc_mutex_unlock(this->mutex);
57 /* Useless return, here just for compatibility with TGS'
58 SbThreadMutex API: */
59 return 0;
60 }
61
62private:
63 // FIXME: we need access to C mutex structure. Should we use friend,
64 // or should we add a new public method to get to this structure?
65 // pederb, 2002-06-26
66 friend class SbCondVar;
67 cc_mutex * mutex;
68};
69
70
71#ifndef COIN_INTERNAL
72// For TGS Inventor compile-time compatibility.
73#include <Inventor/threads/SbThreadAutoLock.h>
74#endif // COIN_INTERNAL
75
76#endif // !COIN_SBMUTEX_H