git.m6w6.name Git - awesomized/libmemcached/blob - docs/memcached_result_st.rst

   1 ========================
   2 Working with result sets
   3 ========================
   4
   5 .. index:: object: memcached_result_st
   6
   7 Work with memcached_result_st
   8
   9
  10 --------
  11 SYNOPSIS
  12 --------
  13
  14 #include <libmemcached/memcached_pool.h>
  15
  16 .. c:function:: memcached_result_st * memcached_result_create (memcached_st *ptr, memcached_result_st *result);
  17
  18 .. c:function:: void memcached_result_free (memcached_result_st *result);
  19
  20 .. c:function:: const char * memcached_result_key_value (memcached_result_st *result);
  21
  22 .. c:function:: size_t memcached_result_key_length (const memcached_result_st *result);
  23
  24 .. c:function:: const char *memcached_result_value (memcached_result_st *ptr);
  25
  26 .. c:function:: size_t memcached_result_length (const memcached_result_st *ptr);
  27
  28 .. c:function:: uint32_t memcached_result_flags (const memcached_result_st *result)
  29
  30 .. c:function:: uint64_t memcached_result_cas (const memcached_result_st *result);
  31
  32 .. c:function:: memcached_return_t memcached_result_set_value (memcached_result_st *ptr, const char *value, size_t length)
  33
  34 .. c:function:: void memcached_result_set_flags (memcached_result_st *ptr, uint32_t flags)
  35
  36 .. c:function:: void memcached_result_set_expiration (memcached_result_st *ptr, time_t)
  37
  38 Compile and link with -lmemcachedutil -lmemcached
  39
  40
  41
  42 -----------
  43 DESCRIPTION
  44 -----------
  45
  46
  47 libmemcached(3) can optionally return a :c:type:`memcached_result_st` which
  48 acts as a result object. The result objects have added benefits over the
  49 character pointer returns, in that they are forward compatible with new
  50 return items that future memcached servers may implement (the best current
  51 example of this is the CAS return item). The structures can also be reused,
  52 which will save on calls to malloc(3). It is suggested that you use result
  53 objects over char \* return functions.
  54
  55 The structure of :c:type:`memcached_result_st` has been encapsulated, you should
  56 not write code to directly access members of the structure.
  57
  58 :c:func:`memcached_result_create()` will either allocate memory for a
  59 :c:type:`memcached_result_st` or will initialize a structure passed to it.
  60
  61 :c:func:`memcached_result_free()` will deallocate any memory attached to the
  62 structure. If the structure was also allocated, it will deallocate it.
  63
  64 :c:func:`memcached_result_key_value()` returns the key value associated with the
  65 current result object.
  66
  67 :c:func:`memcached_result_key_length()` returns the key length associated with
  68 the current result object.
  69
  70 :c:func:`memcached_result_value()` returns the result value associated with the
  71 current result object.
  72
  73 :c:func:`memcached_result_length()` returns the result length associated with
  74 the current result object.
  75
  76 :c:func:`memcached_result_flags()` returns the flags associated with the
  77 current result object.
  78
  79 :c:cune:`memcached_result_cas()` returns the cas associated with the
  80 current result object. This value will only be available if the server
  81 tests it.
  82
  83 :c:func:`memcached_result_set_value()` takes a byte array and a size and sets
  84 the result to this value. This function is used for trigger responses.
  85
  86 :c:func:`void memcached_result_set_flags()` takes a result structure and stores
  87 a new value for the flags field.
  88
  89 :c:func:`void memcached_result_set_expiration(A)` takes a result structure and stores a new value for the expiration field (this is only used by read
  90 through triggers).
  91
  92 You may wish to avoid using memcached_result_create(3) with a
  93 stack based allocation. The most common issues related to ABI safety involve
  94 heap allocated structures.
  95
  96
  97 ------
  98 RETURN
  99 ------
 100
 101
 102 Varies, see particular functions. All structures must have
 103 :c:func:`memcached_result_free()` called on them for cleanup purposes. Failure
 104 to do this will result in leaked memory.
 105
 106
 107 ----
 108 HOME
 109 ----
 110
 111
 112 To find out more information please check:
 113 `http://libmemcached.org/ <http://libmemcached.org/>`_
 114
 115
 116 --------
 117 SEE ALSO
 118 --------
 119
 120 :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`