gss_service_add_option_group ()

void
gss_service_add_option_group (GssService *self,
                              GOptionGroup *group);

Add an option group to the command line options. The options in this group will be listed in the help output, and their values will be set when gss_service_run() is called.

This is effectively a wrapper around g_option_context_add_group(), so see the documentation for that for more information.

Since: 0.1.0

gss_service_run ()

void
gss_service_run (GssService *self,
                 int argc,
                 char **argv,
                 GError **error);

Run the service, and return when the process should exit. If it should exit with an error status, error is set; otherwise it should exit with exit code zero (success).

This handles UNIX signals and command line parsing. If you wish to schedule some work to happen asynchronously while gss_service_run() is running in your main() function, use g_idle_add(). This function, like the rest of the library, is not thread-safe.

Since: 0.1.0

gss_service_exit ()

void
gss_service_exit (GssService *self,
                  const GError *error,
                  int signum);

Cause the service to exit from gss_service_run(). If error is non-NULL, the service will exit with the given error; otherwise it will exit successfully. If this is called multiple times, all errors except the first will be ignored, so it may be safely used for error handling in shutdown code.

It is a programmer error to call this before startup_async() has been called on your service.

Since: 0.1.0

gss_service_get_dbus_connection ()

GDBusConnection *
gss_service_get_dbus_connection (GssService *self);

Get the GDBusConnection used to export the service’s well-known name, as specified in “bus-type”.

Since: 0.1.0

gss_service_get_exit_signal ()

int
gss_service_get_exit_signal (GssService *self);

Get the number of the signal which caused the GssService to exit.

Since: 0.1.0

gss_service_get_inactivity_timeout ()

guint
gss_service_get_inactivity_timeout (GssService *self);

Get the value of “inactivity-timeout”.

Since: 0.1.0

gss_service_set_inactivity_timeout ()

void
gss_service_set_inactivity_timeout (GssService *self,
                                    guint timeout_ms);

Set the value of “inactivity-timeout”.

Since: 0.1.0

gss_service_get_debug_controller ()

GDebugController *
gss_service_get_debug_controller (GssService *self);

Get the value of “debug-controller”.

Since: 0.2.0

gss_service_hold ()

void
gss_service_hold (GssService *self);

Increase the hold count of the service, and hence prevent it from automatically exiting after the “inactivity-timeout” period expires with no activity.

Call gss_service_release() to decrement the hold count. Calls to these two methods must be paired; it is a programmer error not to.

Since: 0.1.0

gss_service_release ()

void
gss_service_release (GssService *self);

Decrease the hold count of the service, and hence potentially (if the hold count reaches zero) allow it to automatically exit after the “inactivity-timeout” period expires with no activity.

Call gss_service_hold() to increment the hold count. Calls to these two methods must be paired; it is a programmer error not to.

Since: 0.1.0

GssService

typedef struct _GssService GssService;

A skeleton implementation of a system service, which exposes itself on the bus with a well-known name.

It follows the implementation recommendations in man 7 daemon.

Since: 0.1.0

struct GssServiceClass

struct GssServiceClass {
  GObjectClass parent_class;

  GOptionEntry *(*get_main_option_entries) (GssService *service);

  void (*startup_async)  (GssService          *service,
                          GCancellable        *cancellable,
                          GAsyncReadyCallback  callback,
                          gpointer             user_data);
  void (*startup_finish) (GssService          *service,
                          GAsyncResult        *result,
                          GError             **error);
  void (*shutdown)       (GssService          *service);
};

Class structure for a GssService implementation.

All services must implement startup_async , startup_finish and shutdown , which are called by gss_service_run() to start up and shut down the service.

If your service needs to support additional command line options in the main group, implement get_main_option_entries ; otherwise leave it unimplemented.

Since: 0.1.0

enum GssServiceError

Errors from running a service.

Since: 0.1.0