clRelease  clSetDfcTimeout

Chapter 2: Bridged Functions

clSetAimStatus

Description

ODL supports publishing an AIM’s status with text to the Global Console. This information displays in the Global Console as custom health code and custom health text. By default, an endpoint failure does not change the status of the destination to which the AIM is being sent. From an e-Biz Impact point of view, the destination is still alive and is capable of accepting transactions from the SFM, so from the Global Console the endpoint displays as healthy. ODL publishing allows the application developer to set the AIM’s health to “bad” if this condition occurs.

Syntax

clSetAimStatus(int code, string text);

Parameter

Description

code

Status value where 0 is for Information (good), 1 is for Warning (problematic), and 2 is for Error (bad).

text

Text description for the current status. Use this to indicate why the current condition is occurring. For example, you can use this to differentiate between two places in your AIM that can result in an Error status.

Return value

Integer.

Returns 1 for success, and 0 for failure.

Examples

Example 16

Good status:

clinit()
{
// rest of your initialization logic here
 clSetAimStatus(0, “Initialization Complete.”);
}
Error Status:
close_flow()
{
 clSetAimStatus(2,”Lostdndpoint Connection!!!”);
 //the rest of your close flow logic
}




Copyright © 2005. Sybase Inc. All rights reserved. clSetDfcTimeout

View this book as PDF