com.ibm.cics.server

Class CICSFuture

  • All Implemented Interfaces:
    java.util.concurrent.Future<ChildResponse>


    public class CICSFuture
    extends API
    implements java.util.concurrent.Future<ChildResponse>
    This class, part of the CICS Asynchronous API, implements Future. Its objects are returned by AsyncService.runTransactionId(String).
    Since CICS TS version:
    5.4
    Since package version:
    1.700.0
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      boolean cancel(boolean mayInterruptIfRunning)
      This method, suggesting the purge of a CICS task, is not supported.
      boolean equals(java.lang.Object obj)
      Compare a CICSFuture object against either another CICSFuture object, or a ChildResponse object.
      ChildResponse get()
      Block the current thread until the child task completes.
      ChildResponse get(long timeout, java.util.concurrent.TimeUnit unit)
      Block the current thread until the child task completes, or the timeout expires.
      int hashCode() 
      boolean isCancelled()
      This method is not supported.
      boolean isDone()
      Check if the child task has finished, without blocking the current thread.
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, toString, wait, wait, wait
    • Method Detail

      • equals

        public boolean equals(java.lang.Object obj)
        Compare a CICSFuture object against either another CICSFuture object, or a ChildResponse object.
        Overrides:
        equals in class java.lang.Object
        See Also:
        Object.equals(java.lang.Object)
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
        See Also:
        Object.hashCode()
      • cancel

        public boolean cancel(boolean mayInterruptIfRunning)
        This method, suggesting the purge of a CICS task, is not supported.
        Specified by:
        cancel in interface java.util.concurrent.Future<ChildResponse>
        See Also:
        Future.cancel(boolean)
      • get

        public ChildResponse get()
                          throws java.lang.InterruptedException,
                                 java.util.concurrent.ExecutionException
        Block the current thread until the child task completes.
        Specified by:
        get in interface java.util.concurrent.Future<ChildResponse>
        Throws:
        java.lang.InterruptedException
        java.util.concurrent.ExecutionException
        See Also:
        Future.get()
      • get

        public ChildResponse get(long timeout,
                                 java.util.concurrent.TimeUnit unit)
                          throws java.lang.InterruptedException,
                                 java.util.concurrent.ExecutionException,
                                 java.util.concurrent.TimeoutException
        Block the current thread until the child task completes, or the timeout expires.
        Specified by:
        get in interface java.util.concurrent.Future<ChildResponse>
        Throws:
        java.lang.InterruptedException
        java.util.concurrent.ExecutionException
        java.util.concurrent.TimeoutException
        See Also:
        Future.get(long, java.util.concurrent.TimeUnit)
      • isCancelled

        public boolean isCancelled()
        This method is not supported.
        Specified by:
        isCancelled in interface java.util.concurrent.Future<ChildResponse>
        See Also:
        Future.isCancelled()
      • isDone

        public boolean isDone()
        Check if the child task has finished, without blocking the current thread.
        Specified by:
        isDone in interface java.util.concurrent.Future<ChildResponse>
        See Also:
        Future.isDone()