diff options
author | Jonathan Maw <jonathan.maw@codethink.co.uk> | 2012-08-09 13:26:45 +0100 |
---|---|---|
committer | Francisco Redondo Marchena <francisco.marchena@codethink.co.uk> | 2012-08-10 10:49:51 +0100 |
commit | a4326808ad9e0500fb5785e7553cc2b46329542c (patch) | |
tree | a418736efc02a407f813c9f98d27c3a97dbc17c3 | |
parent | 6799c47afd8af085370a6668183b61d5b97c706f (diff) | |
download | node-startup-controller-a4326808ad9e0500fb5785e7553cc2b46329542c.tar.gz |
Expand description of the NodeStartupControllerService
Expands the description to explain what it does when it receives the
"handle-begin-lucregistration", "handle-register-with-luc" and
"handle-finish-lucregistration" signals.
-rw-r--r-- | node-startup-controller/node-startup-controller-service.c | 26 |
1 files changed, 22 insertions, 4 deletions
diff --git a/node-startup-controller/node-startup-controller-service.c b/node-startup-controller/node-startup-controller-service.c index 30e8a4b..6d15e6e 100644 --- a/node-startup-controller/node-startup-controller-service.c +++ b/node-startup-controller/node-startup-controller-service.c @@ -35,14 +35,32 @@ * represented by the #NodeStartupControllerSkeleton class. It does this by implementing * handlers for the signals: * - * * "handle-register-with-luc" + * * "handle-register-with-luc" which represents the %RegisterWithLUC method. * - * * "handle-begin-lucregistration" + * * "handle-begin-lucregistration" which represents the %BeginLUCRegistration method. * - * * "handle-finish-lucregistration" + * * "handle-finish-lucregistration" which represents the %FinishLUCRegistration method. * * The specification for the D-Bus interface can be found at - * #gdbus-org.genivi.NodeStartupController1.NodeStartupController + * #gdbus-org.genivi.NodeStartupController1.NodeStartupController. + * + * When the #NodeStartupControllerService receives a "handle-begin-luc-registration" + * signal, it creates an empty #GVariant (of type "a{ias}", a dictionary of LUC types as + * integers to groups of units as string arrays) which it uses to contain the new + * candidate for the Last User Context, and allows other methods to be called + * successfully. + * + * When it receives a "handle-register-with-luc" signal and it has already handled + * "handle-begin-lucregistration", it adds the #GVariant that it received with the signal + * to the new candidate. If a new LUC type is specified, it will add the whole group, + * and if new units are added to an existing group, they get added at the end. If a unit + * exists in both the received #GVariant and in the new candidate then the unit will be + * added at the end. + * + * When it receives a "handle-finish-lucregistration" and it has already handled + * "handle-begin-lucregistration", it writes the new candidate by calling + * node_startup_controller_service_write_luc(), then deletes the candidate so that + * "handle-begin-lucregistration" can be called again. */ |