Skip to content

Commit

Permalink
[automated site update]
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions committed Sep 18, 2024
1 parent a6fd4e8 commit 3812d25
Show file tree
Hide file tree
Showing 8 changed files with 64 additions and 22 deletions.
39 changes: 32 additions & 7 deletions apidoc/html/index.html
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion apidoc/html/redisx-client_8c.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -425,7 +425,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#abc855133c2af4f5d929a0529
</dl>
<dl class="section return"><dt>Returns</dt><dd>The <a class="el" href="structRESP.html" title="Structure that represents a Redis response (RESP format).">RESP</a> structure for the reponse received from <a class="el" href="structRedis.html" title="Structure that represents a Redis database instance, with one or more RedisClient connections.">Redis</a>, 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. </dd></dl>

<p class="reference">References <a class="elRef" href="../../xchange/apidoc/html/xchange_8h.html#aa93f0eb578d23995850d61f7d61c55c1">FALSE</a>, <a class="el" href="structRESP.html#a76f11d9a0a47b94f72c2d0e77fb32240">RESP::n</a>, <a class="el" href="redisx_8h.html#a158f2b6af2421e42128d014e50896bb4">REDIS_INCOMPLETE_TRANSFER</a>, <a class="el" href="redisx-client_8c.html#ac5021fd53b8fb32c06455b174e849751">REDIS_SIMPLE_STRING_SIZE</a>, <a class="el" href="redisx_8h.html#a9d530bcfae7689b4275749b47a6d9b51">REDIS_UNEXPECTED_RESP</a>, <a class="el" href="redisx_8c.html#aa4e23a7454f7055711915ec430599011">redisxDestroyRESP()</a>, <a class="el" href="redisx-client_8c.html#abc855133c2af4f5d929a05292aa634d1">redisxReadReplyAsync()</a>, <a class="el" href="redisx_8h.html#ae140df45d32af33e2334fb677213e887">RESP_ARRAY</a>, <a class="el" href="redisx_8h.html#a980fc225ec0392474ff67e319a33f028">RESP_BULK_STRING</a>, <a class="el" href="redisx_8h.html#a37dfdba3cdcf140c38564c1a6856c04a">RESP_ERROR</a>, <a class="el" href="redisx_8h.html#aea77070444458837e0955ae1e89bd9d0">RESP_INT</a>, <a class="el" href="redisx_8h.html#ab2bc8d02a9fa90910d487412704b99f3">RESP_SIMPLE_STRING</a>, <a class="el" href="structRESP.html#aff17911edc8208aa8ddb1c7c52c78389">RESP::type</a>, <a class="el" href="structRESP.html#a0f61d63b009d0880a89c843bd50d8d76">RESP::value</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#a1d4a0c99f979fd0ecf0e9dcb7191a8d7">X_FAILURE</a>, <a class="elRef" href="../../xchange/apidoc/html/xchange_8h.html#a86d83cc351dfae22fe7346559f5a440e">X_PARSE_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#a41806ac77d095ef2029f26a689ba8b20">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="structRESP.html#a76f11d9a0a47b94f72c2d0e77fb32240">RESP::n</a>, <a class="el" href="redisx_8h.html#a158f2b6af2421e42128d014e50896bb4">REDIS_INCOMPLETE_TRANSFER</a>, <a class="el" href="redisx-client_8c.html#ac5021fd53b8fb32c06455b174e849751">REDIS_SIMPLE_STRING_SIZE</a>, <a class="el" href="redisx_8h.html#a9d530bcfae7689b4275749b47a6d9b51">REDIS_UNEXPECTED_RESP</a>, <a class="el" href="redisx_8c.html#aa4e23a7454f7055711915ec430599011">redisxDestroyRESP()</a>, <a class="el" href="redisx-client_8c.html#abc855133c2af4f5d929a05292aa634d1">redisxReadReplyAsync()</a>, <a class="el" href="redisx_8h.html#ae140df45d32af33e2334fb677213e887">RESP_ARRAY</a>, <a class="el" href="redisx_8h.html#a980fc225ec0392474ff67e319a33f028">RESP_BULK_STRING</a>, <a class="el" href="redisx_8h.html#a37dfdba3cdcf140c38564c1a6856c04a">RESP_ERROR</a>, <a class="el" href="redisx_8h.html#aea77070444458837e0955ae1e89bd9d0">RESP_INT</a>, <a class="el" href="redisx_8h.html#ab2bc8d02a9fa90910d487412704b99f3">RESP_SIMPLE_STRING</a>, <a class="el" href="structRESP.html#aff17911edc8208aa8ddb1c7c52c78389">RESP::type</a>, <a class="el" href="structRESP.html#a0f61d63b009d0880a89c843bd50d8d76">RESP::value</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#a1d4a0c99f979fd0ecf0e9dcb7191a8d7">X_FAILURE</a>, <a class="elRef" href="../../xchange/apidoc/html/xchange_8h.html#a86d83cc351dfae22fe7346559f5a440e">X_PARSE_ERROR</a>, <a class="elRef" href="../../xchange/apidoc/html/xchange_8h.html#a7b2679c964ea5f2160380ed55654b873">X_SUCCESS</a>, <a class="elRef" href="../../xchange/apidoc/html/xchange_8c.html#a41806ac77d095ef2029f26a689ba8b20">x_trace_null()</a>, and <a class="elRef" href="../../xchange/apidoc/html/xchange_8h.html#adf424f5965e2c2bdda4da520548a0c67">xStringCopyOf()</a>.</p>

</div>
</div>
Expand Down
2 changes: 1 addition & 1 deletion apidoc/html/redisx_8h.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2234,7 +2234,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#abc855133c2af4f5d929a0529
</dl>
<dl class="section return"><dt>Returns</dt><dd>The <a class="el" href="structRESP.html" title="Structure that represents a Redis response (RESP format).">RESP</a> structure for the reponse received from <a class="el" href="structRedis.html" title="Structure that represents a Redis database instance, with one or more RedisClient connections.">Redis</a>, 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. </dd></dl>

<p class="reference">References <a class="elRef" href="../../xchange/apidoc/html/xchange_8h.html#aa93f0eb578d23995850d61f7d61c55c1">FALSE</a>, <a class="el" href="structRESP.html#a76f11d9a0a47b94f72c2d0e77fb32240">RESP::n</a>, <a class="el" href="redisx_8h.html#a158f2b6af2421e42128d014e50896bb4">REDIS_INCOMPLETE_TRANSFER</a>, <a class="el" href="redisx-client_8c.html#ac5021fd53b8fb32c06455b174e849751">REDIS_SIMPLE_STRING_SIZE</a>, <a class="el" href="redisx_8h.html#a9d530bcfae7689b4275749b47a6d9b51">REDIS_UNEXPECTED_RESP</a>, <a class="el" href="redisx_8c.html#aa4e23a7454f7055711915ec430599011">redisxDestroyRESP()</a>, <a class="el" href="redisx-client_8c.html#abc855133c2af4f5d929a05292aa634d1">redisxReadReplyAsync()</a>, <a class="el" href="redisx_8h.html#ae140df45d32af33e2334fb677213e887">RESP_ARRAY</a>, <a class="el" href="redisx_8h.html#a980fc225ec0392474ff67e319a33f028">RESP_BULK_STRING</a>, <a class="el" href="redisx_8h.html#a37dfdba3cdcf140c38564c1a6856c04a">RESP_ERROR</a>, <a class="el" href="redisx_8h.html#aea77070444458837e0955ae1e89bd9d0">RESP_INT</a>, <a class="el" href="redisx_8h.html#ab2bc8d02a9fa90910d487412704b99f3">RESP_SIMPLE_STRING</a>, <a class="el" href="structRESP.html#aff17911edc8208aa8ddb1c7c52c78389">RESP::type</a>, <a class="el" href="structRESP.html#a0f61d63b009d0880a89c843bd50d8d76">RESP::value</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#a1d4a0c99f979fd0ecf0e9dcb7191a8d7">X_FAILURE</a>, <a class="elRef" href="../../xchange/apidoc/html/xchange_8h.html#a86d83cc351dfae22fe7346559f5a440e">X_PARSE_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#a41806ac77d095ef2029f26a689ba8b20">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="structRESP.html#a76f11d9a0a47b94f72c2d0e77fb32240">RESP::n</a>, <a class="el" href="redisx_8h.html#a158f2b6af2421e42128d014e50896bb4">REDIS_INCOMPLETE_TRANSFER</a>, <a class="el" href="redisx-client_8c.html#ac5021fd53b8fb32c06455b174e849751">REDIS_SIMPLE_STRING_SIZE</a>, <a class="el" href="redisx_8h.html#a9d530bcfae7689b4275749b47a6d9b51">REDIS_UNEXPECTED_RESP</a>, <a class="el" href="redisx_8c.html#aa4e23a7454f7055711915ec430599011">redisxDestroyRESP()</a>, <a class="el" href="redisx-client_8c.html#abc855133c2af4f5d929a05292aa634d1">redisxReadReplyAsync()</a>, <a class="el" href="redisx_8h.html#ae140df45d32af33e2334fb677213e887">RESP_ARRAY</a>, <a class="el" href="redisx_8h.html#a980fc225ec0392474ff67e319a33f028">RESP_BULK_STRING</a>, <a class="el" href="redisx_8h.html#a37dfdba3cdcf140c38564c1a6856c04a">RESP_ERROR</a>, <a class="el" href="redisx_8h.html#aea77070444458837e0955ae1e89bd9d0">RESP_INT</a>, <a class="el" href="redisx_8h.html#ab2bc8d02a9fa90910d487412704b99f3">RESP_SIMPLE_STRING</a>, <a class="el" href="structRESP.html#aff17911edc8208aa8ddb1c7c52c78389">RESP::type</a>, <a class="el" href="structRESP.html#a0f61d63b009d0880a89c843bd50d8d76">RESP::value</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#a1d4a0c99f979fd0ecf0e9dcb7191a8d7">X_FAILURE</a>, <a class="elRef" href="../../xchange/apidoc/html/xchange_8h.html#a86d83cc351dfae22fe7346559f5a440e">X_PARSE_ERROR</a>, <a class="elRef" href="../../xchange/apidoc/html/xchange_8h.html#a7b2679c964ea5f2160380ed55654b873">X_SUCCESS</a>, <a class="elRef" href="../../xchange/apidoc/html/xchange_8c.html#a41806ac77d095ef2029f26a689ba8b20">x_trace_null()</a>, and <a class="elRef" href="../../xchange/apidoc/html/xchange_8h.html#adf424f5965e2c2bdda4da520548a0c67">xStringCopyOf()</a>.</p>

</div>
</div>
Expand Down
7 changes: 2 additions & 5 deletions apidoc/html/structRESP.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -126,11 +126,10 @@
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a76f11d9a0a47b94f72c2d0e77fb32240" id="r_a76f11d9a0a47b94f72c2d0e77fb32240"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structRESP.html#a76f11d9a0a47b94f72c2d0e77fb32240">n</a></td></tr>
<tr class="memdesc:a76f11d9a0a47b94f72c2d0e77fb32240"><td class="mdescLeft">&#160;</td><td class="mdescRight">the value field. <br /></td></tr>
<tr class="separator:a76f11d9a0a47b94f72c2d0e77fb32240"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aff17911edc8208aa8ddb1c7c52c78389" id="r_aff17911edc8208aa8ddb1c7c52c78389"><td class="memItemLeft" align="right" valign="top"><a id="aff17911edc8208aa8ddb1c7c52c78389" name="aff17911edc8208aa8ddb1c7c52c78389"></a>
char&#160;</td><td class="memItemRight" valign="bottom"><b>type</b></td></tr>
<tr class="memdesc:aff17911edc8208aa8ddb1c7c52c78389"><td class="mdescLeft">&#160;</td><td class="mdescRight">RESP_ARRAY, RESP_INT ... <br /></td></tr>
<tr class="memdesc:aff17911edc8208aa8ddb1c7c52c78389"><td class="mdescLeft">&#160;</td><td class="mdescRight">value type RESP_ARRAY, RESP_INT ... <br /></td></tr>
<tr class="separator:aff17911edc8208aa8ddb1c7c52c78389"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0f61d63b009d0880a89c843bd50d8d76" id="r_a0f61d63b009d0880a89c843bd50d8d76"><td class="memItemLeft" align="right" valign="top"><a id="a0f61d63b009d0880a89c843bd50d8d76" name="a0f61d63b009d0880a89c843bd50d8d76"></a>
void *&#160;</td><td class="memItemRight" valign="bottom"><b>value</b></td></tr>
Expand All @@ -152,9 +151,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a76f11d9a0a47b94f72c2d0e7
</tr>
</table>
</div><div class="memdoc">

<p>the value field. </p>
<p>Either the integer value of a RESP_INT response, or the dimension of </p>
<p>Either the integer value of a RESP_INT response, or the dimension of the value field. </p>

</div>
</div>
Expand Down
7 changes: 2 additions & 5 deletions apidoc/man/man3/RESP.3
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,10 @@ RESP \- Structure that represents a \fBRedis\fP response (\fBRESP\fP format)\&.
.ti -1c
.RI "int \fBn\fP"
.br
.RI "the value field\&. "
.ti -1c
.RI "char \fBtype\fP"
.br
.RI "RESP_ARRAY, RESP_INT \&.\&.\&. "
.RI "value type RESP_ARRAY, RESP_INT \&.\&.\&. "
.ti -1c
.RI "void * \fBvalue\fP"
.br
Expand All @@ -40,9 +39,7 @@ Structure that represents a \fBRedis\fP response (\fBRESP\fP format)\&.
.SH "Field Documentation"
.PP
.SS "int n"

.PP
the value field\&. Either the integer value of a RESP_INT response, or the dimension of
Either the integer value of a RESP_INT response, or the dimension of the value field\&.

.SH "Author"
.PP
Expand Down
2 changes: 1 addition & 1 deletion apidoc/man/man3/redisx-client.c.3
View file
Original file line number Diff line number Diff line change
Expand Up @@ -249,7 +249,7 @@ The \fBRESP\fP structure for the reponse received from \fBRedis\fP, or NULL if a
.PP

.PP
References \fBFALSE\fP, \fBRESP::n\fP, \fBREDIS_INCOMPLETE_TRANSFER\fP, \fBREDIS_SIMPLE_STRING_SIZE\fP, \fBREDIS_UNEXPECTED_RESP\fP, \fBredisxDestroyRESP()\fP, \fBredisxReadReplyAsync()\fP, \fBRESP_ARRAY\fP, \fBRESP_BULK_STRING\fP, \fBRESP_ERROR\fP, \fBRESP_INT\fP, \fBRESP_SIMPLE_STRING\fP, \fBRESP::type\fP, \fBRESP::value\fP, \fBx_error()\fP, \fBX_FAILURE\fP, \fBX_PARSE_ERROR\fP, \fBX_SUCCESS\fP, and \fBx_trace_null()\fP\&.
References \fBFALSE\fP, \fBRESP::n\fP, \fBREDIS_INCOMPLETE_TRANSFER\fP, \fBREDIS_SIMPLE_STRING_SIZE\fP, \fBREDIS_UNEXPECTED_RESP\fP, \fBredisxDestroyRESP()\fP, \fBredisxReadReplyAsync()\fP, \fBRESP_ARRAY\fP, \fBRESP_BULK_STRING\fP, \fBRESP_ERROR\fP, \fBRESP_INT\fP, \fBRESP_SIMPLE_STRING\fP, \fBRESP::type\fP, \fBRESP::value\fP, \fBx_error()\fP, \fBX_FAILURE\fP, \fBX_PARSE_ERROR\fP, \fBX_SUCCESS\fP, \fBx_trace_null()\fP, and \fBxStringCopyOf()\fP\&.
.SS "int redisxResetClient (\fBRedisClient\fP * cl)"
Sends a \fCRESET\fP request to the specified \fBRedis\fP client\&. The server will perform a reset as if the client disconnected and reconnected again\&.
.PP
Expand Down
2 changes: 1 addition & 1 deletion apidoc/man/man3/redisx.h.3
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1361,7 +1361,7 @@ The \fBRESP\fP structure for the reponse received from \fBRedis\fP, or NULL if a
.PP

.PP
References \fBFALSE\fP, \fBRESP::n\fP, \fBREDIS_INCOMPLETE_TRANSFER\fP, \fBREDIS_SIMPLE_STRING_SIZE\fP, \fBREDIS_UNEXPECTED_RESP\fP, \fBredisxDestroyRESP()\fP, \fBredisxReadReplyAsync()\fP, \fBRESP_ARRAY\fP, \fBRESP_BULK_STRING\fP, \fBRESP_ERROR\fP, \fBRESP_INT\fP, \fBRESP_SIMPLE_STRING\fP, \fBRESP::type\fP, \fBRESP::value\fP, \fBx_error()\fP, \fBX_FAILURE\fP, \fBX_PARSE_ERROR\fP, \fBX_SUCCESS\fP, and \fBx_trace_null()\fP\&.
References \fBFALSE\fP, \fBRESP::n\fP, \fBREDIS_INCOMPLETE_TRANSFER\fP, \fBREDIS_SIMPLE_STRING_SIZE\fP, \fBREDIS_UNEXPECTED_RESP\fP, \fBredisxDestroyRESP()\fP, \fBredisxReadReplyAsync()\fP, \fBRESP_ARRAY\fP, \fBRESP_BULK_STRING\fP, \fBRESP_ERROR\fP, \fBRESP_INT\fP, \fBRESP_SIMPLE_STRING\fP, \fBRESP::type\fP, \fBRESP::value\fP, \fBx_error()\fP, \fBX_FAILURE\fP, \fBX_PARSE_ERROR\fP, \fBX_SUCCESS\fP, \fBx_trace_null()\fP, and \fBxStringCopyOf()\fP\&.
.SS "int redisxReconnect (\fBRedis\fP * redis, \fBboolean\fP usePipeline)"
Disconnects from \fBRedis\fP, and then connects again\&.\&.\&.
.PP
Expand Down
25 changes: 24 additions & 1 deletion doc/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -278,7 +278,30 @@ with that response (or `NULL` if there was an error).
### RESP data type

All responses coming from the Redis server are represented by a dynamically allocated `RESP` type (defined in
`redisx.h`) structure. Each `RESP` has a type (e.g. `RESP_SIMPLE_STRING`), an integer value `n`, and a `value` pointer
`redisx.h`) structure.

```c
typedef struct RESP {
char type; // RESP type: RESP_ARRAY, RESP_INT ...
int n; // Either the integer value of a RESP_INT response, or the
// dimension of the value field.
void *value; // Pointer to text (char *) content or to an array of components
// (RESP**)...
} RESP;
```

whose contents are:

| RESP `type` | Redis ID | `n` |`value` cast in C |
|-------------------------|----------|-------------------------------|-----------------------|
| `RESP_ARRAY` | '*' | number of `RESP *` pointers | `(RESP **)` |
| `RESP_INT` | ':' | integer return value | |
| `RESP_SIMPLE_STRING` | '+' | string length | `(char *)` |
| `RESP_ERROR` | '-' | string length | `(char *)` |
| `RESP_BULK_STRING` | '$' | string length or -1 if `NULL` | `(char *)` |


Each `RESP` has a type (e.g. `RESP_SIMPLE_STRING`), an integer value `n`, and a `value` pointer
to further data. If the type is `RESP_INT`, then `n` represents the actual return value (and the `value` pointer is
not used). For string type values `n` is the number of characters in the string `value` (not including termination),
while for `RESP_ARRAY` types the `value` is a pointer to an embedded `RESP` array and `n` is the number of elements
Expand Down

0 comments on commit 3812d25

Please sign in to comment.