Update ABI/API compatibility reports after commit 4e5501b3c72a98b3117e68263afb922092c...
[openjpeg.git] / doxygen / jpip__parser_8h_source.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: jpip_parser.h Source File</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 id="nav-path" class="navpath">
40   <ul>
41 <li class="navelem"><a class="el" href="dir_d522931ffa1371640980b621734a4381.html">Users</a></li><li class="navelem"><a class="el" href="dir_694e20c96f4fc1be4aed4f026eadce94.html">antonin</a></li><li class="navelem"><a class="el" href="dir_3ca1ad36e65e03f9e8d67ddc2553765b.html">dev</a></li><li class="navelem"><a class="el" href="dir_181a881edfcb8646dab693a228fa6bde.html">opj</a></li><li class="navelem"><a class="el" href="dir_5064bb5511811c3176850b7e47443f14.html">github</a></li><li class="navelem"><a class="el" href="dir_0b20524d8f8835ca75acc430451c8412.html">openjpeg</a></li><li class="navelem"><a class="el" href="dir_e3f8a8e294f8271ee71cbcf3c2acacc1.html">src</a></li><li class="navelem"><a class="el" href="dir_da83fe5fdfb6c4554d36abffc03790ad.html">lib</a></li><li class="navelem"><a class="el" href="dir_6ec2d9a1b37a1187cc46aeaf3b19e1b3.html">openjpip</a></li>  </ul>
42 </div>
43 </div><!-- top -->
44 <div class="header">
45   <div class="headertitle">
46 <div class="title">jpip_parser.h</div>  </div>
47 </div><!--header-->
48 <div class="contents">
49 <a href="jpip__parser_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"> * $Id$</span></div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> * Copyright (c) 2002-2014, Universite catholique de Louvain (UCL), Belgium</span></div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> * Copyright (c) 2002-2014, Professor Benoit Macq</span></div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"> * Copyright (c) 2010-2011, Kaori Hagihara</span></div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment"> * Copyright (c) 2011,      Lucian Corlaciu, GSoC</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="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="comment"> * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS</span></div><div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="comment"> * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN</span></div><div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="comment"> * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)</span></div><div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="comment"> * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE</span></div><div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="comment"> * POSSIBILITY OF SUCH DAMAGE.</span></div><div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;</div><div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;<span class="preprocessor">#ifndef     JPIP_PARSER_H_</span></div><div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;<span class="preprocessor"># define    JPIP_PARSER_H_</span></div><div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;</div><div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="query__parser_8h.html">query_parser.h</a>&quot;</span></div><div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="session__manager_8h.html">session_manager.h</a>&quot;</span></div><div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="target__manager_8h.html">target_manager.h</a>&quot;</span></div><div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="msgqueue__manager_8h.html">msgqueue_manager.h</a>&quot;</span></div><div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="channel__manager_8h.html">channel_manager.h</a>&quot;</span></div><div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;</div><div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;<a class="code" href="openjpeg_8h.html#abb5dad6294f4611f1925388e919b16f4">OPJ_BOOL</a> <a class="code" href="jpip__parser_8h.html#a4c5060e4a625ad5f2ffa5dfa4e47cf12">identify_target</a>(<a class="code" href="structquery__param.html">query_param_t</a> <a class="code" href="structquery__param.html">query_param</a>,</div><div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;                         <a class="code" href="structtargetlist__param.html">targetlist_param_t</a> *targetlist, <a class="code" href="structtarget__param.html">target_param_t</a> **target);</div><div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;</div><div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;<a class="code" href="openjpeg_8h.html#abb5dad6294f4611f1925388e919b16f4">OPJ_BOOL</a> <a class="code" href="jpip__parser_8h.html#a90326bc7816043198de9c7b60826afe2">associate_channel</a>(<a class="code" href="structquery__param.html">query_param_t</a>    <a class="code" href="structquery__param.html">query_param</a>,</div><div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;                           <a class="code" href="structsessionlist__param.html">sessionlist_param_t</a> *sessionlist,</div><div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;                           <a class="code" href="structsession__param.html">session_param_t</a> **cursession,</div><div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;                           <a class="code" href="structchannel__param.html">channel_param_t</a> **curchannel);</div><div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;<a class="code" href="openjpeg_8h.html#abb5dad6294f4611f1925388e919b16f4">OPJ_BOOL</a> <a class="code" href="jpip__parser_8h.html#a0a8093084853869a255f8f7f178e2e37">open_channel</a>(<a class="code" href="structquery__param.html">query_param_t</a> <a class="code" href="structquery__param.html">query_param</a>,</div><div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;                      <a class="code" href="structsessionlist__param.html">sessionlist_param_t</a> *sessionlist,</div><div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;                      <a class="code" href="structauxtrans__param.html">auxtrans_param_t</a> auxtrans,</div><div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;                      <a class="code" href="structtarget__param.html">target_param_t</a> *target,</div><div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;                      <a class="code" href="structsession__param.html">session_param_t</a> **cursession,</div><div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;                      <a class="code" href="structchannel__param.html">channel_param_t</a> **curchannel);</div><div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;</div><div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;<a class="code" href="openjpeg_8h.html#abb5dad6294f4611f1925388e919b16f4">OPJ_BOOL</a> <a class="code" href="jpip__parser_8h.html#ab28d80db34574a75d5bc720925dea329">close_channel</a>(<a class="code" href="structquery__param.html">query_param_t</a> <a class="code" href="structquery__param.html">query_param</a>,</div><div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;                       <a class="code" href="structsessionlist__param.html">sessionlist_param_t</a> *sessionlist,</div><div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;                       <a class="code" href="structsession__param.html">session_param_t</a> **cursession,</div><div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;                       <a class="code" href="structchannel__param.html">channel_param_t</a> **curchannel);</div><div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;</div><div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;<a class="code" href="openjpeg_8h.html#abb5dad6294f4611f1925388e919b16f4">OPJ_BOOL</a> <a class="code" href="jpip__parser_8h.html#a81aa485be8deb8d4878b30486c0006cd">gene_JPIPstream</a>(<a class="code" href="structquery__param.html">query_param_t</a> <a class="code" href="structquery__param.html">query_param</a>,</div><div class="line"><a name="l00109"></a><span class="lineno">  109</span>&#160;                         <a class="code" href="structtarget__param.html">target_param_t</a> *target,</div><div class="line"><a name="l00110"></a><span class="lineno">  110</span>&#160;                         <a class="code" href="structsession__param.html">session_param_t</a> *cursession,</div><div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;                         <a class="code" href="structchannel__param.html">channel_param_t</a> *curchannel,</div><div class="line"><a name="l00112"></a><span class="lineno">  112</span>&#160;                         <a class="code" href="structmsgqueue__param.html">msgqueue_param_t</a> **msgqueue);</div><div class="line"><a name="l00113"></a><span class="lineno">  113</span>&#160;</div><div class="line"><a name="l00114"></a><span class="lineno">  114</span>&#160;<span class="preprocessor">#endif      </span><span class="comment">/* !JPIP_PARSER_H_ */</span><span class="preprocessor"></span></div><div class="ttc" id="query__parser_8h_html"><div class="ttname"><a href="query__parser_8h.html">query_parser.h</a></div></div>
50 <div class="ttc" id="jpip__parser_8h_html_a90326bc7816043198de9c7b60826afe2"><div class="ttname"><a href="jpip__parser_8h.html#a90326bc7816043198de9c7b60826afe2">associate_channel</a></div><div class="ttdeci">OPJ_BOOL associate_channel(query_param_t query_param, sessionlist_param_t *sessionlist, session_param_t **cursession, channel_param_t **curchannel)</div><div class="ttdoc">REQUEST: channel association this must be processed before any process. </div><div class="ttdef"><b>Definition:</b> jpip_parser.c:82</div></div>
51 <div class="ttc" id="structmsgqueue__param_html"><div class="ttname"><a href="structmsgqueue__param.html">msgqueue_param</a></div><div class="ttdoc">message queue parameters </div><div class="ttdef"><b>Definition:</b> msgqueue_manager.h:63</div></div>
52 <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>
53 <div class="ttc" id="jpip__parser_8h_html_ab28d80db34574a75d5bc720925dea329"><div class="ttname"><a href="jpip__parser_8h.html#ab28d80db34574a75d5bc720925dea329">close_channel</a></div><div class="ttdeci">OPJ_BOOL close_channel(query_param_t query_param, sessionlist_param_t *sessionlist, session_param_t **cursession, channel_param_t **curchannel)</div><div class="ttdoc">REQUEST: channel close (cclose) </div><div class="ttdef"><b>Definition:</b> jpip_parser.c:131</div></div>
54 <div class="ttc" id="structtargetlist__param_html"><div class="ttname"><a href="structtargetlist__param.html">targetlist_param</a></div><div class="ttdoc">Target list parameters. </div><div class="ttdef"><b>Definition:</b> target_manager.h:59</div></div>
55 <div class="ttc" id="structauxtrans__param_html"><div class="ttname"><a href="structauxtrans__param.html">auxtrans_param</a></div><div class="ttdoc">auxiliary transport setting parameters </div><div class="ttdef"><b>Definition:</b> auxtrans_manager.h:38</div></div>
56 <div class="ttc" id="msgqueue__manager_8h_html"><div class="ttname"><a href="msgqueue__manager_8h.html">msgqueue_manager.h</a></div></div>
57 <div class="ttc" id="target__manager_8h_html"><div class="ttname"><a href="target__manager_8h.html">target_manager.h</a></div></div>
58 <div class="ttc" id="structquery__param_html"><div class="ttname"><a href="structquery__param.html">query_param</a></div><div class="ttdoc">Query parameters. </div><div class="ttdef"><b>Definition:</b> query_parser.h:47</div></div>
59 <div class="ttc" id="channel__manager_8h_html"><div class="ttname"><a href="channel__manager_8h.html">channel_manager.h</a></div></div>
60 <div class="ttc" id="jpip__parser_8h_html_a4c5060e4a625ad5f2ffa5dfa4e47cf12"><div class="ttname"><a href="jpip__parser_8h.html#a4c5060e4a625ad5f2ffa5dfa4e47cf12">identify_target</a></div><div class="ttdeci">OPJ_BOOL identify_target(query_param_t query_param, targetlist_param_t *targetlist, target_param_t **target)</div><div class="ttdoc">REQUEST: target identification by target or tid request. </div><div class="ttdef"><b>Definition:</b> jpip_parser.c:49</div></div>
61 <div class="ttc" id="jpip__parser_8h_html_a0a8093084853869a255f8f7f178e2e37"><div class="ttname"><a href="jpip__parser_8h.html#a0a8093084853869a255f8f7f178e2e37">open_channel</a></div><div class="ttdeci">OPJ_BOOL open_channel(query_param_t query_param, sessionlist_param_t *sessionlist, auxtrans_param_t auxtrans, target_param_t *target, session_param_t **cursession, channel_param_t **curchannel)</div><div class="ttdoc">REQUEST: new channel (cnew) assignment. </div><div class="ttdef"><b>Definition:</b> jpip_parser.c:100</div></div>
62 <div class="ttc" id="structsessionlist__param_html"><div class="ttname"><a href="structsessionlist__param.html">sessionlist_param</a></div><div class="ttdoc">Session list parameters. </div><div class="ttdef"><b>Definition:</b> session_manager.h:45</div></div>
63 <div class="ttc" id="structtarget__param_html"><div class="ttname"><a href="structtarget__param.html">target_param</a></div><div class="ttdoc">target parameters </div><div class="ttdef"><b>Definition:</b> target_manager.h:40</div></div>
64 <div class="ttc" id="jpip__parser_8h_html_a81aa485be8deb8d4878b30486c0006cd"><div class="ttname"><a href="jpip__parser_8h.html#a81aa485be8deb8d4878b30486c0006cd">gene_JPIPstream</a></div><div class="ttdeci">OPJ_BOOL gene_JPIPstream(query_param_t query_param, target_param_t *target, session_param_t *cursession, channel_param_t *curchannel, msgqueue_param_t **msgqueue)</div><div class="ttdoc">REQUEST: view-window (fsiz) </div><div class="ttdef"><b>Definition:</b> jpip_parser.c:204</div></div>
65 <div class="ttc" id="structsession__param_html"><div class="ttname"><a href="structsession__param.html">session_param</a></div><div class="ttdoc">Session parameters. </div><div class="ttdef"><b>Definition:</b> session_manager.h:38</div></div>
66 <div class="ttc" id="structchannel__param_html"><div class="ttname"><a href="structchannel__param.html">channel_param</a></div><div class="ttdoc">Channel parameters. </div><div class="ttdef"><b>Definition:</b> channel_manager.h:43</div></div>
67 <div class="ttc" id="session__manager_8h_html"><div class="ttname"><a href="session__manager_8h.html">session_manager.h</a></div></div>
68 </div><!-- fragment --></div><!-- contents -->
69 <!-- start footer part -->
70 <hr class="footer"/><address class="footer"><small>
71 Generated by &#160;<a href="http://www.doxygen.org/index.html">
72 <img class="footer" src="doxygen.png" alt="doxygen"/>
73 </a> 1.8.13
74 </small></address>
75 </body>
76 </html>