diff options
author | Jonathan Maw <jonathan.maw@codethink.co.uk> | 2012-08-09 16:02:31 +0100 |
---|---|---|
committer | Francisco Redondo Marchena <francisco.marchena@codethink.co.uk> | 2012-08-10 11:39:37 +0100 |
commit | dcad7edbfa32f5e94367dbda90f91bf866b90f64 (patch) | |
tree | 33bdf4d18e114804c4c8cb432fc4381e9931a155 | |
parent | 891bd72390cafd232f9446b43f07295cb04c27ff (diff) | |
download | node-startup-controller-dcad7edbfa32f5e94367dbda90f91bf866b90f64.tar.gz |
Expand description for ShutdownClient
Adds some information about the data it contains.
-rw-r--r-- | common/shutdown-client.c | 14 |
1 files changed, 13 insertions, 1 deletions
diff --git a/common/shutdown-client.c b/common/shutdown-client.c index fb62ed0..f9f619c 100644 --- a/common/shutdown-client.c +++ b/common/shutdown-client.c @@ -30,9 +30,21 @@ * by the #LAHandlerService in the Node Startup Controller, and a #ShutdownConsumerProxy * if it is being used by the #NSMConsumerService in the Node State Manager Dummy. * + * In addition, it contains the following information: + * + * * The bus name, the name that the controlling process owns on the system bus. + * + * * The object path, a unique D-Bus object path which, together with the bus name, + * is used by the Node State Manager to identify the #ShutdownConsumer. + * + * * The shutdown mode, an #NSMShutdownType. + * + * * The timeout, the amount of time the Node State Manager will wait before deciding + * that this #ShutdownClient is not responding. + * * The #LAHandlerService uses it to identify which #ShutdownConsumer was told to shut * down, which it will then use to stop the associated systemd unit. - * + * * The #NSMConsumerService uses it to locate the #ShutdownConsumer, shut it down with the * appropriate mode, and wait for an appropriate length of time when expecting a response. */ |