Previous Page Contents Page Next Page

3.2 DISCONNECT_MS_NODE

This verb disconnects an application from a node, freeing all resources associated with that connection. The node from which the application wants to disconnect is identified by the target_handle parameter on the call.

3.2.1 VCB Structure

typedef struct disconnect_ms_node
{
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        */
} DISCONNECT_MS_NODE; 

3.2.2 Supplied Parameters

An application supplies the following parameter when it issues DISCONNECT_MS_NODE:

opcode

AP_DISCONNECT_MS_NODE

3.2.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

AP_INVALID_TARGET_HANDLE

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

State Check

If the verb does not 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 DISCONNECT_MS_NODE while CONNECT_MS_NODE or a previous DISCONNECT_MS_NODE was still outstanding.

AP_SYNC_PENDING

The application used the synchronous entry point to issue this verb, 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_VERB_IN_PROGRESS

The application issued DISCONNECT_MS_NODE while a previous asynchronous MS verb was still outstanding.

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 successfully 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.

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