/man/redisExpireAt.Rd

http://github.com/bwlewis/rredis · Unknown · 40 lines · 40 code · 0 blank · 0 comment · 0 complexity · fbaf41952d621ed895268ca04b4552f2 MD5 · raw file

  1. \name{redisExpireAt}
  2. \alias{redisExpireAt}
  3. \alias{redisPexpireAt}
  4. \title{Set a timeout on the specified key.}
  5. \description{
  6. Set a timeout on the specified key, after which time the key and
  7. corresponding value will be deleted.
  8. }
  9. \usage{
  10. redisExpireAt(key, time)
  11. redisPexpireAt(key, time)
  12. }
  13. \arguments{
  14. \item{key}{The character key on which to set the timeout.}
  15. \item{time}{The UNIX time of expiration in seconds or milliseconds.}
  16. }
  17. \details{Operations that modify value(s) corresponding to a key subsequent
  18. to the \code{redisExpireAt} function clear the timeout, removing the expiration.
  19. The \code{redisExpireAt} function can't set a new timeout value once a timeout
  20. has been set on a key.
  21. }
  22. \value{
  23. Boolean TRUE if the timeout command was successful, FALSE otherwise.
  24. }
  25. \references{
  26. http://redis.io/commands
  27. }
  28. \author{
  29. B. W. Lewis
  30. }
  31. \seealso{
  32. \code{\link{redisExpire}}
  33. }
  34. \examples{
  35. \dontrun{
  36. redisConnect()
  37. redisLPush('x',runif(5))
  38. redisExpireAt('x', 1266209144)
  39. }
  40. }