common/nsm-consumer-dbus.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <node>
   3   <!--
   4     org.genivi.NodeStateManager.Consumer:
   5     @short_description: Interface for testing the interaction between the
   6                         Node Startup Controller and the Node State Manager.
   7                         It is an excerpt of
   8                         "org.genivi.NodeStateManager.LifecycleControl"
   9                         using only the methods needed to test the NSC.
  10   -->
  11   <interface name="org.genivi.NodeStateManager.Consumer">
  12     <!--
  13       RegisterShutdownClient:
  14       @BusName: Bus name of remote application.
  15       @ObjName: Object name of remote object that provides the shutdown
  16                 interface
  17       @ShutdownMode: Shutdown mode for which client wants to be informed
  18                      (i.e normal, fast etc)
  19       @TimeoutsMs:  Max. Timeout to wait for response from shutdown client.
  20       @ErrorCode
  21
  22       The method is used by other applications to register themselves as
  23       shutdown client. Any client that registers must provide a method in
  24       their DBUS object called NSMLifecycleRequest. This method will take one
  25       parameter which is the Lifecycle Request (i.e. normal shutdown, fast
  26       shutdown, runup). For an example of the required client interface
  27       please see the Node Startup Controller, which will be a client of
  28       the NSM.
  29     -->
  30     <method name="RegisterShutdownClient">
  31       <arg name="BusName" direction="in" type="s"/>
  32       <arg name="ObjName" direction="in" type="s"/>
  33       <arg name="ShutdownMode" direction="in" type="u"/>
  34       <arg name="TimeoutMs" direction="in" type="u"/>
  35       <arg name="ErrorCode" direction="out" type="i"/>
  36     </method>
  37
  38     <!--
  39       UnRegisterShutdownClient
  40       @BusName: Bus name of remote application.
  41       @ObjName: Object name of remote object that provides the shutdown
  42                 interface
  43       @ShutdownMode: Shutdown mode for which client wants to be informed
  44                      (i.e normal, fast etc)
  45       @TimeoutsMs:  Max. Timeout to wait for response from shutdown client.
  46       @ErrorCode
  47
  48       The method is used by other applications to unregister themselves as
  49       shutdown client.
  50     -->
  51     <method name="UnRegisterShutdownClient">
  52       <arg name="BusName" direction="in" type="s"/>
  53       <arg name="ObjName" direction="in" type="s"/>
  54       <arg name="ShutdownMode" direction="in" type="u"/>
  55       <arg name="ErrorCode" direction="out" type="i"/>
  56     </method>
  57
  58     <!--
  59         LifecycleRequestComplete:
  60         @RequestId: The request Id of the called life cycle client. The value
  61                     has been passed when "LifecycleRequest" was called.
  62         @Status:    The result of the call to "LifecycleRequest".
  63                     NsmErrorStatus_Ok: Request successfully processed.
  64                     NsmErrorStatus_Error: An error occured while processing
  65                       the "LifecycleRequest".
  66         @ErrorCode: Return value passed to the caller, based upon NsmErrorStatus_e.
  67
  68         The function has to be called asynchrounously by a lifecycle client
  69         when it has processed an earlier LifecycleRequest.
  70     -->
  71     <method name="LifecycleRequestComplete">
  72       <arg name="RequestId" direction="in" type="u"/>
  73       <arg name="Status"    direction="in" type="i"/>
  74       <arg name="ErrorCode" direction="out" type="i"/>
  75     </method>
  76
  77   </interface>
  78 </node>