cpp_redis

cpp_redis is C++11 Asynchronous Redis Client.

Network is based on Boost Asio library.

Requirements

• C++11
• Boost Asio

Compiling

The library uses cmake. In order to build the library, follow these steps:

git clone https://github.com/Cylix/cpp_redis.git
cd cpp_redis
./install_deps.sh # necessary only for building tests
mkdir build
cd build
cmake .. # only library
cmake .. -DBUILD_TESTS=true # library and tests
cmake .. -DBUILD_EXAMPLES=true # library and examples
cmake .. -DBUILD_TESTS=true -DBUILD_EXAMPLES=true # library, tests and examples
make -j

Then, you just have to link the cpp_redis library with your project.

For building tests, it is necessary to install google_tests. Just run the install_deps.sh script which does the work for you.

Redis Client

redis_client is the class providing communication with a redis server.

Methods

void connect(const std::string& host = "127.0.0.1", unsigned int port = 6379)

Connect to the Redis Server. Connection is done synchronously. Throws redis_error in case of failure or if client if already connected.

void disconnect(void)

Disconnect client from remote host. Throws redis_error if client is not connected to any server.

bool is_connected(void)

Returns whether the client is connected or not.

void set_disconnection_handler(const disconnection_handler& handler)

Set the disconnection handler which is called whenever a disconnection has occurred. Disconnection handler is an std::function<void(redis_client&)>.

void send(const std::vectorstd::string& redis_cmd, const reply_callback& callback = nullptr)

Send a command and set the callback which has to be called when the reply has been received. If nullptr is passed as callback, command is executed and no callback will be called. Reply callback is an std::function<void(reply&)>.

Example

#include "cpp_redis/cpp_redis.hpp"

#include <signal.h>
#include <iostream>

bool should_exit = false;
cpp_redis::redis_client client;

void
sigint_handler(int) {
    std::cout << "disconnected (sigint handler)" << std::endl;
    client.disconnect();
}

int
main(void) {
    client.set_disconnection_handler([] (cpp_redis::redis_client&) {
        std::cout << "client disconnected (disconnection handler)" << std::endl;
        should_exit = true;
    });

    client.connect();

    client.send({"SET", "hello", "world"});
    client.send({"GET", "hello"}, [] (cpp_redis::reply& reply) {
        std::cout << reply.as_string() << std::endl;
    });

    signal(SIGINT, &sigint_handler);
    while (not should_exit);

    return 0;
}

Redis Subscriber

Methods

void connect(const std::string& host = "127.0.0.1", unsigned int port = 6379)

Connect to the Redis Server. Connection is done synchronously. Throws redis_error in case of failure or if client if already connected.

void disconnect(void)

Disconnect client from remote host. Throws redis_error if client is not connected to any server.

bool is_connected(void)

Returns whether the client is connected or not.

void set_disconnection_handler(const disconnection_handler& handler)

Set the disconnection handler which is called whenever a disconnection has occurred. Disconnection handler is an std::function<void(redis_subscriber&)>.

void subscribe(const std::string& channel, const subscribe_callback& callback)

Subscribe to the given channel and call subscribe_callback each time a message is published in this channel. subscribe_callback is an std::function<void(const std::string&, const std::string&)>.

void psubscribe(const std::string& pattern, const subscribe_callback& callback)

PSubscribe to the given pattern and call subscribe_callback each time a message is published in a channel matching the pattern. subscribe_callback is an std::function<void(const std::string&, const std::string&)>.

void unsubscribe(const std::string& channel)

Unsubscribe from the given channel.

void punsubscribe(const std::string& pattern)

Unsubscribe from the given pattern.

Example

#include "cpp_redis/cpp_redis.hpp"

#include <signal.h>
#include <iostream>

bool should_exit = false;
cpp_redis::redis_subscriber sub;

void
sigint_handler(int) {
    std::cout << "disconnected (sigint handler)" << std::endl;
    sub.disconnect();
}

int
main(void) {
    sub.set_disconnection_handler([] (cpp_redis::redis_subscriber&) {
        std::cout << "sub disconnected (disconnection handler)" << std::endl;
        should_exit = true;
    });

    sub.connect();

    sub.subscribe("some_chan", [] (const std::string& chan, const std::string& msg) {
        std::cout << "MESSAGE " << chan << ": " << msg << std::endl;
    });
    sub.psubscribe("*", [] (const std::string& chan, const std::string& msg) {
        std::cout << "PMESSAGE " << chan << ": " << msg << std::endl;
    });

    signal(SIGINT, &sigint_handler);
    while (not should_exit);

    return 0;
}

Examples

Some examples are provided in this repository:

• redis_client.cpp shows how to use the redis client class.
• redis_subscriber.cpp shows how to use the redis subscriber class.

Author

Simon Ninon