Previous Page Contents Page Next Page

3.7 UNREGISTER_MS_APPLICATION

The UNREGISTER_MS_APPLICATION verb indicates to SNAP-IX that this application, which previously registered to receive MDS_MUs, no longer wants to receive them. After this verb completes successfully, SNAP-IX no longer sends any received MDS_MUs to the application.

Before terminating, an application should always issue UNREGISTER_MS_APPLICATION for all its registered application names, followed by DISCONNECT_MS_NODE.

3.7.1 VCB Structure

typedef struct unregister_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                  */
} UNREGISTER_MS_APPLICATION; 

3.7.2 Supplied Parameters

The application supplies the following parameters when it issues UNREGISTER_MS_APPLICATION:

opcode

AP_UNREGISTER_MS_APPLICATION

ms_appl_name

The name identifying the application that is unregistering. This must be a name that the application has previously specified using REGISTER_MS_APPLICATION. The string must be eight characters long; pad on the right with EBCDIC space characters (0x40) if necessary.

3.7.3 Returned Parameters

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.

Successful Execution

If the verb executes successfully, SNAP-IX returns the following parameter:

primary_rc

AP_OK

SNAP-IX does not return a secondary_rc when the verb executes successfully.

Unsuccessful Execution

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.

Parameter Check

If the verb does not execute because of a parameter error, SNAP-IX returns the following parameters:

primary_rc

AP_PARAMETER_CHECK

secondary_rc

One of the following:

AP_INVALID_TARGET_HANDLE

The supplied target handle was not a valid value returned on a previous CONNECT_MS_NODE verb.

AP_MS_APPL_NAME_NOT_REGD

The application has not previously issued REGISTER_MS_APPLICATION with the application name specified on this verb.

State Check

If the verb fails to execute because of a state error, SNAP-IX returns the following parameters:

primary_rc

AP_STATE_CHECK

secondary_rc

One of the following:

AP_INVALID_TARGET_STATE

The application issued this verb while CONNECT_MS_NODE or DISCONNECT_MS_NODE was outstanding.

AP_SYNC_PENDING

This verb was issued using the synchronous entry point, but another synchronous verb was in progress for this target handle. Only one synchronous verb can be in progress on a particular target handle at any time.

AP_SYNC_NOT_ALLOWED

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.

SNAP-IX Software Not Active

If the verb does not execute because the SNAP-IX software is not active, SNAP-IX returns the following parameter:

primary_rc

AP_COMM_SUBSYSTEM_ABENDED

The SNAP-IX software has failed.

SNAP-IX does not return a secondary_rc when the SNAP-IX software is not active.

MDS Support Not Configured

If the verb does not execute because the SNAP-IX configuration does not allow it, SNAP-IX returns the following parameter:

primary_rc

AP_FUNCTION_NOT_SUPPORTED

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.

System Error

If the verb does not execute because of a system error, SNAP-IX returns the following parameters:

primary_rc

AP_UNEXPECTED_SYSTEM_ERROR

An operating system call failed during processing of the verb.

secondary_rc

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 .

Previous Page Contents Page Top of Page Next page