blob: 750ed3a6e249c0c7f2a6e0bf6fcda7eaec451b99 [file] [log] [blame]
Emeric Vigier2f625822012-08-06 11:09:52 -04001// Copyright (C) 2001-2005 Open Source Telecom Corporation.
2// Copyright (C) 2006-2010 David Sugar, Tycho Softworks.
3//
4// This program is free software; you can redistribute it and/or modify
5// it under the terms of the GNU General Public License as published by
6// the Free Software Foundation; either version 2 of the License, or
7// (at your option) any later version.
8//
9// This program is distributed in the hope that it will be useful,
10// but WITHOUT ANY WARRANTY; without even the implied warranty of
11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12// GNU General Public License for more details.
13//
14// You should have received a copy of the GNU General Public License
15// along with this program; if not, write to the Free Software
16// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
17//
18// As a special exception to the GNU General Public License, permission is
19// granted for additional uses of the text contained in its release
20// of Common C++.
21//
22// The exception is that, if you link the Common C++ library with other
23// files to produce an executable, this does not by itself cause the
24// resulting executable to be covered by the GNU General Public License.
25// Your use of that executable is in no way restricted on account of
26// linking the Common C++ library code into it.
27//
28// This exception does not however invalidate any other reasons why
29// the executable file might be covered by the GNU General Public License.
30//
31// This exception applies only to the code released under the
32// name Common C++. If you copy code from other releases into a copy of
33// Common C++, as the General Public License permits, the exception does
34// not apply to the code that you add in this way. To avoid misleading
35// anyone as to the status of such modified files, you must delete
36// this exception notice from them.
37//
38// If you write modifications of your own for Common C++, it is your choice
39// whether to permit this exception to apply to your modifications.
40// If you do not wish that, delete this exception notice.
41
42/**
43 * @file objsync.h
44 * @short Template for creating objects that share a global mutex.
45 **/
46
47#ifndef CCXX_OBJSYNC_H
48#define CCXX_OBJSYNC_H
49#include <cc++/thread.h>
50
51#ifdef CCXX_NAMESPACES
52namespace ost {
53#endif
54
55/**
56 * Generic template to create objects of a common base type which share
57 * a static mutex so that all instances of the class have a global lock.
58 *
59 * @author David Sugar <dyfet@gnutelephony.org>
60 * @short global mutex locked class.
61 */
62template <class T>
63class objSync
64{
65private:
66 static ost::Mutex objMutex;
67
68protected:
69 void objLock(void)
70 {++objMutex;};
71
72 void objUnlock(void)
73 {--objMutex;};
74};
75
76template <class T>
77ost::Mutex objSync<T>::objMutex;
78
79#ifdef CCXX_NAMESPACES
80} // namespace
81#endif
82
83#endif