* Added first version of exceptions to the C++ interface
authorPatrick Galbraith <patg@patrick-galbraiths-macbook-pro.local>
Tue, 4 Aug 2009 14:30:14 +0000 (10:30 -0400)
committerPatrick Galbraith <patg@patrick-galbraiths-macbook-pro.local>
Tue, 4 Aug 2009 14:30:14 +0000 (10:30 -0400)
libmemcached/Makefile.am
libmemcached/exception.hpp [new file with mode: 0644]
libmemcached/memcached.hpp

index 087290e986d33dfae258a71fd01e98e98012c1b5..f192eda45b5d6f035cbb5d5ba0ebf33b7cb7c6ac 100644 (file)
@@ -12,6 +12,7 @@ noinst_HEADERS = libmemcached_probes.h \
 
 pkginclude_HEADERS= memcached.h \
                    memcached.hpp \
+                   exception.hpp \
                     memcached_configure.h \
                    memcached_constants.h \
                    memcached_get.h \
diff --git a/libmemcached/exception.hpp b/libmemcached/exception.hpp
new file mode 100644 (file)
index 0000000..8fb952e
--- /dev/null
@@ -0,0 +1,56 @@
+/*
+ * Drizzle Client & Protocol Library
+ *
+ * Copyright (C) 2009 Patrick Galbraith (patg@patg.net)
+ * All rights reserved.
+ *
+ * Use and distribution licensed under the BSD license.  See
+ * the COPYING file in this directory for full text.
+ */
+
+/**
+ * @file
+ * @brief Exception declarations
+ */
+
+#ifndef LIBMEMACHED_EXCEPTION_HPP
+#define LIBMEMACHED_EXCEPTION_HPP
+
+#include <stdexcept>
+
+
+namespace memcache {
+
+  class Exception : public std::runtime_error
+  {
+  public:
+    Exception(const std::string& msg, bool errno)
+      : std::runtime_error(msg), _errno(errno) {}
+    Exception(const char *msg, bool errno)
+      : std::runtime_error(msg), _errno(errno) {}
+    virtual ~Exception() throw() {}
+
+    int getErrno() const { return _errno; }
+  private:
+    int _errno;
+
+  };
+
+  class Warning : public Exception
+  {
+  public:
+    Warning(const std::string& msg, bool errno) : Exception(msg, errno) {}
+    Warning(const char *msg, bool errno) : Exception(msg, errno) {}
+  };
+
+  class Error : public Exception
+  {
+  public:
+    Error(const std::string& msg, bool errno) : Exception(msg, errno) {}
+    Error(const char *msg, bool errno) : Exception(msg, errno) {}
+    virtual ~Error() throw() {}
+  };
+
+} /* namespace libmemcached */
+
+#endif /* LIBMEMACHED_EXCEPTION_HPP */
index c21651bf3007abb6173a28a97c7e0c7a02666caa..d093192db138bc2176cdf128a408977e01b0636c 100644 (file)
@@ -16,6 +16,7 @@
 #define LIBMEMCACHEDPP_H
 
 #include <libmemcached/memcached.h>
+#include <libmemcached/exception.hpp>
 
 #include <string.h>
 
@@ -127,7 +128,7 @@ public:
    * @return true on success; false otherwise
    */
   bool get(const std::string &key, 
-           std::vector<char> &ret_val)
+           std::vector<char> &ret_val) throw (Error)
   {
     uint32_t flags= 0;
     memcached_return rc;
@@ -135,7 +136,7 @@ public:
 
     if (key.empty())
     {
-      return false;
+      throw(Error("the key supplied is empty!", false));
     }
     char *value= memcached_get(&memc, key.c_str(), key.length(),
                                &value_length, &flags, &rc);
@@ -162,7 +163,7 @@ public:
    */
   bool getByKey(const std::string &master_key, 
                 const std::string &key, 
-                std::vector<char> &ret_val)
+                std::vector<char> &ret_val) throw(Error)
   {
     uint32_t flags= 0;
     memcached_return rc;
@@ -170,10 +171,10 @@ public:
 
     if (master_key.empty() || key.empty())
     {
-      return false;
+      throw(Error("the master key or key supplied is empty!", false));
     }
-    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);
     if (value)
@@ -239,16 +240,16 @@ public:
    * @param[in] flags flags to store with the object
    * @return true on succcess; false otherwise
    */
-  bool set(const std::string &key, 
+  bool set(const std::string &key,
            const std::vector<char> &value,
            time_t expiration,
-           uint32_t flags)
+           uint32_t flags) throw(Error)
   {
     if (key.empty() || value.empty())
     {
-      return false;
+      throw(Error("the key or value supplied is empty!", false));
     }
-    memcached_return rc= memcached_set(&memc, 
+    memcached_return rc= memcached_set(&memc,
                                        key.c_str(), key.length(),
                                        &value[0], value.size(),
                                        expiration, flags);
@@ -270,13 +271,13 @@ public:
                 const std::string &key, 
                 const std::vector<char> &value,
                 time_t expiration,
-                uint32_t flags)
+                uint32_t flags) throw(Error)
   {
     if (master_key.empty() ||
         key.empty() ||
         value.empty())
     {
-      return false;
+      throw(Error("the key or value supplied is empty!", false));
     }
     memcached_return rc= memcached_set_by_key(&memc, master_key.c_str(), 
                                               master_key.length(),
@@ -300,11 +301,11 @@ public:
   bool setAll(std::vector<std::string> &keys,
               std::vector< std::vector<char> *> &values,
               time_t expiration,
-              uint32_t flags)
+              uint32_t flags) throw(Error)
   {
     if (keys.size() != values.size())
     {
-      return false;
+      throw(Error("The number of keys and values do not match!", false));
     }
     bool retval= true;
     std::vector<std::string>::iterator key_it= keys.begin();
@@ -333,11 +334,11 @@ public:
    */
   bool setAll(std::map<const std::string, std::vector<char> > &key_value_map,
               time_t expiration,
-              uint32_t flags)
+              uint32_t flags) throw(Error)
   {
     if (key_value_map.empty())
     {
-      return false;
+      throw(Error("The key/values are not properly set!", false));
     }
     bool retval= true;
     std::map<const std::string, std::vector<char> >::iterator it=
@@ -347,7 +348,10 @@ public:
       retval= set(it->first, it->second, expiration, flags);
       if (retval == false)
       {
-        return false;
+        char err_buff[64];
+        sprintf(err_buff,  "There was an error setting the key %s",
+          it->first.c_str());
+        throw(Error(err_buff, false));
       }
       ++it;
     }
@@ -364,11 +368,11 @@ public:
    * @param[out] value store the result of the increment here
    * @return true on success; false otherwise
    */
-  bool increment(const std::string &key, uint32_t offset, uint64_t *value)
+  bool increment(const std::string &key, uint32_t offset, uint64_t *value) throw(Error)
   {
     if (key.empty())
     {
-      return false;
+      throw(Error("the key supplied is empty!", false));
     }
     memcached_return rc= memcached_increment(&memc, key.c_str(), key.length(),
                                              offset, value);
@@ -386,10 +390,11 @@ public:
    * @return true on success; false otherwise
    */
   bool decrement(const std::string &key, uint32_t offset, uint64_t *value)
+    throw(Error)
   {
     if (key.empty())
     {
-      return false;
+      throw(Error("the key supplied is empty!", false));
     }
     memcached_return rc= memcached_decrement(&memc, key.c_str(), 
                                              key.length(),
@@ -407,10 +412,11 @@ public:
    * @return true on success; false otherwise
    */
   bool add(const std::string &key, const std::vector<char> &value)
+    throw(Error)
   {
     if (key.empty() || value.empty())
     {
-      return false;
+      throw(Error("the key or value supplied is empty!", false));
     }
     memcached_return rc= memcached_add(&memc, key.c_str(), key.length(), 
                                        &value[0], value.size(), 0, 0);
@@ -429,13 +435,13 @@ public:
    */
   bool addByKey(const std::string &master_key, 
                 const std::string &key, 
-                const std::vector<char> &value)
+                const std::vector<char> &value) throw(Error)
   {
     if (master_key.empty() ||
         key.empty() || 
         value.empty())
     {
-      return false;
+      throw(Error("the master key or key supplied is empty!", false));
     }
     memcached_return rc= memcached_add_by_key(&memc, 
                                               master_key.c_str(),
@@ -456,12 +462,12 @@ public:
    * @param[in[ value value to replace object with
    * @return true on success; false otherwise
    */
-  bool replace(const std::string &key, const std::vector<char> &value)
+  bool replace(const std::string &key, const std::vector<char> &value) throw(Error)
   {
     if (key.empty() ||
         value.empty())
     {
-      return false;
+      throw(Error("the key or value supplied is empty!", false));
     }
     memcached_return rc= memcached_replace(&memc, key.c_str(), key.length(),
                                            &value[0], value.size(),
@@ -487,7 +493,7 @@ public:
         key.empty() ||
         value.empty())
     {
-      return false;
+      throw(Error("the master key or key supplied is empty!", false));
     }
     memcached_return rc= memcached_replace_by_key(&memc, 
                                                   master_key.c_str(), 
@@ -508,10 +514,11 @@ public:
    * @return true on success; false otherwise
    */
   bool prepend(const std::string &key, const std::vector<char> &value)
+    throw(Error)
   {
     if (key.empty() || value.empty())
     {
-      return false;
+      throw(Error("the key or value supplied is empty!", false));
     }
     memcached_return rc= memcached_prepend(&memc, key.c_str(), key.length(),
                                            &value[0], value.size(), 0, 0);
@@ -531,19 +538,20 @@ public:
   bool prependByKey(const std::string &master_key, 
                     const std::string &key, 
                     const std::vector<char> &value)
+      throw(Error)
   {
     if (master_key.empty() ||
         key.empty() ||
         value.empty())
     {
-      return false;
+      throw(Error("the master key or key supplied is empty!", false));
     }
-    memcached_return rc= memcached_prepend_by_key(&memc, 
-                                                  master_key.c_str(), 
+    memcached_return rc= memcached_prepend_by_key(&memc,
+                                                  master_key.c_str(),
                                                   master_key.length(),
-                                                  key.c_str(), 
+                                                  key.c_str(),
                                                   key.length(),
-                                                  &value[0], 
+                                                  &value[0],
                                                   value.size(),
                                                   0,
                                                   0);
@@ -558,16 +566,17 @@ public:
    * @return true on success; false otherwise
    */
   bool append(const std::string &key, const std::vector<char> &value)
+    throw(Error)
   {
     if (key.empty() || value.empty())
     {
-      return false;
+      throw(Error("the key or value supplied is empty!", false));
     }
-    memcached_return rc= memcached_append(&memc, 
-                                          key.c_str(), 
+    memcached_return rc= memcached_append(&memc,
+                                          key.c_str(),
                                           key.length(),
-                                          &value[0], 
-                                          value.size(), 
+                                          &value[0],
+                                          value.size(),
                                           0, 0);
     return (rc == MEMCACHED_SUCCESS);
   }
@@ -582,15 +591,16 @@ public:
    * @param[in] value data to append to object's value
    * @return true on success; false otherwise
    */
-  bool appendByKey(const std::string &master_key, 
-                   const std::string &key, 
+  bool appendByKey(const std::string &master_key,
+                   const std::string &key,
                    const std::vector<char> &value)
+    throw(Error)
   {
     if (master_key.empty() ||
         key.empty() ||
         value.empty())
     {
-      return false;
+      throw(Error("the master key or key supplied is empty!", false));
     }
     memcached_return rc= memcached_append_by_key(&memc,
                                                  master_key.c_str(), 
@@ -613,11 +623,11 @@ public:
    */
   bool cas(const std::string &key, 
            const std::vector<char> &value, 
-           uint64_t cas_arg)
+           uint64_t cas_arg) throw(Error)
   {
     if (key.empty() || value.empty())
     {
-      return false;
+      throw(Error("the key or value supplied is empty!", false));
     }
     memcached_return rc= memcached_cas(&memc, key.c_str(), key.length(),
                                        &value[0], value.size(), 
@@ -638,13 +648,13 @@ public:
   bool casByKey(const std::string &master_key, 
                 const std::string &key, 
                 const std::vector<char> &value, 
-                uint64_t cas_arg)
+                uint64_t cas_arg) throw(Error)
   {
     if (master_key.empty() ||
         key.empty() ||
         value.empty())
     {
-      return false;
+      throw(Error("the master key, key or value supplied is empty!", false));
     }
     memcached_return rc= memcached_cas_by_key(&memc,
                                               master_key.c_str(), 
@@ -663,11 +673,11 @@ public:
    * @param[in] key key of object to delete
    * @return true on success; false otherwise
    */
-  bool remove(const std::string &key)
+  bool remove(const std::string &key) throw(Error)
   {
     if (key.empty())
     {
-      return false;
+      throw(Error("the key supplied is empty!", false));
     }
     memcached_return rc= memcached_delete(&memc, key.c_str(), key.length(), 0);
     return (rc == MEMCACHED_SUCCESS);
@@ -681,15 +691,15 @@ public:
    * @return true on success; false otherwise
    */
   bool remove(const std::string &key,
-              time_t expiration)
+              time_t expiration) throw(Error)
   {
     if (key.empty())
     {
-      return false;
+      throw(Error("the key supplied is empty!", false));
     }
-    memcached_return rc= memcached_delete(&memc, 
-                                          key.c_str(), 
-                                          key.length(), 
+    memcached_return rc= memcached_delete(&memc,
+                                          key.c_str(),
+                                          key.length(),
                                           expiration);
     return (rc == MEMCACHED_SUCCESS);
   }
@@ -701,18 +711,18 @@ public:
    * @param[in] key key of object to delete
    * @return true on success; false otherwise
    */
-  bool removeByKey(const std::string &master_key, 
-                   const std::string &key)
+  bool removeByKey(const std::string &master_key,
+                   const std::string &key) throw(Error)
   {
     if (master_key.empty() || key.empty())
     {
-      return false;
+      throw(Error("the master key or key supplied is empty!", false));
     }
-    memcached_return rc= memcached_delete_by_key(&memc, 
-                                                 master_key.c_str(), 
+    memcached_return rc= memcached_delete_by_key(&memc,
+                                                 master_key.c_str(),
                                                  master_key.length(),
-                                                 key.c_str(), 
-                                                 key.length(), 
+                                                 key.c_str(),
+                                                 key.length(),
                                                  0);
     return (rc == MEMCACHED_SUCCESS);
   }
@@ -727,11 +737,11 @@ public:
    */
   bool removeByKey(const std::string &master_key, 
                    const std::string &key,
-                   time_t expiration)
+                   time_t expiration) throw(Error)
   {
     if (master_key.empty() || key.empty())
     {
-      return false;
+      throw(Error("the master key or key supplied is empty!", false));
     }
     memcached_return rc= memcached_delete_by_key(&memc, 
                                                  master_key.c_str(),