libgrss-dev 0.5.0-3 / usr / share / gtk-doc / html / libgrss / GrssFeedsPool.html

This file is indexed.

/usr/share/gtk-doc/html/libgrss/GrssFeedsPool.html is in libgrss-dev 0.5.0-3.

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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GrssFeedsPool</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="libgrss Reference Manual">
<link rel="up" href="libgrss-utils.html" title="Part III. Useful Objects">
<link rel="prev" href="libgrss-utils.html" title="Part III. Useful Objects">
<link rel="next" href="GrssFeedsGroup.html" title="GrssFeedsGroup">
<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="libgrss-utils.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libgrss-utils.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">libgrss Reference Manual</th>
<td><a accesskey="n" href="GrssFeedsGroup.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GrssFeedsPool.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#GrssFeedsPool.description" class="shortcut">Description</a>
                   | 
                  <a href="#GrssFeedsPool.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#GrssFeedsPool.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry">
<a name="GrssFeedsPool"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GrssFeedsPool.top_of_page"></a>GrssFeedsPool</span></h2>
<p>GrssFeedsPool — feeds auto-fetcher</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GrssFeedsPool.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct              <a class="link" href="GrssFeedsPool.html#GrssFeedsPool-struct" title="struct GrssFeedsPool">GrssFeedsPool</a>;
<a class="link" href="GrssFeedsPool.html" title="GrssFeedsPool"><span class="returnvalue">GrssFeedsPool</span></a> *     <a class="link" href="GrssFeedsPool.html#grss-feeds-pool-new" title="grss_feeds_pool_new ()">grss_feeds_pool_new</a>                 ();
<span class="returnvalue">void</span>                <a class="link" href="GrssFeedsPool.html#grss-feeds-pool-listen" title="grss_feeds_pool_listen ()">grss_feeds_pool_listen</a>              (<em class="parameter"><code><a class="link" href="GrssFeedsPool.html" title="GrssFeedsPool"><span class="type">GrssFeedsPool</span></a> *pool</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> *feeds</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *             <a class="link" href="GrssFeedsPool.html#grss-feeds-pool-get-listened" title="grss_feeds_pool_get_listened ()">grss_feeds_pool_get_listened</a>        (<em class="parameter"><code><a class="link" href="GrssFeedsPool.html" title="GrssFeedsPool"><span class="type">GrssFeedsPool</span></a> *pool</code></em>);
<span class="returnvalue">int</span>                 <a class="link" href="GrssFeedsPool.html#grss-feeds-pool-get-listened-num" title="grss_feeds_pool_get_listened_num ()">grss_feeds_pool_get_listened_num</a>    (<em class="parameter"><code><a class="link" href="GrssFeedsPool.html" title="GrssFeedsPool"><span class="type">GrssFeedsPool</span></a> *pool</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="GrssFeedsPool.html#grss-feeds-pool-switch" title="grss_feeds_pool_switch ()">grss_feeds_pool_switch</a>              (<em class="parameter"><code><a class="link" href="GrssFeedsPool.html" title="GrssFeedsPool"><span class="type">GrssFeedsPool</span></a> *pool</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> run</code></em>);
<span class="returnvalue">SoupSession</span> *       <a class="link" href="GrssFeedsPool.html#grss-feeds-pool-get-session" title="grss_feeds_pool_get_session ()">grss_feeds_pool_get_session</a>         (<em class="parameter"><code><a class="link" href="GrssFeedsPool.html" title="GrssFeedsPool"><span class="type">GrssFeedsPool</span></a> *pool</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="GrssFeedsPool.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
   +----GrssFeedsPool
</pre>
</div>
<div class="refsect1">
<a name="GrssFeedsPool.signals"></a><h2>Signals</h2>
<pre class="synopsis">
  "<a class="link" href="GrssFeedsPool.html#GrssFeedsPool-feed-fetching" title='The "feed-fetching" signal'>feed-fetching</a>"                                  : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
  "<a class="link" href="GrssFeedsPool.html#GrssFeedsPool-feed-ready" title='The "feed-ready" signal'>feed-ready</a>"                                     : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
</pre>
</div>
<div class="refsect1">
<a name="GrssFeedsPool.description"></a><h2>Description</h2>
<p>
The <a class="link" href="GrssFeedsPool.html" title="GrssFeedsPool"><span class="type">GrssFeedsPool</span></a> permits to automatically "listen" for more feeds: it
provides to fetch them on regular intervals (as defined by
<a class="link" href="GrssFeedChannel.html#grss-feed-channel-get-update-interval" title="grss_feed_channel_get_update_interval ()"><code class="function">grss_feed_channel_get_update_interval()</code></a> for each channel), parse them with
<a class="link" href="GrssFeedParser.html" title="GrssFeedParser"><span class="type">GrssFeedParser</span></a>, and emits signals when feeds are ready.
</p>
</div>
<div class="refsect1">
<a name="GrssFeedsPool.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GrssFeedsPool-struct"></a><h3>struct GrssFeedsPool</h3>
<pre class="programlisting">struct GrssFeedsPool;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="grss-feeds-pool-new"></a><h3>grss_feeds_pool_new ()</h3>
<pre class="programlisting"><a class="link" href="GrssFeedsPool.html" title="GrssFeedsPool"><span class="returnvalue">GrssFeedsPool</span></a> *     grss_feeds_pool_new                 ();</pre>
<p>
Allocates a new <a class="link" href="GrssFeedsPool.html" title="GrssFeedsPool"><span class="type">GrssFeedsPool</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new <a class="link" href="GrssFeedsPool.html" title="GrssFeedsPool"><span class="type">GrssFeedsPool</span></a>.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="grss-feeds-pool-listen"></a><h3>grss_feeds_pool_listen ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                grss_feeds_pool_listen              (<em class="parameter"><code><a class="link" href="GrssFeedsPool.html" title="GrssFeedsPool"><span class="type">GrssFeedsPool</span></a> *pool</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> *feeds</code></em>);</pre>
<p>
To set the list of feeds to be managed by the pool. The previous list, if
any, is invalidated. After invokation to the function, <a class="link" href="GrssFeedsPool.html#grss-feeds-pool-switch" title="grss_feeds_pool_switch ()"><code class="function">grss_feeds_pool_switch()</code></a>
must be call to run the auto-fetching (always, also if previous state was
"running").
The list in <em class="parameter"><code>feeds</code></em> can be freed after calling this; linked <a class="link" href="GrssFeedChannel.html" title="GrssFeedChannel"><span class="type">GrssFeedChannel</span></a>
are g_object_ref'd here.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>pool</code></em> :</span></p></td>
<td>a <a class="link" href="GrssFeedsPool.html" title="GrssFeedsPool"><span class="type">GrssFeedsPool</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>feeds</code></em> :</span></p></td>
<td>a list of <a class="link" href="GrssFeedChannel.html" title="GrssFeedChannel"><span class="type">GrssFeedChannel</span></a>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="grss-feeds-pool-get-listened"></a><h3>grss_feeds_pool_get_listened ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *             grss_feeds_pool_get_listened        (<em class="parameter"><code><a class="link" href="GrssFeedsPool.html" title="GrssFeedsPool"><span class="type">GrssFeedsPool</span></a> *pool</code></em>);</pre>
<p>
Returns the list of feeds currently managed by the <em class="parameter"><code>pool</code></em>. Please consider
this function has to build the list that returns, and of course this is a
time and resources consuming task: if you only need to know how many feeds
are currently handled, check <a class="link" href="GrssFeedsPool.html#grss-feeds-pool-get-listened-num" title="grss_feeds_pool_get_listened_num ()"><code class="function">grss_feeds_pool_get_listened_num()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>pool</code></em> :</span></p></td>
<td>a <a class="link" href="GrssFeedsPool.html" title="GrssFeedsPool"><span class="type">GrssFeedsPool</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a list of <a class="link" href="GrssFeedChannel.html" title="GrssFeedChannel"><span class="type">GrssFeedChannel</span></a>, to be freed with <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#g-list-free"><code class="function">g_list_free()</code></a> when
no longer in use. Do not modify elements found in this list.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="grss-feeds-pool-get-listened-num"></a><h3>grss_feeds_pool_get_listened_num ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>                 grss_feeds_pool_get_listened_num    (<em class="parameter"><code><a class="link" href="GrssFeedsPool.html" title="GrssFeedsPool"><span class="type">GrssFeedsPool</span></a> *pool</code></em>);</pre>
<p>
Returns number of feeds under the <em class="parameter"><code>pool</code></em> control, as provided by
<a class="link" href="GrssFeedsPool.html#grss-feeds-pool-listen" title="grss_feeds_pool_listen ()"><code class="function">grss_feeds_pool_listen()</code></a>. To get the complete list of those feeds, check
<a class="link" href="GrssFeedsPool.html#grss-feeds-pool-get-listened" title="grss_feeds_pool_get_listened ()"><code class="function">grss_feeds_pool_get_listened()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>pool</code></em> :</span></p></td>
<td>a <a class="link" href="GrssFeedsPool.html" title="GrssFeedsPool"><span class="type">GrssFeedsPool</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>number of feeds currently managed by the <a class="link" href="GrssFeedsPool.html" title="GrssFeedsPool"><span class="type">GrssFeedsPool</span></a>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="grss-feeds-pool-switch"></a><h3>grss_feeds_pool_switch ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                grss_feeds_pool_switch              (<em class="parameter"><code><a class="link" href="GrssFeedsPool.html" title="GrssFeedsPool"><span class="type">GrssFeedsPool</span></a> *pool</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> run</code></em>);</pre>
<p>
Permits to pause or resume the <em class="parameter"><code>pool</code></em> fetching feeds. If <em class="parameter"><code>run</code></em> is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, the
<em class="parameter"><code>pool</code></em> starts immediately.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>pool</code></em> :</span></p></td>
<td>a <a class="link" href="GrssFeedsPool.html" title="GrssFeedsPool"><span class="type">GrssFeedsPool</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>run</code></em> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to run the pool, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> to pause it.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="grss-feeds-pool-get-session"></a><h3>grss_feeds_pool_get_session ()</h3>
<pre class="programlisting"><span class="returnvalue">SoupSession</span> *       grss_feeds_pool_get_session         (<em class="parameter"><code><a class="link" href="GrssFeedsPool.html" title="GrssFeedsPool"><span class="type">GrssFeedsPool</span></a> *pool</code></em>);</pre>
<p>
To access the internal <span class="type">SoupSession</span> used by the <em class="parameter"><code>pool</code></em> to fetch items.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>pool</code></em> :</span></p></td>
<td>a <a class="link" href="GrssFeedsPool.html" title="GrssFeedsPool"><span class="type">GrssFeedsPool</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>istance of <span class="type">SoupSession</span>. Do not free it.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="GrssFeedsPool.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="GrssFeedsPool-feed-fetching"></a><h3>The <code class="literal">"feed-fetching"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="GrssFeedsPool.html" title="GrssFeedsPool"><span class="type">GrssFeedsPool</span></a> *pool,
                                                        <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a>       *feed,
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>       user_data)      : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
<p>
Emitted when the <em class="parameter"><code>pool</code></em> starts fetching a new <a class="link" href="GrssFeedChannel.html" title="GrssFeedChannel"><span class="type">GrssFeedChannel</span></a>. To be
used to know the internal status of the component.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>pool</code></em> :</span></p></td>
<td>the <a class="link" href="GrssFeedsPool.html" title="GrssFeedsPool"><span class="type">GrssFeedsPool</span></a> emitting the signal.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>feed</code></em> :</span></p></td>
<td>the <a class="link" href="GrssFeedChannel.html" title="GrssFeedChannel"><span class="type">GrssFeedChannel</span></a> which is going to be fetched.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GrssFeedsPool-feed-ready"></a><h3>The <code class="literal">"feed-ready"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="GrssFeedsPool.html" title="GrssFeedsPool"><span class="type">GrssFeedsPool</span></a> *pool,
                                                        <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a>       *feed,
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>       items,
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>       user_data)      : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
<p>
Emitted when a <a class="link" href="GrssFeedChannel.html" title="GrssFeedChannel"><span class="type">GrssFeedChannel</span></a> assigned to the <em class="parameter"><code>pool</code></em> has been fetched
and parsed. All parsed items are exposed in the array, with no
regards about previously existing elements. <em class="parameter"><code>items</code></em> may be NULL, if
an error occourred while fetching and/or parsing. List of <em class="parameter"><code>items</code></em>
is freed, and his elements are unref'd, when signal ends.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>pool</code></em> :</span></p></td>
<td>the <a class="link" href="GrssFeedsPool.html" title="GrssFeedsPool"><span class="type">GrssFeedsPool</span></a> emitting the signal.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>feed</code></em> :</span></p></td>
<td>the <a class="link" href="GrssFeedChannel.html" title="GrssFeedChannel"><span class="type">GrssFeedChannel</span></a> which has been fetched and parsed.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>items</code></em> :</span></p></td>
<td>list of <a class="link" href="GrssFeedItem.html" title="GrssFeedItem"><span class="type">GrssFeedItem</span></a> obtained parsing the feed.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</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.