mirror of
https://github.com/FairRootGroup/FairMQ.git
synced 2025-10-13 00:31:14 +00:00
1726 lines
86 KiB
HTML
1726 lines
86 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: FairMQChannel 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="#nested-classes">Classes</a> |
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pub-static-attribs">Static Public Attributes</a> |
|
|
<a href="#friends">Friends</a> |
|
|
<a href="classFairMQChannel-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">FairMQChannel Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Wrapper class for <a class="el" href="classFairMQSocket.html">FairMQSocket</a> and related methods.
|
|
<a href="classFairMQChannel.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="FairMQChannel_8h_source.html">FairMQChannel.h</a>></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
|
|
Classes</h2></td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structFairMQChannel_1_1ChannelConfigurationError.html">ChannelConfigurationError</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><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:ab681571de3ef6c1021b7981054d152f0"><td class="memItemLeft" align="right" valign="top"><a id="ab681571de3ef6c1021b7981054d152f0"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#ab681571de3ef6c1021b7981054d152f0">FairMQChannel</a> ()</td></tr>
|
|
<tr class="memdesc:ab681571de3ef6c1021b7981054d152f0"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br /></td></tr>
|
|
<tr class="separator:ab681571de3ef6c1021b7981054d152f0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acf2763fbdad18f5551ec7a3eb4e09829"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#acf2763fbdad18f5551ec7a3eb4e09829">FairMQChannel</a> (const std::string &name)</td></tr>
|
|
<tr class="separator:acf2763fbdad18f5551ec7a3eb4e09829"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3223d192c795abb3f357df5883dd67f5"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#a3223d192c795abb3f357df5883dd67f5">FairMQChannel</a> (const std::string &type, const std::string &method, const std::string &address)</td></tr>
|
|
<tr class="separator:a3223d192c795abb3f357df5883dd67f5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0c44e61cd9e8153c7a0ed5903d2949c4"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#a0c44e61cd9e8153c7a0ed5903d2949c4">FairMQChannel</a> (const std::string &name, const std::string &type, std::shared_ptr< <a class="el" href="classFairMQTransportFactory.html">FairMQTransportFactory</a> > factory)</td></tr>
|
|
<tr class="separator:a0c44e61cd9e8153c7a0ed5903d2949c4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9c411019f1ee1d0dcc9960ec5b2fde46"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#a9c411019f1ee1d0dcc9960ec5b2fde46">FairMQChannel</a> (const std::string &name, const std::string &type, const std::string &method, const std::string &address, std::shared_ptr< <a class="el" href="classFairMQTransportFactory.html">FairMQTransportFactory</a> > factory)</td></tr>
|
|
<tr class="separator:a9c411019f1ee1d0dcc9960ec5b2fde46"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9818fc56eeecda281a56538378541c7c"><td class="memItemLeft" align="right" valign="top"><a id="a9818fc56eeecda281a56538378541c7c"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>FairMQChannel</b> (const std::string &name, int index, const fair::mq::Properties &properties)</td></tr>
|
|
<tr class="separator:a9818fc56eeecda281a56538378541c7c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0c6054e77d3152f3436acbfc9c85579a"><td class="memItemLeft" align="right" valign="top"><a id="a0c6054e77d3152f3436acbfc9c85579a"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#a0c6054e77d3152f3436acbfc9c85579a">FairMQChannel</a> (const <a class="el" href="classFairMQChannel.html">FairMQChannel</a> &)</td></tr>
|
|
<tr class="memdesc:a0c6054e77d3152f3436acbfc9c85579a"><td class="mdescLeft"> </td><td class="mdescRight">Copy Constructor. <br /></td></tr>
|
|
<tr class="separator:a0c6054e77d3152f3436acbfc9c85579a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a837dbc5a66b93e002f430857c7695efe"><td class="memItemLeft" align="right" valign="top"><a id="a837dbc5a66b93e002f430857c7695efe"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#a837dbc5a66b93e002f430857c7695efe">FairMQChannel</a> (const <a class="el" href="classFairMQChannel.html">FairMQChannel</a> &, const std::string &name)</td></tr>
|
|
<tr class="memdesc:a837dbc5a66b93e002f430857c7695efe"><td class="mdescLeft"> </td><td class="mdescRight">Copy Constructor (with new name) <br /></td></tr>
|
|
<tr class="separator:a837dbc5a66b93e002f430857c7695efe"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a04a9ac897488b2a4a5176b86f5e74483"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classFairMQChannel.html">FairMQChannel</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#a04a9ac897488b2a4a5176b86f5e74483">operator=</a> (const <a class="el" href="classFairMQChannel.html">FairMQChannel</a> &)</td></tr>
|
|
<tr class="memdesc:a04a9ac897488b2a4a5176b86f5e74483"><td class="mdescLeft"> </td><td class="mdescRight">Move constructor. <a href="classFairMQChannel.html#a04a9ac897488b2a4a5176b86f5e74483">More...</a><br /></td></tr>
|
|
<tr class="separator:a04a9ac897488b2a4a5176b86f5e74483"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9f4ffef546b24680daf6d5f40efc848f"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#a9f4ffef546b24680daf6d5f40efc848f">~FairMQChannel</a> ()</td></tr>
|
|
<tr class="memdesc:a9f4ffef546b24680daf6d5f40efc848f"><td class="mdescLeft"> </td><td class="mdescRight">Move assignment operator. <a href="classFairMQChannel.html#a9f4ffef546b24680daf6d5f40efc848f">More...</a><br /></td></tr>
|
|
<tr class="separator:a9f4ffef546b24680daf6d5f40efc848f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1647387a5924f79abc7a376bc7787da9"><td class="memItemLeft" align="right" valign="top"><a id="a1647387a5924f79abc7a376bc7787da9"></a>
|
|
<a class="el" href="classFairMQSocket.html">FairMQSocket</a> & </td><td class="memItemRight" valign="bottom"><b>GetSocket</b> () const</td></tr>
|
|
<tr class="separator:a1647387a5924f79abc7a376bc7787da9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acc43731c2f9603461c0a7a8e2de752fe"><td class="memItemLeft" align="right" valign="top"><a id="acc43731c2f9603461c0a7a8e2de752fe"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><b>Bind</b> (const std::string &address)</td></tr>
|
|
<tr class="separator:acc43731c2f9603461c0a7a8e2de752fe"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8442b8ee4b13fd470616a9786100efb5"><td class="memItemLeft" align="right" valign="top"><a id="a8442b8ee4b13fd470616a9786100efb5"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><b>Connect</b> (const std::string &address)</td></tr>
|
|
<tr class="separator:a8442b8ee4b13fd470616a9786100efb5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9009e62346f999fbdbd79c82cdf3820c"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#a9009e62346f999fbdbd79c82cdf3820c">GetName</a> () const</td></tr>
|
|
<tr class="separator:a9009e62346f999fbdbd79c82cdf3820c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5bd5adc3c59f7606e0e868a0f17e28f5"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#a5bd5adc3c59f7606e0e868a0f17e28f5">GetPrefix</a> () const</td></tr>
|
|
<tr class="separator:a5bd5adc3c59f7606e0e868a0f17e28f5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8d6933d4d73d8fb9e18cf63800b1d8df"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#a8d6933d4d73d8fb9e18cf63800b1d8df">GetIndex</a> () const</td></tr>
|
|
<tr class="separator:a8d6933d4d73d8fb9e18cf63800b1d8df"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac7b933be2f610691dc24439d0d269383"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#ac7b933be2f610691dc24439d0d269383">GetType</a> () const</td></tr>
|
|
<tr class="separator:ac7b933be2f610691dc24439d0d269383"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a314c4760f1c420baed3d379a9da1041d"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#a314c4760f1c420baed3d379a9da1041d">GetMethod</a> () const</td></tr>
|
|
<tr class="separator:a314c4760f1c420baed3d379a9da1041d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4b68f42e263c0666e6bcc01c2e63c384"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#a4b68f42e263c0666e6bcc01c2e63c384">GetAddress</a> () const</td></tr>
|
|
<tr class="separator:a4b68f42e263c0666e6bcc01c2e63c384"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1521eb8016da9ffcb4b159423f8e971d"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#a1521eb8016da9ffcb4b159423f8e971d">GetTransportName</a> () const</td></tr>
|
|
<tr class="separator:a1521eb8016da9ffcb4b159423f8e971d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5f4210c9b05f5b38c2549bf2e65b7c45"><td class="memItemLeft" align="right" valign="top">fair::mq::Transport </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#a5f4210c9b05f5b38c2549bf2e65b7c45">GetTransportType</a> () const</td></tr>
|
|
<tr class="separator:a5f4210c9b05f5b38c2549bf2e65b7c45"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae597404d6fe4209855e44bda8ee9a298"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#ae597404d6fe4209855e44bda8ee9a298">GetSndBufSize</a> () const</td></tr>
|
|
<tr class="separator:ae597404d6fe4209855e44bda8ee9a298"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7998ca57ca6842f52483103a386189a4"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#a7998ca57ca6842f52483103a386189a4">GetRcvBufSize</a> () const</td></tr>
|
|
<tr class="separator:a7998ca57ca6842f52483103a386189a4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abc48790b56c92e1e7f71bf3a9057b8b4"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#abc48790b56c92e1e7f71bf3a9057b8b4">GetSndKernelSize</a> () const</td></tr>
|
|
<tr class="separator:abc48790b56c92e1e7f71bf3a9057b8b4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3247b369b02586543c3c4c62b2dd1ab8"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#a3247b369b02586543c3c4c62b2dd1ab8">GetRcvKernelSize</a> () const</td></tr>
|
|
<tr class="separator:a3247b369b02586543c3c4c62b2dd1ab8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afbc97ff72e152db5cb4f0c63f7e00243"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#afbc97ff72e152db5cb4f0c63f7e00243">GetLinger</a> () const</td></tr>
|
|
<tr class="separator:afbc97ff72e152db5cb4f0c63f7e00243"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af82cb56741d214bd4db0864e34d9cae3"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#af82cb56741d214bd4db0864e34d9cae3">GetRateLogging</a> () const</td></tr>
|
|
<tr class="separator:af82cb56741d214bd4db0864e34d9cae3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2b3d7467e1ee3c5f052efc4ef3ba09d3"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#a2b3d7467e1ee3c5f052efc4ef3ba09d3">GetPortRangeMin</a> () const</td></tr>
|
|
<tr class="separator:a2b3d7467e1ee3c5f052efc4ef3ba09d3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a24199032d2bb90271517e82adfebb45d"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#a24199032d2bb90271517e82adfebb45d">GetPortRangeMax</a> () const</td></tr>
|
|
<tr class="separator:a24199032d2bb90271517e82adfebb45d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae4f8bc56c89538dbd7833f8bd5f2d0d2"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#ae4f8bc56c89538dbd7833f8bd5f2d0d2">GetAutoBind</a> () const</td></tr>
|
|
<tr class="separator:ae4f8bc56c89538dbd7833f8bd5f2d0d2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7dd6f31b095b15a4624045ac259563ca"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#a7dd6f31b095b15a4624045ac259563ca">UpdateName</a> (const std::string &name)</td></tr>
|
|
<tr class="separator:a7dd6f31b095b15a4624045ac259563ca"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af9454c7d2ec6950764f3834158379e9b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#af9454c7d2ec6950764f3834158379e9b">UpdateType</a> (const std::string &type)</td></tr>
|
|
<tr class="separator:af9454c7d2ec6950764f3834158379e9b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac67be0a888fb0ffa61633d28a5c37d18"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#ac67be0a888fb0ffa61633d28a5c37d18">UpdateMethod</a> (const std::string &method)</td></tr>
|
|
<tr class="separator:ac67be0a888fb0ffa61633d28a5c37d18"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a015422384ffb47e8b9c667006a2dff60"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#a015422384ffb47e8b9c667006a2dff60">UpdateAddress</a> (const std::string &address)</td></tr>
|
|
<tr class="separator:a015422384ffb47e8b9c667006a2dff60"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9dc3e2a4a3b3f02be98e2b4e5053a258"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#a9dc3e2a4a3b3f02be98e2b4e5053a258">UpdateTransport</a> (const std::string &transport)</td></tr>
|
|
<tr class="separator:a9dc3e2a4a3b3f02be98e2b4e5053a258"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a041eafc10c70fa73bceaa10644db3e6c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#a041eafc10c70fa73bceaa10644db3e6c">UpdateSndBufSize</a> (const int sndBufSize)</td></tr>
|
|
<tr class="separator:a041eafc10c70fa73bceaa10644db3e6c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa0e59f516d68cdf82b8c4f6150624a0e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#aa0e59f516d68cdf82b8c4f6150624a0e">UpdateRcvBufSize</a> (const int rcvBufSize)</td></tr>
|
|
<tr class="separator:aa0e59f516d68cdf82b8c4f6150624a0e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac74bc8cbda6e2f7b50dd8c7b8643b9d5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#ac74bc8cbda6e2f7b50dd8c7b8643b9d5">UpdateSndKernelSize</a> (const int sndKernelSize)</td></tr>
|
|
<tr class="separator:ac74bc8cbda6e2f7b50dd8c7b8643b9d5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a10e21a697526a8d07cb30e54ce77d675"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#a10e21a697526a8d07cb30e54ce77d675">UpdateRcvKernelSize</a> (const int rcvKernelSize)</td></tr>
|
|
<tr class="separator:a10e21a697526a8d07cb30e54ce77d675"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad077c46bafdaba0a7792458b41600571"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#ad077c46bafdaba0a7792458b41600571">UpdateLinger</a> (const int duration)</td></tr>
|
|
<tr class="separator:ad077c46bafdaba0a7792458b41600571"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2202995e3281a8bc8fdee10c47ff52c4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#a2202995e3281a8bc8fdee10c47ff52c4">UpdateRateLogging</a> (const int rateLogging)</td></tr>
|
|
<tr class="separator:a2202995e3281a8bc8fdee10c47ff52c4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a633ae618067a1b02280fb16cf4117b70"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#a633ae618067a1b02280fb16cf4117b70">UpdatePortRangeMin</a> (const int minPort)</td></tr>
|
|
<tr class="separator:a633ae618067a1b02280fb16cf4117b70"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7dc046299bc2a31135cf170f9952a1a2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#a7dc046299bc2a31135cf170f9952a1a2">UpdatePortRangeMax</a> (const int maxPort)</td></tr>
|
|
<tr class="separator:a7dc046299bc2a31135cf170f9952a1a2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af84f328394d7a2c8ac4252e8aa9c0c69"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#af84f328394d7a2c8ac4252e8aa9c0c69">UpdateAutoBind</a> (const bool autobind)</td></tr>
|
|
<tr class="separator:af84f328394d7a2c8ac4252e8aa9c0c69"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae03deb5cf1ac72f7bcd492e1ebd9b8e7"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#ae03deb5cf1ac72f7bcd492e1ebd9b8e7">IsValid</a> () const</td></tr>
|
|
<tr class="separator:ae03deb5cf1ac72f7bcd492e1ebd9b8e7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab9a7fdf4097c67e4480d7f8dc5f88f8f"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#ab9a7fdf4097c67e4480d7f8dc5f88f8f">Validate</a> ()</td></tr>
|
|
<tr class="separator:ab9a7fdf4097c67e4480d7f8dc5f88f8f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a40f6e290850f84087301b286ad625602"><td class="memItemLeft" align="right" valign="top"><a id="a40f6e290850f84087301b286ad625602"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>Init</b> ()</td></tr>
|
|
<tr class="separator:a40f6e290850f84087301b286ad625602"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a81c75fa0c797cb8e553f34154093b297"><td class="memItemLeft" align="right" valign="top"><a id="a81c75fa0c797cb8e553f34154093b297"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><b>ConnectEndpoint</b> (const std::string &endpoint)</td></tr>
|
|
<tr class="separator:a81c75fa0c797cb8e553f34154093b297"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aeef94ffbd15b2c07aa9890d4232a0396"><td class="memItemLeft" align="right" valign="top"><a id="aeef94ffbd15b2c07aa9890d4232a0396"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><b>BindEndpoint</b> (std::string &endpoint)</td></tr>
|
|
<tr class="separator:aeef94ffbd15b2c07aa9890d4232a0396"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa5ea97bb9ebfe53796b3e59e18ec2266"><td class="memItemLeft" align="right" valign="top"><a id="aa5ea97bb9ebfe53796b3e59e18ec2266"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#aa5ea97bb9ebfe53796b3e59e18ec2266">Invalidate</a> ()</td></tr>
|
|
<tr class="memdesc:aa5ea97bb9ebfe53796b3e59e18ec2266"><td class="mdescLeft"> </td><td class="mdescRight">invalidates the channel (requires validation to be used again). <br /></td></tr>
|
|
<tr class="separator:aa5ea97bb9ebfe53796b3e59e18ec2266"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8be266eb34c0aa683674570866a7804d"><td class="memItemLeft" align="right" valign="top">int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#a8be266eb34c0aa683674570866a7804d">Send</a> (FairMQMessagePtr &msg, int sndTimeoutInMs=-1)</td></tr>
|
|
<tr class="separator:a8be266eb34c0aa683674570866a7804d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1f040835106f6b4fa735ca3d57491f75"><td class="memItemLeft" align="right" valign="top">int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#a1f040835106f6b4fa735ca3d57491f75">Receive</a> (FairMQMessagePtr &msg, int rcvTimeoutInMs=-1)</td></tr>
|
|
<tr class="separator:a1f040835106f6b4fa735ca3d57491f75"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af41430efc6cb963f57c861c1019b64f1"><td class="memItemLeft" align="right" valign="top">int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#af41430efc6cb963f57c861c1019b64f1">Send</a> (std::vector< FairMQMessagePtr > &msgVec, int sndTimeoutInMs=-1)</td></tr>
|
|
<tr class="separator:af41430efc6cb963f57c861c1019b64f1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a260e3826ad87f232f978a00a6a3654cc"><td class="memItemLeft" align="right" valign="top">int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#a260e3826ad87f232f978a00a6a3654cc">Receive</a> (std::vector< FairMQMessagePtr > &msgVec, int rcvTimeoutInMs=-1)</td></tr>
|
|
<tr class="separator:a260e3826ad87f232f978a00a6a3654cc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a190b3a16e9320c6c49e349bca4bf70ef"><td class="memItemLeft" align="right" valign="top">int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#a190b3a16e9320c6c49e349bca4bf70ef">Send</a> (<a class="el" href="classFairMQParts.html">FairMQParts</a> &parts, int sndTimeoutInMs=-1)</td></tr>
|
|
<tr class="separator:a190b3a16e9320c6c49e349bca4bf70ef"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0a58c080d525b7e2e57cbb55a49c1c22"><td class="memItemLeft" align="right" valign="top">int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#a0a58c080d525b7e2e57cbb55a49c1c22">Receive</a> (<a class="el" href="classFairMQParts.html">FairMQParts</a> &parts, int rcvTimeoutInMs=-1)</td></tr>
|
|
<tr class="separator:a0a58c080d525b7e2e57cbb55a49c1c22"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9ed0fd7637838c2507a8ed621522eb24"><td class="memItemLeft" align="right" valign="top"><a id="a9ed0fd7637838c2507a8ed621522eb24"></a>
|
|
unsigned long </td><td class="memItemRight" valign="bottom"><b>GetBytesTx</b> () const</td></tr>
|
|
<tr class="separator:a9ed0fd7637838c2507a8ed621522eb24"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a423cb478c878a2efb3e1aa4cb15d92de"><td class="memItemLeft" align="right" valign="top"><a id="a423cb478c878a2efb3e1aa4cb15d92de"></a>
|
|
unsigned long </td><td class="memItemRight" valign="bottom"><b>GetBytesRx</b> () const</td></tr>
|
|
<tr class="separator:a423cb478c878a2efb3e1aa4cb15d92de"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acca48aaf07fa902e825de87d55d2d956"><td class="memItemLeft" align="right" valign="top"><a id="acca48aaf07fa902e825de87d55d2d956"></a>
|
|
unsigned long </td><td class="memItemRight" valign="bottom"><b>GetMessagesTx</b> () const</td></tr>
|
|
<tr class="separator:acca48aaf07fa902e825de87d55d2d956"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8920f7b8bc440644c5d35529e99c527e"><td class="memItemLeft" align="right" valign="top"><a id="a8920f7b8bc440644c5d35529e99c527e"></a>
|
|
unsigned long </td><td class="memItemRight" valign="bottom"><b>GetMessagesRx</b> () const</td></tr>
|
|
<tr class="separator:a8920f7b8bc440644c5d35529e99c527e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4edc0da9bfb515774042e11b688ee5c7"><td class="memItemLeft" align="right" valign="top"><a id="a4edc0da9bfb515774042e11b688ee5c7"></a>
|
|
auto </td><td class="memItemRight" valign="bottom"><b>Transport</b> () -> <a class="el" href="classFairMQTransportFactory.html">FairMQTransportFactory</a> *</td></tr>
|
|
<tr class="separator:a4edc0da9bfb515774042e11b688ee5c7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2244184963e65a6bf73739f1670df233"><td class="memTemplParams" colspan="2"><a id="a2244184963e65a6bf73739f1670df233"></a>
|
|
template<typename... Args> </td></tr>
|
|
<tr class="memitem:a2244184963e65a6bf73739f1670df233"><td class="memTemplItemLeft" align="right" valign="top">FairMQMessagePtr </td><td class="memTemplItemRight" valign="bottom"><b>NewMessage</b> (Args &&... args)</td></tr>
|
|
<tr class="separator:a2244184963e65a6bf73739f1670df233"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0970345de6b782938a372bb8c9762f0a"><td class="memTemplParams" colspan="2"><a id="a0970345de6b782938a372bb8c9762f0a"></a>
|
|
template<typename T > </td></tr>
|
|
<tr class="memitem:a0970345de6b782938a372bb8c9762f0a"><td class="memTemplItemLeft" align="right" valign="top">FairMQMessagePtr </td><td class="memTemplItemRight" valign="bottom"><b>NewSimpleMessage</b> (const T &data)</td></tr>
|
|
<tr class="separator:a0970345de6b782938a372bb8c9762f0a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a171ae6b18cdab6268c543ba2b814e823"><td class="memTemplParams" colspan="2"><a id="a171ae6b18cdab6268c543ba2b814e823"></a>
|
|
template<typename T > </td></tr>
|
|
<tr class="memitem:a171ae6b18cdab6268c543ba2b814e823"><td class="memTemplItemLeft" align="right" valign="top">FairMQMessagePtr </td><td class="memTemplItemRight" valign="bottom"><b>NewStaticMessage</b> (const T &data)</td></tr>
|
|
<tr class="separator:a171ae6b18cdab6268c543ba2b814e823"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aec6262371a6cc6aefbbdecebc9243b9b"><td class="memTemplParams" colspan="2"><a id="aec6262371a6cc6aefbbdecebc9243b9b"></a>
|
|
template<typename... Args> </td></tr>
|
|
<tr class="memitem:aec6262371a6cc6aefbbdecebc9243b9b"><td class="memTemplItemLeft" align="right" valign="top">FairMQUnmanagedRegionPtr </td><td class="memTemplItemRight" valign="bottom"><b>NewUnmanagedRegion</b> (Args &&... args)</td></tr>
|
|
<tr class="separator:aec6262371a6cc6aefbbdecebc9243b9b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
|
|
Static Public Attributes</h2></td></tr>
|
|
<tr class="memitem:a0771937b56f8921e80b4cca59f6a8288"><td class="memItemLeft" align="right" valign="top"><a id="a0771937b56f8921e80b4cca59f6a8288"></a>
|
|
static constexpr fair::mq::Transport </td><td class="memItemRight" valign="bottom"><b>DefaultTransportType</b> = fair::mq::Transport::DEFAULT</td></tr>
|
|
<tr class="separator:a0771937b56f8921e80b4cca59f6a8288"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa4544defb411d328f17eb2431895078e"><td class="memItemLeft" align="right" valign="top"><a id="aa4544defb411d328f17eb2431895078e"></a>
|
|
static constexpr const char * </td><td class="memItemRight" valign="bottom"><b>DefaultTransportName</b> = "default"</td></tr>
|
|
<tr class="separator:aa4544defb411d328f17eb2431895078e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abf991aa988da6fba97111203d142d612"><td class="memItemLeft" align="right" valign="top"><a id="abf991aa988da6fba97111203d142d612"></a>
|
|
static constexpr const char * </td><td class="memItemRight" valign="bottom"><b>DefaultName</b> = ""</td></tr>
|
|
<tr class="separator:abf991aa988da6fba97111203d142d612"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae77dd21b6f5d49ec73f38fa4b570f573"><td class="memItemLeft" align="right" valign="top"><a id="ae77dd21b6f5d49ec73f38fa4b570f573"></a>
|
|
static constexpr const char * </td><td class="memItemRight" valign="bottom"><b>DefaultType</b> = "unspecified"</td></tr>
|
|
<tr class="separator:ae77dd21b6f5d49ec73f38fa4b570f573"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab6fb49d2a1b58ebba257d6fdbf1da6ac"><td class="memItemLeft" align="right" valign="top"><a id="ab6fb49d2a1b58ebba257d6fdbf1da6ac"></a>
|
|
static constexpr const char * </td><td class="memItemRight" valign="bottom"><b>DefaultMethod</b> = "unspecified"</td></tr>
|
|
<tr class="separator:ab6fb49d2a1b58ebba257d6fdbf1da6ac"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a794edeca7e9505870d8866499b5d6825"><td class="memItemLeft" align="right" valign="top"><a id="a794edeca7e9505870d8866499b5d6825"></a>
|
|
static constexpr const char * </td><td class="memItemRight" valign="bottom"><b>DefaultAddress</b> = "unspecified"</td></tr>
|
|
<tr class="separator:a794edeca7e9505870d8866499b5d6825"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a14a59b6d9b6a5351d6228a9fe5577d19"><td class="memItemLeft" align="right" valign="top"><a id="a14a59b6d9b6a5351d6228a9fe5577d19"></a>
|
|
static constexpr int </td><td class="memItemRight" valign="bottom"><b>DefaultSndBufSize</b> = 1000</td></tr>
|
|
<tr class="separator:a14a59b6d9b6a5351d6228a9fe5577d19"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9002d7d4adefd2de59089550e8c8abc6"><td class="memItemLeft" align="right" valign="top"><a id="a9002d7d4adefd2de59089550e8c8abc6"></a>
|
|
static constexpr int </td><td class="memItemRight" valign="bottom"><b>DefaultRcvBufSize</b> = 1000</td></tr>
|
|
<tr class="separator:a9002d7d4adefd2de59089550e8c8abc6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a34048a58ebf0e30c405ff5ef6efd35f3"><td class="memItemLeft" align="right" valign="top"><a id="a34048a58ebf0e30c405ff5ef6efd35f3"></a>
|
|
static constexpr int </td><td class="memItemRight" valign="bottom"><b>DefaultSndKernelSize</b> = 0</td></tr>
|
|
<tr class="separator:a34048a58ebf0e30c405ff5ef6efd35f3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0f19e895c5159efa68dd3895b9e0a78a"><td class="memItemLeft" align="right" valign="top"><a id="a0f19e895c5159efa68dd3895b9e0a78a"></a>
|
|
static constexpr int </td><td class="memItemRight" valign="bottom"><b>DefaultRcvKernelSize</b> = 0</td></tr>
|
|
<tr class="separator:a0f19e895c5159efa68dd3895b9e0a78a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1e8431140402d244dc0571e4a7ce0297"><td class="memItemLeft" align="right" valign="top"><a id="a1e8431140402d244dc0571e4a7ce0297"></a>
|
|
static constexpr int </td><td class="memItemRight" valign="bottom"><b>DefaultLinger</b> = 500</td></tr>
|
|
<tr class="separator:a1e8431140402d244dc0571e4a7ce0297"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a50da7116f275a95565cb2a34d6de5f1a"><td class="memItemLeft" align="right" valign="top"><a id="a50da7116f275a95565cb2a34d6de5f1a"></a>
|
|
static constexpr int </td><td class="memItemRight" valign="bottom"><b>DefaultRateLogging</b> = 1</td></tr>
|
|
<tr class="separator:a50da7116f275a95565cb2a34d6de5f1a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8055a69311783dd92e4f1a36f6d3b81e"><td class="memItemLeft" align="right" valign="top"><a id="a8055a69311783dd92e4f1a36f6d3b81e"></a>
|
|
static constexpr int </td><td class="memItemRight" valign="bottom"><b>DefaultPortRangeMin</b> = 22000</td></tr>
|
|
<tr class="separator:a8055a69311783dd92e4f1a36f6d3b81e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a95aae1891c3e1fcc0982a789926563bc"><td class="memItemLeft" align="right" valign="top"><a id="a95aae1891c3e1fcc0982a789926563bc"></a>
|
|
static constexpr int </td><td class="memItemRight" valign="bottom"><b>DefaultPortRangeMax</b> = 23000</td></tr>
|
|
<tr class="separator:a95aae1891c3e1fcc0982a789926563bc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4fbd55ed36ba901a97bdb8e48169fb5d"><td class="memItemLeft" align="right" valign="top"><a id="a4fbd55ed36ba901a97bdb8e48169fb5d"></a>
|
|
static constexpr bool </td><td class="memItemRight" valign="bottom"><b>DefaultAutoBind</b> = true</td></tr>
|
|
<tr class="separator:a4fbd55ed36ba901a97bdb8e48169fb5d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
|
|
Friends</h2></td></tr>
|
|
<tr class="memitem:a682583bd45804c6c805b800825ff8b06"><td class="memItemLeft" align="right" valign="top"><a id="a682583bd45804c6c805b800825ff8b06"></a>
|
|
class </td><td class="memItemRight" valign="bottom"><b>FairMQDevice</b></td></tr>
|
|
<tr class="separator:a682583bd45804c6c805b800825ff8b06"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Wrapper class for <a class="el" href="classFairMQSocket.html">FairMQSocket</a> and related methods. </p>
|
|
<p>The class is not thread-safe. </p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="acf2763fbdad18f5551ec7a3eb4e09829"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#acf2763fbdad18f5551ec7a3eb4e09829">◆ </a></span>FairMQChannel() <span class="overload">[1/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">FairMQChannel::FairMQChannel </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>name</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Constructor </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">name</td><td>Channel name </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3223d192c795abb3f357df5883dd67f5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3223d192c795abb3f357df5883dd67f5">◆ </a></span>FairMQChannel() <span class="overload">[2/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">FairMQChannel::FairMQChannel </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>type</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>method</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>address</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Constructor </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">type</td><td>Socket type (push/pull/pub/sub/spub/xsub/pair/req/rep/dealer/router/) </td></tr>
|
|
<tr><td class="paramname">method</td><td>Socket method (bind/connect) </td></tr>
|
|
<tr><td class="paramname">address</td><td>Network address to bind/connect to (e.g. "tcp://127.0.0.1:5555" or "ipc://abc") </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0c44e61cd9e8153c7a0ed5903d2949c4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0c44e61cd9e8153c7a0ed5903d2949c4">◆ </a></span>FairMQChannel() <span class="overload">[3/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">FairMQChannel::FairMQChannel </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>type</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">std::shared_ptr< <a class="el" href="classFairMQTransportFactory.html">FairMQTransportFactory</a> > </td>
|
|
<td class="paramname"><em>factory</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Constructor </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">name</td><td>Channel name </td></tr>
|
|
<tr><td class="paramname">type</td><td>Socket type (push/pull/pub/sub/spub/xsub/pair/req/rep/dealer/router/) </td></tr>
|
|
<tr><td class="paramname">factory</td><td>TransportFactory </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9c411019f1ee1d0dcc9960ec5b2fde46"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9c411019f1ee1d0dcc9960ec5b2fde46">◆ </a></span>FairMQChannel() <span class="overload">[4/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">FairMQChannel::FairMQChannel </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>type</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>method</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>address</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">std::shared_ptr< <a class="el" href="classFairMQTransportFactory.html">FairMQTransportFactory</a> > </td>
|
|
<td class="paramname"><em>factory</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Constructor </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">name</td><td>Channel name </td></tr>
|
|
<tr><td class="paramname">type</td><td>Socket type (push/pull/pub/sub/spub/xsub/pair/req/rep/dealer/router/) </td></tr>
|
|
<tr><td class="paramname">method</td><td>Socket method (bind/connect) </td></tr>
|
|
<tr><td class="paramname">address</td><td>Network address to bind/connect to (e.g. "tcp://127.0.0.1:5555" or "ipc://abc") </td></tr>
|
|
<tr><td class="paramname">factory</td><td>TransportFactory </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9f4ffef546b24680daf6d5f40efc848f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9f4ffef546b24680daf6d5f40efc848f">◆ </a></span>~FairMQChannel()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual FairMQChannel::~FairMQChannel </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Move assignment operator. </p>
|
|
<p>Destructor </p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a4b68f42e263c0666e6bcc01c2e63c384"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4b68f42e263c0666e6bcc01c2e63c384">◆ </a></span>GetAddress()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::string FairMQChannel::GetAddress </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Get socket address (e.g. "tcp://127.0.0.1:5555" or "ipc://abc") </p><dl class="section return"><dt>Returns</dt><dd>Returns socket address (e.g. "tcp://127.0.0.1:5555" or "ipc://abc") </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae4f8bc56c89538dbd7833f8bd5f2d0d2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae4f8bc56c89538dbd7833f8bd5f2d0d2">◆ </a></span>GetAutoBind()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool FairMQChannel::GetAutoBind </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Set automatic binding (pick random port if bind fails) </p><dl class="section return"><dt>Returns</dt><dd>true/false, true if automatic binding is enabled </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8d6933d4d73d8fb9e18cf63800b1d8df"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8d6933d4d73d8fb9e18cf63800b1d8df">◆ </a></span>GetIndex()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::string FairMQChannel::GetIndex </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Get channel index </p><dl class="section return"><dt>Returns</dt><dd>Returns channel index (e.g. 0 in "data[0]") </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="afbc97ff72e152db5cb4f0c63f7e00243"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afbc97ff72e152db5cb4f0c63f7e00243">◆ </a></span>GetLinger()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int FairMQChannel::GetLinger </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Get linger duration (in milliseconds) </p><dl class="section return"><dt>Returns</dt><dd>Returns linger duration (in milliseconds) </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a314c4760f1c420baed3d379a9da1041d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a314c4760f1c420baed3d379a9da1041d">◆ </a></span>GetMethod()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::string FairMQChannel::GetMethod </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Get socket method </p><dl class="section return"><dt>Returns</dt><dd>Returns socket method (bind/connect) </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9009e62346f999fbdbd79c82cdf3820c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9009e62346f999fbdbd79c82cdf3820c">◆ </a></span>GetName()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::string FairMQChannel::GetName </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Get channel name </p><dl class="section return"><dt>Returns</dt><dd>Returns full channel name (e.g. "data[0]") </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a24199032d2bb90271517e82adfebb45d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a24199032d2bb90271517e82adfebb45d">◆ </a></span>GetPortRangeMax()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int FairMQChannel::GetPortRangeMax </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Get end of the port range for automatic binding </p><dl class="section return"><dt>Returns</dt><dd>end of the port range </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2b3d7467e1ee3c5f052efc4ef3ba09d3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2b3d7467e1ee3c5f052efc4ef3ba09d3">◆ </a></span>GetPortRangeMin()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int FairMQChannel::GetPortRangeMin </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Get start of the port range for automatic binding </p><dl class="section return"><dt>Returns</dt><dd>start of the port range </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5bd5adc3c59f7606e0e868a0f17e28f5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5bd5adc3c59f7606e0e868a0f17e28f5">◆ </a></span>GetPrefix()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::string FairMQChannel::GetPrefix </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Get channel prefix </p><dl class="section return"><dt>Returns</dt><dd>Returns channel prefix (e.g. "data" in "data[0]") </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af82cb56741d214bd4db0864e34d9cae3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af82cb56741d214bd4db0864e34d9cae3">◆ </a></span>GetRateLogging()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int FairMQChannel::GetRateLogging </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Get socket rate logging interval (in seconds) </p><dl class="section return"><dt>Returns</dt><dd>Returns socket rate logging interval (in seconds) </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7998ca57ca6842f52483103a386189a4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7998ca57ca6842f52483103a386189a4">◆ </a></span>GetRcvBufSize()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int FairMQChannel::GetRcvBufSize </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Get socket receive buffer size (in number of messages) </p><dl class="section return"><dt>Returns</dt><dd>Returns socket receive buffer size (in number of messages) </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3247b369b02586543c3c4c62b2dd1ab8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3247b369b02586543c3c4c62b2dd1ab8">◆ </a></span>GetRcvKernelSize()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int FairMQChannel::GetRcvKernelSize </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Get socket kernel transmit receive buffer size (in bytes) </p><dl class="section return"><dt>Returns</dt><dd>Returns socket kernel transmit receive buffer size (in bytes) </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae597404d6fe4209855e44bda8ee9a298"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae597404d6fe4209855e44bda8ee9a298">◆ </a></span>GetSndBufSize()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int FairMQChannel::GetSndBufSize </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Get socket send buffer size (in number of messages) </p><dl class="section return"><dt>Returns</dt><dd>Returns socket send buffer size (in number of messages) </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abc48790b56c92e1e7f71bf3a9057b8b4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abc48790b56c92e1e7f71bf3a9057b8b4">◆ </a></span>GetSndKernelSize()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int FairMQChannel::GetSndKernelSize </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Get socket kernel transmit send buffer size (in bytes) </p><dl class="section return"><dt>Returns</dt><dd>Returns socket kernel transmit send buffer size (in bytes) </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1521eb8016da9ffcb4b159423f8e971d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1521eb8016da9ffcb4b159423f8e971d">◆ </a></span>GetTransportName()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::string FairMQChannel::GetTransportName </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Get channel transport name ("default", "zeromq" or "shmem") </p><dl class="section return"><dt>Returns</dt><dd>Returns channel transport name (e.g. "default", "zeromq" or "shmem") </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5f4210c9b05f5b38c2549bf2e65b7c45"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5f4210c9b05f5b38c2549bf2e65b7c45">◆ </a></span>GetTransportType()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">fair::mq::Transport FairMQChannel::GetTransportType </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Get channel transport type </p><dl class="section return"><dt>Returns</dt><dd>Returns channel transport type </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac7b933be2f610691dc24439d0d269383"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac7b933be2f610691dc24439d0d269383">◆ </a></span>GetType()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::string FairMQChannel::GetType </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Get socket type </p><dl class="section return"><dt>Returns</dt><dd>Returns socket type (push/pull/pub/sub/spub/xsub/pair/req/rep/dealer/router/) </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae03deb5cf1ac72f7bcd492e1ebd9b8e7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae03deb5cf1ac72f7bcd492e1ebd9b8e7">◆ </a></span>IsValid()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool FairMQChannel::IsValid </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Checks if the configured channel settings are valid (checks the validity parameter, without running full validation (as oposed to ValidateChannel())) </p><dl class="section return"><dt>Returns</dt><dd>true if channel settings are valid, false otherwise. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a04a9ac897488b2a4a5176b86f5e74483"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a04a9ac897488b2a4a5176b86f5e74483">◆ </a></span>operator=()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classFairMQChannel.html">FairMQChannel</a> & FairMQChannel::operator= </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classFairMQChannel.html">FairMQChannel</a> & </td>
|
|
<td class="paramname"><em>chan</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Move constructor. </p>
|
|
<p>Assignment operator </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1f040835106f6b4fa735ca3d57491f75"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1f040835106f6b4fa735ca3d57491f75">◆ </a></span>Receive() <span class="overload">[1/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int64_t FairMQChannel::Receive </td>
|
|
<td>(</td>
|
|
<td class="paramtype">FairMQMessagePtr & </td>
|
|
<td class="paramname"><em>msg</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>rcvTimeoutInMs</em> = <code>-1</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Receives a message from the socket queue. </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">msg</td><td>Constant reference of unique_ptr to a <a class="el" href="classFairMQMessage.html">FairMQMessage</a> </td></tr>
|
|
<tr><td class="paramname">rcvTimeoutInMs</td><td>receive timeout in ms. -1 will wait forever (or until interrupt (e.g. via state change)), 0 will not wait (return immediately if cannot receive) </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Number of bytes that have been received, TransferCode::timeout if timed out, TransferCode::error if there was an error, TransferCode::interrupted if interrupted (e.g. by requested state change) </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0a58c080d525b7e2e57cbb55a49c1c22"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0a58c080d525b7e2e57cbb55a49c1c22">◆ </a></span>Receive() <span class="overload">[2/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int64_t FairMQChannel::Receive </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classFairMQParts.html">FairMQParts</a> & </td>
|
|
<td class="paramname"><em>parts</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>rcvTimeoutInMs</em> = <code>-1</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Receive <a class="el" href="classFairMQParts.html" title="FairMQParts is a lightweight convenience wrapper around a vector of unique pointers to FairMQMessage,...">FairMQParts</a> </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">parts</td><td><a class="el" href="classFairMQParts.html" title="FairMQParts is a lightweight convenience wrapper around a vector of unique pointers to FairMQMessage,...">FairMQParts</a> reference </td></tr>
|
|
<tr><td class="paramname">rcvTimeoutInMs</td><td>receive timeout in ms. -1 will wait forever (or until interrupt (e.g. via state change)), 0 will not wait (return immediately if cannot receive) </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Number of bytes that have been received, TransferCode::timeout if timed out, TransferCode::error if there was an error, TransferCode::interrupted if interrupted (e.g. by requested state change) </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a260e3826ad87f232f978a00a6a3654cc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a260e3826ad87f232f978a00a6a3654cc">◆ </a></span>Receive() <span class="overload">[3/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int64_t FairMQChannel::Receive </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::vector< FairMQMessagePtr > & </td>
|
|
<td class="paramname"><em>msgVec</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>rcvTimeoutInMs</em> = <code>-1</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Receive a vector of messages </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">msgVec</td><td>message vector reference </td></tr>
|
|
<tr><td class="paramname">rcvTimeoutInMs</td><td>receive timeout in ms. -1 will wait forever (or until interrupt (e.g. via state change)), 0 will not wait (return immediately if cannot receive) </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Number of bytes that have been received, TransferCode::timeout if timed out, TransferCode::error if there was an error, TransferCode::interrupted if interrupted (e.g. by requested state change) </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8be266eb34c0aa683674570866a7804d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8be266eb34c0aa683674570866a7804d">◆ </a></span>Send() <span class="overload">[1/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int64_t FairMQChannel::Send </td>
|
|
<td>(</td>
|
|
<td class="paramtype">FairMQMessagePtr & </td>
|
|
<td class="paramname"><em>msg</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>sndTimeoutInMs</em> = <code>-1</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Sends a message to the socket queue. </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">msg</td><td>Constant reference of unique_ptr to a <a class="el" href="classFairMQMessage.html">FairMQMessage</a> </td></tr>
|
|
<tr><td class="paramname">sndTimeoutInMs</td><td>send timeout in ms. -1 will wait forever (or until interrupt (e.g. via state change)), 0 will not wait (return immediately if cannot send) </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Number of bytes that have been queued, TransferCode::timeout if timed out, TransferCode::error if there was an error, TransferCode::interrupted if interrupted (e.g. by requested state change) </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a190b3a16e9320c6c49e349bca4bf70ef"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a190b3a16e9320c6c49e349bca4bf70ef">◆ </a></span>Send() <span class="overload">[2/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int64_t FairMQChannel::Send </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classFairMQParts.html">FairMQParts</a> & </td>
|
|
<td class="paramname"><em>parts</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>sndTimeoutInMs</em> = <code>-1</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Send <a class="el" href="classFairMQParts.html" title="FairMQParts is a lightweight convenience wrapper around a vector of unique pointers to FairMQMessage,...">FairMQParts</a> </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">parts</td><td><a class="el" href="classFairMQParts.html" title="FairMQParts is a lightweight convenience wrapper around a vector of unique pointers to FairMQMessage,...">FairMQParts</a> reference </td></tr>
|
|
<tr><td class="paramname">sndTimeoutInMs</td><td>send timeout in ms. -1 will wait forever (or until interrupt (e.g. via state change)), 0 will not wait (return immediately if cannot send) </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Number of bytes that have been queued, TransferCode::timeout if timed out, TransferCode::error if there was an error, TransferCode::interrupted if interrupted (e.g. by requested state change) </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af41430efc6cb963f57c861c1019b64f1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af41430efc6cb963f57c861c1019b64f1">◆ </a></span>Send() <span class="overload">[3/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int64_t FairMQChannel::Send </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::vector< FairMQMessagePtr > & </td>
|
|
<td class="paramname"><em>msgVec</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>sndTimeoutInMs</em> = <code>-1</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Send a vector of messages </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">msgVec</td><td>message vector reference </td></tr>
|
|
<tr><td class="paramname">sndTimeoutInMs</td><td>send timeout in ms. -1 will wait forever (or until interrupt (e.g. via state change)), 0 will not wait (return immediately if cannot send) </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Number of bytes that have been queued, TransferCode::timeout if timed out, TransferCode::error if there was an error, TransferCode::interrupted if interrupted (e.g. by requested state change) </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a015422384ffb47e8b9c667006a2dff60"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a015422384ffb47e8b9c667006a2dff60">◆ </a></span>UpdateAddress()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void FairMQChannel::UpdateAddress </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>address</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Set socket address </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">Socket</td><td>address (e.g. "tcp://127.0.0.1:5555" or "ipc://abc") </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af84f328394d7a2c8ac4252e8aa9c0c69"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af84f328394d7a2c8ac4252e8aa9c0c69">◆ </a></span>UpdateAutoBind()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void FairMQChannel::UpdateAutoBind </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const bool </td>
|
|
<td class="paramname"><em>autobind</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Set automatic binding (pick random port if bind fails) </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">autobind</td><td>true/false, true to enable automatic binding </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad077c46bafdaba0a7792458b41600571"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad077c46bafdaba0a7792458b41600571">◆ </a></span>UpdateLinger()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void FairMQChannel::UpdateLinger </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const int </td>
|
|
<td class="paramname"><em>duration</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Set linger duration (in milliseconds) </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">duration</td><td>linger duration (in milliseconds) </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac67be0a888fb0ffa61633d28a5c37d18"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac67be0a888fb0ffa61633d28a5c37d18">◆ </a></span>UpdateMethod()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void FairMQChannel::UpdateMethod </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>method</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Set socket method </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">method</td><td>Socket method (bind/connect) </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7dd6f31b095b15a4624045ac259563ca"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7dd6f31b095b15a4624045ac259563ca">◆ </a></span>UpdateName()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void FairMQChannel::UpdateName </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>name</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Set channel name </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">name</td><td>Arbitrary channel name </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7dc046299bc2a31135cf170f9952a1a2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7dc046299bc2a31135cf170f9952a1a2">◆ </a></span>UpdatePortRangeMax()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void FairMQChannel::UpdatePortRangeMax </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const int </td>
|
|
<td class="paramname"><em>maxPort</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Set end of the port range for automatic binding </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">maxPort</td><td>end of the port range </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a633ae618067a1b02280fb16cf4117b70"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a633ae618067a1b02280fb16cf4117b70">◆ </a></span>UpdatePortRangeMin()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void FairMQChannel::UpdatePortRangeMin </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const int </td>
|
|
<td class="paramname"><em>minPort</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Set start of the port range for automatic binding </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">minPort</td><td>start of the port range </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2202995e3281a8bc8fdee10c47ff52c4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2202995e3281a8bc8fdee10c47ff52c4">◆ </a></span>UpdateRateLogging()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void FairMQChannel::UpdateRateLogging </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const int </td>
|
|
<td class="paramname"><em>rateLogging</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Set socket rate logging interval (in seconds) </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">rateLogging</td><td>Socket rate logging interval (in seconds) </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa0e59f516d68cdf82b8c4f6150624a0e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa0e59f516d68cdf82b8c4f6150624a0e">◆ </a></span>UpdateRcvBufSize()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void FairMQChannel::UpdateRcvBufSize </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const int </td>
|
|
<td class="paramname"><em>rcvBufSize</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Set socket receive buffer size </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">rcvBufSize</td><td>Socket receive buffer size (in number of messages) </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a10e21a697526a8d07cb30e54ce77d675"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a10e21a697526a8d07cb30e54ce77d675">◆ </a></span>UpdateRcvKernelSize()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void FairMQChannel::UpdateRcvKernelSize </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const int </td>
|
|
<td class="paramname"><em>rcvKernelSize</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Set socket kernel transmit receive buffer size (in bytes) </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">rcvKernelSize</td><td>Socket receive buffer size (in bytes) </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a041eafc10c70fa73bceaa10644db3e6c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a041eafc10c70fa73bceaa10644db3e6c">◆ </a></span>UpdateSndBufSize()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void FairMQChannel::UpdateSndBufSize </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const int </td>
|
|
<td class="paramname"><em>sndBufSize</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Set socket send buffer size </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">sndBufSize</td><td>Socket send buffer size (in number of messages) </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac74bc8cbda6e2f7b50dd8c7b8643b9d5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac74bc8cbda6e2f7b50dd8c7b8643b9d5">◆ </a></span>UpdateSndKernelSize()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void FairMQChannel::UpdateSndKernelSize </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const int </td>
|
|
<td class="paramname"><em>sndKernelSize</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Set socket kernel transmit send buffer size (in bytes) </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">sndKernelSize</td><td>Socket send buffer size (in bytes) </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9dc3e2a4a3b3f02be98e2b4e5053a258"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9dc3e2a4a3b3f02be98e2b4e5053a258">◆ </a></span>UpdateTransport()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void FairMQChannel::UpdateTransport </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>transport</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Set channel transport </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">transport</td><td>transport string ("default", "zeromq" or "shmem") </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af9454c7d2ec6950764f3834158379e9b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af9454c7d2ec6950764f3834158379e9b">◆ </a></span>UpdateType()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void FairMQChannel::UpdateType </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>type</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Set socket type </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">type</td><td>Socket type (push/pull/pub/sub/spub/xsub/pair/req/rep/dealer/router/) </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab9a7fdf4097c67e4480d7f8dc5f88f8f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab9a7fdf4097c67e4480d7f8dc5f88f8f">◆ </a></span>Validate()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool FairMQChannel::Validate </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Validates channel configuration </p><dl class="section return"><dt>Returns</dt><dd>true if channel settings are valid, false otherwise. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>fairmq/<a class="el" href="FairMQChannel_8h_source.html">FairMQChannel.h</a></li>
|
|
<li>fairmq/FairMQChannel.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>
|