Interface ITSQueue

    • Method Detail

      • getName

        java.lang.String getName()
        Getter for field NAME

        Queue name

        The name of the temporary storage queue.

        Specified by:
        getName in interface ICICSObject
      • getLocation

        ITSQueue.LocationValue getLocation()
        Getter for field LOCATION

        Queue location

        Indicates where the temporary storage queue resides. Values are:

        • AUXILIARY The temporary storage queue is held in the CICS temporary storage VSAM data set (or in the coupling facility).
        • MAIN The temporary storage queue is held in main storage.
      • getQueueLength

        java.lang.Long getQueueLength()
        Getter for field QUELENGTH

        Total queue length (bytes)

        The total length, in bytes, of all the items in the temporary storage queue.

        Note: If an AUXILIARY TSQNAME contains an item that is larger than the control interval size of the temporary storage data set, this field will be displayed as N/A.

      • getMaxItemLength

        java.lang.Long getMaxItemLength()
        Getter for field MAXITEMLEN

        Largest item length (bytes)

        The length in bytes of the largest item in the temporary storage queue.

        The length of a queue item is the sum of the length of the user data plus 8 bytes for header information, rounded up. For main storage queues, the length is rounded up to the boundary of the MVS storage subpool used to store it.

        For auxiliary temporary storage, the length is rounded to the next highest multiple of either 64 or 128 (depending on the control interval size of the temporary storage data set). (For background information about CI sizes, see The control interval size.)

        For shared queues, the lengths returned in MINITEMLEN, MAXITEMLEN, and QUELENGTH, reflect the data length stored in the coupling facility. This includes any item control information, which consists of a 2-byte length prefix for each item.

        For all types of queue the maximum value returned will be capped at 32767 (Hex '7FFF').

      • getMinItemLength

        java.lang.Long getMinItemLength()
        Getter for field MINITEMLEN

        Smallest item length (bytes)

        The length in bytes of the smallest item in the temporary storage queue. For information about how CICS calculates the length of items, and for information about shared TS queues, see the MAXITEMLEN option.

      • getItemCount

        java.lang.Long getItemCount()
        Getter for field NUMITEMS

        Number of items in queue

        The number of items in the temporary storage queue.

      • getLastusedint

        java.lang.Long getLastusedint()
        Getter for field LASTUSEDINT

        Interval since queue last used (seconds)

        The interval in seconds since the temporary storage queue was last referenced.

        The value returned for large shared temporary storage queues is governed by the value of the LASTUSEDINTERVAL parameter specified for the associated TS queue manager.

      • getTransid

        java.lang.String getTransid()
        Getter for field TRANSID

        Transaction that created TS queue

        The ID of the transaction that created the temporary storage queue.

      • getRecovstatus

        ITSQueue.RecovstatusValue getRecovstatus()
        Getter for field RECOVSTATUS

        Recovery status

        Indicates whether or not the temporary storage queue is recoverable. Options are RECOVERABLE or NOTRECOVERABLE.

      • getExpiryint

        java.lang.Long getExpiryint()
        Getter for field EXPIRYINT

        TS Queue expiry interval (hours)

        The last used interval limit time, in hours, which is used to determine whether a temporary storage queue has expired and is eligible to be automatically deleted. The value is derived from the EXPIRYINT value in the TSMODEL, or for CICS TS 5.2 and higher either the EXPIRYINT value or the EXPIRYINTMIN value rounded up to the next hour. The EXPIRYINTMIN value overrides EXPIRYINT. The value in the TSMODEL at the time a temporary storage queue is created will be used for the lifetime of a queue even if the TSMODEL is subsequently changed. The value of EXPIRYINT can be in the range of 0-to-15000.

        • 0 - Indicates that no expiry interval applies to this TSMODEL and therefore a temporary storage queue based on this will never expire. This is the default value.
        • value - Specifies the last used interval in hours after which the queue becomes eligible for automatic deletion.
      • getHexname

        java.lang.String getHexname()
        Getter for field HEXNAME

        Queue name in hexadecimal

        The name of the temporary storage queue in hexadecimal.

      • getExpiryintmin

        java.lang.Long getExpiryintmin()
        Getter for field EXPIRYINTMIN

        TS Queue expiry interval (minutes)

        The last used interval limit time, in minutes, which is used to determine whether a temporary storage queue has expired and is eligible to be automatically deleted. CICS rounds up the value to a multiple of ten minutes. The value in the TSMODEL at the time a temporary storage queue is created will be used for the lifetime of a queue even if the TSMODEL is subsequently changed. The value of EXPIRYINTMIN can be in the range of 0-to-900000.

        • 0 - Indicates that no expiry interval applies to this TS queue. This is the default value.
        • value - Specifies the last used interval in minutes after which the queue becomes eligible for automatic deletion.
      • getTSModel

        java.lang.String getTSModel()
        Getter for field TSMODEL

        TS Model

        The name of the TS model which was used when the queue was created. Some properties of the queue are set at creation time from the TS model. If the TS model is subsequently altered or deleted, this has no effect on the TS queue.