|
Apache Tomcat 6.0.51 | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.apache.catalina.tribes.group.ChannelInterceptorBase
org.apache.catalina.tribes.group.ChannelCoordinator
public class ChannelCoordinator
The channel coordinator object coordinates the membership service, the sender and the receiver. This is the last interceptor in the chain.
| Nested Class Summary |
|---|
| Nested classes/interfaces inherited from interface org.apache.catalina.tribes.ChannelInterceptor |
|---|
ChannelInterceptor.InterceptorEvent |
| Field Summary | |
|---|---|
protected int |
optionFlag
|
| Fields inherited from class org.apache.catalina.tribes.group.ChannelInterceptorBase |
|---|
log |
| Constructor Summary | |
|---|---|
ChannelCoordinator()
|
|
ChannelCoordinator(ChannelReceiver receiver,
ChannelSender sender,
MembershipService service)
|
|
| Method Summary | |
|---|---|
ChannelReceiver |
getClusterReceiver()
|
ChannelSender |
getClusterSender()
|
Member |
getLocalMember(boolean incAlive)
Return the member that represents this node. |
Member |
getMember(Member mbr)
Intercepts the code>Channel.getMember(Member) method |
Member[] |
getMembers()
Get all current cluster members |
MembershipService |
getMembershipService()
|
int |
getOptionFlag()
An interceptor can react to a message based on a set bit on the message options. |
boolean |
hasMembers()
has members |
void |
heartbeat()
The heartbeat() method gets invoked periodically
to allow interceptors to clean up resources, time out object and
perform actions that are unrelated to sending/receiving data. |
protected void |
internalStart(int svc)
Starts up the channel. |
protected void |
internalStop(int svc)
Shuts down the channel. |
void |
memberAdded(Member member)
A member was added to the group |
void |
memberDisappeared(Member member)
A member was removed from the group If the member left voluntarily, the Member.getCommand will contain the Member.SHUTDOWN_PAYLOAD data |
void |
messageReceived(ChannelMessage msg)
the messageReceived is invoked when a message is received. |
void |
sendMessage(Member[] destination,
ChannelMessage msg,
InterceptorPayload payload)
Send a message to one or more members in the cluster |
void |
setClusterReceiver(ChannelReceiver clusterReceiver)
|
void |
setClusterSender(ChannelSender clusterSender)
|
void |
setMembershipService(MembershipService membershipService)
|
void |
setOptionFlag(int flag)
Sets the option flag |
void |
start(int svc)
Starts up the channel. |
void |
stop(int svc)
Shuts down the channel. |
| Methods inherited from class org.apache.catalina.tribes.group.ChannelInterceptorBase |
|---|
accept, fireInterceptorEvent, getNext, getPrevious, okToProcess, setNext, setPrevious |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface org.apache.catalina.tribes.MessageListener |
|---|
accept, equals, hashCode |
| Field Detail |
|---|
protected int optionFlag
| Constructor Detail |
|---|
public ChannelCoordinator()
public ChannelCoordinator(ChannelReceiver receiver,
ChannelSender sender,
MembershipService service)
| Method Detail |
|---|
public int getOptionFlag()
ChannelInterceptorboolean react = (getOptionFlag() == (getOptionFlag() & ChannelMessage.getOptions()));
getOptionFlag in interface ChannelInterceptorgetOptionFlag in class ChannelInterceptorBaseChannelMessage.getOptions()public void setOptionFlag(int flag)
ChannelInterceptor
setOptionFlag in interface ChannelInterceptorsetOptionFlag in class ChannelInterceptorBaseflag - intChannelInterceptor.getOptionFlag()
public void sendMessage(Member[] destination,
ChannelMessage msg,
InterceptorPayload payload)
throws ChannelException
sendMessage in interface ChannelInterceptorsendMessage in class ChannelInterceptorBasedestination - Member[] - the destinations, null or zero length means allmsg - ClusterMessage - the message to sendpayload - InterceptorPayload - the payload, carrying an error handler and future useful data, can be null
ChannelExceptionErrorHandler,
InterceptorPayload
public void start(int svc)
throws ChannelException
start in interface ChannelInterceptorstart in class ChannelInterceptorBasesvc - int value of ChannelException - if a startup error occurs or the service is already started.Channel
public void stop(int svc)
throws ChannelException
stop in interface ChannelInterceptorstop in class ChannelInterceptorBasesvc - int value of ChannelException - if a startup error occurs or the service is already started.Channel
protected void internalStart(int svc)
throws ChannelException
svc - int value of ChannelException - if a startup error occurs or the service is already started.
protected void internalStop(int svc)
throws ChannelException
svc - int value of ChannelException - if a startup error occurs or the service is already started.public void memberAdded(Member member)
MembershipListener
memberAdded in interface MembershipListenermemberAdded in class ChannelInterceptorBasemember - Member - the member that was addedpublic void memberDisappeared(Member member)
MembershipListener
memberDisappeared in interface MembershipListenermemberDisappeared in class ChannelInterceptorBasemember - MemberMember.SHUTDOWN_PAYLOADpublic void messageReceived(ChannelMessage msg)
ChannelInterceptormessageReceived is invoked when a message is received.
ChannelMessage.getAddress() is the sender, or the reply-to address
if it has been overwritten.
messageReceived in interface ChannelInterceptormessageReceived in interface MessageListenermessageReceived in class ChannelInterceptorBasemsg - ChannelMessagepublic ChannelReceiver getClusterReceiver()
public ChannelSender getClusterSender()
public MembershipService getMembershipService()
public void setClusterReceiver(ChannelReceiver clusterReceiver)
public void setClusterSender(ChannelSender clusterSender)
public void setMembershipService(MembershipService membershipService)
public void heartbeat()
ChannelInterceptorheartbeat() method gets invoked periodically
to allow interceptors to clean up resources, time out object and
perform actions that are unrelated to sending/receiving data.
heartbeat in interface ChannelInterceptorheartbeat in interface Heartbeatheartbeat in class ChannelInterceptorBasepublic boolean hasMembers()
hasMembers in interface ChannelInterceptorhasMembers in class ChannelInterceptorBaseChannel.hasMembers()public Member[] getMembers()
getMembers in interface ChannelInterceptorgetMembers in class ChannelInterceptorBaseChannel.getMembers()public Member getMember(Member mbr)
ChannelInterceptor
getMember in interface ChannelInterceptorgetMember in class ChannelInterceptorBasembr - Member
Channel.getMember(Member)public Member getLocalMember(boolean incAlive)
getLocalMember in interface ChannelInterceptorgetLocalMember in class ChannelInterceptorBaseincAlive - boolean
Channel.getLocalMember(boolean)
|
Apache Tomcat 6.0.51 | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||