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

   1 =head1 NAME
   2
   3 memcahed_result_create, memcached_result_free,
   4 memcached_result_key_value, memcached_result_key_length,
   5 memcached_result_value, memcached_result_length,
   6 memcached_result_flags, memcached_result_cas
   7
   8
   9 =head1 LIBRARY
  10
  11 C Client Library for memcached (libmemcached, -lmemcached)
  12
  13 =head1 SYNOPSIS
  14
  15   #include <memcached.h>
  16
  17   memcached_result_st *memcached_result_create(memcached_st *ptr,
  18                                                memcached_result_st *result);
  19
  20   void memcached_result_free(memcached_result_st *result);
  21
  22   char * memcached_result_key_value(memcached_result_st *result);
  23
  24   size_t memcached_result_key_length(memcached_result_st *result);
  25
  26   char *memcached_result_value(memcached_result_st *ptr);
  27
  28   size_t memcached_result_length(memcached_result_st *ptr);
  29
  30   uint16_t memcached_result_flags(memcached_result_st *result)
  31
  32   uint64_t memcached_result_cas(memcached_result_st *result);
  33
  34 =head1 DESCRIPTION
  35
  36 libmemcached(3) can optionally return a memcached_result_st which acts as a
  37 result object. The result objects have added benefits over the character
  38 pointer returns in that they are forward compatible with new return items
  39 that future memcached servers may implement (the best currect example of
  40 this is the CAS return iteam). The structures can also be reused which will
  41 save on calls to malloc(3). It is suggested that you use result objects over
  42 char * return functions.
  43
  44 The structure of memcached_result_st has been encapsulated, you should not
  45 write code to directly access members of the structure.
  46
  47 memcached_result_create() will either allocate memory for a
  48 memcached_result_st or will initialize a structure passed to it.
  49
  50 memcached_result_free() will deallocate any memory attached to the
  51 structure. If the structure was also alloacted, it will deallocate it.
  52
  53 memcached_result_key_value() returns the key value associated with the
  54 current result object.
  55
  56 memcached_result_key_length() returns the key length associated with the
  57 current result object.
  58
  59 memcached_result_value() returns the result value associated with the
  60 current result object.
  61
  62 memcached_result_length() returns the result length associated with the
  63 current result object.
  64
  65 memcached_result_flags() returns the flags associated with the
  66 current result object.
  67
  68 memcached_result_cas() returns the cas associated with the
  69 current result object. This value will only be available if the server
  70 supports it.
  71
  72
  73 =head1 RETURN
  74
  75 Varies, see particular functions. All structures must have
  76 memcached_result_free() called on them for cleanup purposes. Failure to
  77 do this will result in leaked memory.
  78
  79 =head1 HOME
  80
  81 To find out more information please check:
  82 L<http://tangent.org/552/libmemcached.html>
  83
  84 =head1 AUTHOR
  85
  86 Brian Aker, E<lt>brian@tangent.orgE<gt>
  87
  88 =head1 SEE ALSO
  89
  90 memcached(1) libmemcached(3) memcached_strerror(3)
  91
  92 =cut
  93