Package org.onosproject.net.behaviour.inbandtelemetry

Enum IntMetadataType

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<IntMetadataType>
    public enum IntMetadataType
extends java.lang.Enum<IntMetadataType>
    Represents a type of INT metadata.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      EGRESS_TIMESTAMP
      The device local time when the INT packet was processed by the egress port.
      EGRESS_TX_UTIL
      Current utilization of the egress port via witch the INT packet was sent out.
      HOP_LATENCY
      Time taken for the INT packet to be switched within the device.
      INGRESS_TIMESTAMP
      The device local time when the INT packet was received on the ingress port.
      L1_PORT_ID
      The port on which the INT packet was received and sent out.
      L2_PORT_ID
      The logical ports on which the INT packet was received and sent out.
      QUEUE_OCCUPANCY
      The build-up of traffic in the queue that the INT packet observes in the device while being forwarded.
      SWITCH_ID
      ID of a switch, unique in the scope of the whole network.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static IntMetadataType valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static IntMetadataType[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • SWITCH_ID

        public static final IntMetadataType SWITCH_ID
        ID of a switch, unique in the scope of the whole network.

      • L1_PORT_ID

        public static final IntMetadataType L1_PORT_ID
        The port on which the INT packet was received and sent out.

      • HOP_LATENCY

        public static final IntMetadataType HOP_LATENCY
        Time taken for the INT packet to be switched within the device.

      • QUEUE_OCCUPANCY

        public static final IntMetadataType QUEUE_OCCUPANCY
        The build-up of traffic in the queue that the INT packet observes in the device while being forwarded.

      • INGRESS_TIMESTAMP

        public static final IntMetadataType INGRESS_TIMESTAMP
        The device local time when the INT packet was received on the ingress port.

      • EGRESS_TIMESTAMP

        public static final IntMetadataType EGRESS_TIMESTAMP
        The device local time when the INT packet was processed by the egress port.

      • L2_PORT_ID

        public static final IntMetadataType L2_PORT_ID
        The logical ports on which the INT packet was received and sent out.

      • EGRESS_TX_UTIL

        public static final IntMetadataType EGRESS_TX_UTIL
        Current utilization of the egress port via witch the INT packet was sent out.

    • Method Detail

      • values

        public static IntMetadataType[] 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 (IntMetadataType c : IntMetadataType.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static IntMetadataType valueOf​(java.lang.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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null