com.webos.bootManager

API Summary

Monitors and controls the boot status/mode.

It manages the boot sequence for:

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

Overview of the API

NA

    Methods

    generateSignal

    Description

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

    Parameters

    Name

    Required

    Type

    Description

    nameRequiredString

    Indicates the logical event name to notify bootd. Normally, this is used to generate upstart signal like 'core-boot-done', 'init-boot-done' and 'minimal-boot-done'.

    Note: If bootd internal components await the logical event, bootd unblocks internal components.

    Call Returns

    Name

    Required

    Type

    Description

    errorTextOptionalString

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

    returnValueRequiredBoolean

    Indicates the status of the 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 Codes Reference

    Error Code

    Error Text

    Error Description

    NoneError getting parameter name

    Indicates that there is no name (key or value) in the request payload.

    NoneInvalid JSON argument

    Indicates that the parameter provided does not have a valid json format.

    Example

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

    getBootStatus

    Description

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

    Parameters

    Name

    Required

    Type

    Description

    subscribeOptionalboolean

    Indicates if subscribed to get future updates.

    Possible values are:

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

    Call Returns

    Name

    Required

    Type

    Description

    bootStatusRequiredString

    Returns the current status of the booting process.

    Possible values are:

    • normal: The current status of the booting process is normal.
    • unknown: The current status of the booting process unknown.
    powerStatusRequiredString

    Returns current power status.

    Possible values are:

    • active: Current power status is in active mode.
    • activeStandby: Current power status is in activeStandby mode.
    • suspend: Current power status is in suspend mode.
    • unknown: Current power status is in unknown mode.
    bootTargetRequiredString

    Returns the current target system.

    Possible values are:

    • emulator
    • hardware
    • unknown
    signalsRequiredObject array: signals

    Returns signal information.

    subscribedRequiredboolean

    Returns true to indicate subscribed.

    returnValueRequiredboolean

    Indicates the status of the operation.

    Note: returnValue is always set to true.

    Subscription Returns

    Name

    Required

    Type

    Description

    bootStatusRequiredString

    Returns the current status of the booting process.

    Possible values are:

    • normal: The current status of the booting process is normal.
    • unknown: The current status of the booting process unknown.
    powerStatusRequiredString

    Returns current power status.

    Possible values are:

    • active: Current power status is in active mode.
    • activeStandby: Current power status is in activeStandby mode.
    • suspend: Current power status is in suspend mode.
    • unknown: Current power status is in unknown mode.
    bootTargetRequiredString

    Returns the current target system.

    Possible values are:

    • emulator
    • hardware
    • unknown
    signalsRequiredObject array: signals

    Indicates signal information.

    returnValueRequiredBoolean

    Indicates the status of the operation.

    Note: returnValue is always set to true.

    Example

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

    Response:

    {
       "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

    Contains an array of upstart signals. The value of an upstart signal is set to true after bootd generates the signal.

    Note:

    • The value of all upstart signal in this array is set to false by default.

    Name

    Required

    Type

    Description

    snapshot-resume-doneRequiredBoolean

    Indicates snapshot-resume-done upstart signal.

    core-boot-doneRequiredBoolean

    Indicates core-boot-done upstart signal.

    init-boot-doneRequiredBoolean

    Indicates init-boot-done upstart signal.

    datastore-init-startRequiredBoolean

    Indicates datastore-init-start upstart signal.

    minimal-boot-doneRequiredBoolean

    Indicates minimal-boot-done upstart signal.

    rest-boot-doneRequiredBoolean

    Indicates rest-boot-done upstart signal.

    boot-doneRequiredBoolean

    Indicates boot-done upstart signal.

    Contents