redox

Modern, asynchronous, and wicked fast C++11 client for Redis

Redox is a C++ interface to the Redis key-value store that makes it easy to write applications that are both elegant and high-performance. Communication should be a means to an end, not something we spend a lot of time worrying about. Redox takes care of the details so you can move on to the interesting part of your project.

Features:

• Expressive asynchronous and synchronous API, templated by return value
• Callbacks can be lambdas, class methods, bind expressions, or any std::function
• Thread-safe - use one client in multiple threads or multiple clients in one
• Automatic pipelining, even for synchronous calls from separate threads
• Low-level access when needed
• Accessible and robust error handling
• Fast - developed for robotics applications
• 100% clean Valgrind reports

Redox is built on top of hiredis and libev. It uses only the asynchronous API of hiredis, even for synchronous commands. There is no dependency on Boost or any other libraries.

Benchmarks

Benchmarks are given by averaging the results of five trials of the speed tests in examples/ on an AWS t2.medium instance running Ubuntu 14.04 (64-bit).

Local Redis server, TCP connection:

• 100 command loops (speed_test_async_multi): 710,014 commands/s
• One command loop (speed_test_async): 195,159 commands/s
• Looped synchronous command (speed_test_sync): 28,609 commands/s

Results are comparable to that of an average laptop. On a high-end machine, speed_test_async_multi usually tops 1,000,000 commands/s.

Installation

Instructions provided are for Ubuntu, but all components are platform-independent.

Build from source

Get the build environment and dependencies:

sudo apt-get install git cmake build-essential
sudo apt-get install libhiredis-dev libev-dev

Build the library:

mkdir build && cd build
cmake ..
make

Install into system directories (optional):

sudo make install

Build examples and test suite

Enable examples using ccmake or the following:

cmake -Dexamples=ON ..
make examples

To run the test suite, first make sure you have gtest set up, then:

cmake -Dtests=ON ..
make test_redox
./test_redox

Tutorial

Here is a hello world program for redox:

#include <iostream>
#include "redox.hpp"

int main(int argc, char* argv[]) {

  redox::Redox rdx = {"localhost", 6379};
  if(!rdx.connect()) return 1;

  rdx.set("hello", "world!");
  std::cout << "Hello, " << rdx.get("hello") << std::endl;

  rdx.disconnect();
  return 0;
}

Compile and run:

$ g++ hello.cpp -o hello -std=c++11 -lredox -lev -lhiredis
$ ./hello
Hello, world!