| UDisks Reference Manual | ||||
|---|---|---|---|---|
| Top | Description | Object Hierarchy | Implemented Interfaces | Prerequisites | Known Implementations | Properties | Signals | ||||
UDisksLoop; struct UDisksLoopIface; GDBusInterfaceInfo * udisks_loop_interface_info (void); guint udisks_loop_override_properties (GObjectClass *klass,guint property_id_begin); const gchar * udisks_loop_get_backing_file (UDisksLoop *object); gboolean udisks_loop_get_autoclear (UDisksLoop *object); guint udisks_loop_get_setup_by_uid (UDisksLoop *object); gchar * udisks_loop_dup_backing_file (UDisksLoop *object); void udisks_loop_set_backing_file (UDisksLoop *object,const gchar *value); void udisks_loop_set_autoclear (UDisksLoop *object,gboolean value); void udisks_loop_set_setup_by_uid (UDisksLoop *object,guint value); void udisks_loop_call_delete (UDisksLoop *proxy,GVariant *arg_options,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data); gboolean udisks_loop_call_delete_finish (UDisksLoop *proxy,GAsyncResult *res,GError **error); gboolean udisks_loop_call_delete_sync (UDisksLoop *proxy,GVariant *arg_options,GCancellable *cancellable,GError **error); void udisks_loop_complete_delete (UDisksLoop *object,GDBusMethodInvocation *invocation); void udisks_loop_call_set_autoclear (UDisksLoop *proxy,gboolean arg_value,GVariant *arg_options,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data); gboolean udisks_loop_call_set_autoclear_finish (UDisksLoop *proxy,GAsyncResult *res,GError **error); gboolean udisks_loop_call_set_autoclear_sync (UDisksLoop *proxy,gboolean arg_value,GVariant *arg_options,GCancellable *cancellable,GError **error); void udisks_loop_complete_set_autoclear (UDisksLoop *object,GDBusMethodInvocation *invocation); struct UDisksLoopProxy; struct UDisksLoopProxyClass; void udisks_loop_proxy_new (GDBusConnection *connection,GDBusProxyFlags flags,const gchar *name,const gchar *object_path,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data); UDisksLoop * udisks_loop_proxy_new_finish (GAsyncResult *res,GError **error); UDisksLoop * udisks_loop_proxy_new_sync (GDBusConnection *connection,GDBusProxyFlags flags,const gchar *name,const gchar *object_path,GCancellable *cancellable,GError **error); void udisks_loop_proxy_new_for_bus (GBusType bus_type,GDBusProxyFlags flags,const gchar *name,const gchar *object_path,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data); UDisksLoop * udisks_loop_proxy_new_for_bus_finish (GAsyncResult *res,GError **error); UDisksLoop * udisks_loop_proxy_new_for_bus_sync (GBusType bus_type,GDBusProxyFlags flags,const gchar *name,const gchar *object_path,GCancellable *cancellable,GError **error); struct UDisksLoopSkeleton; struct UDisksLoopSkeletonClass; UDisksLoop * udisks_loop_skeleton_new (void);
GInterface +----UDisksLoop
GObject +----GDBusProxy +----UDisksLoopProxy
GObject +----GDBusInterfaceSkeleton +----UDisksLoopSkeleton +----UDisksLinuxLoop
UDisksLoopProxy implements GDBusInterface, GInitable, GAsyncInitable and UDisksLoop.
UDisksLoopSkeleton implements GDBusInterface and UDisksLoop.
UDisksLoop is implemented by UDisksLinuxLoop, UDisksLoopProxy and UDisksLoopSkeleton.
"autoclear" gboolean : Read / Write "backing-file" gchar* : Read / Write "setup-by-uid" guint : Read / Write
This section contains code for working with the org.freedesktop.UDisks2.Loop D-Bus interface in C.
typedef struct _UDisksLoop UDisksLoop;
Abstract interface type for the D-Bus interface org.freedesktop.UDisks2.Loop.
struct UDisksLoopIface {
GTypeInterface parent_iface;
gboolean (*handle_delete) (
UDisksLoop *object,
GDBusMethodInvocation *invocation,
GVariant *arg_options);
gboolean (*handle_set_autoclear) (
UDisksLoop *object,
GDBusMethodInvocation *invocation,
gboolean arg_value,
GVariant *arg_options);
gboolean (*get_autoclear) (UDisksLoop *object);
const gchar * (*get_backing_file) (UDisksLoop *object);
guint (*get_setup_by_uid) (UDisksLoop *object);
};
Virtual table for the D-Bus interface org.freedesktop.UDisks2.Loop.
GTypeInterface |
The parent interface. |
| Handler for the "handle-delete" signal. | |
| Handler for the "handle-set-autoclear" signal. | |
| Getter for the "autoclear" property. | |
| Getter for the "backing-file" property. | |
| Getter for the "setup-by-uid" property. |
GDBusInterfaceInfo * udisks_loop_interface_info (void);
Gets a machine-readable description of the org.freedesktop.UDisks2.Loop D-Bus interface.
Returns : |
A GDBusInterfaceInfo. Do not free. [transfer none] |
guint udisks_loop_override_properties (GObjectClass *klass,guint property_id_begin);
Overrides all GObject properties in the UDisksLoop interface for a concrete class. The properties are overridden in the order they are defined.
|
The class structure for a GObject-derived class. |
|
The property id to assign to the first overridden property. |
Returns : |
The last property id. |
const gchar * udisks_loop_get_backing_file (UDisksLoop *object);
Gets the value of the "BackingFile" D-Bus property.
Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.
object was constructed. Use udisks_loop_dup_backing_file() if on another thread.
|
A UDisksLoop. |
Returns : |
The property value or NULL if the property is not set. Do not free the returned value, it belongs to object. [transfer none]
|
gboolean udisks_loop_get_autoclear (UDisksLoop *object);
Gets the value of the "Autoclear" D-Bus property.
Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.
|
A UDisksLoop. |
Returns : |
The property value. |
guint udisks_loop_get_setup_by_uid (UDisksLoop *object);
Gets the value of the "SetupByUID" D-Bus property.
Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.
|
A UDisksLoop. |
Returns : |
The property value. |
gchar * udisks_loop_dup_backing_file (UDisksLoop *object);
Gets a copy of the "BackingFile" D-Bus property.
Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.
|
A UDisksLoop. |
Returns : |
The property value or NULL if the property is not set. The returned value should be freed with g_free(). [transfer full]
|
void udisks_loop_set_backing_file (UDisksLoop *object,const gchar *value);
Sets the "BackingFile" D-Bus property to value.
Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side.
|
A UDisksLoop. |
|
The value to set. |
void udisks_loop_set_autoclear (UDisksLoop *object,gboolean value);
Sets the "Autoclear" D-Bus property to value.
Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side.
|
A UDisksLoop. |
|
The value to set. |
void udisks_loop_set_setup_by_uid (UDisksLoop *object,guint value);
Sets the "SetupByUID" D-Bus property to value.
Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side.
|
A UDisksLoop. |
|
The value to set. |
void udisks_loop_call_delete (UDisksLoop *proxy,GVariant *arg_options,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data);
Asynchronously invokes the Delete() D-Bus method on proxy.
When the operation is finished, callback will be invoked in the thread-default main loop of the thread you are calling this method from.
You can then call udisks_loop_call_delete_finish() to get the result of the operation.
See udisks_loop_call_delete_sync() for the synchronous, blocking version of this method.
|
A UDisksLoopProxy. |
|
Argument to pass with the method invocation. |
|
A GCancellable or NULL. [allow-none]
|
|
A GAsyncReadyCallback to call when the request is satisfied or NULL. |
|
User data to pass to callback. |
gboolean udisks_loop_call_delete_finish (UDisksLoop *proxy,GAsyncResult *res,GError **error);
Finishes an operation started with udisks_loop_call_delete().
|
A UDisksLoopProxy. |
|
The GAsyncResult obtained from the GAsyncReadyCallback passed to udisks_loop_call_delete(). |
|
Return location for error or NULL. |
Returns : |
TRUE if the call succeded, FALSE if error is set. [skip]
|
gboolean udisks_loop_call_delete_sync (UDisksLoop *proxy,GVariant *arg_options,GCancellable *cancellable,GError **error);
Synchronously invokes the Delete() D-Bus method on proxy. The calling thread is blocked until a reply is received.
See udisks_loop_call_delete() for the asynchronous version of this method.
|
A UDisksLoopProxy. |
|
Argument to pass with the method invocation. |
|
A GCancellable or NULL. [allow-none]
|
|
Return location for error or NULL. |
Returns : |
TRUE if the call succeded, FALSE if error is set. [skip]
|
void udisks_loop_complete_delete (UDisksLoop *object,GDBusMethodInvocation *invocation);
Helper function used in service implementations to finish handling invocations of the Delete() D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar.
This method will free invocation, you cannot use it afterwards.
|
A UDisksLoop. |
|
A GDBusMethodInvocation. [transfer full] |
void udisks_loop_call_set_autoclear (UDisksLoop *proxy,gboolean arg_value,GVariant *arg_options,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data);
Asynchronously invokes the SetAutoclear() D-Bus method on proxy.
When the operation is finished, callback will be invoked in the thread-default main loop of the thread you are calling this method from.
You can then call udisks_loop_call_set_autoclear_finish() to get the result of the operation.
See udisks_loop_call_set_autoclear_sync() for the synchronous, blocking version of this method.
|
A UDisksLoopProxy. |
|
Argument to pass with the method invocation. |
|
Argument to pass with the method invocation. |
|
A GCancellable or NULL. [allow-none]
|
|
A GAsyncReadyCallback to call when the request is satisfied or NULL. |
|
User data to pass to callback. |
gboolean udisks_loop_call_set_autoclear_finish (UDisksLoop *proxy,GAsyncResult *res,GError **error);
Finishes an operation started with udisks_loop_call_set_autoclear().
|
A UDisksLoopProxy. |
|
The GAsyncResult obtained from the GAsyncReadyCallback passed to udisks_loop_call_set_autoclear(). |
|
Return location for error or NULL. |
Returns : |
TRUE if the call succeded, FALSE if error is set. [skip]
|
gboolean udisks_loop_call_set_autoclear_sync (UDisksLoop *proxy,gboolean arg_value,GVariant *arg_options,GCancellable *cancellable,GError **error);
Synchronously invokes the SetAutoclear() D-Bus method on proxy. The calling thread is blocked until a reply is received.
See udisks_loop_call_set_autoclear() for the asynchronous version of this method.
|
A UDisksLoopProxy. |
|
Argument to pass with the method invocation. |
|
Argument to pass with the method invocation. |
|
A GCancellable or NULL. [allow-none]
|
|
Return location for error or NULL. |
Returns : |
TRUE if the call succeded, FALSE if error is set. [skip]
|
void udisks_loop_complete_set_autoclear (UDisksLoop *object,GDBusMethodInvocation *invocation);
Helper function used in service implementations to finish handling invocations of the SetAutoclear() D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar.
This method will free invocation, you cannot use it afterwards.
|
A UDisksLoop. |
|
A GDBusMethodInvocation. [transfer full] |
struct UDisksLoopProxy;
The UDisksLoopProxy structure contains only private data and should only be accessed using the provided API.
struct UDisksLoopProxyClass {
GDBusProxyClass parent_class;
};
Class structure for UDisksLoopProxy.
GDBusProxyClass |
The parent class. |
void udisks_loop_proxy_new (GDBusConnection *connection,GDBusProxyFlags flags,const gchar *name,const gchar *object_path,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data);
Asynchronously creates a proxy for the D-Bus interface org.freedesktop.UDisks2.Loop. See g_dbus_proxy_new() for more details.
When the operation is finished, callback will be invoked in the thread-default main loop of the thread you are calling this method from.
You can then call udisks_loop_proxy_new_finish() to get the result of the operation.
See udisks_loop_proxy_new_sync() for the synchronous, blocking version of this constructor.
|
A GDBusConnection. |
|
Flags from the GDBusProxyFlags enumeration. |
|
A bus name (well-known or unique) or NULL if connection is not a message bus connection. [allow-none]
|
|
An object path. |
|
A GCancellable or NULL. [allow-none]
|
|
A GAsyncReadyCallback to call when the request is satisfied. |
|
User data to pass to callback. |
UDisksLoop * udisks_loop_proxy_new_finish (GAsyncResult *res,GError **error);
Finishes an operation started with udisks_loop_proxy_new().
|
The GAsyncResult obtained from the GAsyncReadyCallback passed to udisks_loop_proxy_new(). |
|
Return location for error or NULL
|
Returns : |
The constructed proxy object or NULL if error is set. [transfer full][type UDisksLoopProxy]
|
UDisksLoop * udisks_loop_proxy_new_sync (GDBusConnection *connection,GDBusProxyFlags flags,const gchar *name,const gchar *object_path,GCancellable *cancellable,GError **error);
Synchronously creates a proxy for the D-Bus interface org.freedesktop.UDisks2.Loop. See g_dbus_proxy_new_sync() for more details.
The calling thread is blocked until a reply is received.
See udisks_loop_proxy_new() for the asynchronous version of this constructor.
|
A GDBusConnection. |
|
Flags from the GDBusProxyFlags enumeration. |
|
A bus name (well-known or unique) or NULL if connection is not a message bus connection. [allow-none]
|
|
An object path. |
|
A GCancellable or NULL. [allow-none]
|
|
Return location for error or NULL
|
Returns : |
The constructed proxy object or NULL if error is set. [transfer full][type UDisksLoopProxy]
|
void udisks_loop_proxy_new_for_bus (GBusType bus_type,GDBusProxyFlags flags,const gchar *name,const gchar *object_path,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data);
Like udisks_loop_proxy_new() but takes a GBusType instead of a GDBusConnection.
When the operation is finished, callback will be invoked in the thread-default main loop of the thread you are calling this method from.
You can then call udisks_loop_proxy_new_for_bus_finish() to get the result of the operation.
See udisks_loop_proxy_new_for_bus_sync() for the synchronous, blocking version of this constructor.
|
A GBusType. |
|
Flags from the GDBusProxyFlags enumeration. |
|
A bus name (well-known or unique). |
|
An object path. |
|
A GCancellable or NULL. [allow-none]
|
|
A GAsyncReadyCallback to call when the request is satisfied. |
|
User data to pass to callback. |
UDisksLoop * udisks_loop_proxy_new_for_bus_finish (GAsyncResult *res,GError **error);
Finishes an operation started with udisks_loop_proxy_new_for_bus().
|
The GAsyncResult obtained from the GAsyncReadyCallback passed to udisks_loop_proxy_new_for_bus(). |
|
Return location for error or NULL
|
Returns : |
The constructed proxy object or NULL if error is set. [transfer full][type UDisksLoopProxy]
|
UDisksLoop * udisks_loop_proxy_new_for_bus_sync (GBusType bus_type,GDBusProxyFlags flags,const gchar *name,const gchar *object_path,GCancellable *cancellable,GError **error);
Like udisks_loop_proxy_new_sync() but takes a GBusType instead of a GDBusConnection.
The calling thread is blocked until a reply is received.
See udisks_loop_proxy_new_for_bus() for the asynchronous version of this constructor.
|
A GBusType. |
|
Flags from the GDBusProxyFlags enumeration. |
|
A bus name (well-known or unique). |
|
An object path. |
|
A GCancellable or NULL. [allow-none]
|
|
Return location for error or NULL
|
Returns : |
The constructed proxy object or NULL if error is set. [transfer full][type UDisksLoopProxy]
|
struct UDisksLoopSkeleton;
The UDisksLoopSkeleton structure contains only private data and should only be accessed using the provided API.
struct UDisksLoopSkeletonClass {
GDBusInterfaceSkeletonClass parent_class;
};
Class structure for UDisksLoopSkeleton.
GDBusInterfaceSkeletonClass |
The parent class. |
UDisksLoop * udisks_loop_skeleton_new (void);
Creates a skeleton object for the D-Bus interface org.freedesktop.UDisks2.Loop.
Returns : |
The skeleton object. [transfer full][type UDisksLoopSkeleton] |
"autoclear" property"autoclear" gboolean : Read / Write
Represents the D-Bus property "Autoclear".
Since the D-Bus property for this GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.
Default value: FALSE
"backing-file" property"backing-file" gchar* : Read / Write
Represents the D-Bus property "BackingFile".
Since the D-Bus property for this GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.
Default value: NULL
"setup-by-uid" property"setup-by-uid" guint : Read / Write
Represents the D-Bus property "SetupByUID".
Since the D-Bus property for this GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.
Default value: 0
"handle-delete" signalgboolean user_function (UDisksLoop *object,
GDBusMethodInvocation *invocation,
GVariant *arg_options,
gpointer user_data) : Run Last
Signal emitted when a remote caller is invoking the Delete() D-Bus method.
If a signal handler returns TRUE, it means the signal handler will handle the invocation (e.g. take a reference to invocation and eventually call udisks_loop_complete_delete() or e.g. g_dbus_method_invocation_return_error() on it) and no order signal handlers will run. If no signal handler handles the invocation, the G_DBUS_ERROR_UNKNOWN_METHOD error is returned.
|
A UDisksLoop. |
|
A GDBusMethodInvocation. |
|
Argument passed by remote caller. |
|
user data set when the signal handler was connected. |
Returns : |
TRUE if the invocation was handled, FALSE to let other signal handlers run. |
"handle-set-autoclear" signalgboolean user_function (UDisksLoop *object,
GDBusMethodInvocation *invocation,
gboolean arg_value,
GVariant *arg_options,
gpointer user_data) : Run Last
Signal emitted when a remote caller is invoking the SetAutoclear() D-Bus method.
If a signal handler returns TRUE, it means the signal handler will handle the invocation (e.g. take a reference to invocation and eventually call udisks_loop_complete_set_autoclear() or e.g. g_dbus_method_invocation_return_error() on it) and no order signal handlers will run. If no signal handler handles the invocation, the G_DBUS_ERROR_UNKNOWN_METHOD error is returned.
|
A UDisksLoop. |
|
A GDBusMethodInvocation. |
|
Argument passed by remote caller. |
|
Argument passed by remote caller. |
|
user data set when the signal handler was connected. |
Returns : |
TRUE if the invocation was handled, FALSE to let other signal handlers run. |