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

   1 =head1 NAME
   2
   3 memcached_set, memcached_add, memcached_replace
   4
   5 =head1 LIBRARY
   6
   7 C Client Library for memcached (libmemcached, -lmemcached)
   8
   9 =head1 SYNOPSIS
  10
  11   #include <memcached.h>
  12
  13   memcached_return
  14     memcached_set (memcached_st *ptr,
  15                    char *key, size_t key_length,
  16                    char *value, size_t value_length,
  17                    time_t expiration,
  18                    uint16_t flags);
  19
  20   memcached_return
  21     memcached_add (memcached_st *ptr,
  22                    char *key, size_t key_length,
  23                    char *value, size_t value_length,
  24                    time_t expiration,
  25                    uint16_t flags);
  26
  27   memcached_return
  28     memcached_replace (memcached_st *ptr,
  29                        char *key, size_t key_length,
  30                        char *value, size_t value_length,
  31                        time_t expiration,
  32                        uint16_t flags);
  33
  34   memcached_return
  35     memcached_prepend(memcached_st *ptr,
  36                       char *key, size_t key_length,
  37                       char *value, size_t value_length,
  38                       time_t expiration,
  39                       uint16_t flags)
  40
  41   memcached_return
  42     memcached_append(memcached_st *ptr,
  43                      char *key, size_t key_length,
  44                       char *value, size_t value_length,
  45                       time_t expiration,
  46                       uint16_t flags)
  47
  48 =head1 DESCRIPTION
  49
  50 memcached_set(), memcached_add(), and memcached_replace() are all used to
  51 store information on the server. All methods take a key, and its length to
  52 store the object. Keys are currently limited to 250 characters by the
  53 memcached(1) server. You must also supply a value and a length. Optionally you
  54 may support an expiration time for the object and a 16 byte value (it is
  55 meant to be used as a bitmap).
  56
  57 memcached_set() will write an object to the server. If an object already
  58 exists it will overwrite what is in the server. If the object does not exist
  59 it will be written. If you are using the non-blocking mode this function
  60 will always return true unless a network error occurs.
  61
  62 memcached_replace() replaces an object on the server. If the object is not
  63 found on the server an error occurs.
  64
  65 memcached_add() adds an object to the server. If the object is found on the
  66 server an error occurs, otherwise the value is stored.
  67
  68 memcached_prepend() places a segment of data before the last piece of data
  69 stored. Currently expiration and key are not used in the server.
  70
  71 memcached_append() places a segment of data at the end of the last piece of
  72 data stored. Currently expiration and key are not used in the server.
  73
  74 memcached_set() with non-blocking IO is the fastest way to store data on the
  75 server.
  76
  77 =head1 RETURN
  78
  79 All methods return a value of type C<memcached_return>.
  80 On success the value will be C<MEMCACHED_SUCCESS>.
  81 Use memcached_strerror() to translate this value to a printable string.
  82
  83 For memcached_replace() and memcached_add(), C<MEMCACHED_NOTSTORED> is a
  84 legitmate error in the case of a collision.
  85
  86 =head1 HOME
  87
  88 To find out more information please check:
  89 L<http://tangent.org/552/libmemcached.html>
  90
  91 =head1 AUTHOR
  92
  93 Brian Aker, E<lt>brian@tangent.orgE<gt>
  94
  95 =head1 SEE ALSO
  96
  97 memcached(1) libmemached(3) memcached_strerror(3)
  98
  99 =cut
 100