rredis (version 1.7.0)

redisBLPop: Blocking List Pop

Description

Pop the first available value from a key or list of keys, blocking until a value is available.

Usage

redisBLPop(keys, timeout = 0, ...)

Arguments

keys

A character key value or vector of key values to monitor.

timeout

A timeout in seconds after which, if no value is available, the function returns NULL. A value of zero indicates block indefinitely.

...

Optional additional arguments. Specify raw=TRUE to skip de-serialization of the data.

Value

redisBLPop returns NULL after the timeout period, or a list containing:

key

The first key encountered with an available value,

value

The corresponding value.

Details

redisBLPop blocks until at least one of the keys exists and contains a non-empty value, or until the specified timeout period is reached, whichever comes first. Keys are scanned in the order that they are specified.

References

http://redis.io/commands

See Also

redisBRpop

Examples

## Not run: 
# redisConnect()
# redisBLpop('x', 5)
# redisLPush('x',runif(5))
# redisBLPop('x')
# ## End(Not run)