Update ABI/API compatibility reports after commit 4e5501b3c72a98b3117e68263afb922092c...
[openjpeg.git] / doxygen / structcache__param.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: cache_param 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">cache_param Struct Reference</div>  </div>
45 </div><!--header-->
46 <div class="contents">
47
48 <p>cache parameters  
49  <a href="structcache__param.html#details">More...</a></p>
50
51 <p><code>#include &lt;<a class="el" href="cache__manager_8h_source.html">cache_manager.h</a>&gt;</code></p>
52 <table class="memberdecls">
53 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
54 Data Fields</h2></td></tr>
55 <tr class="memitem:a4b1e92d200b2d6f991acfb031024181e"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcache__param.html#a4b1e92d200b2d6f991acfb031024181e">filename</a></td></tr>
56 <tr class="memdesc:a4b1e92d200b2d6f991acfb031024181e"><td class="mdescLeft">&#160;</td><td class="mdescRight">file name  <a href="#a4b1e92d200b2d6f991acfb031024181e">More...</a><br /></td></tr>
57 <tr class="separator:a4b1e92d200b2d6f991acfb031024181e"><td class="memSeparator" colspan="2">&#160;</td></tr>
58 <tr class="memitem:ab49c86ae00ed1c75ec917bec95377aeb"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcache__param.html#ab49c86ae00ed1c75ec917bec95377aeb">tid</a></td></tr>
59 <tr class="memdesc:ab49c86ae00ed1c75ec917bec95377aeb"><td class="mdescLeft">&#160;</td><td class="mdescRight">taregt identifier  <a href="#ab49c86ae00ed1c75ec917bec95377aeb">More...</a><br /></td></tr>
60 <tr class="separator:ab49c86ae00ed1c75ec917bec95377aeb"><td class="memSeparator" colspan="2">&#160;</td></tr>
61 <tr class="memitem:a8f5a0232ef788420480274e68932a8d3"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcache__param.html#a8f5a0232ef788420480274e68932a8d3">csn</a></td></tr>
62 <tr class="memdesc:a8f5a0232ef788420480274e68932a8d3"><td class="mdescLeft">&#160;</td><td class="mdescRight">codestream number  <a href="#a8f5a0232ef788420480274e68932a8d3">More...</a><br /></td></tr>
63 <tr class="separator:a8f5a0232ef788420480274e68932a8d3"><td class="memSeparator" colspan="2">&#160;</td></tr>
64 <tr class="memitem:a15739295a73f8bca1a53b4c11f3a855a"><td class="memItemLeft" align="right" valign="top">char **&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcache__param.html#a15739295a73f8bca1a53b4c11f3a855a">cid</a></td></tr>
65 <tr class="memdesc:a15739295a73f8bca1a53b4c11f3a855a"><td class="mdescLeft">&#160;</td><td class="mdescRight">dynamic array of channel identifiers  <a href="#a15739295a73f8bca1a53b4c11f3a855a">More...</a><br /></td></tr>
66 <tr class="separator:a15739295a73f8bca1a53b4c11f3a855a"><td class="memSeparator" colspan="2">&#160;</td></tr>
67 <tr class="memitem:acc75fa242d285962ff9451c0b875c18c"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcache__param.html#acc75fa242d285962ff9451c0b875c18c">numOfcid</a></td></tr>
68 <tr class="memdesc:acc75fa242d285962ff9451c0b875c18c"><td class="mdescLeft">&#160;</td><td class="mdescRight">number of cids  <a href="#acc75fa242d285962ff9451c0b875c18c">More...</a><br /></td></tr>
69 <tr class="separator:acc75fa242d285962ff9451c0b875c18c"><td class="memSeparator" colspan="2">&#160;</td></tr>
70 <tr class="memitem:a001b90163246b1af6f7b4e37e9ae53c2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="metadata__manager_8h.html#aaa78ced398f149ca92b47e0acddf05e5">metadatalist_param_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcache__param.html#a001b90163246b1af6f7b4e37e9ae53c2">metadatalist</a></td></tr>
71 <tr class="memdesc:a001b90163246b1af6f7b4e37e9ae53c2"><td class="mdescLeft">&#160;</td><td class="mdescRight">metadata-bin list  <a href="#a001b90163246b1af6f7b4e37e9ae53c2">More...</a><br /></td></tr>
72 <tr class="separator:a001b90163246b1af6f7b4e37e9ae53c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
73 <tr class="memitem:a89b857a7eea2ef020774bba91421b47f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="ihdrbox__manager_8h.html#ae88b004f80ae7e57d50cdbee20e25199">ihdrbox_param_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcache__param.html#a89b857a7eea2ef020774bba91421b47f">ihdrbox</a></td></tr>
74 <tr class="memdesc:a89b857a7eea2ef020774bba91421b47f"><td class="mdescLeft">&#160;</td><td class="mdescRight">ihdrbox  <a href="#a89b857a7eea2ef020774bba91421b47f">More...</a><br /></td></tr>
75 <tr class="separator:a89b857a7eea2ef020774bba91421b47f"><td class="memSeparator" colspan="2">&#160;</td></tr>
76 <tr class="memitem:aea41f0c4553d98f30fbd299e78a637e8"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structcache__param.html">cache_param</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcache__param.html#aea41f0c4553d98f30fbd299e78a637e8">next</a></td></tr>
77 <tr class="memdesc:aea41f0c4553d98f30fbd299e78a637e8"><td class="mdescLeft">&#160;</td><td class="mdescRight">pointer to the next cache  <a href="#aea41f0c4553d98f30fbd299e78a637e8">More...</a><br /></td></tr>
78 <tr class="separator:aea41f0c4553d98f30fbd299e78a637e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
79 </table>
80 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
81 <div class="textblock"><p>cache parameters </p>
82 </div><h2 class="groupheader">Field Documentation</h2>
83 <a id="a15739295a73f8bca1a53b4c11f3a855a"></a>
84 <h2 class="memtitle"><span class="permalink"><a href="#a15739295a73f8bca1a53b4c11f3a855a">&#9670;&nbsp;</a></span>cid</h2>
85
86 <div class="memitem">
87 <div class="memproto">
88       <table class="memname">
89         <tr>
90           <td class="memname">char** cache_param::cid</td>
91         </tr>
92       </table>
93 </div><div class="memdoc">
94
95 <p>dynamic array of channel identifiers </p>
96
97 <p class="reference">Referenced by <a class="el" href="cache__manager_8h.html#a87a27aa289a528077e7d77c5c89db5bf">add_cachecid()</a>, <a class="el" href="cache__manager_8h.html#ae673ba42122433300afa3581ed4eb5af">gene_cache()</a>, <a class="el" href="dec__clientmsg__handler_8h.html#aa47b5aa4364e9df31b03eca619009445">handle_CIDreqMSG()</a>, <a class="el" href="cache__manager_8h.html#aaf3ec7928cfc0cfa3888db892d50c20c">print_cache()</a>, <a class="el" href="cache__manager_8c.html#a9acafab6ba8be44d424c238272480aad">remove_cidInCache()</a>, and <a class="el" href="cache__manager_8h.html#ac538e4f629668779ce42d178389c5b7a">search_cacheBycid()</a>.</p>
98
99 </div>
100 </div>
101 <a id="a8f5a0232ef788420480274e68932a8d3"></a>
102 <h2 class="memtitle"><span class="permalink"><a href="#a8f5a0232ef788420480274e68932a8d3">&#9670;&nbsp;</a></span>csn</h2>
103
104 <div class="memitem">
105 <div class="memproto">
106       <table class="memname">
107         <tr>
108           <td class="memname">int cache_param::csn</td>
109         </tr>
110       </table>
111 </div><div class="memdoc">
112
113 <p>codestream number </p>
114
115 <p class="reference">Referenced by <a class="el" href="cache__manager_8h.html#ae673ba42122433300afa3581ed4eb5af">gene_cache()</a>, <a class="el" href="dec__clientmsg__handler_8h.html#a163197f925cd8d6f60da5b6151e01c3b">handle_JP2saveMSG()</a>, <a class="el" href="dec__clientmsg__handler_8h.html#ac1721ebe188622dcbd80540e1bc4a237">handle_PNMreqMSG()</a>, <a class="el" href="dec__clientmsg__handler_8h.html#a98cac1bbde27cbbd1d4292985b3f5b49">handle_SIZreqMSG()</a>, <a class="el" href="cache__manager_8h.html#aaf3ec7928cfc0cfa3888db892d50c20c">print_cache()</a>, and <a class="el" href="cache__manager_8h.html#a3971cee032d83329cb3f23a66f0f9dd9">search_cacheBycsn()</a>.</p>
116
117 </div>
118 </div>
119 <a id="a4b1e92d200b2d6f991acfb031024181e"></a>
120 <h2 class="memtitle"><span class="permalink"><a href="#a4b1e92d200b2d6f991acfb031024181e">&#9670;&nbsp;</a></span>filename</h2>
121
122 <div class="memitem">
123 <div class="memproto">
124       <table class="memname">
125         <tr>
126           <td class="memname">char* cache_param::filename</td>
127         </tr>
128       </table>
129 </div><div class="memdoc">
130
131 <p>file name </p>
132
133 <p class="reference">Referenced by <a class="el" href="cache__manager_8h.html#ae673ba42122433300afa3581ed4eb5af">gene_cache()</a>, <a class="el" href="cache__manager_8h.html#aaf3ec7928cfc0cfa3888db892d50c20c">print_cache()</a>, <a class="el" href="cache__manager_8h.html#a373dac3fd74b9947e59a095048b18a0a">search_cache()</a>, and <a class="el" href="cache__manager_8h.html#aeb3f8c42f00448cd7b3907d8bd516dd8">update_cachetid()</a>.</p>
134
135 </div>
136 </div>
137 <a id="a89b857a7eea2ef020774bba91421b47f"></a>
138 <h2 class="memtitle"><span class="permalink"><a href="#a89b857a7eea2ef020774bba91421b47f">&#9670;&nbsp;</a></span>ihdrbox</h2>
139
140 <div class="memitem">
141 <div class="memproto">
142       <table class="memname">
143         <tr>
144           <td class="memname"><a class="el" href="ihdrbox__manager_8h.html#ae88b004f80ae7e57d50cdbee20e25199">ihdrbox_param_t</a>* cache_param::ihdrbox</td>
145         </tr>
146       </table>
147 </div><div class="memdoc">
148
149 <p>ihdrbox </p>
150
151 <p class="reference">Referenced by <a class="el" href="cache__manager_8h.html#ae673ba42122433300afa3581ed4eb5af">gene_cache()</a>, and <a class="el" href="dec__clientmsg__handler_8h.html#a98cac1bbde27cbbd1d4292985b3f5b49">handle_SIZreqMSG()</a>.</p>
152
153 </div>
154 </div>
155 <a id="a001b90163246b1af6f7b4e37e9ae53c2"></a>
156 <h2 class="memtitle"><span class="permalink"><a href="#a001b90163246b1af6f7b4e37e9ae53c2">&#9670;&nbsp;</a></span>metadatalist</h2>
157
158 <div class="memitem">
159 <div class="memproto">
160       <table class="memname">
161         <tr>
162           <td class="memname"><a class="el" href="metadata__manager_8h.html#aaa78ced398f149ca92b47e0acddf05e5">metadatalist_param_t</a>* cache_param::metadatalist</td>
163         </tr>
164       </table>
165 </div><div class="memdoc">
166
167 <p>metadata-bin list </p>
168
169 <p class="reference">Referenced by <a class="el" href="cache__manager_8h.html#ae673ba42122433300afa3581ed4eb5af">gene_cache()</a>, <a class="el" href="dec__clientmsg__handler_8h.html#ab4022f5e297b5d3a456cd841c3902675">handle_JPIPstreamMSG()</a>, and <a class="el" href="dec__clientmsg__handler_8h.html#a22becf5f598618de947805f858b1a617">handle_XMLreqMSG()</a>.</p>
170
171 </div>
172 </div>
173 <a id="aea41f0c4553d98f30fbd299e78a637e8"></a>
174 <h2 class="memtitle"><span class="permalink"><a href="#aea41f0c4553d98f30fbd299e78a637e8">&#9670;&nbsp;</a></span>next</h2>
175
176 <div class="memitem">
177 <div class="memproto">
178       <table class="memname">
179         <tr>
180           <td class="memname">struct <a class="el" href="structcache__param.html">cache_param</a>* cache_param::next</td>
181         </tr>
182       </table>
183 </div><div class="memdoc">
184
185 <p>pointer to the next cache </p>
186
187 <p class="reference">Referenced by <a class="el" href="cache__manager_8h.html#a60b3dc9f408f026931faa4589d1e4c1b">delete_cachelist()</a>, <a class="el" href="cache__manager_8h.html#ae673ba42122433300afa3581ed4eb5af">gene_cache()</a>, <a class="el" href="cache__manager_8h.html#a602fae2adbfa511bccf6f2fad3fe7891">insert_cache_into_list()</a>, <a class="el" href="cache__manager_8h.html#a86ab032b568db30c8763213f221cc760">print_allcache()</a>, <a class="el" href="cache__manager_8h.html#a373dac3fd74b9947e59a095048b18a0a">search_cache()</a>, <a class="el" href="cache__manager_8h.html#ac538e4f629668779ce42d178389c5b7a">search_cacheBycid()</a>, <a class="el" href="cache__manager_8h.html#a3971cee032d83329cb3f23a66f0f9dd9">search_cacheBycsn()</a>, and <a class="el" href="cache__manager_8h.html#a3bd60aac832b765c765eb71211af2e05">search_cacheBytid()</a>.</p>
188
189 </div>
190 </div>
191 <a id="acc75fa242d285962ff9451c0b875c18c"></a>
192 <h2 class="memtitle"><span class="permalink"><a href="#acc75fa242d285962ff9451c0b875c18c">&#9670;&nbsp;</a></span>numOfcid</h2>
193
194 <div class="memitem">
195 <div class="memproto">
196       <table class="memname">
197         <tr>
198           <td class="memname">int cache_param::numOfcid</td>
199         </tr>
200       </table>
201 </div><div class="memdoc">
202
203 <p>number of cids </p>
204
205 <p class="reference">Referenced by <a class="el" href="cache__manager_8h.html#a87a27aa289a528077e7d77c5c89db5bf">add_cachecid()</a>, <a class="el" href="cache__manager_8h.html#ae673ba42122433300afa3581ed4eb5af">gene_cache()</a>, <a class="el" href="dec__clientmsg__handler_8h.html#aa47b5aa4364e9df31b03eca619009445">handle_CIDreqMSG()</a>, <a class="el" href="cache__manager_8h.html#aaf3ec7928cfc0cfa3888db892d50c20c">print_cache()</a>, <a class="el" href="cache__manager_8c.html#a9acafab6ba8be44d424c238272480aad">remove_cidInCache()</a>, and <a class="el" href="cache__manager_8h.html#ac538e4f629668779ce42d178389c5b7a">search_cacheBycid()</a>.</p>
206
207 </div>
208 </div>
209 <a id="ab49c86ae00ed1c75ec917bec95377aeb"></a>
210 <h2 class="memtitle"><span class="permalink"><a href="#ab49c86ae00ed1c75ec917bec95377aeb">&#9670;&nbsp;</a></span>tid</h2>
211
212 <div class="memitem">
213 <div class="memproto">
214       <table class="memname">
215         <tr>
216           <td class="memname">char* cache_param::tid</td>
217         </tr>
218       </table>
219 </div><div class="memdoc">
220
221 <p>taregt identifier </p>
222
223 <p class="reference">Referenced by <a class="el" href="cache__manager_8h.html#ae673ba42122433300afa3581ed4eb5af">gene_cache()</a>, <a class="el" href="dec__clientmsg__handler_8h.html#a86f804d83268e44baef977b7b54cbbcc">handle_TIDreqMSG()</a>, <a class="el" href="cache__manager_8h.html#aaf3ec7928cfc0cfa3888db892d50c20c">print_cache()</a>, <a class="el" href="cache__manager_8h.html#a3bd60aac832b765c765eb71211af2e05">search_cacheBytid()</a>, and <a class="el" href="cache__manager_8h.html#aeb3f8c42f00448cd7b3907d8bd516dd8">update_cachetid()</a>.</p>
224
225 </div>
226 </div>
227 <hr/>The documentation for this struct was generated from the following file:<ul>
228 <li><a class="el" href="cache__manager_8h_source.html">cache_manager.h</a></li>
229 </ul>
230 </div><!-- contents -->
231 <!-- start footer part -->
232 <hr class="footer"/><address class="footer"><small>
233 Generated by &#160;<a href="http://www.doxygen.org/index.html">
234 <img class="footer" src="doxygen.png" alt="doxygen"/>
235 </a> 1.8.13
236 </small></address>
237 </body>
238 </html>