-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathreceiver.html
307 lines (192 loc) · 14.7 KB
/
receiver.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Receiver — slsDetectorPackage documentation</title>
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/extra.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> slsDetectorPackage
</a>
<div class="version">
5.0.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">Installation:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="dependencies.html">Dependencies</a></li>
<li class="toctree-l1"><a class="reference internal" href="consuming.html">Consuming slsDetectorPackage</a></li>
</ul>
<p class="caption"><span class="caption-text">C++ API</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="detector.html">Detector</a></li>
<li class="toctree-l1"><a class="reference internal" href="result.html">Result</a></li>
<li class="toctree-l1"><a class="reference internal" href="receiver_api.html">Receiver</a></li>
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li>
</ul>
<p class="caption"><span class="caption-text">Python API</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="pygettingstarted.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="pydetector.html">Detector</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyenums.html">Enums</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyexamples.html">Examples</a></li>
</ul>
<p class="caption"><span class="caption-text">Command line</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="commandline.html">Command line interface</a></li>
<li class="toctree-l1"><a class="reference internal" href="quick_start_guide.html">Quick Start Guide</a></li>
</ul>
<p class="caption"><span class="caption-text">Developer</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="container_utils.html">ContainerUtils</a></li>
<li class="toctree-l1"><a class="reference internal" href="type_traits.html">TypeTraits</a></li>
<li class="toctree-l1"><a class="reference internal" href="ToString.html">ToString</a></li>
</ul>
<p class="caption"><span class="caption-text">Firmware</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="firmware.html">Firmware Upgrade</a></li>
</ul>
<p class="caption"><span class="caption-text">Detector Server</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="servers.html">Detector Servers</a></li>
<li class="toctree-l1"><a class="reference internal" href="serverupgrade.html">Detector Server Upgrade</a></li>
<li class="toctree-l1"><a class="reference internal" href="virtualserver.html">Detector Simulators</a></li>
<li class="toctree-l1"><a class="reference internal" href="serverdefaults.html">Default Values</a></li>
</ul>
<p class="caption"><span class="caption-text">Troubleshooting</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">slsDetectorPackage</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> »</li>
<li>Receiver</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/receiver.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="receiver">
<h1>Receiver<a class="headerlink" href="#receiver" title="Permalink to this headline">¶</a></h1>
<dl class="class">
<dt id="_CPPv48Receiver">
<span id="_CPPv38Receiver"></span><span id="_CPPv28Receiver"></span><span id="Receiver"></span><span class="target" id="classReceiver"></span><em class="property">class </em><code class="sig-name descname">Receiver</code> : <em class="property">private</em> <em class="property">virtual</em> slsDetectorDefs<a class="headerlink" href="#_CPPv48Receiver" title="Permalink to this definition">¶</a><br /></dt>
<dd><div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
<dt id="_CPPv4N8Receiver8ReceiverEiA_Pc">
<span id="_CPPv3N8Receiver8ReceiverEiA_Pc"></span><span id="_CPPv2N8Receiver8ReceiverEiA_Pc"></span><span id="Receiver::Receiver__i.cPA"></span><span class="target" id="classReceiver_1a026a2cd1f0ad8a01ff43b29613a8701a"></span><code class="sig-name descname">Receiver</code><span class="sig-paren">(</span>int <em>argc</em>, char *<em>argv</em>[]<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N8Receiver8ReceiverEiA_Pc" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Constructor Starts up a <a class="reference internal" href="receiver_api.html#classReceiver"><span class="std std-ref">Receiver</span></a> server. Reads configuration file, options, and assembles a <a class="reference internal" href="receiver_api.html#classReceiver"><span class="std std-ref">Receiver</span></a> using TCP and UDP detector interfaces throws an exception in case of failure <dl class="simple">
<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
<li><p><code class="docutils literal notranslate"><span class="pre">argc</span></code>: from command line </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">argv</span></code>: from command line </p></li>
</ul>
</dd>
</dl>
</p>
</dd></dl>
<dl class="function">
<dt id="_CPPv4N8Receiver8ReceiverEi">
<span id="_CPPv3N8Receiver8ReceiverEi"></span><span id="_CPPv2N8Receiver8ReceiverEi"></span><span id="Receiver::Receiver__i"></span><span class="target" id="classReceiver_1a1a4b5b8e113f50c9862df60394babca0"></span><code class="sig-name descname">Receiver</code><span class="sig-paren">(</span>int <em>tcpip_port_no</em> = 1954<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N8Receiver8ReceiverEi" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Constructor Starts up a <a class="reference internal" href="receiver_api.html#classReceiver"><span class="std std-ref">Receiver</span></a> server. Reads configuration file, options, and assembles a <a class="reference internal" href="receiver_api.html#classReceiver"><span class="std std-ref">Receiver</span></a> using TCP and UDP detector interfaces throws an exception in case of failure <dl class="simple">
<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
<li><p><code class="docutils literal notranslate"><span class="pre">tcpip_port_no</span></code>: TCP/IP port number </p></li>
</ul>
</dd>
</dl>
</p>
</dd></dl>
<dl class="function">
<dt id="_CPPv4N8Receiver18getReceiverVersionEv">
<span id="_CPPv3N8Receiver18getReceiverVersionEv"></span><span id="_CPPv2N8Receiver18getReceiverVersionEv"></span><span id="Receiver::getReceiverVersion"></span><span class="target" id="classReceiver_1abe9a027e34d56a9b4da3a71cf5e9bb3e"></span>int64_t <code class="sig-name descname">getReceiverVersion</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N8Receiver18getReceiverVersionEv" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>get get <a class="reference internal" href="receiver_api.html#classReceiver"><span class="std std-ref">Receiver</span></a> Version <dl class="simple">
<dt><strong>Return</strong></dt><dd><p>id </p>
</dd>
</dl>
</p>
</dd></dl>
<dl class="function">
<dt id="_CPPv4N8Receiver32registerCallBackStartAcquisitionEPFiNSt6stringENSt6stringE8uint64_t8uint32_tPvEPv">
<span id="_CPPv3N8Receiver32registerCallBackStartAcquisitionEPFiNSt6stringENSt6stringE8uint64_t8uint32_tPvEPv"></span><span id="_CPPv2N8Receiver32registerCallBackStartAcquisitionEPFiNSt6stringENSt6stringE8uint64_t8uint32_tPvEPv"></span><span class="target" id="classReceiver_1a9b77f4432e5551395b96e0b34087657d"></span>void <code class="sig-name descname">registerCallBackStartAcquisition</code><span class="sig-paren">(</span>int (*<em>func</em>)<span class="sig-paren">(</span>std::string, std::string, uint64_t, uint32_t, void *<span class="sig-paren">)</span>, void *<em>arg</em>, <span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N8Receiver32registerCallBackStartAcquisitionEPFiNSt6stringENSt6stringE8uint64_t8uint32_tPvEPv" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Call back for start acquisition callback arguments are filepath filename fileindex datasize</p>
<p>return value is undefined at the moment we write depending on file write enable users get data to write depending on call backs registered </p>
</dd></dl>
<dl class="function">
<dt id="_CPPv4N8Receiver35registerCallBackAcquisitionFinishedEPFv8uint64_tPvEPv">
<span id="_CPPv3N8Receiver35registerCallBackAcquisitionFinishedEPFv8uint64_tPvEPv"></span><span id="_CPPv2N8Receiver35registerCallBackAcquisitionFinishedEPFv8uint64_tPvEPv"></span><span class="target" id="classReceiver_1aecbf403b5ad01826661b1b86f19dfa09"></span>void <code class="sig-name descname">registerCallBackAcquisitionFinished</code><span class="sig-paren">(</span>void (*<em>func</em>)<span class="sig-paren">(</span>uint64_t, void *<span class="sig-paren">)</span>, void *<em>arg</em>, <span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N8Receiver35registerCallBackAcquisitionFinishedEPFv8uint64_tPvEPv" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Call back for acquisition finished callback argument is total frames caught </p>
</dd></dl>
<dl class="function">
<dt id="_CPPv4N8Receiver28registerCallBackRawDataReadyEPFvPcPc8uint32_tPvEPv">
<span id="_CPPv3N8Receiver28registerCallBackRawDataReadyEPFvPcPc8uint32_tPvEPv"></span><span id="_CPPv2N8Receiver28registerCallBackRawDataReadyEPFvPcPc8uint32_tPvEPv"></span><span class="target" id="classReceiver_1a2245318397d2b75f7ebf7b14116b8317"></span>void <code class="sig-name descname">registerCallBackRawDataReady</code><span class="sig-paren">(</span>void (*<em>func</em>)<span class="sig-paren">(</span>char *, char *, uint32_t, void *<span class="sig-paren">)</span>, void *<em>arg</em>, <span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N8Receiver28registerCallBackRawDataReadyEPFvPcPc8uint32_tPvEPv" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Call back for raw data args to raw data ready callback are sls_receiver_header frame metadata, dataPointer is the pointer to the data, dataSize in bytes is the size of the data in bytes. </p>
</dd></dl>
<dl class="function">
<dt id="_CPPv4N8Receiver34registerCallBackRawDataModifyReadyEPFvPcPcR8uint32_tPvEPv">
<span id="_CPPv3N8Receiver34registerCallBackRawDataModifyReadyEPFvPcPcR8uint32_tPvEPv"></span><span id="_CPPv2N8Receiver34registerCallBackRawDataModifyReadyEPFvPcPcR8uint32_tPvEPv"></span><span class="target" id="classReceiver_1ae53ae97198bd03459f2275ca42a5f221"></span>void <code class="sig-name descname">registerCallBackRawDataModifyReady</code><span class="sig-paren">(</span>void (*<em>func</em>)<span class="sig-paren">(</span>char *, char *, uint32_t&, void *<span class="sig-paren">)</span>, void *<em>arg</em>, <span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N8Receiver34registerCallBackRawDataModifyReadyEPFvPcPcR8uint32_tPvEPv" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Call back for raw data (modified) args to raw data ready callback are sls_receiver_header frame metadata, dataPointer is the pointer to the data, revDatasize is the reference of data size in bytes. Can be modified to the new size to be written/streamed. (only smaller value). </p>
</dd></dl>
</div>
</dd></dl>
</div>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2020, PSD Detector Group
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>