mirror of
https://github.com/FairRootGroup/FairMQ.git
synced 2025-10-13 08:41:16 +00:00
206 lines
16 KiB
HTML
206 lines
16 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.18"/>
|
|
<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.4.33</span>
|
|
</div>
|
|
<div id="projectbrief">C++ Message Queuing Library and Framework</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.18 -->
|
|
<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="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" title=" " alt="" coords="213,5,324,32"/>
|
|
<area shape="rect" href="classfair_1_1mq_1_1ofi_1_1Socket.html" title=" " alt="" coords="5,80,153,107"/>
|
|
<area shape="rect" href="classfair_1_1mq_1_1shmem_1_1Socket.html" title=" " alt="" coords="178,80,359,107"/>
|
|
<area shape="rect" href="classfair_1_1mq_1_1zmq_1_1Socket.html" title=" " alt="" coords="383,80,543,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:a273cef9ecddf2bf79f8ad81086f1746c"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a408ee6a70fd8ed6d71cb29911c83d583"><td class="memItemLeft" align="right" valign="top"><a id="a408ee6a70fd8ed6d71cb29911c83d583"></a>
|
|
virtual std::string </td><td class="memItemRight" valign="bottom"><b>GetId</b> () const =0</td></tr>
|
|
<tr class="separator:a408ee6a70fd8ed6d71cb29911c83d583"><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:a677fa9df821927998e9aadd549d8c9a0"><td class="memItemLeft" align="right" valign="top"><a id="a677fa9df821927998e9aadd549d8c9a0"></a>
|
|
virtual bool </td><td class="memItemRight" valign="bottom"><b>Connect</b> (const std::string &address)=0</td></tr>
|
|
<tr class="separator:a677fa9df821927998e9aadd549d8c9a0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad927998610b402d7aa3979af1725b802"><td class="memItemLeft" align="right" valign="top"><a id="ad927998610b402d7aa3979af1725b802"></a>
|
|
virtual int64_t </td><td class="memItemRight" valign="bottom"><b>Send</b> (FairMQMessagePtr &msg, int timeout=-1)=0</td></tr>
|
|
<tr class="separator:ad927998610b402d7aa3979af1725b802"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae5121d84da689225d6156ebfb3795640"><td class="memItemLeft" align="right" valign="top"><a id="ae5121d84da689225d6156ebfb3795640"></a>
|
|
virtual int64_t </td><td class="memItemRight" valign="bottom"><b>Receive</b> (FairMQMessagePtr &msg, int timeout=-1)=0</td></tr>
|
|
<tr class="separator:ae5121d84da689225d6156ebfb3795640"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af49dde24bcbcd2b512f66a46ea1b7c95"><td class="memItemLeft" align="right" valign="top"><a id="af49dde24bcbcd2b512f66a46ea1b7c95"></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=-1)=0</td></tr>
|
|
<tr class="separator:af49dde24bcbcd2b512f66a46ea1b7c95"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae9aae949468daf6393f8e5c02602fd95"><td class="memItemLeft" align="right" valign="top"><a id="ae9aae949468daf6393f8e5c02602fd95"></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=-1)=0</td></tr>
|
|
<tr class="separator:ae9aae949468daf6393f8e5c02602fd95"><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:ac6a51dd23b0e3b01daf8bbc5b087ed78"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQSocket.html#ac6a51dd23b0e3b01daf8bbc5b087ed78">Events</a> (uint32_t *events)=0</td></tr>
|
|
<tr class="separator:ac6a51dd23b0e3b01daf8bbc5b087ed78"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9f0b2199e452929c32df5c014438770e"><td class="memItemLeft" align="right" valign="top"><a id="a9f0b2199e452929c32df5c014438770e"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><b>SetLinger</b> (const int value)=0</td></tr>
|
|
<tr class="separator:a9f0b2199e452929c32df5c014438770e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac6a72d001cb212747d96fa9f505bfa2c"><td class="memItemLeft" align="right" valign="top"><a id="ac6a72d001cb212747d96fa9f505bfa2c"></a>
|
|
virtual int </td><td class="memItemRight" valign="bottom"><b>GetLinger</b> () const =0</td></tr>
|
|
<tr class="separator:ac6a72d001cb212747d96fa9f505bfa2c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a39e1bc122b549c90a1626004761b5f8c"><td class="memItemLeft" align="right" valign="top"><a id="a39e1bc122b549c90a1626004761b5f8c"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><b>SetSndBufSize</b> (const int value)=0</td></tr>
|
|
<tr class="separator:a39e1bc122b549c90a1626004761b5f8c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5ae8ac0e4ec3658be30afd170847e585"><td class="memItemLeft" align="right" valign="top"><a id="a5ae8ac0e4ec3658be30afd170847e585"></a>
|
|
virtual int </td><td class="memItemRight" valign="bottom"><b>GetSndBufSize</b> () const =0</td></tr>
|
|
<tr class="separator:a5ae8ac0e4ec3658be30afd170847e585"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af401004e7bfa17477654fb8e74a4cb2f"><td class="memItemLeft" align="right" valign="top"><a id="af401004e7bfa17477654fb8e74a4cb2f"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><b>SetRcvBufSize</b> (const int value)=0</td></tr>
|
|
<tr class="separator:af401004e7bfa17477654fb8e74a4cb2f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab712baf6f275a4cdadece5461dc79b5b"><td class="memItemLeft" align="right" valign="top"><a id="ab712baf6f275a4cdadece5461dc79b5b"></a>
|
|
virtual int </td><td class="memItemRight" valign="bottom"><b>GetRcvBufSize</b> () const =0</td></tr>
|
|
<tr class="separator:ab712baf6f275a4cdadece5461dc79b5b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adfeb2ef50abf4d108102b662b7b1800f"><td class="memItemLeft" align="right" valign="top"><a id="adfeb2ef50abf4d108102b662b7b1800f"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><b>SetSndKernelSize</b> (const int value)=0</td></tr>
|
|
<tr class="separator:adfeb2ef50abf4d108102b662b7b1800f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6c4c72a9c09107b53cd40a319961f817"><td class="memItemLeft" align="right" valign="top"><a id="a6c4c72a9c09107b53cd40a319961f817"></a>
|
|
virtual int </td><td class="memItemRight" valign="bottom"><b>GetSndKernelSize</b> () const =0</td></tr>
|
|
<tr class="separator:a6c4c72a9c09107b53cd40a319961f817"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5d3aab781aa1cb19d38cb46011545019"><td class="memItemLeft" align="right" valign="top"><a id="a5d3aab781aa1cb19d38cb46011545019"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><b>SetRcvKernelSize</b> (const int value)=0</td></tr>
|
|
<tr class="separator:a5d3aab781aa1cb19d38cb46011545019"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae96adf1972eedadab02a16fce36a8616"><td class="memItemLeft" align="right" valign="top"><a id="ae96adf1972eedadab02a16fce36a8616"></a>
|
|
virtual int </td><td class="memItemRight" valign="bottom"><b>GetRcvKernelSize</b> () const =0</td></tr>
|
|
<tr class="separator:ae96adf1972eedadab02a16fce36a8616"><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:aea39da19f1d31f18ce8cfc972f6a5b82"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4edaad30e0ac3861a257abf11eac707b"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="ac6a51dd23b0e3b01daf8bbc5b087ed78"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac6a51dd23b0e3b01daf8bbc5b087ed78">◆ </a></span>Events()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void FairMQSocket::Events </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint32_t * </td>
|
|
<td class="paramname"><em>events</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>If the backend supports it, fills the unsigned integer <em>events</em> with the ZMQ_EVENTS value DISCLAIMER: this API is experimental and unsupported and might be dropped / refactored in the future. </p>
|
|
|
|
<p>Implemented in <a class="el" href="classfair_1_1mq_1_1shmem_1_1Socket.html#acd1bc3ce745e748eefad50ac19c175dd">fair::mq::shmem::Socket</a>, <a class="el" href="classfair_1_1mq_1_1zmq_1_1Socket.html#a163e97f44e4aa0e316bdb456813bbf78">fair::mq::zmq::Socket</a>, and <a class="el" href="classfair_1_1mq_1_1ofi_1_1Socket.html#a68d8ff414f5b6624ba3fdd387dc07fd0">fair::mq::ofi::Socket</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<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 -->
|
|
<p style="margin: 0 12px 10px 12px;"><a href="https://help.github.com/articles/github-privacy-statement/">privacy</a></p>
|