/man/redisExpire.Rd
http://github.com/bwlewis/rredis · Unknown · 41 lines · 41 code · 0 blank · 0 comment · 0 complexity · 75fc9926f976185a17158833f63cc892 MD5 · raw file
- \name{redisExpire}
- \alias{redisExpire}
- \alias{redisPexpire}
- \title{Set a timeout on the specified key.}
- \description{
- Set a timeout on the specified key, after which the key and
- corresponding value will be deleted.
- }
- \usage{
- redisExpire(key, seconds)
- redisPexpire(key, milliseconds)
- }
- \arguments{
- \item{key}{The character key on which to set the timeout.}
- \item{seconds}{The integer timeout in seconds.}
- \item{milliseconds}{The integer timeout in milliseconds.}
- }
- \details{Operations that modify value(s) corresponding to a key subsequent
- to the \code{redisExpire} function clear the timeout, removing the expiration.
- The \code{redisExpire} function can't set a new timeout value once a timeout
- has been set on a key.
- }
- \value{
- Boolean TRUE if the timeout command was successful, FALSE otherwise.
- }
- \references{
- http://redis.io/commands
- }
- \author{
- B. W. Lewis
- }
- \seealso{
- \code{\link{redisExpireAt}}
- }
- \examples{
- \dontrun{
- redisConnect()
- redisLPush('x',runif(5))
- redisExpire('x', 3)
- }
- }