librdf0-dev 1.0.17-1build1 / usr / share / gtk-doc / html / librdf / redland-log.html

This file is indexed.

/usr/share/gtk-doc/html/librdf/redland-log.html is in librdf0-dev 1.0.17-1build1.

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
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Logging</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Redland RDF Library Manual">
<link rel="up" href="reference-manual.html" title="Part II. Reference Manual">
<link rel="prev" href="redland-list.html" title="List">
<link rel="next" href="redland-model.html" title="RDF Graph (librdf_model)">
<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="redland-list.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="reference-manual.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">Redland RDF Library Manual</th>
<td><a accesskey="n" href="redland-model.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#redland-log.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#redland-log.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="redland-log"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="redland-log.top_of_page"></a>Logging</span></h2>
<p>Logging — Message and error logging.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="redland-log.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"><span class="returnvalue">int</span>                 (<a class="link" href="redland-log.html#librdf-log-level-func" title="librdf_log_level_func ()">*librdf_log_level_func</a>)            (<em class="parameter"><code><span class="type">void</span> *user_data</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *message</code></em>,
                                                         <em class="parameter"><code><span class="type">va_list</span> arguments</code></em>);
<span class="returnvalue">int</span>                 (<a class="link" href="redland-log.html#librdf-log-func" title="librdf_log_func ()">*librdf_log_func</a>)                  (<em class="parameter"><code><span class="type">void</span> *user_data</code></em>,
                                                         <em class="parameter"><code><span class="type">librdf_log_message</span> *message</code></em>);
enum                <a class="link" href="redland-log.html#librdf-log-level" title="enum librdf_log_level">librdf_log_level</a>;
enum                <a class="link" href="redland-log.html#librdf-log-facility" title="enum librdf_log_facility">librdf_log_facility</a>;
<span class="returnvalue">int</span>                 <a class="link" href="redland-log.html#librdf-log-message-code" title="librdf_log_message_code ()">librdf_log_message_code</a>             (<em class="parameter"><code><span class="type">librdf_log_message</span> *message</code></em>);
<a class="link" href="redland-log.html#librdf-log-level" title="enum librdf_log_level"><span class="returnvalue">librdf_log_level</span></a>    <a class="link" href="redland-log.html#librdf-log-message-level" title="librdf_log_message_level ()">librdf_log_message_level</a>            (<em class="parameter"><code><span class="type">librdf_log_message</span> *message</code></em>);
<a class="link" href="redland-log.html#librdf-log-facility" title="enum librdf_log_facility"><span class="returnvalue">librdf_log_facility</span></a> <a class="link" href="redland-log.html#librdf-log-message-facility" title="librdf_log_message_facility ()">librdf_log_message_facility</a>         (<em class="parameter"><code><span class="type">librdf_log_message</span> *message</code></em>);
const <span class="returnvalue">char</span> *        <a class="link" href="redland-log.html#librdf-log-message-message" title="librdf_log_message_message ()">librdf_log_message_message</a>          (<em class="parameter"><code><span class="type">librdf_log_message</span> *message</code></em>);
<span class="returnvalue">raptor_locator</span> *    <a class="link" href="redland-log.html#librdf-log-message-locator" title="librdf_log_message_locator ()">librdf_log_message_locator</a>          (<em class="parameter"><code><span class="type">librdf_log_message</span> *message</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="redland-log.description"></a><h2>Description</h2>
<p>
Provides structured access to debug, information, warning and error
messages from the libraries.  Structured information is most often
used from errors such as parsing where file or URI and line numbers
can be returned via a <span class="type">raptor_locator</span> object pointer found by
<a class="link" href="redland-log.html#librdf-log-message-locator" title="librdf_log_message_locator ()"><code class="function">librdf_log_message_locator()</code></a> on the <span class="type">librdf_log_message</span>.
</p>
</div>
<div class="refsect1">
<a name="redland-log.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="librdf-log-level-func"></a><h3>librdf_log_level_func ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>                 (*librdf_log_level_func)            (<em class="parameter"><code><span class="type">void</span> *user_data</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *message</code></em>,
                                                         <em class="parameter"><code><span class="type">va_list</span> arguments</code></em>);</pre>
<p>
Handler for one log level, for the warning and error levels ONLY.
Used by <a class="link" href="redland-world.html#librdf-world-set-warning" title="librdf_world_set_warning ()"><span class="type">librdf_world_set_warning</span></a> and <a class="link" href="redland-world.html#librdf-world-set-error" title="librdf_world_set_error ()"><span class="type">librdf_world_set_error</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>User data pointer</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td>
<td>Log message.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>arguments</code></em> :</span></p></td>
<td>Message arguments.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>non-zero to indicate log message has been handled</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="librdf-log-func"></a><h3>librdf_log_func ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>                 (*librdf_log_func)                  (<em class="parameter"><code><span class="type">void</span> *user_data</code></em>,
                                                         <em class="parameter"><code><span class="type">librdf_log_message</span> *message</code></em>);</pre>
<p>
Handler for all log levels.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>User data pointer</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td>
<td>Log message structure pointer.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>non-zero to indicate log message has been handled</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="librdf-log-level"></a><h3>enum librdf_log_level</h3>
<pre class="programlisting">typedef enum {
  LIBRDF_LOG_NONE = 0,
  LIBRDF_LOG_DEBUG,
  LIBRDF_LOG_INFO,
  LIBRDF_LOG_WARN,
  LIBRDF_LOG_ERROR,
  LIBRDF_LOG_FATAL,
  LIBRDF_LOG_LAST=LIBRDF_LOG_FATAL
} librdf_log_level;
</pre>
<p>
Indicates the level of the log message.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="LIBRDF-LOG-NONE:CAPS"></a><span class="term"><code class="literal">LIBRDF_LOG_NONE</code></span></p></td>
<td>No level
</td>
</tr>
<tr>
<td><p><a name="LIBRDF-LOG-DEBUG:CAPS"></a><span class="term"><code class="literal">LIBRDF_LOG_DEBUG</code></span></p></td>
<td>Debug.
</td>
</tr>
<tr>
<td><p><a name="LIBRDF-LOG-INFO:CAPS"></a><span class="term"><code class="literal">LIBRDF_LOG_INFO</code></span></p></td>
<td>Information.
</td>
</tr>
<tr>
<td><p><a name="LIBRDF-LOG-WARN:CAPS"></a><span class="term"><code class="literal">LIBRDF_LOG_WARN</code></span></p></td>
<td>Warning.
</td>
</tr>
<tr>
<td><p><a name="LIBRDF-LOG-ERROR:CAPS"></a><span class="term"><code class="literal">LIBRDF_LOG_ERROR</code></span></p></td>
<td>Recoverable error.  Program can continue.
</td>
</tr>
<tr>
<td><p><a name="LIBRDF-LOG-FATAL:CAPS"></a><span class="term"><code class="literal">LIBRDF_LOG_FATAL</code></span></p></td>
<td>Fatal error.  Program will abort if this is not caught.
</td>
</tr>
<tr>
<td><p><a name="LIBRDF-LOG-LAST:CAPS"></a><span class="term"><code class="literal">LIBRDF_LOG_LAST</code></span></p></td>
<td>Internal, never returned.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="librdf-log-facility"></a><h3>enum librdf_log_facility</h3>
<pre class="programlisting">typedef enum {
  LIBRDF_FROM_NONE = 0,
  LIBRDF_FROM_CONCEPTS,
  LIBRDF_FROM_DIGEST,
  LIBRDF_FROM_FILES,
  LIBRDF_FROM_HASH,
  LIBRDF_FROM_INIT,
  LIBRDF_FROM_ITERATOR,
  LIBRDF_FROM_LIST,
  LIBRDF_FROM_MODEL,
  LIBRDF_FROM_NODE,
  LIBRDF_FROM_PARSER,
  LIBRDF_FROM_QUERY,
  LIBRDF_FROM_SERIALIZER,
  LIBRDF_FROM_STATEMENT,
  LIBRDF_FROM_STORAGE,
  LIBRDF_FROM_STREAM,
  LIBRDF_FROM_URI,
  LIBRDF_FROM_UTF8,
  LIBRDF_FROM_MEMORY,
  LIBRDF_FROM_RAPTOR,
  LIBRDF_FROM_LAST=LIBRDF_FROM_RAPTOR
} librdf_log_facility;
</pre>
<p>
Indicates the part of the system that generated the log message.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="LIBRDF-FROM-NONE:CAPS"></a><span class="term"><code class="literal">LIBRDF_FROM_NONE</code></span></p></td>
<td>Associated with no part.
</td>
</tr>
<tr>
<td><p><a name="LIBRDF-FROM-CONCEPTS:CAPS"></a><span class="term"><code class="literal">LIBRDF_FROM_CONCEPTS</code></span></p></td>
<td>Concepts
</td>
</tr>
<tr>
<td><p><a name="LIBRDF-FROM-DIGEST:CAPS"></a><span class="term"><code class="literal">LIBRDF_FROM_DIGEST</code></span></p></td>
<td>Digest
</td>
</tr>
<tr>
<td><p><a name="LIBRDF-FROM-FILES:CAPS"></a><span class="term"><code class="literal">LIBRDF_FROM_FILES</code></span></p></td>
<td>Files
</td>
</tr>
<tr>
<td><p><a name="LIBRDF-FROM-HASH:CAPS"></a><span class="term"><code class="literal">LIBRDF_FROM_HASH</code></span></p></td>
<td>Hash
</td>
</tr>
<tr>
<td><p><a name="LIBRDF-FROM-INIT:CAPS"></a><span class="term"><code class="literal">LIBRDF_FROM_INIT</code></span></p></td>
<td>Init
</td>
</tr>
<tr>
<td><p><a name="LIBRDF-FROM-ITERATOR:CAPS"></a><span class="term"><code class="literal">LIBRDF_FROM_ITERATOR</code></span></p></td>
<td>Iterator
</td>
</tr>
<tr>
<td><p><a name="LIBRDF-FROM-LIST:CAPS"></a><span class="term"><code class="literal">LIBRDF_FROM_LIST</code></span></p></td>
<td>List
</td>
</tr>
<tr>
<td><p><a name="LIBRDF-FROM-MODEL:CAPS"></a><span class="term"><code class="literal">LIBRDF_FROM_MODEL</code></span></p></td>
<td>Model
</td>
</tr>
<tr>
<td><p><a name="LIBRDF-FROM-NODE:CAPS"></a><span class="term"><code class="literal">LIBRDF_FROM_NODE</code></span></p></td>
<td>Node
</td>
</tr>
<tr>
<td><p><a name="LIBRDF-FROM-PARSER:CAPS"></a><span class="term"><code class="literal">LIBRDF_FROM_PARSER</code></span></p></td>
<td>Parser
</td>
</tr>
<tr>
<td><p><a name="LIBRDF-FROM-QUERY:CAPS"></a><span class="term"><code class="literal">LIBRDF_FROM_QUERY</code></span></p></td>
<td>Query
</td>
</tr>
<tr>
<td><p><a name="LIBRDF-FROM-SERIALIZER:CAPS"></a><span class="term"><code class="literal">LIBRDF_FROM_SERIALIZER</code></span></p></td>
<td>Serializer
</td>
</tr>
<tr>
<td><p><a name="LIBRDF-FROM-STATEMENT:CAPS"></a><span class="term"><code class="literal">LIBRDF_FROM_STATEMENT</code></span></p></td>
<td>Statement
</td>
</tr>
<tr>
<td><p><a name="LIBRDF-FROM-STORAGE:CAPS"></a><span class="term"><code class="literal">LIBRDF_FROM_STORAGE</code></span></p></td>
<td>Storage
</td>
</tr>
<tr>
<td><p><a name="LIBRDF-FROM-STREAM:CAPS"></a><span class="term"><code class="literal">LIBRDF_FROM_STREAM</code></span></p></td>
<td>Stream
</td>
</tr>
<tr>
<td><p><a name="LIBRDF-FROM-URI:CAPS"></a><span class="term"><code class="literal">LIBRDF_FROM_URI</code></span></p></td>
<td>URI
</td>
</tr>
<tr>
<td><p><a name="LIBRDF-FROM-UTF8:CAPS"></a><span class="term"><code class="literal">LIBRDF_FROM_UTF8</code></span></p></td>
<td>UTF8
</td>
</tr>
<tr>
<td><p><a name="LIBRDF-FROM-MEMORY:CAPS"></a><span class="term"><code class="literal">LIBRDF_FROM_MEMORY</code></span></p></td>
<td>Memory
</td>
</tr>
<tr>
<td><p><a name="LIBRDF-FROM-RAPTOR:CAPS"></a><span class="term"><code class="literal">LIBRDF_FROM_RAPTOR</code></span></p></td>
<td>Raptor library (parser or serializer; Raptor 2.0.0+).
</td>
</tr>
<tr>
<td><p><a name="LIBRDF-FROM-LAST:CAPS"></a><span class="term"><code class="literal">LIBRDF_FROM_LAST</code></span></p></td>
<td>Internal, never returned.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="librdf-log-message-code"></a><h3>librdf_log_message_code ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>                 librdf_log_message_code             (<em class="parameter"><code><span class="type">librdf_log_message</span> *message</code></em>);</pre>
<p>
Retrieve error code from log message.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td>
<td>log message</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>int error code</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="librdf-log-message-level"></a><h3>librdf_log_message_level ()</h3>
<pre class="programlisting"><a class="link" href="redland-log.html#librdf-log-level" title="enum librdf_log_level"><span class="returnvalue">librdf_log_level</span></a>    librdf_log_message_level            (<em class="parameter"><code><span class="type">librdf_log_message</span> *message</code></em>);</pre>
<p>
Retrieve severity of log message.
</p>
<p>
The log message severity level is defined in rdf_log.h as values
of enum <a class="link" href="redland-log.html#librdf-log-level" title="enum librdf_log_level"><span class="type">librdf_log_level</span></a>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td>
<td>log message</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>severity level</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="librdf-log-message-facility"></a><h3>librdf_log_message_facility ()</h3>
<pre class="programlisting"><a class="link" href="redland-log.html#librdf-log-facility" title="enum librdf_log_facility"><span class="returnvalue">librdf_log_facility</span></a> librdf_log_message_facility         (<em class="parameter"><code><span class="type">librdf_log_message</span> *message</code></em>);</pre>
<p>
Retrieve facility that generated the message.
</p>
<p>
The log message facility is defined in rdf_log.h as values
of enum <a class="link" href="redland-log.html#librdf-log-facility" title="enum librdf_log_facility"><span class="type">librdf_log_facility</span></a>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td>
<td>log message</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>ID of Redland facility that generated the log message.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="librdf-log-message-message"></a><h3>librdf_log_message_message ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> *        librdf_log_message_message          (<em class="parameter"><code><span class="type">librdf_log_message</span> *message</code></em>);</pre>
<p>
Retrieve text message from log entry.
</p>
<p>
The string returned is shared and must be copied by the caller
if required to be retained.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td>
<td>log message</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>shared pointer to the log message string</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="librdf-log-message-locator"></a><h3>librdf_log_message_locator ()</h3>
<pre class="programlisting"><span class="returnvalue">raptor_locator</span> *    librdf_log_message_locator          (<em class="parameter"><code><span class="type">librdf_log_message</span> *message</code></em>);</pre>
<p>
Retrieve locator of log entry.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td>
<td>log message</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>pointer to an appropriate raptor_locator* or NULL if not available</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.18</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.