This file is indexed.

/usr/share/doc/libtelepathy-glib-doc/telepathy-glib/TpDynamicHandleRepo.html is in libtelepathy-glib-doc 0.18.0-1ubuntu1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  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
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>TpDynamicHandleRepo</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="telepathy-glib API Reference Manual">
<link rel="up" href="ch-service-handles.html" title="Service-side handle repositories">
<link rel="prev" href="TpStaticHandleRepo.html" title="TpStaticHandleRepo">
<link rel="next" href="ch-utilities.html" title="Utilities">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="TpStaticHandleRepo.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch-service-handles.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">telepathy-glib API Reference Manual</th>
<td><a accesskey="n" href="ch-utilities.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#TpDynamicHandleRepo.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#TpDynamicHandleRepo.description" class="shortcut">Description</a>
                   | 
                  <a href="#TpDynamicHandleRepo.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#TpDynamicHandleRepo.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
                   | 
                  <a href="#TpDynamicHandleRepo.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry">
<a name="TpDynamicHandleRepo"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="TpDynamicHandleRepo.top_of_page"></a>TpDynamicHandleRepo</span></h2>
<p>TpDynamicHandleRepo — general handle repository implementation, with dynamic
 handle allocation and recycling</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="TpDynamicHandleRepo.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include &lt;telepathy-glib/handle-repo-dynamic.h&gt;

                    <a class="link" href="TpDynamicHandleRepo.html#TpDynamicHandleRepo-struct" title="TpDynamicHandleRepo">TpDynamicHandleRepo</a>;
                    <a class="link" href="TpDynamicHandleRepo.html#TpDynamicHandleRepoClass" title="TpDynamicHandleRepoClass">TpDynamicHandleRepoClass</a>;
<a class="link" href="telepathy-glib-handle.html#TpHandle" title="TpHandle"><span class="returnvalue">TpHandle</span></a>            <a class="link" href="TpDynamicHandleRepo.html#tp-dynamic-handle-repo-lookup-exact" title="tp_dynamic_handle_repo_lookup_exact ()">tp_dynamic_handle_repo_lookup_exact</a> (<em class="parameter"><code><a class="link" href="telepathy-glib-handle-repo.html#TpHandleRepoIface"><span class="type">TpHandleRepoIface</span></a> *irepo</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *id</code></em>);
<a class="link" href="telepathy-glib-handle-repo.html#TpHandleRepoIface"><span class="returnvalue">TpHandleRepoIface</span></a> * <a class="link" href="TpDynamicHandleRepo.html#tp-dynamic-handle-repo-new" title="tp_dynamic_handle_repo_new ()">tp_dynamic_handle_repo_new</a>          (<em class="parameter"><code><a class="link" href="telepathy-glib-enums.html#TpHandleType" title="enum TpHandleType"><span class="type">TpHandleType</span></a> handle_type</code></em>,
                                                         <em class="parameter"><code><a class="link" href="TpDynamicHandleRepo.html#TpDynamicHandleRepoNormalizeFunc" title="TpDynamicHandleRepoNormalizeFunc ()"><span class="type">TpDynamicHandleRepoNormalizeFunc</span></a> normalize_func</code></em>,
                                                         <em class="parameter"><code><span class="type">gpointer</span> default_normalize_context</code></em>);
<span class="returnvalue">gchar</span> *             (<a class="link" href="TpDynamicHandleRepo.html#TpDynamicHandleRepoNormalizeFunc" title="TpDynamicHandleRepoNormalizeFunc ()">*TpDynamicHandleRepoNormalizeFunc</a>) (<em class="parameter"><code><a class="link" href="telepathy-glib-handle-repo.html#TpHandleRepoIface"><span class="type">TpHandleRepoIface</span></a> *repo</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *id</code></em>,
                                                         <em class="parameter"><code><span class="type">gpointer</span> context</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="TpDynamicHandleRepo.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  GObject
   +----TpDynamicHandleRepo
</pre>
</div>
<div class="refsect1">
<a name="TpDynamicHandleRepo.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
TpDynamicHandleRepo implements
 <a class="link" href="telepathy-glib-handle-repo.html#TpHandleRepoIface">TpHandleRepoIface</a>.</p>
</div>
<div class="refsect1">
<a name="TpDynamicHandleRepo.properties"></a><h2>Properties</h2>
<pre class="synopsis">
  "<a class="link" href="TpDynamicHandleRepo.html#TpDynamicHandleRepo--default-normalize-context" title='The "default-normalize-context" property'>default-normalize-context</a>" <span class="type">gpointer</span>              : Read / Write / Construct Only
  "<a class="link" href="TpDynamicHandleRepo.html#TpDynamicHandleRepo--normalize-function" title='The "normalize-function" property'>normalize-function</a>"       <span class="type">gpointer</span>              : Read / Write / Construct Only
</pre>
</div>
<div class="refsect1">
<a name="TpDynamicHandleRepo.description"></a><h2>Description</h2>
<p>
A dynamic handle repository will accept arbitrary handles, which can
be created and destroyed at runtime.
</p>
<p>
The <a class="link" href="telepathy-glib-handle-repo.html#TpHandleRepoIface--handle-type" title='The "handle-type" property'><span class="type">"handle-type"</span></a> property must be set at construction
time; the <a class="link" href="TpDynamicHandleRepo.html#TpDynamicHandleRepo--normalize-function" title='The "normalize-function" property'><span class="type">"normalize-function"</span></a> property may be set to
perform validation and normalization on handle ID strings.
</p>
<p>
Most connection managers will use this for all supported handle types
except <a class="link" href="telepathy-glib-enums.html#TP-HANDLE-TYPE-LIST:CAPS"><code class="literal">TP_HANDLE_TYPE_LIST</code></a>.
</p>
<p>
Changed in 0.13.8: handles are no longer reference-counted, and
the reference-count-related functions are stubs. Instead, handles remain
valid until the handle repository is destroyed.
</p>
</div>
<div class="refsect1">
<a name="TpDynamicHandleRepo.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="TpDynamicHandleRepo-struct"></a><h3>TpDynamicHandleRepo</h3>
<pre class="programlisting">typedef struct _TpDynamicHandleRepo TpDynamicHandleRepo;</pre>
<p>
A dynamic handle repository. The contents of the struct are private.
</p>
</div>
<hr>
<div class="refsect2">
<a name="TpDynamicHandleRepoClass"></a><h3>TpDynamicHandleRepoClass</h3>
<pre class="programlisting">typedef struct _TpDynamicHandleRepoClass TpDynamicHandleRepoClass;</pre>
<p>
The class of a dynamic handle repository. The contents of the struct
are private.
</p>
</div>
<hr>
<div class="refsect2">
<a name="tp-dynamic-handle-repo-lookup-exact"></a><h3>tp_dynamic_handle_repo_lookup_exact ()</h3>
<pre class="programlisting"><a class="link" href="telepathy-glib-handle.html#TpHandle" title="TpHandle"><span class="returnvalue">TpHandle</span></a>            tp_dynamic_handle_repo_lookup_exact (<em class="parameter"><code><a class="link" href="telepathy-glib-handle-repo.html#TpHandleRepoIface"><span class="type">TpHandleRepoIface</span></a> *irepo</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *id</code></em>);</pre>
<p>
Look up a name in the repository, returning the corresponding handle if
it is present in the repository, without creating a new reference.
</p>
<p>
Unlike <a class="link" href="telepathy-glib-handle-repo.html#tp-handle-lookup" title="tp_handle_lookup ()"><code class="function">tp_handle_lookup()</code></a> this function does not perform any normalization;
it just looks for the literal string you requested. This can be useful to
call from normalization callbacks (for instance, Gabble's contacts
repository uses it to see whether we already know that a JID belongs
to a multi-user chat room member).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>irepo</code></em> :</span></p></td>
<td>The handle repository</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
<td>The name to be looked up</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the handle corresponding to the given ID, or 0 if not present</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="tp-dynamic-handle-repo-new"></a><h3>tp_dynamic_handle_repo_new ()</h3>
<pre class="programlisting"><a class="link" href="telepathy-glib-handle-repo.html#TpHandleRepoIface"><span class="returnvalue">TpHandleRepoIface</span></a> * tp_dynamic_handle_repo_new          (<em class="parameter"><code><a class="link" href="telepathy-glib-enums.html#TpHandleType" title="enum TpHandleType"><span class="type">TpHandleType</span></a> handle_type</code></em>,
                                                         <em class="parameter"><code><a class="link" href="TpDynamicHandleRepo.html#TpDynamicHandleRepoNormalizeFunc" title="TpDynamicHandleRepoNormalizeFunc ()"><span class="type">TpDynamicHandleRepoNormalizeFunc</span></a> normalize_func</code></em>,
                                                         <em class="parameter"><code><span class="type">gpointer</span> default_normalize_context</code></em>);</pre>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>handle_type</code></em> :</span></p></td>
<td>The handle type</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>normalize_func</code></em> :</span></p></td>
<td>The function to be used to normalize and validate handles,
or <code class="literal">NULL</code> to accept all handles as-is</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>default_normalize_context</code></em> :</span></p></td>
<td>The context pointer to be passed to the
<em class="parameter"><code>normalize_func</code></em> if a <code class="literal">NULL</code> context is passed to <a class="link" href="telepathy-glib-handle-repo.html#tp-handle-lookup" title="tp_handle_lookup ()"><code class="function">tp_handle_lookup()</code></a> and
<a class="link" href="telepathy-glib-handle-repo.html#tp-handle-ensure" title="tp_handle_ensure ()"><code class="function">tp_handle_ensure()</code></a>; this may itself be <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new dynamic handle repository</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="TpDynamicHandleRepoNormalizeFunc"></a><h3>TpDynamicHandleRepoNormalizeFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> *             (*TpDynamicHandleRepoNormalizeFunc) (<em class="parameter"><code><a class="link" href="telepathy-glib-handle-repo.html#TpHandleRepoIface"><span class="type">TpHandleRepoIface</span></a> *repo</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *id</code></em>,
                                                         <em class="parameter"><code><span class="type">gpointer</span> context</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Signature of the normalization function optionally used by
<a class="link" href="TpDynamicHandleRepo.html" title="TpDynamicHandleRepo"><span class="type">TpDynamicHandleRepo</span></a> instances.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>repo</code></em> :</span></p></td>
<td>The repository on which <a class="link" href="telepathy-glib-handle-repo.html#tp-handle-lookup" title="tp_handle_lookup ()"><code class="function">tp_handle_lookup()</code></a> or <a class="link" href="telepathy-glib-handle-repo.html#tp-handle-ensure" title="tp_handle_ensure ()"><code class="function">tp_handle_ensure()</code></a>
was called</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
<td>The name to be normalized</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>context</code></em> :</span></p></td>
<td>Arbitrary context passed to <a class="link" href="telepathy-glib-handle-repo.html#tp-handle-lookup" title="tp_handle_lookup ()"><code class="function">tp_handle_lookup()</code></a> or
<a class="link" href="telepathy-glib-handle-repo.html#tp-handle-ensure" title="tp_handle_ensure ()"><code class="function">tp_handle_ensure()</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>Used to raise the Telepathy error InvalidHandle with an appropriate
message if NULL is returned</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a normalized version of <em class="parameter"><code>id</code></em> (to be freed with g_free by the
caller), or NULL if <em class="parameter"><code>id</code></em> is not valid for this repository</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="TpDynamicHandleRepo.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="TpDynamicHandleRepo--default-normalize-context"></a><h3>The <code class="literal">"default-normalize-context"</code> property</h3>
<pre class="programlisting">  "default-normalize-context" <span class="type">gpointer</span>              : Read / Write / Construct Only</pre>
<p>
An optional default context given to the
<a class="link" href="TpDynamicHandleRepo.html#TpDynamicHandleRepo--normalize-function" title='The "normalize-function" property'><span class="type">"normalize-function"</span></a> if <code class="literal">NULL</code> is passed as context to
the ensure or lookup functions, e.g. when RequestHandle is called via
D-Bus. The default is <code class="literal">NULL</code>.
</p>
</div>
<hr>
<div class="refsect2">
<a name="TpDynamicHandleRepo--normalize-function"></a><h3>The <code class="literal">"normalize-function"</code> property</h3>
<pre class="programlisting">  "normalize-function"       <span class="type">gpointer</span>              : Read / Write / Construct Only</pre>
<p>
An optional <a class="link" href="TpDynamicHandleRepo.html#TpDynamicHandleRepoNormalizeFunc" title="TpDynamicHandleRepoNormalizeFunc ()"><span class="type">TpDynamicHandleRepoNormalizeFunc</span></a> used to validate and
normalize handle IDs. If <code class="literal">NULL</code> (which is the default), any handle ID is
accepted as-is (equivalent to supplying a pointer to a function that just
calls g_strdup).
</p>
</div>
</div>
<div class="refsect1">
<a name="TpDynamicHandleRepo.see-also"></a><h2>See Also</h2>
TpHandleRepoIface, TpStaticHandleRepo
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.18</div>
</body>
</html>