Overview of the programming interface

The Microsoft .NET Framework is supported on all Windows platforms. The Microsoft .NET Core classes are supported on all Windows and Intel Linux platforms. These can be used to build 32-bit and 64-bit remote mode applications. The .NET Framework and .NET Core classes are not supported in local mode.

The GatewayConnection class represents a connection to CICS® Transaction Gateway and the SslGatewayConnection class represents a connection that uses Secure Sockets Layer (SSL). The connection is opened in the constructor and remains open until the Close() method is invoked. The class provides two methods for interacting with CICS Transaction Gateway: Flow(request) which flows a request to CICS Transaction Gateway, and ListSystems() which returns a list of all CICS servers that have been defined in CICS Transaction Gateway. Transaction tracking can be enabled on the GatewayConnection class by setting the Applid and ApplidQualifier properties.

GatewayConnectionPool class enables connection pool which contains a number of open GatewayConnection instances which can be acquired for use and then later returned to the pool after use. To create a pool of Secure Sockets Layer (SSL) connections, useSslGatewayConnectionPool. Pooled connections can be used in the same way as non-pooled connections, the only difference being the way the connection is obtained. Connection pool removes the overhead of connection establishment and disconnection continuously thus enhancing the performance of the Client by providing a higher throughput. Use of connection pools in .NET Framework and .NET Core for optimal resource utilization and a reduction in response time.

A connection pool is created by passing a ConnectionPoolProperties object to the GatewayConnectionPool class. The properties object contains parameters that controls the number of connections in the connection pool and the behavior of the connection pool.

The EciRequest class represents an ECI call to CICS, and allows data to be flowed in either COMMAREAs or channels. The Channel and Container classes are used to construct and manage channel and container data. If you specify both a channel and a COMMAREA on an ECI call, the channel is flowed and the COMMAREA is ignored.

The EsiVerifyRequest and EsiChangeRequest classes provide methods for verifying security credentials and changing passwords and password phrases.

The Trace class provides methods for controlling tracing within the API.