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.1.0 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 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>
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">
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 current"><a class=
"reference internal" href=
"index_basics.html">Basics
</a><ul class=
"current">
92 <li class=
"toctree-l3 current"><a class=
"current reference internal" href=
"#">Creating and destroying a memcached_st
</a></li>
93 <li class=
"toctree-l3"><a class=
"reference internal" href=
"memcached_get.html">Retrieving data from the server
</a></li>
94 <li class=
"toctree-l3"><a class=
"reference internal" href=
"memcached_set.html">Storing data on the server
</a></li>
95 <li class=
"toctree-l3"><a class=
"reference internal" href=
"memcached_delete.html">Deleting data from a server
</a></li>
96 <li class=
"toctree-l3"><a class=
"reference internal" href=
"memcached_quit.html">Disconnecting a client from a server
</a></li>
99 <li class=
"toctree-l2"><a class=
"reference internal" href=
"index_data.html">Working with Data
</a></li>
100 <li class=
"toctree-l2"><a class=
"reference internal" href=
"index_errors.html">Messages and Errors
</a></li>
101 <li class=
"toctree-l2"><a class=
"reference internal" href=
"index_advanced.html">Advanced Topics
</a></li>
102 <li class=
"toctree-l2"><a class=
"reference internal" href=
"index_deprecated.html">Deprecated Functionality
</a></li>
105 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../libmemcachedutil/index.html">libmemcachedutil API
</a></li>
106 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../libhashkit/index.html">libhashkit API
</a></li>
107 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../bin/index.html">Client Applications
</a></li>
108 <li class=
"toctree-l1"><a class=
"reference internal" href=
"index_misc.html">Miscellaneous
</a></li>
111 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../changelogs.html">Change Logs
</a></li>
112 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../copyright.html">Copyright
</a></li>
121 <section data-toggle=
"wy-nav-shift" class=
"wy-nav-content-wrap">
124 <nav class=
"wy-nav-top" aria-label=
"top navigation">
126 <i data-toggle=
"wy-nav-top" class=
"fa fa-bars"></i>
127 <a href=
"../index.html">libmemcached
</a>
132 <div class=
"wy-nav-content">
134 <div class=
"rst-content">
152 <div role=
"navigation" aria-label=
"breadcrumbs navigation">
154 <ul class=
"wy-breadcrumbs">
156 <li><a href=
"../index.html">Docs
</a> »</li>
158 <li><a href=
"index.html">libmemcached API
</a> »</li>
160 <li><a href=
"index_basics.html">Basics
</a> »</li>
162 <li>Creating and destroying a memcached_st
</li>
165 <li class=
"wy-breadcrumbs-aside">
169 <a href=
"https://github.com/m6w6/libmemcached/blob/v1.x/docs/source/libmemcached/memcached_create.rst" class=
"fa fa-github"> Edit on GitHub
</a>
180 <div role=
"main" class=
"document" itemscope=
"itemscope" itemtype=
"http://schema.org/Article">
181 <div itemprop=
"articleBody">
183 <div class=
"section" id=
"creating-and-destroying-a-memcached-st">
184 <h1>Creating and destroying a memcached_st
<a class=
"headerlink" href=
"#creating-and-destroying-a-memcached-st" title=
"Permalink to this headline">¶
</a></h1>
185 <div class=
"section" id=
"synopsis">
186 <h2>SYNOPSIS
<a class=
"headerlink" href=
"#synopsis" title=
"Permalink to this headline">¶
</a></h2>
187 <dl class=
"docutils">
188 <dt>#include
<libmemcached/memcached.h
></dt>
189 <dd>Compile and link with -lmemcached
</dd>
192 <dt id=
"_CPPv412memcached_st">
193 <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=
"descname">memcached_st
</code><a class=
"headerlink" href=
"#_CPPv412memcached_st" title=
"Permalink to this definition">¶
</a><br /></dt>
196 <dl class=
"function">
197 <dt id=
"_CPPv416memcached_createP12memcached_st">
198 <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=
"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>
199 <dd><table class=
"docutils field-list" frame=
"void" rules=
"none">
200 <col class=
"field-name" />
201 <col class=
"field-body" />
203 <tr class=
"field-odd field"><th class=
"field-name">Parameters:
</th><td class=
"field-body"><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
</td>
205 <tr class=
"field-even field"><th class=
"field-name">Returns:
</th><td class=
"field-body">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
</td>
211 <dl class=
"function">
212 <dt id=
"_CPPv414memcached_freeP12memcached_st">
213 <span id=
"_CPPv314memcached_freeP12memcached_st"></span><span id=
"_CPPv214memcached_freeP12memcached_st"></span><span id=
"memcached_free__memcached_stP"></span>void
<code class=
"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>
214 <dd><table class=
"docutils field-list" frame=
"void" rules=
"none">
215 <col class=
"field-name" />
216 <col class=
"field-body" />
218 <tr class=
"field-odd field"><th class=
"field-name">Parameters:
</th><td class=
"field-body"><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
</td>
224 <dl class=
"function">
225 <dt id=
"_CPPv415memcached_cloneP12memcached_stP12memcached_st">
226 <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=
"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>
227 <dd><table class=
"docutils field-list" frame=
"void" rules=
"none">
228 <col class=
"field-name" />
229 <col class=
"field-body" />
231 <tr class=
"field-odd field"><th class=
"field-name">Parameters:
</th><td class=
"field-body"><ul class=
"first simple">
232 <li><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
</li>
233 <li><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
</li>
237 <tr class=
"field-even field"><th class=
"field-name">Returns:
</th><td class=
"field-body"><p class=
"first last">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>
244 <dl class=
"function">
245 <dt id=
"_CPPv423memcached_servers_resetP12memcached_st">
246 <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=
"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>
247 <dd><table class=
"docutils field-list" frame=
"void" rules=
"none">
248 <col class=
"field-name" />
249 <col class=
"field-body" />
251 <tr class=
"field-odd field"><th class=
"field-name">Parameters:
</th><td class=
"field-body"><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
</td>
258 <div class=
"section" id=
"description">
259 <h2>DESCRIPTION
<a class=
"headerlink" href=
"#description" title=
"Permalink to this headline">¶
</a></h2>
260 <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
261 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
262 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
263 a NULL. If a NULL passed in then a structure is allocated for you.
</p>
264 <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
265 <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>
266 <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
267 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
268 as the argument for the source to clone, it is the same as a call to
269 <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
270 allocated for you.
</p>
271 <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
272 <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>
273 <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
274 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
275 way to make sure all memory is deallocated when you finish using the structure.
</p>
276 <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
277 based allocation. The most common issues related to ABI safety involve heap
278 allocated structures.
</p>
280 <div class=
"section" id=
"return-value">
281 <h2>RETURN VALUE
<a class=
"headerlink" href=
"#return-value" title=
"Permalink to this headline">¶
</a></h2>
282 <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
283 initialized). On an allocation failure, it returns NULL.
</p>
284 <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
285 initialized). On an allocation failure, it returns NULL.
</p>
287 <div class=
"section" id=
"see-also">
288 <h2>SEE ALSO
<a class=
"headerlink" href=
"#see-also" title=
"Permalink to this headline">¶
</a></h2>
290 <li><em class=
"manpage"><a class=
"manpage reference external" href=
"https://linux.die.net/man/1/memcached">memcached(
1)
</a></em></li>
291 <li><a class=
"reference internal" href=
"../libmemcached.html"><span class=
"doc">C/C++ Client Library for memcached
</span></a></li>
302 <div class=
"rst-footer-buttons" role=
"navigation" aria-label=
"footer navigation">
304 <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>
307 <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>
314 <div role=
"contentinfo">
316 © <a href=
"../copyright.html">Copyright
</a>
320 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>.
333 <script type=
"text/javascript">
335 SphinxRtdTheme.Navigation.enable(true);