memcache/README.md

   1 Memcache
   2 ========
   3
   4 _Library for memcached protocol_
   5
   6 Author: Kevin Rosenberg <kevin@rosenberg.net>, based on the
   7 `cl-memcached` library by Abhijit 'quasi' Rao and
   8 Chaitanya Gupta .
   9
  10 Date Started: July 1, 2011
  11
  12 Overview
  13 --------
  14
  15 This package is based on the `cl-memcached` library.
  16 It is substantially modified for use with the memstore
  17 package. The primary areas of additional functionality
  18 are:
  19
  20 * Support for flags field with get and set functions.
  21   This is required as memstore stores bit flags denoting
  22   how the data is serialized. That information is required
  23   to deserialize the data.
  24
  25 * Support for additional memcached functionality, such as
  26   the gets command for retrieving CAS identifiers. The CAS
  27   unique ID is used for the added `:cas` storage command.
  28   Other storage commands newly supported are `:append` and
  29   `:prepend`.
  30
  31 * All communication now uses `mc-send-command` function with
  32   transparently supports writing strings with `write-byte`.
  33   This allows `usocket` to be used on other Lisp implementations
  34   besides AllegroCL. Because cl-memcached used `write-string`
  35   with usocket-stream, only AllegroCL was supported.
  36   By sending all data as (unsigned-byte 8), all Lisp implementions
  37   supported by `usocket` are now supported with `memcached`.
  38
  39 * Encapsulated reading and writing to socket stream to avoid
  40   handling \#return characters in high-level code.
  41
  42 * Changes to support the change in statistics fields with membase.
  43   Some fields were no longer present. Also, membase 1.7 has
  44   187 statistics fields versus the 20 fields supported in
  45   `cl-memcached`. New function `mc-get-stat` allows to retrieving
  46   any statistics field by name.
  47
  48 * More robust `print-object` functions to avoid errors if fields
  49   in statistics are not present.
  50
  51 * Removed compatibility functions in `compat.lisp` and using `kmrcl`
  52   package to provide those functions as well as utilitizing other
  53   `kmrcl` functions to simplify code.
  54
  55 * Added functions to support all memcached API commands,
  56   such as `flush_all` and `version`.
  57
  58 * Support for the `moreply` command argument accepted by
  59   many commands.
  60
  61 * Support the `noreply` argument that many API commands accept.
  62
  63 * Write nearly the entire code base for improved
  64   clarity, robustness, and efficiency.