Mirror/FairMQ
1
0
Fork 0
mirror of https://github.com/FairRootGroup/FairMQ.git synced 2025-10-13 08:41:16 +00:00
Code Issues Packages Projects Releases Wiki Activity
gh-pages
FairMQ/v1.3.8/classFairMQSocketZMQ.html
Dennis Klein f1c3c5f6c4
Add API docs for 1.3.8
2019-01-07 13:13:30 +01:00

206 lines
18 KiB
HTML
Raw Permalink 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.14"/>
<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
&#160;<span id="projectnumber">1.3.8</span>
</div>
<div id="projectbrief">C++ Message Passing Framework</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(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">
<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> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="classFairMQSocketZMQ-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">FairMQSocketZMQ Class Reference<span class="mlabels"><span class="mlabel">final</span></span></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="19,5,126,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="19,5,126,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:a563afa44d4719e61310efa8734cdc77d"><td class="memItemLeft" align="right" valign="top"><a id="a563afa44d4719e61310efa8734cdc77d"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>FairMQSocketZMQ</b> (const std::string &amp;type, const std::string &amp;name, const std::string &amp;id=&quot;&quot;, void *context=nullptr, <a class="el" href="classFairMQTransportFactory.html">FairMQTransportFactory</a> *factory=nullptr)</td></tr>
<tr class="separator:a563afa44d4719e61310efa8734cdc77d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8d5128e26b0f662f8dd51beba2b56d64"><td class="memItemLeft" align="right" valign="top"><a id="a8d5128e26b0f662f8dd51beba2b56d64"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>FairMQSocketZMQ</b> (const <a class="el" href="classFairMQSocketZMQ.html">FairMQSocketZMQ</a> &amp;)=delete</td></tr>
<tr class="separator:a8d5128e26b0f662f8dd51beba2b56d64"><td class="memSeparator" colspan="2">&#160;</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>&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classFairMQSocketZMQ.html">FairMQSocketZMQ</a> &amp;)=delete</td></tr>
<tr class="separator:a38b603bd9ea6c53ebdcdcf61916c4666"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a903c12354aedf4165560c4d0955cd2e7"><td class="memItemLeft" align="right" valign="top"><a id="a903c12354aedf4165560c4d0955cd2e7"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><b>GetId</b> () override</td></tr>
<tr class="separator:a903c12354aedf4165560c4d0955cd2e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5c43ef54c2e8e9b8b14e9ee93d9e8ca5"><td class="memItemLeft" align="right" valign="top"><a id="a5c43ef54c2e8e9b8b14e9ee93d9e8ca5"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>Bind</b> (const std::string &amp;address) override</td></tr>
<tr class="separator:a5c43ef54c2e8e9b8b14e9ee93d9e8ca5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a92fd5c3f33061cbcfdab8cb1048d5a1d"><td class="memItemLeft" align="right" valign="top"><a id="a92fd5c3f33061cbcfdab8cb1048d5a1d"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>Connect</b> (const std::string &amp;address) override</td></tr>
<tr class="separator:a92fd5c3f33061cbcfdab8cb1048d5a1d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abfd1b6c1982ed9e2400713624af07d55"><td class="memItemLeft" align="right" valign="top"><a id="abfd1b6c1982ed9e2400713624af07d55"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>Send</b> (FairMQMessagePtr &amp;msg, const int timeout=-1) override</td></tr>
<tr class="separator:abfd1b6c1982ed9e2400713624af07d55"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a252fa6d07649fac897eed84223e56859"><td class="memItemLeft" align="right" valign="top"><a id="a252fa6d07649fac897eed84223e56859"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>Receive</b> (FairMQMessagePtr &amp;msg, const int timeout=-1) override</td></tr>
<tr class="separator:a252fa6d07649fac897eed84223e56859"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3291fb17e8fa1f9bd94f32e81d53d9f9"><td class="memItemLeft" align="right" valign="top"><a id="a3291fb17e8fa1f9bd94f32e81d53d9f9"></a>
int64_t&#160;</td><td class="memItemRight" valign="bottom"><b>Send</b> (std::vector&lt; std::unique_ptr&lt; <a class="el" href="classFairMQMessage.html">FairMQMessage</a> &gt;&gt; &amp;msgVec, const int timeout=-1) override</td></tr>
<tr class="separator:a3291fb17e8fa1f9bd94f32e81d53d9f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad280a9d55578c7339c629ed64572d734"><td class="memItemLeft" align="right" valign="top"><a id="ad280a9d55578c7339c629ed64572d734"></a>
int64_t&#160;</td><td class="memItemRight" valign="bottom"><b>Receive</b> (std::vector&lt; std::unique_ptr&lt; <a class="el" href="classFairMQMessage.html">FairMQMessage</a> &gt;&gt; &amp;msgVec, const int timeout=-1) override</td></tr>
<tr class="separator:ad280a9d55578c7339c629ed64572d734"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adf04eea867af53f0b4cd70744f84329a"><td class="memItemLeft" align="right" valign="top"><a id="adf04eea867af53f0b4cd70744f84329a"></a>
void *&#160;</td><td class="memItemRight" valign="bottom"><b>GetSocket</b> () const</td></tr>
<tr class="separator:adf04eea867af53f0b4cd70744f84329a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a39554421d6b9010ac63acc7d5b680b8b"><td class="memItemLeft" align="right" valign="top"><a id="a39554421d6b9010ac63acc7d5b680b8b"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>Close</b> () override</td></tr>
<tr class="separator:a39554421d6b9010ac63acc7d5b680b8b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2b1b5ad98709effaee80ff0cb4d9c49d"><td class="memItemLeft" align="right" valign="top"><a id="a2b1b5ad98709effaee80ff0cb4d9c49d"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>SetOption</b> (const std::string &amp;option, const void *value, size_t valueSize) override</td></tr>
<tr class="separator:a2b1b5ad98709effaee80ff0cb4d9c49d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab6923b4b99f436da40280efbedffb25f"><td class="memItemLeft" align="right" valign="top"><a id="ab6923b4b99f436da40280efbedffb25f"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>GetOption</b> (const std::string &amp;option, void *value, size_t *valueSize) override</td></tr>
<tr class="separator:ab6923b4b99f436da40280efbedffb25f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac5786aaab2408365ba6b5958ee58afa8"><td class="memItemLeft" align="right" valign="top"><a id="ac5786aaab2408365ba6b5958ee58afa8"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>SetLinger</b> (const int value) override</td></tr>
<tr class="separator:ac5786aaab2408365ba6b5958ee58afa8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5db5449100baef8392130dd1f0c3b5db"><td class="memItemLeft" align="right" valign="top"><a id="a5db5449100baef8392130dd1f0c3b5db"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>GetLinger</b> () const override</td></tr>
<tr class="separator:a5db5449100baef8392130dd1f0c3b5db"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3703d9f59bb5f83baa7d0301b707bd66"><td class="memItemLeft" align="right" valign="top"><a id="a3703d9f59bb5f83baa7d0301b707bd66"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>SetSndBufSize</b> (const int value) override</td></tr>
<tr class="separator:a3703d9f59bb5f83baa7d0301b707bd66"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a06cfda32e383b3b6390f5d9b6cac0307"><td class="memItemLeft" align="right" valign="top"><a id="a06cfda32e383b3b6390f5d9b6cac0307"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>GetSndBufSize</b> () const override</td></tr>
<tr class="separator:a06cfda32e383b3b6390f5d9b6cac0307"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a927684e88498689065ba20a2b8a038ca"><td class="memItemLeft" align="right" valign="top"><a id="a927684e88498689065ba20a2b8a038ca"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>SetRcvBufSize</b> (const int value) override</td></tr>
<tr class="separator:a927684e88498689065ba20a2b8a038ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3fc28827cb6482f42b96325845b6736d"><td class="memItemLeft" align="right" valign="top"><a id="a3fc28827cb6482f42b96325845b6736d"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>GetRcvBufSize</b> () const override</td></tr>
<tr class="separator:a3fc28827cb6482f42b96325845b6736d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9c4166f3b5c16cee2d497d3a450ae3a1"><td class="memItemLeft" align="right" valign="top"><a id="a9c4166f3b5c16cee2d497d3a450ae3a1"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>SetSndKernelSize</b> (const int value) override</td></tr>
<tr class="separator:a9c4166f3b5c16cee2d497d3a450ae3a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3606ffc614e26ae6b1c79134c6c8e8c8"><td class="memItemLeft" align="right" valign="top"><a id="a3606ffc614e26ae6b1c79134c6c8e8c8"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>GetSndKernelSize</b> () const override</td></tr>
<tr class="separator:a3606ffc614e26ae6b1c79134c6c8e8c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa465a5d9a439e67063f5a200c1a841b1"><td class="memItemLeft" align="right" valign="top"><a id="aa465a5d9a439e67063f5a200c1a841b1"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>SetRcvKernelSize</b> (const int value) override</td></tr>
<tr class="separator:aa465a5d9a439e67063f5a200c1a841b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5fe22791f5cb8b8470f2add86764d9e9"><td class="memItemLeft" align="right" valign="top"><a id="a5fe22791f5cb8b8470f2add86764d9e9"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>GetRcvKernelSize</b> () const override</td></tr>
<tr class="separator:a5fe22791f5cb8b8470f2add86764d9e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aac4d9b1aa8118258d3d9d84370e86d40"><td class="memItemLeft" align="right" valign="top"><a id="aac4d9b1aa8118258d3d9d84370e86d40"></a>
unsigned long&#160;</td><td class="memItemRight" valign="bottom"><b>GetBytesTx</b> () const override</td></tr>
<tr class="separator:aac4d9b1aa8118258d3d9d84370e86d40"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a82b7a1463cf9891cc46121ba8778d3c6"><td class="memItemLeft" align="right" valign="top"><a id="a82b7a1463cf9891cc46121ba8778d3c6"></a>
unsigned long&#160;</td><td class="memItemRight" valign="bottom"><b>GetBytesRx</b> () const override</td></tr>
<tr class="separator:a82b7a1463cf9891cc46121ba8778d3c6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a88cd3a66dcea9ab69c1496696e4bde7a"><td class="memItemLeft" align="right" valign="top"><a id="a88cd3a66dcea9ab69c1496696e4bde7a"></a>
unsigned long&#160;</td><td class="memItemRight" valign="bottom"><b>GetMessagesTx</b> () const override</td></tr>
<tr class="separator:a88cd3a66dcea9ab69c1496696e4bde7a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ace454d0286cc677fec850d4adcc96443"><td class="memItemLeft" align="right" valign="top"><a id="ace454d0286cc677fec850d4adcc96443"></a>
unsigned long&#160;</td><td class="memItemRight" valign="bottom"><b>GetMessagesRx</b> () const override</td></tr>
<tr class="separator:ace454d0286cc677fec850d4adcc96443"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classFairMQSocket"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classFairMQSocket')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classFairMQSocket.html">FairMQSocket</a></td></tr>
<tr class="memitem:a273cef9ecddf2bf79f8ad81086f1746c inherit pub_methods_classFairMQSocket"><td class="memItemLeft" align="right" valign="top"><a id="a273cef9ecddf2bf79f8ad81086f1746c"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>FairMQSocket</b> (<a class="el" href="classFairMQTransportFactory.html">FairMQTransportFactory</a> *fac)</td></tr>
<tr class="separator:a273cef9ecddf2bf79f8ad81086f1746c inherit pub_methods_classFairMQSocket"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aea39da19f1d31f18ce8cfc972f6a5b82 inherit pub_methods_classFairMQSocket"><td class="memItemLeft" align="right" valign="top"><a id="aea39da19f1d31f18ce8cfc972f6a5b82"></a>
<a class="el" href="classFairMQTransportFactory.html">FairMQTransportFactory</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>GetTransport</b> ()</td></tr>
<tr class="separator:aea39da19f1d31f18ce8cfc972f6a5b82 inherit pub_methods_classFairMQSocket"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4edaad30e0ac3861a257abf11eac707b inherit pub_methods_classFairMQSocket"><td class="memItemLeft" align="right" valign="top"><a id="a4edaad30e0ac3861a257abf11eac707b"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>SetTransport</b> (<a class="el" href="classFairMQTransportFactory.html">FairMQTransportFactory</a> *transport)</td></tr>
<tr class="separator:a4edaad30e0ac3861a257abf11eac707b inherit pub_methods_classFairMQSocket"><td class="memSeparator" colspan="2">&#160;</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&#160;</td><td class="memItemRight" valign="bottom"><b>Interrupt</b> ()</td></tr>
<tr class="separator:a01fd9776884ce32b48bc4e635aeb9359"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9b10eb9e7c1eaccce31bcd964e4e043f"><td class="memItemLeft" align="right" valign="top"><a id="a9b10eb9e7c1eaccce31bcd964e4e043f"></a>
static void&#160;</td><td class="memItemRight" valign="bottom"><b>Resume</b> ()</td></tr>
<tr class="separator:a9b10eb9e7c1eaccce31bcd964e4e043f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1a786e85a2b14123882379c1e04e1e59"><td class="memItemLeft" align="right" valign="top"><a id="a1a786e85a2b14123882379c1e04e1e59"></a>
static int&#160;</td><td class="memItemRight" valign="bottom"><b>GetConstant</b> (const std::string &amp;constant)</td></tr>
<tr class="separator:a1a786e85a2b14123882379c1e04e1e59"><td class="memSeparator" colspan="2">&#160;</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 -->
<p style="margin: 0 12px 10px 12px;"><a href="https://help.github.com/articles/github-privacy-statement/">privacy</a></p>
Reference in New Issue View Git Blame Copy Permalink