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

Class IpmiLanMessage

java.lang.Object
org.metricshub.ipmi.core.coding.payload.IpmiPayload
org.metricshub.ipmi.core.coding.payload.lan.IpmiLanMessage
Direct Known Subclasses:
IpmiLanRequest, IpmiLanResponse
public abstract class IpmiLanMessage extends IpmiPayload
A wrapper class for IPMI LAN message

  • Field Details

  • Constructor Details

    • IpmiLanMessage

      public IpmiLanMessage()

  • Method Details

    • setResponderAddress

      public void setResponderAddress(byte responderAddress)

    • getResponderAddress

      public byte getResponderAddress()

    • setNetworkFunction

      public void setNetworkFunction(NetworkFunction networkFunction)

    • getNetworkFunction

      public NetworkFunction getNetworkFunction()
      Returns the network function, when it is one NetworkFunction lists.
      Returns:
      the network function
      Throws:
      IllegalArgumentException - when the code is one NetworkFunction does not list: see getNetworkFunctionCode()

    • getNetworkFunctionCode

      public byte getNetworkFunctionCode()
      Returns the raw network function code (6 bits), which may be one NetworkFunction does not list: Transport (0Ch), Group Extension (2Ch), OEM/Group (2Eh), controller-specific OEM (30h-3Fh), IPMI 2.0 table 5-1.
      Returns:
      the network function code

    • setResponderLogicalUnitNumber

      public void setResponderLogicalUnitNumber(byte responderLogicalUnitNumber)

    • getResponderLogicalUnitNumber

      public byte getResponderLogicalUnitNumber()

    • setSequenceNumber

      public void setSequenceNumber(byte sequenceAddress)

    • getSequenceNumber

      public byte getSequenceNumber()

    • setRequesterAddress

      public void setRequesterAddress(byte requesterAddress)

    • getRequesterAddress

      public byte getRequesterAddress()

    • setRequesterLogicalUnitNumber

      public void setRequesterLogicalUnitNumber(byte requesterLogicalUnitNumber)

    • getRequesterLogicalUnitNumber

      public byte getRequesterLogicalUnitNumber()

    • setCommand

      public void setCommand(byte command)

    • getCommand

      public byte getCommand()

    • getPayloadLength

      public abstract int getPayloadLength()
      Gets expected size of LAN message in bytes.
      Specified by:
      getPayloadLength in class IpmiPayload

    • getPayloadData

      public abstract byte[] getPayloadData()
      Converts IpmiLanMessage to byte array.
      Specified by:
      getPayloadData in class IpmiPayload
      Returns:
      payload

    • getIpmiCommandData

      public byte[] getIpmiCommandData()
      Description copied from class: IpmiPayload
      Returns IPMI command encapsulated in IPMI Payload.
      Specified by:
      getIpmiCommandData in class IpmiPayload