Class McastService
java.lang.Object
org.apache.catalina.tribes.membership.MembershipServiceBase
org.apache.catalina.tribes.membership.McastService
- All Implemented Interfaces:
McastServiceMBean,MembershipListener,MembershipService,MessageListener
public class McastService
extends MembershipServiceBase
implements MessageListener, McastServiceMBean
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.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected byte[]protected McastServiceImplA handle to the actual low level implementationprotected MemberImplThe local memberprotected MessageListenerA message listener delegate for broadcastsprotected byte[]protected static final StringManagerThe string manager for this package.Fields inherited from class org.apache.catalina.tribes.membership.MembershipServiceBase
channel, listener, propertiesFields inherited from interface org.apache.catalina.tribes.MembershipService
MBR_RX, MBR_TX -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleanaccept(ChannelMessage msg) Allows skipping processing of the specified message.voidbroadcast(ChannelMessage message) Broadcasts a message to all members.getBind()byte[]longlongbooleangetLocalMember(boolean alive) Get the local member.Get the MembershipProviderbyte[]intgetPort()intbooleanlongintintgetTtl()protected voidhasProperty(Properties properties, String name) Check if a required property is available.static voidSimple test programvoidReceive a message from the IO components in the Channel stackvoidvoidsetAddress(String addr) voidprotected voidsetDefaults(Properties properties) voidsetDomain(byte[] domain) Set the associated domain.voidvoidsetDropTime(long time) voidsetFrequency(long time) voidsetLocalLoopbackDisabled(boolean localLoopbackDisabled) voidsetLocalMemberProperties(String listenHost, int listenPort, int securePort, int udpPort) Sets the local member properties for broadcasting.voidsetMcastBindAddress(String bindaddr) voidsetMcastDropTime(long time) voidsetMessageListener(MessageListener listener) voidsetPayload(byte[] payload) Set a payload to be broadcasted with each membership broadcast.voidsetPort(int port) voidsetProperties(Properties properties) Sets the properties for the membership service.voidsetRecoveryCounter(int recoveryCounter) voidsetRecoveryEnabled(boolean recoveryEnabled) voidsetRecoverySleepTime(long recoverySleepTime) voidsetSoTimeout(int mcastSoTimeout) voidsetTtl(int mcastTTL) voidstart(int level) Starts the membership service.voidstop(int svc) Stop broadcasting and listening to membership pingsMethods inherited from class org.apache.catalina.tribes.membership.MembershipServiceBase
findMemberByName, getChannel, getMember, getMembers, getMembersByName, getProperties, hasMembers, memberAdded, memberDisappeared, removeMembershipListener, setChannel, setMembershipListener, startMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.apache.catalina.tribes.membership.McastServiceMBean
findMemberByName, getMembersByName, getProperties, hasMembers
-
Field Details
-
sm
The string manager for this package. -
impl
A handle to the actual low level implementation -
msglistener
A message listener delegate for broadcasts -
localMember
The local member -
payload
protected byte[] payload -
domain
protected byte[] domain
-
-
Constructor Details
-
McastService
public McastService()Create a membership service.
-
-
Method Details
-
setProperties
Sets the properties for the membership service.- Specified by:
setPropertiesin interfaceMembershipService- Overrides:
setPropertiesin classMembershipServiceBase- Parameters:
properties-
All are required
1. mcastPort - the port to listen to
2. mcastAddress - the mcast group address
4. bindAddress - the bind address if any - only one that can be null
5. memberDropTime - the time a member is gone before it is considered gone.
6. mcastFrequency - the frequency of sending messages
7. tcpListenPort - the port this member listens to
8. tcpListenHost - the bind address of this member- Throws:
IllegalArgumentException- if a property is missing.
-
getLocalMemberName
- Specified by:
getLocalMemberNamein interfaceMcastServiceMBean- Returns:
- the local member name
-
getLocalMember
Description copied from interface:MembershipServiceGet the local member.- Specified by:
getLocalMemberin interfaceMembershipService- Parameters:
alive-trueto set the alive time on the local member- Returns:
- the member object that defines this member
-
setLocalMemberProperties
public void setLocalMemberProperties(String listenHost, int listenPort, int securePort, int udpPort) Description copied from interface:MembershipServiceSets the local member properties for broadcasting.- Specified by:
setLocalMemberPropertiesin interfaceMembershipService- Parameters:
listenHost- Listen to hostlistenPort- Listen to portsecurePort- Use a secure portudpPort- Use UDP
-
setAddress
-
getAddress
- Specified by:
getAddressin interfaceMcastServiceMBean
-
setMcastBindAddress
-
setBind
-
getBind
- Specified by:
getBindin interfaceMcastServiceMBean
-
setPort
public void setPort(int port) -
setRecoveryCounter
public void setRecoveryCounter(int recoveryCounter) -
getRecoveryCounter
public int getRecoveryCounter()- Specified by:
getRecoveryCounterin interfaceMcastServiceMBean
-
setRecoveryEnabled
public void setRecoveryEnabled(boolean recoveryEnabled) -
getRecoveryEnabled
public boolean getRecoveryEnabled()- Specified by:
getRecoveryEnabledin interfaceMcastServiceMBean
-
setRecoverySleepTime
public void setRecoverySleepTime(long recoverySleepTime) -
getRecoverySleepTime
public long getRecoverySleepTime()- Specified by:
getRecoverySleepTimein interfaceMcastServiceMBean
-
setLocalLoopbackDisabled
public void setLocalLoopbackDisabled(boolean localLoopbackDisabled) -
getLocalLoopbackDisabled
public boolean getLocalLoopbackDisabled()- Specified by:
getLocalLoopbackDisabledin interfaceMcastServiceMBean
-
getPort
public int getPort()- Specified by:
getPortin interfaceMcastServiceMBean
-
setFrequency
public void setFrequency(long time) -
getFrequency
public long getFrequency()- Specified by:
getFrequencyin interfaceMcastServiceMBean
-
setMcastDropTime
public void setMcastDropTime(long time) -
setDropTime
public void setDropTime(long time) -
getDropTime
public long getDropTime()- Specified by:
getDropTimein interfaceMcastServiceMBean
-
hasProperty
Check if a required property is available.- Parameters:
properties- The set of propertiesname- The property to check for
-
start
Description copied from interface:MembershipServiceStarts the membership service. If a membership listeners is added the listener will start to receive membership events.- Specified by:
startin interfaceMembershipService- Parameters:
level- - level MBR_RX starts listening for members, level MBR_TX starts broad casting the server- Throws:
Exception- if the service fails to start.
-
stop
public void stop(int svc) Stop broadcasting and listening to membership pings- Specified by:
stopin interfaceMembershipService- Parameters:
svc- - level MBR_RX stops listening for members, level MBR_TX stops broad casting the server
-
setMessageListener
-
removeMessageListener
public void removeMessageListener() -
messageReceived
Description copied from interface:MessageListenerReceive a message from the IO components in the Channel stack- Specified by:
messageReceivedin interfaceMessageListener- Parameters:
msg- the message
-
accept
Description copied from interface:MessageListenerAllows skipping processing of the specified message.- Specified by:
acceptin interfaceMessageListener- Parameters:
msg- the message- Returns:
trueif the message will be processed
-
broadcast
Description copied from interface:MembershipServiceBroadcasts a message to all members.- Specified by:
broadcastin interfaceMembershipService- Overrides:
broadcastin classMembershipServiceBase- Parameters:
message- The message to broadcast- Throws:
ChannelException- Message broadcast failed
-
getSoTimeout
public int getSoTimeout()- Specified by:
getSoTimeoutin interfaceMcastServiceMBean
-
setSoTimeout
public void setSoTimeout(int mcastSoTimeout) -
getTtl
public int getTtl()- Specified by:
getTtlin interfaceMcastServiceMBean
-
getPayload
public byte[] getPayload() -
getDomain
public byte[] getDomain()- Specified by:
getDomainin interfaceMcastServiceMBean
-
setTtl
public void setTtl(int mcastTTL) -
setPayload
public void setPayload(byte[] payload) Description copied from interface:MembershipServiceSet a payload to be broadcasted with each membership broadcast.- Specified by:
setPayloadin interfaceMembershipService- Parameters:
payload- byte[]
-
setDomain
public void setDomain(byte[] domain) Description copied from interface:MembershipServiceSet the associated domain.- Specified by:
setDomainin interfaceMembershipService- Parameters:
domain- the domain
-
setDomain
-
getMembershipProvider
Description copied from interface:MembershipServiceGet the MembershipProvider- Specified by:
getMembershipProviderin interfaceMembershipService- Returns:
- MembershipProvider
-
setDefaults
-
main
-