/usr/include/libmemcached/memcached.hpp is in libmemcached-dev 0.44-1.1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 | /*
* Summary: C++ interface for memcached server
*
* Copy: See Copyright for the status of this software.
*
* Authors: Padraig O'Sullivan <osullivan.padraig@gmail.com>
* Patrick Galbraith <patg@patg.net>
*/
/**
* @file memcached.hpp
* @brief Libmemcached C++ interface
*/
#ifndef LIBMEMCACHEDPP_H
#define LIBMEMCACHEDPP_H
#include <libmemcached/memcached.h>
#include <libmemcached/exception.hpp>
#include <string.h>
#include <sstream>
#include <string>
#include <vector>
#include <map>
namespace memcache
{
/**
* This is the core memcached library (if later, other objects
* are needed, they will be created from this class).
*/
class Memcache
{
public:
Memcache()
:
servers_list(),
memc(),
result()
{
memcached_create(&memc);
}
Memcache(const std::string &in_servers_list)
:
servers_list(in_servers_list),
memc(),
result()
{
memcached_create(&memc);
init();
}
Memcache(const std::string &hostname,
in_port_t port)
:
servers_list(),
memc(),
result()
{
memcached_create(&memc);
servers_list.append(hostname);
servers_list.append(":");
std::ostringstream strsmt;
strsmt << port;
servers_list.append(strsmt.str());
init();
}
Memcache(memcached_st *clone)
:
servers_list(),
memc(),
result()
{
memcached_clone(&memc, clone);
}
Memcache(const Memcache &rhs)
:
servers_list(rhs.servers_list),
memc(),
result()
{
memcached_clone(&memc, const_cast<memcached_st *>(&rhs.getImpl()));
init();
}
Memcache &operator=(const Memcache &rhs)
{
if (this != &rhs)
{
memcached_clone(&memc, const_cast<memcached_st *>(&rhs.getImpl()));
init();
}
return *this;
}
~Memcache()
{
memcached_free(&memc);
}
void init()
{
memcached_server_st *servers;
servers= memcached_servers_parse(servers_list.c_str());
memcached_server_push(&memc, servers);
memcached_server_free(servers);
}
/**
* Get the internal memcached_st *
*/
memcached_st &getImpl()
{
return memc;
}
/**
* Get the internal memcached_st *
*/
const memcached_st &getImpl() const
{
return memc;
}
/**
* Return an error string for the given 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_t rc) const
{
/* first parameter to strerror is unused */
return memcached_strerror(NULL, rc);
}
bool setBehavior(memcached_behavior_t flag, uint64_t data)
{
memcached_return_t rc;
rc= memcached_behavior_set(&memc, flag, data);
return (rc == MEMCACHED_SUCCESS);
}
uint64_t getBehavior(memcached_behavior_t flag) {
return memcached_behavior_get(&memc, flag);
}
/**
* Return the string which contains the list of memcached servers being
* used.
*
* @return a std::string containing the list of memcached servers
*/
const std::string getServersList() const
{
return servers_list;
}
/**
* Set the list of memcached servers to use.
*
* @param[in] in_servers_list list of servers
* @return true on success; false otherwise
*/
bool setServers(const std::string &in_servers_list)
{
servers_list.assign(in_servers_list);
init();
return (memcached_server_count(&memc));
}
/**
* 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.
*
* @param[in] key key of object to fetch
* @param[out] ret_val store returned object in this vector
* @return a memcached return structure
*/
memcached_return_t fetch(std::string &key,
std::vector<char> &ret_val)
{
char ret_key[MEMCACHED_MAX_KEY];
size_t value_length= 0;
size_t key_length= 0;
memcached_return_t rc;
uint32_t flags= 0;
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);
free(value);
}
else if (value)
{
free(value);
}
return rc;
}
/**
* Fetches an individual value from the server.
*
* @param[in] key key of object whose value to get
* @param[out] ret_val object that is retrieved is stored in
* this vector
* @return true on success; false otherwise
*/
bool get(const std::string &key,
std::vector<char> &ret_val) throw (Error)
{
uint32_t flags= 0;
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(),
&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;
}
/**
* 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
* used for storage.
*
* @param[in] master_key key that specifies server object is stored on
* @param[in] key key of object whose value to get
* @param[out] ret_val object that is retrieved is stored in
* this vector
* @return true on success; false otherwise
*/
bool getByKey(const std::string &master_key,
const std::string &key,
std::vector<char> &ret_val) throw(Error)
{
uint32_t flags= 0;
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,
master_key.c_str(), master_key.length(),
key.c_str(), key.length(),
&value_length, &flags, &rc);
if (value)
{
ret_val.reserve(value_length);
ret_val.assign(value, value + value_length);
free(value);
return true;
}
return false;
}
/**
* Selects multiple keys at once. This method always
* works asynchronously.
*
* @param[in] keys vector of keys to select
* @return true if all keys are found
*/
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;
}
/*
* 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_t rc= memcached_mget(&memc, &real_keys[0], &key_len[0],
real_keys.size());
return (rc == MEMCACHED_SUCCESS);
}
return false;
}
/**
* Writes an object to the server. If the object already exists, it will
* overwrite the existing object. This method always returns true
* when using non-blocking mode unless a network error occurs.
*
* @param[in] key key of object to write to server
* @param[in] value value of object to write to server
* @param[in] expiration time to keep the object stored in the server for
* @param[in] flags flags to store with the object
* @return true on succcess; false otherwise
*/
bool set(const std::string &key,
const std::vector<char> &value,
time_t expiration,
uint32_t flags) throw(Error)
{
if (key.empty() || value.empty())
{
throw(Error("the key or value supplied is empty!", false));
}
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);
}
/**
* Writes an object to a server specified by the master_key parameter.
* If the object already exists, it will overwrite the existing object.
*
* @param[in] master_key key that specifies server to write to
* @param[in] key key of object to write to server
* @param[in] value value of object to write to server
* @param[in] expiration time to keep the object stored in the server for
* @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,
const std::vector<char> &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_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);
}
/**
* Writes a list of objects to the server. Objects are specified by
* 2 vectors - 1 vector of keys and 1 vector of values.
*
* @param[in] keys vector of keys of objects to write to server
* @param[in] values vector of values of objects to write to server
* @param[in] expiration time to keep the objects stored in server for
* @param[in] flags flags to store with the objects
* @return true on success; false otherwise
*/
bool setAll(std::vector<std::string> &keys,
std::vector< std::vector<char> *> &values,
time_t expiration,
uint32_t flags) throw(Error)
{
if (keys.size() != values.size())
{
throw(Error("The number of keys and values do not match!", 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;
}
/**
* Writes a list of objects to the server. Objects are specified by
* a map of keys to values.
*
* @param[in] key_value_map map of keys and values to store in server
* @param[in] expiration time to keep the objects stored in server for
* @param[in] flags flags to store with the objects
* @return true on success; false otherwise
*/
bool setAll(std::map<const std::string, std::vector<char> > &key_value_map,
time_t expiration,
uint32_t flags) throw(Error)
{
if (key_value_map.empty())
{
throw(Error("The key/values are not properly set!", false));
}
bool retval= true;
std::map<const std::string, std::vector<char> >::iterator it=
key_value_map.begin();
while (it != key_value_map.end())
{
retval= set(it->first, it->second, expiration, flags);
if (retval == false)
{
std::string err_buff("There was an error setting the key ");
err_buff.append(it->first);
throw(Error(err_buff, false));
}
++it;
}
return true;
}
/**
* Increment the value of the object associated with the specified
* key by the offset given. The resulting value is saved in the value
* parameter.
*
* @param[in] key key of object in server whose value to increment
* @param[in] offset amount to increment object's value by
* @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)
{
if (key.empty())
{
throw(Error("the key supplied is empty!", false));
}
memcached_return_t rc= memcached_increment(&memc, key.c_str(), key.length(),
offset, value);
return (rc == MEMCACHED_SUCCESS);
}
/**
* Decrement the value of the object associated with the specified
* key by the offset given. The resulting value is saved in the value
* parameter.
*
* @param[in] key key of object in server whose value to decrement
* @param[in] offset amount to increment object's value by
* @param[out] value store the result of the decrement here
* @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_t rc= memcached_decrement(&memc, key.c_str(),
key.length(),
offset, value);
return (rc == MEMCACHED_SUCCESS);
}
/**
* Add an object with the specified key and value to the server. This
* function returns false if the object already exists on the server.
*
* @param[in] key key of object to add
* @param[in] value of object to add
* @return true on success; false otherwise
*/
bool add(const std::string &key, const std::vector<char> &value)
throw(Error)
{
if (key.empty() || value.empty())
{
throw(Error("the key or value supplied is empty!", false));
}
memcached_return_t rc= memcached_add(&memc, key.c_str(), key.length(),
&value[0], value.size(), 0, 0);
return (rc == MEMCACHED_SUCCESS);
}
/**
* Add an object with the specified key and value to the server. This
* function returns false if the object already exists on the server. The
* server to add the object to is specified by the master_key parameter.
*
* @param[in[ master_key key of server to add object to
* @param[in] key key of object to add
* @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<char> &value) throw(Error)
{
if (master_key.empty() ||
key.empty() ||
value.empty())
{
throw(Error("the master key or key supplied is empty!", false));
}
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);
}
/**
* Replaces an object on the server. This method only succeeds
* if the object is already present on the server.
*
* @param[in] key key of object to replace
* @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) throw(Error)
{
if (key.empty() ||
value.empty())
{
throw(Error("the key or value supplied is empty!", false));
}
memcached_return_t rc= memcached_replace(&memc, key.c_str(), key.length(),
&value[0], value.size(),
0, 0);
return (rc == MEMCACHED_SUCCESS);
}
/**
* Replaces an object on the server. This method only succeeds
* if the object is already present on the server. The server
* to replace the object on is specified by the master_key param.
*
* @param[in] master_key key of server to replace object on
* @param[in] key key of object to replace
* @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,
const std::vector<char> &value)
{
if (master_key.empty() ||
key.empty() ||
value.empty())
{
throw(Error("the master key or key supplied is empty!", false));
}
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);
}
/**
* Places a segment of data before the last piece of data stored.
*
* @param[in] key key of object whose value we will prepend data to
* @param[in] value data to prepend to object's value
* @return true on success; false otherwise
*/
bool prepend(const std::string &key, const std::vector<char> &value)
throw(Error)
{
if (key.empty() || value.empty())
{
throw(Error("the key or value supplied is empty!", false));
}
memcached_return_t rc= memcached_prepend(&memc, key.c_str(), key.length(),
&value[0], value.size(), 0, 0);
return (rc == MEMCACHED_SUCCESS);
}
/**
* Places a segment of data before the last piece of data stored. The
* server on which the object where we will be prepending data is stored
* on is specified by the master_key parameter.
*
* @param[in] master_key key of server where object is stored
* @param[in] key key of object whose value we will prepend data to
* @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,
const std::vector<char> &value)
throw(Error)
{
if (master_key.empty() ||
key.empty() ||
value.empty())
{
throw(Error("the master key or key supplied is empty!", false));
}
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);
}
/**
* Places a segment of data at the end of the last piece of data stored.
*
* @param[in] key key of object whose value we will append data to
* @param[in] value data to append to object's value
* @return true on success; false otherwise
*/
bool append(const std::string &key, const std::vector<char> &value)
throw(Error)
{
if (key.empty() || value.empty())
{
throw(Error("the key or value supplied is empty!", false));
}
memcached_return_t rc= memcached_append(&memc,
key.c_str(),
key.length(),
&value[0],
value.size(),
0, 0);
return (rc == MEMCACHED_SUCCESS);
}
/**
* Places a segment of data at the end of the last piece of data stored. The
* server on which the object where we will be appending data is stored
* on is specified by the master_key parameter.
*
* @param[in] master_key key of server where object is stored
* @param[in] key key of object whose value we will append data to
* @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,
const std::vector<char> &value)
throw(Error)
{
if (master_key.empty() ||
key.empty() ||
value.empty())
{
throw(Error("the master key or key supplied is empty!", false));
}
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);
}
/**
* Overwrite data in the server as long as the cas_arg value
* is still the same in the server.
*
* @param[in] key key of object in server
* @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<char> &value,
uint64_t cas_arg) throw(Error)
{
if (key.empty() || value.empty())
{
throw(Error("the key or value supplied is empty!", false));
}
memcached_return_t rc= memcached_cas(&memc, key.c_str(), key.length(),
&value[0], value.size(),
0, 0, cas_arg);
return (rc == MEMCACHED_SUCCESS);
}
/**
* Overwrite data in the server as long as the cas_arg value
* is still the same in the server. The server to use is
* specified by the master_key parameter.
*
* @param[in] master_key specifies server to operate on
* @param[in] key key of object in server
* @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<char> &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_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);
}
/**
* Delete an object from the server specified by the key given.
*
* @param[in] key key of object to delete
* @return true on success; false otherwise
*/
bool remove(const std::string &key) throw(Error)
{
if (key.empty())
{
throw(Error("the key supplied is empty!", false));
}
memcached_return_t rc= memcached_delete(&memc, key.c_str(), key.length(), 0);
return (rc == MEMCACHED_SUCCESS);
}
/**
* Delete an object from the server specified by the key given.
*
* @param[in] key key of object to delete
* @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)
{
if (key.empty())
{
throw(Error("the key supplied is empty!", false));
}
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.
*
* @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_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.
*
* @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,
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_t rc= memcached_delete_by_key(&memc,
master_key.c_str(),
master_key.length(),
key.c_str(),
key.length(),
expiration);
return (rc == MEMCACHED_SUCCESS);
}
/**
* Wipe the contents of memcached servers.
*
* @param[in] expiration time to wait until wiping contents of
* memcached servers
* @return true on success; false otherwise
*/
bool flush(time_t expiration)
{
memcached_return_t 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_fn *callback,
void *context,
uint32_t num_of_callbacks)
{
memcached_return_t rc= memcached_fetch_execute(&memc,
callback,
context,
num_of_callbacks);
return (rc == MEMCACHED_SUCCESS);
}
/**
* Get the library version string.
* @return std::string containing a copy of the library version string.
*/
const std::string libVersion() const
{
const char *ver= memcached_lib_version();
const std::string version(ver);
return version;
}
/**
* 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<std::string, std::string> >
&stats_map)
{
memcached_return_t rc;
memcached_stat_st *stats= memcached_stat(&memc, NULL, &rc);
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<std::string, std::string> 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:
std::string servers_list;
memcached_st memc;
memcached_result_st result;
};
}
#endif /* LIBMEMCACHEDPP_H */
|