Create CNAME
[openjpeg.git] / doxygen / auxtrans__manager_8h.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/>
7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
8 <title>OpenJPEG: auxtrans_manager.h File 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.5.0</span>
23    </div>
24   </td>
25  </tr>
26  </tbody>
27 </table>
28 </div>
29 <!-- end header part -->
30 <!-- Generated by Doxygen 1.8.17 -->
31 <script type="text/javascript" src="menudata.js"></script>
32 <script type="text/javascript" src="menu.js"></script>
33 <script type="text/javascript">
34 /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
35 $(function() {
36   initMenu('',false,false,'search.php','Search');
37 });
38 /* @license-end */</script>
39 <div id="main-nav"></div>
40 <div id="nav-path" class="navpath">
41   <ul>
42 <li class="navelem"><a class="el" href="dir_43e0a1f539e00dcfa1a6bc4d4fee4fc2.html">home</a></li><li class="navelem"><a class="el" href="dir_cb9b2b419d92b64f7cee83d8faf7a4ab.html">even</a></li><li class="navelem"><a class="el" href="dir_f75d9a0165d6564a1e04793ef847d41d.html">openjpeg</a></li><li class="navelem"><a class="el" href="dir_5f588d7ea139c1aae751d03c13a16064.html">openjpeg</a></li><li class="navelem"><a class="el" href="dir_378f732e812ef6cbaaae22e96a4fa79f.html">src</a></li><li class="navelem"><a class="el" href="dir_19dcb5713315405a27e1bde75a489a4c.html">lib</a></li><li class="navelem"><a class="el" href="dir_54d80c9412497e935deb5677b5fae801.html">openjpip</a></li>  </ul>
43 </div>
44 </div><!-- top -->
45 <div class="header">
46   <div class="summary">
47 <a href="#nested-classes">Data Structures</a> &#124;
48 <a href="#typedef-members">Typedefs</a> &#124;
49 <a href="#func-members">Functions</a>  </div>
50   <div class="headertitle">
51 <div class="title">auxtrans_manager.h File Reference</div>  </div>
52 </div><!--header-->
53 <div class="contents">
54 <div class="textblock"><code>#include &quot;<a class="el" href="sock__manager_8h_source.html">sock_manager.h</a>&quot;</code><br />
55 <code>#include &quot;<a class="el" href="opj__includes_8h_source.html">opj_includes.h</a>&quot;</code><br />
56 </div>
57 <p><a href="auxtrans__manager_8h_source.html">Go to the source code of this file.</a></p>
58 <table class="memberdecls">
59 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
60 Data Structures</h2></td></tr>
61 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structauxtrans__param.html">auxtrans_param</a></td></tr>
62 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">auxiliary transport setting parameters  <a href="structauxtrans__param.html#details">More...</a><br /></td></tr>
63 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
64 </table><table class="memberdecls">
65 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
66 Typedefs</h2></td></tr>
67 <tr class="memitem:a7fbdcefe6a0a01cd907fc6023f32b1ad"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structauxtrans__param.html">auxtrans_param</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="auxtrans__manager_8h.html#a7fbdcefe6a0a01cd907fc6023f32b1ad">auxtrans_param_t</a></td></tr>
68 <tr class="memdesc:a7fbdcefe6a0a01cd907fc6023f32b1ad"><td class="mdescLeft">&#160;</td><td class="mdescRight">auxiliary transport setting parameters  <a href="auxtrans__manager_8h.html#a7fbdcefe6a0a01cd907fc6023f32b1ad">More...</a><br /></td></tr>
69 <tr class="separator:a7fbdcefe6a0a01cd907fc6023f32b1ad"><td class="memSeparator" colspan="2">&#160;</td></tr>
70 </table><table class="memberdecls">
71 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
72 Functions</h2></td></tr>
73 <tr class="memitem:a72e679f1d37899db4dec20b648c12ed9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="auxtrans__manager_8h.html#a7fbdcefe6a0a01cd907fc6023f32b1ad">auxtrans_param_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="auxtrans__manager_8h.html#a72e679f1d37899db4dec20b648c12ed9">init_aux_transport</a> (int tcp_auxport, int udp_auxport)</td></tr>
74 <tr class="memdesc:a72e679f1d37899db4dec20b648c12ed9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize auxiliary transport server of JPIP server.  <a href="auxtrans__manager_8h.html#a72e679f1d37899db4dec20b648c12ed9">More...</a><br /></td></tr>
75 <tr class="separator:a72e679f1d37899db4dec20b648c12ed9"><td class="memSeparator" colspan="2">&#160;</td></tr>
76 <tr class="memitem:aff6d8f931e99feb9cb30a4fc2540823d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="auxtrans__manager_8h.html#aff6d8f931e99feb9cb30a4fc2540823d">close_aux_transport</a> (<a class="el" href="auxtrans__manager_8h.html#a7fbdcefe6a0a01cd907fc6023f32b1ad">auxtrans_param_t</a> auxtrans)</td></tr>
77 <tr class="memdesc:aff6d8f931e99feb9cb30a4fc2540823d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Close auxiliary transport server of JPIP server.  <a href="auxtrans__manager_8h.html#aff6d8f931e99feb9cb30a4fc2540823d">More...</a><br /></td></tr>
78 <tr class="separator:aff6d8f931e99feb9cb30a4fc2540823d"><td class="memSeparator" colspan="2">&#160;</td></tr>
79 <tr class="memitem:af61f1523999a847b6e4ae90c5ce8b4bf"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="auxtrans__manager_8h.html#af61f1523999a847b6e4ae90c5ce8b4bf">send_responsedata_on_aux</a> (<a class="el" href="openjpeg_8h.html#abb5dad6294f4611f1925388e919b16f4">OPJ_BOOL</a> istcp, <a class="el" href="auxtrans__manager_8h.html#a7fbdcefe6a0a01cd907fc6023f32b1ad">auxtrans_param_t</a> auxtrans, const char cid[], void *data, <a class="el" href="openjpeg_8h.html#aba7397be054e36dc0284a6589736135e">OPJ_SIZE_T</a> length, <a class="el" href="openjpeg_8h.html#aba7397be054e36dc0284a6589736135e">OPJ_SIZE_T</a> maxlenPerFrame)</td></tr>
80 <tr class="memdesc:af61f1523999a847b6e4ae90c5ce8b4bf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send response data on aux transport.  <a href="auxtrans__manager_8h.html#af61f1523999a847b6e4ae90c5ce8b4bf">More...</a><br /></td></tr>
81 <tr class="separator:af61f1523999a847b6e4ae90c5ce8b4bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
82 </table>
83 <h2 class="groupheader">Typedef Documentation</h2>
84 <a id="a7fbdcefe6a0a01cd907fc6023f32b1ad"></a>
85 <h2 class="memtitle"><span class="permalink"><a href="#a7fbdcefe6a0a01cd907fc6023f32b1ad">&#9670;&nbsp;</a></span>auxtrans_param_t</h2>
86
87 <div class="memitem">
88 <div class="memproto">
89       <table class="memname">
90         <tr>
91           <td class="memname">typedef struct <a class="el" href="structauxtrans__param.html">auxtrans_param</a> <a class="el" href="auxtrans__manager_8h.html#a7fbdcefe6a0a01cd907fc6023f32b1ad">auxtrans_param_t</a></td>
92         </tr>
93       </table>
94 </div><div class="memdoc">
95
96 <p>auxiliary transport setting parameters </p>
97
98 </div>
99 </div>
100 <h2 class="groupheader">Function Documentation</h2>
101 <a id="aff6d8f931e99feb9cb30a4fc2540823d"></a>
102 <h2 class="memtitle"><span class="permalink"><a href="#aff6d8f931e99feb9cb30a4fc2540823d">&#9670;&nbsp;</a></span>close_aux_transport()</h2>
103
104 <div class="memitem">
105 <div class="memproto">
106       <table class="memname">
107         <tr>
108           <td class="memname">void close_aux_transport </td>
109           <td>(</td>
110           <td class="paramtype"><a class="el" href="auxtrans__manager_8h.html#a7fbdcefe6a0a01cd907fc6023f32b1ad">auxtrans_param_t</a>&#160;</td>
111           <td class="paramname"><em>auxtrans</em></td><td>)</td>
112           <td></td>
113         </tr>
114       </table>
115 </div><div class="memdoc">
116
117 <p>Close auxiliary transport server of JPIP server. </p>
118 <dl class="params"><dt>Parameters</dt><dd>
119   <table class="params">
120     <tr><td class="paramdir">[in]</td><td class="paramname">auxtrans</td><td>closing transport server </td></tr>
121   </table>
122   </dd>
123 </dl>
124
125 </div>
126 </div>
127 <a id="a72e679f1d37899db4dec20b648c12ed9"></a>
128 <h2 class="memtitle"><span class="permalink"><a href="#a72e679f1d37899db4dec20b648c12ed9">&#9670;&nbsp;</a></span>init_aux_transport()</h2>
129
130 <div class="memitem">
131 <div class="memproto">
132       <table class="memname">
133         <tr>
134           <td class="memname"><a class="el" href="auxtrans__manager_8h.html#a7fbdcefe6a0a01cd907fc6023f32b1ad">auxtrans_param_t</a> init_aux_transport </td>
135           <td>(</td>
136           <td class="paramtype">int&#160;</td>
137           <td class="paramname"><em>tcp_auxport</em>, </td>
138         </tr>
139         <tr>
140           <td class="paramkey"></td>
141           <td></td>
142           <td class="paramtype">int&#160;</td>
143           <td class="paramname"><em>udp_auxport</em>&#160;</td>
144         </tr>
145         <tr>
146           <td></td>
147           <td>)</td>
148           <td></td><td></td>
149         </tr>
150       </table>
151 </div><div class="memdoc">
152
153 <p>Initialize auxiliary transport server of JPIP server. </p>
154 <dl class="params"><dt>Parameters</dt><dd>
155   <table class="params">
156     <tr><td class="paramdir">[in]</td><td class="paramname">tcp_auxport</td><td>opening tcp auxiliary port ( 0 not to open, valid No. 49152-65535) </td></tr>
157     <tr><td class="paramdir">[in]</td><td class="paramname">udp_auxport</td><td>opening udp auxiliary port ( 0 not to open, valid No. 49152-65535) </td></tr>
158   </table>
159   </dd>
160 </dl>
161 <dl class="section return"><dt>Returns</dt><dd>initialized transport parameters </dd></dl>
162
163 <p class="reference">References <a class="el" href="sock__manager_8c.html#a3c822e28c71631b25683cc57e8e4536b">open_listeningsocket()</a>, <a class="el" href="structauxtrans__param.html#abedbebb343b69044ed6e016063363ad1">auxtrans_param::tcpauxport</a>, <a class="el" href="structauxtrans__param.html#a0d6b0229459be4a4d7b755126fd64b2a">auxtrans_param::tcplistensock</a>, <a class="el" href="structauxtrans__param.html#aa15a5c62c50b46e5eabe9796a4f59947">auxtrans_param::udpauxport</a>, and <a class="el" href="structauxtrans__param.html#af05ae7e0e02361a75ff018aa04a86ff2">auxtrans_param::udplistensock</a>.</p>
164
165 </div>
166 </div>
167 <a id="af61f1523999a847b6e4ae90c5ce8b4bf"></a>
168 <h2 class="memtitle"><span class="permalink"><a href="#af61f1523999a847b6e4ae90c5ce8b4bf">&#9670;&nbsp;</a></span>send_responsedata_on_aux()</h2>
169
170 <div class="memitem">
171 <div class="memproto">
172       <table class="memname">
173         <tr>
174           <td class="memname">void send_responsedata_on_aux </td>
175           <td>(</td>
176           <td class="paramtype"><a class="el" href="openjpeg_8h.html#abb5dad6294f4611f1925388e919b16f4">OPJ_BOOL</a>&#160;</td>
177           <td class="paramname"><em>istcp</em>, </td>
178         </tr>
179         <tr>
180           <td class="paramkey"></td>
181           <td></td>
182           <td class="paramtype"><a class="el" href="auxtrans__manager_8h.html#a7fbdcefe6a0a01cd907fc6023f32b1ad">auxtrans_param_t</a>&#160;</td>
183           <td class="paramname"><em>auxtrans</em>, </td>
184         </tr>
185         <tr>
186           <td class="paramkey"></td>
187           <td></td>
188           <td class="paramtype">const char&#160;</td>
189           <td class="paramname"><em>cid</em>[], </td>
190         </tr>
191         <tr>
192           <td class="paramkey"></td>
193           <td></td>
194           <td class="paramtype">void *&#160;</td>
195           <td class="paramname"><em>data</em>, </td>
196         </tr>
197         <tr>
198           <td class="paramkey"></td>
199           <td></td>
200           <td class="paramtype"><a class="el" href="openjpeg_8h.html#aba7397be054e36dc0284a6589736135e">OPJ_SIZE_T</a>&#160;</td>
201           <td class="paramname"><em>length</em>, </td>
202         </tr>
203         <tr>
204           <td class="paramkey"></td>
205           <td></td>
206           <td class="paramtype"><a class="el" href="openjpeg_8h.html#aba7397be054e36dc0284a6589736135e">OPJ_SIZE_T</a>&#160;</td>
207           <td class="paramname"><em>maxlenPerFrame</em>&#160;</td>
208         </tr>
209         <tr>
210           <td></td>
211           <td>)</td>
212           <td></td><td></td>
213         </tr>
214       </table>
215 </div><div class="memdoc">
216
217 <p>Send response data on aux transport. </p>
218 <dl class="params"><dt>Parameters</dt><dd>
219   <table class="params">
220     <tr><td class="paramdir">[in]</td><td class="paramname">istcp</td><td>true if tcp, false if udp </td></tr>
221     <tr><td class="paramdir">[in]</td><td class="paramname">auxtrans</td><td>available transport parameters </td></tr>
222     <tr><td class="paramdir">[in]</td><td class="paramname">cid</td><td>channel ID </td></tr>
223     <tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>sending data </td></tr>
224     <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>length of data </td></tr>
225     <tr><td class="paramdir">[in]</td><td class="paramname">maxlenPerFrame</td><td>maximum data length to send per frame </td></tr>
226   </table>
227   </dd>
228 </dl>
229
230 <p class="reference">References <a class="el" href="auxtrans__manager_8c.html#a1b2a6aa920175602327fffe3680d20a4">aux_streaming()</a>, <a class="el" href="auxtrans__manager_8c.html#a77b5d5af2adb2cfa7ec785b592fc4074">FCGI_stderr</a>, <a class="el" href="auxtrans__manager_8c.html#acfaceca38039d2821be9d5faca98d850">gene_auxresponse()</a>, and <a class="el" href="structauxtrans__param.html#a0d6b0229459be4a4d7b755126fd64b2a">auxtrans_param::tcplistensock</a>.</p>
231
232 </div>
233 </div>
234 </div><!-- contents -->
235 <!-- start footer part -->
236 <hr class="footer"/><address class="footer"><small>
237 Generated by &#160;<a href="http://www.doxygen.org/index.html">
238 <img class="footer" src="doxygen.png" alt="doxygen"/>
239 </a> 1.8.17
240 </small></address>
241 </body>
242 </html>