|
|
|
|
The REGISTER_MS_APPLICATION verb registers the MS application with SNAP-IX as an MDS-level application that can receive MDS_MUs. Before issuing this verb, the application must issue CONNECT_MS_NODE to obtain a target handle for the SNAP-IX node. This handle is a required parameter to the MS entry point for REGISTER_MS_APPLICATION.
An application must always issue this verb using the asynchronous MS entry point and supply a callback routine. SNAP-IX uses this callback routine to return received MDS_MUs to the application. (For more information about the MS entry points, see Writing MS Applications.)
typedef struct register_ms_application
{
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 ms_appl_name[8]; /* MS application name */
unsigned char ms_category[8]; /* MS category */
AP_UINT16 max_rcv_size; /* Maximum size that can be received */
} REGISTER_MS_APPLICATION;
The application supplies the following parameters when it issues the REGISTER_MS_APPLICATION verb:
A name identifying this application. An application can register more than once using different application names. The name has the following requirements:
It cannot match the name used by any other application that is currently registered as an MS application.
It cannot be either NODE or UNIX , which are reserved for use by SNAP-IX components.
It must be eight characters long; pad on the right with EBCDIC space characters (0x40) if necessary.
It can be one of the following:
An EBCDIC string, using type-1134 characters (uppercase A-Z and numerals 0-9)
One of the MS Discipline-Specific Application Programs specified in an appendix of IBM Systems Network Architecture: Management Services Reference
If the application needs to obtain the name of its focal point for a particular MS category, specify the category name here. If the application does not need to obtain focal point information, set this parameter to eight binary zeros. The application can register more than once for different MS category names.
The MS category name can be one of the following:
A user-defined category name, an 8-byte EBCDIC string using type-1134 characters (uppercase A-Z and numerals 0-9)
One of the category names specified in the MS Discipline-Specific Application Programs table of an appendix of IBM Systems Network Architecture: Management Services Reference
Names of either type should be padded to eight bytes with trailing space (0x40) characters if necessary.
SNAP-IX returns details of the focal point using an FP_NOTIFICATION indication on the callback routine that was supplied with REGISTER_MS_APPLICATION. If the focal point subsequently changes, SNAP-IX sends another FP_NOTIFICATION with the new information.
The maximum number of bytes that the application can accept in one message. If an incoming MDS_MU is longer than this size, SNAP-IX segments it and delivers each segment in a separate MDS_MU_RECEIVED signal.
After the verb executes, SNAP-IX returns parameters to indicate whether the execution was successful and, if not, to indicate the reason the execution was not successful.
If the verb executes successfully, SNAP-IX returns the following parameter:
AP_OK
SNAP-IX does not return a secondary_rc when the verb executes successfully.
When a verb does not execute successfully, SNAP-IX returns a primary return code to indicate the type of error and a secondary return code to provide specific details about the reason for unsuccessful execution.
If the verb does not execute because of a parameter error, SNAP-IX returns the following parameters:
AP_PARAMETER_CHECK
One of the following:
Another application is currently registered with the specified name, or the application specified one of the two reserved names, NODE and UNIX.
The supplied application name contains a character not in the EBCDIC type-1134 character set, and the name is not one of the MS Discipline-Specific Application Program names.
The supplied category name contains a character not in the EBCDIC type-1134 character set, and the name is not one of the MS Discipline-Specific Application Program category names.
The target handle supplied by the entry point used by the verb is not a valid value returned on a previous CONNECT_MS_NODE verb.
The application used the synchronous MS entry point to issue this verb within a callback routine. The application must use the asynchronous entry point to issue any verb from a callback routine.
If the verb does not execute because of a state error, SNAP-IX returns the following parameters:
AP_STATE_CHECK
The application issued this verb while CONNECT_MS_NODE or DISCONNECT_MS_NODE was outstanding.
If the verb does not execute because the SNAP-IX software is not active, SNAP-IX returns the following parameter:
One of the following:
The SNAP-IX software is not loaded.
The SNAP-IX software has failed.
SNAP-IX does not return a secondary_rc when the SNAP-IX software is not active.
If the verb does not execute because the SNAP-IX configuration does not allow it, SNAP-IX returns the following parameter:
The SNAP-IX local node is not configured to support MDS-level network management applications. Only NMVT-level applications can be used.
SNAP-IX does not return a secondary_rc when it is not configured for MDS-level support.
If the verb does not execute because of a system error, SNAP-IX returns the following parameters:
An operating system call failed during processing of the verb.
The return code from the operating system call. For the meaning of this return code, check the returned value in the file /usr/include/sys/errno.h .
|
|
|
 |
|