annotate liboctave/oct-mutex.h @ 7952:2c0a0edae596

reorganize octave_mutex class
author John W. Eaton <jwe@octave.org>
date Sat, 19 Jul 2008 22:59:14 -0400
parents 7b8aca1cdf0a
children ba2e00a216e8
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7934
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
1 /*
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
2
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
3 Copyright (C) 2008 Michael Goffioul
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
4
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
5 This file is part of Octave.
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
6
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
7 Octave is free software; you can redistribute it and/or modify it
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
8 under the terms of the GNU General Public License as published by the
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
9 Free Software Foundation; either version 3 of the License, or (at your
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
10 option) any later version.
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
11
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
12 Octave is distributed in the hope that it will be useful, but WITHOUT
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
15 for more details.
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
16
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
17 You should have received a copy of the GNU General Public License
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
18 along with Octave; see the file COPYING. If not, see
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
19 <http://www.gnu.org/licenses/>.
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
20
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
21 */
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
22
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
23 #if !defined (octave_octave_mutex_h)
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
24 #define octave_octave_mutex_h 1
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
25
7952
2c0a0edae596 reorganize octave_mutex class
John W. Eaton <jwe@octave.org>
parents: 7943
diff changeset
26 class octave_mutex;
2c0a0edae596 reorganize octave_mutex class
John W. Eaton <jwe@octave.org>
parents: 7943
diff changeset
27
2c0a0edae596 reorganize octave_mutex class
John W. Eaton <jwe@octave.org>
parents: 7943
diff changeset
28 class
2c0a0edae596 reorganize octave_mutex class
John W. Eaton <jwe@octave.org>
parents: 7943
diff changeset
29 octave_base_mutex
2c0a0edae596 reorganize octave_mutex class
John W. Eaton <jwe@octave.org>
parents: 7943
diff changeset
30 {
2c0a0edae596 reorganize octave_mutex class
John W. Eaton <jwe@octave.org>
parents: 7943
diff changeset
31 public:
2c0a0edae596 reorganize octave_mutex class
John W. Eaton <jwe@octave.org>
parents: 7943
diff changeset
32 friend class octave_mutex;
2c0a0edae596 reorganize octave_mutex class
John W. Eaton <jwe@octave.org>
parents: 7943
diff changeset
33
2c0a0edae596 reorganize octave_mutex class
John W. Eaton <jwe@octave.org>
parents: 7943
diff changeset
34 octave_base_mutex (void) : count (-1) { }
2c0a0edae596 reorganize octave_mutex class
John W. Eaton <jwe@octave.org>
parents: 7943
diff changeset
35
2c0a0edae596 reorganize octave_mutex class
John W. Eaton <jwe@octave.org>
parents: 7943
diff changeset
36 virtual ~octave_base_mutex (void) { }
2c0a0edae596 reorganize octave_mutex class
John W. Eaton <jwe@octave.org>
parents: 7943
diff changeset
37
2c0a0edae596 reorganize octave_mutex class
John W. Eaton <jwe@octave.org>
parents: 7943
diff changeset
38 virtual void lock (void);
2c0a0edae596 reorganize octave_mutex class
John W. Eaton <jwe@octave.org>
parents: 7943
diff changeset
39
2c0a0edae596 reorganize octave_mutex class
John W. Eaton <jwe@octave.org>
parents: 7943
diff changeset
40 virtual void unlock (void);
2c0a0edae596 reorganize octave_mutex class
John W. Eaton <jwe@octave.org>
parents: 7943
diff changeset
41
2c0a0edae596 reorganize octave_mutex class
John W. Eaton <jwe@octave.org>
parents: 7943
diff changeset
42 private:
2c0a0edae596 reorganize octave_mutex class
John W. Eaton <jwe@octave.org>
parents: 7943
diff changeset
43 int count;
2c0a0edae596 reorganize octave_mutex class
John W. Eaton <jwe@octave.org>
parents: 7943
diff changeset
44 };
2c0a0edae596 reorganize octave_mutex class
John W. Eaton <jwe@octave.org>
parents: 7943
diff changeset
45
7934
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
46 class
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
47 OCTAVE_API
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
48 octave_mutex
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
49 {
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
50 public:
7952
2c0a0edae596 reorganize octave_mutex class
John W. Eaton <jwe@octave.org>
parents: 7943
diff changeset
51 octave_mutex (void);
2c0a0edae596 reorganize octave_mutex class
John W. Eaton <jwe@octave.org>
parents: 7943
diff changeset
52
2c0a0edae596 reorganize octave_mutex class
John W. Eaton <jwe@octave.org>
parents: 7943
diff changeset
53 octave_mutex (const octave_mutex& m)
2c0a0edae596 reorganize octave_mutex class
John W. Eaton <jwe@octave.org>
parents: 7943
diff changeset
54 {
2c0a0edae596 reorganize octave_mutex class
John W. Eaton <jwe@octave.org>
parents: 7943
diff changeset
55 rep = m.rep;
2c0a0edae596 reorganize octave_mutex class
John W. Eaton <jwe@octave.org>
parents: 7943
diff changeset
56 rep->count++;
2c0a0edae596 reorganize octave_mutex class
John W. Eaton <jwe@octave.org>
parents: 7943
diff changeset
57 }
7934
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
58
7952
2c0a0edae596 reorganize octave_mutex class
John W. Eaton <jwe@octave.org>
parents: 7943
diff changeset
59 ~octave_mutex (void)
2c0a0edae596 reorganize octave_mutex class
John W. Eaton <jwe@octave.org>
parents: 7943
diff changeset
60 {
2c0a0edae596 reorganize octave_mutex class
John W. Eaton <jwe@octave.org>
parents: 7943
diff changeset
61 if (--rep->count == 0)
2c0a0edae596 reorganize octave_mutex class
John W. Eaton <jwe@octave.org>
parents: 7943
diff changeset
62 delete rep;
2c0a0edae596 reorganize octave_mutex class
John W. Eaton <jwe@octave.org>
parents: 7943
diff changeset
63 }
2c0a0edae596 reorganize octave_mutex class
John W. Eaton <jwe@octave.org>
parents: 7943
diff changeset
64
2c0a0edae596 reorganize octave_mutex class
John W. Eaton <jwe@octave.org>
parents: 7943
diff changeset
65 octave_mutex& operator = (const octave_mutex& m)
2c0a0edae596 reorganize octave_mutex class
John W. Eaton <jwe@octave.org>
parents: 7943
diff changeset
66 {
2c0a0edae596 reorganize octave_mutex class
John W. Eaton <jwe@octave.org>
parents: 7943
diff changeset
67 if (rep != m.rep)
7934
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
68 {
7952
2c0a0edae596 reorganize octave_mutex class
John W. Eaton <jwe@octave.org>
parents: 7943
diff changeset
69 if (--rep->count == 0)
2c0a0edae596 reorganize octave_mutex class
John W. Eaton <jwe@octave.org>
parents: 7943
diff changeset
70 delete rep;
2c0a0edae596 reorganize octave_mutex class
John W. Eaton <jwe@octave.org>
parents: 7943
diff changeset
71
7934
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
72 rep = m.rep;
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
73 rep->count++;
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
74 }
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
75
7952
2c0a0edae596 reorganize octave_mutex class
John W. Eaton <jwe@octave.org>
parents: 7943
diff changeset
76 return *this;
2c0a0edae596 reorganize octave_mutex class
John W. Eaton <jwe@octave.org>
parents: 7943
diff changeset
77 }
7934
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
78
7952
2c0a0edae596 reorganize octave_mutex class
John W. Eaton <jwe@octave.org>
parents: 7943
diff changeset
79 void lock (void)
2c0a0edae596 reorganize octave_mutex class
John W. Eaton <jwe@octave.org>
parents: 7943
diff changeset
80 {
2c0a0edae596 reorganize octave_mutex class
John W. Eaton <jwe@octave.org>
parents: 7943
diff changeset
81 rep->lock ();
2c0a0edae596 reorganize octave_mutex class
John W. Eaton <jwe@octave.org>
parents: 7943
diff changeset
82 }
7934
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
83
7952
2c0a0edae596 reorganize octave_mutex class
John W. Eaton <jwe@octave.org>
parents: 7943
diff changeset
84 void unlock (void)
2c0a0edae596 reorganize octave_mutex class
John W. Eaton <jwe@octave.org>
parents: 7943
diff changeset
85 {
2c0a0edae596 reorganize octave_mutex class
John W. Eaton <jwe@octave.org>
parents: 7943
diff changeset
86 rep->unlock ();
2c0a0edae596 reorganize octave_mutex class
John W. Eaton <jwe@octave.org>
parents: 7943
diff changeset
87 }
7934
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
88
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
89 protected:
7952
2c0a0edae596 reorganize octave_mutex class
John W. Eaton <jwe@octave.org>
parents: 7943
diff changeset
90 octave_base_mutex *rep;
7934
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
91 };
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
92
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
93 class
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
94 octave_autolock
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
95 {
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
96 public:
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
97 octave_autolock (const octave_mutex& m)
7952
2c0a0edae596 reorganize octave_mutex class
John W. Eaton <jwe@octave.org>
parents: 7943
diff changeset
98 : mutex (m)
2c0a0edae596 reorganize octave_mutex class
John W. Eaton <jwe@octave.org>
parents: 7943
diff changeset
99 {
2c0a0edae596 reorganize octave_mutex class
John W. Eaton <jwe@octave.org>
parents: 7943
diff changeset
100 mutex.lock ();
2c0a0edae596 reorganize octave_mutex class
John W. Eaton <jwe@octave.org>
parents: 7943
diff changeset
101 }
7934
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
102
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
103 ~octave_autolock (void)
7952
2c0a0edae596 reorganize octave_mutex class
John W. Eaton <jwe@octave.org>
parents: 7943
diff changeset
104 {
2c0a0edae596 reorganize octave_mutex class
John W. Eaton <jwe@octave.org>
parents: 7943
diff changeset
105 mutex.unlock ();
2c0a0edae596 reorganize octave_mutex class
John W. Eaton <jwe@octave.org>
parents: 7943
diff changeset
106 }
7934
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
107
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
108 private:
7936
78400fde223e Support for backend-to-octave event management
John W. Eaton <jwe@octave.org>
parents: 7934
diff changeset
109
78400fde223e Support for backend-to-octave event management
John W. Eaton <jwe@octave.org>
parents: 7934
diff changeset
110 // No copying or default constructor!
78400fde223e Support for backend-to-octave event management
John W. Eaton <jwe@octave.org>
parents: 7934
diff changeset
111 octave_autolock (void);
78400fde223e Support for backend-to-octave event management
John W. Eaton <jwe@octave.org>
parents: 7934
diff changeset
112 octave_autolock (const octave_autolock&);
78400fde223e Support for backend-to-octave event management
John W. Eaton <jwe@octave.org>
parents: 7934
diff changeset
113 octave_autolock& operator = (const octave_autolock&);
7934
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
114
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
115 private:
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
116 octave_mutex mutex;
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
117 };
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
118
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
119 #endif