[automated site update]

apidoc/html/index.html

@@ -183,10 +183,10 @@ <h3><a class="anchor" id="autotoc_md5"></a>
 <div class="line"> </div>
 <div class="line"><span class="comment">// Free up the resources used by the &#39;redis&#39; instance.</span></div>
 <div class="line"><a class="code hl_function" href="redisx-net_8c.html#ac54dd4c46d8615db4da02702c18f062b">redisxDestroy</a>(redis);</div>
-<div class="ttc" id="aredisx-net_8c_html_a5c78c2189a76a077231016564a0cecd5"><div class="ttname"><a href="redisx-net_8c.html#a5c78c2189a76a077231016564a0cecd5">redisxInit</a></div><div class="ttdeci">Redis * redisxInit(const char *server)</div><div class="ttdef"><b>Definition</b> redisx-net.c:794</div></div>
-<div class="ttc" id="aredisx-net_8c_html_ac54dd4c46d8615db4da02702c18f062b"><div class="ttname"><a href="redisx-net_8c.html#ac54dd4c46d8615db4da02702c18f062b">redisxDestroy</a></div><div class="ttdeci">void redisxDestroy(Redis *redis)</div><div class="ttdef"><b>Definition</b> redisx-net.c:975</div></div>
+<div class="ttc" id="aredisx-net_8c_html_a5c78c2189a76a077231016564a0cecd5"><div class="ttname"><a href="redisx-net_8c.html#a5c78c2189a76a077231016564a0cecd5">redisxInit</a></div><div class="ttdeci">Redis * redisxInit(const char *server)</div><div class="ttdef"><b>Definition</b> redisx-net.c:797</div></div>
+<div class="ttc" id="aredisx-net_8c_html_ac54dd4c46d8615db4da02702c18f062b"><div class="ttname"><a href="redisx-net_8c.html#ac54dd4c46d8615db4da02702c18f062b">redisxDestroy</a></div><div class="ttdeci">void redisxDestroy(Redis *redis)</div><div class="ttdef"><b>Definition</b> redisx-net.c:977</div></div>
 <div class="ttc" id="aredisx-net_8c_html_acae5ab8af4db1c4ab13c4069aa744a44"><div class="ttname"><a href="redisx-net_8c.html#acae5ab8af4db1c4ab13c4069aa744a44">redisxDisconnect</a></div><div class="ttdeci">void redisxDisconnect(Redis *redis)</div><div class="ttdef"><b>Definition</b> redisx-net.c:512</div></div>
-<div class="ttc" id="aredisx-net_8c_html_ad71822356ffd40ed4b1c71d065f48809"><div class="ttname"><a href="redisx-net_8c.html#ad71822356ffd40ed4b1c71d065f48809">redisxConnect</a></div><div class="ttdeci">int redisxConnect(Redis *redis, boolean usePipeline)</div><div class="ttdef"><b>Definition</b> redisx-net.c:1108</div></div>
+<div class="ttc" id="aredisx-net_8c_html_ad71822356ffd40ed4b1c71d065f48809"><div class="ttname"><a href="redisx-net_8c.html#ad71822356ffd40ed4b1c71d065f48809">redisxConnect</a></div><div class="ttdeci">int redisxConnect(Redis *redis, boolean usePipeline)</div><div class="ttdef"><b>Definition</b> redisx-net.c:1110</div></div>
 <div class="ttc" id="aredisx_8c_html_a09092bd97eead5c5fa73fa0d9241018c"><div class="ttname"><a href="redisx_8c.html#a09092bd97eead5c5fa73fa0d9241018c">redisxRequest</a></div><div class="ttdeci">RESP * redisxRequest(Redis *redis, const char *command, const char *arg1, const char *arg2, const char *arg3, int *status)</div><div class="ttdef"><b>Definition</b> redisx.c:586</div></div>
 <div class="ttc" id="aredisx_8h_html"><div class="ttname"><a href="redisx_8h.html">redisx.h</a></div></div>
 <div class="ttc" id="aredisx_8h_html_afa5c90630d37c2f77e5d7985932941a0a36dd81166f9ba91db70b1571b25fec9f"><div class="ttname"><a href="redisx_8h.html#afa5c90630d37c2f77e5d7985932941a0a36dd81166f9ba91db70b1571b25fec9f">RESP_BULK_STRING</a></div><div class="ttdeci">@ RESP_BULK_STRING</div><div class="ttdoc">RESP bulk string type.</div><div class="ttdef"><b>Definition</b> redisx.h:107</div></div>
@@ -208,7 +208,7 @@ <h3><a class="anchor" id="autotoc_md5"></a>
 <h3><a class="anchor" id="autotoc_md6"></a>
 Features overview</h3>
 <h4><a class="anchor" id="autotoc_md7"></a>
-Generic API Features</h4>
+General Features</h4>
 <table class="markdownTable">
 <tr class="markdownTableHead">
 <th class="markdownTableHeadNone">Feature   </th><th class="markdownTableHeadCenter">supported   </th><th class="markdownTableHeadNone">comments    </th></tr>
@@ -350,7 +350,7 @@ <h3><a class="anchor" id="autotoc_md20"></a>
 <div class="line"> </div>
 <div class="line"><span class="comment">// (optional) configure a non-standard port number to use</span></div>
 <div class="line"><a class="code hl_function" href="redisx-net_8c.html#a37f39ede48014a2463e4c72bf6eb5a3e">redisxSetPort</a>(redis, 7089);</div>
-<div class="ttc" id="aredisx-net_8c_html_a37f39ede48014a2463e4c72bf6eb5a3e"><div class="ttname"><a href="redisx-net_8c.html#a37f39ede48014a2463e4c72bf6eb5a3e">redisxSetPort</a></div><div class="ttdeci">int redisxSetPort(Redis *redis, int port)</div><div class="ttdef"><b>Definition</b> redisx-net.c:1050</div></div>
+<div class="ttc" id="aredisx-net_8c_html_a37f39ede48014a2463e4c72bf6eb5a3e"><div class="ttname"><a href="redisx-net_8c.html#a37f39ede48014a2463e4c72bf6eb5a3e">redisxSetPort</a></div><div class="ttdeci">int redisxSetPort(Redis *redis, int port)</div><div class="ttdef"><b>Definition</b> redisx-net.c:1052</div></div>
 </div><!-- fragment --><h4><a class="anchor" id="autotoc_md21"></a>
 Sentinel</h4>
 <p>Alternatively, instead of <code><a class="el" href="redisx-net_8c.html#a5c78c2189a76a077231016564a0cecd5">redisxInit()</a></code> above you may initialize the client for a high-availability configuration using with a set of <a href="https://redis.io/docs/latest/develop/reference/sentinel-clients/">Redis Sentinel</a> servers, using <code><a class="el" href="redisx-net_8c.html#a993ae780daeae021fba1866d752ba9c5">redisxInitSentinel()</a></code>, e.g.:</p>
@@ -367,8 +367,8 @@ <h3><a class="anchor" id="autotoc_md20"></a>
 <div class="line"> </div>
 <div class="line"><span class="comment">// (optional) set a sentinel discovery timeout in ms...</span></div>
 <div class="line"><a class="code hl_function" href="redisx-net_8c.html#a192ba03de94c1e8a1876d7c533b4df9a">redisxSetSentinelTimeout</a>(redis, 30);</div>
-<div class="ttc" id="aredisx-net_8c_html_a192ba03de94c1e8a1876d7c533b4df9a"><div class="ttname"><a href="redisx-net_8c.html#a192ba03de94c1e8a1876d7c533b4df9a">redisxSetSentinelTimeout</a></div><div class="ttdeci">int redisxSetSentinelTimeout(Redis *redis, int millis)</div><div class="ttdef"><b>Definition</b> redisx-net.c:943</div></div>
-<div class="ttc" id="aredisx-net_8c_html_a993ae780daeae021fba1866d752ba9c5"><div class="ttname"><a href="redisx-net_8c.html#a993ae780daeae021fba1866d752ba9c5">redisxInitSentinel</a></div><div class="ttdeci">Redis * redisxInitSentinel(const char *serviceName, const RedisServer *serverList, int nServers)</div><div class="ttdef"><b>Definition</b> redisx-net.c:897</div></div>
+<div class="ttc" id="aredisx-net_8c_html_a192ba03de94c1e8a1876d7c533b4df9a"><div class="ttname"><a href="redisx-net_8c.html#a192ba03de94c1e8a1876d7c533b4df9a">redisxSetSentinelTimeout</a></div><div class="ttdeci">int redisxSetSentinelTimeout(Redis *redis, int millis)</div><div class="ttdef"><b>Definition</b> redisx-net.c:945</div></div>
+<div class="ttc" id="aredisx-net_8c_html_a993ae780daeae021fba1866d752ba9c5"><div class="ttname"><a href="redisx-net_8c.html#a993ae780daeae021fba1866d752ba9c5">redisxInitSentinel</a></div><div class="ttdeci">Redis * redisxInitSentinel(const char *serviceName, const RedisServer *serverList, int nServers)</div><div class="ttdef"><b>Definition</b> redisx-net.c:899</div></div>
 <div class="ttc" id="astructRedisServer_html"><div class="ttname"><a href="structRedisServer.html">RedisServer</a></div><div class="ttdef"><b>Definition</b> redisx.h:208</div></div>
 </div><!-- fragment --><p>After successful initialization, you may proceed with the configuration the same way as for the regular standalone server connection.</p>
 <p>One thing to keep in mind about Sentinel is that once the connection to the master is established, it works just like a regular server connection, including the possibility of that connection being broken. It is up to the application to initiate reconnection and recovery as appropriate in case of errors. (See more in on <a class="el" href="index.html#reconnecting">Reconnecting</a> further below).</p>
@@ -404,8 +404,8 @@ <h4><a class="anchor" id="autotoc_md23"></a>
 <div class="line"> </div>
 <div class="line"><span class="comment">// (optional) Set the TCP send/rcv buffer sizes to use if not default values.</span></div>
 <div class="line"><a class="code hl_function" href="redisx-net_8c.html#a648557774b354ff99e279d3dcf94d240">redisxSetTcpBuf</a>(redis, 65536);</div>
-<div class="ttc" id="aredisx-net_8c_html_a648557774b354ff99e279d3dcf94d240"><div class="ttname"><a href="redisx-net_8c.html#a648557774b354ff99e279d3dcf94d240">redisxSetTcpBuf</a></div><div class="ttdeci">int redisxSetTcpBuf(Redis *redis, int size)</div><div class="ttdef"><b>Definition</b> redisx-net.c:1026</div></div>
-<div class="ttc" id="aredisx-net_8c_html_aaa87635d37e5d348b7dbb12952b39183"><div class="ttname"><a href="redisx-net_8c.html#aaa87635d37e5d348b7dbb12952b39183">redisxSetSocketTimeout</a></div><div class="ttdeci">int redisxSetSocketTimeout(Redis *redis, int millis)</div><div class="ttdef"><b>Definition</b> redisx-net.c:1076</div></div>
+<div class="ttc" id="aredisx-net_8c_html_a648557774b354ff99e279d3dcf94d240"><div class="ttname"><a href="redisx-net_8c.html#a648557774b354ff99e279d3dcf94d240">redisxSetTcpBuf</a></div><div class="ttdeci">int redisxSetTcpBuf(Redis *redis, int size)</div><div class="ttdef"><b>Definition</b> redisx-net.c:1028</div></div>
+<div class="ttc" id="aredisx-net_8c_html_aaa87635d37e5d348b7dbb12952b39183"><div class="ttname"><a href="redisx-net_8c.html#aaa87635d37e5d348b7dbb12952b39183">redisxSetSocketTimeout</a></div><div class="ttdeci">int redisxSetSocketTimeout(Redis *redis, int millis)</div><div class="ttdef"><b>Definition</b> redisx-net.c:1078</div></div>
 </div><!-- fragment --><p>If you want, you can perform further customization of the client sockets via a user-defined callback function, e.g.:</p>
 <div class="fragment"><div class="line"><span class="keywordtype">int</span> my_socket_config(<span class="keywordtype">int</span> sock, <span class="keyword">enum</span> <a class="code hl_enumeration" href="redisx_8h.html#a5349b7340813fbd1e32d04ed650bc3d9">redisx_channel</a> channel) {</div>
 <div class="line">   <span class="comment">// Set up the socket any way you like...</span></div>
@@ -502,13 +502,13 @@ <h3><a class="anchor" id="autotoc_md30"></a>
 <div class="line">...</div>
 </div><!-- fragment --><p>The <code><a class="el" href="redisx_8c.html#a09092bd97eead5c5fa73fa0d9241018c">redisxRequest()</a></code> sends a command with up to three arguments. If the command takes fewer than 3 parameters, then the remaining ones must be set to <code>NULL</code>. This function thus offers a simple interface for running most basic sequential queries. In cases where 3 parameters are not sufficient, you may use <code><a class="el" href="redisx_8c.html#ac6767cea95b4cc90348796c61ebdac75">redisxArrayRequest()</a></code> instead, e.g.:</p>
 <div class="fragment"><div class="line">...</div>
-<div class="line">char *args[] = { <span class="stringliteral">&quot;my_table&quot;</span>, <span class="stringliteral">&quot;my_key&quot;</span> };  <span class="comment">// parameters as an array...</span></div>
+<div class="line">char *args[] = { <span class="stringliteral">&quot;HGET&quot;</span>, <span class="stringliteral">&quot;my_table&quot;</span>, <span class="stringliteral">&quot;my_key&quot;</span> };  <span class="comment">// parameters as an array...</span></div>
 <div class="line"> </div>
-<div class="line"><span class="comment">// Send &quot;HGET my_table my_key&quot; request with an array of 2 parameters...</span></div>
-<div class="line">resp = <a class="code hl_function" href="redisx_8c.html#ac6767cea95b4cc90348796c61ebdac75">redisxArrayRequest</a>(redis, <span class="stringliteral">&quot;HGET&quot;</span>, args, NULL, 2, &amp;status);</div>
+<div class="line"><span class="comment">// Send &quot;HGET my_table my_key&quot; request with an array of 3 components...</span></div>
+<div class="line">resp = <a class="code hl_function" href="redisx_8c.html#ac6767cea95b4cc90348796c61ebdac75">redisxArrayRequest</a>(redis, args, NULL, 3, &amp;status);</div>
 <div class="line">...</div>
 <div class="ttc" id="aredisx_8c_html_ac6767cea95b4cc90348796c61ebdac75"><div class="ttname"><a href="redisx_8c.html#ac6767cea95b4cc90348796c61ebdac75">redisxArrayRequest</a></div><div class="ttdeci">RESP * redisxArrayRequest(Redis *redis, const char **args, const int *lengths, int n, int *status)</div><div class="ttdef"><b>Definition</b> redisx.c:641</div></div>
-</div><!-- fragment --><p>The 4th argument in the list is an optional <code>int[]</code> array defining the individual string lengths of the parameters (if need be, or else readily available). Here, we used <code>NULL</code> instead, which will use <code>strlen()</code> on each supplied string-terminated parameter to determine its length automatically. Specifying the length may be necessary if the individual parameters are not 0-terminated strings.</p>
+</div><!-- fragment --><p>The 3rd argument in the list is an optional <code>int[]</code> array defining the individual string lengths of the parameters (if need be, or else readily available). Here, we used <code>NULL</code> instead, which will use <code>strlen()</code> on each supplied string-terminated parameter to determine its length automatically. Specifying the length may be necessary if the individual parameters are not 0-terminated strings.</p>
 <p>In interactive mode, each request is sent to the <a class="el" href="structRedis.html" title="Structure that represents a Redis database instance, with one or more RedisClient connections.">Redis</a> server, and the response is collected before the call returns with that response (or <code>NULL</code> if there was an error).</p>
 <p><a class="anchor" id="attributes"></a> </p>
 <h3><a class="anchor" id="autotoc_md31"></a>

apidoc/html/navtreedata.js

@@ -30,7 +30,7 @@ var NAVTREE =
       [ "Introduction", "index.html#autotoc_md4", [
         [ "A simple example", "index.html#autotoc_md5", null ],
         [ "Features overview", "index.html#autotoc_md6", [
-          [ "Generic API Features", "index.html#autotoc_md7", null ],
+          [ "General Features", "index.html#autotoc_md7", null ],
           [ "Redis / Valkey Features", "index.html#autotoc_md8", null ]
         ] ],
         [ "Related links", "index.html#autotoc_md9", null ]

apidoc/html/redisx-net_8c.html

@@ -338,7 +338,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a5c78c2189a76a07723101656
 <dl class="section return"><dt>Returns</dt><dd>X_SUCCESS or X_FAILURE if the IP address is invalid. X_NULL if the IP address is NULL.</dd></dl>
 <dl class="section see"><dt>See also</dt><dd><a class="el" href="redisx-net_8c.html#a993ae780daeae021fba1866d752ba9c5">redisxInitSentinel()</a> </dd></dl>
 
-<p class="reference">References <a class="elRef" href="../../xchange/apidoc/html/xchange_8h.html#aa93f0eb578d23995850d61f7d61c55c1">FALSE</a>, <a class="el" href="structRedis.html#af51011d99955d6f036a9f2c291577749">Redis::interactive</a>, <a class="el" href="structRedis.html#a59d367a240bf9c00366465d842402de8">Redis::pipeline</a>, <a class="el" href="redisx_8h.html#aa748f96c61478c3fbef8074021dee901">REDISX_CHANNELS</a>, <a class="el" href="redisx_8h.html#aff9bac60d5293a00d481b5a6701b3882">REDISX_DEFAULT_TIMEOUT_MILLIS</a>, <a class="el" href="redisx_8h.html#a5349b7340813fbd1e32d04ed650bc3d9a65b4f2926885665960480d008ab2a456">REDISX_INTERACTIVE_CHANNEL</a>, <a class="el" href="redisx_8h.html#a5349b7340813fbd1e32d04ed650bc3d9a7a240839c1e943706535b8d69a605f0c">REDISX_PIPELINE_CHANNEL</a>, <a class="el" href="redisx_8h.html#ae63bc3e31da55ad4e1603d9302f41cccad4bea131b09a2add3c5c92c3d0523161">REDISX_RESP2</a>, <a class="el" href="redisx_8h.html#a5349b7340813fbd1e32d04ed650bc3d9afafc30afa687bc5c56c42b0e677f5981">REDISX_SUBSCRIPTION_CHANNEL</a>, <a class="el" href="redisx_8h.html#a98778e47cc76371868212b00e48ac03d">REDISX_TCP_BUF_SIZE</a>, <a class="el" href="structRedis.html#aa4878fb8cef61468ee8e7426a973a75c">Redis::subscription</a>, <a class="elRef" href="../../xchange/apidoc/html/xchange_8h.html#aa8cecfc5c5c054d2875c03e77b7be15d">TRUE</a>, <a class="elRef" href="../../xchange/apidoc/html/xchange_8c.html#ae73aaf705dc4e7d58dfb0fd81f4805c7">x_error()</a>, and <a class="elRef" href="../../xchange/apidoc/html/xchange_8c.html#ac39ae03ca89b115d49a12f633522dc31">x_trace_null()</a>.</p>
+<p class="reference">References <a class="elRef" href="../../xchange/apidoc/html/xchange_8h.html#aa93f0eb578d23995850d61f7d61c55c1">FALSE</a>, <a class="el" href="structRedis.html#af51011d99955d6f036a9f2c291577749">Redis::interactive</a>, <a class="el" href="structRedis.html#a59d367a240bf9c00366465d842402de8">Redis::pipeline</a>, <a class="el" href="redisx_8h.html#aa748f96c61478c3fbef8074021dee901">REDISX_CHANNELS</a>, <a class="el" href="redisx_8h.html#aff9bac60d5293a00d481b5a6701b3882">REDISX_DEFAULT_TIMEOUT_MILLIS</a>, <a class="el" href="redisx_8h.html#a5349b7340813fbd1e32d04ed650bc3d9a65b4f2926885665960480d008ab2a456">REDISX_INTERACTIVE_CHANNEL</a>, <a class="el" href="redisx_8h.html#a5349b7340813fbd1e32d04ed650bc3d9a7a240839c1e943706535b8d69a605f0c">REDISX_PIPELINE_CHANNEL</a>, <a class="el" href="redisx_8h.html#ae63bc3e31da55ad4e1603d9302f41cccad4bea131b09a2add3c5c92c3d0523161">REDISX_RESP2</a>, <a class="el" href="redisx_8h.html#a5349b7340813fbd1e32d04ed650bc3d9afafc30afa687bc5c56c42b0e677f5981">REDISX_SUBSCRIPTION_CHANNEL</a>, <a class="el" href="redisx_8h.html#a98778e47cc76371868212b00e48ac03d">REDISX_TCP_BUF_SIZE</a>, <a class="el" href="structRedis.html#aa4878fb8cef61468ee8e7426a973a75c">Redis::subscription</a>, <a class="elRef" href="../../xchange/apidoc/html/xchange_8h.html#aa8cecfc5c5c054d2875c03e77b7be15d">TRUE</a>, <a class="elRef" href="../../xchange/apidoc/html/xchange_8c.html#ae73aaf705dc4e7d58dfb0fd81f4805c7">x_error()</a>, <a class="elRef" href="../../xchange/apidoc/html/xchange_8h.html#a7b2679c964ea5f2160380ed55654b873">X_SUCCESS</a>, and <a class="elRef" href="../../xchange/apidoc/html/xchange_8c.html#ac39ae03ca89b115d49a12f633522dc31">x_trace_null()</a>.</p>
 
 </div>
 </div>