mirror of
https://github.com/FairRootGroup/FairMQ.git
synced 2025-10-13 00:31:14 +00:00
197 lines
16 KiB
HTML
197 lines
16 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.13"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>FairMQ: FairMQSocketZMQ Class 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/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="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">FairMQ
|
|
 <span id="projectnumber">1.2.0</span>
|
|
</div>
|
|
<div id="projectbrief">C++ Message Passing Framework</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>
|
|
<!-- 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><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pub-static-methods">Static Public Member Functions</a> |
|
|
<a href="classFairMQSocketZMQ-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">FairMQSocketZMQ Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="dynheader">
|
|
Inheritance diagram for FairMQSocketZMQ:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classFairMQSocketZMQ__inherit__graph.png" border="0" usemap="#FairMQSocketZMQ_inherit__map" alt="Inheritance graph"/></div>
|
|
<map name="FairMQSocketZMQ_inherit__map" id="FairMQSocketZMQ_inherit__map">
|
|
<area shape="rect" id="node2" href="classFairMQSocket.html" title="FairMQSocket" alt="" coords="20,5,131,32"/>
|
|
</map>
|
|
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
|
|
<div class="dynheader">
|
|
Collaboration diagram for FairMQSocketZMQ:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classFairMQSocketZMQ__coll__graph.png" border="0" usemap="#FairMQSocketZMQ_coll__map" alt="Collaboration graph"/></div>
|
|
<map name="FairMQSocketZMQ_coll__map" id="FairMQSocketZMQ_coll__map">
|
|
<area shape="rect" id="node2" href="classFairMQSocket.html" title="FairMQSocket" alt="" coords="20,5,131,32"/>
|
|
</map>
|
|
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:aea86152b8b4bbaedab395b4dc58ba4bf"><td class="memItemLeft" align="right" valign="top"><a id="aea86152b8b4bbaedab395b4dc58ba4bf"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>FairMQSocketZMQ</b> (const std::string &type, const std::string &name, const std::string &id="", void *context=nullptr)</td></tr>
|
|
<tr class="separator:aea86152b8b4bbaedab395b4dc58ba4bf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8d5128e26b0f662f8dd51beba2b56d64"><td class="memItemLeft" align="right" valign="top"><a id="a8d5128e26b0f662f8dd51beba2b56d64"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>FairMQSocketZMQ</b> (const <a class="el" href="classFairMQSocketZMQ.html">FairMQSocketZMQ</a> &)=delete</td></tr>
|
|
<tr class="separator:a8d5128e26b0f662f8dd51beba2b56d64"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a38b603bd9ea6c53ebdcdcf61916c4666"><td class="memItemLeft" align="right" valign="top"><a id="a38b603bd9ea6c53ebdcdcf61916c4666"></a>
|
|
<a class="el" href="classFairMQSocketZMQ.html">FairMQSocketZMQ</a> </td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classFairMQSocketZMQ.html">FairMQSocketZMQ</a> &)=delete</td></tr>
|
|
<tr class="separator:a38b603bd9ea6c53ebdcdcf61916c4666"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a903c12354aedf4165560c4d0955cd2e7"><td class="memItemLeft" align="right" valign="top"><a id="a903c12354aedf4165560c4d0955cd2e7"></a>
|
|
std::string </td><td class="memItemRight" valign="bottom"><b>GetId</b> () override</td></tr>
|
|
<tr class="separator:a903c12354aedf4165560c4d0955cd2e7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5c43ef54c2e8e9b8b14e9ee93d9e8ca5"><td class="memItemLeft" align="right" valign="top"><a id="a5c43ef54c2e8e9b8b14e9ee93d9e8ca5"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><b>Bind</b> (const std::string &address) override</td></tr>
|
|
<tr class="separator:a5c43ef54c2e8e9b8b14e9ee93d9e8ca5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6b2eced569de7d8e56865c0b4112b40c"><td class="memItemLeft" align="right" valign="top"><a id="a6b2eced569de7d8e56865c0b4112b40c"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>Connect</b> (const std::string &address) override</td></tr>
|
|
<tr class="separator:a6b2eced569de7d8e56865c0b4112b40c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a09fc542e4c4a72f4d3fa42151000256e"><td class="memItemLeft" align="right" valign="top"><a id="a09fc542e4c4a72f4d3fa42151000256e"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><b>Send</b> (FairMQMessagePtr &msg, const int timeout=0) override</td></tr>
|
|
<tr class="separator:a09fc542e4c4a72f4d3fa42151000256e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adbe66283174c2e020559af72e0b75c2d"><td class="memItemLeft" align="right" valign="top"><a id="adbe66283174c2e020559af72e0b75c2d"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><b>Receive</b> (FairMQMessagePtr &msg, const int timeout=0) override</td></tr>
|
|
<tr class="separator:adbe66283174c2e020559af72e0b75c2d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a73b2bed1b982e58ee04b2e2e732c741b"><td class="memItemLeft" align="right" valign="top"><a id="a73b2bed1b982e58ee04b2e2e732c741b"></a>
|
|
int64_t </td><td class="memItemRight" valign="bottom"><b>Send</b> (std::vector< std::unique_ptr< <a class="el" href="classFairMQMessage.html">FairMQMessage</a> >> &msgVec, const int timeout=0) override</td></tr>
|
|
<tr class="separator:a73b2bed1b982e58ee04b2e2e732c741b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9212481ad7200a1e97513037806e90cf"><td class="memItemLeft" align="right" valign="top"><a id="a9212481ad7200a1e97513037806e90cf"></a>
|
|
int64_t </td><td class="memItemRight" valign="bottom"><b>Receive</b> (std::vector< std::unique_ptr< <a class="el" href="classFairMQMessage.html">FairMQMessage</a> >> &msgVec, const int timeout=0) override</td></tr>
|
|
<tr class="separator:a9212481ad7200a1e97513037806e90cf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0ee8f9d9683c510e9e1854e09ad3e856"><td class="memItemLeft" align="right" valign="top"><a id="a0ee8f9d9683c510e9e1854e09ad3e856"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><b>TrySend</b> (FairMQMessagePtr &msg) override</td></tr>
|
|
<tr class="separator:a0ee8f9d9683c510e9e1854e09ad3e856"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2bf29bdbcf6805cb128066bb862e26a1"><td class="memItemLeft" align="right" valign="top"><a id="a2bf29bdbcf6805cb128066bb862e26a1"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><b>TryReceive</b> (FairMQMessagePtr &msg) override</td></tr>
|
|
<tr class="separator:a2bf29bdbcf6805cb128066bb862e26a1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aed51673ed2dd9de91cd037d4e536a361"><td class="memItemLeft" align="right" valign="top"><a id="aed51673ed2dd9de91cd037d4e536a361"></a>
|
|
int64_t </td><td class="memItemRight" valign="bottom"><b>TrySend</b> (std::vector< std::unique_ptr< <a class="el" href="classFairMQMessage.html">FairMQMessage</a> >> &msgVec) override</td></tr>
|
|
<tr class="separator:aed51673ed2dd9de91cd037d4e536a361"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a36f98659d28861bddb0de0539cd4eb99"><td class="memItemLeft" align="right" valign="top"><a id="a36f98659d28861bddb0de0539cd4eb99"></a>
|
|
int64_t </td><td class="memItemRight" valign="bottom"><b>TryReceive</b> (std::vector< std::unique_ptr< <a class="el" href="classFairMQMessage.html">FairMQMessage</a> >> &msgVec) override</td></tr>
|
|
<tr class="separator:a36f98659d28861bddb0de0539cd4eb99"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac6c03e4180b8dcc390bd1162819ab74d"><td class="memItemLeft" align="right" valign="top"><a id="ac6c03e4180b8dcc390bd1162819ab74d"></a>
|
|
void * </td><td class="memItemRight" valign="bottom"><b>GetSocket</b> () const override</td></tr>
|
|
<tr class="separator:ac6c03e4180b8dcc390bd1162819ab74d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af3ad22a261cc8a5e1c75654290731fde"><td class="memItemLeft" align="right" valign="top"><a id="af3ad22a261cc8a5e1c75654290731fde"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><b>GetSocket</b> (int nothing) const override</td></tr>
|
|
<tr class="separator:af3ad22a261cc8a5e1c75654290731fde"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a39554421d6b9010ac63acc7d5b680b8b"><td class="memItemLeft" align="right" valign="top"><a id="a39554421d6b9010ac63acc7d5b680b8b"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>Close</b> () override</td></tr>
|
|
<tr class="separator:a39554421d6b9010ac63acc7d5b680b8b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2b1b5ad98709effaee80ff0cb4d9c49d"><td class="memItemLeft" align="right" valign="top"><a id="a2b1b5ad98709effaee80ff0cb4d9c49d"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>SetOption</b> (const std::string &option, const void *value, size_t valueSize) override</td></tr>
|
|
<tr class="separator:a2b1b5ad98709effaee80ff0cb4d9c49d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab6923b4b99f436da40280efbedffb25f"><td class="memItemLeft" align="right" valign="top"><a id="ab6923b4b99f436da40280efbedffb25f"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>GetOption</b> (const std::string &option, void *value, size_t *valueSize) override</td></tr>
|
|
<tr class="separator:ab6923b4b99f436da40280efbedffb25f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aac4d9b1aa8118258d3d9d84370e86d40"><td class="memItemLeft" align="right" valign="top"><a id="aac4d9b1aa8118258d3d9d84370e86d40"></a>
|
|
unsigned long </td><td class="memItemRight" valign="bottom"><b>GetBytesTx</b> () const override</td></tr>
|
|
<tr class="separator:aac4d9b1aa8118258d3d9d84370e86d40"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a82b7a1463cf9891cc46121ba8778d3c6"><td class="memItemLeft" align="right" valign="top"><a id="a82b7a1463cf9891cc46121ba8778d3c6"></a>
|
|
unsigned long </td><td class="memItemRight" valign="bottom"><b>GetBytesRx</b> () const override</td></tr>
|
|
<tr class="separator:a82b7a1463cf9891cc46121ba8778d3c6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a88cd3a66dcea9ab69c1496696e4bde7a"><td class="memItemLeft" align="right" valign="top"><a id="a88cd3a66dcea9ab69c1496696e4bde7a"></a>
|
|
unsigned long </td><td class="memItemRight" valign="bottom"><b>GetMessagesTx</b> () const override</td></tr>
|
|
<tr class="separator:a88cd3a66dcea9ab69c1496696e4bde7a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ace454d0286cc677fec850d4adcc96443"><td class="memItemLeft" align="right" valign="top"><a id="ace454d0286cc677fec850d4adcc96443"></a>
|
|
unsigned long </td><td class="memItemRight" valign="bottom"><b>GetMessagesRx</b> () const override</td></tr>
|
|
<tr class="separator:ace454d0286cc677fec850d4adcc96443"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8d47d19ad00169cc3b14882bec9072d7"><td class="memItemLeft" align="right" valign="top"><a id="a8d47d19ad00169cc3b14882bec9072d7"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><b>SetSendTimeout</b> (const int timeout, const std::string &address, const std::string &method) override</td></tr>
|
|
<tr class="separator:a8d47d19ad00169cc3b14882bec9072d7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a25287cb8160e99b105a8482839a9d8fb"><td class="memItemLeft" align="right" valign="top"><a id="a25287cb8160e99b105a8482839a9d8fb"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><b>GetSendTimeout</b> () const override</td></tr>
|
|
<tr class="separator:a25287cb8160e99b105a8482839a9d8fb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abe7bfd592b0e7c1fe3b5550b49d3c0ec"><td class="memItemLeft" align="right" valign="top"><a id="abe7bfd592b0e7c1fe3b5550b49d3c0ec"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><b>SetReceiveTimeout</b> (const int timeout, const std::string &address, const std::string &method) override</td></tr>
|
|
<tr class="separator:abe7bfd592b0e7c1fe3b5550b49d3c0ec"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1840001980400060f6943122cc110ea5"><td class="memItemLeft" align="right" valign="top"><a id="a1840001980400060f6943122cc110ea5"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><b>GetReceiveTimeout</b> () const override</td></tr>
|
|
<tr class="separator:a1840001980400060f6943122cc110ea5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
|
|
Static Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a01fd9776884ce32b48bc4e635aeb9359"><td class="memItemLeft" align="right" valign="top"><a id="a01fd9776884ce32b48bc4e635aeb9359"></a>
|
|
static void </td><td class="memItemRight" valign="bottom"><b>Interrupt</b> ()</td></tr>
|
|
<tr class="separator:a01fd9776884ce32b48bc4e635aeb9359"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9b10eb9e7c1eaccce31bcd964e4e043f"><td class="memItemLeft" align="right" valign="top"><a id="a9b10eb9e7c1eaccce31bcd964e4e043f"></a>
|
|
static void </td><td class="memItemRight" valign="bottom"><b>Resume</b> ()</td></tr>
|
|
<tr class="separator:a9b10eb9e7c1eaccce31bcd964e4e043f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1a786e85a2b14123882379c1e04e1e59"><td class="memItemLeft" align="right" valign="top"><a id="a1a786e85a2b14123882379c1e04e1e59"></a>
|
|
static int </td><td class="memItemRight" valign="bottom"><b>GetConstant</b> (const std::string &constant)</td></tr>
|
|
<tr class="separator:a1a786e85a2b14123882379c1e04e1e59"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>fairmq/zeromq/<a class="el" href="FairMQSocketZMQ_8h_source.html">FairMQSocketZMQ.h</a></li>
|
|
<li>fairmq/zeromq/FairMQSocketZMQ.cxx</li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.13
|
|
</small></address>
|
|
</body>
|
|
</html>
|