CLEANUP request

The Clean Up Session (CLEANUP) request is sent from the SSCP when a session has been terminated (perhaps because of a network outage). Any outstanding RPLs will still be completed by VTAM®. The parameter list includes the CID for the session and the USERFLD field from the NIB used to establish the session. A CLSDST or TERMSESS macroinstruction should not be used after receipt of CLEANUP for the session because the session is gone; if issued, they fail.

CLEANUP can be received by both the PLU and the SLU. If the CLEANUP request is received by a PLU application program and the application program does not have an NSEXIT exit routine, the LOSTERM exit routine (if it exists) is scheduled. See Table 1 for information about session outage notification. Application programs that intend to act as SLUs in any sessions must have an NSEXIT exit routine, or they might not be notified of the loss of those sessions.

If UNBIND is received by a PLU application program which does not have an SCIP exit routine or for which SONSCIP=NO is coded on the APPL definition statement, the NSEXIT exit routine (if it exists) is scheduled with CLEANUP. See Table 1 for information about session outage notification.

There are several instances where a lost session is reported to the application in the LOSTERM Exit with a reason code of 12 or 20. In the past, if the LOSTERM Exit had already been scheduled with a reason code of 32, this more recent indication of 12 or 32 would be discarded.

If the LOSTERM Exit has already been scheduled with a reason code of 32, this more recent indication of 12 or 20 is promoted to a CLEANUP. Therefore, the NSEXIT, if available, is scheduled with a CLEANUP RU. If the NSEXIT is not available, the indication is discarded and whatever caused the attempt to notify the LOSTERM Exit and then the NSEXIT is discarded.

Table 1. Session outage notification summary
Application program is	Receives	Exit routine scheduling priority (read left to right)
Application program is	Receives	SCIP	NSEXIT	LOSTERM
Primary Logical Unit	CTERM Orderly	Not applicable	Not applicable	Reason code 32
	CTERM Forced	Not applicable	Not applicable	Reason code 12 or 20
	CLEANUP	Not applicable	CLEANUP	Reason code 12 or 24, followed by 16 or, if APPL definition statement includes LOSTERM=SECOND\|IMMED, reason code 48
	UNBIND	UNBIND	CLEANUP	Reason code 12 or 24, followed by 16
	Notify or NSPE	Not applicable	Notify or NSPE	No exit routine scheduled
Secondary Logical Unit	CLEANUP	Not applicable	CLEANUP	No exit routine scheduled
	UNBIND	UNBIND	Not applicable	Not applicable
	Notify or NSPE	Not applicable	Notify or NSPE	No exit routine scheduled
Note: The SCIP exit routine (if available) schedules for a PLU (for UNBIND) only if you code SONSCIP=YES on the APPL definition statement. For SONSCIP=NO, UNBIND is handled as if the SCIP exit routine were not available. (We strongly recommend the SCIP exit routine for support of independent LUs.) An application program acting as an SLU must have an SCIP exit routine. If the LOSTERM exit routine is not available, and is the last choice in the scheduling priority, an exit routine is not scheduled.