INSA/dumber
1
0
Fork 0
mirror of https://github.com/yoboujon/dumber.git synced 2025-06-09 14:20:50 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions
dumber/software/raspberry/superviseur-robot/lib/doc/html/server_8h.html

441 lines
20 KiB
HTML
Raw Blame History

<!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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Bibliotheques TP RT: server.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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.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="projectlogo"><img alt="Logo" src="robot-icon.resized.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Bibliotheques TP RT
&#160;<span id="projectnumber">1.0</span>
</div>
<div id="projectbrief">Bibliotheque de support pour TP/RT</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('server_8h.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">server.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Library for opening a TCP server, receiving data and sending message to monitor.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;<a class="el" href="image_8h_source.html">image.h</a>&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for server.h:</div>
<div class="dyncontent">
<div class="center"><img src="server_8h__incl.png" border="0" usemap="#server_8h" alt=""/></div>
<map name="server_8h" id="server_8h">
<area shape="rect" id="node2" href="image_8h.html" title="Functions for image treatment. " alt="" coords="335,80,403,107"/>
</map>
</div>
</div>
<p><a href="server_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="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:af257e2a3e091629829857a2eb8931a7a"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="server_8h.html#af257e2a3e091629829857a2eb8931a7a">DEFAULT_SERVER_PORT</a>&#160;&#160;&#160;2323</td></tr>
<tr class="separator:af257e2a3e091629829857a2eb8931a7a"><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:a99b54d5b3404766f906f49605a4aa0e3"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="server_8h.html#a99b54d5b3404766f906f49605a4aa0e3">openServer</a> (int port)</td></tr>
<tr class="memdesc:a99b54d5b3404766f906f49605a4aa0e3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Open server port, connect and listen to given port. <a href="#a99b54d5b3404766f906f49605a4aa0e3">More...</a><br /></td></tr>
<tr class="separator:a99b54d5b3404766f906f49605a4aa0e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab65b2df50051036defe0f35366f5a3d6"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="server_8h.html#ab65b2df50051036defe0f35366f5a3d6">closeServer</a> ()</td></tr>
<tr class="memdesc:ab65b2df50051036defe0f35366f5a3d6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Close server. <a href="#ab65b2df50051036defe0f35366f5a3d6">More...</a><br /></td></tr>
<tr class="separator:ab65b2df50051036defe0f35366f5a3d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abff9f8e931ecce919588b371dc511857"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="server_8h.html#abff9f8e931ecce919588b371dc511857">acceptClient</a> ()</td></tr>
<tr class="memdesc:abff9f8e931ecce919588b371dc511857"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wait for a client to connect. <a href="#abff9f8e931ecce919588b371dc511857">More...</a><br /></td></tr>
<tr class="separator:abff9f8e931ecce919588b371dc511857"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8d865d29914b980fd71ed8d347e4ec50"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="server_8h.html#a8d865d29914b980fd71ed8d347e4ec50">sendDataToServer</a> (char *data, int length)</td></tr>
<tr class="memdesc:a8d865d29914b980fd71ed8d347e4ec50"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send given data to monitor. <a href="#a8d865d29914b980fd71ed8d347e4ec50">More...</a><br /></td></tr>
<tr class="separator:a8d865d29914b980fd71ed8d347e4ec50"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4c2df7961aa7379ac79d80980a1c537b"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="server_8h.html#a4c2df7961aa7379ac79d80980a1c537b">sendDataToServerForClient</a> (int client, char *data, int length)</td></tr>
<tr class="memdesc:a4c2df7961aa7379ac79d80980a1c537b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send given data to monitor, using specific client ID. <a href="#a4c2df7961aa7379ac79d80980a1c537b">More...</a><br /></td></tr>
<tr class="separator:a4c2df7961aa7379ac79d80980a1c537b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8b66a2007f3f9ed8538428a309c9d368"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="server_8h.html#a8b66a2007f3f9ed8538428a309c9d368">receiveDataFromServer</a> (char *data, int size)</td></tr>
<tr class="memdesc:a8b66a2007f3f9ed8538428a309c9d368"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read data from monitor. <a href="#a8b66a2007f3f9ed8538428a309c9d368">More...</a><br /></td></tr>
<tr class="separator:a8b66a2007f3f9ed8538428a309c9d368"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a247e0124af257d0cc7abc25a7c448d1b"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="server_8h.html#a247e0124af257d0cc7abc25a7c448d1b">receiveDataFromServerFromClient</a> (int client, char *data, int size)</td></tr>
<tr class="memdesc:a247e0124af257d0cc7abc25a7c448d1b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read data from monitor, using specific client ID. <a href="#a247e0124af257d0cc7abc25a7c448d1b">More...</a><br /></td></tr>
<tr class="separator:a247e0124af257d0cc7abc25a7c448d1b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a51b9372f5467705aa81d76ae034c7628"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="server_8h.html#a51b9372f5467705aa81d76ae034c7628">sendImage</a> (<a class="el" href="image_8h.html#a9ac2855e21920c676a108df386ff9415">Jpg</a> *image)</td></tr>
<tr class="memdesc:a51b9372f5467705aa81d76ae034c7628"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send image to monitor using default client ID. <a href="#a51b9372f5467705aa81d76ae034c7628">More...</a><br /></td></tr>
<tr class="separator:a51b9372f5467705aa81d76ae034c7628"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Library for opening a TCP server, receiving data and sending message to monitor. </p>
<dl class="section author"><dt>Author</dt><dd>PE.Hladik </dd></dl>
<dl class="section version"><dt>Version</dt><dd>1.0 </dd></dl>
<dl class="section date"><dt>Date</dt><dd>06/06/2017 </dd></dl>
<p class="definition">Definition in file <a class="el" href="server_8h_source.html">server.h</a>.</p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="af257e2a3e091629829857a2eb8931a7a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af257e2a3e091629829857a2eb8931a7a">&#9670;&nbsp;</a></span>DEFAULT_SERVER_PORT</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define DEFAULT_SERVER_PORT&#160;&#160;&#160;2323</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="server_8h_source.html#l00030">30</a> of file <a class="el" href="server_8h_source.html">server.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="abff9f8e931ecce919588b371dc511857"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abff9f8e931ecce919588b371dc511857">&#9670;&nbsp;</a></span>acceptClient()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int acceptClient </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Wait for a client to connect. </p>
<dl class="section return"><dt>Returns</dt><dd>Return client Id or -1 if it failed </dd></dl>
</div>
</div>
<a id="ab65b2df50051036defe0f35366f5a3d6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab65b2df50051036defe0f35366f5a3d6">&#9670;&nbsp;</a></span>closeServer()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int closeServer </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Close server. </p>
<dl class="section return"><dt>Returns</dt><dd>-1 if closing failed , 0 otherwise </dd></dl>
</div>
</div>
<a id="a99b54d5b3404766f906f49605a4aa0e3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a99b54d5b3404766f906f49605a4aa0e3">&#9670;&nbsp;</a></span>openServer()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int openServer </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>port</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Open server port, connect and listen to given port. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">port</td><td>A valid port number (1024 - 65535) </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>-1 if opening failed or the socket number </dd></dl>
</div>
</div>
<a id="a8b66a2007f3f9ed8538428a309c9d368"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8b66a2007f3f9ed8538428a309c9d368">&#9670;&nbsp;</a></span>receiveDataFromServer()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int receiveDataFromServer </td>
<td>(</td>
<td class="paramtype">char *&#160;</td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>size</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Read data from monitor. </p>
<p>Read, at most, size data from monitor. Data must be a valid pointer to a buffer large enough.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>A valid pointer to a buffer </td></tr>
<tr><td class="paramname">size</td><td>Amount of data to read </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Return amount of data really received. 0 if communication is broken </dd></dl>
</div>
</div>
<a id="a247e0124af257d0cc7abc25a7c448d1b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a247e0124af257d0cc7abc25a7c448d1b">&#9670;&nbsp;</a></span>receiveDataFromServerFromClient()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int receiveDataFromServerFromClient </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>client</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char *&#160;</td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>size</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Read data from monitor, using specific client ID. </p>
<p>Read, at most, size data from monitor. Data must be a valid pointer to a buffer large enough.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">client</td><td>Client Id to receive from </td></tr>
<tr><td class="paramname">data</td><td>A valid pointer to a buffer </td></tr>
<tr><td class="paramname">size</td><td>Amount of data to read </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Return amount of data really received. 0 if communication is broken </dd></dl>
</div>
</div>
<a id="a8d865d29914b980fd71ed8d347e4ec50"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8d865d29914b980fd71ed8d347e4ec50">&#9670;&nbsp;</a></span>sendDataToServer()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int sendDataToServer </td>
<td>(</td>
<td class="paramtype">char *&#160;</td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>length</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Send given data to monitor. </p>
<p>Send given data to monitor using default client ID</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>A valid pointer to a buffer </td></tr>
<tr><td class="paramname">length</td><td>Amount of data to send </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Return amount of data really written. 0 if communication is broken </dd></dl>
</div>
</div>
<a id="a4c2df7961aa7379ac79d80980a1c537b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4c2df7961aa7379ac79d80980a1c537b">&#9670;&nbsp;</a></span>sendDataToServerForClient()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int sendDataToServerForClient </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>client</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char *&#160;</td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>length</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Send given data to monitor, using specific client ID. </p>
<p>Send given data to monitor using given client ID.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">client</td><td>Client Id to send data to </td></tr>
<tr><td class="paramname">data</td><td>A valid pointer to a buffer </td></tr>
<tr><td class="paramname">length</td><td>Amount of data to send </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Return amount of data really written. 0 if communication is broken </dd></dl>
</div>
</div>
<a id="a51b9372f5467705aa81d76ae034c7628"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a51b9372f5467705aa81d76ae034c7628">&#9670;&nbsp;</a></span>sendImage()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int sendImage </td>
<td>(</td>
<td class="paramtype"><a class="el" href="image_8h.html#a9ac2855e21920c676a108df386ff9415">Jpg</a> *&#160;</td>
<td class="paramname"><em>image</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Send image to monitor using default client ID. </p>
<p>Convert image to raw data, and add correct header before sending to monitor</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">image</td><td>An image object after compression </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Return amount of data really received. 0 if communication is broken </dd></dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="server_8h.html">server.h</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink