PkControl

PkControl — For querying data about PackageKit

Synopsis

#define             PK_CONTROL_ERROR
#define             PK_CONTROL_TYPE_ERROR
enum                PkControlError;
struct              PkControl;
struct              PkControlClass;
GQuark              pk_control_error_quark              (void);
PkControl *         pk_control_new                      (void);
void                pk_control_test                     (gpointer user_data);
void                pk_control_get_tid_async            (PkControl *control,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);
gchar *             pk_control_get_tid_finish           (PkControl *control,
                                                         GAsyncResult *res,
                                                         GError **error);
void                pk_control_suggest_daemon_quit_async
                                                        (PkControl *control,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);
gboolean            pk_control_suggest_daemon_quit_finish
                                                        (PkControl *control,
                                                         GAsyncResult *res,
                                                         GError **error);
void                pk_control_get_daemon_state_async   (PkControl *control,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);
gchar *             pk_control_get_daemon_state_finish  (PkControl *control,
                                                         GAsyncResult *res,
                                                         GError **error);
void                pk_control_set_proxy_async          (PkControl *control,
                                                         const gchar *proxy_http,
                                                         const gchar *proxy_ftp,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);
void                pk_control_set_proxy2_async         (PkControl *control,
                                                         const gchar *proxy_http,
                                                         const gchar *proxy_https,
                                                         const gchar *proxy_ftp,
                                                         const gchar *proxy_socks,
                                                         const gchar *no_proxy,
                                                         const gchar *pac,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);
gboolean            pk_control_set_proxy_finish         (PkControl *control,
                                                         GAsyncResult *res,
                                                         GError **error);
void                pk_control_set_root_async           (PkControl *control,
                                                         const gchar *root,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);
gboolean            pk_control_set_root_finish          (PkControl *control,
                                                         GAsyncResult *res,
                                                         GError **error);
void                pk_control_get_network_state_async  (PkControl *control,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);
PkNetworkEnum       pk_control_get_network_state_finish (PkControl *control,
                                                         GAsyncResult *res,
                                                         GError **error);
void                pk_control_get_time_since_action_async
                                                        (PkControl *control,
                                                         PkRoleEnum role,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);
guint               pk_control_get_time_since_action_finish
                                                        (PkControl *control,
                                                         GAsyncResult *res,
                                                         GError **error);
void                pk_control_get_transaction_list_async
                                                        (PkControl *control,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);
gchar **            pk_control_get_transaction_list_finish
                                                        (PkControl *control,
                                                         GAsyncResult *res,
                                                         GError **error);
void                pk_control_can_authorize_async      (PkControl *control,
                                                         const gchar *action_id,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);
PkAuthorizeEnum     pk_control_can_authorize_finish     (PkControl *control,
                                                         GAsyncResult *res,
                                                         GError **error);
void                pk_control_get_properties_async     (PkControl *control,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);
gboolean            pk_control_get_properties_finish    (PkControl *control,
                                                         GAsyncResult *res,
                                                         GError **error);
                    PkControlPrivate;

Description

A GObject to use for accessing PackageKit asynchronously.

Details

PK_CONTROL_ERROR

#define PK_CONTROL_ERROR (pk_control_error_quark ())

PK_CONTROL_TYPE_ERROR

#define PK_CONTROL_TYPE_ERROR (pk_control_error_get_type ())

enum PkControlError

typedef enum
{
	PK_CONTROL_ERROR_FAILED,
	PK_CONTROL_ERROR_CANNOT_START_DAEMON
} PkControlError;

Errors that can be thrown

PK_CONTROL_ERROR_FAILED

 the transaction failed for an unknown reason

PK_CONTROL_ERROR_CANNOT_START_DAEMON

struct PkControl

struct PkControl {
	 GObject		 parent;
	 PkControlPrivate *priv;
};

struct PkControlClass

struct PkControlClass {
	GObjectClass parent_class;

	/* signals */
	void		(* transaction_list_changed) (PkControl *control,
							 gchar		**transaction_ids);
	void		(* updates_changed)		(PkControl *control);
	void		(* repo_list_changed)		(PkControl *control);
	void		(* network_state_changed) (PkControl *control);
	void		(* restart_schedule)		(PkControl *control);
	void		(* locked)			(PkControl *control,
							 gboolean	 is_locked);
	void		(* connection_changed)		(PkControl *control,
							 gboolean	 connected);
	/* padding for future expansion */
	void (*_pk_reserved1) (void);
	void (*_pk_reserved2) (void);
	void (*_pk_reserved3) (void);
	void (*_pk_reserved4) (void);
	void (*_pk_reserved5) (void);
};

pk_control_error_quark ()

GQuark              pk_control_error_quark              (void);

We are a GObject that sets errors

Returns :

 Our personal error quark.

Since 0.5.2

pk_control_new ()

PkControl *         pk_control_new                      (void);

Returns :

 a new PkControl object.

Since 0.5.2

pk_control_test ()

void                pk_control_test                     (gpointer user_data);

pk_control_get_tid_async ()

void                pk_control_get_tid_async            (PkControl *control,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

Gets a transacton ID from the daemon.

control :

 a valid PkControl instance

cancellable :

 a GCancellable or NULL

callback :

 the function to run on completion

user_data :

 the data to pass to callback

Since 0.5.2

pk_control_get_tid_finish ()

gchar *             pk_control_get_tid_finish           (PkControl *control,
                                                         GAsyncResult *res,
                                                         GError **error);

Gets the result from the asynchronous function.

control :

 a valid PkControl instance

res :

 the GAsyncResult

error :

 A GError or NULL

Returns :

 the ID, or NULL if unset, free with g_free()

Since 0.5.2

pk_control_suggest_daemon_quit_async ()

void                pk_control_suggest_daemon_quit_async
                                                        (PkControl *control,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

Suggests to the daemon that it should quit as soon as possible.

control :

 a valid PkControl instance

cancellable :

 a GCancellable or NULL

callback :

 the function to run on completion

user_data :

 the data to pass to callback

Since 0.6.2

pk_control_suggest_daemon_quit_finish ()

gboolean            pk_control_suggest_daemon_quit_finish
                                                        (PkControl *control,
                                                         GAsyncResult *res,
                                                         GError **error);

Gets the result from the asynchronous function.

control :

 a valid PkControl instance

res :

 the GAsyncResult

error :

 A GError or NULL

Returns :

 TRUE if the suggestion was sent

Since 0.6.2

pk_control_get_daemon_state_async ()

void                pk_control_get_daemon_state_async   (PkControl *control,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

Gets the debugging state from the daemon.

control :

 a valid PkControl instance

cancellable :

 a GCancellable or NULL

callback :

 the function to run on completion

user_data :

 the data to pass to callback

Since 0.5.2

pk_control_get_daemon_state_finish ()

gchar *             pk_control_get_daemon_state_finish  (PkControl *control,
                                                         GAsyncResult *res,
                                                         GError **error);

Gets the result from the asynchronous function.

control :

 a valid PkControl instance

res :

 the GAsyncResult

error :

 A GError or NULL

Returns :

 the ID, or NULL if unset, free with g_free()

Since 0.5.2

pk_control_set_proxy_async ()

void                pk_control_set_proxy_async          (PkControl *control,
                                                         const gchar *proxy_http,
                                                         const gchar *proxy_ftp,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

Set a proxy on the PK daemon

NOTE: This is just provided for backwards compatibility. Clients should really be using pk_control_set_proxy2_async().

control :

 a valid PkControl instance

proxy_http :

 a HTTP proxy string such as "username:passwordserver.lan:8080"

proxy_ftp :

 a FTP proxy string such as "server.lan:8080"

cancellable :

 a GCancellable or NULL

callback :

 the function to run on completion

user_data :

 the data to pass to callback

Since 0.5.2

pk_control_set_proxy2_async ()

void                pk_control_set_proxy2_async         (PkControl *control,
                                                         const gchar *proxy_http,
                                                         const gchar *proxy_https,
                                                         const gchar *proxy_ftp,
                                                         const gchar *proxy_socks,
                                                         const gchar *no_proxy,
                                                         const gchar *pac,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

Set a proxy on the PK daemon

control :

 a valid PkControl instance

proxy_http :

 a HTTP proxy string such as "username:passwordserver.lan:8080", or NULL

proxy_https :

 a HTTPS proxy string such as "username:passwordserver.lan:8080", or NULL

proxy_ftp :

 a FTP proxy string such as "server.lan:8080", or NULL

proxy_socks :

 a SOCKS proxy string such as "server.lan:8080", or NULL

no_proxy :

 a list of download IPs that shouldn't go through the proxy, or NULL

pac :

 a PAC string, or NULL

cancellable :

 a GCancellable or NULL

callback :

 the function to run on completion

user_data :

 the data to pass to callback

Since 0.6.13

pk_control_set_proxy_finish ()

gboolean            pk_control_set_proxy_finish         (PkControl *control,
                                                         GAsyncResult *res,
                                                         GError **error);

Gets the result from the asynchronous function.

control :

 a valid PkControl instance

res :

 the GAsyncResult

error :

 A GError or NULL

Returns :

 TRUE if we set the proxy successfully

Since 0.5.2

pk_control_set_root_async ()

void                pk_control_set_root_async           (PkControl *control,
                                                         const gchar *root,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

Set the install root for the backend used by PackageKit

control :

 a valid PkControl instance

root :

 an install root string such as "/mnt/ltsp"

cancellable :

 a GCancellable or NULL

callback :

 the function to run on completion

user_data :

 the data to pass to callback

Since 0.6.4

pk_control_set_root_finish ()

gboolean            pk_control_set_root_finish          (PkControl *control,
                                                         GAsyncResult *res,
                                                         GError **error);

Gets the result from the asynchronous function.

control :

 a valid PkControl instance

res :

 the GAsyncResult

error :

 A GError or NULL

Returns :

 TRUE if we set the root successfully

Since 0.6.4

pk_control_get_network_state_async ()

void                pk_control_get_network_state_async  (PkControl *control,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

pk_control_get_network_state_finish ()

PkNetworkEnum       pk_control_get_network_state_finish (PkControl *control,
                                                         GAsyncResult *res,
                                                         GError **error);

pk_control_get_time_since_action_async ()

void                pk_control_get_time_since_action_async
                                                        (PkControl *control,
                                                         PkRoleEnum role,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

We may want to know how long it has been since we refreshed the cache or retrieved the update list.

control :

 a valid PkControl instance

role :

 the role enum, e.g. PK_ROLE_ENUM_GET_UPDATES

cancellable :

 a GCancellable or NULL

callback :

 the function to run on completion

user_data :

 the data to pass to callback

Since 0.5.2

pk_control_get_time_since_action_finish ()

guint               pk_control_get_time_since_action_finish
                                                        (PkControl *control,
                                                         GAsyncResult *res,
                                                         GError **error);

Gets the result from the asynchronous function.

control :

 a valid PkControl instance

res :

 the GAsyncResult

error :

 A GError or NULL

Returns :

 TRUE if the daemon serviced the request

Since 0.5.2

pk_control_get_transaction_list_async ()

void                pk_control_get_transaction_list_async
                                                        (PkControl *control,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

Gets the transactions currently running in the daemon.

control :

 a valid PkControl instance

cancellable :

 a GCancellable or NULL

callback :

 the function to run on completion

user_data :

 the data to pass to callback

Since 0.5.2

pk_control_get_transaction_list_finish ()

gchar **            pk_control_get_transaction_list_finish
                                                        (PkControl *control,
                                                         GAsyncResult *res,
                                                         GError **error);

Gets the result from the asynchronous function.

control :

 a valid PkControl instance

res :

 the GAsyncResult

error :

 A GError or NULL

Returns :

 A GStrv list of transaction ID's, free with g_strfreev(). [transfer full]

Since 0.5.2

pk_control_can_authorize_async ()

void                pk_control_can_authorize_async      (PkControl *control,
                                                         const gchar *action_id,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

We may want to know before we run a method if we are going to be denied, accepted or challenged for authentication.

control :

 a valid PkControl instance

action_id :

 The action ID, for instance "org.freedesktop.PackageKit.install-untrusted"

cancellable :

 a GCancellable or NULL

callback :

 the function to run on completion

user_data :

 the data to pass to callback

Since 0.5.2

pk_control_can_authorize_finish ()

PkAuthorizeEnum     pk_control_can_authorize_finish     (PkControl *control,
                                                         GAsyncResult *res,
                                                         GError **error);

Gets the result from the asynchronous function.

control :

 a valid PkControl instance

res :

 the GAsyncResult

error :

 A GError or NULL

Returns :

 the PkAuthorizeEnum or PK_AUTHORIZE_ENUM_UNKNOWN if the method failed

Since 0.5.2

pk_control_get_properties_async ()

void                pk_control_get_properties_async     (PkControl *control,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

Gets global properties from the daemon.

control :

 a valid PkControl instance

cancellable :

 a GCancellable or NULL

callback :

 the function to run on completion

user_data :

 the data to pass to callback

Since 0.5.2

pk_control_get_properties_finish ()

gboolean            pk_control_get_properties_finish    (PkControl *control,
                                                         GAsyncResult *res,
                                                         GError **error);

Gets the result from the asynchronous function.

control :

 a valid PkControl instance

res :

 the GAsyncResult

error :

 A GError or NULL

Returns :

 TRUE if we set the proxy successfully

Since 0.5.2

PkControlPrivate

typedef struct _PkControlPrivate PkControlPrivate;

Private PkControl data

Generated by GTK-Doc V1.17