Skip to content

Commit c090436

Browse files
BewareMyPowerBewareMyPower
authored
Add CPP client v3.7.0 API docs (#983)
1 parent 006f19a commit c090436

File tree

371 files changed

+48568
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

371 files changed

+48568
-0
lines changed

‎static/api/cpp/3.7.x/_authentication_8h_source.html

+439
Large diffs are not rendered by default.

‎static/api/cpp/3.7.x/_batch_receive_policy_8h_source.html

+130
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
6+
<meta name="generator" content="Doxygen 1.9.8"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>pulsar-client-cpp: include/pulsar/BatchReceivePolicy.h Source File</title>
9+
<link href="tabs.css" rel="stylesheet" type="text/css"/>
10+
<script type="text/javascript" src="jquery.js"></script>
11+
<script type="text/javascript" src="dynsections.js"></script>
12+
<link href="search/search.css" rel="stylesheet" type="text/css"/>
13+
<script type="text/javascript" src="search/searchdata.js"></script>
14+
<script type="text/javascript" src="search/search.js"></script>
15+
<script type="text/javascript" src="darkmode_toggle.js"></script>
16+
<link href="doxygen.css" rel="stylesheet" type="text/css" />
17+
</head>
18+
<body>
19+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
20+
<div id="titlearea">
21+
<table cellspacing="0" cellpadding="0">
22+
<tbody>
23+
<tr id="projectrow">
24+
<td id="projectalign">
25+
<div id="projectname">pulsar-client-cpp
26+
</div>
27+
</td>
28+
</tr>
29+
</tbody>
30+
</table>
31+
</div>
32+
<!-- end header part -->
33+
<!-- Generated by Doxygen 1.9.8 -->
34+
<script type="text/javascript">
35+
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
36+
var searchBox = new SearchBox("searchBox", "search/",'.html');
37+
/* @license-end */
38+
</script>
39+
<script type="text/javascript" src="menudata.js"></script>
40+
<script type="text/javascript" src="menu.js"></script>
41+
<script type="text/javascript">
42+
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
43+
$(function() {
44+
initMenu('',true,false,'search.php','Search');
45+
$(document).ready(function() { init_search(); });
46+
});
47+
/* @license-end */
48+
</script>
49+
<div id="main-nav"></div>
50+
<script type="text/javascript">
51+
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
52+
$(document).ready(function() { init_codefold(0); });
53+
/* @license-end */
54+
</script>
55+
<!-- window showing the filter options -->
56+
<div id="MSearchSelectWindow"
57+
onmouseover="return searchBox.OnSearchSelectShow()"
58+
onmouseout="return searchBox.OnSearchSelectHide()"
59+
onkeydown="return searchBox.OnSearchSelectKey(event)">
60+
</div>
61+
62+
<!-- iframe showing the search results (closed by default) -->
63+
<div id="MSearchResultsWindow">
64+
<div id="MSearchResults">
65+
<div class="SRPage">
66+
<div id="SRIndex">
67+
<div id="SRResults"></div>
68+
<div class="SRStatus" id="Loading">Loading...</div>
69+
<div class="SRStatus" id="Searching">Searching...</div>
70+
<div class="SRStatus" id="NoMatches">No Matches</div>
71+
</div>
72+
</div>
73+
</div>
74+
</div>
75+
76+
<div id="nav-path" class="navpath">
77+
<ul>
78+
<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>
79+
</div>
80+
</div><!-- top -->
81+
<div class="header">
82+
<div class="headertitle"><div class="title">BatchReceivePolicy.h</div></div>
83+
</div><!--header-->
84+
<div class="contents">
85+
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span> </div>
86+
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="preprocessor">#ifndef BATCH_RECEIVE_POLICY_HPP_</span></div>
87+
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#define BATCH_RECEIVE_POLICY_HPP_</span></div>
88+
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div>
89+
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="preprocessor">#include &lt;pulsar/defines.h&gt;</span></div>
90+
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> </div>
91+
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="preprocessor">#include &lt;memory&gt;</span></div>
92+
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> </div>
93+
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespacepulsar.html">pulsar</a> {</div>
94+
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> </div>
95+
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="keyword">struct </span>BatchReceivePolicyImpl;</div>
96+
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> </div>
97+
<div class="foldopen" id="foldopen00052" data-start="{" data-end="};">
98+
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"><a class="line" href="classpulsar_1_1_batch_receive_policy.html"> 52</a></span><span class="keyword">class </span>PULSAR_PUBLIC <a class="code hl_class" href="classpulsar_1_1_batch_receive_policy.html">BatchReceivePolicy</a> {</div>
99+
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> <span class="keyword">public</span>:</div>
100+
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"><a class="line" href="classpulsar_1_1_batch_receive_policy.html#a95e11e66f6e2a2ae0d842c39f15ebfe0"> 57</a></span> <a class="code hl_function" href="classpulsar_1_1_batch_receive_policy.html#a95e11e66f6e2a2ae0d842c39f15ebfe0">BatchReceivePolicy</a>();</div>
101+
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> </div>
102+
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"><a class="line" href="classpulsar_1_1_batch_receive_policy.html#af991536bbae3de08b7d11ad3ad28f647"> 66</a></span> <a class="code hl_function" href="classpulsar_1_1_batch_receive_policy.html#af991536bbae3de08b7d11ad3ad28f647">BatchReceivePolicy</a>(<span class="keywordtype">int</span> maxNumMessage, <span class="keywordtype">long</span> maxNumBytes, <span class="keywordtype">long</span> timeoutMs);</div>
103+
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> </div>
104+
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"><a class="line" href="classpulsar_1_1_batch_receive_policy.html#acb75726b7e7a75dc65181bada30b9f31"> 73</a></span> <span class="keywordtype">long</span> <a class="code hl_function" href="classpulsar_1_1_batch_receive_policy.html#acb75726b7e7a75dc65181bada30b9f31">getTimeoutMs</a>() <span class="keyword">const</span>;</div>
105+
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> </div>
106+
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"><a class="line" href="classpulsar_1_1_batch_receive_policy.html#a079a3ecd654faeff462a673a4ba94940"> 79</a></span> <span class="keywordtype">int</span> <a class="code hl_function" href="classpulsar_1_1_batch_receive_policy.html#a079a3ecd654faeff462a673a4ba94940">getMaxNumMessages</a>() <span class="keyword">const</span>;</div>
107+
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> </div>
108+
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"><a class="line" href="classpulsar_1_1_batch_receive_policy.html#a81bf902bd62c003126aafb50a1ea7dea"> 85</a></span> <span class="keywordtype">long</span> <a class="code hl_function" href="classpulsar_1_1_batch_receive_policy.html#a81bf902bd62c003126aafb50a1ea7dea">getMaxNumBytes</a>() <span class="keyword">const</span>;</div>
109+
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> </div>
110+
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> <span class="keyword">private</span>:</div>
111+
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> std::shared_ptr&lt;BatchReceivePolicyImpl&gt; impl_;</div>
112+
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span>};</div>
113+
</div>
114+
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span>} <span class="comment">// namespace pulsar</span></div>
115+
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> </div>
116+
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span><span class="preprocessor">#endif </span><span class="comment">/* BATCH_RECEIVE_POLICY_HPP_ */</span><span class="preprocessor"></span></div>
117+
<div class="ttc" id="aclasspulsar_1_1_batch_receive_policy_html"><div class="ttname"><a href="classpulsar_1_1_batch_receive_policy.html">pulsar::BatchReceivePolicy</a></div><div class="ttdef"><b>Definition</b> BatchReceivePolicy.h:52</div></div>
118+
<div class="ttc" id="aclasspulsar_1_1_batch_receive_policy_html_a079a3ecd654faeff462a673a4ba94940"><div class="ttname"><a href="classpulsar_1_1_batch_receive_policy.html#a079a3ecd654faeff462a673a4ba94940">pulsar::BatchReceivePolicy::getMaxNumMessages</a></div><div class="ttdeci">int getMaxNumMessages() const</div></div>
119+
<div class="ttc" id="aclasspulsar_1_1_batch_receive_policy_html_a81bf902bd62c003126aafb50a1ea7dea"><div class="ttname"><a href="classpulsar_1_1_batch_receive_policy.html#a81bf902bd62c003126aafb50a1ea7dea">pulsar::BatchReceivePolicy::getMaxNumBytes</a></div><div class="ttdeci">long getMaxNumBytes() const</div></div>
120+
<div class="ttc" id="aclasspulsar_1_1_batch_receive_policy_html_a95e11e66f6e2a2ae0d842c39f15ebfe0"><div class="ttname"><a href="classpulsar_1_1_batch_receive_policy.html#a95e11e66f6e2a2ae0d842c39f15ebfe0">pulsar::BatchReceivePolicy::BatchReceivePolicy</a></div><div class="ttdeci">BatchReceivePolicy()</div></div>
121+
<div class="ttc" id="aclasspulsar_1_1_batch_receive_policy_html_acb75726b7e7a75dc65181bada30b9f31"><div class="ttname"><a href="classpulsar_1_1_batch_receive_policy.html#acb75726b7e7a75dc65181bada30b9f31">pulsar::BatchReceivePolicy::getTimeoutMs</a></div><div class="ttdeci">long getTimeoutMs() const</div></div>
122+
<div class="ttc" id="aclasspulsar_1_1_batch_receive_policy_html_af991536bbae3de08b7d11ad3ad28f647"><div class="ttname"><a href="classpulsar_1_1_batch_receive_policy.html#af991536bbae3de08b7d11ad3ad28f647">pulsar::BatchReceivePolicy::BatchReceivePolicy</a></div><div class="ttdeci">BatchReceivePolicy(int maxNumMessage, long maxNumBytes, long timeoutMs)</div></div>
123+
<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>
124+
</div><!-- fragment --></div><!-- contents -->
125+
<!-- start footer part -->
126+
<hr class="footer"/><address class="footer"><small>
127+
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
128+
</small></address>
129+
</body>
130+
</html>

0 commit comments

Comments
 (0)