fetch_result() implemented for memcached_result_st.
[awesomized/libmemcached] / docs / memcached_get.pod
1 =head1 NAME
2
3 memcached_get, memcached_mget, memcached_fetch
4
5 =head1 LIBRARY
6
7 C Client Library for memcached (libmemcached, -lmemcached)
8
9 =head1 SYNOPSIS
10
11 #include <memcached.h>
12
13 memcached_result_st *
14 memcached_fetch_result(memcached_st *ptr,
15 memcached_result_st *result,
16 memcached_return *error);
17
18 char *memcached_get (memcached_st *ptr,
19 char *key, size_t key_length,
20 size_t *value_length,
21 uint16_t *flags,
22 memcached_return *error);
23
24 memcached_return
25 memcached_mget (memcached_st *ptr,
26 char **keys, size_t *key_length,
27 unsigned int number_of_keys);
28
29 char *memcached_fetch (memcached_st *ptr,
30 char *key, size_t *key_length,
31 size_t *value_length,
32 uint16_t *flags,
33 memcached_return *error);
34
35 =head1 DESCRIPTION
36
37 memcached_get() is used to fetch an individual value from the server. You
38 must pass in a key and its length to fetch the object. You must supply
39 three pointer variables which will give you the state of the returned
40 object. A uint16_t pointer to contain whatever flags you stored with the value,
41 a size_t pointer which will be filled with size of of the object, and a
42 memcached_return pointer to hold any error. The object will be returned
43 upon success and NULL will be returned on failure.
44
45 memcached_mget() is used to select multiple keys at once. For multiple key
46 operations it is always faster to use this function. This function always
47 works asynchronously. memcached_fetch() is then used to retrieve any keys
48 found. No error is given on keys that are not found.
49
50 memcached_fetch() is used to fetch an individual value from the server.
51 memcached_mget() must always be called before using this method. You
52 must pass in a key and its length to fetch the object. You must supply
53 three pointer variables which will give you the state of the returned
54 object. A uint16_t pointer to contain whatever flags you stored with the value,
55 a size_t pointer which will be filled with size of of the object, and a
56 memcached_return pointer to hold any error. The object will be returned
57 upon success and NULL will be returned on failure.
58
59 memcached_fetch_result() is used to return a memcached_result_st(3) structure
60 from a memcached server. The result object is forward compatible with changes
61 to the server. For more information please refer to the memcached_result_st(3)
62 help. This function will dynamically allocate a result structure for you
63 if you do not pass one to the function.
64
65 =head1 RETURN
66
67 All objects returned must be freed by the calling application.
68 memcached_get() and memcached_fetch() will return NULL on error. You must
69 look at the value of error to determine what the actual error was.
70
71 =head1 HOME
72
73 To find out more information please check:
74 L<http://tangent.org/552/libmemcached.html>
75
76 =head1 AUTHOR
77
78 Brian Aker, E<lt>brian@tangent.orgE<gt>
79
80 =head1 SEE ALSO
81
82 memcached(1) libmemcached(3) memcached_strerror(3)
83
84 =cut
85