detectors/aare
25
0
Fork 0
mirror of https://github.com/slsdetectorgroup/aare.git synced 2025-06-08 13:40:39 +02:00
Code Issues Actions Packages Releases Activity
aare/docs/html/ZmqSocket_8hpp_source.html
Bechir Braham 2ebbd0d7cd
setup doxygen and clang-uml files
2024-04-11 17:20:34 +02:00

144 lines
18 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.7"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>AARE: network_io/include/aare/network_io/ZmqSocket.hpp Source File</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/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 id="projectrow">
<td id="projectalign">
<div id="projectname">AARE
</div>
<div id="projectbrief">Data analysis library for PSI hybrid detectors</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.7 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- 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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d6681e26bbdc40cc2b8fd2c1ffe8d5dc.html">network_io</a></li><li class="navelem"><a class="el" href="dir_b2a8ea68e79d3967587957f3f88f5f8e.html">include</a></li><li class="navelem"><a class="el" href="dir_d15262210f422790cca47ab9f4f39b98.html">aare</a></li><li class="navelem"><a class="el" href="dir_c96ec884e069a3e16394d9595af8c834.html">network_io</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">ZmqSocket.hpp</div></div>
</div><!--header-->
<div class="contents">
<a href="ZmqSocket_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span> </div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span> </div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment">// Socket to receive data from a ZMQ publisher</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment">// needs to be in sync with the main library (or maybe better use the versioning in the header)</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span> </div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment">// forward declare zmq_msg_t to avoid including zmq.h in the header</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="keyword">class </span>zmq_msg_t;</div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> </div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceaare.html">aare</a> {</div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> </div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"><a class="line" href="classaare_1_1ZmqSocket.html"> 13</a></span><span class="keyword">class </span><a class="code hl_class" href="classaare_1_1ZmqSocket.html">ZmqSocket</a> {</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> <span class="keyword">protected</span>:</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"><a class="line" href="classaare_1_1ZmqSocket.html#ab4b7264f583904f1c3d3181377295204"> 15</a></span> <span class="keywordtype">void</span> *<a class="code hl_variable" href="classaare_1_1ZmqSocket.html#ab4b7264f583904f1c3d3181377295204">m_context</a>{<span class="keyword">nullptr</span>};</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"><a class="line" href="classaare_1_1ZmqSocket.html#a818f6534a600be8422c980d193c85b94"> 16</a></span> <span class="keywordtype">void</span> *<a class="code hl_variable" href="classaare_1_1ZmqSocket.html#a818f6534a600be8422c980d193c85b94">m_socket</a>{<span class="keyword">nullptr</span>};</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"><a class="line" href="classaare_1_1ZmqSocket.html#ab7bfda5aee365ef499a6605b7426ec79"> 17</a></span> std::string <a class="code hl_variable" href="classaare_1_1ZmqSocket.html#ab7bfda5aee365ef499a6605b7426ec79">m_endpoint</a>;</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"><a class="line" href="classaare_1_1ZmqSocket.html#a13c8da9738e41cf6e884ed0c070ced63"> 18</a></span> <span class="keywordtype">int</span> <a class="code hl_variable" href="classaare_1_1ZmqSocket.html#a13c8da9738e41cf6e884ed0c070ced63">m_zmq_hwm</a>{1000};</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"><a class="line" href="classaare_1_1ZmqSocket.html#a6b4316d6f9edfdac66f5e6393d3eaebf"> 19</a></span> <span class="keywordtype">int</span> <a class="code hl_variable" href="classaare_1_1ZmqSocket.html#a6b4316d6f9edfdac66f5e6393d3eaebf">m_timeout_ms</a>{1000};</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"><a class="line" href="classaare_1_1ZmqSocket.html#ab662a79c5fb770399567277523a168d4"> 20</a></span> <span class="keywordtype">size_t</span> <a class="code hl_variable" href="classaare_1_1ZmqSocket.html#ab662a79c5fb770399567277523a168d4">m_potential_frame_size</a>{1024 * 1024};</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"><a class="line" href="classaare_1_1ZmqSocket.html#aeff0afb3278a5474ddb2525caa8375b9"> 21</a></span> <span class="keyword">constexpr</span> <span class="keyword">static</span> <span class="keywordtype">size_t</span> <a class="code hl_variable" href="classaare_1_1ZmqSocket.html#aeff0afb3278a5474ddb2525caa8375b9">m_max_header_size</a> = 1024;</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"><a class="line" href="classaare_1_1ZmqSocket.html#acf6efc2e696efcc0780c0b174e43ae6d"> 22</a></span> <span class="keywordtype">char</span> *<a class="code hl_variable" href="classaare_1_1ZmqSocket.html#acf6efc2e696efcc0780c0b174e43ae6d">m_header_buffer</a> = <span class="keyword">new</span> <span class="keywordtype">char</span>[<a class="code hl_variable" href="classaare_1_1ZmqSocket.html#aeff0afb3278a5474ddb2525caa8375b9">m_max_header_size</a>];</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> </div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"><a class="line" href="classaare_1_1ZmqSocket.html#a1b9bd643c6f86733fc198ad39396cbc8"> 25</a></span> <a class="code hl_function" href="classaare_1_1ZmqSocket.html#a1b9bd643c6f86733fc198ad39396cbc8">ZmqSocket</a>() = <span class="keywordflow">default</span>;</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> <a class="code hl_function" href="classaare_1_1ZmqSocket.html#a8608b7b4aeafc0349763bec3a9f26503">~ZmqSocket</a>();</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> </div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"><a class="line" href="classaare_1_1ZmqSocket.html#ab6fe77359ecda3e89d969b96cbcc2f2f"> 28</a></span> <a class="code hl_function" href="classaare_1_1ZmqSocket.html#ab6fe77359ecda3e89d969b96cbcc2f2f">ZmqSocket</a>(<span class="keyword">const</span> <a class="code hl_class" href="classaare_1_1ZmqSocket.html">ZmqSocket</a> &amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"><a class="line" href="classaare_1_1ZmqSocket.html#a2bda9d69955c0b9d6f917aff2eeacc75"> 29</a></span> <a class="code hl_class" href="classaare_1_1ZmqSocket.html">ZmqSocket</a> <a class="code hl_function" href="classaare_1_1ZmqSocket.html#a2bda9d69955c0b9d6f917aff2eeacc75">operator=</a>(<span class="keyword">const</span> <a class="code hl_class" href="classaare_1_1ZmqSocket.html">ZmqSocket</a> &amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"><a class="line" href="classaare_1_1ZmqSocket.html#a462d2dc5a4bc97428a9ddb911dbca4af"> 30</a></span> <a class="code hl_function" href="classaare_1_1ZmqSocket.html#a462d2dc5a4bc97428a9ddb911dbca4af">ZmqSocket</a>(<a class="code hl_class" href="classaare_1_1ZmqSocket.html">ZmqSocket</a> &amp;&amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> </div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classaare_1_1ZmqSocket.html#a0eab196c0b514be8c49a3fd98d758778">disconnect</a>();</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classaare_1_1ZmqSocket.html#a0223c4d123eb7aec9cd1464509941a99">set_zmq_hwm</a>(<span class="keywordtype">int</span> hwm);</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classaare_1_1ZmqSocket.html#ab1f26596ce66e2ca7d4b26ee912b433c">set_timeout_ms</a>(<span class="keywordtype">int</span> n);</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classaare_1_1ZmqSocket.html#a755a2e592ed706976c0fbf000eb70b96">set_potential_frame_size</a>(<span class="keywordtype">size_t</span> size);</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span>};</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> </div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span>} <span class="comment">// namespace aare</span></div>
<div class="ttc" id="aclassaare_1_1ZmqSocket_html"><div class="ttname"><a href="classaare_1_1ZmqSocket.html">aare::ZmqSocket</a></div><div class="ttdef"><b>Definition</b> ZmqSocket.hpp:13</div></div>
<div class="ttc" id="aclassaare_1_1ZmqSocket_html_a0223c4d123eb7aec9cd1464509941a99"><div class="ttname"><a href="classaare_1_1ZmqSocket.html#a0223c4d123eb7aec9cd1464509941a99">aare::ZmqSocket::set_zmq_hwm</a></div><div class="ttdeci">void set_zmq_hwm(int hwm)</div><div class="ttdef"><b>Definition</b> ZmqSocket.cpp:19</div></div>
<div class="ttc" id="aclassaare_1_1ZmqSocket_html_a0eab196c0b514be8c49a3fd98d758778"><div class="ttname"><a href="classaare_1_1ZmqSocket.html#a0eab196c0b514be8c49a3fd98d758778">aare::ZmqSocket::disconnect</a></div><div class="ttdeci">void disconnect()</div><div class="ttdef"><b>Definition</b> ZmqSocket.cpp:6</div></div>
<div class="ttc" id="aclassaare_1_1ZmqSocket_html_a13c8da9738e41cf6e884ed0c070ced63"><div class="ttname"><a href="classaare_1_1ZmqSocket.html#a13c8da9738e41cf6e884ed0c070ced63">aare::ZmqSocket::m_zmq_hwm</a></div><div class="ttdeci">int m_zmq_hwm</div><div class="ttdef"><b>Definition</b> ZmqSocket.hpp:18</div></div>
<div class="ttc" id="aclassaare_1_1ZmqSocket_html_a1b9bd643c6f86733fc198ad39396cbc8"><div class="ttname"><a href="classaare_1_1ZmqSocket.html#a1b9bd643c6f86733fc198ad39396cbc8">aare::ZmqSocket::ZmqSocket</a></div><div class="ttdeci">ZmqSocket()=default</div></div>
<div class="ttc" id="aclassaare_1_1ZmqSocket_html_a2bda9d69955c0b9d6f917aff2eeacc75"><div class="ttname"><a href="classaare_1_1ZmqSocket.html#a2bda9d69955c0b9d6f917aff2eeacc75">aare::ZmqSocket::operator=</a></div><div class="ttdeci">ZmqSocket operator=(const ZmqSocket &amp;)=delete</div></div>
<div class="ttc" id="aclassaare_1_1ZmqSocket_html_a462d2dc5a4bc97428a9ddb911dbca4af"><div class="ttname"><a href="classaare_1_1ZmqSocket.html#a462d2dc5a4bc97428a9ddb911dbca4af">aare::ZmqSocket::ZmqSocket</a></div><div class="ttdeci">ZmqSocket(ZmqSocket &amp;&amp;)=delete</div></div>
<div class="ttc" id="aclassaare_1_1ZmqSocket_html_a6b4316d6f9edfdac66f5e6393d3eaebf"><div class="ttname"><a href="classaare_1_1ZmqSocket.html#a6b4316d6f9edfdac66f5e6393d3eaebf">aare::ZmqSocket::m_timeout_ms</a></div><div class="ttdeci">int m_timeout_ms</div><div class="ttdef"><b>Definition</b> ZmqSocket.hpp:19</div></div>
<div class="ttc" id="aclassaare_1_1ZmqSocket_html_a755a2e592ed706976c0fbf000eb70b96"><div class="ttname"><a href="classaare_1_1ZmqSocket.html#a755a2e592ed706976c0fbf000eb70b96">aare::ZmqSocket::set_potential_frame_size</a></div><div class="ttdeci">void set_potential_frame_size(size_t size)</div><div class="ttdef"><b>Definition</b> ZmqSocket.cpp:23</div></div>
<div class="ttc" id="aclassaare_1_1ZmqSocket_html_a818f6534a600be8422c980d193c85b94"><div class="ttname"><a href="classaare_1_1ZmqSocket.html#a818f6534a600be8422c980d193c85b94">aare::ZmqSocket::m_socket</a></div><div class="ttdeci">void * m_socket</div><div class="ttdef"><b>Definition</b> ZmqSocket.hpp:16</div></div>
<div class="ttc" id="aclassaare_1_1ZmqSocket_html_a8608b7b4aeafc0349763bec3a9f26503"><div class="ttname"><a href="classaare_1_1ZmqSocket.html#a8608b7b4aeafc0349763bec3a9f26503">aare::ZmqSocket::~ZmqSocket</a></div><div class="ttdeci">~ZmqSocket()</div><div class="ttdef"><b>Definition</b> ZmqSocket.cpp:13</div></div>
<div class="ttc" id="aclassaare_1_1ZmqSocket_html_ab1f26596ce66e2ca7d4b26ee912b433c"><div class="ttname"><a href="classaare_1_1ZmqSocket.html#ab1f26596ce66e2ca7d4b26ee912b433c">aare::ZmqSocket::set_timeout_ms</a></div><div class="ttdeci">void set_timeout_ms(int n)</div><div class="ttdef"><b>Definition</b> ZmqSocket.cpp:21</div></div>
<div class="ttc" id="aclassaare_1_1ZmqSocket_html_ab4b7264f583904f1c3d3181377295204"><div class="ttname"><a href="classaare_1_1ZmqSocket.html#ab4b7264f583904f1c3d3181377295204">aare::ZmqSocket::m_context</a></div><div class="ttdeci">void * m_context</div><div class="ttdef"><b>Definition</b> ZmqSocket.hpp:15</div></div>
<div class="ttc" id="aclassaare_1_1ZmqSocket_html_ab662a79c5fb770399567277523a168d4"><div class="ttname"><a href="classaare_1_1ZmqSocket.html#ab662a79c5fb770399567277523a168d4">aare::ZmqSocket::m_potential_frame_size</a></div><div class="ttdeci">size_t m_potential_frame_size</div><div class="ttdef"><b>Definition</b> ZmqSocket.hpp:20</div></div>
<div class="ttc" id="aclassaare_1_1ZmqSocket_html_ab6fe77359ecda3e89d969b96cbcc2f2f"><div class="ttname"><a href="classaare_1_1ZmqSocket.html#ab6fe77359ecda3e89d969b96cbcc2f2f">aare::ZmqSocket::ZmqSocket</a></div><div class="ttdeci">ZmqSocket(const ZmqSocket &amp;)=delete</div></div>
<div class="ttc" id="aclassaare_1_1ZmqSocket_html_ab7bfda5aee365ef499a6605b7426ec79"><div class="ttname"><a href="classaare_1_1ZmqSocket.html#ab7bfda5aee365ef499a6605b7426ec79">aare::ZmqSocket::m_endpoint</a></div><div class="ttdeci">std::string m_endpoint</div><div class="ttdef"><b>Definition</b> ZmqSocket.hpp:17</div></div>
<div class="ttc" id="aclassaare_1_1ZmqSocket_html_acf6efc2e696efcc0780c0b174e43ae6d"><div class="ttname"><a href="classaare_1_1ZmqSocket.html#acf6efc2e696efcc0780c0b174e43ae6d">aare::ZmqSocket::m_header_buffer</a></div><div class="ttdeci">char * m_header_buffer</div><div class="ttdef"><b>Definition</b> ZmqSocket.hpp:22</div></div>
<div class="ttc" id="aclassaare_1_1ZmqSocket_html_aeff0afb3278a5474ddb2525caa8375b9"><div class="ttname"><a href="classaare_1_1ZmqSocket.html#aeff0afb3278a5474ddb2525caa8375b9">aare::ZmqSocket::m_max_header_size</a></div><div class="ttdeci">static constexpr size_t m_max_header_size</div><div class="ttdef"><b>Definition</b> ZmqSocket.hpp:21</div></div>
<div class="ttc" id="anamespaceaare_html"><div class="ttname"><a href="namespaceaare.html">aare</a></div><div class="ttdoc">Frame class to represent a single frame of data model class should be able to work with streams comin...</div><div class="ttdef"><b>Definition</b> CircularFifo.hpp:11</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.7
</small></address>
</body>
</html>
View Git Blame Copy Permalink