openjpeg/doxygen/thread_8h_source.html

92 lines
31 KiB
HTML
Raw Normal View History

2017-08-10 06:39:58 +02:00
<!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"/>
2020-12-28 22:12:25 +01:00
<meta name="generator" content="Doxygen 1.8.11"/>
2017-08-10 06:39:58 +02:00
<title>OpenJPEG: thread.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 id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">OpenJPEG
2020-12-28 22:12:25 +01:00
&#160;<span id="projectnumber">2.4.0</span>
2017-08-10 06:39:58 +02:00
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
2020-12-28 22:12:25 +01:00
<!-- Generated by Doxygen 1.8.11 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data&#160;Structures</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>Globals</span></a></li>
</ul>
</div>
2017-08-10 06:39:58 +02:00
<div id="nav-path" class="navpath">
<ul>
2020-12-28 22:12:25 +01:00
<li class="navelem"><a class="el" href="dir_43e0a1f539e00dcfa1a6bc4d4fee4fc2.html">home</a></li><li class="navelem"><a class="el" href="dir_cb9b2b419d92b64f7cee83d8faf7a4ab.html">even</a></li><li class="navelem"><a class="el" href="dir_f75d9a0165d6564a1e04793ef847d41d.html">openjpeg</a></li><li class="navelem"><a class="el" href="dir_5f588d7ea139c1aae751d03c13a16064.html">openjpeg</a></li><li class="navelem"><a class="el" href="dir_378f732e812ef6cbaaae22e96a4fa79f.html">src</a></li><li class="navelem"><a class="el" href="dir_19dcb5713315405a27e1bde75a489a4c.html">lib</a></li><li class="navelem"><a class="el" href="dir_54e5bc4f0640fea590afaf04f4d9c88d.html">openjp2</a></li> </ul>
2017-08-10 06:39:58 +02:00
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">thread.h</div> </div>
</div><!--header-->
<div class="contents">
2019-04-02 16:25:55 +02:00
<a href="thread_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>&#160;<span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * The copyright in this software is being made available under the 2-clauses</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> * BSD License, included below. This software may be subject to other third</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * party and contributor rights, including patent rights, and no such rights</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * are granted under this license.</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * Copyright (c) 2016, Even Rouault</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> * All rights reserved.</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> * Redistribution and use in source and binary forms, with or without</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * modification, are permitted provided that the following conditions</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> * are met:</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> * 1. Redistributions of source code must retain the above copyright</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> * notice, this list of conditions and the following disclaimer.</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> * 2. Redistributions in binary form must reproduce the above copyright</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> * notice, this list of conditions and the following disclaimer in the</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment"> * documentation and/or other materials provided with the distribution.</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="comment"> * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS&#39;</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="comment"> * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="comment"> * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="comment"> * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="comment"> * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="comment"> * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF</span></div><div class="l
<div class="ttc" id="group___t_h_r_e_a_d_html_gaf389ecb3a583a30077fc546eef767c89"><div class="ttname"><a href="group___t_h_r_e_a_d.html#gaf389ecb3a583a30077fc546eef767c89">opj_thread_pool_submit_job</a></div><div class="ttdeci">OPJ_BOOL opj_thread_pool_submit_job(opj_thread_pool_t *tp, opj_job_fn job_fn, void *user_data)</div><div class="ttdoc">Submit a new job to be run by one of the thread in the thread pool. </div><div class="ttdef"><b>Definition:</b> thread.c:827</div></div>
2017-08-10 06:39:58 +02:00
<div class="ttc" id="openjpeg_8h_html_abb5dad6294f4611f1925388e919b16f4"><div class="ttname"><a href="openjpeg_8h.html#abb5dad6294f4611f1925388e919b16f4">OPJ_BOOL</a></div><div class="ttdeci">int OPJ_BOOL</div><div class="ttdef"><b>Definition:</b> openjpeg.h:110</div></div>
2017-10-05 00:57:21 +02:00
<div class="ttc" id="group___t_h_r_e_a_d_html_ga24a3a1b343df1168a3beb57babfa0916"><div class="ttname"><a href="group___t_h_r_e_a_d.html#ga24a3a1b343df1168a3beb57babfa0916">opj_thread_pool_create</a></div><div class="ttdeci">opj_thread_pool_t * opj_thread_pool_create(int num_threads)</div><div class="ttdoc">Create a new thread pool. </div><div class="ttdef"><b>Definition:</b> thread.c:625</div></div>
<div class="ttc" id="group___t_h_r_e_a_d_html_ga7f8a4c1ce6d9ad2dde1d293fad317522"><div class="ttname"><a href="group___t_h_r_e_a_d.html#ga7f8a4c1ce6d9ad2dde1d293fad317522">opj_cond_create</a></div><div class="ttdeci">opj_cond_t * opj_cond_create(void)</div><div class="ttdoc">Creates a condition. </div><div class="ttdef"><b>Definition:</b> thread.c:463</div></div>
<div class="ttc" id="group___t_h_r_e_a_d_html_ga6edf64f08cd0b48299800852d52245d6"><div class="ttname"><a href="group___t_h_r_e_a_d.html#ga6edf64f08cd0b48299800852d52245d6">opj_cond_wait</a></div><div class="ttdeci">void opj_cond_wait(opj_cond_t *cond, opj_mutex_t *mutex)</div><div class="ttdoc">Wait for the condition to be signaled. </div><div class="ttdef"><b>Definition:</b> thread.c:468</div></div>
2017-08-10 06:39:58 +02:00
<div class="ttc" id="group___t_h_r_e_a_d_html_gae5f9aa8219645e0e836aaf0c453db624"><div class="ttname"><a href="group___t_h_r_e_a_d.html#gae5f9aa8219645e0e836aaf0c453db624">opj_thread_fn</a></div><div class="ttdeci">void(* opj_thread_fn)(void *user_data)</div><div class="ttdoc">User function to execute in a thread. </div><div class="ttdef"><b>Definition:</b> thread.h:146</div></div>
<div class="ttc" id="openjpeg_8h_html"><div class="ttname"><a href="openjpeg_8h.html">openjpeg.h</a></div></div>
2017-10-05 00:57:21 +02:00
<div class="ttc" id="structopj__tls__t_html"><div class="ttname"><a href="structopj__tls__t.html">opj_tls_t</a></div><div class="ttdef"><b>Definition:</b> thread.c:504</div></div>
2017-08-10 06:39:58 +02:00
<div class="ttc" id="group___t_h_r_e_a_d_html_ga38f8cdfd288c8ff8963444403549ad6c"><div class="ttname"><a href="group___t_h_r_e_a_d.html#ga38f8cdfd288c8ff8963444403549ad6c">opj_tls_free_func</a></div><div class="ttdeci">void(* opj_tls_free_func)(void *value)</div><div class="ttdoc">Type of the function used to free a TLS value. </div><div class="ttdef"><b>Definition:</b> thread.h:177</div></div>
2017-10-05 00:57:21 +02:00
<div class="ttc" id="group___t_h_r_e_a_d_html_gafba4c2356f6d070d43e5f0d5c71fdbee"><div class="ttname"><a href="group___t_h_r_e_a_d.html#gafba4c2356f6d070d43e5f0d5c71fdbee">opj_cond_destroy</a></div><div class="ttdeci">void opj_cond_destroy(opj_cond_t *cond)</div><div class="ttdoc">Destroy a condition. </div><div class="ttdef"><b>Definition:</b> thread.c:479</div></div>
2017-08-10 06:39:58 +02:00
<div class="ttc" id="group___t_h_r_e_a_d_html_ga439cd27c17f11fc56a911a126811fb87"><div class="ttname"><a href="group___t_h_r_e_a_d.html#ga439cd27c17f11fc56a911a126811fb87">opj_cond_t</a></div><div class="ttdeci">struct opj_cond_t opj_cond_t</div><div class="ttdoc">Opaque type for a condition. </div><div class="ttdef"><b>Definition:</b> thread.h:81</div></div>
2017-10-05 00:57:21 +02:00
<div class="ttc" id="group___t_h_r_e_a_d_html_gab1b97098aabc89f98eca8f8f7274f3e7"><div class="ttname"><a href="group___t_h_r_e_a_d.html#gab1b97098aabc89f98eca8f8f7274f3e7">opj_tls_set</a></div><div class="ttdeci">OPJ_BOOL opj_tls_set(opj_tls_t *tls, int key, void *value, opj_tls_free_func free_func)</div><div class="ttdoc">Set a thread local value corresponding to the provided key. </div><div class="ttdef"><b>Definition:</b> thread.c:540</div></div>
2019-04-02 16:25:55 +02:00
<div class="ttc" id="group___t_h_r_e_a_d_html_ga4faef98a6b8495c63e9e5ce9cf0c3fc3"><div class="ttname"><a href="group___t_h_r_e_a_d.html#ga4faef98a6b8495c63e9e5ce9cf0c3fc3">opj_thread_pool_get_thread_count</a></div><div class="ttdeci">int opj_thread_pool_get_thread_count(opj_thread_pool_t *tp)</div><div class="ttdoc">Return the number of threads associated with the thread pool. </div><div class="ttdef"><b>Definition:</b> thread.c:914</div></div>
2017-10-05 00:57:21 +02:00
<div class="ttc" id="group___t_h_r_e_a_d_html_ga541be683ba651c8244bde3f0d3650c92"><div class="ttname"><a href="group___t_h_r_e_a_d.html#ga541be683ba651c8244bde3f0d3650c92">opj_thread_create</a></div><div class="ttdeci">opj_thread_t * opj_thread_create(opj_thread_fn thread_fn, void *user_data)</div><div class="ttdoc">Creates a new thread. </div><div class="ttdef"><b>Definition:</b> thread.c:484</div></div>
<div class="ttc" id="group___t_h_r_e_a_d_html_ga66757c34c788b873ad9acfb60a5e008b"><div class="ttname"><a href="group___t_h_r_e_a_d.html#ga66757c34c788b873ad9acfb60a5e008b">opj_mutex_destroy</a></div><div class="ttdeci">void opj_mutex_destroy(opj_mutex_t *mutex)</div><div class="ttdoc">Destroy a mutex. </div><div class="ttdef"><b>Definition:</b> thread.c:458</div></div>
<div class="ttc" id="group___t_h_r_e_a_d_html_ga0f3687b35d6f3c395e1156a8499d1632"><div class="ttname"><a href="group___t_h_r_e_a_d.html#ga0f3687b35d6f3c395e1156a8499d1632">opj_cond_signal</a></div><div class="ttdeci">void opj_cond_signal(opj_cond_t *cond)</div><div class="ttdoc">Signal waiting threads on a condition. </div><div class="ttdef"><b>Definition:</b> thread.c:474</div></div>
2019-04-02 16:25:55 +02:00
<div class="ttc" id="group___t_h_r_e_a_d_html_ga0ced26c80598e49bf3a964bb802130f1"><div class="ttname"><a href="group___t_h_r_e_a_d.html#ga0ced26c80598e49bf3a964bb802130f1">opj_thread_pool_wait_completion</a></div><div class="ttdeci">void opj_thread_pool_wait_completion(opj_thread_pool_t *tp, int max_remaining_jobs)</div><div class="ttdoc">Wait that no more than max_remaining_jobs jobs are remaining in the queue of the thread pool...</div><div class="ttdef"><b>Definition:</b> thread.c:894</div></div>
2017-08-10 06:39:58 +02:00
<div class="ttc" id="group___t_h_r_e_a_d_html_ga29120af1ce48d5ecd651795f2e427755"><div class="ttname"><a href="group___t_h_r_e_a_d.html#ga29120af1ce48d5ecd651795f2e427755">opj_mutex_t</a></div><div class="ttdeci">struct opj_mutex_t opj_mutex_t</div><div class="ttdoc">Opaque type for a mutex. </div><div class="ttdef"><b>Definition:</b> thread.h:52</div></div>
<div class="ttc" id="group___t_h_r_e_a_d_html_gaed72b7b75acb6eaeb620085b01ee365b"><div class="ttname"><a href="group___t_h_r_e_a_d.html#gaed72b7b75acb6eaeb620085b01ee365b">opj_thread_t</a></div><div class="ttdeci">struct opj_thread_t opj_thread_t</div><div class="ttdoc">Opaque type for a thread handle. </div><div class="ttdef"><b>Definition:</b> thread.h:141</div></div>
2017-10-05 00:57:21 +02:00
<div class="ttc" id="group___t_h_r_e_a_d_html_gaa81ea27e801a8c0cf453b256ab38e067"><div class="ttname"><a href="group___t_h_r_e_a_d.html#gaa81ea27e801a8c0cf453b256ab38e067">opj_mutex_create</a></div><div class="ttdeci">opj_mutex_t * opj_mutex_create(void)</div><div class="ttdoc">Creates a mutex. </div><div class="ttdef"><b>Definition:</b> thread.c:443</div></div>
<div class="ttc" id="structopj__thread__pool__t_html"><div class="ttname"><a href="structopj__thread__pool__t.html">opj_thread_pool_t</a></div><div class="ttdef"><b>Definition:</b> thread.c:605</div></div>
<div class="ttc" id="group___t_h_r_e_a_d_html_gacf1f5a5f7f7257663505af02b717272c"><div class="ttname"><a href="group___t_h_r_e_a_d.html#gacf1f5a5f7f7257663505af02b717272c">opj_mutex_unlock</a></div><div class="ttdeci">void opj_mutex_unlock(opj_mutex_t *mutex)</div><div class="ttdoc">Unlock/release the mutex. </div><div class="ttdef"><b>Definition:</b> thread.c:453</div></div>
<div class="ttc" id="structopj__thread__pool__t_html_a401a98b276c965e0b63efaf9e1369730"><div class="ttname"><a href="structopj__thread__pool__t.html#a401a98b276c965e0b63efaf9e1369730">opj_thread_pool_t::tls</a></div><div class="ttdeci">opj_tls_t * tls</div><div class="ttdef"><b>Definition:</b> thread.c:615</div></div>
<div class="ttc" id="group___t_h_r_e_a_d_html_ga90caa0ff9c1e54033ef1e3010faf03a9"><div class="ttname"><a href="group___t_h_r_e_a_d.html#ga90caa0ff9c1e54033ef1e3010faf03a9">opj_tls_get</a></div><div class="ttdeci">void * opj_tls_get(opj_tls_t *tls, int key)</div><div class="ttdoc">Get a thread local value corresponding to the provided key. </div><div class="ttdef"><b>Definition:</b> thread.c:529</div></div>
<div class="ttc" id="group___t_h_r_e_a_d_html_gad49986b56da75f8609b7c940c17f713f"><div class="ttname"><a href="group___t_h_r_e_a_d.html#gad49986b56da75f8609b7c940c17f713f">opj_thread_join</a></div><div class="ttdeci">void opj_thread_join(opj_thread_t *thread)</div><div class="ttdoc">Wait for a thread to be finished and release associated resources to the thread handle. </div><div class="ttdef"><b>Definition:</b> thread.c:491</div></div>
<div class="ttc" id="group___t_h_r_e_a_d_html_gab38a90b92a1d294f7e1886e36a405518"><div class="ttname"><a href="group___t_h_r_e_a_d.html#gab38a90b92a1d294f7e1886e36a405518">opj_mutex_lock</a></div><div class="ttdeci">void opj_mutex_lock(opj_mutex_t *mutex)</div><div class="ttdoc">Lock/acquire the mutex. </div><div class="ttdef"><b>Definition:</b> thread.c:448</div></div>
2019-04-02 16:25:55 +02:00
<div class="ttc" id="group___t_h_r_e_a_d_html_gae44e8b9258d0baa19e3671a382faa33e"><div class="ttname"><a href="group___t_h_r_e_a_d.html#gae44e8b9258d0baa19e3671a382faa33e">opj_thread_pool_destroy</a></div><div class="ttdeci">void opj_thread_pool_destroy(opj_thread_pool_t *tp)</div><div class="ttdoc">Destroy a thread pool. </div><div class="ttdef"><b>Definition:</b> thread.c:919</div></div>
2017-08-10 06:39:58 +02:00
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
2020-12-28 22:12:25 +01:00
</a> 1.8.11
2017-08-10 06:39:58 +02:00
</small></address>
</body>
</html>