README.md
1# Memcached-libmemcached
2
3[](http://travis-ci.org/timbunce/Memcached-libmemcached/)
4
5Memcached::libmemcached is a very thin, highly efficient, wrapper around the
6libmemcached library.
7
8It gives full access to the rich functionality offered by libmemcached.
9libmemcached is fast, light on memory usage, thread safe, and provides full
10access to server side methods.
11
12 - Synchronous and Asynchronous support.
13 - TCP and Unix Socket protocols.
14 - A half dozen or so different hash algorithms.
15 - Implementations of the new cas, replace, and append operators.
16 - Man pages written up on entire API.
17 - Implements both modulo and consistent hashing solutions.
18
19# INSTALLATION
20
21To install this module, run the following commands:
22
23 perl Makefile.PL
24 make
25 make test (see TESTING below)
26 make install
27
28Note that the "perl Makefile.PL" step will configure and build a private copy
29of libmemcached from source. So don't be surprised to see pages of output
30during that step.
31
32If you'd like to have the commandline tools that come with libmemcached installed, invoke Makefile.PL as:
33
34 perl Makefile.PL --bin
35
36See http://libmemcached.org for details.
37
38
39# TESTING
40
41The "make test" command can run some tests without using a memcached server.
42Others are skipped unless a memcached server can be found.
43By default the tests look for a memcached server at the standard port on localhost.
44
45To use one or more other servers set the PERL_LIBMEMCACHED_TEST_SERVERS
46environment variable to a comma separated list of hostname:port values.
47
48Most tests require just one server but some require at least 5 servers.
49
50# SUPPORT AND DOCUMENTATION
51
52After installing, you can find documentation for this module with the
53perldoc command.
54
55 perldoc Memcached::libmemcached
56
57You can also look for information at:
58
59 RT, CPAN's request tracker
60 http://rt.cpan.org/NoAuth/Bugs.html?Dist=Memcached-libmemcached
61
62 AnnoCPAN, Annotated CPAN documentation
63 http://annocpan.org/dist/Memcached-libmemcached
64
65 CPAN Ratings
66 http://cpanratings.perl.org/d/Memcached-libmemcached
67
68 Search CPAN
69 http://search.cpan.org/dist/Memcached-libmemcached
70
71
72# COPYRIGHT AND LICENCE
73
74Copyright (C) 2008, 2013 Tim Bunce
75
76This program is free software; you can redistribute it and/or modify it
77under the same terms as Perl itself.
78
79# DEVELOPER TOOLS
80
81Debugging
82
83 make realclean # if perl Makefile.PL already run
84 perl Makefile.PL -g
85
86Profiling
87
88 make realclean # if perl Makefile.PL already run
89 perl Makefile.PL -pg
90
91Test coverage analysis
92
93 make realclean # if perl Makefile.PL already run
94 perl Makefile.PL -cov
95 make
96 make testcover
97
98Install commandline tools from libmemcached
99
100 perl Makefile.PL -bin
101 make
102 make install
103
104
){kind=link}