Class McastServiceImpl
- java.lang.Object
-
- org.apache.catalina.tribes.membership.McastServiceImpl
-
public class McastServiceImpl extends Object
A membership implementation using simple multicast. This is the representation of a multicast membership service. This class is responsible for maintaining a list of active cluster nodes in the cluster. If a node fails to send out a heartbeat, the node will be dismissed. This is the low level implementation that handles the multicasting sockets. Need to fix this, could use java.nio and only need one thread to send and receive, or just use a timeout on the receive
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description classMcastServiceImpl.ReceiverThreadprotected static classMcastServiceImpl.RecoveryThreadclassMcastServiceImpl.SenderThread
-
Field Summary
Fields Modifier and Type Field Description protected InetAddressaddressThe multicast addressprotected booleandoRunReceiverprotected booleandoRunSenderInternal flag used for the listen thread that listens to the multicasting socket.protected ExecutorServiceexecutorDont interrupt the sender/receiver thread, but pass off to an executorprotected ObjectexpiredMutexprotected booleanlocalLoopbackDisableddisable/enable local loopback messageprotected static intMAX_PACKET_SIZEprotected InetAddressmcastBindAddressbind addressprotected intmcastSoTimeoutRead timeout on the mcast socketprotected intmcastTTLTime to live for the multicast packets that are being sent outprotected MemberImplmemberThe local member that we intend to broad cast over and over againprotected MembershipmembershipThe membership, used so that we calculate memberships when they arrive or don't arriveprotected MessageListenermsgserviceThe actual listener for broadcast callbacksprotected intportThe multicast portprotected DatagramPacketreceivePacketReuse the receivePacket, no need to create a new one everytimeprotected McastServiceImpl.ReceiverThreadreceiverThread to listen for pingsprotected intrecoveryCounternr of times the system has to fail before a recovery is initiatedprotected booleanrecoveryEnabledAdd the ability to turn on/off recoveryprotected longrecoverySleepTimeThe time the recovery thread sleeps between recovery attemptsprotected McastServiceImpl.SenderThreadsenderThread to send pingsprotected longsendFrequencyHow often to we send out a broadcast saying we are alive, must be smaller than timeToExpirationprotected DatagramPacketsendPacketReuse the sendPacket, no need to create a new one everytimeprotected MembershipListenerserviceThe actual listener, for callback when stuff goes downprotected static StringManagersmprotected MulticastSocketsocketSocket that we intend to listen toprotected intstartLevelprotected longtimeToExpirationThe time it takes for a member to expire.
-
Constructor Summary
Constructors Constructor Description McastServiceImpl(MemberImpl member, long sendFrequency, long expireTime, int port, InetAddress bind, InetAddress mcastAddress, int ttl, int soTimeout, MembershipListener service, MessageListener msgservice, boolean localLoopbackDisabled)Create a new mcast service instance.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected voidcheckExpired()ChannelgetChannel()intgetRecoveryCounter()longgetRecoverySleepTime()longgetServiceStartTime()voidinit()booleanisRecoveryEnabled()voidreceive()Receive a datagram packet, locking waitvoidsend(boolean checkexpired)Send a ping.voidsend(boolean checkexpired, DatagramPacket packet)voidsetChannel(Channel channel)voidsetRecoveryCounter(int recoveryCounter)voidsetRecoveryEnabled(boolean recoveryEnabled)voidsetRecoverySleepTime(long recoverySleepTime)protected voidsetupSocket()voidstart(int level)Start the servicebooleanstop(int level)Stops the service.
-
-
-
Field Detail
-
MAX_PACKET_SIZE
protected static final int MAX_PACKET_SIZE
- See Also:
- Constant Field Values
-
sm
protected static final StringManager sm
-
doRunSender
protected volatile boolean doRunSender
Internal flag used for the listen thread that listens to the multicasting socket.
-
doRunReceiver
protected volatile boolean doRunReceiver
-
startLevel
protected volatile int startLevel
-
socket
protected MulticastSocket socket
Socket that we intend to listen to
-
member
protected final MemberImpl member
The local member that we intend to broad cast over and over again
-
address
protected final InetAddress address
The multicast address
-
port
protected final int port
The multicast port
-
timeToExpiration
protected final long timeToExpiration
The time it takes for a member to expire.
-
sendFrequency
protected final long sendFrequency
How often to we send out a broadcast saying we are alive, must be smaller than timeToExpiration
-
sendPacket
protected DatagramPacket sendPacket
Reuse the sendPacket, no need to create a new one everytime
-
receivePacket
protected DatagramPacket receivePacket
Reuse the receivePacket, no need to create a new one everytime
-
membership
protected Membership membership
The membership, used so that we calculate memberships when they arrive or don't arrive
-
service
protected final MembershipListener service
The actual listener, for callback when stuff goes down
-
msgservice
protected final MessageListener msgservice
The actual listener for broadcast callbacks
-
receiver
protected McastServiceImpl.ReceiverThread receiver
Thread to listen for pings
-
sender
protected McastServiceImpl.SenderThread sender
Thread to send pings
-
mcastTTL
protected final int mcastTTL
Time to live for the multicast packets that are being sent out
-
mcastSoTimeout
protected int mcastSoTimeout
Read timeout on the mcast socket
-
mcastBindAddress
protected final InetAddress mcastBindAddress
bind address
-
recoveryCounter
protected int recoveryCounter
nr of times the system has to fail before a recovery is initiated
-
recoverySleepTime
protected long recoverySleepTime
The time the recovery thread sleeps between recovery attempts
-
recoveryEnabled
protected boolean recoveryEnabled
Add the ability to turn on/off recovery
-
executor
protected final ExecutorService executor
Dont interrupt the sender/receiver thread, but pass off to an executor
-
localLoopbackDisabled
protected final boolean localLoopbackDisabled
disable/enable local loopback message
-
expiredMutex
protected final Object expiredMutex
-
-
Constructor Detail
-
McastServiceImpl
public McastServiceImpl(MemberImpl member, long sendFrequency, long expireTime, int port, InetAddress bind, InetAddress mcastAddress, int ttl, int soTimeout, MembershipListener service, MessageListener msgservice, boolean localLoopbackDisabled) throws IOException
Create a new mcast service instance.- Parameters:
member- - the local membersendFrequency- - the time (ms) in between pings sent outexpireTime- - the time (ms) for a member to expireport- - the mcast portbind- - the bind address (not sure this is used yet)mcastAddress- - the mcast addressttl- multicast ttl that will be set on the socketsoTimeout- Socket timeoutservice- - the callback servicemsgservice- Message listenerlocalLoopbackDisabled- - disable loopbackMode- Throws:
IOException- Init error
-
-
Method Detail
-
init
public void init() throws IOException- Throws:
IOException
-
setupSocket
protected void setupSocket() throws IOException- Throws:
IOException
-
start
public void start(int level) throws IOExceptionStart the service- Parameters:
level- 1 starts the receiver, level 2 starts the sender- Throws:
IOException- if the service fails to startIllegalStateException- if the service is already started
-
stop
public boolean stop(int level) throws IOExceptionStops the service.- Parameters:
level- Stop status- Returns:
trueif the stop is complete- Throws:
IOException- if the service fails to disconnect from the sockets
-
receive
public void receive() throws IOExceptionReceive a datagram packet, locking wait- Throws:
IOException- Received failed
-
checkExpired
protected void checkExpired()
-
send
public void send(boolean checkexpired) throws IOExceptionSend a ping.- Parameters:
checkexpired-trueto check for expiration- Throws:
IOException- Send error
-
send
public void send(boolean checkexpired, DatagramPacket packet) throws IOException- Throws:
IOException
-
getServiceStartTime
public long getServiceStartTime()
-
getRecoveryCounter
public int getRecoveryCounter()
-
isRecoveryEnabled
public boolean isRecoveryEnabled()
-
getRecoverySleepTime
public long getRecoverySleepTime()
-
getChannel
public Channel getChannel()
-
setChannel
public void setChannel(Channel channel)
-
setRecoveryCounter
public void setRecoveryCounter(int recoveryCounter)
-
setRecoveryEnabled
public void setRecoveryEnabled(boolean recoveryEnabled)
-
setRecoverySleepTime
public void setRecoverySleepTime(long recoverySleepTime)
-
-