asia.stampy.server.listener.heartbeat

Class AbstractHeartbeatListener<SVR extends AbstractStampyMessageGateway>

java.lang.Object

asia.stampy.server.listener.heartbeat.AbstractHeartbeatListener<SVR>

All Implemented Interfaces:

StampyMessageListener

Direct Known Subclasses:

NettyHeartbeatListener

@StampyLibrary(libraryName="stampy-client-server")
public abstract class AbstractHeartbeatListener<SVR extends AbstractStampyMessageGateway>
extends java.lang.Object
implements StampyMessageListener

This class intercepts incoming StompMessageType.CONNECT from a STOMP 1.2 client and starts a heartbeat, if requested.

CONNECT heart-beat:[cx],[cy]
CONNECTED: heart-beat:[sx],[sy]

For heart-beats from the client to the server: if [cx] is 0 (the client cannot send heart-beats) or [sy] is 0 (the server does not want to receive heart-beats) then there will be none otherwise, there will be heart-beats every MAX([cx],[sy]) milliseconds In the other direction, [sx] and [cy] are used the same way.

See Also:

HeartbeatContainer, PaceMaker

Constructor Summary

Constructors

Constructor and Description
AbstractHeartbeatListener()

Method Summary

Methods

Modifier and Type	Method and Description
SVR	getGateway() Gets the message gateway.
StampyHeartbeatContainer	getHeartbeatContainer() Gets the heartbeat container.
StompMessageType[]	getMessageTypes() Gets the message types of which the implementation is interested.
boolean	isForMessage(StampyMessage<?> message) Returns true if the message should be processed by the implementation.
void	messageReceived(StampyMessage<?> message, HostPort hostPort) Invoked when the type and the message are to be processed by the implementation.
void	resetHeartbeat(HostPort hostPort) Reset heartbeat.
void	setGateway(SVR gateway) Inject the server AbstractStampyMessageGateway on system startup.
void	setHeartbeatContainer(StampyHeartbeatContainer heartbeatContainer) Inject the HeartbeatContainer on system startup.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractHeartbeatListener

public AbstractHeartbeatListener()

Method Detail

getMessageTypes

public StompMessageType[] getMessageTypes()

Description copied from interface: StampyMessageListener

Gets the message types of which the implementation is interested.

Specified by:

getMessageTypes in interface StampyMessageListener

Returns:

the message types

isForMessage

public boolean isForMessage(StampyMessage<?> message)

Description copied from interface: StampyMessageListener

Returns true if the message should be processed by the implementation.

Specified by:

isForMessage in interface StampyMessageListener

Parameters:

message - the message

Returns:

true, if is for message

messageReceived

public void messageReceived(StampyMessage<?> message,
                   HostPort hostPort)
                     throws java.lang.Exception

Description copied from interface: StampyMessageListener

Invoked when the type and the message are to be processed by the implementation.

Specified by:

messageReceived in interface StampyMessageListener

Parameters:

message - the message

hostPort - the host port

Throws:

java.lang.Exception - the exception

resetHeartbeat

public void resetHeartbeat(HostPort hostPort)

Reset heartbeat.

Parameters:

hostPort - the host port

getHeartbeatContainer

public StampyHeartbeatContainer getHeartbeatContainer()

Gets the heartbeat container.

Returns:

the heartbeat container

setHeartbeatContainer

public void setHeartbeatContainer(StampyHeartbeatContainer heartbeatContainer)

Inject the HeartbeatContainer on system startup.

Parameters:

heartbeatContainer - the new heartbeat container

getGateway

public SVR getGateway()

Gets the message gateway.

Returns:

the message gateway

setGateway

public void setGateway(SVR gateway)

Inject the server AbstractStampyMessageGateway on system startup.

Parameters:

gateway - the new message gateway