unschedTm

The unschedTm method cancels a timeout request.

This method is used when:

The unschedTm method works in the following way:

  1. If the OMReactive instance does not exist, unschedTm returns; otherwise, it invokes a mutex to protect the following operations:
    • If id == Constants, unschedTm cancels all events whose destination is this specific instance of OMReactive.
    • unschedTm calls the isCurrentEvent method to determine whether the current event is delegated to this OMReactive. If it is, unschedTm calls the findInList method (private) to locate the timeout in the matured list, then removes it from the matured list.
  2. Next, unschedTm creates three clones for the following items:
  3. The unschedTm method iterates through the heap and calls the Delete method to delete those timeouts whose destination is the specific OMReactive.
  4. Finally, the method looks for matching timeouts in the matured list. It calls the findInList method to iterate over the matured list to find matching timeouts. When it finds one, it calls the setlId method to set the timeout's ID to Constants, then removes it from the matured list.
  5. If id == Constants, unschedTm cancels only that event.
Visibility
Public
Signature
RP_FRAMEWORK_DLL void unschedTm (short id,
   OMReactive *c);
Parameters
id

Specifies the ID tag of the timeout request.

If Constants is specified, unschedTm cancels all events whose destination is this specific instance of OMReactive. If Constants is specified, unschedTm cancels only that timeout.

c

Specifies a pointer to the OMReactive instance requestor. After a timeout has been canceled, this parameter points to the instance that is notified.

Notes

Feedback