Merge in all updates.

[awesomized/libmemcached] / docs / man / libmemcached_examples.3

diff --git a/docs/man/libmemcached_examples.3 b/docs/man/libmemcached_examples.3
index 621116d68d870fbd0492411c7f9057cae88887f1..d0d6f805bccd7b96de62c4a3d8d44532cf37f2da 100644 (file)
--- a/docs/man/libmemcached_examples.3
+++ b/docs/man/libmemcached_examples.3
@@ -1,4 +1,4 @@
-.TH "LIBMEMCACHED_EXAMPLES" "3" "April 07, 2011" "0.47" "libmemcached"
+.TH "LIBMEMCACHED_EXAMPLES" "3" "April 12, 2011" "0.47" "libmemcached"
 .SH NAME
 libmemcached_examples \- libmemcached Documentation
 .
@@ -37,7 +37,7 @@ Examples for libmemcached
 For full examples, test cases are found in tests/*.c in the main
 distribution. These are always up to date, and are used for each test run of
 the library.
-.SS Creating and Freeing structure
+.SH CREATING AND FREEING THE MEMCACHED_ST STRUCTURE
 .sp
 .nf
 .ft C
@@ -52,35 +52,52 @@ memcached_free(memc);
 .sp
 The above code would create a connection and then free the connection when
 finished.
-.SS Connecting to servers
+.SH CONNECTING TO SERVERS
 .sp
 .nf
 .ft C
-memcached_server_st *servers;
-memcached_st *memc= memcached_create(NULL);
-char servername[]= "0.example.com";
-
-servers= memcached_server_list_append(NULL, servername, 400, &rc);
-
-for (x= 0; x < 20; x++)
+const char *config_string= "\-\-SERVER=host10.example.com \-\-SERVER=host11.example.com \-\-SERVER=host10.example.com"
+memcached_st *memc= memcached_create_with_options(config_string, strlen(config_string);
 {
-  char buffer[SMALL_STRING_LEN];
-
-  snprintf(buffer, SMALL_STRING_LEN, "%u.example.com", 400+x);
-  servers= memcached_server_list_append(servers, buffer, 401, &rc);
+ ...
 }
-rc= memcached_server_push(memc, servers);
-memcached_server_free(servers);
 memcached_free(memc);
 .ft P
 .fi
 .sp
-In the above code you create a \fBmemcached_st\fP object that you then feed in a
-single host into. In the for loop you build a \fBmemcached_server_st\fPpointer that you then later feed via memcached_server_push() into the
-\fBmemcached_st\fP structure.
+In the above code you create a \fBmemcached_st\fP object with three server by making use of \fImemcached_create_with_options(3)\fP.
+.SH CREATING A POOL OF SERVERS
+.sp
+.nf
+.ft C
+const char *config_string= "\-\-SERVER=host10.example.com \-\-SERVER=host11.example.com \-\-SERVER=host10.example.com";
+
+memcached_pool_st* pool= memcached_pool(config_string, strlen(config_string));
+
+memcached_return_t rc;
+
+memcached_st *memc= memcached_pool_pop(pool, false, &rc);
+
+\&.... do work
+
+/*
+  Release the memc_ptr that was pulled from the pool
+*/
+memcached_pool_push(pool, memc);
+
+/*
+  Destroy the pool.
+*/
+memcached_pool_destroy(pool);
+.ft P
+.fi
+.sp
+In the above code you create a \fBmemcached_pool_st\fP object with three
+server by making use of \fImemcached_pool(3)\fP.
 .sp
-You can reuse the \fBmemcached_server_st\fP object with multile \fBmemcached_st\fPstructures.
-.SS Adding a value to the server
+When memcached_pool_destroy() all memory will be released that is associated
+with the pool.
+.SH ADDING A VALUE TO THE SERVER
 .sp
 .nf
 .ft C
@@ -108,7 +125,7 @@ free(value);
 .fi
 .sp
 It is best practice to always look at the return value of any operation.
-.SS Fetching multiple values
+.SH FETCHING MULTIPLE VALUES
 .sp
 .nf
 .ft C
@@ -141,16 +158,13 @@ Notice that you freed values returned from memcached_fetch(). The define
 .sp
 To find out more information please check:
 \fI\%https://launchpad.net/libmemcached\fP
-.SH AUTHOR
-.sp
-Brian Aker, <\fI\%brian@tangent.org\fP>
 .SH SEE ALSO
 .sp
-memcached(1)
+\fImemcached(1)\fP
 .SH AUTHOR
 Brian Aker
 .SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
 .\" Generated by docutils manpage writer.
 .\" 
 .