IBM Books

APPC, CPI-C, and SNA Sense Codes


CPI-RR Return Codes (100 and higher)

The following return codes apply only to CPI-C programs that use CPI Resource Recovery (CPI-RR) calls.

For programs using conversations with sync_level set to CM_SYNC_POINT, all return codes indicating that backout processing is required have numeric values equal to or greater than CM_TAKE_BACKOUT. This allows you to test for a range of return code values to determine if backout processing is required. An example is:

return_code >= CM_TAKE_BACKOUT

100 CM_TAKE_BACKOUT

A Backout() request has been made; the local program needs to handle it.

Explanation
The remote program, the local system, or the remote system issued a CPI-RR Backout() call, and the local application must issue a Backout() call to restore all protected resources for a context to their status as of the last synchronization point. The conversation's context is in the Backout-Required condition upon receipt of this return code. Once the local program issues a Backout() call, the conversation is placed in the state it was in at the time of the last sync point operation.

This return code is returned only for conversations with sync_level set to CM_SYNC_POINT.

Likely Causes
The partner program issued a Backout() call.

Programmer Action
Your program should return to the point where its last synchronization point with its partners. The conversation state is now what it was then. To handle what has occurred since that time, all intervening logic and code must be executed again.

Operator Action
None.

130 CM_DEALLOCATED_ABEND_BO

The partner has abruptly ended the conversation.

Explanation
The remote program issued a Deallocate() call (CMDEAL) with deallocate_type set to CM_DEALLOCATE_ABEND, or the remote system has done so because of a remote program abnormal-ending condition. If the conversation for the remote program was in Receive state when the call was issued, information sent by the local program and not yet received by the remote program is purged.

This conversation with the partner is over.

This return code is returned only for conversations with sync_level set to CM_SYNC_POINT.

Likely Causes
The partner program encountered a condition that caused it to terminate unexpectedly, or it was stopped unexpectedly by a user. For example:

Programmer Action
The local conversation's context is in the Backout-Required condition and the program must issue a CPI-RR Backout() call to restore all of the context's protected resources to their status as of the last synchronization point.

The conversation is now in Reset state; the conversation_ID that was supplied in this CPI-C call is no longer valid.

Operator Action
Correct the problem encountered by the partner program.

131 CM_DEALLOCATED_ABEND_SVC_BO

The partner program was abnormally terminated, or it ended the conversation abnormally by issuing a Deallocate() call.

Explanation
This return code is returned under one of the following conditions:

This return code is returned for basic conversations only. In addition, it is returned only for conversations with sync_level set to CM_SYNC_POINT.

This conversation with the partner is over. This return code is reported to the local program on a call the program issues for a conversation in Send or Receive state.

You may see this return code associated with SNA sense data 08640000.

Likely Causes
Here are some examples of how this return code is caused.

Programmer Action
The local conversation's context is in the Backout-Required condition and the program must issue a CPI-RR Backout() call to restore all of the context's protected resources to their status as of the last synchronization point.

The conversation is now in Reset state; the conversation_ID that was supplied in this CPI-C call is no longer valid.

Operator Action
None.

132 CM_DEALLOCATED_ABEND_TIMER_BO

The partner program ended the conversation abnormally by issuing a Deallocate() call.

Explanation

The remote APPC (LU 6.2) transaction program issued a DEALLOCATE verb specifying a TYPE parameter of ABEND_TIMER. If the conversation for the remote program was in Receive state when the verb was issued, information sent by the local program and not yet received by the remote program is purged. This return code is reported to the local program on a call the program issues for a conversation in Send or Receive state.

This conversation with the partner is over.

This return code is returned for basic conversations only. In addition, it is returned only for conversations with sync_level set to CM_SYNC_POINT, and only when the remote transaction program is using a native APPC (LU 6.2) application programming interface and is not using CPI-C.

Likely Causes
The partner program encountered a condition that caused it to choose to terminate abnormally.

Programmer Action
The local conversation's context is in the Backout-Required condition and the program must issue a CPI-RR Backout() call to restore all of the context's protected resources to their status as of the last synchronization point.

The conversation is now in Reset state; the conversation_ID that was supplied in this CPI-C call is no longer valid.

Operator Action
None.

133 CM_RESOURCE_FAIL_NO_RETRY_BO

The active conversation has been unexpectedly ended, and starting it again probably will fail.

Explanation
A failure occurred that caused the conversation to be prematurely terminated. For example, the session being used for the conversation was deactivated because of a session protocol error, or the conversation was deallocated because of a protocol error between the mapped conversation components of the systems. The condition is not temporary, and the program should not retry the transaction until the condition is corrected. This return code can be reported to the local program on a call it issues for a conversation in any state other than Reset or Initialize.

This conversation with the partner is over.

This return code is returned only for conversations with sync_level set to CM_SYNC_POINT.

Likely Causes
The session or link used to get to the partner has been broken, or the partner program was abruptly stopped. For example:

Programmer Action
The local conversation's context is in the Backout-Required condition and the program must issue a CPI-RR Backout() call to restore all of the context's protected resources to their status as of the last synchronization point.

The conversation is now in Reset state; the conversation_ID that was supplied in this CPI-C call is no longer valid.

Operator Action
Examine any platform-related message logs and error logs at both locations to find more information about this problem. Look for equipment failures or setup problems related to the network components and the computers using them. Fix the problem, as indicated by any SNA sense data associated with this call. You may need to run the applications again with SNA tracing activated to get the sense data.

After correcting the problem, try running the pair of programs again, if appropriate.

134 CM_RESOURCE_FAILURE_RETRY_BO

The active conversation has been unexpectedly ended, and starting it again may be successful.

Explanation
A failure occurred that caused the conversation to be prematurely terminated. For example, the session being used for the conversation was deactivated because of a session outage such as a line failure, a modem failure, or a cryptography failure. The condition may be temporary, and the program can retry the transaction. This return code can be reported to the local program on a call it issues for a conversation in any state other than Reset or Initialize.

This conversation with the partner is over.

This return code is returned only for conversations with sync_level set to CM_SYNC_POINT.

Likely Causes
Some aspect of the partner computer, needed for CPI-C communication, has been deactivated. Here are some examples of how this return code is caused.

Programmer Action
The local program should attempt to allocate a session again. It is possible for some permanent failures to be initially reported as temporary, but the allocation of subsequent conversations would also fail.

The local conversation's context is in the Backout-Required condition and the program must issue a CPI-RR Backout() call to restore all of the context's protected resources to their status as of the last synchronization point.

The conversation is now in Reset state; the conversation_ID that was supplied in this CPI-C call is no longer valid.

Operator Action
Examine any platform-related message logs and error logs at both locations to find more information about this problem. Look for equipment failures or setup problems related to the network components and the computers using them. Fix the problem, as indicated by any SNA sense data associated with this call. You may need to run the applications again with SNA tracing activated to get the sense data.

After correcting the problem, try running the pair of programs again, if appropriate.

135 CM_DEALLOCATED_NORMAL_BO

The local program issued a Send_Error() call, but the conversation with the partner had already been deallocated.

Explanation
When a Send_Error() call (CMSERR) is issued in Receive state, incoming information is purged by the system. This purged information may include a notification of Deallocate-Abend from the remote program or system. When such a notification is purged, CPI-C returns CM_DEALLOCATED_NORMAL_BO instead of one of the following return codes:

This conversation with the partner is over.

This return code is returned only for conversations with sync_level set to CM_SYNC_POINT.

Likely Causes
The partner program deallocated the conversation unexpectedly.

Programmer Action
The local conversation's context is in the Backout-Required condition and the program must issue a CPI-RR Backout() call to restore all of the context's protected resources to their status as of the last synchronization point.

The conversation is now in Reset state; the conversation_ID that was supplied in this CPI-C call is no longer valid.

Operator Action
None.


[ Top of Page | Previous Page | Next Page | Table of Contents ]

[ DB2 List of Books | Search the DB2 Books ]