Update doxygen for release 2.3.1
[openjpeg.git] / doxygen / structopj__thread__pool__t.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head>
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
6 <meta name="generator" content="Doxygen 1.8.13"/>
7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
8 <title>OpenJPEG: opj_thread_pool_t Struct Reference</title>
9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
10 <script type="text/javascript" src="jquery.js"></script>
11 <script type="text/javascript" src="dynsections.js"></script>
12 <link href="doxygen.css" rel="stylesheet" type="text/css" />
13 </head>
14 <body>
15 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
16 <div id="titlearea">
17 <table cellspacing="0" cellpadding="0">
18  <tbody>
19  <tr style="height: 56px;">
20   <td id="projectalign" style="padding-left: 0.5em;">
21    <div id="projectname">OpenJPEG
22    &#160;<span id="projectnumber">2.3.1</span>
23    </div>
24   </td>
25  </tr>
26  </tbody>
27 </table>
28 </div>
29 <!-- end header part -->
30 <!-- Generated by Doxygen 1.8.13 -->
31 <script type="text/javascript" src="menudata.js"></script>
32 <script type="text/javascript" src="menu.js"></script>
33 <script type="text/javascript">
34 $(function() {
35   initMenu('',false,false,'search.php','Search');
36 });
37 </script>
38 <div id="main-nav"></div>
39 </div><!-- top -->
40 <div class="header">
41   <div class="summary">
42 <a href="#pub-attribs">Data Fields</a>  </div>
43   <div class="headertitle">
44 <div class="title">opj_thread_pool_t Struct Reference</div>  </div>
45 </div><!--header-->
46 <div class="contents">
47 <table class="memberdecls">
48 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
49 Data Fields</h2></td></tr>
50 <tr class="memitem:adb012d263904a4f62812ed7d30b0a47e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structopj__worker__thread__t.html">opj_worker_thread_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__thread__pool__t.html#adb012d263904a4f62812ed7d30b0a47e">worker_threads</a></td></tr>
51 <tr class="separator:adb012d263904a4f62812ed7d30b0a47e"><td class="memSeparator" colspan="2">&#160;</td></tr>
52 <tr class="memitem:a43fd14e3ba8409a0fac589a6dd4e7ee1"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__thread__pool__t.html#a43fd14e3ba8409a0fac589a6dd4e7ee1">worker_threads_count</a></td></tr>
53 <tr class="separator:a43fd14e3ba8409a0fac589a6dd4e7ee1"><td class="memSeparator" colspan="2">&#160;</td></tr>
54 <tr class="memitem:a19d0f595937228552fe62c69cb2f6c44"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___t_h_r_e_a_d.html#ga439cd27c17f11fc56a911a126811fb87">opj_cond_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__thread__pool__t.html#a19d0f595937228552fe62c69cb2f6c44">cond</a></td></tr>
55 <tr class="separator:a19d0f595937228552fe62c69cb2f6c44"><td class="memSeparator" colspan="2">&#160;</td></tr>
56 <tr class="memitem:a818a719866334770dda95c675cb73d63"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___t_h_r_e_a_d.html#ga29120af1ce48d5ecd651795f2e427755">opj_mutex_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__thread__pool__t.html#a818a719866334770dda95c675cb73d63">mutex</a></td></tr>
57 <tr class="separator:a818a719866334770dda95c675cb73d63"><td class="memSeparator" colspan="2">&#160;</td></tr>
58 <tr class="memitem:a3ee9c2691cf72fb90bf662490830b72b"><td class="memItemLeft" align="right" valign="top">volatile <a class="el" href="thread_8c.html#a72b07be38efb141bb1f0456227d233e5">opj_worker_thread_state</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__thread__pool__t.html#a3ee9c2691cf72fb90bf662490830b72b">state</a></td></tr>
59 <tr class="separator:a3ee9c2691cf72fb90bf662490830b72b"><td class="memSeparator" colspan="2">&#160;</td></tr>
60 <tr class="memitem:aff15e4a4599fc823762f8d3c28d8353d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structopj__job__list__t.html">opj_job_list_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__thread__pool__t.html#aff15e4a4599fc823762f8d3c28d8353d">job_queue</a></td></tr>
61 <tr class="separator:aff15e4a4599fc823762f8d3c28d8353d"><td class="memSeparator" colspan="2">&#160;</td></tr>
62 <tr class="memitem:ad84a2e09419498cf81c8994f0441b131"><td class="memItemLeft" align="right" valign="top">volatile int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__thread__pool__t.html#ad84a2e09419498cf81c8994f0441b131">pending_jobs_count</a></td></tr>
63 <tr class="separator:ad84a2e09419498cf81c8994f0441b131"><td class="memSeparator" colspan="2">&#160;</td></tr>
64 <tr class="memitem:a50c4caa87ba2a6767d909898cc92b37a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structopj__worker__thread__list__t.html">opj_worker_thread_list_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__thread__pool__t.html#a50c4caa87ba2a6767d909898cc92b37a">waiting_worker_thread_list</a></td></tr>
65 <tr class="separator:a50c4caa87ba2a6767d909898cc92b37a"><td class="memSeparator" colspan="2">&#160;</td></tr>
66 <tr class="memitem:abad6b35fb3cc6cd8aaaf523de9a4a187"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__thread__pool__t.html#abad6b35fb3cc6cd8aaaf523de9a4a187">waiting_worker_thread_count</a></td></tr>
67 <tr class="separator:abad6b35fb3cc6cd8aaaf523de9a4a187"><td class="memSeparator" colspan="2">&#160;</td></tr>
68 <tr class="memitem:a401a98b276c965e0b63efaf9e1369730"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structopj__tls__t.html">opj_tls_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__thread__pool__t.html#a401a98b276c965e0b63efaf9e1369730">tls</a></td></tr>
69 <tr class="separator:a401a98b276c965e0b63efaf9e1369730"><td class="memSeparator" colspan="2">&#160;</td></tr>
70 <tr class="memitem:ae68571d1cf6eae577c75df49c2827438"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__thread__pool__t.html#ae68571d1cf6eae577c75df49c2827438">signaling_threshold</a></td></tr>
71 <tr class="separator:ae68571d1cf6eae577c75df49c2827438"><td class="memSeparator" colspan="2">&#160;</td></tr>
72 </table>
73 <h2 class="groupheader">Field Documentation</h2>
74 <a id="a19d0f595937228552fe62c69cb2f6c44"></a>
75 <h2 class="memtitle"><span class="permalink"><a href="#a19d0f595937228552fe62c69cb2f6c44">&#9670;&nbsp;</a></span>cond</h2>
76
77 <div class="memitem">
78 <div class="memproto">
79       <table class="memname">
80         <tr>
81           <td class="memname"><a class="el" href="group___t_h_r_e_a_d.html#ga439cd27c17f11fc56a911a126811fb87">opj_cond_t</a>* opj_thread_pool_t::cond</td>
82         </tr>
83       </table>
84 </div><div class="memdoc">
85
86 <p class="reference">Referenced by <a class="el" href="group___t_h_r_e_a_d.html#gae44e8b9258d0baa19e3671a382faa33e">opj_thread_pool_destroy()</a>, <a class="el" href="thread_8c.html#a57e6dc05f2283639a2ec0b6884d9691c">opj_thread_pool_get_next_job()</a>, <a class="el" href="thread_8c.html#acdca1ecb372546840fdd9d5d5badce07">opj_thread_pool_setup()</a>, <a class="el" href="group___t_h_r_e_a_d.html#gaf389ecb3a583a30077fc546eef767c89">opj_thread_pool_submit_job()</a>, and <a class="el" href="group___t_h_r_e_a_d.html#ga0ced26c80598e49bf3a964bb802130f1">opj_thread_pool_wait_completion()</a>.</p>
87
88 </div>
89 </div>
90 <a id="aff15e4a4599fc823762f8d3c28d8353d"></a>
91 <h2 class="memtitle"><span class="permalink"><a href="#aff15e4a4599fc823762f8d3c28d8353d">&#9670;&nbsp;</a></span>job_queue</h2>
92
93 <div class="memitem">
94 <div class="memproto">
95       <table class="memname">
96         <tr>
97           <td class="memname"><a class="el" href="structopj__job__list__t.html">opj_job_list_t</a>* opj_thread_pool_t::job_queue</td>
98         </tr>
99       </table>
100 </div><div class="memdoc">
101
102 <p class="reference">Referenced by <a class="el" href="thread_8c.html#a57e6dc05f2283639a2ec0b6884d9691c">opj_thread_pool_get_next_job()</a>, and <a class="el" href="group___t_h_r_e_a_d.html#gaf389ecb3a583a30077fc546eef767c89">opj_thread_pool_submit_job()</a>.</p>
103
104 </div>
105 </div>
106 <a id="a818a719866334770dda95c675cb73d63"></a>
107 <h2 class="memtitle"><span class="permalink"><a href="#a818a719866334770dda95c675cb73d63">&#9670;&nbsp;</a></span>mutex</h2>
108
109 <div class="memitem">
110 <div class="memproto">
111       <table class="memname">
112         <tr>
113           <td class="memname"><a class="el" href="group___t_h_r_e_a_d.html#ga29120af1ce48d5ecd651795f2e427755">opj_mutex_t</a>* opj_thread_pool_t::mutex</td>
114         </tr>
115       </table>
116 </div><div class="memdoc">
117
118 <p class="reference">Referenced by <a class="el" href="group___t_h_r_e_a_d.html#ga24a3a1b343df1168a3beb57babfa0916">opj_thread_pool_create()</a>, <a class="el" href="group___t_h_r_e_a_d.html#gae44e8b9258d0baa19e3671a382faa33e">opj_thread_pool_destroy()</a>, <a class="el" href="thread_8c.html#a57e6dc05f2283639a2ec0b6884d9691c">opj_thread_pool_get_next_job()</a>, <a class="el" href="thread_8c.html#acdca1ecb372546840fdd9d5d5badce07">opj_thread_pool_setup()</a>, <a class="el" href="group___t_h_r_e_a_d.html#gaf389ecb3a583a30077fc546eef767c89">opj_thread_pool_submit_job()</a>, and <a class="el" href="group___t_h_r_e_a_d.html#ga0ced26c80598e49bf3a964bb802130f1">opj_thread_pool_wait_completion()</a>.</p>
119
120 </div>
121 </div>
122 <a id="ad84a2e09419498cf81c8994f0441b131"></a>
123 <h2 class="memtitle"><span class="permalink"><a href="#ad84a2e09419498cf81c8994f0441b131">&#9670;&nbsp;</a></span>pending_jobs_count</h2>
124
125 <div class="memitem">
126 <div class="memproto">
127       <table class="memname">
128         <tr>
129           <td class="memname">volatile int opj_thread_pool_t::pending_jobs_count</td>
130         </tr>
131       </table>
132 </div><div class="memdoc">
133
134 <p class="reference">Referenced by <a class="el" href="thread_8c.html#a57e6dc05f2283639a2ec0b6884d9691c">opj_thread_pool_get_next_job()</a>, <a class="el" href="group___t_h_r_e_a_d.html#gaf389ecb3a583a30077fc546eef767c89">opj_thread_pool_submit_job()</a>, and <a class="el" href="group___t_h_r_e_a_d.html#ga0ced26c80598e49bf3a964bb802130f1">opj_thread_pool_wait_completion()</a>.</p>
135
136 </div>
137 </div>
138 <a id="ae68571d1cf6eae577c75df49c2827438"></a>
139 <h2 class="memtitle"><span class="permalink"><a href="#ae68571d1cf6eae577c75df49c2827438">&#9670;&nbsp;</a></span>signaling_threshold</h2>
140
141 <div class="memitem">
142 <div class="memproto">
143       <table class="memname">
144         <tr>
145           <td class="memname">int opj_thread_pool_t::signaling_threshold</td>
146         </tr>
147       </table>
148 </div><div class="memdoc">
149
150 <p class="reference">Referenced by <a class="el" href="thread_8c.html#a57e6dc05f2283639a2ec0b6884d9691c">opj_thread_pool_get_next_job()</a>, <a class="el" href="group___t_h_r_e_a_d.html#gaf389ecb3a583a30077fc546eef767c89">opj_thread_pool_submit_job()</a>, and <a class="el" href="group___t_h_r_e_a_d.html#ga0ced26c80598e49bf3a964bb802130f1">opj_thread_pool_wait_completion()</a>.</p>
151
152 </div>
153 </div>
154 <a id="a3ee9c2691cf72fb90bf662490830b72b"></a>
155 <h2 class="memtitle"><span class="permalink"><a href="#a3ee9c2691cf72fb90bf662490830b72b">&#9670;&nbsp;</a></span>state</h2>
156
157 <div class="memitem">
158 <div class="memproto">
159       <table class="memname">
160         <tr>
161           <td class="memname">volatile <a class="el" href="thread_8c.html#a72b07be38efb141bb1f0456227d233e5">opj_worker_thread_state</a> opj_thread_pool_t::state</td>
162         </tr>
163       </table>
164 </div><div class="memdoc">
165
166 <p class="reference">Referenced by <a class="el" href="group___t_h_r_e_a_d.html#ga24a3a1b343df1168a3beb57babfa0916">opj_thread_pool_create()</a>, <a class="el" href="group___t_h_r_e_a_d.html#gae44e8b9258d0baa19e3671a382faa33e">opj_thread_pool_destroy()</a>, <a class="el" href="thread_8c.html#a57e6dc05f2283639a2ec0b6884d9691c">opj_thread_pool_get_next_job()</a>, and <a class="el" href="thread_8c.html#acdca1ecb372546840fdd9d5d5badce07">opj_thread_pool_setup()</a>.</p>
167
168 </div>
169 </div>
170 <a id="a401a98b276c965e0b63efaf9e1369730"></a>
171 <h2 class="memtitle"><span class="permalink"><a href="#a401a98b276c965e0b63efaf9e1369730">&#9670;&nbsp;</a></span>tls</h2>
172
173 <div class="memitem">
174 <div class="memproto">
175       <table class="memname">
176         <tr>
177           <td class="memname"><a class="el" href="structopj__tls__t.html">opj_tls_t</a>* opj_thread_pool_t::tls</td>
178         </tr>
179       </table>
180 </div><div class="memdoc">
181
182 <p class="reference">Referenced by <a class="el" href="group___t_h_r_e_a_d.html#ga24a3a1b343df1168a3beb57babfa0916">opj_thread_pool_create()</a>, <a class="el" href="group___t_h_r_e_a_d.html#gae44e8b9258d0baa19e3671a382faa33e">opj_thread_pool_destroy()</a>, and <a class="el" href="group___t_h_r_e_a_d.html#gaf389ecb3a583a30077fc546eef767c89">opj_thread_pool_submit_job()</a>.</p>
183
184 </div>
185 </div>
186 <a id="abad6b35fb3cc6cd8aaaf523de9a4a187"></a>
187 <h2 class="memtitle"><span class="permalink"><a href="#abad6b35fb3cc6cd8aaaf523de9a4a187">&#9670;&nbsp;</a></span>waiting_worker_thread_count</h2>
188
189 <div class="memitem">
190 <div class="memproto">
191       <table class="memname">
192         <tr>
193           <td class="memname">int opj_thread_pool_t::waiting_worker_thread_count</td>
194         </tr>
195       </table>
196 </div><div class="memdoc">
197
198 <p class="reference">Referenced by <a class="el" href="thread_8c.html#a57e6dc05f2283639a2ec0b6884d9691c">opj_thread_pool_get_next_job()</a>, <a class="el" href="thread_8c.html#acdca1ecb372546840fdd9d5d5badce07">opj_thread_pool_setup()</a>, and <a class="el" href="group___t_h_r_e_a_d.html#gaf389ecb3a583a30077fc546eef767c89">opj_thread_pool_submit_job()</a>.</p>
199
200 </div>
201 </div>
202 <a id="a50c4caa87ba2a6767d909898cc92b37a"></a>
203 <h2 class="memtitle"><span class="permalink"><a href="#a50c4caa87ba2a6767d909898cc92b37a">&#9670;&nbsp;</a></span>waiting_worker_thread_list</h2>
204
205 <div class="memitem">
206 <div class="memproto">
207       <table class="memname">
208         <tr>
209           <td class="memname"><a class="el" href="structopj__worker__thread__list__t.html">opj_worker_thread_list_t</a>* opj_thread_pool_t::waiting_worker_thread_list</td>
210         </tr>
211       </table>
212 </div><div class="memdoc">
213
214 <p class="reference">Referenced by <a class="el" href="group___t_h_r_e_a_d.html#gae44e8b9258d0baa19e3671a382faa33e">opj_thread_pool_destroy()</a>, <a class="el" href="thread_8c.html#a57e6dc05f2283639a2ec0b6884d9691c">opj_thread_pool_get_next_job()</a>, and <a class="el" href="group___t_h_r_e_a_d.html#gaf389ecb3a583a30077fc546eef767c89">opj_thread_pool_submit_job()</a>.</p>
215
216 </div>
217 </div>
218 <a id="adb012d263904a4f62812ed7d30b0a47e"></a>
219 <h2 class="memtitle"><span class="permalink"><a href="#adb012d263904a4f62812ed7d30b0a47e">&#9670;&nbsp;</a></span>worker_threads</h2>
220
221 <div class="memitem">
222 <div class="memproto">
223       <table class="memname">
224         <tr>
225           <td class="memname"><a class="el" href="structopj__worker__thread__t.html">opj_worker_thread_t</a>* opj_thread_pool_t::worker_threads</td>
226         </tr>
227       </table>
228 </div><div class="memdoc">
229
230 <p class="reference">Referenced by <a class="el" href="group___t_h_r_e_a_d.html#gae44e8b9258d0baa19e3671a382faa33e">opj_thread_pool_destroy()</a>, and <a class="el" href="thread_8c.html#acdca1ecb372546840fdd9d5d5badce07">opj_thread_pool_setup()</a>.</p>
231
232 </div>
233 </div>
234 <a id="a43fd14e3ba8409a0fac589a6dd4e7ee1"></a>
235 <h2 class="memtitle"><span class="permalink"><a href="#a43fd14e3ba8409a0fac589a6dd4e7ee1">&#9670;&nbsp;</a></span>worker_threads_count</h2>
236
237 <div class="memitem">
238 <div class="memproto">
239       <table class="memname">
240         <tr>
241           <td class="memname">int opj_thread_pool_t::worker_threads_count</td>
242         </tr>
243       </table>
244 </div><div class="memdoc">
245
246 <p class="reference">Referenced by <a class="el" href="group___t_h_r_e_a_d.html#gae44e8b9258d0baa19e3671a382faa33e">opj_thread_pool_destroy()</a>, <a class="el" href="thread_8c.html#a57e6dc05f2283639a2ec0b6884d9691c">opj_thread_pool_get_next_job()</a>, <a class="el" href="group___t_h_r_e_a_d.html#ga4faef98a6b8495c63e9e5ce9cf0c3fc3">opj_thread_pool_get_thread_count()</a>, <a class="el" href="thread_8c.html#acdca1ecb372546840fdd9d5d5badce07">opj_thread_pool_setup()</a>, and <a class="el" href="group___t_h_r_e_a_d.html#gaf389ecb3a583a30077fc546eef767c89">opj_thread_pool_submit_job()</a>.</p>
247
248 </div>
249 </div>
250 <hr/>The documentation for this struct was generated from the following file:<ul>
251 <li><a class="el" href="thread_8c.html">thread.c</a></li>
252 </ul>
253 </div><!-- contents -->
254 <!-- start footer part -->
255 <hr class="footer"/><address class="footer"><small>
256 Generated by &#160;<a href="http://www.doxygen.org/index.html">
257 <img class="footer" src="doxygen.png" alt="doxygen"/>
258 </a> 1.8.13
259 </small></address>
260 </body>
261 </html>