IPlatformComponent Interface Reference


Description

The IPlatformComponent interface must be implemented by all components in the platform. A component must register this interface with the IPlatformManager::ReportComponent method.

Through this interface, the component receives information about the general system execution state.

import "IPlatformComponent.idl";

List of all members.

Public Member Functions

oneway void OnLoad ()
oneway void OnUnload (in boolean willReboot)
oneway void OnStandbyChanged ()
oneway void Ping ()

Member Function Documentation

oneway void IPlatformComponent::OnLoad (  ) 

The OnLoad function is called when all components in the platform have been started and have registered with the IPlatformManager interface. After having received OnLoad, applications may be started on the system.

oneway void IPlatformComponent::OnStandbyChanged (  ) 

The OnStandbyChanged function is called whenever the standby state of the system changes. The component can check the system's standby state by calling IPlatformService::IsInStandby.

See also:
IPlatformService::IsInStandby
oneway void IPlatformComponent::OnUnload ( in boolean  willReboot  ) 

The OnUnload function is called to platform components as a signal do cleanup work, for example terminate applications or write modified non-volatile data to flash before reboot. Regardless whether or not the component has cleanup work to do, the component must always acknowledge this event by calling IPlatformService::UnloadDone when finished.

Parameters:
willReboot Is set to true if a reboot will follow the unload, false if reboot is not planned. The component may want to take different actions depending on this.
See also:
IPlatformService::UnloadDone
oneway void IPlatformComponent::Ping (  ) 

The Ping function tells the platform component to perform a check that it is working properly. The component acknowledges by answering IPlatformService::ReportPing. If the component do not respond within the timeout the entire platform will be restarted.

IPlatformService::ReportPing