TRANSFER_MS_DATA
This verb is used by NMVT-level applications to send unsolicited alerts and to respond to previously-received NMVT requests.
TRANSFER_MS_DATA is also used by MDS-level applications to send unsolicited alerts. This verb can be used by the application using the WinMS call.
VCB Structure
typedef struct ms_transfer_ms_data
{
unsigned short opcode; /* Verb operation code */
unsigned char data_type; /* Data type supplied by app */
unsigned char format; /* format */
unsigned short primary_rc; /* Primary return code */
unsigned long secondary_rc; /* Secondary return code */
unsigned char options; /* Verb options */
unsigned char reserv3; /* reserved */
unsigned char originator_id[8]; /* Originator ID */
unsigned char pu_name[8]; /* Physical unit name */
unsigned char reserv4[4]; /* reserved */
unsigned short dlen; /* Length of data */
unsigned char *dptr; /* Data */
} MS_TRANSFER_MS_DATA;
Supplied Parameters
The application supplies the following parameters:
- opcode
- SV_TRANSFER_MS_DATA
- data_type
- Specifies the type of data enclosed. management services processes the
data as described below. Allowed values:
- SV_NMVT
- The data contains a complete NMVT request unit. Management services converts the data to MDS_MU or CP_MSU format if the data contains an alert, and the alert is to be sent to an MDS-level or migration-level focal point. This is the type required when an application is responding to an NMVT_RECEIVED signal.
- SV_ALERT_SUBVECTORS
- The data contains management services subvectors in the SNA-defined format for an Alert major vector. Management services adds an NMVT header and an alert major vector header. Subsequently, management services converts the data to MDS_MU or CP_MSU format if the alert is to be sent to an MDS-level or migration-level focal point.
- SV_USER_DEFINED
- The data contains a complete NMVT request unit. Management services always logs the data, but does not send it.
- SV_PDSTATS_SUBVECTORS
- The data contains problem determination statistics. Management services always logs the data, and if an alert handler has been registered, then management services sends it the data within an ALERT_INDICATION.
- format
- Identifies the format of the VCB. Set this field to zero to specify the version of the VCB listed above.
- options
- Specifies optional processing on the data supplied on this verb. Note
that management services processes the data primarily according to the type specified if there is any conflict between the data_type and the option specified. This parameter is a
one-byte value, with individual bit settings indicating the options selected.
If all options are specified, set this byte to zero.
- Bit 0 is the most significant, and bit 7 is the least significant bit.
- (Bits 1–3 are ignored if data_type is set to SV_USER_DEFINED.)
- Bit 0: Adds Date/Time (X'01') subvector to the data if set to zero.
- Bit 1: Adds Product Set ID (X'10') subvector to the data if set to zero. If the application supplies data that already contains a Product Set ID subvector, management services adds Personal Communications or Communications Server's Product Set ID subvector immediately before the existing one.
- Bit 2: Sends the data on an SNA session if set to zero. Management services sends the data on the default SSCP-PU session if the data does not contain an alert. If the data contains an alert, management services sends the data on either an SSCP-PU session, a CP-CP session or an LU-LU session, depending on which type of session Personal Communications or Communications Server uses to transmit alerts to the alert focal point.
- Bit 3: Logs the data via the Personal Communications or Communications Server problem determination facility if
set to zero.
Note: The following constants are provided in the management services header file and they refer to the individual bits specified above.
- SV_TIME_STAMP_SUBVECTOR
- SV_PRODUCT_SET_ID_SUBVECTOR
- SV_SEND_ON_SESSION
- SV_LOCAL_LOGGING
- Bits 4–7: reserved.
- originator_id
- Name of the component that issued the verb. This is an 8-byte string in a locally displayable character set. This field is only used by management services when logging the TRANSFER_MS_DATA.
- pu_name
- Name of the physical unit to send the data to. This should be set to either an 8-byte alphanumeric type-A EBCDIC string, padded to the right with EBCDIC spaces, or set to all binary zeros if no pu_name is specified. Applications using TRANSFER_MS_DATA to respond to NMVT_RECEIVED signals should specify the pu_name received in the NMVT_RECEIVED signal. The data contained in TRANSFER_MS_DATA signals of type SV_NMVT that do not specify a pu_name will be sent over the default PU session if available. TRANSFER_MS_DATA signals containing alerts should not specify a pu_name unless the application expressly wishes the alert data to be sent to a specific PU. This will bypass the normal management services alert routing algorithm.
- dlen
- Length of data.
- dptr
- Pointer to data. If this is set to NULL, then management services assumes that the data is contiguous with (and begins immediately following) the VCB.
Returned Parameters
If the verb executes successfully, management services returns the following
parameter:
- primary_rc
- AP_OK
If the verb fails to execute because of a parameter error, management services
returns the following parameters:
- primary_rc
- AP_PARAMETER_CHECK
- secondary_rc
- SV_INVALID_DATA_TYPE
SV_DATA_EXCEEDS_RU_SIZE
AP_INVALID_PU_NAME
If the verb fails to execute because of a state error, management services
returns the following parameters:
- primary_rc
- AP_STATE_CHECK
- secondary_rc
- SV_SSCP_PU_SESSION_NOT_ACTIVE
If the verb does not execute because of a system error, the Program management
services returns the following parameter:
- primary_rc
- AP_UNEXPECTED_SYSTEM_ERROR