3 memcached_get, memcached_mget, memcached_fetch
7 C Client Library for memcached (libmemcached, -lmemcached)
11 #include <memcached.h>
14 memcached_fetch_result(memcached_st *ptr,
15 memcached_result_st *result,
16 memcached_return *error);
18 char *memcached_get (memcached_st *ptr,
19 char *key, size_t key_length,
22 memcached_return *error);
25 memcached_mget (memcached_st *ptr,
26 char **keys, size_t *key_length,
27 unsigned int number_of_keys);
29 char *memcached_fetch (memcached_st *ptr,
30 char *key, size_t *key_length,
33 memcached_return *error);
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.
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. You must call either
49 memcached_fetch() or memcached_fetch_result() after a successful call to
50 memcached_mget(). You should continue to call these functions until they
51 return NULL (aka no more values). If you need to quit in the middle of a
52 memcached_get() call, execute a memcached_quit(). After you do this, you can
53 issue new queries against the server.
55 memcached_fetch() is used to fetch an individual value from the server.
56 memcached_mget() must always be called before using this method. You
57 must pass in a key and its length to fetch the object. You must supply
58 three pointer variables which will give you the state of the returned
59 object. A uint16_t pointer to contain whatever flags you stored with the value,
60 a size_t pointer which will be filled with size of of the object, and a
61 memcached_return pointer to hold any error. The object will be returned
62 upon success and NULL will be returned on failure.
64 memcached_fetch_result() is used to return a memcached_result_st(3) structure
65 from a memcached server. The result object is forward compatible with changes
66 to the server. For more information please refer to the memcached_result_st(3)
67 help. This function will dynamically allocate a result structure for you
68 if you do not pass one to the function.
72 All objects returned must be freed by the calling application.
73 memcached_get() and memcached_fetch() will return NULL on error. You must
74 look at the value of error to determine what the actual error was.
78 To find out more information please check:
79 L<http://tangent.org/552/libmemcached.html>
83 Brian Aker, E<lt>brian@tangent.orgE<gt>
87 memcached(1) libmemcached(3) memcached_strerror(3)