org.apache.catalina.tribes.membership
Class McastServiceImpl

java.lang.Object
  org.apache.catalina.tribes.membership.McastServiceImpl

public class McastServiceImpl
extends java.lang.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

Author:

Filip Hanik

MAX_PACKET_SIZE

protected static int MAX_PACKET_SIZE

doRunSender

protected boolean doRunSender

Internal flag used for the listen thread that listens to the multicasting socket.

doRunReceiver

protected boolean doRunReceiver

startLevel

protected int startLevel

socket

protected java.net.MulticastSocket socket

Socket that we intend to listen to

member

protected MemberImpl member

The local member that we intend to broad cast over and over again

address

protected java.net.InetAddress address

The multicast address

port

protected int port

The multicast port

timeToExpiration

protected long timeToExpiration

The time it takes for a member to expire.

sendFrequency

protected long sendFrequency

How often to we send out a broadcast saying we are alive, must be smaller than timeToExpiration

sendPacket

protected java.net.DatagramPacket sendPacket

Reuse the sendPacket, no need to create a new one everytime

receivePacket

protected java.net.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 MembershipListener service

The actual listener, for callback when shits goes down

receiver

protected McastServiceImpl.ReceiverThread receiver

Thread to listen for pings

sender

protected McastServiceImpl.SenderThread sender

Thread to send pings

serviceStartTime

protected long serviceStartTime

When was the service started

mcastTTL

protected 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 java.net.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

expiredMutex

protected java.lang.Object expiredMutex

McastServiceImpl

public McastServiceImpl(MemberImpl member,
                        long sendFrequency,
                        long expireTime,
                        int port,
                        java.net.InetAddress bind,
                        java.net.InetAddress mcastAddress,
                        int ttl,
                        int soTimeout,
                        MembershipListener service)
                 throws java.io.IOException

Create a new mcast service impl

Parameters:

member - - the local member

sendFrequency - - the time (ms) in between pings sent out

expireTime - - the time (ms) for a member to expire

port - - the mcast port

bind - - the bind address (not sure this is used yet)

mcastAddress - - the mcast address

service - - the callback service

Throws:

java.io.IOException

init

public void init()
          throws java.io.IOException

Throws:

java.io.IOException

setupSocket

protected void setupSocket()
                    throws java.io.IOException

Throws:

java.io.IOException

start

public void start(int level)
           throws java.io.IOException

Start the service

Parameters:

level - 1 starts the receiver, level 2 starts the sender

Throws:

java.io.IOException - if the service fails to start

java.lang.IllegalStateException - if the service is already started

stop

public boolean stop(int level)
             throws java.io.IOException

Stops the service

Throws:

java.io.IOException - if the service fails to disconnect from the sockets

receive

public void receive()
             throws java.io.IOException

Receive a datagram packet, locking wait

Throws:

java.io.IOException

checkExpired

protected void checkExpired()

send

public void send(boolean checkexpired)
          throws java.io.IOException

Send a ping

Throws:

java.lang.Exception

java.io.IOException

getServiceStartTime

public long getServiceStartTime()

getRecoveryCounter

public int getRecoveryCounter()

isRecoveryEnabled

public boolean isRecoveryEnabled()

getRecoverySleepTime

public long getRecoverySleepTime()

setRecoveryCounter

public void setRecoveryCounter(int recoveryCounter)

setRecoveryEnabled

public void setRecoveryEnabled(boolean recoveryEnabled)

setRecoverySleepTime

public void setRecoverySleepTime(long recoverySleepTime)