TrackerMinerOnline

TrackerMinerOnline — Abstract base class for miners connecting to online resources

Synopsis

#include <libtracker-miner/tracker-miner.h>

struct              TrackerMinerOnline;
struct              TrackerMinerOnlineClass;
TrackerNetworkType  tracker_miner_online_get_network_type
                                                        (TrackerMinerOnline *miner);

Object Hierarchy

  GObject
   +----TrackerMiner
         +----TrackerMinerOnline

Implemented Interfaces

TrackerMinerOnline implements GInitable.

Properties

  "network-type"             TrackerNetworkType    : Read

Signals

  "connected"                                      : Run Last
  "disconnected"                                   : Run Last

Description

TrackerMinerOnline is an abstract base class for miners retrieving data from online resources. It's a very thin layer above TrackerMiner that additionally handles network connection status.

TrackerMinerOnline implementations can implement the connected vmethod in order to tell the miner whether a connection is valid to retrieve data or not. The miner data extraction still must be dictated through the TrackerMiner vmethods.

Details

struct TrackerMinerOnline

struct TrackerMinerOnline;

Abstract miner object for data requiring connectivity.


struct TrackerMinerOnlineClass

struct TrackerMinerOnlineClass {
	TrackerMinerClass parent_class;

	/* vmethods */
	gboolean (* connected)    (TrackerMinerOnline *miner,
	                           TrackerNetworkType  network);
	void     (* disconnected) (TrackerMinerOnline *miner);

	/* <Private> */
	gpointer padding[10];
};

Virtual methods that can be overridden.

TrackerMinerClass parent_class;

a TrackerMinerClass

connected ()

called when there is a network connection, or a new default route, returning TRUE starts/resumes indexing.

disconnected ()

called when there is no network connection.

gpointer padding[10];

Reserved for future API improvements.

Since 0.18.


tracker_miner_online_get_network_type ()

TrackerNetworkType  tracker_miner_online_get_network_type
                                                        (TrackerMinerOnline *miner);

Get the type of network this data miner uses to index content.

miner :

a TrackerMinerOnline.

Returns :

a TrackerNetworkType on success or TRACKER_NETWORK_TYPE_NONE on error.

Since 0.18.

Property Details

The "network-type" property

  "network-type"             TrackerNetworkType    : Read

Network type for the current connection.

Default value: TRACKER_NETWORK_TYPE_NONE

Signal Details

The "connected" signal

gboolean            user_function                      (TrackerMinerOnline *miner,
                                                        TrackerNetworkType  type,
                                                        gpointer            user_data)      : Run Last

the ::connected signal is emitted when a specific type of network becomes connected.

Return values of TRUE from this signal indicate whether a TrackerMiner should resume indexing or not upon ::connected.

miner :

a TrackerMinerOnline

type :

a TrackerNetworkType

user_data :

user data set when the signal handler was connected.

Since 0.18.0


The "disconnected" signal

void                user_function                      (TrackerMinerOnline *miner,
                                                        gpointer            user_data)      : Run Last

the ::disconnected signal is emitted when a specific type of network becomes disconnected.

miner :

a TrackerMinerOnline

type :

a TrackerNetworkType

user_data :

user data set when the signal handler was connected.

Since 0.18.0