git.m6w6.name Git - m6w6/libmemcached/blob - libmemcached/memcached_set_encoding_key.html

   1
   2
   3 <!DOCTYPE html>
   4 <html class="writer-html5" lang="en" >
   5 <head>
   6   <meta charset="utf-8">
   7
   8   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   9
  10   <title>Set encryption key &mdash; libmemcached 1.0.99 documentation</title>
  11
  12
  13
  14   <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
  15   <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
  16
  17
  18
  19
  20
  21
  22
  23   <!--[if lt IE 9]>
  24     <script src="../_static/js/html5shiv.min.js"></script>
  25   <![endif]-->
  26
  27
  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>
  33
  34     <script type="text/javascript" src="../_static/js/theme.js"></script>
  35
  36
  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 &amp; Hashing" href="index_advanced_aeh.html" />
  42 </head>
  43
  44 <body class="wy-body-for-nav">
  45
  46
  47   <div class="wy-grid-for-nav">
  48
  49     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
  50       <div class="wy-side-scroll">
  51         <div class="wy-side-nav-search" >
  52
  53
  54
  55             <a href="../index.html" class="icon icon-home" alt="Documentation Home"> libmemcached
  56
  57
  58
  59           </a>
  60
  61
  62
  63
  64               <div class="version">
  65                 1.0
  66               </div>
  67
  68
  69
  70
  71 <div role="search">
  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" />
  76   </form>
  77 </div>
  78
  79
  80         </div>
  81
  82
  83         <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
  84
  85
  86
  87
  88
  89
  90               <p class="caption"><span class="caption-text">libmemcached</span></p>
  91 <ul class="current">
  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 &amp; 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>
 103 </ul>
 104 </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>
 108 </ul>
 109 </li>
 110 <li class="toctree-l2"><a class="reference internal" href="index_deprecated.html">Deprecated Functionality</a></li>
 111 </ul>
 112 </li>
 113 <li class="toctree-l1"><a class="reference internal" href="index_misc.html">Misc</a></li>
 114 </ul>
 115 <p class="caption"><span class="caption-text">libmemcachedutil</span></p>
 116 <ul>
 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>
 119 </ul>
 120 <p class="caption"><span class="caption-text">libhashkit</span></p>
 121 <ul>
 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>
 124 </ul>
 125 <p class="caption"><span class="caption-text">Client Applications</span></p>
 126 <ul>
 127 <li class="toctree-l1"><a class="reference internal" href="../bin/index.html">Client Applications</a></li>
 128 </ul>
 129 <p class="caption"><span class="caption-text">Copyright</span></p>
 130 <ul>
 131 <li class="toctree-l1"><a class="reference internal" href="../copyright.html">Copyright</a></li>
 132 </ul>
 133
 134
 135
 136         </div>
 137
 138       </div>
 139     </nav>
 140
 141     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
 142
 143
 144       <nav class="wy-nav-top" aria-label="top navigation">
 145
 146           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
 147           <a href="../index.html">libmemcached</a>
 148
 149       </nav>
 150
 151
 152       <div class="wy-nav-content">
 153
 154         <div class="rst-content">
 155
 156
 157
 158
 159
 160
 161
 162
 163
 164
 165
 166
 167
 168
 169
 170
 171
 172 <div role="navigation" aria-label="breadcrumbs navigation">
 173
 174   <ul class="wy-breadcrumbs">
 175
 176       <li><a href="../index.html" class="icon icon-home"></a> &raquo;</li>
 177
 178           <li><a href="index.html">libmemcached API</a> &raquo;</li>
 179
 180           <li><a href="index_advanced.html">Advanced Topics</a> &raquo;</li>
 181
 182           <li><a href="index_advanced_aeh.html">Authentication, Encryption &amp; Hashing</a> &raquo;</li>
 183
 184       <li>Set encryption key</li>
 185
 186
 187       <li class="wy-breadcrumbs-aside">
 188
 189
 190
 191       </li>
 192
 193   </ul>
 194
 195
 196   <hr/>
 197 </div>
 198           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
 199            <div itemprop="articleBody">
 200
 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 &lt;libmemcached/memcached.h&gt;</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>
 209 <dd></dd></dl>
 210
 211 <p>Compile and link with -lmemcached</p>
 212 </div>
 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>
 217 </div>
 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>
 223 </div>
 224 <div class="section" id="see-also">
 225 <h2>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>
 226 </div>
 227 </div>
 228
 229
 230            </div>
 231
 232           </div>
 233           <footer>
 234
 235     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 236
 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>
 238
 239
 240         <a href="index_advanced_aeh.html" class="btn btn-neutral float-left" title="Authentication, Encryption &amp; Hashing" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
 241
 242     </div>
 243
 244
 245   <hr/>
 246
 247   <div role="contentinfo">
 248     <p>
 249
 250
 251         &copy; <a href="../copyright.html">Copyright</a>
 252
 253     </p>
 254   </div>
 255
 256
 257
 258     Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
 259
 260     <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
 261
 262     provided by <a href="https://readthedocs.org">Read the Docs</a>.
 263
 264 </footer>
 265
 266         </div>
 267       </div>
 268
 269     </section>
 270
 271   </div>
 272
 273
 274   <script type="text/javascript">
 275       jQuery(function () {
 276           SphinxRtdTheme.Navigation.enable(true);
 277       });
 278   </script>
 279
 280
 281
 282
 283
 284
 285 </body>
 286 </html>