4 <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
5 <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
9 <meta name=
"viewport" content=
"width=device-width, initial-scale=1.0">
11 <title>libmemcached Configuration
— libmemcached
1.0.99 documentation
</title>
20 <script type=
"text/javascript" src=
"../_static/js/modernizr.min.js"></script>
23 <script type=
"text/javascript" id=
"documentation_options" data-url_root=
"../" src=
"../_static/documentation_options.js"></script>
24 <script src=
"../_static/jquery.js"></script>
25 <script src=
"../_static/underscore.js"></script>
26 <script src=
"../_static/doctools.js"></script>
27 <script src=
"../_static/language_data.js"></script>
29 <script type=
"text/javascript" src=
"../_static/js/theme.js"></script>
34 <link rel=
"stylesheet" href=
"../_static/css/theme.css" type=
"text/css" />
35 <link rel=
"stylesheet" href=
"../_static/pygments.css" type=
"text/css" />
36 <link rel=
"index" title=
"Index" href=
"../genindex.html" />
37 <link rel=
"search" title=
"Search" href=
"../search.html" />
38 <link rel=
"copyright" title=
"Copyright" href=
"../copyright.html" />
39 <link rel=
"next" title=
"libmemcached Constants and Defaults" href=
"constants.html" />
40 <link rel=
"prev" title=
"Misc" href=
"index_misc.html" />
43 <body class=
"wy-body-for-nav">
46 <div class=
"wy-grid-for-nav">
48 <nav data-toggle=
"wy-nav-shift" class=
"wy-nav-side">
49 <div class=
"wy-side-scroll">
50 <div class=
"wy-side-nav-search" >
54 <a href=
"../index.html" class=
"icon icon-home"> libmemcached
71 <form id=
"rtd-search-form" class=
"wy-form" action=
"../search.html" method=
"get">
72 <input type=
"text" name=
"q" placeholder=
"Search docs" />
73 <input type=
"hidden" name=
"check_keywords" value=
"yes" />
74 <input type=
"hidden" name=
"area" value=
"default" />
81 <div class=
"wy-menu wy-menu-vertical" data-spy=
"affix" role=
"navigation" aria-label=
"main navigation">
88 <p class=
"caption"><span class=
"caption-text">libmemcached
</span></p>
90 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../libmemcached.html">Introduction
</a></li>
91 <li class=
"toctree-l1"><a class=
"reference internal" href=
"index.html">libmemcached API
</a><ul>
92 <li class=
"toctree-l2"><a class=
"reference internal" href=
"index_basics.html">Basics
</a></li>
93 <li class=
"toctree-l2"><a class=
"reference internal" href=
"index_data.html">Working with Data
</a></li>
94 <li class=
"toctree-l2"><a class=
"reference internal" href=
"index_errors.html">Messages and Errors
</a></li>
95 <li class=
"toctree-l2"><a class=
"reference internal" href=
"index_advanced.html">Advanced Topics
</a></li>
96 <li class=
"toctree-l2"><a class=
"reference internal" href=
"index_deprecated.html">Deprecated Functionality
</a></li>
99 <li class=
"toctree-l1 current"><a class=
"reference internal" href=
"index_misc.html">Misc
</a><ul class=
"current">
100 <li class=
"toctree-l2 current"><a class=
"current reference internal" href=
"#">Configuration
</a></li>
101 <li class=
"toctree-l2"><a class=
"reference internal" href=
"constants.html">Constants
</a></li>
102 <li class=
"toctree-l2"><a class=
"reference internal" href=
"examples.html">Examples
</a></li>
103 <li class=
"toctree-l2"><a class=
"reference internal" href=
"versioning.html">Versioning
</a></li>
107 <p class=
"caption"><span class=
"caption-text">libmemcachedutil
</span></p>
109 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../libmemcachedutil.html">Introduction
</a></li>
110 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../libmemcachedutil/index.html">libmemcachedutil API
</a><ul>
111 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../libmemcachedutil/memcached_pool.html">Working with memcached pools
</a></li>
115 <p class=
"caption"><span class=
"caption-text">libhashkit
</span></p>
117 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../libhashkit.html">Introduction
</a></li>
118 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../libhashkit/index.html">libhashkit API
</a><ul>
119 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../libhashkit/hashkit_create.html">Creating a hashkit structure
</a></li>
120 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../libhashkit/hashkit_function.html">Set Hash Function
</a></li>
121 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../libhashkit/hashkit_functions.html">Available Hashes
</a></li>
122 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../libhashkit/hashkit_value.html">Generate hash value
</a></li>
126 <p class=
"caption"><span class=
"caption-text">Client Applications
</span></p>
128 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../bin/index.html">Client Applications
</a><ul>
129 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../bin/memcapable.html">memcapable - Checking a Memcached server capabilities and compatibility
</a></li>
130 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../bin/memcat.html">memcat - “cat” data from a server
</a></li>
131 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../bin/memcp.html">memcp - Copy data to a server
</a></li>
132 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../bin/memdump.html">memdump - Dumping your server
</a></li>
133 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../bin/memerror.html">memerror - translate an error code to a string
</a></li>
134 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../bin/memflush.html">memflush - flush all data from a server
</a></li>
135 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../bin/memrm.html">memrm - Remove data from a server
</a></li>
136 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../bin/memslap.html">memslap - Load testing and benchmarking a server
</a></li>
137 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../bin/memaslap.html">memaslap - Load testing and benchmarking a server
</a></li>
138 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../bin/memstat.html">memstat - Gather statistics from a server
</a></li>
139 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../bin/memexist.html">memexist - Check for the existence of a key
</a></li>
140 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../bin/memparse.html">memparse - Parse an option string
</a></li>
141 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../bin/memping.html">memping - Test to see if a server is available.
</a></li>
142 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../bin/memtouch.html">memtouch - Touches a key.
</a></li>
153 <section data-toggle=
"wy-nav-shift" class=
"wy-nav-content-wrap">
156 <nav class=
"wy-nav-top" aria-label=
"top navigation">
158 <i data-toggle=
"wy-nav-top" class=
"fa fa-bars"></i>
159 <a href=
"../index.html">libmemcached
</a>
164 <div class=
"wy-nav-content">
166 <div class=
"rst-content">
184 <div role=
"navigation" aria-label=
"breadcrumbs navigation">
186 <ul class=
"wy-breadcrumbs">
188 <li><a href=
"../index.html">Docs
</a> »</li>
190 <li><a href=
"index_misc.html">Misc
</a> »</li>
192 <li>libmemcached Configuration
</li>
195 <li class=
"wy-breadcrumbs-aside">
206 <div role=
"main" class=
"document" itemscope=
"itemscope" itemtype=
"http://schema.org/Article">
207 <div itemprop=
"articleBody">
209 <div class=
"section" id=
"libmemcached-configuration">
210 <h1>libmemcached Configuration
<a class=
"headerlink" href=
"#libmemcached-configuration" title=
"Permalink to this headline">¶
</a></h1>
211 <div class=
"section" id=
"synopsis">
212 <h2>SYNOPSIS
<a class=
"headerlink" href=
"#synopsis" title=
"Permalink to this headline">¶
</a></h2>
214 <dt>#include
<libmemcached-
1.0/memcached.h
></dt><dd><p>Compile and link with -lmemcached
</p>
217 <dl class=
"function">
218 <dt id=
"_CPPv49memcachedPKc6size_t">
219 <span id=
"_CPPv39memcachedPKc6size_t"></span><span id=
"_CPPv29memcachedPKc6size_t"></span><span id=
"memcached__cCP.s"></span><a class=
"reference internal" href=
"memcached_create.html#_CPPv412memcached_st" title=
"memcached_st">memcached_st
</a> *
<code class=
"sig-name descname">memcached
</code><span class=
"sig-paren">(
</span><em class=
"property">const
</em> char *
<em>string
</em>, size_t
<em>string_length
</em><span class=
"sig-paren">)
</span><a class=
"headerlink" href=
"#_CPPv49memcachedPKc6size_t" title=
"Permalink to this definition">¶
</a><br /></dt>
222 <dl class=
"function">
223 <dt id=
"_CPPv432libmemcached_check_configurationPKc6size_tPc6size_t">
224 <span id=
"_CPPv332libmemcached_check_configurationPKc6size_tPc6size_t"></span><span id=
"_CPPv232libmemcached_check_configurationPKc6size_tPc6size_t"></span><span id=
"libmemcached_check_configuration__cCP.s.cP.s"></span><a class=
"reference internal" href=
"memcached_return_t.html#_CPPv418memcached_return_t" title=
"memcached_return_t">memcached_return_t
</a> <code class=
"sig-name descname">libmemcached_check_configuration
</code><span class=
"sig-paren">(
</span><em class=
"property">const
</em> char *
<em>option_string
</em>, size_t
<em>length
</em>, char *
<em>error_buffer
</em>, size_t
<em>error_buffer_size
</em><span class=
"sig-paren">)
</span><a class=
"headerlink" href=
"#_CPPv432libmemcached_check_configurationPKc6size_tPc6size_t" title=
"Permalink to this definition">¶
</a><br /></dt>
228 <div class=
"section" id=
"description">
229 <h2>DESCRIPTION
<a class=
"headerlink" href=
"#description" title=
"Permalink to this headline">¶
</a></h2>
230 <p><code class=
"xref cpp cpp-any docutils literal notranslate"><span class=
"pre">libmemcached
</span></code> implements a custom language for configuring and modifying
231 servers. By passing in an option string you can generate a
<a class=
"reference internal" href=
"memcached_create.html#_CPPv412memcached_st" title=
"memcached_st"><code class=
"xref cpp cpp-any docutils literal notranslate"><span class=
"pre">memcached_st
</span></code></a> object
232 that you can use in your application directly.
</p>
233 <div class=
"section" id=
"general-options">
234 <h3>General Options:
<a class=
"headerlink" href=
"#general-options" title=
"Permalink to this headline">¶
</a></h3>
235 <dl class=
"describe">
237 <code class=
"sig-name descname">--SERVER=
<servername
>:
<optional_port
>/?
<optional_weight
></code></dt>
238 <dd><p>Provide a servername to be used by the client.
</p>
239 <p>Providing a weight will cause weighting to occur with all hosts with each
240 server getting a default weight of
1.
</p>
243 <dl class=
"describe">
245 <code class=
"sig-name descname">--SOCKET=
"<filepath
>/?
<optional_weight
>"</code></dt>
246 <dd><p>Provide a filepath to a UNIX socket file. Providing a weight will cause
247 weighting to occur with all hosts with each server getting a default weight
251 <dl class=
"describe">
253 <code class=
"sig-name descname">--VERIFY-KEY
</code></dt>
254 <dd><p>Verify that keys that are being used fit within the design of the protocol
258 <dl class=
"describe">
260 <code class=
"sig-name descname">--REMOVE_FAILED_SERVERS
</code></dt>
261 <dd><p>Enable the behavior
<a class=
"reference internal" href=
"memcached_behavior.html#_CPPv4N20memcached_behavior_t40MEMCACHED_BEHAVIOR_REMOVE_FAILED_SERVERSE" title=
"MEMCACHED_BEHAVIOR_REMOVE_FAILED_SERVERS"><code class=
"xref cpp cpp-any docutils literal notranslate"><span class=
"pre">MEMCACHED_BEHAVIOR_REMOVE_FAILED_SERVERS
</span></code></a>.
</p>
264 <dl class=
"describe">
266 <code class=
"sig-name descname">--BINARY-PROTOCOL
</code></dt>
267 <dd><p>Force all connections to use the binary protocol.
</p>
270 <dl class=
"describe">
272 <code class=
"sig-name descname">--BUFFER-REQUESTS
</code></dt>
273 <dd><p>Please see
<a class=
"reference internal" href=
"memcached_behavior.html#_CPPv4N20memcached_behavior_t34MEMCACHED_BEHAVIOR_BUFFER_REQUESTSE" title=
"MEMCACHED_BEHAVIOR_BUFFER_REQUESTS"><code class=
"xref cpp cpp-any docutils literal notranslate"><span class=
"pre">MEMCACHED_BEHAVIOR_BUFFER_REQUESTS
</span></code></a>.
</p>
276 <dl class=
"describe">
278 <code class=
"sig-name descname">--CONFIGURE-FILE=
</code></dt>
279 <dd><p>Provide a configuration file to be used to load requests. Beware that by
280 using a configuration file
<code class=
"xref cpp cpp-any docutils literal notranslate"><span class=
"pre">libmemcached
</span></code> will reset
<a class=
"reference internal" href=
"memcached_create.html#_CPPv412memcached_st" title=
"memcached_st"><code class=
"xref cpp cpp-any docutils literal notranslate"><span class=
"pre">memcached_st
</span></code></a> based
281 on information only contained in the file.
</p>
284 <dl class=
"describe">
286 <code class=
"sig-name descname">--CONNECT-TIMEOUT=
</code></dt>
287 <dd><p>See
<a class=
"reference internal" href=
"memcached_behavior.html#_CPPv422memcached_behavior_setP12memcached_st20memcached_behavior_t8uint64_t" title=
"memcached_behavior_set"><code class=
"xref cpp cpp-any docutils literal notranslate"><span class=
"pre">memcached_behavior_set()
</span></code></a> for
<a class=
"reference internal" href=
"memcached_behavior.html#_CPPv4N20memcached_behavior_t34MEMCACHED_BEHAVIOR_CONNECT_TIMEOUTE" title=
"MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT"><code class=
"xref cpp cpp-any docutils literal notranslate"><span class=
"pre">MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT
</span></code></a>.
</p>
290 <dl class=
"describe">
292 <code class=
"sig-name descname">--DISTRIBUTION=
</code></dt>
293 <dd><p>Set the distribution model used by the client.
294 See
<a class=
"reference internal" href=
"memcached_behavior.html#_CPPv422memcached_behavior_setP12memcached_st20memcached_behavior_t8uint64_t" title=
"memcached_behavior_set"><code class=
"xref cpp cpp-any docutils literal notranslate"><span class=
"pre">memcached_behavior_set()
</span></code></a> for more details.
</p>
297 <dl class=
"describe">
299 <code class=
"sig-name descname">--HASH=
</code></dt>
300 <dd><p>Set the hashing algorithm used for placing keys on servers.
</p>
303 <dl class=
"describe">
305 <code class=
"sig-name descname">--HASH-WITH-NAMESPACE
</code></dt>
306 <dd><p>When enabled the prefix key will be added to the key when determining which
307 server to store the data in.
</p>
310 <dl class=
"describe">
312 <code class=
"sig-name descname">--NOREPLY
</code></dt>
313 <dd><p>Enable “no reply” for all calls that support this. It is highly recommended
314 that you use this option with the binary protocol only.
</p>
317 <dl class=
"describe">
319 <code class=
"sig-name descname">--NUMBER-OF-REPLICAS=
</code></dt>
320 <dd><p>Set the number of servers that keys will be replicated to.
</p>
323 <dl class=
"describe">
325 <code class=
"sig-name descname">--RANDOMIZE-REPLICA-READ
</code></dt>
326 <dd><p>Select randomly the server within the replication pool to read from.
</p>
329 <dl class=
"describe">
331 <code class=
"sig-name descname">--SORT-HOSTS
</code></dt>
332 <dd><p>When adding new servers always calculate their distribution based on sorted
336 <dl class=
"describe">
338 <code class=
"sig-name descname">--SUPPORT-CAS
</code></dt>
339 <dd><p>See
<a class=
"reference internal" href=
"memcached_behavior.html#_CPPv422memcached_behavior_setP12memcached_st20memcached_behavior_t8uint64_t" title=
"memcached_behavior_set"><code class=
"xref cpp cpp-any docutils literal notranslate"><span class=
"pre">memcached_behavior_set()
</span></code></a> for
<a class=
"reference internal" href=
"memcached_behavior.html#_CPPv4N20memcached_behavior_t30MEMCACHED_BEHAVIOR_SUPPORT_CASE" title=
"MEMCACHED_BEHAVIOR_SUPPORT_CAS"><code class=
"xref cpp cpp-any docutils literal notranslate"><span class=
"pre">MEMCACHED_BEHAVIOR_SUPPORT_CAS
</span></code></a></p>
342 <dl class=
"describe">
344 <code class=
"sig-name descname">--USE-UDP
</code></dt>
345 <dd><p>See
<a class=
"reference internal" href=
"memcached_behavior.html#_CPPv422memcached_behavior_setP12memcached_st20memcached_behavior_t8uint64_t" title=
"memcached_behavior_set"><code class=
"xref cpp cpp-any docutils literal notranslate"><span class=
"pre">memcached_behavior_set()
</span></code></a> for
<a class=
"reference internal" href=
"memcached_behavior.html#_CPPv4N20memcached_behavior_t26MEMCACHED_BEHAVIOR_USE_UDPE" title=
"MEMCACHED_BEHAVIOR_USE_UDP"><code class=
"xref cpp cpp-any docutils literal notranslate"><span class=
"pre">MEMCACHED_BEHAVIOR_USE_UDP
</span></code></a></p>
348 <dl class=
"describe">
350 <code class=
"sig-name descname">--NAMESPACE=
</code></dt>
351 <dd><p>A namespace is a container that provides context for keys, only other
352 requests that know the namespace can access these values. This is
353 accomplished by prepending the namespace value to all keys.
</p>
357 <div class=
"section" id=
"memcached-pool-options">
358 <h3>Memcached Pool Options:
<a class=
"headerlink" href=
"#memcached-pool-options" title=
"Permalink to this headline">¶
</a></h3>
359 <dl class=
"describe">
361 <code class=
"sig-name descname">--POOL-MIN
</code></dt>
362 <dd><p>Initial size of pool.
</p>
365 <dl class=
"describe">
367 <code class=
"sig-name descname">--POOL-MAX
</code></dt>
368 <dd><p>Maximize size of the pool.
</p>
372 <div class=
"section" id=
"i-o-options">
373 <h3>I/O Options:
<a class=
"headerlink" href=
"#i-o-options" title=
"Permalink to this headline">¶
</a></h3>
374 <dl class=
"describe">
376 <code class=
"sig-name descname">--TCP-NODELAY
</code></dt>
377 <dd><p>See
<a class=
"reference internal" href=
"memcached_behavior.html#_CPPv422memcached_behavior_setP12memcached_st20memcached_behavior_t8uint64_t" title=
"memcached_behavior_set"><code class=
"xref cpp cpp-any docutils literal notranslate"><span class=
"pre">memcached_behavior_set()
</span></code></a> for
<a class=
"reference internal" href=
"memcached_behavior.html#_CPPv4N20memcached_behavior_t30MEMCACHED_BEHAVIOR_TCP_NODELAYE" title=
"MEMCACHED_BEHAVIOR_TCP_NODELAY"><code class=
"xref cpp cpp-any docutils literal notranslate"><span class=
"pre">MEMCACHED_BEHAVIOR_TCP_NODELAY
</span></code></a></p>
380 <dl class=
"describe">
382 <code class=
"sig-name descname">--TCP-KEEPALIVE
</code></dt>
383 <dd><p>See
<a class=
"reference internal" href=
"memcached_behavior.html#_CPPv422memcached_behavior_setP12memcached_st20memcached_behavior_t8uint64_t" title=
"memcached_behavior_set"><code class=
"xref cpp cpp-any docutils literal notranslate"><span class=
"pre">memcached_behavior_set()
</span></code></a> for
<code class=
"xref cpp cpp-any docutils literal notranslate"><span class=
"pre">MEMCACHED_BEHAVIOR_TCP_KEEPALIVE
</span></code></p>
386 <dl class=
"describe">
388 <code class=
"sig-name descname">--RETRY-TIMEOUT=
</code></dt>
389 <dd><p>See
<a class=
"reference internal" href=
"memcached_behavior.html#_CPPv422memcached_behavior_setP12memcached_st20memcached_behavior_t8uint64_t" title=
"memcached_behavior_set"><code class=
"xref cpp cpp-any docutils literal notranslate"><span class=
"pre">memcached_behavior_set()
</span></code></a> for
<a class=
"reference internal" href=
"memcached_behavior.html#_CPPv4N20memcached_behavior_t32MEMCACHED_BEHAVIOR_RETRY_TIMEOUTE" title=
"MEMCACHED_BEHAVIOR_RETRY_TIMEOUT"><code class=
"xref cpp cpp-any docutils literal notranslate"><span class=
"pre">MEMCACHED_BEHAVIOR_RETRY_TIMEOUT
</span></code></a></p>
392 <dl class=
"describe">
394 <code class=
"sig-name descname">--SERVER-FAILURE-LIMIT=
</code></dt>
395 <dd><p>See
<a class=
"reference internal" href=
"memcached_behavior.html#_CPPv422memcached_behavior_setP12memcached_st20memcached_behavior_t8uint64_t" title=
"memcached_behavior_set"><code class=
"xref cpp cpp-any docutils literal notranslate"><span class=
"pre">memcached_behavior_set()
</span></code></a> for
<a class=
"reference internal" href=
"memcached_behavior.html#_CPPv4N20memcached_behavior_t39MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMITE" title=
"MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT"><code class=
"xref cpp cpp-any docutils literal notranslate"><span class=
"pre">MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT
</span></code></a></p>
398 <dl class=
"describe">
400 <code class=
"sig-name descname">--SND-TIMEOUT=
</code></dt>
401 <dd><p>See
<a class=
"reference internal" href=
"memcached_behavior.html#_CPPv422memcached_behavior_setP12memcached_st20memcached_behavior_t8uint64_t" title=
"memcached_behavior_set"><code class=
"xref cpp cpp-any docutils literal notranslate"><span class=
"pre">memcached_behavior_set()
</span></code></a> for
<a class=
"reference internal" href=
"memcached_behavior.html#_CPPv4N20memcached_behavior_t30MEMCACHED_BEHAVIOR_SND_TIMEOUTE" title=
"MEMCACHED_BEHAVIOR_SND_TIMEOUT"><code class=
"xref cpp cpp-any docutils literal notranslate"><span class=
"pre">MEMCACHED_BEHAVIOR_SND_TIMEOUT
</span></code></a></p>
404 <dl class=
"describe">
406 <code class=
"sig-name descname">--SOCKET-RECV-SIZE=
</code></dt>
407 <dd><p>See
<a class=
"reference internal" href=
"memcached_behavior.html#_CPPv422memcached_behavior_setP12memcached_st20memcached_behavior_t8uint64_t" title=
"memcached_behavior_set"><code class=
"xref cpp cpp-any docutils literal notranslate"><span class=
"pre">memcached_behavior_set()
</span></code></a> for
<a class=
"reference internal" href=
"memcached_behavior.html#_CPPv4N20memcached_behavior_t35MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZEE" title=
"MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE"><code class=
"xref cpp cpp-any docutils literal notranslate"><span class=
"pre">MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE
</span></code></a></p>
410 <dl class=
"describe">
412 <code class=
"sig-name descname">--SOCKET-SEND-SIZE=
</code></dt>
413 <dd><p>See
<a class=
"reference internal" href=
"memcached_behavior.html#_CPPv422memcached_behavior_setP12memcached_st20memcached_behavior_t8uint64_t" title=
"memcached_behavior_set"><code class=
"xref cpp cpp-any docutils literal notranslate"><span class=
"pre">memcached_behavior_set()
</span></code></a> for
<a class=
"reference internal" href=
"memcached_behavior.html#_CPPv4N20memcached_behavior_t35MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZEE" title=
"MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE"><code class=
"xref cpp cpp-any docutils literal notranslate"><span class=
"pre">MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE
</span></code></a></p>
416 <dl class=
"describe">
418 <code class=
"sig-name descname">--POLL-TIMEOUT=
</code></dt>
419 <dd><p>Set the timeout used by
<em class=
"manpage"><a class=
"manpage reference external" href=
"http://man7.org/linux/man-pages/man3/poll.3.html">poll(
3)
</a></em>.
</p>
422 <dl class=
"describe">
424 <code class=
"sig-name descname">--IO-BYTES-WATERMARK=
</code></dt>
427 <dl class=
"describe">
429 <code class=
"sig-name descname">--IO-KEY-PREFETCH=
</code></dt>
432 <dl class=
"describe">
434 <code class=
"sig-name descname">--IO-MSG-WATERMARK=
</code></dt>
437 <dl class=
"describe">
439 <code class=
"sig-name descname">--TCP-KEEPIDLE
</code></dt>
442 <dl class=
"describe">
444 <code class=
"sig-name descname">--RCV-TIMEOUT=
</code></dt>
448 <div class=
"section" id=
"other-options">
449 <h3>Other Options:
<a class=
"headerlink" href=
"#other-options" title=
"Permalink to this headline">¶
</a></h3>
450 <dl class=
"describe">
452 <code class=
"sig-name descname">INCLUDE
</code></dt>
453 <dd><p>Include a file in configuration.
454 Unlike –CONFIGURE-FILE= this will not reset
<a class=
"reference internal" href=
"memcached_create.html#_CPPv412memcached_st" title=
"memcached_st"><code class=
"xref cpp cpp-any docutils literal notranslate"><span class=
"pre">memcached_st
</span></code></a>.
</p>
457 <dl class=
"describe">
459 <code class=
"sig-name descname">RESET
</code></dt>
460 <dd><p>Reset
<a class=
"reference internal" href=
"memcached_create.html#_CPPv412memcached_st" title=
"memcached_st"><code class=
"xref cpp cpp-any docutils literal notranslate"><span class=
"pre">memcached_st
</span></code></a> and continue to process.
</p>
463 <dl class=
"describe">
465 <code class=
"sig-name descname">END
</code></dt>
466 <dd><p>End configuration processing.
</p>
469 <dl class=
"describe">
471 <code class=
"sig-name descname">ERROR
</code></dt>
472 <dd><p>End configuration processing and throw an error.
</p>
477 <div class=
"section" id=
"environment">
478 <h2>ENVIRONMENT
<a class=
"headerlink" href=
"#environment" title=
"Permalink to this headline">¶
</a></h2>
480 <dt id=
"envvar-LIBMEMCACHED">
481 <code class=
"sig-name descname">LIBMEMCACHED
</code><a class=
"headerlink" href=
"#envvar-LIBMEMCACHED" title=
"Permalink to this definition">¶
</a></dt>
485 <div class=
"section" id=
"return-value">
486 <h2>RETURN VALUE
<a class=
"headerlink" href=
"#return-value" title=
"Permalink to this headline">¶
</a></h2>
487 <p><a class=
"reference internal" href=
"#_CPPv49memcachedPKc6size_t" title=
"memcached"><code class=
"xref cpp cpp-func docutils literal notranslate"><span class=
"pre">memcached()
</span></code></a> returns a pointer to the memcached_st that was
488 created (or initialized). On an allocation failure, it returns NULL.
</p>
490 <div class=
"section" id=
"example">
491 <h2>EXAMPLE
<a class=
"headerlink" href=
"#example" title=
"Permalink to this headline">¶
</a></h2>
492 <div class=
"highlight-c notranslate"><div class=
"highlight"><pre><span></span><span class=
"k">const
</span> <span class=
"kt">char
</span> <span class=
"o">*
</span><span class=
"n">config_string
</span><span class=
"o">=
</span>
493 <span class=
"s">"--SERVER=host10.example.com
"</span>
494 <span class=
"s">"--SERVER=host11.example.com
"</span>
495 <span class=
"s">"--SERVER=host10.example.com
"</span><span class=
"p">;
</span>
496 <span class=
"n">memcached_st
</span> <span class=
"o">*
</span><span class=
"n">memc
</span><span class=
"o">=
</span> <span class=
"n">memcached
</span><span class=
"p">(
</span><span class=
"n">config_string
</span><span class=
"p">,
</span> <span class=
"n">strlen
</span><span class=
"p">(
</span><span class=
"n">config_string
</span><span class=
"p">));
</span>
497 <span class=
"p">{
</span>
498 <span class=
"c1">// ...
</span>
499 <span class=
"p">}
</span>
500 <span class=
"n">memcached_free
</span><span class=
"p">(
</span><span class=
"n">memc
</span><span class=
"p">);
</span>
504 <div class=
"section" id=
"see-also">
505 <h2>SEE ALSO
<a class=
"headerlink" href=
"#see-also" title=
"Permalink to this headline">¶
</a></h2>
507 <li><p><em class=
"manpage"><a class=
"manpage reference external" href=
"http://man7.org/linux/man-pages/man1/memcached.1.html">memcached(
1)
</a></em></p></li>
508 <li><p><a class=
"reference internal" href=
"../libmemcached.html"><span class=
"doc">C/C++ Client Library for memcached
</span></a></p></li>
509 <li><p><a class=
"reference internal" href=
"memcached_strerror.html"><span class=
"doc">Converting Error Codes to Messages
</span></a></p></li>
520 <div class=
"rst-footer-buttons" role=
"navigation" aria-label=
"footer navigation">
522 <a href=
"constants.html" class=
"btn btn-neutral float-right" title=
"libmemcached Constants and Defaults" accesskey=
"n" rel=
"next">Next
<span class=
"fa fa-arrow-circle-right"></span></a>
525 <a href=
"index_misc.html" class=
"btn btn-neutral float-left" title=
"Misc" accesskey=
"p" rel=
"prev"><span class=
"fa fa-arrow-circle-left"></span> Previous
</a>
532 <div role=
"contentinfo">
534 © <a href=
"../copyright.html">Copyright
</a>
538 Built with
<a href=
"http://sphinx-doc.org/">Sphinx
</a> using a
<a href=
"https://github.com/rtfd/sphinx_rtd_theme">theme
</a> provided by
<a href=
"https://readthedocs.org">Read the Docs
</a>.
551 <script type=
"text/javascript">
553 SphinxRtdTheme.Navigation.enable(true);