Update Doxygen doc
[openjpeg.git] / doxygen / auxtrans__manager_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.10"/>
7 <title>OpenJPEG: auxtrans_manager.h Source File</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><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
36       <li class="current"><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="files.html"><span>File&#160;List</span></a></li>
42       <li><a href="globals.html"><span>Globals</span></a></li>
43     </ul>
44   </div>
45 <div id="nav-path" class="navpath">
46   <ul>
47 <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>
48 </div>
49 </div><!-- top -->
50 <div class="header">
51   <div class="headertitle">
52 <div class="title">auxtrans_manager.h</div>  </div>
53 </div><!--header-->
54 <div class="contents">
55 <a href="auxtrans__manager_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>
56 <div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> * $Id$</span></div>
57 <div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> *</span></div>
58 <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>
59 <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>
60 <div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"> * Copyright (c) 2010-2011, Kaori Hagihara</span></div>
61 <div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment"> * All rights reserved.</span></div>
62 <div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment"> *</span></div>
63 <div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment"> * Redistribution and use in source and binary forms, with or without</span></div>
64 <div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment"> * modification, are permitted provided that the following conditions</span></div>
65 <div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment"> * are met:</span></div>
66 <div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment"> * 1. Redistributions of source code must retain the above copyright</span></div>
67 <div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment"> *    notice, this list of conditions and the following disclaimer.</span></div>
68 <div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment"> * 2. Redistributions in binary form must reproduce the above copyright</span></div>
69 <div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment"> *    notice, this list of conditions and the following disclaimer in the</span></div>
70 <div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="comment"> *    documentation and/or other materials provided with the distribution.</span></div>
71 <div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment"> *</span></div>
72 <div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="comment"> * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS&#39;</span></div>
73 <div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="comment"> * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE</span></div>
74 <div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="comment"> * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE</span></div>
75 <div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="comment"> * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE</span></div>
76 <div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="comment"> * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR</span></div>
77 <div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="comment"> * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF</span></div>
78 <div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="comment"> * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS</span></div>
79 <div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="comment"> * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN</span></div>
80 <div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="comment"> * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)</span></div>
81 <div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="comment"> * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE</span></div>
82 <div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="comment"> * POSSIBILITY OF SUCH DAMAGE.</span></div>
83 <div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="comment"> */</span></div>
84 <div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;</div>
85 <div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;<span class="preprocessor">#ifndef         AUXTRANS_MANAGER_H_</span></div>
86 <div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;<span class="preprocessor"># define        AUXTRANS_MANAGER_H_</span></div>
87 <div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;</div>
88 <div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="sock__manager_8h.html">sock_manager.h</a>&quot;</span></div>
89 <div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="opj__includes_8h.html">opj_includes.h</a>&quot;</span></div>
90 <div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;</div>
91 <div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="structauxtrans__param.html">   38</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structauxtrans__param.html">auxtrans_param</a> {</div>
92 <div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="structauxtrans__param.html#abedbebb343b69044ed6e016063363ad1">   39</a></span>&#160;    <span class="keywordtype">int</span> <a class="code" href="structauxtrans__param.html#abedbebb343b69044ed6e016063363ad1">tcpauxport</a>;       </div>
93 <div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="structauxtrans__param.html#aa15a5c62c50b46e5eabe9796a4f59947">   40</a></span>&#160;    <span class="keywordtype">int</span> <a class="code" href="structauxtrans__param.html#aa15a5c62c50b46e5eabe9796a4f59947">udpauxport</a>;       </div>
94 <div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="structauxtrans__param.html#a0d6b0229459be4a4d7b755126fd64b2a">   41</a></span>&#160;    <a class="code" href="sock__manager_8h.html#a8dc8083897335125630f1af5dafd5831">SOCKET</a> <a class="code" href="structauxtrans__param.html#a0d6b0229459be4a4d7b755126fd64b2a">tcplistensock</a>; </div>
95 <div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="structauxtrans__param.html#af05ae7e0e02361a75ff018aa04a86ff2">   42</a></span>&#160;    <a class="code" href="sock__manager_8h.html#a8dc8083897335125630f1af5dafd5831">SOCKET</a> <a class="code" href="structauxtrans__param.html#af05ae7e0e02361a75ff018aa04a86ff2">udplistensock</a>; </div>
96 <div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;} <a class="code" href="auxtrans__manager_8h.html#a3a43df0d30b6082ba37b6129f3186263">auxtrans_param_t</a>;</div>
97 <div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;</div>
98 <div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;<a class="code" href="structauxtrans__param.html">auxtrans_param_t</a> <a class="code" href="auxtrans__manager_8h.html#a72e679f1d37899db4dec20b648c12ed9">init_aux_transport</a>(<span class="keywordtype">int</span> tcp_auxport, <span class="keywordtype">int</span> udp_auxport);</div>
99 <div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;</div>
100 <div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;<span class="keywordtype">void</span> <a class="code" href="auxtrans__manager_8h.html#aff6d8f931e99feb9cb30a4fc2540823d">close_aux_transport</a>(<a class="code" href="structauxtrans__param.html">auxtrans_param_t</a> auxtrans);</div>
101 <div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;</div>
102 <div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;<span class="keywordtype">void</span> <a class="code" href="auxtrans__manager_8h.html#af61f1523999a847b6e4ae90c5ce8b4bf">send_responsedata_on_aux</a>(<a class="code" href="openjpeg_8h.html#abb5dad6294f4611f1925388e919b16f4">OPJ_BOOL</a> istcp, <a class="code" href="structauxtrans__param.html">auxtrans_param_t</a> auxtrans,</div>
103 <div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;                              <span class="keyword">const</span> <span class="keywordtype">char</span> cid[], <span class="keywordtype">void</span> *data, <a class="code" href="openjpeg_8h.html#aba7397be054e36dc0284a6589736135e">OPJ_SIZE_T</a> length, <a class="code" href="openjpeg_8h.html#aba7397be054e36dc0284a6589736135e">OPJ_SIZE_T</a> maxlenPerFrame);</div>
104 <div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;</div>
105 <div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* !AUXTRANS_MANAGER_H_ */</span><span class="preprocessor"></span></div>
106 <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>
107 <div class="ttc" id="structauxtrans__param_html_aa15a5c62c50b46e5eabe9796a4f59947"><div class="ttname"><a href="structauxtrans__param.html#aa15a5c62c50b46e5eabe9796a4f59947">auxtrans_param::udpauxport</a></div><div class="ttdeci">int udpauxport</div><div class="ttdoc">udp port </div><div class="ttdef"><b>Definition:</b> auxtrans_manager.h:40</div></div>
108 <div class="ttc" id="auxtrans__manager_8h_html_a72e679f1d37899db4dec20b648c12ed9"><div class="ttname"><a href="auxtrans__manager_8h.html#a72e679f1d37899db4dec20b648c12ed9">init_aux_transport</a></div><div class="ttdeci">auxtrans_param_t init_aux_transport(int tcp_auxport, int udp_auxport)</div><div class="ttdoc">Initialize auxiliary transport server of JPIP server. </div><div class="ttdef"><b>Definition:</b> auxtrans_manager.c:51</div></div>
109 <div class="ttc" id="openjpeg_8h_html_aba7397be054e36dc0284a6589736135e"><div class="ttname"><a href="openjpeg_8h.html#aba7397be054e36dc0284a6589736135e">OPJ_SIZE_T</a></div><div class="ttdeci">size_t OPJ_SIZE_T</div><div class="ttdef"><b>Definition:</b> openjpeg.h:133</div></div>
110 <div class="ttc" id="auxtrans__manager_8h_html_a3a43df0d30b6082ba37b6129f3186263"><div class="ttname"><a href="auxtrans__manager_8h.html#a3a43df0d30b6082ba37b6129f3186263">auxtrans_param_t</a></div><div class="ttdeci">struct auxtrans_param auxtrans_param_t</div><div class="ttdoc">auxiliary transport setting parameters </div></div>
111 <div class="ttc" id="sock__manager_8h_html_a8dc8083897335125630f1af5dafd5831"><div class="ttname"><a href="sock__manager_8h.html#a8dc8083897335125630f1af5dafd5831">SOCKET</a></div><div class="ttdeci">int SOCKET</div><div class="ttdef"><b>Definition:</b> sock_manager.h:40</div></div>
112 <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>
113 <div class="ttc" id="auxtrans__manager_8h_html_aff6d8f931e99feb9cb30a4fc2540823d"><div class="ttname"><a href="auxtrans__manager_8h.html#aff6d8f931e99feb9cb30a4fc2540823d">close_aux_transport</a></div><div class="ttdeci">void close_aux_transport(auxtrans_param_t auxtrans)</div><div class="ttdoc">Close auxiliary transport server of JPIP server. </div><div class="ttdef"><b>Definition:</b> auxtrans_manager.c:70</div></div>
114 <div class="ttc" id="structauxtrans__param_html_abedbebb343b69044ed6e016063363ad1"><div class="ttname"><a href="structauxtrans__param.html#abedbebb343b69044ed6e016063363ad1">auxtrans_param::tcpauxport</a></div><div class="ttdeci">int tcpauxport</div><div class="ttdoc">tcp port </div><div class="ttdef"><b>Definition:</b> auxtrans_manager.h:39</div></div>
115 <div class="ttc" id="sock__manager_8h_html"><div class="ttname"><a href="sock__manager_8h.html">sock_manager.h</a></div></div>
116 <div class="ttc" id="auxtrans__manager_8h_html_af61f1523999a847b6e4ae90c5ce8b4bf"><div class="ttname"><a href="auxtrans__manager_8h.html#af61f1523999a847b6e4ae90c5ce8b4bf">send_responsedata_on_aux</a></div><div class="ttdeci">void send_responsedata_on_aux(OPJ_BOOL istcp, auxtrans_param_t auxtrans, const char cid[], void *data, OPJ_SIZE_T length, OPJ_SIZE_T maxlenPerFrame)</div><div class="ttdoc">Send response data on aux transport. </div><div class="ttdef"><b>Definition:</b> auxtrans_manager.c:109</div></div>
117 <div class="ttc" id="structauxtrans__param_html_af05ae7e0e02361a75ff018aa04a86ff2"><div class="ttname"><a href="structauxtrans__param.html#af05ae7e0e02361a75ff018aa04a86ff2">auxtrans_param::udplistensock</a></div><div class="ttdeci">SOCKET udplistensock</div><div class="ttdoc">listenning socket for aux udp (-1 if not open) </div><div class="ttdef"><b>Definition:</b> auxtrans_manager.h:42</div></div>
118 <div class="ttc" id="structauxtrans__param_html_a0d6b0229459be4a4d7b755126fd64b2a"><div class="ttname"><a href="structauxtrans__param.html#a0d6b0229459be4a4d7b755126fd64b2a">auxtrans_param::tcplistensock</a></div><div class="ttdeci">SOCKET tcplistensock</div><div class="ttdoc">listenning socket for aux tcp (-1 if not open) </div><div class="ttdef"><b>Definition:</b> auxtrans_manager.h:41</div></div>
119 <div class="ttc" id="opj__includes_8h_html"><div class="ttname"><a href="opj__includes_8h.html">opj_includes.h</a></div></div>
120 </div><!-- fragment --></div><!-- contents -->
121 <!-- start footer part -->
122 <hr class="footer"/><address class="footer"><small>
123 Generated by &#160;<a href="http://www.doxygen.org/index.html">
124 <img class="footer" src="doxygen.png" alt="doxygen"/>
125 </a> 1.8.10
126 </small></address>
127 </body>
128 </html>