Hard to believe I documented the entire thing... this is a first.
[awesomized/libmemcached] / 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 memcached_behavior_get(memcached_st *ptr, memcached_behavior flag);
14 memcached_return memcached_behavior_set(memcached_st *ptr, memcached_behavior flag, void *data);
15
16 =head1 DESCRIPTION
17
18
19 libmemcached(3) behavior can be modified by use memcached_behavior_set().
20 Default behavior is the library strives to be quick and accurate. Some
21 behavior, like , while being faster can also result in not entirely accurate
22 behavior (for instance memcached_set will always respond with
23 MEMCACHED_SUCCES).
24
25 memcached_behavior_get() takes a behavior flag and returns whether or not
26 that behavior is currently enabled in the client.
27
28 memcached_behavior_set() changes the value of a particular option of the
29 client. It takes both a flag (listed below) and a value. For simple on or
30 off options you just need to pass in a value of 1.
31
32 =item MEMCACHED_BEHAVIOR_NO_BLOCK,
33
34 Causes libmemcached(3) to use asycronous IO. This is the fastest transport
35 available.
36
37 =item MEMCACHED_BEHAVIOR_TCP_NODELAY,
38
39 Turns on the no-delay feature for connecting sockets (may be faster in some
40 setups).
41
42 =item MEMCACHED_BEHAVIOR_MD5_HASHING,
43
44 Makes the default hashing algorithm for keys use RSA's MD5.
45
46 =head1 RETURN
47
48 memcached_behavior_get() returns either the current value of the get, or 0
49 or 1 on simple flag behaviors (1 being enabled). memcached_behavior_set()
50 returns whether or not the behavior was enabled.
51
52 =head1 HOME
53
54 To find out more information please check: http://tangent.org/552/libmemcached.html
55
56 =head1 AUTHOR
57
58 Brian Aker, brian@tangent.org
59
60 =head1 SEE ALSO
61
62 memcached(1) libmemcached(3) memcached_strerror(3)
63
64 =cut
65