Enum SolOperation

java.lang.Object
java.lang.Enum<SolOperation>
org.metricshub.ipmi.core.coding.payload.sol.SolOperation
All Implemented Interfaces:
Serializable, Comparable<SolOperation>

public enum SolOperation extends Enum<SolOperation>
Enumeration of all possible operations, that Remote Console can invoke on BMC during SOL communication.
  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    Generate BREAK (300 ms, nominal)
    Deassert CTS (clear to send) to the baseboard serial controller.
    When test mode inactive, deassert DCD/DSR to baseboard serial controller.
    When test mode inactive, drop (flush) data from remote console to BMC [not including data carried in this packet, if any].
    When test mode inactive, flush Outbound Character Data (flush data from BMC to remote console).
    Assert RI (may not be supported on all implementations) - Goal is to allow this to be used for generating a WOR.
  • Method Summary

    Modifier and Type
    Method
    Description
    int
     
    Returns the enum constant of this type with the specified name.
    static SolOperation[]
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Enum

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

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait
  • Enum Constant Details

    • RingWOR

      public static final SolOperation RingWOR
      Assert RI (may not be supported on all implementations) - Goal is to allow this to be used for generating a WOR.
    • Break

      public static final SolOperation Break
      Generate BREAK (300 ms, nominal)
    • CTS

      public static final SolOperation CTS
      Deassert CTS (clear to send) to the baseboard serial controller. (This is the default state when SOL is deactivated.)
    • DCD_DSR

      public static final SolOperation DCD_DSR
      When test mode inactive, deassert DCD/DSR to baseboard serial controller. For test mode active, deassert just DCD to baseboard serial controller.
    • FlushInbound

      public static final SolOperation FlushInbound
      When test mode inactive, drop (flush) data from remote console to BMC [not including data carried in this packet, if any]. For test mode active, deassert DSR to baseboard serial controller.
    • FlushOutbound

      public static final SolOperation FlushOutbound
      When test mode inactive, flush Outbound Character Data (flush data from BMC to remote console). When test mode active, won't have any effect.
  • Method Details

    • values

      public static SolOperation[] 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 SolOperation 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
    • getOperationNumber

      public int getOperationNumber()