git.m6w6.name Git - awesomized/libmemcached/blob - libmemcached/configuration.html

   1
   2
   3 <!DOCTYPE html>
   4 <html class="writer-html5" lang="en" >
   5 <head>
   6   <meta charset="utf-8">
   7
   8   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   9
  10   <title>libmemcached Configuration &mdash; libmemcached 1.0.99 documentation</title>
  11
  12
  13
  14   <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
  15   <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
  16
  17
  18
  19
  20
  21
  22
  23   <!--[if lt IE 9]>
  24     <script src="../_static/js/html5shiv.min.js"></script>
  25   <![endif]-->
  26
  27
  28       <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
  29         <script src="../_static/jquery.js"></script>
  30         <script src="../_static/underscore.js"></script>
  31         <script src="../_static/doctools.js"></script>
  32         <script src="../_static/language_data.js"></script>
  33
  34     <script type="text/javascript" src="../_static/js/theme.js"></script>
  35
  36
  37     <link rel="index" title="Index" href="../genindex.html" />
  38     <link rel="search" title="Search" href="../search.html" />
  39     <link rel="copyright" title="Copyright" href="../copyright.html" />
  40     <link rel="next" title="libmemcached Constants and Defaults" href="constants.html" />
  41     <link rel="prev" title="Misc" href="index_misc.html" />
  42 </head>
  43
  44 <body class="wy-body-for-nav">
  45
  46
  47   <div class="wy-grid-for-nav">
  48
  49     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
  50       <div class="wy-side-scroll">
  51         <div class="wy-side-nav-search" >
  52
  53
  54
  55             <a href="../index.html" class="icon icon-home" alt="Documentation Home"> libmemcached
  56
  57
  58
  59           </a>
  60
  61
  62
  63
  64               <div class="version">
  65                 1.0
  66               </div>
  67
  68
  69
  70
  71 <div role="search">
  72   <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
  73     <input type="text" name="q" placeholder="Search docs" />
  74     <input type="hidden" name="check_keywords" value="yes" />
  75     <input type="hidden" name="area" value="default" />
  76   </form>
  77 </div>
  78
  79
  80         </div>
  81
  82
  83         <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
  84
  85
  86
  87
  88
  89
  90               <p class="caption"><span class="caption-text">libmemcached</span></p>
  91 <ul class="current">
  92 <li class="toctree-l1"><a class="reference internal" href="../libmemcached.html">Introduction</a></li>
  93 <li class="toctree-l1"><a class="reference internal" href="index.html">libmemcached API</a></li>
  94 <li class="toctree-l1 current"><a class="reference internal" href="index_misc.html">Misc</a><ul class="current">
  95 <li class="toctree-l2 current"><a class="current reference internal" href="#">Configuration</a></li>
  96 <li class="toctree-l2"><a class="reference internal" href="constants.html">Constants</a></li>
  97 <li class="toctree-l2"><a class="reference internal" href="examples.html">Examples</a></li>
  98 <li class="toctree-l2"><a class="reference internal" href="versioning.html">Versioning</a></li>
  99 </ul>
 100 </li>
 101 </ul>
 102 <p class="caption"><span class="caption-text">libmemcachedutil</span></p>
 103 <ul>
 104 <li class="toctree-l1"><a class="reference internal" href="../libmemcachedutil.html">Introduction</a></li>
 105 <li class="toctree-l1"><a class="reference internal" href="../libmemcachedutil/index.html">libmemcachedutil API</a></li>
 106 </ul>
 107 <p class="caption"><span class="caption-text">libhashkit</span></p>
 108 <ul>
 109 <li class="toctree-l1"><a class="reference internal" href="../libhashkit.html">Introduction</a></li>
 110 <li class="toctree-l1"><a class="reference internal" href="../libhashkit/index.html">libhashkit API</a></li>
 111 </ul>
 112 <p class="caption"><span class="caption-text">Client Applications</span></p>
 113 <ul>
 114 <li class="toctree-l1"><a class="reference internal" href="../bin/index.html">Client Applications</a></li>
 115 </ul>
 116 <p class="caption"><span class="caption-text">Copyright</span></p>
 117 <ul>
 118 <li class="toctree-l1"><a class="reference internal" href="../copyright.html">Copyright</a></li>
 119 </ul>
 120
 121
 122
 123         </div>
 124
 125       </div>
 126     </nav>
 127
 128     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
 129
 130
 131       <nav class="wy-nav-top" aria-label="top navigation">
 132
 133           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
 134           <a href="../index.html">libmemcached</a>
 135
 136       </nav>
 137
 138
 139       <div class="wy-nav-content">
 140
 141         <div class="rst-content">
 142
 143
 144
 145
 146
 147
 148
 149
 150
 151
 152
 153
 154
 155
 156
 157
 158
 159 <div role="navigation" aria-label="breadcrumbs navigation">
 160
 161   <ul class="wy-breadcrumbs">
 162
 163       <li><a href="../index.html" class="icon icon-home"></a> &raquo;</li>
 164
 165           <li><a href="index_misc.html">Misc</a> &raquo;</li>
 166
 167       <li>libmemcached Configuration</li>
 168
 169
 170       <li class="wy-breadcrumbs-aside">
 171
 172
 173
 174       </li>
 175
 176   </ul>
 177
 178
 179   <hr/>
 180 </div>
 181           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
 182            <div itemprop="articleBody">
 183
 184   <div class="section" id="libmemcached-configuration">
 185 <h1>libmemcached Configuration<a class="headerlink" href="#libmemcached-configuration" title="Permalink to this headline">¶</a></h1>
 186 <div class="section" id="synopsis">
 187 <h2>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2>
 188 <dl class="simple">
 189 <dt>#include &lt;libmemcached-1.0/memcached.h&gt;</dt><dd><p>Compile and link with -lmemcached</p>
 190 </dd>
 191 </dl>
 192 <dl class="cpp function">
 193 <dt id="_CPPv49memcachedPKc6size_t">
 194 <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>
 195 <dd><dl class="field-list simple">
 196 <dt class="field-odd">Parameters</dt>
 197 <dd class="field-odd"><ul class="simple">
 198 <li><p><strong>string</strong> -- configuration string</p></li>
 199 <li><p><strong>string_length</strong> -- length of the configuration string without any terminating zero</p></li>
 200 </ul>
 201 </dd>
 202 <dt class="field-even">Returns</dt>
 203 <dd class="field-even"><p>allocated and initialized <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> struct</p>
 204 </dd>
 205 </dl>
 206 </dd></dl>
 207
 208 <dl class="cpp function">
 209 <dt id="_CPPv432libmemcached_check_configurationPKc6size_tPc6size_t">
 210 <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>
 211 <dd><dl class="field-list simple">
 212 <dt class="field-odd">Parameters</dt>
 213 <dd class="field-odd"><ul class="simple">
 214 <li><p><strong>option_string</strong> -- configuration string</p></li>
 215 <li><p><strong>length</strong> -- length of the configuration string without any terminating zero</p></li>
 216 <li><p><strong>error_buffer</strong> -- buffer used to store any error message</p></li>
 217 <li><p><strong>error_buffer_size</strong> -- available size of the <a class="reference internal" href="#_CPPv432libmemcached_check_configurationPKc6size_tPc6size_t" title="libmemcached_check_configuration::error_buffer"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">error_buffer</span></code></a></p></li>
 218 </ul>
 219 </dd>
 220 <dt class="field-even">Returns</dt>
 221 <dd class="field-even"><p><a class="reference internal" href="memcached_return_t.html#_CPPv418memcached_return_t" title="memcached_return_t"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_return_t</span></code></a> indicating success</p>
 222 </dd>
 223 </dl>
 224 </dd></dl>
 225
 226 </div>
 227 <div class="section" id="description">
 228 <h2>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
 229 <p><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">libmemcached</span></code> implements a custom language for configuring and modifying
 230 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
 231 that you can use in your application directly.</p>
 232 <div class="section" id="general-options">
 233 <h3>General Options:<a class="headerlink" href="#general-options" title="Permalink to this headline">¶</a></h3>
 234 <dl class="describe">
 235 <dt>
 236 <code class="sig-name descname">--SERVER=&lt;servername&gt;:&lt;optional_port&gt;/?&lt;optional_weight&gt;</code></dt>
 237 <dd><p>Provide a servername to be used by the client.</p>
 238 <p>Providing a weight will cause weighting to occur with all hosts with each
 239 server getting a default weight of 1.</p>
 240 </dd></dl>
 241
 242 <dl class="describe">
 243 <dt>
 244 <code class="sig-name descname">--SOCKET=\&quot;&lt;filepath&gt;/?&lt;optional_weight&gt;\&quot;</code></dt>
 245 <dd><p>Provide a filepath to a UNIX socket file. Providing a weight will cause
 246 weighting to occur with all hosts with each server getting a default weight
 247 of 1.</p>
 248 </dd></dl>
 249
 250 <dl class="describe">
 251 <dt>
 252 <code class="sig-name descname">--VERIFY-KEY</code></dt>
 253 <dd><p>Verify that keys that are being used fit within the design of the protocol
 254 being used.</p>
 255 </dd></dl>
 256
 257 <dl class="describe">
 258 <dt>
 259 <code class="sig-name descname">--REMOVE_FAILED_SERVERS</code></dt>
 260 <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>
 261 </dd></dl>
 262
 263 <dl class="describe">
 264 <dt>
 265 <code class="sig-name descname">--BINARY-PROTOCOL</code></dt>
 266 <dd><p>Force all connections to use the binary protocol.</p>
 267 </dd></dl>
 268
 269 <dl class="describe">
 270 <dt>
 271 <code class="sig-name descname">--BUFFER-REQUESTS</code></dt>
 272 <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>
 273 </dd></dl>
 274
 275 <dl class="describe">
 276 <dt>
 277 <code class="sig-name descname">--CONFIGURE-FILE=</code></dt>
 278 <dd><p>Provide a configuration file to be used to load requests. Beware that by
 279 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
 280 on information only contained in the file.</p>
 281 </dd></dl>
 282
 283 <dl class="describe">
 284 <dt>
 285 <code class="sig-name descname">--CONNECT-TIMEOUT=</code></dt>
 286 <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>
 287 </dd></dl>
 288
 289 <dl class="describe">
 290 <dt>
 291 <code class="sig-name descname">--DISTRIBUTION=</code></dt>
 292 <dd><p>Set the distribution model used by the client.
 293 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>
 294 </dd></dl>
 295
 296 <dl class="describe">
 297 <dt>
 298 <code class="sig-name descname">--HASH=</code></dt>
 299 <dd><p>Set the hashing algorithm used for placing keys on servers.</p>
 300 </dd></dl>
 301
 302 <dl class="describe">
 303 <dt>
 304 <code class="sig-name descname">--HASH-WITH-NAMESPACE</code></dt>
 305 <dd><p>When enabled the prefix key will be added to the key when determining which
 306 server to store the data in.</p>
 307 </dd></dl>
 308
 309 <dl class="describe">
 310 <dt>
 311 <code class="sig-name descname">--NOREPLY</code></dt>
 312 <dd><p>Enable &quot;no reply&quot; for all calls that support this. It is highly recommended
 313 that you use this option with the binary protocol only.</p>
 314 </dd></dl>
 315
 316 <dl class="describe">
 317 <dt>
 318 <code class="sig-name descname">--NUMBER-OF-REPLICAS=</code></dt>
 319 <dd><p>Set the number of servers that keys will be replicated to.</p>
 320 </dd></dl>
 321
 322 <dl class="describe">
 323 <dt>
 324 <code class="sig-name descname">--RANDOMIZE-REPLICA-READ</code></dt>
 325 <dd><p>Select randomly the server within the replication pool to read from.</p>
 326 </dd></dl>
 327
 328 <dl class="describe">
 329 <dt>
 330 <code class="sig-name descname">--SORT-HOSTS</code></dt>
 331 <dd><p>When adding new servers always calculate their distribution based on sorted
 332 naming order.</p>
 333 </dd></dl>
 334
 335 <dl class="describe">
 336 <dt>
 337 <code class="sig-name descname">--SUPPORT-CAS</code></dt>
 338 <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>
 339 </dd></dl>
 340
 341 <dl class="describe">
 342 <dt>
 343 <code class="sig-name descname">--USE-UDP</code></dt>
 344 <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>
 345 </dd></dl>
 346
 347 <dl class="describe">
 348 <dt>
 349 <code class="sig-name descname">--NAMESPACE=</code></dt>
 350 <dd><p>A namespace is a container that provides context for keys, only other
 351 requests that know the namespace can access these values. This is
 352 accomplished by prepending the namespace value to all keys.</p>
 353 </dd></dl>
 354
 355 </div>
 356 <div class="section" id="memcached-pool-options">
 357 <h3>Memcached Pool Options:<a class="headerlink" href="#memcached-pool-options" title="Permalink to this headline">¶</a></h3>
 358 <dl class="describe">
 359 <dt>
 360 <code class="sig-name descname">--POOL-MIN</code></dt>
 361 <dd><p>Initial size of pool.</p>
 362 </dd></dl>
 363
 364 <dl class="describe">
 365 <dt>
 366 <code class="sig-name descname">--POOL-MAX</code></dt>
 367 <dd><p>Maximize size of the pool.</p>
 368 </dd></dl>
 369
 370 </div>
 371 <div class="section" id="i-o-options">
 372 <h3>I/O Options:<a class="headerlink" href="#i-o-options" title="Permalink to this headline">¶</a></h3>
 373 <dl class="describe">
 374 <dt>
 375 <code class="sig-name descname">--TCP-NODELAY</code></dt>
 376 <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>
 377 </dd></dl>
 378
 379 <dl class="describe">
 380 <dt>
 381 <code class="sig-name descname">--TCP-KEEPALIVE</code></dt>
 382 <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>
 383 </dd></dl>
 384
 385 <dl class="describe">
 386 <dt>
 387 <code class="sig-name descname">--RETRY-TIMEOUT=</code></dt>
 388 <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>
 389 </dd></dl>
 390
 391 <dl class="describe">
 392 <dt>
 393 <code class="sig-name descname">--SERVER-FAILURE-LIMIT=</code></dt>
 394 <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>
 395 </dd></dl>
 396
 397 <dl class="describe">
 398 <dt>
 399 <code class="sig-name descname">--SND-TIMEOUT=</code></dt>
 400 <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>
 401 </dd></dl>
 402
 403 <dl class="describe">
 404 <dt>
 405 <code class="sig-name descname">--SOCKET-RECV-SIZE=</code></dt>
 406 <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>
 407 </dd></dl>
 408
 409 <dl class="describe">
 410 <dt>
 411 <code class="sig-name descname">--SOCKET-SEND-SIZE=</code></dt>
 412 <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>
 413 </dd></dl>
 414
 415 <dl class="describe">
 416 <dt>
 417 <code class="sig-name descname">--POLL-TIMEOUT=</code></dt>
 418 <dd><p>Set the timeout used by <em class="manpage"><a class="manpage reference external" href="https://linux.die.net/man/3/poll">poll(3)</a></em>.</p>
 419 </dd></dl>
 420
 421 <dl class="describe">
 422 <dt>
 423 <code class="sig-name descname">--IO-BYTES-WATERMARK=</code></dt>
 424 <dd></dd></dl>
 425
 426 <dl class="describe">
 427 <dt>
 428 <code class="sig-name descname">--IO-KEY-PREFETCH=</code></dt>
 429 <dd></dd></dl>
 430
 431 <dl class="describe">
 432 <dt>
 433 <code class="sig-name descname">--IO-MSG-WATERMARK=</code></dt>
 434 <dd></dd></dl>
 435
 436 <dl class="describe">
 437 <dt>
 438 <code class="sig-name descname">--TCP-KEEPIDLE</code></dt>
 439 <dd></dd></dl>
 440
 441 <dl class="describe">
 442 <dt>
 443 <code class="sig-name descname">--RCV-TIMEOUT=</code></dt>
 444 <dd></dd></dl>
 445
 446 </div>
 447 <div class="section" id="other-options">
 448 <h3>Other Options:<a class="headerlink" href="#other-options" title="Permalink to this headline">¶</a></h3>
 449 <dl class="describe">
 450 <dt>
 451 <code class="sig-name descname">INCLUDE</code></dt>
 452 <dd><p>Include a file in configuration.
 453 Unlike <code class="docutils literal notranslate"><span class="pre">--CONFIGURE-FILE=</span></code> 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>
 454 </dd></dl>
 455
 456 <dl class="describe">
 457 <dt>
 458 <code class="sig-name descname">RESET</code></dt>
 459 <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>
 460 </dd></dl>
 461
 462 <dl class="describe">
 463 <dt>
 464 <code class="sig-name descname">END</code></dt>
 465 <dd><p>End configuration processing.</p>
 466 </dd></dl>
 467
 468 <dl class="describe">
 469 <dt>
 470 <code class="sig-name descname">ERROR</code></dt>
 471 <dd><p>End configuration processing and throw an error.</p>
 472 </dd></dl>
 473
 474 </div>
 475 </div>
 476 <div class="section" id="environment">
 477 <h2>ENVIRONMENT<a class="headerlink" href="#environment" title="Permalink to this headline">¶</a></h2>
 478 <dl class="std envvar">
 479 <dt id="envvar-LIBMEMCACHED">
 480 <code class="sig-name descname">LIBMEMCACHED</code><a class="headerlink" href="#envvar-LIBMEMCACHED" title="Permalink to this definition">¶</a></dt>
 481 <dd></dd></dl>
 482
 483 </div>
 484 <div class="section" id="return-value">
 485 <h2>RETURN VALUE<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2>
 486 <p><a class="reference internal" href="#_CPPv49memcachedPKc6size_t" title="memcached"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached()</span></code></a> returns a pointer to the <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> that was created (or
 487 initialized).  On an allocation failure, it returns NULL.</p>
 488 </div>
 489 <div class="section" id="example">
 490 <h2>EXAMPLE<a class="headerlink" href="#example" title="Permalink to this headline">¶</a></h2>
 491 <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>
 492   <span class="s">&quot;--SERVER=host10.example.com &quot;</span>
 493   <span class="s">&quot;--SERVER=host11.example.com &quot;</span>
 494   <span class="s">&quot;--SERVER=host10.example.com&quot;</span><span class="p">;</span>
 495 <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>
 496 <span class="p">{</span>
 497   <span class="c1">// ...</span>
 498 <span class="p">}</span>
 499 <span class="n">memcached_free</span><span class="p">(</span><span class="n">memc</span><span class="p">);</span>
 500 </pre></div>
 501 </div>
 502 </div>
 503 <div class="section" id="see-also">
 504 <h2>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>
 505 <ul class="simple">
 506 <li><p><em class="manpage"><a class="manpage reference external" href="https://linux.die.net/man/1/memcached">memcached(1)</a></em></p></li>
 507 <li><p><a class="reference internal" href="../libmemcached.html"><span class="doc">C/C++ Client Library for memcached</span></a></p></li>
 508 <li><p><a class="reference internal" href="memcached_strerror.html"><span class="doc">Converting Error Codes to Messages</span></a></p></li>
 509 </ul>
 510 </div>
 511 </div>
 512
 513
 514            </div>
 515
 516           </div>
 517           <footer>
 518
 519     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 520
 521         <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>
 522
 523
 524         <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>
 525
 526     </div>
 527
 528
 529   <hr/>
 530
 531   <div role="contentinfo">
 532     <p>
 533
 534
 535         &copy; <a href="../copyright.html">Copyright</a>
 536
 537     </p>
 538   </div>
 539
 540
 541
 542     Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
 543
 544     <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
 545
 546     provided by <a href="https://readthedocs.org">Read the Docs</a>.
 547
 548 </footer>
 549
 550         </div>
 551       </div>
 552
 553     </section>
 554
 555   </div>
 556
 557
 558   <script type="text/javascript">
 559       jQuery(function () {
 560           SphinxRtdTheme.Navigation.enable(true);
 561       });
 562   </script>
 563
 564
 565
 566
 567
 568
 569 </body>
 570 </html>