memcached 1.2.6 → 1.2.7

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

@@ -0,0 +1,82 @@
+=head1 NAME
+
+memcached_stat, memcached_stat_servername, memcached_stat_get_value, memcached_stat_get_keys - Get memcached statistics
+
+=head1 LIBRARY
+
+C Client Library for memcached (libmemcached, -lmemcached)
+
+=head1 SYNOPSIS
+
+  #include <memcached.h>
+
+  memcached_stat_st *memcached_stat (memcached_st *ptr,
+                                     char *args,
+                                     memcached_return *error);
+
+  memcached_return memcached_stat_servername (memcached_stat_st *stat,
+                                              char *args, 
+                                              char *hostname,
+                                              unsigned int port);
+
+  char *memcached_stat_get_value (memcached_st *ptr,
+                                  memcached_stat_st *stat, 
+                                  char *key,
+                                  memcached_return *error);
+
+  char ** memcached_stat_get_keys (memcached_st *ptr,
+                                   memcached_stat_st *stat, 
+                                   memcached_return *error);
+
+=head1 DESCRIPTION
+
+libmemcached(3) has the ability to query a memcached server (or collection
+of servers) for their current state. Queries to find state return a
+C<memcached_stat_st> structure. You are responsible for freeing this structure.
+While it is possible to access the structure directly it is not advisable.
+<memcached_stat_get_value() has been provided to query the structure.
+
+memcached_stat() fetches an array of C<memcached_stat_st> structures containing
+the state of all available memcached servers. The return value must be freed
+by the calling application. If called with the C<MEMCACHED_BEHAVIOR_USE_UDP>
+behavior set, a NULL value is returned and the error parameter is set to 
+C<MEMCACHED_NOT_SUPPORTED>.
+
+memcached_stat_servername() can be used standalone without a C<memcached_st> to
+obtain the state of a particular server.  "args" is used to define a
+particular state object (a list of these are not provided for by either
+the memcached_stat_get_keys() call nor are they defined in the memcached
+protocol). You must specify the hostname and port of the server you want to
+obtain information on.
+
+memcached_stat_get_value() returns the value of a particular state key. You
+specify the key you wish to obtain.  The key must be null terminated.
+
+memcached_stat_get_keys() returns a list of keys that the server has state
+objects on. You are responsible for freeing this list.
+
+A command line tool, memstat(1), is provided so that you do not have to write
+an application to do this.
+
+=head1 RETURN
+
+Varies, see particular functions.
+
+Any method returning a C<memcached_stat_st> expects you to free the
+memory allocated for it.
+
+=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_strerror.pod

@@ -0,0 +1,46 @@
+=head1 NAME
+
+memcached_strerror - Get error string
+ 
+=head1 LIBRARY
+
+C Client Library for memcached (libmemcached, -lmemcached)
+
+=head1 SYNOPSIS
+
+  #include <memcached.h>
+
+  char *memcached_strerror (memcached_st *ptr,
+                            memcached_return rc);
+
+=head1 DESCRIPTION
+
+memcached_strerror() takes a C<memcached_return> value and returns a string
+describing the error.
+
+This string must not be modified by the application.
+
+C<memcached_return> values are returned from nearly all libmemcached(3) functions.
+
+C<memcached_return> values are of an enum type so that you can set up responses
+with switch/case and know that you are capturing all possible return values.
+
+=head1 RETURN
+
+memcached_strerror() returns a string describing a C<memcached_return> value.
+
+=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)
+
+=cut
+

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

@@ -0,0 +1,49 @@
+=head1 NAME
+
+memcached_set_user_data, memcached_get_user_data - Manage user specific data
+
+=head1 LIBRARY
+
+C Client Library for memcached (libmemcached, -lmemcached)
+
+=head1 SYNOPSIS
+
+  #include <memcached.h>
+
+  void *memcached_get_user_data(memcached_st *ptr);
+  void *memcached_set_user_data(memcached_st *ptr, void *data);
+
+=head1 DESCRIPTION
+
+libmemcached(3) allows you to store a pointer to a user specific data inside
+the memcached_st structure. 
+
+memcached_set_user_data() is used to set the user specific data in the
+memcached_st structure.
+
+memcached_get_user_data() is used to retrieve the user specific data in
+the memcached_st structure.
+
+=head1 RETURN
+
+memcached_set_user_data() returns the previous value of the user specific 
+data.
+
+memcached_get_user_data() returns the current value uf the user specific
+data.
+
+=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_verbosity.pod

@@ -0,0 +1,41 @@
+=head1 NAME
+
+memcached_verbosity - Modifiy verbosity of servers
+
+=head1 LIBRARY
+
+C Client Library for memcached (libmemcached, -lmemcached)
+
+=head1 SYNOPSIS
+
+  #include <memcached.h>
+
+  memcached_return memcached_verbosity (memcached_st *ptr,
+                                        unsigned int verbosity);
+
+=head1 DESCRIPTION
+
+memcached_verbosity() modifies the "verbosity" of the
+memcached(1) servers referenced in the C<memcached_st> parameter.
+
+=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_version.pod

@@ -0,0 +1,56 @@
+=head1 NAME
+
+memcached_lib_version, memcached_version - Get library version
+
+=head1 LIBRARY
+
+C Client Library for memcached (libmemcached, -lmemcached)
+
+=head1 SYNOPSIS
+
+  #include <memcached.h>
+
+  const char *
+    memcached_lib_version(void) 
+
+
+  memcached_return
+    memcached_version(memcached_st *ptr)
+
+
+=head1 DESCRIPTION
+
+memcached_lib_version() is used to return a simple version string representing
+the libmemcached version (version of the client library, not server)
+
+
+memcached_version() is used to set the major, minor, and micro versions of each
+memcached server being used by the memcached_st connection structure. It returns the 
+memcached server return code. 
+
+=head1 RETURN
+
+A string with the version of libmemcached driver is returned from
+memcached_lib_version()
+
+A value of type C<memcached_return> is returned from memcached_version()
+On success that value will be C<MEMCACHED_SUCCESS>. If called with the
+C<MEMCACHED_BEHAVIOR_USE_UDP> behavior set, the value C<MEMCACHED_NOT_SUPPORTED> 
+will be returned. 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/memcat.pod

@@ -0,0 +1,37 @@
+=head1 NAME
+
+memcat - Copy a set of keys to stdout
+
+=head1 SYNOPSIS
+
+  memcat [options] key key ...
+
+=head1 DESCRIPTION
+
+B<memcat> outputs to stdout the value a single or mutiple set of keys
+stored in a memcached(1) server.
+
+It is similar to the standard UNIX cat(1) utility. 
+
+You can specify servers via the B<--servers> option or via the
+environment variable C<MEMCACHED_SERVERS>.
+
+For a full list of operations run the tool with the B<--help> option.
+
+=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>
+
+Mark Atwood E<lt>mark@fallenpegasus.comE<gt>
+
+=head1 SEE ALSO
+
+memcached(1) libmemcached(3)
+
+=cut
+

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

@@ -0,0 +1,40 @@
+=head1 NAME
+
+memcp - Copies files to a collection of memcached servers
+
+=head1 SYNOPSIS
+
+  memcp [options] file file <servers>
+
+=head1 DESCRIPTION
+
+B<memcp> copies one or more files into memcached(1) servers.
+It is similar to the standard UNIX cp(1) command.
+
+The key names will be the names of the files,
+without any directory path part.
+
+You can specify servers via the B<--servers> option or via the
+environment variable C<MEMCACHED_SERVERS>. If you specify neither of
+these, the final value in the command line list is the name of a
+server(s).
+
+For a full list of operations run the tool with the B<--help> option.
+
+=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>
+
+Mark Atwood, E<lt>mark@fallenpegasus.comE<gt>
+
+=head1 SEE ALSO
+
+memcached(1) libmemcached(3)
+
+=cut
+

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

@@ -0,0 +1,31 @@
+=head1 NAME
+
+memdump - Dump a list of keys from a server.
+
+=head1 SYNOPSIS
+
+  memdump [options]
+
+=head1 DESCRIPTION
+
+B<memdump> currently dumps a list of "keys" from all servers that 
+it is told to fetch from. Because memcached does not guarentee to
+provide all keys it is not possible to get a complete "dump".
+
+For a full list of operations run the tool with the B<--help> option.
+
+=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)
+
+=cut
+

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

@@ -0,0 +1,30 @@
+=head1 NAME
+
+memerror - Translate a memcached error code to a string
+
+=head1 SYNOPSIS
+
+  memerror [options] error_code
+
+=head1 DESCRIPTION
+
+B<memerror> translate an error code from libmemcached(3) to  a human
+readable string.
+
+For a full list of operations run the tool with the B<--help> option.
+
+=head1 HOME
+
+To find out more infoerroration 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)
+
+=cut
+

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

@@ -0,0 +1,35 @@
+=head1 NAME
+
+memflush - Reset a server or list of servers
+
+=head1 SYNOPSIS
+
+  memflush [options]
+
+=head1 DESCRIPTION
+
+B<memflush> resets the contents of memcached(1) servers.
+This means all data in these servers will be deleted.
+
+You can specify servers via the B<--servers> option or via the
+environment variable C<MEMCACHED_SERVERS>.
+
+For a full list of operations run the tool with the B<--help> option.
+
+=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>
+
+Mark Atwood E<lt>mark@fallenpegasus.comE<gt>
+
+=head1 SEE ALSO
+
+memcached(1) libmemcached(3)
+
+=cut
+