com.webos.bootManager

API Summary

The basic role of this service is to monitor and control the boot status/mode.

It manages the boot sequence for

  • Ensuring boot time performance.
  • Providing bootmode like 'Normal', and so on.

Overview of the API

(click to expand)

See Summary.


Open All


generateSignal

Description

Generates boot step signals. Caller and argument are decided statically.

Parameters

Name

Required

Type

Description

name Required String

Logical event name to notify bootd.

If bootd internal components wait the logical event, bootd unblocks internal components.

Normally, this is used to generate upstart signal like 'core-boot-done', 'init-boot-done' and 'minimal-boot-done'.

Call Returns

Name

Required

Type

Description

errorText Optional String

Indicates the reason for the failure of the operation. See the "Error Codes Reference" section of this method for details.

returnValue Required Boolean

Indicates the status of operation. Possible values are:

  • true - Indicates that the operation was successful.
  • false - Indicates that the operation failed. Check the "errorCode" and "errorText" fields for details.

Error References

Error Code

Error Text

Error Description

None Error getting parameter name

There is no 'name' key or value in request payload.

None Invalid JSON argument

If parameter is not valid json format, this error occurs.

Example

# luna-send -n 1 -f luna://com.webos.bootManager/generateSignal '{ "name": "minimal-boot-done" }'

Example response for a successful call:

{

"returnValue": true

}

Example response for a failed call: N/A   // This method always returns true.


getBootStatus

Description

Gets the boot status or subscribe to updates on the boot status.

Parameters

Name

Required

Type

Description

subscribe Optional boolean

Subscribe for future updates. Possible values are:

  • true - Get future updates.
  • false - To receive one-time update.

Call Returns

Name

Required

Type

Description

bootStatus Required String

Returns current status name of booting process.

  • 'normal' : It is 'normal' mode
  • 'unknown' : It is 'unknown' mode
powerStatus Required String

Returns current power status

  • 'active' : This is 'active' mode.
  • 'activeStandby' : This is 'activeStandby' mode
  • 'suspend' : This is 'suspend' mode.
  • 'unknown' : This is 'unknown' mode.
bootTarget Required String

Returns current target system.

  • 'emulator'
  • 'hardware'
  • 'unknown'
signals Required Object array

Please refer 'Objects' section below.

subscribed Required boolean

true to indicate subscribed

returnValue Required boolean

returnValue will always contain true.

Subscription Returns

Name

Required

Type

Description

bootStatus Required String

Returns current status name of booting process.

  • 'normal' : It is 'normal' mode
  • 'unknown' : It is 'unknown' mode
powerStatus Required String

Returns current power status

  • 'active' : This is 'active' mode.
  • 'activeStandby' : This is 'activeStandby' mode
  • 'suspend' : This is 'suspend' mode.
  • 'unknown' : This is 'unknown' mode.
bootTarget Required String

Returns current target system.

  • 'emulator'
  • 'hardware'
  • 'unknown'
signals Required Object array

Please refer 'Objects' section below.

returnValue Required Boolean

returnValue will always contain true.

Example

luna-send -n 1 -f luna://com.webos.bootManager/getBootStatus '{ "subscribe" : true }'

{

    "bootTarget": "hardware",

    "bootStatus": "normal",

    "powerStatus": "active",

    "signals": {

        "boot-done": true,

        "core-boot-done": true,

        "datastore-init-start": true,

        "minimal-boot-done": true,

        "init-boot-done": true,

        "rest-boot-done": true

    },

    "subscribed": true,

    "returnValue": true
}


Objects

signals

This is upstart signal object array.

Each object is upstart signal itself.

Default value of upstart signal is 'false'.

The value becomes 'true' after bootd generates the signal

Name

Required

Type

Description

core-boot-done Required Boolean

'core-boot-done' upstart signal

init-boot-done Required Boolean

'init-boot-done' upstart signal

datastore-init-start Required Boolean

'datastore-init-start' upstart signal

minimal-boot-done Required Boolean

'minimal-boot-done' upstart signal

rest-boot-done Required Boolean

'rest-boot-done' upstart signal

boot-done Required Boolean

'boot-done' upstart signal


Except as noted, this content is licensed under Creative Commons Attribution 4.0 and sample code is licensed under Apache License 2.0.