Merge in additional documentation updates.
[awesomized/libmemcached] / libmemcached / get.h
index bb04a15432f24ee2b4aead8e6d941a8be1506668..61e34356696fd61872aed14720068d6abb4d0cb3 100644 (file)
@@ -1,5 +1,5 @@
 /* LibMemcached
- * Copyright (C) 2006-2009 Brian Aker 
+ * Copyright (C) 2006-2009 Brian Aker
  * All rights reserved.
  *
  * Use and distribution licensed under the BSD license.  See
@@ -9,8 +9,8 @@
  *
  */
 
-#ifndef LIBMEMCACHED_MEMCACHED_GET_H
-#define LIBMEMCACHED_MEMCACHED_GET_H
+#ifndef __LIBMEMCACHED_GET_H__
+#define __LIBMEMCACHED_GET_H__
 
 #ifdef __cplusplus
 extern "C" {
@@ -18,42 +18,44 @@ extern "C" {
 
 /* Public defines */
 LIBMEMCACHED_API
-char *memcached_get(memcached_st *ptr, 
+char *memcached_get(memcached_st *ptr,
                     const char *key, size_t key_length,
-                    size_t *value_length, 
+                    size_t *value_length,
                     uint32_t *flags,
                     memcached_return_t *error);
 
 LIBMEMCACHED_API
-memcached_return_t memcached_mget(memcached_st *ptr, 
-                                  const char * const *keys, 
-                                  const size_t *key_length, 
+memcached_return_t memcached_mget(memcached_st *ptr,
+                                  const char * const *keys,
+                                  const size_t *key_length,
                                   size_t number_of_keys);
 
 LIBMEMCACHED_API
-char *memcached_get_by_key(memcached_st *ptr, 
-                           const char *master_key, size_t master_key_length, 
-                           const char *key, size_t key_length, 
-                           size_t *value_length, 
+char *memcached_get_by_key(memcached_st *ptr,
+                           const char *group_key, size_t group_key_length,
+                           const char *key, size_t key_length,
+                           size_t *value_length,
                            uint32_t *flags,
                            memcached_return_t *error);
 
 LIBMEMCACHED_API
-memcached_return_t memcached_mget_by_key(memcached_st *ptr, 
-                                         const char *master_key, size_t 
-                                         master_key_length,
-                                         const char * const *keys, 
-                                         const size_t *key_length, 
-                                         size_t number_of_keys);
+memcached_return_t memcached_mget_by_key(memcached_st *ptr,
+                                         const char *group_key,
+                                         size_t group_key_length,
+                                         const char * const *keys,
+                                         const size_t *key_length,
+                                         const size_t number_of_keys);
 
 LIBMEMCACHED_API
-char *memcached_fetch(memcached_st *ptr, 
-                      char *key, size_t *key_length, 
-                      size_t *value_length, uint32_t *flags, 
+char *memcached_fetch(memcached_st *ptr,
+                      char *key,
+                      size_t *key_length,
+                      size_t *value_length,
+                      uint32_t *flags,
                       memcached_return_t *error);
 
 LIBMEMCACHED_API
-memcached_result_st *memcached_fetch_result(memcached_st *ptr, 
+memcached_result_st *memcached_fetch_result(memcached_st *ptr,
                                             memcached_result_st *result,
                                             memcached_return_t *error);
 
@@ -61,24 +63,24 @@ LIBMEMCACHED_API
 memcached_return_t memcached_mget_execute(memcached_st *ptr,
                                           const char * const *keys,
                                           const size_t *key_length,
-                                          size_t number_of_keys,
+                                          const size_t number_of_keys,
                                           memcached_execute_fn *callback,
                                           void *context,
-                                          unsigned int number_of_callbacks);
+                                          const uint32_t number_of_callbacks);
 
 LIBMEMCACHED_API
 memcached_return_t memcached_mget_execute_by_key(memcached_st *ptr,
-                                                 const char *master_key,
-                                                 size_t master_key_length,
+                                                 const char *group_key,
+                                                 size_t group_key_length,
                                                  const char * const *keys,
                                                  const size_t *key_length,
                                                  size_t number_of_keys,
                                                  memcached_execute_fn *callback,
                                                  void *context,
-                                                 unsigned int number_of_callbacks);
+                                                 const uint32_t number_of_callbacks);
 
 #ifdef __cplusplus
 }
 #endif
 
-#endif /* LIBMEMCACHED_MEMCACHED_GET_H */
+#endif /* __LIBMEMCACHED_GET_H__ */