memcached 1.2.6 → 1.2.7

data/ext/libmemcached-0.32/docs/memcached_memory_allocators.pod

@@ -0,0 +1,73 @@
+=head1 NAME
+
+memcached_set_memory_allocators, memcached_get_memory_allocators - Manage memory allocator functions
+
+=head1 LIBRARY
+
+C Client Library for memcached (libmemcached, -lmemcached)
+
+=head1 SYNOPSIS
+
+  #include <memcached.h>
+
+  memcached_return 
+    memcached_set_memory_allocators(memcached_st *ptr,
+                                    memcached_malloc_function mem_malloc,
+                                    memcached_free_function mem_free,
+                                    memcached_realloc_function mem_realloc,
+                                    memcached_calloc_function mem_calloc);
+
+  void memcached_get_memory_allocators(memcached_st *ptr,
+                                       memcached_malloc_function *mem_malloc,
+                                       memcached_free_function *mem_free,
+                                       memcached_realloc_function *mem_realloc,
+                                       memcached_calloc_function *mem_calloc);
+
+  void *(*memcached_malloc_function)(memcached_st *ptr, const size_t size);
+  void *(*memcached_realloc_function)(memcached_st *ptr, void *mem, 
+                                      const size_t size);
+  void  (*memcached_free_function)(memcached_st *ptr, void *mem);
+  void *(*memcached_calloc_function)(memcached_st *ptr, size_t nelem, 
+                                     const size_t elsize);
+
+
+=head1 DESCRIPTION
+
+libmemcached(3) allows you to specify your own memory allocators optimized
+for your application.
+
+memcached_set_memory_allocators() is used to set the memory allocators used
+by the memcached instance specified by ptr. Please note that you cannot
+override only one of the memory allocators, you have to specify a complete
+new set if you want to override one of them. All of the memory allocation
+functions should behave as specified in the C99 standard. Specify NULL as
+all functions to reset them to the default values.
+
+memcached_get_memory_allocators() is used to get the currently used memory
+allocators by a mamcached handle.
+
+The first argument to the memory allocator functions is a pointer to a
+memcached structure, and you may use the memcached_set_user_data() and
+memcached_get_user_data() to store a user-specific value to each memcached
+structure.
+
+=head1 RETURN
+
+memcached_set_memory_allocators() return MEMCACHED_SUCCESS upon success, 
+and MEMCACHED_FAILURE if you don't pass a complete set of function pointers.
+
+=head1 HOME
+
+To find out more information please check:
+L<http://tangent.org/552/libmemcached.html>
+
+=head1 AUTHOR
+
+Trond Norbye, E<lt>trond.norbye@sun.comE<gt>
+
+=head1 SEE ALSO
+
+memcached(1) libmemcached(3) memcached_get_user_data(3) memcached_set_user_data(3)
+
+=cut
+

data/ext/libmemcached-0.32/docs/memcached_pool.pod

@@ -0,0 +1,77 @@
+=head1 NAME
+
+memcached_pool_create, memcached_pool_destroy, memcached_pool_push, memcached_pool_pop - Manage pools
+
+=head1 LIBRARY
+
+C Client Library for memcached (libmemcachedutil, -lmemcachedutil)
+
+=head1 SYNOPSIS
+
+  #include <libmemcached/memcached_pool.h>
+
+  memcached_pool_st *memcached_pool_create(memcached_st* mmc, int initial, int max);
+  memcached_st* memcached_pool_destroy(memcached_pool_st* pool);
+
+  memcached_st* memcached_pool_pop(memcached_pool_st* pool, bool block, memcached_return *rc);
+  memcached_return memcached_pool_push(memcached_pool_st* pool, memcached_st *mmc);
+
+  memcached_st *memcached_create (memcached_st *ptr);
+
+
+=head1 DESCRIPTION
+
+memcached_pool_create() is used to create a connection pool of objects you
+may use to remove the overhead of using memcached_clone for short
+lived C<memcached_st> objects. The mmc argument should be an
+initialised C<memcached_st> structure, and a successfull invocation of
+memcached_pool_create takes full ownership of the variable (until it
+is released by memcached_pool_destroy). The C<initial> argument
+specifies the initial size of the connection pool, and the C<max>
+argument specifies the maximum size the connection pool should grow
+to. Please note that the library will allocate a fixed size buffer
+scaled to the max size of the connection pool, so you should not pass
+MAXINT or some other large number here.
+
+memcached_pool_destroy() is used to destroy the connection pool
+created with memcached_pool_create() and release all allocated
+resources. It will return the pointer to the C<memcached_st> structure
+passed as an argument to memcached_pool_create(), and returns the
+ownership of the pointer to the caller.
+
+memcached_pool_pop() is used to grab a connection structure from the
+connection pool. The block argument specifies if the function should 
+block and wait for a connection structure to be available if we try
+to exceed the maximum size.
+
+memcached_pool_push() is used to return a connection structure back to the pool.
+
+=head1 RETURN
+
+memcached_pool_create() returns a pointer to the newly created
+memcached_pool_st structure. On an allocation failure, it returns
+NULL.
+
+memcached_pool_destroy() returns the pointer (and ownership) to the
+memcached_st structure used to create the pool. If connections are in
+use it returns NULL.
+
+memcached_pool_pop() returns a pointer to a memcached_st structure
+from the pool (or NULL if an allocation cannot be satisfied). 
+
+memcached_pool_push() returns MEMCACHED_SUCCESS upon success.
+
+=head1 HOME
+
+To find out more information please check:
+L<http://tangent.org/552/libmemcached.html>
+
+=head1 AUTHOR
+
+Trond Norbye, E<lt>trond.norbye@sun.comE<gt>
+
+=head1 SEE ALSO
+
+memcached(1) libmemcached(3) memcached_create(3) memcached_free(3) libmemcachedutil(3)
+
+=cut

data/ext/libmemcached-0.32/docs/memcached_quit.pod

@@ -0,0 +1,47 @@
+=head1 NAME
+
+memcached_quit - Disconnect from all servers
+
+=head1 LIBRARY
+
+C Client Library for memcached (libmemcached, -lmemcached)
+
+=head1 SYNOPSIS
+
+  #include <memcached.h>
+
+  void memcached_quit (memcached_st *ptr);
+
+=head1 DESCRIPTION
+
+memcached_quit() will disconnect you from all currently connected servers.
+It will also reset the state of the connection (ie, any memcached_fetch() you
+are in the middle of will be terminated). This function is called
+automatically when you call memcached_free() on the C<memcached_st> structure.
+
+You do not need to call this on your own. All operations to change server
+hashes and parameters will handle connections to the server for you. This
+function is provided mainly so that you can timeout your connections or
+reset connections during the middle of a memcached_fetch().
+
+=head1 RETURN
+
+A value of type C<memcached_return> is returned
+On success that value will be C<MEMCACHED_SUCCESS>.
+Use memcached_strerror() to translate this value to a printable string.
+
+=head1 HOME
+
+To find out more information please check:
+L<http://tangent.org/552/libmemcached.html>
+
+=head1 AUTHOR
+
+Brian Aker, E<lt>brian@tangent.orgE<gt>
+
+=head1 SEE ALSO
+
+memcached(1) libmemcached(3) memcached_strerror(3)
+
+=cut
+

data/ext/libmemcached-0.32/docs/memcached_sasl.pod

@@ -0,0 +1,63 @@
+=head1 NAME
+
+memcached_set_sasl_callbacks, memcached_get_sasl_callbackss, memcached_get_sasl_set_auth_data - SASL support
+
+=head1 LIBRARY
+
+C Client Library for memcached (libmemcached, -lmemcached)
+
+=head1 SYNOPSIS
+
+  #include <memcached.h>
+
+  void memcached_set_sasl_callbacks(memcached_st *ptr,
+                                    const sasl_callback_t *callbacks)
+
+  const sasl_callback_t *memcached_get_sasl_callbacks(memcached_st *ptr)
+
+  memcached_return memcached_set_sasl_auth_data(memcached_st *ptr,
+                                                const char *username,
+                                                const char *password)
+  memcached_return memcached_destroy_sasl_auth_data(memcached_st *ptr)
+
+
+=head1 DESCRIPTION
+
+libmemcached(3) allows you to plug in your own callbacks function used by
+libsasl to perform SASL authentication.
+
+Please note that SASL requires the memcached binary protocol, and you have
+to specify the callbacks before you connect to the server.
+
+memcached_set_sasl_auth_data() is a helper function for you defining
+the basic functionality for you, but it will store the username and password
+in memory. If you choose to use this method you have to call
+memcached_destroy_sasl_auth_data before calling memcached_free to avoid
+a memory leak. You should NOT call memcached_destroy_sasl_auth_data if you
+specify your own callback function with memcached_set_sasl_callbacks().
+
+You as a client user have to initialize libsasl by using sasl_client_init
+before enabling it in libmemcached, and you have to shut down libsasl by
+calling sasl_done() when you are done using SASL from libmemcached.
+
+
+=head1 RETURN
+
+memcached_get_sasl_callbacks() returns the callbacks currently used
+by this memcached handle.
+memcached_get_sasl_set_auth_data() returns MEMCACHED_SUCCESS upon success.
+
+=head1 HOME
+
+To find out more information please check:
+L<http://tangent.org/552/libmemcached.html>
+
+=head1 AUTHOR
+
+Trond Norbye, E<lt>trond.norbye@sun.comE<gt>
+
+=head1 SEE ALSO
+
+memcached(1) libmemcached(3)
+
+=cut

data/ext/libmemcached-0.32/docs/memcached_server_st.pod

@@ -0,0 +1,75 @@
+=head1 NAME
+
+memcached_server_list_free, memcached_server_list_append,
+memcached_server_list_count, memcached_servers_parse - Manage server list
+
+=head1 LIBRARY
+
+C Client Library for memcached (libmemcached, -lmemcached)
+
+=head1 SYNOPSIS
+
+  #include <memcached.h>
+
+  void memcached_server_list_free (memcached_server_st *ptr);
+
+  memcached_server_st *
+    memcached_server_list_append (memcached_server_st *ptr, 
+                                  const char *hostname,
+                                  unsigned int port, 
+                                  memcached_return *error);
+
+  unsigned int memcached_server_list_count (memcached_server_st *ptr);
+
+  memcached_server_st *memcached_servers_parse (const char *server_strings);
+
+  const char *memcached_server_error(memcached_server_st *ptr);
+
+  void memcached_server_error_reset(memcached_server_st *ptr);
+
+=head1 DESCRIPTION
+
+libmemcached(3) operates on a list of hosts which are stored in
+memcached_server_st structures. You should not modify these structures
+directly. Functions are provided to modify these structures (and more can be
+added, just ask!).
+
+memcached_server_list_free() deallocates all memory associated with the array
+of memcached_server_st that you passed to it. 
+
+memcached_server_list_append() adds a server to the end of a
+memcached_server_st array. On error null will be returned and the
+memcached_return pointer you passed into the function will be set with the
+appropriate error. If the value of port is zero, it is set to the default
+port of a memcached server.
+
+memcached_servers_parse() takes a string, the type that is used for the
+command line applications, and parse it to an array of memcached_server_st.
+The example is "localhost, foo:555, foo, bar". All hosts except foo:555 will
+be set to the default port, while that host will have a port of 555.
+
+memcached_server_error() can be used to look at the text of the last error 
+message sent by the server to to the client. Use memcached_server_error_reset() 
+to reset the message (this does not currently free up the memory associated
+with the message).
+
+
+=head1 RETURN
+
+Varies, see particular functions.
+
+=head1 HOME
+
+To find out more information please check:
+L<http://tangent.org/552/libmemcached.html>
+
+=head1 AUTHOR
+
+Brian Aker, E<lt>brian@tangent.orgE<gt>
+
+=head1 SEE ALSO
+
+memcached(1) libmemcached(3) memcached_strerror(3)
+
+=cut
+

data/ext/libmemcached-0.32/docs/memcached_servers.pod

@@ -0,0 +1,102 @@
+=head1 NAME
+
+memcached_server_count, memcached_server_list, memcached_server_add, memcached_server_push - Manage server list
+
+=head1 LIBRARY
+
+C Client Library for memcached (libmemcached, -lmemcached)
+
+=head1 SYNOPSIS
+
+  #include <memcached.h>
+
+  unsigned int memcached_server_count (memcached_st *ptr);
+
+  memcached_server_st *
+    memcached_server_list (memcached_st *ptr);
+
+  memcached_return
+    memcached_server_add (memcached_st *ptr,
+                          const char *hostname,
+                          unsigned int port);
+
+  memcached_return
+    memcached_server_add_udp (memcached_st *ptr,
+                          const char *hostname,
+                          unsigned int port);
+
+  memcached_return
+    memcached_server_add_unix_socket (memcached_st *ptr,
+                                      const char *socket);
+
+  memcached_return
+    memcached_server_push (memcached_st *ptr,
+                           memcached_server_st *list);
+
+  memcached_server_st *
+    memcached_server_by_key (memcached_st *ptr,  
+                             const char *key, size_t key_length, 
+                             memcached_return *error);
+
+=head1 DESCRIPTION
+
+libmemcached(3) performs operations on a list of hosts. The order of these
+hosts determine routing to keys. Functions are provided to add keys to
+memcached_st structures. To manipulate lists of servers see
+memcached_server_st(3).
+
+memcached_server_count() provides you a count of the current number of
+servers being used by a C<memcached_st> structure.
+
+memcached_server_list() is used to provide an array of all defined hosts.
+You are responsible for freeing this list (aka it is not a pointer to the
+currently used structure).
+
+memcached_server_add() pushes a single TCP server into the C<memcached_st>
+structure. This server will be placed at the end. Duplicate servers are
+allowed, so duplication is not checked. Executing this function with the
+C<MEMCACHED_BEHAVIOR_USE_UDP> behavior set will result in a 
+C<MEMCACHED_INVALID_HOST_PROTOCOL>.
+
+memcached_server_add_udp() pushes a single UDP server into the C<memcached_st>
+structure. This server will be placed at the end. Duplicate servers are
+allowed, so duplication is not checked. Executing this function with out
+setting the C<MEMCACHED_BEHAVIOR_USE_UDP> behavior will result in a 
+C<MEMCACHED_INVALID_HOST_PROTOCOL>.
+
+memcached_server_add_unix_socket() pushes a single UNIX socket into the 
+C<memcached_st> structure. This UNIX socket will be placed at the end. 
+Duplicate servers are allowed, so duplication is not checked. The length
+of the filename must be one character less then MEMCACHED_MAX_HOST_LENGTH.
+
+memcached_server_push() pushes an array of C<memcached_server_st> into
+the C<memcached_st> structure. These servers will be placed at the
+end. Duplicate servers are allowed, so duplication is not checked. A
+copy is made of structure so the list provided (and any operations on
+the list) are not saved.
+
+memcached_server_by_key() allows you to provide a key and retrieve the
+server which would be used for assignment. This structure is cloned
+from its original structure and must be freed. If NULL is returned you
+should consult *error. The returning structure should be freed with
+memcached_server_free().
+
+=head1 RETURN
+
+Varies, see particular functions.
+
+=head1 HOME
+
+To find out more information please check: 
+L<http://tangent.org/552/libmemcached.html>
+
+=head1 AUTHOR
+
+Brian Aker, E<lt>brian@tangent.orgE<gt>
+
+=head1 SEE ALSO
+
+memcached(1) libmemcached(3) memcached_strerror(3)
+
+=cut
+

data/ext/libmemcached-0.32/docs/memcached_set.pod

@@ -0,0 +1,187 @@
+=head1 NAME
+
+memcached_set, memcached_add, memcached_replace - Store value on server
+
+=head1 LIBRARY
+
+C Client Library for memcached (libmemcached, -lmemcached)
+
+=head1 SYNOPSIS
+
+  #include <memcached.h>
+
+  memcached_return
+    memcached_set (memcached_st *ptr,
+                   const char *key, size_t key_length, 
+                   const char *value, size_t value_length, 
+                   time_t expiration,
+                   uint32_t flags);
+
+  memcached_return
+    memcached_add (memcached_st *ptr,
+                   const char *key, size_t key_length,
+                   const char *value, size_t value_length, 
+                   time_t expiration,
+                   uint32_t flags);
+
+  memcached_return
+    memcached_replace (memcached_st *ptr,
+                       const char *key, size_t key_length,
+                       const char *value, size_t value_length, 
+                       time_t expiration,
+                       uint32_t flags);
+
+  memcached_return 
+    memcached_prepend(memcached_st *ptr, 
+                      const char *key, size_t key_length,
+                      const char *value, size_t value_length, 
+                      time_t expiration,
+                      uint32_t flags)
+
+  memcached_return 
+    memcached_append(memcached_st *ptr, 
+                     const char *key, size_t key_length,
+                      const char *value, size_t value_length, 
+                      time_t expiration,
+                      uint32_t flags)
+  memcached_return 
+    memcached_cas(memcached_st *ptr, 
+                  const char *key, size_t key_length,
+                  const char *value, size_t value_length, 
+                  time_t expiration,
+                  uint32_t flags,
+                  uint64_t cas);
+
+  memcached_return 
+    memcached_set_by_key(memcached_st *ptr, 
+                         const char *master_key, size_t master_key_length, 
+                         const char *key, size_t key_length, 
+                         const char *value, size_t value_length, 
+                         time_t expiration,
+                         uint32_t flags);
+
+  memcached_return 
+    memcached_add_by_key(memcached_st *ptr, 
+                         const char *master_key, size_t master_key_length,
+                         const char *key, size_t key_length,
+                         const char *value, size_t value_length, 
+                         time_t expiration,
+                         uint32_t flags);
+
+  memcached_return 
+    memcached_replace_by_key(memcached_st *ptr, 
+                             const char *master_key, size_t master_key_length,
+                             const char *key, size_t key_length,
+                             const char *value, size_t value_length, 
+                             time_t expiration,
+                             uint32_t flags);
+
+  memcached_return 
+    memcached_prepend_by_key(memcached_st *ptr, 
+                             const char *master_key, size_t master_key_length,
+                             const char *key, size_t key_length,
+                             const char *value, size_t value_length, 
+                             time_t expiration,
+                             uint32_t flags);
+
+  memcached_return 
+    memcached_append_by_key(memcached_st *ptr, 
+                            const char *master_key, size_t master_key_length,
+                            const char *key, size_t key_length,
+                            const char *value, size_t value_length, 
+                            time_t expiration,
+                            uint32_t flags);
+
+  memcached_return 
+    memcached_cas_by_key(memcached_st *ptr, 
+                         const char *master_key, size_t master_key_length,
+                         const char *key, size_t key_length,
+                         const char *value, size_t value_length, 
+                         time_t expiration,
+                         uint32_t flags,
+                         uint64_t cas);
+
+=head1 DESCRIPTION
+
+memcached_set(), memcached_add(), and memcached_replace() are all used to
+store information on the server. All methods take a key, and its length to
+store the object. Keys are currently limited to 250 characters by the
+memcached(1) server. You must also supply a value and a length. Optionally you
+may support an expiration time for the object and a 16 byte value (it is
+meant to be used as a bitmap).
+
+memcached_set() will write an object to the server. If an object already
+exists it will overwrite what is in the server. If the object does not exist
+it will be written. If you are using the non-blocking mode this function
+will always return true unless a network error occurs. 
+
+memcached_replace() replaces an object on the server. If the object is not
+found on the server an error occurs.
+
+memcached_add() adds an object to the server. If the object is found on the
+server an error occurs, otherwise the value is stored.
+
+memcached_prepend() places a segment of data before the last piece of data 
+stored. Currently expiration and key are not used in the server.
+
+memcached_append() places a segment of data at the end of the last piece of 
+data stored. Currently expiration and key are not used in the server.
+
+memcached_cas() overwrites data in the server as long as the "cas" value is 
+still the same in the server. You can get the cas value of a result by 
+calling memcached_result_cas() on a memcached_result_st(3) structure. At the point 
+that this note was written cas is still buggy in memached. Turning on support
+for it in libmemcached(3) is optional. Please see memcached_set() for 
+information on how to do this.
+
+memcached_set_by_key(), memcached_add_by_key(), memcached_replace_by_key(), 
+memcached_prepend_by_key(), memcached_append_by_key_by_key(), 
+memcached_cas_by_key() methods all behave in a similar method as the non key 
+methods. The difference is that they use their master_key parameter to map
+objects to particular servers.
+
+If you are looking for performance, memcached_set() with non-blocking IO is 
+the fastest way to store data on the server.
+
+All of the above functions are supported with the C<MEMCACHED_BEHAVIOR_USE_UDP>
+behavior enabled. But when using these operations with this behavior on, there 
+are limits to the size of the payload being sent to the server.  The reason for 
+these limits is that the Memcahed Server does not allow multi-datagram requests
+and the current server implementation sets a datagram size to 1400 bytes. Due 
+to protocol overhead, the actual limit of the user supplied data is less than 
+1400 bytes and depends on the protocol in use as well as the operation being 
+executed. When running with the binary protocol, C< MEMCACHED_BEHAVIOR_BINARY_PROTOCOL>, 
+the size of the key,value, flags and expiry combined may not exceed 1368 bytes. 
+When running with the ASCII protocol, the exact limit fluctuates depending on 
+which function is being executed and whether the function is a cas operation 
+or not. For non-cas ASCII set operations, there are at least 1335 bytes available 
+to split among the key, key_prefix, and value; for cas ASCII operations there are 
+at least 1318 bytes available to split among the key, key_prefix and value. If the
+total size of the command, including overhead, exceeds 1400 bytes, a C<MEMCACHED_WRITE_FAILURE>
+will be returned.
+
+
+=head1 RETURN
+
+All methods return a value of type C<memcached_return>.
+On success the value will be C<MEMCACHED_SUCCESS>.
+Use memcached_strerror() to translate this value to a printable string.
+
+For memcached_replace() and memcached_add(), C<MEMCACHED_NOTSTORED> is a
+legitmate error in the case of a collision.
+
+=head1 HOME
+
+To find out more information please check:
+L<http://tangent.org/552/libmemcached.html>
+
+=head1 AUTHOR
+
+Brian Aker, E<lt>brian@tangent.orgE<gt>
+
+=head1 SEE ALSO
+
+memcached(1) libmemached(3) memcached_strerror(3)
+
+=cut
+