blob: 9e2e72f5afdbec5faabb7a50907ea2a1acf936b4 [file]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>pulsar-client-cpp: include/pulsar/c/client_configuration.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&amp;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&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_84093bac216bb6272e4432021f1ca7f4.html">pulsar</a></li><li class="navelem"><a class="el" href="dir_501ae28692a6b25a33adbd2bed71d4b9.html">c</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">client_configuration.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160; </div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; </div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#include &lt;pulsar/defines.h&gt;</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#include &lt;stdbool.h&gt;</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; </div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; </div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="keyword">typedef</span> <span class="keyword">enum</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;{</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; pulsar_DEBUG = 0,</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; pulsar_INFO = 1,</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; pulsar_WARN = 2,</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; pulsar_ERROR = 3</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;} pulsar_logger_level_t;</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; </div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="keyword">typedef</span> void (*pulsar_logger)(pulsar_logger_level_t level, <span class="keyword">const</span> <span class="keywordtype">char</span> *file, <span class="keywordtype">int</span> line, <span class="keyword">const</span> <span class="keywordtype">char</span> *message,</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="keywordtype">void</span> *ctx);</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; </div>
<div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="structpulsar__logger__t.html"> 40</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structpulsar__logger__t.html">pulsar_logger_t</a> {</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="comment">// The context that will be passed into `is_enabled` and `log` as the last argument</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="keywordtype">void</span> *ctx;</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="comment">// Whether to log for the given log level</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; bool (*is_enabled)(pulsar_logger_level_t level, <span class="keywordtype">void</span> *ctx);</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="comment">// How to log the message</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; pulsar_logger log;</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;} <a class="code" href="structpulsar__logger__t.html">pulsar_logger_t</a>;</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; </div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span>_pulsar_client_configuration pulsar_client_configuration_t;</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span>_pulsar_authentication pulsar_authentication_t;</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; </div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;PULSAR_PUBLIC pulsar_client_configuration_t *pulsar_client_configuration_create();</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; </div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;PULSAR_PUBLIC <span class="keywordtype">void</span> pulsar_client_configuration_free(pulsar_client_configuration_t *conf);</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; </div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;PULSAR_PUBLIC <span class="keywordtype">void</span> pulsar_client_configuration_set_auth(pulsar_client_configuration_t *conf,</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; pulsar_authentication_t *authentication);</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; </div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;PULSAR_PUBLIC <span class="keywordtype">void</span> pulsar_client_configuration_set_memory_limit(pulsar_client_configuration_t *conf,</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> memoryLimitBytes);</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; </div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160;PULSAR_PUBLIC <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> pulsar_client_configuration_get_memory_limit(</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; pulsar_client_configuration_t *conf);</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; </div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160;PULSAR_PUBLIC <span class="keywordtype">void</span> pulsar_client_configuration_set_operation_timeout_seconds(</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; pulsar_client_configuration_t *conf, <span class="keywordtype">int</span> timeout);</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; </div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160;PULSAR_PUBLIC <span class="keywordtype">int</span> pulsar_client_configuration_get_operation_timeout_seconds(</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; pulsar_client_configuration_t *conf);</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; </div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160;PULSAR_PUBLIC <span class="keywordtype">void</span> pulsar_client_configuration_set_io_threads(pulsar_client_configuration_t *conf,</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; <span class="keywordtype">int</span> threads);</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; </div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160;PULSAR_PUBLIC <span class="keywordtype">int</span> pulsar_client_configuration_get_io_threads(pulsar_client_configuration_t *conf);</div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; </div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160;PULSAR_PUBLIC <span class="keywordtype">void</span> pulsar_client_configuration_set_message_listener_threads(</div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160; pulsar_client_configuration_t *conf, <span class="keywordtype">int</span> threads);</div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; </div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160;PULSAR_PUBLIC <span class="keywordtype">int</span> pulsar_client_configuration_get_message_listener_threads(</div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160; pulsar_client_configuration_t *conf);</div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160; </div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160;PULSAR_PUBLIC <span class="keywordtype">void</span> pulsar_client_configuration_set_concurrent_lookup_request(</div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160; pulsar_client_configuration_t *conf, <span class="keywordtype">int</span> concurrentLookupRequest);</div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160; </div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160;PULSAR_PUBLIC <span class="keywordtype">int</span> pulsar_client_configuration_get_concurrent_lookup_request(</div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160; pulsar_client_configuration_t *conf);</div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>&#160; </div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>&#160;PULSAR_PUBLIC <span class="keywordtype">void</span> pulsar_client_configuration_set_logger(pulsar_client_configuration_t *conf,</div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>&#160; pulsar_logger logger, <span class="keywordtype">void</span> *ctx);</div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span>&#160; </div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160;PULSAR_PUBLIC <span class="keywordtype">void</span> pulsar_client_configuration_set_logger_t(pulsar_client_configuration_t *conf,</div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160; <a class="code" href="structpulsar__logger__t.html">pulsar_logger_t</a> logger);</div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span>&#160; </div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span>&#160;PULSAR_PUBLIC <span class="keywordtype">void</span> pulsar_client_configuration_set_use_tls(pulsar_client_configuration_t *conf, <span class="keywordtype">int</span> useTls);</div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span>&#160; </div>
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span>&#160;PULSAR_PUBLIC <span class="keywordtype">int</span> pulsar_client_configuration_is_use_tls(pulsar_client_configuration_t *conf);</div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span>&#160; </div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span>&#160;PULSAR_PUBLIC <span class="keywordtype">void</span> pulsar_client_configuration_set_tls_trust_certs_file_path(</div>
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span>&#160; pulsar_client_configuration_t *conf, <span class="keyword">const</span> <span class="keywordtype">char</span> *tlsTrustCertsFilePath);</div>
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span>&#160; </div>
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span>&#160;PULSAR_PUBLIC <span class="keyword">const</span> <span class="keywordtype">char</span> *pulsar_client_configuration_get_tls_trust_certs_file_path(</div>
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span>&#160; pulsar_client_configuration_t *conf);</div>
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span>&#160; </div>
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span>&#160;PULSAR_PUBLIC <span class="keywordtype">void</span> pulsar_client_configuration_set_tls_allow_insecure_connection(</div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span>&#160; pulsar_client_configuration_t *conf, <span class="keywordtype">int</span> allowInsecure);</div>
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span>&#160; </div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span>&#160;PULSAR_PUBLIC <span class="keywordtype">int</span> pulsar_client_configuration_is_tls_allow_insecure_connection(</div>
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span>&#160; pulsar_client_configuration_t *conf);</div>
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span>&#160; </div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span>&#160;<span class="comment"> * Initialize stats interval in seconds. Stats are printed and reset after every &#39;statsIntervalInSeconds&#39;.</span></div>
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span>&#160;<span class="comment"> * Set to 0 in order to disable stats collection.</span></div>
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span>&#160;PULSAR_PUBLIC <span class="keywordtype">void</span> pulsar_client_configuration_set_stats_interval_in_seconds(</div>
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span>&#160; pulsar_client_configuration_t *conf, <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> interval);</div>
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span>&#160; </div>
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span>&#160;PULSAR_PUBLIC <span class="keywordtype">int</span> pulsar_client_configuration_is_validate_hostname(pulsar_client_configuration_t *conf);</div>
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span>&#160; </div>
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span>&#160;PULSAR_PUBLIC <span class="keywordtype">void</span> pulsar_client_configuration_set_validate_hostname(pulsar_client_configuration_t *conf,</div>
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span>&#160; <span class="keywordtype">int</span> validateHostName);</div>
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span>&#160; </div>
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span>&#160;<span class="comment"> * Get the stats interval set in the client.</span></div>
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span>&#160;PULSAR_PUBLIC <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> pulsar_client_configuration_get_stats_interval_in_seconds(</div>
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span>&#160; pulsar_client_configuration_t *conf);</div>
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span>&#160; </div>
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span>&#160;<span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span>&#160;}</div>
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span>&#160;<span class="preprocessor">#endif</span></div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="astructpulsar__logger__t_html"><div class="ttname"><a href="structpulsar__logger__t.html">pulsar_logger_t</a></div><div class="ttdef"><b>Definition:</b> client_configuration.h:40</div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>