|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The service developer supplies the load manager service interface to handle requests, reports and other responses from the framework load manager function. The service instance supplies the identity of its callback interface at the time it obtains the framework's load manager interface, by use of the obtainInterfaceWithCallback() method on the IpAccess interface. If the IpSvcLoadManager interface is implemented by a Service, at least one of the methods shall be implemented as a minimum requirement. If load level notifications are supported, then loadLevelNotification() shall be implemented. If a the Service is capable of invoking the IpFwLoadManager.queryLoadStatsReq() method, then it shall implement queryLoadStatsRes() and queryLoadStatsErr() methods in this interface.
Method Summary | |
void |
createLoadLevelNotification()
The framework uses this method to register to receive notifications of load level changes associated with the service instance. |
void |
destroyLoadLevelNotification()
The framework uses this method to unregister for notifications of load level changes associated with the service instance. |
void |
loadLevelNotification(org.csapi.jr.se.fw.LoadStatistic[] loadStatistics)
Upon detecting load condition change, (for example load level changing from 0 to 1, 0 to 2, 1 to 0, for the application or framework which has been registered for load level notifications) this method is invoked on the SCF. |
void |
queryLoadErr(org.csapi.jr.se.fw.LoadStatisticError loadStatisticsError)
Deprecated. |
void |
queryLoadRes(org.csapi.jr.se.fw.LoadStatistic[] loadStatistics)
Deprecated. |
void |
queryLoadStatsErr(int loadStatsReqID,
org.csapi.jr.se.fw.LoadStatisticError loadStatisticsError)
The framework uses this method to return an error response to the service that requested the framework's load statistics information, when the framework is unsuccessful in obtaining any load statistic records; that is in response to an invocation of the queryLoadReq method on the IpFwLoadManager interface. |
void |
queryLoadStatsRes(int loadStatsReqID,
org.csapi.jr.se.fw.LoadStatistic[] loadStatistics)
The framework uses this method to send load statistic records back to the service instance that requested the information; that is in response to an invocation of the queryLoadReq method on the IpFwLoadManager interface. |
void |
querySvcLoadReq(org.csapi.jr.se.TimeInterval timeInterval)
Deprecated. |
void |
querySvcLoadStatsReq(int loadStatsReqID,
org.csapi.jr.se.TimeInterval timeInterval)
The framework uses this method to request the service instance to provide its load statistic records. |
void |
resumeNotification()
The framework uses this method to request the service instance to resume sending it notifications: for example after a period of suspension during which the framework handled a temporary overload condition. |
void |
suspendNotification()
The framework uses this method to request the service instance to suspend sending it any notifications: for example while the framework handles a temporary overload condition. |
Method Detail |
public void querySvcLoadReq(org.csapi.jr.se.TimeInterval timeInterval) throws CommonException
timeInterval
- Specifies the time interval for which load statistic records should be reported.
CommonException
- Defines the structure of the exception class which is applicable to all methods.public void queryLoadRes(org.csapi.jr.se.fw.LoadStatistic[] loadStatistics) throws CommonException
loadStatistics
- Specifies the framework-supplied load statistics
CommonException
- Defines the structure of the exception class which is applicable to all methods.public void queryLoadErr(org.csapi.jr.se.fw.LoadStatisticError loadStatisticsError) throws CommonException
loadStatisticsError
- Specifies the error code associated with the failed attempt to retrieve the framework's load statistics.
CommonException
- Defines the structure of the exception class which is applicable to all methods.public void loadLevelNotification(org.csapi.jr.se.fw.LoadStatistic[] loadStatistics) throws CommonException
loadStatistics
- Specifies the framework-supplied load statistics, which include the load level change(s).
CommonException
- Defines the structure of the exception class which is applicable to all methods.public void suspendNotification() throws CommonException
CommonException
- Defines the structure of the exception class which is applicable to all methods.public void resumeNotification() throws CommonException
CommonException
- Defines the structure of the exception class which is applicable to all methods.public void createLoadLevelNotification() throws CommonException
CommonException
- Defines the structure of the exception class which is applicable to all methods.public void destroyLoadLevelNotification() throws CommonException
CommonException
- Defines the structure of the exception class which is applicable to all methods.public void querySvcLoadStatsReq(int loadStatsReqID, org.csapi.jr.se.TimeInterval timeInterval) throws CommonException
loadStatsReqID
- The identifier provided by the framework to correlate the response (when it arrives) with this request.timeInterval
- Specifies the time interval for which load statistic records should be reported.
CommonException
- Defines the structure of the exception class which is applicable to all methods.public void queryLoadStatsRes(int loadStatsReqID, org.csapi.jr.se.fw.LoadStatistic[] loadStatistics) throws CommonException
loadStatsReqID
- Used by the service instance to correlate this response (when it arrives) with the original request.loadStatistics
- Specifies the framework-supplied load statistics
CommonException
- Defines the structure of the exception class which is applicable to all methods.public void queryLoadStatsErr(int loadStatsReqID, org.csapi.jr.se.fw.LoadStatisticError loadStatisticsError) throws CommonException
loadStatsReqID
- Used by the service instance to correlate this error (when it arrives) with the original request.loadStatisticsError
- Specifies the error code associated with the failed attempt to retrieve the framework's load statistics.
CommonException
- Defines the structure of the exception class which is applicable to all methods.
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |