4 <html class=
"writer-html5" lang=
"en" >
8 <meta name=
"viewport" content=
"width=device-width, initial-scale=1.0">
10 <title>Storing custom user information in the client.
— libmemcached
1.0.99 documentation
</title>
14 <link rel=
"stylesheet" href=
"../_static/css/theme.css" type=
"text/css" />
15 <link rel=
"stylesheet" href=
"../_static/pygments.css" type=
"text/css" />
24 <script src="../_static/js/html5shiv.min.js"></script>
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>
34 <script type=
"text/javascript" src=
"../_static/js/theme.js"></script>
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=
"Authentication, Encryption & Hashing" href=
"index_advanced_aeh.html" />
41 <link rel=
"prev" title=
"Use custom allocators for embedded usage" href=
"memcached_memory_allocators.html" />
44 <body class=
"wy-body-for-nav">
47 <div class=
"wy-grid-for-nav">
49 <nav data-toggle=
"wy-nav-shift" class=
"wy-nav-side">
50 <div class=
"wy-side-scroll">
51 <div class=
"wy-side-nav-search" >
55 <a href=
"../index.html" class=
"icon icon-home" alt=
"Documentation Home"> libmemcached
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" />
83 <div class=
"wy-menu wy-menu-vertical" data-spy=
"affix" role=
"navigation" aria-label=
"main navigation">
90 <p class=
"caption"><span class=
"caption-text">libmemcached
</span></p>
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"><a class=
"reference internal" href=
"index_basics.html">Basics
</a></li>
95 <li class=
"toctree-l2"><a class=
"reference internal" href=
"index_data.html">Working with Data
</a></li>
96 <li class=
"toctree-l2"><a class=
"reference internal" href=
"index_errors.html">Messages and Errors
</a></li>
97 <li class=
"toctree-l2 current"><a class=
"reference internal" href=
"index_advanced.html">Advanced Topics
</a><ul class=
"current">
98 <li class=
"toctree-l3 current"><a class=
"reference internal" href=
"index_advanced_internals.html">Internal Behavior
</a><ul class=
"current">
99 <li class=
"toctree-l4"><a class=
"reference internal" href=
"memcached_behavior.html">Behaviors of the library
</a></li>
100 <li class=
"toctree-l4"><a class=
"reference internal" href=
"memcached_callback.html">Library callbacks
</a></li>
101 <li class=
"toctree-l4"><a class=
"reference internal" href=
"memcached_memory_allocators.html">Use custom allocators for embedded usage
</a></li>
102 <li class=
"toctree-l4 current"><a class=
"current reference internal" href=
"#">Storing custom user information in the client.
</a></li>
105 <li class=
"toctree-l3"><a class=
"reference internal" href=
"index_advanced_aeh.html">Authentication, Encryption
& Hashing
</a></li>
106 <li class=
"toctree-l3"><a class=
"reference internal" href=
"index_advanced_servers.html">Servers and Server Lists
</a></li>
107 <li class=
"toctree-l3"><a class=
"reference internal" href=
"index_advanced_daemon.html">Affecting the memcached Daemon
</a></li>
108 <li class=
"toctree-l3"><a class=
"reference internal" href=
"index_advanced_stats.html">Statistics
</a></li>
111 <li class=
"toctree-l2"><a class=
"reference internal" href=
"index_deprecated.html">Deprecated Functionality
</a></li>
114 <li class=
"toctree-l1"><a class=
"reference internal" href=
"index_misc.html">Misc
</a></li>
116 <p class=
"caption"><span class=
"caption-text">libmemcachedutil
</span></p>
118 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../libmemcachedutil.html">Introduction
</a></li>
119 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../libmemcachedutil/index.html">libmemcachedutil API
</a></li>
121 <p class=
"caption"><span class=
"caption-text">libhashkit
</span></p>
123 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../libhashkit.html">Introduction
</a></li>
124 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../libhashkit/index.html">libhashkit API
</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></li>
130 <p class=
"caption"><span class=
"caption-text">Copyright
</span></p>
132 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../copyright.html">Copyright
</a></li>
142 <section data-toggle=
"wy-nav-shift" class=
"wy-nav-content-wrap">
145 <nav class=
"wy-nav-top" aria-label=
"top navigation">
147 <i data-toggle=
"wy-nav-top" class=
"fa fa-bars"></i>
148 <a href=
"../index.html">libmemcached
</a>
153 <div class=
"wy-nav-content">
155 <div class=
"rst-content">
173 <div role=
"navigation" aria-label=
"breadcrumbs navigation">
175 <ul class=
"wy-breadcrumbs">
177 <li><a href=
"../index.html" class=
"icon icon-home"></a> »</li>
179 <li><a href=
"index.html">libmemcached API
</a> »</li>
181 <li><a href=
"index_advanced.html">Advanced Topics
</a> »</li>
183 <li><a href=
"index_advanced_internals.html">Internal Behavior
</a> »</li>
185 <li>Storing custom user information in the client.
</li>
188 <li class=
"wy-breadcrumbs-aside">
199 <div role=
"main" class=
"document" itemscope=
"itemscope" itemtype=
"http://schema.org/Article">
200 <div itemprop=
"articleBody">
202 <div class=
"section" id=
"storing-custom-user-information-in-the-client">
203 <h1>Storing custom user information in the client.
<a class=
"headerlink" href=
"#storing-custom-user-information-in-the-client" title=
"Permalink to this headline">¶
</a></h1>
204 <p id=
"index-0">Manage user specific data
</p>
205 <div class=
"section" id=
"library">
206 <h2>LIBRARY
<a class=
"headerlink" href=
"#library" title=
"Permalink to this headline">¶
</a></h2>
207 <p>C Client Library for memcached (libmemcached, -lmemcached)
</p>
209 <div class=
"section" id=
"synopsis">
210 <h2>SYNOPSIS
<a class=
"headerlink" href=
"#synopsis" title=
"Permalink to this headline">¶
</a></h2>
211 <p>#include
<libmemcached/memcached.h
></p>
212 <dl class=
"cpp function">
213 <dt id=
"_CPPv423memcached_get_user_dataP12memcached_st">
214 <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=
"sig-name 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>
217 <dl class=
"cpp function">
218 <dt id=
"_CPPv423memcached_set_user_dataP12memcached_stPv">
219 <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=
"sig-name 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>
222 <p>Compile and link with -lmemcached
</p>
224 <div class=
"section" id=
"description">
225 <h2>DESCRIPTION
<a class=
"headerlink" href=
"#description" title=
"Permalink to this headline">¶
</a></h2>
226 <p>libmemcached(
3) allows you to store a pointer to a user specific data inside
227 the memcached_st structure.
</p>
228 <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
229 <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>
230 <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 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>
232 <div class=
"section" id=
"return-value">
233 <h2>RETURN VALUE
<a class=
"headerlink" href=
"#return-value" title=
"Permalink to this headline">¶
</a></h2>
234 <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>
235 <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 uf the user specific data.
</p>
237 <div class=
"section" id=
"see-also">
238 <h2>SEE ALSO
<a class=
"headerlink" href=
"#see-also" title=
"Permalink to this headline">¶
</a></h2>
248 <div class=
"rst-footer-buttons" role=
"navigation" aria-label=
"footer navigation">
250 <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>
253 <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>
260 <div role=
"contentinfo">
264 © <a href=
"../copyright.html">Copyright
</a>
271 Built with
<a href=
"http://sphinx-doc.org/">Sphinx
</a> using a
273 <a href=
"https://github.com/rtfd/sphinx_rtd_theme">theme
</a>
275 provided by
<a href=
"https://readthedocs.org">Read the Docs
</a>.
287 <script type=
"text/javascript">
289 SphinxRtdTheme.Navigation.enable(true);