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.10"/>
   7 <title>OpenJPEG: auxtrans_manager.h File Reference</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="summary">
  52 <a href="#nested-classes">Data Structures</a> &#124;
  53 <a href="#typedef-members">Typedefs</a> &#124;
  54 <a href="#func-members">Functions</a>  </div>
  55   <div class="headertitle">
  56 <div class="title">auxtrans_manager.h File Reference</div>  </div>
  57 </div><!--header-->
  58 <div class="contents">
  59 <div class="textblock"><code>#include &quot;<a class="el" href="sock__manager_8h_source.html">sock_manager.h</a>&quot;</code><br />
  60 <code>#include &quot;<a class="el" href="opj__includes_8h_source.html">opj_includes.h</a>&quot;</code><br />
  61 </div>
  62 <p><a href="auxtrans__manager_8h_source.html">Go to the source code of this file.</a></p>
  63 <table class="memberdecls">
  64 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  65 Data Structures</h2></td></tr>
  66 <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>
  67 <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>
  68 <tr class="separator:"><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="typedef-members"></a>
  71 Typedefs</h2></td></tr>
  72 <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>
  73 <tr class="memdesc:a3a43df0d30b6082ba37b6129f3186263"><td class="mdescLeft">&#160;</td><td class="mdescRight">auxiliary transport setting parameters  <a href="#a3a43df0d30b6082ba37b6129f3186263">More...</a><br /></td></tr>
  74 <tr class="separator:a3a43df0d30b6082ba37b6129f3186263"><td class="memSeparator" colspan="2">&#160;</td></tr>
  75 </table><table class="memberdecls">
  76 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  77 Functions</h2></td></tr>
  78 <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>
  79 <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>
  80 <tr class="separator:a72e679f1d37899db4dec20b648c12ed9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81 <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>
  82 <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>
  83 <tr class="separator:aff6d8f931e99feb9cb30a4fc2540823d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84 <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>
  85 <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>
  86 <tr class="separator:af61f1523999a847b6e4ae90c5ce8b4bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87 </table>
  88 <h2 class="groupheader">Typedef Documentation</h2>
  89 <a class="anchor" id="a3a43df0d30b6082ba37b6129f3186263"></a>
  90 <div class="memitem">
  91 <div class="memproto">
  92       <table class="memname">
  93         <tr>
  94           <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>
  95         </tr>
  96       </table>
  97 </div><div class="memdoc">
  98
  99 <p>auxiliary transport setting parameters </p>
 100
 101 </div>
 102 </div>
 103 <h2 class="groupheader">Function Documentation</h2>
 104 <a class="anchor" id="aff6d8f931e99feb9cb30a4fc2540823d"></a>
 105 <div class="memitem">
 106 <div class="memproto">
 107       <table class="memname">
 108         <tr>
 109           <td class="memname">void close_aux_transport </td>
 110           <td>(</td>
 111           <td class="paramtype"><a class="el" href="auxtrans__manager_8h.html#a3a43df0d30b6082ba37b6129f3186263">auxtrans_param_t</a>&#160;</td>
 112           <td class="paramname"><em>auxtrans</em></td><td>)</td>
 113           <td></td>
 114         </tr>
 115       </table>
 116 </div><div class="memdoc">
 117
 118 <p>Close auxiliary transport server of JPIP server. </p>
 119 <dl class="params"><dt>Parameters</dt><dd>
 120   <table class="params">
 121     <tr><td class="paramdir">[in]</td><td class="paramname">auxtrans</td><td>closing transport server</td></tr>
 122   </table>
 123   </dd>
 124 </dl>
 125 <p>auxiliary response parameters </p>
 126
 127 <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>
 128
 129 </div>
 130 </div>
 131 <a class="anchor" id="a72e679f1d37899db4dec20b648c12ed9"></a>
 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>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 class="anchor" id="af61f1523999a847b6e4ae90c5ce8b4bf"></a>
 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#a3a43df0d30b6082ba37b6129f3186263">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>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.10
 240 </small></address>
 241 </body>
 242 </html>