Uses of Class
org.metricshub.ipmi.core.coding.PayloadCoder

Packages that use PayloadCoder

Package	Description
org.metricshub.ipmi.core.api.async	The asynchronous API.
org.metricshub.ipmi.core.api.sync	The synchronous API of the protocol core: IpmiConnector opens RMCP+ sessions and sends commands, waiting for their responses.
org.metricshub.ipmi.core.coding	The part of library responsible for message encoding and decoding.
org.metricshub.ipmi.core.coding.commands	The IPMI commands: one IpmiCommandCoder per command, which encodes the request and decodes the response into its ResponseData.
org.metricshub.ipmi.core.coding.commands.app	The application commands of IPMI 2.0: Get Device ID (section 20.1), which describes the controller, and Send Message (sections 6.13.3 and 22.7), which carries a command to a controller behind the BMC.
org.metricshub.ipmi.core.coding.commands.chassis	Chassis related commands.
org.metricshub.ipmi.core.coding.commands.fru	FRU related commands.
org.metricshub.ipmi.core.coding.commands.payload	The payload commands of IPMI 2.0 (section 24): Activate and Deactivate Payload, Get Payload Activation Status and Get Payload Instance Info, which the Serial over LAN console sends, and Get Channel Payload Support.
org.metricshub.ipmi.core.coding.commands.sdr	SDR related commands.
org.metricshub.ipmi.core.coding.commands.sel	SEL related commands.
org.metricshub.ipmi.core.coding.commands.session	Session management related commands.
org.metricshub.ipmi.core.coding.sol	The coder of the Serial over LAN payload: SolCoder encodes the SOL messages sent to the BMC and decodes its replies into SolResponseData.
org.metricshub.ipmi.core.connection	Package responsible for Connection management.
org.metricshub.ipmi.core.connection.queue	Package responsible for message queuing.
org.metricshub.ipmi.core.sm.events	The StateMachine events.

Uses of PayloadCoder in org.metricshub.ipmi.core.api.async

Methods in org.metricshub.ipmi.core.api.async with parameters of type PayloadCoder

Modifier and Type	Method	Description
int	IpmiAsyncConnector.sendMessage(ConnectionHandle connectionHandle, PayloadCoder request, boolean isOneWay)	Sends the IPMI message to the remote host.

Uses of PayloadCoder in org.metricshub.ipmi.core.api.sync

Methods in org.metricshub.ipmi.core.api.sync with parameters of type PayloadCoder

Modifier and Type	Method	Description
ResponseData	IpmiConnector.sendMessage(ConnectionHandle connectionHandle, PayloadCoder request)	Sends the IPMI message to the remote host.
void	IpmiConnector.sendOneWayMessage(ConnectionHandle connectionHandle, PayloadCoder request)	Sends the IPMI message to the remote host and doesn't wait for any response.

Uses of PayloadCoder in org.metricshub.ipmi.core.coding

Methods in org.metricshub.ipmi.core.coding with parameters of type PayloadCoder

Modifier and Type	Method	Description
static ResponseData	Decoder.decode(byte[] data, IpmiDecoder protocolDecoder, PayloadCoder payloadCoder)	Decodes raw data into ResponseData - a wrapper class for message-specific response data.
static byte[]	Encoder.encode(IpmiEncoder protcolEncoder, PayloadCoder payloadCoder, int messageSequenceNumber, int sessionSequenceNumber, int sessionId)	Encodes IPMI command specified by payloadCoder into byte array raw data.

Uses of PayloadCoder in org.metricshub.ipmi.core.coding.commands

Subclasses of PayloadCoder in org.metricshub.ipmi.core.coding.commands

Modifier and Type	Class	Description
class	IpmiCommandCoder<R extends ResponseData>	A wrapper for an IPMI command: encodes its request and decodes its response, of type R.

Uses of PayloadCoder in org.metricshub.ipmi.core.coding.commands.app

Subclasses of PayloadCoder in org.metricshub.ipmi.core.coding.commands.app

Modifier and Type	Class	Description
class	GetDeviceId	Wrapper for the Get Device ID command (IPMI 2.0 section 20.1): the identity of the controller, its firmware and the functions it provides.
class	SendMessage<R extends ResponseData>	Send Message with response tracking (IPMI 2.0 sections 6.13.3 and 22.7): carries the request of another command to a controller behind the BMC, a satellite management controller on the IPMB for instance, and returns the response of that controller, decoded by that command.

Uses of PayloadCoder in org.metricshub.ipmi.core.coding.commands.chassis

Subclasses of PayloadCoder in org.metricshub.ipmi.core.coding.commands.chassis

Modifier and Type	Class	Description
class	ChassisControl	Wrapper class for Chassis Control request.
class	ChassisIdentify	Wrapper for the Chassis Identify command (IPMI 2.0 section 28.5): makes the chassis identify itself, by a blinking LED or a beep, for a number of seconds, indefinitely, or not any more.
class	GetChassisStatus	Wrapper class for Get Chassis Status request.

Uses of PayloadCoder in org.metricshub.ipmi.core.coding.commands.fru

Subclasses of PayloadCoder in org.metricshub.ipmi.core.coding.commands.fru

Modifier and Type	Class	Description
class	GetFruInventoryAreaInfo	A wrapper class for Get FRU Inventory Area Info Command.
class	ReadFruData	A wrapper class for Read FRU Data Command request.

Uses of PayloadCoder in org.metricshub.ipmi.core.coding.commands.payload

Subclasses of PayloadCoder in org.metricshub.ipmi.core.coding.commands.payload

Modifier and Type	Class	Description
class	ActivatePayload<R extends ActivatePayloadResponseData>	An abstract wrapper class for Activate Payload Command.
class	ActivateSolPayload	Concrete implementation of ActivatePayload command for PayloadType.SOL.
class	DeactivatePayload	A wrapper class for Deactivate Payload Command.
class	GetChannelPayloadSupport	A wrapper class for Get Channel Payload Support Command.
class	GetPayloadActivationStatus	Wrapper for Get Payload Activation Status Command.
class	GetPayloadInstanceInfo	Wrapper for the Get Payload Instance Info command (IPMI 2.0 section 24.5): the session where an instance of a payload is active.

Uses of PayloadCoder in org.metricshub.ipmi.core.coding.commands.sdr

Subclasses of PayloadCoder in org.metricshub.ipmi.core.coding.commands.sdr

Modifier and Type	Class	Description
class	GetDeviceSdr	Get Device SDR (IPMI 2.0 section 35.3): reads a record of the SDRs a Sensor Device holds itself, for a controller without an SDR Repository.
class	GetDeviceSdrInfo	Get Device SDR Info (IPMI 2.0 section 35.2): how many SDRs a Sensor Device holds itself, or how many sensors it implements at the LUN the request is addressed to.
class	GetSdr	Wrapper for Get SDR command.
class	GetSdrRepositoryInfo	A wrapper class for Get SDR Repository Info Command.
class	GetSensorReading	Wrapper for Get Sensor Reading request.
class	GetSensorReadingFactors	Get Sensor Reading Factors (IPMI 2.0 section 35.5): the factors that convert a given reading of a non-linear sensor.
class	ReserveDeviceSdrRepository	Reserve Device SDR Repository (IPMI 2.0 section 35.4): the reservation of the partial reads of GetDeviceSdr.
class	ReserveSdrRepository	Wrapper for Reserve SDR Repository command.

Uses of PayloadCoder in org.metricshub.ipmi.core.coding.commands.sel

Subclasses of PayloadCoder in org.metricshub.ipmi.core.coding.commands.sel

Modifier and Type	Class	Description
class	GetSelEntry	Wrapper for Get Sel Entry request
class	GetSelInfo	Wrapper class for Get SEL Info request.
class	GetSelTimeUtcOffset	Wrapper for the Get SEL Time UTC Offset command (IPMI 2.0 revision 1.1, section 31.11a): the offset from UTC of the SEL time, for a BMC that keeps its SEL time as local time.
class	ReserveSel	Wrapper for Reserve SEL command.

Uses of PayloadCoder in org.metricshub.ipmi.core.coding.commands.session

Subclasses of PayloadCoder in org.metricshub.ipmi.core.coding.commands.session

Modifier and Type	Class	Description
class	CloseSession	Wrapper for Close Session request
class	GetChannelAuthenticationCapabilities	Wrapper for Get Channel Authentication Capabilities request
class	GetChannelCipherSuites	Wrapper for RMCP+ Get Channel Cipher Suites command.
class	GetSessionInfo	Get Session Info (IPMI 2.0 section 22.20), looking a session up by its session ID: what the BMC knows of it.
class	OpenSession	Wrapper class for RMCP+ Open Session request.
class	Rakp1	A wrapper for RMCP+ RAKP1 message and it's response - RAKP2 message.
class	Rakp3	A wrapper for RMCP+ RAKP3 message and it's response - RAKP4 message.
class	SetSessionPrivilegeLevel	Wrapper class for Set Session Privilege Level command

Uses of PayloadCoder in org.metricshub.ipmi.core.coding.sol

Subclasses of PayloadCoder in org.metricshub.ipmi.core.coding.sol

Modifier and Type	Class	Description
class	SolCoder	Implementation of PayloadCoder for payload type PayloadType.Sol.

Uses of PayloadCoder in org.metricshub.ipmi.core.connection

Methods in org.metricshub.ipmi.core.connection with parameters of type PayloadCoder

Modifier and Type	Method	Description
int	Connection.sendMessage(PayloadCoder payloadCoder, boolean isOneWay)	Attempts to send IPMI request to the managed system.
int	MessageHandler.sendMessage(PayloadCoder payloadCoder, StateMachine stateMachine, int sessionId, boolean isOneWay)	Attempts to send message encoded by given PayloadCoder to the remote system.

Uses of PayloadCoder in org.metricshub.ipmi.core.connection.queue

Methods in org.metricshub.ipmi.core.connection.queue that return PayloadCoder

Modifier and Type	Method	Description
PayloadCoder	QueueElement.getRequest()
PayloadCoder	MessageQueue.retry(int tag)	Returns the queued request with the given tag, which is about to be sent again, and restarts its timeout: the request moves to the end of the queue, which stays in the order of the timeouts, with its tag.

Methods in org.metricshub.ipmi.core.connection.queue with parameters of type PayloadCoder

Modifier and Type	Method	Description
int	MessageQueue.add(PayloadCoder request)	Adds request to the queue and generates the tag.
int	MessageQueue.add(PayloadCoder request, boolean oneWay)	Adds request to the queue and generates the tag.
int	MessageQueue.add(PayloadCoder request, boolean oneWay, int tag)	Adds request to the queue under the given tag, when no other request holds it: a SOL packet sent again keeps its packet sequence number.
void	QueueElement.setRequest(PayloadCoder request)

Constructors in org.metricshub.ipmi.core.connection.queue with parameters of type PayloadCoder

Modifier	Constructor	Description
	QueueElement(int id, PayloadCoder request, boolean oneWay)

Uses of PayloadCoder in org.metricshub.ipmi.core.sm.events

Methods in org.metricshub.ipmi.core.sm.events that return PayloadCoder

Modifier and Type	Method	Description
PayloadCoder	Sendv20Message.getPayloadCoder()

Constructors in org.metricshub.ipmi.core.sm.events with parameters of type PayloadCoder

Modifier	Constructor	Description
	Sendv20Message(PayloadCoder payloadCoder, int sessionId, int messageSequenceNumber, int sessionSequenceNumber)	Prepares an event for StateMachine that will perform sending an IPMI command in v2.0 format.