Skip to content

cybozu/php-yrmcds

Repository files navigation

Build Status

memcached / yrmcds extension for PHP

This PHP extension provides an object-oriented interface of libyrmcds, a full-featured memcached / yrmcds client library.

yrmcds is a complete rewrite of memcached that supports replication and the server-side locking. libyrmcds is a companion client library for yrmcds.

Thanks to yrmcds' server-side locking, this extension can provide a stable object locking mechanism when combined with yrmcds.

License

php-yrmcds is licensed under the BSD 2-clause license.

This repository contains LZ4 source code which is licensed under the BSD 2-clause license.

Features

  • Access to all memcached / yrmcds binary protocol commands.
  • Persistent connections.
  • Auto prefix keys.
  • Transparent LZ4 compression for large objects.
  • Asynchronous operations.

As a bonus, a session handler utilizing yrmcds' server-side locking is also available.

Requirements

  • PHP 5.4+ or PHP 7 or PHP 8.
  • Linux or macOS.

Install

Follow the common steps:

$ cd php-yrmcds
$ phpize
$ ./configure --with-php-config=/path/to/your/php-config
$ make
$ sudo make install

Usage

See USAGE.md.