git.m6w6.name Git - awesomized/libmemcached/blob - libmemcached/memcached_version.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>Getting version information about the client and server &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="Statistics" href="index_advanced_stats.html" />
  41     <link rel="prev" title="Setting the verbosity of a server" href="memcached_verbosity.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"><a class="reference internal" href="index_advanced_aeh.html">Authentication, Encryption &amp; Hashing</a></li>
 100 <li class="toctree-l3"><a class="reference internal" href="index_advanced_servers.html">Servers and Server Lists</a></li>
 101 <li class="toctree-l3 current"><a class="reference internal" href="index_advanced_daemon.html">Affecting the memcached Daemon</a><ul class="current">
 102 <li class="toctree-l4"><a class="reference internal" href="memcached_dump.html">Dumping data from a server</a></li>
 103 <li class="toctree-l4"><a class="reference internal" href="memcached_flush.html">Wiping clean the contents of a server</a></li>
 104 <li class="toctree-l4"><a class="reference internal" href="memcached_verbosity.html">Setting the verbosity of a server</a></li>
 105 <li class="toctree-l4 current"><a class="current reference internal" href="#">Getting version information about the client and server</a></li>
 106 </ul>
 107 </li>
 108 <li class="toctree-l3"><a class="reference internal" href="index_advanced_stats.html">Statistics</a></li>
 109 </ul>
 110 </li>
 111 <li class="toctree-l2"><a class="reference internal" href="index_deprecated.html">Deprecated Functionality</a></li>
 112 </ul>
 113 </li>
 114 <li class="toctree-l1"><a class="reference internal" href="index_misc.html">Misc</a></li>
 115 </ul>
 116 <p class="caption"><span class="caption-text">libmemcachedutil</span></p>
 117 <ul>
 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>
 120 </ul>
 121 <p class="caption"><span class="caption-text">libhashkit</span></p>
 122 <ul>
 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>
 125 </ul>
 126 <p class="caption"><span class="caption-text">Client Applications</span></p>
 127 <ul>
 128 <li class="toctree-l1"><a class="reference internal" href="../bin/index.html">Client Applications</a></li>
 129 </ul>
 130 <p class="caption"><span class="caption-text">Copyright</span></p>
 131 <ul>
 132 <li class="toctree-l1"><a class="reference internal" href="../copyright.html">Copyright</a></li>
 133 </ul>
 134
 135
 136
 137         </div>
 138
 139       </div>
 140     </nav>
 141
 142     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
 143
 144
 145       <nav class="wy-nav-top" aria-label="top navigation">
 146
 147           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
 148           <a href="../index.html">libmemcached</a>
 149
 150       </nav>
 151
 152
 153       <div class="wy-nav-content">
 154
 155         <div class="rst-content">
 156
 157
 158
 159
 160
 161
 162
 163
 164
 165
 166
 167
 168
 169
 170
 171
 172
 173 <div role="navigation" aria-label="breadcrumbs navigation">
 174
 175   <ul class="wy-breadcrumbs">
 176
 177       <li><a href="../index.html" class="icon icon-home"></a> &raquo;</li>
 178
 179           <li><a href="index.html">libmemcached API</a> &raquo;</li>
 180
 181           <li><a href="index_advanced.html">Advanced Topics</a> &raquo;</li>
 182
 183           <li><a href="index_advanced_daemon.html">Affecting the memcached Daemon</a> &raquo;</li>
 184
 185       <li>Getting version information about the client and server</li>
 186
 187
 188       <li class="wy-breadcrumbs-aside">
 189
 190
 191
 192       </li>
 193
 194   </ul>
 195
 196
 197   <hr/>
 198 </div>
 199           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
 200            <div itemprop="articleBody">
 201
 202   <div class="section" id="getting-version-information-about-the-client-and-server">
 203 <h1>Getting version information about the client and server<a class="headerlink" href="#getting-version-information-about-the-client-and-server" title="Permalink to this headline">¶</a></h1>
 204 <div class="section" id="synopsis">
 205 <h2>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2>
 206 <p>#include &lt;libmemcached/memcached.h&gt;</p>
 207 <dl class="cpp function">
 208 <dt id="_CPPv421memcached_lib_versionv">
 209 <span id="_CPPv321memcached_lib_versionv"></span><span id="_CPPv221memcached_lib_versionv"></span><span id="memcached_lib_version__void"></span><em class="property">const</em> char *<code class="sig-name descname">memcached_lib_version</code><span class="sig-paren">(</span>void<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv421memcached_lib_versionv" title="Permalink to this definition">¶</a><br /></dt>
 210 <dd></dd></dl>
 211
 212 <dl class="cpp function">
 213 <dt id="_CPPv417memcached_versionP12memcached_st">
 214 <span id="_CPPv317memcached_versionP12memcached_st"></span><span id="_CPPv217memcached_versionP12memcached_st"></span><span id="memcached_version__memcached_stP"></span><a class="reference internal" href="memcached_return_t.html#_CPPv418memcached_return_t" title="memcached_return_t">memcached_return_t</a> <code class="sig-name descname">memcached_version</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="#_CPPv417memcached_versionP12memcached_st" title="Permalink to this definition">¶</a><br /></dt>
 215 <dd></dd></dl>
 216
 217 <p>Compile and link with -lmemcached</p>
 218 </div>
 219 <div class="section" id="description">
 220 <h2>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
 221 <p><a class="reference internal" href="#_CPPv421memcached_lib_versionv" title="memcached_lib_version"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_lib_version()</span></code></a> is used to return a simple version string representing the libmemcached version (client library version, not server version)</p>
 222 <p><a class="reference internal" href="#_CPPv417memcached_versionP12memcached_st" title="memcached_version"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_version()</span></code></a> is used to set the major, minor, and micro versions of each memcached server being used by the memcached_st connection structure. It returns the memcached server return code.</p>
 223 </div>
 224 <div class="section" id="return-value">
 225 <h2>RETURN VALUE<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2>
 226 <p><a class="reference internal" href="#_CPPv421memcached_lib_versionv" title="memcached_lib_version"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_lib_version()</span></code></a> returns a string with the version of the libmemcached driver.</p>
 227 <p>A value of <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 from :func:'memcached_version'</p>
 228 <p>On success that value 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>.</p>
 229 <p>If called with the <a class="reference internal" href="memcached_behavior.html#_CPPv4N20memcached_behavior_t26MEMCACHED_BEHAVIOR_USE_UDPE" title="MEMCACHED_BEHAVIOR_USE_UDP"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">MEMCACHED_BEHAVIOR_USE_UDP</span></code></a> behavior set, the value
 230 <a class="reference internal" href="memcached_return_t.html#_CPPv4N18memcached_return_t23MEMCACHED_NOT_SUPPORTEDE" title="MEMCACHED_NOT_SUPPORTED"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">MEMCACHED_NOT_SUPPORTED</span></code></a> will be returned.</p>
 231 <p>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 translate this value to
 232 a printable string.</p>
 233 </div>
 234 <div class="section" id="see-also">
 235 <h2>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>
 236 </div>
 237 </div>
 238
 239
 240            </div>
 241
 242           </div>
 243           <footer>
 244
 245     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 246
 247         <a href="index_advanced_stats.html" class="btn btn-neutral float-right" title="Statistics" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
 248
 249
 250         <a href="memcached_verbosity.html" class="btn btn-neutral float-left" title="Setting the verbosity of a server" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
 251
 252     </div>
 253
 254
 255   <hr/>
 256
 257   <div role="contentinfo">
 258     <p>
 259
 260
 261         &copy; <a href="../copyright.html">Copyright</a>
 262
 263     </p>
 264   </div>
 265
 266
 267
 268     Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
 269
 270     <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
 271
 272     provided by <a href="https://readthedocs.org">Read the Docs</a>.
 273
 274 </footer>
 275
 276         </div>
 277       </div>
 278
 279     </section>
 280
 281   </div>
 282
 283
 284   <script type="text/javascript">
 285       jQuery(function () {
 286           SphinxRtdTheme.Navigation.enable(true);
 287       });
 288   </script>
 289
 290
 291
 292
 293
 294
 295 </body>
 296 </html>