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

Class GetPayloadInstanceInfo

java.lang.Object

org.metricshub.ipmi.core.coding.PayloadCoder

org.metricshub.ipmi.core.coding.commands.IpmiCommandCoder<GetPayloadInstanceInfoResponseData>

org.metricshub.ipmi.core.coding.commands.payload.GetPayloadInstanceInfo

public class GetPayloadInstanceInfo
extends IpmiCommandCoder<GetPayloadInstanceInfoResponseData>

Wrapper for the Get Payload Instance Info command (IPMI 2.0 section 24.5): the session where an instance of a payload is active.

Constructor Summary

Constructors

Constructor	Description
GetPayloadInstanceInfo(PayloadType payloadType, int payloadInstance)	Creates the command.

Method Summary

Modifier and Type	Method	Description
byte	getCommandCode()	Retrieves command code specific for command represented by this class
NetworkFunction	getNetworkFunction()	Retrieves network function specific for command represented by this class.
GetPayloadInstanceInfoResponseData	getResponseData(IpmiMessage message)	Decodes the response: the session ID (LS-byte first), then 8 bytes of payload-specific information (table 24-7).

Methods inherited from class org.metricshub.ipmi.core.coding.commands.IpmiCommandCoder

answers, getNetworkFunctionCode, getSupportedPayloadType, isCommandResponse

Methods inherited from class org.metricshub.ipmi.core.coding.PayloadCoder

encodePayload, getAuthenticationType, getCipherSuite, getIpmiVersion, setAuthenticationType, setCipherSuite, setIpmiVersion, setSessionParameters

Methods inherited from class java.lang.Object

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

Constructor Details

GetPayloadInstanceInfo

public GetPayloadInstanceInfo(PayloadType payloadType,
 int payloadInstance)

Creates the command.

Parameters:

payloadType - the payload type, not PayloadType.Ipmi

payloadInstance - the instance of the payload, from 1

Method Details

getCommandCode

public byte getCommandCode()

Description copied from class: IpmiCommandCoder

Retrieves command code specific for command represented by this class

Specified by:

getCommandCode in class IpmiCommandCoder<GetPayloadInstanceInfoResponseData>

Returns:

command code

getNetworkFunction

public NetworkFunction getNetworkFunction()

Description copied from class: IpmiCommandCoder

Retrieves network function specific for command represented by this class.

Specified by:

getNetworkFunction in class IpmiCommandCoder<GetPayloadInstanceInfoResponseData>

Returns:

network function, or null for a command of a network function NetworkFunction does not list, which overrides IpmiCommandCoder.getNetworkFunctionCode() instead

See Also:

• NetworkFunction

getResponseData

public GetPayloadInstanceInfoResponseData getResponseData(IpmiMessage message)
                                                   throws IPMIException

Decodes the response: the session ID (LS-byte first), then 8 bytes of payload-specific information (table 24-7).

Specified by:

getResponseData in class IpmiCommandCoder<GetPayloadInstanceInfoResponseData>

Parameters:

message - - IPMI message

Returns:

response data

Throws:

IPMIException - when response completion code isn't OK.