/usr/share/gtk-doc/html/libgrss/GrssFeedsSubscriber.html is in libgrss-dev 0.7.0-2.
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 445 446 447 448 449 450 451 452 453 454 455 456 457 458 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GrssFeedsSubscriber: libgrss Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="libgrss Reference Manual">
<link rel="up" href="libgrss-useful.html" title="Part IV. Useful Objects">
<link rel="prev" href="GrssFeedsGroup.html" title="GrssFeedsGroup">
<link rel="next" href="GrssFeedFormatter.html" title="GrssFeedFormatter">
<meta name="generator" content="GTK-Doc V1.24 (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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#GrssFeedsSubscriber.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#GrssFeedsSubscriber.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_signals"> <span class="dim">|</span>
<a href="#GrssFeedsSubscriber.signals" class="shortcut">Signals</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="libgrss-useful.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GrssFeedsGroup.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GrssFeedFormatter.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GrssFeedsSubscriber"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GrssFeedsSubscriber.top_of_page"></a>GrssFeedsSubscriber</span></h2>
<p>GrssFeedsSubscriber — feeds subscriber</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GrssFeedsSubscriber.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="GrssFeedsSubscriber.html" title="GrssFeedsSubscriber"><span class="returnvalue">GrssFeedsSubscriber</span></a> *
</td>
<td class="function_name">
<a class="link" href="GrssFeedsSubscriber.html#grss-feeds-subscriber-new" title="grss_feeds_subscriber_new ()">grss_feeds_subscriber_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="GrssFeedsSubscriber.html#grss-feeds-subscriber-listen" title="grss_feeds_subscriber_listen ()">grss_feeds_subscriber_listen</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="https://developer.gnome.org/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
</td>
<td class="function_name">
<a class="link" href="GrssFeedsSubscriber.html#grss-feeds-subscriber-get-listened" title="grss_feeds_subscriber_get_listened ()">grss_feeds_subscriber_get_listened</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GrssFeedsSubscriber.html#grss-feeds-subscriber-set-port" title="grss_feeds_subscriber_set_port ()">grss_feeds_subscriber_set_port</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GrssFeedsSubscriber.html#grss-feeds-subscriber-switch" title="grss_feeds_subscriber_switch ()">grss_feeds_subscriber_switch</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="https://developer.gnome.org/gio/unstable/GInetAddress.html"><span class="returnvalue">GInetAddress</span></a> *
</td>
<td class="function_name">
<a class="link" href="GrssFeedsSubscriber.html#grss-feeds-subscriber-get-address" title="grss_feeds_subscriber_get_address ()">grss_feeds_subscriber_get_address</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="GrssFeedsSubscriber.html#grss-feeds-subscriber-get-port" title="grss_feeds_subscriber_get_port ()">grss_feeds_subscriber_get_port</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/libsoup-2.4/SoupSession.html"><span class="returnvalue">SoupSession</span></a> *
</td>
<td class="function_name">
<a class="link" href="GrssFeedsSubscriber.html#grss-feeds-subscriber-get-session" title="grss_feeds_subscriber_get_session ()">grss_feeds_subscriber_get_session</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GrssFeedsSubscriber.signals"></a><h2>Signals</h2>
<div class="informaltable"><table border="0">
<colgroup>
<col width="150px" class="signals_return">
<col width="300px" class="signals_name">
<col width="200px" class="signals_flags">
</colgroup>
<tbody><tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="GrssFeedsSubscriber.html#GrssFeedsSubscriber-notification-received" title="The “notification-received” signal">notification-received</a></td>
<td class="signal_flags"><a href="https://developer.gnome.org/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GrssFeedsSubscriber.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="GrssFeedsSubscriber.html#GRSS-FEEDS-SUBSCRIBER-TYPE:CAPS" title="GRSS_FEEDS_SUBSCRIBER_TYPE">GRSS_FEEDS_SUBSCRIBER_TYPE</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GrssFeedsSubscriber.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
<span class="lineart">╰──</span> GrssFeedsSubscriber
</pre>
</div>
<div class="refsect1">
<a name="GrssFeedsSubscriber.description"></a><h2>Description</h2>
<p><a class="link" href="GrssFeedsSubscriber.html" title="GrssFeedsSubscriber"><span class="type">GrssFeedsSubscriber</span></a> is an alternative for <a class="link" href="GrssFeedsPool.html" title="GrssFeedsPool"><span class="type">GrssFeedsPool</span></a>, able to receive
real-time notifications by feeds managed by one of the supported protocols.
When the subscriber is executed (with <a class="link" href="GrssFeedsSubscriber.html#grss-feeds-subscriber-switch" title="grss_feeds_subscriber_switch ()"><code class="function">grss_feeds_subscriber_switch()</code></a>) it opens
a server on a local port (configurable with <a class="link" href="GrssFeedsSubscriber.html#grss-feeds-subscriber-set-port" title="grss_feeds_subscriber_set_port ()"><code class="function">grss_feeds_subscriber_set_port()</code></a>),
engage a subscription for each <a class="link" href="GrssFeedChannel.html" title="GrssFeedChannel"><span class="type">GrssFeedChannel</span></a> passed with
<a class="link" href="GrssFeedsSubscriber.html#grss-feeds-subscriber-listen" title="grss_feeds_subscriber_listen ()"><code class="function">grss_feeds_subscriber_listen()</code></a>, and waits for direct notifications by the
remote server.</p>
<p>Pay attention to the fact this object doesn't provides any NAT traversing
method to receive notification while behind a NAT.</p>
</div>
<div class="refsect1">
<a name="GrssFeedsSubscriber.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="grss-feeds-subscriber-new"></a><h3>grss_feeds_subscriber_new ()</h3>
<pre class="programlisting"><a class="link" href="GrssFeedsSubscriber.html" title="GrssFeedsSubscriber"><span class="returnvalue">GrssFeedsSubscriber</span></a> *
grss_feeds_subscriber_new ();</pre>
<p>Allocates a new <a class="link" href="GrssFeedsSubscriber.html" title="GrssFeedsSubscriber"><span class="type">GrssFeedsSubscriber</span></a>.</p>
<div class="refsect3">
<a name="id-1.5.4.8.2.5"></a><h4>Returns</h4>
<p> a new <a class="link" href="GrssFeedsSubscriber.html" title="GrssFeedsSubscriber"><span class="type">GrssFeedsSubscriber</span></a>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="grss-feeds-subscriber-listen"></a><h3>grss_feeds_subscriber_listen ()</h3>
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
grss_feeds_subscriber_listen (<em class="parameter"><code><a class="link" href="GrssFeedsSubscriber.html" title="GrssFeedsSubscriber"><span class="type">GrssFeedsSubscriber</span></a> *sub</code></em>,
<em class="parameter"><code><a href="https://developer.gnome.org/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="GrssFeedsSubscriber.html#grss-feeds-subscriber-switch" title="grss_feeds_subscriber_switch ()"><code class="function">grss_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="GrssFeedChannel.html" title="GrssFeedChannel"><span class="type">GrssFeedChannel</span></a>
are g_object_ref'd here.</p>
<div class="refsect3">
<a name="id-1.5.4.8.3.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>sub</p></td>
<td class="parameter_description"><p>a <a class="link" href="GrssFeedsSubscriber.html" title="GrssFeedsSubscriber"><span class="type">GrssFeedsSubscriber</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>feeds</p></td>
<td class="parameter_description"><p> a list of <a class="link" href="GrssFeedChannel.html" title="GrssFeedChannel"><span class="type">GrssFeedChannel</span></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GrssFeedChannel]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.5.4.8.3.6"></a><h4>Returns</h4>
<p> <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if all <a href="GrssFeedChannel.html"><span class="type">GrssFeedChannels</span></a> involved in <em class="parameter"><code>feeds</code></em>
are valid
and can be listened with one of the implemented procotols, <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="grss-feeds-subscriber-get-listened"></a><h3>grss_feeds_subscriber_get_listened ()</h3>
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
grss_feeds_subscriber_get_listened (<em class="parameter"><code><a class="link" href="GrssFeedsSubscriber.html" title="GrssFeedsSubscriber"><span class="type">GrssFeedsSubscriber</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="refsect3">
<a name="id-1.5.4.8.4.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>sub</p></td>
<td class="parameter_description"><p>a <a class="link" href="GrssFeedsSubscriber.html" title="GrssFeedsSubscriber"><span class="type">GrssFeedsSubscriber</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.5.4.8.4.6"></a><h4>Returns</h4>
<p> a
list of <a class="link" href="GrssFeedChannel.html" title="GrssFeedChannel"><span class="type">GrssFeedChannel</span></a>, to be freed with <a href="https://developer.gnome.org/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. </p>
<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GrssFeedChannel][<acronym title="Free data container after the code is done."><span class="acronym">transfer container</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="grss-feeds-subscriber-set-port"></a><h3>grss_feeds_subscriber_set_port ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
grss_feeds_subscriber_set_port (<em class="parameter"><code><a class="link" href="GrssFeedsSubscriber.html" title="GrssFeedsSubscriber"><span class="type">GrssFeedsSubscriber</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="refsect3">
<a name="id-1.5.4.8.5.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>sub</p></td>
<td class="parameter_description"><p>a <a class="link" href="GrssFeedsSubscriber.html" title="GrssFeedsSubscriber"><span class="type">GrssFeedsSubscriber</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>port</p></td>
<td class="parameter_description"><p>new listening port for the server.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="grss-feeds-subscriber-switch"></a><h3>grss_feeds_subscriber_switch ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
grss_feeds_subscriber_switch (<em class="parameter"><code><a class="link" href="GrssFeedsSubscriber.html" title="GrssFeedsSubscriber"><span class="type">GrssFeedsSubscriber</span></a> *sub</code></em>,
<em class="parameter"><code><a href="https://developer.gnome.org/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="refsect3">
<a name="id-1.5.4.8.6.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>sub</p></td>
<td class="parameter_description"><p>a <a class="link" href="GrssFeedsSubscriber.html" title="GrssFeedsSubscriber"><span class="type">GrssFeedsSubscriber</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>run</p></td>
<td class="parameter_description"><p><a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to run the subscriber, <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> to pause it.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="grss-feeds-subscriber-get-address"></a><h3>grss_feeds_subscriber_get_address ()</h3>
<pre class="programlisting"><a href="https://developer.gnome.org/gio/unstable/GInetAddress.html"><span class="returnvalue">GInetAddress</span></a> *
grss_feeds_subscriber_get_address (<em class="parameter"><code><a class="link" href="GrssFeedsSubscriber.html" title="GrssFeedsSubscriber"><span class="type">GrssFeedsSubscriber</span></a> *sub</code></em>);</pre>
<p>This function returns the Internet address where <em class="parameter"><code>sub</code></em>
is listening for
external events. It is often required by <a href="GrssFeedsSubscriberHandler.html"><span class="type">GrssFeedsSubscriberHandlers</span></a> while
subscribing contents to specify the local endpoint for communications.</p>
<div class="refsect3">
<a name="id-1.5.4.8.7.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>sub</p></td>
<td class="parameter_description"><p>a <a class="link" href="GrssFeedsSubscriber.html" title="GrssFeedsSubscriber"><span class="type">GrssFeedsSubscriber</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.5.4.8.7.6"></a><h4>Returns</h4>
<p> the <a href="https://developer.gnome.org/gio/unstable/GInetAddress.html"><span class="type">GInetAddress</span></a> used by <em class="parameter"><code>sub</code></em>
, or
<a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the <a class="link" href="GrssFeedsSubscriber.html" title="GrssFeedsSubscriber"><span class="type">GrssFeedsSubscriber</span></a> is switched off. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="grss-feeds-subscriber-get-port"></a><h3>grss_feeds_subscriber_get_port ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
grss_feeds_subscriber_get_port (<em class="parameter"><code><a class="link" href="GrssFeedsSubscriber.html" title="GrssFeedsSubscriber"><span class="type">GrssFeedsSubscriber</span></a> *sub</code></em>);</pre>
<p>This function returns the Internet port where <em class="parameter"><code>sub</code></em>
is listening for
external events. It is often required by <a href="GrssFeedsSubscriberHandler.html"><span class="type">GrssFeedsSubscriberHandlers</span></a> while
subscribing contents to specify the local endpoint for communications.</p>
<div class="refsect3">
<a name="id-1.5.4.8.8.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>sub</p></td>
<td class="parameter_description"><p>a <a class="link" href="GrssFeedsSubscriber.html" title="GrssFeedsSubscriber"><span class="type">GrssFeedsSubscriber</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.5.4.8.8.6"></a><h4>Returns</h4>
<p> the port of the socket locally opened by <em class="parameter"><code>sub</code></em>
.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="grss-feeds-subscriber-get-session"></a><h3>grss_feeds_subscriber_get_session ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/libsoup-2.4/SoupSession.html"><span class="returnvalue">SoupSession</span></a> *
grss_feeds_subscriber_get_session (<em class="parameter"><code><a class="link" href="GrssFeedsSubscriber.html" title="GrssFeedsSubscriber"><span class="type">GrssFeedsSubscriber</span></a> *sub</code></em>);</pre>
<p>To obtain the internal <a href="/usr/share/gtk-doc/html/libsoup-2.4/SoupSession.html"><span class="type">SoupSession</span></a> of a <a class="link" href="GrssFeedsSubscriber.html" title="GrssFeedsSubscriber"><span class="type">GrssFeedsSubscriber</span></a>, so to re-use
it in <a href="GrssFeedsSubscriberHandler.html"><span class="type">GrssFeedsSubscriberHandlers</span></a> or similar tasks.</p>
<div class="refsect3">
<a name="id-1.5.4.8.9.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>sub</p></td>
<td class="parameter_description"><p>a <a class="link" href="GrssFeedsSubscriber.html" title="GrssFeedsSubscriber"><span class="type">GrssFeedsSubscriber</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.5.4.8.9.6"></a><h4>Returns</h4>
<p> the <a href="/usr/share/gtk-doc/html/libsoup-2.4/SoupSession.html"><span class="type">SoupSession</span></a> used by the provided
<a class="link" href="GrssFeedsSubscriber.html" title="GrssFeedsSubscriber"><span class="type">GrssFeedsSubscriber</span></a>. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="GrssFeedsSubscriber.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GRSS-FEEDS-SUBSCRIBER-TYPE:CAPS"></a><h3>GRSS_FEEDS_SUBSCRIBER_TYPE</h3>
<pre class="programlisting">#define GRSS_FEEDS_SUBSCRIBER_TYPE (grss_feeds_subscriber_get_type())
</pre>
</div>
</div>
<div class="refsect1">
<a name="GrssFeedsSubscriber.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="GrssFeedsSubscriber-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="GrssFeedsSubscriber.html" title="GrssFeedsSubscriber"><span class="type">GrssFeedsSubscriber</span></a> *pool,
<a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *feed,
<a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *item,
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
<p>Emitted when a notification has been received and parsed. The
<em class="parameter"><code>item</code></em>
is cached and unref'd when the <a class="link" href="GrssFeedsSubscriber.html" title="GrssFeedsSubscriber"><span class="type">GrssFeedsSubscriber</span></a> is
destroyed or a new set of feeds is provided.</p>
<div class="refsect3">
<a name="id-1.5.4.10.2.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>pool</p></td>
<td class="parameter_description"><p>the <a class="link" href="GrssFeedsSubscriber.html" title="GrssFeedsSubscriber"><span class="type">GrssFeedsSubscriber</span></a> emitting the signal.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>feed</p></td>
<td class="parameter_description"><p>the <a class="link" href="GrssFeedChannel.html" title="GrssFeedChannel"><span class="type">GrssFeedChannel</span></a> which has been updated.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>item</p></td>
<td class="parameter_description"><p>the <a class="link" href="GrssFeedItem.html" title="GrssFeedItem"><span class="type">GrssFeedItem</span></a> received.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: <a href="https://developer.gnome.org/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>
|