X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=libmemcached.html;h=d85404b71d35681412cc3b449b269066d0cdd5b6;hb=5fe34bb79f817fe734d3e300720ac8a361454f39;hp=f5dc67a46f6a53014226b332ead244cf4af52526;hpb=357fb245dde952b47f190c7eff413fc5017c2049;p=awesomized%2Flibmemcached diff --git a/libmemcached.html b/libmemcached.html index f5dc67a4..d85404b7 100644 --- a/libmemcached.html +++ b/libmemcached.html @@ -21,10 +21,10 @@ - - - - + + + + @@ -174,9 +174,9 @@

C/C++ Client Library for memcached¶

SYNOPSIS¶

-
-
#include <libmemcached/memcached.h>

Compile and link with -lmemcached

-
+
+
#include <libmemcached/memcached.h>
+
Compile and link with -lmemcached

libmemcached is an open source C/C++ client library and tools for the @@ -185,37 +185,35 @@ memory usage, thread safe, and provide full access to server side methods.

libmemcached was designed to provide the greatest number of options to use Memcached. Some of the features provided:

    -
  1. Asynchronous and Synchronous Transport Support.

  2. -
  3. Consistent Hashing and Distribution.

  4. -
  5. Tunable Hashing algorithm to match keys.

  6. -
  7. Access to large object support.

  8. -
  9. Local replication.

  10. -
  11. A complete reference guide and documentation to the API.

  12. -
  13. Tools to Manage your Memcached networks.

  14. +
  15. Asynchronous and Synchronous Transport Support.
  16. +
  17. Consistent Hashing and Distribution.
  18. +
  19. Tunable Hashing algorithm to match keys.
  20. +
  21. Access to large object support.
  22. +
  23. Local replication.
  24. +
  25. A complete reference guide and documentation to the API.
  26. +
  27. Tools to Manage your Memcached networks.

DESCRIPTION¶

-

“Memcached is a high-performance, distributed memory object caching -system, generic in nature, but intended for use in speeding up dynamic web -applications by alleviating database load.” -http://memcached.org/

-

libmemcached is a small, thread-safe client library for the -memcached protocol. The code has all been written to allow -for both web and embedded usage. It handles the work behind routing -individual keys to specific servers specified by the developer (and values are -matched based on server order as supplied by the user). It implements -a modular and consistent method of object distribution.

+

"Memcached is a high-performance, distributed memory object caching system, +generic in nature, but intended for use in speeding up dynamic web applications +by alleviating database load." http://memcached.org/

+

libmemcached is a small, thread-safe client library for the memcached +protocol. The code has all been written to allow for both web and embedded +usage. It handles the work behind routing individual keys to specific servers +specified by the developer (and values are matched based on server order as +supplied by the user). It implements a modular and consistent method of object +distribution.

There are multiple implemented routing and hashing methods. See the -memcached_behavior_set() manpage for more information.

-

All operations are performed against a memcached_st structure. -These structures can either be dynamically allocated or statically -allocated and then initialized by memcached_create(). Functions have -been written in order to encapsulate the memcached_st. It is not -recommended that you operate directly against the structure.

-

Nearly all functions return a memcached_return_t value. -This value can be translated to a printable string with -memcached_strerror.

+memcached_behavior_set() manpage for more information.

+

All operations are performed against a memcached_st structure. These +structures can either be dynamically allocated or statically allocated and then +initialized by memcached_create(). Functions have been written in order to +encapsulate the memcached_st. It is not recommended that you operate directly +against the structure.

+

Nearly all functions return a memcached_return_t value. This value can be +translated to a printable string with memcached_strerror().

Objects are stored on servers by hashing keys. The hash value maps the key to a particular server. All clients understand how this hashing works, so it is possibly to reliably both push data to a server and retrieve data from a server.

@@ -224,61 +222,55 @@ possibly to reliably both push data to a server and retrieve data from a server. applications can use the same memcached servers.

Some features of the library must be enabled through memcached_behavior_set().

-
-

CONSTANTS¶

-

A number of constants have been provided for in the library.

-

See libmemcached Constants and Defaults.

-

THREADS AND PROCESSES¶

No global variables are used in this library.

-

memcached_st structures are thread-safe, but when using threads or -forked processes it is important to keep one instance of memcached_st -per process or thread. Without creating your own locking structures you can not -share a single memcached_st. However, you can call -memcached_quit() on a memcached_st and then use the resulting -cloned structure.

+

memcached_st structures are thread-safe, but when using threads or forked +processes it is important to keep one instance of memcached_st per process or +thread. Without creating your own locking structures you can not share a single +memcached_st. However, you can call memcached_quit() on a memcached_st and +then use the resulting cloned structure.

SYSTEMTAP¶

libmemcached can be built to support Systemtap on Linux when enabled at compile time.

-

Please see stap(1) and dtrace(1) for more information +

Please see stap(1) and dtrace(1) for more information about Systemtap.

CLIENT PROGRAMS¶

libmemcached comes with a few useful client programs:

UTILITY LIBRARIES¶

SEE ALSO¶