gtpg2m4eGeneral Macros

TPPCC-TPF/APPC Conversation Verb Macro

Use this macro to provide the interface for all conversation verbs defined in the LU 6.2 architecture that TPF supports. This section contains a description of the TPPCC macro in its general form, followed by a separate section for each of the valid verbs.

Format




label
A symbolic name can be assigned to the macro statement.

verbname
Specifies the name of the TPF/APPC verb to be executed. The valid verbnames are shown in Table 10.

KEYWORDi=valuei
Specifies the first valid keyword parameter for the verbname specified.

Each macro call begins with TPPCC, followed by the positional parameter verbname, which specifies the verb to be executed. This is followed by one or more keyword parameters and values for those parameters. The values specify either a keyword option or a main storage location of a field.

The main storage location of a field can be specified as either the symbolic name of the field or as a register that points to the field. If you specify a register, the register name must be enclosed in parentheses and must be in the range R1-R7.

Table 10 is a summary of the supported verb names and their associated parameters. The table also contains:

More detailed information for each parameter is provided in the individual verb descriptions later in this chapter.

Table 10. TPF/APPC Conversation Verbs and Valid Keywords

Verb Name Keyword Parameter Passed or Returned Description Architecture Equivalent
ACTIVATE_ON_ CONFIRMATION RESID Passed This specifies the resource ID returned by the ALLOCATE verb or the resource ID assigned by an incoming ATTACH. RESOURCE
  VERB Passed This specifies the architecture's verb function to be performed in conjunction with this verb. Valid choices are:
  • CONFIRM
  • DEALLOCATE
  • PREPARE_TO_RECEIVE
None
  PARM Passed This specifies the data level (DL) indication or the TOKEN to be passed to the activated program. None
  PGM Passed This specifies the TPF E-type program to be activated when there is data or other information available to satisfy the CONFIRM request. The program specified must be defined in the TPF transaction program name table (TPNT) as TYPE=AOR. None
  RCODE Returned This specifies where the return code is to be returned. RETURN_CODE
Note:
The ACTIVATE_ON_CONFIRMATION verb is a TPF-only extension to the LU 6.2 architecture. There is no equivalent verb defined in the architecture.
ACTIVATE_ON_RECEIPT RESID Passed This specifies the resource ID returned by the ALLOCATE verb or the resource ID assigned by an incoming ATTACH. RESOURCE
  PARM Passed This specifies the data level (DL) indication or the TOKEN to be passed to the activated program. None
  PGM Passed This specifies the TPF E-type program to be activated when there is data or other information available to satisfy the RECEIVE request. The program specified must be defined in the TPF TPNT as TYPE=AOR. None
  RCODE Returned This specifies where the return code is to be returned. RETURN_CODE
Note:
The ACTIVATE_ON_RECEIPT verb is a TPF-only extension to the LU 6.2 architecture. There is no equivalent verb defined in the architecture.
ALLOCATE LUNAME Passed This specifies the fully qualified name of the remote LU. LU_NAME
  TPN Passed This specifies the name of the remote transaction program used on this conversation. TPN
  RCONTROL Passed This specifies the condition on which control is returned to the issuing program. The WSA option specifies to return control when a session is allocated for use by the conversation. The IMM option specifies to return control immediately if no contention-winner session is currently active and available. TPF does not support the other options defined by the LU 6.2 architecture. RETURN_CONTROL
  MODE Passed This specifies the name used to designate the properties of the session to be allocated. MODE_NAME
  TYPE Passed This specifies the type of conversation. The BASIC option provides support for the BASIC_CONVERSATION option defined by the LU 6.2 architecture. The MAPPED option provides support for the MAPPED_CONVERSATION option defined by the LU 6.2 architecture. TYPE
  PIP Passed This specifies whether or not program initialization parameters are supported. NO is the only supported option. TPF does not support the YES option defined by the LU 6.2 architecture. PIP
  SYNC Passed This specifies the synchronization level allowed on the allocated conversation. Only the NONE and CONFIRM options are supported. TPF does not support the SYNCPT option defined by the LU 6.2 architecture. SYNC_LEVEL
  SECURITY Passed This specifies the security information used to verify the identity of the end users of the conversation. The option NO provides support for the LU 6.2 architecture's NONE option. This indicates that access security information is omitted on this conversation. TPF does not support the architecture's SAME and PGM options. SECURITY
  RESID Returned This specifies where the resource ID is to be returned. The resource ID uniquely identifies this conversation from all others and is used when issuing other TPF/APPC verbs for this conversation. The resource ID is 4 bytes long. RESOURCE
  RCODE Returned This specifies where the return code is to be returned. RETURN_CODE
CONFIRM RESID Passed This specifies the resource ID returned by the ALLOCATE verb or the resource ID assigned by an incoming ATTACH. RESOURCE
  RCODE Returned This specifies where the return code is to be returned. RETURN_CODE
  RTSRCVD Returned This specifies where the REQUEST_TO_SEND indication is to be returned. REQUEST_TO_SEND_RECEIVED
CONFIRMED RESID Passed This specifies the resource ID returned by the ALLOCATE verb or the resource ID assigned by an incoming ATTACH. RESOURCE
  RCODE Returned This specifies where the return code is to be returned. RETURN_CODE
DEALLOCATE RESID Passed This specifies the resource ID returned by the ALLOCATE verb or the resource ID assigned by an incoming ATTACH. RESOURCE
  TYPE Passed This specifies the type of deallocation to be done. TYPE
  LOGDATA Passed This specifies whether or not error information is to be logged. NO is the only option supported. TPF does not support the YES option defined by the LU 6.2 architecture. LOG_DATA
  RCODE Returned This specifies where the return code is to be returned. RETURN_CODE
FLUSH RESID Passed This specifies the resource ID returned by the ALLOCATE verb or the resource ID assigned by an incoming ATTACH. RESOURCE
  RCODE Returned This specifies where the return code is to be returned. RETURN_CODE
GET_ATTRIBUTES RESID Passed This specifies the resource ID returned by the ALLOCATE verb or the resource ID assigned by an incoming ATTACH. RESOURCE
  RCODE Returned This specifies where the return code is to be returned. RETURN_CODE
  OWNAME Returned This specifies where the local LU name is returned. OWN_FULLY_QUALIFIED_LU_ NAME
  PLUNAME Returned This specifies where the name of the partner LU is returned. The partner LU name and the fully qualified partner LU name are identical. PARTNER_LU_NAME
  MODE Returned This specifies where the mode name used for this conversation is returned. MODE_NAME
  SYNC Returned This specifies where the synchronization level used for this conversation is returned. Only the synchronization levels NONE and CONFIRM supported. TPF does not support the SYNCPT level defined by the LU 6.2 architecture. SYNC_LEVEL
GET_TYPE RESID Passed This specifies the resource ID returned by the ALLOCATE verb or the resource ID assigned by an incoming ATTACH. RESOURCE
  RCODE Returned This specifies where the return code is to be returned. RETURN_CODE
  TYPE Returned This specifies where the conversation type is returned. TYPE
POST_ON_RECEIPT RESID Passed This specifies the resource ID returned by the ALLOCATE verb or the resource ID assigned by an incoming ATTACH. RESOURCE
  FILL Passed This specifies when posting should occur based on the logical record format. Only the LL option is supported, which specifies that posting occurs when a complete or truncated logical record is received, or when a part of a logical record is received that is at least equal in length to that specified on the LENGTH parameter. TPF does not support the BUFFER option defined by the LU 6.2 architecture. FILL
  LENGTH Passed This specifies the minimum amount of data that the LU must receive before the conversation can be posted. This parameter is used along with the FILL parameter to determine when to post the conversation. LENGTH
  RCODE Returned This specifies where the return code is to be returned. RETURN_CODE
PREPARE_TO_RECEIVE RESID Passed This specifies the resource ID returned by the ALLOCATE verb or the resource ID assigned by an incoming ATTACH. RESOURCE
  TYPE Passed This specifies the type of PREPARE_TO_RECEIVE to be performed. The FLUSH, CONFIRM and SYNC options provide support for the LU 6.2 architecture's FLUSH, CONFIRM, and SYNC_LEVEL options, respectively. If FLUSH or CONFIRM is specified, the appropriate verb function is performed. If SYNC is specified, the synchronization level specified on the ALLOCATE is used to determine which verb function is to be performed. If the synchronization level was NONE, the FLUSH verb function is performed. If the synchronization level was CONFIRM, the CONFIRM verb function is performed. TYPE
  LOCKS Passed This specifies when control is to be returned, when the CONFIRM verb is implied. Only the SHORT option is supported, which causes control to be returned upon the receipt of a positive reply to CONFIRM. TPF does not support the LONG option defined by the LU 6.2 architecture. LOCKS
  RCODE Returned This specifies where the return code is to be returned. RETURN_CODE
RECEIVE RESID Passed This specifies the resource ID returned by the ALLOCATE verb or the resource ID assigned by an incoming ATTACH. RESOURCE
  FILL Passed This specifies when the receive should be satisfied based on the logical record format. Only the LL option is supported, which specifies the program is to receive one complete or truncated logical record, or a portion of a logical record that is equal to the length specified by the LENGTH parameter. TPF does not support the BUFFER option defined by the LU 6.2 architecture. FILL
  WAIT Passed This specifies that the RECEIVE_AND_WAIT verb function should be performed. TPF does not support RECEIVE_IMMEDIATE verb defined by the LU 6.2 architecture. RECEIVE_AND_WAIT verb
  LENGTH Passed and Returned This specifies the maximum length of data that the TP can receive. When control is returned to the TP, this variable contains the actual amount of data the program received up to the maximum. If the program receives information other than data, this variable remains unchanged. LENGTH
  DATA Passed This specifies the storage address in which the program is to receive the data. DATA
  RCODE Returned This specifies where the return code is to be returned. RETURN_CODE
  RTSRCVD Returned This specifies where the REQUEST_TO_SEND indication is to be returned. REQUEST_TO_SEND_RECEIVED
  WHATRCV Returned This specifies where the WHAT_RECEIVED indication is returned. The WHAT_RECEIVED indication may indicate data, confirmation, or conversation status. WHAT_RECEIVED
REQUEST_TO_SEND RESID Passed This specifies the resource ID returned by the ALLOCATE verb or the resource ID assigned by an incoming ATTACH. RESOURCE
  RCODE Returned This specifies where the return code is to be returned. RETURN_CODE
SEND_DATA RESID Passed This specifies the resource ID returned by the ALLOCATE verb, or the resource ID assigned by an incoming ATTACH. RESOURCE
  DATA Passed This specifies the address of the data to be sent. DATA
  LENGTH Passed This specifies the length of the data to be sent. This data length is in no way related to the length of a logical record. It is used only to determine the length of the data located at the address specified on the DATA parameter. LENGTH
  RCODE Returned This specifies where the return code is to be returned. RETURN_CODE
  RTSRCVD Returned This specifies where the REQUEST_TO_SEND indication is to be returned. REQUEST_TO_SEND_RECEIVED
SEND_ERROR RESID Passed This specifies the resource ID returned by the ALLOCATE verb or the resource ID assigned by an incoming ATTACH. RESOURCE
  TYPE Passed This specifies the type of error that has been detected. The PROG option specifies that the transaction program detected an error. The SVC option specifies that a TPF service program detected an error. TYPE
  LOGDATA Passed This specifies whether or not error information is to be logged. Only the NO option is supported. TPF does not support the YES option defined by the LU 6.2 architecture. LOG_DATA
  RCODE Returned This specifies where the return code is to be returned. RETURN_CODE
  RTSRCVD Returned This specifies where the REQUEST_TO_SEND indication is to be returned. REQUEST_TO_SEND_RECEIVED
TEST RESID Passed This specifies the resource ID returned by the ALLOCATE verb or the resource ID assigned by an incoming ATTACH. RESOURCE
  TEST Passed This specifies which condition is to be tested. The POSTED option specifies to test whether the conversation has been posted. The RTSRCVD option specifies to test whether a REQUEST_TO_SEND indication has been received. TEST
  RCODE Returned This specifies where the return code is to be returned. RETURN_CODE
WAIT RESIDL Passed This specifies where a list of resource IDs are located. RESOURCE_LIST
  RCODE Returned This specifies where the return code is to be returned. RETURN_CODE
  RESPSTD Returned This specifies where the resource ID of the conversation posted is returned. RESOURCE_POSTED
Note:

Passed
Indicates that the value or option is passed from the transaction program to the verb processing component.

Returned
Indicates that the value or option is returned to the transaction program from the verb processing component.

Entry Requirements

Return Conditions

Programming Considerations

Examples

See the individual verb sections for examples.