IToiSoftwareObserver Interface Reference


Description

Technical Preview:

This interface is a TECHNICAL PREVIEW, it may change.

IToiSoftwareObserver is the observer interface used to monitor the status of IIPs. The IIPs are handled by the Software Service. If a service/application has registered itself as an observer to an IIP with the IToiSoftwareService interface, callbacks with status information are sent via this interface. Most callbacks are response to action taken through the IToiSoftwareService interface.

See also:
IToiSoftwareService
Note:
Services or applications may choose to inherit the adapter class TToiSoftwareObserverAdapter, which provides a default empty implementation of IToiSoftwareObserver.

import "IToiSoftwareObserver.idl";

List of all members.

Public Member Functions

oneway void OnIipAvailable (in string name, in IToiSoftwareService::TToiDependencyType dependencyType)
oneway void OnAddRefResponse (in string name, in IToiSoftwareService::TToiDependencyType dependencyType, in TToiAddRefResult addRefResult)
oneway void OnReleaseResponse (in string name, in IToiSoftwareService::TToiDependencyType dependencyType, in TToiReleaseResult releaseResult)
oneway void OnAddIipsResponse (in string url, in boolean success)

Public Types

enum  TToiAddRefResult { ADDREF_COMPLETED, ADDREF_REDUNDANT, ADDREF_FAILED }
enum  TToiReleaseResult { RELEASE_COMPLETED, RELEASE_REDUNDANT, RELEASE_FAILED }

Member Enumeration Documentation

The TToiAddRefResult datatype is sent as response to an IToiSoftwareService::AddRef() command.

Enumerator:
ADDREF_COMPLETED 

This code states that a reference has been added to an IIP successfully. This means that the IIP and all its dependencies are installed.

ADDREF_REDUNDANT 

This code tells the observer that the IIP has already been addreffed once. Only one AddRef is allowed / IIP via the interface.

ADDREF_FAILED 

This code tells the observer that adding a reference to the IIP failed.

The TToiReleaseResult datatype are sent as response to an IToiSoftwareService::Release() command.

Enumerator:
RELEASE_COMPLETED 

This code tells the observer that the release of the IIP has completed.

RELEASE_REDUNDANT 

This code states that the IIP has already been released.

RELEASE_FAILED 

This code states that the IIP cannot be released. It might be referenced by other IIPs.


Member Function Documentation

oneway void IToiSoftwareObserver::OnAddIipsResponse ( in string  url,
in boolean  success 
)

Sends information on how the runtime adding of a new IIP distribution went.

Parameters:
url The URL of the IIP distribution.
success true if the adding succeeded.
oneway void IToiSoftwareObserver::OnAddRefResponse ( in string  name,
in IToiSoftwareService::TToiDependencyType  dependencyType,
in TToiAddRefResult  addRefResult 
)

Holds the result of the IToiSoftwareService::AddRef() command.

Parameters:
name The name of the IIP.
dependencyType The dependency type which were affected by the call to IToiSoftwareService::AddRef().
addRefResult The result of the AddRef.
oneway void IToiSoftwareObserver::OnIipAvailable ( in string  name,
in IToiSoftwareService::TToiDependencyType  dependencyType 
)

Is called when a new content version of the IIP (or any of its dependencies) is available. Is also called as soon as the IIP has become available for download or when an observer has registered interest in the IIP.

Parameters:
name The name of the IIP.
dependencyType The dependency type which should be addreffed in order to receive the new content version of the IIP.
oneway void IToiSoftwareObserver::OnReleaseResponse ( in string  name,
in IToiSoftwareService::TToiDependencyType  dependencyType,
in TToiReleaseResult  releaseResult 
)

Holds the result of the IToiSoftwareService::Release() command.

Parameters:
name The name of the IIP.
dependencyType The dependency type which were affected by the call to IToiSoftwareService::Release().
releaseResult The result of the Release.