# Memcached

# Introduction

» memcached is a high-performance, distributed memory object caching system, generic in nature, but intended for use in speeding up dynamic web applications by alleviating database load.

This extension uses the libmemcached library to provide an API for communicating with memcached servers. It also provides a session handler (`memcached`).

Information about libmemcached can be found at » http://libmemcached.org/libMemcached.html.

- Installing/Configuring
  - Requirements
  - Installation
  - Runtime Configuration
- Predefined Constants
- Expiration Times
- Callbacks
  - Result callbacks
  - Read-through cache callbacks
- Sessions support
- Memcached — The Memcached class
  - Memcached::add — Add an item under a new key
  - Memcached::addByKey — Add an item under a new key on a specific server
  - Memcached::addServer — Add a server to the server pool
  - Memcached::addServers — Add multiple servers to the server pool
  - Memcached::append — Append data to an existing item
  - Memcached::appendByKey — Append data to an existing item on a specific server
  - Memcached::cas — Compare and swap an item
  - Memcached::casByKey — Compare and swap an item on a specific server
  - Memcached::__construct — Create a Memcached instance
  - Memcached::decrement — Decrement numeric item's value
  - Memcached::decrementByKey — Decrement numeric item's value, stored on a specific server
  - Memcached::delete — Delete an item
  - Memcached::deleteByKey — Delete an item from a specific server
  - Memcached::deleteMulti — Delete multiple items
  - Memcached::deleteMultiByKey — Delete multiple items from a specific server
  - Memcached::fetch — Fetch the next result
  - Memcached::fetchAll — Fetch all the remaining results
  - Memcached::flush — Invalidate all items in the cache
  - Memcached::get — Retrieve an item
  - Memcached::getAllKeys — Gets the keys stored on all the servers
  - Memcached::getByKey — Retrieve an item from a specific server
  - Memcached::getDelayed — Request multiple items
  - Memcached::getDelayedByKey — Request multiple items from a specific server
  - Memcached::getMulti — Retrieve multiple items
  - Memcached::getMultiByKey — Retrieve multiple items from a specific server
  - Memcached::getOption — Retrieve a Memcached option value
  - Memcached::getResultCode — Return the result code of the last operation
  - Memcached::getResultMessage — Return the message describing the result of the last operation
  - Memcached::getServerByKey — Map a key to a server
  - Memcached::getServerList — Get the list of the servers in the pool
  - Memcached::getStats — Get server pool statistics
  - Memcached::getVersion — Get server pool version info
  - Memcached::increment — Increment numeric item's value
  - Memcached::incrementByKey — Increment numeric item's value, stored on a specific server
  - Memcached::isPersistent — Check if a persitent connection to memcache is being used
  - Memcached::isPristine — Check if the instance was recently created
  - Memcached::prepend — Prepend data to an existing item
  - Memcached::prependByKey — Prepend data to an existing item on a specific server
  - Memcached::quit — Close any open connections
  - Memcached::replace — Replace the item under an existing key
  - Memcached::replaceByKey — Replace the item under an existing key on a specific server
  - Memcached::resetServerList — Clears all servers from the server list
  - Memcached::set — Store an item
  - Memcached::setByKey — Store an item on a specific server
  - Memcached::setEncodingKey — Set AES encryption key for data in Memcached
  - Memcached::setMulti — Store multiple items
  - Memcached::setMultiByKey — Store multiple items on a specific server
  - Memcached::setOption — Set a Memcached option
  - Memcached::setOptions — Set Memcached options
  - Memcached::setSaslAuthData — Set the credentials to use for authentication
  - Memcached::touch — Set a new expiration on an item
  - Memcached::touchByKey — Set a new expiration on an item on a specific server
- MemcachedException — The MemcachedException class

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open