caleb-brown/redict
1
0
Fork 0
mirror of https://codeberg.org/redict/redict.git synced 2025-01-23 08:38:27 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update some comments in stream command docs (#10821)

Browse Source 
some small documentation fixes.
This commit is contained in:
Wen Hui 2022-06-09 03:16:56 -04:00 committed by GitHub
parent 9e40b076dd
commit 6e1c3ff132
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
src/t_stream.c
View File

@ -2144,7 +2144,7 @@ void xrevrangeCommand(client *c) {
xrangeGenericCommand(c,1); xrangeGenericCommand(c,1);
} }
/* XLEN */ /* XLEN key*/
void xlenCommand(client *c) { void xlenCommand(client *c) {
robj *o; robj *o;
if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.czero)) == NULL if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.czero)) == NULL
@ -2156,10 +2156,10 @@ void xlenCommand(client *c) {
/* XREAD [BLOCK <milliseconds>] [COUNT <count>] STREAMS key_1 key_2 ... key_N /* XREAD [BLOCK <milliseconds>] [COUNT <count>] STREAMS key_1 key_2 ... key_N
* ID_1 ID_2 ... ID_N * ID_1 ID_2 ... ID_N
* *
* This function also implements the XREAD-GROUP command, which is like XREAD * This function also implements the XREADGROUP command, which is like XREAD
* but accepting the [GROUP group-name consumer-name] additional option. * but accepting the [GROUP group-name consumer-name] additional option.
* This is useful because while XREAD is a read command and can be called * This is useful because while XREAD is a read command and can be called
* on slaves, XREAD-GROUP is not. */ * on slaves, XREADGROUP is not. */
#define XREAD_BLOCKED_DEFAULT_COUNT 1000 #define XREAD_BLOCKED_DEFAULT_COUNT 1000
void xreadCommand(client *c) { void xreadCommand(client *c) {
long long timeout = -1; /* -1 means, no BLOCK argument given. */ long long timeout = -1; /* -1 means, no BLOCK argument given. */
@ -2566,8 +2566,8 @@ void streamDelConsumer(streamCG *cg, streamConsumer *consumer) {
* Consumer groups commands * Consumer groups commands
* ----------------------------------------------------------------------- */ * ----------------------------------------------------------------------- */
/* XGROUP CREATE <key> <groupname> <id or $> [MKSTREAM] [ENTRIESADDED count] /* XGROUP CREATE <key> <groupname> <id or $> [MKSTREAM] [ENTRIESREAD entries_read]
* XGROUP SETID <key> <groupname> <id or $> [ENTRIESADDED count] * XGROUP SETID <key> <groupname> <id or $> [ENTRIESREAD entries_read]
* XGROUP DESTROY <key> <groupname> * XGROUP DESTROY <key> <groupname>
* XGROUP CREATECONSUMER <key> <groupname> <consumer> * XGROUP CREATECONSUMER <key> <groupname> <consumer>
* XGROUP DELCONSUMER <key> <groupname> <consumername> */ * XGROUP DELCONSUMER <key> <groupname> <consumername> */
@ -2805,7 +2805,6 @@ void xsetidCommand(client *c) {
} }
/* XACK <key> <group> <id> <id> ... <id> /* XACK <key> <group> <id> <id> ... <id>
*
* Acknowledge a message as processed. In practical terms we just check the * Acknowledge a message as processed. In practical terms we just check the
* pending entries list (PEL) of the group, and delete the PEL entry both from * pending entries list (PEL) of the group, and delete the PEL entry both from
* the group and the consumer (pending messages are referenced in both places). * the group and the consumer (pending messages are referenced in both places).
@ -3050,7 +3049,7 @@ void xpendingCommand(client *c) {
* [IDLE <milliseconds>] [TIME <mstime>] [RETRYCOUNT <count>] * [IDLE <milliseconds>] [TIME <mstime>] [RETRYCOUNT <count>]
* [FORCE] [JUSTID] * [FORCE] [JUSTID]
* *
* Gets ownership of one or multiple messages in the Pending Entries List * Changes ownership of one or multiple messages in the Pending Entries List
* of a given stream consumer group. * of a given stream consumer group.
* *
* If the message ID (among the specified ones) exists, and its idle * If the message ID (among the specified ones) exists, and its idle
@ -3316,7 +3315,7 @@ cleanup:
/* XAUTOCLAIM <key> <group> <consumer> <min-idle-time> <start> [COUNT <count>] [JUSTID] /* XAUTOCLAIM <key> <group> <consumer> <min-idle-time> <start> [COUNT <count>] [JUSTID]
* *
* Gets ownership of one or multiple messages in the Pending Entries List * Changes ownership of one or multiple messages in the Pending Entries List
* of a given stream consumer group. * of a given stream consumer group.
* *
* For each PEL entry, if its idle time greater or equal to <min-idle-time>, * For each PEL entry, if its idle time greater or equal to <min-idle-time>,