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

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