com.ibm.ctg.client

Class LocalJavaGateway

  • java.lang.Object
    • com.ibm.ctg.client.JavaGatewayInterface
      • com.ibm.ctg.client.LocalJavaGateway


  • public class LocalJavaGateway
    extends com.ibm.ctg.client.JavaGatewayInterface
    The LocalJavaGateway represents a logical connection between your program and the CICS Transaction Server when you specify a local connection. This means rather than flowing the request across the network, you can connect directly to the CICS server, bypassing any CICS Transaction Gateway servers.
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      long closeTimeout
      Time given for in-progress work to end when LocalJavaGateway support has been terminated
      • Fields inherited from class com.ibm.ctg.client.JavaGatewayInterface

        CLASS_VERSION
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      static void destroy()
      When the local Gateway support is cleanly terminated, it will run termination routines for all the different type of requests it has seen.
      • Methods inherited from class com.ibm.ctg.client.JavaGatewayInterface

        getLocalAddress, setRequestExitMonitor
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • closeTimeout

        public long closeTimeout
        Time given for in-progress work to end when LocalJavaGateway support has been terminated
    • Method Detail

      • destroy

        public static void destroy()
                            throws java.io.IOException
        When the local Gateway support is cleanly terminated, it will run termination routines for all the different type of requests it has seen. This allows the correct termination of, for example, the CICS EPI prior to the Gateway process ending.

        When running using the local Gateway object, it is not possible for the local Gateway code to programatically decide when to run these request termination routines, since it cannot tell when the program using the local Gateway is about to end.

        The destroy method is provided to allow a programmer to explicitly say that it has finished using the local Gateway support, and WILL NOT use it again in the program. When called the termination routines of all the used request types will be run. Once called it will not be possible to create another local Gateway for the rest of the life-time of the program.

        Throws:
        java.io.IOException

©Copyright IBM Corp. 1994, 2024


Legal