<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.5"/> <title>GNU CommonC++: objsync.h Source File</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">GNU CommonC++ </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.5 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li><a href="annotated.html"><span>Classes</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> <li><a href="examples.html"><span>Examples</span></a></li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="files.html"><span>File List</span></a></li> <li><a href="globals.html"><span>File Members</span></a></li> </ul> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="dir_bfccd401955b95cf8c75461437045ac0.html">inc</a></li><li class="navelem"><a class="el" href="dir_6b3e09e31d3da6038137f0238e9fb19b.html">cc++</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="headertitle"> <div class="title">objsync.h</div> </div> </div><!--header--> <div class="contents"> <a href="objsync_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// Copyright (C) 2001-2005 Open Source Telecom Corporation.</span></div> <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// Copyright (C) 2006-2010 David Sugar, Tycho Softworks.</span></div> <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">//</span></div> <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// This program is free software; you can redistribute it and/or modify</span></div> <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// it under the terms of the GNU General Public License as published by</span></div> <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">// the Free Software Foundation; either version 2 of the License, or</span></div> <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">// (at your option) any later version.</span></div> <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">//</span></div> <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">// This program is distributed in the hope that it will be useful,</span></div> <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">// but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div> <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span></div> <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">// GNU General Public License for more details.</span></div> <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">//</span></div> <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">// You should have received a copy of the GNU General Public License</span></div> <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">// along with this program; if not, write to the Free Software</span></div> <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.</span></div> <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">//</span></div> <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">// As a special exception to the GNU General Public License, permission is</span></div> <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">// granted for additional uses of the text contained in its release</span></div> <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">// of Common C++.</span></div> <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment">//</span></div> <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">// The exception is that, if you link the Common C++ library with other</span></div> <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment">// files to produce an executable, this does not by itself cause the</span></div> <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment">// resulting executable to be covered by the GNU General Public License.</span></div> <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment">// Your use of that executable is in no way restricted on account of</span></div> <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment">// linking the Common C++ library code into it.</span></div> <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment">//</span></div> <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment">// This exception does not however invalidate any other reasons why</span></div> <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment">// the executable file might be covered by the GNU General Public License.</span></div> <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment">//</span></div> <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment">// This exception applies only to the code released under the</span></div> <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment">// name Common C++. If you copy code from other releases into a copy of</span></div> <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment">// Common C++, as the General Public License permits, the exception does</span></div> <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment">// not apply to the code that you add in this way. To avoid misleading</span></div> <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment">// anyone as to the status of such modified files, you must delete</span></div> <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment">// this exception notice from them.</span></div> <div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment">//</span></div> <div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment">// If you write modifications of your own for Common C++, it is your choice</span></div> <div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment">// whether to permit this exception to apply to your modifications.</span></div> <div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment">// If you do not wish that, delete this exception notice.</span></div> <div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div> <div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="preprocessor">#ifndef CCXX_OBJSYNC_H</span></div> <div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="preprocessor"></span><span class="preprocessor">#define CCXX_OBJSYNC_H</span></div> <div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="preprocessor"></span><span class="preprocessor">#include <<a class="code" href="thread_8h.html">cc++/thread.h</a>></span></div> <div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div> <div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="preprocessor">#ifdef CCXX_NAMESPACES</span></div> <div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="preprocessor"></span><span class="keyword">namespace </span>ost {</div> <div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="preprocessor">#endif</span></div> <div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="keyword">template</span> <<span class="keyword">class</span> T></div> <div class="line"><a name="l00063"></a><span class="lineno"><a class="line" href="classost_1_1obj_sync.html"> 63</a></span> <span class="keyword">class </span><a class="code" href="classost_1_1obj_sync.html">objSync</a></div> <div class="line"><a name="l00064"></a><span class="lineno"> 64</span> {</div> <div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="keyword">private</span>:</div> <div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keyword">static</span> <a class="code" href="classost_1_1_mutex.html">ost::Mutex</a> objMutex;</div> <div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div> <div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="keyword">protected</span>:</div> <div class="line"><a name="l00069"></a><span class="lineno"><a class="line" href="classost_1_1obj_sync.html#a0a40287ae8a4a131bf9c1cd0b4d10ce6"> 69</a></span>  <span class="keywordtype">void</span> <a class="code" href="classost_1_1obj_sync.html#a0a40287ae8a4a131bf9c1cd0b4d10ce6">objLock</a>(<span class="keywordtype">void</span>)</div> <div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  {++objMutex;};</div> <div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div> <div class="line"><a name="l00072"></a><span class="lineno"><a class="line" href="classost_1_1obj_sync.html#a2f1c654e4110b6b055848afed2dda314"> 72</a></span>  <span class="keywordtype">void</span> <a class="code" href="classost_1_1obj_sync.html#a2f1c654e4110b6b055848afed2dda314">objUnlock</a>(<span class="keywordtype">void</span>)</div> <div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  {--objMutex;};</div> <div class="line"><a name="l00074"></a><span class="lineno"> 74</span> };</div> <div class="line"><a name="l00075"></a><span class="lineno"> 75</span> </div> <div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="keyword">template</span> <<span class="keyword">class</span> T></div> <div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <a class="code" href="classost_1_1_mutex.html">ost::Mutex</a> objSync<T>::objMutex;</div> <div class="line"><a name="l00078"></a><span class="lineno"> 78</span> </div> <div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="preprocessor">#ifdef CCXX_NAMESPACES</span></div> <div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="preprocessor"></span>} <span class="comment">// namespace</span></div> <div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="preprocessor">#endif</span></div> <div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="preprocessor">#endif</span></div> <div class="ttc" id="classost_1_1obj_sync_html"><div class="ttname"><a href="classost_1_1obj_sync.html">ost::objSync</a></div><div class="ttdoc">Generic template to create objects of a common base type which share a static mutex so that all insta...</div><div class="ttdef"><b>Definition:</b> objsync.h:63</div></div> <div class="ttc" id="classost_1_1obj_sync_html_a0a40287ae8a4a131bf9c1cd0b4d10ce6"><div class="ttname"><a href="classost_1_1obj_sync.html#a0a40287ae8a4a131bf9c1cd0b4d10ce6">ost::objSync::objLock</a></div><div class="ttdeci">void objLock(void)</div><div class="ttdef"><b>Definition:</b> objsync.h:69</div></div> <div class="ttc" id="thread_8h_html"><div class="ttname"><a href="thread_8h.html">thread.h</a></div><div class="ttdoc">Synchronization and threading services. </div></div> <div class="ttc" id="classost_1_1_mutex_html"><div class="ttname"><a href="classost_1_1_mutex.html">ost::Mutex</a></div><div class="ttdoc">The Mutex class is used to protect a section of code so that at any given time only a single thread c...</div><div class="ttdef"><b>Definition:</b> thread.h:186</div></div> <div class="ttc" id="classost_1_1obj_sync_html_a2f1c654e4110b6b055848afed2dda314"><div class="ttname"><a href="classost_1_1obj_sync.html#a2f1c654e4110b6b055848afed2dda314">ost::objSync::objUnlock</a></div><div class="ttdeci">void objUnlock(void)</div><div class="ttdef"><b>Definition:</b> objsync.h:72</div></div> </div><!-- fragment --></div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Thu Oct 17 2013 23:24:57 for GNU CommonC++ by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.5 </small></address> </body> </html>