ctgclient_eci.h File Reference
#include "ctgclient.h"
#include "eci_channel.h"

Go to the source code of this file.

Detailed Description

Defines functions and typedefs for sending External Call Interface (ECI) requests to a Gateway daemon.

Definition in file ctgclient_eci.h.

Macro Definition Documentation

◆ CICSCALL

Definition at line 56 of file ctgclient_eci.h.

◆ ECI_ABEND_CODE_LENGTH

Length of the eci_abend_code field.

Definition at line 213 of file ctgclient_eci.h.

◆ ECI_ASYNC

A value used with the CTG_ECI_PARMS::eci_call_type field.

Definition at line 101 of file ctgclient_eci.h.

◆ ECI_BACKOUT

A value used with the CTG_ECI_PARMS::eci_extend_mode field.

Definition at line 276 of file ctgclient_eci.h.

◆ ECI_COMMIT

A value used with the CTG_ECI_PARMS::eci_extend_mode field.

Definition at line 272 of file ctgclient_eci.h.

◆ ECI_ERR_ALREADY_ACTIVE

An attempt was made to continue an existing logical unit of work, but there was an outstanding asynchronous call for the same logical unit of work.

Definition at line 609 of file ctgclient_eci.h.

◆ ECI_ERR_CICS_DIED

Communication with the target CICS server was interrupted during the request.

Definition at line 569 of file ctgclient_eci.h.

◆ ECI_ERR_INVALID_CALL_TYPE

The eci_call_type field is not valid.

This can occur for the following reasons:

  • The eci_call_type field is not set to a valid call type value.
  • The active CICS request exit rejected the request.
  • The request includes a channel and the destination CICS server is not a defined IPIC server.

Definition at line 603 of file ctgclient_eci.h.

◆ ECI_ERR_INVALID_DATA_AREA

The combination of eci_commarea and eci_commarea_length values is not valid.

If eci_commarea is NULL, eci_commarea_length must be zero. If eci_commarea is not NULL, eci_commarea_length must not be zero.

Definition at line 626 of file ctgclient_eci.h.

◆ ECI_ERR_INVALID_DATA_LENGTH

Bad data length.

This might be because the protocol used to communicate with CICS is unable to send or receive the specified COMMAREA size.

Definition at line 556 of file ctgclient_eci.h.

◆ ECI_ERR_INVALID_EXTEND_MODE

The eci_extend_mode field is not valid.

Definition at line 560 of file ctgclient_eci.h.

◆ ECI_ERR_INVALID_MSG_QUAL

The message qualifier is not in use.

Definition at line 667 of file ctgclient_eci.h.

◆ ECI_ERR_INVALID_VERSION

The eci_version field was not set to ECI_VERSION_2 or ECI_VERSION_2A.

Definition at line 630 of file ctgclient_eci.h.

◆ ECI_ERR_LUW_TOKEN

The value in eci_luw_token is incorrect.

There is no active unit of work associated with the specified token.

Definition at line 588 of file ctgclient_eci.h.

◆ ECI_ERR_MAX_SESSIONS

There are insufficient communication resources to complete the request.

Definition at line 649 of file ctgclient_eci.h.

◆ ECI_ERR_MAX_SYSTEMS

The CICS TG has reached its limit on the maximum number of CICS servers.

Definition at line 644 of file ctgclient_eci.h.

◆ ECI_ERR_NO_CICS

Communication with the target CICS server could not be established.

Definition at line 564 of file ctgclient_eci.h.

◆ ECI_ERR_NO_REPLY

No reply.

This can occur for the following reasons:

  • The eci_call_type field is set to ECI_GET_REPLY and there are no replies outstanding.
  • The eci_call_type field is set to ECI_GET_SPECIFIC_REPLY and there is no reply for the specified message qualifier.

Definition at line 663 of file ctgclient_eci.h.

◆ ECI_ERR_NO_SESSIONS

There are insufficient communication resources to communicate with the target CICS server.

Definition at line 620 of file ctgclient_eci.h.

◆ ECI_ERR_REQUEST_TIMEOUT

The timeout interval expired before the request was sent to CICS, or the value supplied for timeout is negative.

Definition at line 574 of file ctgclient_eci.h.

◆ ECI_ERR_RESOURCE_SHORTAGE

There are insufficient resources to communicate with the target CICS server; details might be available in the CICS TG error log files.

Definition at line 615 of file ctgclient_eci.h.

◆ ECI_ERR_RESPONSE_TIMEOUT

The ECI call timed out while waiting for a response.

Definition at line 578 of file ctgclient_eci.h.

◆ ECI_ERR_ROLLEDBACK

An attempt was made to commit a logical unit of work, but the CICS server was unable to commit the changes, and backed them out instead.

Definition at line 655 of file ctgclient_eci.h.

◆ ECI_ERR_SECURITY_ERROR

An invalid combination of user ID and password or password phrase was specified.

Definition at line 639 of file ctgclient_eci.h.

◆ ECI_ERR_SYSTEM_ERROR

An internal system error has occurred.

If the problem persists, collect application and Gateway daemon trace and contact your IBM service representative.

Definition at line 594 of file ctgclient_eci.h.

◆ ECI_ERR_TRANSACTION_ABEND

The CICS transaction abended.

The abend code is available in the eci_abend_code field.

Definition at line 583 of file ctgclient_eci.h.

◆ ECI_ERR_UNKNOWN_SERVER

The target CICS server is unknown to the Gateway daemon.

Definition at line 634 of file ctgclient_eci.h.

◆ ECI_EXTENDED

A value used with the CTG_ECI_PARMS::eci_extend_mode field.

Definition at line 268 of file ctgclient_eci.h.

◆ ECI_GET_REPLY

A value used with the CTG_ECI_PARMS::eci_call_type field.

Definition at line 105 of file ctgclient_eci.h.

◆ ECI_GET_REPLY_WAIT

A value used with the CTG_ECI_PARMS::eci_call_type field.

Definition at line 109 of file ctgclient_eci.h.

◆ ECI_GET_SPECIFIC_REPLY

A value used with the CTG_ECI_PARMS::eci_call_type field.

Definition at line 113 of file ctgclient_eci.h.

◆ ECI_GET_SPECIFIC_REPLY_WAIT

A value used with the CTG_ECI_PARMS::eci_call_type field.

Definition at line 117 of file ctgclient_eci.h.

◆ ECI_LUW_NEW

A value used to set the CTG_ECI_PARMS::eci_luw_token field at the start of a new logical unit of work.

Definition at line 323 of file ctgclient_eci.h.

◆ ECI_NO_ERROR

No error.

Definition at line 551 of file ctgclient_eci.h.

◆ ECI_NO_EXTEND

A value used with the CTG_ECI_PARMS::eci_extend_mode field.

Definition at line 264 of file ctgclient_eci.h.

◆ ECI_PASSWORD_LENGTH

Length of the eci_password field.

Definition at line 184 of file ctgclient_eci.h.

◆ ECI_PROGRAM_NAME_LENGTH

Length of the eci_program_name field.

Definition at line 159 of file ctgclient_eci.h.

◆ ECI_SYNC

A value used with the CTG_ECI_PARMS::eci_call_type field.

Definition at line 97 of file ctgclient_eci.h.

◆ ECI_SYSTEM_NAME_LENGTH

Length of the eci_system_name field.

Definition at line 372 of file ctgclient_eci.h.

◆ ECI_TPN_LENGTH

Length of the eci_tpn field.

Definition at line 389 of file ctgclient_eci.h.

◆ ECI_TRANSID_LENGTH

Length of the eci_transid field.

Definition at line 193 of file ctgclient_eci.h.

◆ ECI_USERID_LENGTH

Length of the eci_userid field.

Definition at line 175 of file ctgclient_eci.h.

◆ ECI_VERSION_2

ECI version provided for applications that use the eci_userid and eci_password fields to specify security credentials.

For new applications, specify an eci_version of ECI_VERSION_2A and use the eci_userid_ptr and eci_password_ptr fields for security credentials. ECI_VERSION_2 supports only the ECI_SYNC call type.

Definition at line 351 of file ctgclient_eci.h.

◆ ECI_VERSION_2A

Latest ECI version.

ECI_VERSION_2A supports both synchronous and asynchronous ECI call types. Security credentials are specified using eci_userid_ptr and eci_password_ptr.

Definition at line 357 of file ctgclient_eci.h.

Typedef Documentation

◆ PCTG_ECI_PARMS

A reference for an ECI Parameter block, CTG_ECI_Execute .

Definition at line 463 of file ctgclient_eci.h.

Function Documentation

◆ CTG_ECI_dumpChannels()

Writes the contents of internal CICS TG channel and container structures to the current trace destination.

The debug information is written irrespective of trace settings.

Note
The IBM service organization may request that this function is used to aid problem determination.
Returns
An integer value identifies whether the call was successful or not.
Possible values include

◆ CTG_ECI_Execute()

Sends an ECI request to the Gateway with a COMMAREA or retrieves an asynchronous ECI response, depending on the value of CTG_ECI_PARMS::eci_call_type.

Parameters
Returns
An integer value identifies whether the call was successful or not.
Possible values include Other possible values are all of the documented ECI return codes.

◆ CTG_ECI_Execute_Channel()

Sends an ECI request to the Gateway with a channel object or retrieves an asynchronous ECI response, depending on the value of CTG_ECI_PARMS::eci_call_type.

Parameters
Returns
An integer value identifies whether the call was successful or not.
Possible values include Other possible values are all of the documented ECI return codes.