File: grn_hook.html

package info (click to toggle)
groonga 11.0.0-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 121,576 kB
  • sloc: ansic: 801,209; javascript: 62,121; ruby: 46,206; cpp: 33,790; xml: 24,951; yacc: 13,333; sh: 7,776; python: 3,266; makefile: 2,315; perl: 133
file content (214 lines) | stat: -rw-r--r-- 12,566 bytes parent folder | download 
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
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 


<!DOCTYPE html>

<html lang="en">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>7.25.13. grn_hook &#8212; 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.14. grn_ii" href="grn_ii.html" />
    <link rel="prev" title="7.25.12. grn_geo" href="grn_geo.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/grn_hook.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="grn_ii.html" title="7.25.14. grn_ii"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="grn_geo.html" title="7.25.12. grn_geo"
             accesskey="P">previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../../index.html">Groonga v10.1.1-31-g1e46ba6 documentation</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="../../reference.html" ><span class="section-number">7. </span>Reference manual</a> &#187;</li>
          <li class="nav-item nav-item-2"><a href="../api.html" accesskey="U"><span class="section-number">7.25. </span>API</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href=""><span class="section-number">7.25.13. </span><code class="docutils literal notranslate"><span class="pre">grn_hook</span></code></a></li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <div class="section" id="grn-hook">
<h1><span class="section-number">7.25.13. </span><code class="docutils literal notranslate"><span class="pre">grn_hook</span></code><a class="headerlink" href="#grn-hook" title="Permalink to this headline">¶</a></h1>
<div class="section" id="summary">
<h2><span class="section-number">7.25.13.1. </span>Summary<a class="headerlink" href="#summary" title="Permalink to this headline">¶</a></h2>
<p>TODO…</p>
</div>
<div class="section" id="example">
<h2><span class="section-number">7.25.13.2. </span>Example<a class="headerlink" href="#example" title="Permalink to this headline">¶</a></h2>
<p>TODO…</p>
</div>
<div class="section" id="reference">
<h2><span class="section-number">7.25.13.3. </span>Reference<a class="headerlink" href="#reference" title="Permalink to this headline">¶</a></h2>
<dl class="c type">
<dt id="c.grn_hook_entry">
<em class="property">type </em><code class="sig-name descname">grn_hook_entry</code><a class="headerlink" href="#c.grn_hook_entry" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>TODO…</p>
</dd></dl>

<dl class="c function">
<dt id="c.grn_obj_add_hook">
grn_rc <code class="sig-name descname">grn_obj_add_hook</code><span class="sig-paren">(</span><a class="reference internal" href="grn_ctx.html#c.grn_ctx" title="grn_ctx">grn_ctx</a> *<em>ctx</em>, <a class="reference internal" href="grn_obj.html#c.grn_obj" title="grn_obj">grn_obj</a> *<em>obj</em>, <a class="reference internal" href="#c.grn_hook_entry" title="grn_hook_entry">grn_hook_entry</a> <em>entry</em>, int <em>offset</em>, <a class="reference internal" href="grn_obj.html#c.grn_obj" title="grn_obj">grn_obj</a> *<em>proc</em>, <a class="reference internal" href="grn_obj.html#c.grn_obj" title="grn_obj">grn_obj</a> *<em>data</em><span class="sig-paren">)</span><a class="headerlink" href="#c.grn_obj_add_hook" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>objに対してhookを追加します。</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>obj</strong> – 対象objectを指定します。</p></li>
<li><p><strong>entry</strong> – <p><code class="docutils literal notranslate"><span class="pre">GRN_HOOK_GET</span></code> は、objectの参照時に呼び出されるhookを定義します。</p>
<p><code class="docutils literal notranslate"><span class="pre">GRN_HOOK_SET</span></code> は、objectの更新時に呼び出されるhookを定義します。</p>
<p><code class="docutils literal notranslate"><span class="pre">GRN_HOOK_SELECT</span></code> は、検索処理の実行中に適時呼び出され、処理の実行状況を調べたり、実行の中断を指示することができます。</p>
</p></li>
<li><p><strong>offset</strong> – <p>hookの実行順位。offsetに対応するhookの直前に新たなhookを挿入します。</p>
<p>0を指定した場合は先頭に挿入されます。-1を指定した場合は末尾に挿入されます。</p>
<p>objectに複数のhookが定義されている場合は順位の順に呼び出されます。</p>
</p></li>
<li><p><strong>proc</strong> – 手続きを指定します。</p></li>
<li><p><strong>data</strong> – hook固有情報を指定します。</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="c function">
<dt id="c.grn_obj_get_nhooks">
int <code class="sig-name descname">grn_obj_get_nhooks</code><span class="sig-paren">(</span><a class="reference internal" href="grn_ctx.html#c.grn_ctx" title="grn_ctx">grn_ctx</a> *<em>ctx</em>, <a class="reference internal" href="grn_obj.html#c.grn_obj" title="grn_obj">grn_obj</a> *<em>obj</em>, <a class="reference internal" href="#c.grn_hook_entry" title="grn_hook_entry">grn_hook_entry</a> <em>entry</em><span class="sig-paren">)</span><a class="headerlink" href="#c.grn_obj_get_nhooks" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>objに定義されているhookの数を返します。</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>obj</strong> – 対象objectを指定します。</p></li>
<li><p><strong>entry</strong> – hookタイプを指定します。</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="c function">
<dt id="c.grn_obj_get_hook">
<a class="reference internal" href="grn_obj.html#c.grn_obj" title="grn_obj">grn_obj</a> *<code class="sig-name descname">grn_obj_get_hook</code><span class="sig-paren">(</span><a class="reference internal" href="grn_ctx.html#c.grn_ctx" title="grn_ctx">grn_ctx</a> *<em>ctx</em>, <a class="reference internal" href="grn_obj.html#c.grn_obj" title="grn_obj">grn_obj</a> *<em>obj</em>, <a class="reference internal" href="#c.grn_hook_entry" title="grn_hook_entry">grn_hook_entry</a> <em>entry</em>, int <em>offset</em>, <a class="reference internal" href="grn_obj.html#c.grn_obj" title="grn_obj">grn_obj</a> *<em>data</em><span class="sig-paren">)</span><a class="headerlink" href="#c.grn_obj_get_hook" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>objに定義されているhookの手続き（proc）を返します。hook固有情報が定義されている場合は、その内容をdataにコピーして返します。</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>obj</strong> – 対象objectを指定します。</p></li>
<li><p><strong>entry</strong> – hookタイプを指定します。</p></li>
<li><p><strong>offset</strong> – 実行順位を指定します。</p></li>
<li><p><strong>data</strong> – hook固有情報格納バッファを指定します。</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="c function">
<dt id="c.grn_obj_delete_hook">
grn_rc <code class="sig-name descname">grn_obj_delete_hook</code><span class="sig-paren">(</span><a class="reference internal" href="grn_ctx.html#c.grn_ctx" title="grn_ctx">grn_ctx</a> *<em>ctx</em>, <a class="reference internal" href="grn_obj.html#c.grn_obj" title="grn_obj">grn_obj</a> *<em>obj</em>, <a class="reference internal" href="#c.grn_hook_entry" title="grn_hook_entry">grn_hook_entry</a> <em>entry</em>, int <em>offset</em><span class="sig-paren">)</span><a class="headerlink" href="#c.grn_obj_delete_hook" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>objに定義されているhookを削除します。</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>obj</strong> – 対象objectを指定します。</p></li>
<li><p><strong>entry</strong> – hookタイプを指定します。</p></li>
<li><p><strong>offset</strong> – 実行順位を指定します。</p></li>
</ul>
</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.13. <code class="docutils literal notranslate"><span class="pre">grn_hook</span></code></a><ul>
<li><a class="reference internal" href="#summary">7.25.13.1. Summary</a></li>
<li><a class="reference internal" href="#example">7.25.13.2. Example</a></li>
<li><a class="reference internal" href="#reference">7.25.13.3. Reference</a></li>
</ul>
</li>
</ul>

  <h4>Previous topic</h4>
  <p class="topless"><a href="grn_geo.html"
                        title="previous chapter"><span class="section-number">7.25.12. </span><code class="docutils literal notranslate"><span class="pre">grn_geo</span></code></a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="grn_ii.html"
                        title="next chapter"><span class="section-number">7.25.14. </span><code class="docutils literal notranslate"><span class="pre">grn_ii</span></code></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="grn_ii.html" title="7.25.14. grn_ii"
             >next</a> |</li>
        <li class="right" >
          <a href="grn_geo.html" title="7.25.12. grn_geo"
             >previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../../index.html">Groonga v10.1.1-31-g1e46ba6 documentation</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="../../reference.html" ><span class="section-number">7. </span>Reference manual</a> &#187;</li>
          <li class="nav-item nav-item-2"><a href="../api.html" ><span class="section-number">7.25. </span>API</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href=""><span class="section-number">7.25.13. </span><code class="docutils literal notranslate"><span class="pre">grn_hook</span></code></a></li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
        &#169; Copyright 2009-2021, Brazil, Inc.
    </div>
  </body>
</html>