Update Doxygen doc
[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.10"/>
7 <title>OpenJPEG: cache_param Struct Reference</title>
8 <link href="tabs.css" rel="stylesheet" type="text/css"/>
9 <script type="text/javascript" src="jquery.js"></script>
10 <script type="text/javascript" src="dynsections.js"></script>
11 <link href="doxygen.css" rel="stylesheet" type="text/css" />
12 </head>
13 <body>
14 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
15 <div id="titlearea">
16 <table cellspacing="0" cellpadding="0">
17  <tbody>
18  <tr style="height: 56px;">
19   <td id="projectalign" style="padding-left: 0.5em;">
20    <div id="projectname">OpenJPEG
21    &#160;<span id="projectnumber">2.2.0</span>
22    </div>
23   </td>
24  </tr>
25  </tbody>
26 </table>
27 </div>
28 <!-- end header part -->
29 <!-- Generated by Doxygen 1.8.10 -->
30   <div id="navrow1" class="tabs">
31     <ul class="tablist">
32       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
33       <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
34       <li><a href="modules.html"><span>Modules</span></a></li>
35       <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
36       <li><a href="files.html"><span>Files</span></a></li>
37     </ul>
38   </div>
39   <div id="navrow2" class="tabs2">
40     <ul class="tablist">
41       <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
42       <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
43     </ul>
44   </div>
45 </div><!-- top -->
46 <div class="header">
47   <div class="summary">
48 <a href="#pub-attribs">Data Fields</a>  </div>
49   <div class="headertitle">
50 <div class="title">cache_param Struct Reference</div>  </div>
51 </div><!--header-->
52 <div class="contents">
53
54 <p>cache parameters  
55  <a href="structcache__param.html#details">More...</a></p>
56
57 <p><code>#include &lt;<a class="el" href="cache__manager_8h_source.html">cache_manager.h</a>&gt;</code></p>
58 <table class="memberdecls">
59 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
60 Data Fields</h2></td></tr>
61 <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>
62 <tr class="memdesc:a4b1e92d200b2d6f991acfb031024181e"><td class="mdescLeft">&#160;</td><td class="mdescRight">file name  <a href="#a4b1e92d200b2d6f991acfb031024181e">More...</a><br /></td></tr>
63 <tr class="separator:a4b1e92d200b2d6f991acfb031024181e"><td class="memSeparator" colspan="2">&#160;</td></tr>
64 <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>
65 <tr class="memdesc:ab49c86ae00ed1c75ec917bec95377aeb"><td class="mdescLeft">&#160;</td><td class="mdescRight">taregt identifier  <a href="#ab49c86ae00ed1c75ec917bec95377aeb">More...</a><br /></td></tr>
66 <tr class="separator:ab49c86ae00ed1c75ec917bec95377aeb"><td class="memSeparator" colspan="2">&#160;</td></tr>
67 <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>
68 <tr class="memdesc:a8f5a0232ef788420480274e68932a8d3"><td class="mdescLeft">&#160;</td><td class="mdescRight">codestream number  <a href="#a8f5a0232ef788420480274e68932a8d3">More...</a><br /></td></tr>
69 <tr class="separator:a8f5a0232ef788420480274e68932a8d3"><td class="memSeparator" colspan="2">&#160;</td></tr>
70 <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>
71 <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>
72 <tr class="separator:a15739295a73f8bca1a53b4c11f3a855a"><td class="memSeparator" colspan="2">&#160;</td></tr>
73 <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>
74 <tr class="memdesc:acc75fa242d285962ff9451c0b875c18c"><td class="mdescLeft">&#160;</td><td class="mdescRight">number of cids  <a href="#acc75fa242d285962ff9451c0b875c18c">More...</a><br /></td></tr>
75 <tr class="separator:acc75fa242d285962ff9451c0b875c18c"><td class="memSeparator" colspan="2">&#160;</td></tr>
76 <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>
77 <tr class="memdesc:a001b90163246b1af6f7b4e37e9ae53c2"><td class="mdescLeft">&#160;</td><td class="mdescRight">metadata-bin list  <a href="#a001b90163246b1af6f7b4e37e9ae53c2">More...</a><br /></td></tr>
78 <tr class="separator:a001b90163246b1af6f7b4e37e9ae53c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
79 <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>
80 <tr class="memdesc:a89b857a7eea2ef020774bba91421b47f"><td class="mdescLeft">&#160;</td><td class="mdescRight">ihdrbox  <a href="#a89b857a7eea2ef020774bba91421b47f">More...</a><br /></td></tr>
81 <tr class="separator:a89b857a7eea2ef020774bba91421b47f"><td class="memSeparator" colspan="2">&#160;</td></tr>
82 <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>
83 <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>
84 <tr class="separator:aea41f0c4553d98f30fbd299e78a637e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
85 </table>
86 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
87 <div class="textblock"><p>cache parameters </p>
88 </div><h2 class="groupheader">Field Documentation</h2>
89 <a class="anchor" id="a15739295a73f8bca1a53b4c11f3a855a"></a>
90 <div class="memitem">
91 <div class="memproto">
92       <table class="memname">
93         <tr>
94           <td class="memname">char** cache_param::cid</td>
95         </tr>
96       </table>
97 </div><div class="memdoc">
98
99 <p>dynamic array of channel identifiers </p>
100
101 <p>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>
102
103 </div>
104 </div>
105 <a class="anchor" id="a8f5a0232ef788420480274e68932a8d3"></a>
106 <div class="memitem">
107 <div class="memproto">
108       <table class="memname">
109         <tr>
110           <td class="memname">int cache_param::csn</td>
111         </tr>
112       </table>
113 </div><div class="memdoc">
114
115 <p>codestream number </p>
116
117 <p>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>
118
119 </div>
120 </div>
121 <a class="anchor" id="a4b1e92d200b2d6f991acfb031024181e"></a>
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>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 class="anchor" id="a89b857a7eea2ef020774bba91421b47f"></a>
138 <div class="memitem">
139 <div class="memproto">
140       <table class="memname">
141         <tr>
142           <td class="memname"><a class="el" href="ihdrbox__manager_8h.html#ae88b004f80ae7e57d50cdbee20e25199">ihdrbox_param_t</a>* cache_param::ihdrbox</td>
143         </tr>
144       </table>
145 </div><div class="memdoc">
146
147 <p>ihdrbox </p>
148
149 <p>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>
150
151 </div>
152 </div>
153 <a class="anchor" id="a001b90163246b1af6f7b4e37e9ae53c2"></a>
154 <div class="memitem">
155 <div class="memproto">
156       <table class="memname">
157         <tr>
158           <td class="memname"><a class="el" href="metadata__manager_8h.html#aaa78ced398f149ca92b47e0acddf05e5">metadatalist_param_t</a>* cache_param::metadatalist</td>
159         </tr>
160       </table>
161 </div><div class="memdoc">
162
163 <p>metadata-bin list </p>
164
165 <p>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>
166
167 </div>
168 </div>
169 <a class="anchor" id="aea41f0c4553d98f30fbd299e78a637e8"></a>
170 <div class="memitem">
171 <div class="memproto">
172       <table class="memname">
173         <tr>
174           <td class="memname">struct <a class="el" href="structcache__param.html">cache_param</a>* cache_param::next</td>
175         </tr>
176       </table>
177 </div><div class="memdoc">
178
179 <p>pointer to the next cache </p>
180
181 <p>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>
182
183 </div>
184 </div>
185 <a class="anchor" id="acc75fa242d285962ff9451c0b875c18c"></a>
186 <div class="memitem">
187 <div class="memproto">
188       <table class="memname">
189         <tr>
190           <td class="memname">int cache_param::numOfcid</td>
191         </tr>
192       </table>
193 </div><div class="memdoc">
194
195 <p>number of cids </p>
196
197 <p>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>
198
199 </div>
200 </div>
201 <a class="anchor" id="ab49c86ae00ed1c75ec917bec95377aeb"></a>
202 <div class="memitem">
203 <div class="memproto">
204       <table class="memname">
205         <tr>
206           <td class="memname">char* cache_param::tid</td>
207         </tr>
208       </table>
209 </div><div class="memdoc">
210
211 <p>taregt identifier </p>
212
213 <p>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>
214
215 </div>
216 </div>
217 <hr/>The documentation for this struct was generated from the following file:<ul>
218 <li><a class="el" href="cache__manager_8h_source.html">cache_manager.h</a></li>
219 </ul>
220 </div><!-- contents -->
221 <!-- start footer part -->
222 <hr class="footer"/><address class="footer"><small>
223 Generated by &#160;<a href="http://www.doxygen.org/index.html">
224 <img class="footer" src="doxygen.png" alt="doxygen"/>
225 </a> 1.8.10
226 </small></address>
227 </body>
228 </html>