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

Class IpmiLanRequest

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.IpmiLanRequest

public class IpmiLanRequest
extends IpmiLanMessage

A wrapper class for IPMB LAN 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
IpmiLanRequest(int networkFunctionCode, byte commandCode, byte[] requestData, byte sequenceNumber)	Builds IpmiLanRequest addressed at LUN 0, under a network function given by its code, which may be one NetworkFunction does not list: Transport (0Ch), Group Extension (2Ch: DCMI, PICMG), OEM/Group (2Eh), controller-specific OEM (30h-3Eh), IPMI 2.0 table 5-1.
IpmiLanRequest(NetworkFunction networkFunction, byte commandCode, byte[] requestData, byte sequenceNumber)	Builds IpmiLanRequest addressed at LUN 0.
IpmiLanRequest(NetworkFunction networkFunction, byte commandCode, byte[] requestData, byte sequenceNumber, byte lun)	Builds IpmiLanRequest.

Method Summary

Modifier and Type	Method	Description
byte[]	getPayloadData()	Converts IpmiLanMessage to byte array.
int	getPayloadLength()	Gets expected size of LAN message in bytes.

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

IpmiLanRequest

public IpmiLanRequest(NetworkFunction networkFunction,
 byte commandCode,
 byte[] requestData,
 byte sequenceNumber)

Builds IpmiLanRequest addressed at LUN 0.

Parameters:

networkFunction - - command specific NetworkFunction

commandCode - - command specific CommandCodes

requestData - - command specific payload

sequenceNumber - - used to match request and response - must be in range [0-63]

IpmiLanRequest

public IpmiLanRequest(NetworkFunction networkFunction,
 byte commandCode,
 byte[] requestData,
 byte sequenceNumber,
 byte lun)

Builds IpmiLanRequest.

Parameters:

networkFunction - - command specific NetworkFunction

commandCode - - command specific CommandCodes

requestData - - command specific payload

sequenceNumber - - used to match request and response - must be in range [0-63]

lun - - target Logical Unit Number. Must be in range [0-3].

IpmiLanRequest

public IpmiLanRequest(int networkFunctionCode,
 byte commandCode,
 byte[] requestData,
 byte sequenceNumber)

Builds IpmiLanRequest addressed at LUN 0, under a network function given by its code, which may be one NetworkFunction does not list: Transport (0Ch), Group Extension (2Ch: DCMI, PICMG), OEM/Group (2Eh), controller-specific OEM (30h-3Eh), IPMI 2.0 table 5-1.

Parameters:

networkFunctionCode - - the network function code of the request, 00h to 3Fh

commandCode - - the command code

requestData - - command specific payload, null for none

sequenceNumber - - used to match request and response - must be in range [0-63]

Throws:

IllegalArgumentException - when the code does not fit in 6 bits

Method Details

getPayloadLength

public int getPayloadLength()

Description copied from class: IpmiLanMessage

Gets expected size of LAN message in bytes.

Specified by:

getPayloadLength in class IpmiLanMessage

getPayloadData

public byte[] getPayloadData()

Description copied from class: IpmiLanMessage

Converts IpmiLanMessage to byte array.

Specified by:

getPayloadData in class IpmiLanMessage

Returns:

payload