From d7116927d002bf7a0a6a21997117c36418aa56f3 Mon Sep 17 00:00:00 2001 From: Jonathan Maw Date: Wed, 8 Aug 2012 17:13:53 +0100 Subject: Expand documentation for JobManager --- node-startup-controller/job-manager.c | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/node-startup-controller/job-manager.c b/node-startup-controller/job-manager.c index b8a654c..85d4a0c 100644 --- a/node-startup-controller/job-manager.c +++ b/node-startup-controller/job-manager.c @@ -25,9 +25,20 @@ * @short_description: Manages systemd jobs. * @stability: Internal * - * The Job Manager simplifies starting and stopping systemd units by handling all the + * The #JobManager simplifies starting and stopping systemd units by handling all the * D-Bus communication with the systemd manager internally. Units can be started and - * stopped using job_manager_start() and job_manager_stop(). + * stopped using job_manager_start() and job_manager_stop() and will call the @callback + * passed to the function when the unit is started or stopped. + * + * The #JobManager contains an internal table which associates systemd job names with the + * necessary information about that job, e.g. the unit name. + * + * When the #JobManager is told to start or stop a unit, it creates a job in systemd to + * start or stop that unit, stores the name of that job and waits until that job has + * finished before calling the @callback. + * + * The #JobManager finds out that a job has finished by listening to "JobRemoved" signals + * from systemd and looking for that job by its job name. */ -- cgit v1.2.1