git.m6w6.name Git - awesomized/libmemcached/blob - libmemcached/memcached_append.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>Appending or Prepending Data &mdash; libmemcached-awesome 1.1.4 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 type="text/javascript" src="../_static/jquery.js"></script>
  25         <script type="text/javascript" src="../_static/underscore.js"></script>
  26         <script type="text/javascript" src="../_static/doctools.js"></script>
  27         <script type="text/javascript" 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="Working with data on the server in an atomic fashion" href="memcached_cas.html" />
  40     <link rel="prev" title="Working with result sets" href="memcached_result_st.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-awesome
  55
  56
  57
  58           </a>
  59
  60
  61
  62
  63               <div class="version">
  64                 1.1
  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               <ul class="current">
  89 <li class="toctree-l1"><a class="reference internal" href="../libmemcached.html">Introduction</a></li>
  90 <li class="toctree-l1 current"><a class="reference internal" href="index.html">libmemcached API</a><ul class="current">
  91 <li class="toctree-l2"><a class="reference internal" href="index_basics.html">Basics</a></li>
  92 <li class="toctree-l2 current"><a class="reference internal" href="index_data.html">Working with Data</a><ul class="current">
  93 <li class="toctree-l3"><a class="reference internal" href="memcached_auto.html">Incrementing and Decrementing Values</a></li>
  94 <li class="toctree-l3"><a class="reference internal" href="memcached_exist.html">Determine if a keys exists</a></li>
  95 <li class="toctree-l3"><a class="reference internal" href="memcached_touch.html">Update expiration on a key</a></li>
  96 <li class="toctree-l3"><a class="reference internal" href="memcached_flush_buffers.html">Flush and send buffered commands</a></li>
  97 <li class="toctree-l3"><a class="reference internal" href="memcached_result_st.html">Working with result sets</a></li>
  98 <li class="toctree-l3 current"><a class="current reference internal" href="#">Appending or Prepending Data</a></li>
  99 <li class="toctree-l3"><a class="reference internal" href="memcached_cas.html">Working with data on the server in an atomic fashion</a></li>
 100 </ul>
 101 </li>
 102 <li class="toctree-l2"><a class="reference internal" href="index_errors.html">Messages and Errors</a></li>
 103 <li class="toctree-l2"><a class="reference internal" href="index_advanced.html">Advanced Topics</a></li>
 104 <li class="toctree-l2"><a class="reference internal" href="index_deprecated.html">Deprecated Functionality</a></li>
 105 </ul>
 106 </li>
 107 <li class="toctree-l1"><a class="reference internal" href="../libmemcachedutil/index.html">libmemcachedutil API</a></li>
 108 <li class="toctree-l1"><a class="reference internal" href="../libhashkit/index.html">libhashkit API</a></li>
 109 <li class="toctree-l1"><a class="reference internal" href="../bin/index.html">Client Applications</a></li>
 110 <li class="toctree-l1"><a class="reference internal" href="index_misc.html">Miscellaneous</a></li>
 111 </ul>
 112 <ul>
 113 <li class="toctree-l1"><a class="reference internal" href="../changelogs.html">Change Logs</a></li>
 114 <li class="toctree-l1"><a class="reference internal" href="../issues.html">Known issues</a></li>
 115 <li class="toctree-l1"><a class="reference internal" href="../copyright.html">Copyright</a></li>
 116 </ul>
 117
 118
 119
 120         </div>
 121       </div>
 122     </nav>
 123
 124     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
 125
 126
 127       <nav class="wy-nav-top" aria-label="top navigation">
 128
 129           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
 130           <a href="../index.html">libmemcached-awesome</a>
 131
 132       </nav>
 133
 134
 135       <div class="wy-nav-content">
 136
 137         <div class="rst-content">
 138
 139
 140
 141
 142
 143
 144
 145
 146
 147
 148
 149
 150
 151
 152
 153
 154
 155 <div role="navigation" aria-label="breadcrumbs navigation">
 156
 157   <ul class="wy-breadcrumbs">
 158
 159       <li><a href="../index.html">Docs</a> &raquo;</li>
 160
 161           <li><a href="index.html">libmemcached API</a> &raquo;</li>
 162
 163           <li><a href="index_data.html">Working with Data</a> &raquo;</li>
 164
 165       <li>Appending or Prepending Data</li>
 166
 167
 168       <li class="wy-breadcrumbs-aside">
 169
 170
 171
 172               <a href="https://github.com/awesomized/libmemcached/blob/v1.x/docs/source/libmemcached/memcached_append.rst" class="fa fa-github"> Edit on GitHub</a>
 173
 174
 175
 176       </li>
 177
 178   </ul>
 179
 180
 181   <hr/>
 182 </div>
 183           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
 184            <div itemprop="articleBody">
 185
 186   <div class="section" id="appending-or-prepending-data">
 187 <h1>Appending or Prepending Data<a class="headerlink" href="#appending-or-prepending-data" title="Permalink to this headline">¶</a></h1>
 188 <div class="section" id="synopsis">
 189 <h2>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2>
 190 <dl class="docutils">
 191 <dt>#include &lt;libmemcached-1.0/memcached.h&gt;</dt>
 192 <dd>Compile and link with -lmemcached</dd>
 193 </dl>
 194 <dl class="function">
 195 <dt id="_CPPv417memcached_prependP12memcached_stPKc6size_tPKc6size_t6time_t8uint32_t">
 196 <span id="_CPPv317memcached_prependP12memcached_stPKc6size_tPKc6size_t6time_t8uint32_t"></span><span id="_CPPv217memcached_prependP12memcached_stPKc6size_tPKc6size_t6time_t8uint32_t"></span><span id="memcached_prepend__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_prepend</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_prependP12memcached_stPKc6size_tPKc6size_t6time_t8uint32_t" title="Permalink to this definition">¶</a><br /></dt>
 197 <dd></dd></dl>
 198
 199 <dl class="function">
 200 <dt id="_CPPv416memcached_appendP12memcached_stPKc6size_tPKc6size_t6time_t8uint32_t">
 201 <span id="_CPPv316memcached_appendP12memcached_stPKc6size_tPKc6size_t6time_t8uint32_t"></span><span id="_CPPv216memcached_appendP12memcached_stPKc6size_tPKc6size_t6time_t8uint32_t"></span><span id="memcached_append__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_append</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="#_CPPv416memcached_appendP12memcached_stPKc6size_tPKc6size_t6time_t8uint32_t" title="Permalink to this definition">¶</a><br /></dt>
 202 <dd></dd></dl>
 203
 204 <dl class="function">
 205 <dt id="_CPPv424memcached_prepend_by_keyP12memcached_stPKc6size_tPKc6size_tPKc6size_t6time_t8uint32_t">
 206 <span id="_CPPv324memcached_prepend_by_keyP12memcached_stPKc6size_tPKc6size_tPKc6size_t6time_t8uint32_t"></span><span id="_CPPv224memcached_prepend_by_keyP12memcached_stPKc6size_tPKc6size_tPKc6size_t6time_t8uint32_t"></span><span id="memcached_prepend_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_prepend_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_prepend_by_keyP12memcached_stPKc6size_tPKc6size_tPKc6size_t6time_t8uint32_t" title="Permalink to this definition">¶</a><br /></dt>
 207 <dd></dd></dl>
 208
 209 <dl class="function">
 210 <dt id="_CPPv423memcached_append_by_keyP12memcached_stPKc6size_tPKc6size_tPKc6size_t6time_t8uint32_t">
 211 <span id="_CPPv323memcached_append_by_keyP12memcached_stPKc6size_tPKc6size_tPKc6size_t6time_t8uint32_t"></span><span id="_CPPv223memcached_append_by_keyP12memcached_stPKc6size_tPKc6size_tPKc6size_t6time_t8uint32_t"></span><span id="memcached_append_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_append_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="#_CPPv423memcached_append_by_keyP12memcached_stPKc6size_tPKc6size_tPKc6size_t6time_t8uint32_t" title="Permalink to this definition">¶</a><br /></dt>
 212 <dd><table class="docutils field-list" frame="void" rules="none">
 213 <col class="field-name" />
 214 <col class="field-body" />
 215 <tbody valign="top">
 216 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
 217 <li><strong>ptr</strong> -- pointer to an 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</li>
 218 <li><strong>group_key</strong> -- key namespace</li>
 219 <li><strong>group_key_length</strong> -- length of the key namespace without any terminating zero</li>
 220 <li><strong>key</strong> -- the key</li>
 221 <li><strong>key_length</strong> -- length of the key without any terminating zero</li>
 222 <li><strong>value</strong> -- the value to append/prepend</li>
 223 <li><strong>value_length</strong> -- the length of the value without any terminating zero</li>
 224 <li><strong>expiration</strong> -- expiration as a unix timestamp or as relative expiration time in seconds</li>
 225 <li><strong>flags</strong> -- 16 bit flags</li>
 226 </ul>
 227 </td>
 228 </tr>
 229 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"><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>
 230 </td>
 231 </tr>
 232 </tbody>
 233 </table>
 234 </dd></dl>
 235
 236 </div>
 237 <div class="section" id="description">
 238 <h2>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
 239 <p><a class="reference internal" href="#_CPPv417memcached_prependP12memcached_stPKc6size_tPKc6size_t6time_t8uint32_t" title="memcached_prepend"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_prepend()</span></code></a> and memcached_append are used to modify information on a
 240 server. All methods take a <code class="docutils literal notranslate"><span class="pre">key</span></code>, and <code class="docutils literal notranslate"><span class="pre">key_length</span></code> to store the object. Keys
 241 are currently limited to 250 characters when using either a version of memcached
 242 which is 1.4 or below, or when using the text protocol. You must supply both a
 243 value and a length. Optionally you may set an expiration time for the object
 244 and a 16 bit value (it is meant to be used as a bitmap). <code class="docutils literal notranslate"><span class="pre">flags</span></code> is a 4 byte
 245 space that is stored along the main value. Many sub libraries make use of
 246 this field, so in most cases users should avoid making use of it.</p>
 247 <p><a class="reference internal" href="#_CPPv417memcached_prependP12memcached_stPKc6size_tPKc6size_t6time_t8uint32_t" title="memcached_prepend"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_prepend()</span></code></a> places a segment of data before the last piece of data
 248 stored. Currently expiration and key are not used in the server.</p>
 249 <p><a class="reference internal" href="#_CPPv416memcached_appendP12memcached_stPKc6size_tPKc6size_t6time_t8uint32_t" title="memcached_append"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_append()</span></code></a> places a segment of data at the end of the last piece of data
 250 stored. Currently expiration and key are not used in the server.</p>
 251 <p><a class="reference internal" href="#_CPPv424memcached_prepend_by_keyP12memcached_stPKc6size_tPKc6size_tPKc6size_t6time_t8uint32_t" title="memcached_prepend_by_key"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_prepend_by_key()</span></code></a> and <a class="reference internal" href="#_CPPv423memcached_append_by_keyP12memcached_stPKc6size_tPKc6size_tPKc6size_t6time_t8uint32_t" title="memcached_append_by_key"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_append_by_key()</span></code></a> methods both behave in
 252 a similar manner as the non key methods. The difference is that they use their
 253 group_key parameter to map objects to particular servers.</p>
 254 <p>If you are looking for performance, <a class="reference internal" href="memcached_set.html#_CPPv413memcached_setP12memcached_stPKc6size_tPKc6size_t6time_t8uint32_t" title="memcached_set"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_set()</span></code></a> with non-blocking IO is the
 255 fastest way to store data on the server.</p>
 256 <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>
 257 behavior enabled. However, when using these operations with this behavior on,
 258 there are limits to the size of the payload being sent to the server.  The
 259 reason for these limits is that the Memcached Server does not allow
 260 multi-datagram requests and the current server implementation sets a datagram
 261 size to 1400 bytes. Due to protocol overhead, the actual limit of the user
 262 supplied data is less than 1400 bytes and depends on the protocol in use as,
 263 well as the operation being executed. When running with the binary protocol,
 264 <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
 265 expiry combined may not exceed 1368 bytes. When running with the ASCII protocol,
 266 the exact limit fluctuates depending on which function is being executed and
 267 whether the function is a cas operation or not. For non-cas ASCII set
 268 operations, there are at least 1335 bytes available to split among the key,
 269 key_prefix, and value; for cas ASCII operations there are at least 1318 bytes
 270 available to split among the key, key_prefix and value. If the total size of the
 271 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>
 272 will be returned.</p>
 273 </div>
 274 <div class="section" id="return-value">
 275 <h2>RETURN VALUE<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2>
 276 <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
 277 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>
 278 <p>Use <a class="reference internal" href="memcached_strerror.html#_CPPv418memcached_strerrorP12memcached_st18memcached_return_t" title="memcached_strerror"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_strerror()</span></code></a> to translate this value to a printable string.</p>
 279 </div>
 280 <div class="section" id="see-also">
 281 <h2>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>
 282 <ul class="simple">
 283 <li><em class="manpage"><a class="manpage reference external" href="https://linux.die.net/man/1/memcached">memcached(1)</a></em></li>
 284 <li><a class="reference internal" href="../libmemcached.html"><span class="doc">C/C++ Client Library for memcached</span></a></li>
 285 <li><a class="reference internal" href="memcached_set.html"><span class="doc">Storing data on the server</span></a></li>
 286 <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>
 287 <li><a class="reference internal" href="memcached_strerror.html"><span class="doc">Converting Error Codes to Messages</span></a></li>
 288 </ul>
 289 </div>
 290 </div>
 291
 292
 293            </div>
 294
 295           </div>
 296           <footer>
 297
 298     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 299
 300         <a href="memcached_cas.html" class="btn btn-neutral float-right" title="Working with data on the server in an atomic fashion" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
 301
 302
 303         <a href="memcached_result_st.html" class="btn btn-neutral float-left" title="Working with result sets" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
 304
 305     </div>
 306
 307
 308   <hr/>
 309
 310   <div role="contentinfo">
 311     <p>
 312         &copy; <a href="../copyright.html">Copyright</a>
 313
 314     </p>
 315   </div>
 316   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>.
 317
 318 </footer>
 319
 320         </div>
 321       </div>
 322
 323     </section>
 324
 325   </div>
 326
 327
 328
 329   <script type="text/javascript">
 330       jQuery(function () {
 331           SphinxRtdTheme.Navigation.enable(true);
 332       });
 333   </script>
 334
 335
 336
 337
 338
 339
 340 </body>
 341 </html>