git.m6w6.name Git - m6w6/libmemcached/blob - libmemcached/memcached_create.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>Creating and destroying a memcached_st &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="Retrieving data from the server" href="memcached_get.html" />
  41     <link rel="prev" title="Basics" href="index_basics.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 current"><a class="reference internal" href="index.html">libmemcached API</a><ul class="current">
  94 <li class="toctree-l2 current"><a class="reference internal" href="index_basics.html">Basics</a><ul class="current">
  95 <li class="toctree-l3 current"><a class="current reference internal" href="#">Creating and destroying a memcached_st</a></li>
  96 <li class="toctree-l3"><a class="reference internal" href="memcached_get.html">Retrieving data from the server</a></li>
  97 <li class="toctree-l3"><a class="reference internal" href="memcached_set.html">Storing data on the server</a></li>
  98 <li class="toctree-l3"><a class="reference internal" href="memcached_delete.html">Deleting data from a server</a></li>
  99 <li class="toctree-l3"><a class="reference internal" href="memcached_quit.html">Disconnecting a client from a server</a></li>
 100 </ul>
 101 </li>
 102 <li class="toctree-l2"><a class="reference internal" href="index_data.html">Working with Data</a></li>
 103 <li class="toctree-l2"><a class="reference internal" href="index_errors.html">Messages and Errors</a></li>
 104 <li class="toctree-l2"><a class="reference internal" href="index_advanced.html">Advanced Topics</a></li>
 105 <li class="toctree-l2"><a class="reference internal" href="index_deprecated.html">Deprecated Functionality</a></li>
 106 </ul>
 107 </li>
 108 <li class="toctree-l1"><a class="reference internal" href="index_misc.html">Misc</a></li>
 109 </ul>
 110 <p class="caption"><span class="caption-text">libmemcachedutil</span></p>
 111 <ul>
 112 <li class="toctree-l1"><a class="reference internal" href="../libmemcachedutil.html">Introduction</a></li>
 113 <li class="toctree-l1"><a class="reference internal" href="../libmemcachedutil/index.html">libmemcachedutil API</a></li>
 114 </ul>
 115 <p class="caption"><span class="caption-text">libhashkit</span></p>
 116 <ul>
 117 <li class="toctree-l1"><a class="reference internal" href="../libhashkit.html">Introduction</a></li>
 118 <li class="toctree-l1"><a class="reference internal" href="../libhashkit/index.html">libhashkit API</a></li>
 119 </ul>
 120 <p class="caption"><span class="caption-text">Client Applications</span></p>
 121 <ul>
 122 <li class="toctree-l1"><a class="reference internal" href="../bin/index.html">Client Applications</a></li>
 123 </ul>
 124 <p class="caption"><span class="caption-text">Copyright</span></p>
 125 <ul>
 126 <li class="toctree-l1"><a class="reference internal" href="../copyright.html">Copyright</a></li>
 127 </ul>
 128
 129
 130
 131         </div>
 132
 133       </div>
 134     </nav>
 135
 136     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
 137
 138
 139       <nav class="wy-nav-top" aria-label="top navigation">
 140
 141           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
 142           <a href="../index.html">libmemcached</a>
 143
 144       </nav>
 145
 146
 147       <div class="wy-nav-content">
 148
 149         <div class="rst-content">
 150
 151
 152
 153
 154
 155
 156
 157
 158
 159
 160
 161
 162
 163
 164
 165
 166
 167 <div role="navigation" aria-label="breadcrumbs navigation">
 168
 169   <ul class="wy-breadcrumbs">
 170
 171       <li><a href="../index.html" class="icon icon-home"></a> &raquo;</li>
 172
 173           <li><a href="index.html">libmemcached API</a> &raquo;</li>
 174
 175           <li><a href="index_basics.html">Basics</a> &raquo;</li>
 176
 177       <li>Creating and destroying a memcached_st</li>
 178
 179
 180       <li class="wy-breadcrumbs-aside">
 181
 182
 183
 184       </li>
 185
 186   </ul>
 187
 188
 189   <hr/>
 190 </div>
 191           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
 192            <div itemprop="articleBody">
 193
 194   <div class="section" id="creating-and-destroying-a-memcached-st">
 195 <h1>Creating and destroying a memcached_st<a class="headerlink" href="#creating-and-destroying-a-memcached-st" title="Permalink to this headline">¶</a></h1>
 196 <div class="section" id="synopsis">
 197 <h2>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2>
 198 <dl class="simple">
 199 <dt>#include &lt;libmemcached/memcached.h&gt;</dt><dd><p>Compile and link with -lmemcached</p>
 200 </dd>
 201 </dl>
 202 <dl class="cpp type">
 203 <dt id="_CPPv412memcached_st">
 204 <span id="_CPPv312memcached_st"></span><span id="_CPPv212memcached_st"></span><span id="memcached_st"></span><em class="property">typedef </em><em class="property">struct</em> <a class="reference internal" href="#_CPPv412memcached_st" title="memcached_st">memcached_st</a> <code class="sig-name descname">memcached_st</code><a class="headerlink" href="#_CPPv412memcached_st" title="Permalink to this definition">¶</a><br /></dt>
 205 <dd></dd></dl>
 206
 207 <dl class="cpp function">
 208 <dt id="_CPPv416memcached_createP12memcached_st">
 209 <span id="_CPPv316memcached_createP12memcached_st"></span><span id="_CPPv216memcached_createP12memcached_st"></span><span id="memcached_create__memcached_stP"></span><a class="reference internal" href="#_CPPv412memcached_st" title="memcached_st">memcached_st</a> *<code class="sig-name descname">memcached_create</code><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv412memcached_st" title="memcached_st">memcached_st</a> *<em>ptr</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv416memcached_createP12memcached_st" title="Permalink to this definition">¶</a><br /></dt>
 210 <dd><dl class="field-list simple">
 211 <dt class="field-odd">Parameters</dt>
 212 <dd class="field-odd"><p><strong>ptr</strong> -- pointer to user-allocated <a class="reference internal" href="#_CPPv412memcached_st" title="memcached_st"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_st</span></code></a> struct or null pointer</p>
 213 </dd>
 214 <dt class="field-even">Returns</dt>
 215 <dd class="field-even"><p>pointer to initialized <a class="reference internal" href="#_CPPv412memcached_st" title="memcached_st"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_st</span></code></a> struct</p>
 216 </dd>
 217 </dl>
 218 </dd></dl>
 219
 220 <dl class="cpp function">
 221 <dt id="_CPPv414memcached_freeP12memcached_st">
 222 <span id="_CPPv314memcached_freeP12memcached_st"></span><span id="_CPPv214memcached_freeP12memcached_st"></span><span id="memcached_free__memcached_stP"></span>void <code class="sig-name descname">memcached_free</code><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv412memcached_st" title="memcached_st">memcached_st</a> *<em>ptr</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv414memcached_freeP12memcached_st" title="Permalink to this definition">¶</a><br /></dt>
 223 <dd><dl class="field-list simple">
 224 <dt class="field-odd">Parameters</dt>
 225 <dd class="field-odd"><p><strong>ptr</strong> -- pointer to initialized <a class="reference internal" href="#_CPPv412memcached_st" title="memcached_st"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_st</span></code></a> struct to destroy and possibly free</p>
 226 </dd>
 227 </dl>
 228 </dd></dl>
 229
 230 <dl class="cpp function">
 231 <dt id="_CPPv415memcached_cloneP12memcached_stP12memcached_st">
 232 <span id="_CPPv315memcached_cloneP12memcached_stP12memcached_st"></span><span id="_CPPv215memcached_cloneP12memcached_stP12memcached_st"></span><span id="memcached_clone__memcached_stP.memcached_stP"></span><a class="reference internal" href="#_CPPv412memcached_st" title="memcached_st">memcached_st</a> *<code class="sig-name descname">memcached_clone</code><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv412memcached_st" title="memcached_st">memcached_st</a> *<em>destination</em>, <a class="reference internal" href="#_CPPv412memcached_st" title="memcached_st">memcached_st</a> *<em>source</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv415memcached_cloneP12memcached_stP12memcached_st" title="Permalink to this definition">¶</a><br /></dt>
 233 <dd><dl class="field-list simple">
 234 <dt class="field-odd">Parameters</dt>
 235 <dd class="field-odd"><ul class="simple">
 236 <li><p><strong>destination</strong> -- pointer to user-allocated <a class="reference internal" href="#_CPPv412memcached_st" title="memcached_st"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_st</span></code></a> struct or null pointer</p></li>
 237 <li><p><strong>source</strong> -- pointer to initialized <a class="reference internal" href="#_CPPv412memcached_st" title="memcached_st"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_st</span></code></a> struct to copy from</p></li>
 238 </ul>
 239 </dd>
 240 <dt class="field-even">Returns</dt>
 241 <dd class="field-even"><p>pointer to newly initialized <a class="reference internal" href="#_CPPv415memcached_cloneP12memcached_stP12memcached_st" title="memcached_clone::destination"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">destination</span></code></a>, copied from <a class="reference internal" href="#_CPPv415memcached_cloneP12memcached_stP12memcached_st" title="memcached_clone::source"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">source</span></code></a></p>
 242 </dd>
 243 </dl>
 244 </dd></dl>
 245
 246 <dl class="cpp function">
 247 <dt id="_CPPv423memcached_servers_resetP12memcached_st">
 248 <span id="_CPPv323memcached_servers_resetP12memcached_st"></span><span id="_CPPv223memcached_servers_resetP12memcached_st"></span><span id="memcached_servers_reset__memcached_stP"></span>void <code class="sig-name descname">memcached_servers_reset</code><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv412memcached_st" title="memcached_st">memcached_st</a> *<em>ptr</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv423memcached_servers_resetP12memcached_st" title="Permalink to this definition">¶</a><br /></dt>
 249 <dd><dl class="field-list simple">
 250 <dt class="field-odd">Parameters</dt>
 251 <dd class="field-odd"><p><strong>ptr</strong> -- pointer to initialized <a class="reference internal" href="#_CPPv412memcached_st" title="memcached_st"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_st</span></code></a> struct</p>
 252 </dd>
 253 </dl>
 254 </dd></dl>
 255
 256 </div>
 257 <div class="section" id="description">
 258 <h2>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
 259 <p><a class="reference internal" href="#_CPPv416memcached_createP12memcached_st" title="memcached_create"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_create()</span></code></a> is used to create a <a class="reference internal" href="#_CPPv412memcached_st" title="memcached_st"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_st</span></code></a> structure that will then
 260 be used by other <code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">libmemcached</span></code> functions to communicate with the server. You
 261 should either pass a statically declared <a class="reference internal" href="#_CPPv412memcached_st" title="memcached_st"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_st</span></code></a> to <a class="reference internal" href="#_CPPv416memcached_createP12memcached_st" title="memcached_create"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_create()</span></code></a> or
 262 a NULL. If a NULL passed in then a structure is allocated for you.</p>
 263 <p>Please note, when you write new application use <a class="reference internal" href="configuration.html#_CPPv49memcachedPKc6size_t" title="memcached"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached()</span></code></a> over
 264 <a class="reference internal" href="#_CPPv416memcached_createP12memcached_st" title="memcached_create"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_create()</span></code></a>.</p>
 265 <p><a class="reference internal" href="#_CPPv415memcached_cloneP12memcached_stP12memcached_st" title="memcached_clone"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_clone()</span></code></a> is similar to <a class="reference internal" href="#_CPPv416memcached_createP12memcached_st" title="memcached_create"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_create()</span></code></a> but it copies the defaults
 266 and list of servers from the source <a class="reference internal" href="#_CPPv412memcached_st" title="memcached_st"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_st</span></code></a> pointer. If you pass a null
 267 as the argument for the source to clone, it is the same as a call to
 268 <a class="reference internal" href="#_CPPv416memcached_createP12memcached_st" title="memcached_create"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_create()</span></code></a>. If the destination argument is NULL a <a class="reference internal" href="#_CPPv412memcached_st" title="memcached_st"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_st</span></code></a> will be
 269 allocated for you.</p>
 270 <p><a class="reference internal" href="#_CPPv423memcached_servers_resetP12memcached_st" title="memcached_servers_reset"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_servers_reset()</span></code></a> allows you to zero out the list of servers that the
 271 <a class="reference internal" href="#_CPPv412memcached_st" title="memcached_st"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_st</span></code></a> has.</p>
 272 <p>To clean up memory associated with a <a class="reference internal" href="#_CPPv412memcached_st" title="memcached_st"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_st</span></code></a> structure you should pass it
 273 to <a class="reference internal" href="#_CPPv414memcached_freeP12memcached_st" title="memcached_free"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_free()</span></code></a> when you are finished using it. <a class="reference internal" href="#_CPPv414memcached_freeP12memcached_st" title="memcached_free"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_free()</span></code></a> is the only
 274 way to make sure all memory is deallocated when you finish using the structure.</p>
 275 <p>You may wish to avoid using <a class="reference internal" href="#_CPPv416memcached_createP12memcached_st" title="memcached_create"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_create()</span></code></a> or <a class="reference internal" href="#_CPPv415memcached_cloneP12memcached_stP12memcached_st" title="memcached_clone"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_clone()</span></code></a> with a stack
 276 based allocation. The most common issues related to ABI safety involve heap
 277 allocated structures.</p>
 278 </div>
 279 <div class="section" id="return-value">
 280 <h2>RETURN VALUE<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2>
 281 <p><a class="reference internal" href="#_CPPv416memcached_createP12memcached_st" title="memcached_create"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_create()</span></code></a> returns a pointer to the <a class="reference internal" href="#_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
 282 initialized). On an allocation failure, it returns NULL.</p>
 283 <p><a class="reference internal" href="#_CPPv415memcached_cloneP12memcached_stP12memcached_st" title="memcached_clone"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_clone()</span></code></a> returns a pointer to the <a class="reference internal" href="#_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
 284 initialized). On an allocation failure, it returns NULL.</p>
 285 </div>
 286 <div class="section" id="see-also">
 287 <h2>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>
 288 <ul class="simple">
 289 <li><p><em class="manpage"><a class="manpage reference external" href="https://linux.die.net/man/1/memcached">memcached(1)</a></em></p></li>
 290 <li><p><a class="reference internal" href="../libmemcached.html"><span class="doc">C/C++ Client Library for memcached</span></a></p></li>
 291 </ul>
 292 </div>
 293 </div>
 294
 295
 296            </div>
 297
 298           </div>
 299           <footer>
 300
 301     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 302
 303         <a href="memcached_get.html" class="btn btn-neutral float-right" title="Retrieving data from the server" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
 304
 305
 306         <a href="index_basics.html" class="btn btn-neutral float-left" title="Basics" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
 307
 308     </div>
 309
 310
 311   <hr/>
 312
 313   <div role="contentinfo">
 314     <p>
 315
 316
 317         &copy; <a href="../copyright.html">Copyright</a>
 318
 319     </p>
 320   </div>
 321
 322
 323
 324     Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
 325
 326     <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
 327
 328     provided by <a href="https://readthedocs.org">Read the Docs</a>.
 329
 330 </footer>
 331
 332         </div>
 333       </div>
 334
 335     </section>
 336
 337   </div>
 338
 339
 340   <script type="text/javascript">
 341       jQuery(function () {
 342           SphinxRtdTheme.Navigation.enable(true);
 343       });
 344   </script>
 345
 346
 347
 348
 349
 350
 351 </body>
 352 </html>