mirror of
https://github.com/FairRootGroup/FairMQ.git
synced 2025-10-13 16:46:47 +00:00
208 lines
19 KiB
HTML
208 lines
19 KiB
HTML
<!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">
|
|
<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.15"/>
|
|
<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.3.9</span>
|
|
</div>
|
|
<div id="projectbrief">C++ Message Passing Framework</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.15 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&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&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> |
|
|
<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<span class="mlabels"><span class="mlabel">final</span></span></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" title=" " alt="" coords="5,80,140,107"/>
|
|
<area shape="rect" href="classFairMQSocket.html" title=" " 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 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" title=" " alt="" coords="5,80,140,107"/>
|
|
<area shape="rect" href="classFairMQSocket.html" title=" " 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:a5e5a8868e9d296bef95174d431e3c6af"><td class="memItemLeft" align="right" valign="top"><a id="a5e5a8868e9d296bef95174d431e3c6af"></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, <a class="el" href="classFairMQTransportFactory.html">FairMQTransportFactory</a> *fac=nullptr)</td></tr>
|
|
<tr class="separator:a5e5a8868e9d296bef95174d431e3c6af"><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:a5e5eb7fb421aad7d5ad70a01351ef807"><td class="memItemLeft" align="right" valign="top"><a id="a5e5eb7fb421aad7d5ad70a01351ef807"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><b>Connect</b> (const std::string &address) override</td></tr>
|
|
<tr class="separator:a5e5eb7fb421aad7d5ad70a01351ef807"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a007ba5888c20d718596cf21e434cf552"><td class="memItemLeft" align="right" valign="top"><a id="a007ba5888c20d718596cf21e434cf552"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><b>Send</b> (FairMQMessagePtr &msg, const int timeout=-1) override</td></tr>
|
|
<tr class="separator:a007ba5888c20d718596cf21e434cf552"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3c4f358ea653e5e8c0d78fa2584addb5"><td class="memItemLeft" align="right" valign="top"><a id="a3c4f358ea653e5e8c0d78fa2584addb5"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><b>Receive</b> (FairMQMessagePtr &msg, const int timeout=-1) override</td></tr>
|
|
<tr class="separator:a3c4f358ea653e5e8c0d78fa2584addb5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5ee1cb0e5a9f7ec4d1e2f89740ef382d"><td class="memItemLeft" align="right" valign="top"><a id="a5ee1cb0e5a9f7ec4d1e2f89740ef382d"></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=-1) override</td></tr>
|
|
<tr class="separator:a5ee1cb0e5a9f7ec4d1e2f89740ef382d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac9f8835cba582b47be2aa25f98312fd8"><td class="memItemLeft" align="right" valign="top"><a id="ac9f8835cba582b47be2aa25f98312fd8"></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=-1) override</td></tr>
|
|
<tr class="separator:ac9f8835cba582b47be2aa25f98312fd8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab5368650ff41703e9d1d12e53ff4bcd4"><td class="memItemLeft" align="right" valign="top"><a id="ab5368650ff41703e9d1d12e53ff4bcd4"></a>
|
|
void * </td><td class="memItemRight" valign="bottom"><b>GetSocket</b> () const</td></tr>
|
|
<tr class="separator:ab5368650ff41703e9d1d12e53ff4bcd4"><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:af833692ce555f319526be26f5af58ac5"><td class="memItemLeft" align="right" valign="top"><a id="af833692ce555f319526be26f5af58ac5"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>SetLinger</b> (const int value) override</td></tr>
|
|
<tr class="separator:af833692ce555f319526be26f5af58ac5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2ccd5f20d67d01e0275edda3a2032d46"><td class="memItemLeft" align="right" valign="top"><a id="a2ccd5f20d67d01e0275edda3a2032d46"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><b>GetLinger</b> () const override</td></tr>
|
|
<tr class="separator:a2ccd5f20d67d01e0275edda3a2032d46"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af70661c36518443c5856cf0f3b3b5a29"><td class="memItemLeft" align="right" valign="top"><a id="af70661c36518443c5856cf0f3b3b5a29"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>SetSndBufSize</b> (const int value) override</td></tr>
|
|
<tr class="separator:af70661c36518443c5856cf0f3b3b5a29"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af7f334d6d0cbd32a94e241358913a900"><td class="memItemLeft" align="right" valign="top"><a id="af7f334d6d0cbd32a94e241358913a900"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><b>GetSndBufSize</b> () const override</td></tr>
|
|
<tr class="separator:af7f334d6d0cbd32a94e241358913a900"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0f11a3345bd79bdb3707634f0e5dfd1a"><td class="memItemLeft" align="right" valign="top"><a id="a0f11a3345bd79bdb3707634f0e5dfd1a"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>SetRcvBufSize</b> (const int value) override</td></tr>
|
|
<tr class="separator:a0f11a3345bd79bdb3707634f0e5dfd1a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aec06784fc8b4b84c21e8fe1ede2c6fd8"><td class="memItemLeft" align="right" valign="top"><a id="aec06784fc8b4b84c21e8fe1ede2c6fd8"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><b>GetRcvBufSize</b> () const override</td></tr>
|
|
<tr class="separator:aec06784fc8b4b84c21e8fe1ede2c6fd8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aefb3be4e122ee639be76e181133aff9d"><td class="memItemLeft" align="right" valign="top"><a id="aefb3be4e122ee639be76e181133aff9d"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>SetSndKernelSize</b> (const int value) override</td></tr>
|
|
<tr class="separator:aefb3be4e122ee639be76e181133aff9d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7882316e8ec9ca3d798c591be4982f2a"><td class="memItemLeft" align="right" valign="top"><a id="a7882316e8ec9ca3d798c591be4982f2a"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><b>GetSndKernelSize</b> () const override</td></tr>
|
|
<tr class="separator:a7882316e8ec9ca3d798c591be4982f2a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa6cd5ba516da59c3d8348794a71a7596"><td class="memItemLeft" align="right" valign="top"><a id="aa6cd5ba516da59c3d8348794a71a7596"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>SetRcvKernelSize</b> (const int value) override</td></tr>
|
|
<tr class="separator:aa6cd5ba516da59c3d8348794a71a7596"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa32155555b3af7a912ecfbb7bd20a05e"><td class="memItemLeft" align="right" valign="top"><a id="aa32155555b3af7a912ecfbb7bd20a05e"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><b>GetRcvKernelSize</b> () const override</td></tr>
|
|
<tr class="separator:aa32155555b3af7a912ecfbb7bd20a05e"><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="inherit_header pub_methods_classFairMQSocket"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classFairMQSocket')"><img src="closed.png" alt="-"/> 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>
|
|
 </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"> </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> * </td><td class="memItemRight" valign="bottom"><b>GetTransport</b> ()</td></tr>
|
|
<tr class="separator:aea39da19f1d31f18ce8cfc972f6a5b82 inherit pub_methods_classFairMQSocket"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4edaad30e0ac3861a257abf11eac707b inherit pub_methods_classFairMQSocket"><td class="memItemLeft" align="right" valign="top"><a id="a4edaad30e0ac3861a257abf11eac707b"></a>
|
|
void </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"> </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 -->
|
|
<p style="margin: 0 12px 10px 12px;"><a href="https://help.github.com/articles/github-privacy-statement/">privacy</a></p>
|