1LIBMEMCACHED_CONFIGURATION(3)libmemcached-awesomeLIBMEMCACHED_CONFIGURATION(3)
2
6 libmemcached_configuration - libmemcached Documentation
7
9 #include <libmemcached-1.0/memcached.h>
10 Compile and link with -lmemcached
11 memcached_st *memcached(const char *string, size_t string_length)
13 Parameters
15 • string -- configuration string
17 • string_length -- length of the configuration string
19 without any terminating zero
20 Returns
22 allocated and initialized memcached_st struct
23 memcached_return_t libmemcached_check_configuration(const char *op‐
25 tion_string, size_t length, char *error_buffer, size_t error_buf‐
26 fer_size)
27 Parameters
29 • option_string -- configuration string
31 • length -- length of the configuration string without
33 any terminating zero
34 • error_buffer -- buffer used to store any error message
36 • error_buffer_size -- available size of the error_buffer
38 Returns
40 memcached_return_t indicating success
41
43 libmemcached implements a custom language for configuring and modifying
44 servers. By passing in an option string you can generate a memcached_st
45 object that you can use in your application directly.
46 General Options:
48 --SERVER=<servername>:<optional_port>/?<optional_weight>
49 Provide a servername to be used by the client.
50 Providing a weight will cause weighting to occur with all hosts
52 with each server getting a default weight of 1.
53 --SOCKET=\"<filepath>/?<optional_weight>\"
55 Provide a filepath to a UNIX socket file. Providing a weight
56 will cause weighting to occur with all hosts with each server
57 getting a default weight of 1.
58 --VERIFY-KEY
60 Verify that keys that are being used fit within the design of
61 the protocol being used.
62 --REMOVE_FAILED_SERVERS
64 Enable the behavior MEMCACHED_BEHAVIOR_REMOVE_FAILED_SERVERS.
65 --BINARY-PROTOCOL
67 Force all connections to use the binary protocol.
68 --BUFFER-REQUESTS
70 Please see MEMCACHED_BEHAVIOR_BUFFER_REQUESTS.
71 --CONFIGURE-FILE=
73 Provide a configuration file to be used to load requests. Beware
74 that by using a configuration file libmemcached will reset
75 memcached_st based on information only contained in the file.
76 --CONNECT-TIMEOUT=
78 See memcached_behavior_set() for
79 MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT.
80 --DISTRIBUTION=
82 Set the distribution model used by the client. See
83 memcached_behavior_set() for more details.
84 --HASH=
86 Set the hashing algorithm used for placing keys on servers.
87 --HASH-WITH-NAMESPACE
89 When enabled the prefix key will be added to the key when deter‐
90 mining which server to store the data in.
91 --NOREPLY
93 Enable "no reply" for all calls that support this. It is highly
94 recommended that you use this option with the binary protocol
95 only.
96 --NUMBER-OF-REPLICAS=
98 Set the number of servers that keys will be replicated to.
99 --RANDOMIZE-REPLICA-READ
101 Select randomly the server within the replication pool to read
102 from.
103 --SORT-HOSTS
105 When adding new servers always calculate their distribution
106 based on sorted naming order.
107 --SUPPORT-CAS
109 See memcached_behavior_set() for MEMCACHED_BEHAVIOR_SUPPORT_CAS
110 --USE-UDP
112 See memcached_behavior_set() for MEMCACHED_BEHAVIOR_USE_UDP
113 --NAMESPACE=
115 A namespace is a container that provides context for keys, only
116 other requests that know the namespace can access these values.
117 This is accomplished by prepending the namespace value to all
118 keys.
119 Memcached Pool Options:
121 --POOL-MIN
122 Initial size of pool.
123 --POOL-MAX
125 Maximize size of the pool.
126 I/O Options:
128 --TCP-NODELAY
129 See memcached_behavior_set() for MEMCACHED_BEHAVIOR_TCP_NODELAY
130 --TCP-KEEPALIVE
132 See memcached_behavior_set() for MEMCACHED_BEHAV‐
133 IOR_TCP_KEEPALIVE
134 --RETRY-TIMEOUT=
136 See memcached_behavior_set() for
137 MEMCACHED_BEHAVIOR_RETRY_TIMEOUT
138 --SERVER-FAILURE-LIMIT=
140 See memcached_behavior_set() for
141 MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT
142 --SND-TIMEOUT=
144 See memcached_behavior_set() for MEMCACHED_BEHAVIOR_SND_TIMEOUT
145 --SOCKET-RECV-SIZE=
147 See memcached_behavior_set() for
148 MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE
149 --SOCKET-SEND-SIZE=
151 See memcached_behavior_set() for
152 MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE
153 --POLL-TIMEOUT=
155 Set the timeout used by poll(3).
156 --IO-BYTES-WATERMARK=
158 --IO-KEY-PREFETCH=
160 --IO-MSG-WATERMARK=
162 --TCP-KEEPIDLE
164 --RCV-TIMEOUT=
166 Other Options:
168 INCLUDE
169 Include a file in configuration. Unlike --CONFIGURE-FILE= this
170 will not reset memcached_st.
171 RESET Reset memcached_st and continue to process.
173 END End configuration processing.
175 ERROR End configuration processing and throw an error.
177
179 LIBMEMCACHED
180
182 memcached() returns a pointer to the memcached_st that was created (or
183 initialized). On an allocation failure, it returns NULL.
184
186 const char *config_string=
187 "--SERVER=host10.example.com "
188 "--SERVER=host11.example.com "
189 "--SERVER=host10.example.com";
190 memcached_st *memc= memcached(config_string, strlen(config_string));
191 {
192 // ...
193 }
194 memcached_free(memc);
195
197 memcached(1) libmemcached(3) memcached_strerror(3)
1981.1 Mar 06, 2023 LIBMEMCACHED_CONFIGURATION(3)