Updated the C++ interface to return values as std::vector<char> instead of
[awesomized/libmemcached] / libmemcached / memcached.hh
index 8144a42c1e4a3d61459c0539d217e46eec3075f4..fa535c0c0e266768d134d89dfd887889d35338dd 100644 (file)
@@ -1,7 +1,20 @@
+/*
+ * Summary: C++ interface for memcached server
+ *
+ * Copy: See Copyright for the status of this software.
+ *
+ * Authors: Padraig O'Sullivan, Patrick Galbraith
+ */
+
+#ifndef LIBMEMCACHEDPP_H
+#define LIBMEMCACHEDPP_H
+
 #include <libmemcached/memcached.h>
 
 #include <string.h>
+
 #include <string>
+#include <vector>
 
 class Memcached
 {
@@ -28,204 +41,324 @@ public:
     memcached_free(&memc);
   }
 
-  std::string fetch(const std::string& key, size_t *key_length, size_t *value_length)
+  bool fetch(std::string &key, 
+             std::vector<char> &ret_val,
+             uint32_t *flags,
+             memcached_return *rc)
   {
-    uint32_t flags;
-    memcached_return rc;
-    std::string ret_val;
-
-    char *value= memcached_fetch(&memc, const_cast<char *>(key.c_str()), key_length,
-                                 value_length, &flags, &rc);
+    char ret_key[MEMCACHED_MAX_KEY];
+    size_t value_length= 0;
+    size_t key_length= 0;
+    char *value= memcached_fetch(&memc, ret_key, &key_length,
+                                 &value_length, flags, rc);
     if (value)
     {
-      ret_val.assign(value);
+      ret_val.reserve(value_length);
+      memcpy(&*ret_val.begin(), value, value_length);
+      key.assign(ret_key);
+      return true;
     }
-    return ret_val;
+    return false;
   }
 
-  std::string get(const std::string& key, size_t *value_length) 
+  std::vector<char> &get(const std::string &key, 
+                         std::vector<char> &ret_val)
   {
-    uint32_t flags;
+    uint32_t flags= 0;
     memcached_return rc;
-    std::string ret_val;
+    size_t value_length= 0;
 
     char *value= memcached_get(&memc, key.c_str(), key.length(),
-                               value_length, &flags, &rc);
-    if (value)
+                               &value_length, &flags, &rc);
+    if (value != NULL)
     {
-      ret_val.assign(value);
+      ret_val.reserve(value_length);
+      memcpy(&ret_val[0], value, value_length);
     }
     return ret_val;
   }
 
-  std::string get_by_key(const std::string& master_key, 
-                         const std::string& key, 
-                         size_t *value_length)
+  std::vector<char> &getByKey(const std::string &master_key, 
+                              const std::string &key, 
+                              std::vector<char> &ret_val)
   {
-    uint32_t flags;
+    uint32_t flags= 0;
     memcached_return rc;
-    std::string ret_val;
+    size_t value_length= 0;
 
-    char *value= memcached_get_by_key(&memc, master_key.c_str(), master_key.length(), 
+    char *value= memcached_get_by_key(&memc, 
+                                      master_key.c_str(), master_key.length(), 
                                       key.c_str(), key.length(),
-                                      value_length, &flags, &rc);
+                                      &value_length, &flags, &rc);
     if (value)
     {
-      ret_val.assign(value);
+      ret_val.reserve(value_length);
+      memcpy(&*ret_val.begin(), value, value_length);
     }
     return ret_val;
   }
 
-  bool mget(char **keys, size_t *key_length, 
-            unsigned int number_of_keys)
+  bool mget(std::vector<std::string> &keys)
   {
+    std::vector<const char *> real_keys;
+    std::vector<size_t> key_len;
+    /*
+     * Construct an array which will contain the length
+     * of each of the strings in the input vector. Also, to
+     * interface with the memcached C API, we need to convert
+     * the vector of std::string's to a vector of char *.
+     */
+    real_keys.reserve(keys.size());
+    key_len.reserve(keys.size());
+
+    std::vector<std::string>::iterator it= keys.begin();
+
+    while (it != keys.end())
+    {
+      real_keys.push_back(const_cast<char *>((*it).c_str()));
+      key_len.push_back((*it).length());
+      ++it;
+    }
 
-    memcached_return rc= memcached_mget(&memc, keys, key_length, number_of_keys);
-    return (rc == MEMCACHED_SUCCESS);
+    /*
+     * If the std::vector of keys is empty then we cannot 
+     * call memcached_mget as we will get undefined behavior.
+     */
+    if (!real_keys.empty())
+    {
+      memcached_return rc= memcached_mget(&memc, &real_keys[0], &key_len[0], 
+                                          real_keys.size());
+      return (rc == MEMCACHED_SUCCESS);
+    }
+
+    return false;
   }
 
-  bool set(const std::string& key, const char *value, size_t value_length)
+  bool set(const std::string &key, 
+           const std::vector<char> &value,
+           time_t expiration,
+           uint32_t flags)
   {
-    memcached_return rc= memcached_set(&memc, key.c_str(), key.length(),
-                                       value, value_length,
-                                       time_t(0), uint32_t(0));
-    return (rc == MEMCACHED_SUCCESS);
+    memcached_return rc= memcached_set(&memc, 
+                                       key.c_str(), key.length(),
+                                       &value[0], value.size(),
+                                       expiration, flags);
+    return (rc == MEMCACHED_SUCCESS || rc == MEMCACHED_BUFFERED);
+  }
+
+  bool setAll(std::vector<std::string> &keys,
+              std::vector< std::vector<char> > &values,
+              time_t expiration,
+              uint32_t flags)
+  {
+    if (keys.size() != values.size())
+    {
+      return false;
+    }
+    bool retval= true;
+    std::vector<std::string>::iterator key_it= keys.begin();
+    std::vector< std::vector<char> >::iterator val_it= values.begin();
+    while (key_it != keys.end())
+    {
+      retval= set((*key_it), (*val_it), expiration, flags);
+      if (retval == false)
+      {
+        return retval;
+      }
+      ++key_it;
+      ++val_it;
+    }
+    return retval;
   }
 
-  bool set_by_key(const std::string& master_key, 
-                  const std::string& key, 
-                  const char *value, size_t value_length)
+  bool setByKey(const std::string &master_key, 
+                const std::string &key, 
+                const std::vector<char> &value,
+                time_t expiration,
+                uint32_t flags)
   {
     memcached_return rc= memcached_set_by_key(&memc, master_key.c_str(), 
                                               master_key.length(),
                                               key.c_str(), key.length(),
-                                              value, value_length,
-                                              time_t(0),
-                                              uint32_t(0));
+                                              &value[0], value.size(),
+                                              expiration,
+                                              flags);
     return (rc == MEMCACHED_SUCCESS);
   }
 
-  bool increment(const std::stringkey, unsigned int offset, uint64_t *value)
+  bool increment(const std::string &key, unsigned int offset, uint64_t *value)
   {
     memcached_return rc= memcached_increment(&memc, key.c_str(), key.length(),
                                              offset, value);
     return (rc == MEMCACHED_SUCCESS);
   }
 
-  bool decrement(const char *key, unsigned int offset, uint64_t *value)
+  bool decrement(const std::string &key, unsigned int offset, uint64_t *value)
   {
-    memcached_return rc= memcached_decrement(&memc, key, strlen(key),
+    memcached_return rc= memcached_decrement(&memc, key.c_str(), 
+                                             key.length(),
                                              offset, value);
     return (rc == MEMCACHED_SUCCESS);
   }
 
 
-  bool add(const char *key, const char *value, size_t value_length)
+  bool add(const std::string &key, const std::string &value)
   {
-    memcached_return rc= memcached_add(&memc, key, strlen(key), value, value_length, 0, 0);
+    memcached_return rc= memcached_add(&memc, key.c_str(), key.length(), 
+                                       value.c_str(), value.length(), 0, 0);
     return (rc == MEMCACHED_SUCCESS);
   }
 
-  bool add_by_key(const char *master_key, const char *key, 
-                  const char *value, size_t value_length)
+  bool addByKey(const std::string &master_key, 
+                const std::string &key, 
+                const std::string &value)
   {
-    memcached_return rc= memcached_add_by_key(&memc, master_key, strlen(master_key),
-                                              key, strlen(key),
-                                              value, value_length,
+    memcached_return rc= memcached_add_by_key(&memc, 
+                                              master_key.c_str(),
+                                              master_key.length(),
+                                              key.c_str(),
+                                              key.length(),
+                                              value.c_str(), 
+                                              value.length(),
                                               0, 0);
     return (rc == MEMCACHED_SUCCESS);
   }
 
-  bool replace(const char *key, const char *value, 
-               size_t value_length)
+  bool replace(const std::string &key, const std::string &value)
   {
-    memcached_return rc= memcached_replace(&memc, key, strlen(key),
-                                           value, value_length,
+    memcached_return rc= memcached_replace(&memc, key.c_str(), key.length(),
+                                           value.c_str(), value.length(),
                                            0, 0);
     return (rc == MEMCACHED_SUCCESS);
   }
 
-  bool replace_by_key(const char *master_key, const char *key, 
-                      const char *value, size_t value_length)
+  bool replaceByKey(const std::string &master_key, 
+                    const std::string &key, 
+                    const std::string &value)
   {
-    memcached_return rc= memcached_replace_by_key(&memc, master_key, strlen(master_key),
-                                                  key, strlen(key),
-                                                  value, value_length, 0, 0);
+    memcached_return rc= memcached_replace_by_key(&memc, 
+                                                  master_key.c_str(), 
+                                                  master_key.length(),
+                                                  key.c_str(), 
+                                                  key.length(),
+                                                  value.c_str(), 
+                                                  value.length(), 
+                                                  0, 0);
     return (rc == MEMCACHED_SUCCESS);
   }
 
-  bool prepend(const char *key, const char *value, 
-               size_t value_length)
+  bool prepend(const std::string &key, const std::string &value)
   {
-    memcached_return rc= memcached_prepend(&memc, key, strlen(key),
-                                           value, value_length, 0, 0);
+    memcached_return rc= memcached_prepend(&memc, key.c_str(), key.length(),
+                                           value.c_str(), value.length(), 0, 0);
     return (rc == MEMCACHED_SUCCESS);
   }
 
-  bool prepend_by_key(const char *master_key, const char *key, 
-                      const char *value, size_t value_length)
+  bool prependByKey(const std::string &master_key, 
+                    const std::string &key, 
+                    const std::string &value)
   {
-    memcached_return rc= memcached_prepend_by_key(&memc, master_key, strlen(master_key),
-                                                  key, strlen(key),
-                                                  value, value_length,
+    memcached_return rc= memcached_prepend_by_key(&memc, 
+                                                  master_key.c_str(), 
+                                                  master_key.length(),
+                                                  key.c_str(), 
+                                                  key.length(),
+                                                  value.c_str(), 
+                                                  value.length(),
                                                   0,
                                                   0);
     return (rc == MEMCACHED_SUCCESS);
   }
 
-  bool append(const char *key, const char *value, 
-              size_t value_length)
+  bool append(const std::string &key, const std::string &value)
   {
-    memcached_return rc= memcached_append(&memc, key, strlen(key),
-                                          value, value_length, 0, 0);
+    memcached_return rc= memcached_append(&memc, 
+                                          key.c_str(), 
+                                          key.length(),
+                                          value.c_str(), 
+                                          value.length(), 
+                                          0, 0);
     return (rc == MEMCACHED_SUCCESS);
   }
 
-  bool append_by_key(const char *master_key, const char *key, 
-                     const char *value, size_t value_length)
+  bool appendByKey(const std::string &master_key, 
+                   const std::string &key, 
+                   const std::string &value)
   {
     memcached_return rc= memcached_append_by_key(&memc,
-                                                 master_key, strlen(master_key),
-                                                 key, strlen(key),
-                                                 value, value_length, 0, 0);
+                                                 master_key.c_str(), 
+                                                 master_key.length(),
+                                                 key.c_str(), 
+                                                 key.length(),
+                                                 value.c_str(), 
+                                                 value.length(), 
+                                                 0, 0);
     return (rc == MEMCACHED_SUCCESS);
   }
 
-  bool cas(const char *key, const char *value, 
-           size_t value_length, uint64_t cas_arg)
+  bool cas(const std::string &key, 
+           const std::string &value, 
+           uint64_t cas_arg)
   {
-    memcached_return rc= memcached_cas(&memc, key, strlen(key),
-                                       value, value_length, 0, 0, cas_arg);
+    memcached_return rc= memcached_cas(&memc, key.c_str(), key.length(),
+                                       value.c_str(), value.length(), 
+                                       0, 0, cas_arg);
     return (rc == MEMCACHED_SUCCESS);
   }
 
-  bool cas_by_key(const char *master_key, const char *key, 
-                  const char *value, size_t value_length, 
-                  uint64_t cas_arg)
+  bool casByKey(const std::string &master_key, 
+                const std::string &key, 
+                const std::string &value, 
+                uint64_t cas_arg)
   {
     memcached_return rc= memcached_cas_by_key(&memc,
-                                              master_key, strlen(master_key),
-                                              key, strlen(key),
-                                              value, value_length,
+                                              master_key.c_str(), 
+                                              master_key.length(),
+                                              key.c_str(), 
+                                              key.length(),
+                                              value.c_str(), 
+                                              value.length(),
                                               0, 0, cas_arg);
     return (rc == MEMCACHED_SUCCESS);
   }
 
   // using 'remove' vs. 'delete' since 'delete' is a keyword 
-  bool remove(const std::stringkey)
+  bool remove(const std::string &key)
   {
     memcached_return rc= memcached_delete(&memc, key.c_str(), key.length(), 0);
     return (rc == MEMCACHED_SUCCESS);
   }
 
-  bool delete_by_key(const char *master_key, const char *key)
+  bool removeByKey(const std::string &master_key, 
+                   const std::string &key)
+  {
+    memcached_return rc= memcached_delete_by_key(&memc, 
+                                                 master_key.c_str(), 
+                                                 master_key.length(),
+                                                 key.c_str(), 
+                                                 key.length(), 
+                                                 0);
+    return (rc == MEMCACHED_SUCCESS);
+  }
+
+  bool flush(time_t expiration)
+  {
+    memcached_return rc= memcached_flush(&memc, expiration);
+    return (rc == MEMCACHED_SUCCESS);
+  }
+
+  bool fetchExecute(memcached_execute_function *callback,
+                    void *context,
+                    unsigned int num_of_callbacks)
   {
-    memcached_return rc= memcached_delete_by_key(&memc, master_key, strlen(master_key),
-                                                 key, strlen(key), 0);
+    memcached_return rc= memcached_fetch_execute(&memc,
+                                                 callback,
+                                                 context,
+                                                 num_of_callbacks);
     return (rc == MEMCACHED_SUCCESS);
   }
 
-  const std::string lib_version() const
+  const std::string libVersion() const
   {
     const char *ver= memcached_lib_version();
     const std::string version(ver);
@@ -236,3 +369,5 @@ private:
   memcached_st memc;
   memcached_result_st result;
 };
+
+#endif /* LIBMEMCACHEDPP_H */