ATBST05 - Set_TimeOut_Value (For OS/390 Release 8 through z/OS V1R6)

This section describes the Set_TimeOut_Value advanced callable service provided with provided with OS/390 Release 8. The Set_TimeOut_Value service was enhanced for z/OS V1R7, and renamed ATBST06 (see Set_TimeOut_Value). The ATBST05 call remains valid in z/OS V1R6, but does not contain the enhancements included in ATBST06.

Note: The ATBST06 call is the recommended programming interface for this service.

ATBST05 sets the time limit in minutes that each subsequent APPC/MVS conversation call will wait for VTAM APPCCMD requests to complete. For more information, see Setting a Timeout Value for Potential Network Delays.

The Set_Timeout_Value service can also be invoked to alter the previously set timeout_value.

For outbound transaction programs, the Set_TimeOut_Value service can be invoked at any time after the conversation is successfully established by the Allocate or CMINIT service.

For inbound transaction programs, the Set_TimeOut_Value service can be invoked at any time after successful completion of the Get_Conversation, Receive_Allocate, or CMACCP service.

Requirements

Authorization:

Supervisor state or problem state, any PSW key

Dispatchable unit mode:

Task or SRB

Cross memory mode:

Any PASN, any HASN, any SASN

AMODE:

31-bit

ASC mode:

Primary or access register (AR)

Interrupt status:

Enabled for I/O and external interrupts

Locks:

Unlocked

Control parameters:

All parameters must be addressable by the caller and in the primary address space.

Format

Figure 1. ATBSTO5 - Set_TimeOut_Value

CALL ATBSTO5(
        Conversation_id,
        Timeout_Value,
        Return_code
       );

Parameters

Conversation_ID

Supplied parameter

Type: Character string
Char Set: N/A
Length: 8 bytes

Conversation_ID specifies the conversation ID of the conversation for which you want to time VTAM APPCCMD requests issued during APPC/MVS conversation callable services. Specify the conversation_id that was returned from the Allocate, CMINIT, CMACCP, Get_Conversation. or Receive_Allocate call.

Timeout_value

Supplied parameter

Type: Integer
Char Set: N/A
Length: 32 bits
Value range: 0-1440 (decimal)

Specifies the time in minutes that all subsequent APPC/MVS conversation callable services will wait for VTAM APPCCMD requests to complete.

The maximum supported Timeout_Value is 1440 minutes (24 hours). When a Timeout_Value of zero is specified, VTAM APPCCMD requests issued by subsequent APPC/MVS conversation callable services will not be timed.

Any error in the specification of this parameter will result in a Program_Parameter_Check return code.

Return_code

Returned parameter

Type: Integer
Char Set: N/A
Length: 32 bits

Return_code specifies the return code that is returned to the local program. Possible values of Return_code are:

Return Code

Value, Meaning and Action

Value: OK

Meaning: The call completed successfully.

System Action: The system continues processing.

Application Programmer Response: None required.

Value: Product_Specific_Error

Meaning: The system found a product-specific error.

System Action: The system might write the symptom records which describe the error to the logrec data set.

Application Programmer Response: See Diagnosing Problems with APPC/MVS TPs for methods to diagnose the return code. See Error_Extract for the Error_Extract calling format. If necessary, see Diagnosing Product-Specific Errors for more information about product-specific errors.

Value: Program_Parameter_Check

Meaning: The system detected a program parameter check.

System Action: The system returns this return code to caller of the APPC service in error.

Application Programmer Response: See Diagnosing Problems with APPC/MVS TPs for methods to use to diagnose the return code. See Error_Extract for the Error_Extract calling format.

Restrictions

Transaction programs that call the Set_Timeout_Value service while in task mode should not have any enabled unlocked task (EUT) functional recovery routines (FRRs) established. For more information about EUT FRRs, see the section on providing recovery in z/OS MVS Programming: Authorized Assembler Services Guide.