Deploy to GitHub pages
[m6w6/libmemcached] / libmemcachedutil / index.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>libmemcachedutil - C/C++ utilities extending libmemcached &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="Working with memcached pools" href="memcached_pool.html" />
40 <link rel="prev" title="memcached_fetch" href="../libmemcached/memcached_fetch.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="../libmemcached/index.html">libmemcached API</a></li>
91 <li class="toctree-l1 current"><a class="current reference internal" href="#">libmemcachedutil API</a><ul>
92 <li class="toctree-l2"><a class="reference internal" href="memcached_pool.html">Working with memcached pools</a></li>
93 </ul>
94 </li>
95 <li class="toctree-l1"><a class="reference internal" href="../libhashkit/index.html">libhashkit API</a></li>
96 <li class="toctree-l1"><a class="reference internal" href="../bin/index.html">Client Applications</a></li>
97 <li class="toctree-l1"><a class="reference internal" href="../libmemcached/index_misc.html">Miscellaneous</a></li>
98 </ul>
99 <ul>
100 <li class="toctree-l1"><a class="reference internal" href="../changelogs.html">Change Logs</a></li>
101 <li class="toctree-l1"><a class="reference internal" href="../copyright.html">Copyright</a></li>
102 </ul>
103
104
105
106 </div>
107 </div>
108 </nav>
109
110 <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
111
112
113 <nav class="wy-nav-top" aria-label="top navigation">
114
115 <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
116 <a href="../index.html">libmemcached</a>
117
118 </nav>
119
120
121 <div class="wy-nav-content">
122
123 <div class="rst-content">
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141 <div role="navigation" aria-label="breadcrumbs navigation">
142
143 <ul class="wy-breadcrumbs">
144
145 <li><a href="../index.html">Docs</a> &raquo;</li>
146
147 <li>libmemcachedutil - C/C++ utilities extending libmemcached</li>
148
149
150 <li class="wy-breadcrumbs-aside">
151
152
153
154 <a href="https://github.com/m6w6/libmemcached/blob/v1.x/docs/source/libmemcachedutil/index.rst" class="fa fa-github"> Edit on GitHub</a>
155
156
157
158 </li>
159
160 </ul>
161
162
163 <hr/>
164 </div>
165 <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
166 <div itemprop="articleBody">
167
168 <div class="section" id="libmemcachedutil-c-c-utilities-extending-libmemcached">
169 <h1>libmemcachedutil - C/C++ utilities extending libmemcached<a class="headerlink" href="#libmemcachedutil-c-c-utilities-extending-libmemcached" title="Permalink to this headline"></a></h1>
170 <p>Utility library for libmemcached</p>
171 <div class="section" id="synopsis">
172 <h2>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this headline"></a></h2>
173 <dl class="docutils">
174 <dt>#include &lt;libmemcachedutil-1.0/util.h&gt;</dt>
175 <dd>Compile and link with -lmemcachedutil -lmemcached</dd>
176 </dl>
177 </div>
178 <div class="section" id="description">
179 <h2>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
180 <p><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">libmemcachedutil</span></code> is a small and thread-safe client library that provides extra
181 functionality built on top of <code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">libmemcached</span></code>.</p>
182 </div>
183 <div class="section" id="threads-and-processes">
184 <h2>THREADS AND PROCESSES<a class="headerlink" href="#threads-and-processes" title="Permalink to this headline"></a></h2>
185 <p>Do not try to access an instance of <a class="reference internal" href="../libmemcached/memcached_create.html#_CPPv412memcached_st" title="memcached_st"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_st</span></code></a> from multiple threads at the
186 same time. If you want to access memcached from multiple threads you should
187 either clone the <a class="reference internal" href="../libmemcached/memcached_create.html#_CPPv412memcached_st" title="memcached_st"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_st</span></code></a>, or use the memcached pool implementation. See
188 <a class="reference internal" href="memcached_pool.html#_CPPv414memcached_poolPKc6size_t" title="memcached_pool"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_pool()</span></code></a>.</p>
189 <div class="toctree-wrapper compound">
190 <p class="caption"><span class="caption-text">Additional Utilities</span></p>
191 <ul>
192 <li class="toctree-l1"><a class="reference internal" href="memcached_pool.html">Working with memcached pools</a></li>
193 </ul>
194 </div>
195 </div>
196 <div class="section" id="see-also">
197 <h2>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline"></a></h2>
198 <ul class="simple">
199 <li><a class="reference internal" href="../libmemcached.html"><span class="doc">C/C++ Client Library for memcached</span></a></li>
200 </ul>
201 </div>
202 </div>
203
204
205 </div>
206
207 </div>
208 <footer>
209
210 <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
211
212 <a href="memcached_pool.html" class="btn btn-neutral float-right" title="Working with memcached pools" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
213
214
215 <a href="../libmemcached/memcached_fetch.html" class="btn btn-neutral float-left" title="memcached_fetch" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
216
217 </div>
218
219
220 <hr/>
221
222 <div role="contentinfo">
223 <p>
224 &copy; <a href="../copyright.html">Copyright</a>
225
226 </p>
227 </div>
228 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>.
229
230 </footer>
231
232 </div>
233 </div>
234
235 </section>
236
237 </div>
238
239
240
241 <script type="text/javascript">
242 jQuery(function () {
243 SphinxRtdTheme.Navigation.enable(true);
244 });
245 </script>
246
247
248
249
250
251
252 </body>
253 </html>