org.apache.catalina.tribes.group.interceptors
Class ThroughputInterceptor

java.lang.Object
  org.apache.catalina.tribes.group.ChannelInterceptorBase
      org.apache.catalina.tribes.group.interceptors.ThroughputInterceptor

All Implemented Interfaces:

ChannelInterceptor, Heartbeat, MembershipListener

public class ThroughputInterceptor
extends ChannelInterceptorBase

Version:

1.0

Author:

Filip Hanik

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.catalina.tribes.ChannelInterceptor

ChannelInterceptor.InterceptorEvent

Field Summary

protected static Log

log

Fields inherited from class org.apache.catalina.tribes.group.ChannelInterceptorBase

optionFlag

Constructor Summary

ThroughputInterceptor()

Method Summary

int	getInterval()
void	messageReceived(ChannelMessage msg) the messageReceived is invoked when a message is received.
void	report(double timeTx)
void	sendMessage(Member[] destination, ChannelMessage msg, InterceptorPayload payload) The sendMessage method is called when a message is being sent to one more destinations.
void	setInterval(int interval)

Methods inherited from class org.apache.catalina.tribes.group.ChannelInterceptorBase

accept, fireInterceptorEvent, getLocalMember, getMember, getMembers, getNext, getOptionFlag, getPrevious, hasMembers, heartbeat, memberAdded, memberDisappeared, okToProcess, setNext, setOptionFlag, setPrevious, start, stop

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static Log log

Constructor Detail

ThroughputInterceptor

public ThroughputInterceptor()

Method Detail

sendMessage

public void sendMessage(Member[] destination,
                        ChannelMessage msg,
                        InterceptorPayload payload)
                 throws ChannelException

Description copied from interface: ChannelInterceptor

The sendMessage method is called when a message is being sent to one more destinations. The interceptor can modify any of the parameters and then pass on the message down the stack by invoking getNext().sendMessage(destination,msg,payload)
Alternatively the interceptor can stop the message from being sent by not invoking getNext().sendMessage(destination,msg,payload)
If the message is to be sent asynchronous the application can be notified of completion and errors by passing in an error handler attached to a payload object.
The ChannelMessage.getAddress contains Channel.getLocalMember, and can be overwritten to simulate a message sent from another node.

Specified by:

sendMessage in interface ChannelInterceptor

Overrides:

sendMessage in class ChannelInterceptorBase

Parameters:

destination - Member[] - the destination for this message

msg - ChannelMessage - the message to be sent

payload - InterceptorPayload - the payload, carrying an error handler and future useful data, can be null

Throws:

ChannelException

See Also:

ErrorHandler, InterceptorPayload

messageReceived

public void messageReceived(ChannelMessage msg)

Description copied from interface: ChannelInterceptor

the messageReceived is invoked when a message is received. ChannelMessage.getAddress() is the sender, or the reply-to address if it has been overwritten.

Specified by:

messageReceived in interface ChannelInterceptor

Overrides:

messageReceived in class ChannelInterceptorBase

Parameters:

msg - ChannelMessage

report

public void report(double timeTx)

setInterval

public void setInterval(int interval)

getInterval

public int getInterval()