GfFeedPool

GfFeedPool — GfFeedPool Object API

Synopsis




            GfFeedPool;
GfFeedPool* gf_feed_pool_new                (void);
GfFeed*     gf_feed_pool_register_feed      (GfFeedPool *feed_pool,
                                             GfFeed *feed);
gboolean    gf_feed_pool_unregister_feed    (GfFeedPool *feed_pool,
                                             GfFeed *feed);
GfFeed**    gf_feed_pool_list_feeds         (const GfFeedPool *feed_pool,
                                             guint *num_feeds);
GfFeed*     gf_feed_pool_find_feed          (const GfFeedPool *feed_pool,
                                             const gchar *name);
void        gf_feed_pool_emit_event         (GfFeedPool *feed_pool,
                                             const GfFeed *feed,
                                             const GfEvent *event,
                                             const GfEventInfo *event_info);

Object Hierarchy


  GObject
   +----GfObject
         +----GfFeedPool

Signal Prototypes


"registered-feed"
            void        user_function      (GfFeedPool *gffeedpool,
                                            GfFeed *arg1,
                                            gpointer user_data);
"unregistered-feed"
            void        user_function      (GfFeedPool *gffeedpool,
                                            GfFeed *arg1,
                                            gpointer user_data);

Description

A GfFeedPool is a collection of GfFeed's. It is used internally in the daemon to keep track of available feeds. Client side it is used to determine what feeds the user wants to be notified for and so on.

Details

GfFeedPool

typedef struct _GfFeedPool GfFeedPool;

GfFeedPool is an opaque structure that should not be used directly.

gf_feed_pool_new ()

GfFeedPool* gf_feed_pool_new                (void);

Creates a new GfFeedPool instance.

Returns :

A new GfFeedPool instance.

gf_feed_pool_register_feed ()

GfFeed*     gf_feed_pool_register_feed      (GfFeedPool *feed_pool,
                                             GfFeed *feed);

Registers feed into the pool feed_pool.

`feed_pool` :	The GfFeedPool instance.
`feed` :	The GfFeed instance to register.
Returns :	TRUE on success, FALSE on failure.

gf_feed_pool_unregister_feed ()

gboolean    gf_feed_pool_unregister_feed    (GfFeedPool *feed_pool,
                                             GfFeed *feed);

Unregisters feed from the pool feed_pool.

`feed_pool` :	The GfFeedPool instance.
`feed` :	The GfFeed instance to unregister.
Returns :	TRUE on success, FALSE on failure.

gf_feed_pool_list_feeds ()

GfFeed**    gf_feed_pool_list_feeds         (const GfFeedPool *feed_pool,
                                             guint *num_feeds);

Gets a list of all GfFeed's in feed_pool.

`feed_pool` :	The GfFeedPool instance.
`num_feeds` :	Return address for the number of feeds.
Returns :	A newly allocated array of GfFeed's.

gf_feed_pool_find_feed ()

GfFeed*     gf_feed_pool_find_feed          (const GfFeedPool *feed_pool,
                                             const gchar *name);

Finds a GfFeed in feed_pool.

`feed_pool` :	The GfFeedPool instance.
`name` :	The name of the feed to find.
Returns :	The GfFeed on success, or NULL if the feed could not be found.

gf_feed_pool_emit_event ()

void        gf_feed_pool_emit_event         (GfFeedPool *feed_pool,
                                             const GfFeed *feed,
                                             const GfEvent *event,
                                             const GfEventInfo *event_info);

Emits event for feed registered in feed_pool, using the information from event_info.

`feed_pool` :	The GfFeedPool instance.
`feed` :	The GfFeed instance.
`event` :	The GfEvent instance.
`event_info` :	The GfEventInfo instance.

Signals

The "registered-feed" signal

void        user_function                  (GfFeedPool *gffeedpool,
                                            GfFeed *arg1,
                                            gpointer user_data);

Emitted when a feed is successfully registered.

`feed_pool` :	The GfFeedPool which received the signal.
`feed` :	The GfFeed that was registered
`user_data` :	user data set when the signal handler was connected.

The "unregistered-feed" signal

void        user_function                  (GfFeedPool *gffeedpool,
                                            GfFeed *arg1,
                                            gpointer user_data);

Emitted when a feed is successfully unregistered.

`feed_pool` :	The GfFeedPool which received the signal.
`feed` :	The GfFeed that was unregistered.
`user_data` :	user data set when the signal handler was connected.