Package org.metricshub.ipmi.core.coding.payload.sol

Enum SolStatus

java.lang.Object
java.lang.Enum<SolStatus>
org.metricshub.ipmi.core.coding.payload.sol.SolStatus
All Implemented Interfaces:
Serializable, Comparable<SolStatus>
public enum SolStatus extends Enum<SolStatus>
Enumeration of all possible states, that Remote Console can receive from BMC during SOL communication.

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    Break
    A break condition from the system has been detected.
    CharacterTransferUnavailable
    Character transfer is unavailable because system is in a powered-down or sleep state.
    DtrAsserted
    When test mode active, signals that DTR is asserted on serial port.
    RtsAsserted
    When test mode active, signals that RTS is asserted on serial port.
    SolDeactivated
    SOL is deactivated/deactivating.
    TransmitOverrun
    Characters were dropped between transmitting this packet and the previous packet, because the system did not pay attention to hardware flow control.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getStatusNumber()
    Returns the bit of the status in the Operation/Status byte of a SOL packet from the BMC (IPMI 2.0 table 15-2).
    static SolStatus
    valueOf(String name)
    Returns the enum constant of this type with the specified name.
    static SolStatus[]
    values()
    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

    • CharacterTransferUnavailable

      public static final SolStatus CharacterTransferUnavailable
      Character transfer is unavailable because system is in a powered-down or sleep state.

    • SolDeactivated

      public static final SolStatus SolDeactivated
      SOL is deactivated/deactivating. (Remote console can use this to tell if SOL was deactivated by some other party, or by local pushbutton reset or power on/off).

    • TransmitOverrun

      public static final SolStatus TransmitOverrun
      Characters were dropped between transmitting this packet and the previous packet, because the system did not pay attention to hardware flow control.

    • Break

      public static final SolStatus Break
      A break condition from the system has been detected. The BMC will generate this only on one packet at the start of the break.

    • RtsAsserted

      public static final SolStatus RtsAsserted
      When test mode active, signals that RTS is asserted on serial port. For test mode inactive, it is unused. A packet with this status will be automatically sent whenever RTS changes state. Note that this packet may not contain character data.

    • DtrAsserted

      public static final SolStatus DtrAsserted
      When test mode active, signals that DTR is asserted on serial port. For test mode inactive, it is unused. A packet with this status will be automatically sent whenever DTR changes state. Note that this packet may not contain character data.

  • Method Details

    • values

      public static SolStatus[] 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 SolStatus 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

    • getStatusNumber

      public int getStatusNumber()
      Returns the bit of the status in the Operation/Status byte of a SOL packet from the BMC (IPMI 2.0 table 15-2).
      Returns:
      the bit number, 0 to 5