Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Fast memcached protocol client in pure Erlang

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 src
Octocat-spinner-32 test Fixed test stability and deps URIs January 27, 2014
Octocat-spinner-32 .gitignore
Octocat-spinner-32 CHANGELOG.md Fixed README, Added CHANGELOG February 06, 2014
Octocat-spinner-32 LICENSE
Octocat-spinner-32 Makefile fixed common-test initialization January 28, 2014
Octocat-spinner-32 README.md
Octocat-spinner-32 rebar release 1.1 version of service January 21, 2014
Octocat-spinner-32 rebar.config
README.md

Erlang memcached client library.

This library provides two ways of working with memcached servers. One way is to use a single server, as described in #1. Another way is to use a number of memcached servers in a consistent hashing mode. This is described in #2.

1. RUNNING IN SINGLE-SERVER MODE

1.1 Starting a single memcached

The following will start the anonymous mcd client, addressable by the returned pid().

mcd:start_link(["localhost", 11211]).

The next one will connect to the memcached server on the local host, and will also register the mcd instance under the 'myMcd' name. See #3. The mcd API can use the returned pid() and the registered name interchangeably.

mcd:start_link(myMcd, []).
mcd:set(myMcd, a, b).
mcd:get(myMcd, a).

1.2 A ChildSpec for running the mcd named 'myMcd' under a supervisor

{ local_memcache, { mcd, start_link,
    ['myMcd', ["localhost", 11211] ]
}, permanent, 10000, worker, [mcd] }

2. RUNNING IN CLUSTERED MODE

mcd_cluster starts a set of of memcached instances and dispatcher attached to them. All memcached instances and mcd_cluster are linked to this gen_server, so a proper exit hierarchy is formed.

2.1 Starting memcached cluster from the command line (e.g., for testing)

mcd_cluster:start_link(mainCluster, [
    {host1, ["localhost", 11211], 10},
    {host2, ["localhost", 11211], 20}
]).

2.2 A ChildSpec for running the cluster named 'mainCluster' under a supervisor

{ mainCluster, { mcd_cluster, start_link, [mainCluster, [
    {host1, ["localhost"], 10},
    {host2, ["localhost"], 20}
]]}, permanent, 60000, worker, [mcd_starter] }

Note: the default port for "localhost" is 11211.

2.3 Starting memcached cluster as an application

application:set_env(mcd, mcd_hosts, [{localhost, ["localhost"]}]).
application:set_env(mcd, mcd_buckets, [
    {cluster1, {localhost, 11211}},
    {cluster2, {localhost, 11211}}
]).
application:start(mcd).

{error, notfound} = mcd:get(cluster1, foo).
{error, notfound} = mcd:get(cluster2, foo).

3. USING MEMCACHED

{ok, b} = mcd:set(server, a, b).
{error, notfound} = mcd:get(server, foo).
{ok, [42]} = mcd:set(mainCluster, <<"bar">>, [42]).
{ok, [42]} = mcd:get(mainCluster, <<"bar">>).

4. RELEASE NOTES

See CHANGELOG.md

Something went wrong with that request. Please try again.