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

Class IpmiLanResponse

java.lang.Object

org.metricshub.ipmi.core.coding.payload.IpmiPayload

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

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

public class IpmiLanResponse
extends IpmiLanMessage

A wrapper class for IPMB response message.

Field Summary

Fields inherited from class org.metricshub.ipmi.core.coding.payload.lan.IpmiLanMessage

MAX_SEQUENCE_NUMBER, MIN_SEQUENCE_NUMBER

Constructor Summary

Constructors

Constructor	Description
IpmiLanResponse(byte[] rawData)	Builds IPMI LAN response message from byte array.

Method Summary

Modifier and Type	Method	Description
CompletionCode	getCompletionCode()
byte[]	getPayloadData()	Deprecated. LAN response does not hve payload data
int	getPayloadLength()	Gets expected size of LAN message in bytes.
int	getRawCompletionCode()
void	setCompletionCode(byte completionCode)	Decodes the completion code.

Methods inherited from class org.metricshub.ipmi.core.coding.payload.lan.IpmiLanMessage

getCommand, getIpmiCommandData, getNetworkFunction, getNetworkFunctionCode, getRequesterAddress, getRequesterLogicalUnitNumber, getResponderAddress, getResponderLogicalUnitNumber, getSequenceNumber, setCommand, setNetworkFunction, setRequesterAddress, setRequesterLogicalUnitNumber, setResponderAddress, setResponderLogicalUnitNumber, setSequenceNumber

Methods inherited from class org.metricshub.ipmi.core.coding.payload.IpmiPayload

encryptPayload, getData, getEncryptedPayload, setData

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

IpmiLanResponse

public IpmiLanResponse(byte[] rawData)

Builds IPMI LAN response message from byte array.

Parameters:

rawData -

Throws:

IllegalArgumentException - when the message is too short or a checksum is corrupted

Method Details

setCompletionCode

public void setCompletionCode(byte completionCode)

Decodes the completion code. Only 00h and the generic codes (C0h-FFh, IPMI 2.0 Table 5-2) have a meaning common to every command; an OEM (01h-7Eh) or command-specific (80h-BEh) code is CompletionCode.Unknown here, and the command coder may give it its own meaning.

Parameters:

completionCode - the completion code byte of the response

getCompletionCode

public CompletionCode getCompletionCode()

getRawCompletionCode

public int getRawCompletionCode()

Returns:

the completion code byte as the BMC sent it

getPayloadLength

public int getPayloadLength()

Description copied from class: IpmiLanMessage

Gets expected size of LAN message in bytes.

Specified by:

getPayloadLength in class IpmiLanMessage

getPayloadData

@Deprecated
public byte[] getPayloadData()

Deprecated.

LAN response does not hve payload data

Description copied from class: IpmiLanMessage

Converts IpmiLanMessage to byte array.

Specified by:

getPayloadData in class IpmiLanMessage

Returns:

payload