![]() |
![]() |
![]() |
UDisks Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Properties |
UDisksDaemon; UDisksDaemon * udisks_daemon_new (GDBusConnection *connection
,gboolean disable_modules
,gboolean force_load_modules
,gboolean uninstalled
); GDBusConnection * udisks_daemon_get_connection (UDisksDaemon *daemon
); GDBusObjectManagerServer * udisks_daemon_get_object_manager (UDisksDaemon *daemon
); UDisksMountMonitor * udisks_daemon_get_mount_monitor (UDisksDaemon *daemon
); UDisksFstabMonitor * udisks_daemon_get_fstab_monitor (UDisksDaemon *daemon
); UDisksCrypttabMonitor * udisks_daemon_get_crypttab_monitor (UDisksDaemon *daemon
); UDisksLinuxProvider * udisks_daemon_get_linux_provider (UDisksDaemon *daemon
); PolkitAuthority * udisks_daemon_get_authority (UDisksDaemon *daemon
); UDisksState * udisks_daemon_get_state (UDisksDaemon *daemon
); UDisksObject * udisks_daemon_wait_for_object_sync (UDisksDaemon *daemon
,UDisksDaemonWaitFuncObject wait_func
,gpointer user_data
,GDestroyNotify user_data_free_func
,guint timeout_seconds
,GError **error
); GList * udisks_daemon_get_objects (UDisksDaemon *daemon
); UDisksObject * udisks_daemon_find_object (UDisksDaemon *daemon
,const gchar *object_path
); UDisksObject * udisks_daemon_find_block (UDisksDaemon *daemon
,dev_t block_device_number
); UDisksObject * udisks_daemon_find_block_by_device_file (UDisksDaemon *daemon
,const gchar *device_file
); UDisksObject * udisks_daemon_find_block_by_sysfs_path (UDisksDaemon *daemon
,const gchar *sysfs_path
); UDisksBaseJob * udisks_daemon_launch_simple_job (UDisksDaemon *daemon
,UDisksObject *object
,const gchar *job_operation
,uid_t job_started_by_uid
,GCancellable *cancellable
); UDisksBaseJob * udisks_daemon_launch_spawned_job (UDisksDaemon *daemon
,UDisksObject *object
,const gchar *job_operation
,uid_t job_started_by_uid
,GCancellable *cancellable
,uid_t run_as_uid
,uid_t run_as_euid
,const gchar *input_string
,const gchar *command_line_format
,...
); gboolean udisks_daemon_launch_spawned_job_sync (UDisksDaemon *daemon
,UDisksObject *object
,const gchar *job_operation
,uid_t job_started_by_uid
,GCancellable *cancellable
,uid_t run_as_uid
,uid_t run_as_euid
,gint *out_status
,gchar **out_message
,const gchar *input_string
,const gchar *command_line_format
,...
); UDisksBaseJob * udisks_daemon_launch_threaded_job (UDisksDaemon *daemon
,UDisksObject *object
,const gchar *job_operation
,uid_t job_started_by_uid
,UDisksThreadedJobFunc job_func
,gpointer user_data
,GDestroyNotify user_data_free_func
,GCancellable *cancellable
); gboolean udisks_daemon_get_disable_modules (UDisksDaemon *daemon
); gboolean udisks_daemon_get_force_load_modules (UDisksDaemon *daemon
); UDisksModuleManager * udisks_daemon_get_module_manager (UDisksDaemon *daemon
);
"connection" GDBusConnection* : Read / Write / Construct Only "disable-modules" gboolean : Read / Write / Construct Only "force-load-modules" gboolean : Read / Write / Construct Only "mount-monitor" UDisksMountMonitor* : Read "object-manager" GDBusObjectManagerServer* : Read "uninstalled" gboolean : Read / Write / Construct Only
typedef struct _UDisksDaemon UDisksDaemon;
The UDisksDaemon structure contains only private data and should only be accessed using the provided API.
UDisksDaemon * udisks_daemon_new (GDBusConnection *connection
,gboolean disable_modules
,gboolean force_load_modules
,gboolean uninstalled
);
Create a new daemon object for exporting objects on connection
.
|
A GDBusConnection. |
|
Indicates whether modules should never be activated. |
|
Activate modules on startup (for debugging purposes). |
|
Loads modules from the build directory (for debugging purposes). |
Returns : |
A UDisksDaemon object. Free with g_object_unref() . |
GDBusConnection * udisks_daemon_get_connection (UDisksDaemon *daemon
);
Gets the D-Bus connection used by daemon
.
|
A UDisksDaemon. |
Returns : |
A GDBusConnection. Do not free, the object is owned by daemon . |
GDBusObjectManagerServer * udisks_daemon_get_object_manager
(UDisksDaemon *daemon
);
Gets the D-Bus object manager used by daemon
.
|
A UDisksDaemon. |
Returns : |
A GDBusObjectManagerServer. Do not free, the object is owned by daemon . |
UDisksMountMonitor * udisks_daemon_get_mount_monitor (UDisksDaemon *daemon
);
Gets the mount monitor used by daemon
.
|
A UDisksDaemon |
Returns : |
A UDisksMountMonitor. Do not free, the object is owned by daemon . |
UDisksFstabMonitor * udisks_daemon_get_fstab_monitor (UDisksDaemon *daemon
);
Gets the fstab monitor used by daemon
.
|
A UDisksDaemon |
Returns : |
A UDisksFstabMonitor. Do not free, the object is owned by daemon . |
UDisksCrypttabMonitor * udisks_daemon_get_crypttab_monitor
(UDisksDaemon *daemon
);
Gets the crypttab monitor used by daemon
.
|
A UDisksDaemon |
Returns : |
A UDisksCrypttabMonitor. Do not free, the object is owned by daemon . |
UDisksLinuxProvider * udisks_daemon_get_linux_provider (UDisksDaemon *daemon
);
Gets the Linux Provider, if any.
|
A UDisksDaemon. |
Returns : |
A UDisksLinuxProvider or NULL . Do not free, the object is owned by daemon . |
PolkitAuthority * udisks_daemon_get_authority (UDisksDaemon *daemon
);
Gets the PolicyKit authority used by daemon
.
|
A UDisksDaemon. |
Returns : |
A PolkitAuthority instance or NULL if the polkit
authority is not available. Do not free, the object is owned by
daemon . |
UDisksState * udisks_daemon_get_state (UDisksDaemon *daemon
);
Gets the state object used by daemon
.
|
A UDisksDaemon. |
Returns : |
A UDisksState instance. Do not free, the object is owned by daemon . |
UDisksObject * udisks_daemon_wait_for_object_sync (UDisksDaemon *daemon
,UDisksDaemonWaitFuncObject wait_func
,gpointer user_data
,GDestroyNotify user_data_free_func
,guint timeout_seconds
,GError **error
);
Blocks the calling thread until an object picked by wait_func
is
available or until timeout_seconds
has passed (in which case the
function fails with UDISKS_ERROR_TIMED_OUT
).
Note that wait_func
will be called from time to time - for example
if there is a device event.
|
A UDisksDaemon. |
|
Function to check for desired object. |
|
User data to pass to wait_func . |
|
Function to free user_data or NULL . [allow-none]
|
|
Maximum time to wait for the object (in seconds) or 0 to never wait. |
|
Return location for error or NULL . [allow-none]
|
Returns : |
The object picked by wait_func or NULL if error is set. [transfer full]
|
GList * udisks_daemon_get_objects (UDisksDaemon *daemon
);
Gets all D-Bus objects exported by daemon
.
|
A UDisksDaemon. |
Returns : |
A list of UDisksObject instaces. The returned list should be freed with g_list_free() after each element has been freed with g_object_unref() . [transfer full][element-type UDisksObject]
|
UDisksObject * udisks_daemon_find_object (UDisksDaemon *daemon
,const gchar *object_path
);
Finds an exported object with the object path given by object_path
.
|
A UDisksDaemon. |
|
A dev_t with the device number to find. |
Returns : |
A UDisksObject or NULL if not found. Free with g_object_unref() . [transfer full]
|
UDisksObject * udisks_daemon_find_block (UDisksDaemon *daemon
,dev_t block_device_number
);
Finds a block device with the number given by block_device_number
.
|
A UDisksDaemon. |
|
A dev_t with the device number to find. |
Returns : |
A UDisksObject or NULL if not found. Free with g_object_unref() . [transfer full]
|
UDisksObject * udisks_daemon_find_block_by_device_file (UDisksDaemon *daemon
,const gchar *device_file
);
Finds a block device with device file given by device_file
.
|
A UDisksDaemon. |
|
A device file. |
Returns : |
A UDisksObject or NULL if not found. Free with g_object_unref() . [transfer full]
|
UDisksObject * udisks_daemon_find_block_by_sysfs_path (UDisksDaemon *daemon
,const gchar *sysfs_path
);
Finds a block device with a sysfs path given by sysfs_path
.
|
A UDisksDaemon. |
|
A sysfs path. |
Returns : |
A UDisksObject or NULL if not found. Free with g_object_unref() . [transfer full]
|
UDisksBaseJob * udisks_daemon_launch_simple_job (UDisksDaemon *daemon
,UDisksObject *object
,const gchar *job_operation
,uid_t job_started_by_uid
,GCancellable *cancellable
);
Launches a new simple job.
The returned object will be exported on the bus until the "completed" signal is emitted on the object. It is not valid to use the returned object after this signal fires.
|
A UDisksDaemon. |
|
A UDisksObject to add to the job or NULL . [allow-none]
|
|
The operation for the job. |
|
The user who started the job. |
|
A GCancellable or NULL . |
Returns : |
A UDisksSimpleJob object. Do not free, the object
belongs to manager . |
UDisksBaseJob * udisks_daemon_launch_spawned_job (UDisksDaemon *daemon
,UDisksObject *object
,const gchar *job_operation
,uid_t job_started_by_uid
,GCancellable *cancellable
,uid_t run_as_uid
,uid_t run_as_euid
,const gchar *input_string
,const gchar *command_line_format
,...
);
Launches a new job for command_line_format
.
The job is not started automatically! Use udisks_spawned_job_start()
to start
the job after "spawned-job-completed" or
"completed" signals are connected (to get notified when the job is
done). This is to prevent a race condition with the spawned process
terminating before the signals are connected in which case the signal
handlers are never triggered.
The returned object will be exported on the bus until the "completed" signal is emitted on the object. It is not valid to use the returned object after this signal fires.
|
A UDisksDaemon. |
|
A UDisksObject to add to the job or NULL . [allow-none]
|
|
The operation for the job. |
|
The user who started the job. |
|
A GCancellable or NULL . |
|
The uid_t to run the command as. |
|
The effective uid_t to run the command as. |
|
A string to write to stdin of the spawned program or NULL . |
|
printf()-style format for the command line to spawn. |
|
Arguments for command_line_format . |
Returns : |
A UDisksSpawnedJob object. Do not free, the object
belongs to manager . |
gboolean udisks_daemon_launch_spawned_job_sync (UDisksDaemon *daemon
,UDisksObject *object
,const gchar *job_operation
,uid_t job_started_by_uid
,GCancellable *cancellable
,uid_t run_as_uid
,uid_t run_as_euid
,gint *out_status
,gchar **out_message
,const gchar *input_string
,const gchar *command_line_format
,...
);
Like udisks_daemon_launch_spawned_job()
but blocks the calling
thread until the job completes.
|
A UDisksDaemon. |
|
A UDisksObject to add to the job or NULL . [allow-none]
|
|
The operation for the job. |
|
The user who started the job. |
|
A GCancellable or NULL . |
|
The uid_t to run the command as. |
|
The effective uid_t to run the command as. |
|
A string to write to stdin of the spawned program or NULL . |
|
Return location for the status parameter of the "spawned-job-completed" signal. |
|
Return location for the message parameter of the "completed" signal. |
|
printf()-style format for the command line to spawn. |
|
Arguments for command_line_format . |
Returns : |
The success parameter of the "completed" signal. |
UDisksBaseJob * udisks_daemon_launch_threaded_job (UDisksDaemon *daemon
,UDisksObject *object
,const gchar *job_operation
,uid_t job_started_by_uid
,UDisksThreadedJobFunc job_func
,gpointer user_data
,GDestroyNotify user_data_free_func
,GCancellable *cancellable
);
Launches a new job by running job_func
in a new dedicated thread.
The job is not started automatically! Use udisks_threaded_job_start()
to
start the job after "threaded-job-completed" or
"completed" signals are connected (to get notified when the job is
done). This is to prevent a race condition with the job_func
finishing
before the signals are connected in which case the signal handlers are never
triggered.
Long-running jobs should periodically check cancellable
to see if
they have been cancelled.
The returned object will be exported on the bus until the "completed" signal is emitted on the object. It is not valid to use the returned object after this signal fires.
|
A UDisksDaemon. |
|
A UDisksObject to add to the job or NULL . [allow-none]
|
|
The operation for the job. |
|
The user who started the job. |
|
The function to run in another thread. |
|
User data to pass to job_func . |
|
Function to free user_data with or NULL . |
|
A GCancellable or NULL . |
Returns : |
A UDisksThreadedJob object. Do not free, the object
belongs to manager . |
gboolean udisks_daemon_get_disable_modules (UDisksDaemon *daemon
);
Gets daemon
setting whether modules should never be loaded.
|
A UDisksDaemon. |
Returns : |
TRUE if --disable-modules commandline switch has been specified. |
gboolean udisks_daemon_get_force_load_modules
(UDisksDaemon *daemon
);
Gets daemon
setting whether modules should be activated upon start.
|
A UDisksDaemon. |
Returns : |
TRUE if --force-load-modules commandline switch has been specified. |
UDisksModuleManager * udisks_daemon_get_module_manager (UDisksDaemon *daemon
);
Gets the module manager used by daemon
.
|
A UDisksDaemon. |
Returns : |
A UDisksModuleManager. Do not free, the object is owned by daemon . |
"connection"
property "connection" GDBusConnection* : Read / Write / Construct Only
The GDBusConnection the daemon is for.
"disable-modules"
property "disable-modules" gboolean : Read / Write / Construct Only
Whether modules should be disabled
Default value: FALSE
"force-load-modules"
property "force-load-modules" gboolean : Read / Write / Construct Only
Whether modules should be activated upon startup
Default value: FALSE
"mount-monitor"
property"mount-monitor" UDisksMountMonitor* : Read
The UDisksMountMonitor used by the daemon
"object-manager"
property "object-manager" GDBusObjectManagerServer* : Read
The GDBusObjectManager used by the daemon