4 <html class=
"writer-html5" lang=
"en" >
8 <meta name=
"viewport" content=
"width=device-width, initial-scale=1.0">
10 <title>Set encryption key
— 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=
"Generating hash values directly" href=
"memcached_generate_hash_value.html" />
41 <link rel=
"prev" title=
"Authentication, Encryption & Hashing" href=
"index_advanced_aeh.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"><a class=
"reference internal" href=
"index_advanced_internals.html">Internal Behavior
</a></li>
99 <li class=
"toctree-l3 current"><a class=
"reference internal" href=
"index_advanced_aeh.html">Authentication, Encryption
& Hashing
</a><ul class=
"current">
100 <li class=
"toctree-l4 current"><a class=
"current reference internal" href=
"#">Set encryption key
</a></li>
101 <li class=
"toctree-l4"><a class=
"reference internal" href=
"memcached_generate_hash_value.html">Generating hash values directly
</a></li>
102 <li class=
"toctree-l4"><a class=
"reference internal" href=
"memcached_sasl.html">SASL support
</a></li>
105 <li class=
"toctree-l3"><a class=
"reference internal" href=
"index_advanced_servers.html">Servers and Server Lists
</a></li>
106 <li class=
"toctree-l3"><a class=
"reference internal" href=
"index_advanced_daemon.html">Affecting the memcached Daemon
</a></li>
107 <li class=
"toctree-l3"><a class=
"reference internal" href=
"index_advanced_stats.html">Statistics
</a></li>
110 <li class=
"toctree-l2"><a class=
"reference internal" href=
"index_deprecated.html">Deprecated Functionality
</a></li>
113 <li class=
"toctree-l1"><a class=
"reference internal" href=
"index_misc.html">Misc
</a></li>
115 <p class=
"caption"><span class=
"caption-text">libmemcachedutil
</span></p>
117 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../libmemcachedutil.html">Introduction
</a></li>
118 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../libmemcachedutil/index.html">libmemcachedutil API
</a></li>
120 <p class=
"caption"><span class=
"caption-text">libhashkit
</span></p>
122 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../libhashkit.html">Introduction
</a></li>
123 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../libhashkit/index.html">libhashkit API
</a></li>
125 <p class=
"caption"><span class=
"caption-text">Client Applications
</span></p>
127 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../bin/index.html">Client Applications
</a></li>
129 <p class=
"caption"><span class=
"caption-text">Copyright
</span></p>
131 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../copyright.html">Copyright
</a></li>
141 <section data-toggle=
"wy-nav-shift" class=
"wy-nav-content-wrap">
144 <nav class=
"wy-nav-top" aria-label=
"top navigation">
146 <i data-toggle=
"wy-nav-top" class=
"fa fa-bars"></i>
147 <a href=
"../index.html">libmemcached
</a>
152 <div class=
"wy-nav-content">
154 <div class=
"rst-content">
172 <div role=
"navigation" aria-label=
"breadcrumbs navigation">
174 <ul class=
"wy-breadcrumbs">
176 <li><a href=
"../index.html" class=
"icon icon-home"></a> »</li>
178 <li><a href=
"index.html">libmemcached API
</a> »</li>
180 <li><a href=
"index_advanced.html">Advanced Topics
</a> »</li>
182 <li><a href=
"index_advanced_aeh.html">Authentication, Encryption
& Hashing
</a> »</li>
184 <li>Set encryption key
</li>
187 <li class=
"wy-breadcrumbs-aside">
198 <div role=
"main" class=
"document" itemscope=
"itemscope" itemtype=
"http://schema.org/Article">
199 <div itemprop=
"articleBody">
201 <div class=
"section" id=
"set-encryption-key">
202 <h1>Set encryption key
<a class=
"headerlink" href=
"#set-encryption-key" title=
"Permalink to this headline">¶
</a></h1>
203 <div class=
"section" id=
"synopsis">
204 <span id=
"index-0"></span><h2>SYNOPSIS
<a class=
"headerlink" href=
"#synopsis" title=
"Permalink to this headline">¶
</a></h2>
205 <p>#include
<libmemcached/memcached.h
></p>
206 <dl class=
"cpp function">
207 <dt id=
"_CPPv426memcached_set_encoding_keyP12memcached_stPKcK6size_t">
208 <span id=
"_CPPv326memcached_set_encoding_keyP12memcached_stPKcK6size_t"></span><span id=
"_CPPv226memcached_set_encoding_keyP12memcached_stPKcK6size_t"></span><span id=
"memcached_set_encoding_key__memcached_stP.cCP.sC"></span>void
<code class=
"sig-name descname">memcached_set_encoding_key
</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>,
<em class=
"property">const
</em> char *
<em>string
</em>,
<em class=
"property">const
</em> size_t
<em>string_length
</em><span class=
"sig-paren">)
</span><a class=
"headerlink" href=
"#_CPPv426memcached_set_encoding_keyP12memcached_stPKcK6size_t" title=
"Permalink to this definition">¶
</a><br /></dt>
211 <p>Compile and link with -lmemcached
</p>
213 <div class=
"section" id=
"description">
214 <h2>DESCRIPTION
<a class=
"headerlink" href=
"#description" title=
"Permalink to this headline">¶
</a></h2>
215 <p><a class=
"reference internal" href=
"#_CPPv426memcached_set_encoding_keyP12memcached_stPKcK6size_t" title=
"memcached_set_encoding_key"><code class=
"xref cpp cpp-func docutils literal notranslate"><span class=
"pre">memcached_set_encoding_key()
</span></code></a> sets the key that will be used to encrypt and decrypt data as it is sent and received from the server.
</p>
216 <p>Currently only AES is is supported.
</p>
218 <div class=
"section" id=
"return-value">
219 <h2>RETURN VALUE
<a class=
"headerlink" href=
"#return-value" title=
"Permalink to this headline">¶
</a></h2>
220 <p>A value of type
<a class=
"reference internal" href=
"memcached_return_t.html#_CPPv418memcached_return_t" title=
"memcached_return_t"><code class=
"xref cpp cpp-type docutils literal notranslate"><span class=
"pre">memcached_return_t
</span></code></a> is returned On success that value
221 will be
<a class=
"reference internal" href=
"memcached_return_t.html#_CPPv4N18memcached_return_t17MEMCACHED_SUCCESSE" title=
"MEMCACHED_SUCCESS"><code class=
"xref cpp cpp-any docutils literal notranslate"><span class=
"pre">MEMCACHED_SUCCESS
</span></code></a>. Use
<a class=
"reference internal" href=
"memcached_strerror.html#_CPPv418memcached_strerrorP12memcached_st18memcached_return_t" title=
"memcached_strerror"><code class=
"xref cpp cpp-func docutils literal notranslate"><span class=
"pre">memcached_strerror()
</span></code></a> to
222 translate this value to a printable string.
</p>
224 <div class=
"section" id=
"see-also">
225 <h2>SEE ALSO
<a class=
"headerlink" href=
"#see-also" title=
"Permalink to this headline">¶
</a></h2>
235 <div class=
"rst-footer-buttons" role=
"navigation" aria-label=
"footer navigation">
237 <a href=
"memcached_generate_hash_value.html" class=
"btn btn-neutral float-right" title=
"Generating hash values directly" accesskey=
"n" rel=
"next">Next
<span class=
"fa fa-arrow-circle-right"></span></a>
240 <a href=
"index_advanced_aeh.html" class=
"btn btn-neutral float-left" title=
"Authentication, Encryption & Hashing" accesskey=
"p" rel=
"prev"><span class=
"fa fa-arrow-circle-left"></span> Previous
</a>
247 <div role=
"contentinfo">
251 © <a href=
"../copyright.html">Copyright
</a>
258 Built with
<a href=
"http://sphinx-doc.org/">Sphinx
</a> using a
260 <a href=
"https://github.com/rtfd/sphinx_rtd_theme">theme
</a>
262 provided by
<a href=
"https://readthedocs.org">Read the Docs
</a>.
274 <script type=
"text/javascript">
276 SphinxRtdTheme.Navigation.enable(true);