This file is indexed.

/usr/share/doc/liblog4tango4-doc/html/api/PThreads_8hh_source.html is in liblog4tango4-doc 7.2.6+dfsg-4build2.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
<!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"/>
<title>log4tango: PThreads.hh Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.4 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">log4tango&#160;<span id="projectnumber">4.0.3</span></div>
  </td>
 </tr>
 </tbody>
</table>
</div>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;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>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>File&#160;Members</span></a></li>
    </ul>
  </div>
<div class="header">
  <div class="headertitle">
<div class="title">PThreads.hh</div>  </div>
</div>
<div class="contents">
<a href="PThreads_8hh.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">//</span>
<a name="l00002"></a>00002 <span class="comment">// PThreads.hh</span>
<a name="l00003"></a>00003 <span class="comment">//</span>
<a name="l00004"></a>00004 <span class="comment">// Copyright (C) :  2000 - 2002</span>
<a name="l00005"></a>00005 <span class="comment">//                                      LifeLine Networks BV (www.lifeline.nl). All rights reserved.</span>
<a name="l00006"></a>00006 <span class="comment">//                                      Bastiaan Bakker. All rights reserved.   </span>
<a name="l00007"></a>00007 <span class="comment">//                                      </span>
<a name="l00008"></a>00008 <span class="comment">//                                      2004,2005,2006,2007,2008,2009,2010</span>
<a name="l00009"></a>00009 <span class="comment">//                                      Synchrotron SOLEIL</span>
<a name="l00010"></a>00010 <span class="comment">//                      L&#39;Orme des Merisiers</span>
<a name="l00011"></a>00011 <span class="comment">//                      Saint-Aubin - BP 48 - France</span>
<a name="l00012"></a>00012 <span class="comment">//</span>
<a name="l00013"></a>00013 <span class="comment">// This file is part of log4tango.</span>
<a name="l00014"></a>00014 <span class="comment">//</span>
<a name="l00015"></a>00015 <span class="comment">// Log4ango is free software: you can redistribute it and/or modify</span>
<a name="l00016"></a>00016 <span class="comment">// it under the terms of the GNU Lesser General Public License as published by</span>
<a name="l00017"></a>00017 <span class="comment">// the Free Software Foundation, either version 3 of the License, or</span>
<a name="l00018"></a>00018 <span class="comment">// (at your option) any later version.</span>
<a name="l00019"></a>00019 <span class="comment">// </span>
<a name="l00020"></a>00020 <span class="comment">// Log4tango is distributed in the hope that it will be useful,</span>
<a name="l00021"></a>00021 <span class="comment">// but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00022"></a>00022 <span class="comment">// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</span>
<a name="l00023"></a>00023 <span class="comment">// GNU Lesser General Public License for more details.</span>
<a name="l00024"></a>00024 <span class="comment">// </span>
<a name="l00025"></a>00025 <span class="comment">// You should have received a copy of the GNU Lesser General Public License</span>
<a name="l00026"></a>00026 <span class="comment">// along with Log4Tango.  If not, see &lt;http://www.gnu.org/licenses/&gt;.</span>
<a name="l00027"></a>00027 
<a name="l00028"></a>00028 <span class="preprocessor">#ifndef _LOG4TANGO_THREADING_PTHREADS_H</span>
<a name="l00029"></a>00029 <span class="preprocessor"></span><span class="preprocessor">#define _LOG4TANGO_THREADING_PTHREADS_H</span>
<a name="l00030"></a>00030 <span class="preprocessor"></span>
<a name="l00031"></a>00031 <span class="preprocessor">#include &lt;<a class="code" href="Portability_8hh.html">log4tango/Portability.hh</a>&gt;</span>  
<a name="l00032"></a>00032 <span class="preprocessor">#include &lt;stdio.h&gt;</span>
<a name="l00033"></a>00033 <span class="preprocessor">#include &lt;pthread.h&gt;</span>
<a name="l00034"></a>00034 <span class="preprocessor">#include &lt;string&gt;</span>
<a name="l00035"></a>00035 <span class="preprocessor">#include &lt;assert.h&gt;</span>
<a name="l00036"></a>00036 
<a name="l00037"></a>00037 <span class="keyword">namespace </span>log4tango {
<a name="l00038"></a>00038 
<a name="l00039"></a>00039 <span class="keyword">namespace </span>threading {
<a name="l00040"></a>00040 
<a name="l00041"></a>00041 std::string <a class="code" href="namespacelog4tango_1_1threading.html#a91163823bc4a91e103ecad618f8b146a">get_thread_id</a> (<span class="keywordtype">void</span>);
<a name="l00042"></a>00042 
<a name="l00043"></a>00043 <span class="keywordtype">long</span> <a class="code" href="namespacelog4tango_1_1threading.html#a078567483c4ee7490efecaa30047117f">thread_id</a> (<span class="keywordtype">void</span>);
<a name="l00044"></a>00044 
<a name="l00045"></a>00045 <span class="comment">//-----------------------------------------------------------------------------</span>
<a name="l00046"></a>00046 <span class="comment">// Class : Mutex</span>
<a name="l00047"></a>00047 <span class="comment">//-----------------------------------------------------------------------------</span>
<a name="l00048"></a>00048 <span class="keyword">class </span><a class="code" href="namespacelog4tango_1_1threading.html#a6ab044c515d422f490f47a2499bf1f0a">Mutex</a>
<a name="l00049"></a>00049 {
<a name="l00050"></a>00050 <span class="keyword">private</span>:
<a name="l00051"></a>00051   pthread_mutex_t mutex;
<a name="l00052"></a>00052 
<a name="l00053"></a>00053   
<a name="l00054"></a>00054 <span class="keyword">public</span>:
<a name="l00055"></a><a class="code" href="classlog4tango_1_1threading_1_1Mutex.html#abc347dc995fca40b2017977630c173bc">00055</a>   <span class="keyword">inline</span> <a class="code" href="classlog4tango_1_1threading_1_1Mutex.html#abc347dc995fca40b2017977630c173bc">Mutex</a>() {
<a name="l00056"></a>00056     ::pthread_mutex_init(&amp;mutex, NULL);
<a name="l00057"></a>00057   }
<a name="l00058"></a>00058   
<a name="l00059"></a><a class="code" href="classlog4tango_1_1threading_1_1Mutex.html#ad75cb2944b40e951cb131c66a573ef3c">00059</a>   <span class="keyword">inline</span> <a class="code" href="classlog4tango_1_1threading_1_1Mutex.html#ad75cb2944b40e951cb131c66a573ef3c">~Mutex</a>() {
<a name="l00060"></a>00060     ::pthread_mutex_destroy(&amp;mutex);
<a name="l00061"></a>00061   }
<a name="l00062"></a>00062   
<a name="l00063"></a><a class="code" href="classlog4tango_1_1threading_1_1Mutex.html#a121bae8bb2ca8d412983fbb303441ed0">00063</a>   <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="classlog4tango_1_1threading_1_1Mutex.html#a121bae8bb2ca8d412983fbb303441ed0">lock</a>() {
<a name="l00064"></a>00064     ::pthread_mutex_lock(&amp;mutex);
<a name="l00065"></a>00065   }
<a name="l00066"></a>00066 
<a name="l00067"></a><a class="code" href="classlog4tango_1_1threading_1_1Mutex.html#a0689618bc67462cc3646e86de6b5f261">00067</a>   <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="classlog4tango_1_1threading_1_1Mutex.html#a0689618bc67462cc3646e86de6b5f261">unlock</a>() {
<a name="l00068"></a>00068     ::pthread_mutex_unlock(&amp;mutex);
<a name="l00069"></a>00069   }
<a name="l00070"></a>00070 };
<a name="l00071"></a>00071 
<a name="l00072"></a>00072 <span class="comment">//-----------------------------------------------------------------------------</span>
<a name="l00073"></a>00073 <span class="comment">// Class : ScopedLock</span>
<a name="l00074"></a>00074 <span class="comment">//-----------------------------------------------------------------------------</span>
<a name="l00075"></a>00075 <span class="keyword">class </span><a class="code" href="namespacelog4tango_1_1threading.html#ae0fb75dd01061ba7df4e4a68120507f1">ScopedLock</a>
<a name="l00076"></a>00076 {
<a name="l00077"></a>00077 <span class="keyword">private</span>:
<a name="l00078"></a>00078   <a class="code" href="namespacelog4tango_1_1threading.html#a6ab044c515d422f490f47a2499bf1f0a">Mutex</a>&amp; _mutex;
<a name="l00079"></a>00079 
<a name="l00080"></a>00080 <span class="keyword">public</span>:
<a name="l00081"></a><a class="code" href="classlog4tango_1_1threading_1_1ScopedLock.html#a3c6e5abbb0fada2b3ea6432bd19862dd">00081</a>   <span class="keyword">inline</span> <a class="code" href="classlog4tango_1_1threading_1_1ScopedLock.html#a3c6e5abbb0fada2b3ea6432bd19862dd">ScopedLock</a>(<a class="code" href="classlog4tango_1_1threading_1_1Mutex.html">Mutex</a> &amp;m) : _mutex(m) {
<a name="l00082"></a>00082     _mutex.<a class="code" href="classlog4tango_1_1threading_1_1Mutex.html#a121bae8bb2ca8d412983fbb303441ed0">lock</a>();
<a name="l00083"></a>00083   }
<a name="l00084"></a>00084 
<a name="l00085"></a><a class="code" href="classlog4tango_1_1threading_1_1ScopedLock.html#ab03de73986f5bb51e7e40d5725e725bb">00085</a>   <span class="keyword">inline</span> <a class="code" href="classlog4tango_1_1threading_1_1ScopedLock.html#ab03de73986f5bb51e7e40d5725e725bb">~ScopedLock</a>() {
<a name="l00086"></a>00086     _mutex.<a class="code" href="classlog4tango_1_1threading_1_1Mutex.html#a0689618bc67462cc3646e86de6b5f261">unlock</a>();
<a name="l00087"></a>00087   }
<a name="l00088"></a>00088 };
<a name="l00089"></a>00089 
<a name="l00090"></a>00090 <span class="comment">//-----------------------------------------------------------------------------</span>
<a name="l00091"></a>00091 <span class="comment">// Class : RecursiveMutex</span>
<a name="l00092"></a>00092 <span class="comment">//-----------------------------------------------------------------------------</span>
<a name="l00093"></a>00093 <span class="keyword">class </span>RecursiveMutex
<a name="l00094"></a>00094 {
<a name="l00095"></a>00095 <span class="keyword">public</span>:
<a name="l00096"></a>00096   <span class="comment">// ctor</span>
<a name="l00097"></a>00097   <a class="code" href="classlog4tango_1_1threading_1_1RecursiveMutex.html#a7bb6f1bb4ca7072b24bda6321e196fc8">RecursiveMutex</a> (<span class="keywordtype">void</span>); 
<a name="l00098"></a>00098 
<a name="l00099"></a>00099   <span class="comment">// dtor</span>
<a name="l00100"></a>00100   <a class="code" href="classlog4tango_1_1threading_1_1RecursiveMutex.html#a7210fe141d367494415cf8b580910fdf">~RecursiveMutex</a> (<span class="keywordtype">void</span>);
<a name="l00101"></a>00101 
<a name="l00102"></a>00102   <span class="comment">// Locking an RecursiveMutex:</span>
<a name="l00103"></a>00103   <span class="comment">// If &lt;timeout_&gt; is null (the default), &lt;lock&gt; blocks until </span>
<a name="l00104"></a>00104   <span class="comment">// the mutex is acquired and returns 1 (true). Otherwise, </span>
<a name="l00105"></a>00105   <span class="comment">// &lt;lock&gt; blocks until the mutex is acquired or times out </span>
<a name="l00106"></a>00106   <span class="comment">// after &lt;timeout_&gt; milliseconds in which case 0 (false) is </span>
<a name="l00107"></a>00107   <span class="comment">// returned. </span>
<a name="l00108"></a>00108   <span class="keywordtype">int</span> <a class="code" href="classlog4tango_1_1threading_1_1RecursiveMutex.html#ab25b75795eeed61c179ba00d3b9cd4e0">lock</a> (<span class="keywordtype">long</span> timeout_ = 0);
<a name="l00109"></a>00109   
<a name="l00110"></a>00110   <span class="comment">// Releasing an RecursiveMutex:</span>
<a name="l00111"></a>00111   <span class="comment">// Call unlock &lt;recursion level&gt; times (i.e. one call for </span>
<a name="l00112"></a>00112   <span class="comment">// each previous call to lock) or call unlockn just once. </span>
<a name="l00113"></a>00113   <span class="comment">// These two methods do nothing if the caller is not the</span>
<a name="l00114"></a>00114   <span class="comment">// current owner of the mutex.</span>
<a name="l00115"></a>00115   <span class="keywordtype">void</span> <a class="code" href="classlog4tango_1_1threading_1_1RecursiveMutex.html#a35bcfd9220d32eb5d8974acde72e9820">unlock</a> (<span class="keywordtype">void</span>); 
<a name="l00116"></a>00116   <span class="keywordtype">void</span> <a class="code" href="classlog4tango_1_1threading_1_1RecursiveMutex.html#ae8ca497191c6f8ac476f50fe5172f777">unlockn</a> (<span class="keywordtype">void</span>); 
<a name="l00117"></a>00117 
<a name="l00118"></a>00118 <span class="keyword">protected</span>:
<a name="l00119"></a>00119   <span class="comment">// guards the &lt;recursion level&gt; and &lt;owner id&gt;</span>
<a name="l00120"></a><a class="code" href="classlog4tango_1_1threading_1_1RecursiveMutex.html#a84a463cd8c14c629e9449a1ab16aecfb">00120</a>   pthread_mutex_t <a class="code" href="classlog4tango_1_1threading_1_1RecursiveMutex.html#a84a463cd8c14c629e9449a1ab16aecfb">guard_</a>;
<a name="l00121"></a>00121 
<a name="l00122"></a>00122   <span class="comment">// this condition variable suspends other waiting threads </span>
<a name="l00123"></a>00123   <span class="comment">// until the mutex is available</span>
<a name="l00124"></a><a class="code" href="classlog4tango_1_1threading_1_1RecursiveMutex.html#abafc328ab69204599821730c657c3cba">00124</a>   pthread_cond_t <a class="code" href="classlog4tango_1_1threading_1_1RecursiveMutex.html#abafc328ab69204599821730c657c3cba">mutex_available_</a>;
<a name="l00125"></a>00125   
<a name="l00126"></a>00126 <span class="keyword">private</span>:
<a name="l00127"></a>00127   <span class="comment">// current level of the recursion</span>
<a name="l00128"></a>00128   <span class="keywordtype">long</span> recursion_level_;
<a name="l00129"></a>00129 
<a name="l00130"></a>00130   <span class="comment">// current owner of the lock.</span>
<a name="l00131"></a>00131   pthread_t owner_id_;
<a name="l00132"></a>00132   
<a name="l00133"></a>00133   <span class="comment">// dummy copy constructor and operator= to prevent copying</span>
<a name="l00134"></a>00134   <a class="code" href="classlog4tango_1_1threading_1_1RecursiveMutex.html#a7bb6f1bb4ca7072b24bda6321e196fc8">RecursiveMutex</a> (<span class="keyword">const</span> <a class="code" href="classlog4tango_1_1threading_1_1RecursiveMutex.html">RecursiveMutex</a>&amp;);
<a name="l00135"></a>00135   <a class="code" href="classlog4tango_1_1threading_1_1RecursiveMutex.html">RecursiveMutex</a>&amp; operator= (<span class="keyword">const</span> <a class="code" href="classlog4tango_1_1threading_1_1RecursiveMutex.html">RecursiveMutex</a>&amp;);
<a name="l00136"></a>00136 };
<a name="l00137"></a>00137 
<a name="l00138"></a>00138 <span class="comment">//-----------------------------------------------------------------------------</span>
<a name="l00139"></a>00139 <span class="comment">// Class : ThreadLocalDataHolder</span>
<a name="l00140"></a>00140 <span class="comment">//-----------------------------------------------------------------------------</span>
<a name="l00141"></a>00141 <span class="preprocessor">#ifdef LOG4TANGO_HAS_NDC</span>
<a name="l00142"></a>00142 <span class="preprocessor"></span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> T&gt; <span class="keyword">class </span>ThreadLocalDataHolder {
<a name="l00143"></a>00143 
<a name="l00144"></a>00144 <span class="keyword">private</span>:
<a name="l00145"></a>00145   pthread_key_t _key;
<a name="l00146"></a>00146 
<a name="l00147"></a>00147 <span class="keyword">public</span>:
<a name="l00148"></a>00148   <span class="keyword">typedef</span> T data_type;
<a name="l00149"></a>00149 
<a name="l00150"></a>00150   <span class="keyword">inline</span> ThreadLocalDataHolder() {
<a name="l00151"></a>00151     ::pthread_key_create(&amp;_key, freeHolder);
<a name="l00152"></a>00152   }
<a name="l00153"></a>00153 
<a name="l00154"></a>00154   <span class="keyword">inline</span> <span class="keyword">static</span> <span class="keywordtype">void</span> freeHolder(<span class="keywordtype">void</span> *p) {
<a name="l00155"></a>00155     assert(p != NULL);
<a name="l00156"></a>00156     <span class="keyword">delete</span> <span class="keyword">reinterpret_cast&lt;</span>T *<span class="keyword">&gt;</span>(p);
<a name="l00157"></a>00157   }
<a name="l00158"></a>00158 
<a name="l00159"></a>00159   <span class="keyword">inline</span> ~ThreadLocalDataHolder() {
<a name="l00160"></a>00160     T *data = <span class="keyword">get</span>();
<a name="l00161"></a>00161     <span class="keywordflow">if</span> (data != NULL) {
<a name="l00162"></a>00162       <span class="keyword">delete</span> data;
<a name="l00163"></a>00163     }
<a name="l00164"></a>00164     ::pthread_key_delete(_key);
<a name="l00165"></a>00165   }
<a name="l00166"></a>00166 
<a name="l00167"></a>00167   <span class="keyword">inline</span> T* <span class="keyword">get</span>() <span class="keyword">const</span> {
<a name="l00168"></a>00168     <span class="keywordflow">return</span> <span class="keyword">reinterpret_cast&lt;</span>T *<span class="keyword">&gt;</span>(::pthread_getspecific(_key));
<a name="l00169"></a>00169   }
<a name="l00170"></a>00170 
<a name="l00171"></a>00171   <span class="keyword">inline</span> T* operator-&gt;()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <span class="keyword">get</span>(); }
<a name="l00172"></a>00172   <span class="keyword">inline</span> T&amp; operator*()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> *<span class="keyword">get</span>(); }
<a name="l00173"></a>00173 
<a name="l00174"></a>00174   <span class="keyword">inline</span> T* release() {
<a name="l00175"></a>00175    T* result = <span class="keyword">get</span>();
<a name="l00176"></a>00176    ::pthread_setspecific(_key, NULL);
<a name="l00177"></a>00177    <span class="keywordflow">return</span> result;
<a name="l00178"></a>00178   }
<a name="l00179"></a>00179 
<a name="l00180"></a>00180   <span class="keyword">inline</span> <span class="keywordtype">void</span> reset(T* p = NULL) {
<a name="l00181"></a>00181     T *data = <span class="keyword">get</span>();
<a name="l00182"></a>00182     <span class="keywordflow">if</span> (data != NULL) {
<a name="l00183"></a>00183       <span class="keyword">delete</span> data;
<a name="l00184"></a>00184     }
<a name="l00185"></a>00185     ::pthread_setspecific(_key, p);
<a name="l00186"></a>00186   }
<a name="l00187"></a>00187 };
<a name="l00188"></a>00188 <span class="preprocessor">#endif //LOG4TANGO_HAS_NDC</span>
<a name="l00189"></a>00189 <span class="preprocessor"></span>
<a name="l00190"></a>00190 } <span class="comment">// namespace threading</span>
<a name="l00191"></a>00191 
<a name="l00192"></a>00192 } <span class="comment">// namespace log4tango</span>
<a name="l00193"></a>00193 
<a name="l00194"></a>00194 <span class="preprocessor">#endif  // _LOG4TANGO_THREADING_PTHREADS_H</span>
</pre></div></div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Sat Dec 3 2011 12:45:21 for log4tango by&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>