| UDisks Reference Manual | ||||
|---|---|---|---|---|
| Top | Description | Object Hierarchy | Implemented Interfaces | Prerequisites | Known Implementations | Properties | Signals | ||||
UDisksSwapspaceUDisksSwapspace — Generated C code for the org.freedesktop.UDisks2.Swapspace D-Bus interface |
UDisksSwapspace; struct UDisksSwapspaceIface; GDBusInterfaceInfo * udisks_swapspace_interface_info (void); guint udisks_swapspace_override_properties (GObjectClass *klass,guint property_id_begin); void udisks_swapspace_call_start (UDisksSwapspace *proxy,GVariant *arg_options,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data); gboolean udisks_swapspace_call_start_finish (UDisksSwapspace *proxy,GAsyncResult *res,GError **error); gboolean udisks_swapspace_call_start_sync (UDisksSwapspace *proxy,GVariant *arg_options,GCancellable *cancellable,GError **error); void udisks_swapspace_complete_start (UDisksSwapspace *object,GDBusMethodInvocation *invocation); void udisks_swapspace_call_stop (UDisksSwapspace *proxy,GVariant *arg_options,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data); gboolean udisks_swapspace_call_stop_finish (UDisksSwapspace *proxy,GAsyncResult *res,GError **error); gboolean udisks_swapspace_call_stop_sync (UDisksSwapspace *proxy,GVariant *arg_options,GCancellable *cancellable,GError **error); void udisks_swapspace_complete_stop (UDisksSwapspace *object,GDBusMethodInvocation *invocation); gboolean udisks_swapspace_get_active (UDisksSwapspace *object); void udisks_swapspace_set_active (UDisksSwapspace *object,gboolean value); struct UDisksSwapspaceProxy; struct UDisksSwapspaceProxyClass; void udisks_swapspace_proxy_new (GDBusConnection *connection,GDBusProxyFlags flags,const gchar *name,const gchar *object_path,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data); UDisksSwapspace * udisks_swapspace_proxy_new_finish (GAsyncResult *res,GError **error); UDisksSwapspace * udisks_swapspace_proxy_new_sync (GDBusConnection *connection,GDBusProxyFlags flags,const gchar *name,const gchar *object_path,GCancellable *cancellable,GError **error); void udisks_swapspace_proxy_new_for_bus (GBusType bus_type,GDBusProxyFlags flags,const gchar *name,const gchar *object_path,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data); UDisksSwapspace * udisks_swapspace_proxy_new_for_bus_finish (GAsyncResult *res,GError **error); UDisksSwapspace * udisks_swapspace_proxy_new_for_bus_sync (GBusType bus_type,GDBusProxyFlags flags,const gchar *name,const gchar *object_path,GCancellable *cancellable,GError **error); struct UDisksSwapspaceSkeleton; struct UDisksSwapspaceSkeletonClass; UDisksSwapspace * udisks_swapspace_skeleton_new (void);
GInterface +----UDisksSwapspace
GObject +----GDBusProxy +----UDisksSwapspaceProxy
GObject +----GDBusInterfaceSkeleton +----UDisksSwapspaceSkeleton +----UDisksLinuxSwapspace
UDisksSwapspaceProxy implements GDBusInterface, GInitable, GAsyncInitable and UDisksSwapspace.
UDisksSwapspaceSkeleton implements GDBusInterface and UDisksSwapspace.
UDisksSwapspace is implemented by UDisksLinuxSwapspace, UDisksSwapspaceProxy and UDisksSwapspaceSkeleton.
This section contains code for working with the org.freedesktop.UDisks2.Swapspace D-Bus interface in C.
typedef struct _UDisksSwapspace UDisksSwapspace;
Abstract interface type for the D-Bus interface org.freedesktop.UDisks2.Swapspace.
struct UDisksSwapspaceIface {
GTypeInterface parent_iface;
gboolean (*handle_start) (
UDisksSwapspace *object,
GDBusMethodInvocation *invocation,
GVariant *arg_options);
gboolean (*handle_stop) (
UDisksSwapspace *object,
GDBusMethodInvocation *invocation,
GVariant *arg_options);
gboolean (*get_active) (UDisksSwapspace *object);
};
Virtual table for the D-Bus interface org.freedesktop.UDisks2.Swapspace.
GTypeInterface |
The parent interface. |
| Handler for the "handle-start" signal. | |
| Handler for the "handle-stop" signal. | |
| Getter for the "active" property. |
GDBusInterfaceInfo * udisks_swapspace_interface_info (void);
Gets a machine-readable description of the org.freedesktop.UDisks2.Swapspace D-Bus interface.
Returns : |
A GDBusInterfaceInfo. Do not free. [transfer none] |
guint udisks_swapspace_override_properties (GObjectClass *klass,guint property_id_begin);
Overrides all GObject properties in the UDisksSwapspace 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. |
void udisks_swapspace_call_start (UDisksSwapspace *proxy,GVariant *arg_options,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data);
Asynchronously invokes the Start() 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_swapspace_call_start_finish() to get the result of the operation.
See udisks_swapspace_call_start_sync() for the synchronous, blocking version of this method.
|
A UDisksSwapspaceProxy. |
|
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_swapspace_call_start_finish (UDisksSwapspace *proxy,GAsyncResult *res,GError **error);
Finishes an operation started with udisks_swapspace_call_start().
|
A UDisksSwapspaceProxy. |
|
The GAsyncResult obtained from the GAsyncReadyCallback passed to udisks_swapspace_call_start(). |
|
Return location for error or NULL. |
Returns : |
TRUE if the call succeded, FALSE if error is set. [skip]
|
gboolean udisks_swapspace_call_start_sync (UDisksSwapspace *proxy,GVariant *arg_options,GCancellable *cancellable,GError **error);
Synchronously invokes the Start() D-Bus method on proxy. The calling thread is blocked until a reply is received.
See udisks_swapspace_call_start() for the asynchronous version of this method.
|
A UDisksSwapspaceProxy. |
|
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_swapspace_complete_start (UDisksSwapspace *object,GDBusMethodInvocation *invocation);
Helper function used in service implementations to finish handling invocations of the Start() 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 UDisksSwapspace. |
|
A GDBusMethodInvocation. [transfer full] |
void udisks_swapspace_call_stop (UDisksSwapspace *proxy,GVariant *arg_options,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data);
Asynchronously invokes the Stop() 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_swapspace_call_stop_finish() to get the result of the operation.
See udisks_swapspace_call_stop_sync() for the synchronous, blocking version of this method.
|
A UDisksSwapspaceProxy. |
|
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_swapspace_call_stop_finish (UDisksSwapspace *proxy,GAsyncResult *res,GError **error);
Finishes an operation started with udisks_swapspace_call_stop().
|
A UDisksSwapspaceProxy. |
|
The GAsyncResult obtained from the GAsyncReadyCallback passed to udisks_swapspace_call_stop(). |
|
Return location for error or NULL. |
Returns : |
TRUE if the call succeded, FALSE if error is set. [skip]
|
gboolean udisks_swapspace_call_stop_sync (UDisksSwapspace *proxy,GVariant *arg_options,GCancellable *cancellable,GError **error);
Synchronously invokes the Stop() D-Bus method on proxy. The calling thread is blocked until a reply is received.
See udisks_swapspace_call_stop() for the asynchronous version of this method.
|
A UDisksSwapspaceProxy. |
|
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_swapspace_complete_stop (UDisksSwapspace *object,GDBusMethodInvocation *invocation);
Helper function used in service implementations to finish handling invocations of the Stop() 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 UDisksSwapspace. |
|
A GDBusMethodInvocation. [transfer full] |
gboolean udisks_swapspace_get_active (UDisksSwapspace *object);
Gets the value of the "Active" 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 UDisksSwapspace. |
Returns : |
The property value. |
void udisks_swapspace_set_active (UDisksSwapspace *object,gboolean value);
Sets the "Active" 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 UDisksSwapspace. |
|
The value to set. |
struct UDisksSwapspaceProxy;
The UDisksSwapspaceProxy structure contains only private data and should only be accessed using the provided API.
struct UDisksSwapspaceProxyClass {
GDBusProxyClass parent_class;
};
Class structure for UDisksSwapspaceProxy.
GDBusProxyClass |
The parent class. |
void udisks_swapspace_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.Swapspace. 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_swapspace_proxy_new_finish() to get the result of the operation.
See udisks_swapspace_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. |
UDisksSwapspace * udisks_swapspace_proxy_new_finish (GAsyncResult *res,GError **error);
Finishes an operation started with udisks_swapspace_proxy_new().
|
The GAsyncResult obtained from the GAsyncReadyCallback passed to udisks_swapspace_proxy_new(). |
|
Return location for error or NULL
|
Returns : |
The constructed proxy object or NULL if error is set. [transfer full][type UDisksSwapspaceProxy]
|
UDisksSwapspace * udisks_swapspace_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.Swapspace. See g_dbus_proxy_new_sync() for more details.
The calling thread is blocked until a reply is received.
See udisks_swapspace_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 UDisksSwapspaceProxy]
|
void udisks_swapspace_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_swapspace_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_swapspace_proxy_new_for_bus_finish() to get the result of the operation.
See udisks_swapspace_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. |
UDisksSwapspace * udisks_swapspace_proxy_new_for_bus_finish (GAsyncResult *res,GError **error);
Finishes an operation started with udisks_swapspace_proxy_new_for_bus().
|
The GAsyncResult obtained from the GAsyncReadyCallback passed to udisks_swapspace_proxy_new_for_bus(). |
|
Return location for error or NULL
|
Returns : |
The constructed proxy object or NULL if error is set. [transfer full][type UDisksSwapspaceProxy]
|
UDisksSwapspace * udisks_swapspace_proxy_new_for_bus_sync (GBusType bus_type,GDBusProxyFlags flags,const gchar *name,const gchar *object_path,GCancellable *cancellable,GError **error);
Like udisks_swapspace_proxy_new_sync() but takes a GBusType instead of a GDBusConnection.
The calling thread is blocked until a reply is received.
See udisks_swapspace_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 UDisksSwapspaceProxy]
|
struct UDisksSwapspaceSkeleton;
The UDisksSwapspaceSkeleton structure contains only private data and should only be accessed using the provided API.
struct UDisksSwapspaceSkeletonClass {
GDBusInterfaceSkeletonClass parent_class;
};
Class structure for UDisksSwapspaceSkeleton.
GDBusInterfaceSkeletonClass |
The parent class. |
UDisksSwapspace * udisks_swapspace_skeleton_new (void);
Creates a skeleton object for the D-Bus interface org.freedesktop.UDisks2.Swapspace.
Returns : |
The skeleton object. [transfer full][type UDisksSwapspaceSkeleton] |
"active" property"active" gboolean : Read / Write
Represents the D-Bus property "Active".
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
"handle-start" signalgboolean user_function (UDisksSwapspace *object,
GDBusMethodInvocation *invocation,
GVariant *arg_options,
gpointer user_data) : Run Last
Signal emitted when a remote caller is invoking the Start() 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_swapspace_complete_start() 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 UDisksSwapspace. |
|
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-stop" signalgboolean user_function (UDisksSwapspace *object,
GDBusMethodInvocation *invocation,
GVariant *arg_options,
gpointer user_data) : Run Last
Signal emitted when a remote caller is invoking the Stop() 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_swapspace_complete_stop() 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 UDisksSwapspace. |
|
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. |