 |
» |
|
|
 |
The DEACTIVATE_SESSION verb requests SNAplus2 to deactivate
a particular session, or all sessions on a particular mode. This verb must be issued to a running node. VCB
Structure |  |
typedef struct deactivate_session { 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 */ unsigned char session_id[8]; /* session identifier */ unsigned char plu_alias[8]; /* partner LU alias */ unsigned char mode_name[8]; /* mode name */ unsigned char type; /* deactivation type */ unsigned char reserv3[3]; /* reserved */ AP_UINT32 sense_data; /* deactivation sense data */ unsigned char fqplu_name[17]; /* fully qualified partner */ /* LU name */ unsigned char reserv4[20]; /* reserved */ } DEACTIVATE_SESSION;
|
Supplied
Parameters |  |
The application supplies the following parameters: - opcode
AP_DEACTIVATE_SESSION - 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. - session_id
8-byte identifier of the session to deactivate.
If this field is set to 8 binary zeros, SNAplus2 deactivates all sessions
for the partner LU and mode. - plu_alias
LU alias of the partner LU. 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. To indicate that the partner LU is defined by its
fully qualified LU name instead of its LU alias, set this parameter
to 8 binary zeros. - mode_name
Name of the mode to be used by the LUs. This is an 8-byte alphanumeric type-A EBCDIC string (starting
with a letter), padded on the right with EBCDIC spaces if the name
is shorter than 8 bytes. - 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. - fqplu_name
Fully qualified LU name for the partner LU, as defined to
SNAplus2. This parameter is used only if the plu_alias field is set to zeros; it is ignored if plu_alias is specified. The name is a 17-byte EBCDIC string, right-padded with EBCDIC
spaces. It consists of a network ID of up to 8 A-string characters,
an EBCDIC dot (period) character, and a network name of up to 8
A-string characters.
Returned
Parameters: Successful Execution |  |
If the verb executes successfully, SNAplus2 returns the following parameters.
This return code can also indicate that the session ID did not match
the session ID of an active session (implying that the session has
already been deactivated). 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_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. - AP_INVALID_MODE_NAME
The mode_name parameter did not match any defined mode name. - AP_INVALID_PLU_NAME
The fqplu_name parameter did not match any defined partner 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.
|