libgrss-dev 0.4.0-3 / usr / share / gtk-doc / html / libgrss / FeedsSubscriber.html

This file is indexed.

/usr/share/gtk-doc/html/libgrss/FeedsSubscriber.html is in libgrss-dev 0.4.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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>FeedsSubscriber</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<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="FeedsGroup.html" title="FeedsGroup">
<link rel="next" href="FeedsStore.html" title="FeedsStore">
<meta name="generator" content="GTK-Doc V1.12 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="libgrss.html" title="Part I. libgrss Overview">
<link rel="part" href="libgrss-essentials.html" title="Part II. Essential Elements">
<link rel="part" href="libgrss-utils.html" title="Part III. Useful Objects">
<link rel="index" href="ix01.html" title="Index">
<link rel="appendix" href="license.html" title="Appendix A. License">
</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="FeedsGroup.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="FeedsStore.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#FeedsSubscriber.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#FeedsSubscriber.description" class="shortcut">Description</a>
                   | 
                  <a href="#FeedsSubscriber.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#FeedsSubscriber.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry" title="FeedsSubscriber">
<a name="FeedsSubscriber"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="FeedsSubscriber.top_of_page"></a>FeedsSubscriber</span></h2>
<p>FeedsSubscriber — PubSubHub subscriber</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1" title="Stability Level">
<a name="FeedsSubscriber.stability-level"></a><h2>Stability Level</h2>, unless otherwise indicated
</div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="FeedsSubscriber.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">                    <a class="link" href="FeedsSubscriber.html#FeedsSubscriber-struct" title="FeedsSubscriber">FeedsSubscriber</a>;
<a class="link" href="FeedsSubscriber.html" title="FeedsSubscriber"><span class="returnvalue">FeedsSubscriber</span></a>*    <a class="link" href="FeedsSubscriber.html#feeds-subscriber-new" title="feeds_subscriber_new ()">feeds_subscriber_new</a>                ();
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="FeedsSubscriber.html#feeds-subscriber-listen" title="feeds_subscriber_listen ()">feeds_subscriber_listen</a>             (<em class="parameter"><code><a class="link" href="FeedsSubscriber.html" title="FeedsSubscriber"><span class="type">FeedsSubscriber</span></a> *sub</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="FeedsSubscriber.html#feeds-subscriber-get-listened" title="feeds_subscriber_get_listened ()">feeds_subscriber_get_listened</a>       (<em class="parameter"><code><a class="link" href="FeedsSubscriber.html" title="FeedsSubscriber"><span class="type">FeedsSubscriber</span></a> *sub</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="FeedsSubscriber.html#feeds-subscriber-set-port" title="feeds_subscriber_set_port ()">feeds_subscriber_set_port</a>           (<em class="parameter"><code><a class="link" href="FeedsSubscriber.html" title="FeedsSubscriber"><span class="type">FeedsSubscriber</span></a> *sub</code></em>,
                                                         <em class="parameter"><code><span class="type">int</span> port</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="FeedsSubscriber.html#feeds-subscriber-set-hub" title="feeds_subscriber_set_hub ()">feeds_subscriber_set_hub</a>            (<em class="parameter"><code><a class="link" href="FeedsSubscriber.html" title="FeedsSubscriber"><span class="type">FeedsSubscriber</span></a> *sub</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *hub</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="FeedsSubscriber.html#feeds-subscriber-switch" title="feeds_subscriber_switch ()">feeds_subscriber_switch</a>             (<em class="parameter"><code><a class="link" href="FeedsSubscriber.html" title="FeedsSubscriber"><span class="type">FeedsSubscriber</span></a> *sub</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>
</div>
<div class="refsect1" title="Object Hierarchy">
<a name="FeedsSubscriber.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>
   +----FeedsSubscriber
</pre>
</div>
<div class="refsect1" title="Signals">
<a name="FeedsSubscriber.signals"></a><h2>Signals</h2>
<pre class="synopsis">
  "<a class="link" href="FeedsSubscriber.html#FeedsSubscriber-notification-received" title='The "notification-received" signal'>notification-received</a>"                          : Run Last
</pre>
</div>
<div class="refsect1" title="Description">
<a name="FeedsSubscriber.description"></a><h2>Description</h2>
<p>
<a class="link" href="FeedsSubscriber.html" title="FeedsSubscriber"><span class="type">FeedsSubscriber</span></a> is an alternative for <a class="link" href="FeedsPool.html" title="FeedsPool"><span class="type">FeedsPool</span></a>, able to receive
real-time notifications by feeds managed by a PubSubHub hub.
When the subscriber is executed (with <a class="link" href="FeedsSubscriber.html#feeds-subscriber-switch" title="feeds_subscriber_switch ()"><code class="function">feeds_subscriber_switch()</code></a>) it opens
a server on a local port (configurable with <a class="link" href="FeedsSubscriber.html#feeds-subscriber-set-port" title="feeds_subscriber_set_port ()"><code class="function">feeds_subscriber_set_port()</code></a>),
engage a subscription for each <a class="link" href="FeedChannel.html" title="FeedChannel"><span class="type">FeedChannel</span></a> passed with
<a class="link" href="FeedsSubscriber.html#feeds-subscriber-listen" title="feeds_subscriber_listen ()"><code class="function">feeds_subscriber_listen()</code></a>, and waits for direct notifications by the
remote hub.
For more information look at http://code.google.com/p/pubsubhubbub/</p>
</div>
<div class="refsect1" title="Details">
<a name="FeedsSubscriber.details"></a><h2>Details</h2>
<div class="refsect2" title="FeedsSubscriber">
<a name="FeedsSubscriber-struct"></a><h3>FeedsSubscriber</h3>
<pre class="programlisting">typedef struct _FeedsSubscriber FeedsSubscriber;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="feeds_subscriber_new ()">
<a name="feeds-subscriber-new"></a><h3>feeds_subscriber_new ()</h3>
<pre class="programlisting"><a class="link" href="FeedsSubscriber.html" title="FeedsSubscriber"><span class="returnvalue">FeedsSubscriber</span></a>*    feeds_subscriber_new                ();</pre>
<p>
Allocates a new <a class="link" href="FeedsSubscriber.html" title="FeedsSubscriber"><span class="type">FeedsSubscriber</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="FeedsSubscriber.html" title="FeedsSubscriber"><span class="type">FeedsSubscriber</span></a>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="feeds_subscriber_listen ()">
<a name="feeds-subscriber-listen"></a><h3>feeds_subscriber_listen ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            feeds_subscriber_listen             (<em class="parameter"><code><a class="link" href="FeedsSubscriber.html" title="FeedsSubscriber"><span class="type">FeedsSubscriber</span></a> *sub</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 <em class="parameter"><code>sub</code></em>. The previous list, if any,
is invalidated. After invokation to the function, <a class="link" href="FeedsSubscriber.html#feeds-subscriber-switch" title="feeds_subscriber_switch ()"><code class="function">feeds_subscriber_switch()</code></a>
must be call to run the subscription.
The list in <em class="parameter"><code>feeds</code></em> can be freed after calling this; linked <a class="link" href="FeedChannel.html" title="FeedChannel"><span class="type">FeedChannel</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>sub</code></em> :</span></p></td>
<td>a <a class="link" href="FeedsSubscriber.html" title="FeedsSubscriber"><span class="type">FeedsSubscriber</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="FeedChannel.html" title="FeedChannel"><span class="type">FeedChannel</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</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> if all <a href="FeedChannel.html"><span class="type">FeedChannels</span></a> involved in <em class="parameter"><code>feeds</code></em> are valid
(<a class="link" href="FeedChannel.html#feed-channel-get-pubsubhub" title="feed_channel_get_pubsubhub ()"><code class="function">feed_channel_get_pubsubhub()</code></a> returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>), <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="feeds_subscriber_get_listened ()">
<a name="feeds-subscriber-get-listened"></a><h3>feeds_subscriber_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>*              feeds_subscriber_get_listened       (<em class="parameter"><code><a class="link" href="FeedsSubscriber.html" title="FeedsSubscriber"><span class="type">FeedsSubscriber</span></a> *sub</code></em>);</pre>
<p>
Returns the list of feeds currently managed by <em class="parameter"><code>sub</code></em></p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>sub</code></em> :</span></p></td>
<td>a <a class="link" href="FeedsSubscriber.html" title="FeedsSubscriber"><span class="type">FeedsSubscriber</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="FeedChannel.html" title="FeedChannel"><span class="type">FeedChannel</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" title="feeds_subscriber_set_port ()">
<a name="feeds-subscriber-set-port"></a><h3>feeds_subscriber_set_port ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                feeds_subscriber_set_port           (<em class="parameter"><code><a class="link" href="FeedsSubscriber.html" title="FeedsSubscriber"><span class="type">FeedsSubscriber</span></a> *sub</code></em>,
                                                         <em class="parameter"><code><span class="type">int</span> port</code></em>);</pre>
<p>
To customize the port opened by the local server to catch incoming
publishers' events. By default this is 8444. Changing the port while the
subscriber is running imply restart the local server.
Pay attention to the fact many publishers' implementations accept only
certain ports</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>sub</code></em> :</span></p></td>
<td>a <a class="link" href="FeedsSubscriber.html" title="FeedsSubscriber"><span class="type">FeedsSubscriber</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>port</code></em> :</span></p></td>
<td>new listening port for the server
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="feeds_subscriber_set_hub ()">
<a name="feeds-subscriber-set-hub"></a><h3>feeds_subscriber_set_hub ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                feeds_subscriber_set_hub            (<em class="parameter"><code><a class="link" href="FeedsSubscriber.html" title="FeedsSubscriber"><span class="type">FeedsSubscriber</span></a> *sub</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *hub</code></em>);</pre>
<p>
To customize the default hub to which send subscriptions. If this value is
set, hubs from specific feeds are ignored</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>sub</code></em> :</span></p></td>
<td>a <a class="link" href="FeedsSubscriber.html" title="FeedsSubscriber"><span class="type">FeedsSubscriber</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>hub</code></em> :</span></p></td>
<td>URL of the custom hub
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="feeds_subscriber_switch ()">
<a name="feeds-subscriber-switch"></a><h3>feeds_subscriber_switch ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                feeds_subscriber_switch             (<em class="parameter"><code><a class="link" href="FeedsSubscriber.html" title="FeedsSubscriber"><span class="type">FeedsSubscriber</span></a> *sub</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 <em class="parameter"><code>sub</code></em> listening for events</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>sub</code></em> :</span></p></td>
<td>a <a class="link" href="FeedsSubscriber.html" title="FeedsSubscriber"><span class="type">FeedsSubscriber</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>run</code></em> :</span></p></td>
<td>TRUE to run the subscriber, FALSE to pause it
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" title="Signal Details">
<a name="FeedsSubscriber.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2" title='The "notification-received" signal'>
<a name="FeedsSubscriber-notification-received"></a><h3>The <code class="literal">"notification-received"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="FeedsSubscriber.html" title="FeedsSubscriber"><span class="type">FeedsSubscriber</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/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a>         *item,
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>         user_data)      : Run Last</pre>
<p>
Emitted when a notification has been received and parsed. The
<em class="parameter"><code>item</code></em> is unref'd at the end of signal</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="FeedsSubscriber.html" title="FeedsSubscriber"><span class="type">FeedsSubscriber</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="FeedChannel.html" title="FeedChannel"><span class="type">FeedChannel</span></a> which has been updated
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>item</code></em> :</span></p></td>
<td>the <a class="link" href="FeedItem.html" title="FeedItem"><span class="type">FeedItem</span></a> received
</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.12</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.