| <!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.17"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>pulsar-client-cpp: include/pulsar/c/consumer.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> |
| <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">pulsar-client-cpp |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.17 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| /* @license-end */ |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| /* @license-end */</script> |
| <div id="main-nav"></div> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| </div> |
| |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <iframe src="javascript:void(0)" frameborder="0" |
| name="MSearchResults" id="MSearchResults"> |
| </iframe> |
| </div> |
| |
| <div 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><li class="navelem"><a class="el" href="dir_501ae28692a6b25a33adbd2bed71d4b9.html">c</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"> |
| <div class="title">consumer.h</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>  </div> |
| <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#pragma once</span></div> |
| <div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  </div> |
| <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include <pulsar/defines.h></span></div> |
| <div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  </div> |
| <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#ifdef __cplusplus</span></div> |
| <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div> |
| <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#endif</span></div> |
| <div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  </div> |
| <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include <pulsar/c/message.h></span></div> |
| <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include <pulsar/c/messages.h></span></div> |
| <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include <pulsar/c/result.h></span></div> |
| <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#include <stdint.h></span></div> |
| <div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  </div> |
| <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">typedef</span> <span class="keyword">struct </span>_pulsar_consumer pulsar_consumer_t;</div> |
| <div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  </div> |
| <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">typedef</span> void (*pulsar_result_callback)(pulsar_result, <span class="keywordtype">void</span> *);</div> |
| <div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  </div> |
| <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">typedef</span> void (*pulsar_receive_callback)(pulsar_result result, pulsar_message_t *msg, <span class="keywordtype">void</span> *ctx);</div> |
| <div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  </div> |
| <div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="keyword">typedef</span> void (*pulsar_batch_receive_callback)(pulsar_result result, pulsar_messages_t *msgs, <span class="keywordtype">void</span> *ctx);</div> |
| <div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  </div> |
| <div class="line"><a name="l00043"></a><span class="lineno"> 43</span> PULSAR_PUBLIC <span class="keyword">const</span> <span class="keywordtype">char</span> *pulsar_consumer_get_topic(pulsar_consumer_t *consumer);</div> |
| <div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  </div> |
| <div class="line"><a name="l00048"></a><span class="lineno"> 48</span> PULSAR_PUBLIC <span class="keyword">const</span> <span class="keywordtype">char</span> *pulsar_consumer_get_subscription_name(pulsar_consumer_t *consumer);</div> |
| <div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  </div> |
| <div class="line"><a name="l00063"></a><span class="lineno"> 63</span> PULSAR_PUBLIC pulsar_result pulsar_consumer_unsubscribe(pulsar_consumer_t *consumer);</div> |
| <div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  </div> |
| <div class="line"><a name="l00076"></a><span class="lineno"> 76</span> PULSAR_PUBLIC <span class="keywordtype">void</span> pulsar_consumer_unsubscribe_async(pulsar_consumer_t *consumer,</div> |
| <div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  pulsar_result_callback callback, <span class="keywordtype">void</span> *ctx);</div> |
| <div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  </div> |
| <div class="line"><a name="l00089"></a><span class="lineno"> 89</span> PULSAR_PUBLIC pulsar_result pulsar_consumer_receive(pulsar_consumer_t *consumer, pulsar_message_t **msg);</div> |
| <div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  </div> |
| <div class="line"><a name="l00099"></a><span class="lineno"> 99</span> PULSAR_PUBLIC pulsar_result pulsar_consumer_receive_with_timeout(pulsar_consumer_t *consumer,</div> |
| <div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  pulsar_message_t **msg, <span class="keywordtype">int</span> timeoutMs);</div> |
| <div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  </div> |
| <div class="line"><a name="l00110"></a><span class="lineno"> 110</span> PULSAR_PUBLIC <span class="keywordtype">void</span> pulsar_consumer_receive_async(pulsar_consumer_t *consumer,</div> |
| <div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  pulsar_receive_callback callback, <span class="keywordtype">void</span> *ctx);</div> |
| <div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  </div> |
| <div class="line"><a name="l00121"></a><span class="lineno"> 121</span> PULSAR_PUBLIC pulsar_result pulsar_consumer_batch_receive(pulsar_consumer_t *consumer,</div> |
| <div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  pulsar_messages_t **msgs);</div> |
| <div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  </div> |
| <div class="line"><a name="l00132"></a><span class="lineno"> 132</span> PULSAR_PUBLIC <span class="keywordtype">void</span> pulsar_consumer_batch_receive_async(pulsar_consumer_t *consumer,</div> |
| <div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  pulsar_batch_receive_callback callback, <span class="keywordtype">void</span> *ctx);</div> |
| <div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  </div> |
| <div class="line"><a name="l00146"></a><span class="lineno"> 146</span> PULSAR_PUBLIC pulsar_result pulsar_consumer_acknowledge(pulsar_consumer_t *consumer,</div> |
| <div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  pulsar_message_t *message);</div> |
| <div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  </div> |
| <div class="line"><a name="l00149"></a><span class="lineno"> 149</span> PULSAR_PUBLIC pulsar_result pulsar_consumer_acknowledge_id(pulsar_consumer_t *consumer,</div> |
| <div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  pulsar_message_id_t *messageId);</div> |
| <div class="line"><a name="l00151"></a><span class="lineno"> 151</span>  </div> |
| <div class="line"><a name="l00161"></a><span class="lineno"> 161</span> PULSAR_PUBLIC <span class="keywordtype">void</span> pulsar_consumer_acknowledge_async(pulsar_consumer_t *consumer, pulsar_message_t *message,</div> |
| <div class="line"><a name="l00162"></a><span class="lineno"> 162</span>  pulsar_result_callback callback, <span class="keywordtype">void</span> *ctx);</div> |
| <div class="line"><a name="l00163"></a><span class="lineno"> 163</span>  </div> |
| <div class="line"><a name="l00164"></a><span class="lineno"> 164</span> PULSAR_PUBLIC <span class="keywordtype">void</span> pulsar_consumer_acknowledge_async_id(pulsar_consumer_t *consumer,</div> |
| <div class="line"><a name="l00165"></a><span class="lineno"> 165</span>  pulsar_message_id_t *messageId,</div> |
| <div class="line"><a name="l00166"></a><span class="lineno"> 166</span>  pulsar_result_callback callback, <span class="keywordtype">void</span> *ctx);</div> |
| <div class="line"><a name="l00167"></a><span class="lineno"> 167</span>  </div> |
| <div class="line"><a name="l00185"></a><span class="lineno"> 185</span> PULSAR_PUBLIC pulsar_result pulsar_consumer_acknowledge_cumulative(pulsar_consumer_t *consumer,</div> |
| <div class="line"><a name="l00186"></a><span class="lineno"> 186</span>  pulsar_message_t *message);</div> |
| <div class="line"><a name="l00187"></a><span class="lineno"> 187</span>  </div> |
| <div class="line"><a name="l00188"></a><span class="lineno"> 188</span> PULSAR_PUBLIC pulsar_result pulsar_consumer_acknowledge_cumulative_id(pulsar_consumer_t *consumer,</div> |
| <div class="line"><a name="l00189"></a><span class="lineno"> 189</span>  pulsar_message_id_t *messageId);</div> |
| <div class="line"><a name="l00190"></a><span class="lineno"> 190</span>  </div> |
| <div class="line"><a name="l00201"></a><span class="lineno"> 201</span> PULSAR_PUBLIC <span class="keywordtype">void</span> pulsar_consumer_acknowledge_cumulative_async(pulsar_consumer_t *consumer,</div> |
| <div class="line"><a name="l00202"></a><span class="lineno"> 202</span>  pulsar_message_t *message,</div> |
| <div class="line"><a name="l00203"></a><span class="lineno"> 203</span>  pulsar_result_callback callback, <span class="keywordtype">void</span> *ctx);</div> |
| <div class="line"><a name="l00204"></a><span class="lineno"> 204</span>  </div> |
| <div class="line"><a name="l00205"></a><span class="lineno"> 205</span> PULSAR_PUBLIC <span class="keywordtype">void</span> pulsar_consumer_acknowledge_cumulative_async_id(pulsar_consumer_t *consumer,</div> |
| <div class="line"><a name="l00206"></a><span class="lineno"> 206</span>  pulsar_message_id_t *messageId,</div> |
| <div class="line"><a name="l00207"></a><span class="lineno"> 207</span>  pulsar_result_callback callback,</div> |
| <div class="line"><a name="l00208"></a><span class="lineno"> 208</span>  <span class="keywordtype">void</span> *ctx);</div> |
| <div class="line"><a name="l00209"></a><span class="lineno"> 209</span>  </div> |
| <div class="line"><a name="l00222"></a><span class="lineno"> 222</span> PULSAR_PUBLIC <span class="keywordtype">void</span> pulsar_consumer_negative_acknowledge(pulsar_consumer_t *consumer,</div> |
| <div class="line"><a name="l00223"></a><span class="lineno"> 223</span>  pulsar_message_t *message);</div> |
| <div class="line"><a name="l00224"></a><span class="lineno"> 224</span>  </div> |
| <div class="line"><a name="l00237"></a><span class="lineno"> 237</span> PULSAR_PUBLIC <span class="keywordtype">void</span> pulsar_consumer_negative_acknowledge_id(pulsar_consumer_t *consumer,</div> |
| <div class="line"><a name="l00238"></a><span class="lineno"> 238</span>  pulsar_message_id_t *messageId);</div> |
| <div class="line"><a name="l00239"></a><span class="lineno"> 239</span>  </div> |
| <div class="line"><a name="l00240"></a><span class="lineno"> 240</span> PULSAR_PUBLIC pulsar_result pulsar_consumer_close(pulsar_consumer_t *consumer);</div> |
| <div class="line"><a name="l00241"></a><span class="lineno"> 241</span>  </div> |
| <div class="line"><a name="l00242"></a><span class="lineno"> 242</span> PULSAR_PUBLIC <span class="keywordtype">void</span> pulsar_consumer_close_async(pulsar_consumer_t *consumer, pulsar_result_callback callback,</div> |
| <div class="line"><a name="l00243"></a><span class="lineno"> 243</span>  <span class="keywordtype">void</span> *ctx);</div> |
| <div class="line"><a name="l00244"></a><span class="lineno"> 244</span>  </div> |
| <div class="line"><a name="l00245"></a><span class="lineno"> 245</span> PULSAR_PUBLIC <span class="keywordtype">void</span> pulsar_consumer_free(pulsar_consumer_t *consumer);</div> |
| <div class="line"><a name="l00246"></a><span class="lineno"> 246</span>  </div> |
| <div class="line"><a name="l00247"></a><span class="lineno"> 247</span> <span class="comment">/*</span></div> |
| <div class="line"><a name="l00248"></a><span class="lineno"> 248</span> <span class="comment"> * Pause receiving messages via the messageListener, till resumeMessageListener() is called.</span></div> |
| <div class="line"><a name="l00249"></a><span class="lineno"> 249</span> <span class="comment"> */</span></div> |
| <div class="line"><a name="l00250"></a><span class="lineno"> 250</span> PULSAR_PUBLIC pulsar_result pulsar_consumer_pause_message_listener(pulsar_consumer_t *consumer);</div> |
| <div class="line"><a name="l00251"></a><span class="lineno"> 251</span>  </div> |
| <div class="line"><a name="l00252"></a><span class="lineno"> 252</span> <span class="comment">/*</span></div> |
| <div class="line"><a name="l00253"></a><span class="lineno"> 253</span> <span class="comment"> * Resume receiving the messages via the messageListener.</span></div> |
| <div class="line"><a name="l00254"></a><span class="lineno"> 254</span> <span class="comment"> * Asynchronously receive all the messages enqueued from time pauseMessageListener() was called.</span></div> |
| <div class="line"><a name="l00255"></a><span class="lineno"> 255</span> <span class="comment"> */</span></div> |
| <div class="line"><a name="l00256"></a><span class="lineno"> 256</span> PULSAR_PUBLIC pulsar_result resume_message_listener(pulsar_consumer_t *consumer);</div> |
| <div class="line"><a name="l00257"></a><span class="lineno"> 257</span>  </div> |
| <div class="line"><a name="l00267"></a><span class="lineno"> 267</span> PULSAR_PUBLIC <span class="keywordtype">void</span> pulsar_consumer_redeliver_unacknowledged_messages(pulsar_consumer_t *consumer);</div> |
| <div class="line"><a name="l00268"></a><span class="lineno"> 268</span>  </div> |
| <div class="line"><a name="l00278"></a><span class="lineno"> 278</span> PULSAR_PUBLIC <span class="keywordtype">void</span> pulsar_consumer_seek_async(pulsar_consumer_t *consumer, pulsar_message_id_t *messageId,</div> |
| <div class="line"><a name="l00279"></a><span class="lineno"> 279</span>  pulsar_result_callback callback, <span class="keywordtype">void</span> *ctx);</div> |
| <div class="line"><a name="l00280"></a><span class="lineno"> 280</span>  </div> |
| <div class="line"><a name="l00289"></a><span class="lineno"> 289</span> PULSAR_PUBLIC pulsar_result pulsar_consumer_seek(pulsar_consumer_t *consumer, pulsar_message_id_t *messageId);</div> |
| <div class="line"><a name="l00290"></a><span class="lineno"> 290</span>  </div> |
| <div class="line"><a name="l00300"></a><span class="lineno"> 300</span> PULSAR_PUBLIC <span class="keywordtype">void</span> pulsar_consumer_seek_by_timestamp_async(pulsar_consumer_t *consumer, uint64_t timestamp,</div> |
| <div class="line"><a name="l00301"></a><span class="lineno"> 301</span>  pulsar_result_callback callback, <span class="keywordtype">void</span> *ctx);</div> |
| <div class="line"><a name="l00302"></a><span class="lineno"> 302</span>  </div> |
| <div class="line"><a name="l00311"></a><span class="lineno"> 311</span> PULSAR_PUBLIC pulsar_result pulsar_consumer_seek_by_timestamp(pulsar_consumer_t *consumer,</div> |
| <div class="line"><a name="l00312"></a><span class="lineno"> 312</span>  uint64_t timestamp);</div> |
| <div class="line"><a name="l00313"></a><span class="lineno"> 313</span>  </div> |
| <div class="line"><a name="l00314"></a><span class="lineno"> 314</span> PULSAR_PUBLIC <span class="keywordtype">int</span> pulsar_consumer_is_connected(pulsar_consumer_t *consumer);</div> |
| <div class="line"><a name="l00315"></a><span class="lineno"> 315</span>  </div> |
| <div class="line"><a name="l00316"></a><span class="lineno"> 316</span> PULSAR_PUBLIC pulsar_result pulsar_consumer_get_last_message_id(pulsar_consumer_t *consumer,</div> |
| <div class="line"><a name="l00317"></a><span class="lineno"> 317</span>  pulsar_message_id_t *messageId);</div> |
| <div class="line"><a name="l00318"></a><span class="lineno"> 318</span>  </div> |
| <div class="line"><a name="l00319"></a><span class="lineno"> 319</span> <span class="preprocessor">#ifdef __cplusplus</span></div> |
| <div class="line"><a name="l00320"></a><span class="lineno"> 320</span> }</div> |
| <div class="line"><a name="l00321"></a><span class="lineno"> 321</span> <span class="preprocessor">#endif</span></div> |
| </div><!-- fragment --></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.17 |
| </small></address> |
| </body> |
| </html> |
