mirror of
https://github.com/FairRootGroup/FairMQ.git
synced 2025-10-13 08:41:16 +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: FairMQSocketSHM 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.3</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="classFairMQSocketSHM-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">FairMQSocketSHM Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="dynheader">
|
|
Inheritance diagram for FairMQSocketSHM:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classFairMQSocketSHM__inherit__graph.png" border="0" usemap="#FairMQSocketSHM_inherit__map" alt="Inheritance graph"/></div>
|
|
<map name="FairMQSocketSHM_inherit__map" id="FairMQSocketSHM_inherit__map">
|
|
<area shape="rect" id="node2" href="classFairMQSocket.html" title="FairMQSocket" alt="" coords="19,5,130,32"/>
|
|
</map>
|
|
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
|
|
<div class="dynheader">
|
|
Collaboration diagram for FairMQSocketSHM:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classFairMQSocketSHM__coll__graph.png" border="0" usemap="#FairMQSocketSHM_coll__map" alt="Collaboration graph"/></div>
|
|
<map name="FairMQSocketSHM_coll__map" id="FairMQSocketSHM_coll__map">
|
|
<area shape="rect" id="node2" href="classFairMQSocket.html" title="FairMQSocket" alt="" coords="19,5,130,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:aa194579df409dc4e9b79a5a150c2df9e"><td class="memItemLeft" align="right" valign="top"><a id="aa194579df409dc4e9b79a5a150c2df9e"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>FairMQSocketSHM</b> (<a class="el" href="classfair_1_1mq_1_1shmem_1_1Manager.html">fair::mq::shmem::Manager</a> &manager, const std::string &type, const std::string &name, const std::string &id="", void *context=nullptr)</td></tr>
|
|
<tr class="separator:aa194579df409dc4e9b79a5a150c2df9e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a11cbee7acada708ab82bc9a6671dc819"><td class="memItemLeft" align="right" valign="top"><a id="a11cbee7acada708ab82bc9a6671dc819"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>FairMQSocketSHM</b> (const <a class="el" href="classFairMQSocketSHM.html">FairMQSocketSHM</a> &)=delete</td></tr>
|
|
<tr class="separator:a11cbee7acada708ab82bc9a6671dc819"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a723a868d0abce8bc8d2e5c7ecfc68a1d"><td class="memItemLeft" align="right" valign="top"><a id="a723a868d0abce8bc8d2e5c7ecfc68a1d"></a>
|
|
<a class="el" href="classFairMQSocketSHM.html">FairMQSocketSHM</a> </td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classFairMQSocketSHM.html">FairMQSocketSHM</a> &)=delete</td></tr>
|
|
<tr class="separator:a723a868d0abce8bc8d2e5c7ecfc68a1d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6474373add512bf9c396c703eca1f706"><td class="memItemLeft" align="right" valign="top"><a id="a6474373add512bf9c396c703eca1f706"></a>
|
|
std::string </td><td class="memItemRight" valign="bottom"><b>GetId</b> () override</td></tr>
|
|
<tr class="separator:a6474373add512bf9c396c703eca1f706"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a24e611f2a718c5b3096912694bd9adb9"><td class="memItemLeft" align="right" valign="top"><a id="a24e611f2a718c5b3096912694bd9adb9"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><b>Bind</b> (const std::string &address) override</td></tr>
|
|
<tr class="separator:a24e611f2a718c5b3096912694bd9adb9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aae560b00329210c9a4cf7c2db1b8ab09"><td class="memItemLeft" align="right" valign="top"><a id="aae560b00329210c9a4cf7c2db1b8ab09"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>Connect</b> (const std::string &address) override</td></tr>
|
|
<tr class="separator:aae560b00329210c9a4cf7c2db1b8ab09"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad418d8dc11fde78117e59e7ebb00672b"><td class="memItemLeft" align="right" valign="top"><a id="ad418d8dc11fde78117e59e7ebb00672b"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><b>Send</b> (FairMQMessagePtr &msg, const int timeout=0) override</td></tr>
|
|
<tr class="separator:ad418d8dc11fde78117e59e7ebb00672b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a84a5dacba1d544cd94304a65b6f06d55"><td class="memItemLeft" align="right" valign="top"><a id="a84a5dacba1d544cd94304a65b6f06d55"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><b>Receive</b> (FairMQMessagePtr &msg, const int timeout=0) override</td></tr>
|
|
<tr class="separator:a84a5dacba1d544cd94304a65b6f06d55"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aeffb1117ae8d9e936c25540d630ef1c8"><td class="memItemLeft" align="right" valign="top"><a id="aeffb1117ae8d9e936c25540d630ef1c8"></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:aeffb1117ae8d9e936c25540d630ef1c8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2fd4ff5014d376989866ec54ff7e32ef"><td class="memItemLeft" align="right" valign="top"><a id="a2fd4ff5014d376989866ec54ff7e32ef"></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:a2fd4ff5014d376989866ec54ff7e32ef"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac224d55bba2bb6d5078d96c680b3ebbf"><td class="memItemLeft" align="right" valign="top"><a id="ac224d55bba2bb6d5078d96c680b3ebbf"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><b>TrySend</b> (FairMQMessagePtr &msg) override</td></tr>
|
|
<tr class="separator:ac224d55bba2bb6d5078d96c680b3ebbf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1d6a5a9ad5abbc9e94ffb15c837fd72b"><td class="memItemLeft" align="right" valign="top"><a id="a1d6a5a9ad5abbc9e94ffb15c837fd72b"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><b>TryReceive</b> (FairMQMessagePtr &msg) override</td></tr>
|
|
<tr class="separator:a1d6a5a9ad5abbc9e94ffb15c837fd72b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5ca8e3207f37adeb2a0d057cf557fd0c"><td class="memItemLeft" align="right" valign="top"><a id="a5ca8e3207f37adeb2a0d057cf557fd0c"></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:a5ca8e3207f37adeb2a0d057cf557fd0c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aca2f6e99de9d78bd51b9c23c0ce0b2ed"><td class="memItemLeft" align="right" valign="top"><a id="aca2f6e99de9d78bd51b9c23c0ce0b2ed"></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:aca2f6e99de9d78bd51b9c23c0ce0b2ed"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8084fcc69c3233032356b5d41a54ec9e"><td class="memItemLeft" align="right" valign="top"><a id="a8084fcc69c3233032356b5d41a54ec9e"></a>
|
|
void * </td><td class="memItemRight" valign="bottom"><b>GetSocket</b> () const override</td></tr>
|
|
<tr class="separator:a8084fcc69c3233032356b5d41a54ec9e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0b6ae8a1101a51b6f1e81bb520e0a2fb"><td class="memItemLeft" align="right" valign="top"><a id="a0b6ae8a1101a51b6f1e81bb520e0a2fb"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><b>GetSocket</b> (int nothing) const override</td></tr>
|
|
<tr class="separator:a0b6ae8a1101a51b6f1e81bb520e0a2fb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3cdbb5259b063fd9364e51fd2d5c1ba5"><td class="memItemLeft" align="right" valign="top"><a id="a3cdbb5259b063fd9364e51fd2d5c1ba5"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>Close</b> () override</td></tr>
|
|
<tr class="separator:a3cdbb5259b063fd9364e51fd2d5c1ba5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aaba511a635d28133b269dd7e32884e64"><td class="memItemLeft" align="right" valign="top"><a id="aaba511a635d28133b269dd7e32884e64"></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:aaba511a635d28133b269dd7e32884e64"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1a9db7193bf6c943793cc35fd5ee1c69"><td class="memItemLeft" align="right" valign="top"><a id="a1a9db7193bf6c943793cc35fd5ee1c69"></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:a1a9db7193bf6c943793cc35fd5ee1c69"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a91bd76b3fd70e72681cf4b2d6c4d6752"><td class="memItemLeft" align="right" valign="top"><a id="a91bd76b3fd70e72681cf4b2d6c4d6752"></a>
|
|
unsigned long </td><td class="memItemRight" valign="bottom"><b>GetBytesTx</b> () const override</td></tr>
|
|
<tr class="separator:a91bd76b3fd70e72681cf4b2d6c4d6752"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8db38ed07bfbb00c7b7f57aa1619e115"><td class="memItemLeft" align="right" valign="top"><a id="a8db38ed07bfbb00c7b7f57aa1619e115"></a>
|
|
unsigned long </td><td class="memItemRight" valign="bottom"><b>GetBytesRx</b> () const override</td></tr>
|
|
<tr class="separator:a8db38ed07bfbb00c7b7f57aa1619e115"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a88a997fd980f29057ae18dcc9a4d890d"><td class="memItemLeft" align="right" valign="top"><a id="a88a997fd980f29057ae18dcc9a4d890d"></a>
|
|
unsigned long </td><td class="memItemRight" valign="bottom"><b>GetMessagesTx</b> () const override</td></tr>
|
|
<tr class="separator:a88a997fd980f29057ae18dcc9a4d890d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7981e8041aeb630c86f146ad3002ec8f"><td class="memItemLeft" align="right" valign="top"><a id="a7981e8041aeb630c86f146ad3002ec8f"></a>
|
|
unsigned long </td><td class="memItemRight" valign="bottom"><b>GetMessagesRx</b> () const override</td></tr>
|
|
<tr class="separator:a7981e8041aeb630c86f146ad3002ec8f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aea322f74d1e8d7240f97d72cf1dfcf82"><td class="memItemLeft" align="right" valign="top"><a id="aea322f74d1e8d7240f97d72cf1dfcf82"></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:aea322f74d1e8d7240f97d72cf1dfcf82"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a860a256c7d4dbdeec13dadef7dc82a4f"><td class="memItemLeft" align="right" valign="top"><a id="a860a256c7d4dbdeec13dadef7dc82a4f"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><b>GetSendTimeout</b> () const override</td></tr>
|
|
<tr class="separator:a860a256c7d4dbdeec13dadef7dc82a4f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af480d7576329bbc889702d8dc4772658"><td class="memItemLeft" align="right" valign="top"><a id="af480d7576329bbc889702d8dc4772658"></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:af480d7576329bbc889702d8dc4772658"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acae65f7db82ca403371054dcea757ff7"><td class="memItemLeft" align="right" valign="top"><a id="acae65f7db82ca403371054dcea757ff7"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><b>GetReceiveTimeout</b> () const override</td></tr>
|
|
<tr class="separator:acae65f7db82ca403371054dcea757ff7"><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:aef8f4bf4ee68af9080aa3cc7669d782f"><td class="memItemLeft" align="right" valign="top"><a id="aef8f4bf4ee68af9080aa3cc7669d782f"></a>
|
|
static void </td><td class="memItemRight" valign="bottom"><b>Interrupt</b> ()</td></tr>
|
|
<tr class="separator:aef8f4bf4ee68af9080aa3cc7669d782f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a31f6951529374a87a5abd7a989207ee1"><td class="memItemLeft" align="right" valign="top"><a id="a31f6951529374a87a5abd7a989207ee1"></a>
|
|
static void </td><td class="memItemRight" valign="bottom"><b>Resume</b> ()</td></tr>
|
|
<tr class="separator:a31f6951529374a87a5abd7a989207ee1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afcf2dcb84e8a585e6c9b5f8be77b651e"><td class="memItemLeft" align="right" valign="top"><a id="afcf2dcb84e8a585e6c9b5f8be77b651e"></a>
|
|
static int </td><td class="memItemRight" valign="bottom"><b>GetConstant</b> (const std::string &constant)</td></tr>
|
|
<tr class="separator:afcf2dcb84e8a585e6c9b5f8be77b651e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>fairmq/shmem/<a class="el" href="FairMQSocketSHM_8h_source.html">FairMQSocketSHM.h</a></li>
|
|
<li>fairmq/shmem/FairMQSocketSHM.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>
|