mirror of
https://github.com/FairRootGroup/FairMQ.git
synced 2025-10-13 08:41:16 +00:00
169 lines
14 KiB
HTML
169 lines
14 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: FairMQSocket 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="classFairMQSocket-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">FairMQSocket Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="dynheader">
|
|
Inheritance diagram for FairMQSocket:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classFairMQSocket__inherit__graph.png" border="0" usemap="#FairMQSocket_inherit__map" alt="Inheritance graph"/></div>
|
|
<map name="FairMQSocket_inherit__map" id="FairMQSocket_inherit__map">
|
|
<area shape="rect" id="node2" href="classfair_1_1mq_1_1ofi_1_1Socket.html" title="fair::mq::ofi::Socket" alt="" coords="5,80,155,107"/>
|
|
<area shape="rect" id="node3" href="classFairMQSocketNN.html" title="FairMQSocketNN" alt="" coords="179,80,309,107"/>
|
|
<area shape="rect" id="node4" href="classFairMQSocketSHM.html" title="FairMQSocketSHM" alt="" coords="333,80,472,107"/>
|
|
<area shape="rect" id="node5" href="classFairMQSocketZMQ.html" title="FairMQSocketZMQ" alt="" coords="497,80,637,107"/>
|
|
</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:a79419c6f0e1e78926b3bd2090493411c"><td class="memItemLeft" align="right" valign="top"><a id="a79419c6f0e1e78926b3bd2090493411c"></a>
|
|
virtual std::string </td><td class="memItemRight" valign="bottom"><b>GetId</b> ()=0</td></tr>
|
|
<tr class="separator:a79419c6f0e1e78926b3bd2090493411c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0ac3cc59533aab58ef352ac671a7306c"><td class="memItemLeft" align="right" valign="top"><a id="a0ac3cc59533aab58ef352ac671a7306c"></a>
|
|
virtual bool </td><td class="memItemRight" valign="bottom"><b>Bind</b> (const std::string &address)=0</td></tr>
|
|
<tr class="separator:a0ac3cc59533aab58ef352ac671a7306c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab3d2b67f674ff7368059b98f885ec228"><td class="memItemLeft" align="right" valign="top"><a id="ab3d2b67f674ff7368059b98f885ec228"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><b>Connect</b> (const std::string &address)=0</td></tr>
|
|
<tr class="separator:ab3d2b67f674ff7368059b98f885ec228"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a615ca780f72641c0d741114f58e46672"><td class="memItemLeft" align="right" valign="top"><a id="a615ca780f72641c0d741114f58e46672"></a>
|
|
virtual int </td><td class="memItemRight" valign="bottom"><b>Send</b> (FairMQMessagePtr &msg, int timeout=0)=0</td></tr>
|
|
<tr class="separator:a615ca780f72641c0d741114f58e46672"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6f0f520ef461e894dcbe5bcacb6e5c08"><td class="memItemLeft" align="right" valign="top"><a id="a6f0f520ef461e894dcbe5bcacb6e5c08"></a>
|
|
virtual int </td><td class="memItemRight" valign="bottom"><b>Receive</b> (FairMQMessagePtr &msg, int timeout=0)=0</td></tr>
|
|
<tr class="separator:a6f0f520ef461e894dcbe5bcacb6e5c08"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8d45ce1e3097190470c3edd4d1c51ab2"><td class="memItemLeft" align="right" valign="top"><a id="a8d45ce1e3097190470c3edd4d1c51ab2"></a>
|
|
virtual 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, int timeout=0)=0</td></tr>
|
|
<tr class="separator:a8d45ce1e3097190470c3edd4d1c51ab2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a862bdea3e527c4cedb31087d84fff545"><td class="memItemLeft" align="right" valign="top"><a id="a862bdea3e527c4cedb31087d84fff545"></a>
|
|
virtual 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, int timeout=0)=0</td></tr>
|
|
<tr class="separator:a862bdea3e527c4cedb31087d84fff545"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5ff772e32924b9b72517803323483b74"><td class="memItemLeft" align="right" valign="top"><a id="a5ff772e32924b9b72517803323483b74"></a>
|
|
virtual int </td><td class="memItemRight" valign="bottom"><b>TrySend</b> (FairMQMessagePtr &msg)=0</td></tr>
|
|
<tr class="separator:a5ff772e32924b9b72517803323483b74"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a16480576f06b745be513905798a1d0b4"><td class="memItemLeft" align="right" valign="top"><a id="a16480576f06b745be513905798a1d0b4"></a>
|
|
virtual int </td><td class="memItemRight" valign="bottom"><b>TryReceive</b> (FairMQMessagePtr &msg)=0</td></tr>
|
|
<tr class="separator:a16480576f06b745be513905798a1d0b4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0f92652f3268358aaf2de048ad7fea17"><td class="memItemLeft" align="right" valign="top"><a id="a0f92652f3268358aaf2de048ad7fea17"></a>
|
|
virtual 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)=0</td></tr>
|
|
<tr class="separator:a0f92652f3268358aaf2de048ad7fea17"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac3b46e35fe445935baaa9c165a48ac18"><td class="memItemLeft" align="right" valign="top"><a id="ac3b46e35fe445935baaa9c165a48ac18"></a>
|
|
virtual 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)=0</td></tr>
|
|
<tr class="separator:ac3b46e35fe445935baaa9c165a48ac18"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a370c8b73de38f958838e3bfa72209efc"><td class="memItemLeft" align="right" valign="top"><a id="a370c8b73de38f958838e3bfa72209efc"></a>
|
|
virtual void * </td><td class="memItemRight" valign="bottom"><b>GetSocket</b> () const =0</td></tr>
|
|
<tr class="separator:a370c8b73de38f958838e3bfa72209efc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adf381693f11a5d2f6ea557eafcf3088b"><td class="memItemLeft" align="right" valign="top"><a id="adf381693f11a5d2f6ea557eafcf3088b"></a>
|
|
virtual int </td><td class="memItemRight" valign="bottom"><b>GetSocket</b> (int nothing) const =0</td></tr>
|
|
<tr class="separator:adf381693f11a5d2f6ea557eafcf3088b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a95b9db3c39fe9c0f54cb9176c97a5d50"><td class="memItemLeft" align="right" valign="top"><a id="a95b9db3c39fe9c0f54cb9176c97a5d50"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><b>Close</b> ()=0</td></tr>
|
|
<tr class="separator:a95b9db3c39fe9c0f54cb9176c97a5d50"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a30e1383b58388a9833ecb73d778bcdea"><td class="memItemLeft" align="right" valign="top"><a id="a30e1383b58388a9833ecb73d778bcdea"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><b>SetOption</b> (const std::string &option, const void *value, size_t valueSize)=0</td></tr>
|
|
<tr class="separator:a30e1383b58388a9833ecb73d778bcdea"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a36ae17ca3ce639e02391bf6814d21a3c"><td class="memItemLeft" align="right" valign="top"><a id="a36ae17ca3ce639e02391bf6814d21a3c"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><b>GetOption</b> (const std::string &option, void *value, size_t *valueSize)=0</td></tr>
|
|
<tr class="separator:a36ae17ca3ce639e02391bf6814d21a3c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1adf029bb12ab75937109291fa5cb186"><td class="memItemLeft" align="right" valign="top"><a id="a1adf029bb12ab75937109291fa5cb186"></a>
|
|
virtual unsigned long </td><td class="memItemRight" valign="bottom"><b>GetBytesTx</b> () const =0</td></tr>
|
|
<tr class="separator:a1adf029bb12ab75937109291fa5cb186"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2b5249fabf722a237235df2e3a8da4cf"><td class="memItemLeft" align="right" valign="top"><a id="a2b5249fabf722a237235df2e3a8da4cf"></a>
|
|
virtual unsigned long </td><td class="memItemRight" valign="bottom"><b>GetBytesRx</b> () const =0</td></tr>
|
|
<tr class="separator:a2b5249fabf722a237235df2e3a8da4cf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7da14a9f29796f902c2f994785cbee01"><td class="memItemLeft" align="right" valign="top"><a id="a7da14a9f29796f902c2f994785cbee01"></a>
|
|
virtual unsigned long </td><td class="memItemRight" valign="bottom"><b>GetMessagesTx</b> () const =0</td></tr>
|
|
<tr class="separator:a7da14a9f29796f902c2f994785cbee01"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a33c2d1ef36734c98b0ff48490af6b2e4"><td class="memItemLeft" align="right" valign="top"><a id="a33c2d1ef36734c98b0ff48490af6b2e4"></a>
|
|
virtual unsigned long </td><td class="memItemRight" valign="bottom"><b>GetMessagesRx</b> () const =0</td></tr>
|
|
<tr class="separator:a33c2d1ef36734c98b0ff48490af6b2e4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a789bdd02d40f75ba76568e4a3c28f660"><td class="memItemLeft" align="right" valign="top"><a id="a789bdd02d40f75ba76568e4a3c28f660"></a>
|
|
virtual bool </td><td class="memItemRight" valign="bottom"><b>SetSendTimeout</b> (const int timeout, const std::string &address, const std::string &method)=0</td></tr>
|
|
<tr class="separator:a789bdd02d40f75ba76568e4a3c28f660"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5ea8c1106f44c2fbba55ab94259b43d7"><td class="memItemLeft" align="right" valign="top"><a id="a5ea8c1106f44c2fbba55ab94259b43d7"></a>
|
|
virtual int </td><td class="memItemRight" valign="bottom"><b>GetSendTimeout</b> () const =0</td></tr>
|
|
<tr class="separator:a5ea8c1106f44c2fbba55ab94259b43d7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a95625c091a981d70da3ea94032d4f861"><td class="memItemLeft" align="right" valign="top"><a id="a95625c091a981d70da3ea94032d4f861"></a>
|
|
virtual bool </td><td class="memItemRight" valign="bottom"><b>SetReceiveTimeout</b> (const int timeout, const std::string &address, const std::string &method)=0</td></tr>
|
|
<tr class="separator:a95625c091a981d70da3ea94032d4f861"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3bce8f17b482601665724293f2a43244"><td class="memItemLeft" align="right" valign="top"><a id="a3bce8f17b482601665724293f2a43244"></a>
|
|
virtual int </td><td class="memItemRight" valign="bottom"><b>GetReceiveTimeout</b> () const =0</td></tr>
|
|
<tr class="separator:a3bce8f17b482601665724293f2a43244"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li>fairmq/<a class="el" href="FairMQSocket_8h_source.html">FairMQSocket.h</a></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>
|