redisBRPopLPush: Remove the tail from a list, blocking if it does not exist,...

In rredis: "Redis" Key/Value Database Client

Description

Atomically return and remove the last (tail) element of the src list, blocking if the element does not exist, and push the element as the first (head) element of the dst list.

Usage

redisBRPopLPush(src, dest, timeout = 0, ...)

Arguments

src	A key corresponding to the source list.
dest	A key corresponding to the destination list.
timeout	Block for at most timeout seconds. Set to zero to block indefinitely.
...	Optional additional arguments. Specify raw=TRUE to skip de-serialization of the data.

Details

Atomically return and remove the last (tail) element of the src list, blocking until the element exists, and push the element as the first (head) element of the dst list. For example if the source list contains the elements "a","b","c" and the destination list contains the elements "foo","bar" after a redisRPopLPush command the content of the two lists will be "a","b" and "c","foo","bar".

If the key does not exist or the list is already empty the special value NULL is returned. If the srckey and dstkey are the same the operation is equivalent to removing the last element from the list and pusing it as first element of the list, so it's a "list rotation" command.

See the Redis reference below for programming examples and discussion.

Value

The value moved or rotated across lists, or NULL if the source key does not exist or corresponds to an empty list. An error is thrown if either of the keys does not correspond to a value of 'list' type.

Author(s)

B. W. Lewis

References

http://redis.io/commands

See Also

redisRPopLPush

Examples

## Not run: 
redisConnect()
redisLPush('x',1)
redisBRPopLPush('x','x')

## End(Not run)

rredis documentation built on May 2, 2019, 2:02 p.m.