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

Class SolMessage

java.lang.Object

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

org.metricshub.ipmi.core.coding.payload.sol.SolMessage

Direct Known Subclasses:

SolInboundMessage, SolOutboundMessage

public abstract class SolMessage
extends IpmiPayload

Implementation of IpmiPayload for SOL (Serial over LAN) messages.

Field Summary

Fields

Modifier and Type	Field	Description
static final byte	MAX_SEQUENCE_NUMBER
static final byte	MIN_SEQUENCE_NUMBER
static final int	PAYLOAD_HEADER_LENGTH

Method Summary

Modifier and Type	Method	Description
byte	getAcceptedCharacterCount()
byte	getAckNackSequenceNumber()
byte[]	getData()
byte[]	getIpmiCommandData()	Returns IPMI command encapsulated in IPMI Payload.
byte[]	getPayloadData()	Returns unencrypted payload encoded in byte array (owner is responsible for encryption).
int	getPayloadLength()	Returns encoded but UNENCRYPTED payload length.
byte	getSequenceNumber()
boolean	isAcknowledgeMessage()	Checks if given SolMessage is an ACK/NACK for some other message.
boolean	isDataCarrier()	Checks if given message carries some data (or operation/status).

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

encryptPayload, getEncryptedPayload, setData

Methods inherited from class java.lang.Object

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

Field Details

MIN_SEQUENCE_NUMBER

public static final byte MIN_SEQUENCE_NUMBER

See Also:

• Constant Field Values

MAX_SEQUENCE_NUMBER

public static final byte MAX_SEQUENCE_NUMBER

See Also:

• Constant Field Values

PAYLOAD_HEADER_LENGTH

public static final int PAYLOAD_HEADER_LENGTH

See Also:

• Constant Field Values

Method Details

getPayloadData

public byte[] getPayloadData()

Description copied from class: IpmiPayload

Returns unencrypted payload encoded in byte array (owner is responsible for encryption).

Specified by:

getPayloadData in class IpmiPayload

Returns:

payload

getPayloadLength

public int getPayloadLength()

Description copied from class: IpmiPayload

Returns encoded but UNENCRYPTED payload length.

Specified by:

getPayloadLength in class IpmiPayload

getIpmiCommandData

public byte[] getIpmiCommandData()

Description copied from class: IpmiPayload

Returns IPMI command encapsulated in IPMI Payload.

Specified by:

getIpmiCommandData in class IpmiPayload

getData

public byte[] getData()

Overrides:

getData in class IpmiPayload

getSequenceNumber

public byte getSequenceNumber()

getAckNackSequenceNumber

public byte getAckNackSequenceNumber()

getAcceptedCharacterCount

public byte getAcceptedCharacterCount()

isDataCarrier

public boolean isDataCarrier()

Checks if given message carries some data (or operation/status).

isAcknowledgeMessage

public boolean isAcknowledgeMessage()

Checks if given SolMessage is an ACK/NACK for some other message.