The following table summarizes the members of the constructor and their purpose:
Note that some functions are optional. If you do not need to implement an optional function, pass NULL or 0 in place of its pointer.
Argument |
Description |
Who |
This pointer is maintained but never used by the CAmvConn. Typically, this is a pointer to the object which owns the CAmvConn instance. The callback functions can use this pointer to access members of the owner object. |
DispFunc |
CAmvConn calls this function to notify the viewer of new alarm data. |
ClearDisp |
CAmvConn calls this function when it removes all alarms from its local storage, for example in preparations for receipt of a new static list of alarms. The viewer should remove all its locally-maintained information about current alarms and typically clear the displayed list of alarms. |
LostAM |
CAmvConn calls this function when communication with the Alarm Manager (AM) is lost. |
MaxAlarms |
This is an optional function. CAmvConn calls this function in dynamic mode to query the viewer about how many alarms it can handle. Typically, this routine returns a very large value. |
SetDisplayRedraw |
CAmvConn calls this function with val set to FALSE before calling dispFunc, and again with val set to TRUE after calling dispFunc. Typically, when called with val set to TRUE, this function is responsible for redrawing the alarm view or sending a message to the application to cause a redraw. |
UpdateCount |
CAmvConn calls this function to notify the viewer that the alarm count or date of last change has changed. |
DoRcmError |
CAmvConn calls this function when a Remote Connection Manager error occurs. All locally-maintained information about alarms and the connection should be reset. |
DoConnectionFormed |
CAmvConn calls this function when the connection to the AMRP is complete. Due to the multi-threaded nature of the CAmvConn processing, this can be some time after the CAmvConn constructor completes. |
NotifyAlmGen |
CAmvConn calls this function in dynamic mode to notify the viewer when a new alarm has been generated or an existing alarm has been regenerated. |
NotifyAlmMod |
CAmvConn calls this function in dynamic mode to notify the viewer of the change of state of an existing alarm (for example, when an alarm is acknowledged.) |
NotifyAlmDel |
This is an optional function. |
|
CAmvConn calls this function in dynamic mode to notify the viewer when an alarm has been deleted. |
CAmvConn Syntax. |