|
|
|
libgrss Reference Manual | |
|---|---|---|---|---|
| Top | Description | Object Hierarchy | ||||
struct GrssFeedsStore; GList * grss_feeds_store_get_channels (GrssFeedsStore *store); GList * grss_feeds_store_get_items_by_channel (GrssFeedsStore *store,GrssFeedChannel *channel); gboolean grss_feeds_store_has_item (GrssFeedsStore *store,GrssFeedChannel *channel,const gchar *id); void grss_feeds_store_add_item_in_channel (GrssFeedsStore *store,GrssFeedChannel *channel,GrssFeedItem *item); void grss_feeds_store_switch (GrssFeedsStore *store,gboolean run);
GrssFeedsStore is a class which abstracts storage of feeds, implementing some behaviours valid for all. Extensions of this must provide implementation of different callbacks so to permit permanent saving of channels and feeds.
GList * grss_feeds_store_get_channels (GrssFeedsStore *store);
To retrieve list of feeds permanently saved into the store.
|
a GrssFeedsStore. |
Returns : |
list of GrssFeedChannel found in the store. Do not modify or
free it. |
GList * grss_feeds_store_get_items_by_channel (GrssFeedsStore *store,GrssFeedChannel *channel);
To retrieve list of items saved into the store, assigned to the given
channel.
|
a GrssFeedsStore. |
|
parent feed containing required items. |
Returns : |
list of GrssFeedItem found in the store. Do not modify or free
it. |
gboolean grss_feeds_store_has_item (GrssFeedsStore *store,GrssFeedChannel *channel,const gchar *id);
To retrieve an item into a feed, given his unique ID.
|
a GrssFeedsStore. |
|
parent feed containing required item. |
|
unique ID to look for. |
Returns : |
TRUE if the specified item exists, FALSE otherwise. |
void grss_feeds_store_add_item_in_channel (GrssFeedsStore *store,GrssFeedChannel *channel,GrssFeedItem *item);
To save a new GrssFeedItem into the store. It performs a check to grant
item is not already saved.
|
a GrssFeedsStore. |
|
parent feed for the new item. |
|
new item to permanently save. |
void grss_feeds_store_switch (GrssFeedsStore *store,gboolean run);
This is to permit the store to auto-update itself: it creates an internal
GrssFeedsPool and listens for his signals, so to implement the whole loop
fetch-parse-save trasparently.
|
a GrssFeedsStore. |
|
TRUE to run the store, FALSE to stop. |
|
|
|
libgrss Reference Manual | |
|---|---|---|---|---|
| Top | Description | Object Hierarchy | Signals | ||||
struct GrssFeedsSubscriber; GrssFeedsSubscriber * grss_feeds_subscriber_new (); gboolean grss_feeds_subscriber_listen (GrssFeedsSubscriber *sub,GList *feeds); GList * grss_feeds_subscriber_get_listened (GrssFeedsSubscriber *sub); void grss_feeds_subscriber_set_port (GrssFeedsSubscriber *sub,int port); void grss_feeds_subscriber_switch (GrssFeedsSubscriber *sub,gboolean run); GInetAddress * grss_feeds_subscriber_get_address (GrssFeedsSubscriber *sub); int grss_feeds_subscriber_get_port (GrssFeedsSubscriber *sub); SoupSession * grss_feeds_subscriber_get_session (GrssFeedsSubscriber *sub);
GrssFeedsSubscriber is an alternative for GrssFeedsPool, able to receive
real-time notifications by feeds managed by one of the supported protocols.
When the subscriber is executed (with grss_feeds_subscriber_switch()) it opens
a server on a local port (configurable with grss_feeds_subscriber_set_port()),
engage a subscription for each GrssFeedChannel passed with
grss_feeds_subscriber_listen(), and waits for direct notifications by the
remote server.
Pay attention to the fact this object doesn't provides any NAT traversing method to receive notification while behind a NAT.
GrssFeedsSubscriber * grss_feeds_subscriber_new ();
Allocates a new GrssFeedsSubscriber.
Returns : |
a new GrssFeedsSubscriber. |
gboolean grss_feeds_subscriber_listen (GrssFeedsSubscriber *sub,GList *feeds);
To set the list of feeds to be managed by sub. The previous list, if any,
is invalidated. After invokation to the function, grss_feeds_subscriber_switch()
must be call to run the subscription.
The list in feeds can be freed after calling this; linked GrssFeedChannel
are g_object_ref'd here.
|
a GrssFeedsSubscriber. |
|
a list of GrssFeedChannel. |
Returns : |
TRUE if all GrssFeedChannels involved in feeds are valid
and can be listened with one of the implemented procotols, FALSE otherwise. |
GList * grss_feeds_subscriber_get_listened (GrssFeedsSubscriber *sub);
Returns the list of feeds currently managed by sub.
|
a GrssFeedsSubscriber. |
Returns : |
a list of GrssFeedChannel, to be freed with g_list_free() when
no longer in use. Do not modify elements found in this list. |
void grss_feeds_subscriber_set_port (GrssFeedsSubscriber *sub,int port);
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.
|
a GrssFeedsSubscriber. |
|
new listening port for the server. |
void grss_feeds_subscriber_switch (GrssFeedsSubscriber *sub,gboolean run);
Permits to pause or resume sub listening for events.
|
a GrssFeedsSubscriber. |
|
TRUE to run the subscriber, FALSE to pause it. |
GInetAddress * grss_feeds_subscriber_get_address (GrssFeedsSubscriber *sub);
This function returns the Internet address where sub is listening for
external events. It is often required by GrssFeedsSubscriberHandlers while
subscribing contents to specify the local endpoint for communications.
|
a GrssFeedsSubscriber. |
Returns : |
the GInetAddress used by sub, or NULL if the
GrssFeedsSubscriber is switched off. |
int grss_feeds_subscriber_get_port (GrssFeedsSubscriber *sub);
This function returns the Internet port where sub is listening for
external events. It is often required by GrssFeedsSubscriberHandlers while
subscribing contents to specify the local endpoint for communications.
|
a GrssFeedsSubscriber. |
Returns : |
the port of the socket locally opened by sub. |
SoupSession * grss_feeds_subscriber_get_session (GrssFeedsSubscriber *sub);
To obtain the internal SoupSession of a GrssFeedsSubscriber, so to re-use it in GrssFeedsSubscriberHandlers or similar tasks.
|
a GrssFeedsSubscriber. |
Returns : |
the SoupSession used by the provided GrssFeedsSubscriber. |
"notification-received" signalvoid user_function (GrssFeedsSubscriber *pool,
GObject *feed,
GObject *item,
gpointer user_data) : Run Last
Emitted when a notification has been received and parsed. The
item is cached and unref'd when the GrssFeedsSubscriber is
destroyed or a new set of feeds is provided.
|
the GrssFeedsSubscriber emitting the signal. |
|
the GrssFeedChannel which has been updated. |
|
the GrssFeedItem received. |
|
user data set when the signal handler was connected. |
|
|
|
libgrss Reference Manual | |
|---|---|---|---|---|
| Top | Description | Object Hierarchy | ||||
struct GrssFeedsGroup; GrssFeedsGroup * grss_feeds_group_new (); GList * grss_feeds_group_get_formats (GrssFeedsGroup *group); GList * grss_feeds_group_parse_file (GrssFeedsGroup *group,const gchar *path,GError **error); gboolean grss_feeds_group_export_file (GrssFeedsGroup *group,GList *channels,const gchar *format,const gchar *uri,GError **error);
GrssFeedsGroup is an utility to read and write lists of GrssFeedChannels in different formats, such as OPML and XOXO.
GrssFeedsGroup * grss_feeds_group_new ();
Allocates a new GrssFeedsGroup.
Returns : |
a new GrssFeedsGroup. |
GList * grss_feeds_group_get_formats (GrssFeedsGroup *group);
Returns the list of supported file formats.
|
a GrssFeedsGroup. |
Returns : |
a list of constant strings with names of supported formats. The list must be freed when no longer used |
GList * grss_feeds_group_parse_file (GrssFeedsGroup *group,const gchar *path,GError **error);
Parses the given file to obtain list of listed feeds.
|
a GrssFeedsGroup. |
|
path of the file to parse. |
|
location for eventual errors. |
Returns : |
a list of GrssFeedChannels, or NULL if an error occours and
error is set. |
gboolean grss_feeds_group_export_file (GrssFeedsGroup *group,GList *channels,const gchar *format,const gchar *uri,GError **error);
Creates a new file with the list of channels rappresented in the required
format. It a file already exists at the uri location, it is overwritten.
|
a GrssFeedsGroup. |
|
list of GrssFeedChannels. |
|
string rappresenting the desired export format, as returnes by
grss_feeds_group_get_formats(). |
|
URI of the file to write. |
|
location for eventual errors. |
Returns : |
TRUE if the file is created correctly, or FALSE if an error
occours and error is set. |
|
|
libgrss Reference Manual | |
|---|
Table of Contents
libgrss Reference Manual |
|---|
Version 0.5.0
|
|
libgrss Reference Manual | |
|---|
libgrss is a GObject library intended to be used to manage syndication feeds in convenient way.
|
|
|
libgrss Reference Manual | |
|---|---|---|---|---|
| Top | Description | Object Hierarchy | ||||
struct GrssFeedEnclosure; GrssFeedEnclosure * grss_feed_enclosure_new (gchar *url); const gchar * grss_feed_enclosure_get_url (GrssFeedEnclosure *enclosure); void grss_feed_enclosure_set_format (GrssFeedEnclosure *enclosure,gchar *type); const gchar * grss_feed_enclosure_get_format (GrssFeedEnclosure *enclosure); void grss_feed_enclosure_set_length (GrssFeedEnclosure *enclosure,gsize length); gsize grss_feed_enclosure_get_length (GrssFeedEnclosure *enclosure);
GrssFeedEnclosure describes an external element embedded into a GrssFeedItem: it may be an image, a video of other kind of file to be presented with the parent item.
GrssFeedEnclosure * grss_feed_enclosure_new (gchar *url);
Allocates a new GrssFeedEnclosure, to be downloaded separately.
|
URL of the external element. |
Returns : |
a new GrssFeedEnclosure. |
const gchar * grss_feed_enclosure_get_url (GrssFeedEnclosure *enclosure);
Retrieves the URL of the enclosure.
|
a GrssFeedEnclosure. |
Returns : |
the URL where the enclosure may be found. |
void grss_feed_enclosure_set_format (GrssFeedEnclosure *enclosure,gchar *type);
To set the type of the external file.
|
a GrssFeedEnclosure. |
|
type of content. |
const gchar * grss_feed_enclosure_get_format (GrssFeedEnclosure *enclosure);
Retrieves the format of the enclosed file.
|
a GrssFeedEnclosure. |
Returns : |
type of enclosure. |
void grss_feed_enclosure_set_length (GrssFeedEnclosure *enclosure,gsize length);
To set the size of the embedded enclosure.
|
a GrssFeedEnclosure. |
|
size of the enclosure, in bytes. |
gsize grss_feed_enclosure_get_length (GrssFeedEnclosure *enclosure);
Retrieves the size of the embedded file.
|
a GrssFeedEnclosure. |
Returns : |
size of the enclosure, in bytes. |
|
|
|
libgrss Reference Manual | |
|---|---|---|---|---|
| Top | Description | Object Hierarchy | Signals | ||||
struct GrssFeedsPublisher; GrssFeedsPublisher * grss_feeds_publisher_new (); gchar * grss_feeds_publisher_format_content (GrssFeedsPublisher *pub,GrssFeedChannel *channel,GList *items,GError **error); gboolean grss_feeds_publisher_publish_web (GrssFeedsPublisher *pub,GrssFeedChannel *channel,GList *items,const gchar *id,GError **error); gboolean grss_feeds_publisher_publish_file (GrssFeedsPublisher *pub,GrssFeedChannel *channel,GList *items,const gchar *uri,GError **error); void grss_feeds_publisher_hub_set_port (GrssFeedsPublisher *pub,int port); void grss_feeds_publisher_hub_set_topics (GrssFeedsPublisher *pub,GList *topics); void grss_feeds_publisher_hub_switch (GrssFeedsPublisher *pub,gboolean run);
GrssFeedsPublisher may be used to expose contents for any given GrssFeedChannel, both writing a file to be dispatched by the local webserver or providing himself to distribute it, and implements a server able to receive subscriptions by PubSubHubbub clients and deliver them new contents in real-time.
GrssFeedsPublisher * grss_feeds_publisher_new ();
Allocates a new GrssFeedsPublisher.
Returns : |
a new GrssFeedsPublisher. |
gchar * grss_feeds_publisher_format_content (GrssFeedsPublisher *pub,GrssFeedChannel *channel,GList *items,GError **error);
Format a GrssFeedChannel in Atom and returns the resulting string.
|
a GrssFeedsPublisher. |
|
the GrssFeedChannel to dump in the file. |
|
list of GrssFeedItems to be added in the feed. |
|
if an error occourred, NULL is returned and this is filled with the
message. |
Returns : |
a newly allocated string holding the formatted feed, to be freed when no longer in use. |
gboolean grss_feeds_publisher_publish_web (GrssFeedsPublisher *pub,GrssFeedChannel *channel,GList *items,const gchar *id,GError **error);
If the local web server has been executed (with
grss_feeds_publisher_hub_switch()) this function exposes the given channel
as an Atom formatted file avalable to http://[LOCAL_IP:DEFINED_PORT]/id .
|
a GrssFeedsPublisher. |
|
the GrssFeedChannel to dump in the file. |
|
list of GrssFeedItems to be added in the feed. |
|
name used in the external URL of the feed. |
|
if an error occourred, FALSE is returned and this is filled with the
message. |
Returns : |
TRUE if the file is successfully written, FALSE otherwise. |
gboolean grss_feeds_publisher_publish_file (GrssFeedsPublisher *pub,GrssFeedChannel *channel,GList *items,const gchar *uri,GError **error);
Dump the given channel in an Atom formatted file in path. If the local
PubSubHubbub hub has been activated (with grss_feeds_publisher_hub_switch())
notifies remote subscribers about the new items which has been added since
previous invocation of this function for the same GrssFeedChannel.
|
a GrssFeedsPublisher. |
|
the GrssFeedChannel to dump in the file. |
|
list of GrssFeedItems to be added in the feed. |
|
URI of the file to write. The full path must exists. |
|
if an error occourred, FALSE is returned and this is filled with the
message. |
Returns : |
TRUE if the file is successfully written, FALSE otherwise. |
void grss_feeds_publisher_hub_set_port (GrssFeedsPublisher *pub,int port);
To customize the port opened by the local server to deliver feeds and catch incoming subscriptions. By default this is 80. Changing the port while the hub is running imply restart the local server.
|
a GrssFeedsPublisher. |
|
new listening port for the server. |
void grss_feeds_publisher_hub_set_topics (GrssFeedsPublisher *pub,GList *topics);
To define a list of valid "topics" for which the GrssFeedsPublisher will
deliver contents. Sources of those channels, as retrieved by
grss_feed_channel_get_source(), are accepted as "hub.topic" parameter in
PubSubHubbub registration requests from remote subscribers.
Pay attention to the fact subscriptions requests for different topic are
now rejected.
|
a GrssFeedsPublisher. |
|
a list of GrssFeedChannels. |
void grss_feeds_publisher_hub_switch (GrssFeedsPublisher *pub,gboolean run);
Permits to start and stop the webserver implemented by this object.
|
a GrssFeedsPublisher. |
|
TRUE to run the local server, FALSE to stop it. |
"delete-subscription" signalvoid user_function (GrssFeedsPublisher *grssfeedspublisher,
GrssFeedChannel *arg1,
gchar *arg2,
gpointer user_data) : Run Last
|
the object which received the signal. |
|
user data set when the signal handler was connected. |
"new-subscription" signalvoid user_function (GrssFeedsPublisher *grssfeedspublisher,
GrssFeedChannel *arg1,
gchar *arg2,
gpointer user_data) : Run Last
|
the object which received the signal. |
|
user data set when the signal handler was connected. |
|
|
|
libgrss Reference Manual | |
|---|---|---|---|---|
| Top | Description | Object Hierarchy | ||||
struct GrssFeedParser; GrssFeedParser * grss_feed_parser_new (); GList * grss_feed_parser_parse (GrssFeedParser *parser,GrssFeedChannel *feed,xmlDocPtr doc,GError **error);
The GrssFeedParser is a wrapper to the many handlers available: given a GrssFeedChannel provides to identify his type and invoke the correct parser.
GrssFeedParser * grss_feed_parser_new ();
Allocates a new GrssFeedParser.
Returns : |
a new GrssFeedParser. |
GList * grss_feed_parser_parse (GrssFeedParser *parser,GrssFeedChannel *feed,xmlDocPtr doc,GError **error);
Parses the given XML doc, belonging to the given feed, to obtain a list
of GrssFeedItem.
|
a GrssFeedParser. |
|
a GrssFeedChannel to be parsed. |
|
XML document extracted from the contents of the feed, which must already been fetched. |
|
location for eventual errors. |
Returns : |
a list of GrssFeedItem, to be freed when no longer in use, or
NULL if an error occours and error is set. |
|
|
libgrss Reference Manual | |
|---|
|
|
|
libgrss Reference Manual | |
|---|---|---|---|---|
| Top | Description | Object Hierarchy | ||||
struct GrssFeedItem; GrssFeedItem * grss_feed_item_new (GrssFeedChannel *parent); GrssFeedChannel * grss_feed_item_get_parent (GrssFeedItem *item); void grss_feed_item_set_id (GrssFeedItem *item,gchar *id); const gchar * grss_feed_item_get_id (GrssFeedItem *item); void grss_feed_item_set_title (GrssFeedItem *item,gchar *title); const gchar * grss_feed_item_get_title (GrssFeedItem *item); void grss_feed_item_set_description (GrssFeedItem *item,gchar *description); const gchar * grss_feed_item_get_description (GrssFeedItem *item); void grss_feed_item_add_category (GrssFeedItem *item,gchar *category); const GList * grss_feed_item_get_categories (GrssFeedItem *item); void grss_feed_item_set_source (GrssFeedItem *item,gchar *source); const gchar * grss_feed_item_get_source (GrssFeedItem *item); void grss_feed_item_set_real_source (GrssFeedItem *item,gchar *realsource,gchar *title); void grss_feed_item_get_real_source (GrssFeedItem *item,const gchar **realsource,const gchar **title); void grss_feed_item_set_related (GrssFeedItem *item,gchar *related); const gchar * grss_feed_item_get_related (GrssFeedItem *item); void grss_feed_item_set_copyright (GrssFeedItem *item,gchar *copyright); const gchar * grss_feed_item_get_copyright (GrssFeedItem *item); void grss_feed_item_set_author (GrssFeedItem *item,gchar *author); const gchar * grss_feed_item_get_author (GrssFeedItem *item); void grss_feed_item_add_contributor (GrssFeedItem *item,gchar *contributor); const GList * grss_feed_item_get_contributors (GrssFeedItem *item); void grss_feed_item_set_comments_url (GrssFeedItem *item,gchar *url); const gchar * grss_feed_item_get_comments_url (GrssFeedItem *item); void grss_feed_item_set_geo_point (GrssFeedItem *item,double latitude,double longitude); gboolean grss_feed_item_get_geo_point (GrssFeedItem *item,double *latitude,double *longitude); void grss_feed_item_set_publish_time (GrssFeedItem *item,time_t publish); time_t grss_feed_item_get_publish_time (GrssFeedItem *item); void grss_feed_item_add_enclosure (GrssFeedItem *item,GrssFeedEnclosure *enclosure); const GList * grss_feed_item_get_enclosures (GrssFeedItem *item);
GrssFeedItem is an abstraction for an item, collects all information about a single element found into a feed. It mostly is a passive container for attributes.
GrssFeedItem * grss_feed_item_new (GrssFeedChannel *parent);
To allocate a new empty GrssFeedItem.
|
the feed from which the new item belongs. |
Returns : |
a new GrssFeedItem. |
GrssFeedChannel * grss_feed_item_get_parent (GrssFeedItem *item);
Retrieves the feed from which the item belongs.
|
a GrssFeedItem. |
Returns : |
the parent feed, as set in grss_feed_item_new(). |
void grss_feed_item_set_id (GrssFeedItem *item,gchar *id);
To set the ID of the item. This parameter has not a particular format: it
is just a string used to identify in unique way the item.
|
a GrssFeedItem. |
|
the new ID to set. |
const gchar * grss_feed_item_get_id (GrssFeedItem *item);
Retrieves the ID assigned to the item. If no ID was set with
grss_feed_item_set_id() this returns the same of grss_feed_item_get_source().
Pay attention to the fact this library do not check uniqueness of assigned
IDs.
|
GrssFeedItem from which retrieve the ID. |
Returns : |
ID of the item. |
void grss_feed_item_set_title (GrssFeedItem *item,gchar *title);
To set a title to the item.
|
a GrssFeedItem. |
|
title of the item. |
const gchar * grss_feed_item_get_title (GrssFeedItem *item);
Retrieves the title assigned to item.
|
a GrssFeedItem. |
Returns : |
title of the element. |
void grss_feed_item_set_description (GrssFeedItem *item,gchar *description);
To set the description of item. Usually "description" means his content.
|
a GrssFeedItem. |
|
content of the item. |
const gchar * grss_feed_item_get_description (GrssFeedItem *item);
Retrieves the description of the item.
|
a GrssFeedItem. |
Returns : |
description of item. |
void grss_feed_item_add_category (GrssFeedItem *item,gchar *category);
Adds a category to the item. The complete list can be obtained with
grss_feed_item_get_categories().
|
a GrssFeedItem. |
|
a new category to assign to the item. |
const GList * grss_feed_item_get_categories (GrssFeedItem *item);
Retrieves list of categories assigned to the item.
|
a GrssFeedItem. |
Returns : |
list of strings, one for assigned category. Do not free or modify this list. |
void grss_feed_item_set_source (GrssFeedItem *item,gchar *source);
To set the source of the item.
|
a GrssFeedItem. |
|
URL of the item. |
const gchar * grss_feed_item_get_source (GrssFeedItem *item);
Retrieves the URL where the item can be found.
|
a GrssFeedItem. |
Returns : |
URL of the item, or NULL. |
void grss_feed_item_set_real_source (GrssFeedItem *item,gchar *realsource,gchar *title);
To set an alternative real source for item. This parameter is used by web
aggregators to explicit the origin of a content reproduced in them.
|
a GrssFeedItem. |
|
URL of the real source for the item. |
|
title of the real source. |
void grss_feed_item_get_real_source (GrssFeedItem *item,const gchar **realsource,const gchar **title);
Retrieves references to the real source of item.
|
a GrssFeedItem. |
|
will be assigned to the URL of the real source, or NULL. |
|
will be assigned to the title of the real source, or NULL. |
void grss_feed_item_set_related (GrssFeedItem *item,gchar *related);
To set reference to a post related to item.
|
a GrssFeedItem. |
|
reference to a related post. |
const gchar * grss_feed_item_get_related (GrssFeedItem *item);
Retrieves indication about posts related to item.
|
a GrssFeedItem. |
Returns : |
related posts, or NULL. |
void grss_feed_item_set_copyright (GrssFeedItem *item,gchar *copyright);
To set a copyright reference to item.
|
a GrssFeedItem. |
|
copyright declaration for the item. |
const gchar * grss_feed_item_get_copyright (GrssFeedItem *item);
Retrieves copyright reference for the item.
|
a GrssFeedItem. |
Returns : |
copyright mark, or NULL. |
void grss_feed_item_set_author (GrssFeedItem *item,gchar *author);
To assign an author to the item.
|
a GrssFeedItem. |
|
name of the author. |
const gchar * grss_feed_item_get_author (GrssFeedItem *item);
Retrieves the author of item.
|
a GrssFeedItem. |
Returns : |
author of the item, or NULL. |
void grss_feed_item_add_contributor (GrssFeedItem *item,gchar *contributor);
To add a contributor to the item.
|
a GrssFeedItem. |
|
name of the contributor for the item. |
const GList * grss_feed_item_get_contributors (GrssFeedItem *item);
Retrieves contributors for item.
|
a GrssFeedItem. |
Returns : |
list of contributors to the item. |
void grss_feed_item_set_comments_url (GrssFeedItem *item,gchar *url);
To assign the URL where to fetch comments for the item.
|
a GrssFeedItem. |
|
URL where to retrieve comments to the item. |
const gchar * grss_feed_item_get_comments_url (GrssFeedItem *item);
Retrieves the URL where to catch comments to the item.
|
a GrssFeedItem. |
Returns : |
URL to parse to read comments for item, or NULL. |
void grss_feed_item_set_geo_point (GrssFeedItem *item,double latitude,double longitude);
To assign geographic context to the item.
Passing -1 as latitude or longitude, the relative value is untouched in
the object. This is to easy assignment of coordinates in more than a
single step. If both are -1, nothing happens.
|
a GrssFeedItem. |
|
latitude of the point, or -1 to leave the previous one. |
|
longitude of the point, or -1 to leave the previous one. |
gboolean grss_feed_item_get_geo_point (GrssFeedItem *item,double *latitude,double *longitude);
Retrieves the geo reference of the item.
|
a GrssFeedItem. |
|
will be assigned to the latitude of the point, or NULL. |
|
will be assigned to the longitude of the point, or NULL. |
Returns : |
TRUE if item has geographic coordinates assigned and
latitude and longitude have been set, FALSE if item has not geo
reference. |
void grss_feed_item_set_publish_time (GrssFeedItem *item,time_t publish);
To set the publish time of the item.
|
a GrssFeedItem. |
|
publishing timestamp of the item. |
time_t grss_feed_item_get_publish_time (GrssFeedItem *item);
Retrieves the publish time of the item. By default this value is the
current timestamp assigned when creating the GrssFeedItem, and may be
changed with grss_feed_item_set_publish_time().
|
a GrssFeedItem. |
Returns : |
publish time of item. |
void grss_feed_item_add_enclosure (GrssFeedItem *item,GrssFeedEnclosure *enclosure);
Adds an enclosure to the item. That external elements may be references
to images, videos, or other contents (usually multimedial) embedded in the
element.
|
a GrssFeedItem. |
|
a GrssFeedEnclosure to add to the item. |
const GList * grss_feed_item_get_enclosures (GrssFeedItem *item);
Retrieves the list of enclosures added with grss_feed_item_add_enclosure().
|
a GrssFeedItem. |
Returns : |
a list of GrssFeedEnclosure. This is a direct reference to the internal list, do not free or modify it. |
|
|
|
libgrss Reference Manual | |
|---|---|---|---|---|
| Top | Description | Object Hierarchy | ||||
struct GrssFeedChannel; GrssFeedChannel * grss_feed_channel_new (); GrssFeedChannel * grss_feed_channel_new_with_source (gchar *source); GrssFeedChannel * grss_feed_channel_new_from_file (const gchar *path,GError **error); void grss_feed_channel_set_format (GrssFeedChannel *channel,gchar *format); const gchar * grss_feed_channel_get_format (GrssFeedChannel *channel); void grss_feed_channel_set_source (GrssFeedChannel *channel,gchar *source); const gchar * grss_feed_channel_get_source (GrssFeedChannel *channel); void grss_feed_channel_set_title (GrssFeedChannel *channel,gchar *title); const gchar * grss_feed_channel_get_title (GrssFeedChannel *channel); void grss_feed_channel_set_homepage (GrssFeedChannel *channel,gchar *homepage); const gchar * grss_feed_channel_get_homepage (GrssFeedChannel *channel); void grss_feed_channel_set_description (GrssFeedChannel *channel,gchar *description); const gchar * grss_feed_channel_get_description (GrssFeedChannel *channel); void grss_feed_channel_set_image (GrssFeedChannel *channel,gchar *image); const gchar * grss_feed_channel_get_image (GrssFeedChannel *channel); void grss_feed_channel_set_icon (GrssFeedChannel *channel,gchar *icon); const gchar * grss_feed_channel_get_icon (GrssFeedChannel *channel); void grss_feed_channel_set_language (GrssFeedChannel *channel,gchar *language); const gchar * grss_feed_channel_get_language (GrssFeedChannel *channel); void grss_feed_channel_set_category (GrssFeedChannel *channel,gchar *category); const gchar * grss_feed_channel_get_category (GrssFeedChannel *channel); void grss_feed_channel_set_pubsubhub (GrssFeedChannel *channel,gchar *hub); gboolean grss_feed_channel_get_pubsubhub (GrssFeedChannel *channel,gchar **hub); void grss_feed_channel_set_rsscloud (GrssFeedChannel *channel,gchar *path,gchar *protocol); gboolean grss_feed_channel_get_rsscloud (GrssFeedChannel *channel,gchar **path,gchar **protocol); void grss_feed_channel_set_copyright (GrssFeedChannel *channel,gchar *copyright); const gchar * grss_feed_channel_get_copyright (GrssFeedChannel *channel); void grss_feed_channel_set_editor (GrssFeedChannel *channel,gchar *editor); const gchar * grss_feed_channel_get_editor (GrssFeedChannel *channel); void grss_feed_channel_add_contributor (GrssFeedChannel *channel,gchar *contributor); const GList * grss_feed_channel_get_contributors (GrssFeedChannel *channel); void grss_feed_channel_set_webmaster (GrssFeedChannel *channel,gchar *webmaster); const gchar * grss_feed_channel_get_webmaster (GrssFeedChannel *channel); void grss_feed_channel_set_generator (GrssFeedChannel *channel,gchar *generator); const gchar * grss_feed_channel_get_generator (GrssFeedChannel *channel); void grss_feed_channel_set_publish_time (GrssFeedChannel *channel,time_t publish); time_t grss_feed_channel_get_publish_time (GrssFeedChannel *channel); void grss_feed_channel_set_update_time (GrssFeedChannel *channel,time_t update); time_t grss_feed_channel_get_update_time (GrssFeedChannel *channel); void grss_feed_channel_set_update_interval (GrssFeedChannel *channel,int minutes); int grss_feed_channel_get_update_interval (GrssFeedChannel *channel); gboolean grss_feed_channel_fetch (GrssFeedChannel *channel,GError **error); void grss_feed_channel_fetch_async (GrssFeedChannel *channel,GAsyncReadyCallback callback,gpointer user_data); gboolean grss_feed_channel_fetch_finish (GrssFeedChannel *channel,GAsyncResult *res,GError **error); GList * grss_feed_channel_fetch_all (GrssFeedChannel *channel,GError **error); void grss_feed_channel_fetch_all_async (GrssFeedChannel *channel,GAsyncReadyCallback callback,gpointer user_data); GList * grss_feed_channel_fetch_all_finish (GrssFeedChannel *channel,GAsyncResult *res,GError **error);
GrssFeedChannel rappresents a single feed which may be fetched and parsed. It mostly is a passive container for attributes.
GrssFeedChannel * grss_feed_channel_new ();
Allocates a new GrssFeedChannel.
Returns : |
a GrssFeedChannel. |
GrssFeedChannel * grss_feed_channel_new_with_source (gchar *source);
Allocates a new GrssFeedChannel and assign it the given remote source.
|
URL of the feed. |
Returns : |
a GrssFeedChannel. |
GrssFeedChannel * grss_feed_channel_new_from_file (const gchar *path,GError **error);
Allocates a new GrssFeedChannel and init it with contents found in specified file.
|
path of the file to parse. |
|
if an error occourred, NULL is returned and this is filled with the
message. |
Returns : |
a GrssFeedChannel, or NULL if the file in path is not a
valid document. |
void grss_feed_channel_set_format (GrssFeedChannel *channel,gchar *format);
To assign a file format to the feed.
|
a GrssFeedChannel. |
|
format of the file, such as "application/atom+xml" or "application/rss+xml". |
const gchar * grss_feed_channel_get_format (GrssFeedChannel *channel);
Retrieves the file format of channel.
|
a GrssFeedChannel. |
Returns : |
file format of channel. |
void grss_feed_channel_set_source (GrssFeedChannel *channel,gchar *source);
To assign the URL where to fetch the feed.
|
a GrssFeedChannel. |
|
URL of the feed. |
const gchar * grss_feed_channel_get_source (GrssFeedChannel *channel);
Retrieves URL where to fetch the channel.
|
a GrssFeedChannel. |
Returns : |
URL of the channel. |
void grss_feed_channel_set_title (GrssFeedChannel *channel,gchar *title);
To set a title to the channel.
|
a GrssFeedChannel. |
|
title of the feed. |
const gchar * grss_feed_channel_get_title (GrssFeedChannel *channel);
Retrieves title of the channel.
|
a GrssFeedChannel. |
Returns : |
title of the feed, or NULL. |
void grss_feed_channel_set_homepage (GrssFeedChannel *channel,gchar *homepage);
To set the homepage of the site the channel belongs.
|
a GrssFeedChannel. |
|
homepage for the main website. |
const gchar * grss_feed_channel_get_homepage (GrssFeedChannel *channel);
Retrieves the homepage of the site for which channel is the feed.
|
a GrssFeedChannel. |
Returns : |
reference homepage of the feed, or NULL. |
void grss_feed_channel_set_description (GrssFeedChannel *channel,gchar *description);
To set the description of channel.
|
a GrssFeedChannel. |
|
description of the feed. |
const gchar * grss_feed_channel_get_description (GrssFeedChannel *channel);
Retrieves the description of channel.
|
a GrssFeedChannel. |
Returns : |
description of the feed, or NULL. |
void grss_feed_channel_set_image (GrssFeedChannel *channel,gchar *image);
To set a rappresentative image to channel.
|
a GrssFeedChannel. |
|
URL of the image. |
const gchar * grss_feed_channel_get_image (GrssFeedChannel *channel);
Retrieves the URL of the image assigned to the channel.
|
a GrssFeedChannel. |
Returns : |
URL of the image, or NULL. |
void grss_feed_channel_set_icon (GrssFeedChannel *channel,gchar *icon);
To set the URL of the icon rappresenting channel.
|
a GrssFeedChannel. |
|
URL where to retrieve the favicon. |
const gchar * grss_feed_channel_get_icon (GrssFeedChannel *channel);
Retrieves URL of the favicon of the channel (and/or the website for which this is the feed).
|
a GrssFeedChannel. |
Returns : |
URL of the favicon, or NULL. |
void grss_feed_channel_set_language (GrssFeedChannel *channel,gchar *language);
To set the language of channel.
|
a GrssFeedChannel. |
|
string holding the language of the feed. |
const gchar * grss_feed_channel_get_language (GrssFeedChannel *channel);
Retrieves the language of the channel.
|
a GrssFeedChannel. |
Returns : |
string rappresenting the language of channel, or NULL. |
void grss_feed_channel_set_category (GrssFeedChannel *channel,gchar *category);
To set the category of the channel.
|
a GrssFeedChannel. |
|
category of the feed. |
const gchar * grss_feed_channel_get_category (GrssFeedChannel *channel);
Retrieves category of the channel.
|
a GrssFeedChannel. |
Returns : |
category of the feed, or NULL. |
void grss_feed_channel_set_pubsubhub (GrssFeedChannel *channel,gchar *hub);
To set information about PubSubHubbub for the channel. To unset the hub,
pass NULL as parameter.
|
a GrssFeedChannel. |
|
hub for the feed, or NULL. |
gboolean grss_feed_channel_get_pubsubhub (GrssFeedChannel *channel,gchar **hub);
Retrieves information about the PubSubHubbub hub of the channel.
|
a GrssFeedChannel. |
|
location for the hub string, or NULL. |
Returns : |
TRUE if a valid PubSubHubbub hub has been set for the
channel, FALSE otherwise. |
void grss_feed_channel_set_rsscloud (GrssFeedChannel *channel,gchar *path,gchar *protocol);
To set information about RSSCloud notifications for the channel.
|
a GrssFeedChannel. |
|
complete references of the URL where to register subscription, e.g. http://example.com/rsscloudNotify . |
|
type of protocol used for notifications. |
gboolean grss_feed_channel_get_rsscloud (GrssFeedChannel *channel,gchar **path,gchar **protocol);
Retrieves information about the RSSCloud coordinates of the channel.
|
a GrssFeedChannel. |
|
location for the path string, or NULL. |
|
location for the protocol string, or NULL. |
Returns : |
TRUE if a valid RSSCloud path has been set for the
channel, FALSE otherwise. |
void grss_feed_channel_set_copyright (GrssFeedChannel *channel,gchar *copyright);
To set the copyright of the feed.
|
a GrssFeedChannel. |
|
copyright of the channel. |
const gchar * grss_feed_channel_get_copyright (GrssFeedChannel *channel);
Retrieves indications about the copyright.
|
a GrssFeedChannel. |
Returns : |
copyright of the channel, or NULL. |
void grss_feed_channel_set_editor (GrssFeedChannel *channel,gchar *editor);
To set the editor of the channel.
|
a GrssFeedChannel. |
|
editor of the feed. |
const gchar * grss_feed_channel_get_editor (GrssFeedChannel *channel);
Retrieves reference to the editor or the channel.
|
a GrssFeedChannel. |
Returns : |
editor of the feed, or NULL. |
void grss_feed_channel_add_contributor (GrssFeedChannel *channel,gchar *contributor);
To add a contributor to the channel.
|
a GrssFeedChannel. |
|
contributor of the feed. |
const GList * grss_feed_channel_get_contributors (GrssFeedChannel *channel);
Retrieves reference to the contributors of the channel.
|
a GrssFeedChannel. |
Returns : |
list of contributors to the channel, or NULL. |
void grss_feed_channel_set_webmaster (GrssFeedChannel *channel,gchar *webmaster);
To assign a webmaster to the channel.
|
a GrssFeedChannel. |
|
webmaster of the feed. |
const gchar * grss_feed_channel_get_webmaster (GrssFeedChannel *channel);
Retrieves reference to the webmaster of the feed.
|
a GrssFeedChannel. |
Returns : |
webmaster of channel, or NULL. |
void grss_feed_channel_set_generator (GrssFeedChannel *channel,gchar *generator);
To set information about the software generator of channel.
|
a GrssFeedChannel. |
|
software generator of the feed. |
const gchar * grss_feed_channel_get_generator (GrssFeedChannel *channel);
Retrieves information about the feed's software generator.
|
a GrssFeedChannel. |
Returns : |
generator of channel, or NULL. |
void grss_feed_channel_set_publish_time (GrssFeedChannel *channel,time_t publish);
To set the time of publishing for the feed.
|
a GrssFeedChannel. |
|
timestamp of publishing. |
time_t grss_feed_channel_get_publish_time (GrssFeedChannel *channel);
Retrieves the publishing time of channel.
|
a GrssFeedChannel. |
Returns : |
time of feed's publish. |
void grss_feed_channel_set_update_time (GrssFeedChannel *channel,time_t update);
To set the latest update time of channel.
|
a GrssFeedChannel. |
|
update time of the feed. |
time_t grss_feed_channel_get_update_time (GrssFeedChannel *channel);
Retrieves the update time of channel.
|
a GrssFeedChannel. |
Returns : |
time of the feed's latest update. If this value was not set
(with grss_feed_channel_set_update_time()) returns
grss_feed_channel_get_publish_time(). |
void grss_feed_channel_set_update_interval (GrssFeedChannel *channel,int minutes);
To set the update interval for channel.
|
a GrssFeedChannel. |
|
update interval, in minutes. |
int grss_feed_channel_get_update_interval
(GrssFeedChannel *channel);
Retrieves the update interval for the feed. Pay attention to the fact the
value can be unset, and the function returns 0: in this case the caller
must manually set a default update interval with
grss_feed_channel_set_update_interval().
|
a GrssFeedChannel. |
Returns : |
update interval for the channel, in minutes. |
gboolean grss_feed_channel_fetch (GrssFeedChannel *channel,GError **error);
Utility to fetch and populate a GrssFeedChannel for the first time, and init
all his internal values. Only the source URL has to be set in channel
(with grss_feed_channel_set_source()). Be aware this function is sync, do not
returns until the feed isn't downloaded and parsed.
|
a GrssFeedChannel. |
|
if an error occourred, FALSE is returned and this is filled with the
message. |
Returns : |
TRUE if the feed is correctly fetched and parsed, FALSE
otherwise. |
void grss_feed_channel_fetch_async (GrssFeedChannel *channel,GAsyncReadyCallback callback,gpointer user_data);
Similar to grss_feed_channel_fetch(), but asyncronous.
|
a GrssFeedChannel. |
|
function to invoke at the end of the download. |
|
data passed to the callback. |
gboolean grss_feed_channel_fetch_finish (GrssFeedChannel *channel,GAsyncResult *res,GError **error);
Finalizes an asyncronous operation started with
grss_feed_channel_fetch_async().
|
a GrssFeedChannel. |
|
the GAsyncResult passed to the callback. |
|
if an error occourred, FALSE is returned and this is filled with the
message. |
Returns : |
TRUE if channel informations have been successfully fetched,
FALSE otherwise. |
GList * grss_feed_channel_fetch_all (GrssFeedChannel *channel,GError **error);
Utility to fetch and populate a GrssFeedChannel, and retrieve all its items.
|
a GrssFeedChannel. |
|
if an error occourred, NULL is returned and this is filled with the
message. |
Returns : |
a GList of GrssFeedItem, to be completely unreferenced and
freed when no longer in use, or NULL if an error occurs. |
void grss_feed_channel_fetch_all_async (GrssFeedChannel *channel,GAsyncReadyCallback callback,gpointer user_data);
Similar to grss_feed_channel_fetch_all(), but asyncronous.
|
a GrssFeedChannel. |
|
function to invoke at the end of the download. |
|
data passed to the callback. |
GList * grss_feed_channel_fetch_all_finish (GrssFeedChannel *channel,GAsyncResult *res,GError **error);
Finalizes an asyncronous operation started with
grss_feed_channel_fetch_all_async().
|
a GrssFeedChannel. |
|
the GAsyncResult passed to the callback. |
|
if an error occourred, NULL is returned and this is filled with the
message. |
Returns : |
list of items fetched from the GrssFeedChannel, or NULL if
error is set. The list (and contained items) is freed at the end of the
callback |
|
|
|
libgrss Reference Manual | |
|---|---|---|---|---|
| Top | Description | Object Hierarchy | Signals | ||||
struct GrssFeedsPool; GrssFeedsPool * grss_feeds_pool_new (); void grss_feeds_pool_listen (GrssFeedsPool *pool,GList *feeds); GList * grss_feeds_pool_get_listened (GrssFeedsPool *pool); int grss_feeds_pool_get_listened_num (GrssFeedsPool *pool); void grss_feeds_pool_switch (GrssFeedsPool *pool,gboolean run); SoupSession * grss_feeds_pool_get_session (GrssFeedsPool *pool);
The GrssFeedsPool permits to automatically "listen" for more feeds: it
provides to fetch them on regular intervals (as defined by
grss_feed_channel_get_update_interval() for each channel), parse them with
GrssFeedParser, and emits signals when feeds are ready.
GrssFeedsPool * grss_feeds_pool_new ();
Allocates a new GrssFeedsPool.
Returns : |
a new GrssFeedsPool. |
void grss_feeds_pool_listen (GrssFeedsPool *pool,GList *feeds);
To set the list of feeds to be managed by the pool. The previous list, if
any, is invalidated. After invokation to the function, grss_feeds_pool_switch()
must be call to run the auto-fetching (always, also if previous state was
"running").
The list in feeds can be freed after calling this; linked GrssFeedChannel
are g_object_ref'd here.
|
a GrssFeedsPool. |
|
a list of GrssFeedChannel. |
GList * grss_feeds_pool_get_listened (GrssFeedsPool *pool);
Returns the list of feeds currently managed by the pool. 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 grss_feeds_pool_get_listened_num().
|
a GrssFeedsPool. |
Returns : |
a list of GrssFeedChannel, to be freed with g_list_free() when
no longer in use. Do not modify elements found in this list. |
int grss_feeds_pool_get_listened_num (GrssFeedsPool *pool);
Returns number of feeds under the pool control, as provided by
grss_feeds_pool_listen(). To get the complete list of those feeds, check
grss_feeds_pool_get_listened().
|
a GrssFeedsPool |
Returns : |
number of feeds currently managed by the GrssFeedsPool. |
void grss_feeds_pool_switch (GrssFeedsPool *pool,gboolean run);
Permits to pause or resume the pool fetching feeds. If run is TRUE, the
pool starts immediately.
|
a GrssFeedsPool. |
|
TRUE to run the pool, FALSE to pause it. |
SoupSession * grss_feeds_pool_get_session (GrssFeedsPool *pool);
To access the internal SoupSession used by the pool to fetch items.
|
a GrssFeedsPool. |
Returns : |
istance of SoupSession. Do not free it. |
"feed-fetching" signalvoid user_function (GrssFeedsPool *pool,
GObject *feed,
gpointer user_data) : Run Last
Emitted when the pool starts fetching a new GrssFeedChannel. To be
used to know the internal status of the component.
|
the GrssFeedsPool emitting the signal. |
|
the GrssFeedChannel which is going to be fetched. |
|
user data set when the signal handler was connected. |
"feed-ready" signalvoid user_function (GrssFeedsPool *pool,
GObject *feed,
gpointer items,
gpointer user_data) : Run Last
Emitted when a GrssFeedChannel assigned to the pool has been fetched
and parsed. All parsed items are exposed in the array, with no
regards about previously existing elements. items may be NULL, if
an error occourred while fetching and/or parsing. List of items
is freed, and his elements are unref'd, when signal ends.
|
the GrssFeedsPool emitting the signal. |
|
the GrssFeedChannel which has been fetched and parsed. |
|
list of GrssFeedItem obtained parsing the feed. |
|
user data set when the signal handler was connected. |
|
|
libgrss Reference Manual |
|---|
This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You may obtain a copy of the GNU General Public License from the Free Software Foundation by visiting their Web site.
|
|
libgrss Reference Manual | |
|---|
Table of Contents