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

NA

    Methods

    generateSignal

    Description

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

    Parameters

    Name

    Required

    Type

    Description

    nameRequiredString

    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

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

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

    NoneInvalid JSON argument

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

    Example

    # luna-send -n 1 -f palm://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

    subscribeOptionalboolean

    Subscribe for future updates. Possible values are:

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

    Call Returns

    Name

    Required

    Type

    Description

    bootStatusRequiredString

    Returns current status name of booting process.

    • 'normal' : It is 'normal' mode
    • 'unknown' : It is 'unknown' mode
    powerStatusRequiredString

    Returns current power status

    • 'active' : This is 'active' mode.
    • 'activeStandby' : This is 'activeStandby' mode
    • 'suspend' : This is 'suspend' mode.
    • 'unknown' : This is 'unknown' mode.
    bootTargetRequiredString

    Returns current target system.

    • 'emulator'
    • 'hardware'
    • 'unknown'
    signalsRequiredObject array

    Please refer 'Objects' section below.

    subscribedRequiredboolean

    true to indicate subscribed

    returnValueRequiredboolean

    returnValue will always contain true.

    Subscription Returns

    Name

    Required

    Type

    Description

    bootStatusRequiredString

    Returns current status name of booting process.

    • 'normal' : It is 'normal' mode
    • 'unknown' : It is 'unknown' mode
    powerStatusRequiredString

    Returns current power status

    • 'active' : This is 'active' mode.
    • 'activeStandby' : This is 'activeStandby' mode
    • 'suspend' : This is 'suspend' mode.
    • 'unknown' : This is 'unknown' mode.
    bootTargetRequiredString

    Returns current target system.

    • 'emulator'
    • 'hardware'
    • 'unknown'
    signalsRequiredObject array

    Please refer 'Objects' section below.

    returnValueRequiredBoolean

    returnValue will always contain true.

    Example

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

    // Example response for a successful call:

    {

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

    'core-boot-done' upstart signal

    init-boot-doneRequiredBoolean

    'init-boot-done' upstart signal

    datastore-init-startRequiredBoolean

    'datastore-init-start' upstart signal

    minimal-boot-doneRequiredBoolean

    'minimal-boot-done' upstart signal

    rest-boot-doneRequiredBoolean

    'rest-boot-done' upstart signal

    boot-doneRequiredBoolean

    'boot-done' upstart signal

    Contents