492 lines
23 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.5"/>
<title>My Project: mainReceiver.cpp 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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</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 style="padding-left: 0.5em;">
<div id="projectname">My Project
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</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>File&#160;Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Macros</a></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><!-- top -->
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">mainReceiver.cpp File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;sls_receiver_defs.h&quot;</code><br/>
<code>#include &quot;<a class="el" href="slsReceiverUsers_8h_source.html">slsReceiverUsers.h</a>&quot;</code><br/>
<code>#include &lt;iostream&gt;</code><br/>
<code>#include &lt;string.h&gt;</code><br/>
<code>#include &lt;signal.h&gt;</code><br/>
<code>#include &lt;cstdlib&gt;</code><br/>
<code>#include &lt;sys/types.h&gt;</code><br/>
<code>#include &lt;sys/wait.h&gt;</code><br/>
<code>#include &lt;string&gt;</code><br/>
<code>#include &lt;unistd.h&gt;</code><br/>
<code>#include &lt;errno.h&gt;</code><br/>
<code>#include &lt;syscall.h&gt;</code><br/>
</div>
<p><a href="mainReceiver_8cpp_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:aeac6a4b86729a7e07100fb58600d6481"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mainReceiver_8cpp.html#aeac6a4b86729a7e07100fb58600d6481">PRINT_IN_COLOR</a>(c, f,...)&#160;&#160;&#160;printf (&quot;\033[%dm&quot; f RESET, 30 + c+1, ##__VA_ARGS__)</td></tr>
<tr class="separator:aeac6a4b86729a7e07100fb58600d6481"><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:ac72dad9b593583bd4bf508a979c00f70"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mainReceiver_8cpp.html#ac72dad9b593583bd4bf508a979c00f70">sigInterruptHandler</a> (int p)</td></tr>
<tr class="separator:ac72dad9b593583bd4bf508a979c00f70"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0d20b69b0ad703df78459e1033d5c1d4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mainReceiver_8cpp.html#a0d20b69b0ad703df78459e1033d5c1d4">printHelp</a> ()</td></tr>
<tr class="separator:a0d20b69b0ad703df78459e1033d5c1d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1ec49915ff49957985ebfe6ccc5cd1b3"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mainReceiver_8cpp.html#a1ec49915ff49957985ebfe6ccc5cd1b3">StartAcq</a> (char *filepath, char *filename, uint64_t fileindex, uint32_t datasize, void *p)</td></tr>
<tr class="separator:a1ec49915ff49957985ebfe6ccc5cd1b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a013a16dd72eca4216a42196c4d9c0335"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mainReceiver_8cpp.html#a013a16dd72eca4216a42196c4d9c0335">AcquisitionFinished</a> (uint64_t frames, void *p)</td></tr>
<tr class="separator:a013a16dd72eca4216a42196c4d9c0335"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a009e34ab0d3ebfcf32f4421a2b462311"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mainReceiver_8cpp.html#a009e34ab0d3ebfcf32f4421a2b462311">GetData</a> (char *metadata, char *datapointer, uint32_t datasize, void *p)</td></tr>
<tr class="separator:a009e34ab0d3ebfcf32f4421a2b462311"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8e11c5abfd4b3684eef27775aac7071e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mainReceiver_8cpp.html#a8e11c5abfd4b3684eef27775aac7071e">GetData</a> (char *metadata, char *datapointer, uint32_t &amp;revDatasize, void *p)</td></tr>
<tr class="separator:a8e11c5abfd4b3684eef27775aac7071e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0ddf1224851353fc92bfbff6f499fa97"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mainReceiver_8cpp.html#a0ddf1224851353fc92bfbff6f499fa97">main</a> (int argc, char *argv[])</td></tr>
<tr class="separator:a0ddf1224851353fc92bfbff6f499fa97"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a0d26a166bb416ff34512de6fe9e098bd"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mainReceiver_8cpp.html#a0d26a166bb416ff34512de6fe9e098bd">keeprunning</a></td></tr>
<tr class="separator:a0d26a166bb416ff34512de6fe9e098bd"><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>This file is an example of how to implement the <a class="el" href="classslsReceiverUsers.html" title="Class for implementing the SLS data receiver in the users application. Callbacks can be defined for p...">slsReceiverUsers</a> class You can compile it linking it to the slsReceiver library</p>
<p>g++ <a class="el" href="mainReceiver_8cpp.html">mainReceiver.cpp</a> -L lib -lSlsReceiver -L/usr/lib64/ -L lib2 -lzmq -pthread -lrt -lm -lstdc++</p>
<p>where,</p>
<p>lib is the location of lSlsReceiver.so</p>
<p>lib2 is the location of the libzmq.a. [ libzmq.a is required only when using data call backs and enabling data streaming from receiver to client. It is linked in manual/manual-api from slsReceiverSoftware/include ] </p>
<p>Definition in file <a class="el" href="mainReceiver_8cpp_source.html">mainReceiver.cpp</a>.</p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="aeac6a4b86729a7e07100fb58600d6481"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PRINT_IN_COLOR</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">c, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">f, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>...</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>&#160;&#160;&#160;printf (&quot;\033[%dm&quot; f RESET, 30 + c+1, ##__VA_ARGS__)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Define Colors to print data call back in different colors for different recievers </p>
<p>Definition at line <a class="el" href="mainReceiver_8cpp_source.html#l00038">38</a> of file <a class="el" href="mainReceiver_8cpp_source.html">mainReceiver.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a013a16dd72eca4216a42196c4d9c0335"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void AcquisitionFinished </td>
<td>(</td>
<td class="paramtype">uint64_t&#160;</td>
<td class="paramname"><em>frames</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>p</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Acquisition Finished Call back </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">frames</td><td>Number of frames caught </td></tr>
<tr><td class="paramname">p</td><td>pointer to object </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="mainReceiver_8cpp_source.html#l00085">85</a> of file <a class="el" href="mainReceiver_8cpp_source.html">mainReceiver.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a009e34ab0d3ebfcf32f4421a2b462311"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void GetData </td>
<td>(</td>
<td class="paramtype">char *&#160;</td>
<td class="paramname"><em>metadata</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char *&#160;</td>
<td class="paramname"><em>datapointer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>datasize</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>p</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get Receiver Data Call back Prints in different colors(for each receiver process) the different headers for each image call back. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">metadata</td><td>sls_receiver_header metadata </td></tr>
<tr><td class="paramname">datapointer</td><td>pointer to data </td></tr>
<tr><td class="paramname">datasize</td><td>data size in bytes. </td></tr>
<tr><td class="paramname">p</td><td>pointer to object </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="mainReceiver_8cpp_source.html#l00098">98</a> of file <a class="el" href="mainReceiver_8cpp_source.html">mainReceiver.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a8e11c5abfd4b3684eef27775aac7071e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void GetData </td>
<td>(</td>
<td class="paramtype">char *&#160;</td>
<td class="paramname"><em>metadata</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char *&#160;</td>
<td class="paramname"><em>datapointer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t &amp;&#160;</td>
<td class="paramname"><em>revDatasize</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>p</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get Receiver Data Call back (modified) Prints in different colors(for each receiver process) the different headers for each image call back. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">metadata</td><td>sls_receiver_header metadata </td></tr>
<tr><td class="paramname">datapointer</td><td>pointer to data </td></tr>
<tr><td class="paramname">datasize</td><td>data size in bytes. </td></tr>
<tr><td class="paramname">revDatasize</td><td>new data size in bytes after the callback. This will be the size written/streamed. (only smaller value is allowed). </td></tr>
<tr><td class="paramname">p</td><td>pointer to object </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="mainReceiver_8cpp_source.html#l00132">132</a> of file <a class="el" href="mainReceiver_8cpp_source.html">mainReceiver.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a0ddf1224851353fc92bfbff6f499fa97"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int main </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>argc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char *&#160;</td>
<td class="paramname"><em>argv</em>[]&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Example of main program using the <a class="el" href="classslsReceiverUsers.html" title="Class for implementing the SLS data receiver in the users application. Callbacks can be defined for p...">slsReceiverUsers</a> class</p>
<ul>
<li>Defines in file for:<ul>
<li>Default Number of receivers is 1</li>
<li>Default Start TCP port is 1954 </li>
</ul>
</li>
</ul>
<ul>
<li>set default values</li>
<li>get number of receivers and start tcp port from command line arguments</li>
<li>Catch signal SIGINT to close files and call destructors properly<ul>
<li>Ignore SIG_PIPE, prevents global signal handler, handle locally, instead of a server crashing due to client crash when writing, it just gives error</li>
</ul>
</li>
<li>loop over number of receivers</li>
<li>fork process to create child process</li>
<li>if fork failed, raise SIGINT and properly destroy all child processes</li>
<li>if child process</li>
<li>create <a class="el" href="classslsReceiverUsers.html" title="Class for implementing the SLS data receiver in the users application. Callbacks can be defined for p...">slsReceiverUsers</a> object with appropriate arguments <pre class="fragment"> - register callbacks. remember to set file write enable to 0 (using the client)
</pre> if we should not write files and you will write data using the callbacks</li>
<li>Call back for start acquisition</li>
<li>Call back for acquisition finished</li>
<li>start tcp server thread</li>
<li>as long as keeprunning is true (changes with Ctrl+C)</li>
<li>interrupt caught, delete <a class="el" href="classslsReceiverUsers.html" title="Class for implementing the SLS data receiver in the users application. Callbacks can be defined for p...">slsReceiverUsers</a> object and exit</li>
<li>Parent process ignores SIGINT (exits only when all child process exits)</li>
<li>Print Ready and Instructions how to exit</li>
<li>Parent process waits for all child processes to exit </li>
</ul>
<p>Definition at line <a class="el" href="mainReceiver_8cpp_source.html#l00167">167</a> of file <a class="el" href="mainReceiver_8cpp_source.html">mainReceiver.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a0d20b69b0ad703df78459e1033d5c1d4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void printHelp </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>prints usage of this example program </p>
<p>Definition at line <a class="el" href="mainReceiver_8cpp_source.html#l00055">55</a> of file <a class="el" href="mainReceiver_8cpp_source.html">mainReceiver.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ac72dad9b593583bd4bf508a979c00f70"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void sigInterruptHandler </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>p</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Control+C Interrupt Handler Sets the variable keeprunning to false, to let all the processes know to exit properly </p>
<p>Definition at line <a class="el" href="mainReceiver_8cpp_source.html#l00048">48</a> of file <a class="el" href="mainReceiver_8cpp_source.html">mainReceiver.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a1ec49915ff49957985ebfe6ccc5cd1b3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int StartAcq </td>
<td>(</td>
<td class="paramtype">char *&#160;</td>
<td class="paramname"><em>filepath</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char *&#160;</td>
<td class="paramname"><em>filename</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint64_t&#160;</td>
<td class="paramname"><em>fileindex</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>datasize</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>p</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Start Acquisition Call back slsReceiver writes data if file write enabled. Users get data to write using call back if registerCallBackRawDataReady is registered. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">filepath</td><td>file path </td></tr>
<tr><td class="paramname">filename</td><td>file name </td></tr>
<tr><td class="paramname">fileindex</td><td>file index </td></tr>
<tr><td class="paramname">datasize</td><td>data size in bytes </td></tr>
<tr><td class="paramname">p</td><td>pointer to object </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>ignored </dd></dl>
<p>Definition at line <a class="el" href="mainReceiver_8cpp_source.html#l00072">72</a> of file <a class="el" href="mainReceiver_8cpp_source.html">mainReceiver.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a class="anchor" id="a0d26a166bb416ff34512de6fe9e098bd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool keeprunning</td>
</tr>
</table>
</div><div class="memdoc">
<p>Variable is true to continue running, set to false upon interrupt </p>
<p>Definition at line <a class="el" href="mainReceiver_8cpp_source.html#l00042">42</a> of file <a class="el" href="mainReceiver_8cpp_source.html">mainReceiver.cpp</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.5
</small></address>
</body>
</html>