| <!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/Message.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> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"> |
| <div class="title">Message.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">#ifndef MESSAGE_HPP_</span></div> |
| <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#define MESSAGE_HPP_</span></div> |
| <div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  </div> |
| <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include <pulsar/defines.h></span></div> |
| <div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  </div> |
| <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <map></span></div> |
| <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <memory></span></div> |
| <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include <string></span></div> |
| <div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  </div> |
| <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include "KeyValue.h"</span></div> |
| <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include "MessageId.h"</span></div> |
| <div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  </div> |
| <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">namespace </span><a class="code" href="namespacepulsar.html">pulsar</a> {</div> |
| <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">namespace </span>proto {</div> |
| <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">class </span>CommandMessage;</div> |
| <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">class </span>MessageMetadata;</div> |
| <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">class </span>SingleMessageMetadata;</div> |
| <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> } <span class="comment">// namespace proto</span></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">class </span>SharedBuffer;</div> |
| <div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="keyword">class </span>MessageBuilder;</div> |
| <div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="keyword">class </span>MessageImpl;</div> |
| <div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="keyword">class </span>PulsarWrapper;</div> |
| <div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  </div> |
| <div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="classpulsar_1_1_message.html"> 43</a></span> <span class="keyword">class </span>PULSAR_PUBLIC <a class="code" href="classpulsar_1_1_message.html">Message</a> {</div> |
| <div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keyword">public</span>:</div> |
| <div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keyword">typedef</span> std::map<std::string, std::string> StringMap;</div> |
| <div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  </div> |
| <div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <a class="code" href="classpulsar_1_1_message.html">Message</a>();</div> |
| <div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  </div> |
| <div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keyword">const</span> StringMap& getProperties() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  </div> |
| <div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keywordtype">bool</span> hasProperty(<span class="keyword">const</span> std::string& name) <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  </div> |
| <div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keyword">const</span> std::string& getProperty(<span class="keyword">const</span> std::string& name) <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  </div> |
| <div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keyword">const</span> <span class="keywordtype">void</span>* getData() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  </div> |
| <div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  std::size_t getLength() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  </div> |
| <div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="preprocessor">#if defined(_MSC_VER) && !defined(NDEBUG)</span></div> |
| <div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <span class="keyword">const</span> std::string& getDataAsString() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="preprocessor">#else</span></div> |
| <div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  std::string getDataAsString() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="preprocessor">#endif</span></div> |
| <div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  </div> |
| <div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  <a class="code" href="classpulsar_1_1_key_value.html">KeyValue</a> getKeyValueData() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  </div> |
| <div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  <span class="keyword">const</span> <a class="code" href="classpulsar_1_1_message_id.html">MessageId</a>& getMessageId() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  </div> |
| <div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  <span class="keywordtype">void</span> setMessageId(<span class="keyword">const</span> <a class="code" href="classpulsar_1_1_message_id.html">MessageId</a>& messageId) <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  </div> |
| <div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  <span class="keyword">const</span> std::string& getPartitionKey() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  </div> |
| <div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  <span class="keywordtype">bool</span> hasPartitionKey() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  </div> |
| <div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  <span class="keyword">const</span> std::string& getOrderingKey() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  </div> |
| <div class="line"><a name="l00151"></a><span class="lineno"> 151</span>  <span class="keywordtype">bool</span> hasOrderingKey() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00152"></a><span class="lineno"> 152</span>  </div> |
| <div class="line"><a name="l00157"></a><span class="lineno"> 157</span>  uint64_t getPublishTimestamp() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  </div> |
| <div class="line"><a name="l00162"></a><span class="lineno"> 162</span>  uint64_t getEventTimestamp() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00163"></a><span class="lineno"> 163</span>  </div> |
| <div class="line"><a name="l00167"></a><span class="lineno"> 167</span>  <span class="keyword">const</span> std::string& getTopicName() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00168"></a><span class="lineno"> 168</span>  </div> |
| <div class="line"><a name="l00172"></a><span class="lineno"> 172</span>  <span class="keyword">const</span> <span class="keywordtype">int</span> getRedeliveryCount() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00173"></a><span class="lineno"> 173</span>  </div> |
| <div class="line"><a name="l00177"></a><span class="lineno"> 177</span>  <span class="keywordtype">bool</span> hasSchemaVersion() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00178"></a><span class="lineno"> 178</span>  </div> |
| <div class="line"><a name="l00184"></a><span class="lineno"> 184</span>  int64_t getLongSchemaVersion() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00185"></a><span class="lineno"> 185</span>  </div> |
| <div class="line"><a name="l00189"></a><span class="lineno"> 189</span>  <span class="keyword">const</span> std::string& getSchemaVersion() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00190"></a><span class="lineno"> 190</span>  </div> |
| <div class="line"><a name="l00191"></a><span class="lineno"> 191</span>  <span class="keywordtype">bool</span> operator==(<span class="keyword">const</span> <a class="code" href="classpulsar_1_1_message.html">Message</a>& msg) <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00192"></a><span class="lineno"> 192</span>  </div> |
| <div class="line"><a name="l00193"></a><span class="lineno"> 193</span>  <span class="keyword">protected</span>:</div> |
| <div class="line"><a name="l00194"></a><span class="lineno"> 194</span>  <span class="keyword">typedef</span> std::shared_ptr<MessageImpl> MessageImplPtr;</div> |
| <div class="line"><a name="l00195"></a><span class="lineno"> 195</span>  MessageImplPtr impl_;</div> |
| <div class="line"><a name="l00196"></a><span class="lineno"> 196</span>  </div> |
| <div class="line"><a name="l00197"></a><span class="lineno"> 197</span>  <a class="code" href="classpulsar_1_1_message.html">Message</a>(MessageImplPtr& impl);</div> |
| <div class="line"><a name="l00198"></a><span class="lineno"> 198</span>  <a class="code" href="classpulsar_1_1_message.html">Message</a>(<span class="keyword">const</span> <a class="code" href="classpulsar_1_1_message_id.html">MessageId</a>& messageId, proto::MessageMetadata& metadata, SharedBuffer& payload);</div> |
| <div class="line"><a name="l00200"></a><span class="lineno"> 200</span>  <a class="code" href="classpulsar_1_1_message.html">Message</a>(<span class="keyword">const</span> <a class="code" href="classpulsar_1_1_message_id.html">MessageId</a>& messageId, proto::MessageMetadata& metadata, SharedBuffer& payload,</div> |
| <div class="line"><a name="l00201"></a><span class="lineno"> 201</span>  proto::SingleMessageMetadata& singleMetadata, <span class="keyword">const</span> std::shared_ptr<std::string>& topicName);</div> |
| <div class="line"><a name="l00202"></a><span class="lineno"> 202</span>  <span class="keyword">friend</span> <span class="keyword">class </span>PartitionedProducerImpl;</div> |
| <div class="line"><a name="l00203"></a><span class="lineno"> 203</span>  <span class="keyword">friend</span> <span class="keyword">class </span>MultiTopicsConsumerImpl;</div> |
| <div class="line"><a name="l00204"></a><span class="lineno"> 204</span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classpulsar_1_1_message_builder.html">MessageBuilder</a>;</div> |
| <div class="line"><a name="l00205"></a><span class="lineno"> 205</span>  <span class="keyword">friend</span> <span class="keyword">class </span>ConsumerImpl;</div> |
| <div class="line"><a name="l00206"></a><span class="lineno"> 206</span>  <span class="keyword">friend</span> <span class="keyword">class </span>ProducerImpl;</div> |
| <div class="line"><a name="l00207"></a><span class="lineno"> 207</span>  <span class="keyword">friend</span> <span class="keyword">class </span>Commands;</div> |
| <div class="line"><a name="l00208"></a><span class="lineno"> 208</span>  <span class="keyword">friend</span> <span class="keyword">class </span>BatchMessageContainerBase;</div> |
| <div class="line"><a name="l00209"></a><span class="lineno"> 209</span>  <span class="keyword">friend</span> <span class="keyword">class </span>BatchAcknowledgementTracker;</div> |
| <div class="line"><a name="l00210"></a><span class="lineno"> 210</span>  <span class="keyword">friend</span> <span class="keyword">class </span>PulsarWrapper;</div> |
| <div class="line"><a name="l00211"></a><span class="lineno"> 211</span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classpulsar_1_1_message_batch.html">MessageBatch</a>;</div> |
| <div class="line"><a name="l00212"></a><span class="lineno"> 212</span>  <span class="keyword">friend</span> <span class="keyword">struct </span>OpSendMsg;</div> |
| <div class="line"><a name="l00213"></a><span class="lineno"> 213</span>  </div> |
| <div class="line"><a name="l00214"></a><span class="lineno"> 214</span>  <span class="keyword">friend</span> PULSAR_PUBLIC std::ostream& operator<<(std::ostream& s, <span class="keyword">const</span> StringMap& map);</div> |
| <div class="line"><a name="l00215"></a><span class="lineno"> 215</span>  <span class="keyword">friend</span> PULSAR_PUBLIC std::ostream& operator<<(std::ostream& s, <span class="keyword">const</span> <a class="code" href="classpulsar_1_1_message.html">Message</a>& msg);</div> |
| <div class="line"><a name="l00216"></a><span class="lineno"> 216</span>  <span class="keyword">friend</span> <span class="keyword">class </span>PulsarFriend;</div> |
| <div class="line"><a name="l00217"></a><span class="lineno"> 217</span> };</div> |
| <div class="line"><a name="l00218"></a><span class="lineno"> 218</span> } <span class="comment">// namespace pulsar</span></div> |
| <div class="line"><a name="l00219"></a><span class="lineno"> 219</span>  </div> |
| <div class="line"><a name="l00220"></a><span class="lineno"> 220</span> <span class="preprocessor">#endif </span><span class="comment">/* MESSAGE_HPP_ */</span><span class="preprocessor"></span></div> |
| </div><!-- fragment --></div><!-- contents --> |
| <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_message_batch_html"><div class="ttname"><a href="classpulsar_1_1_message_batch.html">pulsar::MessageBatch</a></div><div class="ttdef"><b>Definition:</b> MessageBatch.h:29</div></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:43</div></div> |
| <div class="ttc" id="aclasspulsar_1_1_key_value_html"><div class="ttname"><a href="classpulsar_1_1_key_value.html">pulsar::KeyValue</a></div><div class="ttdef"><b>Definition:</b> KeyValue.h:35</div></div> |
| <div class="ttc" id="aclasspulsar_1_1_message_builder_html"><div class="ttname"><a href="classpulsar_1_1_message_builder.html">pulsar::MessageBuilder</a></div><div class="ttdef"><b>Definition:</b> MessageBuilder.h:33</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> |
| <!-- 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> |
