| <!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.7"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>pulsar-client-cpp: pulsar::Message 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> |
| <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.7 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&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&dn=expat.txt MIT */ |
| $(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"> |
| <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="namespacepulsar.html">pulsar</a></li><li class="navelem"><a class="el" href="classpulsar_1_1_message.html">Message</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-types">Public Types</a> | |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pro-types">Protected Types</a> | |
| <a href="#pro-methods">Protected Member Functions</a> | |
| <a href="#pro-attribs">Protected Attributes</a> | |
| <a href="#friends">Friends</a> | |
| <a href="classpulsar_1_1_message-members.html">List of all members</a> </div> |
| <div class="headertitle"><div class="title">pulsar::Message Class Reference</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| <div class="dynheader"> |
| Inheritance diagram for pulsar::Message:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="classpulsar_1_1_message.png" usemap="#pulsar::Message_map" alt=""/> |
| <map id="pulsar::Message_map" name="pulsar::Message_map"> |
| <area href="classpulsar_1_1_typed_message.html" alt="pulsar::TypedMessage< T >" shape="rect" coords="0,56,170,80"/> |
| </map> |
| </div></div> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a> |
| Public Types</h2></td></tr> |
| <tr class="memitem:afac658bb0a34af2efd08e03d0e911473"><td class="memItemLeft" align="right" valign="top"><a id="afac658bb0a34af2efd08e03d0e911473" name="afac658bb0a34af2efd08e03d0e911473"></a> |
| typedef std::map< std::string, std::string > </td><td class="memItemRight" valign="bottom"><b>StringMap</b></td></tr> |
| <tr class="separator:afac658bb0a34af2efd08e03d0e911473"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr class="memitem:adb69adf5f4e63cf0fb9fef0f7bc7281c"><td class="memItemLeft" align="right" valign="top">const StringMap & </td><td class="memItemRight" valign="bottom"><a class="el" href="classpulsar_1_1_message.html#adb69adf5f4e63cf0fb9fef0f7bc7281c">getProperties</a> () const</td></tr> |
| <tr class="separator:adb69adf5f4e63cf0fb9fef0f7bc7281c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad3e557ed946f94e6964147a8389532bd"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classpulsar_1_1_message.html#ad3e557ed946f94e6964147a8389532bd">hasProperty</a> (const std::string &name) const</td></tr> |
| <tr class="separator:ad3e557ed946f94e6964147a8389532bd"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a69b6576136ccce73f448e2dbaad8d357"><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classpulsar_1_1_message.html#a69b6576136ccce73f448e2dbaad8d357">getProperty</a> (const std::string &name) const</td></tr> |
| <tr class="separator:a69b6576136ccce73f448e2dbaad8d357"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab485e3ff7dbefa8c0523ebaabef55d5d"><td class="memItemLeft" align="right" valign="top">const void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classpulsar_1_1_message.html#ab485e3ff7dbefa8c0523ebaabef55d5d">getData</a> () const</td></tr> |
| <tr class="separator:ab485e3ff7dbefa8c0523ebaabef55d5d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa47d8ca71292939d4d15e4b543835234"><td class="memItemLeft" align="right" valign="top">std::size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classpulsar_1_1_message.html#aa47d8ca71292939d4d15e4b543835234">getLength</a> () const</td></tr> |
| <tr class="separator:aa47d8ca71292939d4d15e4b543835234"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a45863405a4d3804cc8415d22d502f5c5"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classpulsar_1_1_message.html#a45863405a4d3804cc8415d22d502f5c5">getDataAsString</a> () const</td></tr> |
| <tr class="separator:a45863405a4d3804cc8415d22d502f5c5"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2d282f106addab953cf7b831ffb3f067"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpulsar_1_1_key_value.html">KeyValue</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpulsar_1_1_message.html#a2d282f106addab953cf7b831ffb3f067">getKeyValueData</a> () const</td></tr> |
| <tr class="separator:a2d282f106addab953cf7b831ffb3f067"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad86803a4284b722117abb650c6db0aef"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classpulsar_1_1_message_id.html">MessageId</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classpulsar_1_1_message.html#ad86803a4284b722117abb650c6db0aef">getMessageId</a> () const</td></tr> |
| <tr class="separator:ad86803a4284b722117abb650c6db0aef"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a441a530a2943fc45133690bda73a113a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classpulsar_1_1_message.html#a441a530a2943fc45133690bda73a113a">setMessageId</a> (const <a class="el" href="classpulsar_1_1_message_id.html">MessageId</a> &messageId) const</td></tr> |
| <tr class="separator:a441a530a2943fc45133690bda73a113a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7412304904208c662b346d6328b14261"><td class="memItemLeft" align="right" valign="top">int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classpulsar_1_1_message.html#a7412304904208c662b346d6328b14261">getIndex</a> () const</td></tr> |
| <tr class="separator:a7412304904208c662b346d6328b14261"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a121f31f3216678187c069c681b3b4d7e"><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classpulsar_1_1_message.html#a121f31f3216678187c069c681b3b4d7e">getPartitionKey</a> () const</td></tr> |
| <tr class="separator:a121f31f3216678187c069c681b3b4d7e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a171e78738da5932678cfd83c347186bf"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classpulsar_1_1_message.html#a171e78738da5932678cfd83c347186bf">hasPartitionKey</a> () const</td></tr> |
| <tr class="separator:a171e78738da5932678cfd83c347186bf"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab237804a174974f73bb73970b0163c65"><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classpulsar_1_1_message.html#ab237804a174974f73bb73970b0163c65">getOrderingKey</a> () const</td></tr> |
| <tr class="separator:ab237804a174974f73bb73970b0163c65"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad29a0aeda1dbb934e7c3311d85d0aa02"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classpulsar_1_1_message.html#ad29a0aeda1dbb934e7c3311d85d0aa02">hasOrderingKey</a> () const</td></tr> |
| <tr class="separator:ad29a0aeda1dbb934e7c3311d85d0aa02"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac0a02a1da349789215e6f1a3b6e3f180"><td class="memItemLeft" align="right" valign="top">uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classpulsar_1_1_message.html#ac0a02a1da349789215e6f1a3b6e3f180">getPublishTimestamp</a> () const</td></tr> |
| <tr class="separator:ac0a02a1da349789215e6f1a3b6e3f180"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a952c044fb615b886070bcda08f7ba9f6"><td class="memItemLeft" align="right" valign="top">uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classpulsar_1_1_message.html#a952c044fb615b886070bcda08f7ba9f6">getEventTimestamp</a> () const</td></tr> |
| <tr class="separator:a952c044fb615b886070bcda08f7ba9f6"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:adb7dacb620c7fad56f0aa1d6ae52bb88"><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classpulsar_1_1_message.html#adb7dacb620c7fad56f0aa1d6ae52bb88">getTopicName</a> () const</td></tr> |
| <tr class="separator:adb7dacb620c7fad56f0aa1d6ae52bb88"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aca393b369e6c9ba90c38acac37b54d60"><td class="memItemLeft" align="right" valign="top">const int </td><td class="memItemRight" valign="bottom"><a class="el" href="classpulsar_1_1_message.html#aca393b369e6c9ba90c38acac37b54d60">getRedeliveryCount</a> () const</td></tr> |
| <tr class="separator:aca393b369e6c9ba90c38acac37b54d60"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a51dee56cd5f71a4d4c2cae8a1b42feef"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classpulsar_1_1_message.html#a51dee56cd5f71a4d4c2cae8a1b42feef">hasSchemaVersion</a> () const</td></tr> |
| <tr class="separator:a51dee56cd5f71a4d4c2cae8a1b42feef"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4a4d35b3098d18b04f998764d3c2ce76"><td class="memItemLeft" align="right" valign="top">int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classpulsar_1_1_message.html#a4a4d35b3098d18b04f998764d3c2ce76">getLongSchemaVersion</a> () const</td></tr> |
| <tr class="separator:a4a4d35b3098d18b04f998764d3c2ce76"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac39590d8db47e6011c4185664350f52d"><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classpulsar_1_1_message.html#ac39590d8db47e6011c4185664350f52d">getSchemaVersion</a> () const</td></tr> |
| <tr class="separator:ac39590d8db47e6011c4185664350f52d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a27114c937b215fbb6931bd3f0070e667"><td class="memItemLeft" align="right" valign="top"><a id="a27114c937b215fbb6931bd3f0070e667" name="a27114c937b215fbb6931bd3f0070e667"></a> |
| bool </td><td class="memItemRight" valign="bottom"><b>operator==</b> (const <a class="el" href="classpulsar_1_1_message.html">Message</a> &msg) const</td></tr> |
| <tr class="separator:a27114c937b215fbb6931bd3f0070e667"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-types" name="pro-types"></a> |
| Protected Types</h2></td></tr> |
| <tr class="memitem:a57245815a904abad0625dc1d112c4d61"><td class="memItemLeft" align="right" valign="top"><a id="a57245815a904abad0625dc1d112c4d61" name="a57245815a904abad0625dc1d112c4d61"></a> |
| typedef std::shared_ptr< MessageImpl > </td><td class="memItemRight" valign="bottom"><b>MessageImplPtr</b></td></tr> |
| <tr class="separator:a57245815a904abad0625dc1d112c4d61"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-methods" name="pro-methods"></a> |
| Protected Member Functions</h2></td></tr> |
| <tr class="memitem:a937fde410b6d5d30f5ff0e43fb1c1440"><td class="memItemLeft" align="right" valign="top"><a id="a937fde410b6d5d30f5ff0e43fb1c1440" name="a937fde410b6d5d30f5ff0e43fb1c1440"></a> |
|  </td><td class="memItemRight" valign="bottom"><b>Message</b> (MessageImplPtr &impl)</td></tr> |
| <tr class="separator:a937fde410b6d5d30f5ff0e43fb1c1440"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad99c119fcbca7dada47bf93e66b31999"><td class="memItemLeft" align="right" valign="top"><a id="ad99c119fcbca7dada47bf93e66b31999" name="ad99c119fcbca7dada47bf93e66b31999"></a> |
|  </td><td class="memItemRight" valign="bottom"><b>Message</b> (const <a class="el" href="classpulsar_1_1_message_id.html">MessageId</a> &messageId, proto::BrokerEntryMetadata &brokerEntryMetadata, proto::MessageMetadata &metadata, SharedBuffer &payload)</td></tr> |
| <tr class="separator:ad99c119fcbca7dada47bf93e66b31999"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa3c4673ec7b3c99cc3faf9aa931a4531"><td class="memItemLeft" align="right" valign="top"><a id="aa3c4673ec7b3c99cc3faf9aa931a4531" name="aa3c4673ec7b3c99cc3faf9aa931a4531"></a> |
|  </td><td class="memItemRight" valign="bottom"><b>Message</b> (const <a class="el" href="classpulsar_1_1_message_id.html">MessageId</a> &messageId, proto::BrokerEntryMetadata &brokerEntryMetadata, proto::MessageMetadata &metadata, SharedBuffer &payload, proto::SingleMessageMetadata &singleMetadata, const std::shared_ptr< std::string > &topicName)</td></tr> |
| <tr class="memdesc:aa3c4673ec7b3c99cc3faf9aa931a4531"><td class="mdescLeft"> </td><td class="mdescRight">Used for Batch Messages. <br /></td></tr> |
| <tr class="separator:aa3c4673ec7b3c99cc3faf9aa931a4531"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-attribs" name="pro-attribs"></a> |
| Protected Attributes</h2></td></tr> |
| <tr class="memitem:acb03f6a43fb36a4f0c322f4ddc160865"><td class="memItemLeft" align="right" valign="top"><a id="acb03f6a43fb36a4f0c322f4ddc160865" name="acb03f6a43fb36a4f0c322f4ddc160865"></a> |
| MessageImplPtr </td><td class="memItemRight" valign="bottom"><b>impl_</b></td></tr> |
| <tr class="separator:acb03f6a43fb36a4f0c322f4ddc160865"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="friends" name="friends"></a> |
| Friends</h2></td></tr> |
| <tr class="memitem:a93a73f83d9521ceb15a9adc90042195a"><td class="memItemLeft" align="right" valign="top"><a id="a93a73f83d9521ceb15a9adc90042195a" name="a93a73f83d9521ceb15a9adc90042195a"></a> |
| class </td><td class="memItemRight" valign="bottom"><b>PartitionedProducerImpl</b></td></tr> |
| <tr class="separator:a93a73f83d9521ceb15a9adc90042195a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6089ad7f42ef50ec4a9a4a906d0805d4"><td class="memItemLeft" align="right" valign="top"><a id="a6089ad7f42ef50ec4a9a4a906d0805d4" name="a6089ad7f42ef50ec4a9a4a906d0805d4"></a> |
| class </td><td class="memItemRight" valign="bottom"><b>MultiTopicsConsumerImpl</b></td></tr> |
| <tr class="separator:a6089ad7f42ef50ec4a9a4a906d0805d4"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4503f1df468d52d09a6bea3ad9cf7cdd"><td class="memItemLeft" align="right" valign="top"><a id="a4503f1df468d52d09a6bea3ad9cf7cdd" name="a4503f1df468d52d09a6bea3ad9cf7cdd"></a> |
| class </td><td class="memItemRight" valign="bottom"><b>MessageBuilder</b></td></tr> |
| <tr class="separator:a4503f1df468d52d09a6bea3ad9cf7cdd"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa5d9751b961d8852b3209e522d06e898"><td class="memItemLeft" align="right" valign="top"><a id="aa5d9751b961d8852b3209e522d06e898" name="aa5d9751b961d8852b3209e522d06e898"></a> |
| class </td><td class="memItemRight" valign="bottom"><b>ConsumerImpl</b></td></tr> |
| <tr class="separator:aa5d9751b961d8852b3209e522d06e898"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a15a52177b1b92a9081506ec66c767978"><td class="memItemLeft" align="right" valign="top"><a id="a15a52177b1b92a9081506ec66c767978" name="a15a52177b1b92a9081506ec66c767978"></a> |
| class </td><td class="memItemRight" valign="bottom"><b>ProducerImpl</b></td></tr> |
| <tr class="separator:a15a52177b1b92a9081506ec66c767978"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae9a2dffe589da1f81fa5c202d18e6551"><td class="memItemLeft" align="right" valign="top"><a id="ae9a2dffe589da1f81fa5c202d18e6551" name="ae9a2dffe589da1f81fa5c202d18e6551"></a> |
| class </td><td class="memItemRight" valign="bottom"><b>Commands</b></td></tr> |
| <tr class="separator:ae9a2dffe589da1f81fa5c202d18e6551"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:abc419b69c92427716a099bc468c39b3b"><td class="memItemLeft" align="right" valign="top"><a id="abc419b69c92427716a099bc468c39b3b" name="abc419b69c92427716a099bc468c39b3b"></a> |
| class </td><td class="memItemRight" valign="bottom"><b>BatchMessageContainerBase</b></td></tr> |
| <tr class="separator:abc419b69c92427716a099bc468c39b3b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5113984cffd1a43677de95fd5c5514eb"><td class="memItemLeft" align="right" valign="top"><a id="a5113984cffd1a43677de95fd5c5514eb" name="a5113984cffd1a43677de95fd5c5514eb"></a> |
| class </td><td class="memItemRight" valign="bottom"><b>BatchAcknowledgementTracker</b></td></tr> |
| <tr class="separator:a5113984cffd1a43677de95fd5c5514eb"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aec24ec969dcf4df0185304ccbf6d653c"><td class="memItemLeft" align="right" valign="top"><a id="aec24ec969dcf4df0185304ccbf6d653c" name="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:a1451871721adaad0ba68870cea5195e8"><td class="memItemLeft" align="right" valign="top"><a id="a1451871721adaad0ba68870cea5195e8" name="a1451871721adaad0ba68870cea5195e8"></a> |
| class </td><td class="memItemRight" valign="bottom"><b>MessageBatch</b></td></tr> |
| <tr class="separator:a1451871721adaad0ba68870cea5195e8"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:abc62b753d770fec86bc2dfc2349f542e"><td class="memItemLeft" align="right" valign="top"><a id="abc62b753d770fec86bc2dfc2349f542e" name="abc62b753d770fec86bc2dfc2349f542e"></a> |
| struct </td><td class="memItemRight" valign="bottom"><b>OpSendMsg</b></td></tr> |
| <tr class="separator:abc62b753d770fec86bc2dfc2349f542e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac1899b25eaceed54fad39b7b44d8a00f"><td class="memItemLeft" align="right" valign="top"><a id="ac1899b25eaceed54fad39b7b44d8a00f" name="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:a23c636126626eacef452fb0cc1a37062"><td class="memItemLeft" align="right" valign="top"><a id="a23c636126626eacef452fb0cc1a37062" name="a23c636126626eacef452fb0cc1a37062"></a> |
| PULSAR_PUBLIC std::ostream & </td><td class="memItemRight" valign="bottom"><b>operator<<</b> (std::ostream &s, const StringMap &map)</td></tr> |
| <tr class="separator:a23c636126626eacef452fb0cc1a37062"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab76d944fdb3bc865748d6e5e3491b0ba"><td class="memItemLeft" align="right" valign="top"><a id="ab76d944fdb3bc865748d6e5e3491b0ba" name="ab76d944fdb3bc865748d6e5e3491b0ba"></a> |
| PULSAR_PUBLIC std::ostream & </td><td class="memItemRight" valign="bottom"><b>operator<<</b> (std::ostream &s, const <a class="el" href="classpulsar_1_1_message.html">Message</a> &msg)</td></tr> |
| <tr class="separator:ab76d944fdb3bc865748d6e5e3491b0ba"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="ab485e3ff7dbefa8c0523ebaabef55d5d" name="ab485e3ff7dbefa8c0523ebaabef55d5d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ab485e3ff7dbefa8c0523ebaabef55d5d">◆ </a></span>getData()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const void * pulsar::Message::getData </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Get the content of the message</p> |
| <dl class="section return"><dt>Returns</dt><dd>the pointer to the message payload </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a45863405a4d3804cc8415d22d502f5c5" name="a45863405a4d3804cc8415d22d502f5c5"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a45863405a4d3804cc8415d22d502f5c5">◆ </a></span>getDataAsString()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::string pulsar::Message::getDataAsString </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Get string representation of the message</p> |
| <dl class="section return"><dt>Returns</dt><dd>the string representation of the message payload</dd></dl> |
| <p>NOTE: For MSVC with debug mode, return a thread local std::string object to avoid memory allocation across DLLs and applications, which could lead to a crash. </p> |
| |
| </div> |
| </div> |
| <a id="a952c044fb615b886070bcda08f7ba9f6" name="a952c044fb615b886070bcda08f7ba9f6"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a952c044fb615b886070bcda08f7ba9f6">◆ </a></span>getEventTimestamp()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">uint64_t pulsar::Message::getEventTimestamp </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Get the event timestamp associated with this message. It is set by the client producer. </p> |
| |
| </div> |
| </div> |
| <a id="a7412304904208c662b346d6328b14261" name="a7412304904208c662b346d6328b14261"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a7412304904208c662b346d6328b14261">◆ </a></span>getIndex()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int64_t pulsar::Message::getIndex </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Get the index of this message, if it doesn't exist, return -1 </p><dl class="section return"><dt>Returns</dt><dd></dd></dl> |
| |
| </div> |
| </div> |
| <a id="a2d282f106addab953cf7b831ffb3f067" name="a2d282f106addab953cf7b831ffb3f067"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a2d282f106addab953cf7b831ffb3f067">◆ </a></span>getKeyValueData()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classpulsar_1_1_key_value.html">KeyValue</a> pulsar::Message::getKeyValueData </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Get key value message.</p> |
| <dl class="section return"><dt>Returns</dt><dd>key value message. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="aa47d8ca71292939d4d15e4b543835234" name="aa47d8ca71292939d4d15e4b543835234"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa47d8ca71292939d4d15e4b543835234">◆ </a></span>getLength()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::size_t pulsar::Message::getLength </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Get the length of the message</p> |
| <dl class="section return"><dt>Returns</dt><dd>the length of the message payload </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a4a4d35b3098d18b04f998764d3c2ce76" name="a4a4d35b3098d18b04f998764d3c2ce76"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a4a4d35b3098d18b04f998764d3c2ce76">◆ </a></span>getLongSchemaVersion()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int64_t pulsar::Message::getLongSchemaVersion </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Get the schema version.</p> |
| <dl class="section return"><dt>Returns</dt><dd>the the schema version on success or -1 if the message does not have the schema version </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ad86803a4284b722117abb650c6db0aef" name="ad86803a4284b722117abb650c6db0aef"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ad86803a4284b722117abb650c6db0aef">◆ </a></span>getMessageId()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const <a class="el" href="classpulsar_1_1_message_id.html">MessageId</a> & pulsar::Message::getMessageId </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Get the unique message ID associated with this message.</p> |
| <p>The message id can be used to univocally refer to a message without having to keep the entire payload in memory.</p> |
| <p>Only messages received from the consumer will have a message id assigned. </p> |
| |
| </div> |
| </div> |
| <a id="ab237804a174974f73bb73970b0163c65" name="ab237804a174974f73bb73970b0163c65"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ab237804a174974f73bb73970b0163c65">◆ </a></span>getOrderingKey()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const std::string & pulsar::Message::getOrderingKey </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Get the ordering key of the message</p> |
| <dl class="section return"><dt>Returns</dt><dd>the ordering key of the message </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a121f31f3216678187c069c681b3b4d7e" name="a121f31f3216678187c069c681b3b4d7e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a121f31f3216678187c069c681b3b4d7e">◆ </a></span>getPartitionKey()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const std::string & pulsar::Message::getPartitionKey </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Get the partition key for this message </p><dl class="section return"><dt>Returns</dt><dd>key string that is hashed to determine message's topic partition </dd></dl> |
| |
| </div> |
| </div> |
| <a id="adb69adf5f4e63cf0fb9fef0f7bc7281c" name="adb69adf5f4e63cf0fb9fef0f7bc7281c"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#adb69adf5f4e63cf0fb9fef0f7bc7281c">◆ </a></span>getProperties()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const StringMap & pulsar::Message::getProperties </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Return the properties attached to the message. Properties are application defined key/value pairs that will be attached to the message</p> |
| <dl class="section return"><dt>Returns</dt><dd>an unmodifiable view of the properties map </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a69b6576136ccce73f448e2dbaad8d357" name="a69b6576136ccce73f448e2dbaad8d357"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a69b6576136ccce73f448e2dbaad8d357">◆ </a></span>getProperty()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const std::string & pulsar::Message::getProperty </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>name</em></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Get the value of a specific property</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">name</td><td>the name of the property </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>the value of the property or null if the property was not defined </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ac0a02a1da349789215e6f1a3b6e3f180" name="ac0a02a1da349789215e6f1a3b6e3f180"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ac0a02a1da349789215e6f1a3b6e3f180">◆ </a></span>getPublishTimestamp()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">uint64_t pulsar::Message::getPublishTimestamp </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Get the UTC based timestamp in milliseconds referring to when the message was published by the client producer </p> |
| |
| </div> |
| </div> |
| <a id="aca393b369e6c9ba90c38acac37b54d60" name="aca393b369e6c9ba90c38acac37b54d60"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aca393b369e6c9ba90c38acac37b54d60">◆ </a></span>getRedeliveryCount()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const int pulsar::Message::getRedeliveryCount </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Get the redelivery count for this message </p> |
| |
| </div> |
| </div> |
| <a id="ac39590d8db47e6011c4185664350f52d" name="ac39590d8db47e6011c4185664350f52d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ac39590d8db47e6011c4185664350f52d">◆ </a></span>getSchemaVersion()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const std::string & pulsar::Message::getSchemaVersion </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Get the schema version of the raw bytes. </p> |
| |
| </div> |
| </div> |
| <a id="adb7dacb620c7fad56f0aa1d6ae52bb88" name="adb7dacb620c7fad56f0aa1d6ae52bb88"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#adb7dacb620c7fad56f0aa1d6ae52bb88">◆ </a></span>getTopicName()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const std::string & pulsar::Message::getTopicName </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Get the topic Name from which this message originated from </p> |
| |
| </div> |
| </div> |
| <a id="ad29a0aeda1dbb934e7c3311d85d0aa02" name="ad29a0aeda1dbb934e7c3311d85d0aa02"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ad29a0aeda1dbb934e7c3311d85d0aa02">◆ </a></span>hasOrderingKey()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool pulsar::Message::hasOrderingKey </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Check whether the message has a ordering key</p> |
| <dl class="section return"><dt>Returns</dt><dd>true if the ordering key was set while creating the message false if the ordering key was not set while creating the message </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a171e78738da5932678cfd83c347186bf" name="a171e78738da5932678cfd83c347186bf"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a171e78738da5932678cfd83c347186bf">◆ </a></span>hasPartitionKey()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool pulsar::Message::hasPartitionKey </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>true if the message has a partition key </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ad3e557ed946f94e6964147a8389532bd" name="ad3e557ed946f94e6964147a8389532bd"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ad3e557ed946f94e6964147a8389532bd">◆ </a></span>hasProperty()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool pulsar::Message::hasProperty </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>name</em></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Check whether the message has a specific property attached.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">name</td><td>the name of the property to check </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>true if the message has the specified property </dd> |
| <dd> |
| false if the property is not defined </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a51dee56cd5f71a4d4c2cae8a1b42feef" name="a51dee56cd5f71a4d4c2cae8a1b42feef"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a51dee56cd5f71a4d4c2cae8a1b42feef">◆ </a></span>hasSchemaVersion()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool pulsar::Message::hasSchemaVersion </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Check if schema version exists </p> |
| |
| </div> |
| </div> |
| <a id="a441a530a2943fc45133690bda73a113a" name="a441a530a2943fc45133690bda73a113a"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a441a530a2943fc45133690bda73a113a">◆ </a></span>setMessageId()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void pulsar::Message::setMessageId </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="classpulsar_1_1_message_id.html">MessageId</a> & </td> |
| <td class="paramname"><em>messageId</em></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Set the unique message ID. </p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>include/pulsar/<a class="el" href="_message_8h_source.html">Message.h</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.7 |
| </small></address> |
| </body> |
| </html> |
