openjpeg/doxygen/auxtrans__manager_8h.html

243 lines
14 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>OpenJPEG: auxtrans_manager.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">OpenJPEG
&#160;<span id="projectnumber">2.4.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&#160;List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<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>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">auxtrans_manager.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;<a class="el" href="sock__manager_8h_source.html">sock_manager.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="opj__includes_8h_source.html">opj_includes.h</a>&quot;</code><br />
</div>
<p><a href="auxtrans__manager_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<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>
<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>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a3a43df0d30b6082ba37b6129f3186263"><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#a3a43df0d30b6082ba37b6129f3186263">auxtrans_param_t</a></td></tr>
<tr class="memdesc:a3a43df0d30b6082ba37b6129f3186263"><td class="mdescLeft">&#160;</td><td class="mdescRight">auxiliary transport setting parameters <a href="#a3a43df0d30b6082ba37b6129f3186263">More...</a><br /></td></tr>
<tr class="separator:a3a43df0d30b6082ba37b6129f3186263"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a72e679f1d37899db4dec20b648c12ed9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="auxtrans__manager_8h.html#a3a43df0d30b6082ba37b6129f3186263">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>
<tr class="memdesc:a72e679f1d37899db4dec20b648c12ed9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize auxiliary transport server of JPIP server. <a href="#a72e679f1d37899db4dec20b648c12ed9">More...</a><br /></td></tr>
<tr class="separator:a72e679f1d37899db4dec20b648c12ed9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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#a3a43df0d30b6082ba37b6129f3186263">auxtrans_param_t</a> auxtrans)</td></tr>
<tr class="memdesc:aff6d8f931e99feb9cb30a4fc2540823d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Close auxiliary transport server of JPIP server. <a href="#aff6d8f931e99feb9cb30a4fc2540823d">More...</a><br /></td></tr>
<tr class="separator:aff6d8f931e99feb9cb30a4fc2540823d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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#a3a43df0d30b6082ba37b6129f3186263">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>
<tr class="memdesc:af61f1523999a847b6e4ae90c5ce8b4bf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send response data on aux transport. <a href="#af61f1523999a847b6e4ae90c5ce8b4bf">More...</a><br /></td></tr>
<tr class="separator:af61f1523999a847b6e4ae90c5ce8b4bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="a3a43df0d30b6082ba37b6129f3186263"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structauxtrans__param.html">auxtrans_param</a> <a class="el" href="auxtrans__manager_8h.html#a3a43df0d30b6082ba37b6129f3186263">auxtrans_param_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>auxiliary transport setting parameters </p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="aff6d8f931e99feb9cb30a4fc2540823d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void close_aux_transport </td>
<td>(</td>
<td class="paramtype"><a class="el" href="auxtrans__manager_8h.html#a3a43df0d30b6082ba37b6129f3186263">auxtrans_param_t</a>&#160;</td>
<td class="paramname"><em>auxtrans</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Close auxiliary transport server of JPIP server. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">auxtrans</td><td>closing transport server</td></tr>
</table>
</dd>
</dl>
<p>auxiliary response parameters </p>
<p>References <a class="el" href="sock__manager_8c.html#af35003e15c5a408a198d4b3eb717bfdd">close_socket()</a>, <a class="el" href="structauxtrans__param.html#a0d6b0229459be4a4d7b755126fd64b2a">auxtrans_param::tcplistensock</a>, and <a class="el" href="structauxtrans__param.html#af05ae7e0e02361a75ff018aa04a86ff2">auxtrans_param::udplistensock</a>.</p>
</div>
</div>
<a class="anchor" id="a72e679f1d37899db4dec20b648c12ed9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="auxtrans__manager_8h.html#a3a43df0d30b6082ba37b6129f3186263">auxtrans_param_t</a> init_aux_transport </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>tcp_auxport</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>udp_auxport</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize auxiliary transport server of JPIP server. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<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>
<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>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>initialized transport parameters </dd></dl>
<p>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>
</div>
</div>
<a class="anchor" id="af61f1523999a847b6e4ae90c5ce8b4bf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void send_responsedata_on_aux </td>
<td>(</td>
<td class="paramtype"><a class="el" href="openjpeg_8h.html#abb5dad6294f4611f1925388e919b16f4">OPJ_BOOL</a>&#160;</td>
<td class="paramname"><em>istcp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="auxtrans__manager_8h.html#a3a43df0d30b6082ba37b6129f3186263">auxtrans_param_t</a>&#160;</td>
<td class="paramname"><em>auxtrans</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char&#160;</td>
<td class="paramname"><em>cid</em>[], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="openjpeg_8h.html#aba7397be054e36dc0284a6589736135e">OPJ_SIZE_T</a>&#160;</td>
<td class="paramname"><em>length</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="openjpeg_8h.html#aba7397be054e36dc0284a6589736135e">OPJ_SIZE_T</a>&#160;</td>
<td class="paramname"><em>maxlenPerFrame</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Send response data on aux transport. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">istcp</td><td>true if tcp, false if udp </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">auxtrans</td><td>available transport parameters </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">cid</td><td>channel ID </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>sending data </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>length of data </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">maxlenPerFrame</td><td>maximum data length to send per frame </td></tr>
</table>
</dd>
</dl>
<p>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>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>