<!DOCTYPE html>
-<html class="writer-html5" lang="en" >
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
- <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
- <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
-
-
- <!--[if lt IE 9]>
- <script src="../_static/js/html5shiv.min.js"></script>
- <![endif]-->
+ <script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
- <script src="../_static/jquery.js"></script>
- <script src="../_static/underscore.js"></script>
- <script src="../_static/doctools.js"></script>
- <script src="../_static/language_data.js"></script>
+ <script type="text/javascript" src="../_static/jquery.js"></script>
+ <script type="text/javascript" src="../_static/underscore.js"></script>
+ <script type="text/javascript" src="../_static/doctools.js"></script>
+ <script type="text/javascript" src="../_static/language_data.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
+
+
+ <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
+ <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="copyright" title="Copyright" href="../copyright.html" />
- <a href="../index.html" class="icon icon-home" alt="Documentation Home"> libmemcached
+ <a href="../index.html" class="icon icon-home"> libmemcached
</div>
-
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
</div>
-
</div>
</nav>
<ul class="wy-breadcrumbs">
- <li><a href="../index.html" class="icon icon-home"></a> »</li>
+ <li><a href="../index.html">Docs</a> »</li>
<li><a href="index.html">libmemcached API</a> »</li>
<h1>Storing data on the server<a class="headerlink" href="#storing-data-on-the-server" title="Permalink to this headline">¶</a></h1>
<div class="section" id="synopsis">
<span id="index-0"></span><h2>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2>
-<dl class="simple">
-<dt>#include <libmemcached/memcached.h></dt><dd><p>Compile and link with -lmemcached</p>
-</dd>
+<dl class="docutils">
+<dt>#include <libmemcached/memcached.h></dt>
+<dd>Compile and link with -lmemcached</dd>
</dl>
-<dl class="cpp function">
+<dl class="function">
<dt id="_CPPv413memcached_setP12memcached_stPKc6size_tPKc6size_t6time_t8uint32_t">
-<span id="_CPPv313memcached_setP12memcached_stPKc6size_tPKc6size_t6time_t8uint32_t"></span><span id="_CPPv213memcached_setP12memcached_stPKc6size_tPKc6size_t6time_t8uint32_t"></span><span id="memcached_set__memcached_stP.cCP.s.cCP.s.time_t.uint32_t"></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">memcached_set</code><span class="sig-paren">(</span><a class="reference internal" href="memcached_create.html#_CPPv412memcached_st" title="memcached_st">memcached_st</a> *<em>ptr</em>, <em class="property">const</em> char *<em>key</em>, size_t <em>key_length</em>, <em class="property">const</em> char *<em>value</em>, size_t <em>value_length</em>, time_t <em>expiration</em>, uint32_t <em>flags</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv413memcached_setP12memcached_stPKc6size_tPKc6size_t6time_t8uint32_t" title="Permalink to this definition">¶</a><br /></dt>
+<span id="_CPPv313memcached_setP12memcached_stPKc6size_tPKc6size_t6time_t8uint32_t"></span><span id="_CPPv213memcached_setP12memcached_stPKc6size_tPKc6size_t6time_t8uint32_t"></span><span id="memcached_set__memcached_stP.cCP.s.cCP.s.time_t.uint32_t"></span><a class="reference internal" href="memcached_return_t.html#_CPPv418memcached_return_t" title="memcached_return_t">memcached_return_t</a> <code class="descname">memcached_set</code><span class="sig-paren">(</span><a class="reference internal" href="memcached_create.html#_CPPv412memcached_st" title="memcached_st">memcached_st</a> *<em>ptr</em>, <em class="property">const</em> char *<em>key</em>, size_t <em>key_length</em>, <em class="property">const</em> char *<em>value</em>, size_t <em>value_length</em>, time_t <em>expiration</em>, uint32_t <em>flags</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv413memcached_setP12memcached_stPKc6size_tPKc6size_t6time_t8uint32_t" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
-<dl class="cpp function">
+<dl class="function">
<dt id="_CPPv413memcached_addP12memcached_stPKc6size_tPKc6size_t6time_t8uint32_t">
-<span id="_CPPv313memcached_addP12memcached_stPKc6size_tPKc6size_t6time_t8uint32_t"></span><span id="_CPPv213memcached_addP12memcached_stPKc6size_tPKc6size_t6time_t8uint32_t"></span><span id="memcached_add__memcached_stP.cCP.s.cCP.s.time_t.uint32_t"></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">memcached_add</code><span class="sig-paren">(</span><a class="reference internal" href="memcached_create.html#_CPPv412memcached_st" title="memcached_st">memcached_st</a> *<em>ptr</em>, <em class="property">const</em> char *<em>key</em>, size_t <em>key_length</em>, <em class="property">const</em> char *<em>value</em>, size_t <em>value_length</em>, time_t <em>expiration</em>, uint32_t <em>flags</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv413memcached_addP12memcached_stPKc6size_tPKc6size_t6time_t8uint32_t" title="Permalink to this definition">¶</a><br /></dt>
+<span id="_CPPv313memcached_addP12memcached_stPKc6size_tPKc6size_t6time_t8uint32_t"></span><span id="_CPPv213memcached_addP12memcached_stPKc6size_tPKc6size_t6time_t8uint32_t"></span><span id="memcached_add__memcached_stP.cCP.s.cCP.s.time_t.uint32_t"></span><a class="reference internal" href="memcached_return_t.html#_CPPv418memcached_return_t" title="memcached_return_t">memcached_return_t</a> <code class="descname">memcached_add</code><span class="sig-paren">(</span><a class="reference internal" href="memcached_create.html#_CPPv412memcached_st" title="memcached_st">memcached_st</a> *<em>ptr</em>, <em class="property">const</em> char *<em>key</em>, size_t <em>key_length</em>, <em class="property">const</em> char *<em>value</em>, size_t <em>value_length</em>, time_t <em>expiration</em>, uint32_t <em>flags</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv413memcached_addP12memcached_stPKc6size_tPKc6size_t6time_t8uint32_t" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
-<dl class="cpp function">
+<dl class="function">
<dt id="_CPPv417memcached_replaceP12memcached_stPKc6size_tPKc6size_t6time_t8uint32_t">
-<span id="_CPPv317memcached_replaceP12memcached_stPKc6size_tPKc6size_t6time_t8uint32_t"></span><span id="_CPPv217memcached_replaceP12memcached_stPKc6size_tPKc6size_t6time_t8uint32_t"></span><span id="memcached_replace__memcached_stP.cCP.s.cCP.s.time_t.uint32_t"></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">memcached_replace</code><span class="sig-paren">(</span><a class="reference internal" href="memcached_create.html#_CPPv412memcached_st" title="memcached_st">memcached_st</a> *<em>ptr</em>, <em class="property">const</em> char *<em>key</em>, size_t <em>key_length</em>, <em class="property">const</em> char *<em>value</em>, size_t <em>value_length</em>, time_t <em>expiration</em>, uint32_t <em>flags</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv417memcached_replaceP12memcached_stPKc6size_tPKc6size_t6time_t8uint32_t" title="Permalink to this definition">¶</a><br /></dt>
+<span id="_CPPv317memcached_replaceP12memcached_stPKc6size_tPKc6size_t6time_t8uint32_t"></span><span id="_CPPv217memcached_replaceP12memcached_stPKc6size_tPKc6size_t6time_t8uint32_t"></span><span id="memcached_replace__memcached_stP.cCP.s.cCP.s.time_t.uint32_t"></span><a class="reference internal" href="memcached_return_t.html#_CPPv418memcached_return_t" title="memcached_return_t">memcached_return_t</a> <code class="descname">memcached_replace</code><span class="sig-paren">(</span><a class="reference internal" href="memcached_create.html#_CPPv412memcached_st" title="memcached_st">memcached_st</a> *<em>ptr</em>, <em class="property">const</em> char *<em>key</em>, size_t <em>key_length</em>, <em class="property">const</em> char *<em>value</em>, size_t <em>value_length</em>, time_t <em>expiration</em>, uint32_t <em>flags</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv417memcached_replaceP12memcached_stPKc6size_tPKc6size_t6time_t8uint32_t" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
-<dl class="cpp function">
+<dl class="function">
<dt id="_CPPv420memcached_set_by_keyP12memcached_stPKc6size_tPKc6size_tPKc6size_t6time_t8uint32_t">
-<span id="_CPPv320memcached_set_by_keyP12memcached_stPKc6size_tPKc6size_tPKc6size_t6time_t8uint32_t"></span><span id="_CPPv220memcached_set_by_keyP12memcached_stPKc6size_tPKc6size_tPKc6size_t6time_t8uint32_t"></span><span id="memcached_set_by_key__memcached_stP.cCP.s.cCP.s.cCP.s.time_t.uint32_t"></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">memcached_set_by_key</code><span class="sig-paren">(</span><a class="reference internal" href="memcached_create.html#_CPPv412memcached_st" title="memcached_st">memcached_st</a> *<em>ptr</em>, <em class="property">const</em> char *<em>group_key</em>, size_t <em>group_key_length</em>, <em class="property">const</em> char *<em>key</em>, size_t <em>key_length</em>, <em class="property">const</em> char *<em>value</em>, size_t <em>value_length</em>, time_t <em>expiration</em>, uint32_t <em>flags</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv420memcached_set_by_keyP12memcached_stPKc6size_tPKc6size_tPKc6size_t6time_t8uint32_t" title="Permalink to this definition">¶</a><br /></dt>
+<span id="_CPPv320memcached_set_by_keyP12memcached_stPKc6size_tPKc6size_tPKc6size_t6time_t8uint32_t"></span><span id="_CPPv220memcached_set_by_keyP12memcached_stPKc6size_tPKc6size_tPKc6size_t6time_t8uint32_t"></span><span id="memcached_set_by_key__memcached_stP.cCP.s.cCP.s.cCP.s.time_t.uint32_t"></span><a class="reference internal" href="memcached_return_t.html#_CPPv418memcached_return_t" title="memcached_return_t">memcached_return_t</a> <code class="descname">memcached_set_by_key</code><span class="sig-paren">(</span><a class="reference internal" href="memcached_create.html#_CPPv412memcached_st" title="memcached_st">memcached_st</a> *<em>ptr</em>, <em class="property">const</em> char *<em>group_key</em>, size_t <em>group_key_length</em>, <em class="property">const</em> char *<em>key</em>, size_t <em>key_length</em>, <em class="property">const</em> char *<em>value</em>, size_t <em>value_length</em>, time_t <em>expiration</em>, uint32_t <em>flags</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv420memcached_set_by_keyP12memcached_stPKc6size_tPKc6size_tPKc6size_t6time_t8uint32_t" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
-<dl class="cpp function">
+<dl class="function">
<dt id="_CPPv420memcached_add_by_keyP12memcached_stPKc6size_tPKc6size_tPKc6size_t6time_t8uint32_t">
-<span id="_CPPv320memcached_add_by_keyP12memcached_stPKc6size_tPKc6size_tPKc6size_t6time_t8uint32_t"></span><span id="_CPPv220memcached_add_by_keyP12memcached_stPKc6size_tPKc6size_tPKc6size_t6time_t8uint32_t"></span><span id="memcached_add_by_key__memcached_stP.cCP.s.cCP.s.cCP.s.time_t.uint32_t"></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">memcached_add_by_key</code><span class="sig-paren">(</span><a class="reference internal" href="memcached_create.html#_CPPv412memcached_st" title="memcached_st">memcached_st</a> *<em>ptr</em>, <em class="property">const</em> char *<em>group_key</em>, size_t <em>group_key_length</em>, <em class="property">const</em> char *<em>key</em>, size_t <em>key_length</em>, <em class="property">const</em> char *<em>value</em>, size_t <em>value_length</em>, time_t <em>expiration</em>, uint32_t <em>flags</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv420memcached_add_by_keyP12memcached_stPKc6size_tPKc6size_tPKc6size_t6time_t8uint32_t" title="Permalink to this definition">¶</a><br /></dt>
+<span id="_CPPv320memcached_add_by_keyP12memcached_stPKc6size_tPKc6size_tPKc6size_t6time_t8uint32_t"></span><span id="_CPPv220memcached_add_by_keyP12memcached_stPKc6size_tPKc6size_tPKc6size_t6time_t8uint32_t"></span><span id="memcached_add_by_key__memcached_stP.cCP.s.cCP.s.cCP.s.time_t.uint32_t"></span><a class="reference internal" href="memcached_return_t.html#_CPPv418memcached_return_t" title="memcached_return_t">memcached_return_t</a> <code class="descname">memcached_add_by_key</code><span class="sig-paren">(</span><a class="reference internal" href="memcached_create.html#_CPPv412memcached_st" title="memcached_st">memcached_st</a> *<em>ptr</em>, <em class="property">const</em> char *<em>group_key</em>, size_t <em>group_key_length</em>, <em class="property">const</em> char *<em>key</em>, size_t <em>key_length</em>, <em class="property">const</em> char *<em>value</em>, size_t <em>value_length</em>, time_t <em>expiration</em>, uint32_t <em>flags</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv420memcached_add_by_keyP12memcached_stPKc6size_tPKc6size_tPKc6size_t6time_t8uint32_t" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
-<dl class="cpp function">
+<dl class="function">
<dt id="_CPPv424memcached_replace_by_keyP12memcached_stPKc6size_tPKc6size_tPKc6size_t6time_t8uint32_t">
-<span id="_CPPv324memcached_replace_by_keyP12memcached_stPKc6size_tPKc6size_tPKc6size_t6time_t8uint32_t"></span><span id="_CPPv224memcached_replace_by_keyP12memcached_stPKc6size_tPKc6size_tPKc6size_t6time_t8uint32_t"></span><span id="memcached_replace_by_key__memcached_stP.cCP.s.cCP.s.cCP.s.time_t.uint32_t"></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">memcached_replace_by_key</code><span class="sig-paren">(</span><a class="reference internal" href="memcached_create.html#_CPPv412memcached_st" title="memcached_st">memcached_st</a> *<em>ptr</em>, <em class="property">const</em> char *<em>group_key</em>, size_t <em>group_key_length</em>, <em class="property">const</em> char *<em>key</em>, size_t <em>key_length</em>, <em class="property">const</em> char *<em>value</em>, size_t <em>value_length</em>, time_t <em>expiration</em>, uint32_t <em>flags</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv424memcached_replace_by_keyP12memcached_stPKc6size_tPKc6size_tPKc6size_t6time_t8uint32_t" title="Permalink to this definition">¶</a><br /></dt>
+<span id="_CPPv324memcached_replace_by_keyP12memcached_stPKc6size_tPKc6size_tPKc6size_t6time_t8uint32_t"></span><span id="_CPPv224memcached_replace_by_keyP12memcached_stPKc6size_tPKc6size_tPKc6size_t6time_t8uint32_t"></span><span id="memcached_replace_by_key__memcached_stP.cCP.s.cCP.s.cCP.s.time_t.uint32_t"></span><a class="reference internal" href="memcached_return_t.html#_CPPv418memcached_return_t" title="memcached_return_t">memcached_return_t</a> <code class="descname">memcached_replace_by_key</code><span class="sig-paren">(</span><a class="reference internal" href="memcached_create.html#_CPPv412memcached_st" title="memcached_st">memcached_st</a> *<em>ptr</em>, <em class="property">const</em> char *<em>group_key</em>, size_t <em>group_key_length</em>, <em class="property">const</em> char *<em>key</em>, size_t <em>key_length</em>, <em class="property">const</em> char *<em>value</em>, size_t <em>value_length</em>, time_t <em>expiration</em>, uint32_t <em>flags</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv424memcached_replace_by_keyP12memcached_stPKc6size_tPKc6size_tPKc6size_t6time_t8uint32_t" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
</div>
<div class="section" id="description">
<h2>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
-<p><a class="reference internal" href="#_CPPv413memcached_setP12memcached_stPKc6size_tPKc6size_t6time_t8uint32_t" title="memcached_set"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_set()</span></code></a>, <a class="reference internal" href="#_CPPv413memcached_addP12memcached_stPKc6size_tPKc6size_t6time_t8uint32_t" title="memcached_add"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_add()</span></code></a>, and <a class="reference internal" href="#_CPPv417memcached_replaceP12memcached_stPKc6size_tPKc6size_t6time_t8uint32_t" title="memcached_replace"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_replace()</span></code></a> 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
-store the object. Keys are currently limited to 250 characters by the
+<p><a class="reference internal" href="#_CPPv413memcached_setP12memcached_stPKc6size_tPKc6size_t6time_t8uint32_t" title="memcached_set"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_set()</span></code></a>, <a class="reference internal" href="#_CPPv413memcached_addP12memcached_stPKc6size_tPKc6size_t6time_t8uint32_t" title="memcached_add"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_add()</span></code></a>, and <a class="reference internal" href="#_CPPv417memcached_replaceP12memcached_stPKc6size_tPKc6size_t6time_t8uint32_t" title="memcached_replace"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_replace()</span></code></a> 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 <em class="manpage"><a class="manpage reference external" href="https://linux.die.net/man/1/memcached">memcached(1)</a></em> which is 1.4 or below, or when
+using the text protocol. You must supply both a value and a length. Optionally
+you store the object. Keys are currently limited to 250 characters by the
memcached(1) server. You must supply both a value and a length. Optionally you
-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.</p>
+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.</p>
<p><a class="reference internal" href="#_CPPv413memcached_setP12memcached_stPKc6size_tPKc6size_t6time_t8uint32_t" title="memcached_set"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_set()</span></code></a> will write an object to the server. If an object
already exists it will overwrite what is in the server. If the object does not
exist it will be written. If you are using the non-blocking mode this function
will always return true unless a network error occurs.</p>
-<p><a class="reference internal" href="#_CPPv417memcached_replaceP12memcached_stPKc6size_tPKc6size_t6time_t8uint32_t" title="memcached_replace"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_replace()</span></code></a> replaces an object on the server. If the object is not found on the server an error occurs.</p>
-<p><a class="reference internal" href="#_CPPv413memcached_addP12memcached_stPKc6size_tPKc6size_t6time_t8uint32_t" title="memcached_add"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_add()</span></code></a> adds an object to the server. If the object is found on the server an error occurs, otherwise the value is stored.</p>
-<p><a class="reference internal" href="#_CPPv420memcached_set_by_keyP12memcached_stPKc6size_tPKc6size_tPKc6size_t6time_t8uint32_t" title="memcached_set_by_key"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_set_by_key()</span></code></a>, <a class="reference internal" href="#_CPPv420memcached_add_by_keyP12memcached_stPKc6size_tPKc6size_tPKc6size_t6time_t8uint32_t" title="memcached_add_by_key"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_add_by_key()</span></code></a>, and <a class="reference internal" href="#_CPPv424memcached_replace_by_keyP12memcached_stPKc6size_tPKc6size_tPKc6size_t6time_t8uint32_t" title="memcached_replace_by_key"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_replace_by_key()</span></code></a> methods all behave in a similar method as the non
+<p><a class="reference internal" href="#_CPPv417memcached_replaceP12memcached_stPKc6size_tPKc6size_t6time_t8uint32_t" title="memcached_replace"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_replace()</span></code></a> replaces an object on the server. If the object is not
+found on the server an error occurs.</p>
+<p><a class="reference internal" href="#_CPPv413memcached_addP12memcached_stPKc6size_tPKc6size_t6time_t8uint32_t" title="memcached_add"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_add()</span></code></a> adds an object to the server. If the object is found on
+the server an error occurs, otherwise the value is stored.</p>
+<p><a class="reference internal" href="#_CPPv420memcached_set_by_keyP12memcached_stPKc6size_tPKc6size_tPKc6size_t6time_t8uint32_t" title="memcached_set_by_key"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_set_by_key()</span></code></a>, <a class="reference internal" href="#_CPPv420memcached_add_by_keyP12memcached_stPKc6size_tPKc6size_tPKc6size_t6time_t8uint32_t" title="memcached_add_by_key"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_add_by_key()</span></code></a>, and
+<a class="reference internal" href="#_CPPv424memcached_replace_by_keyP12memcached_stPKc6size_tPKc6size_tPKc6size_t6time_t8uint32_t" title="memcached_replace_by_key"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_replace_by_key()</span></code></a> methods all behave in a similar method as the non
key methods. The difference is that they use their group_key parameter to map
objects to particular servers.</p>
-<p>If you are looking for performance, <a class="reference internal" href="#_CPPv413memcached_setP12memcached_stPKc6size_tPKc6size_t6time_t8uint32_t" title="memcached_set"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_set()</span></code></a> with non-blocking IO is the fastest way to store data on the server.</p>
-<p>All of the above functions are tested with the <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> behavior enabled. However, when using these operations with this behavior
+<p>If you are looking for performance, <a class="reference internal" href="#_CPPv413memcached_setP12memcached_stPKc6size_tPKc6size_t6time_t8uint32_t" title="memcached_set"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_set()</span></code></a> with non-blocking IO
+is the fastest way to store data on the server.</p>
+<p>All of the above functions are tested with the <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>
+behavior enabled. However, when using these operations with this behavior
on, there are limits to the size of the payload being sent to the server.
The reason for these limits is that the Memcached Server does not allow
multi-datagram requests and the current server implementation sets a datagram
-size to 1400 bytes. Due to protocol overhead, the actual limit of the user supplied data is less than 1400 bytes and depends on the protocol in use as, well as the operation being
-executed. When running with the binary protocol, <a class="reference internal" href="memcached_behavior.html#_CPPv4N20memcached_behavior_t34MEMCACHED_BEHAVIOR_BINARY_PROTOCOLE" title="MEMCACHED_BEHAVIOR_BINARY_PROTOCOL"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">MEMCACHED_BEHAVIOR_BINARY_PROTOCOL</span></code></a>, the size of the key,value, flags and expiry combined may not
-exceed 1368 bytes. When running with the ASCII protocol, the exact limit fluctuates depending on which function is being executed and whether the function is a cas operation or not. For non-cas ASCII set operations, there are at least
-1335 bytes available to split among the key, key_prefix, and value; for cas
-ASCII operations there are at least 1318 bytes available to split among the key, key_prefix and value. If the total size of the command, including overhead,
-exceeds 1400 bytes, a <a class="reference internal" href="memcached_return_t.html#_CPPv4N18memcached_return_t23MEMCACHED_WRITE_FAILUREE" title="MEMCACHED_WRITE_FAILURE"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">MEMCACHED_WRITE_FAILURE</span></code></a> will be returned.</p>
+size to 1400 bytes. Due to protocol overhead, the actual limit of the user
+supplied data is less than 1400 bytes and depends on the protocol in use, as
+well as the operation being executed. When running with the binary protocol,
+<a class="reference internal" href="memcached_behavior.html#_CPPv4N20memcached_behavior_t34MEMCACHED_BEHAVIOR_BINARY_PROTOCOLE" title="MEMCACHED_BEHAVIOR_BINARY_PROTOCOL"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">MEMCACHED_BEHAVIOR_BINARY_PROTOCOL</span></code></a>, the size of the key,value, flags and
+expiry combined may not exceed 1368 bytes. When running with the ASCII protocol,
+the exact limit fluctuates depending on which function is being executed and
+whether the function is a cas operation or not. For non-cas ASCII set operations,
+there are at least 1335 bytes available to split among the key, key_prefix, and
+value; for cas ASCII operations there are at least 1318 bytes available to split
+among the key, key_prefix and value. If the total size of the command, including
+overhead, exceeds 1400 bytes, a <a class="reference internal" href="memcached_return_t.html#_CPPv4N18memcached_return_t23MEMCACHED_WRITE_FAILUREE" title="MEMCACHED_WRITE_FAILURE"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">MEMCACHED_WRITE_FAILURE</span></code></a> will be returned.</p>
</div>
<div class="section" id="return-value">
<h2>RETURN VALUE<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2>
-<p>All methods return a value of type <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>.
-On success the value will be <a class="reference internal" href="memcached_return_t.html#_CPPv4N18memcached_return_t17MEMCACHED_SUCCESSE" title="MEMCACHED_SUCCESS"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">MEMCACHED_SUCCESS</span></code></a>.
+<p>All methods return a value of type <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>.</p>
+
<p>On success the value will be <a class="reference internal" href="memcached_return_t.html#_CPPv4N18memcached_return_t17MEMCACHED_SUCCESSE" title="MEMCACHED_SUCCESS"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">MEMCACHED_SUCCESS</span></code></a>.
Use <a class="reference internal" href="memcached_strerror.html#_CPPv418memcached_strerrorP12memcached_st18memcached_return_t" title="memcached_strerror"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_strerror()</span></code></a> to translate this value to a printable string.</p>
<p>For <a class="reference internal" href="#_CPPv417memcached_replaceP12memcached_stPKc6size_tPKc6size_t6time_t8uint32_t" title="memcached_replace"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_replace()</span></code></a> and <a class="reference internal" href="#_CPPv413memcached_addP12memcached_stPKc6size_tPKc6size_t6time_t8uint32_t" title="memcached_add"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_add()</span></code></a>, <a class="reference internal" href="memcached_return_t.html#_CPPv4N18memcached_return_t19MEMCACHED_NOTSTOREDE" title="MEMCACHED_NOTSTORED"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">MEMCACHED_NOTSTORED</span></code></a>
is a legitimate error in the case of a collision.</p>
</div>
<div class="section" id="see-also">
<h2>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>
+<ul class="simple">
+<li><em class="manpage"><a class="manpage reference external" href="https://linux.die.net/man/1/memcached">memcached(1)</a></em></li>
+<li><a class="reference internal" href="../libmemcached.html"><span class="doc">C/C++ Client Library for memcached</span></a></li>
+<li><a class="reference internal" href="memcached_strerror.html"><span class="doc">Converting Error Codes to Messages</span></a></li>
+<li><a class="reference internal" href="memcached_auto.html"><span class="doc">Incrementing and Decrementing Values</span></a></li>
+<li><a class="reference internal" href="memcached_cas.html"><span class="doc">Working with data on the server in an atomic fashion</span></a></li>
+</ul>
</div>
</div>
<div role="contentinfo">
<p>
-
-
© <a href="../copyright.html">Copyright</a>
</p>
</div>
-
-
-
- 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>.
+ 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>.
</footer>
</div>
+
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
projects / m6w6 / libmemcached / blobdiff