mirror of
https://github.com/FairRootGroup/FairMQ.git
synced 2025-10-13 08:41:16 +00:00
212 lines
19 KiB
HTML
212 lines
19 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: fair::mq::ofi::Socket 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 id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="namespacefair.html">fair</a></li><li class="navelem"><b>mq</b></li><li class="navelem"><b>ofi</b></li><li class="navelem"><a class="el" href="classfair_1_1mq_1_1ofi_1_1Socket.html">Socket</a></li> </ul>
|
|
</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="classfair_1_1mq_1_1ofi_1_1Socket-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">fair::mq::ofi::Socket Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><code>#include <<a class="el" href="Socket_8h_source.html">fairmq/ofi/Socket.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for fair::mq::ofi::Socket:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classfair_1_1mq_1_1ofi_1_1Socket__inherit__graph.png" border="0" usemap="#fair_1_1mq_1_1ofi_1_1Socket_inherit__map" alt="Inheritance graph"/></div>
|
|
<map name="fair_1_1mq_1_1ofi_1_1Socket_inherit__map" id="fair_1_1mq_1_1ofi_1_1Socket_inherit__map">
|
|
<area shape="rect" id="node2" href="classFairMQSocket.html" title="fair::mq::Socket" alt="" coords="17,5,143,32"/>
|
|
</map>
|
|
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
|
|
<div class="dynheader">
|
|
Collaboration diagram for fair::mq::ofi::Socket:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classfair_1_1mq_1_1ofi_1_1Socket__coll__graph.png" border="0" usemap="#fair_1_1mq_1_1ofi_1_1Socket_coll__map" alt="Collaboration graph"/></div>
|
|
<map name="fair_1_1mq_1_1ofi_1_1Socket_coll__map" id="fair_1_1mq_1_1ofi_1_1Socket_coll__map">
|
|
<area shape="rect" id="node2" href="classFairMQSocket.html" title="fair::mq::Socket" alt="" coords="17,5,143,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:a6063959d46b77dd63284d1402825a0f3"><td class="memItemLeft" align="right" valign="top"><a id="a6063959d46b77dd63284d1402825a0f3"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>Socket</b> (<a class="el" href="classfair_1_1mq_1_1ofi_1_1Context.html">Context</a> &factory, const std::string &type, const std::string &name, const std::string &id="")</td></tr>
|
|
<tr class="separator:a6063959d46b77dd63284d1402825a0f3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a714165fefd4b4ccbd66f1e820df13e69"><td class="memItemLeft" align="right" valign="top"><a id="a714165fefd4b4ccbd66f1e820df13e69"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>Socket</b> (const <a class="el" href="classfair_1_1mq_1_1ofi_1_1Socket.html">Socket</a> &)=delete</td></tr>
|
|
<tr class="separator:a714165fefd4b4ccbd66f1e820df13e69"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aef8a900153e375eeb625371018e5da84"><td class="memItemLeft" align="right" valign="top"><a id="aef8a900153e375eeb625371018e5da84"></a>
|
|
<a class="el" href="classfair_1_1mq_1_1ofi_1_1Socket.html">Socket</a> </td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classfair_1_1mq_1_1ofi_1_1Socket.html">Socket</a> &)=delete</td></tr>
|
|
<tr class="separator:aef8a900153e375eeb625371018e5da84"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af5b00d89ea2cddf50ffc35f192c0c4ba"><td class="memItemLeft" align="right" valign="top"><a id="af5b00d89ea2cddf50ffc35f192c0c4ba"></a>
|
|
auto </td><td class="memItemRight" valign="bottom"><b>GetId</b> () -> std::string</td></tr>
|
|
<tr class="separator:af5b00d89ea2cddf50ffc35f192c0c4ba"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1ea643b5886d1a0dc40954f393c84ad6"><td class="memItemLeft" align="right" valign="top"><a id="a1ea643b5886d1a0dc40954f393c84ad6"></a>
|
|
auto </td><td class="memItemRight" valign="bottom"><b>Bind</b> (const std::string &address) -> bool override</td></tr>
|
|
<tr class="separator:a1ea643b5886d1a0dc40954f393c84ad6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad9fbfe77b1a7f28c9878ca37a729eae9"><td class="memItemLeft" align="right" valign="top"><a id="ad9fbfe77b1a7f28c9878ca37a729eae9"></a>
|
|
auto </td><td class="memItemRight" valign="bottom"><b>Connect</b> (const std::string &address) -> void override</td></tr>
|
|
<tr class="separator:ad9fbfe77b1a7f28c9878ca37a729eae9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a85f74054c42e2caf1ae663f7e951e765"><td class="memItemLeft" align="right" valign="top"><a id="a85f74054c42e2caf1ae663f7e951e765"></a>
|
|
auto </td><td class="memItemRight" valign="bottom"><b>Send</b> (MessagePtr &msg, int timeout=0) -> int override</td></tr>
|
|
<tr class="separator:a85f74054c42e2caf1ae663f7e951e765"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4e0024265e65289238c8363050e8f69d"><td class="memItemLeft" align="right" valign="top"><a id="a4e0024265e65289238c8363050e8f69d"></a>
|
|
auto </td><td class="memItemRight" valign="bottom"><b>Receive</b> (MessagePtr &msg, int timeout=0) -> int override</td></tr>
|
|
<tr class="separator:a4e0024265e65289238c8363050e8f69d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a32e62f4cc6469db613e4257af7841e6f"><td class="memItemLeft" align="right" valign="top"><a id="a32e62f4cc6469db613e4257af7841e6f"></a>
|
|
auto </td><td class="memItemRight" valign="bottom"><b>Send</b> (std::vector< MessagePtr > &msgVec, int timeout=0) -> int64_t override</td></tr>
|
|
<tr class="separator:a32e62f4cc6469db613e4257af7841e6f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7a8c3da1dd46f6afff8bdc6fad092e7e"><td class="memItemLeft" align="right" valign="top"><a id="a7a8c3da1dd46f6afff8bdc6fad092e7e"></a>
|
|
auto </td><td class="memItemRight" valign="bottom"><b>Receive</b> (std::vector< MessagePtr > &msgVec, int timeout=0) -> int64_t override</td></tr>
|
|
<tr class="separator:a7a8c3da1dd46f6afff8bdc6fad092e7e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7af974467c71d24b575f3cfa9e5e185e"><td class="memItemLeft" align="right" valign="top"><a id="a7af974467c71d24b575f3cfa9e5e185e"></a>
|
|
auto </td><td class="memItemRight" valign="bottom"><b>TrySend</b> (MessagePtr &msg) -> int override</td></tr>
|
|
<tr class="separator:a7af974467c71d24b575f3cfa9e5e185e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a47b017dbffa6232da40979caf6efeafd"><td class="memItemLeft" align="right" valign="top"><a id="a47b017dbffa6232da40979caf6efeafd"></a>
|
|
auto </td><td class="memItemRight" valign="bottom"><b>TryReceive</b> (MessagePtr &msg) -> int override</td></tr>
|
|
<tr class="separator:a47b017dbffa6232da40979caf6efeafd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a88e7e41b78a4e390b3975091af9f36aa"><td class="memItemLeft" align="right" valign="top"><a id="a88e7e41b78a4e390b3975091af9f36aa"></a>
|
|
auto </td><td class="memItemRight" valign="bottom"><b>TrySend</b> (std::vector< MessagePtr > &msgVec) -> int64_t override</td></tr>
|
|
<tr class="separator:a88e7e41b78a4e390b3975091af9f36aa"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4cb98beb98b47288cd232c241376c10f"><td class="memItemLeft" align="right" valign="top"><a id="a4cb98beb98b47288cd232c241376c10f"></a>
|
|
auto </td><td class="memItemRight" valign="bottom"><b>TryReceive</b> (std::vector< MessagePtr > &msgVec) -> int64_t override</td></tr>
|
|
<tr class="separator:a4cb98beb98b47288cd232c241376c10f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa3d98c823ebab5d6abc7e526d861a0ce"><td class="memItemLeft" align="right" valign="top"><a id="aa3d98c823ebab5d6abc7e526d861a0ce"></a>
|
|
auto </td><td class="memItemRight" valign="bottom"><b>GetSocket</b> () const -> void *override</td></tr>
|
|
<tr class="separator:aa3d98c823ebab5d6abc7e526d861a0ce"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4e62111926da131e32faa576a59eaa12"><td class="memItemLeft" align="right" valign="top"><a id="a4e62111926da131e32faa576a59eaa12"></a>
|
|
auto </td><td class="memItemRight" valign="bottom"><b>GetSocket</b> (int nothing) const -> int override</td></tr>
|
|
<tr class="separator:a4e62111926da131e32faa576a59eaa12"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3750a1c2491a1d07718eecaa457ea95a"><td class="memItemLeft" align="right" valign="top"><a id="a3750a1c2491a1d07718eecaa457ea95a"></a>
|
|
auto </td><td class="memItemRight" valign="bottom"><b>Close</b> () -> void override</td></tr>
|
|
<tr class="separator:a3750a1c2491a1d07718eecaa457ea95a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a967c5993a94e08c4e7f8c267724b005e"><td class="memItemLeft" align="right" valign="top"><a id="a967c5993a94e08c4e7f8c267724b005e"></a>
|
|
auto </td><td class="memItemRight" valign="bottom"><b>SetOption</b> (const std::string &option, const void *value, size_t valueSize) -> void override</td></tr>
|
|
<tr class="separator:a967c5993a94e08c4e7f8c267724b005e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2171b635c107241eab2aaf07808e444f"><td class="memItemLeft" align="right" valign="top"><a id="a2171b635c107241eab2aaf07808e444f"></a>
|
|
auto </td><td class="memItemRight" valign="bottom"><b>GetOption</b> (const std::string &option, void *value, size_t *valueSize) -> void override</td></tr>
|
|
<tr class="separator:a2171b635c107241eab2aaf07808e444f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a65624c2ffda95d6c840f983bb7c63230"><td class="memItemLeft" align="right" valign="top"><a id="a65624c2ffda95d6c840f983bb7c63230"></a>
|
|
auto </td><td class="memItemRight" valign="bottom"><b>GetBytesTx</b> () const -> unsigned long override</td></tr>
|
|
<tr class="separator:a65624c2ffda95d6c840f983bb7c63230"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:affed34906fb2238e33b7675b1d549088"><td class="memItemLeft" align="right" valign="top"><a id="affed34906fb2238e33b7675b1d549088"></a>
|
|
auto </td><td class="memItemRight" valign="bottom"><b>GetBytesRx</b> () const -> unsigned long override</td></tr>
|
|
<tr class="separator:affed34906fb2238e33b7675b1d549088"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a43bf947ac933dc797bfbcfd927fc97b4"><td class="memItemLeft" align="right" valign="top"><a id="a43bf947ac933dc797bfbcfd927fc97b4"></a>
|
|
auto </td><td class="memItemRight" valign="bottom"><b>GetMessagesTx</b> () const -> unsigned long override</td></tr>
|
|
<tr class="separator:a43bf947ac933dc797bfbcfd927fc97b4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0cda6f4ba1bd1443818c1ea2de8fc0ca"><td class="memItemLeft" align="right" valign="top"><a id="a0cda6f4ba1bd1443818c1ea2de8fc0ca"></a>
|
|
auto </td><td class="memItemRight" valign="bottom"><b>GetMessagesRx</b> () const -> unsigned long override</td></tr>
|
|
<tr class="separator:a0cda6f4ba1bd1443818c1ea2de8fc0ca"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aff704c489d9e4041269fc6ddc89cbb10"><td class="memItemLeft" align="right" valign="top"><a id="aff704c489d9e4041269fc6ddc89cbb10"></a>
|
|
auto </td><td class="memItemRight" valign="bottom"><b>SetSendTimeout</b> (const int timeout, const std::string &address, const std::string &method) -> bool override</td></tr>
|
|
<tr class="separator:aff704c489d9e4041269fc6ddc89cbb10"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3bc35abdea225da32171369e4db1af6c"><td class="memItemLeft" align="right" valign="top"><a id="a3bc35abdea225da32171369e4db1af6c"></a>
|
|
auto </td><td class="memItemRight" valign="bottom"><b>GetSendTimeout</b> () const -> int override</td></tr>
|
|
<tr class="separator:a3bc35abdea225da32171369e4db1af6c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afce5ac8af229dcb8a4f70077395a74e4"><td class="memItemLeft" align="right" valign="top"><a id="afce5ac8af229dcb8a4f70077395a74e4"></a>
|
|
auto </td><td class="memItemRight" valign="bottom"><b>SetReceiveTimeout</b> (const int timeout, const std::string &address, const std::string &method) -> bool override</td></tr>
|
|
<tr class="separator:afce5ac8af229dcb8a4f70077395a74e4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a55d11edaba6d8f6431afd9c1e1130d23"><td class="memItemLeft" align="right" valign="top"><a id="a55d11edaba6d8f6431afd9c1e1130d23"></a>
|
|
auto </td><td class="memItemRight" valign="bottom"><b>GetReceiveTimeout</b> () const -> int override</td></tr>
|
|
<tr class="separator:a55d11edaba6d8f6431afd9c1e1130d23"><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:a8d45ce1e3097190470c3edd4d1c51ab2 inherit pub_methods_classFairMQSocket"><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 inherit pub_methods_classFairMQSocket"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a862bdea3e527c4cedb31087d84fff545 inherit pub_methods_classFairMQSocket"><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 inherit pub_methods_classFairMQSocket"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0f92652f3268358aaf2de048ad7fea17 inherit pub_methods_classFairMQSocket"><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 inherit pub_methods_classFairMQSocket"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac3b46e35fe445935baaa9c165a48ac18 inherit pub_methods_classFairMQSocket"><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 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:ae265f9fa3ae59df70ea952ce2d5af89f"><td class="memItemLeft" align="right" valign="top"><a id="ae265f9fa3ae59df70ea952ce2d5af89f"></a>
|
|
static auto </td><td class="memItemRight" valign="bottom"><b>GetConstant</b> (const std::string &constant) -> int</td></tr>
|
|
<tr class="separator:ae265f9fa3ae59df70ea952ce2d5af89f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><dl class="todo"><dt><b><a class="el" href="todo.html#_todo000004">Todo:</a></b></dt><dd>TODO insert long description </dd></dl>
|
|
</div><hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>fairmq/ofi/<a class="el" href="Socket_8h_source.html">Socket.h</a></li>
|
|
<li>fairmq/ofi/Socket.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>
|