PhoshLogin1ManagerDBusLoginManagerSkeleton

PhoshLogin1ManagerDBusLoginManagerSkeleton

Functions

Signals

Types and Values

Object Hierarchy

    GInterface
    ╰── PhoshLogin1ManagerDBusLoginManager
    GObject
    ├── GDBusInterfaceSkeleton
       ╰── PhoshLogin1ManagerDBusLoginManagerSkeleton
    ╰── GDBusProxy
        ╰── PhoshLogin1ManagerDBusLoginManagerProxy

Prerequisites

PhoshLogin1ManagerDBusLoginManager requires GObject.

Implemented Interfaces

PhoshLogin1ManagerDBusLoginManagerProxy implements GDBusInterface, GInitable, GAsyncInitable and PhoshLogin1ManagerDBusLoginManager.

PhoshLogin1ManagerDBusLoginManagerSkeleton implements GDBusInterface and PhoshLogin1ManagerDBusLoginManager.

Known Implementations

PhoshLogin1ManagerDBusLoginManager is implemented by PhoshLogin1ManagerDBusLoginManagerProxy and PhoshLogin1ManagerDBusLoginManagerSkeleton.

Description

Functions

phosh_login1_manager_dbus_login_manager_interface_info ()

GDBusInterfaceInfo *
phosh_login1_manager_dbus_login_manager_interface_info
                               (void);

Gets a machine-readable description of the org.freedesktop.login1.Manager D-Bus interface.

Returns

A GDBusInterfaceInfo. Do not free.

[transfer none]


phosh_login1_manager_dbus_login_manager_override_properties ()

guint
phosh_login1_manager_dbus_login_manager_override_properties
                               (GObjectClass *klass,
                                guint property_id_begin);

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

Parameters

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.


phosh_login1_manager_dbus_login_manager_complete_get_session ()

void
phosh_login1_manager_dbus_login_manager_complete_get_session
                               (PhoshLogin1ManagerDBusLoginManager *object,
                                GDBusMethodInvocation *invocation,
                                const gchar *object_path);

Helper function used in service implementations to finish handling invocations of the GetSession() 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.

Parameters

object

A PhoshLogin1ManagerDBusLoginManager.

 

invocation

A GDBusMethodInvocation.

[transfer full]

object_path

Parameter to return.

 

phosh_login1_manager_dbus_login_manager_complete_inhibit ()

void
phosh_login1_manager_dbus_login_manager_complete_inhibit
                               (PhoshLogin1ManagerDBusLoginManager *object,
                                GDBusMethodInvocation *invocation,
                                GUnixFDList *fd_list,
                                GVariant *pipe_fd);

Helper function used in service implementations to finish handling invocations of the Inhibit() 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.

Parameters

object

A PhoshLogin1ManagerDBusLoginManager.

 

invocation

A GDBusMethodInvocation.

[transfer full]

fd_list

A GUnixFDList or NULL.

[nullable]

pipe_fd

Parameter to return.

 

phosh_login1_manager_dbus_login_manager_emit_prepare_for_sleep ()

void
phosh_login1_manager_dbus_login_manager_emit_prepare_for_sleep
                               (PhoshLogin1ManagerDBusLoginManager *object,
                                gboolean arg_start);

Emits the "PrepareForSleep" D-Bus signal.

Parameters

object

A PhoshLogin1ManagerDBusLoginManager.

 

arg_start

Argument to pass with the signal.

 

phosh_login1_manager_dbus_login_manager_call_get_session ()

void
phosh_login1_manager_dbus_login_manager_call_get_session
                               (PhoshLogin1ManagerDBusLoginManager *proxy,
                                const gchar *arg_session_id,
                                GCancellable *cancellable,
                                GAsyncReadyCallback callback,
                                gpointer user_data);

Asynchronously invokes the GetSession() 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 phosh_login1_manager_dbus_login_manager_call_get_session_finish() to get the result of the operation.

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

Parameters

proxy

A PhoshLogin1ManagerDBusLoginManagerProxy.

 

arg_session_id

Argument to pass with the method invocation.

 

cancellable

A GCancellable or NULL.

[nullable]

callback

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

 

user_data

User data to pass to callback .

 

phosh_login1_manager_dbus_login_manager_call_get_session_finish ()

gboolean
phosh_login1_manager_dbus_login_manager_call_get_session_finish
                               (PhoshLogin1ManagerDBusLoginManager *proxy,
                                gchar **out_object_path,
                                GAsyncResult *res,
                                GError **error);

Finishes an operation started with phosh_login1_manager_dbus_login_manager_call_get_session().

Parameters

proxy

A PhoshLogin1ManagerDBusLoginManagerProxy.

 

out_object_path

Return location for return parameter or NULL to ignore.

[out]

res

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

 

error

Return location for error or NULL.

 

Returns

TRUE if the call succeded, FALSE if error is set.

[skip]


phosh_login1_manager_dbus_login_manager_call_get_session_sync ()

gboolean
phosh_login1_manager_dbus_login_manager_call_get_session_sync
                               (PhoshLogin1ManagerDBusLoginManager *proxy,
                                const gchar *arg_session_id,
                                gchar **out_object_path,
                                GCancellable *cancellable,
                                GError **error);

Synchronously invokes the GetSession() D-Bus method on proxy . The calling thread is blocked until a reply is received.

See phosh_login1_manager_dbus_login_manager_call_get_session() for the asynchronous version of this method.

Parameters

proxy

A PhoshLogin1ManagerDBusLoginManagerProxy.

 

arg_session_id

Argument to pass with the method invocation.

 

out_object_path

Return location for return parameter or NULL to ignore.

[out]

cancellable

A GCancellable or NULL.

[nullable]

error

Return location for error or NULL.

 

Returns

TRUE if the call succeded, FALSE if error is set.

[skip]


phosh_login1_manager_dbus_login_manager_call_inhibit ()

void
phosh_login1_manager_dbus_login_manager_call_inhibit
                               (PhoshLogin1ManagerDBusLoginManager *proxy,
                                const gchar *arg_what,
                                const gchar *arg_who,
                                const gchar *arg_why,
                                const gchar *arg_mode,
                                GUnixFDList *fd_list,
                                GCancellable *cancellable,
                                GAsyncReadyCallback callback,
                                gpointer user_data);

Asynchronously invokes the Inhibit() 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 phosh_login1_manager_dbus_login_manager_call_inhibit_finish() to get the result of the operation.

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

Parameters

proxy

A PhoshLogin1ManagerDBusLoginManagerProxy.

 

arg_what

Argument to pass with the method invocation.

 

arg_who

Argument to pass with the method invocation.

 

arg_why

Argument to pass with the method invocation.

 

arg_mode

Argument to pass with the method invocation.

 

fd_list

A GUnixFDList or NULL.

[nullable]

cancellable

A GCancellable or NULL.

[nullable]

callback

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

 

user_data

User data to pass to callback .

 

phosh_login1_manager_dbus_login_manager_call_inhibit_finish ()

gboolean
phosh_login1_manager_dbus_login_manager_call_inhibit_finish
                               (PhoshLogin1ManagerDBusLoginManager *proxy,
                                GVariant **out_pipe_fd,
                                GUnixFDList **out_fd_list,
                                GAsyncResult *res,
                                GError **error);

Finishes an operation started with phosh_login1_manager_dbus_login_manager_call_inhibit().

Parameters

proxy

A PhoshLogin1ManagerDBusLoginManagerProxy.

 

out_pipe_fd

Return location for return parameter or NULL to ignore.

[out]

out_fd_list

Return location for a GUnixFDList or NULL.

[out]

res

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

 

error

Return location for error or NULL.

 

Returns

TRUE if the call succeded, FALSE if error is set.

[skip]


phosh_login1_manager_dbus_login_manager_call_inhibit_sync ()

gboolean
phosh_login1_manager_dbus_login_manager_call_inhibit_sync
                               (PhoshLogin1ManagerDBusLoginManager *proxy,
                                const gchar *arg_what,
                                const gchar *arg_who,
                                const gchar *arg_why,
                                const gchar *arg_mode,
                                GUnixFDList *fd_list,
                                GVariant **out_pipe_fd,
                                GUnixFDList **out_fd_list,
                                GCancellable *cancellable,
                                GError **error);

Synchronously invokes the Inhibit() D-Bus method on proxy . The calling thread is blocked until a reply is received.

See phosh_login1_manager_dbus_login_manager_call_inhibit() for the asynchronous version of this method.

Parameters

proxy

A PhoshLogin1ManagerDBusLoginManagerProxy.

 

arg_what

Argument to pass with the method invocation.

 

arg_who

Argument to pass with the method invocation.

 

arg_why

Argument to pass with the method invocation.

 

arg_mode

Argument to pass with the method invocation.

 

fd_list

A GUnixFDList or NULL.

[nullable]

out_pipe_fd

Return location for return parameter or NULL to ignore.

[out]

out_fd_list

Return location for a GUnixFDList or NULL.

[out]

cancellable

A GCancellable or NULL.

[nullable]

error

Return location for error or NULL.

 

Returns

TRUE if the call succeded, FALSE if error is set.

[skip]


phosh_login1_manager_dbus_login_manager_proxy_new ()

void
phosh_login1_manager_dbus_login_manager_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.login1.Manager. 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 phosh_login1_manager_dbus_login_manager_proxy_new_finish() to get the result of the operation.

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

Parameters

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.

[nullable]

object_path

An object path.

 

cancellable

A GCancellable or NULL.

[nullable]

callback

A GAsyncReadyCallback to call when the request is satisfied.

 

user_data

User data to pass to callback .

 

phosh_login1_manager_dbus_login_manager_proxy_new_finish ()

PhoshLogin1ManagerDBusLoginManager *
phosh_login1_manager_dbus_login_manager_proxy_new_finish
                               (GAsyncResult *res,
                                GError **error);

Finishes an operation started with phosh_login1_manager_dbus_login_manager_proxy_new().

Parameters

res

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

 

error

Return location for error or NULL

 

Returns

The constructed proxy object or NULL if error is set.

[transfer full][type PhoshLogin1ManagerDBusLoginManagerProxy]


phosh_login1_manager_dbus_login_manager_proxy_new_sync ()

PhoshLogin1ManagerDBusLoginManager *
phosh_login1_manager_dbus_login_manager_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.login1.Manager. See g_dbus_proxy_new_sync() for more details.

The calling thread is blocked until a reply is received.

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

Parameters

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.

[nullable]

object_path

An object path.

 

cancellable

A GCancellable or NULL.

[nullable]

error

Return location for error or NULL

 

Returns

The constructed proxy object or NULL if error is set.

[transfer full][type PhoshLogin1ManagerDBusLoginManagerProxy]


phosh_login1_manager_dbus_login_manager_proxy_new_for_bus ()

void
phosh_login1_manager_dbus_login_manager_proxy_new_for_bus
                               (GBusType bus_type,
                                GDBusProxyFlags flags,
                                const gchar *name,
                                const gchar *object_path,
                                GCancellable *cancellable,
                                GAsyncReadyCallback callback,
                                gpointer user_data);

Like phosh_login1_manager_dbus_login_manager_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 phosh_login1_manager_dbus_login_manager_proxy_new_for_bus_finish() to get the result of the operation.

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

Parameters

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.

[nullable]

callback

A GAsyncReadyCallback to call when the request is satisfied.

 

user_data

User data to pass to callback .

 

phosh_login1_manager_dbus_login_manager_proxy_new_for_bus_finish ()

PhoshLogin1ManagerDBusLoginManager *
phosh_login1_manager_dbus_login_manager_proxy_new_for_bus_finish
                               (GAsyncResult *res,
                                GError **error);

Finishes an operation started with phosh_login1_manager_dbus_login_manager_proxy_new_for_bus().

Parameters

res

The GAsyncResult obtained from the GAsyncReadyCallback passed to phosh_login1_manager_dbus_login_manager_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 PhoshLogin1ManagerDBusLoginManagerProxy]


phosh_login1_manager_dbus_login_manager_proxy_new_for_bus_sync ()

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

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

The calling thread is blocked until a reply is received.

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

Parameters

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.

[nullable]

error

Return location for error or NULL

 

Returns

The constructed proxy object or NULL if error is set.

[transfer full][type PhoshLogin1ManagerDBusLoginManagerProxy]


phosh_login1_manager_dbus_login_manager_skeleton_new ()

PhoshLogin1ManagerDBusLoginManager *
phosh_login1_manager_dbus_login_manager_skeleton_new
                               (void);

Creates a skeleton object for the D-Bus interface org.freedesktop.login1.Manager.

Returns

The skeleton object.

[transfer full][type PhoshLogin1ManagerDBusLoginManagerSkeleton]

Types and Values

struct PhoshLogin1ManagerDBusLoginManagerIface

struct PhoshLogin1ManagerDBusLoginManagerIface {
  GTypeInterface parent_iface;


  gboolean (*handle_get_session) (
    PhoshLogin1ManagerDBusLoginManager *object,
    GDBusMethodInvocation *invocation,
    const gchar *arg_session_id);

  gboolean (*handle_inhibit) (
    PhoshLogin1ManagerDBusLoginManager *object,
    GDBusMethodInvocation *invocation,
    GUnixFDList *fd_list,
    const gchar *arg_what,
    const gchar *arg_who,
    const gchar *arg_why,
    const gchar *arg_mode);

  void (*prepare_for_sleep) (
    PhoshLogin1ManagerDBusLoginManager *object,
    gboolean arg_start);
};

Virtual table for the D-Bus interface org.freedesktop.login1.Manager.

Members

GTypeInterface parent_iface;

The parent interface.

 

handle_get_session ()

Handler for the “handle-get-session” signal.

 

handle_inhibit ()

Handler for the “handle-inhibit” signal.

 

prepare_for_sleep ()

Handler for the “prepare-for-sleep” signal.

 

struct PhoshLogin1ManagerDBusLoginManagerProxy

struct PhoshLogin1ManagerDBusLoginManagerProxy;

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


struct PhoshLogin1ManagerDBusLoginManagerProxyClass

struct PhoshLogin1ManagerDBusLoginManagerProxyClass {
  GDBusProxyClass parent_class;
};

Class structure for PhoshLogin1ManagerDBusLoginManagerProxy.

Members


struct PhoshLogin1ManagerDBusLoginManagerSkeleton

struct PhoshLogin1ManagerDBusLoginManagerSkeleton;

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


struct PhoshLogin1ManagerDBusLoginManagerSkeletonClass

struct PhoshLogin1ManagerDBusLoginManagerSkeletonClass {
  GDBusInterfaceSkeletonClass parent_class;
};

Class structure for PhoshLogin1ManagerDBusLoginManagerSkeleton.

Members


PhoshLogin1ManagerDBusLoginManager

typedef struct _PhoshLogin1ManagerDBusLoginManager PhoshLogin1ManagerDBusLoginManager;

Abstract interface type for the D-Bus interface org.freedesktop.login1.Manager.


PhoshLogin1ManagerDBusLoginManagerProxyPrivate

typedef struct _PhoshLogin1ManagerDBusLoginManagerProxyPrivate PhoshLogin1ManagerDBusLoginManagerProxyPrivate;

PhoshLogin1ManagerDBusLoginManagerSkeletonPrivate

typedef struct _PhoshLogin1ManagerDBusLoginManagerSkeletonPrivate PhoshLogin1ManagerDBusLoginManagerSkeletonPrivate;

Signal Details

The “handle-get-session” signal

gboolean
user_function (PhoshLogin1ManagerDBusLoginManager *object,
               GDBusMethodInvocation              *invocation,
               gchar                              *arg_session_id,
               gpointer                            user_data)

Signal emitted when a remote caller is invoking the GetSession() 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 phosh_login1_manager_dbus_login_manager_complete_get_session() 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.

Parameters

object

A PhoshLogin1ManagerDBusLoginManager.

 

invocation

A GDBusMethodInvocation.

 

arg_session_id

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.

Flags: Run Last


The “handle-inhibit” signal

gboolean
user_function (PhoshLogin1ManagerDBusLoginManager *object,
               GDBusMethodInvocation              *invocation,
               GUnixFDList                        *fd_list,
               gchar                              *arg_what,
               gchar                              *arg_who,
               gchar                              *arg_why,
               gchar                              *arg_mode,
               gpointer                            user_data)

Signal emitted when a remote caller is invoking the Inhibit() 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 phosh_login1_manager_dbus_login_manager_complete_inhibit() 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.

Parameters

object

A PhoshLogin1ManagerDBusLoginManager.

 

invocation

A GDBusMethodInvocation.

 

fd_list

A GUnixFDList or NULL.

[nullable]

arg_what

Argument passed by remote caller.

 

arg_who

Argument passed by remote caller.

 

arg_why

Argument passed by remote caller.

 

arg_mode

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.

Flags: Run Last


The “prepare-for-sleep” signal

void
user_function (PhoshLogin1ManagerDBusLoginManager *object,
               gboolean                            arg_start,
               gpointer                            user_data)

On the client-side, this signal is emitted whenever the D-Bus signal "PrepareForSleep" is received.

On the service-side, this signal can be used with e.g. g_signal_emit_by_name() to make the object emit the D-Bus signal.

Parameters

object

A PhoshLogin1ManagerDBusLoginManager.

 

arg_start

Argument.

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last