diff options
Diffstat (limited to 'iredis/data/commands/xack.md')
| -rw-r--r-- | iredis/data/commands/xack.md | 34 |
1 files changed, 18 insertions, 16 deletions
diff --git a/iredis/data/commands/xack.md b/iredis/data/commands/xack.md index eb7ab83..aae2db5 100644 --- a/iredis/data/commands/xack.md +++ b/iredis/data/commands/xack.md @@ -1,25 +1,27 @@ -The `XACK` command removes one or multiple messages from the _Pending Entries -List_ (PEL) of a stream consumer group. A message is pending, and as such stored -inside the PEL, when it was delivered to some consumer, normally as a side -effect of calling `XREADGROUP`, or when a consumer took ownership of a message -calling `XCLAIM`. The pending message was delivered to some consumer but the -server is yet not sure it was processed at least once. So new calls to -`XREADGROUP` to grab the messages history for a consumer (for instance using an -ID of 0), will return such message. Similarly the pending message will be listed -by the `XPENDING` command, that inspects the PEL. +The `XACK` command removes one or multiple messages from the +*Pending Entries List* (PEL) of a stream consumer group. A message is pending, +and as such stored inside the PEL, when it was delivered to some consumer, +normally as a side effect of calling `XREADGROUP`, or when a consumer took +ownership of a message calling `XCLAIM`. The pending message was delivered to +some consumer but the server is yet not sure it was processed at least once. +So new calls to `XREADGROUP` to grab the messages history for a consumer +(for instance using an ID of 0), will return such message. +Similarly the pending message will be listed by the `XPENDING` command, +that inspects the PEL. -Once a consumer _successfully_ processes a message, it should call `XACK` so -that such message does not get processed again, and as a side effect, the PEL -entry about this message is also purged, releasing memory from the Redis server. +Once a consumer *successfully* processes a message, it should call `XACK` +so that such message does not get processed again, and as a side effect, +the PEL entry about this message is also purged, releasing memory from the +Redis server. @return @integer-reply, specifically: -The command returns the number of messages successfully acknowledged. Certain -message IDs may no longer be part of the PEL (for example because they have -already been acknowledged), and XACK will not count them as successfully -acknowledged. +The command returns the number of messages successfully acknowledged. +Certain message IDs may no longer be part of the PEL (for example because +they have already been acknowledged), and XACK will not count them as +successfully acknowledged. @examples |