Package com.kristensoft.kdc

Enum LatencyMetric

  • All Implemented Interfaces:
    Serializable, Comparable<LatencyMetric>
    public enum LatencyMetric
extends Enum<LatencyMetric>
    Identifies the individual latency measurements collected by KDC.

    Each metric represents a stage of agent or reply communication and processing. Metrics are grouped into LatencyContext values according to the type of communication operation.

    Each metric provides an abbreviated title suitable for use in diagnostic output and performance reports.

    Author:
    Charles B. Kozoyed
    See Also:
    LatencyContext, LatencyRecord

    • Enum Constant Detail

      • AGENT_SERIALIZE

        public static final LatencyMetric AGENT_SERIALIZE
        Time spent serializing an agent before transmission.

      • AGENT_SEND

        public static final LatencyMetric AGENT_SEND
        Time spent sending an agent.

      • AGENT_RECEIVE

        public static final LatencyMetric AGENT_RECEIVE
        Time spent receiving an agent.

      • AGENT_DESERIALIZE

        public static final LatencyMetric AGENT_DESERIALIZE
        Time spent de-serializing a received agent.

      • AGENT_QUEUE

        public static final LatencyMetric AGENT_QUEUE
        Time spent waiting in the agent processing queue.

      • AGENT_VISIT

        public static final LatencyMetric AGENT_VISIT
        Time spent executing the agent's visit method.

      • REPLY_SERIALIZE

        public static final LatencyMetric REPLY_SERIALIZE
        Time spent serializing a reply before transmission.

      • REPLY_SEND

        public static final LatencyMetric REPLY_SEND
        Time spent sending a reply.

      • REPLY_WAIT

        public static final LatencyMetric REPLY_WAIT
        Time spent waiting for a synchronous reply.

      • REPLY_RECEIVE

        public static final LatencyMetric REPLY_RECEIVE
        Time spent receiving a reply.

      • REPLY_DESERIALIZE

        public static final LatencyMetric REPLY_DESERIALIZE
        Time spent de-serializing a received reply.

    • Method Detail

      • values

        public static LatencyMetric[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (LatencyMetric c : LatencyMetric.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static LatencyMetric valueOf​(String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null

      • getTitle

        public String getTitle()
        Returns the abbreviated title of this latency metric.

        The title is intended for compact diagnostic displays and performance reports.

        Returns:
        the abbreviated metric title