Update Doxygen doc
[openjpeg.git] / doxygen / structtarget__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: target_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">target_param Struct Reference</div>  </div>
51 </div><!--header-->
52 <div class="contents">
53
54 <p>target parameters  
55  <a href="structtarget__param.html#details">More...</a></p>
56
57 <p><code>#include &lt;<a class="el" href="target__manager_8h_source.html">target_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:a894903c8b208b2746717b3f1b2520234"><td class="memItemLeft" align="right" valign="top">char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structtarget__param.html#a894903c8b208b2746717b3f1b2520234">tid</a> [<a class="el" href="target__manager_8h.html#aa1c4bfdf38055d80194d6cae816467c4">MAX_LENOFTID</a>]</td></tr>
62 <tr class="memdesc:a894903c8b208b2746717b3f1b2520234"><td class="mdescLeft">&#160;</td><td class="mdescRight">target identifier  <a href="#a894903c8b208b2746717b3f1b2520234">More...</a><br /></td></tr>
63 <tr class="separator:a894903c8b208b2746717b3f1b2520234"><td class="memSeparator" colspan="2">&#160;</td></tr>
64 <tr class="memitem:a9b60d04127436a18e722d871e7c0044f"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structtarget__param.html#a9b60d04127436a18e722d871e7c0044f">targetname</a></td></tr>
65 <tr class="memdesc:a9b60d04127436a18e722d871e7c0044f"><td class="mdescLeft">&#160;</td><td class="mdescRight">local file path or URL ( URL is supported only with SERVER mode)  <a href="#a9b60d04127436a18e722d871e7c0044f">More...</a><br /></td></tr>
66 <tr class="separator:a9b60d04127436a18e722d871e7c0044f"><td class="memSeparator" colspan="2">&#160;</td></tr>
67 <tr class="memitem:a8ad04ede26a00264178f9ed678d70306"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structtarget__param.html#a8ad04ede26a00264178f9ed678d70306">fd</a></td></tr>
68 <tr class="memdesc:a8ad04ede26a00264178f9ed678d70306"><td class="mdescLeft">&#160;</td><td class="mdescRight">file descriptor  <a href="#a8ad04ede26a00264178f9ed678d70306">More...</a><br /></td></tr>
69 <tr class="separator:a8ad04ede26a00264178f9ed678d70306"><td class="memSeparator" colspan="2">&#160;</td></tr>
70 <tr class="memitem:abf900f3a6f25818b20fabd9f48502a6a"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structtarget__param.html#abf900f3a6f25818b20fabd9f48502a6a">csn</a></td></tr>
71 <tr class="memdesc:abf900f3a6f25818b20fabd9f48502a6a"><td class="mdescLeft">&#160;</td><td class="mdescRight">codestream number  <a href="#abf900f3a6f25818b20fabd9f48502a6a">More...</a><br /></td></tr>
72 <tr class="separator:abf900f3a6f25818b20fabd9f48502a6a"><td class="memSeparator" colspan="2">&#160;</td></tr>
73 <tr class="memitem:aac158d4d55987cda9053b81a17786c12"><td class="memItemLeft" align="right" valign="top"><a class="el" href="index__manager_8h.html#ac47781e88a7799358fb9c56238a6a251">index_param_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structtarget__param.html#aac158d4d55987cda9053b81a17786c12">codeidx</a></td></tr>
74 <tr class="memdesc:aac158d4d55987cda9053b81a17786c12"><td class="mdescLeft">&#160;</td><td class="mdescRight">index information of codestream  <a href="#aac158d4d55987cda9053b81a17786c12">More...</a><br /></td></tr>
75 <tr class="separator:aac158d4d55987cda9053b81a17786c12"><td class="memSeparator" colspan="2">&#160;</td></tr>
76 <tr class="memitem:a057f7a3cd287995cf3f4ec847f11b960"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structtarget__param.html#a057f7a3cd287995cf3f4ec847f11b960">num_of_use</a></td></tr>
77 <tr class="memdesc:a057f7a3cd287995cf3f4ec847f11b960"><td class="mdescLeft">&#160;</td><td class="mdescRight">numbers of sessions referring to this target  <a href="#a057f7a3cd287995cf3f4ec847f11b960">More...</a><br /></td></tr>
78 <tr class="separator:a057f7a3cd287995cf3f4ec847f11b960"><td class="memSeparator" colspan="2">&#160;</td></tr>
79 <tr class="memitem:acc3f7e29483871762e9be2765d7017a4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#abb5dad6294f4611f1925388e919b16f4">OPJ_BOOL</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structtarget__param.html#acc3f7e29483871762e9be2765d7017a4">jppstream</a></td></tr>
80 <tr class="memdesc:acc3f7e29483871762e9be2765d7017a4"><td class="mdescLeft">&#160;</td><td class="mdescRight">if this target can return JPP-stream  <a href="#acc3f7e29483871762e9be2765d7017a4">More...</a><br /></td></tr>
81 <tr class="separator:acc3f7e29483871762e9be2765d7017a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
82 <tr class="memitem:a40a29d6013b5b62fd489c41cbc2a93a8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#abb5dad6294f4611f1925388e919b16f4">OPJ_BOOL</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structtarget__param.html#a40a29d6013b5b62fd489c41cbc2a93a8">jptstream</a></td></tr>
83 <tr class="memdesc:a40a29d6013b5b62fd489c41cbc2a93a8"><td class="mdescLeft">&#160;</td><td class="mdescRight">if this target can return JPP-stream  <a href="#a40a29d6013b5b62fd489c41cbc2a93a8">More...</a><br /></td></tr>
84 <tr class="separator:a40a29d6013b5b62fd489c41cbc2a93a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
85 <tr class="memitem:a77e272b6376a33c60b6be8d2922634e8"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structtarget__param.html">target_param</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structtarget__param.html#a77e272b6376a33c60b6be8d2922634e8">next</a></td></tr>
86 <tr class="memdesc:a77e272b6376a33c60b6be8d2922634e8"><td class="mdescLeft">&#160;</td><td class="mdescRight">pointer to the next target  <a href="#a77e272b6376a33c60b6be8d2922634e8">More...</a><br /></td></tr>
87 <tr class="separator:a77e272b6376a33c60b6be8d2922634e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
88 </table>
89 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
90 <div class="textblock"><p>target parameters </p>
91 </div><h2 class="groupheader">Field Documentation</h2>
92 <a class="anchor" id="aac158d4d55987cda9053b81a17786c12"></a>
93 <div class="memitem">
94 <div class="memproto">
95       <table class="memname">
96         <tr>
97           <td class="memname"><a class="el" href="index__manager_8h.html#ac47781e88a7799358fb9c56238a6a251">index_param_t</a>* target_param::codeidx</td>
98         </tr>
99       </table>
100 </div><div class="memdoc">
101
102 <p>index information of codestream </p>
103
104 <p>Referenced by <a class="el" href="jpip__parser_8c.html#aca2006bf1afcda0f917aa7794bb6f287">enqueue_allprecincts()</a>, <a class="el" href="jpip__parser_8c.html#a72490e3e8ccd2d8d102a15affea987ec">enqueue_imagedata()</a>, <a class="el" href="msgqueue__manager_8h.html#a0a6f0ae1b724d1ccb7852f3e4ef1fd32">enqueue_mainheader()</a>, <a class="el" href="msgqueue__manager_8h.html#a8b6b00d2ba2bad2a483aed202cf25610">enqueue_metadata()</a>, <a class="el" href="msgqueue__manager_8h.html#afd5f028cafe553d84aa7545ee5837d66">enqueue_precinct()</a>, <a class="el" href="jpip__parser_8c.html#aebe387634751d8d7d253ec5b9273f093">enqueue_precincts()</a>, <a class="el" href="msgqueue__manager_8h.html#a4982e5cda507b39bfc074b4c4b60e3ae">enqueue_tile()</a>, <a class="el" href="msgqueue__manager_8h.html#a3280c3cd4e26ac1e3bdd27d6f5bbf999">enqueue_tileheader()</a>, <a class="el" href="cachemodel__manager_8h.html#a8536ce465d342e4cd99e618c4c20e6d7">gene_cachemodel()</a>, <a class="el" href="jpip__parser_8h.html#a81aa485be8deb8d4878b30486c0006cd">gene_JPIPstream()</a>, <a class="el" href="target__manager_8h.html#afff9d3a8abcbaa01253c294506dc96ba">gene_target()</a>, <a class="el" href="cachemodel__manager_8h.html#a100d5835680e609531af22213616ce97">is_allsent()</a>, and <a class="el" href="cachemodel__manager_8h.html#a269ce98f85275b2b6348aae150108c5b">print_cachemodel()</a>.</p>
105
106 </div>
107 </div>
108 <a class="anchor" id="abf900f3a6f25818b20fabd9f48502a6a"></a>
109 <div class="memitem">
110 <div class="memproto">
111       <table class="memname">
112         <tr>
113           <td class="memname">int target_param::csn</td>
114         </tr>
115       </table>
116 </div><div class="memdoc">
117
118 <p>codestream number </p>
119
120 <p>Referenced by <a class="el" href="msgqueue__manager_8c.html#af9e8592eed6cce4e4662573d4e0baab2">enqueue_box()</a>, <a class="el" href="msgqueue__manager_8c.html#ad0ed65ba620f6de6e80903cc76af81d2">enqueue_boxcontents()</a>, <a class="el" href="msgqueue__manager_8h.html#a0a6f0ae1b724d1ccb7852f3e4ef1fd32">enqueue_mainheader()</a>, <a class="el" href="msgqueue__manager_8c.html#aee12a1a3362e2fb267e73f1b8c276832">enqueue_phld()</a>, <a class="el" href="msgqueue__manager_8h.html#afd5f028cafe553d84aa7545ee5837d66">enqueue_precinct()</a>, <a class="el" href="msgqueue__manager_8h.html#a4982e5cda507b39bfc074b4c4b60e3ae">enqueue_tile()</a>, <a class="el" href="msgqueue__manager_8h.html#a3280c3cd4e26ac1e3bdd27d6f5bbf999">enqueue_tileheader()</a>, <a class="el" href="target__manager_8h.html#afff9d3a8abcbaa01253c294506dc96ba">gene_target()</a>, and <a class="el" href="target__manager_8h.html#a70f4754f86b888e3f0b8a471ed58a17f">print_target()</a>.</p>
121
122 </div>
123 </div>
124 <a class="anchor" id="a8ad04ede26a00264178f9ed678d70306"></a>
125 <div class="memitem">
126 <div class="memproto">
127       <table class="memname">
128         <tr>
129           <td class="memname">int target_param::fd</td>
130         </tr>
131       </table>
132 </div><div class="memdoc">
133
134 <p>file descriptor </p>
135
136 <p>Referenced by <a class="el" href="target__manager_8h.html#afff9d3a8abcbaa01253c294506dc96ba">gene_target()</a>, and <a class="el" href="msgqueue__manager_8h.html#ae67910d9d277b55a257b2b47165000f1">recons_stream_from_msgqueue()</a>.</p>
137
138 </div>
139 </div>
140 <a class="anchor" id="acc3f7e29483871762e9be2765d7017a4"></a>
141 <div class="memitem">
142 <div class="memproto">
143       <table class="memname">
144         <tr>
145           <td class="memname"><a class="el" href="openjpeg_8h.html#abb5dad6294f4611f1925388e919b16f4">OPJ_BOOL</a> target_param::jppstream</td>
146         </tr>
147       </table>
148 </div><div class="memdoc">
149
150 <p>if this target can return JPP-stream </p>
151
152 <p>Referenced by <a class="el" href="cachemodel__manager_8h.html#a8536ce465d342e4cd99e618c4c20e6d7">gene_cachemodel()</a>, and <a class="el" href="target__manager_8h.html#afff9d3a8abcbaa01253c294506dc96ba">gene_target()</a>.</p>
153
154 </div>
155 </div>
156 <a class="anchor" id="a40a29d6013b5b62fd489c41cbc2a93a8"></a>
157 <div class="memitem">
158 <div class="memproto">
159       <table class="memname">
160         <tr>
161           <td class="memname"><a class="el" href="openjpeg_8h.html#abb5dad6294f4611f1925388e919b16f4">OPJ_BOOL</a> target_param::jptstream</td>
162         </tr>
163       </table>
164 </div><div class="memdoc">
165
166 <p>if this target can return JPP-stream </p>
167
168 <p>Referenced by <a class="el" href="cachemodel__manager_8h.html#a8536ce465d342e4cd99e618c4c20e6d7">gene_cachemodel()</a>, and <a class="el" href="target__manager_8h.html#afff9d3a8abcbaa01253c294506dc96ba">gene_target()</a>.</p>
169
170 </div>
171 </div>
172 <a class="anchor" id="a77e272b6376a33c60b6be8d2922634e8"></a>
173 <div class="memitem">
174 <div class="memproto">
175       <table class="memname">
176         <tr>
177           <td class="memname">struct <a class="el" href="structtarget__param.html">target_param</a>* target_param::next</td>
178         </tr>
179       </table>
180 </div><div class="memdoc">
181
182 <p>pointer to the next target </p>
183
184 <p>Referenced by <a class="el" href="target__manager_8h.html#a92923f09314b612eff829c5ff5cd6a33">delete_target_in_list()</a>, <a class="el" href="target__manager_8h.html#a6cb2e1815fd26100a528370452c20945">delete_targetlist()</a>, <a class="el" href="target__manager_8h.html#afff9d3a8abcbaa01253c294506dc96ba">gene_target()</a>, <a class="el" href="target__manager_8h.html#abe48fd7b8d8f521d4d73569b8bb0a3c2">print_alltarget()</a>, <a class="el" href="target__manager_8h.html#ad3a4f792dd27c81fb2c355708ac4b62a">search_target()</a>, and <a class="el" href="target__manager_8h.html#ada4a46123e4fd43bcfeae69eda0051e5">search_targetBytid()</a>.</p>
185
186 </div>
187 </div>
188 <a class="anchor" id="a057f7a3cd287995cf3f4ec847f11b960"></a>
189 <div class="memitem">
190 <div class="memproto">
191       <table class="memname">
192         <tr>
193           <td class="memname">int target_param::num_of_use</td>
194         </tr>
195       </table>
196 </div><div class="memdoc">
197
198 <p>numbers of sessions referring to this target </p>
199
200 <p>Referenced by <a class="el" href="target__manager_8h.html#afff9d3a8abcbaa01253c294506dc96ba">gene_target()</a>, <a class="el" href="target__manager_8h.html#a7b08bd1ea87c9daba4d249892c39aba1">refer_target()</a>, and <a class="el" href="target__manager_8h.html#a22963b6f86858c316cb3ef865deef531">unrefer_target()</a>.</p>
201
202 </div>
203 </div>
204 <a class="anchor" id="a9b60d04127436a18e722d871e7c0044f"></a>
205 <div class="memitem">
206 <div class="memproto">
207       <table class="memname">
208         <tr>
209           <td class="memname">char* target_param::targetname</td>
210         </tr>
211       </table>
212 </div><div class="memdoc">
213
214 <p>local file path or URL ( URL is supported only with SERVER mode) </p>
215
216 <p>Referenced by <a class="el" href="target__manager_8h.html#afff9d3a8abcbaa01253c294506dc96ba">gene_target()</a>, <a class="el" href="channel__manager_8h.html#a52a8a4a100b4d92065e3cc59c524b385">print_allchannel()</a>, <a class="el" href="cachemodel__manager_8h.html#a269ce98f85275b2b6348aae150108c5b">print_cachemodel()</a>, <a class="el" href="target__manager_8h.html#a70f4754f86b888e3f0b8a471ed58a17f">print_target()</a>, and <a class="el" href="target__manager_8h.html#ad3a4f792dd27c81fb2c355708ac4b62a">search_target()</a>.</p>
217
218 </div>
219 </div>
220 <a class="anchor" id="a894903c8b208b2746717b3f1b2520234"></a>
221 <div class="memitem">
222 <div class="memproto">
223       <table class="memname">
224         <tr>
225           <td class="memname">char target_param::tid[<a class="el" href="target__manager_8h.html#aa1c4bfdf38055d80194d6cae816467c4">MAX_LENOFTID</a>]</td>
226         </tr>
227       </table>
228 </div><div class="memdoc">
229
230 <p>target identifier </p>
231
232 <p>Referenced by <a class="el" href="target__manager_8h.html#afff9d3a8abcbaa01253c294506dc96ba">gene_target()</a>, <a class="el" href="target__manager_8h.html#a70f4754f86b888e3f0b8a471ed58a17f">print_target()</a>, and <a class="el" href="target__manager_8h.html#ada4a46123e4fd43bcfeae69eda0051e5">search_targetBytid()</a>.</p>
233
234 </div>
235 </div>
236 <hr/>The documentation for this struct was generated from the following file:<ul>
237 <li><a class="el" href="target__manager_8h_source.html">target_manager.h</a></li>
238 </ul>
239 </div><!-- contents -->
240 <!-- start footer part -->
241 <hr class="footer"/><address class="footer"><small>
242 Generated by &#160;<a href="http://www.doxygen.org/index.html">
243 <img class="footer" src="doxygen.png" alt="doxygen"/>
244 </a> 1.8.10
245 </small></address>
246 </body>
247 </html>