| <!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: pulsar::Reader 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">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="namespacepulsar.html">pulsar</a></li><li class="navelem"><a class="el" href="classpulsar_1_1_reader.html">Reader</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#friends">Friends</a> | |
| <a href="classpulsar_1_1_reader-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">pulsar::Reader Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p><code>#include <<a class="el" href="reader_8h_source.html">Reader.h</a>></code></p> |
| <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:a1c34e49ba3dbca0ff7e23ea9ff94db7b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpulsar_1_1_reader.html#a1c34e49ba3dbca0ff7e23ea9ff94db7b">Reader</a> ()</td></tr> |
| <tr class="separator:a1c34e49ba3dbca0ff7e23ea9ff94db7b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad74c3a9d1999bfd9074747929f1ddf70"><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classpulsar_1_1_reader.html#ad74c3a9d1999bfd9074747929f1ddf70">getTopic</a> () const</td></tr> |
| <tr class="separator:ad74c3a9d1999bfd9074747929f1ddf70"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a11756c69a2f5bd99e302a384ae8a9ff4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbb">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpulsar_1_1_reader.html#a11756c69a2f5bd99e302a384ae8a9ff4">readNext</a> (<a class="el" href="classpulsar_1_1_message.html">Message</a> &msg)</td></tr> |
| <tr class="separator:a11756c69a2f5bd99e302a384ae8a9ff4"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a39c664ea68774721bc0e772b38449b22"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbb">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpulsar_1_1_reader.html#a39c664ea68774721bc0e772b38449b22">readNext</a> (<a class="el" href="classpulsar_1_1_message.html">Message</a> &msg, int timeoutMs)</td></tr> |
| <tr class="separator:a39c664ea68774721bc0e772b38449b22"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1ed12cbc71284694e5ff9fee1e7c462d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classpulsar_1_1_reader.html#a1ed12cbc71284694e5ff9fee1e7c462d">readNextAsync</a> (ReadNextCallback callback)</td></tr> |
| <tr class="separator:a1ed12cbc71284694e5ff9fee1e7c462d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab15cfd0e35d625d2f1af5936c314b623"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbb">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpulsar_1_1_reader.html#ab15cfd0e35d625d2f1af5936c314b623">close</a> ()</td></tr> |
| <tr class="separator:ab15cfd0e35d625d2f1af5936c314b623"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a203d50fd687e2c77e4f7e7bb0b14bab7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classpulsar_1_1_reader.html#a203d50fd687e2c77e4f7e7bb0b14bab7">closeAsync</a> (<a class="el" href="namespacepulsar.html#ae5bf6401bfa8e3962e5c8f9fa2efbf4d">ResultCallback</a> callback)</td></tr> |
| <tr class="separator:a203d50fd687e2c77e4f7e7bb0b14bab7"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0c3755b32954d1aeb1b4ef60e4314c1d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classpulsar_1_1_reader.html#a0c3755b32954d1aeb1b4ef60e4314c1d">hasMessageAvailableAsync</a> (HasMessageAvailableCallback callback)</td></tr> |
| <tr class="separator:a0c3755b32954d1aeb1b4ef60e4314c1d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7f751b63fba4d4734ff79da590f9fd56"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbb">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpulsar_1_1_reader.html#a7f751b63fba4d4734ff79da590f9fd56">hasMessageAvailable</a> (bool &hasMessageAvailable)</td></tr> |
| <tr class="separator:a7f751b63fba4d4734ff79da590f9fd56"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6bec25700e5b4eb7be41625a9bc856bd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbb">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpulsar_1_1_reader.html#a6bec25700e5b4eb7be41625a9bc856bd">seek</a> (const <a class="el" href="classpulsar_1_1_message_id.html">MessageId</a> &msgId)</td></tr> |
| <tr class="separator:a6bec25700e5b4eb7be41625a9bc856bd"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:adebdd61a5150777704c8ce8dcec08fc8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbb">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpulsar_1_1_reader.html#adebdd61a5150777704c8ce8dcec08fc8">seek</a> (uint64_t timestamp)</td></tr> |
| <tr class="separator:adebdd61a5150777704c8ce8dcec08fc8"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:acba58f8fb3ecefc4a693a1091f3c4669"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classpulsar_1_1_reader.html#acba58f8fb3ecefc4a693a1091f3c4669">seekAsync</a> (const <a class="el" href="classpulsar_1_1_message_id.html">MessageId</a> &msgId, <a class="el" href="namespacepulsar.html#ae5bf6401bfa8e3962e5c8f9fa2efbf4d">ResultCallback</a> callback)</td></tr> |
| <tr class="separator:acba58f8fb3ecefc4a693a1091f3c4669"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:addec61dc54aba2959c06a2017bea7c32"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classpulsar_1_1_reader.html#addec61dc54aba2959c06a2017bea7c32">seekAsync</a> (uint64_t timestamp, <a class="el" href="namespacepulsar.html#ae5bf6401bfa8e3962e5c8f9fa2efbf4d">ResultCallback</a> callback)</td></tr> |
| <tr class="separator:addec61dc54aba2959c06a2017bea7c32"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9eda13274f7b1f880694fc1178ae631d"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classpulsar_1_1_reader.html#a9eda13274f7b1f880694fc1178ae631d">isConnected</a> () const</td></tr> |
| <tr class="separator:a9eda13274f7b1f880694fc1178ae631d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1f863d880dc85400e7e50fcd831d7f5e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classpulsar_1_1_reader.html#a1f863d880dc85400e7e50fcd831d7f5e">getLastMessageIdAsync</a> (GetLastMessageIdCallback callback)</td></tr> |
| <tr class="separator:a1f863d880dc85400e7e50fcd831d7f5e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a80a0a4dbbe3cf8a9fb074c7556715823"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbb">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpulsar_1_1_reader.html#a80a0a4dbbe3cf8a9fb074c7556715823">getLastMessageId</a> (<a class="el" href="classpulsar_1_1_message_id.html">MessageId</a> &messageId)</td></tr> |
| <tr class="separator:a80a0a4dbbe3cf8a9fb074c7556715823"><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:ac1899b25eaceed54fad39b7b44d8a00f"><td class="memItemLeft" align="right" valign="top"><a id="ac1899b25eaceed54fad39b7b44d8a00f"></a> |
| class </td><td class="memItemRight" valign="bottom"><b>PulsarFriend</b></td></tr> |
| <tr class="separator:ac1899b25eaceed54fad39b7b44d8a00f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aec24ec969dcf4df0185304ccbf6d653c"><td class="memItemLeft" align="right" valign="top"><a id="aec24ec969dcf4df0185304ccbf6d653c"></a> |
| class </td><td class="memItemRight" valign="bottom"><b>PulsarWrapper</b></td></tr> |
| <tr class="separator:aec24ec969dcf4df0185304ccbf6d653c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad487408ba3f9484aa0f890458286d71d"><td class="memItemLeft" align="right" valign="top"><a id="ad487408ba3f9484aa0f890458286d71d"></a> |
| class </td><td class="memItemRight" valign="bottom"><b>ReaderImpl</b></td></tr> |
| <tr class="separator:ad487408ba3f9484aa0f890458286d71d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1854aa6ea210fd235b7165e67178645b"><td class="memItemLeft" align="right" valign="top"><a id="a1854aa6ea210fd235b7165e67178645b"></a> |
| class </td><td class="memItemRight" valign="bottom"><b>TableViewImpl</b></td></tr> |
| <tr class="separator:a1854aa6ea210fd235b7165e67178645b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab4fd26c01391d0e9642830b3f3442e0c"><td class="memItemLeft" align="right" valign="top"><a id="ab4fd26c01391d0e9642830b3f3442e0c"></a> |
| class </td><td class="memItemRight" valign="bottom"><b>ReaderTest</b></td></tr> |
| <tr class="separator:ab4fd26c01391d0e9642830b3f3442e0c"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>A <a class="el" href="classpulsar_1_1_reader.html">Reader</a> can be used to scan through all the messages currently available in a topic. </p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="a1c34e49ba3dbca0ff7e23ea9ff94db7b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a1c34e49ba3dbca0ff7e23ea9ff94db7b">◆ </a></span>Reader()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">pulsar::Reader::Reader </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Construct an uninitialized reader object </p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="ab15cfd0e35d625d2f1af5936c314b623"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ab15cfd0e35d625d2f1af5936c314b623">◆ </a></span>close()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbb">Result</a> pulsar::Reader::close </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Close the reader and stop the broker to push more messages</p> |
| <dl class="section return"><dt>Returns</dt><dd>ResultOk if the reader is closed successfully </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a203d50fd687e2c77e4f7e7bb0b14bab7"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a203d50fd687e2c77e4f7e7bb0b14bab7">◆ </a></span>closeAsync()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void pulsar::Reader::closeAsync </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="namespacepulsar.html#ae5bf6401bfa8e3962e5c8f9fa2efbf4d">ResultCallback</a> </td> |
| <td class="paramname"><em>callback</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Asynchronously close the reader and stop the broker to push more messages</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">callback</td><td>the callback that is triggered when the reader is closed </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a80a0a4dbbe3cf8a9fb074c7556715823"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a80a0a4dbbe3cf8a9fb074c7556715823">◆ </a></span>getLastMessageId()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbb">Result</a> pulsar::Reader::getLastMessageId </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classpulsar_1_1_message_id.html">MessageId</a> & </td> |
| <td class="paramname"><em>messageId</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Get an ID of the last available message or a message ID with -1 as an entryId if the topic is empty. </p> |
| |
| </div> |
| </div> |
| <a id="a1f863d880dc85400e7e50fcd831d7f5e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a1f863d880dc85400e7e50fcd831d7f5e">◆ </a></span>getLastMessageIdAsync()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void pulsar::Reader::getLastMessageIdAsync </td> |
| <td>(</td> |
| <td class="paramtype">GetLastMessageIdCallback </td> |
| <td class="paramname"><em>callback</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Asynchronously get an ID of the last available message or a message ID with -1 as an entryId if the topic is empty. </p> |
| |
| </div> |
| </div> |
| <a id="ad74c3a9d1999bfd9074747929f1ddf70"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ad74c3a9d1999bfd9074747929f1ddf70">◆ </a></span>getTopic()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const std::string& pulsar::Reader::getTopic </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="section return"><dt>Returns</dt><dd>the topic this reader is reading from </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a7f751b63fba4d4734ff79da590f9fd56"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a7f751b63fba4d4734ff79da590f9fd56">◆ </a></span>hasMessageAvailable()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbb">Result</a> pulsar::Reader::hasMessageAvailable </td> |
| <td>(</td> |
| <td class="paramtype">bool & </td> |
| <td class="paramname"><em>hasMessageAvailable</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Check if there is any message available to read from the current position. </p> |
| |
| </div> |
| </div> |
| <a id="a0c3755b32954d1aeb1b4ef60e4314c1d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a0c3755b32954d1aeb1b4ef60e4314c1d">◆ </a></span>hasMessageAvailableAsync()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void pulsar::Reader::hasMessageAvailableAsync </td> |
| <td>(</td> |
| <td class="paramtype">HasMessageAvailableCallback </td> |
| <td class="paramname"><em>callback</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Asynchronously check if there is any message available to read from the current position. </p> |
| |
| </div> |
| </div> |
| <a id="a9eda13274f7b1f880694fc1178ae631d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a9eda13274f7b1f880694fc1178ae631d">◆ </a></span>isConnected()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool pulsar::Reader::isConnected </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="section return"><dt>Returns</dt><dd>Whether the reader is currently connected to the broker </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a11756c69a2f5bd99e302a384ae8a9ff4"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a11756c69a2f5bd99e302a384ae8a9ff4">◆ </a></span>readNext() <span class="overload">[1/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbb">Result</a> pulsar::Reader::readNext </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classpulsar_1_1_message.html">Message</a> & </td> |
| <td class="paramname"><em>msg</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Read a single message.</p> |
| <p>If a message is not immediately available, this method will block until a new message is available.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">msg</td><td>a non-const reference where the received message will be copied </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>ResultOk when a message is received </dd> |
| <dd> |
| ResultInvalidConfiguration if a message listener had been set in the configuration </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a39c664ea68774721bc0e772b38449b22"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a39c664ea68774721bc0e772b38449b22">◆ </a></span>readNext() <span class="overload">[2/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbb">Result</a> pulsar::Reader::readNext </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classpulsar_1_1_message.html">Message</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>timeoutMs</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Read a single message</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">msg</td><td>a non-const reference where the received message will be copied </td></tr> |
| <tr><td class="paramname">timeoutMs</td><td>the receive timeout in milliseconds </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>ResultOk if a message was received </dd> |
| <dd> |
| ResultTimeout if the receive timeout was triggered </dd> |
| <dd> |
| ResultInvalidConfiguration if a message listener had been set in the configuration </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a1ed12cbc71284694e5ff9fee1e7c462d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a1ed12cbc71284694e5ff9fee1e7c462d">◆ </a></span>readNextAsync()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void pulsar::Reader::readNextAsync </td> |
| <td>(</td> |
| <td class="paramtype">ReadNextCallback </td> |
| <td class="paramname"><em>callback</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Read asynchronously the next message in the topic.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">callback</td><td></td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a6bec25700e5b4eb7be41625a9bc856bd"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a6bec25700e5b4eb7be41625a9bc856bd">◆ </a></span>seek() <span class="overload">[1/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbb">Result</a> pulsar::Reader::seek </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="classpulsar_1_1_message_id.html">MessageId</a> & </td> |
| <td class="paramname"><em>msgId</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Reset the this reader to a specific message id. The message id can either be a specific message or represent the first or last messages in the topic.</p> |
| <p>Note: this operation can only be done on non-partitioned topics. For these, one can rather perform the <a class="el" href="classpulsar_1_1_reader.html#a6bec25700e5b4eb7be41625a9bc856bd">seek()</a> on the individual partitions.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">messageId</td><td>the message id where to reposition the subscription </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="adebdd61a5150777704c8ce8dcec08fc8"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#adebdd61a5150777704c8ce8dcec08fc8">◆ </a></span>seek() <span class="overload">[2/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbb">Result</a> pulsar::Reader::seek </td> |
| <td>(</td> |
| <td class="paramtype">uint64_t </td> |
| <td class="paramname"><em>timestamp</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Reset this reader to a specific message publish time.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">timestamp</td><td>the message publish time where to reposition the subscription </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="acba58f8fb3ecefc4a693a1091f3c4669"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#acba58f8fb3ecefc4a693a1091f3c4669">◆ </a></span>seekAsync() <span class="overload">[1/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void pulsar::Reader::seekAsync </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="classpulsar_1_1_message_id.html">MessageId</a> & </td> |
| <td class="paramname"><em>msgId</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="namespacepulsar.html#ae5bf6401bfa8e3962e5c8f9fa2efbf4d">ResultCallback</a> </td> |
| <td class="paramname"><em>callback</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Asynchronously reset this reader to a specific message id. The message id can either be a specific message or represent the first or last messages in the topic.</p> |
| <p>Note: this operation can only be done on non-partitioned topics. For these, one can rather perform the <a class="el" href="classpulsar_1_1_reader.html#a6bec25700e5b4eb7be41625a9bc856bd">seek()</a> on the individual partitions.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">messageId</td><td>the message id where to reposition the subscription </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="addec61dc54aba2959c06a2017bea7c32"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#addec61dc54aba2959c06a2017bea7c32">◆ </a></span>seekAsync() <span class="overload">[2/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void pulsar::Reader::seekAsync </td> |
| <td>(</td> |
| <td class="paramtype">uint64_t </td> |
| <td class="paramname"><em>timestamp</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="namespacepulsar.html#ae5bf6401bfa8e3962e5c8f9fa2efbf4d">ResultCallback</a> </td> |
| <td class="paramname"><em>callback</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Asynchronously reset this reader to a specific message publish time.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">timestamp</td><td>the message publish time where to reposition the subscription </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>include/pulsar/<a class="el" href="reader_8h_source.html">Reader.h</a></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.17 |
| </small></address> |
| </body> |
| </html> |
