Deploy to GitHub pages
[awesomized/libmemcached] / libmemcached / constants.html
1
2
3 <!DOCTYPE html>
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]-->
6 <head>
7 <meta charset="utf-8">
8
9 <meta name="viewport" content="width=device-width, initial-scale=1.0">
10
11 <title>libmemcached Constants and Defaults &mdash; libmemcached 1.1.0 documentation</title>
12
13
14
15
16
17
18
19
20 <script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
21
22
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>
28
29 <script type="text/javascript" src="../_static/js/theme.js"></script>
30
31
32
33
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="libmemcached Examples" href="examples.html" />
40 <link rel="prev" title="libmemcached Configuration" href="configuration.html" />
41 </head>
42
43 <body class="wy-body-for-nav">
44
45
46 <div class="wy-grid-for-nav">
47
48 <nav data-toggle="wy-nav-shift" class="wy-nav-side">
49 <div class="wy-side-scroll">
50 <div class="wy-side-nav-search" >
51
52
53
54 <a href="../index.html" class="icon icon-home"> libmemcached
55
56
57
58 </a>
59
60
61
62
63 <div class="version">
64 1.1
65 </div>
66
67
68
69
70 <div role="search">
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" />
75 </form>
76 </div>
77
78
79 </div>
80
81 <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
82
83
84
85
86
87
88 <ul class="current">
89 <li class="toctree-l1"><a class="reference internal" href="../libmemcached.html">Introduction</a></li>
90 <li class="toctree-l1"><a class="reference internal" href="index.html">libmemcached API</a></li>
91 <li class="toctree-l1"><a class="reference internal" href="../libmemcachedutil/index.html">libmemcachedutil API</a></li>
92 <li class="toctree-l1"><a class="reference internal" href="../libhashkit/index.html">libhashkit API</a></li>
93 <li class="toctree-l1"><a class="reference internal" href="../bin/index.html">Client Applications</a></li>
94 <li class="toctree-l1 current"><a class="reference internal" href="index_misc.html">Miscellaneous</a><ul class="current">
95 <li class="toctree-l2"><a class="reference internal" href="configuration.html">Configuration</a></li>
96 <li class="toctree-l2 current"><a class="current reference internal" href="#">Constants</a></li>
97 <li class="toctree-l2"><a class="reference internal" href="examples.html">Examples</a></li>
98 <li class="toctree-l2"><a class="reference internal" href="versioning.html">Versioning</a></li>
99 </ul>
100 </li>
101 </ul>
102 <ul>
103 <li class="toctree-l1"><a class="reference internal" href="../changelogs.html">Change Logs</a></li>
104 <li class="toctree-l1"><a class="reference internal" href="../copyright.html">Copyright</a></li>
105 </ul>
106
107
108
109 </div>
110 </div>
111 </nav>
112
113 <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
114
115
116 <nav class="wy-nav-top" aria-label="top navigation">
117
118 <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
119 <a href="../index.html">libmemcached</a>
120
121 </nav>
122
123
124 <div class="wy-nav-content">
125
126 <div class="rst-content">
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144 <div role="navigation" aria-label="breadcrumbs navigation">
145
146 <ul class="wy-breadcrumbs">
147
148 <li><a href="../index.html">Docs</a> &raquo;</li>
149
150 <li><a href="index_misc.html">Miscellaneous</a> &raquo;</li>
151
152 <li>libmemcached Constants and Defaults</li>
153
154
155 <li class="wy-breadcrumbs-aside">
156
157
158
159 <a href="https://github.com/m6w6/libmemcached/blob/v1.x/docs/source/libmemcached/constants.rst" class="fa fa-github"> Edit on GitHub</a>
160
161
162
163 </li>
164
165 </ul>
166
167
168 <hr/>
169 </div>
170 <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
171 <div itemprop="articleBody">
172
173 <div class="section" id="libmemcached-constants-and-defaults">
174 <h1>libmemcached Constants and Defaults<a class="headerlink" href="#libmemcached-constants-and-defaults" title="Permalink to this headline"></a></h1>
175 <div class="section" id="synopsis">
176 <h2>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this headline"></a></h2>
177 <dl class="docutils">
178 <dt>#include &lt;libmemcached-<a href="#id1"><span class="problematic" id="id2">|libmemcached_version|</span></a>/memcached.h&gt;</dt>
179 <dd>Compile and link with -lmemcached</dd>
180 </dl>
181 <dl class="macro">
182 <dt id="c.LIBMEMCACHED_VERSION_STRING">
183 <code class="descname">LIBMEMCACHED_VERSION_STRING</code><a class="headerlink" href="#c.LIBMEMCACHED_VERSION_STRING" title="Permalink to this definition"></a></dt>
184 <dd><p>String value of libmemcached version such as &quot;1.1.0&quot;</p>
185 </dd></dl>
186
187 <dl class="macro">
188 <dt id="c.LIBMEMCACHED_VERSION_HEX">
189 <code class="descname">LIBMEMCACHED_VERSION_HEX</code><a class="headerlink" href="#c.LIBMEMCACHED_VERSION_HEX" title="Permalink to this definition"></a></dt>
190 <dd><p>Hex value of the version number, e.g. &quot;0x00048000&quot;.
191 This can be used for comparing versions based on number.</p>
192 </dd></dl>
193
194 <dl class="macro">
195 <dt id="c.MEMCACHED_DEFAULT_PORT">
196 <code class="descname">MEMCACHED_DEFAULT_PORT</code><a class="headerlink" href="#c.MEMCACHED_DEFAULT_PORT" title="Permalink to this definition"></a></dt>
197 <dd><p>The default port used by <a class="reference internal" href="configuration.html#_CPPv49memcachedPKc6size_t" title="memcached"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached()</span></code></a>.</p>
198 </dd></dl>
199
200 <dl class="macro">
201 <dt id="c.MEMCACHED_DEFAULT_TIMEOUT">
202 <code class="descname">MEMCACHED_DEFAULT_TIMEOUT</code><a class="headerlink" href="#c.MEMCACHED_DEFAULT_TIMEOUT" title="Permalink to this definition"></a></dt>
203 <dd><p>Default timeout of 5000 milliseconds.</p>
204 </dd></dl>
205
206 <dl class="macro">
207 <dt id="c.MEMCACHED_DEFAULT_CONNECT_TIMEOUT">
208 <code class="descname">MEMCACHED_DEFAULT_CONNECT_TIMEOUT</code><a class="headerlink" href="#c.MEMCACHED_DEFAULT_CONNECT_TIMEOUT" title="Permalink to this definition"></a></dt>
209 <dd><p>Default connect timeout of 4000 milliseconds.</p>
210 </dd></dl>
211
212 <dl class="macro">
213 <dt id="c.MEMCACHED_MAX_BUFFER">
214 <code class="descname">MEMCACHED_MAX_BUFFER</code><a class="headerlink" href="#c.MEMCACHED_MAX_BUFFER" title="Permalink to this definition"></a></dt>
215 <dd><p>Default size of read/write buffers (which includes the null pointer).</p>
216 </dd></dl>
217
218 <dl class="macro">
219 <dt id="c.MEMCACHED_MAX_KEY">
220 <code class="descname">MEMCACHED_MAX_KEY</code><a class="headerlink" href="#c.MEMCACHED_MAX_KEY" title="Permalink to this definition"></a></dt>
221 <dd><p>Default maximum size of a key (which includes the null pointer). Master keys
222 have no limit, this only applies to keys used for storage.</p>
223 </dd></dl>
224
225 <dl class="macro">
226 <dt id="c.MEMCACHED_MAX_NAMESPACE">
227 <code class="descname">MEMCACHED_MAX_NAMESPACE</code><a class="headerlink" href="#c.MEMCACHED_MAX_NAMESPACE" title="Permalink to this definition"></a></dt>
228 <dd><p>Maximum length allowed for namespacing of a key. Defaults to 128.</p>
229 </dd></dl>
230
231 <dl class="macro">
232 <dt id="c.MEMCACHED_MAX_HOST_LENGTH">
233 <code class="descname">MEMCACHED_MAX_HOST_LENGTH</code><a class="headerlink" href="#c.MEMCACHED_MAX_HOST_LENGTH" title="Permalink to this definition"></a></dt>
234 <dd><p>Maximum allowed length of the hostname.</p>
235 </dd></dl>
236
237 <dl class="macro">
238 <dt id="c.MEMCACHED_MAX_HOST_SORT_LENGTH">
239 <code class="descname">MEMCACHED_MAX_HOST_SORT_LENGTH</code><a class="headerlink" href="#c.MEMCACHED_MAX_HOST_SORT_LENGTH" title="Permalink to this definition"></a></dt>
240 <dd><p>Length of the host string used for sorting. Used for Ketama.</p>
241 </dd></dl>
242
243 <dl class="macro">
244 <dt id="c.MEMCACHED_MAX_INTEGER_DISPLAY_LENGTH">
245 <code class="descname">MEMCACHED_MAX_INTEGER_DISPLAY_LENGTH</code><a class="headerlink" href="#c.MEMCACHED_MAX_INTEGER_DISPLAY_LENGTH" title="Permalink to this definition"></a></dt>
246 <dd><p>Maximum display width of an integer represented as string.</p>
247 </dd></dl>
248
249 <dl class="macro">
250 <dt id="c.MEMCACHED_CONTINUUM_ADDITION">
251 <code class="descname">MEMCACHED_CONTINUUM_ADDITION</code><a class="headerlink" href="#c.MEMCACHED_CONTINUUM_ADDITION" title="Permalink to this definition"></a></dt>
252 <dd><p>How many extra slots we should build for in the continuum, defaults to 10.</p>
253 </dd></dl>
254
255 <dl class="macro">
256 <dt id="c.MEMCACHED_EXPIRATION_NOT_ADD">
257 <code class="descname">MEMCACHED_EXPIRATION_NOT_ADD</code><a class="headerlink" href="#c.MEMCACHED_EXPIRATION_NOT_ADD" title="Permalink to this definition"></a></dt>
258 <dd><p>Value <code class="docutils literal notranslate"><span class="pre">0xffffffffU</span></code></p>
259 </dd></dl>
260
261 <dl class="macro">
262 <dt id="c.MEMCACHED_STRIDE">
263 <code class="descname">MEMCACHED_STRIDE</code><a class="headerlink" href="#c.MEMCACHED_STRIDE" title="Permalink to this definition"></a></dt>
264 <dd><p>This is the &quot;stride&quot; used in the consistent hash used between replicas.</p>
265 </dd></dl>
266
267 <dl class="macro">
268 <dt id="c.MEMCACHED_SERVER_FAILURE_LIMIT">
269 <code class="descname">MEMCACHED_SERVER_FAILURE_LIMIT</code><a class="headerlink" href="#c.MEMCACHED_SERVER_FAILURE_LIMIT" title="Permalink to this definition"></a></dt>
270 <dd><p>Value 5</p>
271 </dd></dl>
272
273 <dl class="macro">
274 <dt id="c.MEMCACHED_SERVER_FAILURE_RETRY_TIMEOUT">
275 <code class="descname">MEMCACHED_SERVER_FAILURE_RETRY_TIMEOUT</code><a class="headerlink" href="#c.MEMCACHED_SERVER_FAILURE_RETRY_TIMEOUT" title="Permalink to this definition"></a></dt>
276 <dd><p>Value 2</p>
277 </dd></dl>
278
279 <dl class="macro">
280 <dt id="c.MEMCACHED_SERVER_FAILURE_DEAD_TIMEOUT">
281 <code class="descname">MEMCACHED_SERVER_FAILURE_DEAD_TIMEOUT</code><a class="headerlink" href="#c.MEMCACHED_SERVER_FAILURE_DEAD_TIMEOUT" title="Permalink to this definition"></a></dt>
282 <dd><p>Value 0</p>
283 </dd></dl>
284
285 <dl class="macro">
286 <dt id="c.MEMCACHED_VERSION_STRING_LENGTH">
287 <code class="descname">MEMCACHED_VERSION_STRING_LENGTH</code><a class="headerlink" href="#c.MEMCACHED_VERSION_STRING_LENGTH" title="Permalink to this definition"></a></dt>
288 <dd><p>Value 24</p>
289 </dd></dl>
290
291 </div>
292 <div class="section" id="description">
293 <h2>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
294 <p>These compile time defaults are provided by <code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">libmemcached</span></code> for convenience.</p>
295 </div>
296 </div>
297
298
299 </div>
300
301 </div>
302 <footer>
303
304 <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
305
306 <a href="examples.html" class="btn btn-neutral float-right" title="libmemcached Examples" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
307
308
309 <a href="configuration.html" class="btn btn-neutral float-left" title="libmemcached Configuration" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
310
311 </div>
312
313
314 <hr/>
315
316 <div role="contentinfo">
317 <p>
318 &copy; <a href="../copyright.html">Copyright</a>
319
320 </p>
321 </div>
322 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>.
323
324 </footer>
325
326 </div>
327 </div>
328
329 </section>
330
331 </div>
332
333
334
335 <script type="text/javascript">
336 jQuery(function () {
337 SphinxRtdTheme.Navigation.enable(true);
338 });
339 </script>
340
341
342
343
344
345
346 </body>
347 </html>