sbIServiceManager Interface Reference

import"sbIServiceManager.idl";

Inheritance diagram for sbIServiceManager:
[legend]
Collaboration diagram for sbIServiceManager:
[legend]

Public Member Functions

boolean isServiceReady (in string aServiceContractID)
 
void setServiceReady (in string aServiceContractID, in boolean aServiceReady)
 

Detailed Description

The sbIServiceManager interface provides support for managing service components. It provides support for determining whether services are ready and for delivering notifications when services are made ready or shut down. When a service becomes ready, the service manager notifies observers of the "service-ready" topic, providing the ready service contract ID as the observation data. When a service is shutdown, becoming not ready, the service manager notifies observers of the "before-service-shutdown" topic, providing the shut down service contract ID as the observation data.

"@songbirdnest.com/Songbird/ServiceManager;1" Use get service with this component.

Definition at line 47 of file sbIServiceManager.idl.

Member Function Documentation

boolean sbIServiceManager::isServiceReady ( in string  aServiceContractID)

Return true if the service with the contract ID specified by aServiceContractID is ready.

Parameters
aServiceContractIDContract ID of service for which to return ready state.
Returns
true Service is ready. false Service is not ready.
void sbIServiceManager::setServiceReady ( in string  aServiceContractID,
in boolean  aServiceReady 
)

Set the ready state of the service with the contract ID specified by aServiceContractID to the value specified by aServiceReady. Notify observers if the ready state changes.

Parameters
aServiceContractIDContract ID of service for which to set ready state.
aServiceReadyIf true, set service as ready.

The documentation for this interface was generated from the following file: