OSI/FTAM Programming Guide

Using FTM Procedure Calls
HP NonStop OSI/FTAM Programming Guide—528612-001
4-50
Generating Cancels
These steps explain the sequence of procedure calls given in Table 4-19 on page 4-49.
1. To cancel a data transfer, call FTM_CANCEL_REQ_.
a. If the procedure succeeds, it returns a status code of ZAPS-VAL-STATUS-OK.
If the procedure fails, it returns a different status code. To obtain the details of
an error at this stage, call APS_STATUS_, specifying as input the CEPI
returned by the FTM_INITIALIZE_REQ_ procedure for this association.
b. If the association is in nowait mode, call MFM_AWAITIOX_ to wait for
completion of the FTM_CANCEL_REQ_ call. MFM_AWAITIOX_ gives you the
status code for the completed procedure call. For more information on the
MFM_AWAITIOX_ procedure, refer to the OSI/FTAM Programming Reference
Manual.
c. If you call MFM_AWAITIOX_ and the status code returned is not
ZAPS-VAL-STATUS-OK, call APS_STATUS_, specifying as input the CEPI
returned by the FTM_INITIALIZE_REQ_ procedure for this association.
2. Next, to receive a cancel confirm event, call APS_EVENT_RECEIVE_.
a. If the association is in nowait mode, call MFM_AWAITIOX_ to wait for
completion of the APS_EVENT_RECEIVE_ call and to obtain the status code.
A status code of ZAPS-VAL-STATUS-EVENT means you received an event.
In wait mode, this procedure returns a status code of
ZAPS-VAL-STATUS-EVENT when you receive an event. If
APS_EVENT_RECEIVE_ returns a different status code, to obtain the details
of an error at this stage, call APS_STATUS_, specifying as input the CEPI
returned by the FTM_INITIALIZE_REQ_ procedure for this association.
3. If you received an event, call APS_STATUS_ to determine which event. If the event
code is ZFTM-VAL-EVT-CANCEL-CNF, you received a cancel confirm.
4. Next, call FTM_CANCEL_CNF_ to retrieve the data sent by the confirm. Check the
action-result output parameter.
a. If nowait mode, await completion of
APS_EVENT_RECEIVE_.
MFM_AWAITIOX_
3 Check status: is the event a cancel confirm? Or, if
APS_EVENT_RECEIVE_ returns a status other than
ZAPS-VAL-STATUS-EVENT, is there an error?
APS_STATUS_
4 Retrieve service confirm information. FTM_CANCEL_CNF_
Note. If the remote responder was sending data when you issued the cancel request, you
might receive some data indications before receiving the cancel confirm.
Table 4-19. Calls for Generating Cancels (page 2 of 2)
Step Action to Take Procedure(s) to Call