Enum HAProxyProtocolVersion

java.lang.Object
java.lang.Enum<HAProxyProtocolVersion>
io.netty.handler.codec.haproxy.HAProxyProtocolVersion
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<HAProxyProtocolVersion>
public enum HAProxyProtocolVersion extends java.lang.Enum<HAProxyProtocolVersion>
The HAProxy proxy protocol specification version.

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    V1
    The ONE proxy protocol version represents a version 1 (human-readable) header.
    V2
    The TWO proxy protocol version represents a version 2 (binary) header.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final byte
    byteValue
     
    private static final byte
    VERSION_MASK
    The highest 4 bits of the protocol version and command byte contain the version

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    private
    HAProxyProtocolVersion(byte byteValue)
    Creates a new instance

  • Method Summary

    Modifier and Type
    Method
    Description
    byte
    byteValue()
    Returns the byte value of this version.
    static HAProxyProtocolVersion
    valueOf(byte verCmdByte)
    Returns the HAProxyProtocolVersion represented by the highest 4 bits of the specified byte.
    static HAProxyProtocolVersion
    valueOf(java.lang.String name)
    Returns the enum constant of this type with the specified name.
    static HAProxyProtocolVersion[]
    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 Details

    • V1

      public static final HAProxyProtocolVersion V1
      The ONE proxy protocol version represents a version 1 (human-readable) header.

    • V2

      public static final HAProxyProtocolVersion V2
      The TWO proxy protocol version represents a version 2 (binary) header.

  • Field Details

    • VERSION_MASK

      private static final byte VERSION_MASK
      The highest 4 bits of the protocol version and command byte contain the version
      See Also:

    • byteValue

      private final byte byteValue

  • Constructor Details

    • HAProxyProtocolVersion

      private HAProxyProtocolVersion(byte byteValue)
      Creates a new instance

  • Method Details

    • values

      public static HAProxyProtocolVersion[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static HAProxyProtocolVersion 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

    • valueOf

      public static HAProxyProtocolVersion valueOf(byte verCmdByte)
      Returns the HAProxyProtocolVersion represented by the highest 4 bits of the specified byte.
      Parameters:
      verCmdByte - protocol version and command byte

    • byteValue

      public byte byteValue()
      Returns the byte value of this version.