jenkins-promote-staging-trunk-libmemcached-10

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

diff --git a/docs/man/libmemcached_examples.3 b/docs/man/libmemcached_examples.3
index d274724c48176e4b1b9a94a5ee1983e3bb254c95..8155a74bd3ab8d11c1d6f7dbf46d84a5fcc1eefe 100644 (file)
--- a/docs/man/libmemcached_examples.3
+++ b/docs/man/libmemcached_examples.3
@@ -1,4 +1,4 @@
-.TH "LIBMEMCACHED_EXAMPLES" "3" "April 09, 2011" "0.47" "libmemcached"
+.TH "LIBMEMCACHED_EXAMPLES" "3" "April 17, 2012" "1.0.6" "libmemcached"
 .SH NAME
 libmemcached_examples \- libmemcached Documentation
 .
@@ -37,59 +37,81 @@ 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.
-.SH CREATING AND FREEING STRUCTURE
+.SH CONNECTING TO SERVERS
+.sp
+.nf
+.ft C
+const char *config_string= "\-\-SERVER=host10.example.com \-\-SERVER=host11.example.com \-\-SERVER=host10.example.com"
+memcached_st *memc= memcached(config_string, strlen(config_string);
+{
+\&...
+}
+ memcached_free(memc);
+.ft P
+.fi
+.sp
+In the above code you create a \fBmemcached_st\fP object with three server
+by making use of \fBmemcached_create()\fP.
+.SH CREATING A POOL OF SERVERS
 .sp
 .nf
 .ft C
-memcached_st *memc;
-memcached_return_t rc;
 
-memc= memcached_create(NULL);
-\&...do stuff...
-memcached_free(memc);
 .ft P
 .fi
 .sp
-The above code would create a connection and then free the connection when
-finished.
-.SH CONNECTING TO SERVERS
+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_st *memc= memcached_create_with_options(config_string, strlen(config_string);
-{
- ...
-}
-memcached_free(memc);
+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_st\fP object with three server by making use of \fImemcached_create_with_options(3)\fP.
+In the above code you create a \fBmemcached_pool_st\fP object with three
+server by making use of \fBmemcached_pool()\fP.
+.sp
+When \fBmemcached_pool_destroy()\fP all memory will be released that is associated
+with the pool.
 .SH ADDING A VALUE TO THE SERVER
 .sp
 .nf
 .ft C
-char *key= "foo";
-char *value;
-size_t value_length= 8191;
-unsigned int x;
 
-value = (char*)malloc(value_length);
-assert(value);
+.ft P
+.fi
+.sp
+Adding a value to the Server:
+.sp
+.nf
+.ft C
+char *key= "foo";
+char *value= "value";
 
-for (x= 0; x < value_length; x++)
-value[x] = (char) (x % 127);
+memcached_return_t rc= memcached_set(memc, key, strlen(key), value, value_length, (time_t)0, (uint32_t)0);
 
-for (x= 0; x < 1; x++)
+if (rc != MEMCACHED_SUCCESS)
 {
-  rc= memcached_set(memc, key, strlen(key),
-  value, value_length,
-  (time_t)0, (uint32_t)0);
-  assert(rc == MEMCACHED_SUCCESS);
+\&... // handle failure
 }
-
-free(value);
 .ft P
 .fi
 .sp
@@ -126,7 +148,7 @@ Notice that you freed values returned from memcached_fetch(). The define
 .SH HOME
 .sp
 To find out more information please check:
-\fI\%https://launchpad.net/libmemcached\fP
+\fI\%http://libmemcached.org/\fP
 .SH SEE ALSO
 .sp
 \fImemcached(1)\fP