git.m6w6.name Git - awesomized/libmemcached/blob - docs/memcached_behavior.pod

   1 =head1 NAME
   2
   3 memcached_behavior_get memcached_behavior_set
   4
   5 =head1 LIBRARY
   6
   7 C Client Library for memcached (libmemcached, -lmemcached)
   8
   9 =head1 SYNOPSIS
  10
  11   #include <memcached.h>
  12
  13   unsigned long long
  14     memcached_behavior_get (memcached_st *ptr,
  15                             memcached_behavior flag);
  16
  17   memcached_return
  18     memcached_behavior_set (memcached_st *ptr,
  19                             memcached_behavior flag,
  20                             void *data);
  21
  22 =head1 DESCRIPTION
  23
  24 libmemcached(3) behavior can be modified by use memcached_behavior_set().
  25 Default behavior is the library strives to be quick and accurate. Some
  26 behavior, while being faster, can also result in not entirely accurate
  27 behavior (for instance, memcached_set() will always respond with
  28 C<MEMCACHED_SUCCESS>).
  29
  30 memcached_behavior_get() takes a behavior flag and returns whether or not
  31 that behavior is currently enabled in the client.
  32
  33 memcached_behavior_set() changes the value of a particular option of the
  34 client. It takes both a flag (listed below) and a value. For simple on or
  35 off options you just need to pass in a value of 1.
  36
  37 =over 4
  38
  39 =item MEMCACHED_BEHAVIOR_NO_BLOCK
  40
  41 Causes libmemcached(3) to use asychronous IO. This is the fastest transport
  42 available.
  43
  44 =item MEMCACHED_BEHAVIOR_TCP_NODELAY
  45
  46 Turns on the no-delay feature for connecting sockets (may be faster in some
  47 environments).
  48
  49 =item MEMCACHED_BEHAVIOR_MD5_HASHING
  50
  51 Makes the default hashing algorithm for keys use MD5.
  52
  53 =back
  54
  55 =head1 RETURN
  56
  57 memcached_behavior_get() returns either the current value of the get, or 0
  58 or 1 on simple flag behaviors (1 being enabled). memcached_behavior_set()
  59 returns whether or not the behavior was enabled.
  60
  61 =head1 HOME
  62
  63 To find out more information please check:
  64 L<http://tangent.org/552/libmemcached.html>
  65
  66 =head1 AUTHOR
  67
  68 Brian Aker, E<lt>brian@tangent.orgE<gt>
  69
  70 =head1 SEE ALSO
  71
  72 memcached(1) libmemcached(3) memcached_strerror(3)
  73
  74 =cut
  75