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>Storing custom information in the client
— 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 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=
"Authentication, Encryption & Hashing" href=
"index_advanced_aeh.html" />
40 <link rel=
"prev" title=
"Use custom allocators for embedded usage" href=
"memcached_memory_allocators.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"><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 current"><a class=
"reference internal" href=
"index_advanced.html">Advanced Topics
</a><ul class=
"current">
96 <li class=
"toctree-l3 current"><a class=
"reference internal" href=
"index_advanced_internals.html">Internal Behavior
</a><ul class=
"current">
97 <li class=
"toctree-l4"><a class=
"reference internal" href=
"memcached_behavior.html">Behaviors of the library
</a></li>
98 <li class=
"toctree-l4"><a class=
"reference internal" href=
"memcached_callback.html">Library callbacks
</a></li>
99 <li class=
"toctree-l4"><a class=
"reference internal" href=
"memcached_memory_allocators.html">Use custom allocators for embedded usage
</a></li>
100 <li class=
"toctree-l4 current"><a class=
"current reference internal" href=
"#">Storing custom information in the client
</a></li>
103 <li class=
"toctree-l3"><a class=
"reference internal" href=
"index_advanced_aeh.html">Authentication, Encryption
& Hashing
</a></li>
104 <li class=
"toctree-l3"><a class=
"reference internal" href=
"index_advanced_servers.html">Servers and Server Lists
</a></li>
105 <li class=
"toctree-l3"><a class=
"reference internal" href=
"index_advanced_daemon.html">Affecting the memcached Daemon
</a></li>
106 <li class=
"toctree-l3"><a class=
"reference internal" href=
"index_advanced_stats.html">Statistics
</a></li>
109 <li class=
"toctree-l2"><a class=
"reference internal" href=
"index_deprecated.html">Deprecated Functionality
</a></li>
112 <li class=
"toctree-l1"><a class=
"reference internal" href=
"index_misc.html">Misc
</a></li>
114 <p class=
"caption"><span class=
"caption-text">libmemcachedutil
</span></p>
116 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../libmemcachedutil.html">Introduction
</a></li>
117 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../libmemcachedutil/index.html">libmemcachedutil API
</a></li>
119 <p class=
"caption"><span class=
"caption-text">libhashkit
</span></p>
121 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../libhashkit.html">Introduction
</a></li>
122 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../libhashkit/index.html">libhashkit API
</a></li>
124 <p class=
"caption"><span class=
"caption-text">Client Applications
</span></p>
126 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../bin/index.html">Client Applications
</a></li>
128 <p class=
"caption"><span class=
"caption-text">Copyright
</span></p>
130 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../copyright.html">Copyright
</a></li>
139 <section data-toggle=
"wy-nav-shift" class=
"wy-nav-content-wrap">
142 <nav class=
"wy-nav-top" aria-label=
"top navigation">
144 <i data-toggle=
"wy-nav-top" class=
"fa fa-bars"></i>
145 <a href=
"../index.html">libmemcached
</a>
150 <div class=
"wy-nav-content">
152 <div class=
"rst-content">
170 <div role=
"navigation" aria-label=
"breadcrumbs navigation">
172 <ul class=
"wy-breadcrumbs">
174 <li><a href=
"../index.html">Docs
</a> »</li>
176 <li><a href=
"index.html">libmemcached API
</a> »</li>
178 <li><a href=
"index_advanced.html">Advanced Topics
</a> »</li>
180 <li><a href=
"index_advanced_internals.html">Internal Behavior
</a> »</li>
182 <li>Storing custom information in the client
</li>
185 <li class=
"wy-breadcrumbs-aside">
196 <div role=
"main" class=
"document" itemscope=
"itemscope" itemtype=
"http://schema.org/Article">
197 <div itemprop=
"articleBody">
199 <div class=
"section" id=
"storing-custom-information-in-the-client">
200 <h1>Storing custom information in the client
<a class=
"headerlink" href=
"#storing-custom-information-in-the-client" title=
"Permalink to this headline">¶
</a></h1>
201 <div class=
"section" id=
"synopsis">
202 <h2>SYNOPSIS
<a class=
"headerlink" href=
"#synopsis" title=
"Permalink to this headline">¶
</a></h2>
203 <dl class=
"docutils">
204 <dt>#include
<libmemcached/memcached.h
></dt>
205 <dd>Compile and link with -lmemcached
</dd>
207 <dl class=
"function">
208 <dt id=
"_CPPv423memcached_get_user_dataP12memcached_st">
209 <span id=
"_CPPv323memcached_get_user_dataP12memcached_st"></span><span id=
"_CPPv223memcached_get_user_dataP12memcached_st"></span><span id=
"memcached_get_user_data__memcached_stP"></span>void *
<code class=
"descname">memcached_get_user_data
</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><span class=
"sig-paren">)
</span><a class=
"headerlink" href=
"#_CPPv423memcached_get_user_dataP12memcached_st" title=
"Permalink to this definition">¶
</a><br /></dt>
210 <dd><table class=
"docutils field-list" frame=
"void" rules=
"none">
211 <col class=
"field-name" />
212 <col class=
"field-body" />
214 <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=
"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
</td>
216 <tr class=
"field-even field"><th class=
"field-name">Returns:
</th><td class=
"field-body">opaque pointer to the user supplied data
</td>
222 <dl class=
"function">
223 <dt id=
"_CPPv423memcached_set_user_dataP12memcached_stPv">
224 <span id=
"_CPPv323memcached_set_user_dataP12memcached_stPv"></span><span id=
"_CPPv223memcached_set_user_dataP12memcached_stPv"></span><span id=
"memcached_set_user_data__memcached_stP.voidP"></span>void *
<code class=
"descname">memcached_set_user_data
</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>, void *
<em>data
</em><span class=
"sig-paren">)
</span><a class=
"headerlink" href=
"#_CPPv423memcached_set_user_dataP12memcached_stPv" title=
"Permalink to this definition">¶
</a><br /></dt>
225 <dd><table class=
"docutils field-list" frame=
"void" rules=
"none">
226 <col class=
"field-name" />
227 <col class=
"field-body" />
229 <tr class=
"field-odd field"><th class=
"field-name">Parameters:
</th><td class=
"field-body"><ul class=
"first simple">
230 <li><strong>ptr
</strong> -- pointer to 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>
231 <li><strong>data
</strong> -- opaque pointer to user supplied data
</li>
235 <tr class=
"field-even field"><th class=
"field-name">Returns:
</th><td class=
"field-body"><p class=
"first last">opaque pointer to the previously set
<a class=
"reference internal" href=
"#_CPPv423memcached_set_user_dataP12memcached_stPv" title=
"memcached_set_user_data::data"><code class=
"xref cpp cpp-any docutils literal notranslate"><span class=
"pre">data
</span></code></a></p>
243 <div class=
"section" id=
"description">
244 <h2>DESCRIPTION
<a class=
"headerlink" href=
"#description" title=
"Permalink to this headline">¶
</a></h2>
245 <p><code class=
"xref cpp cpp-any docutils literal notranslate"><span class=
"pre">libmemcached
</span></code> allows you to store a pointer to a user specific data inside
246 the memcached_st structure.
</p>
247 <p><a class=
"reference internal" href=
"#_CPPv423memcached_set_user_dataP12memcached_stPv" title=
"memcached_set_user_data"><code class=
"xref cpp cpp-func docutils literal notranslate"><span class=
"pre">memcached_set_user_data()
</span></code></a> is used to set the user specific data in the
248 <a class=
"reference internal" href=
"memcached_create.html#_CPPv412memcached_st" title=
"memcached_st"><code class=
"xref cpp cpp-type docutils literal notranslate"><span class=
"pre">memcached_st
</span></code></a> structure.
</p>
249 <p><a class=
"reference internal" href=
"#_CPPv423memcached_get_user_dataP12memcached_st" title=
"memcached_get_user_data"><code class=
"xref cpp cpp-func docutils literal notranslate"><span class=
"pre">memcached_get_user_data()
</span></code></a> is used to retrieve the user specific data in
250 the
<a class=
"reference internal" href=
"memcached_create.html#_CPPv412memcached_st" title=
"memcached_st"><code class=
"xref cpp cpp-type docutils literal notranslate"><span class=
"pre">memcached_st
</span></code></a> structure.
</p>
252 <div class=
"section" id=
"return-value">
253 <h2>RETURN VALUE
<a class=
"headerlink" href=
"#return-value" title=
"Permalink to this headline">¶
</a></h2>
254 <p><a class=
"reference internal" href=
"#_CPPv423memcached_set_user_dataP12memcached_stPv" title=
"memcached_set_user_data"><code class=
"xref cpp cpp-func docutils literal notranslate"><span class=
"pre">memcached_set_user_data()
</span></code></a> returns the previous value of the user specific data.
</p>
255 <p><a class=
"reference internal" href=
"#_CPPv423memcached_get_user_dataP12memcached_st" title=
"memcached_get_user_data"><code class=
"xref cpp cpp-func docutils literal notranslate"><span class=
"pre">memcached_get_user_data()
</span></code></a> returns the current value of the user specific data.
</p>
257 <div class=
"section" id=
"see-also">
258 <h2>SEE ALSO
<a class=
"headerlink" href=
"#see-also" title=
"Permalink to this headline">¶
</a></h2>
260 <li><em class=
"manpage"><a class=
"manpage reference external" href=
"https://linux.die.net/man/1/memcached">memcached(
1)
</a></em></li>
261 <li><a class=
"reference internal" href=
"../libmemcached.html"><span class=
"doc">C/C++ Client Library for memcached
</span></a></li>
272 <div class=
"rst-footer-buttons" role=
"navigation" aria-label=
"footer navigation">
274 <a href=
"index_advanced_aeh.html" class=
"btn btn-neutral float-right" title=
"Authentication, Encryption & Hashing" accesskey=
"n" rel=
"next">Next
<span class=
"fa fa-arrow-circle-right"></span></a>
277 <a href=
"memcached_memory_allocators.html" class=
"btn btn-neutral float-left" title=
"Use custom allocators for embedded usage" accesskey=
"p" rel=
"prev"><span class=
"fa fa-arrow-circle-left"></span> Previous
</a>
284 <div role=
"contentinfo">
286 © <a href=
"../copyright.html">Copyright
</a>
290 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>.
303 <script type=
"text/javascript">
305 SphinxRtdTheme.Navigation.enable(true);