Contains properties for creating connection pools.
SystemObject IBM.CTGConnectionPoolProperties
Namespace:
IBM.CTG
Assembly:
IBM.CTG.Client (in IBM.CTG.Client.dll) Version: 10.1.0.0 (10.1.0.0)
public class ConnectionPoolProperties
Public Class ConnectionPoolProperties
public ref class ConnectionPoolProperties
The ConnectionPoolProperties type exposes the following members.
Top
|
| Name | Description |
|---|
 | AgedTimeout | Gets or sets the maximum time that connections can remain open in the connection pool. |
 | Applid | Gets or sets the client APPLID used by connections in the connection pool. |
 | ApplidQualifier | Gets or sets the client APPLID qualifier used by connections in the connection pool. |
 | ConnectTimeout | Gets or sets the maximum time to wait for connections in the connection pool to complete. |
 | IdleTimeout | Gets or sets the maximum time that connections can remain idle in the connection pool. |
 | MaxConnections | Gets or sets the maximum number of connections in the connection pool. |
 | MinConnections | Gets or sets the minimum number of connections in the connection pool. |
Top
|
| Name | Description |
|---|
 | Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
 | GetHashCode | Serves as the default hash function. (Inherited from Object.) |
 | GetType | Gets the Type of the current instance. (Inherited from Object.) |
 | MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
 | ToString | Returns a string that represents the current object. (Inherited from Object.) |
Top
An instance of
ConnectionPoolProperties can be specified
when creating a new
GatewayConnectionPool or
SslGatewayConnectionPool in order to control the number of
connections in the connection pool and the behaviour of the connection pool. A single
ConnectionPoolProperties instance can be used to create
multiple connection pools.
The
MinConnections and
MaxConnections properties set the
minimum and maximum number of connections in the connection pool. When a connection
pool is created, the minimum number of connections are established immediately.
Additional connections are established and added to the pool each time
GetConnection is invoked while
all existing connections are in use and the maximum number of connections has not
been reached. Connections are removed from the pool if an error occurs while in
use. If this causes the number of connections in the pool to drop below the
minimum number of connections, new connections are established and added to the
pool until the minimum is reached. The default value for
MinConnections
is 1 and the default value for
MaxConnections
is unlimited (Int32.MaxValue).
The
ConnectTimeout property
sets maximum time, in seconds, to wait for connections in the pool to be established.
A value of zero indicates no timeout. The default value is zero.
The
IdleTimeout property sets
the maximum time, in seconds, that connections in the pool can remain idle before they
are automatically closed. If the number of connections in the connection pool is greater
than
MinConnections, any connections
that have not been acquired for the specified number of seconds are closed. This property
can be used to ensure that communication resources are released during periods of reduced
activity. A value of zero indicates no timeout. The default value is zero.
The
AgedTimeout property sets
maximum time, in seconds, that connections in the pool can remain open before they are
automatically closed. When deploying a high availability environment where work is
balanced across multiple Gateway daemon instances, this property can be used to ensure that
connections in the connection pool continue to be balanced after a failure has occurred.
If this property is set, connections in the pool are periodically closed and then
re-established so that they can be evenly distributed across all available Gateway daemon
instances. A value of zero indicates no timeout. The default value is zero.
Transaction tracking for connections in the connection pool can be enabled by setting the
Applid and
ApplidQualifier
properties. All connections in the connection pool share the same APPLID and APPLID
qualifier.
Static members of this type are safe for multi-threaded operations. Instance members of this type are safe for multi-threaded operations.
Reference