StoragedSwapspace

StoragedSwapspace — Generated C code for the org.storaged.Storaged.Swapspace D-Bus interface

Synopsis

                    StoragedSwapspace;
struct              StoragedSwapspaceIface;
GDBusInterfaceInfo * storaged_swapspace_interface_info  (void);
guint               storaged_swapspace_override_properties
                                                        (GObjectClass *klass,
                                                         guint property_id_begin);
void                storaged_swapspace_call_start       (StoragedSwapspace *proxy,
                                                         GVariant *arg_options,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);
gboolean            storaged_swapspace_call_start_finish
                                                        (StoragedSwapspace *proxy,
                                                         GAsyncResult *res,
                                                         GError **error);
gboolean            storaged_swapspace_call_start_sync  (StoragedSwapspace *proxy,
                                                         GVariant *arg_options,
                                                         GCancellable *cancellable,
                                                         GError **error);
void                storaged_swapspace_complete_start   (StoragedSwapspace *object,
                                                         GDBusMethodInvocation *invocation);
void                storaged_swapspace_call_stop        (StoragedSwapspace *proxy,
                                                         GVariant *arg_options,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);
gboolean            storaged_swapspace_call_stop_finish (StoragedSwapspace *proxy,
                                                         GAsyncResult *res,
                                                         GError **error);
gboolean            storaged_swapspace_call_stop_sync   (StoragedSwapspace *proxy,
                                                         GVariant *arg_options,
                                                         GCancellable *cancellable,
                                                         GError **error);
void                storaged_swapspace_complete_stop    (StoragedSwapspace *object,
                                                         GDBusMethodInvocation *invocation);
gboolean            storaged_swapspace_get_active       (StoragedSwapspace *object);
void                storaged_swapspace_set_active       (StoragedSwapspace *object,
                                                         gboolean value);
struct              StoragedSwapspaceProxy;
struct              StoragedSwapspaceProxyClass;
void                storaged_swapspace_proxy_new        (GDBusConnection *connection,
                                                         GDBusProxyFlags flags,
                                                         const gchar *name,
                                                         const gchar *object_path,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);
StoragedSwapspace * storaged_swapspace_proxy_new_finish (GAsyncResult *res,
                                                         GError **error);
StoragedSwapspace * storaged_swapspace_proxy_new_sync   (GDBusConnection *connection,
                                                         GDBusProxyFlags flags,
                                                         const gchar *name,
                                                         const gchar *object_path,
                                                         GCancellable *cancellable,
                                                         GError **error);
void                storaged_swapspace_proxy_new_for_bus
                                                        (GBusType bus_type,
                                                         GDBusProxyFlags flags,
                                                         const gchar *name,
                                                         const gchar *object_path,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);
StoragedSwapspace * storaged_swapspace_proxy_new_for_bus_finish
                                                        (GAsyncResult *res,
                                                         GError **error);
StoragedSwapspace * storaged_swapspace_proxy_new_for_bus_sync
                                                        (GBusType bus_type,
                                                         GDBusProxyFlags flags,
                                                         const gchar *name,
                                                         const gchar *object_path,
                                                         GCancellable *cancellable,
                                                         GError **error);
struct              StoragedSwapspaceSkeleton;
struct              StoragedSwapspaceSkeletonClass;
StoragedSwapspace * storaged_swapspace_skeleton_new     (void);

Object Hierarchy

  GInterface
   +----StoragedSwapspace

  GObject
   +----GDBusProxy
         +----StoragedSwapspaceProxy

  GObject
   +----GDBusInterfaceSkeleton
         +----StoragedSwapspaceSkeleton
               +----StoragedLinuxSwapspace

Prerequisites

StoragedSwapspace requires GObject.

Implemented Interfaces

StoragedSwapspaceProxy implements GDBusInterface, GInitable, GAsyncInitable and StoragedSwapspace.

StoragedSwapspaceSkeleton implements GDBusInterface and StoragedSwapspace.

Known Implementations

StoragedSwapspace is implemented by StoragedLinuxSwapspace, StoragedSwapspaceProxy and StoragedSwapspaceSkeleton.

Properties

  "active"                   gboolean              : Read / Write

Signals

  "handle-start"                                   : Run Last
  "handle-stop"                                    : Run Last

Description

This section contains code for working with the org.storaged.Storaged.Swapspace D-Bus interface in C.

Details

StoragedSwapspace

typedef struct _StoragedSwapspace StoragedSwapspace;

Abstract interface type for the D-Bus interface org.storaged.Storaged.Swapspace.

struct StoragedSwapspaceIface

struct StoragedSwapspaceIface {
  GTypeInterface parent_iface;


  gboolean (*handle_start) (
    StoragedSwapspace *object,
    GDBusMethodInvocation *invocation,
    GVariant *arg_options);

  gboolean (*handle_stop) (
    StoragedSwapspace *object,
    GDBusMethodInvocation *invocation,
    GVariant *arg_options);

  gboolean  (*get_active) (StoragedSwapspace *object);
};

Virtual table for the D-Bus interface org.storaged.Storaged.Swapspace.

GTypeInterface parent_iface;

 The parent interface.

handle_start ()

 Handler for the "handle-start" signal.

handle_stop ()

 Handler for the "handle-stop" signal.

get_active ()

 Getter for the "active" property.

storaged_swapspace_interface_info ()

GDBusInterfaceInfo * storaged_swapspace_interface_info  (void);

Gets a machine-readable description of the org.storaged.Storaged.Swapspace D-Bus interface.

Returns :

 A GDBusInterfaceInfo. Do not free. [transfer none]

storaged_swapspace_override_properties ()

guint               storaged_swapspace_override_properties
                                                        (GObjectClass *klass,
                                                         guint property_id_begin);

Overrides all GObject properties in the StoragedSwapspace interface for a concrete class. The properties are overridden in the order they are defined.

klass :

 The class structure for a GObject-derived class.

property_id_begin :

 The property id to assign to the first overridden property.

Returns :

 The last property id.

storaged_swapspace_call_start ()

void                storaged_swapspace_call_start       (StoragedSwapspace *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 storaged_swapspace_call_start_finish() to get the result of the operation.

See storaged_swapspace_call_start_sync() for the synchronous, blocking version of this method.

proxy :

 A StoragedSwapspaceProxy.

arg_options :

 Argument to pass with the method invocation.

cancellable :

 A GCancellable or NULL. [allow-none]

callback :

 A GAsyncReadyCallback to call when the request is satisfied or NULL.

user_data :

 User data to pass to callback.

storaged_swapspace_call_start_finish ()

gboolean            storaged_swapspace_call_start_finish
                                                        (StoragedSwapspace *proxy,
                                                         GAsyncResult *res,
                                                         GError **error);

Finishes an operation started with storaged_swapspace_call_start().

proxy :

 A StoragedSwapspaceProxy.

res :

 The GAsyncResult obtained from the GAsyncReadyCallback passed to storaged_swapspace_call_start().

error :

 Return location for error or NULL.

Returns :

 TRUE if the call succeded, FALSE if error is set. [skip]

storaged_swapspace_call_start_sync ()

gboolean            storaged_swapspace_call_start_sync  (StoragedSwapspace *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 storaged_swapspace_call_start() for the asynchronous version of this method.

proxy :

 A StoragedSwapspaceProxy.

arg_options :

 Argument to pass with the method invocation.

cancellable :

 A GCancellable or NULL. [allow-none]

error :

 Return location for error or NULL.

Returns :

 TRUE if the call succeded, FALSE if error is set. [skip]

storaged_swapspace_complete_start ()

void                storaged_swapspace_complete_start   (StoragedSwapspace *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.

object :

 A StoragedSwapspace.

invocation :

 A GDBusMethodInvocation. [transfer full]

storaged_swapspace_call_stop ()

void                storaged_swapspace_call_stop        (StoragedSwapspace *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 storaged_swapspace_call_stop_finish() to get the result of the operation.

See storaged_swapspace_call_stop_sync() for the synchronous, blocking version of this method.

proxy :

 A StoragedSwapspaceProxy.

arg_options :

 Argument to pass with the method invocation.

cancellable :

 A GCancellable or NULL. [allow-none]

callback :

 A GAsyncReadyCallback to call when the request is satisfied or NULL.

user_data :

 User data to pass to callback.

storaged_swapspace_call_stop_finish ()

gboolean            storaged_swapspace_call_stop_finish (StoragedSwapspace *proxy,
                                                         GAsyncResult *res,
                                                         GError **error);

Finishes an operation started with storaged_swapspace_call_stop().

proxy :

 A StoragedSwapspaceProxy.

res :

 The GAsyncResult obtained from the GAsyncReadyCallback passed to storaged_swapspace_call_stop().

error :

 Return location for error or NULL.

Returns :

 TRUE if the call succeded, FALSE if error is set. [skip]

storaged_swapspace_call_stop_sync ()

gboolean            storaged_swapspace_call_stop_sync   (StoragedSwapspace *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 storaged_swapspace_call_stop() for the asynchronous version of this method.

proxy :

 A StoragedSwapspaceProxy.

arg_options :

 Argument to pass with the method invocation.

cancellable :

 A GCancellable or NULL. [allow-none]

error :

 Return location for error or NULL.

Returns :

 TRUE if the call succeded, FALSE if error is set. [skip]

storaged_swapspace_complete_stop ()

void                storaged_swapspace_complete_stop    (StoragedSwapspace *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.

object :

 A StoragedSwapspace.

invocation :

 A GDBusMethodInvocation. [transfer full]

storaged_swapspace_get_active ()

gboolean            storaged_swapspace_get_active       (StoragedSwapspace *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.

object :

 A StoragedSwapspace.

Returns :

 The property value.

storaged_swapspace_set_active ()

void                storaged_swapspace_set_active       (StoragedSwapspace *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.

object :

 A StoragedSwapspace.

value :

 The value to set.

struct StoragedSwapspaceProxy

struct StoragedSwapspaceProxy;

The StoragedSwapspaceProxy structure contains only private data and should only be accessed using the provided API.

struct StoragedSwapspaceProxyClass

struct StoragedSwapspaceProxyClass {
  GDBusProxyClass parent_class;
};

Class structure for StoragedSwapspaceProxy.

GDBusProxyClass parent_class;

 The parent class.

storaged_swapspace_proxy_new ()

void                storaged_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.storaged.Storaged.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 storaged_swapspace_proxy_new_finish() to get the result of the operation.

See storaged_swapspace_proxy_new_sync() for the synchronous, blocking version of this constructor.

connection :

 A GDBusConnection.

flags :

 Flags from the GDBusProxyFlags enumeration.

name :

 A bus name (well-known or unique) or NULL if connection is not a message bus connection. [allow-none]

object_path :

 An object path.

cancellable :

 A GCancellable or NULL. [allow-none]

callback :

 A GAsyncReadyCallback to call when the request is satisfied.

user_data :

 User data to pass to callback.

storaged_swapspace_proxy_new_finish ()

StoragedSwapspace * storaged_swapspace_proxy_new_finish (GAsyncResult *res,
                                                         GError **error);

Finishes an operation started with storaged_swapspace_proxy_new().

res :

 The GAsyncResult obtained from the GAsyncReadyCallback passed to storaged_swapspace_proxy_new().

error :

 Return location for error or NULL

Returns :

 The constructed proxy object or NULL if error is set. [transfer full][type StoragedSwapspaceProxy]

storaged_swapspace_proxy_new_sync ()

StoragedSwapspace * storaged_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.storaged.Storaged.Swapspace. See g_dbus_proxy_new_sync() for more details.

The calling thread is blocked until a reply is received.

See storaged_swapspace_proxy_new() for the asynchronous version of this constructor.

connection :

 A GDBusConnection.

flags :

 Flags from the GDBusProxyFlags enumeration.

name :

 A bus name (well-known or unique) or NULL if connection is not a message bus connection. [allow-none]

object_path :

 An object path.

cancellable :

 A GCancellable or NULL. [allow-none]

error :

 Return location for error or NULL

Returns :

 The constructed proxy object or NULL if error is set. [transfer full][type StoragedSwapspaceProxy]

storaged_swapspace_proxy_new_for_bus ()

void                storaged_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 storaged_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 storaged_swapspace_proxy_new_for_bus_finish() to get the result of the operation.

See storaged_swapspace_proxy_new_for_bus_sync() for the synchronous, blocking version of this constructor.

bus_type :

 A GBusType.

flags :

 Flags from the GDBusProxyFlags enumeration.

name :

 A bus name (well-known or unique).

object_path :

 An object path.

cancellable :

 A GCancellable or NULL. [allow-none]

callback :

 A GAsyncReadyCallback to call when the request is satisfied.

user_data :

 User data to pass to callback.

storaged_swapspace_proxy_new_for_bus_finish ()

StoragedSwapspace * storaged_swapspace_proxy_new_for_bus_finish
                                                        (GAsyncResult *res,
                                                         GError **error);

Finishes an operation started with storaged_swapspace_proxy_new_for_bus().

res :

 The GAsyncResult obtained from the GAsyncReadyCallback passed to storaged_swapspace_proxy_new_for_bus().

error :

 Return location for error or NULL

Returns :

 The constructed proxy object or NULL if error is set. [transfer full][type StoragedSwapspaceProxy]

storaged_swapspace_proxy_new_for_bus_sync ()

StoragedSwapspace * storaged_swapspace_proxy_new_for_bus_sync
                                                        (GBusType bus_type,
                                                         GDBusProxyFlags flags,
                                                         const gchar *name,
                                                         const gchar *object_path,
                                                         GCancellable *cancellable,
                                                         GError **error);

Like storaged_swapspace_proxy_new_sync() but takes a GBusType instead of a GDBusConnection.

The calling thread is blocked until a reply is received.

See storaged_swapspace_proxy_new_for_bus() for the asynchronous version of this constructor.

bus_type :

 A GBusType.

flags :

 Flags from the GDBusProxyFlags enumeration.

name :

 A bus name (well-known or unique).

object_path :

 An object path.

cancellable :

 A GCancellable or NULL. [allow-none]

error :

 Return location for error or NULL

Returns :

 The constructed proxy object or NULL if error is set. [transfer full][type StoragedSwapspaceProxy]

struct StoragedSwapspaceSkeleton

struct StoragedSwapspaceSkeleton;

The StoragedSwapspaceSkeleton structure contains only private data and should only be accessed using the provided API.

struct StoragedSwapspaceSkeletonClass

struct StoragedSwapspaceSkeletonClass {
  GDBusInterfaceSkeletonClass parent_class;
};

Class structure for StoragedSwapspaceSkeleton.

GDBusInterfaceSkeletonClass parent_class;

 The parent class.

storaged_swapspace_skeleton_new ()

StoragedSwapspace * storaged_swapspace_skeleton_new     (void);

Creates a skeleton object for the D-Bus interface org.storaged.Storaged.Swapspace.

Returns :

 The skeleton object. [transfer full][type StoragedSwapspaceSkeleton]

Property Details

The "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

Signal Details

The "handle-start" signal

gboolean            user_function                      (StoragedSwapspace     *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 storaged_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.

object :

 A StoragedSwapspace.

invocation :

 A GDBusMethodInvocation.

arg_options :

 Argument passed by remote caller.

user_data :

 user data set when the signal handler was connected.

Returns :

 TRUE if the invocation was handled, FALSE to let other signal handlers run.

The "handle-stop" signal

gboolean            user_function                      (StoragedSwapspace     *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 storaged_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.

object :

 A StoragedSwapspace.

invocation :

 A GDBusMethodInvocation.

arg_options :

 Argument passed by remote caller.

user_data :

 user data set when the signal handler was connected.

Returns :

 TRUE if the invocation was handled, FALSE to let other signal handlers run.
Generated by GTK-Doc V1.19