doxygen/auxtrans__manager_8h.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: 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.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="summary">
  46 <a href="#nested-classes">Data Structures</a> &#124;
  47 <a href="#typedef-members">Typedefs</a> &#124;
  48 <a href="#func-members">Functions</a>  </div>
  49   <div class="headertitle">
  50 <div class="title">auxtrans_manager.h File Reference</div>  </div>
  51 </div><!--header-->
  52 <div class="contents">
  53 <div class="textblock"><code>#include &quot;<a class="el" href="sock__manager_8h_source.html">sock_manager.h</a>&quot;</code><br />
  54 <code>#include &quot;<a class="el" href="opj__includes_8h_source.html">opj_includes.h</a>&quot;</code><br />
  55 </div>
  56 <p><a href="auxtrans__manager_8h_source.html">Go to the source code of this file.</a></p>
  57 <table class="memberdecls">
  58 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  59 Data Structures</h2></td></tr>
  60 <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>
  61 <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>
  62 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  63 </table><table class="memberdecls">
  64 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
  65 Typedefs</h2></td></tr>
  66 <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>
  67 <tr class="memdesc:a3a43df0d30b6082ba37b6129f3186263"><td class="mdescLeft">&#160;</td><td class="mdescRight">auxiliary transport setting parameters  <a href="#a3a43df0d30b6082ba37b6129f3186263">More...</a><br /></td></tr>
  68 <tr class="separator:a3a43df0d30b6082ba37b6129f3186263"><td class="memSeparator" colspan="2">&#160;</td></tr>
  69 </table><table class="memberdecls">
  70 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  71 Functions</h2></td></tr>
  72 <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>
  73 <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>
  74 <tr class="separator:a72e679f1d37899db4dec20b648c12ed9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  75 <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>
  76 <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>
  77 <tr class="separator:aff6d8f931e99feb9cb30a4fc2540823d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78 <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>
  79 <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>
  80 <tr class="separator:af61f1523999a847b6e4ae90c5ce8b4bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81 </table>
  82 <h2 class="groupheader">Typedef Documentation</h2>
  83 <a id="a3a43df0d30b6082ba37b6129f3186263"></a>
  84 <h2 class="memtitle"><span class="permalink"><a href="#a3a43df0d30b6082ba37b6129f3186263">&#9670;&nbsp;</a></span>auxtrans_param_t</h2>
  85
  86 <div class="memitem">
  87 <div class="memproto">
  88       <table class="memname">
  89         <tr>
  90           <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>
  91         </tr>
  92       </table>
  93 </div><div class="memdoc">
  94
  95 <p>auxiliary transport setting parameters </p>
  96
  97 </div>
  98 </div>
  99 <h2 class="groupheader">Function Documentation</h2>
 100 <a id="aff6d8f931e99feb9cb30a4fc2540823d"></a>
 101 <h2 class="memtitle"><span class="permalink"><a href="#aff6d8f931e99feb9cb30a4fc2540823d">&#9670;&nbsp;</a></span>close_aux_transport()</h2>
 102
 103 <div class="memitem">
 104 <div class="memproto">
 105       <table class="memname">
 106         <tr>
 107           <td class="memname">void close_aux_transport </td>
 108           <td>(</td>
 109           <td class="paramtype"><a class="el" href="auxtrans__manager_8h.html#a3a43df0d30b6082ba37b6129f3186263">auxtrans_param_t</a>&#160;</td>
 110           <td class="paramname"><em>auxtrans</em></td><td>)</td>
 111           <td></td>
 112         </tr>
 113       </table>
 114 </div><div class="memdoc">
 115
 116 <p>Close auxiliary transport server of JPIP server. </p>
 117 <dl class="params"><dt>Parameters</dt><dd>
 118   <table class="params">
 119     <tr><td class="paramdir">[in]</td><td class="paramname">auxtrans</td><td>closing transport server</td></tr>
 120   </table>
 121   </dd>
 122 </dl>
 123 <p>auxiliary response parameters </p>
 124
 125 <p class="reference">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>
 126
 127 </div>
 128 </div>
 129 <a id="a72e679f1d37899db4dec20b648c12ed9"></a>
 130 <h2 class="memtitle"><span class="permalink"><a href="#a72e679f1d37899db4dec20b648c12ed9">&#9670;&nbsp;</a></span>init_aux_transport()</h2>
 131
 132 <div class="memitem">
 133 <div class="memproto">
 134       <table class="memname">
 135         <tr>
 136           <td class="memname"><a class="el" href="auxtrans__manager_8h.html#a3a43df0d30b6082ba37b6129f3186263">auxtrans_param_t</a> init_aux_transport </td>
 137           <td>(</td>
 138           <td class="paramtype">int&#160;</td>
 139           <td class="paramname"><em>tcp_auxport</em>, </td>
 140         </tr>
 141         <tr>
 142           <td class="paramkey"></td>
 143           <td></td>
 144           <td class="paramtype">int&#160;</td>
 145           <td class="paramname"><em>udp_auxport</em>&#160;</td>
 146         </tr>
 147         <tr>
 148           <td></td>
 149           <td>)</td>
 150           <td></td><td></td>
 151         </tr>
 152       </table>
 153 </div><div class="memdoc">
 154
 155 <p>Initialize auxiliary transport server of JPIP server. </p>
 156 <dl class="params"><dt>Parameters</dt><dd>
 157   <table class="params">
 158     <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>
 159     <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>
 160   </table>
 161   </dd>
 162 </dl>
 163 <dl class="section return"><dt>Returns</dt><dd>initialized transport parameters </dd></dl>
 164
 165 <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>
 166
 167 </div>
 168 </div>
 169 <a id="af61f1523999a847b6e4ae90c5ce8b4bf"></a>
 170 <h2 class="memtitle"><span class="permalink"><a href="#af61f1523999a847b6e4ae90c5ce8b4bf">&#9670;&nbsp;</a></span>send_responsedata_on_aux()</h2>
 171
 172 <div class="memitem">
 173 <div class="memproto">
 174       <table class="memname">
 175         <tr>
 176           <td class="memname">void send_responsedata_on_aux </td>
 177           <td>(</td>
 178           <td class="paramtype"><a class="el" href="openjpeg_8h.html#abb5dad6294f4611f1925388e919b16f4">OPJ_BOOL</a>&#160;</td>
 179           <td class="paramname"><em>istcp</em>, </td>
 180         </tr>
 181         <tr>
 182           <td class="paramkey"></td>
 183           <td></td>
 184           <td class="paramtype"><a class="el" href="auxtrans__manager_8h.html#a3a43df0d30b6082ba37b6129f3186263">auxtrans_param_t</a>&#160;</td>
 185           <td class="paramname"><em>auxtrans</em>, </td>
 186         </tr>
 187         <tr>
 188           <td class="paramkey"></td>
 189           <td></td>
 190           <td class="paramtype">const char&#160;</td>
 191           <td class="paramname"><em>cid</em>[], </td>
 192         </tr>
 193         <tr>
 194           <td class="paramkey"></td>
 195           <td></td>
 196           <td class="paramtype">void *&#160;</td>
 197           <td class="paramname"><em>data</em>, </td>
 198         </tr>
 199         <tr>
 200           <td class="paramkey"></td>
 201           <td></td>
 202           <td class="paramtype"><a class="el" href="openjpeg_8h.html#aba7397be054e36dc0284a6589736135e">OPJ_SIZE_T</a>&#160;</td>
 203           <td class="paramname"><em>length</em>, </td>
 204         </tr>
 205         <tr>
 206           <td class="paramkey"></td>
 207           <td></td>
 208           <td class="paramtype"><a class="el" href="openjpeg_8h.html#aba7397be054e36dc0284a6589736135e">OPJ_SIZE_T</a>&#160;</td>
 209           <td class="paramname"><em>maxlenPerFrame</em>&#160;</td>
 210         </tr>
 211         <tr>
 212           <td></td>
 213           <td>)</td>
 214           <td></td><td></td>
 215         </tr>
 216       </table>
 217 </div><div class="memdoc">
 218
 219 <p>Send response data on aux transport. </p>
 220 <dl class="params"><dt>Parameters</dt><dd>
 221   <table class="params">
 222     <tr><td class="paramdir">[in]</td><td class="paramname">istcp</td><td>true if tcp, false if udp </td></tr>
 223     <tr><td class="paramdir">[in]</td><td class="paramname">auxtrans</td><td>available transport parameters </td></tr>
 224     <tr><td class="paramdir">[in]</td><td class="paramname">cid</td><td>channel ID </td></tr>
 225     <tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>sending data </td></tr>
 226     <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>length of data </td></tr>
 227     <tr><td class="paramdir">[in]</td><td class="paramname">maxlenPerFrame</td><td>maximum data length to send per frame </td></tr>
 228   </table>
 229   </dd>
 230 </dl>
 231
 232 <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>
 233
 234 </div>
 235 </div>
 236 </div><!-- contents -->
 237 <!-- start footer part -->
 238 <hr class="footer"/><address class="footer"><small>
 239 Generated by &#160;<a href="http://www.doxygen.org/index.html">
 240 <img class="footer" src="doxygen.png" alt="doxygen"/>
 241 </a> 1.8.13
 242 </small></address>
 243 </body>
 244 </html>