Binary value support for last word in command

Implemented limited but useful binary data support without breaking the API. If the last character of the command is a ", look for the first ", and everything in between the quotes treat as binary data. Takes care of setting a key with a binary value. Not useful if there need to be multiple binary entries in one command, or for binary keys. Also need to be careful if the last character of the value actually needs to be a quote, in which case we need to quote the value.

Binary value support for last word in command
Implemented limited but useful binary data support without breaking the API. If the last character of the command is a ", look for the first ", and everything in between the quotes treat as binary data. Takes care of setting a key with a binary value. Not useful if there need to be multiple binary entries in one command, or for binary keys. Also need to be careful if the last character of the value actually needs to be a quote, in which case we need to quote the value.
Hayk Martirosyan
1 parent 3b431e0e
Showing 5 changed files with 76 additions and 5 deletions
CMakeLists.txt
README.md
examples/binary_data.cpp
src/command.cpp
src/redox.cpp
@@ -84,4 +84,7 @@ if (examples)
   add_executable(multi_client examples/multi-client.cpp ${SRC_ALL})
   target_link_libraries(multi_client ${LIB_REDIS})
+  add_executable(binary_data examples/binary_data.cpp ${SRC_ALL})
+  target_link_libraries(binary_data ${LIB_REDIS})
+
 endif()
 redox
 ======
-Modern, asynchronous, and wicked fast C++11 bindings for Redis
+Modern, asynchronous, and wicked fast C++11 client for Redis
 ## Overview
+/**
+* Basic use of Redox to set and get binary data.
+*/
+
+#include <iostream>
+#include <algorithm>
+#include <random>
+#include "../src/redox.hpp"
+
+using namespace std;
+
+/**
+* Random string generator.
+*/
+std::string random_string(size_t length) {
+  std::string str(length, 0);
+  std::generate_n(str.begin(), length, []{ return (unsigned char)rand(); });
+  return str;
+}
+
+int main(int argc, char* argv[]) {
+
+  redox::Redox rdx = {"localhost", 6379}; // Initialize Redox
+  if(!rdx.start()) return 1; // Start the event loop
+
+  rdx.del("binary");
+
+  string binary_data = random_string(10000);
+
+  auto c = rdx.command_blocking<string>("SET binary \"" + binary_data + "\"");
+  if(c->ok()) cout << "Reply: " << c->reply() << endl;
+  else cerr << "Failed to set key! Status: " << c->status() << endl;
+  c->free();
+
+  c = rdx.command_blocking<string>("GET binary");
+  if(c->ok()) {
+    if(c->reply() == binary_data) cout << "Binary data matches!" << endl;
+    else cerr << "Binary data differs!" << endl;
+  }
+  else cerr << "Failed to get key! Status: " << c->status() << endl;
+  c->free();
+
+  rdx.stop(); // Shut down the event loop
+}
@@ -46,7 +46,7 @@ void Command&lt;std::string&gt;::invoke_callback() {
     invoke_error(REDOX_WRONG_TYPE);
   } else {
-    std::string s = reply_obj->str;
+    std::string s(reply_obj->str, reply_obj->len);
     invoke(s);
   }
 }
@@ -129,7 +129,7 @@ void Command&lt;std::vector&lt;std::string&gt;&gt;::invoke_callback() {
         std::cerr << "[ERROR] " << cmd << ": Received non-array reply." << std::endl;
         invoke_error(REDOX_WRONG_TYPE);
       }
-      v.push_back(r->str);
+      v.emplace_back(r->str, r->len);
     }
     invoke(v);
   }
@@ -153,7 +153,7 @@ void Command&lt;std::unordered_set&lt;std::string&gt;&gt;::invoke_callback() {
         std::cerr << "[ERROR] " << cmd << ": Received non-array reply." << std::endl;
         invoke_error(REDOX_WRONG_TYPE);
       }
-      v.insert(r->str);
+      v.emplace(r->str, r->len);
     }
     invoke(v);
   }
@@ -177,7 +177,7 @@ void Command&lt;std::set&lt;std::string&gt;&gt;::invoke_callback() {
         std::cerr << "[ERROR] " << cmd << ": Received non-array reply." << std::endl;
         invoke_error(REDOX_WRONG_TYPE);
       }
-      v.insert(r->str);
+      v.emplace(r->str, r->len);
     }
     invoke(v);
   }
@@ -235,6 +235,30 @@ void Redox::command_callback(redisAsyncContext *ctx, void *r, void *privdata) {
 template<class ReplyT>
 bool Redox::submit_to_server(Command<ReplyT>* c) {
   c->pending++;
+
+  // Process binary data if trailing quotation. This is a limited implementation
+  // to allow binary data between the first and the last quotes of the command string,
+  // if the very last character of the command is a quote ('"').
+  if(c->cmd[c->cmd.size()-1] == '"') {
+
+    // Indices of the quotes
+    int first = c->cmd.find('"');
+    int last = c->cmd.size()-1;
+
+    // Proceed only if the first and last quotes are different
+    if(first != last) {
+
+      string format = c->cmd.substr(0, first) + "%b";
+      string value = c->cmd.substr(first+1, last-first-1);
+      if (redisAsyncCommand(c->rdx->ctx, command_callback<ReplyT>, (void*)c->id, format.c_str(), value.c_str(), value.size()) != REDIS_OK) {
+        cerr << "[ERROR] Could not send \"" << c->cmd << "\": " << c->rdx->ctx->errstr << endl;
+        c->invoke_error(REDOX_SEND_ERROR);
+        return false;
+      }
+      return true;
+    }
+  }
+
   if (redisAsyncCommand(c->rdx->ctx, command_callback<ReplyT>, (void*)c->id, c->cmd.c_str()) != REDIS_OK) {
     cerr << "[ERROR] Could not send \"" << c->cmd << "\": " << c->rdx->ctx->errstr << endl;
     c->invoke_error(REDOX_SEND_ERROR);