mirror of
https://github.com/FairRootGroup/FairMQ.git
synced 2025-10-13 08:41:16 +00:00
1078 lines
61 KiB
HTML
1078 lines
61 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.13"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>FairMQ: 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.2.3</span>
|
|
</div>
|
|
<div id="projectbrief">C++ Message Passing Framework</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.13 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</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">
|
|
<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: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: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:a04a9ac897488b2a4a5176b86f5e74483"><td class="memItemLeft" align="right" valign="top"><a id="a04a9ac897488b2a4a5176b86f5e74483"></a>
|
|
<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">Assignment operator. <br /></td></tr>
|
|
<tr class="separator:a04a9ac897488b2a4a5176b86f5e74483"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a182d59e06c4159fd3666a399903afe53"><td class="memItemLeft" align="right" valign="top"><a id="a182d59e06c4159fd3666a399903afe53"></a>
|
|
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#a182d59e06c4159fd3666a399903afe53">~FairMQChannel</a> ()</td></tr>
|
|
<tr class="memdesc:a182d59e06c4159fd3666a399903afe53"><td class="mdescLeft"> </td><td class="mdescRight">Default destructor. <br /></td></tr>
|
|
<tr class="separator:a182d59e06c4159fd3666a399903afe53"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3421f1d189a6d2944c8dd099726ae794"><td class="memItemLeft" align="right" valign="top"><a id="a3421f1d189a6d2944c8dd099726ae794"></a>
|
|
<a class="el" href="classFairMQSocket.html">FairMQSocket</a> const & </td><td class="memItemRight" valign="bottom"><b>GetSocket</b> () const</td></tr>
|
|
<tr class="separator:a3421f1d189a6d2944c8dd099726ae794"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6822a9054f6a64153ffee21425a541bb"><td class="memItemLeft" align="right" valign="top"><a id="a6822a9054f6a64153ffee21425a541bb"></a>
|
|
auto </td><td class="memItemRight" valign="bottom"><b>Bind</b> (const std::string &address) -> bool</td></tr>
|
|
<tr class="separator:a6822a9054f6a64153ffee21425a541bb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1ee3251d0b9bfb33bebe0bfa0b40b31e"><td class="memItemLeft" align="right" valign="top"><a id="a1ee3251d0b9bfb33bebe0bfa0b40b31e"></a>
|
|
auto </td><td class="memItemRight" valign="bottom"><b>Connect</b> (const std::string &address) -> void</td></tr>
|
|
<tr class="separator:a1ee3251d0b9bfb33bebe0bfa0b40b31e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3932fbe30d89c23042591876c5059a57"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#a3932fbe30d89c23042591876c5059a57">GetChannelName</a> () const</td></tr>
|
|
<tr class="separator:a3932fbe30d89c23042591876c5059a57"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8b6d12b655c253d10d167fbc66b266fa"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#a8b6d12b655c253d10d167fbc66b266fa">GetChannelPrefix</a> () const</td></tr>
|
|
<tr class="separator:a8b6d12b655c253d10d167fbc66b266fa"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a55be4a9a41be4a15c588f5e487fb2622"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#a55be4a9a41be4a15c588f5e487fb2622">GetChannelIndex</a> () const</td></tr>
|
|
<tr class="separator:a55be4a9a41be4a15c588f5e487fb2622"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3de4aa00c6a17755fac60c5c2f97a22b"><td class="memItemLeft" align="right" valign="top">std::string </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"> </td></tr>
|
|
<tr class="memitem:a13254702e5c18ffc4c66b89af2315867"><td class="memItemLeft" align="right" valign="top">std::string </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"> </td></tr>
|
|
<tr class="memitem:ae6cf6eaca2cd489e7718123f764a5fd9"><td class="memItemLeft" align="right" valign="top">std::string </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"> </td></tr>
|
|
<tr class="memitem:a86025d3cfb14bb0ddf772df50326cdaa"><td class="memItemLeft" align="right" valign="top">std::string </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"> </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: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: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: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:ace79c4f0a38ed550641a87a6b7e4ca05"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#ace79c4f0a38ed550641a87a6b7e4ca05">UpdateChannelName</a> (const std::string &name)</td></tr>
|
|
<tr class="separator:ace79c4f0a38ed550641a87a6b7e4ca05"><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:abe08e04a2395ef389df08bc058c36ae6"><td class="memItemLeft" align="right" valign="top">bool </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"> </td></tr>
|
|
<tr class="memitem:a250519ab776f2904a0011246aca20dbf"><td class="memItemLeft" align="right" valign="top"><a id="a250519ab776f2904a0011246aca20dbf"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#a250519ab776f2904a0011246aca20dbf">ResetChannel</a> ()</td></tr>
|
|
<tr class="memdesc:a250519ab776f2904a0011246aca20dbf"><td class="mdescLeft"> </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"> </td></tr>
|
|
<tr class="memitem:a239419e74740dab12f3eac064f776ee9"><td class="memItemLeft" align="right" valign="top"><a id="a239419e74740dab12f3eac064f776ee9"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><b>Send</b> (std::unique_ptr< <a class="el" href="classFairMQMessage.html">FairMQMessage</a> > &msg) const</td></tr>
|
|
<tr class="separator:a239419e74740dab12f3eac064f776ee9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8c983b3196ab3633db4009539592820a"><td class="memItemLeft" align="right" valign="top"><a id="a8c983b3196ab3633db4009539592820a"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><b>Receive</b> (std::unique_ptr< <a class="el" href="classFairMQMessage.html">FairMQMessage</a> > &msg) const</td></tr>
|
|
<tr class="separator:a8c983b3196ab3633db4009539592820a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a57f5497eb39bba8bfa158f42e51b3bc9"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#a57f5497eb39bba8bfa158f42e51b3bc9">Send</a> (std::unique_ptr< <a class="el" href="classFairMQMessage.html">FairMQMessage</a> > &msg, int sndTimeoutInMs) const</td></tr>
|
|
<tr class="separator:a57f5497eb39bba8bfa158f42e51b3bc9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a799456b290526b3310926ebc54b7a58f"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#a799456b290526b3310926ebc54b7a58f">Receive</a> (std::unique_ptr< <a class="el" href="classFairMQMessage.html">FairMQMessage</a> > &msg, int rcvTimeoutInMs) const</td></tr>
|
|
<tr class="separator:a799456b290526b3310926ebc54b7a58f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aac3f51ae7dd8b389e30bfdce6497ca42"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#aac3f51ae7dd8b389e30bfdce6497ca42">SendAsync</a> (std::unique_ptr< <a class="el" href="classFairMQMessage.html">FairMQMessage</a> > &msg) const</td></tr>
|
|
<tr class="separator:aac3f51ae7dd8b389e30bfdce6497ca42"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a12d63a39074f227cde82c919c5775a61"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#a12d63a39074f227cde82c919c5775a61">ReceiveAsync</a> (std::unique_ptr< <a class="el" href="classFairMQMessage.html">FairMQMessage</a> > &msg) const</td></tr>
|
|
<tr class="separator:a12d63a39074f227cde82c919c5775a61"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a922f885ea4b77dc6cca50c87ced55007"><td class="memItemLeft" align="right" valign="top"><a id="a922f885ea4b77dc6cca50c87ced55007"></a>
|
|
int64_t </td><td class="memItemRight" valign="bottom"><b>Send</b> (std::vector< std::unique_ptr< <a class="el" href="classFairMQMessage.html">FairMQMessage</a> >> &msgVec) const</td></tr>
|
|
<tr class="separator:a922f885ea4b77dc6cca50c87ced55007"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a814e59078db620881643d5e6a14c4b0c"><td class="memItemLeft" align="right" valign="top"><a id="a814e59078db620881643d5e6a14c4b0c"></a>
|
|
int64_t </td><td class="memItemRight" valign="bottom"><b>Receive</b> (std::vector< std::unique_ptr< <a class="el" href="classFairMQMessage.html">FairMQMessage</a> >> &msgVec) const</td></tr>
|
|
<tr class="separator:a814e59078db620881643d5e6a14c4b0c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8dda473d6027f9a8bb32c0f44e8d9c75"><td class="memItemLeft" align="right" valign="top">int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#a8dda473d6027f9a8bb32c0f44e8d9c75">Send</a> (std::vector< std::unique_ptr< <a class="el" href="classFairMQMessage.html">FairMQMessage</a> >> &msgVec, int sndTimeoutInMs) const</td></tr>
|
|
<tr class="separator:a8dda473d6027f9a8bb32c0f44e8d9c75"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a58e111fc04f0edbaf290441b3fb54edc"><td class="memItemLeft" align="right" valign="top">int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#a58e111fc04f0edbaf290441b3fb54edc">Receive</a> (std::vector< std::unique_ptr< <a class="el" href="classFairMQMessage.html">FairMQMessage</a> >> &msgVec, int rcvTimeoutInMs) const</td></tr>
|
|
<tr class="separator:a58e111fc04f0edbaf290441b3fb54edc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8b64807d056b4e6e17721d5b8dbceea7"><td class="memItemLeft" align="right" valign="top">int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#a8b64807d056b4e6e17721d5b8dbceea7">SendAsync</a> (std::vector< std::unique_ptr< <a class="el" href="classFairMQMessage.html">FairMQMessage</a> >> &msgVec) const</td></tr>
|
|
<tr class="separator:a8b64807d056b4e6e17721d5b8dbceea7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3352096e47bfb4ce499633ac293d6189"><td class="memItemLeft" align="right" valign="top">int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQChannel.html#a3352096e47bfb4ce499633ac293d6189">ReceiveAsync</a> (std::vector< std::unique_ptr< <a class="el" href="classFairMQMessage.html">FairMQMessage</a> >> &msgVec) const</td></tr>
|
|
<tr class="separator:a3352096e47bfb4ce499633ac293d6189"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9e626239b994e539dd1bcf495c4ad1df"><td class="memItemLeft" align="right" valign="top"><a id="a9e626239b994e539dd1bcf495c4ad1df"></a>
|
|
int64_t </td><td class="memItemRight" valign="bottom"><b>Send</b> (<a class="el" href="classFairMQParts.html">FairMQParts</a> &parts) const</td></tr>
|
|
<tr class="separator:a9e626239b994e539dd1bcf495c4ad1df"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4cb2a87370eac865fe597c45de7fe46b"><td class="memItemLeft" align="right" valign="top"><a id="a4cb2a87370eac865fe597c45de7fe46b"></a>
|
|
int64_t </td><td class="memItemRight" valign="bottom"><b>Receive</b> (<a class="el" href="classFairMQParts.html">FairMQParts</a> &parts) const</td></tr>
|
|
<tr class="separator:a4cb2a87370eac865fe597c45de7fe46b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7f8f529fa1650230526acf12365d9d93"><td class="memItemLeft" align="right" valign="top"><a id="a7f8f529fa1650230526acf12365d9d93"></a>
|
|
int64_t </td><td class="memItemRight" valign="bottom"><b>Send</b> (<a class="el" href="classFairMQParts.html">FairMQParts</a> &parts, int sndTimeoutInMs) const</td></tr>
|
|
<tr class="separator:a7f8f529fa1650230526acf12365d9d93"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a45921177bb451b0b3bdcaa47b8ffdde2"><td class="memItemLeft" align="right" valign="top"><a id="a45921177bb451b0b3bdcaa47b8ffdde2"></a>
|
|
int64_t </td><td class="memItemRight" valign="bottom"><b>Receive</b> (<a class="el" href="classFairMQParts.html">FairMQParts</a> &parts, int rcvTimeoutInMs) const</td></tr>
|
|
<tr class="separator:a45921177bb451b0b3bdcaa47b8ffdde2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afb8cb76ee0a016790a1242826fae1e64"><td class="memItemLeft" align="right" valign="top"><a id="afb8cb76ee0a016790a1242826fae1e64"></a>
|
|
int64_t </td><td class="memItemRight" valign="bottom"><b>SendAsync</b> (<a class="el" href="classFairMQParts.html">FairMQParts</a> &parts) const</td></tr>
|
|
<tr class="separator:afb8cb76ee0a016790a1242826fae1e64"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a050ebd6e250a5d06be35d9c110498365"><td class="memItemLeft" align="right" valign="top"><a id="a050ebd6e250a5d06be35d9c110498365"></a>
|
|
int64_t </td><td class="memItemRight" valign="bottom"><b>ReceiveAsync</b> (<a class="el" href="classFairMQParts.html">FairMQParts</a> &parts) const</td></tr>
|
|
<tr class="separator:a050ebd6e250a5d06be35d9c110498365"><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:a22ee384c6c484a249cb56dd7e7e6dc7f"><td class="memItemLeft" align="right" valign="top"><a id="a22ee384c6c484a249cb56dd7e7e6dc7f"></a>
|
|
auto </td><td class="memItemRight" valign="bottom"><b>Transport</b> () const -> const <a class="el" href="classFairMQTransportFactory.html">FairMQTransportFactory</a> *</td></tr>
|
|
<tr class="separator:a22ee384c6c484a249cb56dd7e7e6dc7f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a462c154eb98164ed365ec3ac68b89c3f"><td class="memTemplParams" colspan="2"><a id="a462c154eb98164ed365ec3ac68b89c3f"></a>
|
|
template<typename... Args> </td></tr>
|
|
<tr class="memitem:a462c154eb98164ed365ec3ac68b89c3f"><td class="memTemplItemLeft" align="right" valign="top">FairMQMessagePtr </td><td class="memTemplItemRight" valign="bottom"><b>NewMessage</b> (Args &&... args) const</td></tr>
|
|
<tr class="separator:a462c154eb98164ed365ec3ac68b89c3f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4a1468fd559b29fba1ff2134387d923e"><td class="memTemplParams" colspan="2"><a id="a4a1468fd559b29fba1ff2134387d923e"></a>
|
|
template<typename T > </td></tr>
|
|
<tr class="memitem:a4a1468fd559b29fba1ff2134387d923e"><td class="memTemplItemLeft" align="right" valign="top">FairMQMessagePtr </td><td class="memTemplItemRight" valign="bottom"><b>NewSimpleMessage</b> (const T &data) const</td></tr>
|
|
<tr class="separator:a4a1468fd559b29fba1ff2134387d923e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afa264c32ca380d22bd5ecb3c17eb3989"><td class="memTemplParams" colspan="2"><a id="afa264c32ca380d22bd5ecb3c17eb3989"></a>
|
|
template<typename T > </td></tr>
|
|
<tr class="memitem:afa264c32ca380d22bd5ecb3c17eb3989"><td class="memTemplItemLeft" align="right" valign="top">FairMQMessagePtr </td><td class="memTemplItemRight" valign="bottom"><b>NewStaticMessage</b> (const T &data) const</td></tr>
|
|
<tr class="separator:afa264c32ca380d22bd5ecb3c17eb3989"><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>
|
|
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a3223d192c795abb3f357df5883dd67f5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3223d192c795abb3f357df5883dd67f5">◆ </a></span>FairMQChannel() <span class="overload">[1/2]</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">[2/2]</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>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="ae6cf6eaca2cd489e7718123f764a5fd9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae6cf6eaca2cd489e7718123f764a5fd9">◆ </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="a55be4a9a41be4a15c588f5e487fb2622"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a55be4a9a41be4a15c588f5e487fb2622">◆ </a></span>GetChannelIndex()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">string FairMQChannel::GetChannelIndex </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</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="a3932fbe30d89c23042591876c5059a57"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3932fbe30d89c23042591876c5059a57">◆ </a></span>GetChannelName()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">string FairMQChannel::GetChannelName </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</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="a8b6d12b655c253d10d167fbc66b266fa"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8b6d12b655c253d10d167fbc66b266fa">◆ </a></span>GetChannelPrefix()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">string FairMQChannel::GetChannelPrefix </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</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="a13254702e5c18ffc4c66b89af2315867"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a13254702e5c18ffc4c66b89af2315867">◆ </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="af82cb56741d214bd4db0864e34d9cae3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af82cb56741d214bd4db0864e34d9cae3">◆ </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">◆ </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">◆ </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">◆ </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">◆ </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">◆ </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">◆ </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">◆ </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="a799456b290526b3310926ebc54b7a58f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a799456b290526b3310926ebc54b7a58f">◆ </a></span>Receive() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int FairMQChannel::Receive </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::unique_ptr< <a class="el" href="classFairMQMessage.html">FairMQMessage</a> > & </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> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Receives a message from the socket queue.</p>
|
|
<p>Receive method attempts to receive a message from the input queue. If the queue is empty the method blocks.</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>
|
|
</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. In case of errors, returns -1. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a58e111fc04f0edbaf290441b3fb54edc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a58e111fc04f0edbaf290441b3fb54edc">◆ </a></span>Receive() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int64_t FairMQChannel::Receive </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::vector< std::unique_ptr< <a class="el" href="classFairMQMessage.html">FairMQMessage</a> >> & </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> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td> const</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>
|
|
</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. In case of errors, returns -1. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a12d63a39074f227cde82c919c5775a61"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a12d63a39074f227cde82c919c5775a61">◆ </a></span>ReceiveAsync() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int FairMQChannel::ReceiveAsync </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::unique_ptr< <a class="el" href="classFairMQMessage.html">FairMQMessage</a> > & </td>
|
|
<td class="paramname"><em>msg</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Receives a message in non-blocking mode.</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>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Number of bytes that have been received. If queue is empty, returns -2. In case of errors, returns -1. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3352096e47bfb4ce499633ac293d6189"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3352096e47bfb4ce499633ac293d6189">◆ </a></span>ReceiveAsync() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int64_t FairMQChannel::ReceiveAsync </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::vector< std::unique_ptr< <a class="el" href="classFairMQMessage.html">FairMQMessage</a> >> & </td>
|
|
<td class="paramname"><em>msgVec</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Receives a vector of messages in non-blocking mode.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">msgVec</td><td>message vector reference </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Number of bytes that have been received. If queue is empty, returns -2. In case of errors, returns -1. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a57f5497eb39bba8bfa158f42e51b3bc9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a57f5497eb39bba8bfa158f42e51b3bc9">◆ </a></span>Send() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int FairMQChannel::Send </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::unique_ptr< <a class="el" href="classFairMQMessage.html">FairMQMessage</a> > & </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> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Sends a message to the socket queue.</p>
|
|
<p>Send method attempts to send a message by putting it in the output queue. If the queue is full or queueing is not possible for some other reason (e.g. no peers connected for a binding socket), the method blocks.</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>
|
|
</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. In case of errors, returns -1. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8dda473d6027f9a8bb32c0f44e8d9c75"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8dda473d6027f9a8bb32c0f44e8d9c75">◆ </a></span>Send() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int64_t FairMQChannel::Send </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::vector< std::unique_ptr< <a class="el" href="classFairMQMessage.html">FairMQMessage</a> >> & </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> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td> const</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>
|
|
</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. In case of errors, returns -1. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aac3f51ae7dd8b389e30bfdce6497ca42"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aac3f51ae7dd8b389e30bfdce6497ca42">◆ </a></span>SendAsync() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int FairMQChannel::SendAsync </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::unique_ptr< <a class="el" href="classFairMQMessage.html">FairMQMessage</a> > & </td>
|
|
<td class="paramname"><em>msg</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Sends a message in non-blocking mode.</p>
|
|
<p>SendAsync method attempts to send a message without blocking by putting it in the 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>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Number of bytes that have been queued. If queueing failed due to full queue or no connected peers (when binding), returns -2. In case of errors, returns -1. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8b64807d056b4e6e17721d5b8dbceea7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8b64807d056b4e6e17721d5b8dbceea7">◆ </a></span>SendAsync() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int64_t FairMQChannel::SendAsync </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::vector< std::unique_ptr< <a class="el" href="classFairMQMessage.html">FairMQMessage</a> >> & </td>
|
|
<td class="paramname"><em>msgVec</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Sends a vector of message in non-blocking mode.</p>
|
|
<p>SendAsync method attempts to send a vector of messages without blocking by putting it them the queue.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">msgVec</td><td>message vector reference </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Number of bytes that have been queued. If queueing failed due to full queue or no connected peers (when binding), returns -2. In case of errors, returns -1. </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="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>
|
|
</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="ace79c4f0a38ed550641a87a6b7e4ca05"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ace79c4f0a38ed550641a87a6b7e4ca05">◆ </a></span>UpdateChannelName()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void FairMQChannel::UpdateChannelName </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>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="ac67be0a888fb0ffa61633d28a5c37d18"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac67be0a888fb0ffa61633d28a5c37d18">◆ </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 & </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="a2202995e3281a8bc8fdee10c47ff52c4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2202995e3281a8bc8fdee10c47ff52c4">◆ </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 </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">◆ </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 </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">◆ </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 </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">◆ </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 </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">◆ </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 </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">◆ </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 & </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">◆ </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 & </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="abe08e04a2395ef389df08bc058c36ae6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abe08e04a2395ef389df08bc058c36ae6">◆ </a></span>ValidateChannel()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool FairMQChannel::ValidateChannel </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 -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.13
|
|
</small></address>
|
|
</body>
|
|
</html>
|