blob: 42cadedabea3561d7ebaaf4ecddda9d7829e8134 [file]
<!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" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>pulsar-client-cpp: include/pulsar/Producer.h Source File</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>
<script type="text/javascript" src="darkmode_toggle.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 id="projectrow">
<td id="projectalign">
<div id="projectname">pulsar-client-cpp
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
<!-- 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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_84093bac216bb6272e4432021f1ca7f4.html">pulsar</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">Producer.h</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span> </div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="preprocessor">#ifndef PRODUCER_HPP_</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#define PRODUCER_HPP_</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="preprocessor">#include &lt;pulsar/ProducerConfiguration.h&gt;</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="preprocessor">#include &lt;pulsar/defines.h&gt;</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="preprocessor">#include &lt;stdint.h&gt;</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> </div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="preprocessor">#include &lt;memory&gt;</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> </div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespacepulsar.html">pulsar</a> {</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="keyword">class </span>ProducerImplBase;</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="keyword">class </span>PulsarWrapper;</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="keyword">class </span>PulsarFriend;</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> </div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="keyword">typedef</span> std::function&lt;void(<a class="code hl_enumeration" href="namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbb">Result</a>)&gt; FlushCallback;</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="keyword">typedef</span> std::shared_ptr&lt;ProducerImplBase&gt; ProducerImplBasePtr;</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> </div>
<div class="foldopen" id="foldopen00036" data-start="{" data-end="};">
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"><a class="line" href="classpulsar_1_1_producer.html"> 36</a></span><span class="keyword">class </span>PULSAR_PUBLIC <a class="code hl_class" href="classpulsar_1_1_producer.html">Producer</a> {</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"><a class="line" href="classpulsar_1_1_producer.html#a013069fbb382f7f3c7dd58522765698b"> 41</a></span> <a class="code hl_function" href="classpulsar_1_1_producer.html#a013069fbb382f7f3c7dd58522765698b">Producer</a>();</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> </div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"><a class="line" href="classpulsar_1_1_producer.html#ab30cecbdcad0f600c1fcd2783cd6caf3"> 46</a></span> <span class="keyword">const</span> std::string&amp; <a class="code hl_function" href="classpulsar_1_1_producer.html#ab30cecbdcad0f600c1fcd2783cd6caf3">getTopic</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> </div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"><a class="line" href="classpulsar_1_1_producer.html#aba5ac552bef04262ecc989b933ec1d65"> 51</a></span> <span class="keyword">const</span> std::string&amp; <a class="code hl_function" href="classpulsar_1_1_producer.html#aba5ac552bef04262ecc989b933ec1d65">getProducerName</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> </div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"><a class="line" href="classpulsar_1_1_producer.html#ad4737186cf798acfb24a167796259443"> 58</a></span> <a class="code hl_enumeration" href="namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbb">Result</a> <a class="code hl_function" href="classpulsar_1_1_producer.html#ad4737186cf798acfb24a167796259443">send</a>(<span class="keyword">const</span> <a class="code hl_class" href="classpulsar_1_1_message.html">Message</a>&amp; msg);</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> </div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"><a class="line" href="classpulsar_1_1_producer.html#a32a8c234d42e1951c0357a7562ccdb3a"> 84</a></span> <a class="code hl_enumeration" href="namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbb">Result</a> <a class="code hl_function" href="classpulsar_1_1_producer.html#a32a8c234d42e1951c0357a7562ccdb3a">send</a>(<span class="keyword">const</span> <a class="code hl_class" href="classpulsar_1_1_message.html">Message</a>&amp; msg, <a class="code hl_class" href="classpulsar_1_1_message_id.html">MessageId</a>&amp; messageId);</div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> </div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"><a class="line" href="classpulsar_1_1_producer.html#a7b31f92eb0362bdff32316fc9ab70fd7"> 100</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="classpulsar_1_1_producer.html#a7b31f92eb0362bdff32316fc9ab70fd7">sendAsync</a>(<span class="keyword">const</span> <a class="code hl_class" href="classpulsar_1_1_message.html">Message</a>&amp; msg, SendCallback callback);</div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span> </div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"><a class="line" href="classpulsar_1_1_producer.html#a1cd59ffc4a23162eca39183ba4278146"> 106</a></span> <a class="code hl_enumeration" href="namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbb">Result</a> <a class="code hl_function" href="classpulsar_1_1_producer.html#a1cd59ffc4a23162eca39183ba4278146">flush</a>();</div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span> </div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"><a class="line" href="classpulsar_1_1_producer.html#a3173d56da00ea2225f03e152c8c3df22"> 112</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="classpulsar_1_1_producer.html#a3173d56da00ea2225f03e152c8c3df22">flushAsync</a>(FlushCallback callback);</div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span> </div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"><a class="line" href="classpulsar_1_1_producer.html#a99c6c342f700842a065178730c487d5a"> 126</a></span> int64_t <a class="code hl_function" href="classpulsar_1_1_producer.html#a99c6c342f700842a065178730c487d5a">getLastSequenceId</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno"> 127</span> </div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno"><a class="line" href="classpulsar_1_1_producer.html#a2d452694aca8f7ccb5af5e3a974432c3"> 136</a></span> <span class="keyword">const</span> std::string&amp; <a class="code hl_function" href="classpulsar_1_1_producer.html#a2d452694aca8f7ccb5af5e3a974432c3">getSchemaVersion</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno"> 137</span> </div>
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno"><a class="line" href="classpulsar_1_1_producer.html#a0b4a93617a0c0f8d172633a7bf8ba06b"> 147</a></span> <a class="code hl_enumeration" href="namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbb">Result</a> <a class="code hl_function" href="classpulsar_1_1_producer.html#a0b4a93617a0c0f8d172633a7bf8ba06b">close</a>();</div>
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno"> 148</span> </div>
<div class="line"><a id="l00156" name="l00156"></a><span class="lineno"><a class="line" href="classpulsar_1_1_producer.html#a40f5268e6754c9e61e2406d432cffe2f"> 156</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="classpulsar_1_1_producer.html#a40f5268e6754c9e61e2406d432cffe2f">closeAsync</a>(CloseCallback callback);</div>
<div class="line"><a id="l00157" name="l00157"></a><span class="lineno"> 157</span> </div>
<div class="line"><a id="l00161" name="l00161"></a><span class="lineno"><a class="line" href="classpulsar_1_1_producer.html#a0f8b6a4b724a60545a8d427596155f1e"> 161</a></span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classpulsar_1_1_producer.html#a0f8b6a4b724a60545a8d427596155f1e">isConnected</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00162" name="l00162"></a><span class="lineno"> 162</span> </div>
<div class="line"><a id="l00163" name="l00163"></a><span class="lineno"> 163</span> <span class="keyword">private</span>:</div>
<div class="line"><a id="l00164" name="l00164"></a><span class="lineno"> 164</span> <span class="keyword">explicit</span> <a class="code hl_class" href="classpulsar_1_1_producer.html">Producer</a>(ProducerImplBasePtr);</div>
<div class="line"><a id="l00165" name="l00165"></a><span class="lineno"> 165</span> </div>
<div class="line"><a id="l00166" name="l00166"></a><span class="lineno"> 166</span> <span class="keyword">friend</span> <span class="keyword">class </span>ClientImpl;</div>
<div class="line"><a id="l00167" name="l00167"></a><span class="lineno"> 167</span> <span class="keyword">friend</span> <span class="keyword">class </span>PulsarFriend;</div>
<div class="line"><a id="l00168" name="l00168"></a><span class="lineno"> 168</span> <span class="keyword">friend</span> <span class="keyword">class </span>PulsarWrapper;</div>
<div class="line"><a id="l00169" name="l00169"></a><span class="lineno"> 169</span> <span class="keyword">friend</span> <span class="keyword">class </span>ProducerImpl;</div>
<div class="line"><a id="l00170" name="l00170"></a><span class="lineno"> 170</span> </div>
<div class="line"><a id="l00171" name="l00171"></a><span class="lineno"> 171</span> ProducerImplBasePtr impl_;</div>
<div class="line"><a id="l00172" name="l00172"></a><span class="lineno"> 172</span> </div>
<div class="line"><a id="l00173" name="l00173"></a><span class="lineno"> 173</span> <span class="comment">// For unit test case BatchMessageTest::producerFailureResult only</span></div>
<div class="line"><a id="l00174" name="l00174"></a><span class="lineno"> 174</span> <span class="keywordtype">void</span> producerFailMessages(<a class="code hl_enumeration" href="namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbb">Result</a> result);</div>
<div class="line"><a id="l00175" name="l00175"></a><span class="lineno"> 175</span>};</div>
</div>
<div class="line"><a id="l00176" name="l00176"></a><span class="lineno"> 176</span>} <span class="comment">// namespace pulsar</span></div>
<div class="line"><a id="l00177" name="l00177"></a><span class="lineno"> 177</span> </div>
<div class="line"><a id="l00178" name="l00178"></a><span class="lineno"> 178</span><span class="preprocessor">#endif </span><span class="comment">/* PRODUCER_HPP_ */</span><span class="preprocessor"></span></div>
<div class="ttc" id="aclasspulsar_1_1_message_html"><div class="ttname"><a href="classpulsar_1_1_message.html">pulsar::Message</a></div><div class="ttdef"><b>Definition</b> Message.h:44</div></div>
<div class="ttc" id="aclasspulsar_1_1_message_id_html"><div class="ttname"><a href="classpulsar_1_1_message_id.html">pulsar::MessageId</a></div><div class="ttdef"><b>Definition</b> MessageId.h:34</div></div>
<div class="ttc" id="aclasspulsar_1_1_producer_html"><div class="ttname"><a href="classpulsar_1_1_producer.html">pulsar::Producer</a></div><div class="ttdef"><b>Definition</b> Producer.h:36</div></div>
<div class="ttc" id="aclasspulsar_1_1_producer_html_a013069fbb382f7f3c7dd58522765698b"><div class="ttname"><a href="classpulsar_1_1_producer.html#a013069fbb382f7f3c7dd58522765698b">pulsar::Producer::Producer</a></div><div class="ttdeci">Producer()</div></div>
<div class="ttc" id="aclasspulsar_1_1_producer_html_a0b4a93617a0c0f8d172633a7bf8ba06b"><div class="ttname"><a href="classpulsar_1_1_producer.html#a0b4a93617a0c0f8d172633a7bf8ba06b">pulsar::Producer::close</a></div><div class="ttdeci">Result close()</div></div>
<div class="ttc" id="aclasspulsar_1_1_producer_html_a0f8b6a4b724a60545a8d427596155f1e"><div class="ttname"><a href="classpulsar_1_1_producer.html#a0f8b6a4b724a60545a8d427596155f1e">pulsar::Producer::isConnected</a></div><div class="ttdeci">bool isConnected() const</div></div>
<div class="ttc" id="aclasspulsar_1_1_producer_html_a1cd59ffc4a23162eca39183ba4278146"><div class="ttname"><a href="classpulsar_1_1_producer.html#a1cd59ffc4a23162eca39183ba4278146">pulsar::Producer::flush</a></div><div class="ttdeci">Result flush()</div></div>
<div class="ttc" id="aclasspulsar_1_1_producer_html_a2d452694aca8f7ccb5af5e3a974432c3"><div class="ttname"><a href="classpulsar_1_1_producer.html#a2d452694aca8f7ccb5af5e3a974432c3">pulsar::Producer::getSchemaVersion</a></div><div class="ttdeci">const std::string &amp; getSchemaVersion() const</div></div>
<div class="ttc" id="aclasspulsar_1_1_producer_html_a3173d56da00ea2225f03e152c8c3df22"><div class="ttname"><a href="classpulsar_1_1_producer.html#a3173d56da00ea2225f03e152c8c3df22">pulsar::Producer::flushAsync</a></div><div class="ttdeci">void flushAsync(FlushCallback callback)</div></div>
<div class="ttc" id="aclasspulsar_1_1_producer_html_a32a8c234d42e1951c0357a7562ccdb3a"><div class="ttname"><a href="classpulsar_1_1_producer.html#a32a8c234d42e1951c0357a7562ccdb3a">pulsar::Producer::send</a></div><div class="ttdeci">Result send(const Message &amp;msg, MessageId &amp;messageId)</div></div>
<div class="ttc" id="aclasspulsar_1_1_producer_html_a40f5268e6754c9e61e2406d432cffe2f"><div class="ttname"><a href="classpulsar_1_1_producer.html#a40f5268e6754c9e61e2406d432cffe2f">pulsar::Producer::closeAsync</a></div><div class="ttdeci">void closeAsync(CloseCallback callback)</div></div>
<div class="ttc" id="aclasspulsar_1_1_producer_html_a7b31f92eb0362bdff32316fc9ab70fd7"><div class="ttname"><a href="classpulsar_1_1_producer.html#a7b31f92eb0362bdff32316fc9ab70fd7">pulsar::Producer::sendAsync</a></div><div class="ttdeci">void sendAsync(const Message &amp;msg, SendCallback callback)</div></div>
<div class="ttc" id="aclasspulsar_1_1_producer_html_a99c6c342f700842a065178730c487d5a"><div class="ttname"><a href="classpulsar_1_1_producer.html#a99c6c342f700842a065178730c487d5a">pulsar::Producer::getLastSequenceId</a></div><div class="ttdeci">int64_t getLastSequenceId() const</div></div>
<div class="ttc" id="aclasspulsar_1_1_producer_html_ab30cecbdcad0f600c1fcd2783cd6caf3"><div class="ttname"><a href="classpulsar_1_1_producer.html#ab30cecbdcad0f600c1fcd2783cd6caf3">pulsar::Producer::getTopic</a></div><div class="ttdeci">const std::string &amp; getTopic() const</div></div>
<div class="ttc" id="aclasspulsar_1_1_producer_html_aba5ac552bef04262ecc989b933ec1d65"><div class="ttname"><a href="classpulsar_1_1_producer.html#aba5ac552bef04262ecc989b933ec1d65">pulsar::Producer::getProducerName</a></div><div class="ttdeci">const std::string &amp; getProducerName() const</div></div>
<div class="ttc" id="aclasspulsar_1_1_producer_html_ad4737186cf798acfb24a167796259443"><div class="ttname"><a href="classpulsar_1_1_producer.html#ad4737186cf798acfb24a167796259443">pulsar::Producer::send</a></div><div class="ttdeci">Result send(const Message &amp;msg)</div></div>
<div class="ttc" id="anamespacepulsar_html"><div class="ttname"><a href="namespacepulsar.html">pulsar</a></div><div class="ttdef"><b>Definition</b> Authentication.h:31</div></div>
<div class="ttc" id="anamespacepulsar_html_ae85314d6b9e8afd831cf8c66705f2dbb"><div class="ttname"><a href="namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbb">pulsar::Result</a></div><div class="ttdeci">Result</div><div class="ttdef"><b>Definition</b> Result.h:32</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>