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]-->
9 <meta name=
"viewport" content=
"width=device-width, initial-scale=1.0">
11 <title>Creating and destroying a memcached_st
— libmemcached
1.0.99 documentation
</title>
20 <script type=
"text/javascript" src=
"../_static/js/modernizr.min.js"></script>
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>
29 <script type=
"text/javascript" src=
"../_static/js/theme.js"></script>
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=
"Retrieving data from the server" href=
"memcached_get.html" />
40 <link rel=
"prev" title=
"Basics" href=
"index_basics.html" />
43 <body class=
"wy-body-for-nav">
46 <div class=
"wy-grid-for-nav">
48 <nav data-toggle=
"wy-nav-shift" class=
"wy-nav-side">
49 <div class=
"wy-side-scroll">
50 <div class=
"wy-side-nav-search" >
54 <a href=
"../index.html" class=
"icon icon-home"> libmemcached
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" />
81 <div class=
"wy-menu wy-menu-vertical" data-spy=
"affix" role=
"navigation" aria-label=
"main navigation">
88 <p class=
"caption"><span class=
"caption-text">libmemcached
</span></p>
90 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../libmemcached.html">Introduction
</a></li>
91 <li class=
"toctree-l1 current"><a class=
"reference internal" href=
"index.html">libmemcached API
</a><ul class=
"current">
92 <li class=
"toctree-l2 current"><a class=
"reference internal" href=
"index_basics.html">Basics
</a></li>
93 <li class=
"toctree-l2"><a class=
"reference internal" href=
"index_data.html">Working with Data
</a></li>
94 <li class=
"toctree-l2"><a class=
"reference internal" href=
"index_errors.html">Messages and Errors
</a></li>
95 <li class=
"toctree-l2"><a class=
"reference internal" href=
"index_advanced.html">Advanced Topics
</a></li>
96 <li class=
"toctree-l2"><a class=
"reference internal" href=
"index_deprecated.html">Deprecated Functionality
</a></li>
99 <li class=
"toctree-l1"><a class=
"reference internal" href=
"index_misc.html">Misc
</a><ul>
100 <li class=
"toctree-l2"><a class=
"reference internal" href=
"configuration.html">Configuration
</a></li>
101 <li class=
"toctree-l2"><a class=
"reference internal" href=
"constants.html">Constants
</a></li>
102 <li class=
"toctree-l2"><a class=
"reference internal" href=
"examples.html">Examples
</a></li>
103 <li class=
"toctree-l2"><a class=
"reference internal" href=
"versioning.html">Versioning
</a></li>
107 <p class=
"caption"><span class=
"caption-text">libmemcachedutil
</span></p>
109 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../libmemcachedutil.html">Introduction
</a></li>
110 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../libmemcachedutil/index.html">libmemcachedutil API
</a><ul>
111 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../libmemcachedutil/memcached_pool.html">Working with memcached pools
</a></li>
115 <p class=
"caption"><span class=
"caption-text">libhashkit
</span></p>
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><ul>
119 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../libhashkit/hashkit_create.html">Creating a hashkit structure
</a></li>
120 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../libhashkit/hashkit_function.html">Set Hash Function
</a></li>
121 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../libhashkit/hashkit_functions.html">Available Hashes
</a></li>
122 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../libhashkit/hashkit_value.html">Generate hash value
</a></li>
126 <p class=
"caption"><span class=
"caption-text">Client Applications
</span></p>
128 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../bin/index.html">Client Applications
</a><ul>
129 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../bin/memcapable.html">memcapable - Checking a Memcached server capabilities and compatibility
</a></li>
130 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../bin/memcat.html">memcat - “cat” data from a server
</a></li>
131 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../bin/memcp.html">memcp - Copy data to a server
</a></li>
132 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../bin/memdump.html">memdump - Dumping your server
</a></li>
133 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../bin/memerror.html">memerror - translate an error code to a string
</a></li>
134 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../bin/memflush.html">memflush - flush all data from a server
</a></li>
135 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../bin/memrm.html">memrm - Remove data from a server
</a></li>
136 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../bin/memslap.html">memslap - Load testing and benchmarking a server
</a></li>
137 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../bin/memaslap.html">memaslap - Load testing and benchmarking a server
</a></li>
138 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../bin/memstat.html">memstat - Gather statistics from a server
</a></li>
139 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../bin/memexist.html">memexist - Check for the existence of a key
</a></li>
140 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../bin/memparse.html">memparse - Parse an option string
</a></li>
141 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../bin/memping.html">memping - Test to see if a server is available.
</a></li>
142 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../bin/memtouch.html">memtouch - Touches a key.
</a></li>
153 <section data-toggle=
"wy-nav-shift" class=
"wy-nav-content-wrap">
156 <nav class=
"wy-nav-top" aria-label=
"top navigation">
158 <i data-toggle=
"wy-nav-top" class=
"fa fa-bars"></i>
159 <a href=
"../index.html">libmemcached
</a>
164 <div class=
"wy-nav-content">
166 <div class=
"rst-content">
184 <div role=
"navigation" aria-label=
"breadcrumbs navigation">
186 <ul class=
"wy-breadcrumbs">
188 <li><a href=
"../index.html">Docs
</a> »</li>
190 <li><a href=
"index.html">libmemcached API
</a> »</li>
192 <li><a href=
"index_basics.html">Basics
</a> »</li>
194 <li>Creating and destroying a memcached_st
</li>
197 <li class=
"wy-breadcrumbs-aside">
208 <div role=
"main" class=
"document" itemscope=
"itemscope" itemtype=
"http://schema.org/Article">
209 <div itemprop=
"articleBody">
211 <div class=
"section" id=
"creating-and-destroying-a-memcached-st">
212 <h1>Creating and destroying a memcached_st
<a class=
"headerlink" href=
"#creating-and-destroying-a-memcached-st" title=
"Permalink to this headline">¶
</a></h1>
213 <div class=
"section" id=
"synopsis">
214 <h2>SYNOPSIS
<a class=
"headerlink" href=
"#synopsis" title=
"Permalink to this headline">¶
</a></h2>
215 <p>#include
<libmemcached/memcached.h
></p>
217 <dt id=
"_CPPv412memcached_st">
218 <span id=
"_CPPv312memcached_st"></span><span id=
"_CPPv212memcached_st"></span><span id=
"memcached_st"></span><em class=
"property">type
</em><code class=
"sig-name descname">memcached_st
</code><a class=
"headerlink" href=
"#_CPPv412memcached_st" title=
"Permalink to this definition">¶
</a><br /></dt>
221 <dl class=
"function">
222 <dt id=
"_CPPv416memcached_createP12memcached_st">
223 <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>
226 <dl class=
"function">
227 <dt id=
"_CPPv414memcached_freeP12memcached_st">
228 <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>
231 <dl class=
"function">
232 <dt id=
"_CPPv415memcached_cloneP12memcached_stP12memcached_st">
233 <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>
236 <dl class=
"function">
237 <dt id=
"_CPPv423memcached_servers_reset12memcached_st">
238 <span id=
"_CPPv323memcached_servers_reset12memcached_st"></span><span id=
"_CPPv223memcached_servers_reset12memcached_st"></span><span id=
"memcached_servers_reset__memcached_st"></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><span class=
"sig-paren">)
</span><a class=
"headerlink" href=
"#_CPPv423memcached_servers_reset12memcached_st" title=
"Permalink to this definition">¶
</a><br /></dt>
241 <p>Compile and link with -lmemcached
</p>
243 <div class=
"section" id=
"description">
244 <h2>DESCRIPTION
<a class=
"headerlink" href=
"#description" title=
"Permalink to this headline">¶
</a></h2>
245 <p><a class=
"reference internal" href=
"#_CPPv416memcached_createP12memcached_st" title=
"memcached_create"><code class=
"xref cpp cpp-func 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-type docutils literal notranslate"><span class=
"pre">memcached_st
</span></code></a>
246 structure that will then be used by other libmemcached(
3) functions to
247 communicate with the server. You should either pass a statically declared
248 <a class=
"reference internal" href=
"#_CPPv412memcached_st" title=
"memcached_st"><code class=
"xref cpp cpp-type 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-func docutils literal notranslate"><span class=
"pre">memcached_create()
</span></code></a> or
249 a NULL. If a NULL passed in then a structure is allocated for you.
</p>
250 <p>Please note, when you write new application use
251 <a class=
"reference internal" href=
"configuration.html#_CPPv49memcachedPKc6size_t" title=
"memcached"><code class=
"xref cpp cpp-func docutils literal notranslate"><span class=
"pre">memcached()
</span></code></a> over
<a class=
"reference internal" href=
"#_CPPv416memcached_createP12memcached_st" title=
"memcached_create"><code class=
"xref cpp cpp-func docutils literal notranslate"><span class=
"pre">memcached_create()
</span></code></a>.
</p>
252 <p><a class=
"reference internal" href=
"#_CPPv415memcached_cloneP12memcached_stP12memcached_st" title=
"memcached_clone"><code class=
"xref cpp cpp-func 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-func docutils literal notranslate"><span class=
"pre">memcached_create()
</span></code></a> but
253 it copies the defaults and list of servers from the source
254 <a class=
"reference internal" href=
"#_CPPv412memcached_st" title=
"memcached_st"><code class=
"xref cpp cpp-type docutils literal notranslate"><span class=
"pre">memcached_st
</span></code></a>. If you pass a null as the argument for the source
255 to clone, it is the same as a call to
<a class=
"reference internal" href=
"#_CPPv416memcached_createP12memcached_st" title=
"memcached_create"><code class=
"xref cpp cpp-func docutils literal notranslate"><span class=
"pre">memcached_create()
</span></code></a>.
256 If the destination argument is NULL a
<a class=
"reference internal" href=
"#_CPPv412memcached_st" title=
"memcached_st"><code class=
"xref cpp cpp-type docutils literal notranslate"><span class=
"pre">memcached_st
</span></code></a> will be allocated
258 <p><a class=
"reference internal" href=
"#_CPPv423memcached_servers_reset12memcached_st" title=
"memcached_servers_reset"><code class=
"xref cpp cpp-func docutils literal notranslate"><span class=
"pre">memcached_servers_reset()
</span></code></a> allows you to zero out the list of
259 servers that the
<a class=
"reference internal" href=
"#_CPPv412memcached_st" title=
"memcached_st"><code class=
"xref cpp cpp-type docutils literal notranslate"><span class=
"pre">memcached_st
</span></code></a> has.
</p>
260 <p>To clean up memory associated with a
<a class=
"reference internal" href=
"#_CPPv412memcached_st" title=
"memcached_st"><code class=
"xref cpp cpp-type docutils literal notranslate"><span class=
"pre">memcached_st
</span></code></a> structure you
261 should pass it to
<a class=
"reference internal" href=
"#_CPPv414memcached_freeP12memcached_st" title=
"memcached_free"><code class=
"xref cpp cpp-func docutils literal notranslate"><span class=
"pre">memcached_free()
</span></code></a> when you are finished using it.
262 <a class=
"reference internal" href=
"#_CPPv414memcached_freeP12memcached_st" title=
"memcached_free"><code class=
"xref cpp cpp-func docutils literal notranslate"><span class=
"pre">memcached_free()
</span></code></a> is the only way to make sure all memory is
263 deallocated when you finish using the structure.
</p>
264 <p>You may wish to avoid using memcached_create(
3) or memcached_clone(
3) with a
265 stack based allocation. The most common issues related to ABI safety involve
266 heap allocated structures.
</p>
268 <div class=
"section" id=
"return">
269 <h2>RETURN
<a class=
"headerlink" href=
"#return" title=
"Permalink to this headline">¶
</a></h2>
270 <p><a class=
"reference internal" href=
"#_CPPv416memcached_createP12memcached_st" title=
"memcached_create"><code class=
"xref cpp cpp-func 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-type docutils literal notranslate"><span class=
"pre">memcached_st
</span></code></a>
271 that was created (or initialized). On an allocation failure, it returns NULL.
</p>
272 <p><a class=
"reference internal" href=
"#_CPPv415memcached_cloneP12memcached_stP12memcached_st" title=
"memcached_clone"><code class=
"xref cpp cpp-func 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-type docutils literal notranslate"><span class=
"pre">memcached_st
</span></code></a>
273 that was created (or initialized). On an allocation failure, it returns NULL.
</p>
275 <div class=
"section" id=
"see-also">
276 <h2>SEE ALSO
<a class=
"headerlink" href=
"#see-also" title=
"Permalink to this headline">¶
</a></h2>
286 <div class=
"rst-footer-buttons" role=
"navigation" aria-label=
"footer navigation">
288 <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>
291 <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>
298 <div role=
"contentinfo">
300 © <a href=
"../copyright.html">Copyright
</a>
304 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 <script type=
"text/javascript">
319 SphinxRtdTheme.Navigation.enable(true);