This verb adds or replaces a side information entry. A CPI-C
side information entry associates a set of conversation characteristics
with a symbolic destination name. If there is already a side information
entry with the same symbolic destination name as the one supplied
with this verb, it is overwritten with the data supplied to this
call.
Note the difference between this verb and the CPI-C function Set_CPIC_Side_Information. This verb modifies the domain configuration file, so
that it affects all SNAplus2 CPI-C applications. The CPI-C function
modifies the application's own copy in memory of the side information
table, and does not affect any other CPI-C applications.
This verb must be issued to the domain configuration file.
VCB
Structure |
 |
typedef struct define_cpic_side_info
{
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 reserv2a[8]; /* reserved */
unsigned char sym_dest_name[8]; /* Symbolic destination name */
CPIC_SIDE_INFO_DEF_DATA def_data;
} DEFINE_CPIC_SIDE_INFO;
|
typedef struct cpic_side_info_def_data
{
unsigned char description[32]; /* resource description */
unsigned char reserv1[16]; /* reserved */
CPIC_SIDE_INFO side_info; /* CPIC side info */
unsigned char reserved[24]; /* reserved */
} CPIC_SIDE_INFO_DEF_DATA;
|
typedef struct cpic_side_info
{
unsigned char partner_lu_name[17]; /* Fully qualified */
/* partner LU name */
unsigned char reserved[3]; /* Reserved */
AP_UINT32 tp_name_type; /* TP name type */
unsigned char tp_name[64]; /* TP name */
unsigned char mode_name[8]; /* Mode name */
AP_UINT32 conversation_security_type; /* Conversation security */
/* type */
unsigned char security_user_id[10]; /* User ID */
unsigned char security_password[10]; /* Password */
unsigned char lu_alias[8]; /* LU alias */
} CPIC_SIDE_INFO;
|
Supplied
Parameters |
|
The application supplies the following parameters:
- opcode
AP_DEFINE_CPIC_SIDE_INFO
- sym_dest_name
Symbolic destination name which identifies the side information
entry. This is an 8-byte ASCII string, padded on the right with
spaces if necessary. The name can contain any displayable character.
- def_data.description
A null-terminated text string (0-31 characters followed by
a null character) describing the side information entry. This string
is for information only; it is stored in the configuration file
and returned on the QUERY_CPIC_SIDE_INFO verb, but SNAplus2 does not
make any other use of it.
- def_data.side_info.partner_lu_name
Fully qualified name of the partner LU. 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.
- def_data.side_info.tp_name_type
The type of the target TP (the valid characters
for a TP name are determined by the TP type). Possible values are:
- XC_APPLICATION_TP
Application TP. All characters in the TP name must
be valid ASCII characters.
- XC_SNA_SERVICE_TP
Service TP. All characters, except the first, in
the TP name must be valid ASCII characters. The first character must
be a hexadecimal digit in the range 0x0-0x3F,
excluding 0x0E and 0x0F.
- def_data.side_info.tp_name
TP name of the target TP. This is a 64-byte ASCII character
string, padded on the right with ASCII spaces.
- def_data.side_info.mode_name
Name of the mode used to access the target TP. This
is an 8-byte ASCII character string, padded on the right with spaces.
- def_data.side_info.conversation_security_type
Specifies whether the target TP uses conversation security.
Possible values are:
- XC_SECURITY_NONE
The target TP does not use conversation security.
- XC_SECURITY_PROGRAM
The target TP uses conversation security. The security_user_id and security_password parameters specified below will be used to access the
target TP.
- XC_SECURITY_PROGRAM_STRONG
As for XC_SECURITY_PROGRAM,
except that the local node must not send the password across the
network in clear text format. (This value is included for compatibility
with IBM CPI-C implementations. The SNAplus2 node cannot provide
the appropriate restrictions on sending the password; if a CPI-C
application attempts to issue the Allocate call with this value set,
the call will fail with a return code indicating that the requested security
type is not supported.)
- XC_SECURITY_SAME
The target TP uses conversation security, and can
accept an “already verified” indicator from the local
TP. (This indicates that the local TP was itself invoked by another
TP, and has verified the security user ID and password supplied
by this TP.) The security_user_id parameter specified below will be used to access the
target TP; no password is required.
- def_data.side_info.security_user_id
User ID used to access the partner TP. This parameter is
not required if the conversation_security_type parameter is set to XC_SECURITY_NONE.
- def_data.side_info.security_password
Password used to access the partner TP. This parameter
is required only if the conversation_security_type parameter is set to XC_SECURITY_PROGRAM or XC_SECURITY_PROGRAM_STRONG.
- def_data.side_info.lu_alias
The alias of the local LU used to communicate with
the target TP. This alias is a character string using any locally
displayable characters.
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
- AP_INVALID_SYM_DEST_NAME
The sym_dest_name parameter contained a character that 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: 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
