OSI/FTAM Programming Reference Manual

FTM Procedures

HP NonStop OSI/FTAM Programming Reference Manual—528611-001

4-13

FTM_BEGIN_GROUP_REQ_

This procedure allows you to request the start of a group of FTM procedures, which

are then processed and responded to as a group.

status return value

INT

indicates the outcome of the call. For a list of possible ZAPS-VAL-STATUS-xxx

status values, see Table B-1 on page B-2.

cepi input

INT:value

is the connection endpoint identifier (CEPI) used to identify the specific

association. Use the CEPI value returned from the FTM_INITIALIZE_REQ_

procedure for this association. For additional information on using the cepi

parameter, see the OSI/FTAM Programming Guide.

cepi is a required parameter.

threshold input

INT(32):value

specifies how many primitives (not including begin-group and end-group) within a

grouped service must succeed before the group can be considered successful. A

primitive is categorized as successful or unsuccessful on the basis of its

state-result parameter. Success occurs when a primitive returns a

state-result value other than ZFTM-VAL-STATE-FAILURE. Primitives that

have no state-result parameter are considered successful for the purposes of

the threshold count.

If the threshold parameter is set to the total number of primitives in the group,

the primitives in the group succeed or fail as a group; when a single primitive fails,

the entire group fails. If a grouped request fails, no change in state occurs, and the

association remains in the regime in which it was when you initiated the grouped

request.

For transfer service class, management service class, or transfer-and-

management service class, you must set threshold to the total number of

required and optional primitives you plan for the group. This limitation on the

threshold value does not apply to the file-access service class, for which greater

flexibility is provided. For the file-access service class, you can set the threshold

parameter to a value less than the total number of required and optional primitives

to include in the group.

status := FTM_BEGIN_GROUP_REQ_ ( cepi ! I

, threshold ! I

, [ tag ] ); ! I