2
0
mirror of https://github.com/boostorg/redis.git synced 2026-01-19 04:42:09 +00:00
Files
redis/config_8hpp_source.html
Marcelo Zimbres b795d1571c v1.4.2
2023-08-18 23:22:20 +02:00

178 lines
22 KiB
HTML

<!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=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>boost_redis: boost/redis/config.hpp 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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.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/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome-sidebar-only.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">boost_redis<span id="projectnumber">&#160;1.4.2</span>
</div>
<div id="projectbrief">A redis client library</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'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&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('config_8hpp_source.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- 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 class="header">
<div class="headertitle"><div class="title">config.hpp</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/* Copyright (c) 2018-2022 Marcelo Zimbres Silva (mzimbres@gmail.com)</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> *</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> * Distributed under the Boost Software License, Version 1.0. (See</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> * accompanying file LICENSE.txt)</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> */</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span> </div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#ifndef BOOST_REDIS_CONFIG_HPP</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#define BOOST_REDIS_CONFIG_HPP</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="preprocessor">#include &lt;chrono&gt;</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="preprocessor">#include &lt;optional&gt;</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> </div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="keyword">namespace </span>boost::redis</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span>{</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> </div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"><a class="line" href="group__high-level-api.html"> 20</a></span><span class="keyword">struct </span><a class="code hl_struct" href="group__high-level-api.html#structboost_1_1redis_1_1address">address</a> {</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"><a class="line" href="group__high-level-api.html#afb00b91dd1004117161e998d04d68bae"> 22</a></span> std::string <a class="code hl_variable" href="group__high-level-api.html#afb00b91dd1004117161e998d04d68bae">host</a> = <span class="stringliteral">&quot;127.0.0.1&quot;</span>;</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"><a class="line" href="group__high-level-api.html#a629bba53218baa30ce807ce8808b9a36"> 24</a></span> std::string <a class="code hl_variable" href="group__high-level-api.html#a629bba53218baa30ce807ce8808b9a36">port</a> = <span class="stringliteral">&quot;6379&quot;</span>;</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span>};</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"><a class="line" href="group__high-level-api.html"> 30</a></span><span class="keyword">struct </span><a class="code hl_struct" href="group__high-level-api.html#structboost_1_1redis_1_1config">config</a> {</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"><a class="line" href="group__high-level-api.html#abcea19f2e03ef615aa6a955749e4d7dd"> 32</a></span> <span class="keywordtype">bool</span> <a class="code hl_variable" href="group__high-level-api.html#abcea19f2e03ef615aa6a955749e4d7dd">use_ssl</a> = <span class="keyword">false</span>;</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> </div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"><a class="line" href="group__high-level-api.html#a2304a0db25fae6498289c039b71e011f"> 35</a></span> <a class="code hl_struct" href="group__high-level-api.html#structboost_1_1redis_1_1address">address</a> <a class="code hl_variable" href="group__high-level-api.html#a2304a0db25fae6498289c039b71e011f">addr</a> = <a class="code hl_struct" href="group__high-level-api.html#structboost_1_1redis_1_1address">address</a>{<span class="stringliteral">&quot;127.0.0.1&quot;</span>, <span class="stringliteral">&quot;6379&quot;</span>};</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> </div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"><a class="line" href="group__high-level-api.html#af907445bc3426511a6d6e8a1d56edac8"> 41</a></span> std::string <a class="code hl_variable" href="group__high-level-api.html#af907445bc3426511a6d6e8a1d56edac8">username</a>;</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> </div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"><a class="line" href="group__high-level-api.html#a3cfd0bdcf176016e7a8e867e333d659f"> 47</a></span> std::string <a class="code hl_variable" href="group__high-level-api.html#a3cfd0bdcf176016e7a8e867e333d659f">password</a>;</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> </div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"><a class="line" href="group__high-level-api.html#a3388584bc6c20946f824e35602b51c4e"> 50</a></span> std::string <a class="code hl_variable" href="group__high-level-api.html#a3388584bc6c20946f824e35602b51c4e">clientname</a> = <span class="stringliteral">&quot;Boost.Redis&quot;</span>;</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> </div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"><a class="line" href="group__high-level-api.html#a72f73dba57cbafb47d62f7f510b19984"> 53</a></span> std::optional&lt;int&gt; <a class="code hl_variable" href="group__high-level-api.html#a72f73dba57cbafb47d62f7f510b19984">database_index</a> = 0;</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> </div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"><a class="line" href="group__high-level-api.html#a33a1f6383c79785e57b63ef1ff79beed"> 56</a></span> std::string <a class="code hl_variable" href="group__high-level-api.html#a33a1f6383c79785e57b63ef1ff79beed">health_check_id</a> = <span class="stringliteral">&quot;Boost.Redis&quot;</span>;</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> </div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"><a class="line" href="group__high-level-api.html#aedb28694c3cfe1818d2c52c773a9fc18"> 59</a></span> std::string <a class="code hl_variable" href="group__high-level-api.html#aedb28694c3cfe1818d2c52c773a9fc18">log_prefix</a> = <span class="stringliteral">&quot;(Boost.Redis) &quot;</span>;</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> </div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"><a class="line" href="group__high-level-api.html#addc55c3bdcb28228afac96a922165d40"> 62</a></span> std::chrono::steady_clock::duration <a class="code hl_variable" href="group__high-level-api.html#addc55c3bdcb28228afac96a922165d40">resolve_timeout</a> = std::chrono::seconds{10};</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> </div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"><a class="line" href="group__high-level-api.html#ac01a8bcfc1acd353acc62b69f0648442"> 65</a></span> std::chrono::steady_clock::duration <a class="code hl_variable" href="group__high-level-api.html#ac01a8bcfc1acd353acc62b69f0648442">connect_timeout</a> = std::chrono::seconds{10};</div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> </div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"><a class="line" href="group__high-level-api.html#a7ece06408c132bead5d515b4ab05adf6"> 68</a></span> std::chrono::steady_clock::duration <a class="code hl_variable" href="group__high-level-api.html#a7ece06408c132bead5d515b4ab05adf6">ssl_handshake_timeout</a> = std::chrono::seconds{10};</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> </div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"><a class="line" href="group__high-level-api.html#ab1d92223ef715edaf6494d79a9208dd7"> 74</a></span> std::chrono::steady_clock::duration <a class="code hl_variable" href="group__high-level-api.html#ab1d92223ef715edaf6494d79a9208dd7">health_check_interval</a> = std::chrono::seconds{2};</div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> </div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"><a class="line" href="group__high-level-api.html#a682fc27f1873408d377facc3b5d797ba"> 80</a></span> std::chrono::steady_clock::duration <a class="code hl_variable" href="group__high-level-api.html#a682fc27f1873408d377facc3b5d797ba">reconnect_wait_interval</a> = std::chrono::seconds{1};</div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span>};</div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> </div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span>} <span class="comment">// boost::redis</span></div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> </div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span><span class="preprocessor">#endif </span><span class="comment">// BOOST_REDIS_CONFIG_HPP</span></div>
<div class="ttc" id="agroup__high-level-api_html_a2304a0db25fae6498289c039b71e011f"><div class="ttname"><a href="group__high-level-api.html#a2304a0db25fae6498289c039b71e011f">boost::redis::config::addr</a></div><div class="ttdeci">address addr</div><div class="ttdoc">Address of the Redis server.</div><div class="ttdef"><b>Definition:</b> <a href="config_8hpp_source.html#l00035">config.hpp:35</a></div></div>
<div class="ttc" id="agroup__high-level-api_html_a3388584bc6c20946f824e35602b51c4e"><div class="ttname"><a href="group__high-level-api.html#a3388584bc6c20946f824e35602b51c4e">boost::redis::config::clientname</a></div><div class="ttdeci">std::string clientname</div><div class="ttdoc">Client name parameter of the HELLO command.</div><div class="ttdef"><b>Definition:</b> <a href="config_8hpp_source.html#l00050">config.hpp:50</a></div></div>
<div class="ttc" id="agroup__high-level-api_html_a33a1f6383c79785e57b63ef1ff79beed"><div class="ttname"><a href="group__high-level-api.html#a33a1f6383c79785e57b63ef1ff79beed">boost::redis::config::health_check_id</a></div><div class="ttdeci">std::string health_check_id</div><div class="ttdoc">Message used by the health-checker in boost::redis::connection::async_run.</div><div class="ttdef"><b>Definition:</b> <a href="config_8hpp_source.html#l00056">config.hpp:56</a></div></div>
<div class="ttc" id="agroup__high-level-api_html_a3cfd0bdcf176016e7a8e867e333d659f"><div class="ttname"><a href="group__high-level-api.html#a3cfd0bdcf176016e7a8e867e333d659f">boost::redis::config::password</a></div><div class="ttdeci">std::string password</div><div class="ttdoc">Password passed to the HELLO command. If left empty HELLO will be sent without authentication paramet...</div><div class="ttdef"><b>Definition:</b> <a href="config_8hpp_source.html#l00047">config.hpp:47</a></div></div>
<div class="ttc" id="agroup__high-level-api_html_a629bba53218baa30ce807ce8808b9a36"><div class="ttname"><a href="group__high-level-api.html#a629bba53218baa30ce807ce8808b9a36">boost::redis::address::port</a></div><div class="ttdeci">std::string port</div><div class="ttdoc">Redis port.</div><div class="ttdef"><b>Definition:</b> <a href="config_8hpp_source.html#l00024">config.hpp:24</a></div></div>
<div class="ttc" id="agroup__high-level-api_html_a682fc27f1873408d377facc3b5d797ba"><div class="ttname"><a href="group__high-level-api.html#a682fc27f1873408d377facc3b5d797ba">boost::redis::config::reconnect_wait_interval</a></div><div class="ttdeci">std::chrono::steady_clock::duration reconnect_wait_interval</div><div class="ttdoc">Time waited before trying a reconnection.</div><div class="ttdef"><b>Definition:</b> <a href="config_8hpp_source.html#l00080">config.hpp:80</a></div></div>
<div class="ttc" id="agroup__high-level-api_html_a72f73dba57cbafb47d62f7f510b19984"><div class="ttname"><a href="group__high-level-api.html#a72f73dba57cbafb47d62f7f510b19984">boost::redis::config::database_index</a></div><div class="ttdeci">std::optional&lt; int &gt; database_index</div><div class="ttdoc">Database that will be passed to the SELECT command.</div><div class="ttdef"><b>Definition:</b> <a href="config_8hpp_source.html#l00053">config.hpp:53</a></div></div>
<div class="ttc" id="agroup__high-level-api_html_a7ece06408c132bead5d515b4ab05adf6"><div class="ttname"><a href="group__high-level-api.html#a7ece06408c132bead5d515b4ab05adf6">boost::redis::config::ssl_handshake_timeout</a></div><div class="ttdeci">std::chrono::steady_clock::duration ssl_handshake_timeout</div><div class="ttdoc">Time the SSL handshake operation is allowed to last.</div><div class="ttdef"><b>Definition:</b> <a href="config_8hpp_source.html#l00068">config.hpp:68</a></div></div>
<div class="ttc" id="agroup__high-level-api_html_ab1d92223ef715edaf6494d79a9208dd7"><div class="ttname"><a href="group__high-level-api.html#ab1d92223ef715edaf6494d79a9208dd7">boost::redis::config::health_check_interval</a></div><div class="ttdeci">std::chrono::steady_clock::duration health_check_interval</div><div class="ttdef"><b>Definition:</b> <a href="config_8hpp_source.html#l00074">config.hpp:74</a></div></div>
<div class="ttc" id="agroup__high-level-api_html_abcea19f2e03ef615aa6a955749e4d7dd"><div class="ttname"><a href="group__high-level-api.html#abcea19f2e03ef615aa6a955749e4d7dd">boost::redis::config::use_ssl</a></div><div class="ttdeci">bool use_ssl</div><div class="ttdoc">Uses SSL instead of a plain connection.</div><div class="ttdef"><b>Definition:</b> <a href="config_8hpp_source.html#l00032">config.hpp:32</a></div></div>
<div class="ttc" id="agroup__high-level-api_html_ac01a8bcfc1acd353acc62b69f0648442"><div class="ttname"><a href="group__high-level-api.html#ac01a8bcfc1acd353acc62b69f0648442">boost::redis::config::connect_timeout</a></div><div class="ttdeci">std::chrono::steady_clock::duration connect_timeout</div><div class="ttdoc">Time the connect operation is allowed to last.</div><div class="ttdef"><b>Definition:</b> <a href="config_8hpp_source.html#l00065">config.hpp:65</a></div></div>
<div class="ttc" id="agroup__high-level-api_html_addc55c3bdcb28228afac96a922165d40"><div class="ttname"><a href="group__high-level-api.html#addc55c3bdcb28228afac96a922165d40">boost::redis::config::resolve_timeout</a></div><div class="ttdeci">std::chrono::steady_clock::duration resolve_timeout</div><div class="ttdoc">Time the resolve operation is allowed to last.</div><div class="ttdef"><b>Definition:</b> <a href="config_8hpp_source.html#l00062">config.hpp:62</a></div></div>
<div class="ttc" id="agroup__high-level-api_html_aedb28694c3cfe1818d2c52c773a9fc18"><div class="ttname"><a href="group__high-level-api.html#aedb28694c3cfe1818d2c52c773a9fc18">boost::redis::config::log_prefix</a></div><div class="ttdeci">std::string log_prefix</div><div class="ttdoc">Logger prefix, see boost::redis::logger.</div><div class="ttdef"><b>Definition:</b> <a href="config_8hpp_source.html#l00059">config.hpp:59</a></div></div>
<div class="ttc" id="agroup__high-level-api_html_af907445bc3426511a6d6e8a1d56edac8"><div class="ttname"><a href="group__high-level-api.html#af907445bc3426511a6d6e8a1d56edac8">boost::redis::config::username</a></div><div class="ttdeci">std::string username</div><div class="ttdoc">Username passed to the HELLO command. If left empty HELLO will be sent without authentication paramet...</div><div class="ttdef"><b>Definition:</b> <a href="config_8hpp_source.html#l00041">config.hpp:41</a></div></div>
<div class="ttc" id="agroup__high-level-api_html_afb00b91dd1004117161e998d04d68bae"><div class="ttname"><a href="group__high-level-api.html#afb00b91dd1004117161e998d04d68bae">boost::redis::address::host</a></div><div class="ttdeci">std::string host</div><div class="ttdoc">Redis host.</div><div class="ttdef"><b>Definition:</b> <a href="config_8hpp_source.html#l00022">config.hpp:22</a></div></div>
<div class="ttc" id="agroup__high-level-api_html_structboost_1_1redis_1_1address"><div class="ttname"><a href="group__high-level-api.html#structboost_1_1redis_1_1address">boost::redis::address</a></div><div class="ttdoc">Address of a Redis server.</div><div class="ttdef"><b>Definition:</b> <a href="config_8hpp_source.html#l00020">config.hpp:20</a></div></div>
<div class="ttc" id="agroup__high-level-api_html_structboost_1_1redis_1_1config"><div class="ttname"><a href="group__high-level-api.html#structboost_1_1redis_1_1config">boost::redis::config</a></div><div class="ttdoc">Configure parameters used by the connection classes.</div><div class="ttdef"><b>Definition:</b> <a href="config_8hpp_source.html#l00030">config.hpp:30</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_1878a3f4746a95c6aad317458cc7ef80.html">boost</a></li><li class="navelem"><a class="el" href="dir_2cc765c1b27cc1fc357a11cf7463bf5b.html">redis</a></li><li class="navelem"><b>config.hpp</b></li>
<li class="footer">Generated on Fri Aug 18 2023 23:21:52 for boost_redis by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4 </li>
</ul>
</div>
</body>
</html>