Class ModuleInfo.QueueInfo

  • All Implemented Interfaces:
    Cloneable
    Enclosing class:
    ModuleInfo

    public static class ModuleInfo.QueueInfo
    extends Object
    implements Cloneable
    Information about a Queue between modules or containers.
    • Method Detail

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object
      • getMaxQueueLength

        public int getMaxQueueLength()
        Return the maximum numbers of tuples that this queue has ever seen.
        Returns:
        maximum number of tuples that this queue can contain
      • getCurrentQueueLength

        public int getCurrentQueueLength()
        Return the approximate number of tuples currently in this queue. This number is approximate since there can be multiple threads accessing the queue at the same time.
        Returns:
        the approximate number of tuples currently in the queue
      • getBatchProcessingTime

        public int getBatchProcessingTime()
        Return the a moving average of the amount of time (microseconds) that it takes to process a batch of tuples.
        Returns:
        amount of time (microseconds) that it takes to process a batch of tuples
        Since:
        6.3.10
      • getBatchLatency

        public int getBatchLatency()
        Return a moving average of the time (microseconds) for a batch of tuples to traverse the queue
        Returns:
        amount of time (microseconds) for a batch of tuples to traverse the queue
        Since:
        6.3.10
      • getBatchSize

        public long getBatchSize()
        Return a moving average of the size of a batch of tuples
        Returns:
        Return a moving average of the size of a batch of tuples
        Since:
        6.6.13
      • getName

        public String getName()
        Return the name of this queue. For queues between modules the name will be the name of the stream that is being enqueued into. For queues between containers the name will be the name of the container connection.
        Returns:
        the name of this queue