← Back to branch summary

~pierre-php/libmemcached/libmemcached-windows

« back to all changes in this revision

Viewing changes to docs/memcached_get.pod

  • Committer: pierre
  • Date: 2009-11-28 19:35:07 UTC
  • mfrom: (533.1.89 libmemcached)
  • Revision ID: pierre@pierre-win7-20091128193507-amrg03lsrgyas64x
- merge from main libmemcached branch, not tested yet

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/memcached_get.pod
1
1
=head1 NAME
2
2
 
3
 
memcached_get, memcached_mget, memcached_fetch - Get a value
 
3
memcached_get, memcached_mget, memcached_fetch, memcached_mget_execute,
 
4
memcached_mget_execute_by_key - Get a value
4
5
 
5
6
=head1 LIBRARY
6
7
 
23
24
 
24
25
  memcached_return
25
26
  memcached_mget (memcached_st *ptr, 
26
 
                  char **keys, size_t *key_length, 
27
 
                  unsigned int number_of_keys);
 
27
                  const char * const *keys, 
 
28
                  const size_t *key_length, 
 
29
                  size_t number_of_keys);
28
30
  char *
29
31
  memcached_get_by_key(memcached_st *ptr, 
30
32
                       const char *master_key, size_t master_key_length, 
36
38
  memcached_return 
37
39
  memcached_mget_by_key(memcached_st *ptr, 
38
40
                        const char *master_key, size_t master_key_length,
39
 
                        char **keys, size_t *key_length, 
40
 
                        unsigned int number_of_keys);
 
41
                        const char * const *keys, 
 
42
                        const size_t *key_length, 
 
43
                        size_t number_of_keys);
41
44
 
42
45
  char *memcached_fetch (memcached_st *ptr,
43
46
                         char *key, size_t *key_length, 
44
47
                         size_t *value_length,
45
48
                         uint32_t *flags, 
46
49
                         memcached_return *error);
 
50
 
47
51
  memcached_return 
48
52
  memcached_fetch_execute(memcached_st *ptr, 
49
53
                          memcached_return (*callback[])(memcached_st *ptr, memcached_result_st *result, void *context),
50
54
                          void *context,
51
55
                          unsigned int number_of_callbacks);
52
56
 
 
57
 
 
58
  memcached_return
 
59
  memcached_mget_execute(memcached_st *ptr,
 
60
                         const char * const *keys,
 
61
                         const size_t *key_length,
 
62
                         size_t number_of_keys,
 
63
                         memcached_execute_function *callback,
 
64
                         void *context,
 
65
                         unsigned int number_of_callbacks);
 
66
 
 
67
  memcached_return 
 
68
  memcached_mget_execute_by_key(memcached_st *ptr,
 
69
                                const char *master_key,
 
70
                                size_t master_key_length,
 
71
                                const char * const *keys,
 
72
                                const size_t *key_length,
 
73
                                size_t number_of_keys,
 
74
                                memcached_execute_function *callback,
 
75
                                void *context,
 
76
                                unsigned int number_of_callbacks);
 
77
 
 
78
 
53
79
=head1 DESCRIPTION
54
80
 
55
81
memcached_get() is used to fetch an individual value from the server. You
99
125
to each function call. In the future there will be an option to allow this
100
126
to be an array.
101
127
 
 
128
memcached_mget_execute() and memcached_mget_execute_by_key() is
 
129
similar to memcached_mget(), but it may trigger the supplied callbacks
 
130
with result sets while sending out the queries. If you try to perform
 
131
a really large multiget with memcached_mget() you may encounter a
 
132
deadlock in the OS kernel (we fail to write data to the socket because
 
133
the input buffer is full). memcached_mget_execute() solves this
 
134
problem by processing some of the results before continuing sending
 
135
out requests. Please note that this function is only available in the
 
136
binary protocol.
 
137
 
102
138
memcached_get_by_key() and memcached_mget_by_key() behave in a similar nature
103
139
as memcached_get() and memcached_mget(). The difference is that they take
104
140
a master key that is used for determining which server an object was stored