OSI/FTAM Programming Reference Manual

FTM Procedures
HP NonStop OSI/FTAM Programming Reference Manual528611-001
4-2
Procedure Names
Procedure Names
The names of all NonStop FTAM procedures start with the characters “FTM_.” The
FTM procedures fall into four major categories, identified by the last few characters in
the procedure name:
REQ procedures enable you to make requests to the service provider. An example
is FTM_INITIALIZE_REQ_, which requests initiation of an association with an
FTAM responder.
IND procedures enable you to retrieve indication data as a result of service
requests sent by a remote entity. An example is FTM_CANCEL_IND_, which
allows you to retrieve indication information on a responder request to cancel the
data-transfer regime.
RSP procedures enable you to respond to an incoming indication primitive. An
example is FTM_CANCEL_RSP_, which allows you to communicate the results of
actions taken in response to a responder’s request to cancel the data-transfer
regime.
CNF procedures enable you to retrieve confirm information as a result of
responses sent by a remote application entity. An example is
FTM_INITIALIZE_CNF_, which reads the parameters returned to the initiator from
a responder following an initialize request sent from the initiator to the responder.
The middle word or words of a procedure name further identify the functionality
provided by the procedure. For examples, see the brief descriptions of the
FTM_INITIALIZE_REQ_ and FTM_CANCEL_IND_ procedures presented above.
Procedure Calls and Parameters
The parameters, and the procedures in which they can or must, appear are listed in
Table 4-1 on page 4-3. The data type for each parameter is the same for all procedures
in which it is used and is described in more detail in Appendix A, DDL Definitions.
Parameters are categorized into three types: required, optional, and conditional.
For the required input parameters noted in Table 4-1 on page 4-3 and the procedure
descriptions that follow, your application must provide values. If your application does
not, the NonStop initiator will not perform the service.
For the optional input parameters, your application does not need to provide values.
However, this does not necessarily mean that no value is assigned to these
parameters. In some cases, the NonStop initiator provides default values for optional
parameters in the PDU it sends across the network to the remote responder. In other
cases, the NonStop FTAM initiator sends no value for a particular parameter, and the
remote FTAM responder is free to provide its own default values.
Output parameters are generally considered optional. However, several of the output
parameters described in this section (for example, state-result, action-result,