The DEACTIVATE_CONV_GROUP verb requests the deactivation of
the session corresponding to the specified conversation group. Although
this verb is part of the NOF API, it is primarily intended for use
by application programmers writing TPs that use the APPC API. The conversation
group identifier is returned by the APPC verbs [MC_]ALLOCATE, [MC_]GET_ATTRIBUTES,
and RECEIVE_ALLOCATE.
This verb must be issued to a running node.
VCB
Structure |
 |
typedef struct deactivate_conv_group
{
AP_UINT16 opcode; /* verb operation code */
unsigned char reserv2; /* reserved */
unsigned char format; /* reserved */
AP_UINT16 primary_rc; /* primary return code */
AP_UINT32 secondary_rc; /* secondary return code */
unsigned char lu_name[8]; /* local LU name */
unsigned char lu_alias[8]; /* local LU alias */
AP_UINT32 conv_group_id; /* conversation group identifier */
unsigned char type; /* deactivation type */
unsigned char reserv3[3]; /* reserved */
AP_UINT32 sense_data; /* deactivation sense data */
} DEACTIVATE_CONV_GROUP;
|
Supplied
Parameters |
|
The application supplies the following parameters:
- opcode
AP_DEACTIVATE_CONV_GROUP
- lu_name
LU name of the local LU, as defined to SNAplus2.
This is an 8-byte type-A EBCDIC string, padded on the right with
spaces if the name is shorter than 8 bytes. To indicate that the
LU is defined by its LU alias instead of its LU name, set this parameter
to 8 binary zeros.
- lu_alias
LU alias of the local LU, as defined to SNAplus2.
This is an 8-byte ASCII string, using any locally displayable characters,
padded on the right with spaces if the name is shorter than 8 bytes.
It is used only if lu_name is set to zeros.
To indicate the LU associated with the CP (the default LU),
set both lu_name and lu_alias to 8 binary zeros.
- conv_group_id
Conversation group identifier for the session to
be deactivated.
- type
Type of deactivation. Possible values are:
- AP_DEACT_CLEANUP
Deactivate the session immediately, without waiting
for sessions to end.
- AP_DEACT_NORMAL
Do not deactivate the session until all conversations
using the session have ended.
- sense_data
If type is set to AP_DEACT_CLEANUP,
this parameter specifies the sense data to be used when deactivating the
session. Otherwise this parameter is not used.
Returned
Parameters: Successful Execution |
|
If the verb executes successfully, SNAplus2 returns the following parameters:
Returned
Parameters: Parameter Check |
|
If the verb does not execute because of a parameter error,
SNAplus2 returns the following parameters:
- primary_rc
AP_PARAMETER_CHECK
- secondary_rc
Possible values are:
- AP_DEACT_CG_INVALID_CGID
The conv_group_id parameter did not match any valid conversation group
ID.
- AP_INVALID_CLEANUP_TYPE
The type parameter was not set to a valid value.
- AP_INVALID_LU_ALIAS
The lu_alias parameter did not match any defined LU alias.
- AP_INVALID_LU_NAME
The lu_name parameter did not match any defined LU name.
Appendix A “Common
Return Codes” lists further
secondary return codes associated with AP_PARAMETER_CHECK,
which are common to all NOF verbs.
Returned
Parameters: Other Conditions |
|
Appendix A “Common
Return Codes” lists further
combinations of primary and secondary return codes that are common
to all NOF verbs.
Printable version
