annotate liboctave/oct-mutex.h @ 7936:78400fde223e

Support for backend-to-octave event management
author John W. Eaton <jwe@octave.org>
date Thu, 17 Jul 2008 07:58:50 -0400
parents 5a156ab94dd2
children 7b8aca1cdf0a
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
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
26 class
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
27 OCTAVE_API
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
28 octave_mutex
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
29 {
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
30 public:
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
31 octave_mutex (void);
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
32
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
33 octave_mutex (const octave_mutex& m)
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
34 {
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
35 rep = m.rep;
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
36 rep->count++;
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
37 }
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
38
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
39 virtual ~octave_mutex (void)
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
40 {
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
41 if (rep && --rep->count == 0)
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
42 {
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
43 delete rep;
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
44 rep = 0;
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
45 }
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
46 }
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
47
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
48 octave_mutex& operator = (const octave_mutex& m)
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 if (rep != m.rep)
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
51 {
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
52 if (rep && --rep->count == 0)
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
53 delete rep;
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
54
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
55 rep = m.rep;
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
56 rep->count++;
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
57 }
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
58
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
59 return *this;
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
60 }
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
61
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
62 virtual void lock (void)
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
63 { rep->lock (); }
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
64
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
65 virtual void unlock (void)
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
66 { rep->unlock (); }
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
67
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
68 protected:
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
69 explicit octave_mutex (int /* dummy */)
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
70 : count (0) { }
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
71
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
72 protected:
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
73 union
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 octave_mutex *rep;
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
76 int count;
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
77 };
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
78 };
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
79
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
80 class
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
81 octave_autolock
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
82 {
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
83 public:
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
84 octave_autolock (const octave_mutex& m)
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
85 : mutex (m)
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
86 {
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
87 mutex.lock ();
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
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
90 ~octave_autolock (void)
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 mutex.unlock ();
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
93 }
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
94
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
95 private:
7936
78400fde223e Support for backend-to-octave event management
John W. Eaton <jwe@octave.org>
parents: 7934
diff changeset
96
78400fde223e Support for backend-to-octave event management
John W. Eaton <jwe@octave.org>
parents: 7934
diff changeset
97 // No copying or default constructor!
78400fde223e Support for backend-to-octave event management
John W. Eaton <jwe@octave.org>
parents: 7934
diff changeset
98 octave_autolock (void);
78400fde223e Support for backend-to-octave event management
John W. Eaton <jwe@octave.org>
parents: 7934
diff changeset
99 octave_autolock (const octave_autolock&);
78400fde223e Support for backend-to-octave event management
John W. Eaton <jwe@octave.org>
parents: 7934
diff changeset
100 octave_autolock& operator = (const octave_autolock&);
7934
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
101
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
102 private:
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
103 octave_mutex mutex;
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
104 };
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
105
5a156ab94dd2 Add octave_mutex class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
106 #endif