Package org.sentrysoftware.ipmi.core.api.async

Class InboundSolMessageListener

java.lang.Object

org.sentrysoftware.ipmi.core.api.async.InboundSolMessageListener

All Implemented Interfaces:

InboundMessageListener

public class InboundSolMessageListener
extends Object
implements InboundMessageListener

Listener for inbound SOL messages sent by remote system to this application.

Constructor Summary

Constructors

Constructor	Description
InboundSolMessageListener(IpmiConnector connector, ConnectionHandle connectionHandle, List<SolEventListener> eventListeners)

Method Summary

Modifier and Type	Method	Description
int	getAvailableBytesCount()	Returns number of incoming bytes that are available to read from the buffer.
boolean	isPayloadSupported(IpmiPayload payload)	Checks if given payload is supported by this InboundMessageListener instance.
void	notify(IpmiPayload payload)	Notify listener about received inbound message.
byte[]	readBytes(int numberOfBytes)	Attempts to read given number of bytes from this ByteBuffer.

Methods inherited from class java.lang.Object

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

Constructor Details

InboundSolMessageListener

public InboundSolMessageListener(IpmiConnector connector,
 ConnectionHandle connectionHandle,
 List<SolEventListener> eventListeners)

Method Details

isPayloadSupported

public boolean isPayloadSupported(IpmiPayload payload)

Description copied from interface: InboundMessageListener

Checks if given payload is supported by this InboundMessageListener instance. This method should be called prior to invoking InboundMessageListener.notify(IpmiPayload).

Specified by:

isPayloadSupported in interface InboundMessageListener

Parameters:

payload - IpmiPayload instance to check

Returns:

true if payload is supported by this object, false otherwise

notify

public void notify(IpmiPayload payload)

Description copied from interface: InboundMessageListener

Notify listener about received inbound message. This method should be invoked only with payload for which InboundMessageListener.isPayloadSupported(IpmiPayload) returned true.

Specified by:

notify in interface InboundMessageListener

Parameters:

payload - payload extracted from inbound message

readBytes

public byte[] readBytes(int numberOfBytes)

Attempts to read given number of bytes from this ByteBuffer. If buffer currently contains less bytes than requested, this method reads only available number of bytes.

Parameters:

numberOfBytes - requested number of bytes to read

Returns:

actual bytes that could be read from this buffer.

getAvailableBytesCount

public int getAvailableBytesCount()

Returns number of incoming bytes that are available to read from the buffer.

Returns:

number of available bytes to read