X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=libmemcached%2Fmemcached.hpp;h=3bc1d227f934650f63fbcf9c803fb3ba20e35148;hb=fd151d70d25ba4cae4f90a1e57435a8cc72e9c09;hp=d093192db138bc2176cdf128a408977e01b0636c;hpb=498a29bcc235aa3bd8999d73095df8b8cbb10413;p=awesomized%2Flibmemcached diff --git a/libmemcached/memcached.hpp b/libmemcached/memcached.hpp index d093192d..3bc1d227 100644 --- a/libmemcached/memcached.hpp +++ b/libmemcached/memcached.hpp @@ -12,14 +12,14 @@ * @brief Libmemcached C++ interface */ -#ifndef LIBMEMCACHEDPP_H -#define LIBMEMCACHEDPP_H +#pragma once #include #include #include +#include #include #include #include @@ -35,47 +35,53 @@ class Memcache { public: - Memcache() - : - memc(), - result() + Memcache() { - memcached_create(&memc); + memc= memcached("", 0); } - Memcache(memcached_st *clone) - : - memc(), - result() + Memcache(const std::string &config) { - memcached_clone(&memc, clone); + memc= memcached(config.c_str(), config.size()); + } + + Memcache(const std::string &hostname, in_port_t port) + { + memc= memcached("", 0); + if (memc) + memcached_server_add(memc, hostname.c_str(), port); + } + + Memcache(memcached_st *clone) + { + memc= memcached_clone(NULL, clone); } Memcache(const Memcache &rhs) - : - memc(), - result() { - memcached_clone(&memc, const_cast(&rhs.getImpl())); + memc= memcached_clone(NULL, rhs.getImpl()); } - ~Memcache() + Memcache &operator=(const Memcache &rhs) { - memcached_free(&memc); + if (this != &rhs) + { + memcached_free(memc); + memc= memcached_clone(NULL, rhs.getImpl()); + } + + return *this; } - /** - * Get the internal memcached_st * - */ - memcached_st &getImpl() + ~Memcache() { - return memc; + memcached_free(memc); } /** * Get the internal memcached_st * */ - const memcached_st &getImpl() const + const memcached_st *getImpl() const { return memc; } @@ -83,15 +89,75 @@ public: /** * Return an error string for the given return structure. * - * @param[in] rc a memcached_return structure + * @param[in] rc a memcached_return_t structure * @return error string corresponding to given return code in the library. */ - const std::string getError(memcached_return rc) const + const std::string getError(memcached_return_t rc) const { /* first parameter to strerror is unused */ return memcached_strerror(NULL, rc); } + + bool setBehavior(memcached_behavior_t flag, uint64_t data) + { + return (memcached_success(memcached_behavior_set(memc, flag, data))); + } + + uint64_t getBehavior(memcached_behavior_t flag) + { + return memcached_behavior_get(memc, flag); + } + + /** + * Configure the memcache object + * + * @param[in] in_config configuration + * @return true on success; false otherwise + */ + bool configure(const std::string &configuration) + { + return (memcached_success(memcached_parse_configuration(memc, configuration.c_str(), configuration.size()))); + } + + /** + * Add a server to the list of memcached servers to use. + * + * @param[in] server_name name of the server to add + * @param[in] port port number of server to add + * @return true on success; false otherwise + */ + bool addServer(const std::string &server_name, in_port_t port) + { + memcached_return_t rc; + + rc= memcached_server_add(memc, server_name.c_str(), port); + + return (rc == MEMCACHED_SUCCESS); + } + + /** + * Remove a server from the list of memcached servers to use. + * + * @param[in] server_name name of the server to remove + * @param[in] port port number of server to remove + * @return true on success; false otherwise + */ + bool removeServer(const std::string &server_name, in_port_t port) + { + std::string tmp_str; + std::ostringstream strstm; + tmp_str.append(","); + tmp_str.append(server_name); + tmp_str.append(":"); + strstm << port; + tmp_str.append(strstm.str()); + + //memcached_return_t rc= memcached_server_remove(server); + + return false; + } + /** * Fetches an individual value from the server. mget() must always * be called before using this method. @@ -100,22 +166,28 @@ public: * @param[out] ret_val store returned object in this vector * @return a memcached return structure */ - memcached_return fetch(std::string &key, + memcached_return_t fetch(std::string &key, std::vector &ret_val) { char ret_key[MEMCACHED_MAX_KEY]; size_t value_length= 0; size_t key_length= 0; - memcached_return rc; + memcached_return_t rc; uint32_t flags= 0; - char *value= memcached_fetch(&memc, ret_key, &key_length, + char *value= memcached_fetch(memc, ret_key, &key_length, &value_length, &flags, &rc); if (value && ret_val.empty()) { ret_val.reserve(value_length); ret_val.assign(value, value + value_length); - key.assign(ret_key); + key.assign(ret_key, key_length); + free(value); + } + else if (value) + { + free(value); } + return rc; } @@ -127,23 +199,19 @@ public: * this vector * @return true on success; false otherwise */ - bool get(const std::string &key, - std::vector &ret_val) throw (Error) + bool get(const std::string &key, std::vector &ret_val) { uint32_t flags= 0; - memcached_return rc; + memcached_return_t rc; size_t value_length= 0; - if (key.empty()) - { - throw(Error("the key supplied is empty!", false)); - } - char *value= memcached_get(&memc, key.c_str(), key.length(), + char *value= memcached_get(memc, key.c_str(), key.length(), &value_length, &flags, &rc); if (value != NULL && ret_val.empty()) { ret_val.reserve(value_length); ret_val.assign(value, value + value_length); + free(value); return true; } return false; @@ -152,7 +220,7 @@ public: /** * Fetches an individual from a server which is specified by * the master_key parameter that is used for determining which - * server an object was stored in if key partitioning was + * server an object was stored in if key partitioning was * used for storage. * * @param[in] master_key key that specifies server object is stored on @@ -161,19 +229,15 @@ public: * this vector * @return true on success; false otherwise */ - bool getByKey(const std::string &master_key, - const std::string &key, - std::vector &ret_val) throw(Error) + bool getByKey(const std::string &master_key, + const std::string &key, + std::vector &ret_val) { uint32_t flags= 0; - memcached_return rc; + memcached_return_t rc; size_t value_length= 0; - if (master_key.empty() || key.empty()) - { - throw(Error("the master key or key supplied is empty!", false)); - } - char *value= memcached_get_by_key(&memc, + char *value= memcached_get_by_key(memc, master_key.c_str(), master_key.length(), key.c_str(), key.length(), &value_length, &flags, &rc); @@ -181,6 +245,7 @@ public: { ret_val.reserve(value_length); ret_val.assign(value, value + value_length); + free(value); return true; } return false; @@ -216,13 +281,12 @@ public: } /* - * If the std::vector of keys is empty then we cannot + * 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()); + memcached_return_t rc= memcached_mget(memc, &real_keys[0], &key_len[0], real_keys.size()); return (rc == MEMCACHED_SUCCESS); } @@ -243,16 +307,12 @@ public: bool set(const std::string &key, const std::vector &value, time_t expiration, - uint32_t flags) throw(Error) + uint32_t flags) { - if (key.empty() || value.empty()) - { - throw(Error("the key or value supplied is empty!", false)); - } - memcached_return rc= memcached_set(&memc, - key.c_str(), key.length(), - &value[0], value.size(), - expiration, flags); + memcached_return_t rc= memcached_set(memc, + key.c_str(), key.length(), + &value[0], value.size(), + expiration, flags); return (rc == MEMCACHED_SUCCESS || rc == MEMCACHED_BUFFERED); } @@ -267,24 +327,18 @@ public: * @param[in] flags flags to store with the object * @return true on succcess; false otherwise */ - bool setByKey(const std::string &master_key, - const std::string &key, + bool setByKey(const std::string &master_key, + const std::string &key, const std::vector &value, time_t expiration, - uint32_t flags) throw(Error) - { - if (master_key.empty() || - key.empty() || - value.empty()) - { - 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(), - key.c_str(), key.length(), - &value[0], value.size(), - expiration, - flags); + uint32_t flags) + { + memcached_return_t rc= memcached_set_by_key(memc, master_key.c_str(), + master_key.length(), + key.c_str(), key.length(), + &value[0], value.size(), + expiration, + flags); return (rc == MEMCACHED_SUCCESS); } @@ -301,12 +355,8 @@ public: bool setAll(std::vector &keys, std::vector< std::vector *> &values, time_t expiration, - uint32_t flags) throw(Error) + uint32_t flags) { - if (keys.size() != values.size()) - { - throw(Error("The number of keys and values do not match!", false)); - } bool retval= true; std::vector::iterator key_it= keys.begin(); std::vector< std::vector *>::iterator val_it= values.begin(); @@ -334,24 +384,18 @@ public: */ bool setAll(std::map > &key_value_map, time_t expiration, - uint32_t flags) throw(Error) + uint32_t flags) { - if (key_value_map.empty()) - { - throw(Error("The key/values are not properly set!", false)); - } bool retval= true; - std::map >::iterator it= - key_value_map.begin(); + std::map >::iterator it= key_value_map.begin(); + while (it != key_value_map.end()) { retval= set(it->first, it->second, expiration, flags); if (retval == 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)); + // We should tell the user what the key that failed was + return false; } ++it; } @@ -368,14 +412,10 @@ 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) throw(Error) + bool increment(const std::string &key, uint32_t offset, uint64_t *value) { - if (key.empty()) - { - throw(Error("the key supplied is empty!", false)); - } - memcached_return rc= memcached_increment(&memc, key.c_str(), key.length(), - offset, value); + memcached_return_t rc= memcached_increment(memc, key.c_str(), key.length(), + offset, value); return (rc == MEMCACHED_SUCCESS); } @@ -390,15 +430,10 @@ public: * @return true on success; false otherwise */ bool decrement(const std::string &key, uint32_t offset, uint64_t *value) - throw(Error) { - if (key.empty()) - { - throw(Error("the key supplied is empty!", false)); - } - memcached_return rc= memcached_decrement(&memc, key.c_str(), - key.length(), - offset, value); + memcached_return_t rc= memcached_decrement(memc, key.c_str(), + key.length(), + offset, value); return (rc == MEMCACHED_SUCCESS); } @@ -412,14 +447,9 @@ public: * @return true on success; false otherwise */ bool add(const std::string &key, const std::vector &value) - throw(Error) { - if (key.empty() || value.empty()) - { - 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); + memcached_return_t rc= memcached_add(memc, key.c_str(), key.length(), + &value[0], value.size(), 0, 0); return (rc == MEMCACHED_SUCCESS); } @@ -433,24 +463,18 @@ public: * @param[in] value of object to add * @return true on success; false otherwise */ - bool addByKey(const std::string &master_key, - const std::string &key, - const std::vector &value) throw(Error) - { - if (master_key.empty() || - key.empty() || - value.empty()) - { - throw(Error("the master key or key supplied is empty!", false)); - } - memcached_return rc= memcached_add_by_key(&memc, - master_key.c_str(), - master_key.length(), - key.c_str(), - key.length(), - &value[0], - value.size(), - 0, 0); + bool addByKey(const std::string &master_key, + const std::string &key, + const std::vector &value) + { + memcached_return_t rc= memcached_add_by_key(memc, + master_key.c_str(), + master_key.length(), + key.c_str(), + key.length(), + &value[0], + value.size(), + 0, 0); return (rc == MEMCACHED_SUCCESS); } @@ -462,16 +486,11 @@ public: * @param[in[ value value to replace object with * @return true on success; false otherwise */ - bool replace(const std::string &key, const std::vector &value) throw(Error) + bool replace(const std::string &key, const std::vector &value) { - if (key.empty() || - value.empty()) - { - 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(), - 0, 0); + memcached_return_t rc= memcached_replace(memc, key.c_str(), key.length(), + &value[0], value.size(), + 0, 0); return (rc == MEMCACHED_SUCCESS); } @@ -485,24 +504,18 @@ public: * @param[in[ value value to replace object with * @return true on success; false otherwise */ - bool replaceByKey(const std::string &master_key, - const std::string &key, + bool replaceByKey(const std::string &master_key, + const std::string &key, const std::vector &value) { - if (master_key.empty() || - key.empty() || - value.empty()) - { - throw(Error("the master key or key supplied is empty!", false)); - } - memcached_return rc= memcached_replace_by_key(&memc, - master_key.c_str(), - master_key.length(), - key.c_str(), - key.length(), - &value[0], - value.size(), - 0, 0); + memcached_return_t rc= memcached_replace_by_key(memc, + master_key.c_str(), + master_key.length(), + key.c_str(), + key.length(), + &value[0], + value.size(), + 0, 0); return (rc == MEMCACHED_SUCCESS); } @@ -514,14 +527,9 @@ public: * @return true on success; false otherwise */ bool prepend(const std::string &key, const std::vector &value) - throw(Error) { - if (key.empty() || value.empty()) - { - 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); + memcached_return_t rc= memcached_prepend(memc, key.c_str(), key.length(), + &value[0], value.size(), 0, 0); return (rc == MEMCACHED_SUCCESS); } @@ -535,26 +543,19 @@ public: * @param[in] value data to prepend to object's value * @return true on success; false otherwise */ - bool prependByKey(const std::string &master_key, - const std::string &key, + bool prependByKey(const std::string &master_key, + const std::string &key, const std::vector &value) - throw(Error) { - if (master_key.empty() || - key.empty() || - value.empty()) - { - throw(Error("the master key or key supplied is empty!", false)); - } - memcached_return rc= memcached_prepend_by_key(&memc, - master_key.c_str(), - master_key.length(), - key.c_str(), - key.length(), - &value[0], - value.size(), - 0, - 0); + memcached_return_t rc= memcached_prepend_by_key(memc, + master_key.c_str(), + master_key.length(), + key.c_str(), + key.length(), + &value[0], + value.size(), + 0, + 0); return (rc == MEMCACHED_SUCCESS); } @@ -566,18 +567,13 @@ public: * @return true on success; false otherwise */ bool append(const std::string &key, const std::vector &value) - throw(Error) { - if (key.empty() || value.empty()) - { - throw(Error("the key or value supplied is empty!", false)); - } - memcached_return rc= memcached_append(&memc, - key.c_str(), - key.length(), - &value[0], - value.size(), - 0, 0); + memcached_return_t rc= memcached_append(memc, + key.c_str(), + key.length(), + &value[0], + value.size(), + 0, 0); return (rc == MEMCACHED_SUCCESS); } @@ -594,22 +590,15 @@ public: bool appendByKey(const std::string &master_key, const std::string &key, const std::vector &value) - throw(Error) { - if (master_key.empty() || - key.empty() || - value.empty()) - { - throw(Error("the master key or key supplied is empty!", false)); - } - memcached_return rc= memcached_append_by_key(&memc, - master_key.c_str(), - master_key.length(), - key.c_str(), - key.length(), - &value[0], - value.size(), - 0, 0); + memcached_return_t rc= memcached_append_by_key(memc, + master_key.c_str(), + master_key.length(), + key.c_str(), + key.length(), + &value[0], + value.size(), + 0, 0); return (rc == MEMCACHED_SUCCESS); } @@ -621,17 +610,13 @@ public: * @param[in] value value to store for object in server * @param[in] cas_arg "cas" value */ - bool cas(const std::string &key, - const std::vector &value, - uint64_t cas_arg) throw(Error) + bool cas(const std::string &key, + const std::vector &value, + uint64_t cas_arg) { - if (key.empty() || value.empty()) - { - 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(), - 0, 0, cas_arg); + memcached_return_t rc= memcached_cas(memc, key.c_str(), key.length(), + &value[0], value.size(), + 0, 0, cas_arg); return (rc == MEMCACHED_SUCCESS); } @@ -645,25 +630,19 @@ public: * @param[in] value value to store for object in server * @param[in] cas_arg "cas" value */ - bool casByKey(const std::string &master_key, - const std::string &key, - const std::vector &value, - uint64_t cas_arg) throw(Error) - { - if (master_key.empty() || - key.empty() || - value.empty()) - { - throw(Error("the master key, key or value supplied is empty!", false)); - } - memcached_return rc= memcached_cas_by_key(&memc, - master_key.c_str(), - master_key.length(), - key.c_str(), - key.length(), - &value[0], - value.size(), - 0, 0, cas_arg); + bool casByKey(const std::string &master_key, + const std::string &key, + const std::vector &value, + uint64_t cas_arg) + { + memcached_return_t rc= memcached_cas_by_key(memc, + master_key.c_str(), + master_key.length(), + key.c_str(), + key.length(), + &value[0], + value.size(), + 0, 0, cas_arg); return (rc == MEMCACHED_SUCCESS); } @@ -673,13 +652,9 @@ public: * @param[in] key key of object to delete * @return true on success; false otherwise */ - bool remove(const std::string &key) throw(Error) + bool remove(const std::string &key) { - if (key.empty()) - { - throw(Error("the key supplied is empty!", false)); - } - memcached_return rc= memcached_delete(&memc, key.c_str(), key.length(), 0); + memcached_return_t rc= memcached_delete(memc, key.c_str(), key.length(), 0); return (rc == MEMCACHED_SUCCESS); } @@ -690,65 +665,52 @@ public: * @param[in] expiration time to delete the object after * @return true on success; false otherwise */ - bool remove(const std::string &key, - time_t expiration) throw(Error) + bool remove(const std::string &key, time_t expiration) { - if (key.empty()) - { - throw(Error("the key supplied is empty!", false)); - } - memcached_return rc= memcached_delete(&memc, - key.c_str(), - key.length(), - expiration); + memcached_return_t rc= memcached_delete(memc, + key.c_str(), + key.length(), + expiration); return (rc == MEMCACHED_SUCCESS); } /** - * Delete an object from the server specified by the key given. + * Delete an object from the server specified by the key given. * * @param[in] master_key specifies server to remove object from * @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) throw(Error) - { - if (master_key.empty() || key.empty()) - { - throw(Error("the master key or key supplied is empty!", false)); - } - memcached_return rc= memcached_delete_by_key(&memc, - master_key.c_str(), - master_key.length(), - key.c_str(), - key.length(), - 0); + const std::string &key) + { + memcached_return_t rc= memcached_delete_by_key(memc, + master_key.c_str(), + master_key.length(), + key.c_str(), + key.length(), + 0); return (rc == MEMCACHED_SUCCESS); } /** - * Delete an object from the server specified by the key given. + * Delete an object from the server specified by the key given. * * @param[in] master_key specifies server to remove object from * @param[in] key key of object to delete * @param[in] expiration time to delete the object after * @return true on success; false otherwise */ - bool removeByKey(const std::string &master_key, + bool removeByKey(const std::string &master_key, const std::string &key, - time_t expiration) throw(Error) - { - if (master_key.empty() || key.empty()) - { - throw(Error("the master key or key supplied is empty!", false)); - } - memcached_return rc= memcached_delete_by_key(&memc, - master_key.c_str(), - master_key.length(), - key.c_str(), - key.length(), - expiration); + time_t expiration) + { + memcached_return_t rc= memcached_delete_by_key(memc, + master_key.c_str(), + master_key.length(), + key.c_str(), + key.length(), + expiration); return (rc == MEMCACHED_SUCCESS); } @@ -761,28 +723,7 @@ public: */ bool flush(time_t expiration) { - memcached_return rc= memcached_flush(&memc, expiration); - return (rc == MEMCACHED_SUCCESS); - } - - /** - * Callback function for result sets. It passes the result - * sets to the list of functions provided. - * - * @param[in] callback list of callback functions - * @param[in] context pointer to memory reference that is - * supplied to the calling function - * @param[in] num_of_callbacks number of callback functions - * @return true on success; false otherwise - */ - bool fetchExecute(memcached_execute_function *callback, - void *context, - unsigned int num_of_callbacks) - { - memcached_return rc= memcached_fetch_execute(&memc, - callback, - context, - num_of_callbacks); + memcached_return_t rc= memcached_flush(memc, expiration); return (rc == MEMCACHED_SUCCESS); } @@ -797,12 +738,64 @@ public: return version; } -private: + /** + * Retrieve memcached statistics. Populate a std::map with the retrieved + * stats. Each server will map to another std::map of the key:value stats. + * + * @param[out] stats_map a std::map to be populated with the memcached + * stats + * @return true on success; false otherwise + */ + bool getStats(std::map< std::string, std::map > + &stats_map) + { + memcached_return_t rc; + memcached_stat_st *stats= memcached_stat(memc, NULL, &rc); - memcached_st memc; - memcached_result_st result; + if (rc != MEMCACHED_SUCCESS && + rc != MEMCACHED_SOME_ERRORS) + { + return false; + } + + uint32_t server_count= memcached_server_count(memc); + + /* + * For each memcached server, construct a std::map for its stats and add + * it to the std::map of overall stats. + */ + for (uint32_t x= 0; x < server_count; x++) + { + memcached_server_instance_st instance= + memcached_server_instance_by_position(memc, x); + std::ostringstream strstm; + std::string server_name(memcached_server_name(instance)); + server_name.append(":"); + strstm << memcached_server_port(instance); + server_name.append(strstm.str()); + + std::map server_stats; + char **list= NULL; + char **ptr= NULL; + + list= memcached_stat_get_keys(memc, &stats[x], &rc); + for (ptr= list; *ptr; ptr++) + { + char *value= memcached_stat_get_value(memc, &stats[x], *ptr, &rc); + server_stats[*ptr]= value; + free(value); + } + + stats_map[server_name]= server_stats; + free(list); + } + + memcached_stat_free(memc, stats); + return true; + } + +private: + memcached_st *memc; }; } - -#endif /* LIBMEMCACHEDPP_H */