1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
|
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>7.25.2. Global configurations — Groonga v10.1.1-31-g1e46ba6 documentation</title>
<link rel="stylesheet" href="../../_static/groonga.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
<script src="../../_static/jquery.js"></script>
<script src="../../_static/underscore.js"></script>
<script src="../../_static/doctools.js"></script>
<script src="../../_static/language_data.js"></script>
<link rel="shortcut icon" href="../../_static/favicon.ico"/>
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
<link rel="next" title="7.25.3. Plugin" href="plugin.html" />
<link rel="prev" title="7.25.1. Overview" href="overview.html" />
</head><body>
<div class="header">
<h1 class="title">
<a id="top-link" href="../../index.html">
<span class="project">groonga</span>
<span class="separator">-</span>
<span class="description">An open-source fulltext search engine and column store.</span>
</a>
</h1>
<div class="other-language-links">
<ul>
<li><a href="../../../../ja/html/reference/api/global_configurations.html">日本語</a></li>
</ul>
</div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="plugin.html" title="7.25.3. Plugin"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="overview.html" title="7.25.1. Overview"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../../index.html">Groonga v10.1.1-31-g1e46ba6 documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="../../reference.html" ><span class="section-number">7. </span>Reference manual</a> »</li>
<li class="nav-item nav-item-2"><a href="../api.html" accesskey="U"><span class="section-number">7.25. </span>API</a> »</li>
<li class="nav-item nav-item-this"><a href=""><span class="section-number">7.25.2. </span>Global configurations</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="global-configurations">
<h1><span class="section-number">7.25.2. </span>Global configurations<a class="headerlink" href="#global-configurations" title="Permalink to this headline">¶</a></h1>
<div class="section" id="summary">
<h2><span class="section-number">7.25.2.1. </span>Summary<a class="headerlink" href="#summary" title="Permalink to this headline">¶</a></h2>
<p>Groonga has the global configurations. You can access them by API.</p>
</div>
<div class="section" id="reference">
<h2><span class="section-number">7.25.2.2. </span>Reference<a class="headerlink" href="#reference" title="Permalink to this headline">¶</a></h2>
<dl class="c function">
<dt id="c.grn_get_lock_timeout">
int <code class="sig-name descname">grn_get_lock_timeout</code><span class="sig-paren">(</span>void<span class="sig-paren">)</span><a class="headerlink" href="#c.grn_get_lock_timeout" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Returns the lock timeout.</p>
<p><a class="reference internal" href="grn_ctx.html#c.grn_ctx" title="grn_ctx"><code class="xref c c-type docutils literal notranslate"><span class="pre">grn_ctx</span></code></a> acquires a lock for updating a shared value. If
other <a class="reference internal" href="grn_ctx.html#c.grn_ctx" title="grn_ctx"><code class="xref c c-type docutils literal notranslate"><span class="pre">grn_ctx</span></code></a> is already updating the same value,
<a class="reference internal" href="grn_ctx.html#c.grn_ctx" title="grn_ctx"><code class="xref c c-type docutils literal notranslate"><span class="pre">grn_ctx</span></code></a> that try to acquire a lock can’t acquires a lock.
The <a class="reference internal" href="grn_ctx.html#c.grn_ctx" title="grn_ctx"><code class="xref c c-type docutils literal notranslate"><span class="pre">grn_ctx</span></code></a> that can’t acquires a lock waits 1
millisecond and try to acquire a lock again. The try is done
<code class="docutils literal notranslate"><span class="pre">timeout</span></code> times. If the <a class="reference internal" href="grn_ctx.html#c.grn_ctx" title="grn_ctx"><code class="xref c c-type docutils literal notranslate"><span class="pre">grn_ctx</span></code></a> that can’t acquires a
lock until <code class="docutils literal notranslate"><span class="pre">timeout</span></code> times, the tries are failed.</p>
<p>The default lock timeout is <code class="docutils literal notranslate"><span class="pre">10000000</span></code>. It means that Groonga
doesn’t report a lock failure until about 3 hours. (1 * 10000000
[msec] = 10000 [sec] = 166.666… [min] = 2.777… [hour])</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>The lock timeout.</p>
</dd>
</dl>
</dd></dl>
<dl class="c function">
<dt id="c.grn_set_lock_timeout">
grn_rc <code class="sig-name descname">grn_set_lock_timeout</code><span class="sig-paren">(</span>int <em>timeout</em><span class="sig-paren">)</span><a class="headerlink" href="#c.grn_set_lock_timeout" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Sets the lock timeout.</p>
<p>See <a class="reference internal" href="#c.grn_get_lock_timeout" title="grn_get_lock_timeout"><code class="xref c c-func docutils literal notranslate"><span class="pre">grn_get_lock_timeout()</span></code></a> about lock timeout.</p>
<p>There are some special values for <code class="docutils literal notranslate"><span class="pre">timeout</span></code>.</p>
<blockquote>
<div><ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">0</span></code>: It means that Groonga doesn’t retry acquiring a lock.
Groonga reports a failure after one lock acquirement failure.</p></li>
<li><p>negative value: It means that Groonga retries acquiring a lock
until Groonga can acquire a lock.</p></li>
</ul>
</div></blockquote>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>timeout</strong> – The new lock timeout.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">GRN_SUCCESS</span></code>. It doesn’t fail.</p>
</dd>
</dl>
</dd></dl>
</div>
</div>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="../../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">7.25.2. Global configurations</a><ul>
<li><a class="reference internal" href="#summary">7.25.2.1. Summary</a></li>
<li><a class="reference internal" href="#reference">7.25.2.2. Reference</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="overview.html"
title="previous chapter"><span class="section-number">7.25.1. </span>Overview</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="plugin.html"
title="next chapter"><span class="section-number">7.25.3. </span>Plugin</a></p>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="plugin.html" title="7.25.3. Plugin"
>next</a> |</li>
<li class="right" >
<a href="overview.html" title="7.25.1. Overview"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../../index.html">Groonga v10.1.1-31-g1e46ba6 documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="../../reference.html" ><span class="section-number">7. </span>Reference manual</a> »</li>
<li class="nav-item nav-item-2"><a href="../api.html" ><span class="section-number">7.25. </span>API</a> »</li>
<li class="nav-item nav-item-this"><a href=""><span class="section-number">7.25.2. </span>Global configurations</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2009-2021, Brazil, Inc.
</div>
</body>
</html>
|
