Merge

[awesomized/libmemcached] / docs / libmemcached_examples.pod

diff --git a/docs/libmemcached_examples.pod b/docs/libmemcached_examples.pod
index fadfa7f753103590bcad2603a7de2dfd2713e23c..510c920693ae331e3828b9d6e7d98fcf179aa928 100755 (executable)
--- a/docs/libmemcached_examples.pod
+++ b/docs/libmemcached_examples.pod
@@ -4,51 +4,50 @@ libmemcached_examples - Examples for libmemcached
 
 =head1 DESCRIPTION
 
 
 =head1 DESCRIPTION
 

-For full example, example test cases found in tests/*.c in the main
+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.
 
 distribution. These are always up to date, and are used for each test run of
 the library.
 

-=item Creating and Freeing structure
+=head2 Creating and Freeing structure

 
 

-memcached_st *memc;
-memcached_return rc;
-struct timeval start_time, end_time;
+  memcached_st *memc;
+  memcached_return rc;

 
 

-memc= memcached_create(NULL);
-...do stuff...
-memcached_free(memc);
+  memc= memcached_create(NULL);
+  ...do stuff...
+  memcached_free(memc);

 
 The above code would create a connection and then free the connection when
 finished.
 
 
 The above code would create a connection and then free the connection when
 finished.
 

-=item Connecting to servers
+=head2 Connecting to servers

 
 

-memcached_server_st *servers;
-memcached_st *memc= memcached_create(NULL);
-char servername[]= "0.example.com";
+  memcached_server_st *servers;
+  memcached_st *memc= memcached_create(NULL);
+  char servername[]= "0.example.com";

 
 

-servers= memcached_server_list_append(NULL, servername, 400, &rc);
+  servers= memcached_server_list_append(NULL, servername, 400, &rc);

 
 

-for (x= 0; x < 20; x++)
-{
-  char buffer[SMALL_STRING_LEN];
+  for (x= 0; x < 20; x++)
+  {
+    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);
+    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);

 
 

-In the above code we create a memc object that we then feed in a single
-hosts into. In the for loop we build a memcached_server_st* that we then
-later feed via memcached_server_push(3) into the memcached_st structure.
+In the above code you create a C<memcached_st> object that you then feed in a
+single host into. In the for loop you build a C<memcached_server_st>
+pointer that you then later feed via memcached_server_push() into the
+C<memcached_st> structure.

 
 

-We can reuse the memcached_server_st() object with multile memcached_st
+You can reuse the C<memcached_server_st> object with multile C<memcached_st>

 structures.
 
 structures.
 

-=item Adding a value to the server
+=head2 Adding a value to the server

 
   char *key= "foo";
   char *value;
 
   char *key= "foo";
   char *value;


@@ -65,7 +64,7 @@ structures.
   {
     rc= memcached_set(memc, key, strlen(key), 
     value, value_length,
   {
     rc= memcached_set(memc, key, strlen(key), 
     value, value_length,

-    (time_t)0, (uint16_t)0);
+    (time_t)0, (uint32_t)0);

     assert(rc == MEMCACHED_SUCCESS);
   }
 
     assert(rc == MEMCACHED_SUCCESS);
   }
 


@@ -73,13 +72,13 @@ structures.
 
 It is best practice to always look at the return value of any operation.
 
 
 It is best practice to always look at the return value of any operation.
 

-=item Fetching multiple values
+=head2 Fetching multiple values

 
   memcached_return rc;
   char *keys[]= {"fudge", "son", "food"};
   size_t key_length[]= {5, 3, 4};
   unsigned int x;
 
   memcached_return rc;
   char *keys[]= {"fudge", "son", "food"};
   size_t key_length[]= {5, 3, 4};
   unsigned int x;

-  uint16_t flags;
+  uint32_t flags;

 
   char return_key[MEMCACHED_MAX_KEY];
   size_t return_key_length;
 
   char return_key[MEMCACHED_MAX_KEY];
   size_t return_key_length;


@@ -96,20 +95,21 @@ It is best practice to always look at the return value of any operation.
     x++;
   }
 
     x++;
   }
 

-Notice that we freed values returned fromm memcached_fetch(3). The define
-MEMCACHED_MAX_KEY is provided for usage.
+Notice that you freed values returned from memcached_fetch(). The define
+C<MEMCACHED_MAX_KEY> is provided for usage.

 
 =head1 HOME
 
 
 =head1 HOME
 

-To find out more information please check: http://tangent.org/552/libmemcached.html
+To find out more information please check:
+L<http://tangent.org/552/libmemcached.html>

 
 =head1 AUTHOR
 
 
 =head1 AUTHOR
 

-Brian Aker, brian@tangent.org
+Brian Aker, E<lt>brian@tangent.orgE<gt>

 
 =head1 SEE ALSO
 
 
 =head1 SEE ALSO
 

-memcached(1). 
+memcached(1)

 
 =cut
 
 
 =cut