libmemcached Manual

libmemcached is an open source C/C++ client library and tools for the memcached server (http://memcached.org/). It has been designed to be light on memory usage, thread safe, and provide full access to server side methods.

• Introduction
• libmemcached API
  • Basics
    • Creating and destroying a memcached_st
    • Retrieving data from the server
    • Storing data on the server
    • Deleting data from a server
    • Disconnecting a client from a server
  • Working with Data
    • Incrementing and Decrementing Values
    • Determine if a keys exists
    • Update expiration on a key
    • Flush and send buffered commands
    • Working with result sets
    • Appending or Prepending Data
    • Working with data on the server in an atomic fashion
  • Messages and Errors
    • Error Codes - memcached_return_t
    • Retrieving Error Codes and Messages
    • Converting Error Codes to Messages
  • Advanced Topics
    • Internal Behavior
      • Behaviors of the library
      • Library callbacks
      • Use custom allocators for embedded usage
      • Storing custom information in the client
    • Authentication, Encryption & Hashing
      • Set encryption key
      • Generating hash values directly
      • SASL support
    • Servers and Server Lists
      • Managing lists of servers
      • Managing the servers used by memcached_st
    • Affecting the memcached Daemon
      • Dumping data from a server
      • Wiping clean the contents of a server
      • Setting the verbosity of a server
    • Statistics
      • Analyzing servers
      • Working with statistical information from a server
      • Getting version information
  • Deprecated Functionality
    • memcached_fetch
• libmemcachedutil API
  • Working with memcached pools
• libhashkit API
  • Creating a hashkit structure
  • Set Hash Function
  • Available Hashes
  • Generate hash value
• Client Applications
  • memexist — Check for the existence of a key
  • memcat — "cat" data from a server
  • memcp — "cp" files to a server
  • memtouch — "touch" a key
  • memrm – "rm" a key
  • memaslap - Load testing and benchmarking a server
  • memslap - Load testing and benchmarking a server
  • memping – Ping a server
  • memstat – Gather statistics from a server
  • memerror — Translate libmemcached error codes
  • memparse — Parse and validate an option string
  • memcapable — Check a server's capabilities and compatibility
  • memdump — Dump a server's data
  • memflush — Flush a server (erase all cached data)
• Miscellaneous
  • Configuration
  • Constants
  • Examples
  • Versioning

• Change Logs
• Copyright

Index

Index