 |
» |
|
|
|
The ACTIVATE_SESSION verb requests SNAplus2 to activate a
session between the local LU and a specified partner LU, using a
specified mode. You must issue an INITIALIZE_SESSION_LIMIT verb
before issuing an ACTIVATE_SESSION verb, unless cnos_permitted is set to AP_YES. This verb must be issued to a running node. VCB
Structure | |
typedef struct activate_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 plu_alias[8]; /* partner LU alias */
unsigned char mode_name[8]; /* mode name */
unsigned char fqplu_name[17]; /* fully qualified partner LU name */
unsigned char polarity; /* requested session polarity */
unsigned char session_id[8]; /* session ID */
unsigned char cnos_permitted; /* is implicit CNOS permitted? */
unsigned char reserv4[15]; /* reserved */
ACTIVATE_SESSION;
|
Supplied
Parameters | |
The application supplies the following parameters: - opcode
AP_ACTIVATE_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.
This parameter is used only if lu_name is set to zeros. If both the LU name and the LU alias are set to all zeros,
the verb is forwarded to the LU associated with the CP (the default
LU). - 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. - 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. - polarity
The polarity for the session. Possible values are: | AP_POL_EITHER | | AP_POL_FIRST_SPEAKER | | AP_POL_BIDDER |
If AP_POL_EITHER is set, ACTIVATE_SESSION activates
a first speaker session if available, otherwise a bidder session
is activated. If AP_POL_FIRST_SPEAKER or AP_POL_BIDDER is
set, ACTIVATE_SESSION only succeeds if a session of the requested
polarity is available. - cnos_permitted
Indicates that CNOS processing is permitted. Possible values
are: - AP_YES
CNOS processing is permitted. - AP_NO
CNOS processing is not permitted.
If the activation of a new session is not possible because
the session limits for the specified mode are reset, and this parameter
is set to AP_YES, implicit CNOS processing
will initialize the session limits. Execution of this command is
suspended while CNOS processing is active.
Returned
Parameters: Successful Execution | |
If the verb executes successfully, SNAplus2 returns the following parameters: - primary_rc
AP_OK - secondary_rc
Possible values are: - AP_AS_NEGOTIATED
The session was activated successfully; the session
limit defined for the mode was negotiated during the activation
process. - AP_AS_SPECIFIED
The session was activated successfully; the session
limit was not changed.
- session_id
The 8-byte identifier of the activated session.
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_EXCEEDS_MAX_ALLOWED
The session cannot be activated, because this would
exceed the current session limit for this LU-LU-mode combination. - AP_INVALID_LU_ALIAS
The lu_alias parameter did not match any defined local LU alias. - AP_INVALID_LU_NAME
The lu_name parameter did not match any defined local LU name. - AP_INVALID_PLU_NAME
The fqplu_name parameter did not match any defined partner LU name, or
the plu_alias parameter did not match any defined partner LU name. - AP_INVALID_CNOS_PERMITTED
The value specified in the cnos_permitted parameter was not valid.
Appendix A “Common
Return Codes” lists further
secondary return codes associated with AP_PARAMETER_CHECK,
which are common to all NOF verbs. Returned
Parameters: Activation Failure | |
If the verb does not execute because of other errors, SNAplus2
returns one of the following parameters. - primary_rc
Possible values are: - AP_ACTIVATION_FAIL_NO_RETRY
The session could not be activated because of a
condition that requires action (such as a configuration mismatch
or a session protocol error). Check the SNAplus2 log file for information
about the error condition, and correct it before retrying this verb. - AP_ACTIVATION_FAIL_RETRY
The session could not be activated because of a
temporary condition (such as a link failure). Retry the verb, preferably
after a timeout to allow the condition to clear. Check the SNAplus2
log file for information about the error condition.
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
