org.apache.catalina.tribes.group

Class ChannelInterceptorBase

public abstract class ChannelInterceptorBase extends Object implements ChannelInterceptor

Abstract class for the interceptor base class.

Version: $Revision: 467222 $, $Date: 2006-10-24 05:17:11 +0200 (Tue, 24 Oct 2006) $

Author: Filip Hanik

Field Summary
protected static Log	log
protected int	optionFlag

Constructor Summary
	ChannelInterceptorBase()

Method Summary
boolean	accept(ChannelMessage msg)
void	fireInterceptorEvent(InterceptorEvent event)
Member	getLocalMember(boolean incAlive) Return the member that represents this node.
Member	getMember(Member mbr)
Member[]	getMembers() Get all current cluster members
ChannelInterceptor	getNext()
int	getOptionFlag()
ChannelInterceptor	getPrevious()
boolean	hasMembers() has members
void	heartbeat()
void	memberAdded(Member member)
void	memberDisappeared(Member member)
void	messageReceived(ChannelMessage msg)
boolean	okToProcess(int messageFlags)
void	sendMessage(Member[] destination, ChannelMessage msg, InterceptorPayload payload)
void	setNext(ChannelInterceptor next)
void	setOptionFlag(int optionFlag)
void	setPrevious(ChannelInterceptor previous)
void	start(int svc) Starts up the channel.
void	stop(int svc) Shuts down the channel.

Field Detail

Method Detail

accept

public boolean accept(ChannelMessage msg)

fireInterceptorEvent

public void fireInterceptorEvent(InterceptorEvent event)

getLocalMember

public Member getLocalMember(boolean incAlive)

Return the member that represents this node.

Returns: Member

getMember

public Member getMember(Member mbr)

Parameters: mbr Member

Returns: Member

getMembers

public Member[] getMembers()

Get all current cluster members

Returns: all members or empty array

getNext

public final ChannelInterceptor getNext()

getPrevious

public final ChannelInterceptor getPrevious()

memberDisappeared

public void memberDisappeared(Member member)

messageReceived

public void messageReceived(ChannelMessage msg)

okToProcess

public boolean okToProcess(int messageFlags)

sendMessage

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

setNext

public final void setNext(ChannelInterceptor next)

setOptionFlag

public void setOptionFlag(int optionFlag)

setPrevious

public final void setPrevious(ChannelInterceptor previous)

start

public void start(int svc)

Starts up the channel. This can be called multiple times for individual services to start The svc parameter can be the logical or value of any constants

Parameters: svc int value of
DEFAULT - will start all services
MBR_RX_SEQ - starts the membership receiver
MBR_TX_SEQ - starts the membership broadcaster
SND_TX_SEQ - starts the replication transmitter
SND_RX_SEQ - starts the replication receiver

Throws: ChannelException if a startup error occurs or the service is already started.

stop

public void stop(int svc)

Shuts down the channel. This can be called multiple times for individual services to shutdown The svc parameter can be the logical or value of any constants

Parameters: svc int value of
DEFAULT - will shutdown all services
MBR_RX_SEQ - stops the membership receiver
MBR_TX_SEQ - stops the membership broadcaster
SND_TX_SEQ - stops the replication transmitter
SND_RX_SEQ - stops the replication receiver

Throws: ChannelException if a startup error occurs or the service is already started.