abstract class EnsLib.DotNetGateway.AbstractOperation
extends Ens.BusinessOperation
An abstract business operation that can be used as a base for business operations
requiring the .NET Gateway.
This operation doesn't actually handle I/O and there isn't an adapter.
This is a Business Operation class.
parameter SETTINGS = "DotNetServer:Basic,Port:Basic,AdditionalPaths,ConnectTimeout,-ArchiveIO";
Configurable settings for this operation.
property AdditionalPaths
as %String(MAXLEN=32000);
Comma-separated list of assembly files containing classes you are using via the .NET Gateway.
Each path element should correspond to individual assembly DLL entry, fully qualified.
Example: "C:\InterSystems\IRIS\Dev\dotnet\bin\DotNetGatewaySamples.dll".
property ConnectTimeout
as %Numeric(MINVAL=0) [ InitialExpression = 5 ];
Timeout in seconds to connect to the .NET Gateway Server from InterSystems IRIS.
property DotNetServer
as %String [ InitialExpression = "127.0.0.1" ];
IP address or name of the machine where the .NET Gateway Server executable is located.
property Port
as %Integer [ InitialExpression = "55000" ];
TCP port number for communication between the .NET Gateway Server and the proxy classes in InterSystems IRIS.
method CloseConnection()
as %Status
Close the connection from the business operation to the Gateway Server.
method ConnectDNG(ByRef pGateway As %Net.Remote.Gateway, pTimeout As %Numeric)
as %Status
This method is invoked from GetConnection and will either start a new connection or
attempt to restore a broken connection.
It can be used in case there is a failure during communication with the .NET Gateway Server.
A status is returned indicating success or failure of the [re]connection.
method GetConnection(ByRef pGateway As %Net.Remote.Gateway, pTimeout As %Numeric)
as %Status
Ensure we have a valid .NET Gateway connection. If not, try to recover.
This method returns a private gateway connection object to be used with the proxy classes.
Example: Set tSC = ..GetConnection(.tGateway)
If $$$ISOK(tSC) {
// Start using the .NET Gateway connection object tGateway
...
}
method OnInit()
as %Status
This user callback method is called just after %OnNew() to initialize the connection among other things.
If you need to override this code, invoke the method in the superclass or add to the original code.
method OnTearDown()
as %Status
This user callback method is called just before %OnClose() to disconnect from the .NET gateway server.
If you need to override this code, invoke the method in the superclass or add to the original code.