3 [![Gitter Badge]](https://gitter.im/m6w6/libmemcached)
4 [![License Badge]](https://opensource.org/licenses/BSD-3-Clause)
6 [Gitter Badge]: https://badges.gitter.im/m6w6/libmemcached.svg "Gitter Chat"
7 [License Badge]: https://img.shields.io/badge/License-BSD%203--Clause-blue.svg "BSD 3-Clause"
9 libmemcached is an open source C/C++ client library and tools for the
10 memcached server (http://memcached.org/). It has been designed to be
11 light on memory usage, thread safe, and provide full access to server
15 > This is a resurrection of the original work from Brian Aker at
16 > [libmemcached.org](https://libmemcached.org) and the only publicly maintained
17 > version of libmemcached currently known to me.
21 [![Docs Actions Badge]](
22 https://github.com/m6w6/libmemcached/actions?query=workflow%3Adocs-publish-pages)
25 https://github.com/m6w6/libmemcached/workflows/docs-publish-pages/badge.svg?branch=v1.x
28 See https://m6w6.github.io/libmemcached
30 ### Building and updating docs
32 See [gh-pages/publish](./docs/gh-pages/publish.sh) script and the
33 [docs-publish-pages](./.github/workflows/docs-publish-pages.yml) workflow,
34 which automate pushing updated documentation to github pages.
38 libmemcached uses `CMake`.
39 Please see/edit [`CMakeConfig.txt`](./CMakeConfig.txt) or use `ccmake(1)` to
40 set any preferred options.
44 git clone github.com:m6w6/libmemcached
45 mkdir build-libmemcached
55 * GNU Bison 2.3+ and Flex
57 ##### Optional dependencies
59 * A C++17 compiler (tests: required)
60 * Intel's libtbb (tests: optional for GCC's stdlib parallelism support)
61 * PThreads (tests, contrib/bin/memaslap, libmemcachedutil/pool)
62 * libevent (contrib/bin/memaslap)
63 * Cyrus' libsasl2 (libmemacached/sasl)
67 [![Codecov Badge]](https://codecov.io/gh/m6w6/libmemcached)
70 https://codecov.io/gh/m6w6/libmemcached/branch/v1.x/graph/badge.svg
73 Enable the `BUILD_TESTING` setting for a build and run `make test`.
75 cmake -DBUILD_TESTING=ON ../libmemcached
78 ### Continuous integration
80 [![Travis Badge]](https://travis-ci.org/github/m6w6/libmemcached)
81 [![Actions Badge]](https://github.com/m6w6/libmemcached/actions?query=workflow%3Acmake-build-ci)
82 [![Sourcehut Badge]](https://builds.sr.ht/~m6w6/libmemcached)
85 https://api.travis-ci.org/m6w6/libmemcached.svg?branch=v1.x
88 https://github.com/m6w6/libmemcached/workflows/cmake-build-ci/badge.svg?branch=v1.x
91 https://builds.sr.ht/~m6w6/libmemcached/commits.svg
94 CI/Test results are performed on the follwing system matrix:
96 | OS | Compiler | Arch |
97 |------------------|------------------------------|-----------------------|
98 | Linux | GNU 9 | arm64, ppc64le, s390x |
99 | Linux | GNU 7/8/9/10, Clang 6/8/9/10 | amd64 |
100 | MacOS | Clang 12 (apple) | amd64 |
101 | FreeBSD, OpenBSD | Clang 8 | amd64 |
103 libmemcached has been tested against [memcached](https://github.com/memcached/memcached) v1.5 and v1.6.
107 Check out the latest [releases](https://github.com/m6w6/libmemcached/releases)
108 or the bundled [ChangeLog](./ChangeLog.md) for a comprehensive list of changes.
112 libmemcached is licensed under the 3-Clause-BSD license, which can be
113 found in the accompanying [LICENSE](./LICENSE) file.
117 Please report any issues on the [bug tracker](https://github.com/m6w6/libmemcached/issues).
119 A list of known permanent issues is maintained in [BUGS](./BUGS.md).
121 All forms of contribution are welcome! Please see the bundled
122 [CONTRIBUTING](./CONTRIBUTING.md) note for the general principles followed.
124 The list of current and past maintainers and contributors is available in [AUTHORS](./AUTHORS).