Update doxygen for release 2.3.1
[openjpeg.git] / doxygen / sock__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.13"/>
7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
8 <title>OpenJPEG: sock_manager.h Source File</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="headertitle">
46 <div class="title">sock_manager.h</div>  </div>
47 </div><!--header-->
48 <div class="contents">
49 <a href="sock__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><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> * $Id$</span></div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> *</span></div><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><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><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"> * Copyright (c) 2010-2011, Kaori Hagihara</span></div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment"> * All rights reserved.</span></div><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment"> *</span></div><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><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><div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment"> * are met:</span></div><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><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><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><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><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><div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment"> *</span></div><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><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><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><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><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><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><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><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><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><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><div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="comment"> * POSSIBILITY OF SUCH DAMAGE.</span></div><div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;</div><div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;<span class="preprocessor">#ifndef     SOCK_MANAGER_H_</span></div><div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;<span class="preprocessor"># define    SOCK_MANAGER_H_</span></div><div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;</div><div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="byte__manager_8h.html">byte_manager.h</a>&quot;</span></div><div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="opj__stdint_8h.html">opj_stdint.h</a>&quot;</span></div><div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;</div><div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;<span class="preprocessor">#ifdef _WIN32</span></div><div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;<span class="preprocessor">#include &lt;winsock.h&gt;</span></div><div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;<span class="preprocessor">#else</span></div><div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="sock__manager_8h.html#a8dc8083897335125630f1af5dafd5831">   40</a></span>&#160;<span class="keyword">typedef</span> <span class="keywordtype">int</span> <a class="code" href="sock__manager_8h.html#a8dc8083897335125630f1af5dafd5831">SOCKET</a>;</div><div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/*_WIN32*/</span><span class="preprocessor"></span></div><div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;</div><div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="sock__manager_8h.html#a8b5839f71a3b6e7d64b2d5e9967e3dd1">   43</a></span>&#160;<span class="preprocessor">#define BUF_LEN 256</span></div><div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;</div><div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;<a class="code" href="sock__manager_8h.html#a8dc8083897335125630f1af5dafd5831">SOCKET</a> <a class="code" href="sock__manager_8h.html#a3c822e28c71631b25683cc57e8e4536b">open_listeningsocket</a>(uint16_t port);</div><div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;</div><div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;<a class="code" href="sock__manager_8h.html#a8dc8083897335125630f1af5dafd5831">SOCKET</a> <a class="code" href="sock__manager_8h.html#a792461126a522ddf1db31e7353c055d8">accept_socket</a>(<a class="code" href="sock__manager_8h.html#a8dc8083897335125630f1af5dafd5831">SOCKET</a> listening_socket);</div><div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;</div><div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;</div><div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;<a class="code" href="openjpeg_8h.html#aba7397be054e36dc0284a6589736135e">OPJ_SIZE_T</a> <a class="code" href="sock__manager_8h.html#aed57d59576e34d348c940f59f9d6a286">receive_line</a>(<a class="code" href="sock__manager_8h.html#a8dc8083897335125630f1af5dafd5831">SOCKET</a> connected_socket, <span class="keywordtype">char</span> *buf);</div><div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;</div><div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;<span class="keywordtype">char</span> * <a class="code" href="sock__manager_8h.html#a0257a018729bc73d0ccc970069a6352c">receive_string</a>(<a class="code" href="sock__manager_8h.html#a8dc8083897335125630f1af5dafd5831">SOCKET</a> connected_socket);</div><div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;</div><div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;<span class="keywordtype">void</span> * <a class="code" href="sock__manager_8h.html#aaeac7207dae4f03273607ba021530da6">receive_stream</a>(<a class="code" href="sock__manager_8h.html#a8dc8083897335125630f1af5dafd5831">SOCKET</a> connected_socket, <a class="code" href="openjpeg_8h.html#aba7397be054e36dc0284a6589736135e">OPJ_SIZE_T</a> length);</div><div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;</div><div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;<span class="keywordtype">void</span> <a class="code" href="sock__manager_8h.html#a7f5fb3b9c22e70ba6e82ca5560d98cc5">send_stream</a>(<a class="code" href="sock__manager_8h.html#a8dc8083897335125630f1af5dafd5831">SOCKET</a> connected_socket, <span class="keyword">const</span> <span class="keywordtype">void</span> *stream,</div><div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;                 <a class="code" href="openjpeg_8h.html#aba7397be054e36dc0284a6589736135e">OPJ_SIZE_T</a> length);</div><div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;</div><div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;<span class="keywordtype">int</span> <a class="code" href="sock__manager_8h.html#af35003e15c5a408a198d4b3eb717bfdd">close_socket</a>(<a class="code" href="sock__manager_8h.html#a8dc8083897335125630f1af5dafd5831">SOCKET</a> sock);</div><div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;</div><div class="line"><a name="l00106"></a><span class="lineno">  106</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* !SOCK_MANAGER_H_ */</span><span class="preprocessor"></span></div><div class="ttc" id="opj__stdint_8h_html"><div class="ttname"><a href="opj__stdint_8h.html">opj_stdint.h</a></div></div>
50 <div class="ttc" id="sock__manager_8h_html_a3c822e28c71631b25683cc57e8e4536b"><div class="ttname"><a href="sock__manager_8h.html#a3c822e28c71631b25683cc57e8e4536b">open_listeningsocket</a></div><div class="ttdeci">SOCKET open_listeningsocket(uint16_t port)</div><div class="ttdoc">open listening socket </div><div class="ttdef"><b>Definition:</b> sock_manager.c:57</div></div>
51 <div class="ttc" id="sock__manager_8h_html_a0257a018729bc73d0ccc970069a6352c"><div class="ttname"><a href="sock__manager_8h.html#a0257a018729bc73d0ccc970069a6352c">receive_string</a></div><div class="ttdeci">char * receive_string(SOCKET connected_socket)</div><div class="ttdoc">receive a string line (ending with &amp;#39; &amp;#39;) from client, return malloc string </div><div class="ttdef"><b>Definition:</b> sock_manager.c:169</div></div>
52 <div class="ttc" id="sock__manager_8h_html_a7f5fb3b9c22e70ba6e82ca5560d98cc5"><div class="ttname"><a href="sock__manager_8h.html#a7f5fb3b9c22e70ba6e82ca5560d98cc5">send_stream</a></div><div class="ttdeci">void send_stream(SOCKET connected_socket, const void *stream, OPJ_SIZE_T length)</div><div class="ttdoc">send data stream to client </div><div class="ttdef"><b>Definition:</b> sock_manager.c:104</div></div>
53 <div class="ttc" id="sock__manager_8h_html_aaeac7207dae4f03273607ba021530da6"><div class="ttname"><a href="sock__manager_8h.html#aaeac7207dae4f03273607ba021530da6">receive_stream</a></div><div class="ttdeci">void * receive_stream(SOCKET connected_socket, OPJ_SIZE_T length)</div><div class="ttdoc">receive data stream to client </div><div class="ttdef"><b>Definition:</b> sock_manager.c:120</div></div>
54 <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>
55 <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>
56 <div class="ttc" id="sock__manager_8h_html_aed57d59576e34d348c940f59f9d6a286"><div class="ttname"><a href="sock__manager_8h.html#aed57d59576e34d348c940f59f9d6a286">receive_line</a></div><div class="ttdeci">OPJ_SIZE_T receive_line(SOCKET connected_socket, char *buf)</div><div class="ttdoc">receive a string line (ending with &amp;#39; &amp;#39;) from client </div><div class="ttdef"><b>Definition:</b> sock_manager.c:142</div></div>
57 <div class="ttc" id="sock__manager_8h_html_af35003e15c5a408a198d4b3eb717bfdd"><div class="ttname"><a href="sock__manager_8h.html#af35003e15c5a408a198d4b3eb717bfdd">close_socket</a></div><div class="ttdeci">int close_socket(SOCKET sock)</div><div class="ttdoc">close socket </div><div class="ttdef"><b>Definition:</b> sock_manager.c:180</div></div>
58 <div class="ttc" id="sock__manager_8h_html_a792461126a522ddf1db31e7353c055d8"><div class="ttname"><a href="sock__manager_8h.html#a792461126a522ddf1db31e7353c055d8">accept_socket</a></div><div class="ttdeci">SOCKET accept_socket(SOCKET listening_socket)</div><div class="ttdoc">accept a new connection to the listenning socket </div><div class="ttdef"><b>Definition:</b> sock_manager.c:96</div></div>
59 <div class="ttc" id="byte__manager_8h_html"><div class="ttname"><a href="byte__manager_8h.html">byte_manager.h</a></div></div>
60 </div><!-- fragment --></div><!-- contents -->
61 <!-- start footer part -->
62 <hr class="footer"/><address class="footer"><small>
63 Generated by &#160;<a href="http://www.doxygen.org/index.html">
64 <img class="footer" src="doxygen.png" alt="doxygen"/>
65 </a> 1.8.13
66 </small></address>
67 </body>
68 </html>