From a6fd4e8442eed7fae0ed62396d1267d7be88f7d0 Mon Sep 17 00:00:00 2001 From: github-actions Date: Mon, 16 Sep 2024 18:45:08 +0000 Subject: [PATCH] [automated site update] --- apidoc/html/annotated.html | 2 +- apidoc/html/classes.html | 2 +- .../dir_68267d1309a1af8e8297ef4c3efbcdba.html | 2 +- .../dir_d44c64559bbebec7f509842c48db8b23.html | 2 +- apidoc/html/files.html | 2 +- apidoc/html/functions.html | 2 +- apidoc/html/functions_vars.html | 2 +- apidoc/html/globals.html | 2 +- apidoc/html/globals_defs.html | 2 +- apidoc/html/globals_enum.html | 2 +- apidoc/html/globals_eval.html | 2 +- apidoc/html/globals_func.html | 2 +- apidoc/html/globals_type.html | 2 +- apidoc/html/index.html | 6 ++-- apidoc/html/pages.html | 2 +- apidoc/html/redisx-client_8c.html | 8 ++--- apidoc/html/redisx-hooks_8c.html | 2 +- apidoc/html/redisx-net_8c.html | 4 +-- apidoc/html/redisx-script_8c.html | 4 +-- apidoc/html/redisx-sub_8c.html | 4 +-- apidoc/html/redisx-tab_8c.html | 14 ++++---- apidoc/html/redisx_8c.html | 12 +++---- apidoc/html/redisx_8h.html | 34 +++++++++---------- apidoc/html/structRESP.html | 2 +- apidoc/html/structRedis.html | 2 +- apidoc/html/structRedisClient.html | 2 +- apidoc/html/structRedisEntry.html | 2 +- apidoc/redisx.tag | 2 +- doc/README.md | 2 +- 29 files changed, 64 insertions(+), 64 deletions(-) diff --git a/apidoc/html/annotated.html b/apidoc/html/annotated.html index e8f0516..8f0e077 100644 --- a/apidoc/html/annotated.html +++ b/apidoc/html/annotated.html @@ -6,7 +6,7 @@ - + diff --git a/apidoc/html/classes.html b/apidoc/html/classes.html index 5128698..0eab9e8 100644 --- a/apidoc/html/classes.html +++ b/apidoc/html/classes.html @@ -6,7 +6,7 @@ - + diff --git a/apidoc/html/dir_68267d1309a1af8e8297ef4c3efbcdba.html b/apidoc/html/dir_68267d1309a1af8e8297ef4c3efbcdba.html index 919d61f..39c78d3 100644 --- a/apidoc/html/dir_68267d1309a1af8e8297ef4c3efbcdba.html +++ b/apidoc/html/dir_68267d1309a1af8e8297ef4c3efbcdba.html @@ -6,7 +6,7 @@ - + diff --git a/apidoc/html/dir_d44c64559bbebec7f509842c48db8b23.html b/apidoc/html/dir_d44c64559bbebec7f509842c48db8b23.html index 187e4ad..05b2cdf 100644 --- a/apidoc/html/dir_d44c64559bbebec7f509842c48db8b23.html +++ b/apidoc/html/dir_d44c64559bbebec7f509842c48db8b23.html @@ -6,7 +6,7 @@ - + diff --git a/apidoc/html/files.html b/apidoc/html/files.html index b167808..618aae8 100644 --- a/apidoc/html/files.html +++ b/apidoc/html/files.html @@ -6,7 +6,7 @@ - + diff --git a/apidoc/html/functions.html b/apidoc/html/functions.html index 424359f..ac89cbd 100644 --- a/apidoc/html/functions.html +++ b/apidoc/html/functions.html @@ -6,7 +6,7 @@ - + diff --git a/apidoc/html/functions_vars.html b/apidoc/html/functions_vars.html index 6d9db67..50d5886 100644 --- a/apidoc/html/functions_vars.html +++ b/apidoc/html/functions_vars.html @@ -6,7 +6,7 @@ - + diff --git a/apidoc/html/globals.html b/apidoc/html/globals.html index 9ff705a..5fed043 100644 --- a/apidoc/html/globals.html +++ b/apidoc/html/globals.html @@ -6,7 +6,7 @@ - + diff --git a/apidoc/html/globals_defs.html b/apidoc/html/globals_defs.html index 08201f5..376b35f 100644 --- a/apidoc/html/globals_defs.html +++ b/apidoc/html/globals_defs.html @@ -6,7 +6,7 @@ - + diff --git a/apidoc/html/globals_enum.html b/apidoc/html/globals_enum.html index a0b19f0..5b5c448 100644 --- a/apidoc/html/globals_enum.html +++ b/apidoc/html/globals_enum.html @@ -6,7 +6,7 @@ - + diff --git a/apidoc/html/globals_eval.html b/apidoc/html/globals_eval.html index e3ad309..8cbea2b 100644 --- a/apidoc/html/globals_eval.html +++ b/apidoc/html/globals_eval.html @@ -6,7 +6,7 @@ - + diff --git a/apidoc/html/globals_func.html b/apidoc/html/globals_func.html index b371dd7..49032b5 100644 --- a/apidoc/html/globals_func.html +++ b/apidoc/html/globals_func.html @@ -6,7 +6,7 @@ - + diff --git a/apidoc/html/globals_type.html b/apidoc/html/globals_type.html index d80b509..014a9b4 100644 --- a/apidoc/html/globals_type.html +++ b/apidoc/html/globals_type.html @@ -6,7 +6,7 @@ - + diff --git a/apidoc/html/index.html b/apidoc/html/index.html index 730fbaf..e4c9c89 100644 --- a/apidoc/html/index.html +++ b/apidoc/html/index.html @@ -6,7 +6,7 @@ - + @@ -115,7 +115,7 @@
RedisX
-

A simple, light-weight C/C++ Redis client library.

+

A simple, light-weight C/C++ Redis client library.

Table of Contents

    @@ -136,7 +136,7 @@

    Introduction

    RedisX is a light-weight Redis client library for C/C++. As such, it should also work with Redis forks / clones like Dragonfly or Valkey. It supports both interactive and pipelined Redis queries, managing and processing subscriptions, atomic execution blocks, and LUA scripts loading. It can be used with multiple Redis servers simultaneously also.

    -

    While there are other C/C++ Redis clients available, this one is C90 compatible, and hence can be used on older platforms also. It is also small and fast, but still capable and versatile.

    +

    While there are other C/C++ Redis clients available, this one is C99 compatible, and hence can be used on older platforms also. It is also small and fast, but still capable and versatile.

    Rather than providing high-level support for every possible Redis command (which would probably be impossible given the pace new commands are being introduced all the time), it provides a basic framework for synchronous and asynchronous queries, with some higher-level functions for managing key/value storage types (including hash tables), and PUB/SUB. Future releases may add further higher-level functionality based on demand for such features.

    The RedisX library was created, and is maintained, by Attila Kovács at the Center for Astrophysics | Harvard & Smithsonian, and it is available through the Smithsonian/redisx repository on GitHub.

    There are no official releases of RedisX yet. An initial 1.0.0 release is expected in late 2024 or early 2025. Before then the API may undergo slight changes and tweaks. Use the repository as is at your own risk for now.

    diff --git a/apidoc/html/pages.html b/apidoc/html/pages.html index 5c9b4cb..3b99dc3 100644 --- a/apidoc/html/pages.html +++ b/apidoc/html/pages.html @@ -6,7 +6,7 @@ - + diff --git a/apidoc/html/redisx-client_8c.html b/apidoc/html/redisx-client_8c.html index 07c5917..71078ee 100644 --- a/apidoc/html/redisx-client_8c.html +++ b/apidoc/html/redisx-client_8c.html @@ -6,7 +6,7 @@ - + @@ -222,7 +222,7 @@

    redisxAbortBlockAsync() -

    References redisxDestroyRESP(), redisxReadReplyAsync(), redisxSkipReplyAsync(), RESP_ARRAY, RESP_ERROR, TRUE, RESP::type, x_error(), and x_trace_null().

    +

    References redisxDestroyRESP(), redisxReadReplyAsync(), redisxSkipReplyAsync(), RESP_ARRAY, RESP_ERROR, TRUE, RESP::type, x_error(), and x_trace_null().

@@ -305,7 +305,7 @@

redisxLockConnected() -

References redisxGetClient(), redisxLockConnected(), X_SUCCESS, and x_trace_null().

+

References redisxGetClient(), redisxLockConnected(), X_SUCCESS, and x_trace_null().

@@ -425,7 +425,7 @@

Returns
The RESP structure for the reponse received from Redis, or NULL if an error was encountered (errno will be set to describe the error, which may either be an errno produced by recv() or EBADMSG if the message was corrupted and/or unparseable.
-

References FALSE, RESP::n, REDIS_INCOMPLETE_TRANSFER, REDIS_SIMPLE_STRING_SIZE, REDIS_UNEXPECTED_RESP, redisxDestroyRESP(), redisxReadReplyAsync(), RESP_ARRAY, RESP_BULK_STRING, RESP_ERROR, RESP_INT, RESP_SIMPLE_STRING, RESP::type, RESP::value, x_error(), X_FAILURE, X_PARSE_ERROR, X_SUCCESS, and x_trace_null().

+

References FALSE, RESP::n, REDIS_INCOMPLETE_TRANSFER, REDIS_SIMPLE_STRING_SIZE, REDIS_UNEXPECTED_RESP, redisxDestroyRESP(), redisxReadReplyAsync(), RESP_ARRAY, RESP_BULK_STRING, RESP_ERROR, RESP_INT, RESP_SIMPLE_STRING, RESP::type, RESP::value, x_error(), X_FAILURE, X_PARSE_ERROR, X_SUCCESS, and x_trace_null().

diff --git a/apidoc/html/redisx-hooks_8c.html b/apidoc/html/redisx-hooks_8c.html index c21bd7a..0713b2f 100644 --- a/apidoc/html/redisx-hooks_8c.html +++ b/apidoc/html/redisx-hooks_8c.html @@ -6,7 +6,7 @@ - + diff --git a/apidoc/html/redisx-net_8c.html b/apidoc/html/redisx-net_8c.html index 9c6418a..b473633 100644 --- a/apidoc/html/redisx-net_8c.html +++ b/apidoc/html/redisx-net_8c.html @@ -6,7 +6,7 @@ - + @@ -300,7 +300,7 @@

Returns
X_SUCCESS or X_FAILURE if the IP address is invalid. X_NULL if the IP address is NULL.
-

References FALSE, Redis::id, Redis::interactive, Redis::pipeline, REDISX_CHANNELS, REDISX_INTERACTIVE_CHANNEL, REDISX_PIPELINE_CHANNEL, REDISX_SUBSCRIPTION_CHANNEL, REDISX_TCP_PORT, Redis::subscription, TRUE, x_error(), x_trace_null(), and xStringCopyOf().

+

References FALSE, Redis::id, Redis::interactive, Redis::pipeline, REDISX_CHANNELS, REDISX_INTERACTIVE_CHANNEL, REDISX_PIPELINE_CHANNEL, REDISX_SUBSCRIPTION_CHANNEL, REDISX_TCP_PORT, Redis::subscription, TRUE, x_error(), x_trace_null(), and xStringCopyOf().

diff --git a/apidoc/html/redisx-script_8c.html b/apidoc/html/redisx-script_8c.html index 1efe9b1..ef0db9d 100644 --- a/apidoc/html/redisx-script_8c.html +++ b/apidoc/html/redisx-script_8c.html @@ -6,7 +6,7 @@ - + @@ -230,7 +230,7 @@

redisxLoadScript() -

References Redis::interactive, redisxLockConnected(), redisxReadReplyAsync(), redisxRunScriptAsync(), redisxUnlockClient(), X_SUCCESS, and x_trace_null().

+

References Redis::interactive, redisxLockConnected(), redisxReadReplyAsync(), redisxRunScriptAsync(), redisxUnlockClient(), X_SUCCESS, and x_trace_null().

diff --git a/apidoc/html/redisx-sub_8c.html b/apidoc/html/redisx-sub_8c.html index 77cdacc..e4e3fcc 100644 --- a/apidoc/html/redisx-sub_8c.html +++ b/apidoc/html/redisx-sub_8c.html @@ -6,7 +6,7 @@ - + @@ -188,7 +188,7 @@

redisxSubscribe() -

References x_error(), X_NULL, X_SUCCESS, x_warn(), xStringCopyOf(), and xvprintf.

+

References x_error(), X_NULL, X_SUCCESS, x_warn(), xStringCopyOf(), and xvprintf.

diff --git a/apidoc/html/redisx-tab_8c.html b/apidoc/html/redisx-tab_8c.html index 6b4993c..bc76ffe 100644 --- a/apidoc/html/redisx-tab_8c.html +++ b/apidoc/html/redisx-tab_8c.html @@ -6,7 +6,7 @@ - + @@ -288,7 +288,7 @@

redisxDestroyKeys() -

References RESP::n, redisxCheckDestroyRESP(), redisxDestroyRESP(), redisxRequest(), RESP_ARRAY, RESP::value, x_error(), X_NULL, and x_trace_null().

+

References RESP::n, redisxCheckDestroyRESP(), redisxDestroyRESP(), redisxRequest(), RESP_ARRAY, RESP::value, x_error(), X_NULL, and x_trace_null().

@@ -376,7 +376,7 @@

Returns
A freshly allocated RESP array containing the Redis response, or NULL if no valid response could be obtained.
See also
redisxGetValue()
-

References RESP::n, redisxCheckRESP(), redisxDestroyRESP(), redisxGetValue(), RESP_BULK_STRING, RESP::value, x_error(), X_NULL, X_SUCCESS, and x_trace_null().

+

References RESP::n, redisxCheckRESP(), redisxDestroyRESP(), redisxGetValue(), RESP_BULK_STRING, RESP::value, x_error(), X_NULL, X_SUCCESS, and x_trace_null().

@@ -426,7 +426,7 @@

References RedisEntry::key, RedisEntry::length, RESP::n, redisxCheckDestroyRESP(), redisxDestroyRESP(), redisxRequest(), RESP_ARRAY, RESP::value, RedisEntry::value, x_error(), X_GROUP_INVALID, X_NULL, and x_trace_null().

+

References RedisEntry::key, RedisEntry::length, RESP::n, redisxCheckDestroyRESP(), redisxDestroyRESP(), redisxRequest(), RESP_ARRAY, RESP::value, RedisEntry::value, x_error(), X_GROUP_INVALID, X_NULL, and x_trace_null().

@@ -481,7 +481,7 @@

Returns
A freshly allocated RESP array containing the Redis response, or NULL if no valid response could be obtained.
See also
redisxGetStringValue()
-

References redisxRequest(), x_error(), X_GROUP_INVALID, X_NAME_INVALID, X_NULL, and x_trace_null().

+

References redisxRequest(), x_error(), X_GROUP_INVALID, X_NAME_INVALID, X_NULL, and x_trace_null().

@@ -665,7 +665,7 @@

redisxDestroyKeys() -

References RESP::n, redisxArrayRequest(), redisxCheckRESP(), redisxDestroyRESP(), redisxGetScanCount(), RESP_ARRAY, RESP_BULK_STRING, SCAN_INITIAL_STORE_CAPACITY, RESP::value, x_error(), X_NULL, X_SUCCESS, x_trace(), xdprintf, xStringCopyOf(), and xvprintf.

+

References RESP::n, redisxArrayRequest(), redisxCheckRESP(), redisxDestroyRESP(), redisxGetScanCount(), RESP_ARRAY, RESP_BULK_STRING, SCAN_INITIAL_STORE_CAPACITY, RESP::value, x_error(), X_NULL, X_SUCCESS, x_trace(), xdprintf, xStringCopyOf(), and xvprintf.

@@ -733,7 +733,7 @@

redisxDestroyEntries() -

References RedisEntry::key, RedisEntry::length, RESP::n, redisxArrayRequest(), redisxCheckRESP(), redisxDestroyRESP(), redisxGetScanCount(), RESP_ARRAY, RESP_BULK_STRING, SCAN_INITIAL_STORE_CAPACITY, RESP::value, RedisEntry::value, x_error(), X_GROUP_INVALID, X_NULL, X_SUCCESS, x_trace(), xdprintf, xStringCopyOf(), and xvprintf.

+

References RedisEntry::key, RedisEntry::length, RESP::n, redisxArrayRequest(), redisxCheckRESP(), redisxDestroyRESP(), redisxGetScanCount(), RESP_ARRAY, RESP_BULK_STRING, SCAN_INITIAL_STORE_CAPACITY, RESP::value, RedisEntry::value, x_error(), X_GROUP_INVALID, X_NULL, X_SUCCESS, x_trace(), xdprintf, xStringCopyOf(), and xvprintf.

diff --git a/apidoc/html/redisx_8c.html b/apidoc/html/redisx_8c.html index cc09c8a..a7f5de1 100644 --- a/apidoc/html/redisx_8c.html +++ b/apidoc/html/redisx_8c.html @@ -6,7 +6,7 @@ - + @@ -231,7 +231,7 @@

redisxReadReplyAsync() -

References Redis::interactive, redisxLockConnected(), redisxReadReplyAsync(), redisxSendArrayRequestAsync(), redisxUnlockClient(), x_error(), X_NULL, X_SUCCESS, x_trace_null(), and xvprintf.

+

References Redis::interactive, redisxLockConnected(), redisxReadReplyAsync(), redisxSendArrayRequestAsync(), redisxUnlockClient(), x_error(), X_NULL, X_SUCCESS, x_trace_null(), and xvprintf.

@@ -447,7 +447,7 @@

Returns
A constant string with the error description.
-

References REDIS_ERROR, REDIS_INCOMPLETE_TRANSFER, REDIS_INVALID_CHANNEL, REDIS_NULL, REDIS_UNEXPECTED_ARRAY_SIZE, REDIS_UNEXPECTED_RESP, and xErrorDescription().

+

References REDIS_ERROR, REDIS_INCOMPLETE_TRANSFER, REDIS_INVALID_CHANNEL, REDIS_NULL, REDIS_UNEXPECTED_ARRAY_SIZE, REDIS_UNEXPECTED_RESP, and xErrorDescription().

@@ -647,7 +647,7 @@

redisxReadReplyAsync() -

References redisxArrayRequest(), x_error(), X_NULL, and x_trace_null().

+

References redisxArrayRequest(), x_error(), X_NULL, and x_trace_null().

@@ -729,7 +729,7 @@

Returns
X_SUCCESS (0) if successful, X_NULL if the redis argument is NULL, or X_ALREADY_OPEN if called after Redis was already connected.
See also
redisxSetUser()
-

References redisxIsConnected(), X_ALREADY_OPEN, x_error(), X_NULL, X_SUCCESS, and xStringCopyOf().

+

References redisxIsConnected(), X_ALREADY_OPEN, x_error(), X_NULL, X_SUCCESS, and xStringCopyOf().

@@ -847,7 +847,7 @@

Returns
X_SUCCESS (0) if successful, X_NULL if the redis argument is NULL, or X_ALREADY_OPEN if called after Redis was already connected.
See also
redisxSetPassword()
-

References redisxIsConnected(), X_ALREADY_OPEN, x_error(), X_NULL, X_SUCCESS, and xStringCopyOf().

+

References redisxIsConnected(), X_ALREADY_OPEN, x_error(), X_NULL, X_SUCCESS, and xStringCopyOf().

diff --git a/apidoc/html/redisx_8h.html b/apidoc/html/redisx_8h.html index 37aa5a3..e8ebad1 100644 --- a/apidoc/html/redisx_8h.html +++ b/apidoc/html/redisx_8h.html @@ -6,7 +6,7 @@ - + @@ -659,7 +659,7 @@

redisxSubscribe() -

References x_error(), X_NULL, X_SUCCESS, x_warn(), xStringCopyOf(), and xvprintf.

+

References x_error(), X_NULL, X_SUCCESS, x_warn(), xStringCopyOf(), and xvprintf.

@@ -729,7 +729,7 @@

redisxReadReplyAsync() -

References Redis::interactive, redisxLockConnected(), redisxReadReplyAsync(), redisxSendArrayRequestAsync(), redisxUnlockClient(), x_error(), X_NULL, X_SUCCESS, x_trace_null(), and xvprintf.

+

References Redis::interactive, redisxLockConnected(), redisxReadReplyAsync(), redisxSendArrayRequestAsync(), redisxUnlockClient(), x_error(), X_NULL, X_SUCCESS, x_trace_null(), and xvprintf.

@@ -1240,7 +1240,7 @@

Returns
A constant string with the error description.
-

References REDIS_ERROR, REDIS_INCOMPLETE_TRANSFER, REDIS_INVALID_CHANNEL, REDIS_NULL, REDIS_UNEXPECTED_ARRAY_SIZE, REDIS_UNEXPECTED_RESP, and xErrorDescription().

+

References REDIS_ERROR, REDIS_INCOMPLETE_TRANSFER, REDIS_INVALID_CHANNEL, REDIS_NULL, REDIS_UNEXPECTED_ARRAY_SIZE, REDIS_UNEXPECTED_RESP, and xErrorDescription().

@@ -1271,7 +1271,7 @@

redisxAbortBlockAsync() -

References redisxDestroyRESP(), redisxReadReplyAsync(), redisxSkipReplyAsync(), RESP_ARRAY, RESP_ERROR, TRUE, RESP::type, x_error(), and x_trace_null().

+

References redisxDestroyRESP(), redisxReadReplyAsync(), redisxSkipReplyAsync(), RESP_ARRAY, RESP_ERROR, TRUE, RESP::type, x_error(), and x_trace_null().

@@ -1360,7 +1360,7 @@

redisxDestroyKeys() -

References RESP::n, redisxCheckDestroyRESP(), redisxDestroyRESP(), redisxRequest(), RESP_ARRAY, RESP::value, x_error(), X_NULL, and x_trace_null().

+

References RESP::n, redisxCheckDestroyRESP(), redisxDestroyRESP(), redisxRequest(), RESP_ARRAY, RESP::value, x_error(), X_NULL, and x_trace_null().

@@ -1404,7 +1404,7 @@

redisxLockConnected() -

References redisxGetClient(), redisxLockConnected(), X_SUCCESS, and x_trace_null().

+

References redisxGetClient(), redisxLockConnected(), X_SUCCESS, and x_trace_null().

@@ -1492,7 +1492,7 @@

Returns
A freshly allocated RESP array containing the Redis response, or NULL if no valid response could be obtained.
See also
redisxGetValue()
-

References RESP::n, redisxCheckRESP(), redisxDestroyRESP(), redisxGetValue(), RESP_BULK_STRING, RESP::value, x_error(), X_NULL, X_SUCCESS, and x_trace_null().

+

References RESP::n, redisxCheckRESP(), redisxDestroyRESP(), redisxGetValue(), RESP_BULK_STRING, RESP::value, x_error(), X_NULL, X_SUCCESS, and x_trace_null().

@@ -1542,7 +1542,7 @@

References RedisEntry::key, RedisEntry::length, RESP::n, redisxCheckDestroyRESP(), redisxDestroyRESP(), redisxRequest(), RESP_ARRAY, RESP::value, RedisEntry::value, x_error(), X_GROUP_INVALID, X_NULL, and x_trace_null().

+

References RedisEntry::key, RedisEntry::length, RESP::n, redisxCheckDestroyRESP(), redisxDestroyRESP(), redisxRequest(), RESP_ARRAY, RESP::value, RedisEntry::value, x_error(), X_GROUP_INVALID, X_NULL, and x_trace_null().

@@ -1636,7 +1636,7 @@

Returns
A freshly allocated RESP array containing the Redis response, or NULL if no valid response could be obtained.
See also
redisxGetStringValue()
-

References redisxRequest(), x_error(), X_GROUP_INVALID, X_NAME_INVALID, X_NULL, and x_trace_null().

+

References redisxRequest(), x_error(), X_GROUP_INVALID, X_NAME_INVALID, X_NULL, and x_trace_null().

@@ -1720,7 +1720,7 @@

Returns
X_SUCCESS or X_FAILURE if the IP address is invalid. X_NULL if the IP address is NULL.
-

References FALSE, Redis::id, Redis::interactive, Redis::pipeline, REDISX_CHANNELS, REDISX_INTERACTIVE_CHANNEL, REDISX_PIPELINE_CHANNEL, REDISX_SUBSCRIPTION_CHANNEL, REDISX_TCP_PORT, Redis::subscription, TRUE, x_error(), x_trace_null(), and xStringCopyOf().

+

References FALSE, Redis::id, Redis::interactive, Redis::pipeline, REDISX_CHANNELS, REDISX_INTERACTIVE_CHANNEL, REDISX_PIPELINE_CHANNEL, REDISX_SUBSCRIPTION_CHANNEL, REDISX_TCP_PORT, Redis::subscription, TRUE, x_error(), x_trace_null(), and xStringCopyOf().

@@ -2234,7 +2234,7 @@

Returns
The RESP structure for the reponse received from Redis, or NULL if an error was encountered (errno will be set to describe the error, which may either be an errno produced by recv() or EBADMSG if the message was corrupted and/or unparseable.
-

References FALSE, RESP::n, REDIS_INCOMPLETE_TRANSFER, REDIS_SIMPLE_STRING_SIZE, REDIS_UNEXPECTED_RESP, redisxDestroyRESP(), redisxReadReplyAsync(), RESP_ARRAY, RESP_BULK_STRING, RESP_ERROR, RESP_INT, RESP_SIMPLE_STRING, RESP::type, RESP::value, x_error(), X_FAILURE, X_PARSE_ERROR, X_SUCCESS, and x_trace_null().

+

References FALSE, RESP::n, REDIS_INCOMPLETE_TRANSFER, REDIS_SIMPLE_STRING_SIZE, REDIS_UNEXPECTED_RESP, redisxDestroyRESP(), redisxReadReplyAsync(), RESP_ARRAY, RESP_BULK_STRING, RESP_ERROR, RESP_INT, RESP_SIMPLE_STRING, RESP::type, RESP::value, x_error(), X_FAILURE, X_PARSE_ERROR, X_SUCCESS, and x_trace_null().

@@ -2469,7 +2469,7 @@

redisxReadReplyAsync() -

References redisxArrayRequest(), x_error(), X_NULL, and x_trace_null().

+

References redisxArrayRequest(), x_error(), X_NULL, and x_trace_null().

@@ -2530,7 +2530,7 @@

redisxDestroyKeys() -

References RESP::n, redisxArrayRequest(), redisxCheckRESP(), redisxDestroyRESP(), redisxGetScanCount(), RESP_ARRAY, RESP_BULK_STRING, SCAN_INITIAL_STORE_CAPACITY, RESP::value, x_error(), X_NULL, X_SUCCESS, x_trace(), xdprintf, xStringCopyOf(), and xvprintf.

+

References RESP::n, redisxArrayRequest(), redisxCheckRESP(), redisxDestroyRESP(), redisxGetScanCount(), RESP_ARRAY, RESP_BULK_STRING, SCAN_INITIAL_STORE_CAPACITY, RESP::value, x_error(), X_NULL, X_SUCCESS, x_trace(), xdprintf, xStringCopyOf(), and xvprintf.

@@ -2598,7 +2598,7 @@

redisxDestroyEntries() -

References RedisEntry::key, RedisEntry::length, RESP::n, redisxArrayRequest(), redisxCheckRESP(), redisxDestroyRESP(), redisxGetScanCount(), RESP_ARRAY, RESP_BULK_STRING, SCAN_INITIAL_STORE_CAPACITY, RESP::value, RedisEntry::value, x_error(), X_GROUP_INVALID, X_NULL, X_SUCCESS, x_trace(), xdprintf, xStringCopyOf(), and xvprintf.

+

References RedisEntry::key, RedisEntry::length, RESP::n, redisxArrayRequest(), redisxCheckRESP(), redisxDestroyRESP(), redisxGetScanCount(), RESP_ARRAY, RESP_BULK_STRING, SCAN_INITIAL_STORE_CAPACITY, RESP::value, RedisEntry::value, x_error(), X_GROUP_INVALID, X_NULL, X_SUCCESS, x_trace(), xdprintf, xStringCopyOf(), and xvprintf.

@@ -2793,7 +2793,7 @@

Returns
X_SUCCESS (0) if successful, X_NULL if the redis argument is NULL, or X_ALREADY_OPEN if called after Redis was already connected.
See also
redisxSetUser()
-

References redisxIsConnected(), X_ALREADY_OPEN, x_error(), X_NULL, X_SUCCESS, and xStringCopyOf().

+

References redisxIsConnected(), X_ALREADY_OPEN, x_error(), X_NULL, X_SUCCESS, and xStringCopyOf().

@@ -3020,7 +3020,7 @@

Returns
X_SUCCESS (0) if successful, X_NULL if the redis argument is NULL, or X_ALREADY_OPEN if called after Redis was already connected.
See also
redisxSetPassword()
-

References redisxIsConnected(), X_ALREADY_OPEN, x_error(), X_NULL, X_SUCCESS, and xStringCopyOf().

+

References redisxIsConnected(), X_ALREADY_OPEN, x_error(), X_NULL, X_SUCCESS, and xStringCopyOf().

diff --git a/apidoc/html/structRESP.html b/apidoc/html/structRESP.html index cb8b689..017a23b 100644 --- a/apidoc/html/structRESP.html +++ b/apidoc/html/structRESP.html @@ -6,7 +6,7 @@ - + diff --git a/apidoc/html/structRedis.html b/apidoc/html/structRedis.html index 00b0783..ae797f2 100644 --- a/apidoc/html/structRedis.html +++ b/apidoc/html/structRedis.html @@ -6,7 +6,7 @@ - + diff --git a/apidoc/html/structRedisClient.html b/apidoc/html/structRedisClient.html index d07d89a..6c9bfeb 100644 --- a/apidoc/html/structRedisClient.html +++ b/apidoc/html/structRedisClient.html @@ -6,7 +6,7 @@ - + diff --git a/apidoc/html/structRedisEntry.html b/apidoc/html/structRedisEntry.html index a0e1832..3707aea 100644 --- a/apidoc/html/structRedisEntry.html +++ b/apidoc/html/structRedisEntry.html @@ -6,7 +6,7 @@ - + diff --git a/apidoc/redisx.tag b/apidoc/redisx.tag index 4192e54..50b7601 100644 --- a/apidoc/redisx.tag +++ b/apidoc/redisx.tag @@ -1349,7 +1349,7 @@ index RedisX index.html - md_README-orig + md_README-redisx introduction prerequisites building-redisx diff --git a/doc/README.md b/doc/README.md index 9f26a51..1bf0a96 100644 --- a/doc/README.md +++ b/doc/README.md @@ -26,7 +26,7 @@ Redis forks / clones like [Dragonfly](https://dragonfly.io) or [Valkey](https:// interactive and pipelined Redis queries, managing and processing subscriptions, atomic execution blocks, and LUA scripts loading. It can be used with multiple Redis servers simultaneously also. -While there are other C/C++ Redis clients available, this one is C90 compatible, and hence can be used on older +While there are other C/C++ Redis clients available, this one is C99 compatible, and hence can be used on older platforms also. It is also small and fast, but still capable and versatile. Rather than providing high-level support for every possible Redis command (which would probably be impossible given