~brianaker/libmemcached/1164440

« back to all changes in this revision

Viewing changes to docs/man/memcached_add_by_key.3

  • Committer: Continuous Integration
  • Date: 2012-03-14 16:53:36 UTC
  • mfrom: (990.2.1 workspace)
  • Revision ID: ci@tangent.org-20120314165336-mjrg2hwmb6sx1er2
jenkins-promote-staging-trunk-libmemcached-3

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
.TH "MEMCACHED_ADD_BY_KEY" "3" "January 26, 2012" "1.0.4" "libmemcached"
 
1
.TH "MEMCACHED_ADD_BY_KEY" "3" "March 14, 2012" "1.0.5" "libmemcached"
2
2
.SH NAME
3
3
memcached_add_by_key \- Storing and Replacing Data
4
4
.
35
35
#include <libmemcached/memcached.h>
36
36
.INDENT 0.0
37
37
.TP
38
 
.B memcached_return_t memcached_set (memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags);
39
 
.UNINDENT
40
 
.INDENT 0.0
41
 
.TP
42
 
.B memcached_return_t memcached_add (memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags);
43
 
.UNINDENT
44
 
.INDENT 0.0
45
 
.TP
46
 
.B memcached_return_t memcached_replace (memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags);
47
 
.UNINDENT
48
 
.INDENT 0.0
49
 
.TP
50
 
.B memcached_return_t memcached_set_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags);
51
 
.UNINDENT
52
 
.INDENT 0.0
53
 
.TP
54
 
.B memcached_return_t memcached_add_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags);
55
 
.UNINDENT
56
 
.INDENT 0.0
57
 
.TP
58
 
.B memcached_return_t memcached_replace_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags);
 
38
.B memcached_return_t memcached_set(memcached_st\fI\ *ptr\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, const char\fI\ *value\fP, size_t\fI\ value_length\fP, time_t\fI\ expiration\fP, uint32_t\fI\ flags\fP)
 
39
.UNINDENT
 
40
.INDENT 0.0
 
41
.TP
 
42
.B memcached_return_t memcached_add(memcached_st\fI\ *ptr\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, const char\fI\ *value\fP, size_t\fI\ value_length\fP, time_t\fI\ expiration\fP, uint32_t\fI\ flags\fP)
 
43
.UNINDENT
 
44
.INDENT 0.0
 
45
.TP
 
46
.B memcached_return_t memcached_replace(memcached_st\fI\ *ptr\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, const char\fI\ *value\fP, size_t\fI\ value_length\fP, time_t\fI\ expiration\fP, uint32_t\fI\ flags\fP)
 
47
.UNINDENT
 
48
.INDENT 0.0
 
49
.TP
 
50
.B memcached_return_t memcached_set_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, const char\fI\ *value\fP, size_t\fI\ value_length\fP, time_t\fI\ expiration\fP, uint32_t\fI\ flags\fP)
 
51
.UNINDENT
 
52
.INDENT 0.0
 
53
.TP
 
54
.B memcached_return_t memcached_add_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, const char\fI\ *value\fP, size_t\fI\ value_length\fP, time_t\fI\ expiration\fP, uint32_t\fI\ flags\fP)
 
55
.UNINDENT
 
56
.INDENT 0.0
 
57
.TP
 
58
.B memcached_return_t memcached_replace_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, const char\fI\ *value\fP, size_t\fI\ value_length\fP, time_t\fI\ expiration\fP, uint32_t\fI\ flags\fP)
59
59
.UNINDENT
60
60
.sp
61
61
Compile and link with \-lmemcached
62
62
.SH DESCRIPTION
63
63
.sp
64
 
\fBmemcached_set()\fP, \fBmemcached_add()\fP, and \fBmemcached_replace()\fP are all used to store information on the server. All methods take a key, and its length to store the object. Keys are currently limited to 250 characters when using either a version of memcached(1) which is 1.4 or below, or when using the text protocol. You must supply both a value and a length. Optionally you
 
64
\fI\%memcached_set()\fP, \fI\%memcached_add()\fP, and \fI\%memcached_replace()\fP are all used to store information on the server. All methods take a key, and its length to store the object. Keys are currently limited to 250 characters when using either a version of memcached(1) which is 1.4 or below, or when using the text protocol. You must supply both a value and a length. Optionally you
65
65
store the object. Keys are currently limited to 250 characters by the
66
66
memcached(1) server. You must supply both a value and a length. Optionally you
67
67
may test an expiration time for the object and a 16 byte value (it is meant to be used as a bitmap). "flags" is a 4byte space that is stored alongside of the main value. Many sub libraries make use of this field, so in most cases users should avoid making use of it.
68
68
.sp
69
 
\fBmemcached_set()\fP will write an object to the server. If an object
 
69
\fI\%memcached_set()\fP will write an object to the server. If an object
70
70
already exists it will overwrite what is in the server. If the object does not
71
71
exist it will be written. If you are using the non\-blocking mode this function
72
72
will always return true unless a network error occurs.
73
73
.sp
74
 
\fBmemcached_replace()\fP replaces an object on the server. If the object is not found on the server an error occurs.
 
74
\fI\%memcached_replace()\fP replaces an object on the server. If the object is not found on the server an error occurs.
75
75
.sp
76
 
\fBmemcached_add()\fP adds an object to the server. If the object is found on the server an error occurs, otherwise the value is stored.
 
76
\fI\%memcached_add()\fP adds an object to the server. If the object is found on the server an error occurs, otherwise the value is stored.
77
77
.sp
78
78
\fBmemcached_cas()\fP overwrites data in the server as long as the "cas"
79
79
value is still the same in the server. You can get the cas value of a result by
80
80
calling \fBmemcached_result_cas()\fP on a memcached_result_st(3) structure. At the point
81
81
that this note was written cas is still buggy in memached. Turning on tests
82
 
for it in libmemcached(3) is optional. Please see memcached_set() for
 
82
for it in libmemcached(3) is optional. Please see memcached_set for
83
83
information on how to do this.
84
84
.sp
85
 
\fBmemcached_set_by_key()\fP, \fBmemcached_add_by_key()\fP, and \fBmemcached_replace_by_key()\fP methods all behave in a similar method as the non
 
85
\fI\%memcached_set_by_key()\fP, \fI\%memcached_add_by_key()\fP, and \fI\%memcached_replace_by_key()\fP methods all behave in a similar method as the non
86
86
key methods. The difference is that they use their group_key parameter to map
87
87
objects to particular servers.
88
88
.sp
89
 
If you are looking for performance, \fBmemcached_set()\fP with non\-blocking IO is the fastest way to store data on the server.
 
89
If you are looking for performance, \fI\%memcached_set()\fP with non\-blocking IO is the fastest way to store data on the server.
90
90
.sp
91
91
All of the above functions are testsed with the \fBMEMCACHED_BEHAVIOR_USE_UDP\fP behavior enabled. However, when using these operations with this behavior
92
92
on, there are limits to the size of the payload being sent to the server.
104
104
On success the value will be \fBMEMCACHED_SUCCESS\fP.
105
105
Use \fBmemcached_strerror()\fP to translate this value to a printable string.
106
106
.sp
107
 
For \fBmemcached_replace()\fP and \fBmemcached_add()\fP, \fBMEMCACHED_NOTSTORED\fP is a legitmate error in the case of a collision.
 
107
For \fI\%memcached_replace()\fP and \fI\%memcached_add()\fP, \fBMEMCACHED_NOTSTORED\fP is a legitmate error in the case of a collision.
108
108
.SH HOME
109
109
.sp
110
110
To find out more information please check: