BeagleQueryableStatus

BeagleQueryableStatus

Synopsis




                    BeagleQueryableStatus;
enum                BeagleQueryableState;
BeagleQueryableStatus* beagle_queryable_status_ref      (BeagleQueryableStatus *status);
void                beagle_queryable_status_unref       (BeagleQueryableStatus *status);
const char*         beagle_queryable_status_get_name    (BeagleQueryableStatus *status);
int                 beagle_queryable_status_get_item_count
                                                        (BeagleQueryableStatus *status);
BeagleQueryableState beagle_queryable_status_get_state  (BeagleQueryableStatus *status);
int                 beagle_queryable_status_get_progress_percent
                                                        (BeagleQueryableStatus *status);
gboolean            beagle_queryable_status_get_is_indexing
                                                        (BeagleQueryableStatus *status);

Description

Details

BeagleQueryableStatus

typedef struct _BeagleQueryableStatus BeagleQueryableStatus;


enum BeagleQueryableState

typedef enum {
	BEAGLE_QUERYABLE_STATE_NA, /* Not Applicable */
	BEAGLE_QUERYABLE_STATE_IDLE,
	BEAGLE_QUERYABLE_STATE_CRAWLING,
	BEAGLE_QUERYABLE_STATE_INDEXING,
	BEAGLE_QUERYABLE_STATE_FLUSHING
} BeagleQueryableState;


beagle_queryable_status_ref ()

BeagleQueryableStatus* beagle_queryable_status_ref      (BeagleQueryableStatus *status);

Increases the reference count of the BeagleQueryableStatus.

status : a BeagleQueryableStatus
Returns : the BeagleQueryableStatus

beagle_queryable_status_unref ()

void                beagle_queryable_status_unref       (BeagleQueryableStatus *status);

Decreases the reference count of the BeagleQueryableStatus. When the reference count drops to 0, it is freed.

status : a BeagleQueryableStatus

beagle_queryable_status_get_name ()

const char*         beagle_queryable_status_get_name    (BeagleQueryableStatus *status);

Fetches the name of the backend for the given BeagleQueryableStatus.

status : a BeagleQueryableStatus
Returns : the name of the backend for the BeagleQueryableStatus.

beagle_queryable_status_get_item_count ()

int                 beagle_queryable_status_get_item_count
                                                        (BeagleQueryableStatus *status);

Fetches the number of items in the backend for the given BeagleQueryableStatus.

status : a BeagleQueryableStatus
Returns : the number of items in the backend for the BeagleQueryableStatus.

beagle_queryable_status_get_state ()

BeagleQueryableState beagle_queryable_status_get_state  (BeagleQueryableStatus *status);

DEPRECATED: This function is obsolete since 0.2.0. At present, this function will always reutrn BEAGLE_QUERYABLE_STATE_NA.

status : a BeagleQueryableStatus
Returns : BEAGLE_QUERYABLE_STATE_NA.

beagle_queryable_status_get_progress_percent ()

int                 beagle_queryable_status_get_progress_percent
                                                        (BeagleQueryableStatus *status);

Fetches the progress in percent of the backend for the given BeagleQueryableStatus.

status : a BeagleQueryableStatus
Returns : the progress of the backend for the BeagleQueryableStatus.

beagle_queryable_status_get_is_indexing ()

gboolean            beagle_queryable_status_get_is_indexing
                                                        (BeagleQueryableStatus *status);

Fetches whether the backend for the given BeagleQueryableStatus is currently indexing.

status : a BeagleQueryableStatus
Returns : whether the backend for the BeagleQueryableStatus is currently indexing.