Mirror/FairMQ
1
0
Fork 0
mirror of https://github.com/FairRootGroup/FairMQ.git synced 2025-10-13 00:31:14 +00:00
Code Issues Packages Projects Releases Wiki Activity
gh-pages
FairMQ/v1.3.9/classFairMQChannel.html
Dennis Klein 95b8ff7858
Add API docs for 1.3.9
2019-08-07 18:00:46 +02:00

1427 lines
78 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>FairMQ: 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
&#160;<span id="projectnumber">1.3.9</span>
</div>
<div id="projectbrief">C++ Message Passing Framework</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;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&amp;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> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="#friends">Friends</a> &#124;
<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">
<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 &#160;</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">&#160;</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>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#ab681571de3ef6c1021b7981054d152f0">FairMQChannel</a> ()</td></tr>
<tr class="memdesc:ab681571de3ef6c1021b7981054d152f0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor. <br /></td></tr>
<tr class="separator:ab681571de3ef6c1021b7981054d152f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3223d192c795abb3f357df5883dd67f5"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#a3223d192c795abb3f357df5883dd67f5">FairMQChannel</a> (const std::string &amp;type, const std::string &amp;method, const std::string &amp;address)</td></tr>
<tr class="separator:a3223d192c795abb3f357df5883dd67f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0c44e61cd9e8153c7a0ed5903d2949c4"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#a0c44e61cd9e8153c7a0ed5903d2949c4">FairMQChannel</a> (const std::string &amp;name, const std::string &amp;type, std::shared_ptr&lt; <a class="el" href="classFairMQTransportFactory.html">FairMQTransportFactory</a> &gt; factory)</td></tr>
<tr class="separator:a0c44e61cd9e8153c7a0ed5903d2949c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9c411019f1ee1d0dcc9960ec5b2fde46"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#a9c411019f1ee1d0dcc9960ec5b2fde46">FairMQChannel</a> (const std::string &amp;name, const std::string &amp;type, const std::string &amp;method, const std::string &amp;address, std::shared_ptr&lt; <a class="el" href="classFairMQTransportFactory.html">FairMQTransportFactory</a> &gt; factory)</td></tr>
<tr class="separator:a9c411019f1ee1d0dcc9960ec5b2fde46"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0c6054e77d3152f3436acbfc9c85579a"><td class="memItemLeft" align="right" valign="top"><a id="a0c6054e77d3152f3436acbfc9c85579a"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#a0c6054e77d3152f3436acbfc9c85579a">FairMQChannel</a> (const <a class="el" href="classFairMQChannel.html">FairMQChannel</a> &amp;)</td></tr>
<tr class="memdesc:a0c6054e77d3152f3436acbfc9c85579a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy Constructor. <br /></td></tr>
<tr class="separator:a0c6054e77d3152f3436acbfc9c85579a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a04a9ac897488b2a4a5176b86f5e74483"><td class="memItemLeft" align="right" valign="top"><a id="a04a9ac897488b2a4a5176b86f5e74483"></a>
<a class="el" href="classFairMQChannel.html">FairMQChannel</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#a04a9ac897488b2a4a5176b86f5e74483">operator=</a> (const <a class="el" href="classFairMQChannel.html">FairMQChannel</a> &amp;)</td></tr>
<tr class="memdesc:a04a9ac897488b2a4a5176b86f5e74483"><td class="mdescLeft">&#160;</td><td class="mdescRight">Assignment operator. <br /></td></tr>
<tr class="separator:a04a9ac897488b2a4a5176b86f5e74483"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9f4ffef546b24680daf6d5f40efc848f"><td class="memItemLeft" align="right" valign="top"><a id="a9f4ffef546b24680daf6d5f40efc848f"></a>
virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#a9f4ffef546b24680daf6d5f40efc848f">~FairMQChannel</a> ()</td></tr>
<tr class="memdesc:a9f4ffef546b24680daf6d5f40efc848f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default destructor. <br /></td></tr>
<tr class="separator:a9f4ffef546b24680daf6d5f40efc848f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8f95faffe81596d8489e595e1cb1fcb0"><td class="memItemLeft" align="right" valign="top"><a id="a8f95faffe81596d8489e595e1cb1fcb0"></a>
<a class="el" href="classFairMQSocket.html">FairMQSocket</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>GetSocket</b> () const</td></tr>
<tr class="separator:a8f95faffe81596d8489e595e1cb1fcb0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acc43731c2f9603461c0a7a8e2de752fe"><td class="memItemLeft" align="right" valign="top"><a id="acc43731c2f9603461c0a7a8e2de752fe"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>Bind</b> (const std::string &amp;address)</td></tr>
<tr class="separator:acc43731c2f9603461c0a7a8e2de752fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8442b8ee4b13fd470616a9786100efb5"><td class="memItemLeft" align="right" valign="top"><a id="a8442b8ee4b13fd470616a9786100efb5"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>Connect</b> (const std::string &amp;address)</td></tr>
<tr class="separator:a8442b8ee4b13fd470616a9786100efb5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac7c5441656c1371462afb62fe9e1afb4"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#ac7c5441656c1371462afb62fe9e1afb4">GetChannelName</a> () const</td></tr>
<tr class="separator:ac7c5441656c1371462afb62fe9e1afb4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8e113286667571ab00d31b2b7f5df376"><td class="memItemLeft" align="right" valign="top"><a id="a8e113286667571ab00d31b2b7f5df376"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><b>GetName</b> () const</td></tr>
<tr class="separator:a8e113286667571ab00d31b2b7f5df376"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae190401eefb2f1dc6061b2ba17e4abcb"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#ae190401eefb2f1dc6061b2ba17e4abcb">GetChannelPrefix</a> () const</td></tr>
<tr class="separator:ae190401eefb2f1dc6061b2ba17e4abcb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a462065a7952cea444569fd5f9981891c"><td class="memItemLeft" align="right" valign="top"><a id="a462065a7952cea444569fd5f9981891c"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><b>GetPrefix</b> () const</td></tr>
<tr class="separator:a462065a7952cea444569fd5f9981891c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a163ff719378ab657c21e5b0555c9a31c"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#a163ff719378ab657c21e5b0555c9a31c">GetChannelIndex</a> () const</td></tr>
<tr class="separator:a163ff719378ab657c21e5b0555c9a31c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab5d01627fcf31643c3992388daa861e4"><td class="memItemLeft" align="right" valign="top"><a id="ab5d01627fcf31643c3992388daa861e4"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><b>GetIndex</b> () const</td></tr>
<tr class="separator:ab5d01627fcf31643c3992388daa861e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3de4aa00c6a17755fac60c5c2f97a22b"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#a3de4aa00c6a17755fac60c5c2f97a22b">GetType</a> () const</td></tr>
<tr class="separator:a3de4aa00c6a17755fac60c5c2f97a22b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a13254702e5c18ffc4c66b89af2315867"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#a13254702e5c18ffc4c66b89af2315867">GetMethod</a> () const</td></tr>
<tr class="separator:a13254702e5c18ffc4c66b89af2315867"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae6cf6eaca2cd489e7718123f764a5fd9"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#ae6cf6eaca2cd489e7718123f764a5fd9">GetAddress</a> () const</td></tr>
<tr class="separator:ae6cf6eaca2cd489e7718123f764a5fd9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a86025d3cfb14bb0ddf772df50326cdaa"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#a86025d3cfb14bb0ddf772df50326cdaa">GetTransportName</a> () const</td></tr>
<tr class="separator:a86025d3cfb14bb0ddf772df50326cdaa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae597404d6fe4209855e44bda8ee9a298"><td class="memItemLeft" align="right" valign="top">int&#160;</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">&#160;</td></tr>
<tr class="memitem:a7998ca57ca6842f52483103a386189a4"><td class="memItemLeft" align="right" valign="top">int&#160;</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">&#160;</td></tr>
<tr class="memitem:abc48790b56c92e1e7f71bf3a9057b8b4"><td class="memItemLeft" align="right" valign="top">int&#160;</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">&#160;</td></tr>
<tr class="memitem:a3247b369b02586543c3c4c62b2dd1ab8"><td class="memItemLeft" align="right" valign="top">int&#160;</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">&#160;</td></tr>
<tr class="memitem:afbc97ff72e152db5cb4f0c63f7e00243"><td class="memItemLeft" align="right" valign="top">int&#160;</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">&#160;</td></tr>
<tr class="memitem:af82cb56741d214bd4db0864e34d9cae3"><td class="memItemLeft" align="right" valign="top">int&#160;</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">&#160;</td></tr>
<tr class="memitem:a2b3d7467e1ee3c5f052efc4ef3ba09d3"><td class="memItemLeft" align="right" valign="top">int&#160;</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">&#160;</td></tr>
<tr class="memitem:a24199032d2bb90271517e82adfebb45d"><td class="memItemLeft" align="right" valign="top">int&#160;</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">&#160;</td></tr>
<tr class="memitem:ae4f8bc56c89538dbd7833f8bd5f2d0d2"><td class="memItemLeft" align="right" valign="top">bool&#160;</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">&#160;</td></tr>
<tr class="memitem:af9454c7d2ec6950764f3834158379e9b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#af9454c7d2ec6950764f3834158379e9b">UpdateType</a> (const std::string &amp;type)</td></tr>
<tr class="separator:af9454c7d2ec6950764f3834158379e9b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac67be0a888fb0ffa61633d28a5c37d18"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#ac67be0a888fb0ffa61633d28a5c37d18">UpdateMethod</a> (const std::string &amp;method)</td></tr>
<tr class="separator:ac67be0a888fb0ffa61633d28a5c37d18"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a015422384ffb47e8b9c667006a2dff60"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#a015422384ffb47e8b9c667006a2dff60">UpdateAddress</a> (const std::string &amp;address)</td></tr>
<tr class="separator:a015422384ffb47e8b9c667006a2dff60"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9dc3e2a4a3b3f02be98e2b4e5053a258"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#a9dc3e2a4a3b3f02be98e2b4e5053a258">UpdateTransport</a> (const std::string &amp;transport)</td></tr>
<tr class="separator:a9dc3e2a4a3b3f02be98e2b4e5053a258"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a041eafc10c70fa73bceaa10644db3e6c"><td class="memItemLeft" align="right" valign="top">void&#160;</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">&#160;</td></tr>
<tr class="memitem:aa0e59f516d68cdf82b8c4f6150624a0e"><td class="memItemLeft" align="right" valign="top">void&#160;</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">&#160;</td></tr>
<tr class="memitem:ac74bc8cbda6e2f7b50dd8c7b8643b9d5"><td class="memItemLeft" align="right" valign="top">void&#160;</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">&#160;</td></tr>
<tr class="memitem:a10e21a697526a8d07cb30e54ce77d675"><td class="memItemLeft" align="right" valign="top">void&#160;</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">&#160;</td></tr>
<tr class="memitem:ad077c46bafdaba0a7792458b41600571"><td class="memItemLeft" align="right" valign="top">void&#160;</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">&#160;</td></tr>
<tr class="memitem:a2202995e3281a8bc8fdee10c47ff52c4"><td class="memItemLeft" align="right" valign="top">void&#160;</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">&#160;</td></tr>
<tr class="memitem:a633ae618067a1b02280fb16cf4117b70"><td class="memItemLeft" align="right" valign="top">void&#160;</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">&#160;</td></tr>
<tr class="memitem:a7dc046299bc2a31135cf170f9952a1a2"><td class="memItemLeft" align="right" valign="top">void&#160;</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">&#160;</td></tr>
<tr class="memitem:af84f328394d7a2c8ac4252e8aa9c0c69"><td class="memItemLeft" align="right" valign="top">void&#160;</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">&#160;</td></tr>
<tr class="memitem:ace79c4f0a38ed550641a87a6b7e4ca05"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#ace79c4f0a38ed550641a87a6b7e4ca05">UpdateChannelName</a> (const std::string &amp;name)</td></tr>
<tr class="separator:ace79c4f0a38ed550641a87a6b7e4ca05"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7dd6f31b095b15a4624045ac259563ca"><td class="memItemLeft" align="right" valign="top"><a id="a7dd6f31b095b15a4624045ac259563ca"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>UpdateName</b> (const std::string &amp;name)</td></tr>
<tr class="separator:a7dd6f31b095b15a4624045ac259563ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae03deb5cf1ac72f7bcd492e1ebd9b8e7"><td class="memItemLeft" align="right" valign="top">bool&#160;</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">&#160;</td></tr>
<tr class="memitem:abe08e04a2395ef389df08bc058c36ae6"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#abe08e04a2395ef389df08bc058c36ae6">ValidateChannel</a> ()</td></tr>
<tr class="separator:abe08e04a2395ef389df08bc058c36ae6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab9a7fdf4097c67e4480d7f8dc5f88f8f"><td class="memItemLeft" align="right" valign="top">bool&#160;</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">&#160;</td></tr>
<tr class="memitem:a40f6e290850f84087301b286ad625602"><td class="memItemLeft" align="right" valign="top"><a id="a40f6e290850f84087301b286ad625602"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>Init</b> ()</td></tr>
<tr class="separator:a40f6e290850f84087301b286ad625602"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a81c75fa0c797cb8e553f34154093b297"><td class="memItemLeft" align="right" valign="top"><a id="a81c75fa0c797cb8e553f34154093b297"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>ConnectEndpoint</b> (const std::string &amp;endpoint)</td></tr>
<tr class="separator:a81c75fa0c797cb8e553f34154093b297"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeef94ffbd15b2c07aa9890d4232a0396"><td class="memItemLeft" align="right" valign="top"><a id="aeef94ffbd15b2c07aa9890d4232a0396"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>BindEndpoint</b> (std::string &amp;endpoint)</td></tr>
<tr class="separator:aeef94ffbd15b2c07aa9890d4232a0396"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a250519ab776f2904a0011246aca20dbf"><td class="memItemLeft" align="right" valign="top"><a id="a250519ab776f2904a0011246aca20dbf"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#a250519ab776f2904a0011246aca20dbf">ResetChannel</a> ()</td></tr>
<tr class="memdesc:a250519ab776f2904a0011246aca20dbf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Resets the channel (requires validation to be used again). <br /></td></tr>
<tr class="separator:a250519ab776f2904a0011246aca20dbf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a77613bb4abc5c29387cea3a4b93da3e0"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#a77613bb4abc5c29387cea3a4b93da3e0">Send</a> (FairMQMessagePtr &amp;msg, int sndTimeoutInMs=-1)</td></tr>
<tr class="separator:a77613bb4abc5c29387cea3a4b93da3e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aed602093bfb5637bc7aff1545757b9b4"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#aed602093bfb5637bc7aff1545757b9b4">Receive</a> (FairMQMessagePtr &amp;msg, int rcvTimeoutInMs=-1)</td></tr>
<tr class="separator:aed602093bfb5637bc7aff1545757b9b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a87eae6d11748e5dc5a26ce53d5bd413d"><td class="memItemLeft" align="right" valign="top"><a id="a87eae6d11748e5dc5a26ce53d5bd413d"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>SendAsync</b> (FairMQMessagePtr &amp;msg) __attribute__((deprecated(&quot;For non-blocking <a class="el" href="classFairMQChannel.html#a77613bb4abc5c29387cea3a4b93da3e0">Send</a></td></tr>
<tr class="separator:a87eae6d11748e5dc5a26ce53d5bd413d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a683778c562ffb39f63c4b729893c568c"><td class="memItemLeft" align="right" valign="top"><a id="a683778c562ffb39f63c4b729893c568c"></a>
return fSocket&#160;</td><td class="memItemRight" valign="bottom"><b>Send</b> (msg, 0)</td></tr>
<tr class="separator:a683778c562ffb39f63c4b729893c568c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8ef8d167d065e298934f77521dda78ec"><td class="memItemLeft" align="right" valign="top"><a id="a8ef8d167d065e298934f77521dda78ec"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>ReceiveAsync</b> (FairMQMessagePtr &amp;msg) __attribute__((deprecated(&quot;For non-blocking <a class="el" href="classFairMQChannel.html#aed602093bfb5637bc7aff1545757b9b4">Receive</a></td></tr>
<tr class="separator:a8ef8d167d065e298934f77521dda78ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2124f4418c6fc3a4585e11cab0a4260b"><td class="memItemLeft" align="right" valign="top"><a id="a2124f4418c6fc3a4585e11cab0a4260b"></a>
return fSocket&#160;</td><td class="memItemRight" valign="bottom"><b>Receive</b> (msg, 0)</td></tr>
<tr class="separator:a2124f4418c6fc3a4585e11cab0a4260b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af41430efc6cb963f57c861c1019b64f1"><td class="memItemLeft" align="right" valign="top">int64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#af41430efc6cb963f57c861c1019b64f1">Send</a> (std::vector&lt; FairMQMessagePtr &gt; &amp;msgVec, int sndTimeoutInMs=-1)</td></tr>
<tr class="separator:af41430efc6cb963f57c861c1019b64f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a260e3826ad87f232f978a00a6a3654cc"><td class="memItemLeft" align="right" valign="top">int64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#a260e3826ad87f232f978a00a6a3654cc">Receive</a> (std::vector&lt; FairMQMessagePtr &gt; &amp;msgVec, int rcvTimeoutInMs=-1)</td></tr>
<tr class="separator:a260e3826ad87f232f978a00a6a3654cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad15229d9cc2de259cc46244a583b4608"><td class="memItemLeft" align="right" valign="top"><a id="ad15229d9cc2de259cc46244a583b4608"></a>
int64_t&#160;</td><td class="memItemRight" valign="bottom"><b>SendAsync</b> (std::vector&lt; FairMQMessagePtr &gt; &amp;msgVec) __attribute__((deprecated(&quot;For non-blocking <a class="el" href="classFairMQChannel.html#a77613bb4abc5c29387cea3a4b93da3e0">Send</a></td></tr>
<tr class="separator:ad15229d9cc2de259cc46244a583b4608"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2da72cbfef39284fceae7598456d2629"><td class="memItemLeft" align="right" valign="top"><a id="a2da72cbfef39284fceae7598456d2629"></a>
return fSocket&#160;</td><td class="memItemRight" valign="bottom"><b>Send</b> (msgVec, 0)</td></tr>
<tr class="separator:a2da72cbfef39284fceae7598456d2629"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0b4b02b31023f602771adabfdc3e80a6"><td class="memItemLeft" align="right" valign="top"><a id="a0b4b02b31023f602771adabfdc3e80a6"></a>
int64_t&#160;</td><td class="memItemRight" valign="bottom"><b>ReceiveAsync</b> (std::vector&lt; FairMQMessagePtr &gt; &amp;msgVec) __attribute__((deprecated(&quot;For non-blocking <a class="el" href="classFairMQChannel.html#aed602093bfb5637bc7aff1545757b9b4">Receive</a></td></tr>
<tr class="separator:a0b4b02b31023f602771adabfdc3e80a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa91e104ef1728cfb0f1c772e72212388"><td class="memItemLeft" align="right" valign="top"><a id="aa91e104ef1728cfb0f1c772e72212388"></a>
return fSocket&#160;</td><td class="memItemRight" valign="bottom"><b>Receive</b> (msgVec, 0)</td></tr>
<tr class="separator:aa91e104ef1728cfb0f1c772e72212388"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a190b3a16e9320c6c49e349bca4bf70ef"><td class="memItemLeft" align="right" valign="top">int64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#a190b3a16e9320c6c49e349bca4bf70ef">Send</a> (<a class="el" href="classFairMQParts.html">FairMQParts</a> &amp;parts, int sndTimeoutInMs=-1)</td></tr>
<tr class="separator:a190b3a16e9320c6c49e349bca4bf70ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0a58c080d525b7e2e57cbb55a49c1c22"><td class="memItemLeft" align="right" valign="top">int64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#a0a58c080d525b7e2e57cbb55a49c1c22">Receive</a> (<a class="el" href="classFairMQParts.html">FairMQParts</a> &amp;parts, int rcvTimeoutInMs=-1)</td></tr>
<tr class="separator:a0a58c080d525b7e2e57cbb55a49c1c22"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1d4e7d79d12de4cf628d011bf5c5caf5"><td class="memItemLeft" align="right" valign="top"><a id="a1d4e7d79d12de4cf628d011bf5c5caf5"></a>
int64_t&#160;</td><td class="memItemRight" valign="bottom"><b>SendAsync</b> (<a class="el" href="classFairMQParts.html">FairMQParts</a> &amp;parts) __attribute__((deprecated(&quot;For non-blocking <a class="el" href="classFairMQChannel.html#a77613bb4abc5c29387cea3a4b93da3e0">Send</a></td></tr>
<tr class="separator:a1d4e7d79d12de4cf628d011bf5c5caf5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a03113be1eb2f38e56e9c67a3238b0abe"><td class="memItemLeft" align="right" valign="top"><a id="a03113be1eb2f38e56e9c67a3238b0abe"></a>
int64_t&#160;</td><td class="memItemRight" valign="bottom"><b>ReceiveAsync</b> (<a class="el" href="classFairMQParts.html">FairMQParts</a> &amp;parts) __attribute__((deprecated(&quot;For non-blocking <a class="el" href="classFairMQChannel.html#aed602093bfb5637bc7aff1545757b9b4">Receive</a></td></tr>
<tr class="separator:a03113be1eb2f38e56e9c67a3238b0abe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9ed0fd7637838c2507a8ed621522eb24"><td class="memItemLeft" align="right" valign="top"><a id="a9ed0fd7637838c2507a8ed621522eb24"></a>
unsigned long&#160;</td><td class="memItemRight" valign="bottom"><b>GetBytesTx</b> () const</td></tr>
<tr class="separator:a9ed0fd7637838c2507a8ed621522eb24"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a423cb478c878a2efb3e1aa4cb15d92de"><td class="memItemLeft" align="right" valign="top"><a id="a423cb478c878a2efb3e1aa4cb15d92de"></a>
unsigned long&#160;</td><td class="memItemRight" valign="bottom"><b>GetBytesRx</b> () const</td></tr>
<tr class="separator:a423cb478c878a2efb3e1aa4cb15d92de"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acca48aaf07fa902e825de87d55d2d956"><td class="memItemLeft" align="right" valign="top"><a id="acca48aaf07fa902e825de87d55d2d956"></a>
unsigned long&#160;</td><td class="memItemRight" valign="bottom"><b>GetMessagesTx</b> () const</td></tr>
<tr class="separator:acca48aaf07fa902e825de87d55d2d956"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8920f7b8bc440644c5d35529e99c527e"><td class="memItemLeft" align="right" valign="top"><a id="a8920f7b8bc440644c5d35529e99c527e"></a>
unsigned long&#160;</td><td class="memItemRight" valign="bottom"><b>GetMessagesRx</b> () const</td></tr>
<tr class="separator:a8920f7b8bc440644c5d35529e99c527e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4edc0da9bfb515774042e11b688ee5c7"><td class="memItemLeft" align="right" valign="top"><a id="a4edc0da9bfb515774042e11b688ee5c7"></a>
auto&#160;</td><td class="memItemRight" valign="bottom"><b>Transport</b> () -&gt; <a class="el" href="classFairMQTransportFactory.html">FairMQTransportFactory</a> *</td></tr>
<tr class="separator:a4edc0da9bfb515774042e11b688ee5c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2244184963e65a6bf73739f1670df233"><td class="memTemplParams" colspan="2"><a id="a2244184963e65a6bf73739f1670df233"></a>
template&lt;typename... Args&gt; </td></tr>
<tr class="memitem:a2244184963e65a6bf73739f1670df233"><td class="memTemplItemLeft" align="right" valign="top">FairMQMessagePtr&#160;</td><td class="memTemplItemRight" valign="bottom"><b>NewMessage</b> (Args &amp;&amp;... args)</td></tr>
<tr class="separator:a2244184963e65a6bf73739f1670df233"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0970345de6b782938a372bb8c9762f0a"><td class="memTemplParams" colspan="2"><a id="a0970345de6b782938a372bb8c9762f0a"></a>
template&lt;typename T &gt; </td></tr>
<tr class="memitem:a0970345de6b782938a372bb8c9762f0a"><td class="memTemplItemLeft" align="right" valign="top">FairMQMessagePtr&#160;</td><td class="memTemplItemRight" valign="bottom"><b>NewSimpleMessage</b> (const T &amp;data)</td></tr>
<tr class="separator:a0970345de6b782938a372bb8c9762f0a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a171ae6b18cdab6268c543ba2b814e823"><td class="memTemplParams" colspan="2"><a id="a171ae6b18cdab6268c543ba2b814e823"></a>
template&lt;typename T &gt; </td></tr>
<tr class="memitem:a171ae6b18cdab6268c543ba2b814e823"><td class="memTemplItemLeft" align="right" valign="top">FairMQMessagePtr&#160;</td><td class="memTemplItemRight" valign="bottom"><b>NewStaticMessage</b> (const T &amp;data)</td></tr>
<tr class="separator:a171ae6b18cdab6268c543ba2b814e823"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a3c96fc0a975d5f4fce294e4c9086634b"><td class="memItemLeft" align="right" valign="top"><a id="a3c96fc0a975d5f4fce294e4c9086634b"></a>
int use timeout version with timeout&#160;</td><td class="memItemRight" valign="bottom"><b>of</b>: <a class="el" href="classFairMQChannel.html#a77613bb4abc5c29387cea3a4b93da3e0">Send</a>(msg</td></tr>
<tr class="separator:a3c96fc0a975d5f4fce294e4c9086634b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1c2ad3f6999615c627dc9d78c87b26ed"><td class="memItemLeft" align="right" valign="top"><a id="a1c2ad3f6999615c627dc9d78c87b26ed"></a>
int use timeout version with timeout&#160;</td><td class="memItemRight" valign="bottom"><b>timeout</b></td></tr>
<tr class="separator:a1c2ad3f6999615c627dc9d78c87b26ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3c96fc0a975d5f4fce294e4c9086634b"><td class="memItemLeft" align="right" valign="top"><a id="a3c96fc0a975d5f4fce294e4c9086634b"></a>
int64_t use timeout version with timeout&#160;</td><td class="memItemRight" valign="bottom"><b>of</b>: <a class="el" href="classFairMQChannel.html#a77613bb4abc5c29387cea3a4b93da3e0">Send</a>(msgVec</td></tr>
<tr class="separator:a3c96fc0a975d5f4fce294e4c9086634b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1c2ad3f6999615c627dc9d78c87b26ed"><td class="memItemLeft" align="right" valign="top"><a id="a1c2ad3f6999615c627dc9d78c87b26ed"></a>
int64_t use timeout version with timeout&#160;</td><td class="memItemRight" valign="bottom"><b>timeout</b></td></tr>
<tr class="separator:a1c2ad3f6999615c627dc9d78c87b26ed"><td class="memSeparator" colspan="2">&#160;</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&#160;</td><td class="memItemRight" valign="bottom"><b>FairMQDevice</b></td></tr>
<tr class="separator:a682583bd45804c6c805b800825ff8b06"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a3223d192c795abb3f357df5883dd67f5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3223d192c795abb3f357df5883dd67f5">&#9670;&nbsp;</a></span>FairMQChannel() <span class="overload">[1/3]</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 &amp;&#160;</td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>method</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>address</em>&#160;</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">&#9670;&nbsp;</a></span>FairMQChannel() <span class="overload">[2/3]</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 &amp;&#160;</td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::shared_ptr&lt; <a class="el" href="classFairMQTransportFactory.html">FairMQTransportFactory</a> &gt;&#160;</td>
<td class="paramname"><em>factory</em>&#160;</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">&#9670;&nbsp;</a></span>FairMQChannel() <span class="overload">[3/3]</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 &amp;&#160;</td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>method</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>address</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::shared_ptr&lt; <a class="el" href="classFairMQTransportFactory.html">FairMQTransportFactory</a> &gt;&#160;</td>
<td class="paramname"><em>factory</em>&#160;</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>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ae6cf6eaca2cd489e7718123f764a5fd9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae6cf6eaca2cd489e7718123f764a5fd9">&#9670;&nbsp;</a></span>GetAddress()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string FairMQChannel::GetAddress </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</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">&#9670;&nbsp;</a></span>GetAutoBind()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool FairMQChannel::GetAutoBind </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</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="a163ff719378ab657c21e5b0555c9a31c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a163ff719378ab657c21e5b0555c9a31c">&#9670;&nbsp;</a></span>GetChannelIndex()</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::GetChannelIndex </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="ac7c5441656c1371462afb62fe9e1afb4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac7c5441656c1371462afb62fe9e1afb4">&#9670;&nbsp;</a></span>GetChannelName()</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::GetChannelName </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="ae190401eefb2f1dc6061b2ba17e4abcb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae190401eefb2f1dc6061b2ba17e4abcb">&#9670;&nbsp;</a></span>GetChannelPrefix()</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::GetChannelPrefix </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="afbc97ff72e152db5cb4f0c63f7e00243"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afbc97ff72e152db5cb4f0c63f7e00243">&#9670;&nbsp;</a></span>GetLinger()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int FairMQChannel::GetLinger </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</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="a13254702e5c18ffc4c66b89af2315867"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a13254702e5c18ffc4c66b89af2315867">&#9670;&nbsp;</a></span>GetMethod()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string FairMQChannel::GetMethod </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</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="a24199032d2bb90271517e82adfebb45d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a24199032d2bb90271517e82adfebb45d">&#9670;&nbsp;</a></span>GetPortRangeMax()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int FairMQChannel::GetPortRangeMax </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</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">&#9670;&nbsp;</a></span>GetPortRangeMin()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int FairMQChannel::GetPortRangeMin </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</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="af82cb56741d214bd4db0864e34d9cae3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af82cb56741d214bd4db0864e34d9cae3">&#9670;&nbsp;</a></span>GetRateLogging()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int FairMQChannel::GetRateLogging </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</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">&#9670;&nbsp;</a></span>GetRcvBufSize()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int FairMQChannel::GetRcvBufSize </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</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">&#9670;&nbsp;</a></span>GetRcvKernelSize()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int FairMQChannel::GetRcvKernelSize </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</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">&#9670;&nbsp;</a></span>GetSndBufSize()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int FairMQChannel::GetSndBufSize </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</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">&#9670;&nbsp;</a></span>GetSndKernelSize()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int FairMQChannel::GetSndKernelSize </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</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="a86025d3cfb14bb0ddf772df50326cdaa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a86025d3cfb14bb0ddf772df50326cdaa">&#9670;&nbsp;</a></span>GetTransportName()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string FairMQChannel::GetTransportName </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get channel transport ("default", "zeromq", "nanomsg" or "shmem") </p><dl class="section return"><dt>Returns</dt><dd>Returns channel transport (e.g. "default", "zeromq", "nanomsg" or "shmem") </dd></dl>
</div>
</div>
<a id="a3de4aa00c6a17755fac60c5c2f97a22b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3de4aa00c6a17755fac60c5c2f97a22b">&#9670;&nbsp;</a></span>GetType()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string FairMQChannel::GetType </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</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">&#9670;&nbsp;</a></span>IsValid()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool FairMQChannel::IsValid </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</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 <a class="el" href="classFairMQChannel.html#abe08e04a2395ef389df08bc058c36ae6">ValidateChannel()</a>)) </p><dl class="section return"><dt>Returns</dt><dd>true if channel settings are valid, false otherwise. </dd></dl>
</div>
</div>
<a id="aed602093bfb5637bc7aff1545757b9b4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aed602093bfb5637bc7aff1545757b9b4">&#9670;&nbsp;</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">int FairMQChannel::Receive </td>
<td>(</td>
<td class="paramtype">FairMQMessagePtr &amp;&#160;</td>
<td class="paramname"><em>msg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>rcvTimeoutInMs</em> = <code>-1</code>&#160;</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. -2 if reading from the queue was not possible or timed out. -1 if there was an error. </dd></dl>
</div>
</div>
<a id="a260e3826ad87f232f978a00a6a3654cc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a260e3826ad87f232f978a00a6a3654cc">&#9670;&nbsp;</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">std::vector&lt; FairMQMessagePtr &gt; &amp;&#160;</td>
<td class="paramname"><em>msgVec</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>rcvTimeoutInMs</em> = <code>-1</code>&#160;</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. -2 if reading from the queue was not possible or timed out. -1 if there was an error. </dd></dl>
</div>
</div>
<a id="a0a58c080d525b7e2e57cbb55a49c1c22"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0a58c080d525b7e2e57cbb55a49c1c22">&#9670;&nbsp;</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"><a class="el" href="classFairMQParts.html">FairMQParts</a> &amp;&#160;</td>
<td class="paramname"><em>parts</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>rcvTimeoutInMs</em> = <code>-1</code>&#160;</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. -2 if reading from the queue was not possible or timed out. -1 if there was an error. </dd></dl>
</div>
</div>
<a id="a77613bb4abc5c29387cea3a4b93da3e0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a77613bb4abc5c29387cea3a4b93da3e0">&#9670;&nbsp;</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">int FairMQChannel::Send </td>
<td>(</td>
<td class="paramtype">FairMQMessagePtr &amp;&#160;</td>
<td class="paramname"><em>msg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>sndTimeoutInMs</em> = <code>-1</code>&#160;</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. -2 If queueing was not possible or timed out. -1 if there was an error. </dd></dl>
</div>
</div>
<a id="af41430efc6cb963f57c861c1019b64f1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af41430efc6cb963f57c861c1019b64f1">&#9670;&nbsp;</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">std::vector&lt; FairMQMessagePtr &gt; &amp;&#160;</td>
<td class="paramname"><em>msgVec</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>sndTimeoutInMs</em> = <code>-1</code>&#160;</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. -2 If queueing was not possible or timed out. -1 if there was an error. </dd></dl>
</div>
</div>
<a id="a190b3a16e9320c6c49e349bca4bf70ef"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a190b3a16e9320c6c49e349bca4bf70ef">&#9670;&nbsp;</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"><a class="el" href="classFairMQParts.html">FairMQParts</a> &amp;&#160;</td>
<td class="paramname"><em>parts</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>sndTimeoutInMs</em> = <code>-1</code>&#160;</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. -2 If queueing was not possible or timed out. -1 if there was an error. </dd></dl>
</div>
</div>
<a id="a015422384ffb47e8b9c667006a2dff60"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a015422384ffb47e8b9c667006a2dff60">&#9670;&nbsp;</a></span>UpdateAddress()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FairMQChannel::UpdateAddress </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>address</em></td><td>)</td>
<td></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">&#9670;&nbsp;</a></span>UpdateAutoBind()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FairMQChannel::UpdateAutoBind </td>
<td>(</td>
<td class="paramtype">const bool&#160;</td>
<td class="paramname"><em>autobind</em></td><td>)</td>
<td></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="ace79c4f0a38ed550641a87a6b7e4ca05"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ace79c4f0a38ed550641a87a6b7e4ca05">&#9670;&nbsp;</a></span>UpdateChannelName()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void FairMQChannel::UpdateChannelName </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</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="ad077c46bafdaba0a7792458b41600571"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad077c46bafdaba0a7792458b41600571">&#9670;&nbsp;</a></span>UpdateLinger()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FairMQChannel::UpdateLinger </td>
<td>(</td>
<td class="paramtype">const int&#160;</td>
<td class="paramname"><em>duration</em></td><td>)</td>
<td></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">&#9670;&nbsp;</a></span>UpdateMethod()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FairMQChannel::UpdateMethod </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>method</em></td><td>)</td>
<td></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="a7dc046299bc2a31135cf170f9952a1a2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7dc046299bc2a31135cf170f9952a1a2">&#9670;&nbsp;</a></span>UpdatePortRangeMax()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FairMQChannel::UpdatePortRangeMax </td>
<td>(</td>
<td class="paramtype">const int&#160;</td>
<td class="paramname"><em>maxPort</em></td><td>)</td>
<td></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">&#9670;&nbsp;</a></span>UpdatePortRangeMin()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FairMQChannel::UpdatePortRangeMin </td>
<td>(</td>
<td class="paramtype">const int&#160;</td>
<td class="paramname"><em>minPort</em></td><td>)</td>
<td></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">&#9670;&nbsp;</a></span>UpdateRateLogging()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FairMQChannel::UpdateRateLogging </td>
<td>(</td>
<td class="paramtype">const int&#160;</td>
<td class="paramname"><em>rateLogging</em></td><td>)</td>
<td></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">&#9670;&nbsp;</a></span>UpdateRcvBufSize()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FairMQChannel::UpdateRcvBufSize </td>
<td>(</td>
<td class="paramtype">const int&#160;</td>
<td class="paramname"><em>rcvBufSize</em></td><td>)</td>
<td></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">&#9670;&nbsp;</a></span>UpdateRcvKernelSize()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FairMQChannel::UpdateRcvKernelSize </td>
<td>(</td>
<td class="paramtype">const int&#160;</td>
<td class="paramname"><em>rcvKernelSize</em></td><td>)</td>
<td></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">&#9670;&nbsp;</a></span>UpdateSndBufSize()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FairMQChannel::UpdateSndBufSize </td>
<td>(</td>
<td class="paramtype">const int&#160;</td>
<td class="paramname"><em>sndBufSize</em></td><td>)</td>
<td></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">&#9670;&nbsp;</a></span>UpdateSndKernelSize()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FairMQChannel::UpdateSndKernelSize </td>
<td>(</td>
<td class="paramtype">const int&#160;</td>
<td class="paramname"><em>sndKernelSize</em></td><td>)</td>
<td></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">&#9670;&nbsp;</a></span>UpdateTransport()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FairMQChannel::UpdateTransport </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>transport</em></td><td>)</td>
<td></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", "nanomsg" or "shmem") </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="af9454c7d2ec6950764f3834158379e9b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af9454c7d2ec6950764f3834158379e9b">&#9670;&nbsp;</a></span>UpdateType()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FairMQChannel::UpdateType </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>type</em></td><td>)</td>
<td></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">&#9670;&nbsp;</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>
<a id="abe08e04a2395ef389df08bc058c36ae6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abe08e04a2395ef389df08bc058c36ae6">&#9670;&nbsp;</a></span>ValidateChannel()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool FairMQChannel::ValidateChannel </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> </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>
Reference in New Issue View Git Blame Copy Permalink